LayoutParser类 参考

LayoutParser 的协作图:

Public 成员函数
void	setDocumentLocator (const XMLLocator *locator)
void	error (const std::string &fileName, int lineNr, const std::string &msg)
void	startElement (const std::string &name, const XMLHandlers::Attributes &attrib)
void	endElement (const std::string &name)
void	startSimpleEntry (LayoutDocEntry::Kind k, const XMLHandlers::Attributes &attrib)
void	startSectionEntry (LayoutDocEntry::Kind k, const XMLHandlers::Attributes &attrib, const QCString &title)
void	startMemberDeclEntry (const XMLHandlers::Attributes &attrib, MemberListType type, const QCString &title, const QCString &subscript)
void	startMemberDefEntry (const XMLHandlers::Attributes &attrib, MemberListType type, const QCString &title, const QCString &)
void	startLayout (const XMLHandlers::Attributes &)
void	startNavIndex (const XMLHandlers::Attributes &)
void	endNavIndex ()
void	startNavEntry (const XMLHandlers::Attributes &attrib)
void	endNavEntry ()
void	startClass (const XMLHandlers::Attributes &)
void	endClass ()
void	startNamespace (const XMLHandlers::Attributes &)
void	endNamespace ()
void	startConcept (const XMLHandlers::Attributes &)
void	endConcept ()
void	startFile (const XMLHandlers::Attributes &)
void	endFile ()
void	startGroup (const XMLHandlers::Attributes &)
void	endGroup ()
void	startDirectory (const XMLHandlers::Attributes &)
void	endDirectory ()
void	startMemberDef (const XMLHandlers::Attributes &)
void	endMemberDef ()
void	startMemberDecl (const XMLHandlers::Attributes &)
void	endMemberDecl ()

静态 Public 成员函数
static LayoutParser &	instance ()

Private 成员函数
	LayoutParser ()
	~LayoutParser ()

Private 属性
QCString	m_scope
int	m_part = -1
LayoutNavEntry *	m_rootNav = 0
bool	m_invalidEntry = false
const XMLLocator *	m_locator = nullptr

静态 Private 属性
static int	m_userGroupCount =0

详细描述

在文件 layout.cpp 第 163 行定义.

构造及析构函数说明

LayoutParser()

LayoutParser::LayoutParser ( )

inlineprivate

在文件 layout.cpp 第 701 行定义.

{ }

被这些函数引用 instance().

~LayoutParser()

LayoutParser::~LayoutParser ( )

inlineprivate

在文件 layout.cpp 第 702 行定义.

{ delete m_rootNav; }

引用了 m_rootNav.

成员函数说明

endClass()

void LayoutParser::endClass ( )

inline

在文件 layout.cpp 第 580 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endConcept()

void LayoutParser::endConcept ( )

inline

在文件 layout.cpp 第 606 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endDirectory()

void LayoutParser::endDirectory ( )

inline

在文件 layout.cpp 第 645 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endElement()

void LayoutParser::endElement

(

const std::string &

name

)

在文件 layout.cpp 第 1518 行定义.

{
  //printf("endElement [%s]::[%s]\n",qPrint(m_scope),qPrint(name));
  auto it=g_elementHandlers.end();
 
  if (!m_scope.isEmpty() && m_scope.right(static_cast<uint>(name.length())+1)==name+"/")
  { // element ends current scope
    it = g_elementHandlers.find(m_scope.left(m_scope.length()-1).str());
  }
  else // continue with current scope
  {
    it = g_elementHandlers.find(m_scope.str()+name);
  }
  if (it!=g_elementHandlers.end())
  {
    it->second.endCb(*this);
  }
}

引用了 g_elementHandlers, QCString::isEmpty(), QCString::left(), QCString::length(), m_scope, QCString::right() , 以及 QCString::str().

被这些函数引用 LayoutDocManager::init() , 以及 LayoutDocManager::parse().

endFile()

void LayoutParser::endFile ( )

inline

