Inheritance diagram for DirDefImpl:

Collaboration diagram for DirDefImpl:

Public Member Functions
	DirDefImpl (const QCString &path)

	~DirDefImpl () override

DefType	definitionType () const override

CodeSymbolType	codeSymbolType () const override

QCString	getOutputFileBase () const override

QCString	anchor () const override

bool	isLinkableInProject () const override

bool	isLinkable () const override

QCString	displayName (bool=TRUE) const override

const QCString	shortName () const override

void	addSubDir (DirDef *subdir) override

const FileList &	getFiles () const override

void	addFile (FileDef *fd) override

const DirList &	subDirs () const override

bool	hasSubdirs () const override

int	level () const override

DirDef *	parent () const override

int	dirIndex () const override

const UsedDirLinkedMap &	usedDirs () const override

bool	isParentOf (const DirDef *dir) const override

bool	depGraphIsTrivial () const override

QCString	shortTitle () const override

bool	hasDetailedDescription () const override

void	writeDocumentation (OutputList &ol) override

void	writeTagFile (TextStream &t) override

void	setDiskName (const QCString &name) override

void	sort () override

void	setParent (DirDef *parent) override

void	setDirIndex (int index) override

void	setLevel () override

void	addUsesDependency (const DirDef usedDir, const FileDef srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect) override
	Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd.

void	computeDependencies () override
	Computes the dependencies between directories.

bool	hasDirectoryGraph () const override

void	overrideDirectoryGraph (bool e) override

Public Member Functions inherited from DefinitionMixin< DirDef >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=nullptr, const char d=nullptr, bool isSymbol=TRUE)

	DefinitionMixin (const DefinitionMixin &other)

	DefinitionMixin (DefinitionMixin &&)=delete

DefinitionMixin &	operator= (const DefinitionMixin &other)

DefinitionMixin &	operator= (DefinitionMixin &&)=delete

	~DefinitionMixin () override=default

bool	isAlias () const override

const QCString &	name () const override

bool	isAnonymous () const override

const QCString &	localName () const override

QCString	qualifiedName () const override

QCString	symbolName () const override

QCString	getSourceFileBase () const override

QCString	getSourceAnchor () const override

QCString	documentation () const override

int	docLine () const override

QCString	docFile () const override

QCString	briefDescription (bool abbreviate=FALSE) const override

QCString	briefDescriptionAsTooltip () const override

int	briefLine () const override

QCString	inbodyDocumentation () const override

QCString	inbodyFile () const override

int	inbodyLine () const override

QCString	briefFile () const override

QCString	getDefFileName () const override

QCString	getDefFileExtension () const override

int	getDefLine () const override

int	getDefColumn () const override

bool	hasDocumentation () const override

bool	hasUserDocumentation () const override

bool	isVisibleInProject () const override

bool	isVisible () const override

bool	isHidden () const override

bool	isArtificial () const override

bool	isExported () const override

QCString	getReference () const override

bool	isReference () const override

