LayoutParser Class Reference

Collaboration diagram for LayoutParser:

Public Member Functions
	LayoutParser (LayoutDocManager &manager)
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 std::string &id, const XMLHandlers::Attributes &attrib)
void	startSectionEntry (LayoutDocEntry::Kind k, const std::string &id, const XMLHandlers::Attributes &attrib, const DString &title)
void	startMemberDeclEntry (const std::string &id, const XMLHandlers::Attributes &attrib, MemberListType type, const DString &title, const DString &subscript)
void	startMemberDefEntry (const std::string &id, const XMLHandlers::Attributes &attrib, MemberListType type, const DString &title, const DString &)
void	startLayout (const std::string &, const XMLHandlers::Attributes &attrib)
void	startNavIndex (const std::string &, const XMLHandlers::Attributes &)
void	endNavIndex (const std::string &)
void	startNavEntry (const std::string &, const XMLHandlers::Attributes &attrib)
void	endNavEntry (const std::string &)
void	startTop (const std::string &, const XMLHandlers::Attributes &attrib, LayoutDocManager::LayoutPart part, const DString &scope, LayoutNavEntry::Kind nav)
void	endTop (const std::string &)
void	startMemberDef (const std::string &id, const XMLHandlers::Attributes &attrib)
void	endMemberDef (const std::string &id)
void	startMemberDecl (const std::string &id, const XMLHandlers::Attributes &attrib)
void	endMemberDecl (const std::string &id)
int	majorVersion () const
int	minorVersion () const

Private Attributes
DString	m_scope
LayoutDocManager &	m_layoutDocManager
LayoutDocManager::LayoutPart	m_part = LayoutDocManager::Undefined
LayoutNavEntry *	m_rootNav = nullptr
bool	m_invalidEntry = false
bool	m_visible = true
const XMLLocator *	m_locator = nullptr
int	m_majorVersion = 1
int	m_minorVersion = 0

Static Private Attributes
static int	m_userGroupCount =0

Detailed Description

Definition at line 195 of file layout.cpp.

Constructor & Destructor Documentation

LayoutParser()

LayoutParser::LayoutParser ( LayoutDocManager & manager )

inline

Definition at line 198 of file layout.cpp.

: m_layoutDocManager(manager) {}

References m_layoutDocManager.

Member Function Documentation

endElement()

void LayoutParser::endElement

(

const std::string &

name

)

Definition at line 1374 of file layout.cpp.

{
  //printf("endElement [%s]::[%s]\n",qPrint(m_scope),qPrint(name));
  auto it=g_elementHandlers.end();
 
  if (!m_scope.empty() && m_scope.right(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,it->first+" end"); // added end to id to make it unique
  }
}

References DString::empty(), anonymous_namespace{layout.cpp}::g_elementHandlers, DString::left(), DString::length(), m_scope, DString::right(), and DString::str().

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

endMemberDecl()

void LayoutParser::endMemberDecl ( const std::string & id )

inline

Definition at line 681 of file layout.cpp.

    {
      if (size_t i=m_scope.rfind("memberdecl/"); i!=DString::npos)
      {
        m_scope=m_scope.left(i);
        bool isVisible = true;
        for (const auto &lde : m_layoutDocManager.docEntries(m_part))
        {
          if (lde->kind() == LayoutDocEntry::MemberDeclStart)
          {
             isVisible = static_cast<const LayoutDocEntrySimple*>(lde.get())->visible();
             break;
          }
        }
        if (m_part!=LayoutDocManager::Undefined)
        {
          m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntrySimple>(LayoutDocEntry::MemberDeclEnd,id,isVisible));
        }
      }
    }

References LayoutDocManager::addEntry(), LayoutDocManager::docEntries(), DString::left(), m_layoutDocManager, m_part, m_scope, DString::npos, DString::rfind(), and LayoutDocEntrySimple::visible().

endMemberDef()

void LayoutParser::endMemberDef ( const std::string & id )

inline

Definition at line 649 of file layout.cpp.

    {
      DString scopeOrg = m_scope;
      if (size_t i=m_scope.rfind("memberdef/"); i!=DString::npos)
      {
        m_scope=m_scope.left(i);
        bool isVisible = true;
        for (const auto &lde : m_layoutDocManager.docEntries(m_part))
        {
          if (lde->kind() == LayoutDocEntry::MemberDefStart)
          {
             isVisible = static_cast<const LayoutDocEntrySimple*>(lde.get())->visible();
             break;
          }
        }
        if (m_part!=LayoutDocManager::Undefined)
        {
          m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntrySimple>(LayoutDocEntry::MemberDefEnd,id,isVisible));
        }
      }
    }

