浏览该文件的文档.
24 #include <unordered_map>
100 bool keepSpaces=
FALSE,
116 bool forceEmptyScope=
FALSE,
128 bool lookForSpecializations =
TRUE,
129 const FileDef *currentFile = 0,
130 bool checkScope =
FALSE
174 return c==
'_' || c>=128 || c<0 ||
isalnum(c) || c==
'$';
178 return c>=128 || c<0 ||
isalnum(c);
214 bool allowEmptyClass=
FALSE);
252 const std::unique_ptr<ArgumentList> &actualArgs);
255 bool parentOnly=
TRUE,
354 std::string
expandAlias(
const std::string &aliasName,
const std::string &aliasValue);
363 bool filter=
TRUE,
bool isSourceCode=
FALSE);
373 std::function<
void(
size_t)> replaceFunc);
std::vector< std::string > StringVector
QCString removeRedundantWhiteSpace(const QCString &s)
QCString substituteKeywords(const QCString &s, const QCString &title, const QCString &projName, const QCString &projNum, const QCString &projBrief)
void writeExamples(OutputList &ol, const ExampleList &el)
OutputDocInterface & m_od
FortranFormat convertFileNameFortranParserCode(QCString fn)
This struct is used to capture the tag file information for an Entry.
bool findAndRemoveWord(QCString &s, const char *word)
removes occurrences of whole word from sentence, while keeps internal spaces and reducing multiple se...
void writePageRef(OutputDocInterface &od, const QCString &cn, const QCString &mn)
QCString convertToXML(const QCString &s, bool keepEntities=FALSE)
QCString transcodeCharacterStringToUTF8(const QCString &input)
bool containsWord(const QCString &s, const char *word)
returns TRUE iff string s contains word w
void addMembersToMemberGroup(MemberList *ml, MemberGroupList *pMemberGroups, const Definition *context)
QCString stripExtension(const QCString &fName)
QCString stripFromPath(const QCString &path)
Protection
Protection level of members
QCString stripScope(const QCString &name)
QCString stripIndentation(const QCString &s)
QCString getFileNameExtension(const QCString &fn)
QCString fileToString(const QCString &name, bool filter=FALSE, bool isSourceCode=FALSE)
The common base class of all entity definitions found in the sources.
Data associated with a HSV colored image.
QCString filterTitle(const QCString &title)
bool openOutputFile(const QCString &outFile, std::ofstream &f)
An abstract interface of a namespace symbol.
Class representing a directory in the file system
bool patternMatch(const FileInfo &fi, const StringVector &patList)
bool copyFile(const QCString &src, const QCString &dest)
Copies the contents of file with name src to the newly created file with name dest.
Interface used for generating documentation.
This file contains a number of basic enums and types.
QCString getCanonicalTemplateSpec(const Definition *d, const FileDef *fs, const QCString &spec)
Buffer used to store strings
QCString escapeCharsInString(const QCString &name, bool allowDots, bool allowUnderscore=FALSE)
This class represents an function or template argument list.
QCString unescapeCharsInString(const QCString &s)
QCString processMarkup(const QCString &s)
QCString generateMarker(int id)
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
QCString convertToJSString(const QCString &s)
int getScopeFragment(const QCString &s, int p, int *l)
QCString replaceAnonymousScopes(const QCString &s, const QCString &replacement=QCString())
Implements TextGeneratorIntf for an OutputDocInterface stream.
QCString stripExtensionGeneral(const QCString &fName, const QCString &ext)
QCString stripFromIncludePath(const QCString &path)
SrcLangExt
Language as given by extension
QCString convertCharEntitiesToUTF8(const QCString &s)
QCString argListToString(const ArgumentList &al, bool useCanonicalType=FALSE, bool showDefVals=TRUE)
QCString insertTemplateSpecifierInScope(const QCString &scope, const QCString &templ)
SrcLangExt getLanguageFromCodeLang(QCString &fileName)
Routine to handle the language attribute of the \code command
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)
QCString clearBlock(const char *s, const char *begin, const char *end)
void writeLatexSpecialFormulaChars(TextStream &t)
QCString substituteTemplateArgumentsInString(const QCString &name, const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs)
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
QCString getFileFilter(const QCString &name, bool isSourceCode)
int lineBlock(const QCString &text, const QCString &marker)
Returns the line number of the line following the line with the marker.
QCString extractBlock(const QCString &text, const QCString &marker)
Returns the section of text, in between a pair of markers.
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)
void writeExtraLatexPackages(TextStream &t)
QCString convertToLaTeX(const QCString &s, bool insideTabbing=FALSE, bool keepSpaces=FALSE)
int countAliasArguments(const QCString &argList)
virtual ~TextGeneratorIntf()
Text streaming class that buffers data.
QCString convertToDocBook(const QCString &s)
QCString convertToId(const QCString &s)
QCString selectBlock(const QCString &s, const QCString &name, bool enable, OutputGenerator::OutputType o)
QCString integerToAlpha(int n, bool upper=true)
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
DirIterator begin(DirIterator it) noexcept
int extractClassNameFromType(const QCString &type, int &pos, QCString &name, QCString &templSpec, SrcLangExt=SrcLangExt_Unknown)
QCString getOverloadDocs()
Ordered dictionary of FileName objects.
QCString stripLeadingAndTrailingEmptyLines(const QCString &s, int &docLine)
Special version of QCString::stripWhiteSpace() that only strips completely blank lines.
DirIterator end(const DirIterator &) noexcept
void addDirPrefix(QCString &fileName)
QCString stripTemplateSpecifiersFromScope(const QCString &fullName, bool parentOnly=TRUE, QCString *lastScopeStripped=0)
void initDefaultExtensionMapping()
A model of a page symbol.
A model of a group of symbols.
bool rightScopeMatch(const QCString &scope, const QCString &name)
QCString recodeString(const QCString &str, const char *fromEncoding, const char *toEncoding)
virtual ~TextGeneratorOLImpl()
Class representing a list of output generators that are written to in parallel.
QCString extractDirection(QCString &docs)
Strip the direction part from docs and return it as a string in canonical form The input docs string ...
bool checkExtension(const QCString &fName, const QCString &ext)
int getPrefixIndex(const QCString &name)
A model of a class/file/namespace member symbol.
A abstract class representing of a compound symbol.
QCString convertToPSString(const QCString &s)
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
int nextUtf8CharPosition(const QCString &utf8Str, uint len, uint startPos)
QCString externalRef(const QCString &relPath, const QCString &ref, bool href)
virtual void writeLink(const QCString &extRef, const QCString &file, const QCString &anchor, const QCString &text) const =0
QCString correctId(const QCString &s)
void generateFileRef(OutputDocInterface &od, const QCString &, const QCString &linkTxt=QCString())
void createSubDirs(const Dir &d)
bool fileVisibleInIndex(const FileDef *fd, bool &genSourceFile)
QCString correctURL(const QCString &url, const QCString &relPath)
Corrects URL url according to the relative path relPath.
static bool isalnum(char c)
QCString addHtmlExtensionIfMissing(const QCString &fName)
QCString stripPath(const QCString &s)
bool checkIfTypedef(const Definition *scope, const FileDef *fileScope, const QCString &n)
QCString latexEscapeIndexChars(const QCString &s)
Abstract interface for a hyperlinked text fragment.
QCString convertToHtml(const QCString &s, bool keepEntities=TRUE)
bool resolveLink(const QCString &scName, const QCString &lr, bool inSeeBlock, const Definition **resContext, QCString &resAnchor)
void clearSubDirs(const Dir &d)
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 c...
QCString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope=FALSE)
Returns the scope separator to use given the programming language lang
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)
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)
void addGroupListToTitle(OutputList &ol, const Definition *d)
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const ArgumentList *dstAl, bool checkCV)
void replaceNamespaceAliases(QCString &scope, int i)
QCString mergeScopes(const QCString &leftScope, const QCString &rightScope)
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces)
QCString resolveTypeDef(const Definition *d, const QCString &name, const Definition **typedefContext=0)
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
std::string expandAlias(const std::string &aliasName, const std::string &aliasValue)
QCString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefaults=true)
QCString resolveAliasCmd(const QCString &aliasCmd)
QCString stripAnonymousNamespaceScope(const QCString &s)
void writeString(const QCString &s, bool keepSpaces) const
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 be...
void writeColoredImgData(const QCString &dir, ColoredImgDataItem data[])
Writes the intensity only bitmap represented by data as an image to directory dir using the colors de...
void mergeArguments(ArgumentList &, ArgumentList &, bool forceNameOverwrite=FALSE)
QCString relativePathToRoot(const QCString &name)
QCString extractAliasArgs(const QCString &args, size_t pos)
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang=SrcLangExt_Cpp)
QCString latexEscapeLabelName(const QCString &s)
std::vector< RefItem * > RefItemVector
QCString latexFilterURL(const QCString &s)
QCString convertNameToFile(const QCString &name, bool allowDots=FALSE, bool allowUnderscore=FALSE)
QCString linkToText(SrcLangExt lang, const QCString &link, bool isFileName)
virtual void writeBreak(int indent) const =0
Class representing a regular expression.
static bool insideTable(DocNode *n)
bool protectionLevelVisible(Protection prot)
bool readInputFile(const QCString &fileName, BufStr &inBuf, bool filter=TRUE, bool isSourceCode=FALSE)
read a file name fileName and optionally filter and transcode it
Minimal replacement for QFileInfo.
void writeLink(const QCString &extRef, const QCString &file, const QCString &anchor, const QCString &text) const
bool isURL(const QCString &url)
Checks whether the given url starts with a supported protocol
class that provide information about a section.
int computeQualifiedIndex(const QCString &name)
void writeBreak(int indent) const
QCString externalLinkTarget(const bool parent=false)
QCString removeAnonymousScopes(const QCString &s)
QCString langToString(SrcLangExt lang)
Returns a string representation of lang.
QCString normalizeNonTemplateArgumentsInString(const QCString &name, const Definition *context, const ArgumentList &formalArgs)
A model of a file symbol.
bool generateLink(OutputDocInterface &od, const QCString &, const QCString &, bool inSeeBlock, const QCString &)
bool recognizeFixedForm(const QCString &contents, FortranFormat format)
void addCodeOnlyMappings()
QCString parseCommentAsText(const Definition *scope, const MemberDef *member, const QCString &doc, const QCString &fileName, int lineNr)
QCString latexEscapePDFString(const QCString &s)
QCString rtfFormatBmkStr(const QCString &name)
QCString removeEmptyLines(const QCString &s)
bool leftScopeMatch(const QCString &scope, const QCString &name)
QCString replaceColorMarkers(const QCString &str)
Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC,...
TextGeneratorOLImpl(OutputDocInterface &od)
A list of MemberDef objects as shown in documentation sections.
QCString showFileDefMatches(const FileNameLinkedMap *fnMap, const QCString &n)
int guessSection(const QCString &name)
QCString substituteClassNames(const QCString &s)
QCString getDotImageExtension()
QCString integerToRoman(int n, bool upper=true)
void extractNamespaceName(const QCString &scopeName, QCString &className, QCString &namespaceName, bool allowEmptyClass=FALSE)
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
bool updateLanguageMapping(const QCString &extension, const QCString &parser)
This is an alternative implementation of QCString.
virtual void writeString(const QCString &, bool) const =0