QCString	externalReference (const QCString &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 Definition *	findInnerCompound (const QCString &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

QCString	id () const override

const SectionRefs &	getSectionRefs () const override

void	setName (const QCString &name) override

void	setId (const QCString &name) override

void	setDefFile (const QCString &df, int defLine, int defColumn) override

void	setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override

void	setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override

void	setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override

void	setReference (const QCString &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 QCString &sourceRefName) override

void	addSourceReferences (MemberDef *md, const QCString &sourceRefName) override

void	setRefItems (const RefItemVector &sli) 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 QCString &scopeName) const override

bool	hasSourceRefs () const override

bool	hasSourceReffedBy () const override

void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const override

void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override

void	makePartOfGroup (GroupDef *gd) override

void	writeNavigationPath (OutputList &ol) const override

QCString	navigationPathAsString () const override

void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override

void	writeSummaryLinks (OutputList &ol) const override

QCString	pathFragment () const override

void	writeDocAnchorsToTagFile (TextStream &fs) const override

void	setLocalName (const QCString &name) override

void	writeToc (OutputList &ol, const LocalToc &lt) const override

void	computeTooltip () override

void	_setSymbolName (const QCString &name) override

QCString	_symbolName () const override

Public Member Functions inherited from DirDef
Public Member Functions inherited from DefinitionMutable
Public Member Functions inherited from Definition

Static Public Member Functions
static DirDef *	mergeDirectoryInTree (const QCString &path)

Private Member Functions
void	writeDetailedDescription (OutputList &ol, const QCString &title)

void	writeBriefDescription (OutputList &ol)

void	writeDirectoryGraph (OutputList &ol)

void	writeSubDirList (OutputList &ol)

void	writeFileList (OutputList &ol)

void	startMemberDeclarations (OutputList &ol)

void	endMemberDeclarations (OutputList &ol)

Static Private Member Functions
static DirDef *	createNewDir (const QCString &path)

static bool	matchPath (const QCString &path, const StringVector &l)

Private Attributes
DirList	m_subdirs

QCString	m_dispName

QCString	m_shortName

QCString	m_diskName

FileList	m_fileList

int	m_dirIndex = -1

int	m_level

DirDef *	m_parent

UsedDirLinkedMap	m_usedDirs

bool	m_hasDirectoryGraph = false

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 37 of file dirdef.cpp.

Constructor & Destructor Documentation

◆ DirDefImpl()

DirDefImpl::DirDefImpl ( const QCString & path )

Definition at line 116 of file dirdef.cpp.

                                           : DefinitionMixin(path,1,1,path)
{
  bool fullPathNames = Config_getBool(FULL_PATH_NAMES);
  // get display name (stripping the paths mentioned in STRIP_FROM_PATH)
  // get short name (last part of path)
  m_shortName = path;
  m_diskName = path;
  if (m_shortName.at(m_shortName.length()-1)=='/')
  { // strip trailing /
    m_shortName = m_shortName.left(m_shortName.length()-1);
  }
  int pi=m_shortName.findRev('/');
  if (pi!=-1)
  { // remove everything till the last /
    m_shortName = m_shortName.mid(pi+1);
  }
  setLocalName(m_shortName);
  m_dispName = fullPathNames ? stripFromPath(path) : m_shortName;
  if (m_dispName.length()>0 && m_dispName.at(m_dispName.length()-1)=='/')
  { // strip trailing /
    m_dispName = m_dispName.left(m_dispName.length()-1);
  }
 
  m_level=-1;
  m_parent=nullptr;
  m_hasDirectoryGraph=Config_getBool(DIRECTORY_GRAPH);
 
}

References Config_getBool, DefinitionMixin< DirDef >::DefinitionMixin(), m_diskName, m_dispName, m_hasDirectoryGraph, m_level, m_parent, m_shortName, DefinitionMixin< DirDef >::setLocalName(), and stripFromPath().

◆ ~DirDefImpl()

DirDefImpl::~DirDefImpl ( )

override

Definition at line 145 of file dirdef.cpp.

146{

147}

Member Function Documentation

◆ addFile()

void DirDefImpl::addFile ( FileDef * fd )

overridevirtual

Implements DirDef.

Definition at line 176 of file dirdef.cpp.

{
  m_fileList.push_back(fd);
  fd->setDirDef(this);
}

References m_fileList, and FileDef::setDirDef().

◆ addSubDir()

void DirDefImpl::addSubDir ( DirDef * subdir )

overridevirtual

Implements DirDef.

Definition at line 159 of file dirdef.cpp.

{
  m_subdirs.push_back(subdir);
  subdir->setOuterScope(this);
  subdir->setParent(this);
}

References m_subdirs, DefinitionMutable::setOuterScope(), and DirDef::setParent().

◆ addUsesDependency()

void DirDefImpl::addUsesDependency	(	const DirDef *	dir,
		const FileDef *	srcFd,
		const FileDef *	dstFd,
		bool	srcDirect,
		bool	dstDirect )

overridevirtual

Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd.

srcDirect and dstDirect indicate if it is a direct dependencies (true) or if the dependencies was indirect (e.g. a parent dir that has a child dir that has the dependencies)

Implements DirDef.

Definition at line 683 of file dirdef.cpp.

{
  if (this==dir) return; // do not add self-dependencies
  AUTO_TRACE("add dependency {}->{} due to {}->{}",
      qPrint(shortName()),
      qPrint(dir->shortName()),
      qPrint(srcFd->name()),
      qPrint(dstFd->name()));
 
  // levels match => add direct dependency
  bool added=FALSE;
  UsedDir *usedDir = m_usedDirs.find(dir->getOutputFileBase());
  if (usedDir) // dir dependency already present
  {
     const FilePair *usedPair = usedDir->findFilePair(FilePair::key(srcFd,dstFd));
     if (usedPair==nullptr) // new file dependency
     {
       AUTO_TRACE_ADD("{} => {} new file dependency",srcFd->name(),dstFd->name());
       usedDir->addFileDep(srcFd,dstFd, srcDirect, dstDirect);
       added=TRUE;
     }
     else
     {
       // dir & file dependency already added
     }
  }
  else // new directory dependency
  {
    AUTO_TRACE_ADD("{} => {} new file dependency",srcFd->name(),dstFd->name());
    auto newUsedDir = std::make_unique<UsedDir>(dir);
    newUsedDir->addFileDep(srcFd,dstFd, srcDirect, dstDirect);
    m_usedDirs.add(dir->getOutputFileBase(),std::move(newUsedDir));
    added=TRUE;
  }
  if (added)
  {
    if (dir->parent())
    {
      // add relation to parent of used dir
      addUsesDependency(dir->parent(),
                        srcFd,
                        dstFd,
                        srcDirect,
                        false); // indirect dependency on dest dir
    }
    if (parent())
    {
      // add relation for the parent of this dir as well
      parent()->addUsesDependency(dir,
                                 srcFd,
                                 dstFd,
                                 false, // indirect dependency from source dir
                                 dstDirect);
    }
  }
}

References UsedDir::addFileDep(), DirDef::addUsesDependency(), addUsesDependency(), AUTO_TRACE, AUTO_TRACE_ADD, FALSE, UsedDir::findFilePair(), Definition::getOutputFileBase(), FilePair::key(), m_usedDirs, Definition::name(), DirDef::parent(), parent(), qPrint(), DirDef::shortName(), shortName(), and TRUE.

Referenced by addUsesDependency(), and computeDependencies().

◆ anchor()

QCString DirDefImpl::anchor ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 47 of file dirdef.cpp.

47{ return QCString(); }

◆ codeSymbolType()

CodeSymbolType DirDefImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 45 of file dirdef.cpp.

45{ return CodeSymbolType::Default; }

CodeSymbolType::Default

@ Default

Definition types.h:320

References Default.

◆ computeDependencies()

void DirDefImpl::computeDependencies ( )

overridevirtual

Computes the dependencies between directories.

Implements DirDef.

Definition at line 743 of file dirdef.cpp.

{
  AUTO_TRACE();
  for (const auto &fd : m_fileList)
  {
    AUTO_TRACE_ADD("dir={} file={}",shortName(),fd->name());
    for (const auto &ii : fd->includeFileList())
    {
      AUTO_TRACE_ADD("#include {}",ii.includeName);
      if (ii.fileDef && ii.fileDef->isLinkable()) // linkable file
      {
        DirDef *usedDir = ii.fileDef->getDirDef();
        if (usedDir)
        {
          // add dependency: thisDir->usedDir
          AUTO_TRACE_ADD("add dependency {}->{}",name(),usedDir->name());
          addUsesDependency(usedDir,fd,ii.fileDef,true,true);
        }
      }
    }
  }
 
  std::stable_sort(m_usedDirs.begin(),m_usedDirs.end(),
            [](const auto &u1,const auto &u2)
            { return qstricmp_sort(u1->dir()->getOutputFileBase(),u2->dir()->getOutputFileBase())<0; });
 
  for (const auto& usedDirectory : m_usedDirs)
  {
    usedDirectory->sort();
  }
}

References addUsesDependency(), AUTO_TRACE, AUTO_TRACE_ADD, m_fileList, m_usedDirs, Definition::name(), DefinitionMixin< DirDef >::name(), and shortName().

◆ createNewDir()

DirDef * DirDefImpl::createNewDir ( const QCString & path )

staticprivate

Definition at line 823 of file dirdef.cpp.

{
  AUTO_TRACE();
  ASSERT(path!=nullptr);
  DirDef *dir = Doxygen::dirLinkedMap->find(path);
  if (dir==nullptr) // new dir
  {
    dir = Doxygen::dirLinkedMap->add(path,
            std::unique_ptr<DirDef>(
              createDirDef(path)));
    AUTO_TRACE_ADD("Adding new dir {} shortName {}",path,dir->shortName());
  }
  return dir;
}

References ASSERT, AUTO_TRACE, AUTO_TRACE_ADD, createDirDef(), Doxygen::dirLinkedMap, and DirDef::shortName().

Referenced by mergeDirectoryInTree().

◆ definitionType()

DefType DirDefImpl::definitionType ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 44 of file dirdef.cpp.

44{ return TypeDir; }

Definition::TypeDir

@ TypeDir

Definition definition.h:91

References definitionType(), and Definition::TypeDir.

Referenced by definitionType().

◆ depGraphIsTrivial()

bool DirDefImpl::depGraphIsTrivial ( ) const

overridevirtual

Implements DirDef.

Definition at line 785 of file dirdef.cpp.

{
  return m_usedDirs.empty() && m_parent==nullptr;
}

References m_parent, and m_usedDirs.

◆ dirIndex()

int DirDefImpl::dirIndex ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 59 of file dirdef.cpp.

59{ return m_dirIndex; }

DirDefImpl::m_dirIndex

int m_dirIndex

Definition dirdef.cpp:100

References m_dirIndex.

◆ displayName()

QCString DirDefImpl::displayName ( bool includeScope = TRUE ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 50 of file dirdef.cpp.

50{ return m_dispName; }

References m_dispName, and TRUE.

Referenced by writeDirectoryGraph(), and writeTagFile().

◆ endMemberDeclarations()

void DirDefImpl::endMemberDeclarations ( OutputList & ol )

private

Definition at line 482 of file dirdef.cpp.

{
  ol.endMemberSections();
}

References OutputList::endMemberSections().

Referenced by writeDocumentation().

◆ getFiles()

const FileList & DirDefImpl::getFiles ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 53 of file dirdef.cpp.

53{ return m_fileList; }

References m_fileList.

◆ getOutputFileBase()

QCString DirDefImpl::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 222 of file dirdef.cpp.

{
  QCString dir = "dir_"+encodeDirName(m_diskName);
  AUTO_TRACE("diskName={} result={}",m_diskName,dir);
  return dir;
}

References AUTO_TRACE, encodeDirName(), and m_diskName.

Referenced by writeDocumentation(), and writeTagFile().

◆ hasDetailedDescription()

bool DirDefImpl::hasDetailedDescription ( ) const

overridevirtual

Implements DirDef.

Definition at line 492 of file dirdef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  return (!briefDescription().isEmpty() && repeatBrief) || !documentation().isEmpty();
}

References DefinitionMixin< DirDef >::briefDescription(), Config_getBool, DefinitionMixin< DirDef >::documentation(), and QCString::isEmpty().

◆ hasDirectoryGraph()

bool DirDefImpl::hasDirectoryGraph ( ) const

overridevirtual

Implements DirDef.

Definition at line 876 of file dirdef.cpp.

{
  return m_hasDirectoryGraph;
}

References m_hasDirectoryGraph.

◆ hasSubdirs()

bool DirDefImpl::hasSubdirs ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 56 of file dirdef.cpp.

56{ return !m_subdirs.empty(); }

References m_subdirs.

◆ isLinkable()

bool DirDefImpl::isLinkable ( ) const

overridevirtual

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 154 of file dirdef.cpp.

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

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

◆ isLinkableInProject()

bool DirDefImpl::isLinkableInProject ( ) const

overridevirtual

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

Implements Definition.

Definition at line 149 of file dirdef.cpp.

{
  return !isReference();
}

References DefinitionMixin< DirDef >::isReference().

Referenced by isLinkable().

◆ isParentOf()

bool DirDefImpl::isParentOf ( const DirDef * dir ) const

overridevirtual

Implements DirDef.

Definition at line 775 of file dirdef.cpp.

{
  if (dir->parent()==this) // this is a parent of dir
    return TRUE;
  else if (dir->parent()) // repeat for the parent of dir
    return isParentOf(dir->parent());
  else
    return FALSE;
}

References FALSE, isParentOf(), DirDef::parent(), and TRUE.

Referenced by isParentOf().

◆ level()

int DirDefImpl::level ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 57 of file dirdef.cpp.

57{ return m_level; }

References m_level.

◆ matchPath()

bool DirDefImpl::matchPath	(	const QCString &	path,
		const StringVector &	l )

staticprivate

Definition at line 838 of file dirdef.cpp.

{
  for (const auto &s : l)
  {
    std::string prefix = s.substr(0,path.length());
    if (qstricmp_sort(prefix.c_str(),path)==0) // case insensitive compare
    {
      return TRUE;
    }
  }
  return FALSE;
}

References FALSE, QCString::length(), prefix, qstricmp_sort(), and TRUE.

Referenced by mergeDirectoryInTree().

◆ mergeDirectoryInTree()

DirDef * DirDefImpl::mergeDirectoryInTree ( const QCString & path )

static

strip part of path if it matches one of the paths in the Config_getList(STRIP_FROM_PATH) list

Definition at line 854 of file dirdef.cpp.

{
  AUTO_TRACE("path={}",path);
  int p=0,i=0;
  DirDef *dir=nullptr;
  while ((i=path.find('/',p))!=-1)
  {
    QCString part=path.left(i+1);
    if (!matchPath(part,Config_getList(STRIP_FROM_PATH)) && (part!="/" && part!="//" && part!="//?/"))
    {
      dir=createNewDir(removeLongPathMarker(part));
    }
    p=i+1;
  }
  return dir;
}

References AUTO_TRACE, Config_getList, createNewDir(), QCString::find(), QCString::left(), matchPath(), and removeLongPathMarker().

Referenced by buildDirectories().

◆ overrideDirectoryGraph()

void DirDefImpl::overrideDirectoryGraph ( bool e )

overridevirtual

Implements DirDef.

Definition at line 871 of file dirdef.cpp.

{
  m_hasDirectoryGraph=e;
}

References m_hasDirectoryGraph.

◆ parent()

DirDef * DirDefImpl::parent ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 58 of file dirdef.cpp.

58{ return m_parent; }

References m_parent.

Referenced by addUsesDependency(), and setLevel().

◆ setDirIndex()

void DirDefImpl::setDirIndex ( int index )

overridevirtual

Implements DirDef.

Definition at line 171 of file dirdef.cpp.

{
  m_dirIndex=index;
}

References m_dirIndex.

◆ setDiskName()

void DirDefImpl::setDiskName ( const QCString & name )

inlineoverridevirtual

Implements DirDef.

Definition at line 67 of file dirdef.cpp.

67{ m_diskName = name; }

References m_diskName, and DefinitionMixin< DirDef >::name().

◆ setLevel()

void DirDefImpl::setLevel ( )

overridevirtual

Implements DirDef.

Definition at line 661 of file dirdef.cpp.

{
  if (m_level==-1) // level not set before
  {
    DirDef *p = parent();
    if (p)
    {
      p->setLevel();
      m_level = p->level()+1;
    }
    else
    {
      m_level = 0;
    }
  }
}

References DirDef::level(), m_level, parent(), and DirDef::setLevel().

◆ setParent()

void DirDefImpl::setParent ( DirDef * parent )

overridevirtual

Implements DirDef.

Definition at line 166 of file dirdef.cpp.

{
   m_parent=p;
}

References m_parent.

◆ shortName()

const QCString DirDefImpl::shortName ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 51 of file dirdef.cpp.

51{ return m_shortName; }

References m_shortName.

Referenced by addUsesDependency(), computeDependencies(), and writeDirectoryGraph().

◆ shortTitle()

QCString DirDefImpl::shortTitle ( ) const

overridevirtual

Implements DirDef.

Definition at line 487 of file dirdef.cpp.

{
  return theTranslator->trDirReference(m_shortName);
}

References m_shortName, and theTranslator.

Referenced by writeDocumentation().

◆ sort()

void DirDefImpl::sort ( )

overridevirtual

Implements DirDef.

Definition at line 182 of file dirdef.cpp.

{
  std::stable_sort(m_subdirs.begin(), m_subdirs.end(), compareDirDefs);
  std::stable_sort(m_fileList.begin(), m_fileList.end(), compareFileDefs);
}

References compareDirDefs(), compareFileDefs(), m_fileList, and m_subdirs.

◆ startMemberDeclarations()

void DirDefImpl::startMemberDeclarations ( OutputList & ol )

private

Definition at line 477 of file dirdef.cpp.

{
  ol.startMemberSections();
}

References OutputList::startMemberSections().

Referenced by writeDocumentation().

◆ subDirs()

const DirList & DirDefImpl::subDirs ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 55 of file dirdef.cpp.

55{ return m_subdirs; }

References m_subdirs.

◆ usedDirs()

const UsedDirLinkedMap & DirDefImpl::usedDirs ( ) const

inlineoverridevirtual

Implements DirDef.

Definition at line 60 of file dirdef.cpp.

60{ return m_usedDirs; }

References m_usedDirs.

◆ writeBriefDescription()

void DirDefImpl::writeBriefDescription ( OutputList & ol )

private

Definition at line 276 of file dirdef.cpp.

{
  AUTO_TRACE();
  if (hasBriefDescription())
  {
    auto parser { createDocParser() };
    auto ast    { validatingParseDoc(
         *parser.get(), briefFile(),briefLine(),this,nullptr,briefDescription(),TRUE,FALSE,
         QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
    if (!ast->isEmpty())
    {
      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().isEmpty()
         )
      {
        ol.disableAllBut(OutputType::Html);
        ol.startTextLink(QCString(),"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
 
      ol.endParagraph();
    }
  }
  ol.writeSynopsis();
}

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

Referenced by writeDocumentation().

◆ writeDetailedDescription()

void DirDefImpl::writeDetailedDescription	(	OutputList &	ol,
		const QCString &	title )

private

Definition at line 229 of file dirdef.cpp.

{
  AUTO_TRACE();
  if ((!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF)) ||
      !documentation().isEmpty())
  {
    ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.writeRuler();
    ol.popGeneratorState();
    ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      ol.writeAnchor(QCString(),"details");
    ol.popGeneratorState();
    ol.startGroupHeader();
    ol.parseText(title);
    ol.endGroupHeader();
 
    // repeat brief description
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
    {
      ol.generateDoc(briefFile(),briefLine(),this,nullptr,briefDescription(),FALSE,FALSE,
                     QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
    }
    // separator between brief and details
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) &&
        !documentation().isEmpty())
    {
      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();
    }
 
    // write documentation
    if (!documentation().isEmpty())
    {
      ol.generateDoc(docFile(),docLine(),this,nullptr,documentation()+"\n",TRUE,FALSE,
                     QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
    }
  }
}

References AUTO_TRACE, DefinitionMixin< DirDef >::briefDescription(), DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< DirDef >::docFile(), DefinitionMixin< DirDef >::docLine(), DefinitionMixin< DirDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), FALSE, OutputList::generateDoc(), Html, Latex, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startGroupHeader(), TRUE, OutputList::writeAnchor(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ writeDirectoryGraph()

void DirDefImpl::writeDirectoryGraph ( OutputList & ol )

private

Definition at line 315 of file dirdef.cpp.

{
  // write graph dependency graph
  if (Config_getBool(HAVE_DOT) && m_hasDirectoryGraph /*&& Config_getBool(DIRECTORY_GRAPH)*/)
  {
    DotDirDeps dirDep(this);
    if (!dirDep.isTrivial())
    {
      msg("Generating dependency graph for directory %s\n",qPrint(displayName()));
      ol.disable(OutputType::Man);
      //ol.startParagraph();
      ol.startDirDepGraph();
      ol.parseText(theTranslator->trDirDepGraph(shortName()));
      ol.endDirDepGraph(dirDep);
      //ol.endParagraph();
      ol.enableAll();
    }
  }
}

References Config_getBool, OutputList::disable(), displayName(), OutputList::enableAll(), OutputList::endDirDepGraph(), DotDirDeps::isTrivial(), m_hasDirectoryGraph, Man, msg(), OutputList::parseText(), qPrint(), shortName(), OutputList::startDirDepGraph(), and theTranslator.

Referenced by writeDocumentation().

◆ writeDocumentation()

void DirDefImpl::writeDocumentation ( OutputList & ol )

overridevirtual

Implements DirDef.

Definition at line 537 of file dirdef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
 
  QCString title=theTranslator->trDirReference(m_dispName);
  AUTO_TRACE("title={}",title);
  startFile(ol,getOutputFileBase(),name(),title,HighlightedItem::Files,!generateTreeView);
 
  if (!generateTreeView)
  {
    // write navigation path
    writeNavigationPath(ol);
    ol.endQuickIndices();
  }
 
  startTitle(ol,getOutputFileBase());
  ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    ol.parseText(shortTitle());
    ol.enableAll();
    ol.disable(OutputType::Html);
    ol.parseText(title);
  ol.popGeneratorState();
  endTitle(ol,getOutputFileBase(),title);
  ol.startContents();
 
  //---------------------------------------- start flexible part -------------------------------
 
  SrcLangExt lang = getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Directory))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        writeBriefDescription(ol);
        break;
      case LayoutDocEntry::DirGraph:
        writeDirectoryGraph(ol);
        break;
      case LayoutDocEntry::MemberDeclStart:
        startMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DirSubDirs:
        writeSubDirList(ol);
        break;
      case LayoutDocEntry::DirFiles:
        writeFileList(ol);
        break;
      case LayoutDocEntry::MemberDeclEnd:
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc:
        {
          const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
          if (ls)
          {
            writeDetailedDescription(ol,ls->title(lang));
          }
        }
        break;
      case LayoutDocEntry::ClassIncludes:
      case LayoutDocEntry::ClassInlineClasses:
      case LayoutDocEntry::ClassInheritanceGraph:
      case LayoutDocEntry::ClassNestedClasses:
      case LayoutDocEntry::ClassCollaborationGraph:
      case LayoutDocEntry::ClassAllMembersLink:
      case LayoutDocEntry::ClassUsedFiles:
      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::FileClasses:
      case LayoutDocEntry::FileConcepts:
      case LayoutDocEntry::FileInterfaces:
      case LayoutDocEntry::FileStructs:
      case LayoutDocEntry::FileExceptions:
      case LayoutDocEntry::FileNamespaces:
      case LayoutDocEntry::FileConstantGroups:
      case LayoutDocEntry::FileIncludes:
      case LayoutDocEntry::FileIncludeGraph:
      case LayoutDocEntry::FileIncludedByGraph:
      case LayoutDocEntry::FileSourceLink:
      case LayoutDocEntry::FileInlineClasses:
      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::AuthorSection:
      case LayoutDocEntry::MemberGroups:
      case LayoutDocEntry::MemberDecl:
      case LayoutDocEntry::MemberDef:
      case LayoutDocEntry::MemberDefStart:
      case LayoutDocEntry::MemberDefEnd:
        err("Internal inconsistency: member '%s' should not be part of "
            "LayoutDocManager::Directory entry list\n",qPrint(lde->entryToString()));
        break;
    }
  }
 
  //---------------------------------------- end flexible part -------------------------------
 
  ol.endContents();
 
  endFileWithNavPath(ol,this);
 
  ol.popGeneratorState();
}

