TDocParser Class Reference

#include <TDocParser.h>

Inheritance diagram for TDocParser:

TObject TObject List of all members.

Public Types

enum  ESourceInfo
enum  EAccess
enum  EParseContext
enum  EParseContextFlag
enum  ESourceInfo
enum  EAccess
enum  EParseContext
enum  EParseContextFlag

Public Member Functions

 TDocParser (TClassDocOutput &docOutput, TClass *cl)
 TDocParser (TDocOutput &docOutput)
virtual ~TDocParser ()
void Convert (std::ostream &out, std::istream &in, const char *relpath, Bool_t isCode, Bool_t interpretDirectives)
void DecrementMethodCount (const char *name)
virtual void DecorateKeywords (std::ostream &out, const char *text)
virtual void DecorateKeywords (TString &text)
virtual void DeleteDirectiveOutput () const
const TList * GetMethods (EAccess access) const
TClass * GetCurrentClass () const
void GetCurrentModule (TString &out_module) const
TDocOutput * GetDocOutput () const
Long_t GetLineNumber () const
const TList * GetDataMembers (EAccess access) const
const TList * GetEnums (EAccess access) const
const char * GetSourceInfo (ESourceInfo type) const
void SetCurrentModule (const char *module)
UInt_t InContext (Int_t context) const
virtual void Parse (std::ostream &out)
 ClassDef (TDocParser, 0)
 TDocParser (TClassDocOutput &docOutput, TClass *cl)
 TDocParser (TDocOutput &docOutput)
virtual ~TDocParser ()
void Convert (std::ostream &out, std::istream &in, const char *relpath, Bool_t isCode, Bool_t interpretDirectives)
void DecrementMethodCount (const char *name)
virtual void DecorateKeywords (std::ostream &out, const char *text)
virtual void DecorateKeywords (TString &text)
virtual void DeleteDirectiveOutput () const
const TList * GetMethods (EAccess access) const
TClass * GetCurrentClass () const
void GetCurrentModule (TString &out_module) const
TDocOutput * GetDocOutput () const
Long_t GetLineNumber () const
const TList * GetDataMembers (EAccess access) const
const TList * GetEnums (EAccess access) const
const char * GetSourceInfo (ESourceInfo type) const
void SetCurrentModule (const char *module)
UInt_t InContext (Int_t context) const
virtual void Parse (std::ostream &out)
 ClassDef (TDocParser, 0)

Static Public Member Functions

static void AnchorFromLine (const TString &line, TString &anchor)
static Bool_t IsName (UChar_t c)
static Bool_t IsWord (UChar_t c)
static Bool_t Strip (TString &s)
static void AnchorFromLine (const TString &line, TString &anchor)
static Bool_t IsName (UChar_t c)
static Bool_t IsWord (UChar_t c)
static Bool_t Strip (TString &s)

Protected Types

enum  EDocContext
enum  
enum  EDocContext
enum  

Protected Member Functions

void AddClassMethodsRecursively (TBaseClass *bc)
void AddClassDataMembersRecursively (TBaseClass *bc)
EParseContext Context () const
virtual void ExpandCPPLine (TString &line, Ssiz_t &pos)
virtual Bool_t HandleDirective (TString &keyword, Ssiz_t &pos, TString &word, Ssiz_t &copiedToCommentUpTo)
virtual void InitKeywords () const
virtual TClass * IsDirective (const TString &line, Ssiz_t pos, const TString &word, Bool_t &begin) const
TMethod * LocateMethodInCurrentLine (Ssiz_t &posMethodName, TString &ret, TString &name, TString &params, Bool_t &isconst, std::ostream &srcOut, TString &anchor, std::ifstream &sourcefile, Bool_t allowPureVirtual)
void LocateMethodsInSource (std::ostream &out)
void LocateMethodsInHeaderInline (std::ostream &out)
void LocateMethodsInHeaderClassDecl (std::ostream &out)
void LocateMethods (std::ostream &out, const char *filename, Bool_t lookForSourceInfo=kTRUE, Bool_t useDocxxStyle=kFALSE, Bool_t allowPureVirtual=kFALSE, const char *methodPattern=0, const char *sourceExt=0)
virtual Bool_t ProcessComment ()
void RemoveCommentContext (Bool_t cxxcomment)
void WriteClassDoc (std::ostream &out, Bool_t first=kTRUE)
void WriteMethod (std::ostream &out, TString &ret, TString &name, TString &params, Bool_t isconst, const char *file, TString &anchor, TString &codeOneLiner)
void WriteSourceLine (std::ostream &out)
void AddClassMethodsRecursively (TBaseClass *bc)
void AddClassDataMembersRecursively (TBaseClass *bc)
EParseContext Context () const
virtual void ExpandCPPLine (TString &line, Ssiz_t &pos)
virtual Bool_t HandleDirective (TString &keyword, Ssiz_t &pos, TString &word, Ssiz_t &copiedToCommentUpTo)
virtual void InitKeywords () const
virtual TClass * IsDirective (const TString &line, Ssiz_t pos, const TString &word, Bool_t &begin) const
TMethod * LocateMethodInCurrentLine (Ssiz_t &posMethodName, TString &ret, TString &name, TString &params, Bool_t &isconst, std::ostream &srcOut, TString &anchor, std::ifstream &sourcefile, Bool_t allowPureVirtual)
void LocateMethodsInSource (std::ostream &out)
void LocateMethodsInHeaderInline (std::ostream &out)
void LocateMethodsInHeaderClassDecl (std::ostream &out)
void LocateMethods (std::ostream &out, const char *filename, Bool_t lookForSourceInfo=kTRUE, Bool_t useDocxxStyle=kFALSE, Bool_t allowPureVirtual=kFALSE, const char *methodPattern=0, const char *sourceExt=0)
virtual Bool_t ProcessComment ()
void RemoveCommentContext (Bool_t cxxcomment)
void WriteClassDoc (std::ostream &out, Bool_t first=kTRUE)
void WriteMethod (std::ostream &out, TString &ret, TString &name, TString &params, Bool_t isconst, const char *file, TString &anchor, TString &codeOneLiner)
void WriteSourceLine (std::ostream &out)

