The TagFileParser
Class Reference
Tag file parser. More...
Declaration
Enumerations Index
enum | State { ... } |
Public Constructors Index
TagFileParser (const char *tagName) | |
Public Member Functions Index
void | setDocumentLocator (const XMLLocator *locator) |
void | startDocument () |
void | startElement (const QCString &name, const XMLHandlers::Attributes &attrib) |
void | endElement (const QCString &name) |
void | characters (const QCString &ch) |
void | error (const QCString &fileName, int lineNr, const QCString &msg) |
void | dump () |
void | buildLists (const std::shared_ptr< Entry > &root) |
void | addIncludes () |
void | startCompound (const XMLHandlers::Attributes &attrib) |
void | endCompound () |
void | startMember (const XMLHandlers::Attributes &attrib) |
void | endMember () |
void | startEnumValue (const XMLHandlers::Attributes &attrib) |
void | endEnumValue () |
void | endDocAnchor () |
void | endClass () |
void | endConcept () |
void | endModule () |
void | endNamespace () |
void | endFile () |
void | endPage () |
void | endSubpage () |
void | endDir () |
void | startStringValue (const XMLHandlers::Attributes &) |
void | startDocAnchor (const XMLHandlers::Attributes &attrib) |
void | endType () |
void | endName () |
void | startBase (const XMLHandlers::Attributes &attrib) |
void | endBase () |
void | startIncludes (const XMLHandlers::Attributes &attrib) |
void | endIncludes () |
void | endTemplateArg () |
void | endFilename () |
void | endPath () |
void | endAnchor () |
void | endClangId () |
void | endAnchorFile () |
void | endArglist () |
void | endTitle () |
void | endSubgroup () |
void | startIgnoreElement (const XMLHandlers::Attributes &) |
void | endIgnoreElement () |
void | buildMemberList (const std::shared_ptr< Entry > &ce, const std::vector< TagMemberInfo > &members) |
void | addDocAnchors (const std::shared_ptr< Entry > &e, const std::vector< TagAnchorInfo > &l) |
Private Member Functions Index
void | buildClassEntry (const std::shared_ptr< Entry > &root, const TagClassInfo *tci) |
void | buildClassTree (const std::shared_ptr< Entry > &root, const ClassNode &node) |
Private Member Attributes Index
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 328 of file tagreader.cpp.
Enumerations
State
|
- Enumeration values
-
Invalid InClass InConcept InFile InNamespace InGroup InPage InMember InEnumValue InPackage InDir InModule InTempArgList
Definition at line 989 of file tagreader.cpp.
Public Constructors
TagFileParser()
| inline explicit |
Definition at line 336 of file tagreader.cpp.
Reference m_tagName.
Referenced by parseTagFile.
Public Member Functions
addDocAnchors()
|
Definition at line 986 of file tagreader.cpp.
References SectionManager::add, SectionType::Anchor, SectionManager::instance, m_tagName and SectionManager::replace.
Referenced by buildClassEntry, buildLists and buildMemberList.
addIncludes()
|
Definition at line 358 of file tagreader.cpp.
References ASSERT, ImportLocal, ImportModule, ImportSystem, IncludeLocal, anonymous{tagreader.cpp}::TagFileInfo::includes, IncludeSystem, Doxygen::inputNameLinkedMap, m_tagFileCompounds, m_tagName, anonymous{tagreader.cpp}::TagCompoundInfo::name and anonymous{tagreader.cpp}::TagFileInfo::path.
buildLists()
|
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 357 of file tagreader.cpp.
References SectionManager::add, addDocAnchors, DefinitionMutable::addSectionsToDefinition, SectionType::Anchor, buildClassTree, buildMemberList, anonymous{tagreader.cpp}::TagFileParser::ClassNode::children, anonymous{tagreader.cpp}::TagConceptInfo::clangId, anonymous{tagreader.cpp}::TagModuleInfo::clangId, anonymous{tagreader.cpp}::TagNamespaceInfo::clangId, createFileDef, anonymous{tagreader.cpp}::TagCompoundInfo::docAnchors, anonymous{tagreader.cpp}::TagCompoundInfo::filename, getFileNameExtension, Grouping::GROUPING_INGROUP, guessSection, Doxygen::inputNameLinkedMap, ModuleManager::instance, SectionManager::instance, anonymous{tagreader.cpp}::TagCompoundInfo::lineNr, m_tagFileCompounds, m_tagName, anonymous{tagreader.cpp}::TagCompoundInfo::members, anonymous{tagreader.cpp}::TagCompoundInfo::name, p_warn, anonymous{tagreader.cpp}::TagFileInfo::path, split, QCString::str, stripExtension, stripExtensionGeneral, stripPath, anonymous{tagreader.cpp}::TagGroupInfo::subgroupList, anonymous{tagreader.cpp}::TagPageInfo::subpages, anonymous{tagreader.cpp}::TagFileParser::ClassNode::tci, anonymous{tagreader.cpp}::TagGroupInfo::title, anonymous{tagreader.cpp}::TagPageInfo::title and TRUE.
buildMemberList()
|
Definition at line 985 of file tagreader.cpp.
References addDocAnchors, Grouping::GROUPING_INGROUP, m_tagName, stringToArgumentList and TRUE.
Referenced by buildClassEntry and buildLists.
characters()
| inline |
Definition at line 350 of file tagreader.cpp.
Reference m_curString.
dump()
|
Dumps the internal structures. For debugging only!
Definition at line 356 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::bases, anonymous{tagreader.cpp}::TagCompoundVariant::Class, anonymous{tagreader.cpp}::TagFileInfo::classList, anonymous{tagreader.cpp}::TagGroupInfo::classList, anonymous{tagreader.cpp}::TagNamespaceInfo::classList, anonymous{tagreader.cpp}::TagCompoundVariant::Concept, anonymous{tagreader.cpp}::TagCompoundVariant::Dir, anonymous{tagreader.cpp}::TagCompoundVariant::File, anonymous{tagreader.cpp}::TagDirInfo::fileList, anonymous{tagreader.cpp}::TagGroupInfo::fileList, anonymous{tagreader.cpp}::TagCompoundInfo::filename, anonymous{tagreader.cpp}::TagCompoundVariant::Group, anonymous{tagreader.cpp}::TagFileInfo::includes, m_tagFileCompounds, anonymous{tagreader.cpp}::TagCompoundInfo::members, anonymous{tagreader.cpp}::TagCompoundVariant::Module, anonymous{tagreader.cpp}::TagCompoundInfo::name, BaseInfo::name, anonymous{tagreader.cpp}::TagCompoundVariant::Namespace, anonymous{tagreader.cpp}::TagFileInfo::namespaceList, anonymous{tagreader.cpp}::TagGroupInfo::namespaceList, anonymous{tagreader.cpp}::TagCompoundVariant::Page, anonymous{tagreader.cpp}::TagGroupInfo::pageList, anonymous{tagreader.cpp}::TagDirInfo::path, Debug::print, anonymous{tagreader.cpp}::TagDirInfo::subdirList, anonymous{tagreader.cpp}::TagGroupInfo::subgroupList, Debug::Tag and anonymous{tagreader.cpp}::TagPageInfo::title.
endAnchor()
| inline |
Definition at line 877 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::anchor, InClass, InMember, m_curCompound, m_curMember, m_curString, m_state and p_warn.
endAnchorFile()
| inline |
Definition at line 918 of file tagreader.cpp.
References InMember, m_curMember, m_curString, m_state and p_warn.
endArglist()
| inline |
Definition at line 930 of file tagreader.cpp.
References InMember, m_curMember, m_curString, m_state and p_warn.
endBase()
| inline |
Definition at line 779 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::bases, InClass, m_curCompound, m_curString, m_state and p_warn.
endClangId()
| inline |
Definition at line 894 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::clangId, anonymous{tagreader.cpp}::TagNamespaceInfo::clangId, InClass, InMember, InNamespace, m_curCompound, m_curMember, m_curString, m_state and p_warn.
endClass()
| inline |
Definition at line 516 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::classList, anonymous{tagreader.cpp}::TagFileInfo::classList, anonymous{tagreader.cpp}::TagGroupInfo::classList, anonymous{tagreader.cpp}::TagNamespaceInfo::classList, anonymous{tagreader.cpp}::TagPackageInfo::classList, InClass, InFile, InGroup, InNamespace, InPackage, m_curCompound, m_curString, m_state and p_warn.
endCompound()
| inline |
Definition at line 361 of file tagreader.cpp.
References InClass, InConcept, InDir, InFile, InGroup, InModule, InNamespace, InPackage, InPage, m_curCompound, m_state, m_tagFileCompounds and p_warn.
endConcept()
| inline |
Definition at line 556 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagFileInfo::conceptList, anonymous{tagreader.cpp}::TagGroupInfo::conceptList, anonymous{tagreader.cpp}::TagNamespaceInfo::conceptList, InFile, InGroup, InNamespace, m_curCompound, m_curString, m_state and p_warn.
endDir()
| inline |
Definition at line 682 of file tagreader.cpp.
References InDir, m_curCompound, m_curString, m_state, p_warn and anonymous{tagreader.cpp}::TagDirInfo::subdirList.
endDocAnchor()
| inline |
Definition at line 469 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagCompoundInfo::docAnchors, InClass, InConcept, InDir, InFile, InGroup, InMember, InModule, InNamespace, InPackage, InPage, AnchorGenerator::looksGenerated, m_curCompound, m_curMember, m_curString, m_fileName, m_state, m_title and p_warn.
endElement()
|
Definition at line 349 of file tagreader.cpp.
References anonymous{tagreader.cpp}::g_elementHandlers, p_warn and QCString::str.
endEnumValue()
| inline |
Definition at line 457 of file tagreader.cpp.
References InMember, m_curEnumValue, m_curMember, m_curString, m_state, m_stateStack, QCString::str and QCString::stripWhiteSpace.
endFile()
| inline |
Definition at line 628 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagDirInfo::fileList, anonymous{tagreader.cpp}::TagGroupInfo::fileList, InDir, InGroup, m_curCompound, m_curString, m_state and p_warn.
endFilename()
| inline |
Definition at line 831 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagCompoundInfo::filename, InClass, InConcept, InDir, InFile, InGroup, InModule, InNamespace, InPackage, InPage, m_curCompound, m_curString, m_state and p_warn.
endIgnoreElement()
| inline |
Definition at line 981 of file tagreader.cpp.
endIncludes()
| inline |
Definition at line 804 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagFileInfo::includes, InFile, m_curCompound, m_curIncludes, m_curString, m_state and p_warn.
endMember()
| inline |
Definition at line 414 of file tagreader.cpp.
References InClass, InFile, InGroup, InNamespace, InPackage, m_curCompound, m_curMember, m_state, m_stateStack, anonymous{tagreader.cpp}::TagCompoundInfo::members and p_warn.
endModule()
| inline |
Definition at line 584 of file tagreader.cpp.
References InGroup, m_curCompound, m_curString, m_state, anonymous{tagreader.cpp}::TagGroupInfo::moduleList and p_warn.
endName()
| inline |
Definition at line 722 of file tagreader.cpp.
References InClass, InConcept, InDir, InFile, InGroup, InMember, InModule, InNamespace, InPackage, InPage, m_curCompound, m_curMember, m_curString, m_state, anonymous{tagreader.cpp}::TagCompoundInfo::name and p_warn.
endNamespace()
| inline |
Definition at line 600 of file tagreader.cpp.
References InFile, InGroup, InNamespace, m_curCompound, m_curString, m_state, anonymous{tagreader.cpp}::TagFileInfo::namespaceList, anonymous{tagreader.cpp}::TagGroupInfo::namespaceList, anonymous{tagreader.cpp}::TagNamespaceInfo::namespaceList and p_warn.
endPage()
| inline |
Definition at line 650 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagGroupInfo::fileList, InGroup, m_curCompound, m_curString, m_state and p_warn.
endPath()
| inline |
Definition at line 855 of file tagreader.cpp.
References InDir, InFile, m_curCompound, m_curString, m_state, p_warn, anonymous{tagreader.cpp}::TagDirInfo::path and anonymous{tagreader.cpp}::TagFileInfo::path.
endSubgroup()
| inline |
Definition at line 964 of file tagreader.cpp.
References InGroup, m_curCompound, m_curString, m_state, p_warn and anonymous{tagreader.cpp}::TagGroupInfo::subgroupList.
endSubpage()
| inline |
Definition at line 666 of file tagreader.cpp.
References InPage, m_curCompound, m_curString, m_state, p_warn and anonymous{tagreader.cpp}::TagPageInfo::subpages.
endTemplateArg()
| inline |
Definition at line 818 of file tagreader.cpp.
References InClass, m_curCompound, m_curString, m_state, p_warn and anonymous{tagreader.cpp}::TagClassInfo::templateArguments.
endTitle()
| inline |
Definition at line 942 of file tagreader.cpp.
References InGroup, InPage, m_curCompound, m_curString, m_state, p_warn, anonymous{tagreader.cpp}::TagGroupInfo::title and anonymous{tagreader.cpp}::TagPageInfo::title.
endType()
| inline |
Definition at line 710 of file tagreader.cpp.
References InMember, m_curMember, m_curString, m_state and p_warn.
error()
setDocumentLocator()
| inline |
Definition at line 338 of file tagreader.cpp.
Reference m_locator.
startBase()
| inline |
Definition at line 749 of file tagreader.cpp.
References anonymous{tagreader.cpp}::TagClassInfo::bases, InClass, m_curCompound, m_curString, m_state, p_warn and XMLHandlers::value.
startCompound()
|
Definition at line 359 of file tagreader.cpp.
References anonymous{tagreader.cpp}::g_compoundFactory, Invalid, anonymous{tagreader.cpp}::TagClassInfo::isObjC, anonymous{tagreader.cpp}::TagCompoundInfo::lineNr, m_curCompound, m_curString, m_locator, m_state, p_warn, TRUE and XMLHandlers::value.
startDocAnchor()
| inline |
Definition at line 703 of file tagreader.cpp.
References m_curString, m_fileName, m_title and XMLHandlers::value.
startDocument()
| inline |
Definition at line 343 of file tagreader.cpp.
startElement()
|
Definition at line 348 of file tagreader.cpp.
References anonymous{tagreader.cpp}::g_elementHandlers, p_warn and QCString::str.
startEnumValue()
| inline |
Definition at line 439 of file tagreader.cpp.
References InEnumValue, InMember, m_curEnumValue, m_curString, m_state, m_stateStack, p_warn and XMLHandlers::value.
startIgnoreElement()
| inline |
Definition at line 977 of file tagreader.cpp.
startIncludes()
| inline |
Definition at line 792 of file tagreader.cpp.
References m_curIncludes, m_curString and XMLHandlers::value.
startMember()
| inline |
Definition at line 382 of file tagreader.cpp.
References InMember, m_curMember, m_locator, m_state, m_stateStack, TRUE and XMLHandlers::value.
startStringValue()
| inline |
Definition at line 698 of file tagreader.cpp.
Reference m_curString.
Private Member Functions
buildClassEntry()
|
Definition at line 1013 of file tagreader.cpp.
References addDocAnchors, anonymous{tagreader.cpp}::TagClassInfo::anchor, anonymous{tagreader.cpp}::TagClassInfo::bases, buildMemberList, anonymous{tagreader.cpp}::TagClassInfo::Category, anonymous{tagreader.cpp}::TagClassInfo::clangId, anonymous{tagreader.cpp}::TagClassInfo::Class, anonymous{tagreader.cpp}::TagCompoundInfo::docAnchors, anonymous{tagreader.cpp}::TagClassInfo::Enum, anonymous{tagreader.cpp}::TagClassInfo::Exception, anonymous{tagreader.cpp}::TagCompoundInfo::filename, anonymous{tagreader.cpp}::TagClassInfo::Interface, anonymous{tagreader.cpp}::TagClassInfo::isObjC, anonymous{tagreader.cpp}::TagClassInfo::kind, anonymous{tagreader.cpp}::TagCompoundInfo::lineNr, m_tagName, anonymous{tagreader.cpp}::TagCompoundInfo::members, anonymous{tagreader.cpp}::TagCompoundInfo::name, Argument::name, anonymous{tagreader.cpp}::TagClassInfo::None, anonymous{tagreader.cpp}::TagClassInfo::Protocol, ArgumentList::push_back, anonymous{tagreader.cpp}::TagClassInfo::Service, anonymous{tagreader.cpp}::TagClassInfo::Singleton, anonymous{tagreader.cpp}::TagClassInfo::Struct, anonymous{tagreader.cpp}::TagClassInfo::templateArguments, TRUE, Argument::type and anonymous{tagreader.cpp}::TagClassInfo::Union.
Referenced by buildClassTree.
buildClassTree()
|
Definition at line 1014 of file tagreader.cpp.
References buildClassEntry, buildClassTree, anonymous{tagreader.cpp}::TagFileParser::ClassNode::children and anonymous{tagreader.cpp}::TagFileParser::ClassNode::tci.
Referenced by buildClassTree and buildLists.
Private Member Attributes
m_curCompound
|
Definition at line 1018 of file tagreader.cpp.
Referenced by endAnchor, endBase, endClangId, endClass, endCompound, endConcept, endDir, endDocAnchor, endFile, endFilename, endIncludes, endMember, endModule, endName, endNamespace, endPage, endPath, endSubgroup, endSubpage, endTemplateArg, endTitle, startBase and startCompound.
m_curEnumValue
|
Definition at line 1021 of file tagreader.cpp.
Referenced by endEnumValue and startEnumValue.
m_curIncludes
|
Definition at line 1022 of file tagreader.cpp.
Referenced by endIncludes and startIncludes.
m_curMember
|
Definition at line 1020 of file tagreader.cpp.
Referenced by endAnchor, endAnchorFile, endArglist, endClangId, endDocAnchor, endEnumValue, endMember, endName, endType and startMember.
m_curString
|
Definition at line 1024 of file tagreader.cpp.
Referenced by characters, endAnchor, endAnchorFile, endArglist, endBase, endClangId, endClass, endConcept, endDir, endDocAnchor, endEnumValue, endFile, endFilename, endIncludes, endModule, endName, endNamespace, endPage, endPath, endSubgroup, endSubpage, endTemplateArg, endTitle, endType, startBase, startCompound, startDocAnchor, startEnumValue, startIncludes and startStringValue.
m_fileName
|
Definition at line 1026 of file tagreader.cpp.
Referenced by endDocAnchor and startDocAnchor.
m_locator
|
Definition at line 1030 of file tagreader.cpp.
Referenced by setDocumentLocator, startCompound and startMember.
m_state
|
Definition at line 1028 of file tagreader.cpp.
Referenced by endAnchor, endAnchorFile, endArglist, endBase, endClangId, endClass, endCompound, endConcept, endDir, endDocAnchor, endEnumValue, endFile, endFilename, endIncludes, endMember, endModule, endName, endNamespace, endPage, endPath, endSubgroup, endSubpage, endTemplateArg, endTitle, endType, startBase, startCompound, startDocument, startEnumValue and startMember.
m_stateStack
|
Definition at line 1029 of file tagreader.cpp.
Referenced by endEnumValue, endMember, startEnumValue and startMember.
m_tagFileCompounds
|
Definition at line 1017 of file tagreader.cpp.
Referenced by addIncludes, buildLists, dump and endCompound.
m_tagName
|
Definition at line 1025 of file tagreader.cpp.
Referenced by addDocAnchors, addIncludes, buildClassEntry, buildLists, buildMemberList and TagFileParser.
m_title
|
Definition at line 1027 of file tagreader.cpp.
Referenced by endDocAnchor and startDocAnchor.
The documentation for this class was generated from the following file:
Generated via doxygen2docusaurus by Doxygen 1.14.0.