pagedef.h File Reference

#include "definition.h"

Include dependency graph for pagedef.h:

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

Go to the source code of this file.

Classes
class	PageDef
	A model of a page symbol. More...
class	PageLinkedMap
class	PageLinkedRefMap

Functions
std::unique_ptr< PageDef >	createPageDef (const DString &f, int l, const DString &n, const DString &d, const DString &t)
PageDef *	addRelatedPage (const DString &name, const DString &ptitle, const DString &doc, const DString &fileName, int docLine, int startLine, const RefItemVector &sli=RefItemVector(), GroupDef *gd=nullptr, const TagInfo *tagInfo=nullptr, bool xref=false, SrcLangExt lang=SrcLangExt::Unknown)
PageDef *	toPageDef (Definition *d)
const PageDef *	toPageDef (const Definition *d)

Function Documentation

addRelatedPage()

PageDef * addRelatedPage	(	const DString &	name,
		const DString &	ptitle,
		const DString &	doc,
		const DString &	fileName,
		int	docLine,
		int	startLine,
		const RefItemVector &	sli = RefItemVector(),
		GroupDef *	gd = nullptr,
		const TagInfo *	tagInfo = nullptr,
		bool	xref = false,
		SrcLangExt	lang = SrcLangExt::Unknown )

Definition at line 524 of file pagedef.cpp.

{
  PageDef *pd=nullptr;
  //printf("addRelatedPage(name=%s gd=%p)\n",qPrint(name),gd);
  DString title=ptitle.stripWhiteSpace();
  bool newPage = true;
  if ((pd=Doxygen::pageLinkedMap->find(name)) && !pd->isReference())
  {
    if (!xref && !title.empty() && pd->title()!=pd->name() && pd->title()!=title)
    {
      warn(fileName,startLine,"multiple use of page label '{}' with different titles, (other occurrence: {}, line: {})",
         name,pd->docFile(),pd->getStartBodyLine());
    }
    if (!title.empty() && pd->title()==pd->name()) // pd has no real title yet
    {
      pd->setTitle(title);
      SectionInfo *si = SectionManager::instance().find(pd->name());
      if (si)
      {
        si->setTitle(title);
      }
    }
    // append documentation block to the page.
    pd->setDocumentation(doc,fileName,docLine);
    //printf("Adding page docs '%s' pi=%p name=%s\n",qPrint(doc),pd,name);
    // append (x)refitems to the page.
    pd->setRefItems(sli);
    newPage = false;
  }
 
  if (newPage) // new page
  {
    DString baseName=name;
    if (baseName.endsWith(".tex"))
      baseName=baseName.left(baseName.length()-4);
    else if (baseName.right(Doxygen::htmlFileExtension.length())==Doxygen::htmlFileExtension)
      baseName=baseName.left(baseName.length()-Doxygen::htmlFileExtension.length());
 
    //printf("Appending page '%s'\n",qPrint(baseName));
    if (pd) // replace existing page
    {
      pd->setDocumentation(doc,fileName,docLine);
      pd->setFileName(::convertNameToFile(baseName,false,true));
      pd->setShowLineNo(false);
      pd->setNestingLevel(0);
      pd->setPageScope(nullptr);
      pd->setTitle(title);
      pd->setReference(DString());
    }
    else // newPage
    {
      pd = Doxygen::pageLinkedMap->add(baseName,
             createPageDef(fileName,docLine,baseName,doc,title));
    }
    pd->setBodySegment(startLine,startLine,-1);
 
    pd->setRefItems(sli);
    pd->setLanguage(lang);
 
    if (tagInfo)
    {
      pd->setReference(tagInfo->tagName);
      pd->setFileName(tagInfo->fileName);
    }
 
    if (gd) gd->addPage(pd);
 
    if (pd->hasTitle())
    {
      //outputList->writeTitle(pi->name,pi->title);
 
      // a page name is a label as well!
      DString file;
      DString orgFile;
      int line  = -1;
      if (gd)
      {
        file=gd->getOutputFileBase();
        orgFile=gd->getOutputFileBase();
      }
      else
      {
        file=pd->getOutputFileBase();
        orgFile=pd->docFile();
        line = pd->getStartBodyLine();
      }
      const SectionInfo *si = SectionManager::instance().find(pd->name());
      if (si)
      {
        if (!si->ref().empty()) // we are from a tag file
        {
          SectionManager::instance().replace(pd->name(),
              file,-1,pd->title(),SectionType::Page,0,pd->getReference());
        }
        else if (si->lineNr() != -1)
        {
          warn(orgFile,line,"multiple use of section label '{}', (first occurrence: {}, line {})",pd->name(),si->fileName(),si->lineNr());
        }
        else
        {
          warn(orgFile,line,"multiple use of section label '{}', (first occurrence: {})",pd->name(),si->fileName());
        }
      }
      else
      {
        SectionManager::instance().add(pd->name(),
            file,-1,pd->title(),SectionType::Page,0,pd->getReference());
        //printf("si->label='%s' si->definition=%s si->fileName='%s'\n",
        //      qPrint(si->label),si->definition?si->definition->name().data():"<none>",
        //      qPrint(si->fileName));
        //printf("  SectionInfo: sec=%p sec->fileName=%s\n",si,qPrint(si->fileName));
        //printf("Adding section key=%s si->fileName=%s\n",qPrint(pageName),qPrint(si->fileName));
      }
    }
  }
  return pd;
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), SectionManager::add(), GroupDef::addPage(), convertNameToFile(), createPageDef(), Definition::docFile(), DString::empty(), DString::endsWith(), SectionInfo::fileName(), TagInfo::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getStartBodyLine(), PageDef::hasTitle(), Doxygen::htmlFileExtension, SectionManager::instance(), Definition::isReference(), DString::left(), DString::length(), SectionInfo::lineNr(), Definition::name(), SectionType::Page, Doxygen::pageLinkedMap, SectionInfo::ref(), SectionManager::replace(), DString::right(), DefinitionMutable::setBodySegment(), DefinitionMutable::setDocumentation(), PageDef::setFileName(), DefinitionMutable::setLanguage(), PageDef::setNestingLevel(), PageDef::setPageScope(), DefinitionMutable::setReference(), DefinitionMutable::setRefItems(), PageDef::setShowLineNo(), PageDef::setTitle(), SectionInfo::setTitle(), DString::stripWhiteSpace(), TagInfo::tagName, PageDef::title(), and warn.