在文件 layout.cpp 第 619 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endGroup()

void LayoutParser::endGroup ( )

inline

在文件 layout.cpp 第 632 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endMemberDecl()

void LayoutParser::endMemberDecl ( )

inline

在文件 layout.cpp 第 685 行定义.

    {
      int i=m_scope.findRev("memberdecl/");
      if (i!=-1)
      {
        m_scope=m_scope.left(i);
        if (m_part!=-1)
        {
          LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySimple(LayoutDocEntry::MemberDeclEnd));
        }
      }
    }

引用了 LayoutDocManager::addEntry(), QCString::findRev(), LayoutDocManager::instance(), QCString::left(), m_part, m_scope , 以及 LayoutDocEntry::MemberDeclEnd.

endMemberDef()

void LayoutParser::endMemberDef ( )

inline

在文件 layout.cpp 第 661 行定义.

    {
      int i=m_scope.findRev("memberdef/");
      if (i!=-1)
      {
        m_scope=m_scope.left(i);
        if (m_part!=-1)
        {
          LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySimple(LayoutDocEntry::MemberDefEnd));
        }
      }
    }

引用了 LayoutDocManager::addEntry(), QCString::findRev(), LayoutDocManager::instance(), QCString::left(), m_part, m_scope , 以及 LayoutDocEntry::MemberDefEnd.

endNamespace()

void LayoutParser::endNamespace ( )

inline

在文件 layout.cpp 第 593 行定义.

    {
      m_scope="";
      m_part = -1;
    }

引用了 m_part , 以及 m_scope.

endNavEntry()

void LayoutParser::endNavEntry ( )

inline

在文件 layout.cpp 第 566 行定义.

    {
      // set the root back to the parent
      if (m_rootNav && !m_invalidEntry) m_rootNav = m_rootNav->parent();
      m_invalidEntry=FALSE;
    }

引用了 FALSE, m_invalidEntry, m_rootNav , 以及 LayoutNavEntry::parent().

endNavIndex()

void LayoutParser::endNavIndex ( )

inline

在文件 layout.cpp 第 253 行定义.

    {
      m_scope="";
      if (m_rootNav && !m_rootNav->find(LayoutNavEntry::MainPage))
      {
        // no MainPage node... add one as the first item of the root node...
        new LayoutNavEntry(m_rootNav,LayoutNavEntry::MainPage, TRUE,
            /*Config_getBool(GENERATE_TREEVIEW) ? "main" :*/ "index",
            theTranslator->trMainPage(),"",TRUE);
      }
    }

引用了 LayoutNavEntry::find(), m_rootNav, m_scope, LayoutNavEntry::MainPage, theTranslator, Translator::trMainPage() , 以及 TRUE.

error()

void LayoutParser::error ( const std::string &  fileName, int  lineNr, const std::string &  msg  )

inline

在文件 layout.cpp 第 177 行定义.

    {
      ::warn(fileName.c_str(),lineNr,"%s",msg.c_str());
    }

引用了 msg() , 以及 warn().

被这些函数引用 LayoutDocManager::init() , 以及 LayoutDocManager::parse().

instance()

static LayoutParser& LayoutParser::instance ( )

inlinestatic

在文件 layout.cpp 第 166 行定义.

    {
      static LayoutParser *theInstance = new LayoutParser;
      return *theInstance;
    }

引用了 LayoutParser().

被这些函数引用 LayoutDocManager::init() , 以及 LayoutDocManager::parse().

setDocumentLocator()

void LayoutParser::setDocumentLocator ( const XMLLocator *  locator )

inline

在文件 layout.cpp 第 173 行定义.

    {
      m_locator = locator;
    }

引用了 m_locator.

被这些函数引用 LayoutDocManager::init() , 以及 LayoutDocManager::parse().

startClass()

void LayoutParser::startClass ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 573 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::Class);
      m_scope="class/";
      m_part = (int)LayoutDocManager::Class;
    }