Protected Attributes

THtml * fHtml
TDocOutput * fDocOutput
UInt_t fLineNo
TString fLineRaw
TString fLineStripped
TString fLineComment
TString fLineSource
TString fComment
TString fFirstClassDoc
TString fLastClassDoc
TClass * fCurrentClass
TClass * fRecentClass
TString fCurrentModule
TString fCurrentMethodTag
Int_t fDirectiveCount
Long_t fLineNumber
TString fCurrentFile
std::map< std::string, Int_t > fMethodCounts
EDocContext fDocContext
std::list< UInt_t > fParseContext
Bool_t fCheckForMethod
enum TDocParser:: { ... }  fClassDocState
Bool_t fCommentAtBOL
TString fClassDescrTag
TString fSourceInfoTags [kNumSourceInfos]
TList fDirectiveHandlers
Bool_t fAllowDirectives
std::set< UInt_t > fExtraLinesWithAnchor
TString fSourceInfo [kNumSourceInfos]
THashList fMethods [3]
TList fDataMembers [6]
THtml * fHtml
TDocOutput * fDocOutput
TClass * fCurrentClass
TClass * fRecentClass
std::map< std::string, Int_t > fMethodCounts
std::list< UInt_t > fParseContext
enum TDocParser:: { ... }  fClassDocState
std::set< UInt_t > fExtraLinesWithAnchor

Static Protected Attributes

static std::set< std::string > fgKeywords
static std::set< std::string > fgKeywords

Detailed Description

Definition at line 53 of file TDocParser.h.

Member Enumeration Documentation

enum TDocParser::EDocContext [protected]

Definition at line 55 of file TDocParser.h.

enum TDocParser::ESourceInfo

Definition at line 63 of file TDocParser.h.

enum TDocParser::EAccess

Definition at line 71 of file TDocParser.h.

enum TDocParser::EParseContext

Definition at line 76 of file TDocParser.h.

enum TDocParser::EParseContextFlag

Definition at line 88 of file TDocParser.h.

anonymous enum [protected]

Definition at line 116 of file TDocParser.h.

enum TDocParser::EDocContext [protected]

Definition at line 55 of file TDocParser.h.

enum TDocParser::ESourceInfo

Definition at line 63 of file TDocParser.h.

enum TDocParser::EAccess

Definition at line 71 of file TDocParser.h.

enum TDocParser::EParseContext

Definition at line 76 of file TDocParser.h.

enum TDocParser::EParseContextFlag

Definition at line 88 of file TDocParser.h.

anonymous enum [protected]

Definition at line 116 of file TDocParser.h.

Constructor & Destructor Documentation

TDocParser::TDocParser ( TClassDocOutput &  docOutput,
TClass *  cl 
)

Definition at line 140 of file TDocParser.cxx.

References AddClassDataMembersRecursively(), AddClassMethodsRecursively(), fClassDescrTag, fCurrentClass, fHtml, fMethodCounts, fMethods, fParseContext, fSourceInfoTags, THtml::GetAuthorTag(), THtml::GetClassDocTag(), THtml::GetCopyrightTag(), THtml::GetLastUpdateTag(), TClass::GetListOfMethods(), InitKeywords(), kCode, kInfoAuthor, kInfoCopyright, kInfoLastUpdate, and method.

TDocParser::TDocParser ( TDocOutput &  docOutput  ) 

Definition at line 180 of file TDocParser.cxx.

References fClassDescrTag, fHtml, fSourceInfoTags, THtml::GetAuthorTag(), THtml::GetClassDocTag(), THtml::GetCopyrightTag(), THtml::GetLastUpdateTag(), InitKeywords(), kInfoAuthor, kInfoCopyright, and kInfoLastUpdate.

TDocParser::~TDocParser (  )  [virtual]

