PageDefImpl Class Reference

Inheritance diagram for PageDefImpl:

Collaboration diagram for PageDefImpl:

Public Member Functions
	PageDefImpl (const DString &f, int l, const DString &n, const DString &d, const DString &t)
	~PageDefImpl () override
void	setFileName (const DString &name) override
void	setLocalToc (const LocalToc &tl) override
void	setShowLineNo (bool) override
DefType	definitionType () const override
CodeSymbolType	codeSymbolType () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
DString	getOutputFileBase () const override
DString	anchor () const override
void	findSectionsInDocumentation () override
DString	title () const override
DString	titleAsText () const override
const GroupDef *	getGroupDef () const override
const PageLinkedRefMap &	getSubPages () const override
void	addInnerCompound (Definition *d) override
bool	visibleInIndex () const override
bool	documentedPage () const override
bool	hasSubPages () const override
bool	hasParentPage () const override
bool	hasTitle () const override
LocalToc	localToc () const override
void	setPageScope (Definition *d) override
Definition *	getPageScope () const override
DString	displayName (bool=true) const override
bool	showLineNo () const override
void	setTitle (const DString &title) override
void	writeDocumentation (OutputList &ol) override
void	writeTagFile (TextStream &) override
void	setNestingLevel (int l) override
void	writePageDocumentation (OutputList &ol) const override
void	addSectionsToIndex () override
void	writePageNavigation (OutputList &ol) const override
void	addListReferences () override
void	addRequirementReferences () override
Public Member Functions inherited from DefinitionMixin< PageDef >
	DefinitionMixin (const DString &defFileName, int defLine, int defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	~DefinitionMixin () override=default
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
int	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
const Definition *	findInnerCompound (const DString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
void	setName (const DString &name) override
void	setId (const DString &name) override
void	setDefFile (const DString &df, int defLine, int defColumn) override
void	setDocumentation (const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void	setBriefDescription (const DString &brief, const DString &briefFile, int briefLine) override
void	setInbodyDocumentation (const DString &doc, const DString &docFile, int docLine) override
void	setReference (const DString &r) override
void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void	setBodySegment (int defLine, int bls, int ble) override
void	setBodyDef (const FileDef *fd) override
void	addSourceReferencedBy (MemberDef *md, const DString &sourceRefName) override
void	addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void	setRefItems (const RefItemVector &sli) override
void	setRequirementReferences (const RequirementRefs &rqli) override
void	mergeRefItems (Definition *def) override
void	mergeReferences (const Definition *other) override
void	mergeReferencedBy (const Definition *other) override
void	setOuterScope (Definition *def) override
void	setHidden (bool b) override
void	setArtificial (bool b) override
void	setExported (bool b) override
void	setLanguage (SrcLangExt lang) override
void	writeSourceDef (OutputList &ol) const override
void	writeInlineCode (OutputList &ol, const DString &scopeName) const override
bool	hasSourceRefs () const override
bool	hasSourceReffedBy () const override
void	writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool	hasRequirementRefs () const override
void	writeRequirementRefs (OutputList &ol) const override
void	makePartOfGroup (GroupDef *gd) override
void	writeNavigationPath (OutputList &ol) const override
DString	navigationPathAsString () const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writeSummaryLinks (OutputList &ol) const override
DString	pathFragment () const override
void	writeDocAnchorsToTagFile (TextStream &fs) const override
void	setLocalName (const DString &name) override
void	writeToc (OutputList &ol, const LocalToc &lt) const override
void	computeTooltip () override
void	_setSymbolName (const DString &name) override
DString	_symbolName () const override

Private Attributes
DString	m_fileName
DString	m_title
DString	m_titleAsText
PageLinkedRefMap	m_subPages
Definition *	m_pageScope
int	m_nestingLevel
LocalToc	m_localToc
bool	m_showLineNo

Additional Inherited Members
Public Types inherited from Definition
enum	DefType {   TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,   TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,   TypeDir = 8 , TypeConcept = 9 }

Detailed Description

Definition at line 31 of file pagedef.cpp.

Constructor & Destructor Documentation

PageDefImpl()

PageDefImpl::PageDefImpl	(	const DString &	f,
		int	l,
		const DString &	n,
		const DString &	d,
		const DString &	t )

Definition at line 91 of file pagedef.cpp.

 : DefinitionMixin(f,l,1,n)
{
  setDocumentation(d,f,l);
  m_pageScope = nullptr;
  m_nestingLevel = 0;
  m_fileName = ::convertNameToFile(n,false,true);
  m_showLineNo = false;
  setTitle(t);
}

References convertNameToFile(), DefinitionMixin< PageDef >::DefinitionMixin(), m_fileName, m_nestingLevel, m_pageScope, m_showLineNo, DefinitionMixin< PageDef >::setDocumentation(), and setTitle().

~PageDefImpl()

PageDefImpl::~PageDefImpl ( )

override

Definition at line 103 of file pagedef.cpp.

{
}

Member Function Documentation

addInnerCompound()

void PageDefImpl::addInnerCompound ( Definition * d )

overridevirtual

Reimplemented from DefinitionMixin< PageDef >.

Definition at line 132 of file pagedef.cpp.

{
  if (def->definitionType()==Definition::TypePage)
  {
    PageDef *pd = toPageDef(def);
    if (pd)
    {
      m_subPages.add(pd->name(),pd);
      pd->setOuterScope(this);
      if (this==Doxygen::mainPage.get())
      {
        pd->setNestingLevel(m_nestingLevel);
      }
      else
      {
        pd->setNestingLevel(m_nestingLevel+1);
      }
    }
  }
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::definitionType(), m_nestingLevel, m_subPages, Doxygen::mainPage, Definition::name(), PageDef::setNestingLevel(), DefinitionMutable::setOuterScope(), toPageDef(), and Definition::TypePage.

addListReferences()

void PageDefImpl::addListReferences ( )

overridevirtual

Implements PageDef.

Definition at line 207 of file pagedef.cpp.

{
  DString name = getOutputFileBase();
  if (getGroupDef())
  {
    name = getGroupDef()->getOutputFileBase();
  }
  addRefItem(xrefListItems(),name,
             theTranslator->trPage(true,true),
             name,title(),DString(),nullptr);
}

References addRefItem(), DString::DString(), getGroupDef(), Definition::getOutputFileBase(), getOutputFileBase(), DefinitionMixin< PageDef >::name(), theTranslator, title(), Translator::trPage(), and DefinitionMixin< PageDef >::xrefListItems().

addRequirementReferences()

void PageDefImpl::addRequirementReferences ( )

overridevirtual

Implements PageDef.

Definition at line 219 of file pagedef.cpp.

{
  RequirementManager::instance().addRequirementRefsForSymbol(this);
}

References RequirementManager::addRequirementRefsForSymbol(), and RequirementManager::instance().

addSectionsToIndex()

void PageDefImpl::addSectionsToIndex ( )

overridevirtual

Implements PageDef.

Definition at line 153 of file pagedef.cpp.

{
  const SectionRefs &sectionRefs = getSectionRefs();
  if (sectionRefs.empty()) return;
  //printf("PageDefImpl::addSectionsToIndex()\n");
  int level=1;
  for (auto it = sectionRefs.begin(); it!=sectionRefs.end(); ++it)
  {
    const SectionInfo *si = *it;
    SectionType type = si->type();
    if (type.isSection())
    {
      //printf("  level=%d title=%s\n",level,qPrint(si->title));
      int nextLevel = type.level();
      if (nextLevel>level)
      {
        for (int i=level;i<nextLevel;i++)
        {
          Doxygen::indexList->incContentsDepth();
        }
      }
      else if (nextLevel<level)
      {
        for (int i=nextLevel;i<level;i++)
        {
          Doxygen::indexList->decContentsDepth();
        }
      }
      DString title = si->title();
      if (title.empty()) title = si->label();
      title = parseCommentAsText(this,nullptr,title,si->fileName(),si->lineNr());
      DString titleAsHtml = parseCommentAsHtml(this,nullptr,si->title(),si->fileName(),si->lineNr());
      // determine if there is a next level inside this item, but be aware of the anchor and table section references.
      auto it_next = std::next(it);
      bool isDir = (it_next!=sectionRefs.end()) ?  ((*it_next)->type().isSection() && (*it_next)->type().level() > nextLevel) : false;
      Doxygen::indexList->addContentsItem(isDir,               // isDir
                                          title,               // name
                                          getReference(),      // ref
                                          getOutputFileBase(), // file
                                          si->label(),         // anchor
                                          false,               // separateIndex
                                          true,                // addToNavIndex
                                          nullptr,             // def
                                          titleAsHtml);        // nameAsHtml
      level = nextLevel;
    }
  }
  while (level>1)
  {
    Doxygen::indexList->decContentsDepth();
    level--;
  }
}

References IndexList::addContentsItem(), SectionRefs::begin(), IndexList::decContentsDepth(), DString::empty(), SectionRefs::empty(), SectionRefs::end(), SectionInfo::fileName(), getOutputFileBase(), DefinitionMixin< PageDef >::getReference(), DefinitionMixin< PageDef >::getSectionRefs(), IndexList::incContentsDepth(), Doxygen::indexList, SectionType::isSection(), SectionInfo::label(), SectionType::level(), SectionInfo::lineNr(), parseCommentAsHtml(), parseCommentAsText(), title(), SectionInfo::title(), and SectionInfo::type().

anchor()

DString PageDefImpl::anchor ( ) const

inlineoverridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 46 of file pagedef.cpp.

{ return DString(); }

References DString::DString().

codeSymbolType()

CodeSymbolType PageDefImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 42 of file pagedef.cpp.

{ return CodeSymbolType::Default; }

References Default.

definitionType()

DefType PageDefImpl::definitionType ( ) const

inlineoverridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 41 of file pagedef.cpp.

{ return TypePage; }

References Definition::TypePage.

displayName()

DString PageDefImpl::displayName ( bool includeScope = true ) const

inlineoverridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 61 of file pagedef.cpp.

{ return hasTitle() ? m_title : DefinitionMixin::name(); }

References hasTitle(), m_title, and DefinitionMixin< Base >::name().

documentedPage()

bool PageDefImpl::documentedPage ( ) const

overridevirtual

Implements PageDef.

Definition at line 460 of file pagedef.cpp.

{
   return // not part of a group
          !getGroupDef() &&
          // not an externally defined page
          !isReference();
}

References getGroupDef(), and DefinitionMixin< PageDef >::isReference().

findSectionsInDocumentation()

void PageDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements PageDef.

Definition at line 107 of file pagedef.cpp.

{
  docFindSections(briefDescription(),this,docFile());
  docFindSections(documentation(),this,docFile());
  docFindSections(inbodyDocumentation(),this,docFile());
}

References DefinitionMixin< PageDef >::briefDescription(), DefinitionMixin< PageDef >::docFile(), docFindSections(), DefinitionMixin< PageDef >::documentation(), and DefinitionMixin< PageDef >::inbodyDocumentation().

getGroupDef()

const GroupDef * PageDefImpl::getGroupDef ( ) const

overridevirtual

Implements PageDef.

Definition at line 114 of file pagedef.cpp.

{
  return !partOfGroups().empty() ? partOfGroups().front() : nullptr;
}

References DefinitionMixin< PageDef >::partOfGroups().

Referenced by addListReferences(), documentedPage(), getOutputFileBase(), and visibleInIndex().

getOutputFileBase()

DString PageDefImpl::getOutputFileBase ( ) const

overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 119 of file pagedef.cpp.

{
  if (getGroupDef())
    return getGroupDef()->getOutputFileBase();
  else
    return m_fileName;
}

References getGroupDef(), Definition::getOutputFileBase(), and m_fileName.

Referenced by addListReferences(), addSectionsToIndex(), writeDocumentation(), and writeTagFile().

getPageScope()

Definition * PageDefImpl::getPageScope ( ) const

inlineoverridevirtual

Implements PageDef.

Definition at line 60 of file pagedef.cpp.

{ return m_pageScope; }

References m_pageScope.

getSubPages()

const PageLinkedRefMap & PageDefImpl::getSubPages ( ) const

inlineoverridevirtual

Implements PageDef.

Definition at line 51 of file pagedef.cpp.

{ return m_subPages; }

References m_subPages.

hasParentPage()

bool PageDefImpl::hasParentPage ( ) const

overridevirtual

Implements PageDef.

Definition at line 224 of file pagedef.cpp.

{
  return getOuterScope() &&
         getOuterScope()->definitionType()==Definition::TypePage;
}

References Definition::definitionType(), DefinitionMixin< PageDef >::getOuterScope(), and Definition::TypePage.

hasSubPages()

bool PageDefImpl::hasSubPages ( ) const

overridevirtual

Implements PageDef.

Definition at line 468 of file pagedef.cpp.

{
  return !m_subPages.empty();
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::empty(), and m_subPages.

Referenced by writePageDocumentation().

hasTitle()

bool PageDefImpl::hasTitle ( ) const

overridevirtual

Implements PageDef.

Definition at line 493 of file pagedef.cpp.

{
  return !m_title.empty() && m_title.lower()!="notitle";
}

References DString::empty(), DString::lower(), and m_title.

Referenced by displayName(), and writeDocumentation().

isLinkable()

bool PageDefImpl::isLinkable ( ) const

inlineoverridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 44 of file pagedef.cpp.

{ return isLinkableInProject() || isReference(); }

References isLinkableInProject(), and DefinitionMixin< PageDef >::isReference().

isLinkableInProject()

bool PageDefImpl::isLinkableInProject ( ) const

inlineoverridevirtual

Returns true iff it is possible to link to this item within this project.

Implements Definition.

Definition at line 43 of file pagedef.cpp.

{ return /*hasDocumentation() &&*/ !isReference(); }

References DefinitionMixin< PageDef >::isReference().

Referenced by isLinkable().

localToc()

LocalToc PageDefImpl::localToc ( ) const

inlineoverridevirtual

Implements PageDef.

Definition at line 58 of file pagedef.cpp.

{ return m_localToc; }

References m_localToc.

setFileName()

void PageDefImpl::setFileName ( const DString & name )

overridevirtual

Implements PageDef.

Definition at line 127 of file pagedef.cpp.

{
  m_fileName = name;
}

References m_fileName, and DefinitionMixin< PageDef >::name().

setLocalToc()

void PageDefImpl::setLocalToc ( const LocalToc & tl )

overridevirtual

Implements PageDef.

Definition at line 478 of file pagedef.cpp.

{
  m_localToc = lt;
}

References m_localToc.

setNestingLevel()

void PageDefImpl::setNestingLevel ( int l )

overridevirtual

Implements PageDef.

Definition at line 473 of file pagedef.cpp.

{
  m_nestingLevel = l;
}

References m_nestingLevel.

setPageScope()

void PageDefImpl::setPageScope ( Definition * d )

inlineoverridevirtual

Implements PageDef.

Definition at line 59 of file pagedef.cpp.

{ m_pageScope = d; }

References m_pageScope.

setShowLineNo()

void PageDefImpl::setShowLineNo ( bool b )

overridevirtual

Implements PageDef.

Definition at line 483 of file pagedef.cpp.

{
  m_showLineNo = b;
}

References m_showLineNo.

setTitle()

void PageDefImpl::setTitle ( const DString & title )

overridevirtual

Implements PageDef.

Definition at line 498 of file pagedef.cpp.

{
  if (!title.empty())
  {
    m_title = title;
    m_titleAsText = parseCommentAsText(this,nullptr,title,docFile(),docLine());
  }
  else
  {
    m_title = name();
    m_titleAsText = m_title;
  }
}

References DefinitionMixin< PageDef >::docFile(), DefinitionMixin< PageDef >::docLine(), DString::empty(), m_title, m_titleAsText, DefinitionMixin< PageDef >::name(), parseCommentAsText(), and title().

Referenced by PageDefImpl().

showLineNo()

bool PageDefImpl::showLineNo ( ) const

overridevirtual

Implements PageDef.

Definition at line 488 of file pagedef.cpp.

{
  return m_showLineNo;
}

References m_showLineNo.

title()

DString PageDefImpl::title ( ) const

inlineoverridevirtual

Implements PageDef.

Definition at line 48 of file pagedef.cpp.

{ return m_title; }

References m_title.

Referenced by addListReferences(), addSectionsToIndex(), setTitle(), writeDocumentation(), and writeTagFile().

titleAsText()

DString PageDefImpl::titleAsText ( ) const

overridevirtual

Implements PageDef.

Definition at line 512 of file pagedef.cpp.

{
  return m_titleAsText;
}

References m_titleAsText.

Referenced by writeDocumentation().

visibleInIndex()

bool PageDefImpl::visibleInIndex ( ) const

overridevirtual

Implements PageDef.

Definition at line 451 of file pagedef.cpp.

{
  bool externalPages = Config_getBool(EXTERNAL_PAGES);
  return // not part of a group
         !getGroupDef() &&
         // not an externally defined page
         (!isReference() || externalPages);
}

References Config_getBool, getGroupDef(), and DefinitionMixin< PageDef >::isReference().

writeDocumentation()

void PageDefImpl::writeDocumentation ( OutputList & ol )

overridevirtual

Implements PageDef.

Definition at line 260 of file pagedef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  int hierarchyLevel = -1; // Pages start at the root
  PageDef *pd = this;
  while (pd && pd->hasParentPage())
  {
    pd = dynamic_cast<PageDef *>(pd->getOuterScope());
    ++hierarchyLevel;
  }
 
  //outputList->disable(OutputType::Man);
  DString pageName,manPageName;
  pageName    = escapeCharsInString(name(),false,true);
  manPageName = escapeCharsInString(name(),true,true);
 
  //printf("PageDefImpl::writeDocumentation: %s\n",getOutputFileBase().data());
 
  ol.pushGeneratorState();
  //1.{
 
  ol.pushGeneratorState();
  //2.{
  ol.disableAllBut(OutputType::Man);
  startFile(ol,getOutputFileBase(),false,manPageName,titleAsText(),HighlightedItem::Pages,!generateTreeView,
            DString() /* altSidebarName */, hierarchyLevel);
  ol.enableAll();
  ol.disable(OutputType::Man);
  startFile(ol,getOutputFileBase(),false,pageName,titleAsText(),HighlightedItem::Pages,!generateTreeView,
            DString() /* altSidebarName */, hierarchyLevel);
  ol.popGeneratorState();
  //2.}
 
  if (!generateTreeView)
  {
    if (getOuterScope()!=Doxygen::globalScope && !Config_getBool(DISABLE_INDEX))
    {
      DefinitionMutable *outerScope = toDefinitionMutable(getOuterScope());
      if (outerScope)
      {
        outerScope->writeNavigationPath(ol);
      }
    }
    ol.endQuickIndices();
  }
  const SectionInfo *si=SectionManager::instance().find(name());
 
  // save old generator state and write title only to Man generator
  ol.pushGeneratorState();
  //2.{
  ol.disableAllBut(OutputType::Man);
  ol.startTitleHead(manPageName);
  ol.endTitleHead(manPageName, manPageName);
  if (si)
  {
    ol.writeString(" - ");
 
    if (si->title() != manPageName)
    {
      ol.generateDoc(docFile(),
                     getStartBodyLine(),
                     this,
                     nullptr,
                     si->title(),
                     DocOptions()
                     .setSingleLine(true)
                     .setAutolinkSupport(false));
      ol.endSection(si->label(),si->type());
    }
  }
  ol.popGeneratorState();
  //2.}
 
  ol.pushGeneratorState();
  //2.{
  ol.disable(OutputType::Man);
  DString title;
  if (this == Doxygen::mainPage.get() && !hasTitle())
    title = theTranslator->trMainPage();
  else
    title = m_title;
 
  if (!title.empty() && !name().empty() && si!=nullptr)
  {
    ol.startPageDoc(si->title());
    ol.startHeaderSection();
    ol.startTitleHead(getOutputFileBase());
    ol.generateDoc(docFile(),
                   getStartBodyLine(),
                   this,
                   nullptr,
                   title,
                   DocOptions()
                   .setIndexWords(true)
                   .setSingleLine(true)
                   .setAutolinkSupport(false));
    ol.endTitleHead(getOutputFileBase(),title);
    ol.endHeaderSection();
  }
  else
  {
    ol.startPageDoc("");
  }
  ol.popGeneratorState();
  //2.}
 
  bool pageWithSections = hasSections();
  ol.startContents();
  if ((m_localToc.isHtmlEnabled() || m_localToc.isLatexEnabled() || m_localToc.isDocbookEnabled())
    && pageWithSections)
  {
    writeToc(ol, m_localToc);
  }
 
  writePageDocumentation(ol);
  ol.endContents();
  ol.endPageDoc();
 
  if (generateTreeView && getOuterScope()!=Doxygen::globalScope && !Config_getBool(DISABLE_INDEX))
  {
    endFileWithNavPath(ol,toDefinitionMutable(const_cast<Definition*>(getOuterScope())));
  }
  else
  {
    if (generateTreeView && Config_getBool(PAGE_OUTLINE_PANEL) && pageWithSections)
    {
      ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      ol.writeString("</div><!-- doc-content -->\n");
      writePageNavigation(ol);
      ol.writeString("</div><!-- container -->\n");
      ol.popGeneratorState();
      endFile(ol,true);
    }
    else
    {
      endFile(ol,false,true);
    }
  }
 
  ol.popGeneratorState();
  //1.}
}

References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< PageDef >::docFile(), DString::DString(), DString::empty(), OutputList::enableAll(), OutputList::endContents(), endFile(), endFileWithNavPath(), OutputList::endHeaderSection(), OutputList::endPageDoc(), OutputList::endQuickIndices(), OutputList::endSection(), OutputList::endTitleHead(), escapeCharsInString(), LinkedMap< T, Hash, KeyEqual, Map >::find(), OutputList::generateDoc(), Definition::getOuterScope(), DefinitionMixin< PageDef >::getOuterScope(), getOutputFileBase(), DefinitionMixin< PageDef >::getStartBodyLine(), Doxygen::globalScope, PageDef::hasParentPage(), DefinitionMixin< PageDef >::hasSections(), hasTitle(), Html, SectionManager::instance(), LocalToc::isDocbookEnabled(), LocalToc::isHtmlEnabled(), LocalToc::isLatexEnabled(), SectionInfo::label(), m_localToc, m_title, Doxygen::mainPage, Man, DefinitionMixin< PageDef >::name(), Pages, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startContents(), startFile(), OutputList::startHeaderSection(), OutputList::startPageDoc(), OutputList::startTitleHead(), theTranslator, title(), SectionInfo::title(), titleAsText(), Definition::toDefinitionMutable, Translator::trMainPage(), SectionInfo::type(), DefinitionMutable::writeNavigationPath(), writePageDocumentation(), writePageNavigation(), OutputList::writeString(), and DefinitionMixin< PageDef >::writeToc().

writePageDocumentation()

void PageDefImpl::writePageDocumentation ( OutputList & ol ) const

overridevirtual

Implements PageDef.

Definition at line 404 of file pagedef.cpp.

{
  ol.startTextBlock();
  DString docStr = (briefDescription().empty()?"":briefDescription()+"\n\n")+documentation()+inbodyDocumentation();
  if (hasBriefDescription() && !SectionManager::instance().find(name()))
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Man);
    ol.writeString(" - ");
    ol.popGeneratorState();
  }
  ol.generateDoc(
      docFile(),           // fileName
      docLine(),           // startLine
      this,                // context
      nullptr,             // memberdef
      docStr,              // docStr
      DocOptions()
      .setIndexWords(true));
  ol.endTextBlock();
 
  if (hasSubPages())
  {
    // for printed documentation we write subpages as section's of the
    // parent page.
    ol.pushGeneratorState();
    ol.disableAll();
    ol.enable(OutputType::Latex);
    ol.enable(OutputType::Docbook);
    ol.enable(OutputType::RTF);
 
    for (const auto &subPage : m_subPages)
    {
      ol.writePageLink(subPage->getOutputFileBase(), false);
    }
 
    ol.popGeneratorState();
  }
 
  if (hasRequirementRefs()) writeRequirementRefs(ol);
}

References DefinitionMixin< PageDef >::briefDescription(), OutputList::disableAll(), OutputList::disableAllBut(), Docbook, DefinitionMixin< PageDef >::docFile(), DefinitionMixin< PageDef >::docLine(), DefinitionMixin< PageDef >::documentation(), DString::empty(), OutputList::enable(), OutputList::endTextBlock(), OutputList::generateDoc(), DefinitionMixin< PageDef >::hasBriefDescription(), DefinitionMixin< PageDef >::hasRequirementRefs(), hasSubPages(), DefinitionMixin< PageDef >::inbodyDocumentation(), SectionManager::instance(), Latex, m_subPages, Man, DefinitionMixin< PageDef >::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startTextBlock(), OutputList::writePageLink(), DefinitionMixin< PageDef >::writeRequirementRefs(), and OutputList::writeString().

Referenced by writeDocumentation().

writePageNavigation()

void PageDefImpl::writePageNavigation ( OutputList & ol ) const

overridevirtual

Reimplemented from DefinitionMixin< PageDef >.

Definition at line 446 of file pagedef.cpp.

{
  ol.writePageOutline();
}

References OutputList::writePageOutline().

Referenced by writeDocumentation().

writeTagFile()

void PageDefImpl::writeTagFile ( TextStream & tagFile )

overridevirtual

Implements PageDef.

Definition at line 230 of file pagedef.cpp.

{
  bool found = name()=="citelist" || name()=="requirements";
  for (RefListManager::Ptr &rl : RefListManager::instance())
  {
    if (rl->listName()==name())
    {
      found=true;
      break;
    }
  }
  if (!found) // not one of the generated related pages
  {
    DString fn = getOutputFileBase();
    addHtmlExtensionIfMissing(fn);
    tagFile << "  <compound kind=\"page\">\n";
    tagFile << "    <name>" << name() << "</name>\n";
    tagFile << "    <title>" << convertToXML(title()) << "</title>\n";
    tagFile << "    <filename>" << fn << "</filename>\n";
    for (const auto &subPage : m_subPages)
    {
      DString sfn = subPage->getOutputFileBase();
      addHtmlExtensionIfMissing(sfn);
      tagFile << "    <subpage>" << sfn << "</subpage>\n";
    }
    writeDocAnchorsToTagFile(tagFile);
    tagFile << "  </compound>\n";
  }
}

References addHtmlExtensionIfMissing(), convertToXML(), getOutputFileBase(), RefListManager::instance(), m_subPages, DefinitionMixin< PageDef >::name(), title(), and DefinitionMixin< PageDef >::writeDocAnchorsToTagFile().

Member Data Documentation

m_fileName

DString PageDefImpl::m_fileName

private

Definition at line 74 of file pagedef.cpp.

Referenced by getOutputFileBase(), PageDefImpl(), and setFileName().

m_localToc

LocalToc PageDefImpl::m_localToc

private

Definition at line 80 of file pagedef.cpp.

Referenced by localToc(), setLocalToc(), and writeDocumentation().

m_nestingLevel

int PageDefImpl::m_nestingLevel

private

Definition at line 79 of file pagedef.cpp.

Referenced by addInnerCompound(), PageDefImpl(), and setNestingLevel().

m_pageScope

Definition* PageDefImpl::m_pageScope

private

Definition at line 78 of file pagedef.cpp.

Referenced by getPageScope(), PageDefImpl(), and setPageScope().

m_showLineNo

bool PageDefImpl::m_showLineNo

private

Definition at line 81 of file pagedef.cpp.

Referenced by PageDefImpl(), setShowLineNo(), and showLineNo().

m_subPages

PageLinkedRefMap PageDefImpl::m_subPages

private

Definition at line 77 of file pagedef.cpp.

Referenced by addInnerCompound(), getSubPages(), hasSubPages(), writePageDocumentation(), and writeTagFile().

m_title

DString PageDefImpl::m_title

private

Definition at line 75 of file pagedef.cpp.

Referenced by displayName(), hasTitle(), setTitle(), title(), and writeDocumentation().

m_titleAsText

DString PageDefImpl::m_titleAsText

private

Definition at line 76 of file pagedef.cpp.

Referenced by setTitle(), and titleAsText().

---

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

• src/pagedef.cpp