引用了 LayoutDocManager::Class, LayoutDocManager::clear(), LayoutDocManager::instance(), m_part , 以及 m_scope.

startConcept()

void LayoutParser::startConcept ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 599 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::Concept);
      m_scope="concept/";
      m_part = (int)LayoutDocManager::Concept;
    }

引用了 LayoutDocManager::clear(), LayoutDocManager::Concept, LayoutDocManager::instance(), m_part , 以及 m_scope.

startDirectory()

void LayoutParser::startDirectory ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 638 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::Directory);
      m_scope="directory/";
      m_part = (int)LayoutDocManager::Directory;
    }

引用了 LayoutDocManager::clear(), LayoutDocManager::Directory, LayoutDocManager::instance(), m_part , 以及 m_scope.

startElement()

void LayoutParser::startElement	(	const std::string &	name,
		const XMLHandlers::Attributes &	attrib
	)

在文件 layout.cpp 第 1502 行定义.

{
  //printf("startElement [%s]::[%s]\n",qPrint(m_scope),qPrint(name));
  auto it = g_elementHandlers.find(m_scope.str()+name);
  if (it!=g_elementHandlers.end())
  {
    it->second.startCb(*this,attrib);
  }
  else
  {
    std::string fileName = m_locator->fileName();
    ::warn(fileName.c_str(),m_locator->lineNr(),"Unexpected start tag '%s' found in scope='%s'!\n",
        qPrint(name),qPrint(m_scope));
  }
}

引用了 XMLLocator::fileName(), g_elementHandlers, XMLLocator::lineNr(), m_locator, m_scope, qPrint(), QCString::str() , 以及 warn().

被这些函数引用 LayoutDocManager::init() , 以及 LayoutDocManager::parse().

startFile()

void LayoutParser::startFile ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 612 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::File);
      m_scope="file/";
      m_part = (int)LayoutDocManager::File;
    }

引用了 LayoutDocManager::clear(), LayoutDocManager::File, LayoutDocManager::instance(), m_part , 以及 m_scope.

startGroup()

void LayoutParser::startGroup ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 625 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::Group);
      m_scope="group/";
      m_part = (int)LayoutDocManager::Group;
    }

引用了 LayoutDocManager::clear(), LayoutDocManager::Group, LayoutDocManager::instance(), m_part , 以及 m_scope.

startLayout()

void LayoutParser::startLayout ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 242 行定义.

    {
    }

startMemberDecl()

void LayoutParser::startMemberDecl ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 675 行定义.

    {
      m_scope+="memberdecl/";
      if (m_part!=-1)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySimple(LayoutDocEntry::MemberDeclStart));
      }
    }

引用了 LayoutDocManager::addEntry(), LayoutDocManager::instance(), m_part, m_scope , 以及 LayoutDocEntry::MemberDeclStart.

startMemberDeclEntry()

void LayoutParser::startMemberDeclEntry ( const XMLHandlers::Attributes &  attrib, MemberListType  type, const QCString &  title, const QCString &  subscript  )

inline

在文件 layout.cpp 第 212 行定义.

    {
      //QCString visible = convertToQCString(XMLHandlers::value(attrib,"visible"));
      //bool isVisible = visible.isEmpty() || (visible!="no" && visible!="0");
      QCString userTitle     = XMLHandlers::value(attrib,"title");
      QCString userSubscript = XMLHandlers::value(attrib,"subtitle");
      if (userTitle.isEmpty())     userTitle     = title;
      if (userSubscript.isEmpty()) userSubscript = subscript;
      //printf("memberdecl: %s\n",qPrint(userTitle));
      if (m_part!=-1 /*&& isVisible*/)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntryMemberDecl(type,userTitle,userSubscript));
      }
    }

引用了 LayoutDocManager::addEntry(), LayoutDocManager::instance(), QCString::isEmpty(), m_part , 以及 XMLHandlers::value().

startMemberDef()

void LayoutParser::startMemberDef ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 651 行定义.

    {
      m_scope+="memberdef/";
      if (m_part!=-1)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySimple(LayoutDocEntry::MemberDefStart));
      }
    }

