TagFileParser Class Reference

List of all members.

Public Member Functions

 TagFileParser (const char *tagName)
void setDocumentLocator (QXmlLocator *locator)
void setFileName (const QString &fileName)
void warn (const char *fmt)
void warn (const char *fmt, const char *s)
void startCompound (const QXmlAttributes &attrib)
void endCompound ()
void startMember (const QXmlAttributes &attrib)
void endMember ()
void endDocAnchor ()
void endClass ()
void endNamespace ()
void endFile ()
void endPage ()
void endDir ()
void startStringValue (const QXmlAttributes &)
void startDocAnchor (const QXmlAttributes &attrib)
void endType ()
void endName ()
void startBase (const QXmlAttributes &attrib)
void endBase ()
void startIncludes (const QXmlAttributes &attrib)
void endIncludes ()
void endTemplateArg ()
void endFilename ()
void endPath ()
void endAnchor ()
void endAnchorFile ()
void endArglist ()
void endTitle ()
void endSubgroup ()
void startIgnoreElement (const QXmlAttributes &)
void endIgnoreElement ()
bool startDocument ()
bool startElement (const QString &, const QString &, const QString &name, const QXmlAttributes &attrib)
bool endElement (const QString &, const QString &, const QString &name)
bool characters (const QString &ch)
void dump ()
void buildLists (Entry *root)
void addIncludes ()

Classes

class  EndElementHandler
class  StartElementHandler

Detailed Description

Tag file parser. Reads an XML-structured tagfile and builds up the structure in memory. The method buildLists() is used to transfer/translate the structures to the doxygen engine.

Definition at line 186 of file tagreader.cpp.


Constructor & Destructor Documentation

TagFileParser::TagFileParser ( const char *  tagName  )  [inline]

Definition at line 222 of file tagreader.cpp.


Member Function Documentation

void TagFileParser::setDocumentLocator ( QXmlLocator *  locator  )  [inline]

Definition at line 230 of file tagreader.cpp.

void TagFileParser::setFileName ( const QString &  fileName  )  [inline]

Definition at line 235 of file tagreader.cpp.

Referenced by parseTagFile().

void TagFileParser::warn ( const char *  fmt  )  [inline]

Definition at line 240 of file tagreader.cpp.

Referenced by endAnchor(), endAnchorFile(), endArglist(), endBase(), endClass(), endCompound(), endDir(), endDocAnchor(), endElement(), endFile(), endFilename(), endMember(), endName(), endNamespace(), endPage(), endPath(), endSubgroup(), endTemplateArg(), endTitle(), endType(), startBase(), startCompound(), startElement(), startIncludes(), and warn().

void TagFileParser::warn ( const char *  fmt,
const char *  s 
) [inline]

Definition at line 244 of file tagreader.cpp.

References warn().

void TagFileParser::startCompound ( const QXmlAttributes &  attrib  )  [inline]

Definition at line 249 of file tagreader.cpp.

References TagClassInfo::Category, TagClassInfo::Class, TagClassInfo::Exception, TagClassInfo::Interface, TagClassInfo::isObjC, TagClassInfo::kind, TagClassInfo::Protocol, TagClassInfo::Struct, TagClassInfo::Union, and warn().

Referenced by startDocument().

void TagFileParser::endCompound (  )  [inline]

Definition at line 336 of file tagreader.cpp.

References warn().

Referenced by startDocument().

void TagFileParser::startMember ( const QXmlAttributes &  attrib  )  [inline]

Definition at line 359 of file tagreader.cpp.

References TagMemberInfo::isStatic, TagMemberInfo::kind, Private, TagMemberInfo::prot, Protected, Pure, TagMemberInfo::virt, and Virtual.

Referenced by startDocument().

void TagFileParser::endMember (  )  [inline]

Definition at line 390 of file tagreader.cpp.

References TagPackageInfo::members, TagGroupInfo::members, TagNamespaceInfo::members, TagFileInfo::members, TagClassInfo::members, and warn().

Referenced by startDocument().

void TagFileParser::endDocAnchor (  )  [inline]

Definition at line 405 of file tagreader.cpp.

References TagDirInfo::docAnchors, TagPackageInfo::docAnchors, TagMemberInfo::docAnchors, TagPageInfo::docAnchors, TagGroupInfo::docAnchors, TagNamespaceInfo::docAnchors, TagFileInfo::docAnchors, TagClassInfo::docAnchors, and warn().

Referenced by startDocument().

void TagFileParser::endClass (  )  [inline]

Definition at line 421 of file tagreader.cpp.

References TagPackageInfo::classList, TagGroupInfo::classList, TagNamespaceInfo::classList, TagFileInfo::classList, TagClassInfo::classList, and warn().

Referenced by startDocument().

void TagFileParser::endNamespace (  )  [inline]

