summaryrefslogtreecommitdiffstats
path: root/src/util.h
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2005-12-27 20:36:39 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2005-12-27 20:36:39 (GMT)
commitd4da97f32ddc6c44df781b3b7b762be0101b9bac (patch)
tree0e4517c465cd2c2702cd62de3f3f29bc068bc1da /src/util.h
parentcbb944eb7796b2501628c65de1c014d7cca48dcd (diff)
downloadDoxygen-d4da97f32ddc6c44df781b3b7b762be0101b9bac.zip
Doxygen-d4da97f32ddc6c44df781b3b7b762be0101b9bac.tar.gz
Doxygen-d4da97f32ddc6c44df781b3b7b762be0101b9bac.tar.bz2
Release-1.4.5-20051227
Diffstat (limited to 'src/util.h')
-rw-r--r--src/util.h107
1 files changed, 89 insertions, 18 deletions
diff --git a/src/util.h b/src/util.h
index 00d52ee..52b2316 100644
--- a/src/util.h
+++ b/src/util.h
@@ -28,6 +28,8 @@
#include <ctype.h>
#include "sortdict.h"
+//--------------------------------------------------------------------
+
class ClassDef;
class FileDef;
class MemberList;
@@ -81,6 +83,19 @@ class TextGeneratorOLImpl : public TextGeneratorIntf
//--------------------------------------------------------------------
+enum SrcLangExt
+{
+ SrcLangExt_IDL = 0x008,
+ SrcLangExt_Java = 0x010,
+ SrcLangExt_CSharp = 0x020,
+ SrcLangExt_D = 0x040,
+ SrcLangExt_PHP = 0x080,
+ SrcLangExt_ObjC = 0x100,
+ SrcLangExt_Cpp = 0x200,
+};
+
+//--------------------------------------------------------------------
+
void linkifyText(const TextGeneratorIntf &ol,
Definition *scope,
FileDef *fileScope,
@@ -90,9 +105,13 @@ void linkifyText(const TextGeneratorIntf &ol,
bool external=TRUE,
bool keepSpaces=FALSE
);
+
void setAnchors(ClassDef *cd,char id,MemberList *ml,int groupId=-1);
+
QCString fileToString(const char *name,bool filter=FALSE);
+
QCString dateToString(bool);
+
bool getDefs(const QCString &scopeName,
const QCString &memberName,
const char *,
@@ -124,28 +143,30 @@ bool resolveLink(/* in */ const char *scName,
bool generateRef(OutputDocInterface &od,const char *,
const char *,bool inSeeBlock,const char * =0);
+
bool generateLink(OutputDocInterface &od,const char *,
const char *,bool inSeeBlock,const char *);
void generateFileRef(OutputDocInterface &od,const char *,
const char *linkTxt=0);
+
void writePageRef(OutputDocInterface &od,const char *cn,const char *mn);
-#if 0
-bool matchArguments(ArgumentList *,ArgumentList *,
- const char *cl=0,const char *ns=0,bool checkCV=TRUE,
- NamespaceSDict *usingNamespaces=0,
- SDict<Definition> *usingClasses=0);
-#endif
bool matchArguments2(Definition *srcScope,FileDef *srcFileScope,ArgumentList *srcAl,
Definition *dstScope,FileDef *dstFileScope,ArgumentList *dstAl,
bool checkCV
);
+
void mergeArguments(ArgumentList *,ArgumentList *,bool forceNameOverwrite=FALSE);
+
QCString substituteClassNames(const QCString &s);
+
QCString substitute(const char *s,const char *src,const char *dst);
+
QCString resolveDefines(const char *n);
+
ClassDef *getClass(const char *key);
+
ClassDef *getResolvedClass(Definition *scope,
FileDef *fileScope,
const char *key,
@@ -153,61 +174,102 @@ ClassDef *getResolvedClass(Definition *scope,
QCString *pTemplSpec=0,
bool mayBeUnlinkable=FALSE,
bool mayBeHidden=FALSE);
+
NamespaceDef *getResolvedNamespace(const char *key);
+
FileDef *findFileDef(const FileNameDict *fnDict,const char *n,
bool &ambig);
+
QCString showFileDefMatches(const FileNameDict *fnDict,const char *n);
+
int guessSection(const char *name);
+
bool isId(char c);
+
QCString removeRedundantWhiteSpace(const QCString &s);
+
QCString argListToString(ArgumentList *al,bool useCanonicalType=FALSE);
+
QCString tempArgListToString(ArgumentList *al);
+
QCString generateMarker(int id);
+
void writeExample(OutputList &ol,ExampleSDict *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 char *title,const QCString &relPath="");
+
int getPrefixIndex(const QCString &name);
+
QCString removeAnonymousScopes(const QCString &s);
+
QCString replaceAnonymousScopes(const QCString &s);
+
void initClassHierarchy(ClassSDict *cl);
+
bool hasVisibleRoot(BaseClassList *bcl);
+
int minClassDistance(ClassDef *cd,ClassDef *bcd,int level=0);
+
QCString convertNameToFile(const char *name,bool allowDots=FALSE);
+
void extractNamespaceName(const QCString &scopeName,
QCString &className,QCString &namespaceName,
bool allowEmptyClass=FALSE);
+
QCString insertTemplateSpecifierInScope(const QCString &scope,const QCString &templ);
+
QCString stripScope(const char *name);
+
int iSystem(const char *command,const char *args,bool isBatchFile=FALSE);
+
QCString convertToHtml(const char *s);
+
QCString convertToXML(const char *s);
+
QCString getOverloadDocs();
+
void addMembersToMemberGroup(MemberList *ml,
MemberGroupSDict *memberGroupSDict,
Definition *context);
+
int extractClassNameFromType(const QCString &type,int &pos,
QCString &name,QCString &templSpec);
+
QCString substituteTemplateArgumentsInString(
const QCString &name,
ArgumentList *formalArgs,
ArgumentList *actualArgs);
ArgumentList *copyArgumentList(const ArgumentList *src);
+
QList<ArgumentList> *copyArgumentLists(const QList<ArgumentList> *srcLists);
+
QCString stripTemplateSpecifiersFromScope(const QCString &fullName,
bool parentOnly=TRUE,
QCString *lastScopeStripped=0);
+
QCString resolveTypeDef(Definition *d,const QCString &name,
Definition **typedefContext=0);
+
QCString mergeScopes(const QCString &leftScope,const QCString &rightScope);
+
int getScopeFragment(const QCString &s,int p,int *l);
+
int filterCRLF(char *buf,int len);
+
void addRefItem(const QList<ListItemInfo> *sli,const char *prefix,
const char *name,const char *title,const char *args=0);
+
PageDef *addRelatedPage(const char *name,const QCString &ptitle,
const QCString &doc,QList<SectionInfo> *anchors,
const char *fileName,int startLine,
@@ -215,44 +277,53 @@ PageDef *addRelatedPage(const char *name,const QCString &ptitle,
GroupDef *gd=0,
TagInfo *tagInfo=0
);
+
QCString escapeCharsInString(const char *name,bool allowDots);
+
void addGroupListToTitle(OutputList &ol,Definition *d);
+
void filterLatexString(QTextStream &t,const char *str,
bool insideTabbing=FALSE,bool insidePre=FALSE,
bool insideItem=FALSE);
+
QCString rtfFormatBmkStr(const char *name);
+
QCString linkToText(const char *link,bool isFileName);
+
QCString stripExtension(const char *fName);
+
void replaceNamespaceAliases(QCString &scope,int i);
+
int isAccessibleFrom(Definition *scope,FileDef *fileScope,Definition *item);
+
int isAccessibleFromWithExpScope(Definition *scope,FileDef *fileScope,Definition *item,
const QCString &explicitScopePart);
+
int computeQualifiedIndex(const QCString &name);
+
void addDirPrefix(QCString &fileName);
+
QCString relativePathToRoot(const char *name);
-#define REL_PATH_TO_ROOT "../../"
+
void createSubDirs(QDir &d);
+
QCString stripPath(const char *s);
+
bool containsWord(const QCString &s,const QCString &word);
+
bool findAndRemoveWord(QCString &s,const QCString &word);
+
QCString stripLeadingAndTrailingEmptyLines(const QCString &s);
+
void stringToSearchIndex(const QCString &docUrlBase,const QCString &title,
const QCString &str, bool priority=FALSE,
const QCString &anchor="");
-enum SrcLangExt
-{
- SrcLangExt_IDL = 0x008,
- SrcLangExt_Java = 0x010,
- SrcLangExt_CSharp = 0x020,
- SrcLangExt_D = 0x040,
- SrcLangExt_PHP = 0x080,
- SrcLangExt_ObjC = 0x100,
- SrcLangExt_Cpp = 0x200,
-};
-
SrcLangExt getLanguageFromFileName(const QCString fileName);
+bool checkIfTypedef(Definition *scope,FileDef *fileScope,const char *n);
+
+
#endif