Definition at line 200 of file TDocParser.cxx.

References TString::Data(), fCurrentClass, fDirectiveHandlers, fMethodCounts, gDebug, TDocDirective::GetEndTag(), TDocDirective::GetName(), TObject::Info(), and TObject::Warning().

TDocParser::TDocParser ( TClassDocOutput &  docOutput,
TClass *  cl 
)

TDocParser::TDocParser ( TDocOutput &  docOutput  ) 

virtual TDocParser::~TDocParser (  )  [virtual]

Member Function Documentation

void TDocParser::AddClassMethodsRecursively ( TBaseClass *  bc  )  [protected]

Definition at line 221 of file TDocParser.cxx.

References access, TList::Add(), fCurrentClass, THashList::FindObject(), fMethods, TBaseClass::GetClassPointer(), TClass::GetListOfBases(), TClass::GetListOfMethods(), kFALSE, method, TBaseClass::Property(), and TList::Sort().

Referenced by TDocParser().

void TDocParser::AddClassDataMembersRecursively ( TBaseClass *  bc  )  [protected]

Definition at line 292 of file TDocParser.cxx.

References access, TList::Add(), fCurrentClass, fDataMembers, G__BIT_ISCONSTANT, G__BIT_ISENUM, G__BIT_ISSTATIC, TBaseClass::GetClassPointer(), TDataMember::GetDataType(), TClass::GetListOfBases(), TClass::GetListOfDataMembers(), TDataType::GetType(), kFALSE, kInt_t, TDataMember::Property(), TBaseClass::Property(), and Sort().

Referenced by TDocParser().

EParseContext TDocParser::Context (  )  const [inline, protected]

Definition at line 138 of file TDocParser.h.

References fParseContext, kComment, and kParseContextMask.

Referenced by DecorateKeywords(), and ProcessComment().

void TDocParser::ExpandCPPLine ( TString &  line,
Ssiz_t &  pos 
) [protected, virtual]

Definition at line 889 of file TDocParser.cxx.

References TSystem::BaseName(), TDocOutput::CopyHtmlFile(), TDocOutput::DecorateEntityBegin(), TDocOutput::DecorateEntityEnd(), fDocOutput, fHtml, THtml::GetMakeClassMutex(), THtml::GetPathDefinition(), gSystem, i, kCPP, kFALSE, kNPOS, kTRUE, line, R__LOCKGUARD, and TDocOutput::ReplaceSpecialChars().

Referenced by DecorateKeywords().

Bool_t TDocParser::HandleDirective ( TString &  keyword,
Ssiz_t &  pos,
TString &  word,
Ssiz_t &  copiedToCommentUpTo 
) [protected, virtual]

Definition at line 962 of file TDocParser.cxx.

References TList::AddLast(), TDocDirective::AddLine(), c, TString::Data(), TDocOutput::DecorateEntityBegin(), fCurrentMethodTag, fDirectiveCount, fDirectiveHandlers, fDocOutput, fLineComment, fLineRaw, fLineSource, fParseContext, TDocDirective::GetEndTag(), TDocDirective::GetResult(), InContext(), IsDirective(), kComment, kCXXComment, kDirective, kFALSE, TString::kIgnoreCase, kNPOS, kTRUE, TList::Last(), TList::LastLink(), TString::Length(), line, TClass::New(), params, TList::Remove(), TDocOutput::ReplaceSpecialChars(), result(), TDocDirective::SetCounter(), TDocDirective::SetParameters(), TDocDirective::SetParser(), TDocDirective::SetTag(), start, and TObject::Warning().

Referenced by DecorateKeywords().

void TDocParser::InitKeywords (  )  const [protected, virtual]

Definition at line 1161 of file TDocParser.cxx.

References fgKeywords.

Referenced by TDocParser().

TClass * TDocParser::IsDirective ( const TString &  line,
Ssiz_t  pos,
const TString &  word,
Bool_t &  begin 
) const [protected, virtual]

Definition at line 1234 of file TDocParser.cxx.

References TString::BeginsWith(), TString::Data(), fLineNo, gDebug, TClass::GetClass(), kFALSE, TString::kIgnoreCase, TString::Length(), line, TString::Prepend(), TString::ToLower(), and TObject::Warning().

Referenced by HandleDirective().

TMethod * TDocParser::LocateMethodInCurrentLine ( Ssiz_t &  posMethodName,
TString &  ret,
TString &  name,
TString &  params,
Bool_t &  isconst,
std::ostream &  srcOut,
TString &  anchor,
std::ifstream &  sourcefile,
Bool_t  allowPureVirtual 
) [protected]

Definition at line 1324 of file TDocParser.cxx.

References AnchorFromLine(), TString::BeginsWith(), DecorateKeywords(), TObject::Error(), fCommentAtBOL, fCurrentClass, fCurrentMethodTag, fDirectiveCount, fLineNumber, fLineRaw, fLineSource, fLineStripped, fMethodCounts, TClass::GetMethodAny(), TString::Index(), IsName(), IsWord(), kFALSE, TString::kLeading, kNPOS, kTRUE, TString::Length(), name, params, TString::ReadLine(), TString::Strip(), Strip(), and WriteSourceLine().

