Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

THtml Class Reference

#include <THtml.h>

Inheritance diagram for THtml:

Inheritance graph
[legend]
Collaboration diagram for THtml:

Collaboration graph
[legend]
List of all members.

Public Methods

 THtml ()
virtual ~THtml ()
void Convert (const char *filename, const char *title, const char *dirname="")
const char * GetSourceDir ()
const char * GetOutputDir ()
const char * GetXwho () const
void MakeAll (Bool_t force=kFALSE, const char *filter="*")
void MakeClass (const char *className, Bool_t force=kFALSE)
void MakeIndex (const char *filter="*")
void MakeTree (const char *className, Bool_t force=kFALSE)
void SetEscape (char esc='\\')
void SetSourcePrefix (const char *prefix)
void SetSourceDir (const char *dir)
void SetOutputDir (const char *dir)
void SetXwho (const char *xwho)
virtual void WriteHtmlHeader (ofstream &out, const char *title)
virtual void WriteHtmlFooter (ofstream &out, const char *dir="", const char *lastUpdate="", const char *author="", const char *copyright="")
void ExtractDocumentation (const char *cFileName, TList *listClassesFound)
void ExtractClassDocumentation (const TClass *classPtr)
const char * GetDoc (TDictionary *dict) const
TMap * MakeHelp (TClass *cl)
TPaveText * GetDocPave (TDictionary *dict)

Static Public Methods

Bool_t ParseWord (const char *begin, Int_t &step, const char *allowedChars=0)
Bool_t ParseWord (const char *begin, Int_t &step, TString &strWord, const char *allowedChars=0)
TDictionary * GetType (const char *type)

Protected Methods

void Class2Html (TClass *classPtr, Bool_t force=kFALSE)
void ClassDescription (ofstream &out, TClass *classPtr, Bool_t &flag)
void ClassTree (TVirtualPad *canvas, TClass *classPtr, Bool_t force=kFALSE)
Bool_t CopyHtmlFile (const char *sourceName, const char *destName="")
void CreateIndex (const char **classNames, Int_t numberOfClasses)
void CreateIndexByTopic (char **filenames, Int_t numberOfNames, Int_t maxLen)
void CreateListOfTypes ()
void DerivedClasses (ofstream &out, TClass *classPtr)
void ExpandKeywords (ofstream &out, char *text, TClass *ptr2class, Bool_t &flag, const char *dir="")
void ExpandPpLine (ofstream &out, char *line)
TClass * GetClass (const char *name, Bool_t load=kTRUE)
const char * GetFileName (const char *filename)
char * GetSourceFileName (const char *filename)
char * GetHtmlFileName (TClass *classPtr)
Bool_t IsModified (TClass *classPtr, const Int_t type)
void NameSpace2FileName (char *name)
void ReplaceSpecialChars (ofstream &out, const char c)
void ReplaceSpecialChars (ofstream &out, const char *string)
void SortNames (const char **strings, Int_t num, Bool_t type=0)
char * StrDup (const char *s1, Int_t n=1)
TClass * ParseClassDecl (char *&cfirstLinePos, const TParseStack &parseStack, TString &strClassName)
TDocElement * AddDocElement (TDictionary *dict, TString &strDoc, const char *filename)
TDocElement * GetDocElement (TDictionary *dict) const
Bool_t FindMethodImpl (TString strMethFullName, TList &listMethodSameName, TList &listArgs, TParseStack &parseStack, Bool_t done=kFALSE) const

Static Protected Methods

Bool_t IsName (Int_t c)
Bool_t IsWord (Int_t c)

Protected Attributes

TString fXwho
const char * fSourcePrefix
const char * fSourceDir
const char * fOutputDir
char * fLine
Int_t fLen
char * fCounter
Bool_t fEscFlag
char fEsc
TMap * fMapDocElements
TList fFilesParsed

Static Protected Attributes

THashList fgLocalTypes

Friends

