|
Doxygen
|
A bunch of utility functions. More...
#include <src/util.h>
Go to the source code of this file.
Classes | |
| struct | ReadInputFileOptions |
| struct | GetDefInput |
| struct | GetDefResult |
| struct | SelectionBlock |
| struct | SelectionMarkerInfo |
| struct | KeywordSubstitution |
Typedefs | |
| using | SelectionBlockList = std::vector<SelectionBlock> |
| using | KeywordSubstitutionList = std::vector<KeywordSubstitution> |
Functions | |
| DString | getLanguageSpecificSeparator (SrcLangExt lang, bool classScope=false) |
| DString | fileToString (const DString &name, bool filter=false, bool isSourceCode=false) |
| bool | readInputFile (const DString &fileName, std::string &contents, const ReadInputFileOptions &options=ReadInputFileOptions()) |
| read a file name fileName and optionally filter and transcode it | |
| DString | writeInlineGraph (const DString &baseName, const DString &extension, const DString &content, bool &exists) |
| void | cleanupInlineGraphs () |
| GetDefResult | getDefs (const GetDefInput &input) |
| DString | getFileFilter (const DString &name, bool isSourceCode) |
| bool | resolveRef (const DString &scName, const DString &name, bool inSeeBlock, const Definition **resContext, const MemberDef **resMember, SrcLangExt lang, bool lookForSpecializations=true, const FileDef *currentFile=nullptr, bool checkScope=false) |
| bool | resolveLink (const DString &scName, const DString &lr, bool inSeeBlock, const Definition **resContext, DString &resAnchor, SrcLangExt lang, const DString &prefix=DString(), const FileDef *currentFile=nullptr) |
| DString | resolveTypeDef (const Definition *d, const DString &name, const Definition **typedefContext=nullptr) |
| DString | externalRef (const DString &relPath, const DString &ref) |
| bool | matchArguments2 (const Definition *srcScope, const FileDef *srcFileScope, const DString &srcReturnType, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const DString &dstReturnType, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang) |
| void | mergeArguments (ArgumentList &srcAl, ArgumentList &dstAl, bool forceNameOverwrite=false) |
| bool | matchTemplateArguments (const ArgumentList &srcAl, const ArgumentList &dstAl) |
| DString | normalizeNonTemplateArgumentsInString (const DString &name, const Definition *context, const ArgumentList &formalArgs) |
| DString | substituteTemplateArgumentsInString (const DString &name, const ArgumentList &formalArgs, const ArgumentList *actualArgs) |
| DString | inlineArgListToDoc (const ArgumentList &al) |
| DString | inlineTemplateArgListToDoc (const ArgumentList &al) |
| DString | argListToString (const ArgumentList &al, bool useCanonicalType=false, bool showDefVals=true) |
| DString | tempArgListToString (const ArgumentList &al, SrcLangExt lang, bool includeDefaults=true) |
| DString | selectBlocks (const DString &s, const SelectionBlockList &blockList, const SelectionMarkerInfo &markerInfo) |
| remove disabled blocks and all block markers from s and return the result as a string | |
| void | checkBlocks (const DString &s, const DString fileName, const SelectionMarkerInfo &markerInfo) |
| DString | findExampleFilePath (const DString &file, bool &ambig) |
| void | writeExamples (OutputList &ol, const ExampleList &el) |
| DString | stripScope (const DString &name) |
| DString | stripAnonymousNamespaceScope (const DString &s) |
| DString | stripFromPath (const DString &path) |
| DString | stripFromIncludePath (const DString &path) |
| DString | stripPath (const DString &s) |
| DString | stripIndentation (const DString &s, bool skipFirstLine=false) |
| DString | stripExtensionGeneral (const DString &fName, const DString &ext) |
| DString | stripExtension (const DString &fName) |
| DString | stripLeadingAndTrailingEmptyLines (const DString &s, int &docLine) |
| Special version of DString::stripWhiteSpace() that only strips completely blank lines. | |
| void | stripIndentationVerbatim (DString &doc, size_t indentationLevel, bool skipFirstLine=true) |
| DString | removeRedundantWhiteSpace (const DString &s) |
| DString | detab (const DString &s, size_t &refIndent) |
| bool | rightScopeMatch (const DString &scope, const DString &name) |
| bool | leftScopeMatch (const DString &scope, const DString &name) |
| DString | substituteKeywords (const DString &file, const DString &s, const KeywordSubstitutionList &keywords) |
| void | addDirPrefix (DString &fileName) |
| int | getPrefixIndex (const DString &name) |
| int | computeQualifiedIndex (const DString &name) |
| Return the index of the last :: in the string name that is still before the first <. | |
| DString | convertNameToFile (const DString &name, bool allowDots=false, bool allowUnderscore=false) |
| DString | escapeCharsInString (const DString &name, bool allowDots, bool allowUnderscore=false) |
| DString | unescapeCharsInString (const DString &s) |
| DString | linkToText (SrcLangExt lang, const DString &link, bool ignoreDots) |
| DString | removeAnonymousScopes (const DString &s) |
| DString | replaceAnonymousScopes (const DString &s, const DString &replacement=DString()) |
| DString | insertTemplateSpecifierInScope (const DString &scope, const DString &templ) |
| DString | stripTemplateSpecifiersFromScope (const DString &fullName, bool parentOnly=true, DString *lastScopeStripped=nullptr, DString scopeName=DString(), bool allowArtificial=true) |
| DString | mergeScopes (const DString &leftScope, const DString &rightScope) |
| int | getScopeFragment (const DString &s, int p, int *l) |
| DString | convertToId (const DString &s) |
| DString | convertToHtml (const DString &s, bool keepEntities=true) |
| DString | convertToXML (const DString &s, bool keepEntities=false, bool citeEntry=false) |
| DString | convertToJSString (const DString &s, bool keepEntities=false, bool singleQuotes=false) |
| bool | updateLanguageMapping (const DString &extension, const DString &parser) |
| SrcLangExt | getLanguageFromFileName (const DString &fileName, SrcLangExt defLang=SrcLangExt::Cpp) |
| SrcLangExt | getLanguageFromCodeLang (DString &fileName) |
| Routine to handle the language attribute of the \code command. | |
| DString | getFileNameExtension (const DString &fn) |
| void | initDefaultExtensionMapping () |
| void | addCodeOnlyMappings () |
| void | writeMarkerList (OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc) |
| DString | writeMarkerList (const std::string &markerText, size_t numMarkers, std::function< DString(size_t)> replaceFunc) |
| DString | replaceColorMarkers (const DString &str) |
| Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC, where #AABBCC represents a valid color, based on the intensity represented by hex number AA and the current HTML_COLORSTYLE_* settings. | |
| void | createSubDirs (const Dir &d) |
| void | clearSubDirs (const Dir &d) |
| DString | relativePathToRoot (const DString &name) |
| bool | copyFile (const DString &src, const DString &dest) |
| Copies the contents of file with name src to the newly created file with name dest. | |
| bool | openOutputFile (const DString &outFile, std::ofstream &f) |
| bool | isURL (const DString &url) |
| Checks whether the given url starts with a supported protocol. | |
| DString | correctURL (const DString &url, const DString &relPath) |
| Corrects URL url according to the relative path relPath. | |
| DString | createHtmlUrl (const DString &relPath, const DString &ref, bool islocalFile, const DString &targetFileName, const DString &anchor) |
| DString | mangleCSharpGenericName (const DString &name) |
| DString | demangleCSharpGenericName (const DString &name, const DString &templArgs) |
| DString | extractBeginRawStringDelimiter (const char *rawStart) |
| DString | extractEndRawStringDelimiter (const char *rawEnd) |
| void | extractNamespaceName (const DString &scopeName, DString &className, DString &namespaceName, bool allowEmptyClass=false) |
| int | extractClassNameFromType (const DString &type, int &pos, DString &name, DString &templSpec, SrcLangExt=SrcLangExt::Unknown) |
| bool | useCaseSenseNames () |
| Returns true if the names of the symbols can be case sensitive. | |
| bool | checkExtension (const DString &fName, const DString &ext) |
| void | addHtmlExtensionIfMissing (DString &fName) |
| bool | checkIfTypedef (const Definition *scope, const FileDef *fileScope, const DString &n) |
| void | addGroupListToTitle (OutputList &ol, const Definition *d) |
| void | writeTypeConstraints (OutputList &ol, const Definition *d, const ArgumentList &al) |
| void | stackTrace () |
| bool | protectionLevelVisible (Protection prot) |
| void | convertProtectionLevel (MemberListType inListType, Protection inProt, MemberListType *outListType1, MemberListType *outListType2) |
| Computes for a given list type inListType, which are the the corresponding list type(s) in the base class that are to be added to this list. | |
| DString | makeBaseName (const DString &name, const DString &ext) |
| DString | determineAbsoluteIncludeName (const DString &curFile, const DString &incFileName) |
| DString | filterTitle (const DString &title) |
| DString | getDotImageExtension () |
| DString | getDotImageExtension (const DString &format) |
| DString | getDotImageExtensionGenerated (const DString &format) |
| DString | externalLinkTarget (const bool parent=false) |
| DString | getEncoding (const FileInfo &fi) |
| bool | mainPageHasTitle () |
| DString | getProjectId () |
| DString | projectLogoFile () |
| DString | projectLogoSize () |
| DString | showDate (const DString &fmt) |
A bunch of utility functions.
Definition in file util.h.
| using KeywordSubstitutionList = std::vector<KeywordSubstitution> |
| using SelectionBlockList = std::vector<SelectionBlock> |
| void addCodeOnlyMappings | ( | ) |
Definition at line 4171 of file util.cpp.
References updateLanguageMapping().
Referenced by generateOutput().
| void addGroupListToTitle | ( | OutputList & | ol, |
| const Definition * | d ) |
Definition at line 3930 of file util.cpp.
References recursivelyAddGroupListToTitle().
Referenced by ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), and NamespaceDefImpl::writeDocumentation().
| void addHtmlExtensionIfMissing | ( | DString & | fName | ) |
Definition at line 3940 of file util.cpp.
References DString::empty(), DString::find(), Doxygen::htmlFileExtension, DString::npos, and DString::rfind().
Referenced by HtmlCodeGenerator::_writeCodeLink(), Crawlmap::addContentsItem(), DocSets::addContentsItem(), EclipseHelp::addContentsItem(), HtmlHelp::addContentsItem(), Qhp::addContentsItem(), Crawlmap::addIndexFile(), Sitemap::addIndexFile(), common_attributes(), convertMapFile(), dumpSymbol(), field2URL(), FTVHelp::Private::generateTree(), Crawlmap::initialize(), makeFileName(), makeFileName(), makeURL(), DefinitionImpl::navigationPathAsString(), node2URL(), HtmlDocVisitor::operator()(), replaceRef(), SearchIndexExternal::setCurrentDoc(), HtmlGenerator::startFile(), HtmlGenerator::startIndexItem(), HtmlDocVisitor::startLink(), HtmlGenerator::startTextLink(), LayoutNavEntry::url(), DefinitionImpl::writeDocAnchorsToTagFile(), HtmlGenerator::writeInheritedSectionTitle(), writeJavasScriptSearchDataPage(), writeMapArea(), HtmlGenerator::writeObjectLink(), ClassDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), NamespaceDefImpl::writeQuickMemberLinks(), HtmlGenerator::writeSplitBarAsString(), HtmlGenerator::writeStartAnnoItem(), HtmlGenerator::writeSummaryLink(), ClassDefImpl::writeTagFile(), ConceptDefImpl::writeTagFile(), DirDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), MemberDefImpl::writeTagFile(), ModuleDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), PageDefImpl::writeTagFile(), RequirementManager::writeTagFile(), VhdlDocGen::writeTagFile(), DocSets::writeToken(), HtmlCodeGenerator::writeTooltip(), and DotNode::writeUrl().
| DString argListToString | ( | const ArgumentList & | al, |
| bool | useCanonicalType = false, | ||
| bool | showDefVals = true ) |
Returns a string representation of the parameter list al. If useCanonicalType is true then the canonical type is used for each argument. If showDefVals is true then default values are included in the string representation.
Definition at line 864 of file util.cpp.
References Argument::array, Argument::attrib, ArgumentList::begin(), Argument::canType, ArgumentList::constSpecifier(), Argument::defval, DString::empty(), ArgumentList::end(), DString::find(), ArgumentList::hasParameters(), DString::left(), LValue, DString::mid(), Argument::name, DString::npos, ArgumentList::pureSpecifier(), ArgumentList::refQualifier(), removeRedundantWhiteSpace(), RValue, ArgumentList::trailingReturnType(), Argument::type, and ArgumentList::volatileSpecifier().
Referenced by addMemberFunction(), DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), findFriends(), findGlobalMember(), findMember(), SymbolResolver::Private::getResolvedSymbol(), matchArguments2(), matchTemplateArguments(), mergeArguments(), substituteTemplateArgumentsInString(), and ClassDefImpl::title().
| void checkBlocks | ( | const DString & | s, |
| const DString | fileName, | ||
| const SelectionMarkerInfo & | markerInfo ) |
Definition at line 5142 of file util.cpp.
References SelectionMarkerInfo::beginLen, SelectionMarkerInfo::beginStr, SelectionMarkerInfo::closeLen, SelectionMarkerInfo::closeStr, DString::data(), dstrncmp(), DString::empty(), SelectionMarkerInfo::endLen, SelectionMarkerInfo::endStr, SelectionMarkerInfo::markerChar, and warn.
Referenced by HtmlGenerator::init(), and LatexGenerator::init().
Definition at line 3935 of file util.cpp.
References DString::length(), and DString::right().
Referenced by copyLatexStyleSheet(), and extraLatexStyleSheet().
| bool checkIfTypedef | ( | const Definition * | scope, |
| const FileDef * | fileScope, | ||
| const DString & | n ) |
Returns true iff the given name string appears to be a typedef in scope.
Definition at line 4280 of file util.cpp.
References getMemberFromSymbol(), and MemberDef::isTypedef().
Referenced by isVarWithConstructor().
| void cleanupInlineGraphs | ( | ) |
Deletes all graph files written with writeInlineGraph()
Definition at line 5435 of file util.cpp.
References Config_getBool, qPrint(), Dir::remove(), and writeFileContents_set.
Referenced by generateOutput().
| void clearSubDirs | ( | const Dir & | d | ) |
Definition at line 3005 of file util.cpp.
References Config_getBool, Config_getInt, Dir::empty(), Dir::exists(), Dir::rmdir(), DString::sprintf(), and DString::str().
Referenced by DocbookGenerator::cleanup(), HtmlGenerator::cleanup(), LatexGenerator::cleanup(), ManGenerator::cleanup(), RTFGenerator::cleanup(), and generateXML().
| int computeQualifiedIndex | ( | const DString & | name | ) |
Return the index of the last :: in the string name that is still before the first <.
Definition at line 5312 of file util.cpp.
Referenced by addToMap(), addVariable(), buildFunctionList(), buildTypedefList(), getMemberFromSymbol(), SymbolResolver::Private::getResolvedSymbolRec(), and SymbolResolver::Private::getResolvedTypeRec().
This function determines the file name on disk of an item given its name, which could be a class name with template arguments, so special characters need to be escaped.
Definition at line 2872 of file util.cpp.
References Config_getBool, Config_getInt, escapeCharsInString(), g_usedNames, g_usedNamesCount, g_usedNamesMutex, DString::left(), DString::length(), md5hash(), md5str(), DString::prepend(), DString::sprintf(), and DString::view().
Referenced by addRelatedPage(), buildExampleList(), ClassDefImpl::ClassDefImpl(), ClassDefImpl::deepCopy(), DocAnchor::DocAnchor(), DocCite::DocCite(), ModuleDefImpl::getOutputFileBase(), DocParser::handleAHref(), PageDefImpl::PageDefImpl(), CCodeParser::parseCode(), FortranCodeParser::parseCode(), VHDLCodeParser::parseCode(), RefList::RefList(), FileDefImpl::setDiskNameLocal(), NamespaceDefImpl::setFileNameLocal(), and xmlRequirementId().
| void convertProtectionLevel | ( | MemberListType | inListType, |
| Protection | inProt, | ||
| MemberListType * | outListType1, | ||
| MemberListType * | outListType2 ) |
Computes for a given list type inListType, which are the the corresponding list type(s) in the base class that are to be added to this list.
So for public inheritance, the mapping is 1-1, so outListType1=inListType Private members are to be hidden completely.
For protected inheritance, both protected and public members of the base class should be joined in the protected member section.
For private inheritance, both protected and public members of the base class should be joined in the private member section.
Definition at line 4917 of file util.cpp.
References Config_getBool, MemberListType::Invalid(), MemberListType::isPrivate(), MemberListType::isProtected(), MemberListType::isPublic(), MemberListType::toProtected(), and MemberListType::toPublic().
Referenced by ClassDefImpl::countInheritedDecMembers(), and ClassDefImpl::writeInheritedMemberDeclarations().
Converts a string to a HTML-encoded string
Definition at line 3300 of file util.cpp.
References DString::data(), DString::empty(), hex, isId(), DString::length(), and DString::reserve().
Referenced by HtmlCodeGenerator::_writeCodeLink(), HtmlHelp::addContentsItem(), addMembersToIndex(), convertToHtmlAndTruncate(), FTVHelp::Private::generateLink(), RequirementManager::generatePage(), DefinitionImpl::navigationPathAsString(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlGenerator::startFile(), HtmlDocVisitor::startLink(), substituteHtmlKeywords(), writeClassTree(), writeClassTreeForList(), writeClassTreeToOutput(), HtmlHelpIndex::writeFields(), HtmlGenerator::writeInheritedSectionTitle(), HtmlGenerator::writeLogoAsString(), writeMapArea(), HtmlGenerator::writePageFooter(), ClassDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), NamespaceDefImpl::writeQuickMemberLinks(), and HtmlGenerator::writeSearchPage().
Converts a string to a HTML id string
Definition at line 3211 of file util.cpp.
References DString::data(), DString::empty(), hex, DString::length(), and DString::reserve().
Referenced by HtmlGenerator::endClassDiagram(), HtmlGenerator::endMemberTemplateParams(), HtmlGenerator::startGroupHeader(), HtmlGenerator::startMemberItem(), writeMemberList(), writeQuickMemberIndex(), ClassDefImpl::writeSummaryLinks(), and VhdlDocGen::writeVHDLDeclarations().
| DString convertToJSString | ( | const DString & | s, |
| bool | keepEntities = false, | ||
| bool | singleQuotes = false ) |
Definition at line 3360 of file util.cpp.
References HtmlEntityMapper::convertCharEntitiesToUTF8(), DString::data(), DString::empty(), HtmlEntityMapper::instance(), DString::length(), and DString::reserve().
Referenced by generateJSLink(), generateJSNavTree(), writeJavascriptSearchData(), and writeJavasScriptSearchDataPage().
Converts a string to an XML-encoded string
Definition at line 3241 of file util.cpp.
References DString::data(), DString::empty(), HtmlEntityMapper::instance(), isId(), DString::length(), DString::reserve(), HtmlEntityMapper::writeHtmlEntity(), and HtmlEntityMapper::xml().
Referenced by DocSets::addContentsItem(), EclipseHelp::addContentsItem(), Qhp::addFile(), Sitemap::addIndexFile(), Qhp::addIndexItem(), XmlDocVisitor::filter(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForMember(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), generateXMLForRequirement(), generateXMLForRequirements(), generateXMLSection(), DotDirDeps::getImgAltText(), EclipseHelp::initialize(), Qhp::initialize(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), HtmlAttribList::toString(), QhpSectionTree::traverse(), visitPreStart(), SearchIndexExternal::write(), FileDefImpl::writeClassesToTagFile(), NamespaceDefImpl::writeClassesToTagFile(), NamespaceDefImpl::writeConceptsToTagFile(), DefinitionImpl::writeDocAnchorsToTagFile(), DotNode::writeDocbook(), DotGraph::writeGraphHeader(), writeInnerClasses(), writeInnerConcepts(), writeInnerDirs(), writeInnerFiles(), writeInnerGroups(), writeInnerModules(), writeInnerNamespaces(), writeInnerPages(), writeJavascriptSearchData(), writeJavasScriptSearchDataPage(), DotNode::writeLabel(), writeListOfAllMembers(), writeMapArea(), writeMemberReference(), writeRequirementRefs(), ClassDefImpl::writeTagFile(), ConceptDefImpl::writeTagFile(), DirDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), MemberDefImpl::writeTagFile(), ModuleDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), PageDefImpl::writeTagFile(), RequirementManager::writeTagFile(), VhdlDocGen::writeTagFile(), writeTemplateArgumentList(), DocSets::writeToken(), DotNode::writeXML(), writeXMLLink(), and writeXMLString().
Copies the contents of file with name src to the newly created file with name dest.
Copies the file src to dest. Returns true if the copy was successful, false otherwise. When a relative path is used, is is based on the current working directory.
Returns true if successful.
Definition at line 4632 of file util.cpp.
References err, and DString::str().
Referenced by copyExtraFiles(), copyIcon(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), CitationManager::generatePage(), RTFGenerator::init(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), and substituteLatexKeywords().
Corrects URL url according to the relative path relPath.
Returns the corrected URL. For absolute URLs no correction will be done.
Definition at line 4672 of file util.cpp.
References DString::empty(), isURL(), and DString::prepend().
Referenced by HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), XmlDocVisitor::operator()(), and startQuickIndexItem().
| DString createHtmlUrl | ( | const DString & | relPath, |
| const DString & | ref, | ||
| bool | islocalFile, | ||
| const DString & | targetFileName, | ||
| const DString & | anchor ) |
Definition at line 4515 of file util.cpp.
References DString::empty(), DString::endsWith(), and externalRef().
Referenced by HtmlCodeGenerator::_writeCodeLink(), RequirementManager::generatePage(), HtmlDocVisitor::startLink(), HtmlGenerator::startTextLink(), HtmlGenerator::writeObjectLink(), and HtmlCodeGenerator::writeTooltip().
| void createSubDirs | ( | const Dir & | d | ) |
Definition at line 2978 of file util.cpp.
References Config_getBool, Config_getInt, Dir::exists(), Dir::mkdir(), DString::sprintf(), DString::str(), and term.
Referenced by generateXML(), DocbookGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), ManGenerator::init(), RTFGenerator::init(), ClassDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), and NamespaceDefImpl::writeQuickMemberLinks().
Definition at line 5380 of file util.cpp.
References DString::endsWith(), DString::find(), and DString::left().
Referenced by ClassDefImpl::className().
Definition at line 5207 of file util.cpp.
References Config_getInt, DString::data(), getUTF8CharNumBytes(), isUTF8NonBreakableSpace(), DString::length(), literal_at(), and DString::reserve().
Referenced by FileDefImpl::parseSource(), Markdown::process(), DocParser::readTextFileByName(), readTextFileByName(), MemberDefImpl::setInitializer(), DefinitionImpl::writeInlineCode(), and FileDefImpl::writeSourceBody().
Definition at line 2938 of file util.cpp.
References FileInfo::absFilePath(), Config_getBool, Config_getList, FileInfo::dirPath(), FileInfo::exists(), FileInfo::isDir(), and DString::str().
Referenced by readIncludeFile(), and ModuleManager::resolveImports().
Definition at line 2697 of file util.cpp.
References Config_getBool, getUTF8CharNumBytes(), hex, DString::reserve(), and useCaseSenseNames().
Referenced by convertNameToFile(), DotClassGraph::getMapLabel(), DotDirDeps::getMapLabel(), DotGfxHierarchyTable::getMapLabel(), DotGroupCollaboration::getMapLabel(), DotInclDepGraph::getMapLabel(), markdownFileNameToId(), and PageDefImpl::writeDocumentation().
| DString externalLinkTarget | ( | const bool | parent = false | ) |
Definition at line 4504 of file util.cpp.
References Config_getBool, and parent().
Referenced by HtmlCodeGenerator::_writeCodeLink(), FTVHelp::Private::generateLink(), Markdown::Private::processLink(), replaceRef(), HtmlGenerator::startIndexItem(), HtmlDocVisitor::startLink(), HtmlGenerator::writeInheritedSectionTitle(), writeMapArea(), and HtmlGenerator::writeObjectLink().
Resolve a reference via a tagfile reference ref. If after resolving the reference the result points to a relative path then relPath is prepended to create the correct link.
Definition at line 4551 of file util.cpp.
References DString::at(), DString::empty(), end(), DString::length(), DString::prepend(), DString::str(), and Doxygen::tagDestinationMap.
Referenced by HtmlHelp::addContentsItem(), convertMapFile(), createHtmlUrl(), generateJSLink(), FTVHelp::Private::generateLink(), replaceRef(), HtmlGenerator::startIndexItem(), LayoutNavEntry::url(), HtmlGenerator::writeInheritedSectionTitle(), writeJavasScriptSearchDataPage(), and writeMapArea().
| DString extractBeginRawStringDelimiter | ( | const char * | rawStart | ) |
Definition at line 5391 of file util.cpp.
References ASSERT, DString::find(), DString::length(), DString::mid(), and DString::npos.
| int extractClassNameFromType | ( | const DString & | type, |
| int & | pos, | ||
| DString & | name, | ||
| DString & | templSpec, | ||
| SrcLangExt | lang ) |
Extracts a (sub-)string from type starting at pos that could form a class. The index of the match is returned and the found class name and a template argument list templSpec. If -1 is returned there are no more matches.
Definition at line 3389 of file util.cpp.
References AUTO_TRACE, AUTO_TRACE_EXIT, DString::clear(), DString::empty(), end(), DString::length(), DString::lower(), DString::mid(), DString::startsWith(), and DString::str().
Referenced by extractCanonicalType(), findUsedClassesForClass(), stripClassName(), and stripClassName().
| DString extractEndRawStringDelimiter | ( | const char * | rawEnd | ) |
Definition at line 5399 of file util.cpp.
References DString::length(), and DString::mid().
| void extractNamespaceName | ( | const DString & | scopeName, |
| DString & | className, | ||
| DString & | namespaceName, | ||
| bool | allowEmptyClass ) |
Input is a scopeName, output is the scopename split into a namespace part (as large as possible) and a classname part.
Definition at line 3035 of file util.cpp.
References DString::clear(), DString::empty(), DString::endsWith(), getClass(), getResolvedNamespace(), DString::left(), DString::length(), DString::mid(), Definition::name(), DString::npos, and DString::rfind().
Referenced by addClassToContext(), addConceptToContext(), findMember(), and writeAlphabeticalClassList().
reads a file with name name and returns it as a string. If filter is true the file will be filtered by any user specified input filter. If name is "-" the string will be read from standard input.
Definition at line 1058 of file util.cpp.
References addTerminalCharIfMissing(), err, FileInfo::exists(), FileInfo::isFile(), and readInputFile().
Referenced by createDVIFile(), extractBoundingBox(), getConvertLatexMacro(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::parse(), parseInput(), FileDefImpl::parseSource(), parseTagFile(), DocParser::readTextFileByName(), readTextFileByName(), runMermaid(), runPlantumlContent(), FileDefImpl::writeSourceBody(), HtmlGenerator::writeStyleInfo(), and writeXMLCodeBlock().
Definition at line 4467 of file util.cpp.
References end(), and DString::str().
Referenced by addToIndices(), createJavaScriptSearchIndex(), PerlModGenerator::generatePerlModForPage(), generateSqlite3ForPage(), generateXMLForPage(), generateXMLForRequirement(), generateXMLForRequirements(), parseCommentAsHtml(), SearchIndexExternal::setCurrentDoc(), HtmlGenerator::startFile(), and writeJavasScriptSearchDataPage().
Definition at line 2460 of file util.cpp.
References FileDef::absFilePath(), FileInfo::absFilePath(), Config_getList, Doxygen::exampleNameLinkedMap, FileInfo::exists(), FileNameLinkedMap::findFileDef(), Portable::pathSeparator(), and DString::str().
Referenced by readIncludeFile(), and DocParser::readTextFileByName().
| GetDefResult getDefs | ( | const GetDefInput & | input | ) |
Definition at line 1874 of file util.cpp.
References GetDefInput::args, AUTO_TRACE, GetDefResult::cd, GetDefInput::checkCV, GetDefResult::cnd, GetDefInput::currentFile, Definition::definitionType(), DString::empty(), GetDefResult::fd, GetDefInput::forceEmptyScope, GetDefResult::found, GetDefResult::gd, MemberDef::getClassDef(), MemberDef::getFileDef(), MemberDef::getGroupDef(), MemberDef::getNamespaceDef(), Doxygen::globalScope, GetDefInput::insideCode, GetDefResult::md, GetDefInput::memberName, GetDefResult::modd, GetDefResult::nd, SymbolResolver::resolveSymbol(), GetDefInput::scopeName, SymbolResolver::setFileScope(), toClassDef(), toConceptDef(), toMemberDef(), toModuleDef(), toNamespaceDef(), Definition::TypeClass, Definition::TypeConcept, Definition::TypeMember, Definition::TypeModule, and Definition::TypeNamespace.
Referenced by DocParser::findDocsForMemberOrCompound(), getLinkInScope(), getLinkInScope(), linkifyText(), and resolveRef().
| DString getDotImageExtension | ( | ) |
Returns the file extension to use for dot files as specified via the DOT_IMAGE_FORMAT configuration option.
Definition at line 4977 of file util.cpp.
References Config_getEnumAsString, and getDotImageExtension().
Referenced by MermaidManager::convertToImageFormat(), RTFGenerator::endCallGraph(), RTFGenerator::endDirDepGraph(), RTFGenerator::endDotGraph(), RTFGenerator::endInclDepGraph(), DotGraph::generateCode(), getDotImageExtension(), DotGraph::imgName(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), DotRunner::run(), DocbookDocVisitor::startDotFile(), TranslatorAfrikaans::trLegendDocs(), TranslatorArabic::trLegendDocs(), TranslatorArmenian::trLegendDocs(), TranslatorBrazilian::trLegendDocs(), TranslatorBulgarian::trLegendDocs(), TranslatorCatalan::trLegendDocs(), TranslatorChinese::trLegendDocs(), TranslatorChinesetraditional::trLegendDocs(), TranslatorCroatian::trLegendDocs(), TranslatorCzech::trLegendDocs(), TranslatorDanish::trLegendDocs(), TranslatorDutch::trLegendDocs(), TranslatorEnglish::trLegendDocs(), TranslatorEsperanto::trLegendDocs(), TranslatorFinnish::trLegendDocs(), TranslatorFrench::trLegendDocs(), TranslatorGerman::trLegendDocs(), TranslatorGreek::trLegendDocs(), TranslatorHindi::trLegendDocs(), TranslatorHungarian::trLegendDocs(), TranslatorIndonesian::trLegendDocs(), TranslatorItalian::trLegendDocs(), TranslatorJapanese::trLegendDocs(), TranslatorKorean::trLegendDocs(), TranslatorLatvian::trLegendDocs(), TranslatorLithuanian::trLegendDocs(), TranslatorMacedonian::trLegendDocs(), TranslatorNorwegian::trLegendDocs(), TranslatorPersian::trLegendDocs(), TranslatorPolish::trLegendDocs(), TranslatorPortuguese::trLegendDocs(), TranslatorRomanian::trLegendDocs(), TranslatorRussian::trLegendDocs(), TranslatorSerbian::trLegendDocs(), TranslatorSerbianCyrillic::trLegendDocs(), TranslatorSlovak::trLegendDocs(), TranslatorSlovene::trLegendDocs(), TranslatorSpanish::trLegendDocs(), TranslatorSwedish::trLegendDocs(), TranslatorTurkish::trLegendDocs(), TranslatorUkrainian::trLegendDocs(), TranslatorVietnamese::trLegendDocs(), DocbookDocVisitor::writeDotFile(), RTFDocVisitor::writeDotFile(), writeDotGraphFromFile(), writeDotImageMapFromFile(), DotLegendGraph::writeGraph(), HtmlDocVisitor::writeMscFile(), and HtmlDocVisitor::writePlantUMLFile().
Returns the file extension to use for dot files as specified via the argument format.
Definition at line 4981 of file util.cpp.
References DString::find(), DString::left(), and DString::npos.
Definition at line 4987 of file util.cpp.
References split(), and DString::str().
Referenced by DotRunner::run().
Definition at line 4490 of file util.cpp.
References Config_getString, InputFileEncoding::encoding, Doxygen::inputFileEncodingList, FileInfo::match(), and useCaseSenseNames().
Referenced by readCodeFragment(), and readInputFile().
looks for a filter for the file name. Returns the name of the filter if there is a match for the file name, otherwise an empty string. In case inSourceCode is true then first the source filter list is considered.
Definition at line 1025 of file util.cpp.
References Config_getList, Config_getString, DString::empty(), getFilterFromList(), DString::length(), and DString::mid().
Referenced by FilterCache::getFileContents(), CodeFragmentManager::parseCodeFragment(), readCodeFragment(), readInputFile(), and FileDefImpl::writeSourceBody().
Definition at line 4219 of file util.cpp.
References DString::empty(), DString::mid(), DString::npos, and DString::rfind().
Referenced by TooltipManager::addTooltip(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), convertFileNameFortranParserCode(), generateExampleDocs(), FileDefImpl::isDocumentationFile(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), CodeFragmentManager::parseCodeFragment(), and MarkdownOutlineParser::parseInput().
| SrcLangExt getLanguageFromCodeLang | ( | DString & | fileName | ) |
Routine to handle the language attribute of the \code command.
Definition at line 4195 of file util.cpp.
References DString::at(), g_lang2extMap, getLanguageFromFileName(), DString::lower(), and DString::mid().
Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().
| SrcLangExt getLanguageFromFileName | ( | const DString & | fileName, |
| SrcLangExt | defLang = SrcLangExt::Cpp ) |
Definition at line 4177 of file util.cpp.
References DString::at(), DString::empty(), FileInfo::extension(), g_extLookup, DString::lower(), DString::prepend(), and DString::str().
Referenced by MemberDefImpl::_writeMultiLineInitializer(), ClassDefImpl::ClassDefImpl(), convertCppComments(), DocRef::DocRef(), FileDefImpl::FileDefImpl(), generateExampleDocs(), getLanguageFromCodeLang(), EntryType::guessSection(), FileDefImpl::isDocumentationFile(), COutlineParser::needsPreprocessing(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), CodeFragmentManager::parseCodeFragment(), parseFilesMultiThreading(), parseFilesSingleThreading(), parseMain(), Markdown::Private::processLink(), readCodeFragment(), setContext(), setFileName(), validatingParseDoc(), and writeXMLCodeBlock().
| DString getLanguageSpecificSeparator | ( | SrcLangExt | lang, |
| bool | classScope = false ) |
Returns the scope separator to use given the programming language lang
Definition at line 4642 of file util.cpp.
Referenced by DefinitionImpl::_writeSourceRefList(), addGlobalFunction(), MemberDefImpl::addListReference(), addMethodToClass(), addVariableToFile(), MemberDefImpl::displayDefinition(), DefinitionAliasImpl::init(), linkToText(), makeDisplayName(), makeDisplayName(), makeQualifiedNameWithTemplateParameters(), ClassDefImpl::mergeMembersFromBaseClasses(), MemberDefImpl::qualifiedName(), SearchIndex::setCurrentDoc(), validatingParseDoc(), MemberDefImpl::warnIfUndocumented(), writeAlphabeticalClassList(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeJavasScriptSearchDataPage(), MemberDefImpl::writeLink(), and writeMemberReference().
| int getPrefixIndex | ( | const DString & | name | ) |
Returns the character index within name of the first prefix in Config_getList(IGNORE_PREFIX) that matches name at the left hand side, or zero if no match was found
Definition at line 2660 of file util.cpp.
References Config_getList.
Referenced by Index::addClassMemberNameToIndex(), Index::addFileMemberNameToIndex(), Index::addModuleMemberNameToIndex(), Index::addNamespaceMemberNameToIndex(), SearchIndex::addWordRec(), parseInput(), writeAlphabeticalClassList(), and writeMemberList().
| DString getProjectId | ( | ) |
Definition at line 5304 of file util.cpp.
References Config_getString, DString::empty(), md5str(), and DString::view().
Referenced by generateJSNavTree(), HtmlGenerator::init(), and writeJavaScriptSearchIndex().
| int getScopeFragment | ( | const DString & | s, |
| int | p, | ||
| int * | l ) |
Returns a fragment from scope s, starting at position p.
| s | the scope name as a string. |
| p | the start position (0 is the first). |
| l | the resulting length of the fragment. |
Definition at line 3807 of file util.cpp.
References DString::at(), and DString::length().
Referenced by buildScopeFromQualifiedName(), findScopeFromQualifiedName(), SymbolResolver::Private::followPath(), resolveTypeDef(), and stripAnonymousNamespaceScope().
| void initDefaultExtensionMapping | ( | ) |
Definition at line 4104 of file util.cpp.
References updateLanguageMapping().
Referenced by initDoxygen().
| DString inlineArgListToDoc | ( | const ArgumentList & | al | ) |
Returns a documentation string combining the inline documentation for each parameter in the list al.
Definition at line 4878 of file util.cpp.
References extractDirection(), and ArgumentList::hasDocumentation().
Referenced by DocParser::processCopyDoc(), and MemberDefImpl::writeDocumentation().
| DString inlineTemplateArgListToDoc | ( | const ArgumentList & | al | ) |
Returns a documentation string combining the inline documentation for each template parameter in the list al.
Definition at line 837 of file util.cpp.
References ArgumentList::hasTemplateDocumentation(), DString::stripPrefix(), and DString::stripWhiteSpace().
Referenced by ClassDefImpl::writeDetailedDocumentationBody(), and MemberDefImpl::writeDocumentation().
Definition at line 3085 of file util.cpp.
References ArgumentList::empty(), DString::empty(), DString::find(), getClass(), DString::left(), DString::mid(), DString::npos, and ClassDef::templateArguments().
Referenced by DotClassGraph::addClass(), generateXMLForClass(), DiagramItem::label(), ClassDefImpl::writeInheritanceGraph(), and ClassDefImpl::writeTagFile().
| bool isURL | ( | const DString & | url | ) |
Checks whether the given url starts with a supported protocol.
Definition at line 4659 of file util.cpp.
References DString::find(), DString::left(), DString::npos, DString::str(), and DString::stripWhiteSpace().
Referenced by correctURL(), and Markdown::Private::processLink().
Definition at line 745 of file util.cpp.
References DString::length().
Referenced by addClassToContext(), addConceptToContext(), buildFunctionList(), mergeScopes(), pushScope(), and resolveRef().
| DString linkToText | ( | SrcLangExt | lang, |
| const DString & | link, | ||
| bool | ignoreDots ) |
Definition at line 2273 of file util.cpp.
References DString::at(), DString::empty(), DString::find(), getLanguageSpecificSeparator(), DString::mid(), DString::npos, and substitute().
Referenced by DotCallGraph::buildGraph(), DocRef::DocRef(), DotCallGraph::DotCallGraph(), and DocParser::handleLinkedWord().
| bool mainPageHasTitle | ( | ) |
Definition at line 4972 of file util.cpp.
References Doxygen::mainPage.
Referenced by generateJSNavTree(), generateSqlite3ForPage(), and generateXMLForPage().
Definition at line 3983 of file util.cpp.
References stripExtensionGeneral(), and stripPath().
Referenced by HtmlDocVisitor::operator()(), DocbookDocVisitor::startDiaFile(), LatexDocVisitor::startDiaFile(), DocbookDocVisitor::startDotFile(), LatexDocVisitor::startDotFile(), DocbookDocVisitor::startMscFile(), LatexDocVisitor::startMscFile(), DocbookDocVisitor::startPlantUmlFile(), LatexDocVisitor::startPlantUmlFile(), HtmlDocVisitor::writeDiaFile(), RTFDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), HtmlDocVisitor::writeDotFile(), RTFDocVisitor::writeDotFile(), HtmlDocVisitor::writeMermaidFile(), RTFDocVisitor::writeMermaidFile(), DocbookDocVisitor::writeMscFile(), HtmlDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), RTFDocVisitor::writeMscFile(), HtmlDocVisitor::writePlantUMLFile(), and RTFDocVisitor::writePlantUMLFile().
Definition at line 5354 of file util.cpp.
References DString::npos, and DString::setNum().
Referenced by addClassToContext(), addEnumValuesToEnums(), addVariable(), buildFunctionList(), extractClassName(), findClassRelation(), findEnums(), SymbolResolver::resolveClass(), resolveLink(), and resolveRef().
| bool matchArguments2 | ( | const Definition * | srcScope, |
| const FileDef * | srcFileScope, | ||
| const DString & | srcReturnType, | ||
| const ArgumentList * | srcAl, | ||
| const Definition * | dstScope, | ||
| const FileDef * | dstFileScope, | ||
| const DString & | dstReturnType, | ||
| const ArgumentList * | dstAl, | ||
| bool | checkCV, | ||
| SrcLangExt | lang ) |
Compares two parameter lists srcAl and dstAl and returns true if they match.
Definition at line 1597 of file util.cpp.
References argListToString(), ASSERT, AUTO_TRACE, ArgumentList::begin(), ArgumentList::constSpecifier(), ArgumentList::empty(), ArgumentList::end(), ArgumentList::front(), MATCH, matchArgument2(), Definition::name(), NOMATCH, ArgumentList::refQualifier(), ArgumentList::size(), ArgumentList::trailingReturnType(), Argument::type, and ArgumentList::volatileSpecifier().
Referenced by addMemberDocs(), addMemberFunction(), buildFunctionList(), combineDeclarationAndDefinition(), computeMemberRelationsForBaseClass(), ClassDefImpl::containsOverload(), findFriends(), findGlobalMember(), findMember(), SymbolResolver::Private::getResolvedSymbol(), GroupDefImpl::insertMember(), matchCanonicalTypes(), ClassDefImpl::mergeMembersFromBaseClasses(), transferFunctionReferences(), and transferRelatedFunctionDocumentation().
| bool matchTemplateArguments | ( | const ArgumentList & | srcAl, |
| const ArgumentList & | dstAl ) |
Returns true if the template parameter lists srcAl and dstAl match. The lists are considered to match if they have the same number of parameters and each matching parameter in srcAl and dstAl has the same constraints (or at least one parameter has no constraints).
Definition at line 1841 of file util.cpp.
References argListToString(), AUTO_TRACE, AUTO_TRACE_EXIT, ArgumentList::begin(), ArgumentList::end(), ArgumentList::size(), and Argument::type.
Referenced by buildFunctionList().
| void mergeArguments | ( | ArgumentList & | srcAl, |
| ArgumentList & | dstAl, | ||
| bool | forceNameOverwrite = false ) |
Merges the information of two parameter lists (typically a declaration and a definition). Missing information is added to either list. The name of parameter of srcAl is only overwritten if forceNameOverwrite is true.
Definition at line 1697 of file util.cpp.
References argListToString(), AUTO_TRACE, AUTO_TRACE_ADD, ArgumentList::begin(), DString::clear(), Argument::defval, Argument::docs, DString::empty(), ArgumentList::end(), DString::find(), DString::left(), DString::length(), Argument::name, DString::npos, qPrint(), DString::right(), ArgumentList::size(), DString::stripWhiteSpace(), and Argument::type.
Referenced by addMemberDocs(), buildFunctionList(), and findFriends().
Merges two scope parts together. The parts may (partially) overlap. Example1: A::B and B::C will result in A::B::C
Example2: A and B will be A::B
Example3: A::B and B will be A::B
| leftScope | the left hand part of the scope. |
| rightScope | the right hand part of the scope. |
Definition at line 3762 of file util.cpp.
References AUTO_TRACE, AUTO_TRACE_EXIT, DString::empty(), DString::left(), leftScopeMatch(), DString::length(), DString::mid(), DString::npos, and DString::rfind().
Referenced by addEnumValuesToEnums(), addVariable(), findEnums(), findMember(), and stripTemplateSpecifiersFromScope().
| DString normalizeNonTemplateArgumentsInString | ( | const DString & | name, |
| const Definition * | context, | ||
| const ArgumentList & | formalArgs ) |
Returns a representation of name where all known types have been normalized to their canonical form. The normalization is done in the context of context and using the formal arguments in formalArgs.
Definition at line 3474 of file util.cpp.
References end(), Definition::name(), DString::npos, removeRedundantWhiteSpace(), SymbolResolver::resolveClass(), and DString::substr().
Referenced by findUsedClassesForClass().
| bool openOutputFile | ( | const DString & | outFile, |
| std::ofstream & | f ) |
Helper to open an output search f for writing. If the file already exists it will be renamed to .bak first. If outFile is "-" then the output will be written to standard output.
Definition at line 4999 of file util.cpp.
References ASSERT, FileInfo::exists(), FileInfo::filePath(), Portable::openOutputStream(), Dir::remove(), Dir::rename(), and DString::str().
Referenced by compareDoxyfile(), generateConfigFile(), readConfiguration(), and writeDefaultLayoutFile().
| DString projectLogoFile | ( | ) |
Definition at line 2589 of file util.cpp.
References Config_getString, DString::empty(), DString::find(), DString::left(), and DString::npos.
Referenced by copyLogo(), substituteHtmlKeywords(), and substituteLatexKeywords().
| DString projectLogoSize | ( | ) |
Definition at line 2608 of file util.cpp.
References DString::at(), Config_getString, DString::empty(), DString::find(), DString::length(), DString::mid(), DString::npos, DString::prepend(), DString::quoted(), and DString::stripWhiteSpace().
Referenced by substituteHtmlKeywords(), and substituteLatexKeywords().
| bool protectionLevelVisible | ( | Protection | prot | ) |
Definition at line 4684 of file util.cpp.
References Config_getBool.
Referenced by MemberDefImpl::_computeLinkableInProject(), addClassAndNestedClasses(), computeClassRelations(), MemberDefImpl::hasDetailedDescription(), ClassDefImpl::internalInsertMember(), MemberDefImpl::isBriefSectionVisible(), ClassDefImpl::isLinkableInProject(), ClassDefImpl::isVisibleInHierarchy(), MemberDefImpl::warnIfUndocumented(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDocumentationForInnerClasses(), ClassDefImpl::writeMemberList(), and ClassDefImpl::writeTagFile().
| bool readInputFile | ( | const DString & | fileName, |
| std::string & | contents, | ||
| const ReadInputFileOptions & | options = ReadInputFileOptions() ) |
read a file name fileName and optionally filter and transcode it
Definition at line 4383 of file util.cpp.
References ReadInputFileOptions::binary(), DString::empty(), err, FileInfo::exists(), Debug::ExtCmd, ReadInputFileOptions::filter(), filterCRLF(), Debug::FilterOutput, getEncoding(), getFileFilter(), ReadInputFileOptions::isSourceCode(), Portable::openInputStream(), Portable::pclose(), Portable::popen(), Debug::print(), FileInfo::size(), DString::str(), and transcodeCharacterBuffer().
Referenced by checkAndOpenFile(), fileToString(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), parseFile(), parseInput(), readIncludeFile(), DocbookDocVisitor::startMermaidFile(), LatexDocVisitor::startMermaidFile(), DocbookDocVisitor::startPlantUmlFile(), and LatexDocVisitor::startPlantUmlFile().
Definition at line 2921 of file util.cpp.
References Config_getBool, DString::npos, and REL_PATH_TO_ROOT.
Referenced by generateBriefDoc(), DocbookGenerator::startFile(), HtmlGenerator::startFile(), LatexGenerator::startFile(), RTFGenerator::startFile(), and validatingParseDoc().
Removes all anonymous scopes from string s Possible examples:
"bla::@10::blep" => "bla::blep" "bla::@10::@11::blep" => "bla::blep" "@10::blep" => "blep" " @10::blep" => "blep" "@9::@10::blep" => "blep" "bla::@1" => "bla" "bla::@1::@2" => "bla" "bla @1" => "bla"
Definition at line 98 of file util.cpp.
References DString::empty(), end(), and DString::str().
Referenced by createTagLessInstance(), MemberDefImpl::displayDefinition(), generateClassMemberLink(), ClassDefImpl::internalInsertMember(), makeDisplayName(), makeDisplayName(), simplifyTypeForTable(), MemberDefImpl::writeDeclaration(), and MemberDefImpl::writeDocumentation().
Definition at line 427 of file util.cpp.
References CharAroundSpace::CharElem::after, CharAroundSpace::CharElem::before, CharAroundSpace::charMap, Config_getBool, constScope, DString::data(), disspace(), DString::empty(), g_charAroundSpace, isId(), DString::length(), operatorScope, staticScope, THREAD_LOCAL, virtualScope, and volatileScope.
Referenced by addFrom(), addGlobalFunction(), addMethodToClass(), addVariable(), addVariableToClass(), argListToString(), buildFunctionList(), buildInterfaceAndServiceList(), buildTypedefList(), ClassDefImpl::ClassDefImpl(), extractCanonicalType(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findMember(), findUsedClassesForClass(), findUsingDeclImports(), ArgumentList::finishTrailingReturnType(), generateFunctionLink(), generateFunctionLink(), generateLink(), getCanonicalTypeForIdentifier(), getLink(), getLink(), getLink(), MemberDefImpl::init(), ClassDefImpl::insertTemplateInstance(), MemberDefImpl::MemberDefImpl(), normalizeNonTemplateArgumentsInString(), parseFuncDecl(), resolveRef(), tempArgListToString(), and writeExceptionListImpl().
Definition at line 155 of file util.cpp.
References DString::data(), DString::empty(), reg::replace(), and DString::str().
Referenced by addMemberFunction(), findGlobalMember(), and generateDEFForMember().
Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC, where #AABBCC represents a valid color, based on the intensity represented by hex number AA and the current HTML_COLORSTYLE_* settings.
Definition at line 4581 of file util.cpp.
References Config_getInt, DString::empty(), end(), hex, HEXTONUM, ColoredImage::hsl2rgb(), and DString::str().
Referenced by ResourceMgr::copyResourceAs(), fillColorStyleMaps(), HtmlGenerator::init(), and writeDefaultStyleSheet().
| bool resolveLink | ( | const DString & | scName, |
| const DString & | lr, | ||
| bool | inSeeBlock, | ||
| const Definition ** | resContext, | ||
| DString & | resAnchor, | ||
| SrcLangExt | lang, | ||
| const DString & | prefix = DString(), | ||
| const FileDef * | currentFile = nullptr ) |
Returns an symbol definition given its name and context for an explicitly linked symbol.
Definition at line 2316 of file util.cpp.
References Definition::anchor(), AUTO_TRACE, AUTO_TRACE_EXIT, SectionInfo::definition(), DString::empty(), Doxygen::exampleLinkedMap, LinkedMap< T, Hash, KeyEqual, Map >::find(), getClass(), getConcept(), PageDef::getGroupDef(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), SectionManager::instance(), Definition::isLinkable(), SectionInfo::label(), mangleCSharpGenericName(), Definition::name(), Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, prefix, resolveDirLink(), resolveRef(), and stripTemplateSpecifiersFromScope().
Referenced by DocLink::DocLink(), and DocRef::DocRef().
| bool resolveRef | ( | const DString & | scName, |
| const DString & | name, | ||
| bool | inSeeBlock, | ||
| const Definition ** | resContext, | ||
| const MemberDef ** | resMember, | ||
| SrcLangExt | lang, | ||
| bool | lookForSpecializations = true, | ||
| const FileDef * | currentFile = nullptr, | ||
| bool | checkScope = false ) |
Returns a symbol definition (compound and/or member) given its name and context.
Definition at line 2016 of file util.cpp.
References ASSERT, AUTO_TRACE, AUTO_TRACE_ADD, GetDefResult::cd, GetDefInput::checkCV, GetDefResult::cnd, Doxygen::conceptLinkedMap, GetDefInput::currentFile, DString::empty(), GetDefResult::fd, DString::find(), LinkedMap< T, Hash, KeyEqual, Map >::find(), FileNameLinkedMap::findFileDef(), findParameterList(), GetDefInput::forceEmptyScope, GetDefResult::found, GetDefResult::gd, getClass(), getDefs(), Definition::getOuterScope(), getScopeDefs(), Doxygen::globalScope, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), MemberDef::isEnumerate(), isLowerCase(), MemberDef::isStrongEnumValue(), MemberDef::isTypedef(), DString::left(), leftScopeMatch(), DString::length(), mangleCSharpGenericName(), GetDefResult::md, DString::mid(), GetDefResult::modd, Definition::name(), GetDefResult::nd, DString::npos, removeRedundantWhiteSpace(), resolveRef(), DString::rfind(), DString::startsWith(), and substitute().
Referenced by DocParser::handleLinkedWord(), resolveLink(), and resolveRef().
| DString resolveTypeDef | ( | const Definition * | d, |
| const DString & | name, | ||
| const Definition ** | typedefContext = nullptr ) |
Definition at line 232 of file util.cpp.
References MemberDef::argsString(), AUTO_TRACE, AUTO_TRACE_ADD, AUTO_TRACE_EXIT, Definition::definitionType(), DString::empty(), DString::find(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Definition::findInnerCompound(), Doxygen::functionNameLinkedMap, Definition::getOuterScope(), getScopeFragment(), Doxygen::globalScope, SymbolResolver::isAccessibleFrom(), MemberDef::isRelated(), MemberDef::isTypedef(), DString::left(), Doxygen::memberNameLinkedMap, DString::mid(), Definition::name(), DString::npos, resolveTypeDef(), DString::rfind(), Definition::TypeClass, and MemberDef::typeString().
Referenced by findUsedClassesForClass(), getCanonicalTemplateSpec(), getCanonicalTypeForIdentifier(), isVarWithConstructor(), and resolveTypeDef().
Definition at line 734 of file util.cpp.
References DString::at(), DString::length(), and DString::right().
Referenced by addMemberFunction(), findScopeFromQualifiedName(), and isRecursiveBaseClass().
| DString selectBlocks | ( | const DString & | s, |
| const SelectionBlockList & | blockList, | ||
| const SelectionMarkerInfo & | markerInfo ) |
remove disabled blocks and all block markers from s and return the result as a string
Definition at line 5029 of file util.cpp.
References SelectionMarkerInfo::beginLen, SelectionMarkerInfo::beginStr, SelectionMarkerInfo::closeLen, SelectionMarkerInfo::closeStr, DString::data(), dstrlen(), dstrncmp(), DString::empty(), SelectionMarkerInfo::endLen, SelectionMarkerInfo::endStr, DString::length(), SelectionMarkerInfo::markerChar, and DString::reserve().
Referenced by substituteHtmlKeywords(), and substituteLatexKeywords().
Definition at line 2576 of file util.cpp.
References dateTimeFromString(), err, and formatDateTime().
Referenced by substituteHtmlKeywords(), and substituteLatexKeywords().
| void stackTrace | ( | ) |
Definition at line 4319 of file util.cpp.
References Portable::pclose(), and Portable::popen().
Definition at line 167 of file util.cpp.
References DString::at(), DString::empty(), getScopeFragment(), DString::left(), DString::length(), DString::mid(), Doxygen::namespaceLinkedMap, and DString::right().
Referenced by addMemberFunction(), addPageToContext(), addVariable(), buildNamespaceList(), computeTemplateClassRelations(), extractClassName(), findGroupScope(), findUsingDeclImports(), findUsingDirectives(), and resolveClassNestingRelations().
Definition at line 3964 of file util.cpp.
References Doxygen::htmlFileExtension, and stripExtensionGeneral().
Referenced by anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), ClassDefImpl::ClassDefImpl(), and MemberDefImpl::setTagInfo().
Definition at line 3954 of file util.cpp.
References DString::left(), DString::length(), and DString::right().
Referenced by TooltipManager::addTooltip(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), extraLatexStyleSheet(), makeBaseName(), MarkdownOutlineParser::parseInput(), stripExtension(), DocbookCodeGenerator::writeCodeLinkLine(), LatexCodeGenerator::writeLineNumber(), and RTFCodeGenerator::writeLineNumber().
strip part of path if it matches one of the paths in the Config_getList(INCLUDE_PATH) list
Definition at line 227 of file util.cpp.
References Config_getList, and stripFromPath().
Referenced by MemberDefImpl::_writeGroupInclude(), addIncludeFile(), FileNameLinkedMap::findFileDef(), and FileNameLinkedMap::showFileDefMatches().
strip part of path if it matches one of the paths in the Config_getList(STRIP_FROM_PATH) list
Definition at line 219 of file util.cpp.
References Config_getList, and stripFromPath().
Referenced by Config::checkAndCorrect(), DirDefImpl::DirDefImpl(), FileDefImpl::FileDefImpl(), generateAnonymousAnchor(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForMember(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), generateXMLForRequirement(), generateXMLForRequirements(), handleFileInfoResult(), insertPath(), markdownFileNameToId(), MarkdownOutlineParser::parseInput(), ModuleManager::resolveImports(), ClassDefImpl::showUsedFiles(), ModuleDefImpl::writeFiles(), writeSingleFileIndex(), DirDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), and GroupDefImpl::writeTagFile().
Definition at line 4696 of file util.cpp.
References Config_getInt, DString::data(), DString::empty(), literal_at(), TextStream::str(), and substitute().
Referenced by handleCommentBlock(), handleCommentBlock(), handleCommentBlock(), handleParametersCommentBlocks(), DocPara::handleStartCode(), and MarkdownOutlineParser::parseInput().
| void stripIndentationVerbatim | ( | DString & | doc, |
| size_t | indentationLevel, | ||
| bool | skipFirstLine = true ) |
Definition at line 4785 of file util.cpp.
References DString::data(), DString::empty(), DString::rawData(), and DString::resize().
Referenced by MemberDefImpl::setInitializer().
Special version of DString::stripWhiteSpace() that only strips completely blank lines.
| s | the string to be stripped |
| docLine | the line number corresponding to the start of the string. This will be adjusted based on the number of lines stripped from the start. |
Definition at line 3996 of file util.cpp.
References DString::data(), DString::empty(), DString::length(), literal_at(), and DString::mid().
Referenced by DefinitionImpl::_setBriefDescription(), DocGroup::addDocs(), VHDLOutlineParser::checkInlineCode(), DocPara::handleCommand(), CommentScanner::parseCommentBlock(), and toDefinition().
Definition at line 3969 of file util.cpp.
References DString::mid(), DString::npos, and DString::rfind().
Referenced by LatexGenerator::addLabel(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), RTFGenerator::endDoxyAnchor(), LatexGenerator::endIndexItem(), LatexGenerator::endIndexValue(), LatexGenerator::endTitleHead(), makeBaseName(), objectLinkToString(), objectLinkToString(), objectLinkToString(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), XmlDocVisitor::operator()(), DotFilePatcher::run(), SearchIndexExternal::setCurrentDoc(), DocbookGenerator::startDoxyAnchor(), LatexGenerator::startDoxyAnchor(), DocbookGenerator::startFile(), LatexGenerator::startFile(), RTFGenerator::startFile(), DocbookDocVisitor::startLink(), LatexDocVisitor::startLink(), RTFDocVisitor::startLink(), DocbookDocVisitor::startMermaidFile(), LatexDocVisitor::startMermaidFile(), LatexDocVisitor::startPlantUmlFile(), DocbookGenerator::startSection(), LatexGenerator::startSection(), LatexGenerator::startTextLink(), RTFGenerator::startTextLink(), substituteHtmlKeywords(), substituteLatexKeywords(), LatexGenerator::writeAnchor(), RTFGenerator::writeAnchor(), LatexCodeGenerator::writeCodeLink(), RTFCodeGenerator::writeCodeLink(), DocbookCodeGenerator::writeCodeLinkLine(), MemberList::writeDeclarations(), DocbookDocVisitor::writeDiaFile(), writeDocbookLink(), LatexCodeGenerator::writeLineNumber(), RTFCodeGenerator::writeLineNumber(), DocbookDocVisitor::writeMermaidFile(), LatexDocVisitor::writeMermaidFile(), DocbookDocVisitor::writePlantUMLFile(), LatexDocVisitor::writePlantUMLFile(), RTFGenerator::writeRTFReference(), and RTFGenerator::writeStartAnnoItem().
Strips the scope from a name. Examples: A::B will return A and A<T>::B<N::C<D> > will return A<T>.
Definition at line 3118 of file util.cpp.
References DString::at(), DString::length(), and DString::right().
Referenced by DotClassGraph::addClass(), DocRef::DocRef(), generateJSLink(), getCanonicalTypeForIdentifier(), DefinitionImpl::Private::init(), DiagramItem::label(), NamespaceDefImpl::writeBriefDescription(), and ClassDefImpl::writeIncludeFilesForSlice().
| DString stripTemplateSpecifiersFromScope | ( | const DString & | fullName, |
| bool | parentOnly, | ||
| DString * | pLastScopeStripped, | ||
| DString | scopeName, | ||
| bool | allowArtificial ) |
Strips template specifiers from scope fullName, except those that make up specialized classes. The switch parentOnly determines whether or not a template "at the end" of a scope should be considered, e.g. with parentOnly is true, A<T>::B<S> will try to strip <T> and not <S>, while parentOnly is false will strip both unless A<T> or B<S> are specialized template classes.
Definition at line 3695 of file util.cpp.
References DString::at(), DString::find(), getClass(), Definition::isArtificial(), DString::length(), mergeScopes(), DString::mid(), DString::npos, and DString::right().
Referenced by addClassToContext(), addMemberFunction(), addVariable(), buildFunctionList(), computeTemplateClassRelations(), extractClassName(), findMember(), findScopeFromQualifiedName(), findUsingDeclImports(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedTypeRec(), SymbolResolver::Private::newResolveTypedef(), and resolveLink().
| DString substituteKeywords | ( | const DString & | file, |
| const DString & | s, | ||
| const KeywordSubstitutionList & | keywords ) |
Definition at line 2503 of file util.cpp.
References DString::data(), dstrlen(), dstrncmp(), DString::left(), DString::length(), and warn.
Referenced by substituteHtmlKeywords(), and substituteLatexKeywords().
| DString substituteTemplateArgumentsInString | ( | const DString & | name, |
| const ArgumentList & | formalArgs, | ||
| const ArgumentList * | actualArgs ) |
Substitutes any occurrence of a formal argument from argument list formalArgs in name by the corresponding actual argument in argument list actualArgs. The result after substitution is returned as a string. The argument name is used to prevent recursive substitution.
Definition at line 3533 of file util.cpp.
References argListToString(), AUTO_TRACE, AUTO_TRACE_ADD, AUTO_TRACE_EXIT, ArgumentList::begin(), Argument::defval, ArgumentList::empty(), DString::empty(), ArgumentList::end(), end(), isId(), DString::left(), DString::mid(), Argument::name, DString::npos, prefix, DString::simplifyWhiteSpace(), DString::startsWith(), DString::str(), DString::stripWhiteSpace(), substituteTemplateArgumentsInString(), and Argument::type.
Referenced by computeMemberRelationsForBaseClass(), computeTemplateClassRelations(), MemberDefImpl::createTemplateInstanceMember(), findBaseClassesForClass(), findUsedClassesForClass(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::newResolveTypedef(), and substituteTemplateArgumentsInString().
| DString tempArgListToString | ( | const ArgumentList & | al, |
| SrcLangExt | lang, | ||
| bool | includeDefaults = true ) |
Returns a string representation of the template parameter list al. The lang parameter is used to determine the correct syntax for the template parameters. If includeDefaults is true then default values are included in the string representation.
Definition at line 908 of file util.cpp.
References ArgumentList::empty(), isId(), DString::npos, removeRedundantWhiteSpace(), and DString::right().
Referenced by addMemberFunction(), ClassDefImpl::className(), findTemplateInstanceRelation(), makeQualifiedNameWithTemplateParameters(), searchTemplateSpecs(), and writeDefArgumentList().
Definition at line 2784 of file util.cpp.
References DString::data(), DString::empty(), DString::length(), DString::reserve(), and useCaseSenseNames().
Definition at line 4072 of file util.cpp.
References DString::at(), DString::data(), DString::empty(), err, g_extLookup, g_lang2extMap, DString::lower(), Doxygen::parserManager, DString::prepend(), and DString::str().
Referenced by addCodeOnlyMappings(), adjustConfiguration(), and initDefaultExtensionMapping().
| bool useCaseSenseNames | ( | ) |
Returns true if the names of the symbols can be case sensitive.
Definition at line 2688 of file util.cpp.
References Config_getEnum, and Portable::fileSystemIsCaseSensitive().
Referenced by checkAndOpenFile(), escapeCharsInString(), getEncoding(), readDir(), FileNameFn::searchKey(), and unescapeCharsInString().
| void writeExamples | ( | OutputList & | ol, |
| const ExampleList & | el ) |
Definition at line 809 of file util.cpp.
References OutputList::disable(), Docbook, Html, Latex, Man, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, DString::str(), theTranslator, Translator::trWriteList(), writeMarkerList(), OutputList::writeObjectLink(), and OutputList::writeString().
Referenced by MemberDefImpl::_writeExamples(), and ClassDefImpl::writeDetailedDocumentationBody().
| DString writeInlineGraph | ( | const DString & | baseName, |
| const DString & | extension, | ||
| const DString & | content, | ||
| bool & | exists ) |
Thread-safe function to write a string representing an inline graph to a file. The contents will be used to create a hash that will be used to make the name unique.
| [in] | baseName | the base name of the file to write including path. |
| [in] | extension | the file extension to use. |
| [in] | content | the data to write to the file |
| [out] | exists | is set to true if the file was already written before. |
Definition at line 5410 of file util.cpp.
References DString::data(), err, DString::length(), md5str(), Portable::openOutputStream(), DString::str(), DString::view(), writeFileContents_lock, and writeFileContents_set.
Referenced by DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), and RTFDocVisitor::operator()().
| DString writeMarkerList | ( | const std::string & | markerText, |
| size_t | numMarkers, | ||
| std::function< DString(size_t)> | replaceFunc ) |
Definition at line 781 of file util.cpp.
References end(), and DString::substr().
| void writeMarkerList | ( | OutputList & | ol, |
| const std::string & | markerText, | ||
| size_t | numMarkers, | ||
| std::function< void(size_t)> | replaceFunc ) |
Definition at line 758 of file util.cpp.
References end(), and OutputList::parseText().
Referenced by MemberDefImpl::_writeReimplementedBy(), DefinitionImpl::_writeSourceRefList(), RequirementManager::generatePage(), writeExamples(), ClassDefImpl::writeInheritanceGraph(), and DefinitionImpl::writeRequirementRefs().
| void writeTypeConstraints | ( | OutputList & | ol, |
| const Definition * | d, | ||
| const ArgumentList & | al ) |
Definition at line 4292 of file util.cpp.
References Definition::docFile(), Definition::docLine(), ArgumentList::empty(), OutputList::endConstraintDocs(), OutputList::endConstraintList(), OutputList::endConstraintParam(), OutputList::endConstraintType(), OutputList::generateDoc(), linkifyText(), OutputList::parseText(), OutputList::startConstraintDocs(), OutputList::startConstraintList(), OutputList::startConstraintParam(), OutputList::startConstraintType(), theTranslator, and Translator::trTypeConstraints().
Referenced by MemberDefImpl::_writeTypeConstraints(), and ClassDefImpl::writeDetailedDocumentationBody().