Definition at line 434 of file tagreader.cpp.

References TagNamespaceInfo::classList, TagGroupInfo::namespaceList, TagFileInfo::namespaceList, and warn().

Referenced by startDocument().

void TagFileParser::endFile (  )  [inline]

Definition at line 445 of file tagreader.cpp.

References TagDirInfo::fileList, TagGroupInfo::fileList, and warn().

Referenced by startDocument().

void TagFileParser::endPage (  )  [inline]

Definition at line 455 of file tagreader.cpp.

References TagGroupInfo::fileList, and warn().

Referenced by startDocument().

void TagFileParser::endDir (  )  [inline]

Definition at line 464 of file tagreader.cpp.

References TagDirInfo::subdirList, and warn().

Referenced by startDocument().

void TagFileParser::startStringValue ( const QXmlAttributes &   )  [inline]

Definition at line 473 of file tagreader.cpp.

Referenced by startDocument().

void TagFileParser::startDocAnchor ( const QXmlAttributes &  attrib  )  [inline]

Definition at line 478 of file tagreader.cpp.

Referenced by startDocument().

void TagFileParser::endType (  )  [inline]

Definition at line 484 of file tagreader.cpp.

References TagMemberInfo::type, and warn().

Referenced by startDocument().

void TagFileParser::endName (  )  [inline]

Definition at line 496 of file tagreader.cpp.

References TagPackageInfo::name, TagMemberInfo::name, TagDirInfo::name, TagPageInfo::name, TagGroupInfo::name, TagNamespaceInfo::name, TagFileInfo::name, TagClassInfo::name, and warn().

Referenced by startDocument().

void TagFileParser::startBase ( const QXmlAttributes &  attrib  )  [inline]

Definition at line 512 of file tagreader.cpp.

References TagClassInfo::bases, Normal, Private, Protected, Public, Virtual, and warn().

Referenced by startDocument().

void TagFileParser::endBase (  )  [inline]

Definition at line 546 of file tagreader.cpp.

References TagClassInfo::bases, and warn().

Referenced by startDocument().

void TagFileParser::startIncludes ( const QXmlAttributes &  attrib  )  [inline]

Definition at line 558 of file tagreader.cpp.

References TagIncludeInfo::id, TagFileInfo::includes, TagIncludeInfo::isImported, TagIncludeInfo::isLocal, TagIncludeInfo::name, and warn().

Referenced by startDocument().

void TagFileParser::endIncludes (  )  [inline]

Definition at line 576 of file tagreader.cpp.

References TagIncludeInfo::text.

Referenced by startDocument().

void TagFileParser::endTemplateArg (  )  [inline]

Definition at line 581 of file tagreader.cpp.

References TagClassInfo::templateArguments, and warn().

Referenced by startDocument().

void TagFileParser::endFilename (  )  [inline]

Definition at line 598 of file tagreader.cpp.

References TagDirInfo::filename, TagPackageInfo::filename, TagPageInfo::filename, TagGroupInfo::filename, TagFileInfo::filename, TagNamespaceInfo::filename, TagClassInfo::filename, and warn().

Referenced by startDocument().

void TagFileParser::endPath (  )  [inline]

Definition at line 613 of file tagreader.cpp.

References TagDirInfo::path, TagFileInfo::path, and warn().

Referenced by startDocument().

void TagFileParser::endAnchor (  )  [inline]

Definition at line 623 of file tagreader.cpp.

References TagMemberInfo::anchor, and warn().

Referenced by startDocument().

void TagFileParser::endAnchorFile (  )  [inline]

Definition at line 635 of file tagreader.cpp.

References TagMemberInfo::anchorFile, and warn().

Referenced by startDocument().

void TagFileParser::endArglist (  )  [inline]

Definition at line 647 of file tagreader.cpp.

References TagMemberInfo::arglist, and warn().

Referenced by startDocument().

void TagFileParser::endTitle (  )  [inline]

Definition at line 658 of file tagreader.cpp.

References TagPageInfo::title, TagGroupInfo::title, and warn().

Referenced by startDocument().

void TagFileParser::endSubgroup (  )  [inline]

Definition at line 668 of file tagreader.cpp.

References TagGroupInfo::subgroupList, and warn().

Referenced by startDocument().

void TagFileParser::startIgnoreElement ( const QXmlAttributes &   )  [inline]

Definition at line 680 of file tagreader.cpp.

Referenced by startDocument().

void TagFileParser::endIgnoreElement (  )  [inline]

Definition at line 684 of file tagreader.cpp.

Referenced by startDocument().

bool TagFileParser::startDocument (  )  [inline]

Definition at line 688 of file tagreader.cpp.