引用了 LayoutDocManager::addEntry(), LayoutDocManager::instance(), m_part, m_scope , 以及 LayoutDocEntry::MemberDefStart.

startMemberDefEntry()

void LayoutParser::startMemberDefEntry ( const XMLHandlers::Attributes &  attrib, MemberListType  type, const QCString &  title, const QCString &    )

inline

在文件 layout.cpp 第 229 行定义.

    {
      QCString userTitle = XMLHandlers::value(attrib,"title");
      if (userTitle.isEmpty()) userTitle = title;
      //printf("memberdef: %s\n",qPrint(userTitle));
      if (m_part!=-1 /*&& isVisible*/)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntryMemberDef(type,userTitle));
      }
    }

引用了 LayoutDocManager::addEntry(), LayoutDocManager::instance(), QCString::isEmpty(), m_part , 以及 XMLHandlers::value().

startNamespace()

void LayoutParser::startNamespace ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 586 行定义.

    {
      LayoutDocManager::instance().clear(LayoutDocManager::Namespace);
      m_scope="namespace/";
      m_part = (int)LayoutDocManager::Namespace;
    }

引用了 LayoutDocManager::clear(), LayoutDocManager::instance(), m_part, m_scope , 以及 LayoutDocManager::Namespace.

startNavEntry()

void LayoutParser::startNavEntry ( const XMLHandlers::Attributes &  attrib )

inline

