LayoutDocManager Class Reference

Singleton providing access to the (user configurable) layout of the documentation. More...

#include <src/layout.h>

Classes
class	Private

Public Types
enum	LayoutPart { PART_SPECIFICATIONS }

Public Member Functions
const LayoutDocEntryList &	docEntries (LayoutPart part) const
	Returns the list of LayoutDocEntry's in representation order for a given page identified by part.
LayoutNavEntry *	rootNavEntry () const
	returns the (invisible) root of the navigation tree.
LayoutNavEntry *	createChildNavEntry (LayoutNavEntry *root, LayoutNavEntry::Kind k, bool vs, const QCString &bf, const QCString &tl, const QCString &intro)
void	parse (const QCString &fileName, const char *data=nullptr)
	Parses a user provided layout.
void	init ()

Static Public Member Functions
static LayoutDocManager &	instance ()
	Returns a reference to this singleton.
static std::string	partToString (int k)

Private Member Functions
void	addEntry (LayoutPart p, LayoutDocEntryPtr &&e)
void	clear (LayoutPart p)
	LayoutDocManager ()
	~LayoutDocManager ()

Private Attributes
std::unique_ptr< Private >	d

Friends
class	LayoutParser

Detailed Description

Singleton providing access to the (user configurable) layout of the documentation.

Definition at line 232 of file layout.h.

Member Enumeration Documentation

LayoutPart

enum LayoutDocManager::LayoutPart

Enumerator
PART_SPECIFICATIONS

Definition at line 236 of file layout.h.

    {
#define PSPEC(x,y) x y,
      PART_SPECIFICATIONS
#undef PSPEC
    };

Constructor & Destructor Documentation

LayoutDocManager()

LayoutDocManager::LayoutDocManager ( )

private

Definition at line 1398 of file layout.cpp.

                                   : d(std::make_unique<Private>())
{
}

References d.

Referenced by instance().

~LayoutDocManager()

LayoutDocManager::~LayoutDocManager ( )

private

Definition at line 1402 of file layout.cpp.

{
}

Member Function Documentation

addEntry()

void LayoutDocManager::addEntry ( LayoutDocManager::LayoutPart p, LayoutDocEntryPtr && e )

private

Definition at line 1449 of file layout.cpp.

{
  d->docEntries[static_cast<int>(p)].push_back(std::move(e));
}

References d.

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

clear()

void LayoutDocManager::clear ( LayoutDocManager::LayoutPart p )

private

Definition at line 1454 of file layout.cpp.

{
  d->docEntries[static_cast<int>(p)].clear();
}

References clear(), and d.

Referenced by clear(), and LayoutParser::startTop().

createChildNavEntry()

LayoutNavEntry * LayoutDocManager::createChildNavEntry	(	LayoutNavEntry *	root,
		LayoutNavEntry::Kind	k,
		bool	vs,
		const QCString &	bf,
		const QCString &	tl,
		const QCString &	intro )

Definition at line 1439 of file layout.cpp.

{
  if (parent==nullptr) parent = &d->rootNav;
  auto ptr = std::make_unique<LayoutNavEntry>(parent,k,vs,bf,tl,intro);
  auto child = ptr.get();
  parent->addChild(std::move(ptr));
  return child;
}

References d, and parent().

Referenced by LayoutParser::startNavEntry().

docEntries()

const LayoutDocEntryList & LayoutDocManager::docEntries

(

LayoutDocManager::LayoutPart

part

)

const

Returns the list of LayoutDocEntry's in representation order for a given page identified by part.

Definition at line 1429 of file layout.cpp.

{
  return d->docEntries[static_cast<int>(part)];
}

References d.

init()

void LayoutDocManager::init

(

)

Definition at line 1406 of file layout.cpp.

{
  LayoutParser &layoutParser = LayoutParser::instance();
  XMLHandlers handlers;
  handlers.startElement = [&layoutParser](const std::string &name,const XMLHandlers::Attributes &attrs) { layoutParser.startElement(name,attrs); };
  handlers.endElement   = [&layoutParser](const std::string &name) { layoutParser.endElement(name); };
  handlers.error        = [&layoutParser](const std::string &fileName,int lineNr,const std::string &msg) { layoutParser.error(fileName,lineNr,msg); };
  XMLParser parser(handlers);
  layoutParser.setDocumentLocator(&parser);
  constexpr auto layoutFile = "layout_default.xml";
  QCString layout_default = ResourceMgr::instance().getAsString(layoutFile);
  parser.parse(layoutFile,layout_default.data(),Debug::isFlagSet(Debug::Lex_xml),
               [&]() { DebugLex::print(Debug::Lex_xml,"Entering","libxml/xml.l",layoutFile); },
               [&]() { DebugLex::print(Debug::Lex_xml,"Finished", "libxml/xml.l",layoutFile); }
              );
}

References QCString::data(), LayoutParser::endElement(), XMLHandlers::endElement, LayoutParser::error(), XMLHandlers::error, ResourceMgr::getAsString(), LayoutParser::instance(), ResourceMgr::instance(), Debug::isFlagSet(), LayoutParser, Debug::Lex_xml, msg(), XMLParser::parse(), LayoutParser::setDocumentLocator(), LayoutParser::startElement(), and XMLHandlers::startElement.

