A bunch of utility functions. 更多...

#include <memory>
#include <unordered_map>
#include <algorithm>
#include <functional>
#include <fstream>
#include <ctype.h>
#include "types.h"
#include "docparser.h"
#include "containers.h"
#include "outputgen.h"
#include "regex.h"
#include "conceptdef.h"

util.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

类
class	TextGeneratorIntf
	Abstract interface for a hyperlinked text fragment. 更多...

class	TextGeneratorOLImpl
	Implements TextGeneratorIntf for an OutputDocInterface stream. 更多...

struct	ColoredImgDataItem
	Data associated with a HSV colored image. 更多...

函数
QCString	langToString (SrcLangExt lang)
	Returns a string representation of lang. 更多...

QCString	getLanguageSpecificSeparator (SrcLangExt lang, bool classScope=FALSE)
	Returns the scope separator to use given the programming language lang 更多...

void	linkifyText (const TextGeneratorIntf &ol, const Definition scope, const FileDef fileScope, const Definition *self, const QCString &text, bool autoBreak=FALSE, bool external=TRUE, bool keepSpaces=FALSE, int indentLevel=0)

QCString	fileToString (const QCString &name, bool filter=FALSE, bool isSourceCode=FALSE)

QCString	dateToString (bool)

bool	getDefs (const QCString &scopeName, const QCString &memberName, const QCString &args, const MemberDef &md, const ClassDef &cd, const FileDef &fd, const NamespaceDef &nd, const GroupDef &gd, bool forceEmptyScope=FALSE, const FileDef currentFile=0, bool checkCV=FALSE)

QCString	getFileFilter (const QCString &name, bool isSourceCode)

bool	resolveRef (const QCString &scName, const QCString &name, bool inSeeBlock, const Definition resContext, const MemberDef resMember, bool lookForSpecializations=TRUE, const FileDef *currentFile=0, bool checkScope=FALSE)

bool	resolveLink (const QCString &scName, const QCString &lr, bool inSeeBlock, const Definition **resContext, QCString &resAnchor)

bool	generateLink (OutputDocInterface &od, const QCString &, const QCString &, bool inSeeBlock, const QCString &)

void	generateFileRef (OutputDocInterface &od, const QCString &, const QCString &linkTxt=QCString())

void	writePageRef (OutputDocInterface &od, const QCString &cn, const QCString &mn)

QCString	getCanonicalTemplateSpec (const Definition d, const FileDef fs, const QCString &spec)

bool	matchArguments2 (const Definition srcScope, const FileDef srcFileScope, const ArgumentList srcAl, const Definition dstScope, const FileDef dstFileScope, const ArgumentList dstAl, bool checkCV)

void	mergeArguments (ArgumentList &, ArgumentList &, bool forceNameOverwrite=FALSE)

QCString	substituteClassNames (const QCString &s)

QCString	clearBlock (const char s, const char begin, const char *end)

QCString	selectBlock (const QCString &s, const QCString &name, bool enable, OutputGenerator::OutputType o)

QCString	removeEmptyLines (const QCString &s)

FileDef *	findFileDef (const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)

QCString	showFileDefMatches (const FileNameLinkedMap *fnMap, const QCString &n)

int	guessSection (const QCString &name)

bool	isId (int c)

bool	isIdJS (int c)

QCString	removeRedundantWhiteSpace (const QCString &s)

QCString	argListToString (const ArgumentList &al, bool useCanonicalType=FALSE, bool showDefVals=TRUE)

QCString	tempArgListToString (const ArgumentList &al, SrcLangExt lang, bool includeDefaults=true)

QCString	generateMarker (int id)

void	writeExamples (OutputList &ol, const ExampleList &el)

QCString	stripAnonymousNamespaceScope (const QCString &s)

QCString	stripFromPath (const QCString &path)

QCString	stripFromIncludePath (const QCString &path)

bool	rightScopeMatch (const QCString &scope, const QCString &name)

bool	leftScopeMatch (const QCString &scope, const QCString &name)

QCString	substituteKeywords (const QCString &s, const QCString &title, const QCString &projName, const QCString &projNum, const QCString &projBrief)

int	getPrefixIndex (const QCString &name)

QCString	removeAnonymousScopes (const QCString &s)

QCString	replaceAnonymousScopes (const QCString &s, const QCString &replacement=QCString())

QCString	convertNameToFile (const QCString &name, bool allowDots=FALSE, bool allowUnderscore=FALSE)

void	extractNamespaceName (const QCString &scopeName, QCString &className, QCString &namespaceName, bool allowEmptyClass=FALSE)

QCString	insertTemplateSpecifierInScope (const QCString &scope, const QCString &templ)

QCString	stripScope (const QCString &name)

QCString	convertToId (const QCString &s)

QCString	correctId (const QCString &s)

QCString	convertToHtml (const QCString &s, bool keepEntities=TRUE)

QCString	convertToLaTeX (const QCString &s, bool insideTabbing=FALSE, bool keepSpaces=FALSE)

QCString	convertToXML (const QCString &s, bool keepEntities=FALSE)

QCString	convertToDocBook (const QCString &s)

QCString	convertToJSString (const QCString &s)

QCString	convertToPSString (const QCString &s)

QCString	getOverloadDocs ()

void	addMembersToMemberGroup (MemberList ml, MemberGroupList pMemberGroups, const Definition *context)

int	extractClassNameFromType (const QCString &type, int &pos, QCString &name, QCString &templSpec, SrcLangExt=SrcLangExt_Unknown)

QCString	normalizeNonTemplateArgumentsInString (const QCString &name, const Definition *context, const ArgumentList &formalArgs)

QCString	substituteTemplateArgumentsInString (const QCString &name, const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs)

QCString	stripTemplateSpecifiersFromScope (const QCString &fullName, bool parentOnly=TRUE, QCString *lastScopeStripped=0)

QCString	resolveTypeDef (const Definition d, const QCString &name, const Definition *typedefContext=0)

QCString	mergeScopes (const QCString &leftScope, const QCString &rightScope)

int	getScopeFragment (const QCString &s, int p, int *l)

void	addRefItem (const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)

PageDef *	addRelatedPage (const QCString &name, const QCString &ptitle, const QCString &doc, const QCString &fileName, int docLine, int startLine, const RefItemVector &sli=RefItemVector(), GroupDef gd=0, const TagInfo tagInfo=0, bool xref=FALSE, SrcLangExt lang=SrcLangExt_Unknown)

QCString	escapeCharsInString (const QCString &name, bool allowDots, bool allowUnderscore=FALSE)

QCString	unescapeCharsInString (const QCString &s)

void	addGroupListToTitle (OutputList &ol, const Definition *d)

void	filterLatexString (TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces)

QCString	latexEscapeLabelName (const QCString &s)

QCString	latexEscapeIndexChars (const QCString &s)

QCString	latexEscapePDFString (const QCString &s)

QCString	latexFilterURL (const QCString &s)

QCString	rtfFormatBmkStr (const QCString &name)

QCString	linkToText (SrcLangExt lang, const QCString &link, bool isFileName)

bool	checkExtension (const QCString &fName, const QCString &ext)

QCString	addHtmlExtensionIfMissing (const QCString &fName)

QCString	stripExtensionGeneral (const QCString &fName, const QCString &ext)

QCString	stripExtension (const QCString &fName)

void	replaceNamespaceAliases (QCString &scope, int i)

int	computeQualifiedIndex (const QCString &name)

void	addDirPrefix (QCString &fileName)

QCString	relativePathToRoot (const QCString &name)

void	createSubDirs (const Dir &d)

void	clearSubDirs (const Dir &d)

QCString	stripPath (const QCString &s)

bool	containsWord (const QCString &s, const char *word)
	returns `TRUE` iff string s contains word w 更多...

bool	findAndRemoveWord (QCString &s, const char *word)
	removes occurrences of whole word from sentence, while keeps internal spaces and reducing multiple sequences of spaces. 更多...

QCString	stripLeadingAndTrailingEmptyLines (const QCString &s, int &docLine)
	Special version of QCString::stripWhiteSpace() that only strips completely blank lines. 更多...

bool	updateLanguageMapping (const QCString &extension, const QCString &parser)

SrcLangExt	getLanguageFromFileName (const QCString &fileName, SrcLangExt defLang=SrcLangExt_Cpp)

SrcLangExt	getLanguageFromCodeLang (QCString &fileName)
	Routine to handle the language attribute of the `\code` command 更多...

QCString	getFileNameExtension (const QCString &fn)

void	initDefaultExtensionMapping ()

void	addCodeOnlyMappings ()

bool	checkIfTypedef (const Definition scope, const FileDef fileScope, const QCString &n)

QCString	parseCommentAsText (const Definition scope, const MemberDef member, const QCString &doc, const QCString &fileName, int lineNr)

QCString	transcodeCharacterStringToUTF8 (const QCString &input)

QCString	recodeString (const QCString &str, const char fromEncoding, const char toEncoding)

QCString	extractAliasArgs (const QCString &args, size_t pos)

int	countAliasArguments (const QCString &argList)

QCString	resolveAliasCmd (const QCString &aliasCmd)

std::string	expandAlias (const std::string &aliasName, const std::string &aliasValue)

void	writeTypeConstraints (OutputList &ol, const Definition *d, const ArgumentList &al)

QCString	convertCharEntitiesToUTF8 (const QCString &s)

void	stackTrace ()

bool	readInputFile (const QCString &fileName, BufStr &inBuf, bool filter=TRUE, bool isSourceCode=FALSE)
	read a file name fileName and optionally filter and transcode it 更多...

QCString	filterTitle (const QCString &title)

bool	patternMatch (const FileInfo &fi, const StringVector &patList)

QCString	externalLinkTarget (const bool parent=false)

QCString	externalRef (const QCString &relPath, const QCString &ref, bool href)

int	nextUtf8CharPosition (const QCString &utf8Str, uint len, uint startPos)

void	writeMarkerList (OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)

void	writeColoredImgData (const QCString &dir, ColoredImgDataItem data[])
	Writes the intensity only bitmap represented by data as an image to directory dir using the colors defined by HTML_COLORSTYLE_*. 更多...

QCString	replaceColorMarkers (const QCString &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. 更多...

bool	copyFile (const QCString &src, const QCString &dest)
	Copies the contents of file with name src to the newly created file with name dest. 更多...

QCString	extractBlock (const QCString &text, const QCString &marker)
	Returns the section of text, in between a pair of markers. 更多...

int	lineBlock (const QCString &text, const QCString &marker)
	Returns the line number of the line following the line with the marker. 更多...

bool	isURL (const QCString &url)
	Checks whether the given url starts with a supported protocol 更多...

QCString	correctURL (const QCString &url, const QCString &relPath)
	Corrects URL url according to the relative path relPath. 更多...

QCString	processMarkup (const QCString &s)

bool	protectionLevelVisible (Protection prot)

QCString	stripIndentation (const QCString &s)

void	stripIndentation (QCString &doc, const int indentationLevel)

QCString	getDotImageExtension ()

bool	fileVisibleInIndex (const FileDef *fd, bool &genSourceFile)

QCString	extractDirection (QCString &docs)
	Strip the direction part from docs and return it as a string in canonical form The input docs string can start with e.g. 更多...

void	convertProtectionLevel (MemberListType inListType, Protection inProt, int outListType1, int 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. 更多...

bool	mainPageHasTitle ()

bool	openOutputFile (const QCString &outFile, std::ofstream &f)

void	writeExtraLatexPackages (TextStream &t)

void	writeLatexSpecialFormulaChars (TextStream &t)

StringVector	split (const std::string &s, const std::string &delimiter)
	split input string s by string delimiter delimiter. returns a vector of non-empty strings that are between the delimiters 更多...

StringVector	split (const std::string &s, const reg::Ex &delimiter)
	split input string s by regular expression delimiter delimiter. returns a vector of non-empty strings that are between the delimiters 更多...

int	findIndex (const StringVector &sv, const std::string &s)
	find the index of a string in a vector of strings, returns -1 if the string could not be found 更多...

int	findIndex (const std::string &s, const reg::Ex &re)
	find the index of the first occurrence of pattern re in a string s returns -1 if the pattern could not be found 更多...

std::string	join (const StringVector &s, const std::string &delimiter)
	create a string where the string in the vector are joined by the given delimiter 更多...

bool	recognizeFixedForm (const QCString &contents, FortranFormat format)

FortranFormat	convertFileNameFortranParserCode (QCString fn)

QCString	integerToAlpha (int n, bool upper=true)

QCString	integerToRoman (int n, bool upper=true)

详细描述

A bunch of utility functions.

在文件 util.h 中定义.

函数说明

◆ addCodeOnlyMappings()

void addCodeOnlyMappings ( )

在文件 util.cpp 第 5568 行定义.

 {
   updateLanguageMapping(".xml",   "xml");
   updateLanguageMapping(".sql",   "sql");
 }

引用了 updateLanguageMapping().

被这些函数引用 generateOutput().

◆ addDirPrefix()

void addDirPrefix ( QCString & fileName )

◆ addGroupListToTitle()

void addGroupListToTitle	(	OutputList &	ol,
		const Definition *	d
	)

在文件 util.cpp 第 4929 行定义.

 {
   recursivelyAddGroupListToTitle(ol,d,TRUE);
 }

引用了 recursivelyAddGroupListToTitle() , 以及 TRUE.

被这些函数引用 NamespaceDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation() , 以及 ClassDefImpl::writeDocumentation().

◆ addHtmlExtensionIfMissing()

QCString addHtmlExtensionIfMissing ( const QCString & fName )

在文件 util.cpp 第 5275 行定义.

 {
   if (fName.isEmpty()) return fName;
   if (fName.find('.')==-1) // no extension
   {
     return QCString(fName)+Doxygen::htmlFileExtension;
   }
   return fName;
 }

引用了 QCString::find(), Doxygen::htmlFileExtension , 以及 QCString::isEmpty().

◆ addMembersToMemberGroup()

void addMembersToMemberGroup	(	MemberList *	ml,
		MemberGroupList *	pMemberGroups,
		const Definition *	context
	)

在文件 util.cpp 第 4220 行定义.

 {
   ASSERT(context!=0);
   //printf("addMemberToMemberGroup() context=%s\n",qPrint(context->name()));
   if (ml==0) return;
  
   struct MoveMemberInfo
   {
     MoveMemberInfo(const MemberDef *md,MemberGroup *mg,const RefItemVector &rv)
       : memberDef(md), memberGroup(mg), sli(rv) {}
     const MemberDef *memberDef;
     MemberGroup *memberGroup;
     RefItemVector sli;
   };
   std::vector<MoveMemberInfo> movedMembers;
  
   for (const auto &md : *ml)
   {
     if (md->isEnumerate()) // insert enum value of this enum into groups
     {
       for (const auto &fmd : md->enumFieldList())
       {
         int groupId=fmd->getMemberGroupId();
         if (groupId!=-1)
         {
           auto it = Doxygen::memberGroupInfoMap.find(groupId);
           if (it!=Doxygen::memberGroupInfoMap.end())
           {
             auto &info = it->second;
             auto mg_it = std::find_if(pMemberGroups->begin(),
                                       pMemberGroups->end(),
                                       [&groupId](const auto &g)
                                       { return g->groupId()==groupId; }
                                      );
             MemberGroup *mg_ptr = 0;
             if (mg_it==pMemberGroups->end())
             {
               auto mg = std::make_unique<MemberGroup>(
                         context,
                         groupId,
                         info->header,
                         info->doc,
                         info->docFile,
                         info->docLine,
                         ml->container());
               mg_ptr = mg.get();
               pMemberGroups->push_back(std::move(mg));
             }
             else
             {
               mg_ptr = (*mg_it).get();
             }
             mg_ptr->insertMember(fmd); // insert in member group
             MemberDefMutable *fmdm = toMemberDefMutable(fmd);
             if (fmdm)
             {
               fmdm->setMemberGroup(mg_ptr);
             }
           }
         }
       }
     }
     int groupId=md->getMemberGroupId();
     if (groupId!=-1)
     {
       auto it = Doxygen::memberGroupInfoMap.find(groupId);
       if (it!=Doxygen::memberGroupInfoMap.end())
       {
         auto &info = it->second;
         auto mg_it = std::find_if(pMemberGroups->begin(),
                                   pMemberGroups->end(),
                                   [&groupId](const auto &g)
                                   { return g->groupId()==groupId; }
                                  );
         MemberGroup *mg_ptr = 0;
         if (mg_it==pMemberGroups->end())
         {
           auto mg = std::make_unique<MemberGroup>(
                     context,
                     groupId,
                     info->header,
                     info->doc,
                     info->docFile,
                     info->docLine,
                     ml->container());
           mg_ptr = mg.get();
           pMemberGroups->push_back(std::move(mg));
         }
         else
         {
           mg_ptr = (*mg_it).get();
         }
         movedMembers.push_back(MoveMemberInfo(md,mg_ptr,info->m_sli));
       }
     }
   }
  
   // move the members to their group
   for (const auto &mmi : movedMembers)
   {
     ml->remove(mmi.memberDef); // remove from member list
     mmi.memberGroup->insertMember(mmi.memberDef->resolveAlias()); // insert in member group
     mmi.memberGroup->setRefItems(mmi.sli);
     MemberDefMutable *rmdm = toMemberDefMutable(mmi.memberDef);
     if (rmdm)
     {
       rmdm->setMemberGroup(mmi.memberGroup);
     }
   }
 }

引用了 ASSERT, Definition::docFile(), end(), MemberDef::enumFieldList(), MemberDef::getMemberGroupId(), MemberGroup::insertMember(), MemberDef::isEnumerate(), Doxygen::memberGroupInfoMap, MemberDef::setMemberGroup() , 以及 toMemberDefMutable().

◆ addRefItem()

void addRefItem	(	const RefItemVector &	sli,
		const QCString &	key,
		const QCString &	prefix,
		const QCString &	name,
		const QCString &	title,
		const QCString &	args,
		const Definition *	scope
	)

在文件 util.cpp 第 4880 行定义.

 {
   //printf("addRefItem(sli=%d,key=%s,prefix=%s,name=%s,title=%s,args=%s)\n",(int)sli.size(),key,prefix,name,title,args);
   if (!key.isEmpty() && key[0]!='@') // check for @ to skip anonymous stuff (see bug427012)
   {
     for (RefItem *item : sli)
     {
         item->setPrefix(prefix);
         item->setScope(scope);
         item->setName(name);
         item->setTitle(title);
         item->setArgs(args);
         item->setGroup(key);
     }
   }
 }

引用了 QCString::isEmpty().

被这些函数引用 MemberDefImpl::addListReference(), MemberGroup::addListReferences(), NamespaceDefImpl::addListReferences(), GroupDefImpl::addListReferences(), FileDefImpl::addListReferences(), ClassDefImpl::addListReferences(), addListReferences() , 以及 buildPageList().

◆ addRelatedPage()

PageDef* addRelatedPage	(	const QCString &	name,
		const QCString &	ptitle,
		const QCString &	doc,
		const QCString &	fileName,
		int	docLine,
		int	startLine,
		const RefItemVector &	sli = `RefItemVector()`,
		GroupDef *	gd = `0`,
		const TagInfo *	tagInfo = `0`,
		bool	xref = `FALSE`,
		SrcLangExt	lang = `SrcLangExt_Unknown`
	)

在文件 util.cpp 第 4749 行定义.

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

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), SectionManager::add(), GroupDef::addPage(), convertNameToFile(), createPageDef(), Definition::docFile(), FALSE, TagInfo::fileName, SectionInfo::fileName(), LinkedMap< T, Hash, KeyEqual, Map >::find(), PageDef::getOutputFileBase(), GroupDef::getOutputFileBase(), Definition::getReference(), Definition::getStartBodyLine(), PageDef::hasTitle(), Doxygen::htmlFileExtension, SectionManager::instance(), QCString::isEmpty(), Definition::isReference(), QCString::left(), QCString::length(), SectionInfo::lineNr(), Definition::name(), Page, Doxygen::pageLinkedMap, qPrint(), SectionInfo::ref(), SectionManager::replace(), QCString::right(), DefinitionMutable::setBodySegment(), DefinitionMutable::setDocumentation(), PageDef::setFileName(), DefinitionMutable::setLanguage(), PageDef::setNestingLevel(), PageDef::setPageScope(), DefinitionMutable::setReference(), DefinitionMutable::setRefItems(), PageDef::setShowLineNo(), PageDef::setTitle(), SectionInfo::setTitle(), QCString::stripWhiteSpace(), TagInfo::tagName, PageDef::title(), TRUE , 以及 warn().

◆ argListToString()

QCString argListToString	(	const ArgumentList &	al,
		bool	useCanonicalType = `FALSE`,
		bool	showDefVals = `TRUE`
	)

在文件 util.cpp 第 1149 行定义.

 {
   QCString result;
   if (!al.hasParameters()) return result;
   result+="(";
   for (auto it = al.begin() ; it!=al.end() ;)
   {
     Argument a = *it;
     QCString type1 = useCanonicalType && !a.canType.isEmpty() ? a.canType : a.type;
     QCString type2;
     int i=type1.find(")("); // hack to deal with function pointers
     if (i!=-1)
     {
       type2=type1.mid(i);
       type1=type1.left(i);
     }
     if (!a.attrib.isEmpty())
     {
       result+=a.attrib+" ";
     }
     if (!a.name.isEmpty() || !a.array.isEmpty())
     {
       result+= type1+" "+a.name+type2+a.array;
     }
     else
     {
       result+= type1+type2;
     }
     if (!a.defval.isEmpty() && showDefVals)
     {
       result+="="+a.defval;
     }
     ++it;
     if (it!=al.end()) result+=", ";
   }
   result+=")";
   if (al.constSpecifier()) result+=" const";
   if (al.volatileSpecifier()) result+=" volatile";
   if (al.refQualifier()==RefQualifierLValue) result+=" &";
   else if (al.refQualifier()==RefQualifierRValue) result+=" &&";
   if (!al.trailingReturnType().isEmpty()) result+=al.trailingReturnType();
   if (al.pureSpecifier()) result+=" =0";
   return removeRedundantWhiteSpace(result);
 }

引用了 Argument::array, Argument::attrib, ArgumentList::begin(), Argument::canType, ArgumentList::constSpecifier(), Argument::defval, ArgumentList::end(), QCString::find(), ArgumentList::hasParameters(), QCString::isEmpty(), QCString::left(), QCString::mid(), Argument::name, ArgumentList::pureSpecifier(), ArgumentList::refQualifier(), RefQualifierLValue, RefQualifierRValue, removeRedundantWhiteSpace(), ArgumentList::trailingReturnType(), Argument::type , 以及 ArgumentList::volatileSpecifier().

被这些函数引用 addMemberFunction(), DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), findGlobalMember() , 以及 findMember().

◆ checkExtension()

bool checkExtension	(	const QCString &	fName,
		const QCString &	ext
	)

在文件 util.cpp 第 5270 行定义.

 {
   return fName.right(ext.length())==ext;
 }

引用了 QCString::length() , 以及 QCString::right().

被这些函数引用 copyLatexStyleSheet() , 以及 extraLatexStyleSheet().

◆ checkIfTypedef()

bool checkIfTypedef	(	const Definition *	scope,
		const FileDef *	fileScope,
		const QCString &	n
	)

Returns true iff the given name string appears to be a typedef in scope.

在文件 util.cpp 第 5684 行定义.

 {
   MemberDef *bestMatch = getMemberFromSymbol(scope,fileScope,n);
  
   if (bestMatch && bestMatch->isTypedef())
     return TRUE; // closest matching symbol is a typedef
   else
     return FALSE;
 }

引用了 FALSE, getMemberFromSymbol(), MemberDef::isTypedef() , 以及 TRUE.

被这些函数引用 isVarWithConstructor().

◆ clearBlock()

QCString clearBlock	(	const char *	s,
		const char *	begin,
		const char *	end
	)

◆ clearSubDirs()

void clearSubDirs ( const Dir & d )

在文件 util.cpp 第 3704 行定义.

 {
   if (Config_getBool(CREATE_SUBDIRS))
   {
     // remove empty subdirectories
     for (int l1=0;l1<16;l1++)
     {
       QCString subdir;
       subdir.sprintf("d%x",l1);
       for (int l2=0;l2<256;l2++)
       {
         QCString subsubdir;
         subsubdir.sprintf("d%x/d%02x",l1,l2);
         if (d.exists(subsubdir.str()) && d.isEmpty(subsubdir.str()))
         {
           d.rmdir(subsubdir.str());
         }
       }
       if (d.exists(subdir.str()) && d.isEmpty(subdir.str()))
       {
         d.rmdir(subdir.str());
       }
     }
   }
 }

引用了 Config_getBool, Dir::exists(), Dir::isEmpty(), Dir::rmdir(), QCString::sprintf() , 以及 QCString::str().

被这些函数引用 RTFGenerator::cleanup(), ManGenerator::cleanup(), HtmlGenerator::cleanup(), LatexGenerator::cleanup(), DocbookGenerator::cleanup() , 以及 generateXML().

◆ computeQualifiedIndex()

int computeQualifiedIndex ( const QCString & name )

在文件 util.cpp 第 486 行定义.

 {
   int i = name.find('<');
   return name.findRev("::",i==-1 ? name.length() : i);
 }

引用了 QCString::find(), QCString::findRev() , 以及 QCString::length().

被这些函数引用 addToMap(), getMemberFromSymbol() , 以及 SymbolResolver::Private::getResolvedClassRec().

◆ containsWord()

bool containsWord	(	const QCString &	s,
		const char *	word
	)

returns TRUE iff string s contains word w

在文件 util.cpp 第 5335 行定义.

 {
   if (str.isEmpty() || word==0) return false;
   static const reg::Ex re(R"(\a+)");
   std::string s = str.str();
   for (reg::Iterator it(s,re) ; it!=reg::Iterator() ; ++it)
   {
     if (it->str()==word) return true;
   }
   return false;
 }

引用了 QCString::isEmpty() , 以及 QCString::str().

◆ convertCharEntitiesToUTF8()

QCString convertCharEntitiesToUTF8 ( const QCString & s )

在文件 util.cpp 第 4170 行定义.

 {
   if (str.isEmpty()) return QCString();
  
   std::string s = str.data();
   static const reg::Ex re(R"(&\a\w*;)");
   reg::Iterator it(s,re);
   reg::Iterator end;
  
   GrowBuf growBuf;
   size_t p,i=0,l;
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     p = match.position();
     l = match.length();
     if (p>i)
     {
       growBuf.addStr(s.substr(i,p-i));
     }
     QCString entity(match.str());
     DocSymbol::SymType symType = HtmlEntityMapper::instance()->name2sym(entity);
     const char *code=0;
     if (symType!=DocSymbol::Sym_Unknown && (code=HtmlEntityMapper::instance()->utf8(symType)))
     {
       growBuf.addStr(code);
     }
     else
     {
       growBuf.addStr(entity);
     }
     i=p+l;
   }
   growBuf.addStr(s.substr(i));
   growBuf.addChar(0);
   //printf("convertCharEntitiesToUTF8(%s)->%s\n",qPrint(s),growBuf.get());
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), end(), GrowBuf::get(), HtmlEntityMapper::instance(), QCString::isEmpty(), reg::match(), HtmlEntityMapper::name2sym() , 以及 DocSymbol::Sym_Unknown.

被这些函数引用 convertToJSString(), generateXMLForPage(), parseCommentAsText(), HtmlDocVisitor::visitPre(), LatexDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ convertFileNameFortranParserCode()

FortranFormat convertFileNameFortranParserCode ( QCString fn )

在文件 util.cpp 第 7156 行定义.

 {
   QCString ext = getFileNameExtension(fn);
   QCString parserName = Doxygen::parserManager->getParserName(ext);
  
   if (parserName == "fortranfixed") return FortranFormat_Fixed;
   else if (parserName == "fortranfree") return FortranFormat_Free;
  
   return FortranFormat_Unknown;
 }

引用了 FortranFormat_Fixed, FortranFormat_Free, FortranFormat_Unknown, getFileNameExtension(), ParserManager::getParserName() , 以及 Doxygen::parserManager.

◆ convertNameToFile()

QCString convertNameToFile	(	const QCString &	name,
		bool	allowDots,
		bool	allowUnderscore
	)

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.

在文件 util.cpp 第 3604 行定义.

 {
   if (name.isEmpty()) return name;
   static bool shortNames = Config_getBool(SHORT_NAMES);
   static bool createSubdirs = Config_getBool(CREATE_SUBDIRS);
   QCString result;
   if (shortNames) // use short names only
   {
     std::lock_guard<std::mutex> lock(g_usedNamesMutex);
     auto kv = g_usedNames.find(name.str());
     uint num=0;
     if (kv!=g_usedNames.end())
     {
       num = kv->second;
     }
     else
     {
       num = g_usedNamesCount;
       g_usedNames.insert(std::make_pair(name.str(),g_usedNamesCount++));
     }
     result.sprintf("a%05d",num);
   }
   else // long names
   {
     result=escapeCharsInString(name,allowDots,allowUnderscore);
     int resultLen = result.length();
     if (resultLen>=128) // prevent names that cannot be created!
     {
       // third algorithm based on MD5 hash
       uchar md5_sig[16];
       char sigStr[33];
       MD5Buffer((const unsigned char *)result.data(),resultLen,md5_sig);
       MD5SigToString(md5_sig,sigStr);
       result=result.left(128-32)+sigStr;
     }
   }
   if (createSubdirs)
   {
     int l1Dir=0,l2Dir=0;
  
     // compute md5 hash to determine sub directory to use
     uchar md5_sig[16];
     MD5Buffer((const unsigned char *)result.data(),result.length(),md5_sig);
     l1Dir = md5_sig[14]&0xf;
     l2Dir = md5_sig[15];
  
     result.prepend(QCString().sprintf("d%x/d%02x/",l1Dir,l2Dir));
   }
   //printf("*** convertNameToFile(%s)->%s\n",qPrint(name),qPrint(result));
   return result;
 }

引用了 Config_getBool, QCString::data(), escapeCharsInString(), g_usedNames, g_usedNamesCount, g_usedNamesMutex, QCString::isEmpty(), QCString::left(), QCString::length(), QCString::prepend(), QCString::sprintf() , 以及 QCString::str().

◆ convertProtectionLevel()

