layout.h File Reference

#include <memory>
#include <vector>
#include <utility>
#include "types.h"
#include "construct.h"

Include dependency graph for layout.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	LayoutDocEntry
	Base class representing a piece of a documentation page. More...
struct	LayoutDocEntrySimple
	Represents of a piece of a documentation page without configurable parts. More...
struct	LayoutDocEntrySection
struct	LayoutDocEntryMemberDecl
	Represents of a member declaration list with configurable title and subtitle. More...
struct	LayoutDocEntryMemberDef
	Represents of a member definition list with configurable title. More...
struct	LayoutNavEntry
	Base class for the layout of a navigation item at the top of the HTML pages. More...
class	LayoutDocManager
	Singleton providing access to the (user configurable) layout of the documentation. More...

Macros
#define	ENTRY_SPECIFICATIONS
#define	ESPEC(x)
#define	ESPEC(x)
#define	NAV_SPECIFICATIONS
#define	NSPEC(x, y)
#define	NSPEC(x, y)
#define	PART_SPECIFICATIONS
#define	PSPEC(x, y)
#define	PSPEC(x, y)

Typedefs
using	LayoutDocEntryPtr = std::unique_ptr<LayoutDocEntry>
using	LayoutDocEntryList = std::vector<LayoutDocEntryPtr>
using	LayoutNavEntryList = std::vector< std::unique_ptr<LayoutNavEntry> >

Functions
void	writeDefaultLayoutFile (const QCString &fileName)
void	printLayout ()

Macro Definition Documentation

ENTRY_SPECIFICATIONS

#define ENTRY_SPECIFICATIONS

Value:

              /* Generic items for all pages */ \
              ESPEC(MemberGroups) \
              ESPEC(MemberDeclStart) ESPEC(MemberDeclEnd) ESPEC(MemberDecl) \
              ESPEC(MemberDefStart) ESPEC(MemberDefEnd) ESPEC(MemberDef) \
              ESPEC(BriefDesc) ESPEC(DetailedDesc) \
              ESPEC(AuthorSection) \
              /* Class specific items */ \
              ESPEC(ClassIncludes) ESPEC(ClassInlineClasses) \
              ESPEC(ClassInheritanceGraph) ESPEC(ClassNestedClasses) \
              ESPEC(ClassCollaborationGraph) ESPEC(ClassAllMembersLink) \
              ESPEC(ClassUsedFiles) \
              /* Concept specific items */ \
              ESPEC(ConceptDefinition) \
              /* Namespace specific items */ \
              ESPEC(NamespaceNestedNamespaces) ESPEC(NamespaceNestedConstantGroups) \
              ESPEC(NamespaceClasses) ESPEC(NamespaceConcepts) ESPEC(NamespaceInterfaces) ESPEC(NamespaceStructs) ESPEC(NamespaceExceptions) \
              ESPEC(NamespaceInlineClasses) \
              /* File specific items */ \
              ESPEC(FileClasses) ESPEC(FileConcepts) ESPEC(FileInterfaces) ESPEC(FileStructs) ESPEC(FileExceptions) ESPEC(FileConstantGroups) ESPEC(FileNamespaces) \
              ESPEC(FileIncludes) ESPEC(FileIncludeGraph) \
              ESPEC(FileIncludedByGraph) ESPEC(FileSourceLink) \
              ESPEC(FileInlineClasses) \
              /* C++20 Modules */ \
              ESPEC(ModuleExports) ESPEC(ModuleClasses) ESPEC(ModuleConcepts) ESPEC(ModuleUsedFiles) \
              /* Group specific items */ \
              ESPEC(GroupClasses) ESPEC(GroupConcepts) ESPEC(GroupModules) ESPEC(GroupInlineClasses) ESPEC(GroupNamespaces) \
              ESPEC(GroupDirs) ESPEC(GroupNestedGroups) ESPEC(GroupFiles) \
              ESPEC(GroupGraph) ESPEC(GroupPageDocs) \
              /* Directory specific items */ \
              ESPEC(DirSubDirs) ESPEC(DirFiles) ESPEC(DirGraph)

Definition at line 35 of file layout.h.