References LayoutDocManager::addEntry(), LayoutDocManager::docEntries(), DString::left(), m_layoutDocManager, m_part, m_scope, DString::npos, DString::rfind(), and LayoutDocEntrySimple::visible().

endNavEntry()

void LayoutParser::endNavEntry ( const std::string & )

inline

Definition at line 617 of file layout.cpp.

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

References m_invalidEntry, m_rootNav, and LayoutNavEntry::parent().

endNavIndex()

void LayoutParser::endNavIndex ( const std::string & )

inline

Definition at line 287 of file layout.cpp.

    {
      m_scope="";
      if (m_rootNav && !m_rootNav->find(LayoutNavEntry::MainPage))
      {
        // no MainPage node... add one as the first item of the root node...
        m_rootNav->insertChild(0,std::make_unique<LayoutNavEntry>(m_rootNav,LayoutNavEntry::MainPage, true,
                                                   "index",theTranslator->trMainPage(),""));
      }
    }

References LayoutNavEntry::find(), LayoutNavEntry::insertChild(), m_rootNav, m_scope, theTranslator, and Translator::trMainPage().

endTop()

void LayoutParser::endTop ( const std::string & )

inline

Definition at line 633 of file layout.cpp.

    {
      m_scope="";
      m_part = LayoutDocManager::Undefined;
    }

References m_part, and m_scope.

error()

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

inline

Definition at line 205 of file layout.cpp.

    {
      warn_layout(fileName,lineNr,"{}",msg);
    }

References msg, and warn_layout.

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

majorVersion()

int LayoutParser::majorVersion ( ) const

inline

Definition at line 702 of file layout.cpp.

{ return m_majorVersion; }

References m_majorVersion.

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

minorVersion()

int LayoutParser::minorVersion ( ) const

inline

Definition at line 703 of file layout.cpp.

{ return m_minorVersion; }

References m_minorVersion.

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

setDocumentLocator()

void LayoutParser::setDocumentLocator ( const XMLLocator * locator )

inline

Definition at line 201 of file layout.cpp.

    {
      m_locator = locator;
    }

References m_locator.

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

startElement()

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

Definition at line 1358 of file layout.cpp.

{
  //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,it->first,attrib);
  }
  else
  {
    DString fileName = m_locator->fileName();
    warn_layout(fileName,m_locator->lineNr(),"Unexpected start tag '{}' found in scope='{}'!",
        name,m_scope);
  }
}

References XMLLocator::fileName(), anonymous_namespace{layout.cpp}::g_elementHandlers, XMLLocator::lineNr(), m_locator, m_scope, DString::str(), and warn_layout.

Referenced by LayoutDocManager::init(), and LayoutDocManager::parse().

startLayout()

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

inline

Definition at line 267 of file layout.cpp.

    {
      // extract and store version number
      DString version = XMLHandlers::value(attrib,"version");
      static const reg::Ex re(R"((\d+)\.(\d+))");
      reg::Match match;
      if (reg::match(version.view(),match,re))
      {
        m_majorVersion = atoi(match[1].str().c_str());
        m_minorVersion = atoi(match[2].str().c_str());
        //printf("layout version %d.%d\n",m_versionMajor,m_versionMinor);
      }
    }

References m_majorVersion, m_minorVersion, reg::match(), XMLHandlers::value(), and DString::view().

startMemberDecl()

void LayoutParser::startMemberDecl ( const std::string & id, const XMLHandlers::Attributes & attrib )

inline

Definition at line 671 of file layout.cpp.

    {
      m_scope+="memberdecl/";
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (m_part!=LayoutDocManager::Undefined)
      {
        m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntrySimple>(LayoutDocEntry::MemberDeclStart,id,isVisible));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), m_layoutDocManager, m_part, m_scope, and m_visible.

startMemberDeclEntry()

void LayoutParser::startMemberDeclEntry ( const std::string & id, const XMLHandlers::Attributes & attrib, MemberListType type, const DString & title, const DString & subscript )

