diff options
Diffstat (limited to 'src/vhdldocgen.h')
| -rw-r--r-- | src/vhdldocgen.h | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/src/vhdldocgen.h b/src/vhdldocgen.h index a557c27..22751c5 100644 --- a/src/vhdldocgen.h +++ b/src/vhdldocgen.h @@ -3,8 +3,8 @@ * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * @@ -16,8 +16,8 @@ #ifndef VHDLDOCGEN_H #define VHDLDOCGEN_H -/** - * This class implements functions for parsing and generating +/** + * This class implements functions for parsing and generating * vhdl documents */ @@ -31,6 +31,7 @@ class Entry; class ClassDef; class MemberList; class MemberDef; +class MemberDefMutable; class FTextStream; class OutputList; class Definition; @@ -42,15 +43,15 @@ struct Argument; struct VhdlConfNode -{ - VhdlConfNode(const char* a,const char* b,const char* config,const char* cs,bool leaf) - { +{ + VhdlConfNode(const char* a,const char* b,const char* config,const char* cs,bool leaf) + { arch=a; // architecture e.g. for iobuffer arch=arch.lower(); binding=b; // binding e.g. use entity work.xxx(bev) binding=binding.lower(); confVhdl=config; // configuration foo is bar - compSpec=cs; + compSpec=cs; isInlineConf=false; // primary configuration? isLeaf=leaf; }; @@ -67,7 +68,7 @@ struct VhdlConfNode /** Class for generating documentation specific for VHDL */ -class VhdlDocGen +class VhdlDocGen { public: @@ -98,11 +99,11 @@ class VhdlDocGen USE, PROCESS, PORT, - UNITS, + UNITS, GENERIC, INSTANTIATION, GROUP, - VFILE, + VFILE, SHAREDVARIABLE, CONFIG, ALIAS, @@ -115,7 +116,7 @@ class VhdlDocGen static void init(); static QCString convertFileNameToClassName(QCString name); // --- used by vhdlscanner.l ----------- - + static bool isSubClass(ClassDef* cd,ClassDef *scd, bool followInstances,int level); static QCString getIndexWord(const char* ,int index); @@ -129,10 +130,10 @@ class VhdlDocGen static void computeVhdlComponentRelations(); - static QCString* findKeyWord(const QCString& word); + static const char* findKeyWord(const QCString& word); static ClassDef* getPackageName(const QCString& name); - static MemberDef* findMember(const QCString& className, + static MemberDef* findMember(const QCString& className, const QCString& memName); static void findAllPackages(ClassDef*); static MemberDef* findMemberDef(ClassDef* cd, @@ -144,7 +145,7 @@ class VhdlDocGen static QCString getClassTitle(const ClassDef*); static void writeInlineClassLink(const ClassDef*, OutputList &ol); - static void writeTagFile(MemberDef *mdef,FTextStream &tagFile); + static void writeTagFile(MemberDefMutable *mdef,FTextStream &tagFile); static bool isConstraint(const MemberDef *mdef); static bool isConfig(const MemberDef *mdef); @@ -190,7 +191,7 @@ class VhdlDocGen static void writeVhdlDeclarations(const MemberList*,OutputList&,const GroupDef*,const ClassDef*,const FileDef*,const NamespaceDef*); - static void writeVHDLDeclaration(const MemberDef* mdef,OutputList &ol, + static void writeVHDLDeclaration(const MemberDefMutable* mdef,OutputList &ol, const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd, bool inGroup); @@ -207,20 +208,19 @@ class VhdlDocGen static QCString convertArgumentListToString(const ArgumentList &al,bool f); static QCString getProcessNumber(); static QCString getRecordNumber(); - + static QCString getClassName(const ClassDef*); static bool isNumber(const QCString& s); static QCString getProtectionName(int prot); static void parseUCF(const char* input,Entry* entity,QCString f,bool vendor); - static bool findConstraintFile( LayoutNavEntry *lne); - static ClassDef* findArchitecture(const ClassDef *cd); - static ClassDef* findArchitecture(QCString identifier, QCString entity_name); + static const ClassDef* findArchitecture(const ClassDef *cd); + //static const ClassDef* findArchitecture(QCString identifier, QCString entity_name); - static void correctMemberProperties(MemberDef *md); - - static void writeSource(const MemberDef *mdef,OutputList& ol,const QCString & cname); + static void correctMemberProperties(MemberDefMutable *md); + + static void writeSource(const MemberDefMutable *mdef,OutputList& ol,const QCString & cname); static QCString parseForConfig(QCString & entity,QCString & arch); static QCString parseForBinding(QCString & entity,QCString & arch); @@ -229,15 +229,15 @@ class VhdlDocGen static void writeOverview(OutputList &ol); static void writeOverview(); - + // flowcharts static void createFlowChart(const MemberDef*); //static void addFlowImage(const FTextStream &,const QCString &); - + static void setFlowMember( const MemberDef *flowMember); static const MemberDef *getFlowMember(); - static bool isVhdlClass (const Entry *cu) + static bool isVhdlClass (const Entry *cu) { return cu->spec==VhdlDocGen::ENTITY || cu->spec==VhdlDocGen::PACKAGE || @@ -253,7 +253,7 @@ class VhdlDocGen static void writeVhdlLink(const ClassDef* cdd ,OutputList& ol,QCString& type,QCString& name,QCString& beh); static void writeStringLink(const MemberDef *mdef,QCString mem,OutputList& ol); static void writeRecUnitDocu( const MemberDef *md, OutputList& ol,QCString largs); - static void writeRecorUnit(QCString & largs,OutputList& ol ,const MemberDef *mdef); + static void writeRecordUnit(QCString & largs,QCString & ltype,OutputList& ol,const MemberDefMutable *mdef); }; //------------------------------------------------------------------------------------------------------------------- @@ -290,7 +290,7 @@ class FlowChart BEGIN_NO = 1<<21 }; - //---------- create svg ------------------------------------------------------------- + //---------- create svg ------------------------------------------------------------- static void createSVG(); static void startDot(FTextStream &t); static void endDot(FTextStream &t); |