void convertProtectionLevel	(	MemberListType	inListType,
		Protection	inProt,
		int *	outListType1,
		int *	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.

在文件 util.cpp 第 6851 行定义.

 {
   static bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
   // default representing 1-1 mapping
   *outListType1=inListType;
   *outListType2=-1;
   if (inProt==Public)
   {
     switch (inListType) // in the private section of the derived class,
                         // the private section of the base class should not
                         // be visible
     {
       case MemberListType_priMethods:
       case MemberListType_priStaticMethods:
       case MemberListType_priSlots:
       case MemberListType_priAttribs:
       case MemberListType_priStaticAttribs:
       case MemberListType_priTypes:
         *outListType1=-1;
         *outListType2=-1;
         break;
       default:
         break;
     }
   }
   else if (inProt==Protected) // Protected inheritance
   {
     switch (inListType) // in the protected section of the derived class,
                         // both the public and protected members are shown
                         // as protected
     {
       case MemberListType_pubMethods:
       case MemberListType_pubStaticMethods:
       case MemberListType_pubSlots:
       case MemberListType_pubAttribs:
       case MemberListType_pubStaticAttribs:
       case MemberListType_pubTypes:
       case MemberListType_priMethods:
       case MemberListType_priStaticMethods:
       case MemberListType_priSlots:
       case MemberListType_priAttribs:
       case MemberListType_priStaticAttribs:
       case MemberListType_priTypes:
         *outListType1=-1;
         *outListType2=-1;
         break;
  
       case MemberListType_proMethods:
         *outListType2=MemberListType_pubMethods;
         break;
       case MemberListType_proStaticMethods:
         *outListType2=MemberListType_pubStaticMethods;
         break;
       case MemberListType_proSlots:
         *outListType2=MemberListType_pubSlots;
         break;
       case MemberListType_proAttribs:
         *outListType2=MemberListType_pubAttribs;
         break;
       case MemberListType_proStaticAttribs:
         *outListType2=MemberListType_pubStaticAttribs;
         break;
       case MemberListType_proTypes:
         *outListType2=MemberListType_pubTypes;
         break;
       default:
         break;
     }
   }
   else if (inProt==Private)
   {
     switch (inListType) // in the private section of the derived class,
                         // both the public and protected members are shown
                         // as private
     {
       case MemberListType_pubMethods:
       case MemberListType_pubStaticMethods:
       case MemberListType_pubSlots:
       case MemberListType_pubAttribs:
       case MemberListType_pubStaticAttribs:
       case MemberListType_pubTypes:
       case MemberListType_proMethods:
       case MemberListType_proStaticMethods:
       case MemberListType_proSlots:
       case MemberListType_proAttribs:
       case MemberListType_proStaticAttribs:
       case MemberListType_proTypes:
         *outListType1=-1;
         *outListType2=-1;
         break;
  
       case MemberListType_priMethods:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubMethods;
           *outListType2=MemberListType_proMethods;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       case MemberListType_priStaticMethods:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubStaticMethods;
           *outListType2=MemberListType_proStaticMethods;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       case MemberListType_priSlots:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubSlots;
           *outListType2=MemberListType_proSlots;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       case MemberListType_priAttribs:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubAttribs;
           *outListType2=MemberListType_proAttribs;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       case MemberListType_priStaticAttribs:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubStaticAttribs;
           *outListType2=MemberListType_proStaticAttribs;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       case MemberListType_priTypes:
         if (extractPrivate)
         {
           *outListType1=MemberListType_pubTypes;
           *outListType2=MemberListType_proTypes;
         }
         else
         {
           *outListType1=-1;
           *outListType2=-1;
         }
         break;
       default:
         break;
     }
   }
   //printf("convertProtectionLevel(type=%d prot=%d): %d,%d\n",
   //    inListType,inProt,*outListType1,*outListType2);
 }

引用了 Config_getBool, MemberListType_priAttribs, MemberListType_priMethods, MemberListType_priSlots, MemberListType_priStaticAttribs, MemberListType_priStaticMethods, MemberListType_priTypes, MemberListType_proAttribs, MemberListType_proMethods, MemberListType_proSlots, MemberListType_proStaticAttribs, MemberListType_proStaticMethods, MemberListType_proTypes, MemberListType_pubAttribs, MemberListType_pubMethods, MemberListType_pubSlots, MemberListType_pubStaticAttribs, MemberListType_pubStaticMethods, MemberListType_pubTypes, Private, Protected , 以及 Public.

被这些函数引用 ClassDefImpl::countInheritedDecMembers(), InheritedMemberInfoListContext::Private::findInheritedMembers() , 以及 ClassDefImpl::writeInheritedMemberDeclarations().

◆ convertToDocBook()

QCString convertToDocBook ( const QCString & s )

Converts a string to an DocBook-encoded string

在文件 util.cpp 第 3999 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const unsigned char *q;
   int cnt;
   const unsigned char *p=(const unsigned char *)s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '<':  growBuf.addStr("&lt;");   break;
       case '>':  growBuf.addStr("&gt;");   break;
       case '&':  // possibility to have a special symbol
         q = p;
         cnt = 2; // we have to count & and ; as well
         while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
         {
           cnt++;
           q++;
         }
         if (*q == ';')
         {
            --p; // we need & as well
            DocSymbol::SymType res = HtmlEntityMapper::instance()->name2sym(QCString((char *)p).left(cnt));
            if (res == DocSymbol::Sym_Unknown)
            {
              p++;
              growBuf.addStr("&amp;");
            }
            else
            {
              growBuf.addStr(HtmlEntityMapper::instance()->docbook(res));
              q++;
              p = q;
            }
         }
         else
         {
           growBuf.addStr("&amp;");
         }
         break;
       case '\'': growBuf.addStr("&apos;"); break;
       case '"':  growBuf.addStr("&quot;"); break;
       case  1: case  2: case  3: case  4: case  5: case  6: case 7:  case  8:
       case 11: case 12: case 14: case 15: case 16: case 17: case 18:
       case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26:
       case 27: case 28: case 29: case 30: case 31:
         growBuf.addStr("&#x24");
         growBuf.addChar(hex[static_cast<uchar>(c)>>4]);
         growBuf.addChar(hex[static_cast<uchar>(c)&0xF]);
         growBuf.addChar(';');
         break;
       default:
         growBuf.addChar(c);
         break;
     }
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), GrowBuf::get(), hex, HtmlEntityMapper::instance(), QCString::isEmpty(), HtmlEntityMapper::name2sym() , 以及 DocSymbol::Sym_Unknown.

被这些函数引用 addIndexTerm(), DocbookGenerator::docify(), DocbookDocVisitor::filter(), DocbookGenerator::startDescTable(), DocbookGenerator::startIndexSection(), DocbookGenerator::startMemberDoc(), DocbookGenerator::startMemberDocSimple(), DocbookDocVisitor::visitPre(), DocbookDocVisitor::visitPreStart(), writeDocbookString(), DocbookGenerator::writePageLink() , 以及 DefinitionImpl::writeToc().

◆ convertToHtml()

QCString convertToHtml	(	const QCString &	s,
		bool	keepEntities
	)

Converts a string to a HTML-encoded string

在文件 util.cpp 第 4063 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const char *p=s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '<':  growBuf.addStr("&lt;");   break;
       case '>':  growBuf.addStr("&gt;");   break;
       case '&':  if (keepEntities)
                  {
                    const char *e=p;
                    char ce;
                    while ((ce=*e++))
                    {
                      if (ce==';' || (!(isId(ce) || ce=='#'))) break;
                    }
                    if (ce==';') // found end of an entity
                    {
                      // copy entry verbatim
                      growBuf.addChar(c);
                      while (p<e) growBuf.addChar(*p++);
                    }
                    else
                    {
                      growBuf.addStr("&amp;");
                    }
                  }
                  else
                  {
                    growBuf.addStr("&amp;");
                  }
                  break;
       case '\'': growBuf.addStr("&#39;");  break;
       case '"':  growBuf.addStr("&quot;"); break;
       default:
         {
           uchar uc = static_cast<uchar>(c);
           if (uc<32 && !isspace(c))
           {
             growBuf.addStr("&#x24");
             growBuf.addChar(hex[uc>>4]);
             growBuf.addChar(hex[uc&0xF]);
             growBuf.addChar(';');
           }
           else
           {
             growBuf.addChar(c);
           }
         }
         break;
     }
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), GrowBuf::get(), hex, QCString::isEmpty(), isId() , 以及 reg::isspace().

被这些函数引用 HtmlCodeGenerator::_writeCodeLink(), HtmlHelp::addContentsItem(), FilterEscape::apply(), HtmlEscaper::escape(), FTVHelp::generateLink(), ClassContext::Private::inheritanceDiagram(), DefinitionImpl::navigationPathAsString(), HtmlGenerator::startFile(), HtmlDocVisitor::startLink(), substituteHtmlKeywords(), HtmlDocVisitor::visit(), HtmlDocVisitor::visitPre(), HtmlHelpIndex::writeFields(), HtmlGenerator::writeInheritedSectionTitle(), TextGeneratorHtml::writeLink(), writeMapArea(), HtmlGenerator::writePageFooter(), NamespaceDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), ClassDefImpl::writeQuickMemberLinks(), HtmlGenerator::writeSearchPage(), TextGeneratorHtml::writeString() , 以及 DefinitionImpl::writeToc().

◆ convertToId()

QCString convertToId ( const QCString & s )

Converts a string to a HTML id string

在文件 util.cpp 第 3908 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const char *p=s.data();
   char c;
   bool first=TRUE;
   while ((c=*p++))
   {
     char encChar[4];
     if ((c>='0' && c<='9') || (c>='a' && c<='z') || (c>='A' && c<='Z') || c=='-' || c==':' || c=='.')
     { // any permissive character except _
       if (first && c>='0' && c<='9') growBuf.addChar('a'); // don't start with a digit
       growBuf.addChar(c);
     }
     else
     {
       encChar[0]='_';
       encChar[1]=hex[((unsigned char)c)>>4];
       encChar[2]=hex[((unsigned char)c)&0xF];
       encChar[3]=0;
       growBuf.addStr(encChar);
     }
     first=FALSE;
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), FALSE, GrowBuf::get(), hex, QCString::isEmpty() , 以及 TRUE.

被这些函数引用 HtmlGenerator::endClassDiagram(), ClassContext::Private::inheritanceDiagram(), renderMemberIndicesAsJs(), writeMemberList(), writeQuickMemberIndex(), ClassDefImpl::writeSummaryLinks() , 以及 VhdlDocGen::writeVHDLDeclarations().

◆ convertToJSString()

QCString convertToJSString ( const QCString & s )

在文件 util.cpp 第 4123 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const char *p=s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '"':  growBuf.addStr("\\\""); break;
       case '\\': growBuf.addStr("\\\\"); break;
       default:   growBuf.addChar(c);   break;
     }
   }
   growBuf.addChar(0);
   return convertCharEntitiesToUTF8(growBuf.get());
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), convertCharEntitiesToUTF8(), QCString::data(), GrowBuf::get() , 以及 QCString::isEmpty().

被这些函数引用 generateJSLink(), generateJSNavTree(), renderMemberIndicesAsJs() , 以及 renderQuickLinksAsJs().

◆ convertToLaTeX()

QCString convertToLaTeX	(	const QCString &	s,
		bool	insideTabbing = `FALSE`,
		bool	keepSpaces = `FALSE`
	)

在文件 util.cpp 第 4161 行定义.

 {
   TextStream t;
   filterLatexString(t,s,insideTabbing,false,false,false,keepSpaces);
   return t.str();
 }

引用了 filterLatexString() , 以及 TextStream::str().

被这些函数引用 LatexGenerator::endIndexSection(), LatexEscaper::escape(), LatexGenerator::startIndexSection(), substituteLatexKeywords() , 以及 TextGeneratorLatex::writeString().

◆ convertToPSString()

QCString convertToPSString ( const QCString & s )

在文件 util.cpp 第 4142 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const char *p=s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '(':  growBuf.addStr("\\("); break;
       case ')': growBuf.addStr("\\)"); break;
       default:   growBuf.addChar(c);   break;
     }
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), GrowBuf::get() , 以及 QCString::isEmpty().

被这些函数引用 ClassDiagram::writeFigure() , 以及 writeVectorBox().

◆ convertToXML()

QCString convertToXML	(	const QCString &	s,
		bool	keepEntities
	)

Converts a string to an XML-encoded string

在文件 util.cpp 第 3948 行定义.

 {
   if (s.isEmpty()) return s;
   GrowBuf growBuf;
   const char *p=s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '<':  growBuf.addStr("&lt;");   break;
       case '>':  growBuf.addStr("&gt;");   break;
       case '&':  if (keepEntities)
                  {
                    const char *e=p;
                    char ce;
                    while ((ce=*e++))
                    {
                      if (ce==';' || (!(isId(ce) || ce=='#'))) break;
                    }
                    if (ce==';') // found end of an entity
                    {
                      // copy entry verbatim
                      growBuf.addChar(c);
                      while (p<e) growBuf.addChar(*p++);
                    }
                    else
                    {
                      growBuf.addStr("&amp;");
                    }
                  }
                  else
                  {
                    growBuf.addStr("&amp;");
                  }
                  break;
       case '\'': growBuf.addStr("&apos;"); break;
       case '"':  growBuf.addStr("&quot;"); break;
       case  1: case  2: case  3: case  4: case  5: case  6: case  7: case  8:
       case 11: case 12: case 13: case 14: case 15: case 16: case 17: case 18:
       case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26:
       case 27: case 28: case 29: case 30: case 31:
         break; // skip invalid XML characters (see http://www.w3.org/TR/2000/REC-xml-20001006#NT-Char)
       default:   growBuf.addChar(c);       break;
     }
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), QCString::data(), GrowBuf::get(), QCString::isEmpty() , 以及 isId().

◆ copyFile()

bool copyFile	(	const QCString &	src,
		const QCString &	dest
	)

Copies the contents of file with name src to the newly created file with name dest.

Returns TRUE if successful.

在文件 util.cpp 第 6439 行定义.

 {
   if (!Dir().copy(src.str(),dest.str()))
   {
     err("could not copy file %s to %s\n",qPrint(src),qPrint(dest));
     return false;
   }
   return true;
 }

引用了 err(), qPrint() , 以及 QCString::str().

被这些函数引用 copyExtraFiles(), copyLatexStyleSheet(), copyLogo(), copyStyleSheet(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), CitationManager::generatePage(), substituteLatexKeywords(), DocbookDocVisitor::visitPost() , 以及 XmlDocVisitor::visitPre().

◆ correctId()

QCString correctId ( const QCString & s )

Some strings have been corrected but the requirement regarding the fact that an id cannot have a digit at the first position. To overcome problems with double labels we always place an "a" in front

在文件 util.cpp 第 3941 行定义.

 {
   if (s.isEmpty()) return s;
   return "a" + s;
 }

引用了 QCString::isEmpty().

被这些函数引用 DotGraph::generateCode() , 以及 DotFilePatcher::run().

◆ correctURL()

QCString correctURL	(	const QCString &	url,
		const QCString &	relPath
	)

Corrects URL url according to the relative path relPath.

Returns the corrected URL. For absolute URLs no correction will be done.

在文件 util.cpp 第 6573 行定义.

 {
   QCString result = url;
   if (!relPath.isEmpty() && !isURL(url))
   {
     result.prepend(relPath);
   }
   return result;
 }

引用了 QCString::isEmpty(), isURL() , 以及 QCString::prepend().

被这些函数引用 startQuickIndexItem(), HtmlDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 writeIndexHierarchyEntries().

◆ countAliasArguments()

int countAliasArguments ( const QCString & argList )

在文件 util.cpp 第 6001 行定义.

 {
   int count=1;
   int l = argList.length();
   int i;
   for (i=0;i<l;i++)
   {
     char c = argList.at(i);
     if (c==',' && (i==0 || argList.at(i-1)!='\\')) count++;
     else if (c=='@' || c=='\\')
     {
       // check if this is the start of another aliased command (see bug704172)
       i+=findEndOfCommand(argList.data()+i+1);
     }
   }
   //printf("countAliasArguments=%d\n",count);
   return count;
 }

引用了 QCString::at(), QCString::data(), findEndOfCommand() , 以及 QCString::length().

被这些函数引用 expandAliasRec().

◆ createSubDirs()

void createSubDirs ( const Dir & d )

在文件 util.cpp 第 3677 行定义.

 {
   if (Config_getBool(CREATE_SUBDIRS))
   {
     // create 4096 subdirectories
     int l1,l2;
     for (l1=0;l1<16;l1++)
     {
       QCString subdir;
       subdir.sprintf("d%x",l1);
       if (!d.exists(subdir.str()) && !d.mkdir(subdir.str()))
       {
         term("Failed to create output directory '%s'\n",qPrint(subdir));
       }
       for (l2=0;l2<256;l2++)
       {
         QCString subsubdir;
         subsubdir.sprintf("d%x/d%02x",l1,l2);
         if (!d.exists(subsubdir.str()) && !d.mkdir(subsubdir.str()))
         {
           term("Failed to create output directory '%s'\n",qPrint(subsubdir));
         }
       }
     }
   }
 }

引用了 Config_getBool, Dir::exists(), Dir::mkdir(), qPrint(), QCString::sprintf(), QCString::str() , 以及 term().

被这些函数引用 generateOutputViaTemplate(), generateXML(), RTFGenerator::init(), ManGenerator::init(), HtmlGenerator::init(), LatexGenerator::init(), DocbookGenerator::init(), NamespaceDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks() , 以及 ClassDefImpl::writeQuickMemberLinks().

◆ dateToString()

QCString dateToString ( bool )

在文件 util.cpp 第 1470 行定义.

 {
   auto current = getCurrentDateTime();
   return theTranslator->trDateTime(current.tm_year + 1900,
                                    current.tm_mon + 1,
                                    current.tm_mday,
                                    (current.tm_wday+6)%7+1, // map: Sun=0..Sat=6 to Mon=1..Sun=7
                                    current.tm_hour,
                                    current.tm_min,
                                    current.tm_sec,
                                    includeTime);
 }

引用了 getCurrentDateTime(), theTranslator , 以及 Translator::trDateTime().

被这些函数引用 DoxygenContext::Private::date(), RTFGenerator::endIndexSection(), ManGenerator::endTitleHead(), substituteHtmlKeywords(), substituteKeywords(), substituteLatexKeywords() , 以及 HtmlGenerator::writeLogoAsString().

◆ escapeCharsInString()

QCString escapeCharsInString	(	const QCString &	name,
		bool	allowDots,
		bool	allowUnderscore = `FALSE`
	)

在文件 util.cpp 第 3442 行定义.

 {
   if (name.isEmpty()) return name;
   bool caseSenseNames = Config_getBool(CASE_SENSE_NAMES);
   bool allowUnicodeNames = Config_getBool(ALLOW_UNICODE_NAMES);
   GrowBuf growBuf;
   signed char c;
   const char *p=name.data();
   while ((c=*p++)!=0)
   {
     switch(c)
     {
       case '_': if (allowUnderscore) growBuf.addChar('_'); else growBuf.addStr("__"); break;
       case '-': growBuf.addChar('-');  break;
       case ':': growBuf.addStr("_1"); break;
       case '/': growBuf.addStr("_2"); break;
       case '<': growBuf.addStr("_3"); break;
       case '>': growBuf.addStr("_4"); break;
       case '*': growBuf.addStr("_5"); break;
       case '&': growBuf.addStr("_6"); break;
       case '|': growBuf.addStr("_7"); break;
       case '.': if (allowDots) growBuf.addChar('.'); else growBuf.addStr("_8"); break;
       case '!': growBuf.addStr("_9"); break;
       case ',': growBuf.addStr("_00"); break;
       case ' ': growBuf.addStr("_01"); break;
       case '{': growBuf.addStr("_02"); break;
       case '}': growBuf.addStr("_03"); break;
       case '?': growBuf.addStr("_04"); break;
       case '^': growBuf.addStr("_05"); break;
       case '%': growBuf.addStr("_06"); break;
       case '(': growBuf.addStr("_07"); break;
       case ')': growBuf.addStr("_08"); break;
       case '+': growBuf.addStr("_09"); break;
       case '=': growBuf.addStr("_0a"); break;
       case '$': growBuf.addStr("_0b"); break;
       case '\\': growBuf.addStr("_0c"); break;
       case '@': growBuf.addStr("_0d"); break;
       case ']': growBuf.addStr("_0e"); break;
       case '[': growBuf.addStr("_0f"); break;
       case '#': growBuf.addStr("_0g"); break;
       default:
                 if (c<0)
                 {
                   bool doEscape = true;
                   if (allowUnicodeNames)
                   {
                     int charLen = getUTF8CharNumBytes(c);
                     if (charLen>0)
                     {
                       growBuf.addStr(p-1,charLen);
                       p+=charLen;
                       doEscape = false;
                     }
                   }
                   if (doEscape) // not a valid unicode char or escaping needed
                   {
                     char ids[5];
                     unsigned char id = (unsigned char)c;
                     ids[0]='_';
                     ids[1]='x';
                     ids[2]=hex[id>>4];
                     ids[3]=hex[id&0xF];
                     ids[4]=0;
                     growBuf.addStr(ids);
                   }
                 }
                 else if (caseSenseNames || !isupper(c))
                 {
                   growBuf.addChar(c);
                 }
                 else
                 {
                   growBuf.addChar('_');
                   growBuf.addChar((char)tolower(c));
                 }
                 break;
     }
   }
   growBuf.addChar(0);
   return growBuf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), Config_getBool, QCString::data(), GrowBuf::get(), getUTF8CharNumBytes(), hex , 以及 QCString::isEmpty().

被这些函数引用 convertNameToFile(), DotGroupCollaboration::getMapLabel(), DotGfxHierarchyTable::getMapLabel(), DotInclDepGraph::getMapLabel(), DotClassGraph::getMapLabel(), DotDirDeps::getMapLabel() , 以及 PageDefImpl::writeDocumentation().

◆ expandAlias()

std::string expandAlias	(	const std::string &	aliasName,
		const std::string &	aliasValue
	)

在文件 util.cpp 第 6060 行定义.

 {
   QCString result;
   StringUnorderedSet aliasesProcessed;
   // avoid expanding this command recursively
   aliasesProcessed.insert(aliasName);
   // expand embedded commands
   //printf("Expanding: '%s'->'%s'\n",qPrint(aliasName),qPrint(aliasValue));
   result = expandAliasRec(aliasesProcessed,aliasValue.c_str());
   //printf("Expanding result: '%s'->'%s'\n",qPrint(aliasName),qPrint(result));
   return result.str();
 }

引用了 expandAliasRec(), QCString::insert() , 以及 QCString::str().

被这些函数引用 expandAliases().

◆ externalLinkTarget()

QCString externalLinkTarget ( const bool parent = false )

在文件 util.cpp 第 6323 行定义.

 {
   static bool extLinksInWindow = Config_getBool(EXT_LINKS_IN_WINDOW);
   if (extLinksInWindow)
     return "target=\"_blank\" ";
   else if (parent)
     return "target=\"_parent\" ";
   else
     return "";
 }

引用了 Config_getBool.

被这些函数引用 HtmlCodeGenerator::_writeCodeLink(), FTVHelp::generateLink(), Markdown::processLink(), replaceRef(), HtmlGenerator::startIndexItem(), HtmlDocVisitor::startLink(), HtmlGenerator::writeInheritedSectionTitle(), TextGeneratorHtml::writeLink(), writeMapArea() , 以及 HtmlGenerator::writeObjectLink().

◆ externalRef()

QCString externalRef	(	const QCString &	relPath,
		const QCString &	ref,
		bool	href
	)

在文件 util.cpp 第 6334 行定义.

 {
   QCString result;
   if (!ref.isEmpty())
   {
     auto it = Doxygen::tagDestinationMap.find(ref.str());
     if (it!=Doxygen::tagDestinationMap.end())
     {
       result = it->second;
       int l = result.length();
       if (!relPath.isEmpty() && l>0 && result.at(0)=='.')
       { // relative path -> prepend relPath.
         result.prepend(relPath);
         l+=relPath.length();
       }
       if (l>0 && result.at(l-1)!='/') result+='/';
       if (!href) result.append("\" ");
     }
   }
   else
   {
     result = relPath;
   }
   return result;
 }

引用了 QCString::append(), QCString::at(), end(), QCString::isEmpty(), QCString::length(), QCString::prepend(), QCString::str() , 以及 Doxygen::tagDestinationMap.

被这些函数引用 HtmlCodeGenerator::_writeCodeLink(), convertMapFile(), generateJSLink(), FTVHelp::generateLink(), SymbolContext::Private::relPath(), replaceRef(), HtmlGenerator::startIndexItem(), HtmlDocVisitor::startLink(), HtmlGenerator::writeInheritedSectionTitle(), writeJavaScriptSearchIndex(), TextGeneratorHtml::writeLink(), writeMapArea(), HtmlGenerator::writeObjectLink() , 以及 HtmlCodeGenerator::writeTooltip().

◆ extractAliasArgs()

QCString extractAliasArgs	(	const QCString &	args,
		size_t	pos
	)

在文件 util.cpp 第 6020 行定义.

 {
   size_t i;
   int bc=0;
   char prevChar=0;
   if (args.at(pos)=='{') // alias has argument
   {
     for (i=pos;i<args.length();i++)
     {
       if (prevChar!='\\')
       {
         if (args.at(i)=='{') bc++;
         if (args.at(i)=='}') bc--;
         prevChar=args.at(i);
       }
       else
       {
         prevChar=0;
       }
  
       if (bc==0)
       {
         //printf("extractAliasArgs('%s')->'%s'\n",qPrint(args),qPrint(args.mid(pos+1,i-pos-1)));
         return args.mid(pos+1,i-pos-1);
       }
     }
   }
   return "";
 }

引用了 QCString::at(), QCString::length() , 以及 QCString::mid().

被这些函数引用 expandAliasRec() , 以及 findEndOfCommand().

◆ extractBlock()

QCString extractBlock	(	const QCString &	text,
		const QCString &	marker
	)

Returns the section of text, in between a pair of markers.

Full lines are returned, excluding the lines on which the markers appear.

参见: routine lineBlock

在文件 util.cpp 第 6453 行定义.

 {
   QCString result;
   int p=0,i;
   bool found=FALSE;
  
   // find the character positions of the markers
   int m1 = text.find(marker);
   if (m1==-1) return result;
   int m2 = text.find(marker,m1+marker.length());
   if (m2==-1) return result;
  
   // find start and end line positions for the markers
   int l1=-1,l2=-1;
   while (!found && (i=text.find('\n',p))!=-1)
   {
     found = (p<=m1 && m1<i); // found the line with the start marker
     p=i+1;
   }
   l1=p;
   int lp=i;
   if (found)
   {
     while ((i=text.find('\n',p))!=-1)
     {
       if (p<=m2 && m2<i) // found the line with the end marker
       {
         l2=p;
         break;
       }
       p=i+1;
       lp=i;
     }
   }
   if (l2==-1) // marker at last line without newline (see bug706874)
   {
     l2=lp;
   }
   //printf("text=[%s]\n",qPrint(text.mid(l1,l2-l1)));
   return l2>l1 ? text.mid(l1,l2-l1) : QCString();
 }

引用了 FALSE, QCString::find(), QCString::length() , 以及 QCString::mid().