在文件 layout.cpp 第 265 行定义.

    {
      static bool javaOpt    = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
      static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
      static bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      static bool sliceOpt   = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
      static bool hasGraphicalHierarchy = Config_getBool(HAVE_DOT) &&
                                          Config_getBool(GRAPHICAL_HIERARCHY);
      static bool extractAll = Config_getBool(EXTRACT_ALL);
      static struct NavEntryMap
      {
        const char *typeStr;       // type attribute name in the XML file
        LayoutNavEntry::Kind kind; // corresponding enum name
        QCString mainName;         // default title for an item if it has children
        QCString subName;          // optional name for an item if it is rendered as a child
        QCString intro;            // introduction text to be put on the index page
        QCString baseFile;         // base name of the file containing the index page
      } mapping[] =
      {
        { "mainpage",
          LayoutNavEntry::MainPage,
          theTranslator->trMainPage(),
          QCString(),
          QCString(),
          "index"
        },
        { "pages",
          LayoutNavEntry::Pages,
          theTranslator->trRelatedPages(),
          QCString(),
          theTranslator->trRelatedPagesDescription(),
          "pages"
        },
        { "modules",
          LayoutNavEntry::Modules,
          theTranslator->trModules(),
          QCString(),
          theTranslator->trModulesDescription(),
          "modules"
        },
        { "namespaces",
          LayoutNavEntry::Namespaces,
          javaOpt || vhdlOpt   ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModules() : theTranslator->trNamespaces(),
          javaOpt || vhdlOpt   ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
          javaOpt || vhdlOpt   ? theTranslator->trPackageListDescription() : fortranOpt || sliceOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
          "namespaces"
        },
        { "namespacelist",
          LayoutNavEntry::NamespaceList,
          javaOpt || vhdlOpt   ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
          QCString(),
          javaOpt || vhdlOpt   ? theTranslator->trPackageListDescription() : fortranOpt || sliceOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
          "namespaces"
        },
        { "namespacemembers",
          LayoutNavEntry::NamespaceMembers,
          javaOpt || vhdlOpt   ? theTranslator->trPackageMembers() : fortranOpt || sliceOpt ? theTranslator->trModulesMembers() : theTranslator->trNamespaceMembers(),
          QCString(),
          fortranOpt || sliceOpt ? theTranslator->trModulesMemberDescription(extractAll) : theTranslator->trNamespaceMemberDescription(extractAll),
          "namespacemembers"
        },
        { "concepts",
          LayoutNavEntry::Concepts,
          theTranslator->trConcept(true,false),
          theTranslator->trConceptList(),
          theTranslator->trConceptListDescription(extractAll),
          "concepts"
        },
        { "classindex",
          LayoutNavEntry::ClassIndex,
          fortranOpt ? theTranslator->trDataTypes() : vhdlOpt ? theTranslator->trDesignUnits() : theTranslator->trCompoundIndex(),
          QCString(),
          QCString(),
          "classes"
        },
        { "classes",
          LayoutNavEntry::Classes,
          fortranOpt ? theTranslator->trCompoundListFortran() : vhdlOpt ? theTranslator->trDesignUnitList() : theTranslator->trClasses(),
          theTranslator->trCompoundList(),
          fortranOpt ? theTranslator->trCompoundListDescriptionFortran() : vhdlOpt ? theTranslator->trDesignUnitListDescription() : theTranslator->trCompoundListDescription(),
          "annotated"
        },
        { "classlist",
          LayoutNavEntry::ClassList,
          fortranOpt ? theTranslator->trCompoundListFortran() : vhdlOpt ? theTranslator->trDesignUnitList() : theTranslator->trCompoundList(),
          QCString(),
          fortranOpt ? theTranslator->trCompoundListDescriptionFortran() : vhdlOpt ? theTranslator->trDesignUnitListDescription() : theTranslator->trCompoundListDescription(),
          "annotated"
        },
        { "hierarchy",
          LayoutNavEntry::ClassHierarchy,
          vhdlOpt    ? theTranslator->trDesignUnitHierarchy() : theTranslator->trClassHierarchy(),
          QCString(),
          theTranslator->trClassHierarchyDescription(),
          hasGraphicalHierarchy ? "inherits" : "hierarchy"
        },
        { "classmembers",
          LayoutNavEntry::ClassMembers,
          fortranOpt ? theTranslator->trCompoundMembersFortran() : vhdlOpt ? theTranslator->trDesignUnitMembers() : theTranslator->trCompoundMembers(),
          QCString(),
          fortranOpt ? theTranslator->trCompoundMembersDescriptionFortran(extractAll) : theTranslator->trCompoundMembersDescription(extractAll),
          "functions"
        },
        { "interfaceindex",
          LayoutNavEntry::InterfaceIndex,
          theTranslator->trInterfaceIndex(),
          QCString(),
          QCString(),
          "interfaces"
        },
        { "interfaces",
          LayoutNavEntry::Interfaces,
          theTranslator->trSliceInterfaces(),
          theTranslator->trInterfaceList(),
          theTranslator->trInterfaceListDescription(),
          "annotatedinterfaces"
        },
        { "interfacelist",
          LayoutNavEntry::InterfaceList,
          theTranslator->trInterfaceList(),
          QCString(),
          theTranslator->trInterfaceListDescription(),
          "annotatedinterfaces"
        },
        { "interfacehierarchy",
          LayoutNavEntry::InterfaceHierarchy,
          theTranslator->trInterfaceHierarchy(),
          QCString(),
          theTranslator->trInterfaceHierarchyDescription(),
          hasGraphicalHierarchy ? "interfaceinherits" : "interfacehierarchy"
        },
        { "structindex",
          LayoutNavEntry::StructIndex,
          theTranslator->trStructIndex(),
          QCString(),
          QCString(),
          "structs"
        },
        { "structs",
          LayoutNavEntry::Structs,
          theTranslator->trStructs(),
          theTranslator->trStructList(),
          theTranslator->trStructListDescription(),
          "annotatedstructs"
        },
        { "structlist",
          LayoutNavEntry::StructList,
          theTranslator->trStructList(),
          QCString(),
          theTranslator->trStructListDescription(),
          "annotatedstructs"
        },
        { "exceptionindex",
          LayoutNavEntry::ExceptionIndex,
          theTranslator->trExceptionIndex(),
          QCString(),
          QCString(),
          "exceptions"
        },
        { "exceptions",
          LayoutNavEntry::Exceptions,
          theTranslator->trExceptions(),
          theTranslator->trExceptionList(),
          theTranslator->trExceptionListDescription(),
          "annotatedexceptions"
        },
        { "exceptionlist",
          LayoutNavEntry::ExceptionList,
          theTranslator->trExceptionList(),
          QCString(),
          theTranslator->trExceptionListDescription(),
          "annotatedexceptions"
        },
        { "exceptionhierarchy",
          LayoutNavEntry::ExceptionHierarchy,
          theTranslator->trExceptionHierarchy(),
          QCString(),
          theTranslator->trExceptionHierarchyDescription(),
          hasGraphicalHierarchy ? "exceptioninherits" : "exceptionhierarchy"
        },
        { "files",
          LayoutNavEntry::Files,
          theTranslator->trFile(TRUE,FALSE),
          theTranslator->trFileList(),
          theTranslator->trFileListDescription(extractAll),
          "files"
        },
        { "filelist",
          LayoutNavEntry::FileList,
          theTranslator->trFileList(),
          QCString(),
          theTranslator->trFileListDescription(extractAll),
          "files"
        },
        { "globals",
          LayoutNavEntry::FileGlobals,
          theTranslator->trFileMembers(),
          QCString(),
          theTranslator->trFileMembersDescription(extractAll),
          "globals"
        },
        //{ "dirs",
        //  LayoutNavEntry::Dirs,
        //  theTranslator->trDirectories(),
        //  QCString(),
        //  theTranslator->trDirDescription(),
        //  "dirs"
        //},
        { "examples",
          LayoutNavEntry::Examples,
          theTranslator->trExamples(),
          QCString(),
          theTranslator->trExamplesDescription(),
          "examples"
        },
        { "user",
          LayoutNavEntry::User,
          QCString(),
          QCString(),
          QCString(),
          "user"
        },
        { "usergroup",
          LayoutNavEntry::UserGroup,
          QCString(),
          QCString(),
          QCString(),
          "usergroup"
        },
        { 0, // end of list
          (LayoutNavEntry::Kind)0,
          QCString(),
          QCString(),
          QCString(),
          QCString()
        }
      };
      LayoutNavEntry::Kind kind;
      // find type in the table
      int i=0;
      QCString type = XMLHandlers::value(attrib,"type");
      while (mapping[i].typeStr)
      {
        if (mapping[i].typeStr==type)
        {
          kind = mapping[i].kind;
          break;
        }
        i++;
      }
      if (mapping[i].typeStr==0)
      {
        std::string fileName = m_locator->fileName();
        if (type.isEmpty())
        {
          ::warn(fileName.c_str(),m_locator->lineNr(),"an entry tag within a navindex has no type attribute! Check your layout file!\n");
        }
        else
        {
          ::warn(fileName.c_str(),m_locator->lineNr(),"the type '%s' is not supported for the entry tag within a navindex! Check your layout file!\n",qPrint(type));
        }
        m_invalidEntry=TRUE;
        return;
      }
      QCString baseFile = mapping[i].baseFile;
      QCString title = XMLHandlers::value(attrib,"title");
      bool isVisible = elemIsVisible(attrib);
      if (title.isEmpty()) // use default title
      {
        title = mapping[i].mainName; // use title for main row
        if (m_rootNav!=LayoutDocManager::instance().rootNavEntry() && !mapping[i].subName.isEmpty())
        {
          title = mapping[i].subName; // if this is a child of another row, use the subName if available
                                      // this is mainly done to get compatible naming with older versions.
        }
      }
      QCString intro = XMLHandlers::value(attrib,"intro");
      if (intro.isEmpty()) // use default intro text
      {
        intro = mapping[i].intro;
      }
      QCString url = XMLHandlers::value(attrib,"url");
      if (mapping[i].kind==LayoutNavEntry::User && !url.isEmpty())
      {
        baseFile=url;
      }
      else if (kind==LayoutNavEntry::UserGroup)
      {
        if (!url.isEmpty())
        {
          baseFile=url;
        }
        else
        {
          baseFile+=QCString().sprintf("%d",m_userGroupCount++);
        }
      }
      // create new item and make it the new root
      m_rootNav = new LayoutNavEntry(m_rootNav,kind,isVisible,baseFile,title,intro);
    }