Referenced by LocateMethods().

void TDocParser::LocateMethodsInSource ( std::ostream &  out  )  [protected]

Definition at line 1830 of file TDocParser.cxx.

References fCurrentClass, fHtml, THtml::GetDocStyle(), THtml::GetImplFileName(), kFALSE, kNPOS, kTRUE, and LocateMethods().

Referenced by Parse().

void TDocParser::LocateMethodsInHeaderInline ( std::ostream &  out  )  [protected]

Definition at line 1864 of file TDocParser.cxx.

References fCurrentClass, fHtml, THtml::GetDeclFileName(), kFALSE, kNPOS, kTRUE, and LocateMethods().

Referenced by Parse().

void TDocParser::LocateMethodsInHeaderClassDecl ( std::ostream &  out  )  [protected]

Definition at line 1897 of file TDocParser.cxx.

References fCurrentClass, fHtml, THtml::GetDeclFileName(), kTRUE, and LocateMethods().

Referenced by Parse().

void TDocParser::LocateMethods ( std::ostream &  out,
const char *  filename,
Bool_t  lookForSourceInfo = kTRUE,
Bool_t  useDocxxStyle = kFALSE,
Bool_t  allowPureVirtual = kFALSE,
const char *  methodPattern = 0,
const char *  sourceExt = 0 
) [protected]

Definition at line 1578 of file TDocParser.cxx.

References AnchorFromLine(), TSystem::BaseName(), TString::CountChar(), TString::Data(), DecorateKeywords(), TObject::Error(), fClassDocState, fComment, fCommentAtBOL, fCurrentClass, fCurrentFile, fDocContext, fDocOutput, fExtraLinesWithAnchor, fFirstClassDoc, fHtml, TString::First(), TDocOutput::FixupAuthorSourceInfo(), fLastClassDoc, fLineComment, fLineNo, fLineNumber, fLineRaw, fLineSource, fLineStripped, fParseContext, fSourceInfo, fSourceInfoTags, THtml::GetImplFileName(), gSystem, InContext(), TString::Index(), kClassDoc_LookingHaveSomething, kClassDoc_LookingNothingFound, kClassDoc_Written, kCode, kComment, kDocClass, kDocFunc, kFALSE, kIgnore, kInfoAuthor, kNPOS, kNumSourceInfos, TString::Length(), LocateMethodInCurrentLine(), TPMERegexp::Match(), name, TDocOutput::NameSpace2FileName(), TSystem::PrependPathName(), ProcessComment(), TString::ReadLine(), TString::Remove(), Strip(), WriteClassDoc(), TDocOutput::WriteHtmlFooter(), TDocOutput::WriteLineNumbers(), WriteMethod(), and WriteSourceLine().

Referenced by LocateMethodsInHeaderClassDecl(), LocateMethodsInHeaderInline(), and LocateMethodsInSource().

Bool_t TDocParser::ProcessComment (  )  [protected, virtual]

Definition at line 1910 of file TDocParser.cxx.

References c, Context(), fClassDescrTag, fClassDocState, fComment, fCommentAtBOL, fDocContext, fLineComment, fLineStripped, InContext(), IsWord(), TString::kBoth, kClassDoc_LookingHaveSomething, kClassDoc_LookingNothingFound, kComment, kCXXComment, kDirective, kDocClass, kFALSE, kIgnore, TString::kIgnoreCase, kNPOS, TString::kTrailing, kTRUE, len, TString::Length(), TString::Strip(), and Strip().

Referenced by Convert(), and LocateMethods().

void TDocParser::RemoveCommentContext ( Bool_t  cxxcomment  )  [protected]

Definition at line 2046 of file TDocParser.cxx.

References fParseContext, kComment, and kCXXComment.

Referenced by DecorateKeywords().

void TDocParser::WriteClassDoc ( std::ostream &  out,
Bool_t  first = kTRUE 
) [protected]

Definition at line 2081 of file TDocParser.cxx.

References fClassDocState, fDocOutput, fFirstClassDoc, fLastClassDoc, kClassDoc_LookingHaveSomething, kClassDoc_LookingNothingFound, kClassDoc_Written, and TString::Length().

Referenced by LocateMethods(), and WriteMethod().

void TDocParser::WriteMethod ( std::ostream &  out,
TString &  ret,
TString &  name,
TString &  params,
Bool_t  isconst,
const char *  file,
TString &  anchor,
TString &  codeOneLiner 
) [protected]

Definition at line 2227 of file TDocParser.cxx.