References AUTO_TRACE, Config_getBool, OutputList::disable(), OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endContents(), endFileWithNavPath(), endMemberDeclarations(), OutputList::endQuickIndices(), endTitle(), err, Files, DefinitionMixin< DirDef >::getLanguage(), getOutputFileBase(), Html, LayoutDocManager::instance(), m_dispName, DefinitionMixin< DirDef >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), qPrint(), shortTitle(), OutputList::startContents(), startFile(), startMemberDeclarations(), startTitle(), theTranslator, LayoutDocEntrySection::title(), writeBriefDescription(), writeDetailedDescription(), writeDirectoryGraph(), writeFileList(), DefinitionMixin< DirDef >::writeNavigationPath(), and writeSubDirList().

◆ writeFileList()

void DirDefImpl::writeFileList ( OutputList & ol )

private

Definition at line 394 of file dirdef.cpp.

{
  AUTO_TRACE();
  int numFiles = 0;
  for (const auto &fd : m_fileList)
  {
    bool genSourceFile=false;
    if (fileVisibleInIndex(fd,genSourceFile))
    {
      numFiles++;
    }
    else if (genSourceFile)
    {
      numFiles++;
    }
  }
 
  AUTO_TRACE_ADD("numFiles={}",numFiles);
  // write file list
  if (numFiles>0)
  {
    ol.startMemberHeader("files");
    ol.parseText(theTranslator->trFile(TRUE,FALSE));
    ol.endMemberHeader();
    ol.startMemberList();
    for (const auto &fd : m_fileList)
    {
      bool src = false;
      bool doc = fileVisibleInIndex(fd,src);
      if (doc || src)
      {
        ol.startMemberDeclaration();
        ol.startMemberItem(fd->anchor(),OutputGenerator::MemberItemType::Normal);
        {
          ol.pushGeneratorState();
          ol.disableAllBut(OutputType::Html);
          bool genSrc = fd->generateSourceFile();
          if (genSrc)
          {
            ol.startTextLink(fd->includeName(),QCString());
          }
          ol.writeString("<span class=\"icondoc\"></span>");
          if (genSrc)
          {
            ol.endTextLink();
          }
          ol.enableAll();
          ol.disable(OutputType::Html);
          ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");
          ol.popGeneratorState();
        }
        ol.insertMemberAlign();
        if (fd->isLinkable())
        {
          ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),QCString(),fd->displayName());
        }
        else
        {
          ol.startBold();
          ol.docify(fd->displayName());
          ol.endBold();
        }
        ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
        if (!fd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
        {
          ol.startMemberDescription(fd->getOutputFileBase());
          ol.generateDoc(briefFile(),briefLine(),fd,nullptr,fd->briefDescription(),
              FALSE, // indexWords
              FALSE, // isExample
              QCString(), // exampleName
              TRUE,  // single line
              TRUE,  // link from index
              Config_getBool(MARKDOWN_SUPPORT)
              );
          ol.endMemberDescription();
        }
        ol.endMemberDeclaration(fd->anchor(),QCString());
      }
    }
    ol.endMemberList();
  }
}