Referenced by parseInput().

instance()

LayoutDocManager & LayoutDocManager::instance ( )

static

Returns a reference to this singleton.

Definition at line 1423 of file layout.cpp.

{
  static LayoutDocManager theInstance;
  return theInstance;
}

References LayoutDocManager().

Referenced by addMembersToIndex(), ClassDefImpl::countAdditionalInheritedMembers(), ModuleDefImpl::countVisibleMembers(), NamespaceDefImpl::countVisibleMembers(), LayoutParser::endMemberDecl(), LayoutParser::endMemberDef(), generateJSNavTree(), ClassDefImpl::getTitleForMemberListType(), parseInput(), printLayout(), renderQuickLinksAsTabs(), ClassDefImpl::setAnonymousEnumType(), LayoutParser::startMemberDecl(), LayoutParser::startMemberDeclEntry(), LayoutParser::startMemberDef(), LayoutParser::startMemberDefEntry(), LayoutParser::startNavEntry(), LayoutParser::startNavIndex(), LayoutParser::startSectionEntry(), LayoutParser::startSimpleEntry(), LayoutParser::startTop(), ClassDefImpl::writeAdditionalInheritedMembers(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), ClassDefImpl::writeDeclaration(), writeDefaultQuickLinks(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeIndexHierarchy(), writeIndexHierarchyEntries(), ClassDefImpl::writeInlineDocumentation(), writeMenuData(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeModuleMembers(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceMembers(), writePageIndex(), writePages(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), ClassDefImpl::writeTagFile(), DirDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), ModuleDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), and writeTopicIndex().

parse()

void LayoutDocManager::parse	(	const QCString &	fileName,
		const char *	data = nullptr )

Parses a user provided layout.

Definition at line 1459 of file layout.cpp.

{
  LayoutParser &layoutParser = LayoutParser::instance();
  XMLHandlers handlers;
  handlers.startElement = [&layoutParser](const std::string &name,const XMLHandlers::Attributes &attrs) { layoutParser.startElement(name,attrs); };
  handlers.endElement   = [&layoutParser](const std::string &name) { layoutParser.endElement(name); };
  handlers.error        = [&layoutParser](const std::string &fn,int lineNr,const std::string &msg) { layoutParser.error(fn,lineNr,msg); };
  XMLParser parser(handlers);
  layoutParser.setDocumentLocator(&parser);
  parser.parse(fileName.data(),
               data ? data : fileToString(fileName).data(),
               Debug::isFlagSet(Debug::Lex_xml),
               [&]() { DebugLex::print(Debug::Lex_xml,"Entering","libxml/xml.l",qPrint(fileName)); },
               [&]() { DebugLex::print(Debug::Lex_xml,"Finished", "libxml/xml.l",qPrint(fileName)); },
               transcodeCharacterStringToUTF8
              );
}

References QCString::data(), LayoutParser::endElement(), XMLHandlers::endElement, LayoutParser::error(), XMLHandlers::error, fileToString(), LayoutParser::instance(), Debug::isFlagSet(), LayoutParser, Debug::Lex_xml, msg(), XMLParser::parse(), DebugLex::print(), qPrint(), LayoutParser::setDocumentLocator(), LayoutParser::startElement(), XMLHandlers::startElement, and transcodeCharacterStringToUTF8().

Referenced by parseInput().

partToString()

static std::string LayoutDocManager::partToString ( int k )

inlinestatic

Definition at line 244 of file layout.h.

    {
      switch (k)
      {
#define PSPEC(x,y) case x: return #x; break;
        PART_SPECIFICATIONS
#undef PSPEC
        default: return "unknown"; // to satisfy compiler
      }
    }

References PART_SPECIFICATIONS.

Referenced by printLayout().

rootNavEntry()

LayoutNavEntry * LayoutDocManager::rootNavEntry

(

)

const

returns the (invisible) root of the navigation tree.

Definition at line 1434 of file layout.cpp.

{
  return &d->rootNav;
}

References d.

Referenced by generateJSNavTree(), LayoutParser::startNavIndex(), LayoutParser::startTop(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeConceptIndex(), writeDefaultQuickLinks(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), writeIndexHierarchy(), writeMenuData(), writeModuleIndex(), writeModuleMemberIndex(), writeModuleMemberIndexFiltered(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), writePages(), and writeTopicIndex().

Friends And Related Symbol Documentation

LayoutParser

friend class LayoutParser

friend

Definition at line 272 of file layout.h.

References LayoutParser, and writeDefaultLayoutFile().

Referenced by init(), LayoutParser, and parse().

Member Data Documentation

d

std::unique_ptr<Private> LayoutDocManager::d

private

Definition at line 271 of file layout.h.

Referenced by addEntry(), clear(), createChildNavEntry(), docEntries(), LayoutDocManager(), and rootNavEntry().

---

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

• src/layout.h
• src/layout.cpp