FileDefImpl Class Reference

Inheritance diagram for FileDefImpl:

Collaboration diagram for FileDefImpl:

Public Member Functions
	FileDefImpl (const DString &p, const DString &n, const DString &ref=DString(), const DString &dn=DString())
	~FileDefImpl () override
DefType	definitionType () const override
CodeSymbolType	codeSymbolType () const override
const DString &	name () const override
DString	displayName (bool=true) const override
DString	fileName () const override
DString	getOutputFileBase () const override
DString	anchor () const override
DString	getSourceFileBase () const override
DString	includeName () const override
DString	includeDependencyGraphFileName () const override
DString	includedByDependencyGraphFileName () const override
DString	absFilePath () const override
const DString &	docName () const override
bool	isSource () const override
bool	isDocumentationFile () const override
const Definition *	getSourceDefinition (int lineNr) const override
const MemberDef *	getSourceMember (int lineNr) const override
DString	getPath () const override
DString	getVersion () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
bool	isIncluded (const DString &name) const override
DirDef *	getDirDef () const override
ModuleDef *	getModuleDef () const override
const LinkedRefMap< NamespaceDef > &	getUsedNamespaces () const override
const LinkedRefMap< const Definition > &	getUsedDefinitions () const override
const IncludeInfoList &	includeFileList () const override
const IncludeInfoList &	includedByFileList () const override
void	getAllIncludeFilesRecursively (StringVector &incFiles) const override
MemberList *	getMemberList (MemberListType lt) const override
const MemberLists &	getMemberLists () const override
const MemberGroupList &	getMemberGroups () const override
const NamespaceLinkedRefMap &	getNamespaces () const override
const ConceptLinkedRefMap &	getConcepts () const override
const ClassLinkedRefMap &	getClasses () const override
DString	title () const override
bool	hasDetailedDescription () const override
DString	fileVersion () const override
bool	subGrouping () const override
void	countMembers () override
int	numDocMembers () const override
int	numDecMembers () const override
void	addSourceRef (int line, const Definition *d, const MemberDef *md) override
void	writeDocumentation (OutputList &ol) override
void	writeMemberPages (OutputList &ol) override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
void	writeTagFile (TextStream &t) override
void	writeSourceHeader (OutputList &ol) override
void	writeSourceBody (OutputList &ol, ClangTUParser *clangParser) override
void	writeSourceFooter (OutputList &ol) override
void	parseSource (ClangTUParser *clangParser) override
void	setDiskName (const DString &name) override
void	insertMember (MemberDef *md) override
void	removeMember (MemberDef *md) override
void	insertClass (ClassDef *cd) override
void	insertConcept (ConceptDef *cd) override
void	insertNamespace (NamespaceDef *nd) override
void	computeAnchors () override
void	setDirDef (DirDef *dd) override
void	setModuleDef (ModuleDef *mod) override
void	addUsingDirective (NamespaceDef *nd) override
void	addUsingDeclaration (const Definition *d) override
void	combineUsingRelations () override
bool	generateSourceFile () const override
void	sortMemberLists () override
void	addIncludeDependency (const FileDef *fd, const DString &incName, IncludeKind kind) override
void	addIncludedByDependency (const FileDef *fd, const DString &incName, IncludeKind kind) override
void	addMembersToMemberGroup () override
void	distributeMemberGroupDocumentation () override
void	findSectionsInDocumentation () override
void	setIncludeFile (FileDef *fd, const DString &includeName, bool local, bool force) override
void	addIncludedUsingDirectives (FileDefSet &visitedFiles) override
void	addListReferences () override
void	addRequirementReferences () override
bool	hasIncludeGraph () const override
bool	hasIncludedByGraph () const override
void	overrideIncludeGraph (bool e) override
void	overrideIncludedByGraph (bool e) override
bool	visibleInIndex (bool &genSourceFile) const override
	Returns true if this file is visible in the index.
Public Member Functions inherited from DefinitionMixin< FileDef >
	DefinitionMixin (const DString &defFileName, int defLine, size_t 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
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () 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
size_t	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, size_t 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	addInnerCompound (Definition *def) 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
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 Member Functions
void	setDiskNameLocal (const DString &name)
void	acquireFileVersion ()
void	addMemberToList (MemberListType lt, MemberDef *md)
void	writeMemberDeclarations (OutputList &ol, MemberListType lt, const DString &title)
void	writeMemberDocumentation (OutputList &ol, MemberListType lt, const DString &title)
void	writeIncludeFiles (OutputList &ol)
void	writeIncludeGraph (OutputList &ol)
void	writeIncludedByGraph (OutputList &ol)
void	writeMemberGroups (OutputList &ol)
void	writeAuthorSection (OutputList &ol)
void	writeSourceLink (OutputList &ol)
void	writeNamespaceDeclarations (OutputList &ol, const DString &title, bool isConstantGroup)
void	writeClassDeclarations (OutputList &ol, const DString &title, const ClassLinkedRefMap &list)
void	writeConcepts (OutputList &ol, const DString &title)
void	writeInlineClasses (OutputList &ol)
void	startMemberDeclarations (OutputList &ol)
void	endMemberDeclarations (OutputList &ol)
void	startMemberDocumentation (OutputList &ol)
void	endMemberDocumentation (OutputList &ol)
void	writeDetailedDescription (OutputList &ol, const DString &title)
void	writeBriefDescription (OutputList &ol)
void	writeClassesToTagFile (TextStream &t, const ClassLinkedRefMap &list)
void	removeMemberFromList (MemberListType lt, MemberDef *md)

Private Attributes
IncludeInfoMap	m_includeMap
IncludeInfoList	m_includeList
IncludeInfoMap	m_includedByMap
IncludeInfoList	m_includedByList
LinkedRefMap< NamespaceDef >	m_usingDirList
LinkedRefMap< const Definition >	m_usingDeclList
std::unique_ptr< IncludeInfo >	m_incInfo
DString	m_path
DString	m_filePath
DString	m_inclDepFileName
DString	m_inclByDepFileName
DString	m_outputDiskName
DString	m_fileName
DString	m_docname
DefinitionLineMap	m_srcDefMap
MemberDefLineMap	m_srcMemberMap
bool	m_isSource
DString	m_fileVersion
DirDef *	m_dir = nullptr
ModuleDef *	m_moduleDef = nullptr
MemberLists	m_memberLists
MemberGroupList	m_memberGroups
NamespaceLinkedRefMap	m_namespaces
ClassLinkedRefMap	m_classes
ClassLinkedRefMap	m_interfaces
ClassLinkedRefMap	m_structs
ClassLinkedRefMap	m_exceptions
ConceptLinkedRefMap	m_concepts
bool	m_subGrouping
bool	m_hasIncludeGraph = Config_getBool(INCLUDE_GRAPH)
bool	m_hasIncludedByGraph = Config_getBool(INCLUDED_BY_GRAPH)

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 118 of file filedef.cpp.

Constructor & Destructor Documentation

FileDefImpl()

FileDefImpl::FileDefImpl	(	const DString &	p,
		const DString &	nm,
		const DString &	lref = DString(),
		const DString &	dn = DString() )

create a new file definition, where p is the file path, nm the file name, and lref is an HTML anchor name if the file was read from a tag file or nullptr otherwise

Definition at line 281 of file filedef.cpp.

   : DefinitionMixin(p+nm,1,1,nm,nullptr,nullptr,!p.empty())
{
  m_path=Portable::removeLongPathMarker(p);
  m_filePath=p+nm;
  m_fileName=nm;
 
  setReference(lref);
  setDiskNameLocal(!dn.empty() ? dn : nm);
  m_isSource          = EntryType::guessSection(nm).isSource();
  m_docname           = nm;
  m_dir               = nullptr;
  if (Config_getBool(FULL_PATH_NAMES))
  {
    m_docname.prepend(stripFromPath(m_path));
  }
  setLanguage(getLanguageFromFileName(
     Config_getBool(FULL_PATH_NAMES) ? m_fileName : DefinitionMixin::name()));
  acquireFileVersion();
  m_subGrouping=Config_getBool(SUBGROUPING);
}

References acquireFileVersion(), Config_getBool, DefinitionMixin< FileDef >::DefinitionMixin(), DString::empty(), getLanguageFromFileName(), EntryType::guessSection(), m_dir, m_docname, m_fileName, m_filePath, m_isSource, m_path, m_subGrouping, DefinitionMixin< Base >::name(), DString::prepend(), Portable::removeLongPathMarker(), setDiskNameLocal(), DefinitionMixin< FileDef >::setLanguage(), DefinitionMixin< FileDef >::setReference(), and stripFromPath().

~FileDefImpl()

FileDefImpl::~FileDefImpl ( )

override

destroy the file definition

Definition at line 305 of file filedef.cpp.

{
}

Member Function Documentation

absFilePath()

DString FileDefImpl::absFilePath ( ) const

inlineoverridevirtual

Returns the absolute path including the file name.

Implements FileDef.

Definition at line 137 of file filedef.cpp.

{ return m_filePath; }

References m_filePath.

Referenced by parseSource(), and writeSourceBody().

acquireFileVersion()

void FileDefImpl::acquireFileVersion ( )

private

Definition at line 1757 of file filedef.cpp.

{
  DString vercmd = Config_getString(FILE_VERSION_FILTER);
  if (!vercmd.empty() && !m_filePath.empty() && !isReference() &&
      m_filePath!="generated" && m_filePath!="graph_legend.dox")
  {
    msg("Version of {} : ",m_filePath);
    DString cmd = vercmd+" \""+m_filePath+"\"";
    Debug::print(Debug::ExtCmd,0,"Executing popen(`{}`)\n",cmd);
    FILE *f=Portable::popen(cmd,"r");
    if (!f)
    {
      err("could not execute {}\n",vercmd);
      return;
    }
    const int bufSize=1024;
    char buf[bufSize];
    int numRead = static_cast<int>(fread(buf,1,bufSize-1,f));
    Portable::pclose(f);
    if (numRead>0 && numRead<bufSize)
    {
      buf[numRead]='\0';
      m_fileVersion=DString(buf,numRead).stripWhiteSpace();
      if (!m_fileVersion.empty())
      {
        msg("{}\n",m_fileVersion);
        return;
      }
    }
    msg("no version available\n");
  }
}

References Config_getString, DString::empty(), err, Debug::ExtCmd, DefinitionMixin< FileDef >::isReference(), m_filePath, m_fileVersion, msg, Portable::pclose(), Portable::popen(), Debug::print(), and DString::stripWhiteSpace().

Referenced by FileDefImpl().

addIncludedByDependency()

void FileDefImpl::addIncludedByDependency ( const FileDef * fd, const DString & incName, IncludeKind kind )

overridevirtual

Implements FileDef.

Definition at line 1649 of file filedef.cpp.

{
  //printf("FileDefImpl::addIncludedByDependency(%p,%s,%d)\n",fd,incName,local);
  DString iName = fd ? fd->absFilePath() : incName;
  if (!iName.empty() && m_includedByMap.find(iName.str())==m_includedByMap.end())
  {
    m_includedByList.emplace_back(fd,incName,kind);
    m_includedByMap.emplace(iName.str(),&m_includedByList.back());
  }
}

References FileDef::absFilePath(), DString::empty(), m_includedByList, m_includedByMap, and DString::str().

addIncludeDependency()

void FileDefImpl::addIncludeDependency ( const FileDef * fd, const DString & incName, IncludeKind kind )

overridevirtual

Implements FileDef.

Definition at line 1590 of file filedef.cpp.

{
  //printf("FileDefImpl::addIncludeDependency(%p,%s,%d)\n",(void*)fd,qPrint(incName),kind);
  DString iName = fd ? fd->absFilePath() : incName;
  if (!iName.empty() && m_includeMap.find(iName.str())==m_includeMap.end())
  {
    m_includeList.emplace_back(fd,incName,kind);
    m_includeMap.emplace(iName.str(),&m_includeList.back());
  }
}

References FileDef::absFilePath(), DString::empty(), m_includeList, m_includeMap, and DString::str().

addIncludedUsingDirectives()

void FileDefImpl::addIncludedUsingDirectives ( FileDefSet & visitedFiles )

overridevirtual

Implements FileDef.

Definition at line 1601 of file filedef.cpp.

{
  if (visitedFiles.find(this)!=visitedFiles.end()) return; // file already processed
  visitedFiles.insert(this);
  //printf("( FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
 
  if (!m_includeList.empty()) // file contains #includes
  {
    {
      for (const auto &ii : m_includeList) // foreach #include...
      {
        if (ii.fileDef) // ...that is a known file
        {
          // recurse into this file
          const_cast<FileDef*>(ii.fileDef)->addIncludedUsingDirectives(visitedFiles);
        }
      }
    }
    {
      // iterate through list from last to first
      for (auto ii_it = m_includeList.rbegin(); ii_it!=m_includeList.rend(); ++ii_it)
      {
        auto &ii = *ii_it;
        if (ii.fileDef && ii.fileDef!=this)
        {
          // add using directives
          auto unl = ii.fileDef->getUsedNamespaces();
          for (auto it = unl.rbegin(); it!=unl.rend(); ++it)
          {
            auto *nd = *it;
            //printf("  adding using directive for %s\n",qPrint(nd->qualifiedName()));
            m_usingDirList.prepend(nd->qualifiedName(),nd);
          }
          // add using declarations
          auto  udl = ii.fileDef->getUsedDefinitions();
          for (auto it = udl.rbegin(); it!=udl.rend(); ++it)
          {
            auto *d = *it;
            m_usingDeclList.prepend(d->qualifiedName(),d);
          }
        }
      }
    }
  }
  //printf(") end FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
}

References addIncludedUsingDirectives(), DString::insert(), m_includeList, m_usingDeclList, m_usingDirList, and LinkedRefMap< T, Hash, KeyEqual, Map >::prepend().

Referenced by addIncludedUsingDirectives().

addListReferences()

void FileDefImpl::addListReferences ( )

overridevirtual

Implements FileDef.

Definition at line 1678 of file filedef.cpp.

{
  addRefItem(xrefListItems(),
             getOutputFileBase(),
             theTranslator->trFile(true,true),
             getOutputFileBase(),name(),
             DString(),
             nullptr
            );
  for (const auto &mg : m_memberGroups)
  {
    mg->addListReferences(this);
  }
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDocumentation())
    {
      ml->addListReferences(this);
    }
  }
}