#define ENTRY_SPECIFICATIONS \
              /* Generic items for all pages */ \
              ESPEC(MemberGroups) \
              ESPEC(MemberDeclStart) ESPEC(MemberDeclEnd) ESPEC(MemberDecl) \
              ESPEC(MemberDefStart) ESPEC(MemberDefEnd) ESPEC(MemberDef) \
              ESPEC(BriefDesc) ESPEC(DetailedDesc) \
              ESPEC(AuthorSection) \
              /* Class specific items */ \
              ESPEC(ClassIncludes) ESPEC(ClassInlineClasses) \
              ESPEC(ClassInheritanceGraph) ESPEC(ClassNestedClasses) \
              ESPEC(ClassCollaborationGraph) ESPEC(ClassAllMembersLink) \
              ESPEC(ClassUsedFiles) \
              /* Concept specific items */ \
              ESPEC(ConceptDefinition) \
              /* Namespace specific items */ \
              ESPEC(NamespaceNestedNamespaces) ESPEC(NamespaceNestedConstantGroups) \
              ESPEC(NamespaceClasses) ESPEC(NamespaceConcepts) ESPEC(NamespaceInterfaces) ESPEC(NamespaceStructs) ESPEC(NamespaceExceptions) \
              ESPEC(NamespaceInlineClasses) \
              /* File specific items */ \
              ESPEC(FileClasses) ESPEC(FileConcepts) ESPEC(FileInterfaces) ESPEC(FileStructs) ESPEC(FileExceptions) ESPEC(FileConstantGroups) ESPEC(FileNamespaces) \
              ESPEC(FileIncludes) ESPEC(FileIncludeGraph) \
              ESPEC(FileIncludedByGraph) ESPEC(FileSourceLink) \
              ESPEC(FileInlineClasses) \
              /* C++20 Modules */ \
              ESPEC(ModuleExports) ESPEC(ModuleClasses) ESPEC(ModuleConcepts) ESPEC(ModuleUsedFiles) \
              /* Group specific items */ \
              ESPEC(GroupClasses) ESPEC(GroupConcepts) ESPEC(GroupModules) ESPEC(GroupInlineClasses) ESPEC(GroupNamespaces) \
              ESPEC(GroupDirs) ESPEC(GroupNestedGroups) ESPEC(GroupFiles) \
              ESPEC(GroupGraph) ESPEC(GroupPageDocs) \
              /* Directory specific items */ \
              ESPEC(DirSubDirs) ESPEC(DirFiles) ESPEC(DirGraph)

ESPEC [1/2]

#define ESPEC

(

x

)

Value:

x,

Definition at line 68 of file layout.h.

ESPEC [2/2]

#define ESPEC

(

x

)

Value:

case x: return #x; break;

Definition at line 68 of file layout.h.

NAV_SPECIFICATIONS

#define NAV_SPECIFICATIONS

Definition at line 157 of file layout.h.

#define NAV_SPECIFICATIONS \
      NSPEC(None, = -1) \
      NSPEC(MainPage,) \
      NSPEC(Pages,) \
      NSPEC(Modules,) \
      NSPEC(ModuleList,) \
      NSPEC(ModuleMembers,) \
      NSPEC(Topics,) \
      NSPEC(Namespaces,) \
      NSPEC(NamespaceList,) \
      NSPEC(NamespaceMembers,) \
      NSPEC(Concepts,) \
      NSPEC(Classes,) \
      NSPEC(ClassList,) \
      NSPEC(ClassIndex,) \
      NSPEC(ClassHierarchy,) \
      NSPEC(ClassMembers,) \
      NSPEC(Interfaces,) \
      NSPEC(InterfaceList,) \
      NSPEC(InterfaceIndex,) \
      NSPEC(InterfaceHierarchy,) \
      NSPEC(Structs,) \
      NSPEC(StructList,) \
      NSPEC(StructIndex,) \
      NSPEC(Exceptions,) \
      NSPEC(ExceptionList,) \
      NSPEC(ExceptionIndex,) \
      NSPEC(ExceptionHierarchy,) \
      NSPEC(Files,) \
      NSPEC(FileList,) \
      NSPEC(FileGlobals,) \
      NSPEC(Examples,) \
      NSPEC(User,) \
      NSPEC(UserGroup,)

NSPEC [1/2]

#define NSPEC	(		x,
			y )

Value:

x y,

Definition at line 194 of file layout.h.

NSPEC [2/2]

#define NSPEC	(		x,
			y )

Value:

case x: return #x; break;

Definition at line 194 of file layout.h.

PART_SPECIFICATIONS

#define PART_SPECIFICATIONS

Value:

  PSPEC(Undefined, = -1)     \
  PSPEC(Class,) PSPEC(Concept,) PSPEC(Namespace,) PSPEC(File,) PSPEC(Group,) PSPEC(Directory,) PSPEC(Module,)       \
  PSPEC(NrParts,)

