Doxygen
Loading...
Searching...
No Matches
util.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2026 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16#ifndef UTIL_H
17#define UTIL_H
18
19/*! \file
20 * \brief A bunch of utility functions.
21 */
22
23#include <cctype>
24#include <functional>
25#include <iosfwd>
26#include <variant>
27
28#include "construct.h"
29#include "containers.h"
30#include "types.h"
31
32//--------------------------------------------------------------------
33
34class ArgumentList;
35class ClassDef;
36class ConceptDef;
37class Definition;
38class Dir;
39class ExampleList;
40class FileDef;
41class FileInfo;
42class GroupDef;
43class MemberDef;
44class ModuleDef;
45class NamespaceDef;
46class OutputList;
47
48/*! Returns the scope separator to use given the programming language \a lang */
49DString getLanguageSpecificSeparator(SrcLangExt lang,bool classScope=false);
50
51//----------------------------------------------------------------
52
53/*! reads a file with name \a name and returns it as a string. If \a filter
54 * is true the file will be filtered by any user specified input filter.
55 * If \a name is "-" the string will be read from standard input.
56 */
57DString fileToString(const DString &name,bool filter=false,bool isSourceCode=false);
58
60{
61 public:
62 bool filter() const { return m_filter; }
63 bool isSourceCode() const { return m_isSourceCode; }
64 bool binary() const { return m_binary; }
65
66 ReadInputFileOptions &setFilter(bool b) { m_filter=b; return *this; }
68 ReadInputFileOptions &setBinary(bool b) { m_binary=b; return *this; }
69
70 private:
71 bool m_filter = true;
72 bool m_isSourceCode = false;
73 bool m_binary = false;
74};
75
76//! read a file name \a fileName and optionally filter and transcode it
77bool readInputFile(const DString &fileName,std::string &contents, const ReadInputFileOptions &options = ReadInputFileOptions());
78
79/*! Thread-safe function to write a string representing an inline graph to a file.
80 * The contents will be used to create a hash that will be used to make the name unique.
81 * @param[in] baseName the base name of the file to write including path.
82 * @param[in] extension the file extension to use.
83 * @param[in] content the data to write to the file
84 * @param[out] exists is set to true if the file was already written before.
85 * @returns the name of the file written or an empty string in case of an error.
86 */
87DString writeInlineGraph(const DString &baseName,const DString &extension,const DString &content,bool &exists);
88
89/*! Deletes all graph files written with writeInlineGraph() */
91
92//----------------------------------------------------------------
93
94/*! Helper to pass the input parameters to getDefs() */
96{
97 GetDefInput(const DString &scName,const DString &memName,const DString &a) :
98 scopeName(scName),memberName(memName),args(a) {}
102 bool forceEmptyScope = false;
103 const FileDef *currentFile = nullptr;
104 bool checkCV = false;
105 bool insideCode = false;
106};
107
108/*! Helper to pass the result parameters from getDefs() */
110{
111 bool found = false;
112 const MemberDef *md=nullptr;
113 const ClassDef *cd=nullptr;
114 const FileDef *fd=nullptr;
115 const NamespaceDef *nd=nullptr;
116 const GroupDef *gd=nullptr;
117 const ConceptDef *cnd=nullptr;
118 const ModuleDef *modd=nullptr;
119};
120
121GetDefResult getDefs(const GetDefInput &input);
122
123/*! looks for a filter for the file \a name. Returns the name of the filter
124 * if there is a match for the file name, otherwise an empty string.
125 * In case \a inSourceCode is true then first the source filter list is
126 * considered.
127 */
128DString getFileFilter(const DString &name,bool isSourceCode);
129
130/*! Returns a symbol definition (compound and/or member) given its name and context.
131 * @post return value true implies *resContext!=0 or *resMember!=0
132 */
133bool resolveRef(/* in */ const DString &scName,
134 /* in */ const DString &name,
135 /* in */ bool inSeeBlock,
136 /* out */ const Definition **resContext,
137 /* out */ const MemberDef **resMember,
138 /* in */ SrcLangExt lang,
139 /* in */ bool lookForSpecializations = true,
140 /* in */ const FileDef *currentFile = nullptr,
141 /* in */ bool checkScope = false
142 );
143
144/*! Returns an symbol definition given its name and context for an explicitly linked symbol.
145 * @post return value true implies *resContext!=0
146 */
147bool resolveLink(/* in */ const DString &scName,
148 /* in */ const DString &lr,
149 /* in */ bool inSeeBlock,
150 /* out */ const Definition **resContext,
151 /* out */ DString &resAnchor,
152 /* in */ SrcLangExt lang,
153 /* in */ const DString &prefix=DString(),
154 /* in */ const FileDef *currentFile=nullptr
155 );
156
157DString resolveTypeDef(const Definition *d,const DString &name,
158 const Definition **typedefContext=nullptr);
159
160/*! Resolve a reference via a tagfile reference \a ref.
161 * If after resolving the reference the result points to a relative path
162 * then \a relPath is prepended to create the correct link.
163 */
164DString externalRef(const DString &relPath,const DString &ref);
165
166//----------------------------------------------------------------
167
168/*! Compares two parameter lists \a srcAl and \a dstAl and returns true if they match. */
169bool matchArguments2(const Definition *srcScope,const FileDef *srcFileScope,const DString &srcReturnType,const ArgumentList *srcAl,
170 const Definition *dstScope,const FileDef *dstFileScope,const DString &dstReturnType,const ArgumentList *dstAl,
171 bool checkCV,SrcLangExt lang
172 );
173
174/*! Merges the information of two parameter lists (typically a declaration and a definition).
175 * Missing information is added to either list.
176 * The name of parameter of srcAl is only overwritten if \a forceNameOverwrite is true.
177 */
178void mergeArguments(ArgumentList &srcAl,ArgumentList &dstAl,bool forceNameOverwrite=false);
179
180/*! Returns true if the template parameter lists \a srcAl and \a dstAl match.
181 * The lists are considered to match if they have the same number of parameters and
182 * each matching parameter in \a srcAl and \a dstAl has the same constraints (or at least one parameter has no constraints).
183 */
184bool matchTemplateArguments(const ArgumentList &srcAl,const ArgumentList &dstAl);
185
186/*! Returns a representation of \a name where all known types have been normalized to their canonical form.
187 * The normalization is done in the context of \a context and using the formal arguments in \a formalArgs.
188 */
190 const DString &name,
191 const Definition *context,
192 const ArgumentList &formalArgs);
193
194/*! Substitutes any occurrence of a formal argument from argument list
195 * \a formalArgs in \a name by the corresponding actual argument in
196 * argument list \a actualArgs. The result after substitution
197 * is returned as a string. The argument \a name is used to
198 * prevent recursive substitution.
199 */
201 const DString &name,
202 const ArgumentList &formalArgs,
203 const ArgumentList *actualArgs);
204
205/*! Returns a documentation string combining the inline documentation for each parameter in the list \a al. */
207
208/*! Returns a documentation string combining the inline documentation for each template parameter in the list \a al. */
210
211/*! Returns a string representation of the parameter list \a al.
212 * If \a useCanonicalType is true then the canonical type is used for each argument.
213 * If \a showDefVals is true then default values are included in the string representation.
214 */
215DString argListToString(const ArgumentList &al,bool useCanonicalType=false,bool showDefVals=true);
216
217/*! Returns a string representation of the template parameter list \a al.
218 * The \a lang parameter is used to determine the correct syntax for the template parameters.
219 * If \a includeDefaults is true then default values are included in the string representation.
220 */
221DString tempArgListToString(const ArgumentList &al,SrcLangExt lang,bool includeDefaults=true);
222
223//----------------------------------------------------------------
224
226{
227 const char *name;
229};
230
231using SelectionBlockList = std::vector<SelectionBlock>;
232
234{
236 const char *beginStr;
237 size_t beginLen;
238 const char *endStr;
239 size_t endLen;
240 const char *closeStr;
241 size_t closeLen;
242};
243
244DString selectBlocks(const DString& s,const SelectionBlockList &blockList, const SelectionMarkerInfo &markerInfo);
245void checkBlocks(const DString& s,const DString fileName, const SelectionMarkerInfo &markerInfo);
246
247//----------------------------------------------------------------
248
249DString findExampleFilePath(const DString &file, bool &ambig);
250void writeExamples(OutputList &ol,const ExampleList &el);
251
252//----------------------------------------------------------------
253
254DString stripScope(const DString &name);
256DString stripFromPath(const DString &path);
258DString stripPath(const DString &s);
259DString stripIndentation(const DString &s,bool skipFirstLine=false);
260DString stripExtensionGeneral(const DString &fName, const DString &ext);
261DString stripExtension(const DString &fName);
263void stripIndentationVerbatim(DString &doc,size_t indentationLevel, bool skipFirstLine=true);
264
266DString detab(const DString &s,size_t &refIndent);
267
268//---------------------------------------------------------------
269
270bool rightScopeMatch(const DString &scope, const DString &name);
271bool leftScopeMatch(const DString &scope, const DString &name);
272
273//---------------------------------------------------------------
274
276{
277 const char *keyword;
278 using GetValue = std::function<DString()>;
279 using GetValueWithParam = std::function<DString(const DString &)>;
280 std::variant<GetValue,GetValueWithParam> getValueVariant;
281};
282
283using KeywordSubstitutionList = std::vector<KeywordSubstitution>;
284
285DString substituteKeywords(const DString &file,const DString &s,const KeywordSubstitutionList &keywords);
286
287//---------------------------------------------------------------
288
289void addDirPrefix(DString &fileName);
290int getPrefixIndex(const DString &name);
291int computeQualifiedIndex(const DString &name);
292
293//---------------------------------------------------------------
294
295DString convertNameToFile(const DString &name,bool allowDots=false,bool allowUnderscore=false);
296DString escapeCharsInString(const DString &name,bool allowDots,bool allowUnderscore=false);
298DString linkToText(SrcLangExt lang,const DString &link,bool ignoreDots);
299
300//---------------------------------------------------------------
301
303
304DString replaceAnonymousScopes(const DString &s,const DString &replacement=DString());
305
306DString insertTemplateSpecifierInScope(const DString &scope,const DString &templ);
307
309 bool parentOnly=true,
310 DString *lastScopeStripped=nullptr,
311 DString scopeName=DString(),
312 bool allowArtificial=true);
313
314DString mergeScopes(const DString &leftScope,const DString &rightScope);
315
316int getScopeFragment(const DString &s,int p,int *l);
317
318//---------------------------------------------------------------
319
320DString convertToId(const DString &s);
321DString convertToHtml(const DString &s,bool keepEntities=true);
322DString convertToXML(const DString &s, bool keepEntities=false, bool citeEntry = false);
323DString convertToJSString(const DString &s,bool keepEntities=false,bool singleQuotes=false);
324
325//---------------------------------------------------------------
326
327bool updateLanguageMapping(const DString &extension,const DString &parser);
328SrcLangExt getLanguageFromFileName(const DString& fileName, SrcLangExt defLang=SrcLangExt::Cpp);
333
334//---------------------------------------------------------------
335
336void writeMarkerList(OutputList &ol,const std::string &markerText,size_t numMarkers,
337 std::function<void(size_t)> replaceFunc);
338DString writeMarkerList(const std::string &markerText,size_t numMarkers,
339 std::function<DString(size_t)> replaceFunc);
340
342
343//---------------------------------------------------------------
344
345void createSubDirs(const Dir &d);
346void clearSubDirs(const Dir &d);
348
349/*! Copies the file \a src to \a dest. Returns true if the copy was successful, false otherwise.
350 * When a relative path is used, is is based on the current working directory.
351 */
352bool copyFile(const DString &src,const DString &dest);
353
354/*! Helper to open an output search \a f for writing. If the file already exists it will be renamed to .bak first.
355 * If \a outFile is "-" then the output will be written to standard output.
356 */
357bool openOutputFile(const DString &outFile,std::ofstream &f);
358
359//---------------------------------------------------------------
360
361bool isURL(const DString &url);
362DString correctURL(const DString &url,const DString &relPath);
363DString createHtmlUrl(const DString &relPath,
364 const DString &ref,
365 bool islocalFile,
366 const DString &targetFileName,
367 const DString &anchor);
368
369//---------------------------------------------------------------
370
372DString demangleCSharpGenericName(const DString &name,const DString &templArgs);
373
374//---------------------------------------------------------------
375DString extractBeginRawStringDelimiter(const char *rawStart);
376DString extractEndRawStringDelimiter(const char *rawEnd);
377
378//---------------------------------------------------------------
379
380void extractNamespaceName(const DString &scopeName,
381 DString &className,DString &namespaceName,
382 bool allowEmptyClass=false);
383
384int extractClassNameFromType(const DString &type,int &pos,
385 DString &name,DString &templSpec,SrcLangExt=SrcLangExt::Unknown);
386
387
388/** Returns true if the names of the symbols can be case sensitive. */
389bool useCaseSenseNames();
390
391bool checkExtension(const DString &fName, const DString &ext);
392
394
395bool checkIfTypedef(const Definition *scope,const FileDef *fileScope,const DString &n);
396
397void addGroupListToTitle(OutputList &ol,const Definition *d);
398
399void writeTypeConstraints(OutputList &ol,const Definition *d,const ArgumentList &al);
400
401void stackTrace();
402
404
406 MemberListType inListType,
407 Protection inProt,
408 MemberListType *outListType1,
409 MemberListType *outListType2
410 );
411
412DString makeBaseName(const DString &name, const DString &ext);
413
414DString determineAbsoluteIncludeName(const DString &curFile,const DString &incFileName);
415
416DString filterTitle(const DString &title);
417
418/*! Returns the file extension to use for dot files as specified via the DOT_IMAGE_FORMAT configuration option. */
420/*! Returns the file extension to use for dot files as specified via the argument `format`. */
422
424
425DString externalLinkTarget(const bool parent = false);
426
427DString getEncoding(const FileInfo &fi);
428
429bool mainPageHasTitle();
434
435#endif
constexpr auto prefix
Definition anchor.cpp:47
This class represents an function or template argument list.
Definition arguments.h:66
A abstract class representing of a compound symbol.
Definition classdef.h:100
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:84
The common base class of all entity definitions found in the sources.
Definition definition.h:77
Class representing a directory in the file system.
Definition dir.h:73
A model of a file symbol.
Definition filedef.h:97
Minimal replacement for QFileInfo.
Definition fileinfo.h:26
A model of a group of symbols.
Definition groupdef.h:48
A model of a class/file/namespace member symbol.
Definition memberdef.h:45
Wrapper class for the MemberListType type.
Definition types.h:346
An abstract interface of a namespace symbol.
Class representing a list of output generators that are written to in parallel.
Definition outputlist.h:311
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
Definition docnode.h:1335
Definition message.h:146
bool forceEmptyScope
Definition util.h:102
const FileDef * currentFile
Definition util.h:103
bool insideCode
Definition util.h:105
DString args
Definition util.h:101
DString memberName
Definition util.h:100
bool checkCV
Definition util.h:104
DString scopeName
Definition util.h:99
GetDefInput(const DString &scName, const DString &memName, const DString &a)
Definition util.h:97
const MemberDef * md
Definition util.h:112
const ConceptDef * cnd
Definition util.h:117
const FileDef * fd
Definition util.h:114
const ModuleDef * modd
Definition util.h:118
const GroupDef * gd
Definition util.h:116
bool found
Definition util.h:111
const ClassDef * cd
Definition util.h:113
const NamespaceDef * nd
Definition util.h:115
std::function< DString()> GetValue
Definition util.h:278
std::variant< GetValue, GetValueWithParam > getValueVariant
Definition util.h:280
std::function< DString(const DString &)> GetValueWithParam
Definition util.h:279
const char * keyword
Definition util.h:277
ReadInputFileOptions & setBinary(bool b)
Definition util.h:68
bool binary() const
Definition util.h:64
ReadInputFileOptions & setIsSourceCode(bool b)
Definition util.h:67
bool m_isSourceCode
Definition util.h:72
ReadInputFileOptions & setFilter(bool b)
Definition util.h:66
bool filter() const
Definition util.h:62
bool isSourceCode() const
Definition util.h:63
const char * name
Definition util.h:227
bool enabled
Definition util.h:228
size_t beginLen
Definition util.h:237
const char * closeStr
Definition util.h:240
const char * beginStr
Definition util.h:236
size_t closeLen
Definition util.h:241
const char * endStr
Definition util.h:238
This file contains a number of basic enums and types.
Protection
Definition types.h:32
SrcLangExt
Definition types.h:207
void mergeArguments(ArgumentList &srcAl, ArgumentList &dstAl, bool forceNameOverwrite=false)
Definition util.cpp:1697
DString stripExtension(const DString &fName)
Definition util.cpp:3964
bool useCaseSenseNames()
Returns true if the names of the symbols can be case sensitive.
Definition util.cpp:2688
bool isURL(const DString &url)
Checks whether the given url starts with a supported protocol.
Definition util.cpp:4659
bool resolveLink(const DString &scName, const DString &lr, bool inSeeBlock, const Definition **resContext, DString &resAnchor, SrcLangExt lang, const DString &prefix=DString(), const FileDef *currentFile=nullptr)
Definition util.cpp:2316
DString inlineArgListToDoc(const ArgumentList &al)
Definition util.cpp:4878
DString stripLeadingAndTrailingEmptyLines(const DString &s, int &docLine)
Special version of DString::stripWhiteSpace() that only strips completely blank lines.
Definition util.cpp:3996
DString externalLinkTarget(const bool parent=false)
Definition util.cpp:4504
bool mainPageHasTitle()
Definition util.cpp:4972
DString replaceColorMarkers(const DString &str)
Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC,...
Definition util.cpp:4581
bool protectionLevelVisible(Protection prot)
Definition util.cpp:4684
DString stripFromIncludePath(const DString &path)
Definition util.cpp:227
bool updateLanguageMapping(const DString &extension, const DString &parser)
Definition util.cpp:4072
std::vector< KeywordSubstitution > KeywordSubstitutionList
Definition util.h:283
void extractNamespaceName(const DString &scopeName, DString &className, DString &namespaceName, bool allowEmptyClass=false)
Definition util.cpp:3035
DString mergeScopes(const DString &leftScope, const DString &rightScope)
Definition util.cpp:3762
DString filterTitle(const DString &title)
Definition util.cpp:4467
DString detab(const DString &s, size_t &refIndent)
Definition util.cpp:5207
DString selectBlocks(const DString &s, const SelectionBlockList &blockList, const SelectionMarkerInfo &markerInfo)
remove disabled blocks and all block markers from s and return the result as a string
Definition util.cpp:5029
bool matchTemplateArguments(const ArgumentList &srcAl, const ArgumentList &dstAl)
Definition util.cpp:1841
void addCodeOnlyMappings()
Definition util.cpp:4171
DString resolveTypeDef(const Definition *d, const DString &name, const Definition **typedefContext=nullptr)
Definition util.cpp:232
DString stripTemplateSpecifiersFromScope(const DString &fullName, bool parentOnly=true, DString *lastScopeStripped=nullptr, DString scopeName=DString(), bool allowArtificial=true)
Definition util.cpp:3695
DString convertNameToFile(const DString &name, bool allowDots=false, bool allowUnderscore=false)
Definition util.cpp:2872
DString escapeCharsInString(const DString &name, bool allowDots, bool allowUnderscore=false)
Definition util.cpp:2697
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
Definition util.cpp:4292
DString extractBeginRawStringDelimiter(const char *rawStart)
Definition util.cpp:5391
DString getProjectId()
Definition util.cpp:5304
DString writeInlineGraph(const DString &baseName, const DString &extension, const DString &content, bool &exists)
Definition util.cpp:5410
bool rightScopeMatch(const DString &scope, const DString &name)
Definition util.cpp:734
bool checkIfTypedef(const Definition *scope, const FileDef *fileScope, const DString &n)
Definition util.cpp:4280
DString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefaults=true)
Definition util.cpp:908
DString unescapeCharsInString(const DString &s)
Definition util.cpp:2784
void cleanupInlineGraphs()
Definition util.cpp:5435
DString correctURL(const DString &url, const DString &relPath)
Corrects URL url according to the relative path relPath.
Definition util.cpp:4672
int computeQualifiedIndex(const DString &name)
Return the index of the last :: in the string name that is still before the first <.
Definition util.cpp:5312
DString convertToId(const DString &s)
Definition util.cpp:3211
bool resolveRef(const DString &scName, const DString &name, bool inSeeBlock, const Definition **resContext, const MemberDef **resMember, SrcLangExt lang, bool lookForSpecializations=true, const FileDef *currentFile=nullptr, bool checkScope=false)
Definition util.cpp:2016
DString insertTemplateSpecifierInScope(const DString &scope, const DString &templ)
Definition util.cpp:3085
DString removeRedundantWhiteSpace(const DString &s)
Definition util.cpp:427
DString convertToXML(const DString &s, bool keepEntities=false, bool citeEntry=false)
Definition util.cpp:3241
bool checkExtension(const DString &fName, const DString &ext)
Definition util.cpp:3935
DString showDate(const DString &fmt)
Definition util.cpp:2576
bool leftScopeMatch(const DString &scope, const DString &name)
Definition util.cpp:745
std::vector< SelectionBlock > SelectionBlockList
Definition util.h:231
DString stripExtensionGeneral(const DString &fName, const DString &ext)
Definition util.cpp:3954
DString stripIndentation(const DString &s, bool skipFirstLine=false)
Definition util.cpp:4696
DString argListToString(const ArgumentList &al, bool useCanonicalType=false, bool showDefVals=true)
Definition util.cpp:864
void addGroupListToTitle(OutputList &ol, const Definition *d)
Definition util.cpp:3930
DString extractEndRawStringDelimiter(const char *rawEnd)
Definition util.cpp:5399
int extractClassNameFromType(const DString &type, int &pos, DString &name, DString &templSpec, SrcLangExt=SrcLangExt::Unknown)
Definition util.cpp:3389
void clearSubDirs(const Dir &d)
Definition util.cpp:3005
DString stripScope(const DString &name)
Definition util.cpp:3118
DString getFileNameExtension(const DString &fn)
Definition util.cpp:4219
void createSubDirs(const Dir &d)
Definition util.cpp:2978
SrcLangExt getLanguageFromFileName(const DString &fileName, SrcLangExt defLang=SrcLangExt::Cpp)
Definition util.cpp:4177
DString normalizeNonTemplateArgumentsInString(const DString &name, const Definition *context, const ArgumentList &formalArgs)
Definition util.cpp:3474
DString getFileFilter(const DString &name, bool isSourceCode)
Definition util.cpp:1025
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const DString &srcReturnType, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const DString &dstReturnType, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang)
Definition util.cpp:1597
void initDefaultExtensionMapping()
Definition util.cpp:4104
void addHtmlExtensionIfMissing(DString &fName)
Definition util.cpp:3940
void checkBlocks(const DString &s, const DString fileName, const SelectionMarkerInfo &markerInfo)
Definition util.cpp:5142
DString linkToText(SrcLangExt lang, const DString &link, bool ignoreDots)
Definition util.cpp:2273
DString substituteKeywords(const DString &file, const DString &s, const KeywordSubstitutionList &keywords)
Definition util.cpp:2503
void addDirPrefix(DString &fileName)
DString relativePathToRoot(const DString &name)
Definition util.cpp:2921
DString convertToJSString(const DString &s, bool keepEntities=false, bool singleQuotes=false)
Definition util.cpp:3360
DString projectLogoFile()
Definition util.cpp:2589
void convertProtectionLevel(MemberListType inListType, Protection inProt, MemberListType *outListType1, MemberListType *outListType2)
Computes for a given list type inListType, which are the the corresponding list type(s) in the base c...
Definition util.cpp:4917
DString removeAnonymousScopes(const DString &s)
Definition util.cpp:98
DString getEncoding(const FileInfo &fi)
Definition util.cpp:4490
bool copyFile(const DString &src, const DString &dest)
Copies the contents of file with name src to the newly created file with name dest.
Definition util.cpp:4632
void writeExamples(OutputList &ol, const ExampleList &el)
Definition util.cpp:809
int getPrefixIndex(const DString &name)
Definition util.cpp:2660
DString createHtmlUrl(const DString &relPath, const DString &ref, bool islocalFile, const DString &targetFileName, const DString &anchor)
Definition util.cpp:4515
void stackTrace()
Definition util.cpp:4319
void stripIndentationVerbatim(DString &doc, size_t indentationLevel, bool skipFirstLine=true)
Definition util.cpp:4785
DString demangleCSharpGenericName(const DString &name, const DString &templArgs)
Definition util.cpp:5380
DString projectLogoSize()
Definition util.cpp:2608
DString mangleCSharpGenericName(const DString &name)
Definition util.cpp:5354
GetDefResult getDefs(const GetDefInput &input)
Definition util.cpp:1874
DString getDotImageExtension()
Definition util.cpp:4977
DString replaceAnonymousScopes(const DString &s, const DString &replacement=DString())
Definition util.cpp:155
int getScopeFragment(const DString &s, int p, int *l)
Definition util.cpp:3807
DString determineAbsoluteIncludeName(const DString &curFile, const DString &incFileName)
Definition util.cpp:2938
DString substituteTemplateArgumentsInString(const DString &name, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
Definition util.cpp:3533
bool readInputFile(const DString &fileName, std::string &contents, const ReadInputFileOptions &options=ReadInputFileOptions())
read a file name fileName and optionally filter and transcode it
Definition util.cpp:4383
DString makeBaseName(const DString &name, const DString &ext)
Definition util.cpp:3983
DString getDotImageExtensionGenerated(const DString &format)
Definition util.cpp:4987
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
Definition util.cpp:758
DString externalRef(const DString &relPath, const DString &ref)
Definition util.cpp:4551
DString fileToString(const DString &name, bool filter=false, bool isSourceCode=false)
Definition util.cpp:1058
DString stripPath(const DString &s)
Definition util.cpp:3969
DString stripFromPath(const DString &path)
Definition util.cpp:219
DString inlineTemplateArgListToDoc(const ArgumentList &al)
Definition util.cpp:837
DString convertToHtml(const DString &s, bool keepEntities=true)
Definition util.cpp:3300
bool openOutputFile(const DString &outFile, std::ofstream &f)
Definition util.cpp:4999
DString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope=false)
Definition util.cpp:4642
DString stripAnonymousNamespaceScope(const DString &s)
Definition util.cpp:167
DString findExampleFilePath(const DString &file, bool &ambig)
Definition util.cpp:2460
SrcLangExt getLanguageFromCodeLang(DString &fileName)
Routine to handle the language attribute of the \code command.
Definition util.cpp:4195