References addRefItem(), getOutputFileBase(), m_memberGroups, m_memberLists, name(), theTranslator, Translator::trFile(), and DefinitionMixin< FileDef >::xrefListItems().

addMembersToMemberGroup()

void FileDefImpl::addMembersToMemberGroup ( )

overridevirtual

Implements FileDef.

Definition at line 1328 of file filedef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDeclaration())
    {
      ::addMembersToMemberGroup(ml.get(),&m_memberGroups,this);
    }
  }
 
  // add members inside sections to their groups
  for (const auto &mg : m_memberGroups)
  {
    if (mg->allMembersInSameSection() && m_subGrouping)
    {
      //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
      mg->addToDeclarationSection();
    }
  }
}

References addMembersToMemberGroup(), m_memberGroups, m_memberLists, and m_subGrouping.

Referenced by addMembersToMemberGroup().

addMemberToList()

void FileDefImpl::addMemberToList ( MemberListType lt, MemberDef * md )

private

Definition at line 1814 of file filedef.cpp.

{
  bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
  const auto &ml = m_memberLists.get(lt,MemberListContainer::File);
  ml->setNeedsSorting(
       (ml->listType().isDeclaration() && sortBriefDocs) ||
       (ml->listType().isDocumentation() && sortMemberDocs));
  ml->push_back(md);
  if (ml->listType().isDeclaration())
  {
    MemberDefMutable *mdm = toMemberDefMutable(md);
    if (mdm)
    {
      mdm->setSectionList(this,ml.get());
    }
  }
}

References Config_getBool, File, MemberLists::get(), m_memberLists, MemberDefMutable::setSectionList(), and toMemberDefMutable().

Referenced by insertMember().

addRequirementReferences()

void FileDefImpl::addRequirementReferences ( )

overridevirtual

Implements FileDef.

Definition at line 1700 of file filedef.cpp.

{
  RequirementManager::instance().addRequirementRefsForSymbol(this);
  for (const auto &mg : m_memberGroups)
  {
    mg->addRequirementReferences(this);
  }
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDocumentation())
    {
      ml->addRequirementReferences(this);
    }
  }
}

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

addSourceRef()

void FileDefImpl::addSourceRef ( int line, const Definition * d, const MemberDef * md )

overridevirtual

Implements FileDef.

Definition at line 1525 of file filedef.cpp.

{
  //printf("FileDefImpl::addSourceRef(%d,%s,%s)\n",line,qPrint(d?d->name():"nullptr"),qPrint(md?md->name():"nullptr"));
  if (d)
  {
    m_srcDefMap.emplace(line,d);
    if (md) m_srcMemberMap.emplace(line,md);
    //printf("Adding member %s with anchor %s at line %d to file %s\n",
    //    md?qPrint(md->name()):"<none>",md?qPrint(md->anchor()):"<none>",line,qPrint(name()));
  }
}

References m_srcDefMap, and m_srcMemberMap.

addUsingDeclaration()

void FileDefImpl::addUsingDeclaration ( const Definition * d )

overridevirtual

Implements FileDef.

Definition at line 1564 of file filedef.cpp.

{
  m_usingDeclList.add(d->qualifiedName(),d);
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDeclList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

addUsingDirective()

void FileDefImpl::addUsingDirective ( NamespaceDef * nd )

overridevirtual

Implements FileDef.

Definition at line 1552 of file filedef.cpp.

{
  m_usingDirList.add(nd->qualifiedName(),nd);
  //printf("%p: FileDefImpl::addUsingDirective: %s:%d\n",this,qPrint(name()),usingDirList->count());
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDirList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

anchor()

DString FileDefImpl::anchor ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 132 of file filedef.cpp.

{ return DString(); }

codeSymbolType()

CodeSymbolType FileDefImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 126 of file filedef.cpp.

{ return CodeSymbolType::Default; }

References Default.

combineUsingRelations()

void FileDefImpl::combineUsingRelations ( )

overridevirtual

Implements FileDef.

Definition at line 1718 of file filedef.cpp.

{
  LinkedRefMap<NamespaceDef> usingDirList = m_usingDirList;
  NamespaceDefSet visitedNamespaces;
  for (auto &nd : usingDirList)
  {
    NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
    if (ndm)
    {
      ndm->combineUsingRelations(visitedNamespaces);
    }
  }
 
  for (auto &nd : usingDirList)
  {
    // add used namespaces of namespace nd to this namespace
    for (const auto &und : nd->getUsedNamespaces())
    {
      addUsingDirective(und);
    }
    // add used classes of namespace nd to this namespace
    for (const auto &ud : nd->getUsedDefinitions())
    {
      addUsingDeclaration(ud);
    }
  }
}

References addUsingDeclaration(), addUsingDirective(), NamespaceDefMutable::combineUsingRelations(), m_usingDirList, and toNamespaceDefMutable().

computeAnchors()

void FileDefImpl::computeAnchors ( )

overridevirtual

Compute the HTML anchor names for all members in the class

Implements FileDef.

Definition at line 331 of file filedef.cpp.

{
  MemberList *ml = getMemberList(MemberListType::AllMembersList());
  if (ml) ml->setAnchors();
}

References getMemberList(), and MemberList::setAnchors().

countMembers()

void FileDefImpl::countMembers ( )

overridevirtual

Implements FileDef.

Definition at line 1970 of file filedef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    ml->countDecMembers();
    ml->countDocMembers();
  }
  for (const auto &mg : m_memberGroups)
  {
    mg->countDecMembers();
    mg->countDocMembers();
  }
}

References m_memberGroups, and m_memberLists.

definitionType()

DefType FileDefImpl::definitionType ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 125 of file filedef.cpp.

{ return TypeFile; }

References definitionType(), and Definition::TypeFile.

Referenced by definitionType().

displayName()

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

inlineoverridevirtual

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

Implements Definition.

Definition at line 129 of file filedef.cpp.

{ return localName(); }

References DefinitionMixin< FileDef >::localName().

Referenced by writeDocumentation().

distributeMemberGroupDocumentation()

void FileDefImpl::distributeMemberGroupDocumentation ( )

overridevirtual

Implements FileDef.

Definition at line 337 of file filedef.cpp.

{
  //printf("FileDefImpl::distributeMemberGroupDocumentation()\n");
  for (const auto &mg : m_memberGroups)
  {
    mg->distributeMemberGroupDocumentation();
  }
}

References m_memberGroups.

docName()

const DString & FileDefImpl::docName ( ) const

inlineoverridevirtual

Returns the name as it is used in the documentation

Implements FileDef.

Definition at line 138 of file filedef.cpp.

{ return m_docname; }

References m_docname.

endMemberDeclarations()

void FileDefImpl::endMemberDeclarations ( OutputList & ol )

private

Definition at line 785 of file filedef.cpp.

{
  ol.endMemberSections();
}

References OutputList::endMemberSections().

Referenced by writeDocumentation().

endMemberDocumentation()

void FileDefImpl::endMemberDocumentation ( OutputList & ol )

private

Definition at line 799 of file filedef.cpp.

{
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.enable(OutputType::Html);
    Doxygen::suppressDocWarnings = false;
  }
}

References Config_getBool, OutputList::enable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

fileName()

DString FileDefImpl::fileName ( ) const

inlineoverridevirtual

Returns the unique file name (this may include part of the path).

Implements FileDef.

Definition at line 130 of file filedef.cpp.

{ return m_fileName; }

References m_fileName.

fileVersion()

DString FileDefImpl::fileVersion ( ) const

overridevirtual

Implements FileDef.

Definition at line 1955 of file filedef.cpp.

{
  return m_fileVersion;
}

References m_fileVersion.

findSectionsInDocumentation()

void FileDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements FileDef.

Definition at line 346 of file filedef.cpp.

{
  docFindSections(briefDescription(),this,docFile());
  docFindSections(documentation(),this,docFile());
  docFindSections(inbodyDocumentation(),this,docFile());
  for (const auto &mg : m_memberGroups)
  {
    mg->findSectionsInDocumentation(this);
  }
 
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDeclaration())
    {
      ml->findSectionsInDocumentation(this);
    }
  }
}

References DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::docFile(), docFindSections(), DefinitionMixin< FileDef >::documentation(), DefinitionMixin< FileDef >::inbodyDocumentation(), m_memberGroups, and m_memberLists.

generateSourceFile()

bool FileDefImpl::generateSourceFile ( ) const

overridevirtual

Implements FileDef.

Definition at line 1666 of file filedef.cpp.

{
  bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  bool verbatimHeaders = Config_getBool(VERBATIM_HEADERS);
  return !isReference() &&
         (sourceBrowser ||
           (verbatimHeaders && (EntryType::guessSection(name()).isHeader() || !m_includedByMap.empty()))
         ) &&
         !isDocumentationFile();
}

References Config_getBool, EntryType::guessSection(), isDocumentationFile(), DefinitionMixin< FileDef >::isReference(), m_includedByMap, and name().

Referenced by visibleInIndex(), writeSourceHeader(), and writeSourceLink().

getAllIncludeFilesRecursively()

void FileDefImpl::getAllIncludeFilesRecursively ( StringVector & incFiles ) const

overridevirtual

Implements FileDef.

Definition at line 1937 of file filedef.cpp.

{
  StringUnorderedSet includes;
  ::getAllIncludeFilesRecursively(includes,this,incFiles);
}

References getAllIncludeFilesRecursively().

Referenced by getAllIncludeFilesRecursively().

getClasses()

const ClassLinkedRefMap & FileDefImpl::getClasses ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 160 of file filedef.cpp.

{ return m_classes; }

References m_classes.

getConcepts()

const ConceptLinkedRefMap & FileDefImpl::getConcepts ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 159 of file filedef.cpp.

{ return m_concepts; }

References m_concepts.

getDirDef()

DirDef * FileDefImpl::getDirDef ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 148 of file filedef.cpp.

{ return m_dir; }

References m_dir.

Referenced by writeDocumentation(), and writeSourceHeader().

getMemberGroups()

const MemberGroupList & FileDefImpl::getMemberGroups ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 157 of file filedef.cpp.

{ return m_memberGroups; }

References m_memberGroups.

getMemberList()

MemberList * FileDefImpl::getMemberList ( MemberListType lt ) const

overridevirtual

Implements FileDef.

Definition at line 1879 of file filedef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->listType()==lt)
    {
      return ml.get();
    }
  }
  return nullptr;
}

References m_memberLists.

Referenced by computeAnchors(), insertMember(), numDecMembers(), numDocMembers(), removeMemberFromList(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeQuickMemberLinks(), writeSummaryLinks(), and writeTagFile().

getMemberLists()

const MemberLists & FileDefImpl::getMemberLists ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 156 of file filedef.cpp.

{ return m_memberLists; }

References m_memberLists.

getModuleDef()

ModuleDef * FileDefImpl::getModuleDef ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 149 of file filedef.cpp.

{ return m_moduleDef; }

References m_moduleDef.

getNamespaces()

const NamespaceLinkedRefMap & FileDefImpl::getNamespaces ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 158 of file filedef.cpp.

{ return m_namespaces; }

References m_namespaces.

getOutputFileBase()

DString FileDefImpl::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 1803 of file filedef.cpp.

{
  return m_outputDiskName;
}

References m_outputDiskName.

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

getPath()

DString FileDefImpl::getPath ( ) const

inlineoverridevirtual

Returns the absolute path of this file.

Implements FileDef.

Definition at line 143 of file filedef.cpp.

{ return m_path; }

References m_path.

Referenced by writeTagFile().

getSourceDefinition()

const Definition * FileDefImpl::getSourceDefinition ( int lineNr ) const

overridevirtual

Implements FileDef.

Definition at line 1537 of file filedef.cpp.

{
  auto it = m_srcDefMap.find(lineNr);
  //printf("%s::getSourceDefinition(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcDefMap.end()?qPrint(it->second->name()):"none");
  return it!=m_srcDefMap.end() ? it->second : nullptr;
}

References m_srcDefMap.

getSourceFileBase()

DString FileDefImpl::getSourceFileBase ( ) const

overridevirtual

Returns the name of the source listing of this definition.

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1791 of file filedef.cpp.

{
  if (Htags::useHtags)
  {
    return Htags::path2URL(m_filePath);
  }
  else
  {
    return m_outputDiskName+"_source";
  }
}

References m_filePath, m_outputDiskName, Htags::path2URL(), and Htags::useHtags.

Referenced by includeName(), writeDetailedDescription(), and writeSourceHeader().

getSourceMember()

const MemberDef * FileDefImpl::getSourceMember ( int lineNr ) const

overridevirtual

Implements FileDef.

Definition at line 1544 of file filedef.cpp.

{
  auto it = m_srcMemberMap.find(lineNr);
  //printf("%s::getSourceMember(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcMemberMap.end()?qPrint(it->second->name()):"none");
  return it!=m_srcMemberMap.end() ? it->second : nullptr;
}

References m_srcMemberMap.

getUsedDefinitions()

const LinkedRefMap< const Definition > & FileDefImpl::getUsedDefinitions ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 151 of file filedef.cpp.

{ return m_usingDeclList; }

References m_usingDeclList.

getUsedNamespaces()

const LinkedRefMap< NamespaceDef > & FileDefImpl::getUsedNamespaces ( ) const

overridevirtual

Implements FileDef.

Definition at line 1558 of file filedef.cpp.

{
  //printf("%p: FileDefImpl::getUsedNamespace: %s:%d\n",this,qPrint(name()),usingDirList?usingDirList->count():0);
  return m_usingDirList;
}

References m_usingDirList.

getVersion()

DString FileDefImpl::getVersion ( ) const

inlineoverridevirtual

Returns version of this file.

Implements FileDef.

Definition at line 144 of file filedef.cpp.

{ return m_fileVersion; }

References m_fileVersion.

hasDetailedDescription()

bool FileDefImpl::hasDetailedDescription ( ) const

overridevirtual

Implements FileDef.

Definition at line 365 of file filedef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  return ((!briefDescription().empty() && repeatBrief) ||
          !documentation().stripWhiteSpace().empty() || // avail empty section
          (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()) ||
          hasRequirementRefs()
         );
}

References DefinitionMixin< FileDef >::briefDescription(), Config_getBool, DefinitionMixin< FileDef >::documentation(), DefinitionMixin< FileDef >::getBodyDef(), DefinitionMixin< FileDef >::getStartBodyLine(), DefinitionMixin< FileDef >::hasRequirementRefs(), and stripWhiteSpace().

Referenced by writeDetailedDescription().

hasIncludedByGraph()

bool FileDefImpl::hasIncludedByGraph ( ) const

overridevirtual

Implements FileDef.

Definition at line 2011 of file filedef.cpp.

{
  return m_hasIncludedByGraph;
}

References m_hasIncludedByGraph.

hasIncludeGraph()

bool FileDefImpl::hasIncludeGraph ( ) const

overridevirtual

Implements FileDef.

Definition at line 2006 of file filedef.cpp.

{
  return m_hasIncludeGraph;
}

References m_hasIncludeGraph.

includedByDependencyGraphFileName()

DString FileDefImpl::includedByDependencyGraphFileName ( ) const

overridevirtual

Implements FileDef.

Definition at line 1965 of file filedef.cpp.

{
  return m_inclByDepFileName;
}

References m_inclByDepFileName.

includedByFileList()

const IncludeInfoList & FileDefImpl::includedByFileList ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 153 of file filedef.cpp.

{ return m_includedByList; }

References m_includedByList.

includeDependencyGraphFileName()

DString FileDefImpl::includeDependencyGraphFileName ( ) const

overridevirtual

Implements FileDef.

Definition at line 1960 of file filedef.cpp.

{
  return m_inclDepFileName;
}

References m_inclDepFileName.

includeFileList()

const IncludeInfoList & FileDefImpl::includeFileList ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 152 of file filedef.cpp.

{ return m_includeList; }

References m_includeList.

includeName()

DString FileDefImpl::includeName ( ) const

overridevirtual

Returns the name of the verbatim copy of this file (if any).

Implements FileDef.

Definition at line 1809 of file filedef.cpp.

{
  return getSourceFileBase();
}

References getSourceFileBase().

Referenced by setIncludeFile(), and writeSourceLink().

insertClass()

void FileDefImpl::insertClass ( ClassDef * cd )

overridevirtual

Adds compound definition cd to the list of all compounds of this file

Implements FileDef.

Definition at line 1479 of file filedef.cpp.

{
  if (cd->isHidden()) return;
 
  ClassLinkedRefMap *list = &m_classes;
 
  if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
  {
    if (cd->compoundType()==ClassDef::Interface)
    {
      list = &m_interfaces;
    }
    else if (cd->compoundType()==ClassDef::Struct)
    {
      list = &m_structs;
    }
    else if (cd->compoundType()==ClassDef::Exception)
    {
      list = &m_exceptions;
    }
  }
 
  list->add(cd->name(),cd);
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), ClassDef::compoundType(), Config_getBool, ClassDef::Exception, ClassDef::Interface, Definition::isHidden(), m_classes, m_exceptions, m_interfaces, m_structs, Definition::name(), and ClassDef::Struct.

insertConcept()

void FileDefImpl::insertConcept ( ConceptDef * cd )

overridevirtual

Implements FileDef.

Definition at line 1504 of file filedef.cpp.

{
  if (cd->isHidden()) return;
  m_concepts.add(cd->name(),cd);
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::isHidden(), m_concepts, and Definition::name().

insertMember()

void FileDefImpl::insertMember ( MemberDef * md )

overridevirtual

Adds member definition md to the list of all members of this file

Implements FileDef.

Definition at line 1350 of file filedef.cpp.

{
  if (md->isHidden()) return;
  MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
  //printf("%s:FileDefImpl::insertMember(%s (=%p) list has %zu elements)\n",
  //    qPrint(name()),qPrint(md->name()),(void*)md,allMemberList ? allMemberList->size() : 0);
  if (allMemberList && allMemberList->contains(md))
  {
    //printf("already added\n");
    return;
  }
 
  if (allMemberList==nullptr)
  {
    m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType::AllMembersList(),MemberListContainer::File));
    allMemberList = m_memberLists.back().get();
  }
  allMemberList->push_back(md);
  switch (md->memberType())
  {
    case MemberType::Property:
      if (md->getLanguage() == SrcLangExt::Python)
      {
        addMemberToList(MemberListType::PropertyMembers(),md);
        addMemberToList(MemberListType::Properties(),md);
        break;
      }
      //  fallthrough, explicitly no break here
    case MemberType::Variable:
      if (md->anonymousMemberForDeclaration()==nullptr) // not a split member that has a separate declaration member
      {
        addMemberToList(MemberListType::DecVarMembers(),md);
      }
      if (!md->isAnonymous() && md->anonymousMemberForDetails()==nullptr) // not a split member that has a separate details member
      {
        addMemberToList(MemberListType::DocVarMembers(),md);
      }
      break;
    case MemberType::Function:
      addMemberToList(MemberListType::DecFuncMembers(),md);
      addMemberToList(MemberListType::DocFuncMembers(),md);
      break;
    case MemberType::Typedef:
      addMemberToList(MemberListType::DecTypedefMembers(),md);
      addMemberToList(MemberListType::DocTypedefMembers(),md);
      break;
    case MemberType::Sequence:
      addMemberToList(MemberListType::DecSequenceMembers(),md);
      addMemberToList(MemberListType::DocSequenceMembers(),md);
      break;
    case MemberType::Dictionary:
      addMemberToList(MemberListType::DecDictionaryMembers(),md);
      addMemberToList(MemberListType::DocDictionaryMembers(),md);
      break;
    case MemberType::Enumeration:
      addMemberToList(MemberListType::DecEnumMembers(),md);
      addMemberToList(MemberListType::DocEnumMembers(),md);
      break;
    case MemberType::EnumValue:    // enum values are shown inside their enums
      break;
    case MemberType::Define:
      addMemberToList(MemberListType::DecDefineMembers(),md);
      addMemberToList(MemberListType::DocDefineMembers(),md);
      break;
    default:
       err("FileDefImpl::insertMembers(): "
           "member '{}' with class scope '{}' inserted in file scope '{}'!\n",
           md->name(),
           md->getClassDef() ? md->getClassDef()->name() : "<global>",
           name());
  }
  //addMemberToGroup(md,groupId);
}