inline

Definition at line 240 of file layout.cpp.

    {
      DString userTitle     = XMLHandlers::value(attrib,"title");
      DString userSubscript = XMLHandlers::value(attrib,"subtitle");
      if (userTitle.empty())     userTitle     = title;
      if (userSubscript.empty()) userSubscript = subscript;
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (m_part!=LayoutDocManager::Undefined)
      {
        m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntryMemberDecl>(type,id,userTitle,userSubscript,isVisible));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), DString::empty(), m_layoutDocManager, m_part, m_visible, and XMLHandlers::value().

startMemberDef()

void LayoutParser::startMemberDef ( const std::string & id, const XMLHandlers::Attributes & attrib )

inline

Definition at line 639 of file layout.cpp.

    {
      m_scope+="memberdef/";
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (m_part!=LayoutDocManager::Undefined)
      {
        m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntrySimple>(LayoutDocEntry::MemberDefStart,id,isVisible));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), m_layoutDocManager, m_part, m_scope, and m_visible.

startMemberDefEntry()

void LayoutParser::startMemberDefEntry ( const std::string & id, const XMLHandlers::Attributes & attrib, MemberListType type, const DString & title, const DString &  )

inline

Definition at line 254 of file layout.cpp.

    {
      DString userTitle = XMLHandlers::value(attrib,"title");
      if (userTitle.empty()) userTitle = title;
      //printf("memberdef: %s\n",qPrint(userTitle));
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (m_part!=LayoutDocManager::Undefined)
      {
        m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntryMemberDef>(type,id,userTitle,isVisible));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), DString::empty(), m_layoutDocManager, m_part, m_visible, and XMLHandlers::value().

startNavEntry()

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

inline