References access, TList::Add(), DecrementMethodCount(), fClassDocState, fComment, fDocContext, fDocOutput, TList::First(), fMethods, TCollection::GetSize(), TString::kBoth, kClassDoc_Written, TDocMethodWrapper::kDocumented, kIgnore, TString::Length(), MatchOverloadSignatures(), method, name, nparams, params, ParseParameters(), TString::Remove(), TObject::SetBit(), TCollection::SetOwner(), TString::Strip(), and WriteClassDoc().

Referenced by LocateMethods().

void TDocParser::WriteSourceLine ( std::ostream &  out  )  [protected]

Definition at line 2291 of file TDocParser.cxx.

References TDocOutput::AdjustSourcePath(), fDocOutput, and fLineSource.

Referenced by LocateMethodInCurrentLine(), and LocateMethods().

void TDocParser::AnchorFromLine ( const TString &  line,
TString &  anchor 
) [static]

Definition at line 368 of file TDocParser.cxx.

References hash, TObject::Hash(), line, and TString::Remove().

Referenced by G__G__Html_128_0_20(), G__setup_memfuncTDocParser(), LocateMethodInCurrentLine(), LocateMethods(), and TDocOutput::NameSpace2FileName().

void TDocParser::Convert ( std::ostream &  out,
std::istream &  in,
const char *  relpath,
Bool_t  isCode,
Bool_t  interpretDirectives 
)

Definition at line 389 of file TDocParser.cxx.

References TDocOutput::AdjustSourcePath(), DecorateKeywords(), fLineComment, fLineNumber, fLineRaw, fLineSource, fLineStripped, fParseContext, GetDocOutput(), InContext(), kCode, kComment, kDirective, kFALSE, TString::Length(), ProcessComment(), TString::ReadLine(), and Strip().

Referenced by TDocOutput::Convert(), TDocMacroDirective::GetResult(), and TDocOutput::ProcessDocInDir().

void TDocParser::DecrementMethodCount ( const char *  name  ) 

Definition at line 855 of file TDocParser.cxx.

References fMethodCounts.

Referenced by WriteMethod().

void TDocParser::DecorateKeywords ( std::ostream &  out,
const char *  text 
) [virtual]

Definition at line 438 of file TDocParser.cxx.

References str.

Referenced by Convert(), TDocOutput::CreateClassTypeDefs(), TClassDocOutput::ListDataMembers(), TClassDocOutput::ListFunctions(), LocateMethodInCurrentLine(), LocateMethods(), TClassDocOutput::WriteClassDescription(), and TClassDocOutput::WriteMethod().

void TDocParser::DecorateKeywords ( TString &  text  )  [virtual]

Definition at line 447 of file TDocParser.cxx.

References TString::BeginsWith(), xmlio::Class, Context(), TString::Data(), TDocOutput::DecorateEntityBegin(), TDocOutput::DecorateEntityEnd(), ExpandCPPLine(), fCommentAtBOL, fCurrentClass, fDirectiveHandlers, fDocOutput, fgKeywords, fHtml, fLineComment, fLineRaw, fParseContext, fRecentClass, THtml::GetClass(), TClass::GetDataMember(), TROOT::GetGlobal(), TClass::GetMethodAllAny(), TFunction::GetReturnTypeName(), TROOT::GetType(), TGlobal::GetTypeName(), gROOT, HandleDirective(), i, InContext(), IsName(), IsWord(), kCode, kComment, kCPP, kCXXComment, kDirective, kFALSE, TString::kIgnoreCase, kKeyword, kNPOS, kString, kTRUE, TList::Last(), TSubString::Length(), TString::Length(), line, TDocOutput::ReferenceEntity(), TString::Remove(), RemoveCommentContext(), TDocOutput::ReplaceSpecialChars(), start, and TObject::Warning().

void TDocParser::DeleteDirectiveOutput (  )  const [virtual]

Definition at line 870 of file TDocParser.cxx.

References xmlio::Class, TROOT::GetListOfClasses(), and gROOT.

Referenced by Parse().

const TList* TDocParser::GetMethods ( EAccess  access  )  const [inline]

Definition at line 179 of file TDocParser.h.

References fMethods.

Referenced by TClassDocOutput::ListFunctions().

TClass* TDocParser::GetCurrentClass (  )  const [inline]

Definition at line 180 of file TDocParser.h.

References fCurrentClass.

Referenced by TDocDirective::GetName().

void TDocParser::GetCurrentModule ( TString &  out_module  )  const

Definition at line 954 of file TDocParser.cxx.

References fCurrentClass, fCurrentModule, fHtml, and THtml::GetModuleNameForClass().

Referenced by TDocMacroDirective::GetResult().

TDocOutput* TDocParser::GetDocOutput (  )  const [inline]

Definition at line 182 of file TDocParser.h.

References fDocOutput.

Referenced by Convert(), and TDocDirective::SetParser().

Long_t TDocParser::GetLineNumber (  )  const [inline]

Definition at line 183 of file TDocParser.h.

References fLineNumber.

Referenced by TDocOutput::Convert().

const TList* TDocParser::GetDataMembers ( EAccess  access  )  const [inline]

Definition at line 184 of file TDocParser.h.