引用了 LayoutNavEntry::Classes, LayoutNavEntry::ClassHierarchy, LayoutNavEntry::ClassIndex, LayoutNavEntry::ClassList, LayoutNavEntry::ClassMembers, LayoutNavEntry::Concepts, Config_getBool, elemIsVisible(), LayoutNavEntry::Examples, LayoutNavEntry::ExceptionHierarchy, LayoutNavEntry::ExceptionIndex, LayoutNavEntry::ExceptionList, LayoutNavEntry::Exceptions, FALSE, LayoutNavEntry::FileGlobals, LayoutNavEntry::FileList, XMLLocator::fileName(), LayoutNavEntry::Files, LayoutDocManager::instance(), LayoutNavEntry::InterfaceHierarchy, LayoutNavEntry::InterfaceIndex, LayoutNavEntry::InterfaceList, LayoutNavEntry::Interfaces, QCString::isEmpty(), XMLLocator::lineNr(), m_invalidEntry, m_locator, m_rootNav, m_userGroupCount, LayoutNavEntry::MainPage, LayoutNavEntry::Modules, LayoutNavEntry::NamespaceList, LayoutNavEntry::NamespaceMembers, LayoutNavEntry::Namespaces, LayoutNavEntry::Pages, qPrint(), QCString::sprintf(), LayoutNavEntry::StructIndex, LayoutNavEntry::StructList, LayoutNavEntry::Structs, theTranslator, Translator::trClasses(), Translator::trClassHierarchy(), Translator::trClassHierarchyDescription(), Translator::trCompoundIndex(), Translator::trCompoundList(), Translator::trCompoundListDescription(), Translator::trCompoundListDescriptionFortran(), Translator::trCompoundListFortran(), Translator::trCompoundMembers(), Translator::trCompoundMembersDescription(), Translator::trCompoundMembersDescriptionFortran(), Translator::trCompoundMembersFortran(), Translator::trConcept(), Translator::trConceptList(), Translator::trConceptListDescription(), Translator::trDataTypes(), Translator::trDesignUnitHierarchy(), Translator::trDesignUnitList(), Translator::trDesignUnitListDescription(), Translator::trDesignUnitMembers(), Translator::trDesignUnits(), Translator::trExamples(), Translator::trExamplesDescription(), Translator::trExceptionHierarchy(), Translator::trExceptionHierarchyDescription(), Translator::trExceptionIndex(), Translator::trExceptionList(), Translator::trExceptionListDescription(), Translator::trExceptions(), Translator::trFile(), Translator::trFileList(), Translator::trFileListDescription(), Translator::trFileMembers(), Translator::trFileMembersDescription(), Translator::trInterfaceHierarchy(), Translator::trInterfaceHierarchyDescription(), Translator::trInterfaceIndex(), Translator::trInterfaceList(), Translator::trInterfaceListDescription(), Translator::trMainPage(), Translator::trModules(), Translator::trModulesDescription(), Translator::trModulesList(), Translator::trModulesListDescription(), Translator::trModulesMemberDescription(), Translator::trModulesMembers(), Translator::trNamespaceList(), Translator::trNamespaceListDescription(), Translator::trNamespaceMemberDescription(), Translator::trNamespaceMembers(), Translator::trNamespaces(), Translator::trPackageListDescription(), Translator::trPackageMembers(), Translator::trPackages(), Translator::trRelatedPages(), Translator::trRelatedPagesDescription(), Translator::trSliceInterfaces(), Translator::trStructIndex(), Translator::trStructList(), Translator::trStructListDescription(), Translator::trStructs(), TRUE, LayoutNavEntry::User, LayoutNavEntry::UserGroup, XMLHandlers::value() , 以及 warn().