Definition at line 298 of file layout.cpp.

    {
      bool javaOpt    = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
      bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
      bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
      bool sliceOpt   = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
      bool hasGraphicalHierarchy = Config_getBool(HAVE_DOT) &&
                                          Config_getBool(GRAPHICAL_HIERARCHY);
      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
        DString mainName;         // default title for an item if it has children
        DString subName;          // optional name for an item if it is rendered as a child
        DString intro;            // introduction text to be put on the index page
        DString baseFile;         // base name of the file containing the index page
      } mapping[] =
      {
        { "mainpage",
          LayoutNavEntry::MainPage,
          theTranslator->trMainPage(),
          DString(),
          DString(),
          "index"
        },
        { "pages",
          LayoutNavEntry::Pages,
          theTranslator->trRelatedPages(),
          DString(),
          theTranslator->trRelatedPagesDescription(),
          "pages"
        },
        { "topics",
          LayoutNavEntry::Topics,
          theTranslator->trTopics(),
          DString(),
          theTranslator->trTopicListDescription(),
          "topics"
        },
        { "modules",
          LayoutNavEntry::Modules,
          theTranslator->trModules(),
          theTranslator->trModulesList(),
          theTranslator->trModulesDescription(),
          "modules"
        },
        { "modulelist",
          LayoutNavEntry::ModuleList,
          theTranslator->trModulesList(),
          DString(),
          theTranslator->trModulesListDescription(extractAll),
          "modules"
        },
        { "modulemembers",
          LayoutNavEntry::ModuleMembers,
          theTranslator->trModulesMembers(),
          DString(),
          theTranslator->trModulesMemberDescription(extractAll),
          "modulemembers"
        },
        { "namespaces",
          LayoutNavEntry::Namespaces,
          javaOpt || vhdlOpt   ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModules() : theTranslator->trNamespaces(),
          javaOpt || vhdlOpt   ? theTranslator->trPackageList() : 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->trPackageList() : fortranOpt || sliceOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
          DString(),
          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(),
          DString(),
          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->trCompoundIndexFortran() : vhdlOpt ? theTranslator->trDesignUnitIndex() : theTranslator->trCompoundIndex(),
          DString(),
          DString(),
          "classes"
        },
        { "classes",
          LayoutNavEntry::Classes,
          fortranOpt ? theTranslator->trDataTypes() : vhdlOpt ? theTranslator->trDesignUnits() : theTranslator->trClasses(),
          theTranslator->trCompoundList(),
          fortranOpt ? theTranslator->trCompoundListDescriptionFortran() : vhdlOpt ? theTranslator->trDesignUnitListDescription() : theTranslator->trCompoundListDescription(),
          "annotated"
        },
        { "classlist",
          LayoutNavEntry::ClassList,
          fortranOpt ? theTranslator->trCompoundListFortran() : vhdlOpt ? theTranslator->trDesignUnitList() : theTranslator->trCompoundList(),
          DString(),
          fortranOpt ? theTranslator->trCompoundListDescriptionFortran() : vhdlOpt ? theTranslator->trDesignUnitListDescription() : theTranslator->trCompoundListDescription(),
          "annotated"
        },
        { "hierarchy",
          LayoutNavEntry::ClassHierarchy,
          vhdlOpt    ? theTranslator->trDesignUnitHierarchy() : theTranslator->trClassHierarchy(),
          DString(),
          theTranslator->trClassHierarchyDescription(),
          hasGraphicalHierarchy ? "inherits" : "hierarchy"
        },
        { "classmembers",
          LayoutNavEntry::ClassMembers,
          fortranOpt ? theTranslator->trCompoundMembersFortran() : vhdlOpt ? theTranslator->trDesignUnitMembers() : theTranslator->trCompoundMembers(),
          DString(),
          fortranOpt ? theTranslator->trCompoundMembersDescriptionFortran(extractAll) : theTranslator->trCompoundMembersDescription(extractAll),
          "functions"
        },
        { "interfaceindex",
          LayoutNavEntry::InterfaceIndex,
          theTranslator->trInterfaceIndex(),
          DString(),
          DString(),
          "interfaces"
        },
        { "interfaces",
          LayoutNavEntry::Interfaces,
          theTranslator->trSliceInterfaces(),
          theTranslator->trInterfaceList(),
          theTranslator->trInterfaceListDescription(),
          "annotatedinterfaces"
        },
        { "interfacelist",
          LayoutNavEntry::InterfaceList,
          theTranslator->trInterfaceList(),
          DString(),
          theTranslator->trInterfaceListDescription(),
          "annotatedinterfaces"
        },
        { "interfacehierarchy",
          LayoutNavEntry::InterfaceHierarchy,
          theTranslator->trInterfaceHierarchy(),
          DString(),
          theTranslator->trInterfaceHierarchyDescription(),
          hasGraphicalHierarchy ? "interfaceinherits" : "interfacehierarchy"
        },
        { "structindex",
          LayoutNavEntry::StructIndex,
          theTranslator->trStructIndex(),
          DString(),
          DString(),
          "structs"
        },
        { "structs",
          LayoutNavEntry::Structs,
          theTranslator->trStructs(),
          theTranslator->trStructList(),
          theTranslator->trStructListDescription(),
          "annotatedstructs"
        },
        { "structlist",
          LayoutNavEntry::StructList,
          theTranslator->trStructList(),
          DString(),
          theTranslator->trStructListDescription(),
          "annotatedstructs"
        },
        { "exceptionindex",
          LayoutNavEntry::ExceptionIndex,
          theTranslator->trExceptionIndex(),
          DString(),
          DString(),
          "exceptions"
        },
        { "exceptions",
          LayoutNavEntry::Exceptions,
          theTranslator->trExceptions(),
          theTranslator->trExceptionList(),
          theTranslator->trExceptionListDescription(),
          "annotatedexceptions"
        },
        { "exceptionlist",
          LayoutNavEntry::ExceptionList,
          theTranslator->trExceptionList(),
          DString(),
          theTranslator->trExceptionListDescription(),
          "annotatedexceptions"
        },
        { "exceptionhierarchy",
          LayoutNavEntry::ExceptionHierarchy,
          theTranslator->trExceptionHierarchy(),
          DString(),
          theTranslator->trExceptionHierarchyDescription(),
          hasGraphicalHierarchy ? "exceptioninherits" : "exceptionhierarchy"
        },
        { "files",
          LayoutNavEntry::Files,
          theTranslator->trFile(true,false),
          theTranslator->trFileList(),
          theTranslator->trFileListDescription(extractAll),
          "files"
        },
        { "filelist",
          LayoutNavEntry::FileList,
          theTranslator->trFileList(),
          DString(),
          theTranslator->trFileListDescription(extractAll),
          "files"
        },
        { "globals",
          LayoutNavEntry::FileGlobals,
          theTranslator->trFileMembers(),
          DString(),
          theTranslator->trFileMembersDescription(extractAll),
          "globals"
        },
        { "examples",
          LayoutNavEntry::Examples,
          theTranslator->trExamples(),
          DString(),
          theTranslator->trExamplesDescription(),
          "examples"
        },
        { "user",
          LayoutNavEntry::User,
          DString(),
          DString(),
          DString(),
          "user"
        },
        { "usergroup",
          LayoutNavEntry::UserGroup,
          DString(),
          DString(),
          DString(),
          "usergroup"
        },
        { nullptr, // end of list
          static_cast<LayoutNavEntry::Kind>(0),
          DString(),
          DString(),
          DString(),
          DString()
        }
      };
      // find type in the table
      int i=0;
      DString type = XMLHandlers::value(attrib,"type");
      while (mapping[i].typeStr)
      {
        if (mapping[i].typeStr==type)
          break;
        i++;
      }
      if (mapping[i].typeStr==nullptr)
      {
        DString fileName = m_locator->fileName();
        if (type.empty())
        {
          warn_layout(fileName,m_locator->lineNr(),"an entry tag within a navindex has no type attribute! Check your layout file!");
        }
        else
        {
          warn_layout(fileName,m_locator->lineNr(),"the type '{}' is not supported for the entry tag within a navindex! Check your layout file!",type);
        }
        m_invalidEntry=true;
        return;
      }
      LayoutNavEntry::Kind kind = mapping[i].kind;
      DString baseFile = mapping[i].baseFile;
      DString title = XMLHandlers::value(attrib,"title");
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (title.empty()) // use default title
      {
        title = mapping[i].mainName; // use title for main row
        if (m_rootNav!=m_layoutDocManager.rootNavEntry() && !mapping[i].subName.empty())
        {
          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.
        }
      }
      DString intro = XMLHandlers::value(attrib,"intro");
      if (intro.empty()) // use default intro text
      {
        intro = mapping[i].intro;
      }
      DString url = XMLHandlers::value(attrib,"url");
      if (mapping[i].kind==LayoutNavEntry::User && !url.empty())
      {
        baseFile=url;
      }
      else if (kind==LayoutNavEntry::UserGroup)
      {
        if (!url.empty())
        {
          if (url == "[none]")
          {
            baseFile = DString();
          }
          else
          {
            baseFile=url;
          }
        }
        else
        {
          baseFile+=DString().sprintf("%d",m_userGroupCount++);
        }
      }
      // create new item and make it the new root
      m_rootNav = m_layoutDocManager.createChildNavEntry(m_rootNav,kind,isVisible,baseFile,title,intro);
    }