References fDataMembers.

Referenced by TClassDocOutput::ListDataMembers().

const TList* TDocParser::GetEnums ( EAccess  access  )  const [inline]

Definition at line 185 of file TDocParser.h.

References fDataMembers.

Referenced by TClassDocOutput::ListDataMembers().

const char* TDocParser::GetSourceInfo ( ESourceInfo  type  )  const [inline]

Definition at line 186 of file TDocParser.h.

References fSourceInfo.

Referenced by TClassDocOutput::Class2Html().

void TDocParser::SetCurrentModule ( const char *  module  )  [inline]

Definition at line 187 of file TDocParser.h.

References fCurrentModule.

UInt_t TDocParser::InContext ( Int_t  context  )  const

Definition at line 1141 of file TDocParser.cxx.

References fParseContext, kParseContextFlagMask, and kParseContextMask.

Referenced by Convert(), DecorateKeywords(), HandleDirective(), LocateMethods(), and ProcessComment().

Bool_t TDocParser::IsName ( UChar_t  c  )  [static]

Definition at line 1278 of file TDocParser.cxx.

References kFALSE, and kTRUE.

Referenced by DecorateKeywords(), G__G__Html_128_0_36(), G__setup_memfuncTDocParser(), and LocateMethodInCurrentLine().

Bool_t TDocParser::IsWord ( UChar_t  c  )  [static]

Definition at line 1301 of file TDocParser.cxx.

References kFALSE, and kTRUE.

Referenced by DecorateKeywords(), G__G__Html_128_0_37(), G__setup_memfuncTDocParser(), LocateMethodInCurrentLine(), and ProcessComment().

void TDocParser::Parse ( std::ostream &  out  )  [virtual]

Definition at line 1557 of file TDocParser.cxx.

References TDatime::AsString(), DeleteDirectiveOutput(), fClassDocState, fSourceInfo, kClassDoc_LookingNothingFound, kInfoLastUpdate, LocateMethodsInHeaderClassDecl(), LocateMethodsInHeaderInline(), and LocateMethodsInSource().

Referenced by TClassDocOutput::Class2Html().

Bool_t TDocParser::Strip ( TString &  s  )  [static]

Definition at line 2061 of file TDocParser.cxx.

References i, kFALSE, kTRUE, and str.

Referenced by TDocLatexDirective::AddLine(), Convert(), G__G__Html_128_0_39(), G__setup_memfuncTDocParser(), LocateMethodInCurrentLine(), LocateMethods(), and ProcessComment().

TDocParser::ClassDef ( TDocParser  ,
0   
)

void TDocParser::AddClassMethodsRecursively ( TBaseClass *  bc  )  [protected]

void TDocParser::AddClassDataMembersRecursively ( TBaseClass *  bc  )  [protected]

EParseContext TDocParser::Context (  )  const [inline, protected]

Definition at line 138 of file TDocParser.h.

References fParseContext, kComment, and kParseContextMask.

virtual void TDocParser::ExpandCPPLine ( TString &  line,
Ssiz_t &  pos 
) [protected, virtual]

virtual Bool_t TDocParser::HandleDirective ( TString &  keyword,
Ssiz_t &  pos,
TString &  word,
Ssiz_t &  copiedToCommentUpTo 
) [protected, virtual]

virtual void TDocParser::InitKeywords (  )  const [protected, virtual]

virtual TClass* TDocParser::IsDirective ( const TString &  line,
Ssiz_t  pos,
const TString &  word,
Bool_t &  begin 
) const [protected, virtual]

TMethod* TDocParser::LocateMethodInCurrentLine ( Ssiz_t &  posMethodName,
TString &  ret,
TString &  name,
TString &  params,
Bool_t &  isconst,
std::ostream &  srcOut,
TString &  anchor,
std::ifstream &  sourcefile,
Bool_t  allowPureVirtual 
) [protected]

void TDocParser::LocateMethodsInSource ( std::ostream &  out  )  [protected]

void TDocParser::LocateMethodsInHeaderInline ( std::ostream &  out  )  [protected]

void TDocParser::LocateMethodsInHeaderClassDecl ( std::ostream &  out  )  [protected]

void TDocParser::LocateMethods ( std::ostream &  out,
const char *  filename,
Bool_t  lookForSourceInfo = kTRUE,
Bool_t  useDocxxStyle = kFALSE,
Bool_t  allowPureVirtual = kFALSE,
const char *  methodPattern = 0,
const char *  sourceExt = 0 
) [protected]

virtual Bool_t TDocParser::ProcessComment (  )  [protected, virtual]

void TDocParser::RemoveCommentContext ( Bool_t  cxxcomment  )  [protected]

void TDocParser::WriteClassDoc ( std::ostream &  out,
Bool_t  first = kTRUE 
) [protected]

void TDocParser::WriteMethod ( std::ostream &  out,
TString &  ret,
TString &  name,
TString &  params,
Bool_t  isconst,
const char *  file,
TString &  anchor,
TString &  codeOneLiner 
) [protected]

