(UNKNOWN PRODUCT) » TIDY » TMrbTidyDoc

class TMrbTidyDoc: public TNamed

__________________________________________________[C++IMPLEMENTATION]

 Name:           TMrbTidy
 Purpose:        MARaBOU utilities: tidy interface
 Description:    Implements class methods to interface the tidy library
 Keywords:
 Author:         R. Lutter
 Mailto:         <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a>
 Revision:       $Id: TMrbTidy.cxx,v 1.34 2007/08/03 10:11:05 Rudolf.Lutter Exp $
 Date:
/* Example of a HTML document (file "tidy.html")
<!DOCTYPE HTML PUBLIC "-// IETF/DTD HTML 2.0// EN">
<html>
<!-- Author: Marabou team (marabou@physik.uni-muenchen.de)  -->
<head><title>TMrbTidyDoc.html</title></head>
<body bgcolor="#ebfcb0">
<h1>TMrbTidyDoc: A MARaBOU class interfacing Dave Raggett's TidyLib</h1>
</body>
</html>



ROOT script to invoke TIDY:

{
    gSystem->Load("$MARABOU/lib/libTMrbUtils.so");
    gSystem->Load("$MARABOU/lib/libTMrbTidy.so");
    gSystem->Load("$MARABOU/lib/libTidy.so");
    TMrbTidyDoc * tdoc = new TMrbTidyDoc("demo", "tidy.html");
    tdoc->Print();
}


Output from method TMrbTidyDoc::Print():

Document demo (file tidy.html): structure as analyzed by D. Raggett's TIDY
----------------------------------------------------------------------------------------------
[ 0] node root: type=Root(0) parent=root
[ 1] . node HTML: type=DOCTYPE(1) parent=root text='<!DOCTYPE HTML><cr><cr>' PUBLIC=
[ 1] . node html: type=StartTag(5) tagid=HTML(48) parent=root
[ 2] .. node comment: type=Comment(2) parent=html text='<!-- Author: Marabou team (marabou@physik.uni-muenchen.de)  --><cr><cr>'
[ 2] .. node head: type=StartTag(5) tagid=HEAD(46) parent=html
[ 3] ... node title: type=StartTag(5) tagid=TITLE(111) parent=head
[ 4] .... node text: type=Text(4) parent=title text='TMrbTidyDoc.html<cr>'
[ 2] .. node body: type=StartTag(5) tagid=BODY(16) parent=html bgcolor=#EBFCB0
[ 3] ... node h1: type=StartTag(5) tagid=H1(40) parent=body
[ 4] .... node text: type=Text(4) parent=h1 text='TMrbTidyDoc: A MARaBOU class interfacing Dave Raggett's TidyLib<cr>'


*/

Function Members (Methods)