startNavIndex()

void LayoutParser::startNavIndex ( const XMLHandlers::Attributes &  )

inline

在文件 layout.cpp 第 246 行定义.

    {
      m_scope="navindex/";
      m_rootNav = LayoutDocManager::instance().rootNavEntry();
      if (m_rootNav) m_rootNav->clear();
    }

引用了 LayoutNavEntry::clear(), LayoutDocManager::instance(), m_rootNav, m_scope , 以及 LayoutDocManager::rootNavEntry().

startSectionEntry()

void LayoutParser::startSectionEntry ( LayoutDocEntry::Kind  k, const XMLHandlers::Attributes &  attrib, const QCString &  title  )

inline

在文件 layout.cpp 第 196 行定义.

    {
      bool isVisible = elemIsVisible(attrib);
      QCString userTitle = XMLHandlers::value(attrib,"title");
      //printf("startSectionEntry: title='%s' userTitle='%s'\n",
      //    qPrint(title),qPrint(userTitle));
      if (userTitle.isEmpty())  userTitle = title;
      if (m_part!=-1 && isVisible)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySection(k,userTitle));
      }
    }

引用了 LayoutDocManager::addEntry(), elemIsVisible(), LayoutDocManager::instance(), QCString::isEmpty(), m_part , 以及 XMLHandlers::value().