void TDocParser::WriteSourceLine ( std::ostream &  out  )  [protected]

static void TDocParser::AnchorFromLine ( const TString &  line,
TString &  anchor 
) [static]

void TDocParser::Convert ( std::ostream &  out,
std::istream &  in,
const char *  relpath,
Bool_t  isCode,
Bool_t  interpretDirectives 
)

void TDocParser::DecrementMethodCount ( const char *  name  ) 

virtual void TDocParser::DecorateKeywords ( std::ostream &  out,
const char *  text 
) [virtual]

virtual void TDocParser::DecorateKeywords ( TString &  text  )  [virtual]

virtual void TDocParser::DeleteDirectiveOutput (  )  const [virtual]

const TList* TDocParser::GetMethods ( EAccess  access  )  const [inline]

Definition at line 179 of file TDocParser.h.

References fMethods.

TClass* TDocParser::GetCurrentClass (  )  const [inline]

Definition at line 180 of file TDocParser.h.

References fCurrentClass.

void TDocParser::GetCurrentModule ( TString &  out_module  )  const

TDocOutput* TDocParser::GetDocOutput (  )  const [inline]

Definition at line 182 of file TDocParser.h.

References fDocOutput.

Long_t TDocParser::GetLineNumber (  )  const [inline]

Definition at line 183 of file TDocParser.h.

References fLineNumber.

const TList* TDocParser::GetDataMembers ( EAccess  access  )  const [inline]

Definition at line 184 of file TDocParser.h.

References fDataMembers.

const TList* TDocParser::GetEnums ( EAccess  access  )  const [inline]

Definition at line 185 of file TDocParser.h.

References fDataMembers.

const char* TDocParser::GetSourceInfo ( ESourceInfo  type  )  const [inline]

Definition at line 186 of file TDocParser.h.

References fSourceInfo.

void TDocParser::SetCurrentModule ( const char *  module  )  [inline]

Definition at line 187 of file TDocParser.h.

References fCurrentModule.

UInt_t TDocParser::InContext ( Int_t  context  )  const

static Bool_t TDocParser::IsName ( UChar_t  c  )  [static]

static Bool_t TDocParser::IsWord ( UChar_t  c  )  [static]

virtual void TDocParser::Parse ( std::ostream &  out  )  [virtual]

static Bool_t TDocParser::Strip ( TString &  s  )  [static]

TDocParser::ClassDef ( TDocParser  ,
0   
)

Member Data Documentation

THtml* TDocParser::fHtml [protected]

Definition at line 95 of file TDocParser.h.

Referenced by DecorateKeywords(), ExpandCPPLine(), GetCurrentModule(), LocateMethods(), LocateMethodsInHeaderClassDecl(), LocateMethodsInHeaderInline(), LocateMethodsInSource(), and TDocParser().

TDocOutput* TDocParser::fDocOutput [protected]

Definition at line 96 of file TDocParser.h.

Referenced by DecorateKeywords(), ExpandCPPLine(), GetDocOutput(), HandleDirective(), LocateMethods(), WriteClassDoc(), WriteMethod(), and WriteSourceLine().

UInt_t TDocParser::fLineNo [protected]

Definition at line 97 of file TDocParser.h.

Referenced by IsDirective(), and LocateMethods().

TString TDocParser::fLineRaw [protected]

Definition at line 98 of file TDocParser.h.

Referenced by Convert(), DecorateKeywords(), HandleDirective(), LocateMethodInCurrentLine(), and LocateMethods().

TString TDocParser::fLineStripped [protected]

Definition at line 99 of file TDocParser.h.

Referenced by Convert(), LocateMethodInCurrentLine(), LocateMethods(), and ProcessComment().

TString TDocParser::fLineComment [protected]

Definition at line 100 of file TDocParser.h.

Referenced by Convert(), DecorateKeywords(), HandleDirective(), LocateMethods(), and ProcessComment().

TString TDocParser::fLineSource [protected]

Definition at line 101 of file TDocParser.h.

Referenced by Convert(), HandleDirective(), LocateMethodInCurrentLine(), LocateMethods(), and WriteSourceLine().

TString TDocParser::fComment [protected]

Definition at line 102 of file TDocParser.h.

Referenced by LocateMethods(), ProcessComment(), and WriteMethod().

TString TDocParser::fFirstClassDoc [protected]

Definition at line 103 of file TDocParser.h.

Referenced by LocateMethods(), and WriteClassDoc().

TString TDocParser::fLastClassDoc [protected]

Definition at line 104 of file TDocParser.h.

Referenced by LocateMethods(), and WriteClassDoc().

TClass* TDocParser::fCurrentClass [protected]

Definition at line 105 of file TDocParser.h.

Referenced by AddClassDataMembersRecursively(), AddClassMethodsRecursively(), DecorateKeywords(), GetCurrentClass(), GetCurrentModule(), LocateMethodInCurrentLine(), LocateMethods(), LocateMethodsInHeaderClassDecl(), LocateMethodsInHeaderInline(), LocateMethodsInSource(), TDocParser(), and ~TDocParser().