public:
TMrbTidyDoc()
TMrbTidyDoc(const Char_t* DocName)
TMrbTidyDoc(const Char_t* DocName, const Char_t* DocFile, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
TMrbTidyDoc(const Char_t* DocName, istream& Stream, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
TMrbTidyDoc(const Char_t* DocName, TString& Buffer, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
virtual~TMrbTidyDoc()
voidTObject::AbstractMethod(const char* method) const
Bool_tAddToList()
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
Bool_tCleanAndRepair()
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
Int_tGetAccessWarningCount() const
TMrbTidyNode*GetBody()
const Char_t*GetCfgFile() const
Int_tGetConfigErrorCount() const
const Char_t*GetDocFile() const
const Char_t*GetDocName(Bool_t LongFlag = kFALSE)
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
const Char_t*GetErrorBuffer()
Int_tGetErrorCount() const
TidyDocGetHandle() const
TMrbTidyNode*GetHead()
TMrbTidyNode*GetHtml()
Int_tGetHtmlVersion() const
virtual const char*TObject::GetIconName() const
TMrbLofNamedX*GetLofMnodes()
TMrbLofNamedX*GetLofOptions()
TMrbTidyNode*GetMbody()
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
TMrbTidyNode*GetRoot()
Int_tGetStatus() const
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
Int_tGetWarningCount() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
Bool_tHasMnodes()
Bool_tHasNodes()
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
Bool_tIsRepaired()
virtual Bool_tTNamed::IsSortable() const
Bool_tIsXhtml() const
Bool_tIsXml() const
Bool_tTObject::IsZombie() const
Bool_tLoadConfig(const Char_t* CfgFile)
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TNamed&TNamed::operator=(const TNamed& rhs)
Bool_tOutputHtml(const Char_t* HtmlFile)
Bool_tOutputHtml(ostream& Out = cout)
virtual voidTObject::Paint(Option_t* option = "")
Bool_tParseBuffer(const Char_t* Buffer, Bool_t Repair = kFALSE)
Bool_tParseBuffer(TString& Buffer, Bool_t Repair = kFALSE)
Bool_tParseFile(const Char_t* DocFile, Bool_t Repair = kFALSE)
virtual voidTObject::Pop()
virtual voidPrint(Option_t* Option) const
voidPrint(const Char_t* File, Bool_t Verbose = kFALSE, Bool_t HtmlFlag = kFALSE)
voidPrint(ostream& Out = cout, Bool_t Verbose = kFALSE, Bool_t HtmlFlag = kFALSE)
voidPrintDiagnostics(ostream& Out = cout)
voidPrintOptions(ostream& Out = cout, Bool_t Verbose = kFALSE)
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidReset(Bool_t Release = kFALSE)
voidTObject::ResetBit(UInt_t f)
Bool_tResetOptions()
Bool_tRunDiagnostics()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidSetMnodeFlag(Bool_t Flag = kTRUE)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
Bool_tSetOption(TidyOptionId OptionId, Bool_t Flag)
Bool_tSetOption(TidyOptionId OptionId, Int_t Value)
Bool_tSetOption(TidyOptionId OptionId, const Char_t* String)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp)
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
voidStripText(Bool_t Flag = kTRUE)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
Bool_tTextToBeStripped()
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidInitErrorBuffer()
Bool_tIsFirstChild()
Bool_tIsLastChild()
voidTObject::MakeZombie()
Int_tReadOptions()

Data Members

public:
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TStringfCfgFilename of configuration file
TStringfDocFilename of document file
_TidyBufferfErrorBufferinternal error buffer
TidyDocfHandletidy doc handle
Bool_tfHasMnodeskTRUE if special marabou nodes exist
TMrbLofNamedXfLofMnodeslist of special marabou nodes
TMrbLofNamedXfLofOptionslist of options
TStringTNamed::fNameobject identifier
Bool_tfRepairkTRUE if 'clean and repair' is to be called
Bool_tfStripTextkTRUE if <cr>s surrounding text have to be stripped
TMrbTidyNode*fTidyBodyptr to <body>...</body>
TMrbTidyNode*fTidyHeadprt to <head>...</head>
TMrbTidyNode*fTidyHtmlptr to <html>...</html>
TMrbTidyNode*fTidyMbodyptr to <mb>...</mb>
TMrbTidyNode*fTidyRootptr to whole document
TStringTNamed::fTitleobject title

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TMrbTidyDoc()
__________________________________________________________________[C++ CTOR]

 Name:           TMrbTidyDoc
 Purpose:        Create a tidy document
 Arguments:      --
 Description:    Ctor to instantiate a tidy document
 Keywords:
TMrbTidyDoc(const Char_t* DocName)
__________________________________________________________________[C++ CTOR]

 Name:           TMrbTidyDoc
 Purpose:        Create a tidy document
 Arguments:      Char_t * DocName       -- name of document
 Description:    Ctor to instantiate a tidy document
 Keywords:
TMrbTidyDoc(const Char_t* DocName, const Char_t* DocFile, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
__________________________________________________________________[C++ CTOR]

 Name:           TMrbTidyDoc
 Purpose:        Create a tidy document
 Arguments:      Char_t * DocName       -- name of document
                 Char_t * DocFile       -- file containing document
                 Bool_t Repair          -- clean and repair
                 Char_t * CfgFile       -- Tidy's config file
 Description:    Ctor to instantiate a tidy document
 Keywords:
TMrbTidyDoc(const Char_t* DocName, istream& Stream, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
__________________________________________________________________[C++ CTOR]

 Name:           TMrbTidyDoc
 Purpose:        Create a tidy document
 Arguments:      Char_t * DocName       -- name of document
                 istream & Stream       -- stream to read from
                 Bool_t Repair          -- clean and repair
                 Char_t * CfgFile       -- Tidy's config file
 Description:    Ctor to instantiate a tidy document
 Keywords:
TMrbTidyDoc(const Char_t* DocName, TString& Buffer, Bool_t Repair = kFALSE, const Char_t* CfgFile = NULL)
__________________________________________________________________[C++ CTOR]

 Name:           TMrbTidyDoc
 Purpose:        Create a tidy document
 Arguments:      Char_t * DocName       -- name of document
                 TString & Buffer       -- buffer containing html data
                 Bool_t Repair          -- clean and repair
                 Char_t * CfgFile       -- Tidy's config file
 Description:    Ctor to instantiate a tidy document
 Keywords:
void Reset(Bool_t Release = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::Reset
 Purpose:        Reset
 Arguments:      Bool_t Release  -- kTRUE -> release
 Results:        --
 Exceptions:
 Description:    Resets to initial values
 Keywords:
void InitErrorBuffer()
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::InitErrorBuffer
 Purpose:        Initialize tidy's error buffer
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Resets internal error buffer
 Keywords:
Bool_t LoadConfig(const Char_t* CfgFile)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::LoadConfig
 Purpose:        Load Tidy's config file
 Arguments:      Char_t * CfgFile    -- config file
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Reads config data from file (via tidyLoadConfig())
 Keywords:
Int_t ReadOptions()
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::ReadOptions
 Purpose:        Read tidy options
 Arguments:      --
 Results:        Int_t NofOptions   -- number of options read
 Exceptions:
 Description:    Reads options via tidyGetOptionsList()
 Keywords:
void PrintOptions(ostream& Out = cout, Bool_t Verbose = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::PrintOptions
 Purpose:        Print tidy options
 Arguments:      Bool_t Verbose  -- verbose
 Results:        --
 Exceptions:
 Description:    Prints tidy options.
 Keywords:
Bool_t ParseFile(const Char_t* DocFile, Bool_t Repair = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::ParseFile
 Purpose:        Parse html data from file
 Arguments:      Char_t * DocFile     -- html document to be processed
                 Bool_t Repair        -- kTRUE if tidy's repair mechanism has to be called
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Processes html data from file.
 Keywords:
Bool_t ParseBuffer(const Char_t* Buffer, Bool_t Repair = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::ParseBuffer
 Purpose:        Parse html data from buffer
 Arguments:      Char_t * Buffer      -- buffer with html data
                 Bool_t Repair        -- kTRUE if tidy's repair mechanism has to be called
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Processes html data.
 Keywords:
Bool_t CleanAndRepair()
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::CleanAndRepair
 Purpose:        Start tidy's repair mechanism
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Repair inconsistencies via tidyCleanAndRepair().
 Keywords:
Bool_t RunDiagnostics()
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::RunDiagnostics
 Purpose:        Perform tidy's diagnostic step
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Runs diagnostics via tidyRunDiagnostics().
 Keywords:
Bool_t AddToList()
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::AddToList
 Purpose:        Add to list of documents
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Adds this tidy object to list of documents
 Keywords:
const Char_t * GetDocName(Bool_t LongFlag = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::GetDocName
 Purpose:        Return name
 Arguments:      Bool_t LongFlag    -- long output
 Results:        Char_t * DocName   -- name
 Exceptions:
 Description:    Runs diagnostics via tidyRunDiagnostics().
 Keywords:
void Print(const Char_t* File, Bool_t Verbose = kFALSE, Bool_t HtmlFlag = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::Print
 Purpose:        Print data
 Arguments:      Char_t * File    -- file name
                 Bool_t Verbose   -- kTRUE: print full text strings
                 Bool_t HtmlFlag  -- kTRUE: output html format
 Results:        --
 Exceptions:
 Description:    Prints document data
 Keywords:
void Print(ostream& Out = cout, Bool_t Verbose = kFALSE, Bool_t HtmlFlag = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::Print
 Purpose:        Print data
 Arguments:      ostream & Out    -- output stream
                 Bool_t Verbose   -- kTRUE: print full text strings
                 Bool_t HtmlFlag  -- kTRUE: output html format
 Results:        --
 Exceptions:
 Description:    Prints document data
 Keywords:
Bool_t OutputHtml(const Char_t* HtmlFile)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::OutputHtml
 Purpose:        Output HTML code
 Arguments:      Char_t * HtmlFile    -- output file
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Outputs html code to file
                 including special code for marabou nodes
 Keywords:
Bool_t OutputHtml(ostream& Out = cout)
________________________________________________________________[C++ METHOD]

 Name:           TMrbTidyDoc::OutputHtml
 Purpose:        Output HTML code
 Arguments:      ostream & Out    -- output stream
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Outputs html code to stream
                 including special code for marabou nodes
 Keywords:
void Print(Option_t* Option) const
{ TObject::Print(Option); }
TidyOption GetHandle()
{ return(fHandle); }
virtual ~TMrbTidyDoc()
{ this->Reset(kTRUE); }
Int_t GetStatus() const
{ return(tidyStatus(fHandle)); }
Int_t GetHtmlVersion() const
{ return(tidyDetectedHtmlVersion(fHandle)); }
Bool_t IsXhtml() const
{ return(tidyDetectedXhtml(fHandle)); }
Bool_t IsXml() const
{ return(tidyDetectedGenericXml(fHandle)); }
Int_t GetErrorCount() const
{ return((Int_t) tidyErrorCount(fHandle)); }
Int_t GetWarningCount() const
{ return((Int_t) tidyWarningCount(fHandle)); }
Int_t GetAccessWarningCount() const
{ return((Int_t) tidyAccessWarningCount(fHandle)); }
const Char_t * GetErrorBuffer()
{ return(fErrorBuffer.bp); }
void PrintDiagnostics(ostream& Out = cout)
{ Out << this->GetErrorBuffer() << endl; }
Int_t GetConfigErrorCount() const
{ return(tidyConfigErrorCount(fHandle)); }
Bool_t SetOption(TidyOptionId OptionId, Bool_t Flag)
Bool_t SetOption(TidyOptionId OptionId, Int_t Value)
Bool_t SetOption(TidyOptionId OptionId, const Char_t* String)
TMrbLofNamedX * GetLofOptions()
{ return(&fLofOptions); }
TMrbLofNamedX * GetLofMnodes()
{ return(&fLofMnodes); }
Bool_t ParseBuffer(const Char_t* Buffer, Bool_t Repair = kFALSE)
Bool_t IsRepaired()
{ return(fRepair); }
Bool_t HasNodes()
{ return((fTidyRoot != NULL) && fTidyRoot->HasChilds()); }
void StripText(Bool_t Flag = kTRUE)
{ fStripText = Flag; }
Bool_t TextToBeStripped()
{ return(fStripText); }
const Char_t * GetDocFile() const
{ return(fDocFile.Length() ? fDocFile.Data() : NULL); }
const Char_t * GetCfgFile() const
{ return(fCfgFile.Length() ? fCfgFile.Data() : NULL); }
Bool_t ResetOptions()
{ return(tidyOptResetAllToDefault(fHandle)); }
TMrbTidyNode * GetRoot()
{ return(fTidyRoot); }
TMrbTidyNode * GetHtml()
{ return(fTidyHtml); }
TMrbTidyNode * GetHead()
{ return(fTidyHead); }
TMrbTidyNode * GetBody()
{ return(fTidyBody); }
TMrbTidyNode * GetMbody()
{ return(fTidyMbody); }
void SetMnodeFlag(Bool_t Flag = kTRUE)
{ fHasMnodes = Flag; }
Bool_t HasMnodes()
{ return(fHasMnodes); }
Bool_t IsFirstChild()
Bool_t IsLastChild()


Revision: $Id: TMrbTidy.h,v 1.22 2007/08/03 10:11:05 Rudolf.Lutter Exp $
ROOT page - Home page - Class index - Top of the page
This page has been automatically generated by use of ROOT's THtml class. If you have any comments or suggestions about the page layout send a mail to Marabou Support.