References addMemberToList(), MemberDef::anonymousMemberForDeclaration(), MemberDef::anonymousMemberForDetails(), MemberVector::contains(), err, File, MemberLists::get(), MemberDef::getClassDef(), Definition::getLanguage(), getMemberList(), Definition::isAnonymous(), Definition::isHidden(), m_memberLists, MemberDef::memberType(), Definition::name(), name(), and MemberVector::push_back().

insertNamespace()

void FileDefImpl::insertNamespace ( NamespaceDef * nd )

overridevirtual

Adds namespace definition nd to the list of all compounds of this file

Implements FileDef.

Definition at line 1511 of file filedef.cpp.

{
  if (nd->isHidden()) return;
  m_namespaces.add(nd->name(),nd);
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::isHidden(), m_namespaces, and Definition::name().

isDocumentationFile()

bool FileDefImpl::isDocumentationFile ( ) const

overridevirtual

Implements FileDef.

Definition at line 1746 of file filedef.cpp.

{
  static const std::unordered_set<std::string> docExtensions =
  { "doc", "txt", "dox", "md", "markdown" };
 
  size_t lastDot = name().rfind('.');
  return (lastDot!=DString::npos &&
          docExtensions.find(name().mid(lastDot+1).str())!=docExtensions.end()) ||
          getLanguageFromFileName(getFileNameExtension(name())) == SrcLangExt::Markdown;
}

References getFileNameExtension(), getLanguageFromFileName(), name(), DString::npos, and DString::rfind().

Referenced by generateSourceFile(), visibleInIndex(), and writeSourceHeader().

isIncluded()

bool FileDefImpl::isIncluded ( const DString & name ) const

overridevirtual

Implements FileDef.

Definition at line 1660 of file filedef.cpp.

{
  if (name.empty()) return false;
  return m_includeMap.find(name.str())!=m_includeMap.end();
}

References m_includeMap, and name().

isLinkable()

bool FileDefImpl::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 146 of file filedef.cpp.

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

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

Referenced by visibleInIndex(), and writeSourceHeader().

isLinkableInProject()

bool FileDefImpl::isLinkableInProject ( ) const

overridevirtual

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

Implements Definition.

Definition at line 1915 of file filedef.cpp.

{
  bool showFiles = Config_getBool(SHOW_FILES);
  return hasDocumentation() && !isReference() && (showFiles || isLinkableViaGroup());
}

References Config_getBool, DefinitionMixin< FileDef >::hasDocumentation(), DefinitionMixin< FileDef >::isLinkableViaGroup(), and DefinitionMixin< FileDef >::isReference().

Referenced by isLinkable(), and visibleInIndex().

isSource()

bool FileDefImpl::isSource ( ) const

inlineoverridevirtual

Returns true if this file is a source file.

Implements FileDef.

Definition at line 139 of file filedef.cpp.

{ return m_isSource; }

References m_isSource.

name()

const DString & FileDefImpl::name ( ) const

overridevirtual

Returns the name of the definition

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1517 of file filedef.cpp.

{
  if (Config_getBool(FULL_PATH_NAMES))
    return m_fileName;
  else
    return DefinitionMixin::name();
}

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

Referenced by addListReferences(), generateSourceFile(), insertMember(), isDocumentationFile(), isIncluded(), setDiskName(), setDiskNameLocal(), title(), writeDetailedDescription(), writeDocumentation(), writeIncludedByGraph(), writeIncludeGraph(), writeMemberDocumentation(), writeMemberPages(), writeSourceHeader(), and writeTagFile().

numDecMembers()

int FileDefImpl::numDecMembers ( ) const

overridevirtual

Implements FileDef.

Definition at line 1990 of file filedef.cpp.

{
  MemberList *ml = getMemberList(MemberListType::AllMembersList());
  return ml ? ml->numDecMembers() : 0;
}

References getMemberList(), and MemberList::numDecMembers().

numDocMembers()

int FileDefImpl::numDocMembers ( ) const

overridevirtual

Implements FileDef.

Definition at line 1984 of file filedef.cpp.

{
  MemberList *ml = getMemberList(MemberListType::AllMembersList());
  return ml ? ml->numDocMembers() : 0;
}

References getMemberList(), and MemberList::numDocMembers().

overrideIncludedByGraph()

void FileDefImpl::overrideIncludedByGraph ( bool e )

overridevirtual

Implements FileDef.

Definition at line 2001 of file filedef.cpp.

{
  m_hasIncludedByGraph=e;
}

References m_hasIncludedByGraph.

overrideIncludeGraph()

void FileDefImpl::overrideIncludeGraph ( bool e )

overridevirtual

Implements FileDef.

Definition at line 1996 of file filedef.cpp.

{
  m_hasIncludeGraph=e;
}

References m_hasIncludeGraph.

parseSource()

void FileDefImpl::parseSource ( ClangTUParser * clangParser )

overridevirtual

Implements FileDef.

Definition at line 1299 of file filedef.cpp.

{
  bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
  OutputCodeList devNullList;
  devNullList.add<DevNullCodeGenerator>();
#if USE_LIBCLANG
  if (Doxygen::clangAssistedParsing && clangParser &&
      (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
  {
    clangParser->switchToFile(this);
    clangParser->writeSources(devNullList,this);
  }
  else
#endif
  {
    auto intf = Doxygen::parserManager->getCodeParser(getDefFileExtension());
    intf->resetCodeParserState();
    size_t indent = 0;
    intf->parseCode(
            devNullList,DString(),
            detab(fileToString(absFilePath(),filterSourceFiles,true),indent),
            getLanguage(),
            Config_getBool(STRIP_CODE_COMMENTS),
            CodeParserOptions()
            .setFileDef(this)
           );
  }
}

References absFilePath(), OutputCodeList::add(), Doxygen::clangAssistedParsing, Config_getBool, detab(), fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), DefinitionMixin< FileDef >::getLanguage(), and Doxygen::parserManager.

removeMember()

void FileDefImpl::removeMember ( MemberDef * md )

overridevirtual

Implements FileDef.

Definition at line 1430 of file filedef.cpp.

{
  removeMemberFromList(MemberListType::AllMembersList(),md);
  switch(md->memberType())
  {
    case MemberType::Property:
      if (md->getLanguage() == SrcLangExt::Python)
      {
        removeMemberFromList(MemberListType::PropertyMembers(),md);
        removeMemberFromList(MemberListType::Properties(),md);
        break;
      }
      //  fallthrough, explicitly no break here
    case MemberType::Variable:
      removeMemberFromList(MemberListType::DecVarMembers(),md);
      removeMemberFromList(MemberListType::DocVarMembers(),md);
      break;
    case MemberType::Function:
      removeMemberFromList(MemberListType::DecFuncMembers(),md);
      removeMemberFromList(MemberListType::DocFuncMembers(),md);
      break;
    case MemberType::Typedef:
      removeMemberFromList(MemberListType::DecTypedefMembers(),md);
      removeMemberFromList(MemberListType::DocTypedefMembers(),md);
      break;
    case MemberType::Sequence:
      removeMemberFromList(MemberListType::DecSequenceMembers(),md);
      removeMemberFromList(MemberListType::DocSequenceMembers(),md);
      break;
    case MemberType::Dictionary:
      removeMemberFromList(MemberListType::DecDictionaryMembers(),md);
      removeMemberFromList(MemberListType::DocDictionaryMembers(),md);
      break;
    case MemberType::Enumeration:
      removeMemberFromList(MemberListType::DecEnumMembers(),md);
      removeMemberFromList(MemberListType::DocEnumMembers(),md);
      break;
    case MemberType::EnumValue:    // enum values are shown inside their enums
      break;
    case MemberType::Define:
      removeMemberFromList(MemberListType::DecDefineMembers(),md);
      removeMemberFromList(MemberListType::DocDefineMembers(),md);
      break;
    default:
      err("FileDefImpl::removeMember(): unexpected member remove in file!\n");
  }
}

References err, Definition::getLanguage(), MemberDef::memberType(), and removeMemberFromList().

removeMemberFromList()

void FileDefImpl::removeMemberFromList ( MemberListType lt, MemberDef * md )

private

Definition at line 1424 of file filedef.cpp.

{
  MemberList *ml = getMemberList(lt);
  if (ml) ml->remove(md);
}

References getMemberList(), and MemberVector::remove().

Referenced by removeMember().

setDirDef()

void FileDefImpl::setDirDef ( DirDef * dd )

inlineoverridevirtual

Implements FileDef.

Definition at line 186 of file filedef.cpp.

{ m_dir=dd; }

References m_dir.

setDiskName()

void FileDefImpl::setDiskName ( const DString & name )

overridevirtual

Implements FileDef.

Definition at line 325 of file filedef.cpp.

{
  setDiskNameLocal(name);
}

References name(), and setDiskNameLocal().

setDiskNameLocal()

void FileDefImpl::setDiskNameLocal ( const DString & name )

private

Definition at line 309 of file filedef.cpp.

{
  if (isReference())
  {
    m_outputDiskName = name;
    m_inclDepFileName = name+"_incl";
    m_inclByDepFileName = name+"_dep_incl";
  }
  else
  {
    m_outputDiskName = convertNameToFile(name);
    m_inclDepFileName = convertNameToFile(name+"_incl");
    m_inclByDepFileName = convertNameToFile(name+"_dep_incl");
  }
}

References convertNameToFile(), DefinitionMixin< FileDef >::isReference(), m_inclByDepFileName, m_inclDepFileName, m_outputDiskName, and name().

Referenced by FileDefImpl(), and setDiskName().

setIncludeFile()

void FileDefImpl::setIncludeFile ( FileDef * fd, const DString & includeName, bool local, bool force )

overridevirtual

Implements FileDef.

Definition at line 1569 of file filedef.cpp.

{
  //printf("FileDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
  if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
  if ((!includeName.empty() && m_incInfo->includeName.empty()) ||
      (fd!=nullptr && m_incInfo->fileDef==nullptr)
     )
  {
    //printf("Setting file info\n");
    m_incInfo->fileDef     = fd;
    m_incInfo->includeName = includeName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
  if (force && !includeName.empty())
  {
    m_incInfo->includeName = includeName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
}

References DString::empty(), IncludeLocal, includeName(), IncludeSystem, and m_incInfo.

setModuleDef()

void FileDefImpl::setModuleDef ( ModuleDef * mod )

inlineoverridevirtual

Implements FileDef.

Definition at line 187 of file filedef.cpp.

{ m_moduleDef=mod; }

References m_moduleDef.

sortMemberLists()

void FileDefImpl::sortMemberLists ( )

overridevirtual

Implements FileDef.

Definition at line 1833 of file filedef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(false); }
  }
 
  for (const auto &mg : m_memberGroups)
  {
    MemberList &mlg = const_cast<MemberList&>(mg->members());
    if (mlg.needsSorting()) { mlg.sort(); mlg.setNeedsSorting(false); }
  }
 
  std::stable_sort(m_includedByList.begin(),m_includedByList.end(),
      [](const auto &fi1,const auto &fi2) { return fi1.includeName < fi2.includeName; });
 
  if (Config_getBool(SORT_BRIEF_DOCS))
  {
    auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
    {
      return Config_getBool(SORT_BY_SCOPE_NAME)          ?
        dstricmp_sort(c1->displayName(), c2->displayName())<0     :
        dstricmp_sort(c1->className(), c2->className())<0;
    };
 
    std::stable_sort(m_classes.begin(),   m_classes.end(),   classComp);
    std::stable_sort(m_interfaces.begin(),m_interfaces.end(),classComp);
    std::stable_sort(m_structs.begin(),   m_structs.end(),   classComp);
    std::stable_sort(m_exceptions.begin(),m_exceptions.end(),classComp);
 
    auto conceptComp = [](const ConceptLinkedRefMap::Ptr &c1,const ConceptLinkedRefMap::Ptr &c2)
    {
      return dstricmp_sort(c1->name(),c2->name())<0;
    };
 
    std::stable_sort(m_concepts.begin(), m_concepts.end(), conceptComp);
 
    auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
    {
      return dstricmp_sort(n1->name(),n2->name())<0;
    };
 
    std::stable_sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
  }
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), ClassDef::className(), Config_getBool, Definition::displayName(), dstricmp_sort(), LinkedRefMap< T, Hash, KeyEqual, Map >::end(), m_classes, m_concepts, m_exceptions, m_includedByList, m_interfaces, m_memberGroups, m_memberLists, m_namespaces, m_structs, Definition::name(), MemberList::needsSorting(), MemberList::setNeedsSorting(), and MemberVector::sort().

startMemberDeclarations()

void FileDefImpl::startMemberDeclarations ( OutputList & ol )

private

Definition at line 780 of file filedef.cpp.

{
  ol.startMemberSections();
}

References OutputList::startMemberSections().

Referenced by writeDocumentation().

startMemberDocumentation()

void FileDefImpl::startMemberDocumentation ( OutputList & ol )

private

Definition at line 790 of file filedef.cpp.

{
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.disable(OutputType::Html);
    Doxygen::suppressDocWarnings = true;
  }
}