Referenced by RequirementManager::addRequirement(), PageDef::addRequirementReferences(), CitationManager::generatePage(), and RefList::generatePage().

createPageDef()

std::unique_ptr< PageDef > createPageDef	(	const DString &	f,
		int	l,
		const DString &	n,
		const DString &	d,
		const DString &	t )

Definition at line 89 of file pagedef.cpp.

{
  return std::make_unique<PageDefImpl>(f,l,n,d,t);
}

Referenced by addRelatedPage(), PageDef::addRequirementReferences(), buildExampleList(), and findMainPage().

toPageDef() [1/2]

const PageDef * toPageDef

(

const Definition *

d

)

Definition at line 661 of file pagedef.cpp.

{
  return (d && typeid(*d) == typeid(PageDefImpl)) ? static_cast<const PageDef*>(d) : nullptr;
}

toPageDef() [2/2]

PageDef * toPageDef

(

Definition *

d

)

Definition at line 656 of file pagedef.cpp.

{
  return (d && typeid(*d) == typeid(PageDefImpl)) ? static_cast<PageDef*>(d) : nullptr;
}

Referenced by PageDefImpl::addInnerCompound(), PageDef::addRequirementReferences(), SearchTerm::makeTitle(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), SearchIndex::setCurrentDoc(), SearchIndexExternal::setCurrentDoc(), validatingParseDoc(), and writeJavasScriptSearchDataPage().