References AUTO_TRACE, AUTO_TRACE_ADD, DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), OutputList::endBold(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::endTextLink(), FALSE, fileVisibleInIndex(), OutputList::generateDoc(), Html, OutputList::insertMemberAlign(), m_fileList, OutputGenerator::Normal, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startBold(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), OutputList::startTextLink(), theTranslator, TRUE, OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ writeSubDirList()

void DirDefImpl::writeSubDirList ( OutputList & ol )

private

Definition at line 335 of file dirdef.cpp.

{
  AUTO_TRACE();
  int numSubdirs = 0;
  for(const auto dd : m_subdirs)
  {
    if (dd->hasDocumentation() || !dd->getFiles().empty())
    {
      numSubdirs++;
    }
  }
 
  AUTO_TRACE_ADD("numSubdirs={}",numSubdirs);
  // write subdir list
  if (numSubdirs>0)
  {
    ol.startMemberHeader("subdirs");
    ol.parseText(theTranslator->trDir(TRUE,FALSE));
    ol.endMemberHeader();
    ol.startMemberList();
    for(const auto dd : m_subdirs)
    {
      if (dd->hasDocumentation() || !dd->getFiles().empty())
      {
        ol.startMemberDeclaration();
        ol.startMemberItem(dd->anchor(),OutputGenerator::MemberItemType::Normal);
        {
          ol.pushGeneratorState();
          ol.disableAllBut(OutputType::Html);
          ol.writeString("<span class=\"iconfclosed\"></span>");
          ol.enableAll();
          ol.disable(OutputType::Html);
          ol.parseText(theTranslator->trDir(FALSE,TRUE)+" ");
          ol.popGeneratorState();
        }
        ol.insertMemberAlign();
        ol.writeObjectLink(dd->getReference(),dd->getOutputFileBase(),QCString(),dd->shortName());
        ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
        if (!dd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
        {
          ol.startMemberDescription(dd->getOutputFileBase());
          ol.generateDoc(briefFile(),briefLine(),dd,nullptr,dd->briefDescription(),
              FALSE, // indexWords
              FALSE, // isExample
              QCString(), // exampleName
              TRUE,  // single line
              TRUE,  // link from index
              Config_getBool(MARKDOWN_SUPPORT)
              );
          ol.endMemberDescription();
        }
        ol.endMemberDeclaration(dd->anchor(),QCString());
      }
    }
 
    ol.endMemberList();
  }
}

References AUTO_TRACE, AUTO_TRACE_ADD, DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), Html, OutputList::insertMemberAlign(), m_subdirs, OutputGenerator::Normal, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, TRUE, OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ writeTagFile()

void DirDefImpl::writeTagFile ( TextStream & t )

overridevirtual

Implements DirDef.

Definition at line 498 of file dirdef.cpp.

{
  tagFile << "  <compound kind=\"dir\">\n";
  tagFile << "    <name>" << convertToXML(displayName()) << "</name>\n";
  tagFile << "    <path>" << convertToXML(stripFromPath(name())) << "</path>\n";
  QCString fn=getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "    <filename>" << fn << "</filename>\n";
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Directory))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::DirSubDirs:
        {
          if (m_subdirs.size()>0)
          {
            for(const auto dd : m_subdirs)
            {
              tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::DirFiles:
        {
          for (const auto &fd : m_fileList)
          {
              tagFile << "    <file>" << convertToXML(fd->name()) << "</file>\n";
          }
        }
        break;
      default:
        break;
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>\n";
}

References addHtmlExtensionIfMissing(), convertToXML(), displayName(), getOutputFileBase(), LayoutDocManager::instance(), m_fileList, m_subdirs, DefinitionMixin< DirDef >::name(), stripFromPath(), and DefinitionMixin< DirDef >::writeDocAnchorsToTagFile().

Member Data Documentation

◆ m_dirIndex

int DirDefImpl::m_dirIndex = -1

private

Definition at line 100 of file dirdef.cpp.

Referenced by dirIndex(), and setDirIndex().

◆ m_diskName

QCString DirDefImpl::m_diskName

private

Definition at line 98 of file dirdef.cpp.

Referenced by DirDefImpl(), getOutputFileBase(), and setDiskName().

◆ m_dispName

QCString DirDefImpl::m_dispName

private

Definition at line 96 of file dirdef.cpp.

Referenced by DirDefImpl(), displayName(), and writeDocumentation().

◆ m_fileList

FileList DirDefImpl::m_fileList

private

Definition at line 99 of file dirdef.cpp.

Referenced by addFile(), computeDependencies(), getFiles(), sort(), writeFileList(), and writeTagFile().

◆ m_hasDirectoryGraph

bool DirDefImpl::m_hasDirectoryGraph = false

private

Definition at line 104 of file dirdef.cpp.

Referenced by DirDefImpl(), hasDirectoryGraph(), overrideDirectoryGraph(), and writeDirectoryGraph().

◆ m_level

int DirDefImpl::m_level

private

Definition at line 101 of file dirdef.cpp.

Referenced by DirDefImpl(), level(), and setLevel().

◆ m_parent

DirDef* DirDefImpl::m_parent

private

Definition at line 102 of file dirdef.cpp.

Referenced by depGraphIsTrivial(), DirDefImpl(), parent(), and setParent().

◆ m_shortName

QCString DirDefImpl::m_shortName

private

Definition at line 97 of file dirdef.cpp.

Referenced by DirDefImpl(), shortName(), and shortTitle().

◆ m_subdirs

DirList DirDefImpl::m_subdirs

private

Definition at line 95 of file dirdef.cpp.

Referenced by addSubDir(), hasSubdirs(), sort(), subDirs(), writeSubDirList(), and writeTagFile().

◆ m_usedDirs

UsedDirLinkedMap DirDefImpl::m_usedDirs

private

Definition at line 103 of file dirdef.cpp.

Referenced by addUsesDependency(), computeDependencies(), depGraphIsTrivial(), and usedDirs().

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

src/dirdef.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirDefImpl()

◆ ~DirDefImpl()

Member Function Documentation

◆ addFile()

◆ addSubDir()

◆ addUsesDependency()

◆ anchor()

◆ codeSymbolType()

◆ computeDependencies()

◆ createNewDir()

◆ definitionType()

◆ depGraphIsTrivial()

◆ dirIndex()

◆ displayName()

◆ endMemberDeclarations()

◆ getFiles()

◆ getOutputFileBase()

◆ hasDetailedDescription()

◆ hasDirectoryGraph()

◆ hasSubdirs()

◆ isLinkable()

◆ isLinkableInProject()

◆ isParentOf()

◆ level()

◆ matchPath()

◆ mergeDirectoryInTree()

◆ overrideDirectoryGraph()

◆ parent()

◆ setDirIndex()

◆ setDiskName()

◆ setLevel()

◆ setParent()

◆ shortName()

◆ shortTitle()

◆ sort()

◆ startMemberDeclarations()

◆ subDirs()

◆ usedDirs()

◆ writeBriefDescription()

◆ writeDetailedDescription()

◆ writeDirectoryGraph()

◆ writeDocumentation()

◆ writeFileList()

◆ writeSubDirList()

◆ writeTagFile()

Member Data Documentation

◆ m_dirIndex

◆ m_diskName

◆ m_dispName

◆ m_fileList

◆ m_hasDirectoryGraph

◆ m_level

◆ m_parent

◆ m_shortName

◆ m_subdirs

◆ m_usedDirs