Int_t CaseSensitiveSort (const void *name1, const void *name2)
Int_t CaseInsensitiveSort (const void *name1, const void *name2)

Constructor & Destructor Documentation

THtml::THtml (    ) 
 

virtual THtml::~THtml (    )  [virtual]
 

Member Function Documentation

void THtml::Class2Html (  TClass *    classPtr,
Bool_t    force = kFALSE
)  [protected]
 

void THtml::ClassDescription (  ofstream &    out,
TClass *    classPtr,
Bool_t &    flag
)  [protected]
 

void THtml::ClassTree (  TVirtualPad *    canvas,
TClass *    classPtr,
Bool_t    force = kFALSE
)  [protected]
 

Bool_t THtml::CopyHtmlFile (  const char *    sourceName,
const char *    destName = ""
)  [protected]
 

void THtml::CreateIndex (  const char **    classNames,
Int_t    numberOfClasses
)  [protected]
 

void THtml::CreateIndexByTopic (  char **    filenames,
Int_t    numberOfNames,
Int_t    maxLen
)  [protected]
 

void THtml::CreateListOfTypes (    )  [protected]
 

void THtml::DerivedClasses (  ofstream &    out,
TClass *    classPtr
)  [protected]
 

void THtml::ExpandKeywords (  ofstream &    out,
char *    text,
TClass *    ptr2class,
Bool_t &    flag,
const char *    dir = ""
)  [protected]
 

void THtml::ExpandPpLine (  ofstream &    out,
char *    line
)  [protected]
 

TClass* THtml::GetClass (  const char *    name,
Bool_t    load = kTRUE
)  [protected]
 

const char* THtml::GetFileName (  const char *    filename )  [protected]
 

char* THtml::GetSourceFileName (  const char *    filename )  [protected]
 

char* THtml::GetHtmlFileName (  TClass *    classPtr )  [protected]
 

Bool_t THtml::IsModified (  TClass *    classPtr,
const Int_t    type
)  [protected]
 

Bool_t THtml::IsName (  Int_t    c )  [static, protected]
 

Bool_t THtml::IsWord (  Int_t    c )  [static, protected]
 

void THtml::NameSpace2FileName (  char *    name )  [protected]
 

void THtml::ReplaceSpecialChars (  ofstream &    out,
const char    c
)  [protected]
 

void THtml::ReplaceSpecialChars (  ofstream &    out,
const char *    string
)  [protected]
 

void THtml::SortNames (  const char **    strings,
Int_t    num,
Bool_t    type = 0
)  [protected]
 

char* THtml::StrDup (  const char *    s1,
Int_t    n = 1
)  [protected]
 

TClass* THtml::ParseClassDecl (  char *&    cfirstLinePos,
const TParseStack &    parseStack,
TString &    strClassName
)  [protected]
 

TDocElement* THtml::AddDocElement (  TDictionary *    dict,
TString &    strDoc,
const char *    filename
)  [protected]
 

TDocElement* THtml::GetDocElement (  TDictionary *    dict )  const [protected]
 

Definition at line 455 of file THtml.h.

References TMap::GetValue().

Referenced by GetDoc().

Bool_t THtml::FindMethodImpl (  TString    strMethFullName,
TList &    listMethodSameName,
TList &    listArgs,
TParseStack &    parseStack,
Bool_t    done = kFALSE
)  const [protected]
 

void THtml::Convert (  const char *    filename,
const char *    title,
const char *    dirname = ""
) 
 

const char* THtml::GetSourceDir (    ) 
 

Definition at line 466 of file THtml.h.

References fSourceDir.

const char* THtml::GetOutputDir (    ) 
 

Definition at line 467 of file THtml.h.

References fOutputDir.

const char* THtml::GetXwho (    )  const
 

Definition at line 468 of file THtml.h.

References TString::Data().

void THtml::MakeAll (  Bool_t    force = kFALSE,
const char *    filter = "*"
) 
 

void THtml::MakeClass (  const char *    className,
Bool_t    force = kFALSE
) 
 

