74 const FileDef *dstFd,
bool srcDirect,
bool dstDirect)
override;
196 MD5Buffer(anchor.
data(),
static_cast<unsigned int>(anchor.
length()),md5_sig);
197 MD5SigToString(md5_sig,sigStr);
282 .setIndexWords(
true));
300 .setIndexWords(
true))
309 ol.
writeDoc(ast.get(),
this,
nullptr);
345 msg(
"Generating dependency graph for directory {}\n",
displayName());
363 if (dd->hasDocumentation() || !dd->getFiles().empty())
379 if (dd->hasDocumentation() || !dd->getFiles().empty())
383 if (anc.
isEmpty()) anc=dd->shortName();
else anc.
prepend(dd->shortName()+
"_");
388 ol.
writeString(
"<span class=\"iconfolder\"><div class=\"folder-icon\"></div></span>");
397 if (!dd->briefDescription().isEmpty() &&
Config_getBool(BRIEF_MEMBER_DESC))
404 dd->briefDescription(),
407 .setLinkFromIndex(
true));
424 bool genSourceFile=
false;
429 else if (genSourceFile)
451 if (anc.
isEmpty()) anc=fd->displayName();
else anc.
prepend(fd->displayName()+
"_");
456 bool genSrc = fd->generateSourceFile();
461 ol.
writeString(
"<span class=\"icondoc\"><div class=\"doc-icon\"></div></span>");
472 if (fd->isLinkable())
479 ol.
docify(fd->displayName());
483 if (!fd->briefDescription().isEmpty() &&
Config_getBool(BRIEF_MEMBER_DESC))
490 fd->briefDescription(),
493 .setLinkFromIndex(
true));
533 tagFile <<
" <compound kind=\"dir\">\n";
538 tagFile <<
" <filename>" << fn <<
"</filename>\n";
543 case LayoutDocEntry::DirSubDirs:
549 tagFile <<
" <dir>" <<
convertToXML(dd->displayName()) <<
"</dir>\n";
554 case LayoutDocEntry::DirFiles:
558 tagFile <<
" <file>" <<
convertToXML(fd->name()) <<
"</file>\n";
567 tagFile <<
" </compound>\n";
587 if (!generateTreeView)
612 case LayoutDocEntry::BriefDesc:
615 case LayoutDocEntry::DirGraph:
618 case LayoutDocEntry::MemberDeclStart:
621 case LayoutDocEntry::DirSubDirs:
624 case LayoutDocEntry::DirFiles:
627 case LayoutDocEntry::MemberDeclEnd:
630 case LayoutDocEntry::DetailedDesc:
639 case LayoutDocEntry::ClassIncludes:
640 case LayoutDocEntry::ClassInlineClasses:
641 case LayoutDocEntry::ClassInheritanceGraph:
642 case LayoutDocEntry::ClassNestedClasses:
643 case LayoutDocEntry::ClassCollaborationGraph:
644 case LayoutDocEntry::ClassAllMembersLink:
645 case LayoutDocEntry::ClassUsedFiles:
646 case LayoutDocEntry::NamespaceNestedNamespaces:
647 case LayoutDocEntry::NamespaceNestedConstantGroups:
648 case LayoutDocEntry::NamespaceClasses:
649 case LayoutDocEntry::NamespaceConcepts:
650 case LayoutDocEntry::NamespaceInterfaces:
651 case LayoutDocEntry::NamespaceStructs:
652 case LayoutDocEntry::NamespaceExceptions:
653 case LayoutDocEntry::NamespaceInlineClasses:
654 case LayoutDocEntry::ConceptDefinition:
655 case LayoutDocEntry::FileClasses:
656 case LayoutDocEntry::FileConcepts:
657 case LayoutDocEntry::FileInterfaces:
658 case LayoutDocEntry::FileStructs:
659 case LayoutDocEntry::FileExceptions:
660 case LayoutDocEntry::FileNamespaces:
661 case LayoutDocEntry::FileConstantGroups:
662 case LayoutDocEntry::FileIncludes:
663 case LayoutDocEntry::FileIncludeGraph:
664 case LayoutDocEntry::FileIncludedByGraph:
665 case LayoutDocEntry::FileSourceLink:
666 case LayoutDocEntry::FileInlineClasses:
667 case LayoutDocEntry::GroupClasses:
668 case LayoutDocEntry::GroupConcepts:
669 case LayoutDocEntry::GroupModules:
670 case LayoutDocEntry::GroupInlineClasses:
671 case LayoutDocEntry::GroupNamespaces:
672 case LayoutDocEntry::GroupDirs:
673 case LayoutDocEntry::GroupNestedGroups:
674 case LayoutDocEntry::GroupFiles:
675 case LayoutDocEntry::GroupGraph:
676 case LayoutDocEntry::GroupPageDocs:
677 case LayoutDocEntry::ModuleExports:
678 case LayoutDocEntry::ModuleClasses:
679 case LayoutDocEntry::ModuleConcepts:
680 case LayoutDocEntry::ModuleUsedFiles:
681 case LayoutDocEntry::AuthorSection:
682 case LayoutDocEntry::MemberGroups:
683 case LayoutDocEntry::MemberDecl:
684 case LayoutDocEntry::MemberDef:
685 case LayoutDocEntry::MemberDefStart:
686 case LayoutDocEntry::MemberDefEnd:
687 err(
"Internal inconsistency: member '{}' should not be part of "
688 "LayoutDocManager::Directory entry list\n",
qPrint(lde->entryToString()));
725 const FileDef *dstFd,
bool srcDirect,
bool dstDirect)
727 if (
this==dir)
return;
728 AUTO_TRACE(
"add dependency {}->{} due to {}->{}",
740 if (usedPair==
nullptr)
743 usedDir->
addFileDep(srcFd,dstFd, srcDirect, dstDirect);
754 auto newUsedDir = std::make_unique<UsedDir>(dir);
755 newUsedDir->addFileDep(srcFd,dstFd, srcDirect, dstDirect);
796 for (
const auto &ii : fd->includeFileList())
799 if (ii.fileDef && ii.fileDef->isLinkable())
801 DirDef *usedDir = ii.fileDef->getDirDef();
813 [](
const auto &u1,
const auto &u2)
814 { return qstricmp_sort(u1->dir()->getOutputFileBase(),u2->dir()->getOutputFileBase())<0; });
818 usedDirectory->sort();
856 [](
const auto &left,
const auto &right)
858 int orderHi = qstricmp_sort(left->source()->name(),right->source()->name());
859 if (orderHi!=0) return orderHi<0;
860 int orderLo = qstricmp_sort(left->destination()->name(),right->destination()->name());
878 std::unique_ptr<DirDef>(
887 for (
const auto &s : l)
906 while ((i=path.
find(
'/',p))!=-1)
939 if (target->
parent()!=root)
973 (
m_src->shortName()+
" → "+
m_dst->dir()->shortName()));
975 (
m_src->displayName()+
" -> "+
m_dst->dir()->shortName()));
980 if (!generateTreeView)
983 m_src->writeNavigationPath(ol);
999 for (
const auto &fp :
m_dst->filePairs())
1035 path=path.
left(i+1);
1045 int l =
static_cast<int>(path.
length());
1053 if (dirName.
left(l)!=path)
1055 i = l>=2 ? path.
findRev(
'/',l-2) : -1;
1063 path=path.
left(i+1);
1071 l=
static_cast<int>(path.
length());
1080 path=path.
left(i+1);
1097 dir->setDiskName(diskName);
1108 for (
const auto &fd : *fn)
1110 if (fd->getReference().isEmpty())
1117 if (dir && !fd->isDocumentationFile()) dir->
addFile(fd.get());
1137 parent->addSubDir(dir.get());
1138 AUTO_TRACE_ADD(
"DirDefImpl::addSubdir(): Adding subdir {} to {}",
1139 dir->displayName(),
parent->displayName());
1153 [](
const auto &d1,
const auto &d2)
1155 QCString s1 = d1->shortName(), s2 = d2->shortName();
1159 QCString n1 = d1->name(), n2 = d2->name();
1170 dir->setDirIndex(dirIndex++);
1189 dir->computeDependencies();
1199 if (!dir->hasDocumentation())
1203 dir->writeDocumentation(ol);
1210 dr->writeDocumentation(ol);
1224 if (d==
nullptr)
return nullptr;
1227 return static_cast<DirDef*
>(d);
1237 if (d==
nullptr)
return nullptr;
1240 return static_cast<const DirDef*
>(d);
The common base class of all entity definitions found in the sources.
virtual bool isLinkable() const =0
virtual QCString getReference() const =0
virtual QCString getOutputFileBase() const =0
virtual const QCString & name() const =0
bool isReference() const override
const QCString & name() const override
void writeNavigationPath(OutputList &ol) const override
bool hasBriefDescription() const override
QCString docFile() const override
QCString briefFile() const override
QCString briefDescription(bool abbreviate=FALSE) const override
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
void setLocalName(const QCString &name) override
int docLine() const override
int briefLine() const override
QCString documentation() const override
void writeDocAnchorsToTagFile(TextStream &fs) const override
bool hasDocumentation() const override
SrcLangExt getLanguage() const override
virtual void setOuterScope(Definition *d)=0
A model of a directory symbol.
virtual int level() const =0
virtual void setLevel()=0
virtual void addFile(FileDef *fd)=0
virtual DirDef * parent() const =0
virtual void addUsesDependency(const DirDef *usedDir, const FileDef *srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)=0
virtual void setParent(DirDef *parent)=0
virtual const QCString shortName() const =0
void writeDocumentation(OutputList &ol) override
void writeSubDirList(OutputList &ol)
static DirDef * createNewDir(const QCString &path)
static bool matchPath(const QCString &path, const StringVector &l)
bool hasSubdirs() const override
void writeTagFile(TextStream &t) override
const FileList & getFiles() const override
const QCString shortName() const override
bool isLinkable() const override
const UsedDirLinkedMap & usedDirs() const override
void addSubDir(DirDef *subdir) override
bool hasDetailedDescription() const override
DirDef * parent() const override
void startMemberDeclarations(OutputList &ol)
int level() const override
bool isLinkableInProject() const override
void writePageNavigation(OutputList &ol) const override
void writeDetailedDescription(OutputList &ol, const QCString &title)
DefType definitionType() const override
bool isParentOf(const DirDef *dir) const override
QCString getOutputFileBase() const override
int dirIndex() const override
QCString anchor() const override
CodeSymbolType codeSymbolType() const override
void addFile(FileDef *fd) override
bool depGraphIsTrivial() const override
void findSectionsInDocumentation() override
void overrideDirectoryGraph(bool e) 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 writeDirectoryGraph(OutputList &ol)
const DirList & subDirs() const override
UsedDirLinkedMap m_usedDirs
void setDiskName(const QCString &name) override
static DirDef * mergeDirectoryInTree(const QCString &path)
void writeFileList(OutputList &ol)
QCString shortTitle() const override
DirDefImpl(const QCString &path)
void setDirIndex(int index) override
void endMemberDeclarations(OutputList &ol)
void writeBriefDescription(OutputList &ol)
void computeDependencies() override
Computes the dependencies between directories.
QCString displayName(bool=TRUE) const override
void setParent(DirDef *parent) override
bool hasDirectoryGraph() const override
void writeDocumentation(OutputList &ol)
QCString getOutputFileBase() const
Representation of an directory dependency graph.
static FileNameLinkedMap * inputNameLinkedMap
static DirLinkedMap * dirLinkedMap
static DirRelationLinkedMap dirRelations
A model of a file symbol.
virtual void setDirDef(DirDef *dd)=0
virtual DirDef * getDirDef() const =0
Class representing a pair of FileDef objects.
static QCString key(const FileDef *srcFd, const FileDef *dstFd)
static LayoutDocManager & instance()
Returns a reference to this singleton.
Class representing a list of output generators that are written to in parallel.
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md, int sectionLevel=-1)
void writeString(const QCString &text)
void startMemberDeclaration()
void disable(OutputType o)
void endDirDepGraph(DotDirDeps &g)
void startGroupHeader(const QCString &id=QCString(), int extraLevels=0)
void enable(OutputType o)
void endMemberDescription()
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
void startMemberDescription(const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
void docify(const QCString &s)
void generateDoc(const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, const DocOptions &options)
void startParagraph(const QCString &classDef=QCString())
void startMemberSections()
void endMemberItem(OutputGenerator::MemberItemType type)
void pushGeneratorState()
void insertMemberAlign(bool templ=FALSE)
void disableAllBut(OutputType o)
void writeAnchor(const QCString &fileName, const QCString &name)
void endGroupHeader(int extraLevels=0)
void endMemberDeclaration(const QCString &anchor, const QCString &inheritId)
void startMemberItem(const QCString &anchor, OutputGenerator::MemberItemType type, const QCString &id=QCString())
void parseText(const QCString &textStr)
void startTextLink(const QCString &file, const QCString &anchor)
void startMemberHeader(const QCString &anchor, int typ=2)
This is an alternative implementation of QCString.
int find(char c, int index=0, bool cs=TRUE) const
QCString & prepend(const char *s)
size_t length() const
Returns the length of the string, not counting the 0-terminator.
bool isEmpty() const
Returns TRUE iff the string is empty.
QCString right(size_t len) const
int findRev(char c, int index=-1, bool cs=TRUE) const
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
QCString left(size_t len) const
Text streaming class that buffers data.
Usage information of a directory.
FilePairLinkedMap m_filePairs
void addFileDep(const FileDef *srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)
Take up dependency between files.
const DirDef * dir() const
UsedDir(const DirDef *dir)
FilePair * findFilePair(const QCString &name)
#define Config_getList(name)
#define Config_getBool(name)
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
std::vector< std::string > StringVector
DirIterator begin(DirIterator it) noexcept
DirIterator end(const DirIterator &) noexcept
DirDef * createDirDef(const QCString &path)
static void writePartialFilePath(OutputList &ol, const DirDef *root, const FileDef *fd)
bool compareDirDefs(const DirDef *item1, const DirDef *item2)
static void writePartialDirPath(OutputList &ol, const DirDef *root, const DirDef *target)
static QCString encodeDirName(const QCString &anchor)
void computeDirDependencies()
DirDef * toDirDef(Definition *d)
static void computeCommonDirPrefix()
In order to create stable, but unique directory names, we compute the common part of the path shared ...
void generateDirDocs(OutputList &ol)
#define AUTO_TRACE_ADD(...)
#define AUTO_TRACE_EXIT(...)
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
void docFindSections(const QCString &input, const Definition *d, const QCString &fileName)
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, const DocOptions &options)
IDocParserPtr createDocParser()
factory function to create a parser
static void writeTagFile()
bool compareFileDefs(const FileDef *fd1, const FileDef *fd2)
void startTitle(OutputList &ol, const QCString &fileName, const DefinitionMutable *def)
void endTitle(OutputList &ol, const QCString &fileName, const QCString &name)
void startFile(OutputList &ol, const QCString &name, bool isSource, const QCString &manName, const QCString &title, HighlightedItem hli, bool additionalIndices, const QCString &altSidebarName, int hierarchyLevel, const QCString &allMembersFile)
void endFileWithNavPath(OutputList &ol, const DefinitionMutable *d, bool showPageNavigation)
Translator * theTranslator
int qstricmp_sort(const char *str1, const char *str2)
const char * qPrint(const char *s)
QCString title(SrcLangExt lang) const
bool fileVisibleInIndex(const FileDef *fd, bool &genSourceFile)
static QCString stripFromPath(const QCString &p, const StringVector &l)
QCString convertToXML(const QCString &s, bool keepEntities)
QCString removeLongPathMarker(QCString path)
void addHtmlExtensionIfMissing(QCString &fName)
A bunch of utility functions.