References Config_getBool, OutputList::disable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

subGrouping()

bool FileDefImpl::subGrouping ( ) const

inlineoverridevirtual

Implements FileDef.

Definition at line 164 of file filedef.cpp.

{ return m_subGrouping; }

References m_subGrouping.

title()

DString FileDefImpl::title ( ) const

overridevirtual

Implements FileDef.

Definition at line 1943 of file filedef.cpp.

{
  if (Config_getBool(HIDE_COMPOUND_REFERENCE))
  {
    return name();
  }
  else
  {
    return theTranslator->trFileReference(name());
  }
}

References Config_getBool, name(), theTranslator, and Translator::trFileReference().

Referenced by writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeNamespaceDeclarations(), and writeSourceHeader().

visibleInIndex()

bool FileDefImpl::visibleInIndex ( bool & genSourceFile ) const

overridevirtual

Returns true if this file is visible in the index.

The parameter genSourceFile is set to true if this file is only linkable as a source file.

Implements FileDef.

Definition at line 2016 of file filedef.cpp.

{
  bool allExternals = Config_getBool(ALLEXTERNALS);
  bool isDocFile = isDocumentationFile();
  genSourceFile = !isDocFile && generateSourceFile();
  return ((allExternals && isLinkable()) || isLinkableInProject()) && !isDocFile;
}

References Config_getBool, generateSourceFile(), isDocumentationFile(), isLinkable(), and isLinkableInProject().

writeAuthorSection()

void FileDefImpl::writeAuthorSection ( OutputList & ol )

private

Definition at line 820 of file filedef.cpp.

{
  // write Author section (Man only)
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Man);
  ol.startGroupHeader();
  ol.parseText(theTranslator->trAuthor(true,true));
  ol.endGroupHeader();
  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
  ol.popGeneratorState();
}

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), and Translator::trGeneratedAutomatically().

Referenced by writeDocumentation().

writeBriefDescription()

void FileDefImpl::writeBriefDescription ( OutputList & ol )

private

Definition at line 545 of file filedef.cpp.

{
  if (hasBriefDescription())
  {
    auto parser { createDocParser() };
    auto ast    { validatingParseDoc(*parser.get(),
                                     briefFile(),
                                     briefLine(),
                                     this,
                                     nullptr,
                                     briefDescription(),
                                     DocOptions()
                                     .setIndexWords(true)
                                     .setSingleLine(true))
                };
    if (!ast->empty())
    {
      ol.startParagraph();
      ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Man);
      ol.writeString(" - ");
      ol.popGeneratorState();
      ol.writeDoc(ast.get(),this,nullptr);
      ol.pushGeneratorState();
      ol.disable(OutputType::RTF);
      ol.writeString(" \n");
      ol.enable(OutputType::RTF);
 
      if (Config_getBool(REPEAT_BRIEF) ||
          !documentation().stripWhiteSpace().empty()
         )
      {
        ol.disableAllBut(OutputType::Html);
        ol.startTextLink(DString(),"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
      ol.endParagraph();
    }
  }
  ol.writeSynopsis();
}

References DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), DefinitionMixin< FileDef >::hasBriefDescription(), Html, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), OutputList::startTextLink(), stripWhiteSpace(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

writeClassDeclarations()

void FileDefImpl::writeClassDeclarations ( OutputList & ol, const DString & title, const ClassLinkedRefMap & list )

private

Definition at line 755 of file filedef.cpp.

{
  // write list of classes
  list.writeDeclaration(ol,nullptr,title,false);
}

References title(), and ClassLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

writeClassesToTagFile()

void FileDefImpl::writeClassesToTagFile ( TextStream & t, const ClassLinkedRefMap & list )

private

Definition at line 589 of file filedef.cpp.

{
  for (const auto &cd : list)
  {
    if (cd->isLinkableInProject())
    {
      tagFile << "    <class kind=\"" << cd->compoundTypeString() <<
        "\">" << convertToXML(cd->name()) << "</class>\n";
    }
  }
}

References convertToXML().

Referenced by writeTagFile().

writeConcepts()

void FileDefImpl::writeConcepts ( OutputList & ol, const DString & title )

private

Definition at line 761 of file filedef.cpp.

{
  // write list of classes
  m_concepts.writeDeclaration(ol,title,false);
}

References m_concepts, title(), and ConceptLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

writeDetailedDescription()

void FileDefImpl::writeDetailedDescription ( OutputList & ol, const DString & title )

private

Definition at line 474 of file filedef.cpp.

{
  if (hasDetailedDescription())
  {
    ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.writeRuler();
    ol.popGeneratorState();
    ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      ol.writeAnchor(DString(),"details");
    ol.popGeneratorState();
    ol.startGroupHeader("details");
    ol.parseText(title);
    ol.endGroupHeader();
 
    ol.startTextBlock();
    if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF))
    {
      ol.generateDoc(briefFile(),
                     briefLine(),
                     this,
                     nullptr,
                     briefDescription(),
                     DocOptions());
    }
    if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF) &&
        !documentation().empty())
    {
      ol.pushGeneratorState();
        ol.disable(OutputType::Man);
        ol.disable(OutputType::RTF);
        ol.enableAll();
        ol.disableAllBut(OutputType::Man);
        ol.enable(OutputType::Latex);
        ol.writeString("\n\n");
      ol.popGeneratorState();
    }
    if (!documentation().empty())
    {
      ol.generateDoc(docFile(),
                     docLine(),
                     this,
                     nullptr,
                     documentation()+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
    //printf("Writing source ref for file %s\n",qPrint(name()));
    if (Config_getBool(SOURCE_BROWSER))
    {
      ol.startParagraph("definition");
      DString refText = theTranslator->trDefinedInSourceFile();
      if (size_t fileMarkerPos = refText.find("@0"); fileMarkerPos!=DString::npos) // should always pass this.
      {
        ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1
        ol.writeObjectLink(DString(),getSourceFileBase(),DString(),name());
        ol.parseText(refText.right(
              refText.length()-fileMarkerPos-2)); // text right from marker 2
      }
      else
      {
        err("translation error: invalid marker in trDefinedInSourceFile()\n");
      }
      ol.endParagraph();
    }
    if (hasRequirementRefs()) writeRequirementRefs(ol);
    ol.endTextBlock();
  }
}

References DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::docFile(), DefinitionMixin< FileDef >::docLine(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endParagraph(), OutputList::endTextBlock(), err, DString::find(), OutputList::generateDoc(), getSourceFileBase(), hasDetailedDescription(), DefinitionMixin< FileDef >::hasRequirementRefs(), Html, Latex, DString::left(), DString::length(), Man, name(), DString::npos, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DString::right(), RTF, OutputList::startGroupHeader(), OutputList::startParagraph(), OutputList::startTextBlock(), theTranslator, title(), Translator::trDefinedInSourceFile(), OutputList::writeAnchor(), OutputList::writeObjectLink(), DefinitionMixin< FileDef >::writeRequirementRefs(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

writeDocumentation()

void FileDefImpl::writeDocumentation ( OutputList & ol )

overridevirtual

Write the documentation page for this file to the file of output generators ol.

Implements FileDef.

Definition at line 906 of file filedef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  //funcList->countDecMembers();
 
  //DString fn = name();
  //if (Config_getBool(FULL_PATH_NAMES))
  //{
  //  fn.prepend(stripFromPath(getPath()));
  //}
 
  //printf("WriteDocumentation diskname=%s\n",qPrint(diskname));
 
  DString versionTitle;
  if (!m_fileVersion.empty())
  {
    versionTitle=" ("+m_fileVersion+")";
  }
  DString title = m_docname+versionTitle;
  DString pageTitle;
  if (Config_getBool(HIDE_COMPOUND_REFERENCE))
  {
    pageTitle=m_docname;
  }
  else
  {
    pageTitle=theTranslator->trFileReference(m_docname);
  }
 
  if (getDirDef())
  {
    startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
    if (!generateTreeView)
    {
      getDirDef()->writeNavigationPath(ol);
      ol.endQuickIndices();
    }
    startTitle(ol,getOutputFileBase(),this);
    ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      if (Config_getBool(HIDE_COMPOUND_REFERENCE))
      {
        ol.parseText(displayName()); // Html only
      }
      else
      {
        ol.parseText(theTranslator->trFileReference(displayName())); // Html only
      }
      ol.enableAll();
      ol.disable(OutputType::Html);
      if (Config_getBool(HIDE_COMPOUND_REFERENCE))
      {
        ol.parseText(Config_getBool(FULL_PATH_NAMES) ?  // other output formats
                     pageTitle :
                     name());
      }
      else
      {
        ol.parseText(Config_getBool(FULL_PATH_NAMES) ?  // other output formats
                     pageTitle :
                     theTranslator->trFileReference(name()));
      }
    ol.popGeneratorState();
    addGroupListToTitle(ol,this);
    endTitle(ol,getOutputFileBase(),title);
  }
  else
  {
    startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
    if (!generateTreeView)
    {
      ol.endQuickIndices();
    }
    startTitle(ol,getOutputFileBase(),this);
    ol.parseText(pageTitle);
    addGroupListToTitle(ol,this);
    endTitle(ol,getOutputFileBase(),title);
  }
 
  ol.startContents();
 
  if (!m_fileVersion.empty())
  {
    ol.disableAllBut(OutputType::Html);
    ol.startProjectNumber();
    ol.docify(versionTitle);
    ol.endProjectNumber();
    ol.enableAll();
  }
 
  //---------------------------------------- start flexible part -------------------------------
 
  SrcLangExt lang = getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
  {
    const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        writeBriefDescription(ol);
        break;
      case LayoutDocEntry::MemberDeclStart:
        startMemberDeclarations(ol);
        break;
      case LayoutDocEntry::Includes:
        writeIncludeFiles(ol);
        break;
      case LayoutDocEntry::FileIncludeGraph:
        writeIncludeGraph(ol);
        break;
      case LayoutDocEntry::FileIncludedByGraph:
        writeIncludedByGraph(ol);
        break;
      case LayoutDocEntry::FileSourceLink:
        writeSourceLink(ol);
        break;
      case LayoutDocEntry::FileClasses:
        if (ls) writeClassDeclarations(ol,ls->title(lang),m_classes);
        break;
      case LayoutDocEntry::FileInterfaces:
        if (ls) writeClassDeclarations(ol,ls->title(lang),m_interfaces);
        break;
      case LayoutDocEntry::FileStructs:
        if (ls) writeClassDeclarations(ol,ls->title(lang),m_structs);
        break;
      case LayoutDocEntry::FileExceptions:
        if (ls) writeClassDeclarations(ol,ls->title(lang),m_exceptions);
        break;
      case LayoutDocEntry::FileConcepts:
        if (ls) writeConcepts(ol,ls->title(lang));
        break;
      case LayoutDocEntry::FileNamespaces:
        if (ls) writeNamespaceDeclarations(ol,ls->title(lang),false);
        break;
      case LayoutDocEntry::FileConstantGroups:
        if (ls) writeNamespaceDeclarations(ol,ls->title(lang),true);
        break;
      case LayoutDocEntry::MemberGroups:
        writeMemberGroups(ol);
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd) writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDeclEnd:
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc:
        if (ls) writeDetailedDescription(ol,ls->title(lang));
        break;
      case LayoutDocEntry::MemberDefStart:
        startMemberDocumentation(ol);
        break;
      case LayoutDocEntry::FileInlineClasses:
        writeInlineClasses(ol);
        break;
      case LayoutDocEntry::MemberDef:
        {
          const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
          if (lmd) writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDefEnd:
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::AuthorSection:
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::ClassInheritanceGraph:
      case LayoutDocEntry::ClassNestedClasses:
      case LayoutDocEntry::ClassCollaborationGraph:
      case LayoutDocEntry::ClassAllMembersLink:
      case LayoutDocEntry::ClassUsedFiles:
      case LayoutDocEntry::ClassInlineClasses:
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceNestedConstantGroups:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::NamespaceConcepts:
      case LayoutDocEntry::NamespaceInterfaces:
      case LayoutDocEntry::NamespaceStructs:
      case LayoutDocEntry::NamespaceExceptions:
      case LayoutDocEntry::NamespaceInlineClasses:
      case LayoutDocEntry::ConceptDefinition:
      case LayoutDocEntry::GroupClasses:
      case LayoutDocEntry::GroupConcepts:
      case LayoutDocEntry::GroupModules:
      case LayoutDocEntry::GroupInlineClasses:
      case LayoutDocEntry::GroupNamespaces:
      case LayoutDocEntry::GroupDirs:
      case LayoutDocEntry::GroupNestedGroups:
      case LayoutDocEntry::GroupFiles:
      case LayoutDocEntry::GroupGraph:
      case LayoutDocEntry::GroupPageDocs:
      case LayoutDocEntry::ModuleExports:
      case LayoutDocEntry::ModuleClasses:
      case LayoutDocEntry::ModuleConcepts:
      case LayoutDocEntry::ModuleUsedFiles:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member '{}' should not be part of "
            "LayoutDocManager::File entry list\n",lde->entryToString());
        break;
    }
  }
 
  //---------------------------------------- end flexible part -------------------------------
 
  ol.endContents();
 
  endFileWithNavPath(ol,this);
 
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    MemberList *ml = getMemberList(MemberListType::AllMembersList());
    if (ml) ml->sort();
    writeMemberPages(ol);
  }
}