被这些函数引用 DocPara::handleInclude(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

◆ extractClassNameFromType()

int extractClassNameFromType	(	const QCString &	type,
		int &	pos,
		QCString &	name,
		QCString &	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.

在文件 util.cpp 第 4338 行定义.

 {
   static reg::Ex re_norm(R"(\a[\w:]*)");
   static reg::Ex re_fortran(R"(\a[\w:()=]*)");
   static const reg::Ex *re = &re_norm;
  
   name.resize(0);
   templSpec.resize(0);
   if (type.isEmpty()) return -1;
   int typeLen=(int)type.length();
   if (typeLen>0)
   {
     if (lang == SrcLangExt_Fortran)
     {
       if (type[pos]==',') return -1;
       if (QCString(type).left(4).lower()!="type")
       {
         re = &re_fortran;
       }
     }
     std::string s = type.str();
     reg::Iterator it(s,*re,(int)pos);
     reg::Iterator end;
  
     if (it!=end)
     {
       const auto &match = *it;
       int i = (int)match.position();
       int l = (int)match.length();
       int ts = i+l;
       int te = ts;
       int tl = 0;
  
       while (ts<typeLen && type[ts]==' ') ts++,tl++; // skip any whitespace
       if (ts<typeLen && type[ts]=='<') // assume template instance
       {
         // locate end of template
         te=ts+1;
         int brCount=1;
         while (te<typeLen && brCount!=0)
         {
           if (type[te]=='<')
           {
             if (te<typeLen-1 && type[te+1]=='<') te++; else brCount++;
           }
           if (type[te]=='>')
           {
             if (te<typeLen-1 && type[te+1]=='>') te++; else brCount--;
           }
           te++;
         }
       }
       name = match.str();
       if (te>ts)
       {
         templSpec = QCString(type).mid(ts,te-ts);
         tl+=te-ts;
         pos=i+l+tl;
       }
       else // no template part
       {
         pos=i+l;
       }
       //printf("extractClassNameFromType([in] type=%s,[out] pos=%d,[out] name=%s,[out] templ=%s)=TRUE i=%d\n",
       //    type,pos,qPrint(name),qPrint(templSpec),i);
       return i;
     }
   }
   pos = typeLen;
   //printf("extractClassNameFromType([in] type=%s,[out] pos=%d,[out] name=%s,[out] templ=%s)=FALSE\n",
   //       type,pos,qPrint(name),qPrint(templSpec));
   return -1;
 }

引用了 end(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::lower(), reg::match(), QCString::mid(), QCString::resize(), SrcLangExt_Fortran , 以及 QCString::str().

被这些函数引用 extractCanonicalType() , 以及 findUsedClassesForClass().

◆ extractDirection()

QCString extractDirection ( QCString & docs )

Strip the direction part from docs and return it as a string in canonical form The input docs string can start with e.g.

"[in]", "[in, out]", "[inout]", "[out,in]"...

返回: either "[in,out]", "[in]", or "[out]" or the empty string.

在文件 util.cpp 第 6801 行定义.

 {
   std::string s = docs.str();
   static const reg::Ex re(R"(\[([ inout,]+)\])");
   reg::Iterator it(s,re);
   reg::Iterator end;
   if (it!=end)
   {
     const auto &match = *it;
     size_t p = match.position();
     size_t l = match.length();
     if (p==0 && l>2)
     {
       // make dir the part inside [...] without separators
       std::string dir = match[1].str();
       // strip , and ' ' from dir
       dir.erase(std::remove_if(dir.begin(),dir.end(),
                                [](const char c) { return c==' ' || c==','; }
                               ),dir.end());
       size_t inIndex, outIndex;
       unsigned char ioMask=0;
       if (( inIndex=dir.find( "in"))!=std::string::npos) dir.erase( inIndex,2),ioMask|=(1<<0);
       if ((outIndex=dir.find("out"))!=std::string::npos) dir.erase(outIndex,3),ioMask|=(1<<1);
       if (dir.empty() && ioMask!=0) // only in and/or out attributes found
       {
         docs = s.substr(l); // strip attributes
         if (ioMask==((1<<0)|(1<<1))) return "[in,out]";
         else if (ioMask==(1<<0))     return "[in]";
         else if (ioMask==(1<<1))     return "[out]";
       }
     }
   }
   return "";
 }

引用了 end(), reg::match() , 以及 QCString::str().

被这些函数引用 MemberContext::Private::createParamDocs() , 以及 MemberDefImpl::writeDocumentation().

◆ extractNamespaceName()

void extractNamespaceName	(	const QCString &	scopeName,
		QCString &	className,
		QCString &	namespaceName,
		bool	allowEmptyClass
	)

Input is a scopeName, output is the scopename split into a namespace part (as large as possible) and a classname part.

在文件 util.cpp 第 3733 行定义.

 {
   int i,p;
   QCString clName=scopeName;
   NamespaceDef *nd = 0;
   if (!clName.isEmpty() && (nd=getResolvedNamespace(clName)) && getClass(clName)==0)
   { // the whole name is a namespace (and not a class)
     namespaceName=nd->name();
     className.resize(0);
     goto done;
   }
   p=clName.length()-2;
   while (p>=0 && (i=clName.findRev("::",p))!=-1)
     // see if the first part is a namespace (and not a class)
   {
     //printf("Trying %s\n",qPrint(clName.left(i)));
     if (i>0 && (nd=getResolvedNamespace(clName.left(i))) && getClass(clName.left(i))==0)
     {
       //printf("found!\n");
       namespaceName=nd->name();
       className=clName.right(clName.length()-i-2);
       goto done;
     }
     p=i-2; // try a smaller piece of the scope
   }
   //printf("not found!\n");
  
   // not found, so we just have to guess.
   className=scopeName;
   namespaceName.resize(0);
  
 done:
   if (className.isEmpty() && !namespaceName.isEmpty() && !allowEmptyClass)
   {
     // class and namespace with the same name, correct to return the class.
     className=namespaceName;
     namespaceName.resize(0);
   }
   //printf("extractNamespace '%s' => '%s|%s'\n",qPrint(scopeName),
   //       qPrint(className),qPrint(namespaceName));
   if (/*className.right(2)=="-g" ||*/ className.right(2)=="-p")
   {
     className = className.left(className.length()-2);
   }
   return;
 }

引用了 QCString::findRev(), getClass(), getResolvedNamespace(), QCString::isEmpty(), QCString::left(), QCString::length(), Definition::name(), QCString::resize() , 以及 QCString::right().

被这些函数引用 addClassToContext(), addConceptToContext(), findMember() , 以及 writeAlphabeticalClassList().

◆ fileToString()

QCString fileToString	(	const QCString &	name,
		bool	filter,
		bool	isSourceCode
	)

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.

在文件 util.cpp 第 1394 行定义.

 {
   if (name.isEmpty()) return QCString();
   bool fileOpened=false;
   if (name[0]=='-' && name[1]==0) // read from stdin
   {
     fileOpened=true;
     std::string contents;
     std::string line;
     while (getline(std::cin,line))
     {
       contents+=line+'\n';
     }
     return QCString(contents);
   }
   else // read from file
   {
     FileInfo fi(name.str());
     if (!fi.exists() || !fi.isFile())
     {
       err("file '%s' not found\n",qPrint(name));
       return "";
     }
     BufStr buf((uint)fi.size());
     fileOpened=readInputFile(name,buf,filter,isSourceCode);
     if (fileOpened)
     {
       int s = buf.size();
       if (s>1 && buf.at(s-2)!='\n')
       {
         buf.at(s-1)='\n';
         buf.addChar(0);
       }
       return buf.data();
     }
   }
   if (!fileOpened)
   {
     err("cannot open file '%s' for reading\n",qPrint(name));
   }
   return "";
 }

引用了 BufStr::addChar(), BufStr::at(), BufStr::data(), err(), FileInfo::exists(), QCString::isEmpty(), FileInfo::isFile(), qPrint(), readInputFile(), FileInfo::size(), BufStr::size() , 以及 QCString::str().

被这些函数引用 DoxygenContext::Private::createMathJaxCodeFile(), FormulaManager::generateImages(), getConvertLatexMacro(), HtmlGenerator::init(), LatexGenerator::init(), LayoutDocManager::parse(), parseCode(), FileDefImpl::parseSource(), parseTagFile(), DocParser::readTextFileByName(), runPlantumlContent(), FileDefImpl::writeSourceBody(), HtmlGenerator::writeStyleInfo() , 以及 writeXMLCodeBlock().

◆ fileVisibleInIndex()

bool fileVisibleInIndex	(	const FileDef *	fd,
		bool &	genSourceFile
	)

在文件 util.cpp 第 6712 行定义.

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

引用了 Config_getBool, FileDef::generateSourceFile(), FileDef::isDocumentationFile(), FileDef::isLinkable() , 以及 FileDef::isLinkableInProject().

被这些函数引用 countFiles(), dirHasVisibleChildren(), generateJSTree(), writeDirHierarchy() , 以及 writeDirTreeNode().

◆ filterLatexString()

void filterLatexString	(	TextStream &	t,
		const QCString &	str,
		bool	insideTabbing,
		bool	insidePre,
		bool	insideItem,
		bool	insideTable,
		bool	keepSpaces
	)

在文件 util.cpp 第 4934 行定义.

 {
   if (str.isEmpty()) return;
   //if (strlen(str)<2) stackTrace();
   const unsigned char *p=(const unsigned char *)str.data();
   const unsigned char *q;
   int cnt;
   unsigned char c;
   unsigned char pc='\0';
   while (*p)
   {
     c=*p++;
  
     if (insidePre)
     {
       switch(c)
       {
         case 0xef: // handle U+FFFD i.e. "Replacement character" caused by octal: 357 277 275 / hexadecimal 0xef 0xbf 0xbd
                    // the LaTeX command \ucr has been defined in doxygen.sty
           if ((unsigned char)*(p) == 0xbf && (unsigned char)*(p+1) == 0xbd)
           {
             t << "{\\ucr}";
             p += 2;
           }
           else
             t << (char)c;
           break;
         case '\\': t << "\\(\\backslash\\)"; break;
         case '{':  t << "\\{"; break;
         case '}':  t << "\\}"; break;
         case '_':  t << "\\_"; break;
         case '&':  t << "\\&"; break;
         case '%':  t << "\\%"; break;
         case '#':  t << "\\#"; break;
         case '$':  t << "\\$"; break;
         case '"':  t << "\"{}"; break;
         case '-':  t << "-\\/"; break;
         case '^':  insideTable ? t << "\\string^" : t << (char)c;    break;
         case '~':  t << "\\string~";    break;
         case ' ':  if (keepSpaces) t << "~"; else t << ' ';
                    break;
         default:
                    if (c<32) t << ' '; // non printable control character
                    else t << (char)c;
                    break;
       }
     }
     else
     {
       switch(c)
       {
         case 0xef: // handle U+FFFD i.e. "Replacement character" caused by octal: 357 277 275 / hexadecimal 0xef 0xbf 0xbd
                    // the LaTeX command \ucr has been defined in doxygen.sty
           if ((unsigned char)*(p) == 0xbf && (unsigned char)*(p+1) == 0xbd)
           {
             t << "{\\ucr}";
             p += 2;
           }
           else
             t << (char)c;
           break;
         case '#':  t << "\\#";           break;
         case '$':  t << "\\$";           break;
         case '%':  t << "\\%";           break;
         case '^':  t << "$^\\wedge$";    break;
         case '&':  // possibility to have a special symbol
                    q = p;
                    cnt = 2; // we have to count & and ; as well
                    while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
                    {
                      cnt++;
                      q++;
                    }
                    if (*q == ';')
                    {
                       --p; // we need & as well
                       DocSymbol::SymType res = HtmlEntityMapper::instance()->name2sym(QCString((char *)p).left(cnt));
                       if (res == DocSymbol::Sym_Unknown)
                       {
                         p++;
                         t << "\\&";
                       }
                       else
                       {
                         t << HtmlEntityMapper::instance()->latex(res);
                         q++;
                         p = q;
                       }
                    }
                    else
                    {
                      t << "\\&";
                    }
                    break;
         case '*':  t << "$\\ast$";       break;
         case '_':  if (!insideTabbing) t << "\\+";
                    t << "\\_";
                    if (!insideTabbing) t << "\\+";
                    break;
         case '{':  t << "\\{";           break;
         case '}':  t << "\\}";           break;
         case '<':  t << "$<$";           break;
         case '>':  t << "$>$";           break;
         case '|':  t << "$\\vert$";      break;
         case '~':  t << "$\\sim$";       break;
         case '[':  if (Config_getBool(PDF_HYPERLINKS) || insideItem)
                      t << "\\mbox{[}";
                    else
                      t << "[";
                    break;
         case ']':  if (pc=='[') t << "$\\,$";
                      if (Config_getBool(PDF_HYPERLINKS) || insideItem)
                        t << "\\mbox{]}";
                      else
                        t << "]";
                    break;
         case '-':  t << "-\\/";
                    break;
         case '\\': t << "\\textbackslash{}";
                    break;
         case '"':  t << "\\char`\\\"{}";
                    break;
         case '`':  t << "\\`{}";
                    break;
         case '\'': t << "\\textquotesingle{}";
                    break;
         case ' ':  if (keepSpaces) { if (insideTabbing) t << "\\>"; else t << '~'; } else t << ' ';
                    break;
  
         default:
                    //if (!insideTabbing && forceBreaks && c!=' ' && *p!=' ')
                    if (!insideTabbing &&
                        ((c>='A' && c<='Z' && pc!=' ' && !(pc>='A' && pc <= 'Z') && pc!='\0' && *p) || (c==':' && pc!=':') || (pc=='.' && isId(c)))
                       )
                    {
                      t << "\\+";
                    }
                    if (c<32)
                    {
                      t << ' '; // non-printable control character
                    }
                    else
                    {
                      t << (char)c;
                    }
       }
     }
     pc = c;
   }
 }

引用了 Config_getBool, QCString::data(), insideTable(), HtmlEntityMapper::instance(), QCString::isEmpty(), isId(), HtmlEntityMapper::latex(), HtmlEntityMapper::name2sym() , 以及 DocSymbol::Sym_Unknown.

被这些函数引用 LatexCodeGenerator::codify(), convertToLaTeX(), LatexGenerator::docify(), LatexDocVisitor::filter(), latexEscapeIndexChars(), latexEscapeLabelName(), substituteLatexKeywords() , 以及 TextGeneratorLatex::writeLink().

◆ filterTitle()

QCString filterTitle ( const QCString & title )

在文件 util.cpp 第 6254 行定义.

 {
   std::string tf;
   std::string t = title.str();
   static const reg::Ex re(R"(%[a-z_A-Z]+)");
   reg::Iterator it(t,re);
   reg::Iterator end;
   size_t p = 0;
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     size_t i = match.position();
     size_t l = match.length();
     if (i>p) tf+=t.substr(p,i-p);
     tf+=match.str().substr(1); // skip %
     p=i+l;
   }
   tf+=t.substr(p);
   return QCString(tf);
 }

引用了 end(), reg::match() , 以及 QCString::str().

被这些函数引用 addToIndices(), PerlModGenerator::generatePerlModForPage(), generateXMLForPage(), mainPageHasOwnTitle(), HtmlGenerator::startFile(), writeExampleIndex(), writeIndex() , 以及 writePages().

◆ findAndRemoveWord()

bool findAndRemoveWord	(	QCString &	sentence,
		const char *	word
	)

removes occurrences of whole word from sentence, while keeps internal spaces and reducing multiple sequences of spaces.

Example: sentence=cat+ catfish cat cat concat cat, word=cat returns: + catfish concat

在文件 util.cpp 第 5351 行定义.

 {
   static reg::Ex re(R"(\s*(<\a+>)\s*)");
   std::string s = sentence.str();
   reg::Iterator it(s,re);
   reg::Iterator end;
   std::string result;
   bool found=false;
   size_t p=0;
   for ( ; it!=end ; ++it)
   {
     const auto match = *it;
     std::string part = match[1].str();
     if (part!=word)
     {
       size_t i = match.position();
       size_t l = match.length();
       result+=s.substr(p,i-p);
       result+=match.str();
       p=i+l;
     }
     else
     {
       found=true;
       size_t i = match[1].position();
       size_t l = match[1].length();
       result+=s.substr(p,i-p);
       p=i+l;
     }
   }
   result+=s.substr(p);
   sentence = QCString(result).simplifyWhiteSpace();
   return found;
 }

引用了 end(), reg::match(), QCString::simplifyWhiteSpace() , 以及 QCString::str().

被这些函数引用 isVarWithConstructor().

◆ findFileDef()

FileDef* findFileDef	(	const FileNameLinkedMap *	fnMap,
		const QCString &	n,
		bool &	ambig
	)

在文件 util.cpp 第 3222 行定义.

 {
   ambig=FALSE;
   if (n.isEmpty()) return 0;
  
   std::lock_guard<std::mutex> lock(g_findFileDefMutex);
  
   const int maxAddrSize = 20;
   char addr[maxAddrSize];
   qsnprintf(addr,maxAddrSize,"%p:",(void*)fnMap);
   QCString key = addr;
   key+=n;
  
   FindFileCacheElem *cachedResult = g_findFileDefCache.find(key.str());
   //printf("key=%s cachedResult=%p\n",qPrint(key),cachedResult);
   if (cachedResult)
   {
     ambig = cachedResult->isAmbig;
     //printf("cached: fileDef=%p\n",cachedResult->fileDef);
     return cachedResult->fileDef;
   }
   else
   {
     cachedResult = g_findFileDefCache.insert(key.str(),FindFileCacheElem(0,FALSE));
   }
  
   QCString name=Dir::cleanDirPath(n.str());
   QCString path;
   int slashPos;
   const FileName *fn;
   if (name.isEmpty()) goto exit;
   slashPos=std::max(name.findRev('/'),name.findRev('\\'));
   if (slashPos!=-1)
   {
     path=name.left(slashPos+1);
     name=name.right(name.length()-slashPos-1);
   }
   if (name.isEmpty()) goto exit;
   if ((fn=fnMap->find(name)))
   {
     //printf("fn->size()=%zu\n",fn->size());
     if (fn->size()==1)
     {
       const std::unique_ptr<FileDef> &fd = fn->front();
       bool isSamePath = Portable::fileSystemIsCaseSensitive() ?
                  fd->getPath().right(path.length())==path :
                  fd->getPath().right(path.length()).lower()==path.lower();
       if (path.isEmpty() || isSamePath)
       {
         cachedResult->fileDef = fd.get();
         return fd.get();
       }
     }
     else // file name alone is ambiguous
     {
       int count=0;
       FileDef *lastMatch=0;
       QCString pathStripped = stripFromIncludePath(path);
       for (const auto &fd_p : *fn)
       {
         FileDef *fd = fd_p.get();
         QCString fdStripPath = stripFromIncludePath(fd->getPath());
         if (path.isEmpty() || fdStripPath.right(pathStripped.length())==pathStripped)
         {
           count++;
           lastMatch=fd;
         }
       }
  
       ambig=(count>1);
       cachedResult->isAmbig = ambig;
       cachedResult->fileDef = lastMatch;
       return lastMatch;
     }
   }
   else
   {
     //printf("not found!\n");
   }
 exit:
   //delete cachedResult;
   return 0;
 }

引用了 Dir::cleanDirPath(), FALSE, FindFileCacheElem::fileDef, Portable::fileSystemIsCaseSensitive(), QCString::findRev(), g_findFileDefCache, g_findFileDefMutex, FileDef::getPath(), FindFileCacheElem::isAmbig, QCString::isEmpty(), QCString::left(), QCString::length(), QCString::lower(), qsnprintf, QCString::right(), QCString::str() , 以及 stripFromIncludePath().

被这些函数引用 addIncludeFile(), buildFileList(), DocParser::findAndCopyImage(), DocParser::findDocsForMemberOrCompound(), generateFileRef(), generateFileSources(), DocParser::handleLinkedWord(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), parseFilesMultiThreading(), parseFilesSingleThreading(), Markdown::processLink(), DocParser::readTextFileByName(), resolveLink(), resolveRef(), DocbookDocVisitor::visitPost() , 以及 XmlDocVisitor::visitPre().

◆ findIndex() [1/2]

int findIndex	(	const std::string &	s,
		const reg::Ex &	re
	)

find the index of the first occurrence of pattern re in a string s returns -1 if the pattern could not be found

在文件 util.cpp 第 7327 行定义.

 {
   reg::Match match;
   return reg::search(s,match,re) ? (int)match.position() : -1;
 }

引用了 reg::match() , 以及 reg::search().

◆ findIndex() [2/2]

int findIndex	(	const StringVector &	sv,
		const std::string &	s
	)

find the index of a string in a vector of strings, returns -1 if the string could not be found

在文件 util.cpp 第 7319 行定义.

 {
   auto it = std::find(sv.begin(),sv.end(),s);
   return it!=sv.end() ? (int)(it-sv.begin()) : -1;
 }

被这些函数引用 initUCF(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseUCF(), DotFilePatcher::run() , 以及 VhdlDocGen::writeFormatString().

◆ generateFileRef()

void generateFileRef	(	OutputDocInterface &	od,
		const QCString &	,
		const QCString &	linkTxt = `QCString()`
	)

在文件 util.cpp 第 3193 行定义.

 {
   //printf("generateFileRef(%s,%s)\n",name,text);
   QCString linkText = text.isEmpty() ? text : name;
   //FileInfo *fi;
   FileDef *fd;
   bool ambig;
   if ((fd=findFileDef(Doxygen::inputNameLinkedMap,name,ambig)) &&
       fd->isLinkable())
     // link to documented input file
     od.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),QCString(),linkText);
   else
     od.docify(linkText);
 }

引用了 BaseOutputDocInterface::docify(), findFileDef(), FileDef::getOutputFileBase(), Definition::getReference(), Doxygen::inputNameLinkedMap, QCString::isEmpty(), FileDef::isLinkable() , 以及 BaseOutputDocInterface::writeObjectLink().

◆ generateLink()

bool generateLink	(	OutputDocInterface &	od,
		const QCString &	,
		const QCString &	,
		bool	inSeeBlock,
		const QCString &
	)

在文件 util.cpp 第 3151 行定义.

 {
   //printf("generateLink(clName=%s,lr=%s,lr=%s)\n",clName,lr,lt);
   const Definition *compound = 0;
   //PageDef *pageDef=0;
   QCString anchor,linkText=linkToText(SrcLangExt_Unknown,lt,FALSE);
   //printf("generateLink linkText=%s\n",qPrint(linkText));
   if (resolveLink(clName,lr,inSeeBlock,&compound,anchor))
   {
     if (compound) // link to compound
     {
       if (lt.isEmpty() && anchor.isEmpty() &&                      /* compound link */
           compound->definitionType()==Definition::TypeGroup /* is group */
          )
       {
         linkText=(toGroupDef(compound))->groupTitle(); // use group's title as link
       }
       else if (compound->definitionType()==Definition::TypeFile)
       {
         linkText=linkToText(compound->getLanguage(),lt,TRUE);
       }
       od.writeObjectLink(compound->getReference(),
           compound->getOutputFileBase(),anchor,linkText);
       if (!compound->isReference())
       {
         writePageRef(od,compound->getOutputFileBase(),anchor);
       }
     }
     else
     {
       err("%s:%d: Internal error: resolveLink successful but no compound found!",__FILE__,__LINE__);
     }
     return TRUE;
   }
   else // link could not be found
   {
     od.docify(linkText);
     return FALSE;
   }
 }

引用了 Definition::definitionType(), BaseOutputDocInterface::docify(), err(), FALSE, Definition::getLanguage(), Definition::getOutputFileBase(), Definition::getReference(), QCString::isEmpty(), Definition::isReference(), linkToText(), resolveLink(), SrcLangExt_Unknown, toGroupDef(), TRUE, Definition::TypeFile, Definition::TypeGroup, BaseOutputDocInterface::writeObjectLink() , 以及 writePageRef().

◆ generateMarker()

QCString generateMarker ( int id )

Generate a place holder for a position in a list. Used for translators to be able to specify different elements orders depending on whether text flows from left to right or visa versa.

在文件 util.cpp 第 284 行定义.

 {
   const int maxMarkerStrLen = 20;
   char result[maxMarkerStrLen];
   qsnprintf(result,maxMarkerStrLen,"@%d",id);
   return result;
 }

引用了 qsnprintf.

被这些函数引用 TranslatorPortuguese::trCompoundReference(), TranslatorItalian::trFriends(), TranslatorBrazilian::trNamespaceReference(), TranslatorSpanish::trPrivateSlots(), TranslatorChinese::trWriteList(), TranslatorPersian::trWriteList() , 以及 TranslatorDanish::trWriteList().

◆ getCanonicalTemplateSpec()

QCString getCanonicalTemplateSpec	(	const Definition *	d,
		const FileDef *	fs,
		const QCString &	spec
	)

在文件 util.cpp 第 1594 行定义.

 {
  
   QCString templSpec = spec.stripWhiteSpace();
   // this part had been commented out before... but it is needed to match for instance
   // std::list<std::string> against list<string> so it is now back again!
   if (!templSpec.isEmpty() && templSpec.at(0) == '<')
   {
     templSpec = "< " + extractCanonicalType(d,fs,templSpec.right(templSpec.length()-1).stripWhiteSpace());
   }
   QCString resolvedType = resolveTypeDef(d,templSpec);
   if (!resolvedType.isEmpty()) // not known as a typedef either
   {
     templSpec = resolvedType;
   }
   //printf("getCanonicalTemplateSpec(%s)=%s\n",qPrint(spec),qPrint(templSpec));
   return templSpec;
 }

引用了 QCString::at(), extractCanonicalType(), QCString::isEmpty(), QCString::length(), resolveTypeDef(), QCString::right() , 以及 QCString::stripWhiteSpace().

被这些函数引用 getCanonicalTypeForIdentifier().

◆ getDefs()

bool getDefs	(	const QCString &	scName,
		const QCString &	mbName,
		const QCString &	args,
		const MemberDef *&	md,
		const ClassDef *&	cd,
		const FileDef *&	fd,
		const NamespaceDef *&	nd,
		const GroupDef *&	gd,
		bool	forceEmptyScope,
		const FileDef *	currentFile,
		bool	checkCV
	)

Searches for a member definition given its name 'memberName' as a string. memberName may also include a (partial) scope to indicate the scope in which the member is located.

The parameter 'scName' is a string representing the name of the scope in which the link was found.

In case of a function args contains a string representation of the argument list. Passing 0 means the member has no arguments. Passing "()" means any argument list will do, but "()" is preferred.

The function returns TRUE if the member is known and documented or FALSE if it is not. If TRUE is returned parameter 'md' contains a pointer to the member definition. Furthermore exactly one of the parameter 'cd', 'nd', or 'fd' will be non-zero:

if 'cd' is non zero, the member was found in a class pointed to by cd.
if 'nd' is non zero, the member was found in a namespace pointed to by nd.
if 'fd' is non zero, the member was found in the global namespace of file fd.

在文件 util.cpp 第 2208 行定义.

 {
   fd=0, md=0, cd=0, nd=0, gd=0;
   if (mbName.isEmpty()) return FALSE; /* empty name => nothing to link */
  
   QCString scopeName=scName;
   QCString memberName=mbName;
   scopeName = substitute(scopeName,"\\","::"); // for PHP
   memberName = substitute(memberName,"\\","::"); // for PHP
   //printf("Search for name=%s args=%s in scope=%s forceEmpty=%d\n",
   //          qPrint(memberName),qPrint(args),qPrint(scopeName),forceEmptyScope);
  
   int is,im=0,pm=0;
   // strip common part of the scope from the scopeName
   while ((is=scopeName.findRev("::"))!=-1 &&
          (im=memberName.find("::",pm))!=-1 &&
           (scopeName.right(scopeName.length()-is-2)==memberName.mid(pm,im-pm))
         )
   {
     scopeName=scopeName.left(is);
     pm=im+2;
   }
   //printf("result after scope corrections scope=%s name=%s\n",
   //          qPrint(scopeName), qPrint(memberName));
  
   QCString mName=memberName;
   QCString mScope;
   if (memberName.left(9)!="operator " && // treat operator conversion methods
       // as a special case
       (im=memberName.findRev("::"))!=-1 &&
       im<(int)memberName.length()-2 // not A::
      )
   {
     mScope=memberName.left(im);
     mName=memberName.right(memberName.length()-im-2);
   }
  
   // handle special the case where both scope name and member scope are equal
   if (mScope==scopeName) scopeName.resize(0);
  
   //printf("mScope='%s' mName='%s'\n",qPrint(mScope),qPrint(mName));
  
   MemberName *mn = Doxygen::memberNameLinkedMap->find(mName);
   //printf("mName=%s mn=%p\n",qPrint(mName),mn);
  
   if ((!forceEmptyScope || scopeName.isEmpty()) && // this was changed for bug638856, forceEmptyScope => empty scopeName
       mn && !(scopeName.isEmpty() && mScope.isEmpty()))
   {
     //printf("  >member name '%s' found\n",qPrint(mName));
     int scopeOffset=scopeName.length();
     do
     {
       QCString className = scopeName.left(scopeOffset);
       if (!className.isEmpty() && !mScope.isEmpty())
       {
         className+="::"+mScope;
       }
       else if (!mScope.isEmpty())
       {
         className=mScope;
       }
  
       SymbolResolver resolver;
       const ClassDef *fcd=resolver.resolveClass(Doxygen::globalScope,className);
       const MemberDef *tmd=resolver.getTypedef();
  
       if (fcd==0 && className.find('<')!=-1) // try without template specifiers as well
       {
          QCString nameWithoutTemplates = stripTemplateSpecifiersFromScope(className,FALSE);
          fcd=resolver.resolveClass(Doxygen::globalScope,nameWithoutTemplates);
          tmd=resolver.getTypedef();
       }
       //printf("Trying class scope %s: fcd=%p tmd=%p\n",qPrint(className),fcd,tmd);
       // todo: fill in correct fileScope!
       if (fcd &&  // is it a documented class
           fcd->isLinkable()
          )
       {
         //printf("  Found fcd=%p\n",fcd);
         int mdist=maxInheritanceDepth;
         std::unique_ptr<ArgumentList> argList;
         if (!args.isEmpty())
         {
           argList = stringToArgumentList(fcd->getLanguage(),args);
         }
         for (const auto &mmd_p : *mn)
         {
           MemberDef *mmd = mmd_p.get();
           if (!mmd->isStrongEnumValue())
           {
             const ArgumentList &mmdAl = mmd->argumentList();
             bool match = args.isEmpty() ||
               matchArguments2(mmd->getOuterScope(),mmd->getFileDef(),&mmdAl,
                              fcd,                  fcd->getFileDef(),argList.get(),
                              checkCV);
             //printf("match=%d\n",match);
             if (match)
             {
               const ClassDef *mcd=mmd->getClassDef();
               if (mcd)
               {
                 int m=minClassDistance(fcd,mcd);
                 if (m<mdist && mcd->isLinkable())
                 {
                   mdist=m;
                   cd=mcd;
                   md=mmd;
                 }
               }
             }
           }
         }
         if (mdist==maxInheritanceDepth && args=="()")
           // no exact match found, but if args="()" an arbitrary member will do
         {
           //printf("  >Searching for arbitrary member\n");
           for (const auto &mmd_p : *mn)
           {
             MemberDef *mmd = mmd_p.get();
             //if (mmd->isLinkable())
             //{
             const ClassDef *mcd=mmd->getClassDef();
             //printf("  >Class %s found\n",qPrint(mcd->name()));
             if (mcd)
             {
               int m=minClassDistance(fcd,mcd);
               if (m<mdist /* && mcd->isLinkable()*/ )
               {
                 //printf("Class distance %d\n",m);
                 mdist=m;
                 cd=mcd;
                 md=mmd;
               }
             }
             //}
           }
         }
         //printf("  >Success=%d\n",mdist<maxInheritanceDepth);
         if (mdist<maxInheritanceDepth)
         {
           if (!md->isLinkable() || md->isStrongEnumValue())
           {
             md=0; // avoid returning things we cannot link to
             cd=0;
             return FALSE; // match found, but was not linkable
           }
           else
           {
             gd=md->getGroupDef();
             if (gd) cd=0;
             return TRUE; /* found match */
           }
         }
       }
       if (tmd && tmd->isEnumerate() && tmd->isStrong()) // scoped enum
       {
         //printf("Found scoped enum!\n");
         for (const auto &emd : tmd->enumFieldList())
         {
           if (emd->localName()==mName)
           {
             if (emd->isLinkable())
             {
               cd=tmd->getClassDef();
               md=emd;
               return TRUE;
             }
             else
             {
               cd=0;
               md=0;
               return FALSE;
             }
           }
         }
       }
       /* go to the parent scope */
       if (scopeOffset==0)
       {
         scopeOffset=-1;
       }
       else if ((scopeOffset=scopeName.findRev("::",scopeOffset-1))==-1)
       {
         scopeOffset=0;
       }
     } while (scopeOffset>=0);
  
   }
   if (mn && scopeName.isEmpty() && mScope.isEmpty()) // Maybe a related function?
   {
     //printf("Global symbol\n");
     const MemberDef *fuzzy_mmd = 0;
     std::unique_ptr<ArgumentList> argList;
     bool hasEmptyArgs = args=="()";
  
     if (!args.isEmpty())
     {
       argList = stringToArgumentList(SrcLangExt_Cpp, args);
     }
  
     for (const auto &mmd_p : *mn)
     {
       const MemberDef *mmd = mmd_p.get();
       if (!mmd->isLinkable() || (!mmd->isRelated() && !mmd->isForeign()) ||
            !mmd->getClassDef())
       {
         continue;
       }
  
       if (args.isEmpty())
       {
         fuzzy_mmd = mmd;
         break;
       }
  
       const ArgumentList &mmdAl = mmd->argumentList();
       if (matchArguments2(mmd->getOuterScope(),mmd->getFileDef(),&mmdAl,
             Doxygen::globalScope,mmd->getFileDef(),argList.get(),
             checkCV
             )
          )
       {
         fuzzy_mmd = mmd;
         break;
       }
  
       if (!fuzzy_mmd && hasEmptyArgs)
       {
         fuzzy_mmd = mmd;
       }
     }
  
     if (fuzzy_mmd && !fuzzy_mmd->isStrongEnumValue())
     {
       md = fuzzy_mmd;
       cd = fuzzy_mmd->getClassDef();
       return TRUE;
     }
   }
  
  
   // maybe an namespace, file or group member ?
   //printf("Testing for global symbol scopeName='%s' mScope='%s' :: mName='%s'\n",
   //              qPrint(scopeName), qPrint(mScope), qPrint(mName));
   if ((mn=Doxygen::functionNameLinkedMap->find(mName))) // name is known
   {
     //printf("  >symbol name found\n");
     NamespaceDef *fnd=0;
     int scopeOffset=scopeName.length();
     do
     {
       QCString namespaceName = scopeName.left(scopeOffset);
       if (!namespaceName.isEmpty() && !mScope.isEmpty())
       {
         namespaceName+="::"+mScope;
       }
       else if (!mScope.isEmpty())
       {
         namespaceName=mScope;
       }
       //printf("Trying namespace %s\n",qPrint(namespaceName));
       if (!namespaceName.isEmpty() &&
           (fnd=Doxygen::namespaceLinkedMap->find(namespaceName)) &&
           fnd->isLinkable()
          )
       {
         //printf("Symbol inside existing namespace '%s' count=%d\n",
         //    qPrint(namespaceName),mn->count());
         bool found=FALSE;
         for (const auto &mmd_p : *mn)
         {
           const MemberDef *mmd = mmd_p.get();
           //printf("mmd->getNamespaceDef()=%p fnd=%p\n",
           //    mmd->getNamespaceDef(),fnd);
           const MemberDef *emd = mmd->getEnumScope();
           if (emd && emd->isStrong())
           {
             //printf("yes match %s<->%s!\n",qPrint(mScope),qPrint(emd->localName()));
             if (emd->getNamespaceDef()==fnd &&
                 rightScopeMatch(mScope,emd->localName()))
             {
               //printf("found it!\n");
               nd=fnd;
               md=mmd;
               found=TRUE;
               break;
             }
             else
             {
               md=0;
               cd=0;
               return FALSE;
             }
           }
           else if (mmd->getOuterScope()==fnd /* && mmd->isLinkable() */ )
           { // namespace is found
             bool match=TRUE;
             if (!args.isEmpty() && args!="()")
             {
               const ArgumentList &mmdAl = mmd->argumentList();
               auto argList_p = stringToArgumentList(mmd->getLanguage(),args);
               match=matchArguments2(
                   mmd->getOuterScope(),mmd->getFileDef(),&mmdAl,
                   fnd,mmd->getFileDef(),argList_p.get(),
                   checkCV);
             }
             if (match)
             {
               nd=fnd;
               md=mmd;
               found=TRUE;
               break;
             }
           }
         }
         if (!found && args=="()")
           // no exact match found, but if args="()" an arbitrary
           // member will do
         {
           for (const auto &mmd_p : *mn)
           {
             const MemberDef *mmd = mmd_p.get();
             if (mmd->getNamespaceDef()==fnd /*&& mmd->isLinkable() */ )
             {
               nd=fnd;
               md=mmd;
               found=TRUE;
               break;
             }
           }
         }
         if (found)
         {
           if (!md->isLinkable())
           {
             md=0; // avoid returning things we cannot link to
             nd=0;
             return FALSE; // match found but not linkable
           }
           else
           {
             gd=md->resolveAlias()->getGroupDef();
             if (gd && gd->isLinkable()) nd=0; else gd=0;
             return TRUE;
           }
         }
       }
       else
       {
         //printf("not a namespace\n");
         for (const auto &mmd_p : *mn)
         {
           const MemberDef *mmd = mmd_p.get();
           const MemberDef *tmd = mmd->getEnumScope();
           //printf("try member %s tmd=%s\n",qPrint(mmd->name()),tmd ? qPrint(tmd->name()) : "<none>");
           int ni=namespaceName.findRev("::");
           //printf("namespaceName=%s ni=%d\n",qPrint(namespaceName),ni);
           bool notInNS = tmd && ni==-1 && tmd->getNamespaceDef()==0 && (mScope.isEmpty() || mScope==tmd->name());
           bool sameNS  = tmd && ni>=0 && tmd->getNamespaceDef() && namespaceName.left(ni)==tmd->getNamespaceDef()->name() && namespaceName.mid(ni+2)==tmd->name();
           //printf("notInNS=%d sameNS=%d\n",notInNS,sameNS);
           if (tmd && tmd->isStrong() && // C++11 enum class
               (notInNS || sameNS) &&
               namespaceName.length()>0  // enum is part of namespace so this should not be empty
              )
           {
             md=mmd;
             fd=mmd->getFileDef();
             gd=mmd->getGroupDef();
             if (gd && gd->isLinkable()) fd=0; else gd=0;
             //printf("Found scoped enum %s fd=%p gd=%p\n",
             //    qPrint(mmd->name()),fd,gd);
             return TRUE;
           }
         }
       }
       if (scopeOffset==0)
       {
         scopeOffset=-1;
       }
       else if ((scopeOffset=scopeName.findRev("::",scopeOffset-1))==-1)
       {
         scopeOffset=0;
       }
     } while (scopeOffset>=0);
  
     //else // no scope => global function
     {
       std::vector<const MemberDef *> members;
       // search for matches with strict static checking
       findMembersWithSpecificName(mn,args,TRUE,currentFile,checkCV,members);
       if (members.empty()) // nothing found
       {
         // search again without strict static checking
         findMembersWithSpecificName(mn,args,FALSE,currentFile,checkCV,members);
       }
       //printf("found %d members\n",members.count());
       if (members.size()!=1 && args=="()")
       {
         // no exact match found, but if args="()" an arbitrary
         // member will do
         //MemberNameIterator mni(*mn);
         //for (mni.toLast();(md=mni.current());--mni)
         for (auto it = mn->rbegin(); it!=mn->rend(); ++it)
         {
           const auto &mmd_p = *it;
           const MemberDef *mmd = mmd_p.get();
           //printf("Found member '%s'\n",qPrint(mmd->name()));
           //printf("member is linkable mmd->name()='%s'\n",qPrint(mmd->name()));
           fd=mmd->getFileDef();
           gd=mmd->getGroupDef();
           const MemberDef *tmd = mmd->getEnumScope();
           if (
               (gd && gd->isLinkable()) || (fd && fd->isLinkable()) ||
               (tmd && tmd->isStrong())
              )
           {
             members.push_back(mmd);
           }
         }
       }
       //printf("found %d candidate members\n",members.count());
       if (!members.empty()) // at least one match
       {
         if (currentFile)
         {
           //printf("multiple results; pick one from file:%s\n",qPrint( currentFile->name()));
           for (const auto &rmd : members)
           {
             if (rmd->getFileDef() && rmd->getFileDef()->name() == currentFile->name())
             {
               md = rmd;
               break; // found match in the current file
             }
           }
           if (!md) // member not in the current file
           {
             md=members.back();
           }
         }
         else
         {
           md=members.back();
         }
       }
       if (md && (md->getEnumScope()==0 || !md->getEnumScope()->isStrong()))
            // found a matching global member, that is not a scoped enum value (or uniquely matches)
       {
         fd=md->getFileDef();
         gd=md->getGroupDef();
         //printf("fd=%p gd=%p gd->isLinkable()=%d\n",fd,gd,gd->isLinkable());
         if (gd && gd->isLinkable()) fd=0; else gd=0;
         return TRUE;
       }
     }
   }
  
   // no nothing found
   return FALSE;
 }

引用了 MemberDef::argumentList(), MemberDef::enumFieldList(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::find(), findMembersWithSpecificName(), QCString::findRev(), Doxygen::functionNameLinkedMap, MemberDef::getClassDef(), MemberDef::getEnumScope(), MemberDef::getFileDef(), ClassDef::getFileDef(), MemberDef::getGroupDef(), Definition::getLanguage(), MemberDef::getNamespaceDef(), Definition::getOuterScope(), SymbolResolver::getTypedef(), Doxygen::globalScope, QCString::isEmpty(), MemberDef::isEnumerate(), MemberDef::isForeign(), NamespaceDef::isLinkable(), GroupDef::isLinkable(), FileDef::isLinkable(), MemberDef::isLinkable(), ClassDef::isLinkable(), MemberDef::isRelated(), MemberDef::isStrong(), MemberDef::isStrongEnumValue(), QCString::left(), QCString::length(), Definition::localName(), reg::match(), matchArguments2(), maxInheritanceDepth, Doxygen::memberNameLinkedMap, QCString::mid(), minClassDistance(), FileDef::name(), Definition::name(), Doxygen::namespaceLinkedMap, MemberName::rbegin(), MemberName::rend(), QCString::resize(), MemberDef::resolveAlias(), SymbolResolver::resolveClass(), QCString::right(), rightScopeMatch(), SrcLangExt_Cpp, stringToArgumentList(), stripTemplateSpecifiersFromScope(), substitute() , 以及 TRUE.

被这些函数引用 DocParser::findDocsForMemberOrCompound(), linkifyText() , 以及 resolveRef().

◆ getDotImageExtension()

QCString getDotImageExtension ( )

在文件 util.cpp 第 7032 行定义.

 {
   QCString imgExt = Config_getEnumAsString(DOT_IMAGE_FORMAT);
   int i= imgExt.find(':'); // strip renderer part when using e.g. 'png:cairo:gd' as format
   return i==-1 ? imgExt : imgExt.left(i);
 }

引用了 Config_getEnumAsString, QCString::find() , 以及 QCString::left().

被这些函数引用 RTFGenerator::endCallGraph(), RTFGenerator::endDirDepGraph(), RTFGenerator::endDotGraph(), RTFGenerator::endInclDepGraph(), DotGraph::generateCode(), DotGraph::imgName(), DocbookDocVisitor::startDotFile(), TranslatorChinese::trLegendDocs(), TranslatorDanish::trLegendDocs(), TranslatorPersian::trLegendDocs(), HtmlDocVisitor::visit(), RTFDocVisitor::writeDotFile(), DocbookDocVisitor::writeDotFile(), writeDotGraphFromFile(), writeDotImageMapFromFile(), DotLegendGraph::writeGraph(), writeGraphInfo(), HtmlDocVisitor::writeMscFile() , 以及 HtmlDocVisitor::writePlantUMLFile().

◆ getFileFilter()

QCString getFileFilter	(	const QCString &	name,
		bool	isSourceCode
	)

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.

在文件 util.cpp 第 1315 行定义.

 {
   // sanity check
   if (name.isEmpty()) return "";
  
   const StringVector& filterSrcList = Config_getList(FILTER_SOURCE_PATTERNS);
   const StringVector& filterList    = Config_getList(FILTER_PATTERNS);
  
   QCString filterName;
   bool found=FALSE;
   if (isSourceCode && !filterSrcList.empty())
   { // first look for source filter pattern list
     filterName = getFilterFromList(name,filterSrcList,found);
   }
   if (!found && filterName.isEmpty())
   { // then look for filter pattern list
     filterName = getFilterFromList(name,filterList,found);
   }
   if (!found)
   { // then use the generic input filter
     return Config_getString(INPUT_FILTER);
   }
   else
   {
     /* remove surrounding double quotes */
     if ((filterName.right(1) == "\"") && (filterName.left(1) == "\""))
     {
        filterName.remove(filterName.length() - 1, 1);
        filterName.remove(0, 1);
     }
     return filterName;
   }
 }

引用了 Config_getList, Config_getString, FALSE, getFilterFromList(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::remove() , 以及 QCString::right().

被这些函数引用 FilterCache::getFileContents(), readCodeFragment(), readInputFile() , 以及 FileDefImpl::writeSourceBody().

◆ getFileNameExtension()

QCString getFileNameExtension ( const QCString & fn )

在文件 util.cpp 第 5621 行定义.

 {
   if (fn.isEmpty()) return "";
   int lastDot = fn.findRev('.');
   if (lastDot!=-1) return fn.mid(lastDot);
   return "";
 }

引用了 QCString::findRev(), QCString::isEmpty() , 以及 QCString::mid().

被这些函数引用 TooltipManager::addTooltip(), TagFileParser::buildLists(), convertFileNameFortranParserCode(), FileDefImpl::isDocumentationFile(), MarkdownOutlineParser::parseInput(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

◆ getLanguageFromCodeLang()

SrcLangExt getLanguageFromCodeLang ( QCString & fileName )

Routine to handle the language attribute of the \code command

在文件 util.cpp 第 5592 行定义.

 {
   // try the extension
   SrcLangExt lang = getLanguageFromFileName(fileName, SrcLangExt_Unknown);
   if (lang == SrcLangExt_Unknown)
   {
     // try the language names
     const Lang2ExtMap *p = g_lang2extMap;
     QCString langName = fileName.lower();
     if (langName.at(0)=='.') langName = langName.mid(1);
     while (p->langName)
     {
       if (langName==p->langName)
       {
         // found the language
         lang     = p->parserId;
         fileName = p->defExt;
         break;
       }
       p++;
     }
     if (!p->langName)
     {
       return SrcLangExt_Cpp;
     }
   }
   return lang;
 }

引用了 QCString::at(), Lang2ExtMap::defExt, g_lang2extMap, getLanguageFromFileName(), Lang2ExtMap::langName, QCString::lower(), QCString::mid(), Lang2ExtMap::parserId, SrcLangExt_Cpp , 以及 SrcLangExt_Unknown.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

◆ getLanguageFromFileName()

SrcLangExt getLanguageFromFileName	(	const QCString &	fileName,
		SrcLangExt	defLang = `SrcLangExt_Cpp`
	)

在文件 util.cpp 第 5574 行定义.

 {
   FileInfo fi(fileName.str());
   // we need only the part after the last ".", newer implementations of FileInfo have 'suffix()' for this.
   QCString extName = QCString(fi.extension(FALSE)).lower();
   if (extName.isEmpty()) extName=".no_extension";
   if (extName.at(0)!='.') extName.prepend(".");
   auto it = g_extLookup.find(extName.str());
   if (it!=g_extLookup.end()) // listed extension
   {
     //printf("getLanguageFromFileName(%s)=%x\n",qPrint(fi.extension()),*pVal);
     return (SrcLangExt)it->second;
   }
   //printf("getLanguageFromFileName(%s) not found!\n",qPrint(fileName));
   return defLang; // not listed => assume C-ish language.
 }

引用了 QCString::at(), FileInfo::extension(), FALSE, g_extLookup, QCString::isEmpty(), QCString::lower(), QCString::prepend() , 以及 QCString::str().

被这些函数引用 MemberDefImpl::_writeMultiLineInitializer(), DocRef::DocRef(), FileDefImpl::FileDefImpl(), getLanguageFromCodeLang(), ClassDefImpl::IMPL::init(), FileDefImpl::isDocumentationFile(), DocSecRefItem::parse(), Markdown::processLink(), readCodeFragment(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), DocbookDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), XmlDocVisitor::visit() , 以及 writeXMLCodeBlock().

◆ getLanguageSpecificSeparator()

QCString getLanguageSpecificSeparator	(	SrcLangExt	lang,
		bool	classScope = `FALSE`
	)

Returns the scope separator to use given the programming language lang

在文件 util.cpp 第 6545 行定义.

 {
   if (lang==SrcLangExt_Java || lang==SrcLangExt_CSharp || lang==SrcLangExt_VHDL || lang==SrcLangExt_Python)
   {
     return ".";
   }
   else if (lang==SrcLangExt_PHP && !classScope)
   {
     return "\\";
   }
   else
   {
     return "::";
   }
 }

引用了 SrcLangExt_CSharp, SrcLangExt_Java, SrcLangExt_PHP, SrcLangExt_Python , 以及 SrcLangExt_VHDL.

被这些函数引用 DefinitionImpl::_writeSourceRefList(), MemberDefImpl::addListReference(), addVariableToFile(), SymbolContext::Private::createScope(), MemberDefImpl::displayDefinition(), MemberContext::Private::handleNameWithContextFor(), linkToText(), makeDisplayName(), makeQualifiedNameWithTemplateParameters(), ClassDefImpl::mergeMembers(), DefinitionImpl::qualifiedName(), MemberDefImpl::qualifiedName(), DefinitionAliasImpl::qualifiedName(), SearchIndex::setCurrentDoc(), writeAlphabeticalClassList(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation(), writeJavaScriptSearchIndex(), MemberDefImpl::writeLink() , 以及 writeMemberReference().

◆ getOverloadDocs()

QCString getOverloadDocs ( )

Returns the standard string that is generated when the \overload command is used.

在文件 util.cpp 第 4212 行定义.

 {
   return theTranslator->trOverloadText();
   //"This is an overloaded member function, "
   //       "provided for convenience. It differs from the above "
   //       "function only in what argument(s) it accepts.";
 }

引用了 theTranslator , 以及 Translator::trOverloadText().

被这些函数引用 addMemberDocs() , 以及 addOverloaded().

◆ getPrefixIndex()

int getPrefixIndex ( const QCString & 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

在文件 util.cpp 第 3357 行定义.

 {
   if (name.isEmpty()) return 0;
   const StringVector &sl = Config_getList(IGNORE_PREFIX);
   for (const auto &s : sl)
   {
     const char *ps=s.c_str();
     const char *pd=name.data();
     int i=0;
     while (*ps!=0 && *pd!=0 && *ps==*pd) ps++,pd++,i++;
     if (*ps==0 && *pd!=0)
     {
       return i;
     }
   }
   return 0;
 }

引用了 Config_getList, QCString::data() , 以及 QCString::isEmpty().

被这些函数引用 addClassMemberNameToIndex(), addFileMemberNameToIndex(), addNamespaceMemberNameToIndex(), SearchIndex::addWord(), FilterAlphaIndex::determineSortKey(), parseInput(), writeAlphabeticalClassList() , 以及 writeMemberList().

◆ getScopeFragment()

int getScopeFragment	(	const QCString &	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.

返回: the location of the fragment, or -1 if non is found.

在文件 util.cpp 第 4702 行定义.

 {
   int sl=s.length();
   int sp=p;
   int count=0;
   bool done;
   if (sp>=sl) return -1;
   while (sp<sl)
   {
     char c=s.at(sp);
     if (c==':') sp++,p++; else break;
   }
   while (sp<sl)
   {
     char c=s.at(sp);
     switch (c)
     {
       case ':': // found next part
         goto found;
       case '<': // skip template specifier
         count=1;sp++;
         done=FALSE;
         while (sp<sl && !done)
         {
           // TODO: deal with << and >> operators!
           c=s.at(sp++);
           switch(c)
           {
             case '<': count++; break;
             case '>': count--; if (count==0) done=TRUE; break;
             default: break;
           }
         }
         break;
       default:
         sp++;
         break;
     }
   }
 found:
   *l=sp-p;
   //printf("getScopeFragment(%s,%d)=%s\n",qPrint(s),p,qPrint(s.mid(p,*l)));
   return p;
 }

引用了 QCString::at(), FALSE, QCString::length() , 以及 TRUE.

被这些函数引用 buildScopeFromQualifiedName(), findScopeFromQualifiedName(), SymbolResolver::Private::followPath(), resolveTypeDef() , 以及 stripAnonymousNamespaceScope().

◆ guessSection()

int guessSection ( const QCString & name )

try to determine if name is a source or a header file name by looking at the extension. A number of variations is allowed in both upper and lower case) If anyone knows or uses another extension please let me know :-)

在文件 util.cpp 第 331 行定义.

 {
   QCString n=name.lower();
   if (n.right(2)==".c"    || // source
       n.right(3)==".cc"   ||
       n.right(4)==".cxx"  ||
       n.right(4)==".cpp"  ||
       n.right(4)==".c++"  ||
       n.right(5)==".java" ||
       n.right(2)==".m"    ||
       n.right(3)==".mm"   ||
       n.right(3)==".ii"   || // inline
       n.right(4)==".ixx"  ||
       n.right(4)==".ipp"  ||
       n.right(4)==".i++"  ||
       n.right(4)==".inl"  ||
       n.right(4)==".xml"  ||
       n.right(4)==".lex"  ||
       n.right(4)==".sql"
      ) return Entry::SOURCE_SEC;
   if (n.right(2)==".h"    || // header
       n.right(3)==".hh"   ||
       n.right(4)==".hxx"  ||
       n.right(4)==".hpp"  ||
       n.right(4)==".h++"  ||
       n.right(4)==".idl"  ||
       n.right(4)==".ddl"  ||
       n.right(5)==".pidl" ||
       n.right(4)==".ice"
      ) return Entry::HEADER_SEC;
   return 0;
 }

引用了 Entry::HEADER_SEC, QCString::lower(), QCString::right() , 以及 Entry::SOURCE_SEC.

被这些函数引用 addIncludeFile(), TagFileParser::buildLists(), computeClassRelations(), FileDefImpl::FileDefImpl(), FileDefImpl::generateSourceFile() , 以及 ClassDefImpl::IMPL::init().

◆ initDefaultExtensionMapping()

void initDefaultExtensionMapping ( )

在文件 util.cpp 第 5505 行定义.

 {
   // NOTE: when adding an extension, also add the extension in config.xml
   //                  extension      parser id
   updateLanguageMapping(".dox",      "c");
   updateLanguageMapping(".txt",      "c"); // see bug 760836
   updateLanguageMapping(".doc",      "c");
   updateLanguageMapping(".c",        "c");
   updateLanguageMapping(".C",        "c");
   updateLanguageMapping(".cc",       "c");
   updateLanguageMapping(".CC",       "c");
   updateLanguageMapping(".cxx",      "c");
   updateLanguageMapping(".cpp",      "c");
   updateLanguageMapping(".c++",      "c");
   updateLanguageMapping(".ii",       "c");
   updateLanguageMapping(".ixx",      "c");
   updateLanguageMapping(".ipp",      "c");
   updateLanguageMapping(".i++",      "c");
   updateLanguageMapping(".inl",      "c");
   updateLanguageMapping(".h",        "c");
   updateLanguageMapping(".H",        "c");
   updateLanguageMapping(".hh",       "c");
   updateLanguageMapping(".HH",       "c");
   updateLanguageMapping(".hxx",      "c");
   updateLanguageMapping(".hpp",      "c");
   updateLanguageMapping(".h++",      "c");
   updateLanguageMapping(".idl",      "idl");
   updateLanguageMapping(".ddl",      "idl");
   updateLanguageMapping(".odl",      "idl");
   updateLanguageMapping(".java",     "java");
   //updateLanguageMapping(".as",       "javascript"); // not officially supported
   //updateLanguageMapping(".js",       "javascript"); // not officially supported
   updateLanguageMapping(".cs",       "csharp");
   updateLanguageMapping(".d",        "d");
   updateLanguageMapping(".php",      "php");
   updateLanguageMapping(".php4",     "php");
   updateLanguageMapping(".php5",     "php");
   updateLanguageMapping(".inc",      "php");
   updateLanguageMapping(".phtml",    "php");
   updateLanguageMapping(".m",        "objective-c");
   updateLanguageMapping(".M",        "objective-c");
   updateLanguageMapping(".mm",       "c");  // see bug746361
   updateLanguageMapping(".py",       "python");
   updateLanguageMapping(".pyw",      "python");
   updateLanguageMapping(".f",        "fortran");
   updateLanguageMapping(".for",      "fortran");
   updateLanguageMapping(".f90",      "fortran");
   updateLanguageMapping(".f95",      "fortran");
   updateLanguageMapping(".f03",      "fortran");
   updateLanguageMapping(".f08",      "fortran");
   updateLanguageMapping(".f18",      "fortran");
   updateLanguageMapping(".vhd",      "vhdl");
   updateLanguageMapping(".vhdl",     "vhdl");
   updateLanguageMapping(".ucf",      "vhdl");
   updateLanguageMapping(".qsf",      "vhdl");
   updateLanguageMapping(".md",       "md");
   updateLanguageMapping(".markdown", "md");
   updateLanguageMapping(".ice",      "slice");
   updateLanguageMapping(".l",        "lex");
   updateLanguageMapping(".doxygen_lex_c", "c"); // this is a placeholder so we can map initializations
                                                 // in the lex scanning to cpp
 }

引用了 updateLanguageMapping().

被这些函数引用 initDoxygen().

◆ insertTemplateSpecifierInScope()

QCString insertTemplateSpecifierInScope	(	const QCString &	scope,
		const QCString &	templ
	)

在文件 util.cpp 第 3782 行定义.

 {
   QCString result=scope;
   if (!templ.isEmpty() && scope.find('<')==-1)
   {
     int si,pi=0;
     ClassDef *cd=0;
     while (
         (si=scope.find("::",pi))!=-1 && !getClass(scope.left(si)+templ) &&
         ((cd=getClass(scope.left(si)))==0 || cd->templateArguments().empty())
         )
     {
       //printf("Tried '%s'\n",qPrint((scope.left(si)+templ)));
       pi=si+2;
     }
     if (si==-1) // not nested => append template specifier
     {
       result+=templ;
     }
     else // nested => insert template specifier before after first class name
     {
       result=scope.left(si) + templ + scope.right(scope.length()-si);
     }
   }
   //printf("insertTemplateSpecifierInScope('%s','%s')=%s\n",
   //    qPrint(scope),qPrint(templ),qPrint(result));
   return result;
 }

引用了 ArgumentList::empty(), QCString::find(), getClass(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::right() , 以及 ClassDef::templateArguments().

被这些函数引用 DotClassGraph::addClass(), generateXMLForClass(), InheritanceListContext::InheritanceListContext(), DiagramItem::label() , 以及 ClassDefImpl::writeInheritanceGraph().

◆ integerToAlpha()

QCString integerToAlpha	(	int	n,
		bool	upper = `true`
	)

在文件 util.cpp 第 7347 行定义.

 {
   QCString result;
   int residual = n;
  
   char modVal[2];
   modVal[1] = 0;
   while (residual > 0)
   {
     modVal[0] = (upper ? 'A': 'a') + (residual-1)%26;
     result = modVal + result;
     residual = (residual-1) / 26;
   }
   return result;
 }

被这些函数引用 ManDocVisitor::visitPre() , 以及 RTFDocVisitor::visitPre().

◆ integerToRoman()

QCString integerToRoman	(	int	n,
		bool	upper = `true`
	)

在文件 util.cpp 第 7363 行定义.

 {
   static const char *str_romans_upper[] = {  "M", "CM", "D", "CD", "C", "XC", "L", "XL", "X", "IX", "V", "IV", "I" };
   static const char *str_romans_lower[] = {  "m", "cm", "d", "cd", "c", "xc", "l", "xl", "x", "ix", "v", "iv", "i" };
   static const int values[]             = { 1000,  900, 500,  400, 100,   90,  50,   40,  10,    9,   5,    4,   1 };
   static const char **str_romans = upper ? str_romans_upper : str_romans_lower;
  
   QCString result;
   int residual = n;
  
   for (int i = 0; i < 13; ++i)
   {
     while (residual - values[i] >= 0)
     {
       result += str_romans[i];
       residual -= values[i];
     }
   }
  
   return result;
 }

被这些函数引用 LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre() , 以及 ManDocVisitor::visitPre().

◆ isId()

bool isId ( int c )

inline

在文件 util.h 第 172 行定义.

 {
   return c=='_' || c>=128 || c<0 || isalnum(c) || c=='$';
 }

引用了 reg::isalnum().

被这些函数引用 addTemplateNames(), SearchIndexExternal::addWord(), convertToHtml(), convertToXML(), MemberDefImpl::displayDefinition(), escapeId(), filterLatexString(), findEndOfCommand(), markdownFileNameToId(), matchExcludedSymbols(), removeRedundantWhiteSpace(), stripIrrelevantString(), tempArgListToString() , 以及 MemberDefImpl::writeDocumentation().

◆ isIdJS()

bool isIdJS ( int c )

inline

在文件 util.h 第 176 行定义.

 {
   return c>=128 || c<0 || isalnum(c);
 }

引用了 reg::isalnum().

被这些函数引用 searchId().

◆ isURL()

bool isURL ( const QCString & url )

Checks whether the given url starts with a supported protocol

在文件 util.cpp 第 6561 行定义.

 {
   QCString loc_url = url.stripWhiteSpace();
   return loc_url.left(5)=="http:" || loc_url.left(6)=="https:" ||
          loc_url.left(4)=="ftp:"  || loc_url.left(5)=="ftps:"  ||
          loc_url.left(5)=="sftp:" || loc_url.left(5)=="file:"  ||
          loc_url.left(5)=="news:" || loc_url.left(4)=="irc:"   ||
          loc_url.left(5)=="ircs:";
 }

引用了 QCString::left() , 以及 QCString::stripWhiteSpace().

被这些函数引用 correctURL() , 以及 Markdown::processLink().

◆ join()

std::string join	(	const StringVector &	s,
		const std::string &	delimiter
	)

create a string where the string in the vector are joined by the given delimiter

在文件 util.cpp 第 7334 行定义.

 {
   std::string result;
   bool first=true;
   for (const auto &s : sv)
   {
     if (!first) result+=delimiter;
     first=false;
     result+=s;
   }
   return result;
 }

◆ langToString()

QCString langToString ( SrcLangExt lang )

Returns a string representation of lang.

在文件 util.cpp 第 6519 行定义.

 {
   switch(lang)
   {
     case SrcLangExt_Unknown:  return "Unknown";
     case SrcLangExt_IDL:      return "IDL";
     case SrcLangExt_Java:     return "Java";
     case SrcLangExt_CSharp:   return "C#";
     case SrcLangExt_D:        return "D";
     case SrcLangExt_PHP:      return "PHP";
     case SrcLangExt_ObjC:     return "Objective-C";
     case SrcLangExt_Cpp:      return "C++";
     case SrcLangExt_JS:       return "JavaScript";
     case SrcLangExt_Python:   return "Python";
     case SrcLangExt_Fortran:  return "Fortran";
     case SrcLangExt_VHDL:     return "VHDL";
     case SrcLangExt_XML:      return "XML";
     case SrcLangExt_SQL:      return "SQL";
     case SrcLangExt_Markdown: return "Markdown";
     case SrcLangExt_Slice:    return "Slice";
     case SrcLangExt_Lex:      return "Lex";
   }
   return "Unknown";
 }

引用了 SrcLangExt_Cpp, SrcLangExt_CSharp, SrcLangExt_D, SrcLangExt_Fortran, SrcLangExt_IDL, SrcLangExt_Java, SrcLangExt_JS, SrcLangExt_Lex, SrcLangExt_Markdown, SrcLangExt_ObjC, SrcLangExt_PHP, SrcLangExt_Python, SrcLangExt_Slice, SrcLangExt_SQL, SrcLangExt_Unknown, SrcLangExt_VHDL , 以及 SrcLangExt_XML.

被这些函数引用 generateXMLForClass(), generateXMLForFile() , 以及 generateXMLForNamespace().

◆ latexEscapeIndexChars()

QCString latexEscapeIndexChars ( const QCString & s )

在文件 util.cpp 第 5129 行定义.

 {
   if (s.isEmpty()) return s;
   QCString tmp(s.length()+1);
   TextStream t;
   const char *p=s.data();
   char c;
   int i;
   while ((c=*p++))
   {
     switch (c)
     {
       case '!': t << "\"!"; break;
       case '"': t << "\"\""; break;
       case '@': t << "\"@"; break;
       case '|': t << "\\texttt{\"|}"; break;
       case '[': t << "["; break;
       case ']': t << "]"; break;
       case '{': t << "\\lcurly{}"; break;
       case '}': t << "\\rcurly{}"; break;
       // NOTE: adding a case here, means adding it to while below as well!
       default:
         i=0;
         // collect as long string as possible, before handing it to docify
         tmp[i++]=c;
         while ((c=*p) && c!='"' && c!='@' && c!='[' && c!=']' && c!='!' && c!='{' && c!='}' && c!='|')
         {
           tmp[i++]=c;
           p++;
         }
         tmp[i]=0;
         filterLatexString(t,tmp,
                           true,   // insideTabbing
                           false,  // insidePre
                           false,  // insideItem
                           false,  // insideTable
                           false   // keepSpaces
                          );
         break;
     }
   }
   return t.str();
 }

引用了 QCString::data(), filterLatexString(), QCString::isEmpty(), QCString::length() , 以及 TextStream::str().

被这些函数引用 LatexGenerator::addIndexItem(), FilterTexIndex::apply(), LatexGenerator::endTitleHead(), LatexGenerator::startMemberDoc() , 以及 LatexDocVisitor::visit().

◆ latexEscapeLabelName()

QCString latexEscapeLabelName ( const QCString & s )

在文件 util.cpp 第 5086 行定义.

 {
   if (s.isEmpty()) return s;
   QCString tmp(s.length()+1);
   TextStream t;
   const char *p=s.data();
   char c;
   int i;
   while ((c=*p++))
   {
     switch (c)
     {
       case '|': t << "\\texttt{\"|}"; break;
       case '!': t << "\"!"; break;
       case '@': t << "\"@"; break;
       case '%': t << "\\%";       break;
       case '{': t << "\\lcurly{}"; break;
       case '}': t << "\\rcurly{}"; break;
       case '~': t << "````~"; break; // to get it a bit better in index together with other special characters
       // NOTE: adding a case here, means adding it to while below as well!
       default:
         i=0;
         // collect as long string as possible, before handing it to docify
         tmp[i++]=c;
         while ((c=*p) && c!='@' && c!='[' && c!=']' && c!='!' && c!='{' && c!='}' && c!='|')
         {
           tmp[i++]=c;
           p++;
         }
         tmp[i]=0;
         filterLatexString(t,tmp,
                           true,  // insideTabbing
                           false, // insidePre
                           false, // insideItem
                           false, // insideTable
                           false  // keepSpaces
                          );
         break;
     }
   }
   return t.str();
 }

引用了 QCString::data(), filterLatexString(), QCString::isEmpty(), QCString::length() , 以及 TextStream::str().

被这些函数引用 LatexGenerator::addIndexItem(), FilterTexLabel::apply(), LatexGenerator::endTitleHead(), LatexGenerator::startMemberDoc() , 以及 LatexDocVisitor::visit().

◆ latexEscapePDFString()

QCString latexEscapePDFString ( const QCString & s )

在文件 util.cpp 第 5173 行定义.

 {
   if (s.isEmpty()) return s;
   TextStream t;
   const char *p=s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '\\': t << "\\textbackslash{}"; break;
       case '{':  t << "\\{"; break;
       case '}':  t << "\\}"; break;
       case '_':  t << "\\_"; break;
       case '%':  t << "\\%"; break;
       case '&':  t << "\\&"; break;
       default:
         t << c;
         break;
     }
   }
   return t.str();
 }

引用了 QCString::data(), QCString::isEmpty() , 以及 TextStream::str().

被这些函数引用 LatexGenerator::startMemberDoc().

◆ latexFilterURL()

QCString latexFilterURL ( const QCString & s )

在文件 util.cpp 第 5197 行定义.

 {
   if (s.isEmpty()) return s;
   TextStream t;
   const signed char *p=(const signed char*)s.data();
   char c;
   while ((c=*p++))
   {
     switch (c)
     {
       case '#':  t << "\\#"; break;
       case '%':  t << "\\%"; break;
       case '\\':  t << "\\\\"; break;
       default:
         if (c<0)
         {
           unsigned char id = (unsigned char)c;
           t << "\\%" << hex[id>>4] << hex[id&0xF];
         }
         else
         {
           t << c;
         }
         break;
     }
   }
   return t.str();
 }

引用了 QCString::data(), hex, QCString::isEmpty() , 以及 TextStream::str().

被这些函数引用 LatexGenerator::startHtmlLink(), LatexDocVisitor::visit() , 以及 LatexDocVisitor::visitPre().

◆ leftScopeMatch()

bool leftScopeMatch	(	const QCString &	scope,
		const QCString &	name
	)

在文件 util.cpp 第 874 行定义.

 {
   int sl=scope.length();
   int nl=name.length();
   return (name==scope || // equal
           (scope.left(nl)==name && // substring
            sl>nl+1 && scope.at(nl)==':' && scope.at(nl+1)==':' // scope
           )
          );
 }

引用了 QCString::at(), QCString::left() , 以及 QCString::length().

被这些函数引用 addClassToContext(), addConceptToContext(), mergeScopes() , 以及 substituteTemplateArgumentsInString().

◆ lineBlock()

int lineBlock	(	const QCString &	text,
		const QCString &	marker
	)

Returns the line number of the line following the line with the marker.

参见: routine extractBlock

在文件 util.cpp 第 6498 行定义.

 {
   int result = 1;
   int p=0,i;
   bool found=FALSE;
  
   // find the character positions of the first marker
   int m1 = text.find(marker);
   if (m1==-1) return result;
  
   // find start line positions for the markers
   while (!found && (i=text.find('\n',p))!=-1)
   {
     found = (p<=m1 && m1<i); // found the line with the start marker
     p=i+1;
     result++;
   }
   return result;
 }

引用了 FALSE , 以及 QCString::find().

被这些函数引用 DocPara::handleInclude(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

◆ linkifyText()

void linkifyText	(	const TextGeneratorIntf &	ol,
		const Definition *	scope,
		const FileDef *	fileScope,
		const Definition *	self,
		const QCString &	text,
		bool	autoBreak = `FALSE`,
		bool	external = `TRUE`,
		bool	keepSpaces = `FALSE`,
		int	indentLevel = `0`
	)

在文件 util.cpp 第 886 行定义.

 {
   if (text.isEmpty()) return;
   //printf("linkify='%s'\n",text);
   std::string txtStr=text.str();
   size_t strLen = txtStr.length();
   if (strLen==0) return;
  
   static const reg::Ex regExp(R"(\a[\w~!\\.:$]*)");
   reg::Iterator it(txtStr,regExp);
   reg::Iterator end;
  
   //printf("linkifyText scope=%s fileScope=%s strtxt=%s strlen=%d external=%d\n",
   //    scope ? qPrint(scope->name()):"<none>",
   //    fileScope ? qPrint(fileScope->name()) : "<none>",
   //    qPrint(txtStr),strLen,external);
   size_t index=0;
   size_t skipIndex=0;
   size_t floatingIndex=0;
   for (; it!=end ; ++it) // for each word from the text string
   {
     const auto &match = *it;
     size_t newIndex = match.position();
     size_t matchLen = match.length();
     floatingIndex+=newIndex-skipIndex+matchLen;
     if (newIndex>0 && txtStr.at(newIndex-1)=='0') // ignore hex numbers (match x00 in 0x00)
     {
       std::string part = txtStr.substr(skipIndex,newIndex+matchLen-skipIndex);
       out.writeString(part.c_str(),keepSpaces);
       skipIndex=index=newIndex+matchLen;
       continue;
     }
  
     // add non-word part to the result
     bool insideString=FALSE;
     for (size_t i=index;i<newIndex;i++)
     {
       if (txtStr.at(i)=='"') insideString=!insideString;
     }
  
     //printf("floatingIndex=%d strlen=%d autoBreak=%d\n",floatingIndex,strLen,autoBreak);
     if (strLen>35 && floatingIndex>30 && autoBreak) // try to insert a split point
     {
       std::string splitText = txtStr.substr(skipIndex,newIndex-skipIndex);
       size_t splitLength = splitText.length();
       size_t offset=1;
       size_t i = splitText.find(',');
       if (i==std::string::npos) { i=splitText.find('<'); if (i!=std::string::npos) offset=0; }
       if (i==std::string::npos) i=splitText.find('>');
       if (i==std::string::npos) i=splitText.find(' ');
       //printf("splitText=[%s] len=%d i=%d offset=%d\n",qPrint(splitText),splitLength,i,offset);
       if (i!=std::string::npos) // add a link-break at i in case of Html output
       {
         std::string part1 = splitText.substr(0,i+offset);
         out.writeString(part1.c_str(),keepSpaces);
         out.writeBreak(indentLevel==0 ? 0 : indentLevel+1);
         std::string part2 = splitText.substr(i+offset);
         out.writeString(part2.c_str(),keepSpaces);
         floatingIndex=splitLength-i-offset+matchLen;
       }
       else
       {
         out.writeString(splitText.c_str(),keepSpaces);
       }
     }
     else
     {
       //ol.docify(txtStr.mid(skipIndex,newIndex-skipIndex));
       std::string part = txtStr.substr(skipIndex,newIndex-skipIndex);
       out.writeString(part.c_str(),keepSpaces);
     }
     // get word from string
     std::string word=txtStr.substr(newIndex,matchLen);
     QCString matchWord = substitute(substitute(QCString(word),"\\","::"),".","::");
     //printf("linkifyText word=%s matchWord=%s scope=%s\n",
     //    qPrint(word),qPrint(matchWord),scope ? qPrint(scope->name()) : "<none>");
     bool found=FALSE;
     if (!insideString)
     {
       const MemberDef    *md=0;
       const ClassDef     *cd=0;
       const FileDef      *fd=0;
       const NamespaceDef *nd=0;
       const GroupDef     *gd=0;
       const ConceptDef   *cnd=0;
       //printf("** Match word '%s'\n",qPrint(matchWord));
  
       SymbolResolver resolver(fileScope);
       cd=resolver.resolveClass(scope,matchWord);
       const MemberDef *typeDef = resolver.getTypedef();
       if (typeDef) // First look at typedef then class, see bug 584184.
       {
         //printf("Found typedef %s\n",qPrint(typeDef->name()));
         if (external ? typeDef->isLinkable() : typeDef->isLinkableInProject())
         {
           if (typeDef->getOuterScope()!=self)
           {
             out.writeLink(typeDef->getReference(),
                 typeDef->getOutputFileBase(),
                 typeDef->anchor(),
                 word.c_str());
             found=TRUE;
           }
         }
       }
       if (!found && (cd || (cd=getClass(matchWord))))
       {
         //printf("Found class %s\n",qPrint(cd->name()));
         // add link to the result
         if (external ? cd->isLinkable() : cd->isLinkableInProject())
         {
           if (cd!=self)
           {
             out.writeLink(cd->getReference(),cd->getOutputFileBase(),cd->anchor(),word.c_str());
             found=TRUE;
           }
         }
       }
       else if ((cd=getClass(matchWord+"-p"))) // search for Obj-C protocols as well
       {
         // add link to the result
         if (external ? cd->isLinkable() : cd->isLinkableInProject())
         {
           if (cd!=self)
           {
             out.writeLink(cd->getReference(),cd->getOutputFileBase(),cd->anchor(),word.c_str());
             found=TRUE;
           }
         }
       }
       else if ((cnd=getConcept(matchWord)))
       {
         // add link to the result
         if (external ? cnd->isLinkable() : cnd->isLinkableInProject())
         {
           if (cnd!=self)
           {
             out.writeLink(cnd->getReference(),cnd->getOutputFileBase(),cnd->anchor(),word.c_str());
             found=TRUE;
           }
         }
       }
       else
       {
         //printf("   -> nothing\n");
       }
  
       int m = matchWord.findRev("::");
       QCString scopeName;
       if (scope &&
           (scope->definitionType()==Definition::TypeClass ||
            scope->definitionType()==Definition::TypeNamespace
           )
          )
       {
         scopeName=scope->name();
       }
       else if (m!=-1)
       {
         scopeName = matchWord.left(m);
         matchWord = matchWord.mid(m+2);
       }
  
       //printf("ScopeName=%s\n",qPrint(scopeName));
       //if (!found) printf("Trying to link %s in %s\n",qPrint(word),qPrint(scopeName));
       if (!found &&
           getDefs(scopeName,matchWord,QCString(),md,cd,fd,nd,gd) &&
           //(md->isTypedef() || md->isEnumerate() ||
           // md->isReference() || md->isVariable()
           //) &&
           (external ? md->isLinkable() : md->isLinkableInProject())
          )
       {
         //printf("Found ref scope=%s\n",d ? qPrint(d->name()) : "<global>");
         //ol.writeObjectLink(d->getReference(),d->getOutputFileBase(),
         //                       md->anchor(),word);
         if (md!=self && (self==0 || md->name()!=self->name()))
           // name check is needed for overloaded members, where getDefs just returns one
         {
           /* in case of Fortran scop and the variable is a non Fortran variable: don't link,
            * see also getLink in fortrancode.l
            */
           if (!(scope && (scope->getLanguage() == SrcLangExt_Fortran) && md->isVariable() && (md->getLanguage() != SrcLangExt_Fortran)))
           {
             out.writeLink(md->getReference(),md->getOutputFileBase(),
                 md->anchor(),word.c_str());
             //printf("found symbol %s\n",qPrint(matchWord));
             found=TRUE;
           }
         }
       }
     }
  
     if (!found) // add word to the result
     {
       out.writeString(word.c_str(),keepSpaces);
     }
     // set next start point in the string
     //printf("index=%d/%d\n",index,txtStr.length());
     skipIndex=index=newIndex+matchLen;
   }
   // add last part of the string to the result.
   //ol.docify(txtStr.right(txtStr.length()-skipIndex));
   std::string lastPart = txtStr.substr(skipIndex);
   out.writeString(lastPart.c_str(),keepSpaces);
 }

引用了 ConceptDef::anchor(), MemberDef::anchor(), ClassDef::anchor(), Definition::definitionType(), end(), FALSE, QCString::findRev(), getClass(), getConcept(), getDefs(), Definition::getLanguage(), Definition::getOuterScope(), ConceptDef::getOutputFileBase(), MemberDef::getOutputFileBase(), ClassDef::getOutputFileBase(), MemberDef::getReference(), ClassDef::getReference(), Definition::getReference(), SymbolResolver::getTypedef(), QCString::isEmpty(), ConceptDef::isLinkable(), MemberDef::isLinkable(), ClassDef::isLinkable(), ConceptDef::isLinkableInProject(), MemberDef::isLinkableInProject(), ClassDef::isLinkableInProject(), MemberDef::isVariable(), QCString::left(), reg::match(), QCString::mid(), Definition::name(), SymbolResolver::resolveClass(), SrcLangExt_Fortran, QCString::str(), substitute(), TRUE, Definition::TypeClass, Definition::TypeNamespace, TextGeneratorIntf::writeBreak(), TextGeneratorIntf::writeLink() , 以及 TextGeneratorIntf::writeString().

被这些函数引用 MemberDefImpl::_writeTemplatePrefix(), createLinkedText(), generateXMLForClass(), generateXMLForConcept(), generateXMLForMember(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), MemberDefImpl::writeMemberDocSimple(), writeTemplateArgumentList(), ClassDefImpl::writeTemplateSpec() , 以及 writeTypeConstraints().

◆ linkToText()

QCString linkToText	(	SrcLangExt	lang,
		const QCString &	link,
		bool	isFileName
	)

在文件 util.cpp 第 2943 行定义.

 {
   //static bool optimizeOutputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
   QCString result=link;
   if (!result.isEmpty())
   {
     // replace # by ::
     result=substitute(result,"#","::");
     // replace . by ::
     if (!isFileName && result.find('<')==-1) result=substitute(result,".","::",3);
     // strip leading :: prefix if present
     if (result.at(0)==':' && result.at(1)==':')
     {
       result=result.right(result.length()-2);
     }
     QCString sep = getLanguageSpecificSeparator(lang);
     if (sep!="::")
     {
       result=substitute(result,"::",sep);
     }
   }
   return result;
 }

引用了 QCString::at(), QCString::find(), getLanguageSpecificSeparator(), QCString::isEmpty(), QCString::length(), QCString::right() , 以及 substitute().

被这些函数引用 DotCallGraph::buildGraph(), DocRef::DocRef(), DotCallGraph::DotCallGraph(), generateLink() , 以及 DocParser::handleLinkedWord().

◆ mainPageHasTitle()

bool mainPageHasTitle ( )

在文件 util.cpp 第 7027 行定义.

 {
   return Doxygen::mainPage!=0 && Doxygen::mainPage->hasTitle();
 }

引用了 Doxygen::mainPage.

被这些函数引用 RTFGenerator::endIndexSection(), generateJSNavTree(), generateXMLForPage(), mainPageHasOwnTitle() , 以及 writeIndex().

◆ matchArguments2()

bool matchArguments2	(	const Definition *	srcScope,
		const FileDef *	srcFileScope,
		const ArgumentList *	srcAl,
		const Definition *	dstScope,
		const FileDef *	dstFileScope,
		const ArgumentList *	dstAl,
		bool	checkCV
	)

在文件 util.cpp 第 1919 行定义.

 {
   ASSERT(srcScope!=0 && dstScope!=0);
  
   if (srcAl==0 || dstAl==0)
   {
     bool match = srcAl==dstAl;
     if (match)
     {
       MATCH
       return TRUE;
     }
     else
     {
       NOMATCH
       return FALSE;
     }
   }
  
   // handle special case with void argument
   if ( srcAl->empty() && dstAl->size()==1 && dstAl->front().type=="void" )
   { // special case for finding match between func() and func(void)
     Argument a;
     a.type = "void";
     const_cast<ArgumentList*>(srcAl)->push_back(a);
     MATCH
     return TRUE;
   }
   if ( dstAl->empty() && srcAl->size()==1 && srcAl->front().type=="void" )
   { // special case for finding match between func(void) and func()
     Argument a;
     a.type = "void";
     const_cast<ArgumentList*>(dstAl)->push_back(a);
     MATCH
     return TRUE;
   }
  
   if (srcAl->size() != dstAl->size())
   {
     NOMATCH
     return FALSE; // different number of arguments -> no match
   }
  
   if (checkCV)
   {
     if (srcAl->constSpecifier() != dstAl->constSpecifier())
     {
       NOMATCH
       return FALSE; // one member is const, the other not -> no match
     }
     if (srcAl->volatileSpecifier() != dstAl->volatileSpecifier())
     {
       NOMATCH
       return FALSE; // one member is volatile, the other not -> no match
     }
   }
  
   if (srcAl->refQualifier() != dstAl->refQualifier())
   {
     NOMATCH
     return FALSE; // one member is has a different ref-qualifier than the other
   }
  
   // so far the argument list could match, so we need to compare the types of
   // all arguments.
   auto srcIt = srcAl->begin();
   auto dstIt = dstAl->begin();
   for (;srcIt!=srcAl->end() && dstIt!=dstAl->end();++srcIt,++dstIt)
   {
     Argument &srcA = const_cast<Argument&>(*srcIt);
     Argument &dstA = const_cast<Argument&>(*dstIt);
     if (!matchArgument2(srcScope,srcFileScope,srcA,
           dstScope,dstFileScope,dstA)
        )
     {
       NOMATCH
       return FALSE;
     }
   }
   MATCH
   return TRUE; // all arguments match
 }

引用了 ASSERT, ArgumentList::begin(), ArgumentList::constSpecifier(), ArgumentList::empty(), ArgumentList::end(), FALSE, ArgumentList::front(), reg::match(), MATCH, matchArgument2(), NOMATCH, ArgumentList::refQualifier(), ArgumentList::size(), TRUE, Argument::type , 以及 ArgumentList::volatileSpecifier().

被这些函数引用 addMemberDocs(), addMemberFunction(), combineDeclarationAndDefinition(), computeMemberRelations(), findGlobalMember(), findMember(), findMembersWithSpecificName(), getDefs(), GroupDefImpl::insertMember(), ClassDefImpl::mergeMembers(), transferFunctionReferences() , 以及 transferRelatedFunctionDocumentation().

◆ mergeArguments()

void mergeArguments	(	ArgumentList &	,
		ArgumentList &	,
		bool	forceNameOverwrite = `FALSE`
	)

在文件 util.cpp 第 2008 行定义.

 {
   //printf("mergeArguments '%s', '%s'\n",
   //    qPrint(argListToString(srcAl)),qPrint(argListToString(dstAl)));
  
   if (srcAl.size()!=dstAl.size())
   {
     return; // invalid argument lists -> do not merge
   }
  
   auto srcIt=srcAl.begin();
   auto dstIt=dstAl.begin();
   while (srcIt!=srcAl.end() && dstIt!=dstAl.end())
   {
     Argument &srcA = *srcIt;
     Argument &dstA = *dstIt;
  
     if (srcA.defval.isEmpty() && !dstA.defval.isEmpty())
     {
       //printf("Defval changing '%s'->'%s'\n",qPrint(srcA.defval),qPrint(dstA.defval));
       srcA.defval=dstA.defval;
     }
     else if (!srcA.defval.isEmpty() && dstA.defval.isEmpty())
     {
       //printf("Defval changing '%s'->'%s'\n",qPrint(dstA.defval),qPrint(srcA.defval));
       dstA.defval=srcA.defval;
     }
  
     // fix wrongly detected const or volatile specifiers before merging.
     // example: "const A *const" is detected as type="const A *" name="const"
     if (srcA.name=="const" || srcA.name=="volatile")
     {
       srcA.type+=" "+srcA.name;
       srcA.name.resize(0);
     }
     if (dstA.name=="const" || dstA.name=="volatile")
     {
       dstA.type+=" "+dstA.name;
       dstA.name.resize(0);
     }
  
     if (srcA.type==dstA.type)
     {
       //printf("1. merging %s:%s <-> %s:%s\n",qPrint(srcA.type),qPrint(srcA.name),qPrint(dstA.type),qPrint(dstA.name));
       if (srcA.name.isEmpty() && !dstA.name.isEmpty())
       {
         //printf("type: '%s':='%s'\n",qPrint(srcA.type),qPrint(dstA.type));
         //printf("name: '%s':='%s'\n",qPrint(srcA.name),qPrint(dstA.name));
         srcA.type = dstA.type;
         srcA.name = dstA.name;
       }
       else if (!srcA.name.isEmpty() && dstA.name.isEmpty())
       {
         //printf("type: '%s':='%s'\n",qPrint(dstA.type),qPrint(srcA.type));
         //printf("name: '%s':='%s'\n",qPrint(dstA.name),qPrint(srcA.name));
         dstA.type = srcA.type;
         dstA.name = srcA.name;
       }
       else if (!srcA.name.isEmpty() && !dstA.name.isEmpty())
       {
         //printf("srcA.name=%s dstA.name=%s\n",qPrint(srcA.name),qPrint(dstA.name));
         if (forceNameOverwrite)
         {
           srcA.name = dstA.name;
         }
         else
         {
           if (srcA.docs.isEmpty() && !dstA.docs.isEmpty())
           {
             srcA.name = dstA.name;
           }
           else if (!srcA.docs.isEmpty() && dstA.docs.isEmpty())
           {
             dstA.name = srcA.name;
           }
         }
       }
     }
     else
     {
       //printf("2. merging '%s':'%s' <-> '%s':'%s'\n",qPrint(srcA.type),qPrint(srcA.name),qPrint(dstA.type),qPrint(dstA.name));
       srcA.type=srcA.type.stripWhiteSpace();
       dstA.type=dstA.type.stripWhiteSpace();
       if (srcA.type+" "+srcA.name==dstA.type) // "unsigned long:int" <-> "unsigned long int:bla"
       {
         srcA.type+=" "+srcA.name;
         srcA.name=dstA.name;
       }
       else if (dstA.type+" "+dstA.name==srcA.type) // "unsigned long int bla" <-> "unsigned long int"
       {
         dstA.type+=" "+dstA.name;
         dstA.name=srcA.name;
       }
       else if (srcA.name.isEmpty() && !dstA.name.isEmpty())
       {
         srcA.name = dstA.name;
       }
       else if (dstA.name.isEmpty() && !srcA.name.isEmpty())
       {
         dstA.name = srcA.name;
       }
     }
     int i1=srcA.type.find("::"),
         i2=dstA.type.find("::"),
         j1=srcA.type.length()-i1-2,
         j2=dstA.type.length()-i2-2;
     if (i1!=-1 && i2==-1 && srcA.type.right(j1)==dstA.type)
     {
       //printf("type: '%s':='%s'\n",qPrint(dstA.type),qPrint(srcA.type));
       //printf("name: '%s':='%s'\n",qPrint(dstA.name),qPrint(srcA.name));
       dstA.type = srcA.type.left(i1+2)+dstA.type;
       dstA.name = srcA.name;
     }
     else if (i1==-1 && i2!=-1 && dstA.type.right(j2)==srcA.type)
     {
       //printf("type: '%s':='%s'\n",qPrint(srcA.type),qPrint(dstA.type));
       //printf("name: '%s':='%s'\n",qPrint(dstA.name),qPrint(srcA.name));
       srcA.type = dstA.type.left(i2+2)+srcA.type;
       srcA.name = dstA.name;
     }
     if (srcA.docs.isEmpty() && !dstA.docs.isEmpty())
     {
       srcA.docs = dstA.docs;
     }
     else if (dstA.docs.isEmpty() && !srcA.docs.isEmpty())
     {
       dstA.docs = srcA.docs;
     }
     //printf("Merge argument '%s|%s' '%s|%s'\n",
     //  qPrint(srcA.type), qPrint(srcA.name),
     //  qPrint(dstA.type), qPrint(dstA.name));
     ++srcIt;
     ++dstIt;
   }
 }

引用了 ArgumentList::begin(), Argument::defval, Argument::docs, ArgumentList::end(), QCString::find(), QCString::isEmpty(), QCString::left(), QCString::length(), Argument::name, QCString::resize(), QCString::right(), ArgumentList::size(), QCString::stripWhiteSpace() , 以及 Argument::type.

被这些函数引用 addMemberDocs().

◆ mergeScopes()

QCString mergeScopes	(	const QCString &	leftScope,
		const QCString &	rightScope
	)

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.

返回: the merged scope.

在文件 util.cpp 第 4667 行定义.

 {
   // case leftScope=="A" rightScope=="A::B" => result = "A::B"
   if (leftScopeMatch(rightScope,leftScope)) return rightScope;
   QCString result;
   int i=0,p=leftScope.length();
  
   // case leftScope=="A::B" rightScope=="B::C" => result = "A::B::C"
   // case leftScope=="A::B" rightScope=="B" => result = "A::B"
   bool found=FALSE;
   while ((i=leftScope.findRev("::",p))>0)
   {
     if (leftScopeMatch(rightScope,leftScope.right(leftScope.length()-i-2)))
     {
       result = leftScope.left(i+2)+rightScope;
       found=TRUE;
     }
     p=i-1;
   }
   if (found) return result;
  
   // case leftScope=="A" rightScope=="B" => result = "A::B"
   result=leftScope;
   if (!result.isEmpty() && !rightScope.isEmpty()) result+="::";
   result+=rightScope;
   return result;
 }

引用了 FALSE, QCString::findRev(), QCString::isEmpty(), QCString::left(), leftScopeMatch(), QCString::length(), QCString::right() , 以及 TRUE.

被这些函数引用 addEnumValuesToEnums(), findEnums() , 以及 findMember().

◆ nextUtf8CharPosition()

int nextUtf8CharPosition	(	const QCString &	utf8Str,
		uint	len,
		uint	startPos
	)

◆ normalizeNonTemplateArgumentsInString()

QCString normalizeNonTemplateArgumentsInString	(	const QCString &	name,
		const Definition *	context,
		const ArgumentList &	formalArgs
	)

在文件 util.cpp 第 4412 行定义.

 {
   // skip until <
   int p=name.find('<');
   if (p==-1) return name;
   p++;
   QCString result = name.left(p);
  
   std::string s = result.mid(p).str();
   static const reg::Ex re(R"([\a:][\w:]*)");
   reg::Iterator it(s,re);
   reg::Iterator end;
   size_t pi=0;
   // for each identifier in the template part (e.g. B<T> -> T)
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     size_t i = match.position();
     size_t l = match.length();
     result += s.substr(pi,i-pi);
     QCString n(match.str());
     bool found=FALSE;
     for (const Argument &formArg : formalArgs)
     {
       if (formArg.name == n)
       {
         found=TRUE;
         break;
       }
     }
     if (!found)
     {
       // try to resolve the type
       SymbolResolver resolver;
       const ClassDef *cd = resolver.resolveClass(context,n);
       if (cd)
       {
         result+=cd->name();
       }
       else
       {
         result+=n;
       }
     }
     else
     {
       result+=n;
     }
     pi=i+l;
   }
   result+=s.substr(pi);
   //printf("normalizeNonTemplateArgumentInString(%s)=%s\n",qPrint(name),qPrint(result));
   return removeRedundantWhiteSpace(result);
 }

引用了 end(), FALSE, QCString::find(), QCString::left(), reg::match(), QCString::mid(), Definition::name(), removeRedundantWhiteSpace(), SymbolResolver::resolveClass(), QCString::str() , 以及 TRUE.

被这些函数引用 findUsedClassesForClass().

◆ openOutputFile()

bool openOutputFile	(	const QCString &	outFile,
		std::ofstream &	f
	)

在文件 util.cpp 第 7039 行定义.

 {
   assert(!f.is_open());
   bool fileOpened=FALSE;
   bool writeToStdout=outFile=="-";
   if (writeToStdout) // write to stdout
   {
     f.basic_ios<char>::rdbuf(std::cout.rdbuf());
     fileOpened = true;
   }
   else // write to file
   {
     FileInfo fi(outFile.str());
     if (fi.exists()) // create a backup
     {
       Dir dir;
       FileInfo backup(fi.fileName()+".bak");
       if (backup.exists()) // remove existing backup
         dir.remove(backup.fileName());
       dir.rename(fi.fileName(),fi.fileName()+".bak");
     }
     f.open(outFile.str(),std::ofstream::out | std::ofstream::binary);
     fileOpened = f.is_open();
   }
   return fileOpened;
 }

引用了 FileInfo::exists(), FALSE, FileInfo::fileName(), Dir::remove(), Dir::rename() , 以及 QCString::str().

被这些函数引用 compareDoxyfile(), generateConfigFile(), readConfiguration() , 以及 writeDefaultLayoutFile().

◆ parseCommentAsText()

QCString parseCommentAsText	(	const Definition *	scope,
		const MemberDef *	member,
		const QCString &	doc,
		const QCString &	fileName,
		int	lineNr
	)

在文件 util.cpp 第 5738 行定义.

 {
   if (doc.isEmpty()) return "";
   //printf("parseCommentAsText(%s)\n",qPrint(doc));
   TextStream t;
   std::unique_ptr<IDocParser> parser { createDocParser() };
   std::unique_ptr<DocRoot>    root   { validatingParseDoc(*parser.get(),
                                        fileName,lineNr,
                                        (Definition*)scope,(MemberDef*)md,doc,FALSE,FALSE,
                                        QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
   auto visitor = std::make_unique<TextDocVisitor>(t);
   root->accept(visitor.get());
   QCString result = convertCharEntitiesToUTF8(t.str().c_str()).stripWhiteSpace();
   int i=0;
   int charCnt=0;
   int l=result.length();
   while ((i=nextUTF8CharPosition(result,l,i))<l)
   {
     charCnt++;
     if (charCnt>=80) break;
   }
   if (charCnt>=80) // try to truncate the string
   {
     while ((i=nextUTF8CharPosition(result,l,i))<l && charCnt<100)
     {
       charCnt++;
       if (result.at(i)==',' ||
           result.at(i)=='.' ||
           result.at(i)=='!' ||
           result.at(i)=='?')
       {
         i++; // we want to be "behind" last inspected character
         break;
       }
     }
   }
   if ( i < l) result=result.left(i)+"...";
   return result.data();
 }

引用了 QCString::at(), Config_getBool, convertCharEntitiesToUTF8(), createDocParser(), QCString::data(), FALSE, QCString::isEmpty(), QCString::left(), QCString::length(), nextUTF8CharPosition(), TextStream::str(), QCString::stripWhiteSpace() , 以及 validatingParseDoc().

被这些函数引用 DefinitionImpl::computeTooltip() , 以及 formatBriefNote().

◆ patternMatch()

bool patternMatch	(	const FileInfo &	fi,
		const StringVector &	patList
	)

在文件 util.cpp 第 6279 行定义.

 {
   bool caseSenseNames = Config_getBool(CASE_SENSE_NAMES);
   bool found = FALSE;
  
   // For platforms where the file system is non case sensitive overrule the setting
   if (!Portable::fileSystemIsCaseSensitive())
   {
     caseSenseNames = FALSE;
   }
  
   if (!patList.empty())
   {
     std::string fn = fi.fileName();
     std::string fp = fi.filePath();
     std::string afp= fi.absFilePath();
  
     for (auto pattern: patList)
     {
       if (!pattern.empty())
       {
         size_t i=pattern.find('=');
         if (i!=std::string::npos) pattern=pattern.substr(0,i); // strip of the extension specific filter name
  
         if (!caseSenseNames)
         {
           pattern = QCString(pattern).lower().str();
           fn      = QCString(fn).lower().str();
           fp      = QCString(fp).lower().str();
           afp     = QCString(afp).lower().str();
         }
         reg::Ex re(pattern,reg::Ex::Mode::Wildcard);
         found = re.isValid() && (reg::match(fn,re) ||
                                  (fn!=fp && reg::match(fp,re)) ||
                                  (fn!=afp && fp!=afp && reg::match(afp,re)));
         if (found) break;
         //printf("Matching '%s' against pattern '%s' found=%d\n",
         //    qPrint(fi->fileName()),qPrint(pattern),found);
       }
     }
   }
   return found;
 }

引用了 FileInfo::absFilePath(), Config_getBool, FALSE, FileInfo::fileName(), FileInfo::filePath(), Portable::fileSystemIsCaseSensitive(), reg::Ex::isValid(), QCString::lower(), reg::match(), QCString::str() , 以及 reg::Ex::Wildcard.

被这些函数引用 readDir().

◆ processMarkup()

QCString processMarkup ( const QCString & s )

◆ protectionLevelVisible()

bool protectionLevelVisible ( Protection prot )

在文件 util.cpp 第 6585 行定义.

 {
   static bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
   static bool extractPackage = Config_getBool(EXTRACT_PACKAGE);
  
   return (prot!=Private && prot!=Package)  ||
          (prot==Private && extractPrivate) ||
          (prot==Package && extractPackage);
 }

引用了 Config_getBool, Package , 以及 Private.

被这些函数引用 MemberDefImpl::_computeLinkableInProject(), computeClassRelations(), MemberDefImpl::hasDetailedDescription(), ClassDefImpl::internalInsertMember(), MemberDefImpl::isBriefSectionVisible(), ClassDefImpl::isLinkableInProject(), ClassDefImpl::isVisibleInHierarchy(), AllMembersListContext::Private::Private(), MemberDefImpl::warnIfUndocumented(), ClassDefImpl::writeDocumentationForInnerClasses(), ClassDefImpl::writeMemberList() , 以及 ClassDefImpl::writeTagFile().

◆ readInputFile()

bool readInputFile	(	const QCString &	fileName,
		BufStr &	inBuf,
		bool	filter = `TRUE`,
		bool	isSourceCode = `FALSE`
	)

read a file name fileName and optionally filter and transcode it

在文件 util.cpp 第 6158 行定义.

 {
   // try to open file
   int size=0;
  
   FileInfo fi(fileName.str());
   if (!fi.exists()) return FALSE;
   QCString filterName = getFileFilter(fileName,isSourceCode);
   if (filterName.isEmpty() || !filter)
   {
     std::ifstream f(fileName.str(),std::ifstream::in | std::ifstream::binary);
     if (!f.is_open())
     {
       err("could not open file %s\n",qPrint(fileName));
       return FALSE;
     }
     size=(int)fi.size();
     // read the file
     inBuf.skip(size);
     f.read(inBuf.data(),size);
     if (f.fail())
     {
       err("problems while reading file %s\n",qPrint(fileName));
       return FALSE;
     }
   }
   else
   {
     QCString cmd=filterName+" \""+fileName+"\"";
     Debug::print(Debug::ExtCmd,0,"Executing popen(`%s`)\n",qPrint(cmd));
     FILE *f=Portable::popen(cmd,"r");
     if (!f)
     {
       err("could not execute filter %s\n",qPrint(filterName));
       return FALSE;
     }
     const int bufSize=1024;
     char buf[bufSize];
     int numRead;
     while ((numRead=(int)fread(buf,1,bufSize,f))>0)
     {
       //printf(">>>>>>>>Reading %d bytes\n",numRead);
       inBuf.addArray(buf,numRead),size+=numRead;
     }
     Portable::pclose(f);
     inBuf.at(inBuf.curPos()) ='\0';
     Debug::print(Debug::FilterOutput, 0, "Filter output\n");
     Debug::print(Debug::FilterOutput,0,"-------------\n%s\n-------------\n",qPrint(inBuf));
   }
  
   int start=0;
   if (size>=2 &&
       ((uchar)inBuf.at(0)==0xFF && (uchar)inBuf.at(1)==0xFE) // Little endian BOM
      ) // UCS-2LE encoded file
   {
     transcodeCharacterBuffer(fileName,inBuf,inBuf.curPos(),
         "UCS-2LE","UTF-8");
   }
   else if (size>=2 &&
            ((uchar)inBuf.at(0)==0xFE && (uchar)inBuf.at(1)==0xFF) // big endian BOM
          ) // UCS-2BE encoded file
   {
     transcodeCharacterBuffer(fileName,inBuf,inBuf.curPos(),
         "UCS-2BE","UTF-8");
   }
   else if (size>=3 &&
            (uchar)inBuf.at(0)==0xEF &&
            (uchar)inBuf.at(1)==0xBB &&
            (uchar)inBuf.at(2)==0xBF
      ) // UTF-8 encoded file
   {
     inBuf.dropFromStart(3); // remove UTF-8 BOM: no translation needed
   }
   else // transcode according to the INPUT_ENCODING setting
   {
     // do character transcoding if needed.
     transcodeCharacterBuffer(fileName,inBuf,inBuf.curPos(),
         Config_getString(INPUT_ENCODING),"UTF-8");
   }
  
   //inBuf.addChar('\n'); /* to prevent problems under Windows ? */
  
   // and translate CR's
   size=inBuf.curPos()-start;
   int newSize=filterCRLF(inBuf.data()+start,size);
   //printf("filter char at %p size=%d newSize=%d\n",qPrint(dest)+oldPos,size,newSize);
   if (newSize!=size) // we removed chars
   {
     inBuf.shrink(newSize); // resize the array
     //printf(".......resizing from %d to %d result=[%s]\n",oldPos+size,oldPos+newSize,qPrint(dest));
   }
   inBuf.addChar(0);
   return TRUE;
 }

引用了 BufStr::addArray(), BufStr::addChar(), BufStr::at(), Config_getString, BufStr::curPos(), BufStr::data(), BufStr::dropFromStart(), err(), FileInfo::exists(), Debug::ExtCmd, FALSE, filterCRLF(), Debug::FilterOutput, getFileFilter(), QCString::isEmpty(), Portable::pclose(), Portable::popen(), Debug::print(), qPrint(), BufStr::shrink(), FileInfo::size(), BufStr::skip(), QCString::str(), transcodeCharacterBuffer() , 以及 TRUE.

被这些函数引用 fileToString() , 以及 parseFile().

◆ recodeString()

QCString recodeString	(	const QCString &	str,
		const char *	fromEncoding,
		const char *	toEncoding
	)

◆ recognizeFixedForm()

bool recognizeFixedForm	(	const QCString &	contents,
		FortranFormat	format
	)

在文件 util.cpp 第 7112 行定义.

 {
   int column=0;
   bool skipLine=FALSE;
  
   if (format == FortranFormat_Fixed) return TRUE;
   if (format == FortranFormat_Free)  return FALSE;
  
   for (int i=0;;i++)
   {
     column++;
  
     switch(contents[i])
     {
       case '\n':
         column=0;
         skipLine=FALSE;
         break;
       case ' ':
         break;
       case '\000':
         return FALSE;
       case '#':
         skipLine=TRUE;
         break;
       case 'C':
       case 'c':
       case '*':
         if (column==1) return TRUE;
         if (skipLine) break;
         return FALSE;
       case '!':
         if (column>1 && column<7) return FALSE;
         skipLine=TRUE;
         break;
       default:
         if (skipLine) break;
         if (column>=7) return TRUE;
         return FALSE;
     }
   }
   return FALSE;
 }

引用了 FALSE, FortranFormat_Fixed, FortranFormat_Free , 以及 TRUE.

◆ relativePathToRoot()

QCString relativePathToRoot ( const QCString & name )

在文件 util.cpp 第 3656 行定义.

 {
   QCString result;
   if (Config_getBool(CREATE_SUBDIRS))
   {
     if (name.isEmpty())
     {
       return REL_PATH_TO_ROOT;
     }
     else
     {
       int i = name.findRev('/');
       if (i!=-1)
       {
         result=REL_PATH_TO_ROOT;
       }
     }
   }
   return result;
 }

引用了 Config_getBool, QCString::findRev(), QCString::isEmpty() , 以及 REL_PATH_TO_ROOT.

被这些函数引用 generateBriefDoc(), RTFGenerator::startFile(), HtmlGenerator::startFile(), LatexGenerator::startFile(), DocbookGenerator::startFile() , 以及 validatingParseDoc().

◆ removeAnonymousScopes()

QCString removeAnonymousScopes ( const QCString & str )

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"

在文件 util.cpp 第 166 行定义.

 {
   std::string result;
   if (str.isEmpty()) return QCString(result);
  
   // helper to check if the found delimiter starts with a colon
   auto startsWithColon = [](const std::string &del)
   {
     for (size_t i=0;i<del.size();i++)
     {
       if (del[i]=='@') return false;
       else if (del[i]==':') return true;
     }
     return false;
   };
  
   // helper to check if the found delimiter ends with a colon
   auto endsWithColon = [](const std::string &del)
   {
     for (int i=(int)del.size()-1;i>=0;i--)
     {
       if (del[i]=='@') return false;
       else if (del[i]==':') return true;
     }
     return false;
   };
  
   static const reg::Ex re(R"([\s:]*@\d+[\s:]*)");
   std::string s = str.str();
   reg::Iterator iter(s,re);
   reg::Iterator end;
   size_t p=0;
   size_t sl=s.length();
   bool needsSeparator=false;
   for ( ; iter!=end ; ++iter)
   {
     const auto &match = *iter;
     size_t i = match.position();
     if (i>p) // add non-matching prefix
     {
       if (needsSeparator) result+="::";
       needsSeparator=false;
       result+=s.substr(p,i-p);
     }
     std::string delim = match.str();
     needsSeparator = needsSeparator || (startsWithColon(delim) && endsWithColon(delim));
     p = match.position()+match.length();
   }
   if (p<sl) // add trailing remainder
   {
     if (needsSeparator) result+="::";
     result+=s.substr(p);
   }
   return result;
 }

引用了 end(), reg::match() , 以及 TextStream::str().

被这些函数引用 createTagLessInstance(), makeDisplayName(), simplifyTypeForTable() , 以及 MemberDefImpl::writeDeclaration().

◆ removeEmptyLines()

QCString removeEmptyLines ( const QCString & s )

在文件 util.cpp 第 7251 行定义.

 {
   BufStr out(s.length()+1);
   const char *p=s.data();
   if (p)
   {
     char c;
     while ((c=*p++))
     {
       if (c=='\n')
       {
         const char *e = p;
         while (*e==' ' || *e=='\t') e++;
         if (*e=='\n')
         {
           p=e;
         }
         else out.addChar(c);
       }
       else
       {
         out.addChar(c);
       }
     }
   }
   out.addChar('\0');
   //printf("removeEmptyLines(%s)=%s\n",qPrint(s),qPrint(out));
   return out.data();
 }

引用了 BufStr::addChar(), BufStr::data(), QCString::data() , 以及 QCString::length().

被这些函数引用 substituteHtmlKeywords() , 以及 substituteLatexKeywords().

◆ removeRedundantWhiteSpace()

QCString removeRedundantWhiteSpace ( const QCString & s )

在文件 util.cpp 第 544 行定义.

 {
   bool cliSupport = Config_getBool(CPP_CLI_SUPPORT);
   bool vhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  
   if (s.isEmpty() || vhdl) return s;
  
   // We use a static character array to
   // improve the performance of this function
   // and thread_local is needed to make it multi-thread safe
   static THREAD_LOCAL char *growBuf = 0;
   static THREAD_LOCAL int growBufLen = 0;
   if ((int)s.length()*3>growBufLen) // For input character we produce at most 3 output characters,
   {
     growBufLen = s.length()*3;
     growBuf = (char *)realloc(growBuf,growBufLen+1); // add 1 for 0-terminator
   }
   if (growBuf==0) return s; // should not happen, only we run out of memory
  
   const char *src=s.data();
   char *dst=growBuf;
  
   uint i=0;
   uint l=s.length();
   uint csp=0;
   uint vosp=0;
   uint vsp=0;
   uint osp=0;
   char c;
   char pc=0;
   // skip leading whitespace
   while (i<l && isspace((uchar)src[i]))
   {
     i++;
   }
   for (;i<l;i++)
   {
     c=src[i];
     char nc=i<l-1 ? src[i+1] : ' ';
  
     // search for "const"
     if (csp<6 && c==constScope[csp] && // character matches substring "const"
          (csp>0 ||                     // inside search string
           i==0  ||                     // if it is the first character
           !isId(pc)                    // the previous may not be a digit
          )
        )
       csp++;
     else // reset counter
       csp=0;
  
     if (vosp<6 && c==volatileScope[vosp] && // character matches substring "volatile"
          (vosp>0 ||                     // inside search string
           i==0  ||                     // if it is the first character
           !isId(pc)                    // the previous may not be a digit
          )
        )
       vosp++;
     else // reset counter
       vosp=0;
  
     // search for "virtual"
     if (vsp<8 && c==virtualScope[vsp] && // character matches substring "virtual"
          (vsp>0 ||                       // inside search string
           i==0  ||                       // if it is the first character
           !isId(pc)                      // the previous may not be a digit
          )
        )
       vsp++;
     else // reset counter
       vsp=0;
  
     // search for "operator"
     if (osp<11 && (osp>=8 || c==operatorScope[osp]) && // character matches substring "operator" followed by 3 arbitrary characters
         (osp>0 ||                         // inside search string
          i==0 ||                          // if it is the first character
          !isId(pc)                        // the previous may not be a digit
         )
        )
       osp++;
     else // reset counter
       osp=0;
  
     switch(c)
     {
       case '"': // quoted string
         {
           *dst++=c;
           pc = c;
           i++;
           for (;i<l;i++) // find end of string
           {
             c = src[i];
             *dst++=c;
             if (c=='\\' && i+1<l)
             {
               pc = c;
               i++;
               c = src[i];
               *dst++=c;
             }
             else if (c=='"')
             {
               break;
             }
             pc = c;
           }
         }
         break;
       case '<': // current char is a <
         *dst++=c;
         if (i<l-1 &&
             (isId(nc)) && // next char is an id char
             (osp<8) // string in front is not "operator"
            )
         {
           *dst++=' '; // add extra space
         }
         break;
       case '>': // current char is a >
         if (i>0 && !isspace((uchar)pc) &&
             (isId(pc) || pc=='*' || pc=='&' || pc=='.' || pc=='>') && // prev char is an id char or space or *&.
             (osp<8 || (osp==8 && pc!='-')) // string in front is not "operator>" or "operator->"
            )
         {
           *dst++=' '; // add extra space in front
         }
         *dst++=c;
         if (i<l-1 && (nc=='-' || nc=='&')) // '>-' -> '> -'
         {
           *dst++=' '; // add extra space after
         }
         break;
       case ',': // current char is a ,
         *dst++=c;
         if (i>0 && !isspace((uchar)pc) &&
             ((i<l-1 && (isId(nc) || nc=='[')) || // the [ is for attributes (see bug702170)
              (i<l-2 && nc=='$' && isId(src[i+2])) ||   // for PHP: ',$name' -> ', $name'
              (i<l-3 && nc=='&' && src[i+2]=='$' && isId(src[i+3])) // for PHP: ',&$name' -> ', &$name'
             )
            )
         {
           *dst++=' '; // add extra space after
         }
         break;
       case '^':  // CLI 'Type^name' -> 'Type^ name'
       case '%':  // CLI 'Type%name' -> 'Type% name'
         *dst++=c;
         if (cliSupport && i<l-1 && (isId(nc) || nc=='-'))
         {
           *dst++=' '; // add extra space after
         }
         break;
       case ')':  // current char is a )  -> ')name' -> ') name'
         *dst++=c;
         if (i<l-1 && (isId(nc) || nc=='-'))
         {
           *dst++=' '; // add extra space after
         }
         break;
       case '*':
         if (i>0 && pc!=' ' && pc!='\t' && pc!=':' &&
                    pc!='*' && pc!='&'  && pc!='(' && pc!='/' &&
                    pc!='.' && osp<9
            )
           // avoid splitting &&, **, .*, operator*, operator->*
         {
           *dst++=' ';
         }
         *dst++=c;
         break;
       case '&':
         if (i>0 && isId(pc) && osp<9)
         {
           if (nc != '=')
           // avoid splitting operator&=
           {
             *dst++=' ';
           }
         }
         *dst++=c;
         break;
       case '$':  // '$name' -> ' $name'
                  // 'name$name' -> 'name$name'
         if (isId(pc))
         {
           *dst++=c;
           break;
         }
         // else fallthrough
       case '@':  // '@name' -> ' @name'
       case '\'': // ''name' -> '' name'
         if (i>0 && i<l-1 && pc!='=' && pc!=':' && !isspace((uchar)pc) &&
             isId(nc) && osp<8) // ")id" -> ") id"
         {
           *dst++=' ';
         }
         *dst++=c;
         break;
       case ':': // current char is a :
         if (csp==6) // replace const::A by const ::A
         {
           *dst++=' ';
           csp=0;
         }
         else if (vosp==9) // replace volatile::A by volatile ::A
         {
           *dst++=' ';
           vosp=0;
         }
         else if (vsp==8) // replace virtual::A by virtual ::A
         {
           *dst++=' ';
           vsp=0;
         }
         *dst++=c;
         break;
       case ' ':  // fallthrough
       case '\n': // fallthrough
       case '\t':
         {
           if (g_charAroundSpace.charMap[(uchar)pc].before &&
               g_charAroundSpace.charMap[(uchar)nc].after  &&
               !(pc==',' && nc=='.') &&
               (osp<8 || (osp>=8 && isId(pc) && isId(nc)))
                   // e.g.    'operator >>' -> 'operator>>',
                   //         'operator "" _x' -> 'operator""_x',
                   // but not 'operator int' -> 'operatorint'
              )
           { // keep space
             *dst++=' ';
           }
           else if ((pc=='*' || pc=='&' || pc=='.') && nc=='>')
           {
             *dst++=' ';
           }
         }
         break;
       default:
         *dst++=c;
         if (c=='t' && csp==5 && i<l-1 && // found 't' in 'const'
              !(isId(nc) || nc==')' || nc==',' || isspace((uchar)nc))
            ) // prevent const ::A from being converted to const::A
         {
           *dst++=' ';
           csp=0;
         }
         else if (c=='e' && vosp==8 && i<l-1 && // found 'e' in 'volatile'
              !(isId(nc) || nc==')' || nc==',' || isspace((uchar)nc))
            ) // prevent volatile ::A from being converted to volatile::A
         {
           *dst++=' ';
           vosp=0;
         }
         else if (c=='l' && vsp==7 && i<l-1 && // found 'l' in 'virtual'
              !(isId(nc) || nc==')' || nc==',' || isspace((uchar)nc))
             ) // prevent virtual ::A from being converted to virtual::A
         {
           *dst++=' ';
           vsp=0;
         }
         break;
     }
     pc=c;
   }
   *dst++='\0';
   //printf("removeRedundantWhitespace(%s)->%s\n",qPrint(s),growBuf);
   return growBuf;
 }

引用了 CharAroundSpace::CharElem::before, CharAroundSpace::charMap, Config_getBool, constScope, QCString::data(), g_charAroundSpace, QCString::isEmpty(), isId(), reg::isspace(), QCString::length(), operatorScope, THREAD_LOCAL, virtualScope , 以及 volatileScope.

被这些函数引用 addVariableToClass(), argListToString(), extractCanonicalType(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findMember(), findUsedClassesForClass(), findUsingDeclImports(), getCanonicalTypeForIdentifier(), SymbolResolver::Private::getResolvedClassRec(), MemberDefImpl::IMPL::init(), ClassDefImpl::insertTemplateInstance(), normalizeNonTemplateArgumentsInString(), resolveRef(), tempArgListToString() , 以及 writeExceptionListImpl().

◆ replaceAnonymousScopes()

QCString replaceAnonymousScopes	(	const QCString &	s,
		const QCString &	replacement = `QCString()`
	)

在文件 util.cpp 第 223 行定义.

 {
   if (s.isEmpty()) return s;
   static const reg::Ex marker(R"(@\d+)");
   std::string result = reg::replace(s.str(),marker,
                                     replacement.isEmpty() ? replacement.data() : "__anonymous__");
   //printf("replaceAnonymousScopes('%s')='%s'\n",qPrint(s),qPrint(result));
   return QCString(result);
 }

引用了 QCString::data(), QCString::isEmpty(), reg::replace() , 以及 QCString::str().

被这些函数引用 generateDEFForMember().

◆ replaceColorMarkers()

QCString replaceColorMarkers ( const QCString & 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.

在文件 util.cpp 第 6387 行定义.

 {
   if (str.isEmpty()) return QCString();
   std::string result;
   std::string s=str.str();
   static const reg::Ex re(R"(##[0-9A-Fa-f][0-9A-Fa-f])");
   reg::Iterator it(s,re);
   reg::Iterator end;
   static int hue   = Config_getInt(HTML_COLORSTYLE_HUE);
   static int sat   = Config_getInt(HTML_COLORSTYLE_SAT);
   static int gamma = Config_getInt(HTML_COLORSTYLE_GAMMA);
   size_t sl=s.length();
   size_t p=0;
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     size_t i = match.position();
     size_t l = match.length();
     if (i>p) result+=s.substr(p,i-p);
     std::string lumStr = match.str().substr(2);
 #define HEXTONUM(x) (((x)>='0' && (x)<='9') ? ((x)-'0') :       \
                      ((x)>='a' && (x)<='f') ? ((x)-'a'+10) :    \
                      ((x)>='A' && (x)<='F') ? ((x)-'A'+10) : 0)
  
     double r,g,b;
     int red,green,blue;
     int level = HEXTONUM(lumStr[0])*16+HEXTONUM(lumStr[1]);
     ColoredImage::hsl2rgb(hue/360.0,sat/255.0,
                           pow(level/255.0,gamma/100.0),&r,&g,&b);
     red   = (int)(r*255.0);
     green = (int)(g*255.0);
     blue  = (int)(b*255.0);
     char colStr[8];
     colStr[0]='#';
     colStr[1]=hex[red>>4];
     colStr[2]=hex[red&0xf];
     colStr[3]=hex[green>>4];
     colStr[4]=hex[green&0xf];
     colStr[5]=hex[blue>>4];
     colStr[6]=hex[blue&0xf];
     colStr[7]=0;
     //printf("replacing %s->%s (level=%d)\n",qPrint(lumStr),colStr,level);
     result+=colStr;
     p=i+l;
   }
   if (p<sl) result+=s.substr(p);
   return QCString(result);
 }

引用了 Config_getInt, end(), hex, HEXTONUM, ColoredImage::hsl2rgb(), QCString::isEmpty(), reg::match() , 以及 QCString::str().

被这些函数引用 ResourceMgr::copyResourceAs(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo() , 以及 HtmlGenerator::writeStyleSheetFile().

◆ replaceNamespaceAliases()

void replaceNamespaceAliases	(	QCString &	scope,
		int	i
	)

在文件 util.cpp 第 5300 行定义.

 {
   while (i>0)
   {
     QCString ns = scope.left(i);
     if (!ns.isEmpty())
     {
       auto it = Doxygen::namespaceAliasMap.find(ns.str());
       if (it!=Doxygen::namespaceAliasMap.end())
       {
         scope=QCString(it->second)+scope.right(scope.length()-i);
         i=static_cast<int>(it->second.length());
       }
     }
     if (i>0 && ns==scope.left(i)) break;
   }
 }

引用了 end(), QCString::isEmpty(), QCString::left(), QCString::length(), Doxygen::namespaceAliasMap, QCString::right() , 以及 QCString::str().

被这些函数引用 findClassRelation(), findUsedClassesForClass(), getMemberFromSymbol() , 以及 SymbolResolver::Private::getResolvedClassRec().

◆ resolveAliasCmd()

QCString resolveAliasCmd ( const QCString & aliasCmd )

在文件 util.cpp 第 6050 行定义.

 {
   QCString result;
   StringUnorderedSet aliasesProcessed;
   //printf("Expanding: '%s'\n",qPrint(aliasCmd));
   result = expandAliasRec(aliasesProcessed,aliasCmd);
   //printf("Expanding result: '%s'->'%s'\n",qPrint(aliasCmd),qPrint(result));
   return result;
 }

引用了 expandAliasRec().

◆ resolveLink()

bool resolveLink	(	const QCString &	scName,
		const QCString &	lr,
		bool	inSeeBlock,
		const Definition **	resContext,
		QCString &	resAnchor
	)

在文件 util.cpp 第 3037 行定义.

 {
   *resContext=0;
  
   QCString linkRef=lr;
   QCString linkRefWithoutTemplates = stripTemplateSpecifiersFromScope(linkRef,FALSE);
   //printf("ResolveLink linkRef=%s\n",qPrint(lr));
   const FileDef  *fd;
   const GroupDef *gd;
   const PageDef  *pd;
   const ClassDef *cd;
   const DirDef   *dir;
   const ConceptDef *cnd;
   const NamespaceDef *nd;
   const SectionInfo *si=0;
   bool ambig;
   if (linkRef.isEmpty()) // no reference name!
   {
     return FALSE;
   }
   else if ((pd=Doxygen::pageLinkedMap->find(linkRef))) // link to a page
   {
     gd = pd->getGroupDef();
     if (gd)
     {
       if (!pd->name().isEmpty()) si=SectionManager::instance().find(pd->name());
       *resContext=gd;
       if (si) resAnchor = si->label();
     }
     else
     {
       *resContext=pd;
     }
     return TRUE;
   }
   else if ((si=SectionManager::instance().find(linkRef)))
   {
     *resContext=si->definition();
     resAnchor = si->label();
     return TRUE;
   }
   else if ((pd=Doxygen::exampleLinkedMap->find(linkRef))) // link to an example
   {
     *resContext=pd;
     return TRUE;
   }
   else if ((gd=Doxygen::groupLinkedMap->find(linkRef))) // link to a group
   {
     *resContext=gd;
     return TRUE;
   }
   else if ((fd=findFileDef(Doxygen::inputNameLinkedMap,linkRef,ambig)) // file link
       && fd->isLinkable())
   {
     *resContext=fd;
     return TRUE;
   }
   else if ((cd=getClass(linkRef))) // class link
   {
     *resContext=cd;
     resAnchor=cd->anchor();
     return TRUE;
   }
   else if ((cd=getClass(linkRefWithoutTemplates))) // C#/Java generic class link
   {
     *resContext=cd;
     resAnchor=cd->anchor();
     return TRUE;
   }
   else if ((cd=getClass(linkRef+"-p"))) // Obj-C protocol link
   {
     *resContext=cd;
     resAnchor=cd->anchor();
     return TRUE;
   }
   else if ((cnd=getConcept(linkRef))) // C++20 concept definition
   {
     *resContext=cnd;
     resAnchor=cnd->anchor();
     return TRUE;
   }
   else if ((nd=Doxygen::namespaceLinkedMap->find(linkRef)))
   {
     *resContext=nd;
     return TRUE;
   }
   else if ((dir=Doxygen::dirLinkedMap->find(FileInfo(linkRef.str()).absFilePath()+"/"))
       && dir->isLinkable()) // TODO: make this location independent like filedefs
   {
     *resContext=dir;
     return TRUE;
   }
   else // probably a member reference
   {
     const MemberDef *md = 0;
     bool res = resolveRef(scName,lr,TRUE,resContext,&md);
     if (md) resAnchor=md->anchor();
     return res;
   }
 }

引用了 FileInfo::absFilePath(), ConceptDef::anchor(), MemberDef::anchor(), ClassDef::anchor(), SectionInfo::definition(), Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), findFileDef(), getClass(), getConcept(), PageDef::getGroupDef(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, SectionManager::instance(), QCString::isEmpty(), FileDef::isLinkable(), DirDef::isLinkable(), SectionInfo::label(), Definition::name(), Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, resolveRef(), QCString::str(), stripTemplateSpecifiersFromScope() , 以及 TRUE.

被这些函数引用 DocLink::DocLink(), DocRef::DocRef(), generateLink() , 以及 LayoutNavEntry::url().

◆ resolveRef()

bool resolveRef	(	const QCString &	scName,
		const QCString &	name,
		bool	inSeeBlock,
		const Definition **	resContext,
		const MemberDef **	resMember,
		bool	lookForSpecialization,
		const FileDef *	currentFile,
		bool	checkScope
	)

Returns an object to reference to given its name and context

后置条件: return value TRUE implies *resContext!=0 or *resMember!=0

在文件 util.cpp 第 2757 行定义.

 {
   //printf("resolveRef(scope=%s,name=%s,inSeeBlock=%d)\n",qPrint(scName),qPrint(name),inSeeBlock);
   QCString tsName = name;
   //bool memberScopeFirst = tsName.find('#')!=-1;
   QCString fullName = substitute(tsName,"#","::");
   if (fullName.find("anonymous_namespace{")==-1)
   {
     fullName = removeRedundantWhiteSpace(substitute(fullName,".","::",3));
   }
   else
   {
     fullName = removeRedundantWhiteSpace(fullName);
   }
  
   int bracePos=findParameterList(fullName);
   int endNamePos=bracePos!=-1 ? bracePos : fullName.length();
   int scopePos=fullName.findRev("::",endNamePos);
   bool explicitScope = fullName.left(2)=="::" &&   // ::scope or #scope
                        (scopePos>2 ||              // ::N::A
                         tsName.left(2)=="::" ||    // ::foo in local scope
                         scName==0                  // #foo  in global scope
                        );
  
   // default result values
   *resContext=0;
   *resMember=0;
  
   if (bracePos==-1) // simple name
   {
     ClassDef *cd=0;
     NamespaceDef *nd=0;
  
     // the following if() was commented out for releases in the range
     // 1.5.2 to 1.6.1, but has been restored as a result of bug report 594787.
     if (!inSeeBlock && scopePos==-1 && isLowerCase(tsName))
     { // link to lower case only name => do not try to autolink
       return FALSE;
     }
  
     //printf("scName=%s fullName=%s\n",scName,qPrint(fullName));
  
     // check if this is a class or namespace reference
     if (scName!=fullName && getScopeDefs(scName,fullName,cd,nd))
     {
       if (cd) // scope matches that of a class
       {
         *resContext = cd;
       }
       else // scope matches that of a namespace
       {
         ASSERT(nd!=0);
         *resContext = nd;
       }
       return TRUE;
     }
     else if (scName==fullName || (!inSeeBlock && scopePos==-1))
       // nothing to link => output plain text
     {
       //printf("found scName=%s fullName=%s scName==fullName=%d "
       //    "inSeeBlock=%d scopePos=%d!\n",
       //    scName,qPrint(fullName),scName==fullName,inSeeBlock,scopePos);
       return FALSE;
     }
     // continue search...
   }
  
   // extract userscope+name
   QCString nameStr=fullName.left(endNamePos);
   if (explicitScope) nameStr=nameStr.mid(2);
  
   // extract arguments
   QCString argsStr;
   if (bracePos!=-1) argsStr=fullName.right(fullName.length()-bracePos);
  
   // strip template specifier
   // TODO: match against the correct partial template instantiation
   int templPos=nameStr.find('<');
   bool tryUnspecializedVersion = FALSE;
   if (templPos!=-1 && nameStr.find("operator")==-1)
   {
     int endTemplPos=nameStr.findRev('>');
     if (endTemplPos!=-1)
     {
       if (!lookForSpecialization)
       {
         nameStr=nameStr.left(templPos)+nameStr.right(nameStr.length()-endTemplPos-1);
       }
       else
       {
         tryUnspecializedVersion = TRUE;
       }
     }
   }
  
   QCString scopeStr=scName;
  
   const MemberDef    *md = 0;
   const ClassDef     *cd = 0;
   const FileDef      *fd = 0;
   const NamespaceDef *nd = 0;
   const GroupDef     *gd = 0;
   const ConceptDef   *cnd = 0;
  
   // check if nameStr is a member or global.
   //printf("getDefs(scope=%s,name=%s,args=%s checkScope=%d)\n",
   //    qPrint(scopeStr), qPrint(nameStr), qPrint(argsStr),checkScope);
   if (getDefs(scopeStr,nameStr,argsStr,
         md,cd,fd,nd,gd,
         //scopePos==0 && !memberScopeFirst, // forceEmptyScope
         explicitScope, // replaces prev line due to bug 600829
         currentFile,
         TRUE                              // checkCV
         )
      )
   {
     //printf("after getDefs checkScope=%d nameStr=%s cd=%p nd=%p\n",checkScope,qPrint(nameStr),cd,nd);
     if (checkScope && md && md->getOuterScope()==Doxygen::globalScope &&
         !md->isStrongEnumValue() &&
         (!scopeStr.isEmpty() || nameStr.find("::")>0))
     {
       // we did find a member, but it is a global one while we were explicitly
       // looking for a scoped variable. See bug 616387 for an example why this check is needed.
       // note we do need to support autolinking to "::symbol" hence the >0
       //printf("not global member!\n");
       *resContext=0;
       *resMember=0;
       return FALSE;
     }
     //printf("after getDefs md=%p cd=%p fd=%p nd=%p gd=%p\n",md,cd,fd,nd,gd);
     if      (md) { *resMember=md; *resContext=md; }
     else if (cd) *resContext=cd;
     else if (nd) *resContext=nd;
     else if (fd) *resContext=fd;
     else if (gd) *resContext=gd;
     else         { *resContext=0; *resMember=0; return FALSE; }
     //printf("member=%s (md=%p) anchor=%s linkable()=%d context=%s\n",
     //    qPrint(md->name()), md, qPrint(md->anchor()), md->isLinkable(), qPrint((*resContext)->name()));
     return TRUE;
   }
   else if (inSeeBlock && !nameStr.isEmpty() && (gd=Doxygen::groupLinkedMap->find(nameStr)))
   { // group link
     *resContext=gd;
     return TRUE;
   }
   else if ((cnd=Doxygen::conceptLinkedMap->find(nameStr)))
   {
     *resContext=cnd;
     return TRUE;
   }
   else if (tsName.find('.')!=-1) // maybe a link to a file
   {
     bool ambig;
     fd=findFileDef(Doxygen::inputNameLinkedMap,tsName,ambig);
     if (fd && !ambig)
     {
       *resContext=fd;
       return TRUE;
     }
   }
  
   if (tryUnspecializedVersion)
   {
     return resolveRef(scName,name,inSeeBlock,resContext,resMember,FALSE,0,checkScope);
   }
   if (bracePos!=-1) // Try without parameters as well, could be a constructor invocation
   {
     *resContext=getClass(fullName.left(bracePos));
     if (*resContext)
     {
       return TRUE;
     }
   }
   //printf("resolveRef: %s not found!\n",name);
  
   return FALSE;
 }

引用了 ASSERT, Doxygen::conceptLinkedMap, FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::find(), findFileDef(), findParameterList(), QCString::findRev(), getClass(), getDefs(), Definition::getOuterScope(), getScopeDefs(), Doxygen::globalScope, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, QCString::isEmpty(), isLowerCase(), MemberDef::isStrongEnumValue(), QCString::left(), QCString::length(), QCString::mid(), removeRedundantWhiteSpace(), resolveRef(), QCString::right(), substitute() , 以及 TRUE.

被这些函数引用 DocParser::handleLinkedWord(), resolveLink() , 以及 resolveRef().

◆ resolveTypeDef()

QCString resolveTypeDef	(	const Definition *	d,
		const QCString &	name,
		const Definition **	typedefContext = `0`
	)

在文件 util.cpp 第 364 行定义.

 {
   //printf("<<resolveTypeDef(%s,%s)\n",
   //          context ? qPrint(context->name()) : "<none>",qPrint(qualifiedName));
   QCString result;
   if (qualifiedName.isEmpty())
   {
     //printf("  qualified name empty!\n");
     return result;
   }
  
   const Definition *mContext=context;
   if (typedefContext) *typedefContext=context;
  
   // see if the qualified name has a scope part
   int scopeIndex = qualifiedName.findRev("::");
   QCString resName=qualifiedName;
   if (scopeIndex!=-1) // strip scope part for the name
   {
     resName=qualifiedName.right(qualifiedName.length()-scopeIndex-2);
     if (resName.isEmpty())
     {
       // qualifiedName was of form A:: !
       //printf("  qualified name of form A::!\n");
       return result;
     }
   }
   const MemberDef *md=0;
   while (mContext && md==0)
   {
     // step 1: get the right scope
     const Definition *resScope=mContext;
     if (scopeIndex!=-1)
     {
       // split-off scope part
       QCString resScopeName = qualifiedName.left(scopeIndex);
       //printf("resScopeName='%s'\n",qPrint(resScopeName));
  
       // look-up scope in context
       int is,ps=0;
       int l;
       while ((is=getScopeFragment(resScopeName,ps,&l))!=-1)
       {
         QCString qualScopePart = resScopeName.mid(is,l);
         QCString tmp = resolveTypeDef(mContext,qualScopePart);
         if (!tmp.isEmpty()) qualScopePart=tmp;
         resScope = resScope->findInnerCompound(qualScopePart);
         //printf("qualScopePart='%s' resScope=%p\n",qPrint(qualScopePart),resScope);
         if (resScope==0) break;
         ps=is+l;
       }
     }
     //printf("resScope=%s\n",resScope? qPrint(resScope->name()) : "<none>");
  
     // step 2: get the member
     if (resScope) // no scope or scope found in the current context
     {
       //printf("scope found: %s, look for typedef %s\n",
       //     qPrint(resScope->qualifiedName()),qPrint(resName));
       MemberNameLinkedMap *mnd=0;
       if (resScope->definitionType()==Definition::TypeClass)
       {
         mnd=Doxygen::memberNameLinkedMap;
       }
       else
       {
         mnd=Doxygen::functionNameLinkedMap;
       }
       MemberName *mn=mnd->find(resName);
       if (mn)
       {
         int minDist=-1;
         for (const auto &tmd_p : *mn)
         {
           const MemberDef *tmd = tmd_p.get();
           //printf("Found member %s resScope=%s outerScope=%s mContext=%p\n",
           //    qPrint(tmd->name()),qPrint( resScope->name()),
           //    qPrint(tmd->getOuterScope()->name()), mContext);
           if (tmd->isTypedef() /*&& tmd->getOuterScope()==resScope*/)
           {
             SymbolResolver resolver;
             int dist=resolver.isAccessibleFrom(resScope,tmd);
             if (dist!=-1 && (md==0 || dist<minDist))
             {
               md = tmd;
               minDist = dist;
             }
           }
         }
       }
     }
     mContext=mContext->getOuterScope();
   }
  
   // step 3: get the member's type
   if (md)
   {
     //printf(">>resolveTypeDef: Found typedef name '%s' in scope '%s' value='%s' args='%s'\n",
     //    qPrint(qualifiedName),qPrint(context->name()),md->typeString(),md->argsString()
     //    );
     result=md->typeString();
     QCString args = md->argsString();
     if (args.find(")(")!=-1) // typedef of a function/member pointer
     {
       result+=args;
     }
     else if (args.find('[')!=-1) // typedef of an array
     {
       result+=args;
     }
     if (typedefContext) *typedefContext=md->getOuterScope();
   }
   else
   {
     //printf(">>resolveTypeDef: Typedef '%s' not found in scope '%s'!\n",
     //    qPrint(qualifiedName),context ? qPrint(context->name()) : "<global>");
   }
   return result;
  
 }

引用了 MemberDef::argsString(), Definition::definitionType(), LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::find(), Definition::findInnerCompound(), QCString::findRev(), Doxygen::functionNameLinkedMap, Definition::getOuterScope(), getScopeFragment(), SymbolResolver::isAccessibleFrom(), QCString::isEmpty(), MemberDef::isTypedef(), QCString::left(), QCString::length(), Doxygen::memberNameLinkedMap, QCString::mid(), resolveTypeDef(), QCString::right(), Definition::TypeClass , 以及 MemberDef::typeString().

被这些函数引用 findUsedClassesForClass(), getCanonicalTemplateSpec(), getCanonicalTypeForIdentifier(), isVarWithConstructor() , 以及 resolveTypeDef().

◆ rightScopeMatch()

bool rightScopeMatch	(	const QCString &	scope,
		const QCString &	name
	)

在文件 util.cpp 第 863 行定义.

 {
   int sl=scope.length();
   int nl=name.length();
   return (name==scope || // equal
           (scope.right(nl)==name && // substring
            sl-nl>1 && scope.at(sl-nl-1)==':' && scope.at(sl-nl-2)==':' // scope
           )
          );
 }

引用了 QCString::at(), QCString::length() , 以及 QCString::right().

被这些函数引用 addMemberFunction(), findScopeFromQualifiedName(), getDefs() , 以及 isRecursiveBaseClass().

◆ rtfFormatBmkStr()

QCString rtfFormatBmkStr ( const QCString & name )

在文件 util.cpp 第 5230 行定义.

 {
   std::lock_guard<std::mutex> lock(g_rtfFormatMutex);
  
   // To overcome the 40-character tag limitation, we
   // substitute a short arbitrary string for the name
   // supplied, and keep track of the correspondence
   // between names and strings.
   auto it = g_tagMap.find(name.str());
   if (it!=g_tagMap.end()) // already known
   {
     return QCString(it->second);
   }
  
   QCString tag = g_nextTag;
   auto result = g_tagMap.insert( std::make_pair(name.str(), g_nextTag.str()) );
  
   if (result.second) // new item was added
   {
     // increment the next tag.
  
     char* nxtTag = g_nextTag.rawData() + g_nextTag.length() - 1;
     for ( unsigned int i = 0; i < g_nextTag.length(); ++i, --nxtTag )
     {
       if ( ( ++(*nxtTag) ) > 'Z' )
       {
         *nxtTag = 'A';
       }
       else
       {
         // Since there was no carry, we can stop now
         break;
       }
     }
   }
  
   Debug::print(Debug::Rtf,0,"Name = %s RTF_tag = %s\n",qPrint(name),qPrint(tag));
   return tag;
 }

引用了 g_nextTag, g_rtfFormatMutex, g_tagMap, QCString::length(), Debug::print(), qPrint(), QCString::rawData(), Debug::Rtf , 以及 QCString::str().

被这些函数引用 RTFGenerator::endDoxyAnchor(), RTFDocVisitor::startLink(), RTFGenerator::startTextLink(), RTFDocVisitor::visit(), RTFDocVisitor::visitPre(), RTFGenerator::writeAnchor(), RTFGenerator::writeCodeLink(), RTFGenerator::writeLineNumber(), RTFGenerator::writeObjectLink(), RTFGenerator::writeRTFReference() , 以及 RTFGenerator::writeStartAnnoItem().

◆ selectBlock()

QCString selectBlock	(	const QCString &	s,
		const QCString &	name,
		bool	enable,
		OutputGenerator::OutputType	o
	)

在文件 util.cpp 第 7209 行定义.

 {
   // TODO: this is an expensive function that is called a lot -> optimize it
   QCString begin;
   QCString end;
   QCString nobegin;
   QCString noend;
   switch (o)
   {
     case OutputGenerator::Html:
       begin = "<!--BEGIN " + name + "-->";
       end = "<!--END " + name + "-->";
       nobegin = "<!--BEGIN !" + name + "-->";
       noend = "<!--END !" + name + "-->";
       break;
     case OutputGenerator::Latex:
       begin = "%%BEGIN " + name;
       end = "%%END " + name;
       nobegin = "%%BEGIN !" + name;
       noend = "%%END !" + name;
       break;
     default:
       break;
   }
  
   QCString result = s;
   if (enable)
   {
     result = substitute(result, begin, "");
     result = substitute(result, end, "");
     result = clearBlock(result, nobegin, noend);
   }
   else
   {
     result = substitute(result, nobegin, "");
     result = substitute(result, noend, "");
     result = clearBlock(result, begin, end);
   }
  
   return result;
 }

引用了 begin(), clearBlock(), end(), OutputGenerator::Html, OutputGenerator::Latex , 以及 substitute().

被这些函数引用 substituteHtmlKeywords() , 以及 substituteLatexKeywords().

◆ showFileDefMatches()

QCString showFileDefMatches	(	const FileNameLinkedMap *	fnMap,
		const QCString &	n
	)

在文件 util.cpp 第 3308 行定义.

 {
   QCString result;
   QCString name=n;
   QCString path;
   int slashPos=std::max(name.findRev('/'),name.findRev('\\'));
   if (slashPos!=-1)
   {
     path=name.left(slashPos+1);
     name=name.right(name.length()-slashPos-1);
   }
   const FileName *fn;
   if ((fn=fnMap->find(name)))
   {
     for (const auto &fd : *fn)
     {
       if (path.isEmpty() || fd->getPath().right(path.length())==path)
       {
         result+="   "+fd->absFilePath()+"\n";
       }
     }
   }
   return result;
 }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::findRev(), QCString::isEmpty(), QCString::left(), QCString::length() , 以及 QCString::right().

被这些函数引用 addIncludeFile(), buildFileList(), DocParser::findAndCopyImage(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse() , 以及 DocParser::readTextFileByName().

◆ split() [1/2]

StringVector split	(	const std::string &	s,
		const reg::Ex &	delimiter
	)

split input string s by regular expression delimiter delimiter. returns a vector of non-empty strings that are between the delimiters

在文件 util.cpp 第 7300 行定义.

 {
   StringVector result;
   reg::Iterator iter(s, delimiter);
   reg::Iterator end;
   size_t p=0;
   for ( ; iter != end; ++iter)
   {
     const auto &match = *iter;
     size_t i=match.position();
     size_t l=match.length();
     if (i>p) result.push_back(s.substr(p,i-p));
     p=i+l;
   }
   if (p<s.length()) result.push_back(s.substr(p));
   return result;
 }

引用了 end() , 以及 reg::match().

◆ split() [2/2]

StringVector split	(	const std::string &	s,
		const std::string &	delimiter
	)

split input string s by string delimiter delimiter. returns a vector of non-empty strings that are between the delimiters

在文件 util.cpp 第 7283 行定义.

 {
   StringVector result;
   size_t prev = 0, pos = 0, len = s.length();
   do
   {
     pos = s.find(delimiter, prev);
     if (pos == std::string::npos) pos = len;
     if (pos>prev) result.push_back(s.substr(prev,pos-prev));
     prev = pos + delimiter.length();
   }
   while (pos<len && prev<len);
   return result;
 }

◆ stackTrace()

void stackTrace ( )

在文件 util.cpp 第 6095 行定义.

 {
 #ifdef TRACINGSUPPORT
   void *backtraceFrames[128];
   int frameCount = backtrace(backtraceFrames, 128);
   static char cmd[40960];
   char *p = cmd;
   p += sprintf(p,"/usr/bin/atos -p %d ", (int)getpid());
   for (int x = 0; x < frameCount; x++)
   {
     p += sprintf(p,"%p ", backtraceFrames[x]);
   }
   fprintf(stderr,"========== STACKTRACE START ==============\n");
   if (FILE *fp = Portable::popen(cmd, "r"))
   {
     char resBuf[512];
     while (size_t len = fread(resBuf, 1, sizeof(resBuf), fp))
     {
       fwrite(resBuf, 1, len, stderr);
     }
     Portable::pclose(fp);
   }
   fprintf(stderr,"============ STACKTRACE END ==============\n");
   //fprintf(stderr,"%s\n", frameStrings[x]);
 #endif
 }

引用了 Portable::pclose() , 以及 Portable::popen().

◆ stripAnonymousNamespaceScope()

QCString stripAnonymousNamespaceScope ( const QCString & s )

在文件 util.cpp 第 235 行定义.

 {
   int i,p=0,l;
   QCString newScope;
   int sl = s.length();
   while ((i=getScopeFragment(s,p,&l))!=-1)
   {
     //printf("Scope fragment %s\n",qPrint(s.mid(i,l)));
     if (Doxygen::namespaceLinkedMap->find(s.left(i+l))!=0)
     {
       if (s.at(i)!='@')
       {
         if (!newScope.isEmpty()) newScope+="::";
         newScope+=s.mid(i,l);
       }
     }
     else if (i<sl)
     {
       if (!newScope.isEmpty()) newScope+="::";
       newScope+=s.right(sl-i);
       goto done;
     }
     p=i+l;
   }
 done:
   //printf("stripAnonymousNamespaceScope('%s')='%s'\n",qPrint(s),qPrint(newScope));
   return newScope;
 }

引用了 QCString::at(), getScopeFragment(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::mid(), Doxygen::namespaceLinkedMap , 以及 QCString::right().

被这些函数引用 addMemberFunction(), addPageToContext(), buildNamespaceList(), computeTemplateClassRelations(), extractClassName(), findGroupScope(), findUsingDeclImports(), findUsingDirectives(), MemberDefImpl::getClassDefOfAnonymousType() , 以及 resolveClassNestingRelations().

◆ stripExtension()

QCString stripExtension ( const QCString & fName )

在文件 util.cpp 第 5295 行定义.

 {
   return stripExtensionGeneral(fName, Doxygen::htmlFileExtension);
 }

引用了 Doxygen::htmlFileExtension , 以及 stripExtensionGeneral().

被这些函数引用 ConceptDefImpl::ConceptDefImpl(), ClassDefImpl::IMPL::init(), NamespaceDefImpl::NamespaceDefImpl() , 以及 MemberDefImpl::setTagInfo().

◆ stripExtensionGeneral()

QCString stripExtensionGeneral	(	const QCString &	fName,
		const QCString &	ext
	)

在文件 util.cpp 第 5285 行定义.

 {
   QCString result=fName;
   if (result.right(ext.length())==ext)
   {
     result=result.left(result.length()-ext.length());
   }
   return result;
 }

引用了 QCString::left(), QCString::length() , 以及 QCString::right().

被这些函数引用 TooltipManager::addTooltip(), TagFileParser::buildLists(), extraLatexStyleSheet(), MarkdownOutlineParser::parseInput(), stripExtension(), DocbookCodeGenerator::writeCodeLinkLine(), LatexCodeGenerator::writeLineNumber() , 以及 RTFGenerator::writeLineNumber().

◆ stripFromIncludePath()

QCString stripFromIncludePath ( const QCString & path )

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

在文件 util.cpp 第 322 行定义.

 {
   return stripFromPath(path,Config_getList(STRIP_FROM_INC_PATH));
 }

引用了 Config_getList , 以及 stripFromPath().

被这些函数引用 addIncludeFile() , 以及 findFileDef().

◆ stripFromPath()

QCString stripFromPath ( const QCString & path )

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

在文件 util.cpp 第 314 行定义.

 {
   return stripFromPath(path,Config_getList(STRIP_FROM_PATH));
 }

引用了 Config_getList , 以及 stripFromPath().

◆ stripIndentation() [1/2]

QCString stripIndentation ( const QCString & s )

在文件 util.cpp 第 6597 行定义.

 {
   if (s.isEmpty()) return s; // empty string -> we're done
  
   //printf("stripIndentation:\n%s\n------\n",qPrint(s));
   // compute minimum indentation over all lines
   const char *p=s.data();
   char c;
   int indent=0;
   int minIndent=1000000; // "infinite"
   bool searchIndent=TRUE;
   static int tabSize=Config_getInt(TAB_SIZE);
   while ((c=*p++))
   {
     if      (c=='\t') indent+=tabSize - (indent%tabSize);
     else if (c=='\n') indent=0,searchIndent=TRUE;
     else if (c==' ')  indent++;
     else if (searchIndent)
     {
       searchIndent=FALSE;
       if (indent<minIndent) minIndent=indent;
     }
   }
  
   // no indent to remove -> we're done
   if (minIndent==0) return s;
  
   // remove minimum indentation for each line
   TextStream result;
   p=s.data();
   indent=0;
   while ((c=*p++))
   {
     if (c=='\n') // start of new line
     {
       indent=0;
       result << c;
     }
     else if (indent<minIndent) // skip until we reach minIndent
     {
       if (c=='\t')
       {
         int newIndent = indent+tabSize-(indent%tabSize);
         int i=newIndent;
         while (i>minIndent) // if a tab crosses the minIndent boundary fill the rest with spaces
         {
           result << ' ';
           i--;
         }
         indent=newIndent;
       }
       else // space
       {
         indent++;
       }
     }
     else // copy anything until the end of the line
     {
       result << c;
     }
   }
  
   return result.str();
 }

引用了 Config_getInt, QCString::data(), FALSE, QCString::isEmpty(), TextStream::str() , 以及 TRUE.

被这些函数引用 DocPara::handleInclude() , 以及 DocPara::handleStartCode().

◆ stripIndentation() [2/2]

void stripIndentation	(	QCString &	doc,
		const int	indentationLevel
	)

在文件 util.cpp 第 6663 行定义.

 {
   if (indentationLevel <= 0 || doc.isEmpty()) return; // nothing to strip
  
   // by stripping content the string will only become shorter so we write the results
   // back into the input string and then resize it at the end.
   char c;
   const char *src = doc.data();
   char *dst = doc.rawData();
   bool insideIndent = false; // skip the initial line from stripping
   int cnt = 0;
   while ((c=*src++)!=0)
   {
     // invariant: dst<=src
     switch(c)
     {
       case '\n':
         *dst++ = c;
         insideIndent = true;
         cnt = indentationLevel;
         break;
       case ' ':
         if (insideIndent)
         {
           if (cnt>0) // count down the spacing until the end of the indent
           {
             cnt--;
           }
           else // reached the end of the indent, start of the part of the line to keep
           {
             insideIndent = false;
             *dst++ = c;
           }
         }
         else // part after indent, copy to the output
         {
           *dst++ = c;
         }
         break;
       default:
         insideIndent = false;
         *dst++ = c;
         break;
     }
   }
   doc.resize(static_cast<uint>(dst-doc.data())+1);
 }

引用了 QCString::data(), QCString::isEmpty(), QCString::rawData() , 以及 QCString::resize().

◆ stripLeadingAndTrailingEmptyLines()

QCString stripLeadingAndTrailingEmptyLines	(	const QCString &	s,
		int &	docLine
	)

Special version of QCString::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.

返回: The stripped string.

在文件 util.cpp 第 5394 行定义.

 {
   if (s.isEmpty()) return QCString();
   const char *p = s.data();
  
   // search for leading empty lines
   int i=0,li=-1,l=s.length();
   char c;
   while ((c=*p))
   {
     if (c==' ' || c=='\t' || c=='\r') i++,p++;
     else if (c=='\\' && qstrncmp(p,"\\ilinebr",8)==0) i+=8,li=i,p+=8;
     else if (c=='\n') i++,li=i,docLine++,p++;
     else break;
   }
  
   // search for trailing empty lines
   int b=l-1,bi=-1;
   p=s.data()+b;
   while (b>=0)
   {
     c=*p;
     if (c==' ' || c=='\t' || c=='\r') b--,p--;
     else if (c=='r' && b>=7 && qstrncmp(p-7,"\\ilinebr",8)==0) bi=b-7,b-=8,p-=8;
     else if (c=='\n') bi=b,b--,p--;
     else break;
   }
  
   // return whole string if no leading or trailing lines where found
   if (li==-1 && bi==-1) return s;
  
   // return substring
   if (bi==-1) bi=l;
   if (li==-1) li=0;
   if (bi<=li) return QCString(); // only empty lines
   //printf("docLine='%s' len=%d li=%d bi=%d\n",qPrint(s),s.length(),li,bi);
   return s.mid(li,bi-li);
 }

引用了 QCString::data(), QCString::isEmpty(), QCString::length(), QCString::mid() , 以及 qstrncmp().

被这些函数引用 DefinitionImpl::_setBriefDescription(), DefinitionImpl::_setDocumentation(), DocGroup::addDocs(), VHDLOutlineParser::checkInlineCode() , 以及 DocPara::handleCommand().

◆ stripPath()

QCString stripPath ( const QCString & s )

在文件 util.cpp 第 5318 行定义.

 {
   QCString result=s;
   int i=result.findRev('/');
   if (i!=-1)
   {
     result=result.mid(i+1);
   }
   i=result.findRev('\\');
   if (i!=-1)
   {
     result=result.mid(i+1);
   }
   return result;
 }

引用了 QCString::findRev() , 以及 QCString::mid().

被这些函数引用 TagFileParser::buildLists(), RTFGenerator::endDoxyAnchor(), LatexGenerator::endIndexItem(), LatexGenerator::endIndexValue(), LatexGenerator::endTitleHead(), InheritedMemberInfoContext::Private::id(), DotFilePatcher::run(), SearchIndexExternal::setCurrentDoc(), LatexGenerator::startDoxyAnchor(), DocbookGenerator::startDoxyAnchor(), RTFGenerator::startFile(), LatexGenerator::startFile(), DocbookGenerator::startFile(), DocbookDocVisitor::startLink(), RTFDocVisitor::startLink(), LatexDocVisitor::startLink(), DocbookGenerator::startSection(), LatexGenerator::startSection(), RTFGenerator::startTextLink(), LatexGenerator::startTextLink(), LatexGenerator::startTitleHead(), substituteHtmlKeywords(), substituteKeywords(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), LatexDocVisitor::visitPost(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), RTFGenerator::writeAnchor(), LatexGenerator::writeAnchor(), LatexCodeGenerator::writeCodeLink(), RTFGenerator::writeCodeLink(), DocbookCodeGenerator::writeCodeLinkLine(), MemberList::writeDeclarations(), writeDocbookLink(), LatexGenerator::writeEndAnnoItem(), LatexCodeGenerator::writeLineNumber(), RTFGenerator::writeLineNumber(), TextGeneratorLatex::writeLink(), RTFGenerator::writeObjectLink(), LatexGenerator::writeObjectLink(), DocbookGenerator::writeObjectLink(), DocbookGenerator::writePageLink(), RTFGenerator::writeRTFReference() , 以及 RTFGenerator::writeStartAnnoItem().

◆ stripScope()

QCString stripScope ( const QCString & name )

Strips the scope from a name. Examples: A::B will return A and A<T>::B<N::C<D> > will return A<T>.

在文件 util.cpp 第 3815 行定义.

 {
   QCString result = name;
   int l=result.length();
   int p;
   bool done = FALSE;
   bool skipBracket=FALSE; // if brackets do not match properly, ignore them altogether
   int count=0;
   int round=0;
  
   do
   {
     p=l-1; // start at the end of the string
     while (p>=0 && count>=0)
     {
       char c=result.at(p);
       switch (c)
       {
         case ':':
           // only exit in the case of ::
           //printf("stripScope(%s)=%s\n",name,qPrint(result.right(l-p-1)));
           if (p>0 && result.at(p-1)==':' && (count==0 || skipBracket))
           {
             return result.right(l-p-1);
           }
           p--;
           break;
         case '>':
           if (skipBracket) // we don't care about brackets
           {
             p--;
           }
           else // count open/close brackets
           {
             if (p>0 && result.at(p-1)=='>') // skip >> operator
             {
               p-=2;
               break;
             }
             count=1;
             //printf("pos < = %d\n",p);
             p--;
             bool foundMatch=false;
             while (p>=0 && !foundMatch)
             {
               c=result.at(p--);
               switch (c)
               {
                 case ')':
                   round++;
                   break;
                 case '(':
                   round--;
                   break;
                 case '>': // ignore > inside (...) to support e.g. (sizeof(T)>0) inside template parameters
                   if (round==0) count++;
                   break;
                 case '<':
                   if (round==0)
                   {
                     if (p>0)
                     {
                       if (result.at(p-1) == '<') // skip << operator
                       {
                         p--;
                         break;
                       }
                     }
                     count--;
                     foundMatch = count==0;
                   }
                   break;
                 default:
                   //printf("c=%c count=%d\n",c,count);
                   break;
               }
             }
           }
           //printf("pos > = %d\n",p+1);
           break;
         default:
           p--;
       }
     }
     done = count==0 || skipBracket; // reparse if brackets do not match
     skipBracket=TRUE;
   }
   while (!done); // if < > unbalanced repeat ignoring them
   //printf("stripScope(%s)=%s\n",name,name);
   return name;
 }

引用了 QCString::at(), FALSE, QCString::length(), QCString::right() , 以及 TRUE.

被这些函数引用 DotClassGraph::addClass(), getCanonicalTypeForIdentifier(), DefinitionImpl::IMPL::init(), DiagramItem::label(), NamespaceDefImpl::writeBriefDescription() , 以及 ClassDefImpl::writeIncludeFilesForSlice().

◆ stripTemplateSpecifiersFromScope()

QCString stripTemplateSpecifiersFromScope	(	const QCString &	fullName,
		bool	parentOnly,
		QCString *	pLastScopeStripped
	)

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.

在文件 util.cpp 第 4605 行定义.

 {
   int i=fullName.find('<');
   if (i==-1) return fullName;
   QCString result;
   int p=0;
   int l=fullName.length();
   while (i!=-1)
   {
     //printf("1:result+=%s\n",qPrint(fullName.mid(p,i-p)));
     int e=i+1;
     int count=1;
     int round=0;
     while (e<l && count>0)
     {
       char c=fullName.at(e++);
       switch (c)
       {
         case '(': round++; break;
         case ')': if (round>0) round--; break;
         case '<': if (round==0) count++; break;
         case '>': if (round==0) count--; break;
         default:
           break;
       }
     }
     int si= fullName.find("::",e);
  
     if (parentOnly && si==-1) break;
     // we only do the parent scope, so we stop here if needed
  
     result+=fullName.mid(p,i-p);
     //printf("  trying %s\n",qPrint(result+fullName.mid(i,e-i)));
     if (getClass(result+fullName.mid(i,e-i))!=0)
     {
       result+=fullName.mid(i,e-i);
       //printf("  2:result+=%s\n",qPrint(fullName.mid(i,e-i-1)));
     }
     else if (pLastScopeStripped)
     {
       //printf("  last stripped scope '%s'\n",qPrint(fullName.mid(i,e-i)));
       *pLastScopeStripped=fullName.mid(i,e-i);
     }
     p=e;
     i=fullName.find('<',p);
   }
   result+=fullName.right(l-p);
   //printf("3:result+=%s\n",qPrint(fullName.right(l-p)));
   return result;
 }

引用了 QCString::at(), QCString::find(), getClass(), QCString::length(), QCString::mid() , 以及 QCString::right().

被这些函数引用 addClassToContext(), addMemberFunction(), computeTemplateClassRelations(), extractClassName(), findMember(), findScopeFromQualifiedName(), findUsingDeclImports(), getCanonicalTypeForIdentifier(), getDefs(), SymbolResolver::Private::getResolvedClassRec(), SymbolResolver::Private::newResolveTypedef() , 以及 resolveLink().

◆ substituteClassNames()

QCString substituteClassNames ( const QCString & s )

◆ substituteKeywords()

QCString substituteKeywords	(	const QCString &	s,
		const QCString &	title,
		const QCString &	projName,
		const QCString &	projNum,
		const QCString &	projBrief
	)

在文件 util.cpp 第 3335 行定义.

 {
   QCString result = s;
   if (!title.isEmpty()) result = substitute(result,"$title",title);
   result = substitute(result,"$datetime",dateToString(TRUE));
   result = substitute(result,"$date",dateToString(FALSE));
   result = substitute(result,"$year",yearToString());
   result = substitute(result,"$doxygenversion",getDoxygenVersion());
   result = substitute(result,"$projectname",projName);
   result = substitute(result,"$projectnumber",projNum);
   result = substitute(result,"$projectbrief",projBrief);
   result = substitute(result,"$projectlogo",stripPath(Config_getString(PROJECT_LOGO)));
   return result;
 }

引用了 Config_getString, dateToString(), FALSE, QCString::isEmpty(), stripPath(), substitute(), TRUE , 以及 yearToString().

被这些函数引用 substituteHtmlKeywords() , 以及 substituteLatexKeywords().

◆ substituteTemplateArgumentsInString()

QCString substituteTemplateArgumentsInString	(	const QCString &	nm,
		const ArgumentList &	formalArgs,
		const std::unique_ptr< 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.

在文件 util.cpp 第 4477 行定义.

 {
   //printf("substituteTemplateArgumentsInString(name=%s formal=%s actualArg=%s)\n",
   //    qPrint(name),qPrint(argListToString(formalArgs)),qPrint(argListToString(actualArgs)));
   if (formalArgs.empty()) return nm;
   QCString result;
  
   static const reg::Ex re(R"(\a[\w:]*)");
   std::string name = nm.str();
   reg::Iterator it(name,re);
   reg::Iterator end;
   size_t p=0;
  
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     size_t i = match.position();
     size_t l = match.length();
     if (i>p) result += name.substr(p,i-p);
     QCString n(match.str());
     ArgumentList::iterator actIt;
     if (actualArgs)
     {
       actIt = actualArgs->begin();
     }
  
     // if n is a template argument, then we substitute it
     // for its template instance argument.
     bool found=FALSE;
     for (auto formIt = formalArgs.begin();
         formIt!=formalArgs.end() && !found;
         ++formIt
         )
     {
       Argument formArg = *formIt;
       Argument actArg;
       if (actualArgs && actIt!=actualArgs->end())
       {
         actArg = *actIt;
       }
       if (formArg.type.left(6)=="class " && formArg.name.isEmpty())
       {
         formArg.name = formArg.type.mid(6);
         formArg.type = "class";
       }
       if (formArg.type.left(9)=="typename " && formArg.name.isEmpty())
       {
         formArg.name = formArg.type.mid(9);
         formArg.type = "typename";
       }
       if (formArg.type=="class" || formArg.type=="typename" || formArg.type.left(8)=="template")
       {
         //printf("n=%s formArg->type='%s' formArg->name='%s' formArg->defval='%s'\n",
         //  qPrint(n),qPrint(formArg->type),qPrint(formArg->name),qPrint(formArg->defval));
         //printf(">> n='%s' formArg->name='%s' actArg->type='%s' actArg->name='%s'\n",
         //    qPrint(n),qPrint(formArg.name),actIt!=actualArgs.end() ? qPrint(actIt->type) : "",actIt!=actualArgs.end() ? qPrint(actIt->name) : ""
         //    );
         if (formArg.name==n && actualArgs && actIt!=actualArgs->end() && !actArg.type.isEmpty()) // base class is a template argument
         {
           // replace formal argument with the actual argument of the instance
           if (!leftScopeMatch(actArg.type,n))
             // the scope guard is to prevent recursive lockup for
             // template<class A> class C : public<A::T>,
             // where A::T would become A::T::T here,
             // since n==A and actArg->type==A::T
             // see bug595833 for an example
           {
             if (actArg.name.isEmpty())
             {
               result += actArg.type+" ";
               found=TRUE;
             }
             else
               // for case where the actual arg is something like "unsigned int"
               // the "int" part is in actArg->name.
             {
               result += actArg.type+" "+actArg.name+" ";
               found=TRUE;
             }
           }
         }
         else if (formArg.name==n &&
                  (actualArgs==nullptr || actIt==actualArgs->end()) &&
                  !formArg.defval.isEmpty() &&
                  formArg.defval!=nm /* to prevent recursion */
             )
         {
           result += substituteTemplateArgumentsInString(formArg.defval,formalArgs,actualArgs)+" ";
           found=TRUE;
         }
       }
       else if (formArg.name==n &&
                (actualArgs==nullptr || actIt==actualArgs->end()) &&
                !formArg.defval.isEmpty() &&
                formArg.defval!=nm /* to prevent recursion */
               )
       {
         result += substituteTemplateArgumentsInString(formArg.defval,formalArgs,actualArgs)+" ";
         found=TRUE;
       }
       if (actualArgs && actIt!=actualArgs->end())
       {
         actIt++;
       }
     }
     if (!found)
     {
       result += n;
     }
     p=i+l;
   }
   result+=name.substr(p);
   //printf("      Inheritance relation %s -> %s\n",
   //    qPrint(name),qPrint(result));
   return result.stripWhiteSpace();
 }

引用了 ArgumentList::begin(), Argument::defval, ArgumentList::empty(), ArgumentList::end(), end(), FALSE, QCString::isEmpty(), QCString::left(), leftScopeMatch(), reg::match(), QCString::mid(), Argument::name, QCString::str(), QCString::stripWhiteSpace(), substituteTemplateArgumentsInString(), TRUE , 以及 Argument::type.

被这些函数引用 computeTemplateClassRelations(), MemberDefImpl::createTemplateInstanceMember(), findBaseClassesForClass(), findUsedClassesForClass(), SymbolResolver::Private::newResolveTypedef() , 以及 substituteTemplateArgumentsInString().

◆ tempArgListToString()

QCString tempArgListToString	(	const ArgumentList &	al,
		SrcLangExt	lang,
		bool	includeDefaults = `true`
	)

在文件 util.cpp 第 1194 行定义.

 {
   QCString result;
   if (al.empty()) return result;
   result="<";
   bool first=true;
   for (const auto &a : al)
   {
     if (a.defval.isEmpty() || includeDefault)
     {
       if (!first) result+=", ";
       if (!a.name.isEmpty()) // add template argument name
       {
         if (lang==SrcLangExt_Java || lang==SrcLangExt_CSharp)
         {
           result+=a.type+" ";
         }
         result+=a.name;
       }
       else // extract name from type
       {
         int i=a.type.length()-1;
         while (i>=0 && isId(a.type.at(i))) i--;
         if (i>0)
         {
           result+=a.type.right(a.type.length()-i-1);
           if (a.type.find("...")!=-1)
           {
             result+="...";
           }
         }
         else // nothing found -> take whole name
         {
           result+=a.type;
         }
       }
       if (!a.typeConstraint.isEmpty() && lang==SrcLangExt_Java)
       {
         result+=" extends "; // TODO: now Java specific, C# has where...
         result+=a.typeConstraint;
       }
       first=false;
     }
   }
   result+=">";
   return removeRedundantWhiteSpace(result);
 }

引用了 ArgumentList::empty(), isId(), QCString::length(), removeRedundantWhiteSpace(), QCString::right(), SrcLangExt_CSharp , 以及 SrcLangExt_Java.

被这些函数引用 addMemberFunction(), findTemplateInstanceRelation(), makeQualifiedNameWithTemplateParameters(), searchTemplateSpecs() , 以及 writeDefArgumentList().

◆ transcodeCharacterStringToUTF8()

QCString transcodeCharacterStringToUTF8 ( const QCString & input )

在文件 util.cpp 第 1350 行定义.

 {
   bool error=FALSE;
   static QCString inputEncoding = Config_getString(INPUT_ENCODING);
   const char *outputEncoding = "UTF-8";
   if (inputEncoding.isEmpty() || qstricmp(inputEncoding,outputEncoding)==0) return input;
   int inputSize=input.length();
   int outputSize=inputSize*4+1;
   QCString output(outputSize);
   void *cd = portable_iconv_open(outputEncoding,inputEncoding.data());
   if (cd==(void *)(-1))
   {
     err("unsupported character conversion: '%s'->'%s'\n",
         qPrint(inputEncoding),outputEncoding);
     error=TRUE;
   }
   if (!error)
   {
     size_t iLeft=inputSize;
     size_t oLeft=outputSize;
     const char *inputPtr = input.data();
     char *outputPtr = output.rawData();
     if (!portable_iconv(cd, &inputPtr, &iLeft, &outputPtr, &oLeft))
     {
       outputSize-=(int)oLeft;
       output.resize(outputSize+1);
       output.at(outputSize)='\0';
       //printf("iconv: input size=%d output size=%d\n[%s]\n",size,newSize,qPrint(srcBuf));
     }
     else
     {
       err("failed to translate characters from %s to %s: check INPUT_ENCODING\ninput=[%s]\n",
           qPrint(inputEncoding),outputEncoding,qPrint(input));
       error=TRUE;
     }
   }
   portable_iconv_close(cd);
   return error ? input : output;
 }

引用了 QCString::at(), Config_getString, QCString::data(), err(), FALSE, QCString::isEmpty(), QCString::length(), portable_iconv(), portable_iconv_close(), portable_iconv_open(), qPrint(), qstricmp(), QCString::rawData(), QCString::resize() , 以及 TRUE.

被这些函数引用 readCodeFragment().

◆ unescapeCharsInString()

QCString unescapeCharsInString ( const QCString & s )

在文件 util.cpp 第 3524 行定义.

 {
   if (s.isEmpty()) return s;
   bool caseSenseNames = Config_getBool(CASE_SENSE_NAMES);
   QCString result;
   const char *p = s.data();
   if (p)
   {
     char c;
     while ((c=*p++))
     {
       if (c=='_') // 2 or 3 character escape
       {
         switch (*p)
         {
           case '_': result+=c;   p++; break; // __ -> '_'
           case '1': result+=':'; p++; break; // _1 -> ':'
           case '2': result+='/'; p++; break; // _2 -> '/'
           case '3': result+='<'; p++; break; // _3 -> '<'
           case '4': result+='>'; p++; break; // _4 -> '>'
           case '5': result+='*'; p++; break; // _5 -> '*'
           case '6': result+='&'; p++; break; // _6 -> '&'
           case '7': result+='|'; p++; break; // _7 -> '|'
           case '8': result+='.'; p++; break; // _8 -> '.'
           case '9': result+='!'; p++; break; // _9 -> '!'
           case '0': // 3 character escape
              switch (*(p+1))
              {
                case '0': result+=','; p+=2; break; // _00 -> ','
                case '1': result+=' '; p+=2; break; // _01 -> ' '
                case '2': result+='{'; p+=2; break; // _02 -> '{'
                case '3': result+='}'; p+=2; break; // _03 -> '}'
                case '4': result+='?'; p+=2; break; // _04 -> '?'
                case '5': result+='^'; p+=2; break; // _05 -> '^'
                case '6': result+='%'; p+=2; break; // _06 -> '%'
                case '7': result+='('; p+=2; break; // _07 -> '('
                case '8': result+=')'; p+=2; break; // _08 -> ')'
                case '9': result+='+'; p+=2; break; // _09 -> '+'
                case 'a': result+='='; p+=2; break; // _0a -> '='
                case 'b': result+='$'; p+=2; break; // _0b -> '$'
                case 'c': result+='\\'; p+=2; break;// _0c -> '\'
                case 'd': result+='@'; p+=2; break; // _0d -> '@'
                case 'e': result+=']'; p+=2; break; // _0e -> ']'
                case 'f': result+='['; p+=2; break; // _0f -> '['
                case 'g': result+='#'; p+=2; break; // _0g -> '#'
                default: // unknown escape, just pass underscore character as-is
                  result+=c;
                  break;
              }
              break;
           default:
             if (!caseSenseNames && c>='a' && c<='z') // lower to upper case escape, _a -> 'A'
             {
               result+=(char)toupper(*p);
               p++;
             }
             else // unknown escape, pass underscore character as-is
             {
               result+=c;
             }
             break;
         }
       }
       else // normal character; pass as is
       {
         result+=c;
       }
     }
   }
   return result;
 }

引用了 Config_getBool, QCString::data() , 以及 QCString::isEmpty().

◆ updateLanguageMapping()

bool updateLanguageMapping	(	const QCString &	extension,
		const QCString &	parser
	)

在文件 util.cpp 第 5469 行定义.

 {
   const Lang2ExtMap *p = g_lang2extMap;
   QCString langName = language.lower();
   while (p->langName)
   {
     if (langName==p->langName) break;
     p++;
   }
   if (!p->langName) return FALSE;
  
   // found the language
   SrcLangExt parserId = p->parserId;
   QCString extName = extension.lower();
   if (extName.isEmpty()) return FALSE;
   if (extName.at(0)!='.') extName.prepend(".");
   auto it = g_extLookup.find(extName.str());
   if (it!=g_extLookup.end())
   {
     g_extLookup.erase(it); // language was already register for this ext
   }
   //printf("registering extension %s\n",qPrint(extName));
   g_extLookup.insert(std::make_pair(extName.str(),parserId));
   if (!Doxygen::parserManager->registerExtension(extName,p->parserName))
   {
     err("Failed to assign extension %s to parser %s for language %s\n",
         extName.data(),p->parserName,qPrint(language));
   }
   else
   {
     //msg("Registered extension %s to language parser %s...\n",
     //    extName.data(),qPrint(language));
   }
   return TRUE;
 }

引用了 QCString::at(), QCString::data(), err(), FALSE, g_extLookup, g_lang2extMap, QCString::isEmpty(), Lang2ExtMap::langName, QCString::lower(), Lang2ExtMap::parserId, Doxygen::parserManager, Lang2ExtMap::parserName, QCString::prepend(), qPrint(), QCString::str() , 以及 TRUE.

被这些函数引用 addCodeOnlyMappings(), adjustConfiguration() , 以及 initDefaultExtensionMapping().

◆ writeColoredImgData()

void writeColoredImgData	(	const QCString &	dir,
		ColoredImgDataItem	data[]
	)

Writes the intensity only bitmap represented by data as an image to directory dir using the colors defined by HTML_COLORSTYLE_*.

在文件 util.cpp 第 6363 行定义.

 {
   static int hue   = Config_getInt(HTML_COLORSTYLE_HUE);
   static int sat   = Config_getInt(HTML_COLORSTYLE_SAT);
   static int gamma = Config_getInt(HTML_COLORSTYLE_GAMMA);
   while (data->name)
   {
     QCString fileName = dir+"/"+data->name;
     ColoredImage img(data->width,data->height,data->content,data->alpha,
                      sat,hue,gamma);
     if (!img.save(fileName))
     {
       fprintf(stderr,"Warning: Cannot open file %s for writing\n",data->name);
     }
     Doxygen::indexList->addImageFile(data->name);
     data++;
   }
 }

引用了 IndexList::addImageFile(), ColoredImgDataItem::alpha, Config_getInt, ColoredImgDataItem::content, ColoredImgDataItem::height, Doxygen::indexList, ColoredImgDataItem::name, ColoredImage::save() , 以及 ColoredImgDataItem::width.

被这些函数引用 ResourceMgr::copyResourceAs().

◆ writeExamples()

void writeExamples	(	OutputList &	ol,
		const ExampleList &	el
	)

在文件 util.cpp 第 1120 行定义.

 {
   auto replaceFunc = [&list,&ol](size_t entryIndex)
   {
     const auto &e = list[entryIndex];
     ol.pushGeneratorState();
     ol.disable(OutputGenerator::Latex);
     ol.disable(OutputGenerator::RTF);
     ol.disable(OutputGenerator::Docbook);
     // link for Html / man
     //printf("writeObjectLink(file=%s)\n",qPrint(e->file));
     ol.writeObjectLink(QCString(),e.file,e.anchor,e.name);
     ol.popGeneratorState();
  
     ol.pushGeneratorState();
     ol.disable(OutputGenerator::Man);
     ol.disable(OutputGenerator::Html);
     // link for Latex / pdf with anchor because the sources
     // are not hyperlinked (not possible with a verbatim environment).
     ol.writeObjectLink(QCString(),e.file,QCString(),e.name);
     ol.popGeneratorState();
   };
  
   writeMarkerList(ol, theTranslator->trWriteList((int)list.size()).str(), list.size(), replaceFunc);
  
   ol.writeString(".");
 }

引用了 OutputList::disable(), OutputGenerator::Docbook, OutputGenerator::Html, OutputGenerator::Latex, OutputGenerator::Man, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, QCString::str(), theTranslator, Translator::trWriteList(), writeMarkerList(), OutputList::writeObjectLink() , 以及 OutputList::writeString().

被这些函数引用 MemberDefImpl::_writeExamples() , 以及 ClassDefImpl::writeDetailedDocumentationBody().

◆ writeExtraLatexPackages()

void writeExtraLatexPackages ( TextStream & t )

在文件 util.cpp 第 7066 行定义.

 {
   // User-specified packages
   const StringVector &extraPackages = Config_getList(EXTRA_PACKAGES);
   if (!extraPackages.empty())
   {
     t << "% Packages requested by user\n";
     for (const auto &pkgName : extraPackages)
     {
       if ((pkgName[0] == '[') || (pkgName[0] == '{'))
         t << "\\usepackage" << pkgName.c_str() << "\n";
       else
         t << "\\usepackage{" << pkgName.c_str() << "}\n";
     }
     t << "\n";
   }
 }

引用了 Config_getList.

被这些函数引用 FormulaManager::generateImages() , 以及 substituteLatexKeywords().

◆ writeLatexSpecialFormulaChars()

void writeLatexSpecialFormulaChars ( TextStream & t )

在文件 util.cpp 第 7084 行定义.

 {
     unsigned char minus[4]; // Superscript minus
     char *pminus = (char *)minus;
     unsigned char sup2[3]; // Superscript two
     char *psup2 = (char *)sup2;
     unsigned char sup3[3];
     char *psup3 = (char *)sup3; // Superscript three
     minus[0]= 0xE2;
     minus[1]= 0x81;
     minus[2]= 0xBB;
     minus[3]= 0;
     sup2[0]= 0xC2;
     sup2[1]= 0xB2;
     sup2[2]= 0;
     sup3[0]= 0xC2;
     sup3[1]= 0xB3;
     sup3[2]= 0;
  
     t << "\\usepackage{newunicodechar}\n"
          "  \\newunicodechar{" << pminus << "}{${}^{-}$}% Superscript minus\n"
          "  \\newunicodechar{" << psup2  << "}{${}^{2}$}% Superscript two\n"
          "  \\newunicodechar{" << psup3  << "}{${}^{3}$}% Superscript three\n"
          "\n";
 }

被这些函数引用 FormulaManager::generateImages() , 以及 substituteLatexKeywords().

◆ writeMarkerList()

void writeMarkerList	(	OutputList &	ol,
		const std::string &	markerText,
		size_t	numMarkers,
		std::function< void(size_t)>	replaceFunc
	)

在文件 util.cpp 第 1096 行定义.

 {
   static const reg::Ex marker(R"(@(\d+))");
   reg::Iterator it(markerText,marker);
   reg::Iterator end;
   size_t index=0;
   // now replace all markers in inheritLine with links to the classes
   for ( ; it!=end ; ++it)
   {
     const auto &match = *it;
     size_t newIndex = match.position();
     size_t matchLen = match.length();
     ol.parseText(markerText.substr(index,newIndex-index));
     unsigned long entryIndex = std::stoul(match[1].str());
     if (entryIndex<(unsigned long)numMarkers)
     {
       replaceFunc(entryIndex);
     }
     index=newIndex+matchLen;
   }
   ol.parseText(markerText.substr(index));
 }

引用了 end(), reg::match() , 以及 OutputList::parseText().

被这些函数引用 MemberDefImpl::_writeReimplementedBy(), DefinitionImpl::_writeSourceRefList(), writeExamples() , 以及 ClassDefImpl::writeInheritanceGraph().

◆ writePageRef()

void writePageRef	(	OutputDocInterface &	od,
		const QCString &	cn,
		const QCString &	mn
	)

在文件 util.cpp 第 264 行定义.

 {
   od.pushGeneratorState();
  
   od.disable(OutputGenerator::Html);
   od.disable(OutputGenerator::Man);
   od.disable(OutputGenerator::Docbook);
   if (Config_getBool(PDF_HYPERLINKS)) od.disable(OutputGenerator::Latex);
   if (Config_getBool(RTF_HYPERLINKS)) od.disable(OutputGenerator::RTF);
   od.startPageRef();
   od.docify(theTranslator->trPageAbbreviation());
   od.endPageRef(cn,mn);
  
   od.popGeneratorState();
 }

引用了 Config_getBool, OutputDocInterface::disable(), OutputGenerator::Docbook, BaseOutputDocInterface::docify(), BaseOutputDocInterface::endPageRef(), OutputGenerator::Html, OutputGenerator::Latex, OutputGenerator::Man, OutputDocInterface::popGeneratorState(), OutputDocInterface::pushGeneratorState(), OutputGenerator::RTF, BaseOutputDocInterface::startPageRef(), theTranslator , 以及 Translator::trPageAbbreviation().

被这些函数引用 MemberDefImpl::_writeReimplementedBy(), MemberDefImpl::_writeReimplements() , 以及 generateLink().

◆ writeTypeConstraints()

void writeTypeConstraints	(	OutputList &	ol,
		const Definition *	d,
		const ArgumentList &	al
	)

在文件 util.cpp 第 6073 行定义.

 {
   if (al.empty()) return;
   ol.startConstraintList(theTranslator->trTypeConstraints());
   for (const Argument &a : al)
   {
     ol.startConstraintParam();
     ol.parseText(a.name);
     ol.endConstraintParam();
     ol.startConstraintType();
     linkifyText(TextGeneratorOLImpl(ol),d,0,0,a.type);
     ol.endConstraintType();
     ol.startConstraintDocs();
     ol.generateDoc(d->docFile(),d->docLine(),d,0,a.docs,TRUE,FALSE,
                    QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     ol.endConstraintDocs();
   }
   ol.endConstraintList();
 }

引用了 Config_getBool, Definition::docFile(), Definition::docLine(), ArgumentList::empty(), OutputList::endConstraintDocs(), OutputList::endConstraintList(), OutputList::endConstraintParam(), OutputList::endConstraintType(), FALSE, OutputList::generateDoc(), linkifyText(), OutputList::parseText(), OutputList::startConstraintDocs(), OutputList::startConstraintList(), OutputList::startConstraintParam(), OutputList::startConstraintType(), theTranslator, Translator::trTypeConstraints() , 以及 TRUE.

被这些函数引用 MemberDefImpl::_writeTypeConstraints() , 以及 ClassDefImpl::writeDetailedDocumentationBody().

类

函数

详细描述

函数说明

◆ addCodeOnlyMappings()

◆ addDirPrefix()

◆ addGroupListToTitle()

◆ addHtmlExtensionIfMissing()

◆ addMembersToMemberGroup()

◆ addRefItem()

◆ addRelatedPage()

◆ argListToString()

◆ checkExtension()

◆ checkIfTypedef()

◆ clearBlock()

◆ clearSubDirs()

◆ computeQualifiedIndex()

◆ containsWord()

◆ convertCharEntitiesToUTF8()

◆ convertFileNameFortranParserCode()

◆ convertNameToFile()

◆ convertProtectionLevel()

◆ convertToDocBook()

◆ convertToHtml()

◆ convertToId()

◆ convertToJSString()

◆ convertToLaTeX()

◆ convertToPSString()

◆ convertToXML()

◆ copyFile()

◆ correctId()

◆ correctURL()

◆ countAliasArguments()

◆ createSubDirs()

◆ dateToString()

◆ escapeCharsInString()

◆ expandAlias()

◆ externalLinkTarget()

◆ externalRef()

◆ extractAliasArgs()

◆ extractBlock()

◆ extractClassNameFromType()

◆ extractDirection()

◆ extractNamespaceName()

◆ fileToString()

◆ fileVisibleInIndex()

◆ filterLatexString()

◆ filterTitle()

◆ findAndRemoveWord()

◆ findFileDef()

◆ findIndex() [1/2]

◆ findIndex() [2/2]

◆ generateFileRef()

◆ generateLink()

◆ generateMarker()

◆ getCanonicalTemplateSpec()

◆ getDefs()

◆ getDotImageExtension()

◆ getFileFilter()

◆ getFileNameExtension()

◆ getLanguageFromCodeLang()

◆ getLanguageFromFileName()

◆ getLanguageSpecificSeparator()

◆ getOverloadDocs()

◆ getPrefixIndex()

◆ getScopeFragment()

◆ guessSection()

◆ initDefaultExtensionMapping()

◆ insertTemplateSpecifierInScope()

◆ integerToAlpha()

◆ integerToRoman()

◆ isId()

◆ isIdJS()

◆ isURL()

◆ join()

◆ langToString()

◆ latexEscapeIndexChars()

◆ latexEscapeLabelName()

◆ latexEscapePDFString()

◆ latexFilterURL()