References Config_getBool, LayoutDocManager::createChildNavEntry(), DString::DString(), elemIsVisible(), DString::empty(), XMLLocator::fileName(), XMLLocator::lineNr(), m_invalidEntry, m_layoutDocManager, m_locator, m_rootNav, m_userGroupCount, m_visible, LayoutDocManager::rootNavEntry(), DString::sprintf(), theTranslator, Translator::trClasses(), Translator::trClassHierarchy(), Translator::trClassHierarchyDescription(), Translator::trCompoundIndex(), Translator::trCompoundIndexFortran(), 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::trDesignUnitIndex(), 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::trPackageList(), Translator::trPackageListDescription(), Translator::trPackageMembers(), Translator::trPackages(), Translator::trRelatedPages(), Translator::trRelatedPagesDescription(), Translator::trSliceInterfaces(), Translator::trStructIndex(), Translator::trStructList(), Translator::trStructListDescription(), Translator::trStructs(), Translator::trTopicListDescription(), Translator::trTopics(), XMLHandlers::value(), and warn_layout.

startNavIndex()

void LayoutParser::startNavIndex ( const std::string & , const XMLHandlers::Attributes &  )

inline

Definition at line 281 of file layout.cpp.

    {
      m_scope="navindex/";
      m_rootNav = m_layoutDocManager.rootNavEntry();
    }

References m_layoutDocManager, m_rootNav, m_scope, and LayoutDocManager::rootNavEntry().

startSectionEntry()

void LayoutParser::startSectionEntry ( LayoutDocEntry::Kind k, const std::string & id, const XMLHandlers::Attributes & attrib, const DString & title )

inline