References endAnchor(), endAnchorFile(), endArglist(), endBase(), endClass(), endCompound(), endDir(), endDocAnchor(), endFile(), endFilename(), endIgnoreElement(), endIncludes(), endMember(), endName(), endNamespace(), endPage(), endPath(), endSubgroup(), endTemplateArg(), endTitle(), endType(), startBase(), startCompound(), startDocAnchor(), startIgnoreElement(), startIncludes(), startMember(), and startStringValue().

bool TagFileParser::startElement ( const QString &  ,
const QString &  ,
const QString &  name,
const QXmlAttributes &  attrib 
) [inline]

Definition at line 756 of file tagreader.cpp.

References warn().

bool TagFileParser::endElement ( const QString &  ,
const QString &  ,
const QString &  name 
) [inline]

Definition at line 772 of file tagreader.cpp.

References warn().

bool TagFileParser::characters ( const QString &  ch  )  [inline]

Definition at line 787 of file tagreader.cpp.

void TagFileParser::dump (  ) 

Dumps the internal structures. For debugging only!

Definition at line 856 of file tagreader.cpp.

References TagMemberInfo::anchor, TagMemberInfo::arglist, TagClassInfo::bases, TagGroupInfo::classList, TagFileInfo::classList, TagNamespaceInfo::classList, TagDirInfo::fileList, TagGroupInfo::fileList, TagPageInfo::filename, TagGroupInfo::filename, TagFileInfo::filename, TagNamespaceInfo::filename, TagClassInfo::filename, TagIncludeInfo::id, TagFileInfo::includes, TagMemberInfo::kind, TagGroupInfo::members, TagFileInfo::members, TagNamespaceInfo::members, TagClassInfo::members, msg(), TagDirInfo::name, TagPageInfo::name, TagGroupInfo::name, TagIncludeInfo::name, TagFileInfo::name, TagNamespaceInfo::name, TagMemberInfo::name, BaseInfo::name, TagClassInfo::name, TagGroupInfo::namespaceList, TagFileInfo::namespaceList, TagGroupInfo::pageList, TagDirInfo::path, TagDirInfo::subdirList, TagGroupInfo::subgroupList, and TagPageInfo::title.

void TagFileParser::buildLists ( Entry root  ) 

Injects the info gathered by the XML parser into the Entry tree. This tree contains the information extracted from the input in a "unrelated" form.

Definition at line 1166 of file tagreader.cpp.

References Entry::addSubEntry(), Entry::args, TagClassInfo::bases, Entry::Category, TagClassInfo::Category, TagClassInfo::Class, Entry::CLASS_SEC, TagPageInfo::docAnchors, TagGroupInfo::docAnchors, TagPackageInfo::docAnchors, TagNamespaceInfo::docAnchors, TagFileInfo::docAnchors, TagClassInfo::docAnchors, Entry::Exception, TagClassInfo::Exception, Entry::extends, TagPageInfo::filename, TagGroupInfo::filename, TagPackageInfo::filename, TagNamespaceInfo::filename, Entry::fileName, TagFileInfo::filename, TagClassInfo::filename, TagInfo::fileName, Entry::GROUPDOC_SEC, guessSection(), Doxygen::inputNameDict, Doxygen::inputNameList, Entry::Interface, TagClassInfo::Interface, TagClassInfo::isObjC, TagClassInfo::kind, TagGroupInfo::members, TagPackageInfo::members, TagNamespaceInfo::members, TagFileInfo::members, TagClassInfo::members, TagPageInfo::name, TagGroupInfo::name, TagPackageInfo::name, TagNamespaceInfo::name, TagFileInfo::name, TagClassInfo::name, Entry::name, Entry::NAMESPACE_SEC, Entry::objc, Entry::PACKAGE_SEC, Entry::PAGEDOC_SEC, TagFileInfo::path, Entry::Protocol, TagClassInfo::Protocol, Entry::section, Entry::spec, Entry::Struct, TagClassInfo::Struct, Entry::tagInfo, TagInfo::tagName, Entry::tArgLists, TagClassInfo::templateArguments, TagPageInfo::title, TagGroupInfo::title, Entry::type, Entry::Union, and TagClassInfo::Union.

Referenced by parseTagFile().

void TagFileParser::addIncludes (  ) 

Definition at line 1337 of file tagreader.cpp.

References FileDef::addIncludeDependency(), FileDef::getOutputFileBase(), FileDef::getPath(), TagIncludeInfo::id, TagFileInfo::includes, Doxygen::inputNameDict, TagIncludeInfo::isImported, TagIncludeInfo::isLocal, TagIncludeInfo::name, TagFileInfo::name, TagFileInfo::path, QCString, and TagIncludeInfo::text.

Referenced by parseTagFile().


The documentation for this class was generated from the following file:



Generated on Mon Mar 31 10:59:03 2008 by  doxygen 1.5.1