References addGroupListToTitle(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), DString::empty(), OutputList::enableAll(), OutputList::endContents(), endFileWithNavPath(), endMemberDeclarations(), endMemberDocumentation(), OutputList::endProjectNumber(), OutputList::endQuickIndices(), endTitle(), err, FileVisible, getDirDef(), DefinitionMixin< FileDef >::getLanguage(), getMemberList(), getOutputFileBase(), Html, LayoutDocManager::instance(), m_classes, m_docname, m_exceptions, m_fileVersion, m_interfaces, m_structs, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), MemberVector::sort(), OutputList::startContents(), startFile(), startMemberDeclarations(), startMemberDocumentation(), OutputList::startProjectNumber(), startTitle(), theTranslator, title(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntrySection::title(), Translator::trFileReference(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeIncludedByGraph(), writeIncludeFiles(), writeIncludeGraph(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeMemberPages(), writeNamespaceDeclarations(), DefinitionMutable::writeNavigationPath(), and writeSourceLink().

writeIncludedByGraph()

void FileDefImpl::writeIncludedByGraph ( OutputList & ol )

private

Definition at line 707 of file filedef.cpp.

{
  if (Config_getBool(HAVE_DOT) && m_hasIncludedByGraph /*&& Config_getBool(INCLUDED_BY_GRAPH)*/)
  {
    //printf("Graph for file %s\n",qPrint(name()));
    DotInclDepGraph incDepGraph(this,true);
    if (incDepGraph.isTooBig())
    {
       warn_uncond("Included by graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!incDepGraph.isTrivial())
    {
      ol.startTextBlock();
      ol.disable(OutputType::Man);
      ol.startInclDepGraph();
      ol.parseText(theTranslator->trInclByDepGraph());
      ol.endInclDepGraph(incDepGraph);
      ol.enableAll();
      ol.endTextBlock(true);
    }
    //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
  }
}

References Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), m_hasIncludedByGraph, Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclByDepGraph(), and warn_uncond.

Referenced by writeDocumentation().

writeIncludeFiles()

void FileDefImpl::writeIncludeFiles ( OutputList & ol )

private

Definition at line 601 of file filedef.cpp.

{
  if (m_incInfo)
  {
    DString nm=m_incInfo->includeName.empty() ?
      (m_incInfo->fileDef ?
       m_incInfo->fileDef->docName() : DString()
      ) :
      m_incInfo->includeName;
    if (!nm.empty())
    {
      ol.startParagraph();
      ol.startTypewriter();
      ol.docify(::includeStatement(SrcLangExt::Cpp,m_incInfo->kind));
      ol.docify(::includeOpen(SrcLangExt::Cpp,m_incInfo->kind));
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.docify(nm);
      ol.disableAllBut(OutputType::Html);
      ol.enable(OutputType::Html);
      if (m_incInfo->fileDef)
      {
        ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
      }
      else
      {
        ol.docify(nm);
      }
      ol.popGeneratorState();
      ol.docify(::includeClose(SrcLangExt::Cpp,m_incInfo->kind));
      ol.endTypewriter();
      ol.endParagraph();
    }
  }
  else if (!m_includeList.empty())
  {
    ol.startTextBlock(true);
    for (const auto &ii : m_includeList)
    {
      const FileDef *fd=ii.fileDef;
      ol.startTypewriter();
      SrcLangExt lang = fd ? fd->getLanguage() : SrcLangExt::Cpp;
      ol.docify(::includeStatement(lang,ii.kind));
      ol.docify(::includeOpen(lang,ii.kind));
      ol.disable(OutputType::Html);
      ol.docify(ii.includeName);
      ol.enableAll();
      ol.disableAllBut(OutputType::Html);
 
      // Here we use the include file name as it appears in the file.
      // we could also we the name as it is used within doxygen,
      // then we should have used fd->docName() instead of ii->includeName
      if (fd && fd->isLinkable())
      {
        ol.writeObjectLink(fd->getReference(),
            fd->generateSourceFile() ? fd->includeName() : fd->getOutputFileBase(),
            DString(),ii.includeName);
      }
      else
      {
        ModuleDef *mod = ModuleManager::instance().getPrimaryInterface(ii.includeName);
        if (ii.kind==IncludeKind::ImportModule && mod && mod->isLinkable())
        {
          ol.writeObjectLink(mod->getReference(),mod->getOutputFileBase(),
                             DString(),ii.includeName);
        }
        else
        {
          ol.docify(ii.includeName);
        }
      }
 
      ol.enableAll();
      ol.docify(::includeClose(lang,ii.kind));
      ol.endTypewriter();
      ol.lineBreak();
    }
    ol.endTextBlock();
  }
}

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextBlock(), OutputList::endTypewriter(), FileDef::generateSourceFile(), Definition::getLanguage(), Definition::getOutputFileBase(), ModuleManager::getPrimaryInterface(), Definition::getReference(), Html, ImportModule, includeClose(), FileDef::includeName(), includeOpen(), includeStatement(), ModuleManager::instance(), Definition::isLinkable(), OutputList::lineBreak(), m_incInfo, m_includeList, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTextBlock(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

writeIncludeGraph()

void FileDefImpl::writeIncludeGraph ( OutputList & ol )

private

Definition at line 682 of file filedef.cpp.

{
  if (Config_getBool(HAVE_DOT) && m_hasIncludeGraph /*&& Config_getBool(INCLUDE_GRAPH)*/)
  {
    //printf("Graph for file %s\n",qPrint(name()));
    DotInclDepGraph incDepGraph(this,false);
    if (incDepGraph.isTooBig())
    {
       warn_uncond("Include graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!incDepGraph.isTrivial())
    {
      ol.startTextBlock();
      ol.disable(OutputType::Man);
      ol.startInclDepGraph();
      ol.parseText(theTranslator->trInclDepGraph(name()));
      ol.endInclDepGraph(incDepGraph);
      ol.enableAll();
      ol.endTextBlock(true);
    }
    //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
  }
}

References Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), m_hasIncludeGraph, Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclDepGraph(), and warn_uncond.

Referenced by writeDocumentation().

writeInlineClasses()

void FileDefImpl::writeInlineClasses ( OutputList & ol )

private

Definition at line 767 of file filedef.cpp.

{
  // temporarily undo the disabling could be done by startMemberDocumentation()
  // as a result of setting SEPARATE_MEMBER_PAGES to YES; see bug730512
  bool isEnabled = ol.isEnabled(OutputType::Html);
  ol.enable(OutputType::Html);
 
  m_classes.writeDocumentation(ol,this);
 
  // restore the initial state if needed
  if (!isEnabled) ol.disable(OutputType::Html);
}

References OutputList::disable(), OutputList::enable(), Html, OutputList::isEnabled(), m_classes, and ClassLinkedRefMap::writeDocumentation().

Referenced by writeDocumentation().

writeMemberDeclarations()

void FileDefImpl::writeMemberDeclarations ( OutputList & ol, MemberListType lt, const DString & title )

private

Definition at line 1891 of file filedef.cpp.

{
  bool optVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  MemberList * ml = getMemberList(lt);
  if (ml)
  {
    if (optVhdl) // use specific declarations function
    {
 
      VhdlDocGen::writeVhdlDeclarations(ml,ol,nullptr,nullptr,this,nullptr,nullptr);
    }
    else
    {
      ml->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr,title,DString());
    }
  }
}

References Config_getBool, getMemberList(), title(), MemberList::writeDeclarations(), and VhdlDocGen::writeVhdlDeclarations().

Referenced by writeDocumentation().

writeMemberDocumentation()

void FileDefImpl::writeMemberDocumentation ( OutputList & ol, MemberListType lt, const DString & title )

private

Definition at line 1909 of file filedef.cpp.

{
  MemberList * ml = getMemberList(lt);
  if (ml) ml->writeDocumentation(ol,name(),this,title,ml->listType().toLabel());
}

References getMemberList(), MemberList::listType(), name(), title(), MemberListType::toLabel(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

writeMemberGroups()

void FileDefImpl::writeMemberGroups ( OutputList & ol )

private

Definition at line 808 of file filedef.cpp.

{
  /* write user defined member groups */
  for (const auto &mg : m_memberGroups)
  {
    if (!mg->allMembersInSameSection() || !m_subGrouping)
    {
      mg->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr);
    }
  }
}

References m_memberGroups, and m_subGrouping.

Referenced by writeDocumentation().

writeMemberPages()

void FileDefImpl::writeMemberPages ( OutputList & ol )

overridevirtual

Implements FileDef.

Definition at line 1128 of file filedef.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  for (const auto &ml : m_memberLists)
  {
    if (ml->listType().isDocumentation())
    {
      ml->writeDocumentationPage(ol,name(),this);
    }
  }
 
  ol.popGeneratorState();
}

References OutputList::disableAllBut(), Html, m_memberLists, name(), OutputList::popGeneratorState(), and OutputList::pushGeneratorState().

Referenced by writeDocumentation().

writeNamespaceDeclarations()

void FileDefImpl::writeNamespaceDeclarations ( OutputList & ol, const DString & title, bool isConstantGroup )

private

Definition at line 748 of file filedef.cpp.

{
  // write list of namespaces
  m_namespaces.writeDeclaration(ol,title,isConstantGroup);
}

References m_namespaces, title(), and NamespaceLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

writePageNavigation()

void FileDefImpl::writePageNavigation ( OutputList & ol ) const

overridevirtual

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 898 of file filedef.cpp.

{
  ol.writePageOutline();
}

References OutputList::writePageOutline().

writeQuickMemberLinks()

void FileDefImpl::writeQuickMemberLinks ( OutputList & ol, const MemberDef * currentMd ) const

overridevirtual

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1144 of file filedef.cpp.

{
  bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
 
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
 
  MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
  if (allMemberList)
  {
    for (const auto &md : *allMemberList)
    {
      if (md->getFileDef()==this && md->getNamespaceDef()==nullptr && md->isLinkable() && !md->isEnumValue())
      {
        if (md->isLinkableInProject())
        {
          DString fn=md->getOutputFileBase();
          addHtmlExtensionIfMissing(fn);
          if (md==currentMd) // selected item => highlight
          {
            ol.writeString("          <tr><td class=\"navtabHL\">");
          }
          else
          {
            ol.writeString("          <tr><td class=\"navtab\">");
          }
          ol.writeString("<span class=\"label\"><a ");
          ol.writeString("href=\"");
          if (createSubDirs) ol.writeString("../../");
          ol.writeString(fn+"#"+md->anchor());
          ol.writeString("\">");
          ol.writeString(convertToHtml(md->localName()));
          ol.writeString("</a></span>");
          ol.writeString("</td></tr>\n");
        }
      }
    }
  }
 
  ol.writeString("        </table>\n");
  ol.writeString("      </div>\n");
}

References addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), createSubDirs(), getMemberList(), and OutputList::writeString().

writeSourceBody()

void FileDefImpl::writeSourceBody ( OutputList & ol, ClangTUParser * clangParser )

overridevirtual

Implements FileDef.

Definition at line 1241 of file filedef.cpp.

{
  bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
  OutputCodeList devNullList;
  devNullList.add<DevNullCodeGenerator>();
#if USE_LIBCLANG
  if (Doxygen::clangAssistedParsing && clangParser &&
      (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
  {
    auto &codeOL = ol.codeGenerators();
    codeOL.startCodeFragment("DoxyCode");
    clangParser->switchToFile(this);
    clangParser->writeSources(codeOL,this);
    codeOL.endCodeFragment("DoxyCode");
  }
  else
#endif
  {
    auto intf = Doxygen::parserManager->getCodeParser(getDefFileExtension());
    intf->resetCodeParserState();
    auto &codeOL = ol.codeGenerators();
    codeOL.startCodeFragment("DoxyCode");
    bool needs2PassParsing =
        Doxygen::parseSourcesNeeded &&                // we need to parse (filtered) sources for cross-references
        !filterSourceFiles &&                         // but user wants to show sources as-is
        !getFileFilter(absFilePath(),true).empty(); // and there is a filter used while parsing
 
    if (needs2PassParsing)
    {
      // parse code for cross-references only (see bug707641)
      intf->parseCode(devNullList,DString(),
                       fileToString(absFilePath(),true,true),
                       getLanguage(),
                       Config_getBool(STRIP_CODE_COMMENTS),
                       CodeParserOptions()
                       .setFileDef(this)
                      );
    }
    size_t indent = 0;
    intf->parseCode(codeOL,DString(),
        detab(fileToString(absFilePath(),filterSourceFiles,true),indent),
        getLanguage(),      // lang
        Config_getBool(STRIP_CODE_COMMENTS),
        CodeParserOptions()
        .setFileDef(this)
        .setCollectXRefs(!needs2PassParsing)
        );
    codeOL.endCodeFragment("DoxyCode");
  }
}

References absFilePath(), OutputCodeList::add(), Doxygen::clangAssistedParsing, OutputList::codeGenerators(), Config_getBool, detab(), DString::empty(), fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), getFileFilter(), DefinitionMixin< FileDef >::getLanguage(), Doxygen::parserManager, Doxygen::parseSourcesNeeded, and OutputCodeList::startCodeFragment().

writeSourceFooter()

void FileDefImpl::writeSourceFooter ( OutputList & ol )

overridevirtual

Implements FileDef.

Definition at line 1292 of file filedef.cpp.

{
  ol.endContents();
  endFileWithNavPath(ol,this,false);
  ol.enableAll();
}

References OutputList::enableAll(), OutputList::endContents(), and endFileWithNavPath().

writeSourceHeader()

void FileDefImpl::writeSourceHeader ( OutputList & ol )

overridevirtual

Write a source listing of this file to the output

Implements FileDef.

Definition at line 1188 of file filedef.cpp.

{
  bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
  DString title = m_docname;
  if (!m_fileVersion.empty())
  {
    title+=" ("+m_fileVersion+")";
  }
  DString pageTitle = theTranslator->trSourceFile(title);
  ol.disable(OutputType::Man);
 
  bool isDocFile = isDocumentationFile();
  bool genSourceFile = !isDocFile && generateSourceFile();
  if (getDirDef())
  {
    startFile(ol,getSourceFileBase(),true,DString(),pageTitle,HighlightedItem::FileVisible,
        !generateTreeView,
        !isDocFile && genSourceFile ? DString() : getOutputFileBase(),
        0);
    if (!generateTreeView)
    {
      getDirDef()->writeNavigationPath(ol);
      ol.endQuickIndices();
    }
    startTitle(ol,getSourceFileBase());
    ol.parseText(name());
    endTitle(ol,getSourceFileBase(),title);
  }
  else
  {
    startFile(ol,getSourceFileBase(),true,DString(),pageTitle,HighlightedItem::FileVisible,false,
        !isDocFile && genSourceFile ? DString() : getOutputFileBase(),
        0);
    startTitle(ol,getSourceFileBase());
    ol.parseText(title);
    endTitle(ol,getSourceFileBase(),DString());
  }
 
  ol.startContents();
 
  if (isLinkable())
  {
    ol.startTextLink(getOutputFileBase(),DString());
    ol.parseText(theTranslator->trGotoDocumentation());
    ol.endTextLink();
 
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::RTF);
    ol.writeString("\\par\n");
    ol.popGeneratorState();
  }
}

References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DString::empty(), OutputList::endQuickIndices(), OutputList::endTextLink(), endTitle(), FileVisible, generateSourceFile(), getDirDef(), getOutputFileBase(), getSourceFileBase(), isDocumentationFile(), isLinkable(), m_docname, m_fileVersion, Man, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startContents(), startFile(), OutputList::startTextLink(), startTitle(), theTranslator, title(), Translator::trGotoDocumentation(), Translator::trSourceFile(), DefinitionMutable::writeNavigationPath(), and OutputList::writeString().

writeSourceLink()

void FileDefImpl::writeSourceLink ( OutputList & ol )

private

Definition at line 733 of file filedef.cpp.

{
  //printf("%s: generateSourceFile()=%d\n",qPrint(name()),generateSourceFile());
  if (generateSourceFile())
  {
    ol.disableAllBut(OutputType::Html);
    ol.startParagraph();
    ol.startTextLink(includeName(),DString());
    ol.parseText(theTranslator->trGotoSourceCode());
    ol.endTextLink();
    ol.endParagraph();
    ol.enableAll();
  }
}

References OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextLink(), generateSourceFile(), Html, includeName(), OutputList::parseText(), OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, and Translator::trGotoSourceCode().

Referenced by writeDocumentation().

writeSummaryLinks()

void FileDefImpl::writeSummaryLinks ( OutputList & ol ) const

overridevirtual

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 832 of file filedef.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  bool first=true;
  SrcLangExt lang=getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
  {
    const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
    if (lde->kind()==LayoutDocEntry::FileClasses && m_classes.declVisible() && ls)
    {
      DString label = "nested-classes";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::FileInterfaces && m_interfaces.declVisible() && ls)
    {
      DString label = "interfaces";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::FileStructs && m_structs.declVisible() && ls)
    {
      DString label = "structs";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::FileExceptions && m_exceptions.declVisible() && ls)
    {
      DString label = "exceptions";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::FileNamespaces && m_namespaces.declVisible(false) && ls)
    {
      DString label = "namespaces";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::FileConcepts && m_concepts.declVisible() && ls)
    {
      DString label = "concepts";
      ol.writeSummaryLink(DString(),label,ls->title(lang),first);
      first=false;
    }
    else if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd)
      {
        MemberList * ml = getMemberList(lmd->type);
        if (ml && ml->declVisible())
        {
          ol.writeSummaryLink(DString(),ml->listType().toLabel(),lmd->title(lang),first);
          first=false;
        }
      }
    }
  }
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

References ClassLinkedRefMap::declVisible(), ConceptLinkedRefMap::declVisible(), MemberList::declVisible(), NamespaceLinkedRefMap::declVisible(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::getLanguage(), getMemberList(), Html, LayoutDocManager::instance(), MemberList::listType(), m_classes, m_concepts, m_exceptions, m_interfaces, m_namespaces, m_structs, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntryMemberDecl::title(), LayoutDocEntrySection::title(), MemberListType::toLabel(), LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

writeTagFile()

void FileDefImpl::writeTagFile ( TextStream & t )

overridevirtual

Implements FileDef.

Definition at line 376 of file filedef.cpp.

{
  DString fn=getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "  <compound kind=\"file\">\n";
  tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
  tagFile << "    <path>" << convertToXML(stripFromPath(getPath())) << "</path>\n";
  tagFile << "    <filename>" << fn << "</filename>\n";
  for (const auto &ii : m_includeList)
  {
    const FileDef *fd=ii.fileDef;
    if (fd && fd->isLinkable() && !fd->isReference())
    {
      DString attr = includeTagFileAttributes(fd->getLanguage(),ii.kind);
      tagFile << "    <includes id=\""
        << convertToXML(fd->getOutputFileBase()) << "\" "
        << "name=\"" << convertToXML(fd->name()) << "\" "
        << attr << ">"
        << convertToXML(ii.includeName)
        << "</includes>\n";
    }
  }
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::FileClasses:
        {
          writeClassesToTagFile(tagFile, m_classes);
        }
        break;
      case LayoutDocEntry::FileInterfaces:
        {
          writeClassesToTagFile(tagFile, m_interfaces);
        }
        break;
      case LayoutDocEntry::FileStructs:
        {
          writeClassesToTagFile(tagFile, m_structs);
        }
        break;
      case LayoutDocEntry::FileExceptions:
        {
          writeClassesToTagFile(tagFile, m_exceptions);
        }
        break;
      case LayoutDocEntry::FileConcepts:
        {
          for (const auto *nd : m_concepts)
          {
            if (nd->isLinkableInProject())
            {
              tagFile << "    <concept>" << convertToXML(nd->name()) << "</concept>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::FileNamespaces:
        {
          for (const auto *nd : m_namespaces)
          {
            if (nd->isLinkableInProject())
            {
              tagFile << "    <namespace>" << convertToXML(nd->name()) << "</namespace>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            MemberList * ml = getMemberList(lmd->type);
            if (ml)
            {
              ml->writeTagFile(tagFile,false,false);
            }
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        {
          for (const auto &mg : m_memberGroups)
          {
            mg->writeTagFile(tagFile);
          }
        }
        break;
      default:
        break;
    }
  }
 
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>\n";
}

References addHtmlExtensionIfMissing(), convertToXML(), Definition::getLanguage(), getMemberList(), Definition::getOutputFileBase(), getOutputFileBase(), getPath(), includeTagFileAttributes(), LayoutDocManager::instance(), Definition::isLinkable(), Definition::isReference(), m_classes, m_concepts, m_exceptions, m_includeList, m_interfaces, m_memberGroups, m_namespaces, m_structs, Definition::name(), name(), stripFromPath(), LayoutDocEntryMemberDecl::type, writeClassesToTagFile(), DefinitionMixin< FileDef >::writeDocAnchorsToTagFile(), and MemberList::writeTagFile().

Member Data Documentation

m_classes

ClassLinkedRefMap FileDefImpl::m_classes

private

Definition at line 259 of file filedef.cpp.

Referenced by getClasses(), insertClass(), sortMemberLists(), writeDocumentation(), writeInlineClasses(), writeSummaryLinks(), and writeTagFile().

m_concepts

ConceptLinkedRefMap FileDefImpl::m_concepts

private

Definition at line 263 of file filedef.cpp.

Referenced by getConcepts(), insertConcept(), sortMemberLists(), writeConcepts(), writeSummaryLinks(), and writeTagFile().

m_dir

DirDef* FileDefImpl::m_dir = nullptr

private

Definition at line 254 of file filedef.cpp.

Referenced by FileDefImpl(), getDirDef(), and setDirDef().

m_docname

DString FileDefImpl::m_docname

private

Definition at line 249 of file filedef.cpp.

Referenced by docName(), FileDefImpl(), writeDocumentation(), and writeSourceHeader().

m_exceptions

ClassLinkedRefMap FileDefImpl::m_exceptions

private

Definition at line 262 of file filedef.cpp.

Referenced by insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks(), and writeTagFile().

m_fileName

DString FileDefImpl::m_fileName

private

Definition at line 248 of file filedef.cpp.

Referenced by FileDefImpl(), fileName(), and name().

m_filePath

DString FileDefImpl::m_filePath

private

Definition at line 244 of file filedef.cpp.

Referenced by absFilePath(), acquireFileVersion(), FileDefImpl(), and getSourceFileBase().

m_fileVersion

DString FileDefImpl::m_fileVersion

private

Definition at line 253 of file filedef.cpp.

Referenced by acquireFileVersion(), fileVersion(), getVersion(), writeDocumentation(), and writeSourceHeader().

m_hasIncludedByGraph

bool FileDefImpl::m_hasIncludedByGraph = Config_getBool(INCLUDED_BY_GRAPH)

private

Definition at line 266 of file filedef.cpp.

Referenced by hasIncludedByGraph(), overrideIncludedByGraph(), and writeIncludedByGraph().

m_hasIncludeGraph

bool FileDefImpl::m_hasIncludeGraph = Config_getBool(INCLUDE_GRAPH)

private

Definition at line 265 of file filedef.cpp.

Referenced by hasIncludeGraph(), overrideIncludeGraph(), and writeIncludeGraph().

m_incInfo

std::unique_ptr<IncludeInfo> FileDefImpl::m_incInfo

private

Definition at line 242 of file filedef.cpp.

Referenced by setIncludeFile(), and writeIncludeFiles().

m_inclByDepFileName

DString FileDefImpl::m_inclByDepFileName

private

Definition at line 246 of file filedef.cpp.

Referenced by includedByDependencyGraphFileName(), and setDiskNameLocal().

m_inclDepFileName

DString FileDefImpl::m_inclDepFileName

private

Definition at line 245 of file filedef.cpp.

Referenced by includeDependencyGraphFileName(), and setDiskNameLocal().

m_includedByList

IncludeInfoList FileDefImpl::m_includedByList

private

Definition at line 239 of file filedef.cpp.

Referenced by addIncludedByDependency(), includedByFileList(), and sortMemberLists().

m_includedByMap

IncludeInfoMap FileDefImpl::m_includedByMap

private

Definition at line 238 of file filedef.cpp.

Referenced by addIncludedByDependency(), and generateSourceFile().

m_includeList

IncludeInfoList FileDefImpl::m_includeList

private

Definition at line 237 of file filedef.cpp.

Referenced by addIncludeDependency(), addIncludedUsingDirectives(), includeFileList(), writeIncludeFiles(), and writeTagFile().

m_includeMap

IncludeInfoMap FileDefImpl::m_includeMap

private

Definition at line 236 of file filedef.cpp.

Referenced by addIncludeDependency(), and isIncluded().

m_interfaces

ClassLinkedRefMap FileDefImpl::m_interfaces

private

Definition at line 260 of file filedef.cpp.

Referenced by insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks(), and writeTagFile().

m_isSource

bool FileDefImpl::m_isSource

private

Definition at line 252 of file filedef.cpp.

Referenced by FileDefImpl(), and isSource().

m_memberGroups

MemberGroupList FileDefImpl::m_memberGroups

private

Definition at line 257 of file filedef.cpp.

Referenced by addListReferences(), addMembersToMemberGroup(), addRequirementReferences(), countMembers(), distributeMemberGroupDocumentation(), findSectionsInDocumentation(), getMemberGroups(), sortMemberLists(), writeMemberGroups(), and writeTagFile().

m_memberLists

MemberLists FileDefImpl::m_memberLists

private

Definition at line 256 of file filedef.cpp.

Referenced by addListReferences(), addMembersToMemberGroup(), addMemberToList(), addRequirementReferences(), countMembers(), findSectionsInDocumentation(), getMemberList(), getMemberLists(), insertMember(), sortMemberLists(), and writeMemberPages().

m_moduleDef

ModuleDef* FileDefImpl::m_moduleDef = nullptr

private

Definition at line 255 of file filedef.cpp.

Referenced by getModuleDef(), and setModuleDef().

m_namespaces

NamespaceLinkedRefMap FileDefImpl::m_namespaces

private

Definition at line 258 of file filedef.cpp.

Referenced by getNamespaces(), insertNamespace(), sortMemberLists(), writeNamespaceDeclarations(), writeSummaryLinks(), and writeTagFile().

m_outputDiskName

DString FileDefImpl::m_outputDiskName

private

Definition at line 247 of file filedef.cpp.

Referenced by getOutputFileBase(), getSourceFileBase(), and setDiskNameLocal().

m_path

DString FileDefImpl::m_path

private

Definition at line 243 of file filedef.cpp.

Referenced by FileDefImpl(), and getPath().

m_srcDefMap

DefinitionLineMap FileDefImpl::m_srcDefMap

private

Definition at line 250 of file filedef.cpp.

Referenced by addSourceRef(), and getSourceDefinition().

m_srcMemberMap

MemberDefLineMap FileDefImpl::m_srcMemberMap

private

Definition at line 251 of file filedef.cpp.

Referenced by addSourceRef(), and getSourceMember().

m_structs

ClassLinkedRefMap FileDefImpl::m_structs

private

Definition at line 261 of file filedef.cpp.

Referenced by insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks(), and writeTagFile().

m_subGrouping

bool FileDefImpl::m_subGrouping

private

Definition at line 264 of file filedef.cpp.

Referenced by addMembersToMemberGroup(), FileDefImpl(), subGrouping(), and writeMemberGroups().

m_usingDeclList

LinkedRefMap<const Definition> FileDefImpl::m_usingDeclList

private

Definition at line 241 of file filedef.cpp.

Referenced by addIncludedUsingDirectives(), addUsingDeclaration(), and getUsedDefinitions().

m_usingDirList

LinkedRefMap<NamespaceDef> FileDefImpl::m_usingDirList

private

Definition at line 240 of file filedef.cpp.

Referenced by addIncludedUsingDirectives(), addUsingDirective(), combineUsingRelations(), and getUsedNamespaces().

---

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

• src/filedef.cpp