startSimpleEntry()

void LayoutParser::startSimpleEntry ( LayoutDocEntry::Kind  k, const XMLHandlers::Attributes &  attrib  )

inline

在文件 layout.cpp 第 184 行定义.

    {
      bool isVisible = elemIsVisible(attrib);
      if (m_part!=-1 && isVisible)
      {
        LayoutDocManager::instance().addEntry((LayoutDocManager::LayoutPart)m_part,
                                              new LayoutDocEntrySimple(k));
      }
    }

引用了 LayoutDocManager::addEntry(), elemIsVisible(), LayoutDocManager::instance() , 以及 m_part.

类成员变量说明

m_invalidEntry

bool LayoutParser::m_invalidEntry = false

private

在文件 layout.cpp 第 707 行定义.

被这些函数引用 endNavEntry() , 以及 startNavEntry().

m_locator

const XMLLocator* LayoutParser::m_locator = nullptr

private

在文件 layout.cpp 第 709 行定义.

被这些函数引用 setDocumentLocator(), startElement() , 以及 startNavEntry().

m_part

int LayoutParser::m_part = -1

private

在文件 layout.cpp 第 705 行定义.

被这些函数引用 endClass(), endConcept(), endDirectory(), endFile(), endGroup(), endMemberDecl(), endMemberDef(), endNamespace(), startClass(), startConcept(), startDirectory(), startFile(), startGroup(), startMemberDecl(), startMemberDeclEntry(), startMemberDef(), startMemberDefEntry(), startNamespace(), startSectionEntry() , 以及 startSimpleEntry().

m_rootNav

LayoutNavEntry* LayoutParser::m_rootNav = 0

private

在文件 layout.cpp 第 706 行定义.

被这些函数引用 endNavEntry(), endNavIndex(), startNavEntry(), startNavIndex() , 以及 ~LayoutParser().

m_scope

QCString LayoutParser::m_scope

private

在文件 layout.cpp 第 704 行定义.

被这些函数引用 endClass(), endConcept(), endDirectory(), endElement(), endFile(), endGroup(), endMemberDecl(), endMemberDef(), endNamespace(), endNavIndex(), startClass(), startConcept(), startDirectory(), startElement(), startFile(), startGroup(), startMemberDecl(), startMemberDef(), startNamespace() , 以及 startNavIndex().

m_userGroupCount

int LayoutParser::m_userGroupCount =0

staticprivate

在文件 layout.cpp 第 708 行定义.

被这些函数引用 startNavEntry().

---

该类的文档由以下文件生成:

• src/layout.cpp