void THtml::MakeIndex (  const char *    filter = "*" ) 
 

void THtml::MakeTree (  const char *    className,
Bool_t    force = kFALSE
) 
 

void THtml::SetEscape (  char    esc = '\\' ) 
 

Definition at line 473 of file THtml.h.

References fEsc.

void THtml::SetSourcePrefix (  const char *    prefix ) 
 

Definition at line 474 of file THtml.h.

References fSourcePrefix.

void THtml::SetSourceDir (  const char *    dir ) 
 

Definition at line 475 of file THtml.h.

References fSourceDir.

void THtml::SetOutputDir (  const char *    dir ) 
 

Definition at line 476 of file THtml.h.

References fOutputDir.

void THtml::SetXwho (  const char *    xwho ) 
 

Definition at line 477 of file THtml.h.

virtual void THtml::WriteHtmlHeader (  ofstream &    out,
const char *    title
)  [virtual]
 

virtual void THtml::WriteHtmlFooter (  ofstream &    out,
const char *    dir = "",
const char *    lastUpdate = "",
const char *    author = "",
const char *    copyright = ""
)  [virtual]
 

void THtml::ExtractDocumentation (  const char *    cFileName,
TList *    listClassesFound
) 
 

void THtml::ExtractClassDocumentation (  const TClass *    classPtr ) 
 

Bool_t THtml::ParseWord (  const char *    begin,
Int_t &    step,
const char *    allowedChars = 0
)  [static]
 

Referenced by THtml::TParseStack::FindType().

Bool_t THtml::ParseWord (  const char *    begin,
Int_t &    step,
TString &    strWord,
const char *    allowedChars = 0
)  [static]
 

TDictionary* THtml::GetType (  const char *    type )  [static]
 

Definition at line 489 of file THtml.h.

References THashList::FindObject(), TROOT::GetClass(), and gROOT.

Referenced by THtml::TParseStack::FindTypeFQI().

const char* THtml::GetDoc (  TDictionary *    dict )  const
 

Definition at line 495 of file THtml.h.

References TString::Data(), THtml::TDocElement::GetDoc(), and GetDocElement().

TMap* THtml::MakeHelp (  TClass *    cl ) 
 

TPaveText* THtml::GetDocPave (  TDictionary *    dict ) 
 

Friends And Related Function Documentation

Int_t CaseSensitiveSort (  const void *    name1,
const void *    name2
)  [friend]
 

Int_t CaseInsensitiveSort (  const void *    name1,
const void *    name2
)  [friend]
 

Member Data Documentation

TString THtml::fXwho [protected]
 

Definition at line 413 of file THtml.h.

const char* THtml::fSourcePrefix [protected]
 

Definition at line 414 of file THtml.h.

Referenced by SetSourcePrefix().

const char* THtml::fSourceDir [protected]
 

Definition at line 415 of file THtml.h.

Referenced by GetSourceDir(), and SetSourceDir().

const char* THtml::fOutputDir [protected]
 

Definition at line 416 of file THtml.h.

Referenced by GetOutputDir(), and SetOutputDir().

char* THtml::fLine [protected]
 

Definition at line 417 of file THtml.h.

Int_t THtml::fLen [protected]
 

Definition at line 418 of file THtml.h.

char* THtml::fCounter [protected]
 

Definition at line 419 of file THtml.h.

Bool_t THtml::fEscFlag [protected]
 

Definition at line 420 of file THtml.h.

char THtml::fEsc [protected]
 

Definition at line 421 of file THtml.h.

Referenced by SetEscape().

TMap* THtml::fMapDocElements [protected]
 

Definition at line 422 of file THtml.h.

THashList THtml::fgLocalTypes [static, protected]
 

Definition at line 423 of file THtml.h.

TList THtml::fFilesParsed [protected]
 

Definition at line 424 of file THtml.h.

The documentation for this class was generated from the following file:
Generated on Thu Dec 18 15:03:56 2003 for ROOT by doxygen1.2.16