Definition at line 256 of file layout.h.

#define PART_SPECIFICATIONS \
  PSPEC(Undefined, = -1)     \
  PSPEC(Class,) PSPEC(Concept,) PSPEC(Namespace,) PSPEC(File,) PSPEC(Group,) PSPEC(Directory,) PSPEC(Module,)       \
  PSPEC(NrParts,)

PSPEC [1/2]

#define PSPEC	(		x,
			y )

Value:

x y,

Definition at line 267 of file layout.h.

PSPEC [2/2]

#define PSPEC	(		x,
			y )

Value:

case x: return #x; break;

Definition at line 267 of file layout.h.

Typedef Documentation

LayoutDocEntryList

using LayoutDocEntryList = std::vector<LayoutDocEntryPtr>

Definition at line 148 of file layout.h.

LayoutDocEntryPtr

using LayoutDocEntryPtr = std::unique_ptr<LayoutDocEntry>

Definition at line 147 of file layout.h.

LayoutNavEntryList

using LayoutNavEntryList = std::vector< std::unique_ptr<LayoutNavEntry> >

Definition at line 152 of file layout.h.

Function Documentation

printLayout()

void printLayout

(

)

Definition at line 1820 of file layout.cpp.

{
  bool extraIndent = false;
 
  auto &mgr = LayoutDocManager::instance();
  Debug::print(Debug::Layout,0,"Layout version {}.{}\n",mgr.majorVersion(),mgr.minorVersion());
 
  Debug::print(Debug::Layout,0,"Part: Navigation index\n");
  for (const auto &e : mgr.rootNavEntry()->children())
  {
    printNavLayout(e.get(),2);
  }
 
  for (int i = 0; i < LayoutDocManager::NrParts; i++)
  {
     Debug::print(Debug::Layout,0,"\nPart: {}\n", LayoutDocManager::partToString(i));
     for (const auto &lde : mgr.docEntries(static_cast<LayoutDocManager::LayoutPart>(i)))
     {
       if (const LayoutDocEntrySimple *ldes = dynamic_cast<const LayoutDocEntrySimple*>(lde.get()))
       {
         if (lde->kind() == LayoutDocEntry::MemberDeclEnd || lde->kind() == LayoutDocEntry::MemberDefEnd) extraIndent = false;
         Debug::print(Debug::Layout,0,"  {}kind: {}, visible={}\n",
           extraIndent? "  " : "",lde->entryToString(), ldes->visible());
         if (lde->kind() == LayoutDocEntry::MemberDeclStart || lde->kind() == LayoutDocEntry::MemberDefStart) extraIndent = true;
       }
       else if (const LayoutDocEntryMemberDecl *lmdecl = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get()))
       {
         Debug::print(Debug::Layout,0,"  {}complex kind: {}, visible={}, type: {}\n",
           extraIndent? "  " : "",lde->entryToString(),lmdecl->visible(),lmdecl->type.to_string());
       }
       else if (const LayoutDocEntryMemberDef *lmdef = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get()))
       {
         Debug::print(Debug::Layout,0,"  {}complex kind: {}, visible={}, type: {}\n",
           extraIndent? "  " : "",lde->entryToString(),lmdef->visible(),lmdef->type.to_string());
       }
       else
       {
         // should not happen
         Debug::print(Debug::Layout,0,"  {}not handled kind: {}\n",extraIndent? "  " : "",lde->entryToString());
       }
     }
  }
}

References LayoutDocManager::instance(), Debug::Layout, LayoutDocManager::partToString(), Debug::print(), and printNavLayout().

Referenced by LayoutDocManager::LayoutParser, and parseInput().

writeDefaultLayoutFile()

void writeDefaultLayoutFile

(

const QCString &

fileName

)

Definition at line 1732 of file layout.cpp.

{
  std::ofstream f;
  if (openOutputFile(fileName,f))
  {
    TextStream t(&f);
    QCString layout_default = ResourceMgr::instance().getAsString("layout_default.xml");
    t << substitute(layout_default,"$doxygenversion",getDoxygenVersion());
  }
  else
  {
    err("Failed to open file {} for writing!\n",fileName);
    return;
  }
  f.close();
}

References err, ResourceMgr::getAsString(), ResourceMgr::instance(), openOutputFile(), and substitute().

Referenced by LayoutDocManager::LayoutParser, and readConfiguration().