TClass* TDocParser::fRecentClass [protected]

Definition at line 106 of file TDocParser.h.

Referenced by DecorateKeywords().

TString TDocParser::fCurrentModule [protected]

Definition at line 107 of file TDocParser.h.

Referenced by GetCurrentModule(), and SetCurrentModule().

TString TDocParser::fCurrentMethodTag [protected]

Definition at line 108 of file TDocParser.h.

Referenced by HandleDirective(), and LocateMethodInCurrentLine().

Int_t TDocParser::fDirectiveCount [protected]

Definition at line 109 of file TDocParser.h.

Referenced by HandleDirective(), and LocateMethodInCurrentLine().

Long_t TDocParser::fLineNumber [protected]

Definition at line 110 of file TDocParser.h.

Referenced by Convert(), GetLineNumber(), LocateMethodInCurrentLine(), and LocateMethods().

TString TDocParser::fCurrentFile [protected]

Definition at line 111 of file TDocParser.h.

Referenced by LocateMethods().

std::map<std::string , Int_t > TDocParser::fMethodCounts [protected]

Definition at line 112 of file TDocParser.h.

Referenced by DecrementMethodCount(), LocateMethodInCurrentLine(), TDocParser(), and ~TDocParser().

EDocContext TDocParser::fDocContext [protected]

Definition at line 113 of file TDocParser.h.

Referenced by LocateMethods(), ProcessComment(), and WriteMethod().

std::list<UInt_t> TDocParser::fParseContext [protected]

Definition at line 114 of file TDocParser.h.

Referenced by Context(), Convert(), DecorateKeywords(), HandleDirective(), InContext(), LocateMethods(), RemoveCommentContext(), and TDocParser().

Bool_t TDocParser::fCheckForMethod [protected]

Definition at line 115 of file TDocParser.h.

enum { ... } TDocParser::fClassDocState [protected]

Referenced by LocateMethods(), Parse(), ProcessComment(), WriteClassDoc(), and WriteMethod().

Bool_t TDocParser::fCommentAtBOL [protected]

Definition at line 124 of file TDocParser.h.

Referenced by DecorateKeywords(), LocateMethodInCurrentLine(), LocateMethods(), and ProcessComment().

TString TDocParser::fClassDescrTag [protected]

Definition at line 125 of file TDocParser.h.

Referenced by ProcessComment(), and TDocParser().

TString TDocParser::fSourceInfoTags [protected]

Definition at line 126 of file TDocParser.h.

Referenced by LocateMethods(), and TDocParser().

TList TDocParser::fDirectiveHandlers [protected]

Definition at line 127 of file TDocParser.h.

Referenced by DecorateKeywords(), HandleDirective(), and ~TDocParser().

Bool_t TDocParser::fAllowDirectives [protected]

Definition at line 128 of file TDocParser.h.

std::set<UInt_t> TDocParser::fExtraLinesWithAnchor [protected]

Definition at line 129 of file TDocParser.h.

Referenced by LocateMethods().

TString TDocParser::fSourceInfo [protected]

Definition at line 130 of file TDocParser.h.

Referenced by GetSourceInfo(), LocateMethods(), and Parse().

THashList TDocParser::fMethods [protected]

Definition at line 131 of file TDocParser.h.

Referenced by AddClassMethodsRecursively(), GetMethods(), TDocParser(), and WriteMethod().

TList TDocParser::fDataMembers [protected]

Definition at line 132 of file TDocParser.h.

Referenced by AddClassDataMembersRecursively(), GetDataMembers(), and GetEnums().

std::set< std::string > TDocParser::fgKeywords [static, protected]

Definition at line 134 of file TDocParser.h.

Referenced by DecorateKeywords(), and InitKeywords().

THtml* TDocParser::fHtml [protected]

Definition at line 95 of file TDocParser.h.

TDocOutput* TDocParser::fDocOutput [protected]

Definition at line 96 of file TDocParser.h.

TClass* TDocParser::fCurrentClass [protected]

Definition at line 105 of file TDocParser.h.

TClass* TDocParser::fRecentClass [protected]

Definition at line 106 of file TDocParser.h.

std::map<std::string , Int_t > TDocParser::fMethodCounts [protected]

Definition at line 112 of file TDocParser.h.

std::list<UInt_t> TDocParser::fParseContext [protected]

Definition at line 114 of file TDocParser.h.

enum { ... } TDocParser::fClassDocState [protected]

std::set<UInt_t> TDocParser::fExtraLinesWithAnchor [protected]

Definition at line 129 of file TDocParser.h.

std::set<std::string> TDocParser::fgKeywords [static, protected]

Definition at line 134 of file TDocParser.h.

The documentation for this class was generated from the following files:
Generated on Tue Jul 5 16:36:14 2011 for ROOT_528-00b_version by  doxygen 1.5.1