Definition at line 225 of file layout.cpp.

    {
      bool isVisible = m_visible && elemIsVisible(attrib);
      DString userTitle = XMLHandlers::value(attrib,"title");
      //printf("startSectionEntry: title='%s' userTitle='%s'\n",
      //    qPrint(title),qPrint(userTitle));
      if (userTitle.empty())  userTitle = title;
      if (m_part!=LayoutDocManager::Undefined)
      {
        m_layoutDocManager.addEntry(m_part,std::make_unique<LayoutDocEntrySection>(k,id,userTitle,isVisible));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), DString::empty(), m_layoutDocManager, m_part, m_visible, and XMLHandlers::value().

startSimpleEntry()

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

inline

Definition at line 212 of file layout.cpp.

    {
      bool isVisible = m_visible && elemIsVisible(attrib);
      if (m_part!=LayoutDocManager::Undefined)
      {
        auto elem = std::make_unique<LayoutDocEntrySimple>(k,id,isVisible);
        //printf("startSimpleEntry(%s) isVisible=%d visible=%d\n",qPrint(elem->entryToString()),isVisible,elem->visible());
        m_layoutDocManager.addEntry(m_part,std::move(elem));
      }
    }

References LayoutDocManager::addEntry(), elemIsVisible(), m_layoutDocManager, m_part, and m_visible.

startTop()

void LayoutParser::startTop ( const std::string & , const XMLHandlers::Attributes & attrib, LayoutDocManager::LayoutPart part, const DString & scope, LayoutNavEntry::Kind nav )

inline

Definition at line 624 of file layout.cpp.

    {
      //printf("startTop(scope=%s)\n",qPrint(scope));
      m_scope = scope;
      m_part = part;
      m_visible = elemIsVisible(attrib);
    }

References elemIsVisible(), m_part, m_scope, and m_visible.

Member Data Documentation

m_invalidEntry

bool LayoutParser::m_invalidEntry = false

private

Definition at line 710 of file layout.cpp.

Referenced by endNavEntry(), and startNavEntry().

m_layoutDocManager

LayoutDocManager& LayoutParser::m_layoutDocManager

private

Definition at line 707 of file layout.cpp.

Referenced by endMemberDecl(), endMemberDef(), LayoutParser(), startMemberDecl(), startMemberDeclEntry(), startMemberDef(), startMemberDefEntry(), startNavEntry(), startNavIndex(), startSectionEntry(), and startSimpleEntry().

m_locator

const XMLLocator* LayoutParser::m_locator = nullptr

private

Definition at line 713 of file layout.cpp.

Referenced by setDocumentLocator(), startElement(), and startNavEntry().

m_majorVersion

int LayoutParser::m_majorVersion = 1

private

Definition at line 714 of file layout.cpp.

Referenced by majorVersion(), and startLayout().

m_minorVersion

int LayoutParser::m_minorVersion = 0

private

Definition at line 715 of file layout.cpp.

Referenced by minorVersion(), and startLayout().

m_part

LayoutDocManager::LayoutPart LayoutParser::m_part = LayoutDocManager::Undefined

private

Definition at line 708 of file layout.cpp.

Referenced by endMemberDecl(), endMemberDef(), endTop(), startMemberDecl(), startMemberDeclEntry(), startMemberDef(), startMemberDefEntry(), startSectionEntry(), startSimpleEntry(), and startTop().

m_rootNav

LayoutNavEntry* LayoutParser::m_rootNav = nullptr

private

Definition at line 709 of file layout.cpp.

Referenced by endNavEntry(), endNavIndex(), startNavEntry(), and startNavIndex().

m_scope

DString LayoutParser::m_scope

private

Definition at line 706 of file layout.cpp.

Referenced by endElement(), endMemberDecl(), endMemberDef(), endNavIndex(), endTop(), startElement(), startMemberDecl(), startMemberDef(), startNavIndex(), and startTop().

m_userGroupCount

int LayoutParser::m_userGroupCount =0

staticprivate

Definition at line 712 of file layout.cpp.

Referenced by startNavEntry().

m_visible

bool LayoutParser::m_visible = true

private

Definition at line 711 of file layout.cpp.

Referenced by startMemberDecl(), startMemberDeclEntry(), startMemberDef(), startMemberDefEntry(), startNavEntry(), startSectionEntry(), startSimpleEntry(), and startTop().

---

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

• src/layout.cpp