1 /******************************************************************************
3 * Copyright (C) 1997-2013 by Dimitri van Heesch.
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.
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
20 * This class implements functions for parsing and generating
27 #include "arguments.h"
42 /** Class for generating documentation specific for VHDL */
47 enum VhdlClasses // Overlays: Protection
49 ENTITYCLASS, // Overlays: Public
50 PACKBODYCLASS, // Overlays: Protected
51 ARCHITECTURECLASS, // Overlays: Private
52 PACKAGECLASS // Overlays: Package
87 virtual ~VhdlDocGen();
89 static QCString convertFileNameToClassName(QCString name);
90 // --- used by vhdlscanner.l -----------
92 static bool isSubClass(ClassDef* cd,ClassDef *scd, bool followInstances,int level);
94 static QCString getIndexWord(const char* ,int index);
95 static bool deleteCharRev(QCString &s,char c);
96 static void deleteAllChars(QCString &s,char c);
97 static void parseFuncProto(const char* text,
102 // -----------------------------------
104 static void computeVhdlComponentRelations();
106 static QCString* findKeyWord(const QCString& word);
108 static ClassDef* getPackageName(const QCString& name);
109 static MemberDef* findMember(const QCString& className,
110 const QCString& memName);
111 static void findAllPackages(ClassDef*);
112 static MemberDef* findMemberDef(ClassDef* cd,
114 MemberListType type);
115 static ClassDef *getClass(const char *name);
116 static MemberDef* findFunction(const QList<Argument> &ql,
117 const QCString& name,
118 const QCString& package, bool type);
119 static QCString getClassTitle(const ClassDef*);
120 static void writeInlineClassLink(const ClassDef*,
123 static bool isConstraint(const MemberDef *mdef);
124 static bool isConfig(const MemberDef *mdef);
125 static bool isAlias(const MemberDef *mdef);
126 static bool isLibrary(const MemberDef *mdef);
127 static bool isGeneric(const MemberDef *mdef);
128 static bool isPort(const MemberDef *mdef);
129 static bool isComponent(const MemberDef *mdef);
130 static bool isPackage(const MemberDef *mdef);
131 static bool isEntity(const MemberDef *mdef);
132 static bool isConstant(const MemberDef *mdef);
133 static bool isVType(const MemberDef *mdef);
134 static bool isSubType(const MemberDef *mdef);
135 static bool isVhdlFunction(const MemberDef *mdef);
136 static bool isProcess(const MemberDef *mdef);
137 static bool isSignal(const MemberDef *mdef);
138 static bool isAttribute(const MemberDef *mdef);
139 static bool isSignals(const MemberDef *mdef);
140 static bool isProcedure(const MemberDef *mdef);
141 static bool isRecord(const MemberDef *mdef);
142 static bool isArchitecture(const MemberDef *mdef);
143 static bool isUnit(const MemberDef *mdef);
144 static bool isPackageBody(const MemberDef *mdef);
145 static bool isVariable(const MemberDef *mdef);
146 static bool isFile(const MemberDef *mdef);
147 static bool isGroup(const MemberDef *mdef);
148 static bool isCompInst(const MemberDef *mdef);
149 static bool isMisc(const MemberDef *mdef);
151 //-----------------------------------------------------
152 // translatable items
154 static QCString trTypeString(uint64 type);
155 static QCString trVhdlType(uint64 type,bool sing=true);
158 static QCString trDesignUnitHierarchy();
161 static QCString trDesignUnitList();
163 // trCompoundMembers.
164 static QCString trDesignUnitMembers();
166 // trCompoundListDescription
167 static QCString trDesignUnitListDescription();
170 static QCString trDesignUnits();
173 static QCString trDesignUnitIndex();
176 static QCString trFunctionAndProc();
178 //-----------------------------------------------------
180 static void prepareComment(QCString&);
181 static void formatString(const QCString&,OutputList& ol,const MemberDef*);
183 static void writeFormatString(const QCString&,OutputList& ol,const MemberDef*);
184 static void writeFunctionProto(OutputList& ol,const ArgumentList *al,const MemberDef*);
185 static void writeProcessProto(OutputList& ol,const ArgumentList *al,const MemberDef*);
186 static void writeProcedureProto(OutputList& ol, const ArgumentList *al,const MemberDef*);
187 static bool writeFuncProcDocu(const MemberDef *mdef, OutputList& ol,const ArgumentList* al,bool type=false);
188 static void writeRecordProto(const MemberDef *mdef, OutputList& ol,const ArgumentList *al);
190 static bool writeVHDLTypeDocumentation(const MemberDef* mdef, const Definition* d, OutputList &ol);
192 static void writeVhdlDeclarations(MemberList*,OutputList&,GroupDef*,ClassDef*,FileDef*,NamespaceDef*);
194 static void writeVHDLDeclaration(MemberDef* mdef,OutputList &ol,
195 ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd,
198 static void writePlainVHDLDeclarations(MemberList* ml,OutputList &ol,
199 ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd,int specifier);
201 static void writeVHDLDeclarations(MemberList* ml,OutputList &ol,
202 ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd,
203 const char *title,const char *subtitle,bool showEnumValues,int type);
205 static bool writeClassType(ClassDef *&,OutputList &ol ,QCString & cname);
207 static QCString convertArgumentListToString(const ArgumentList* al,bool f);
208 static QCString getProcessNumber();
209 static QCString getRecordNumber();
211 static QCString getClassName(const ClassDef*);
212 static bool isNumber(const QCString& s);
213 static QCString getProtectionName(int prot);
215 static void parseUCF(const char* input,Entry* entity,QCString f,bool vendor);
216 static bool findConstraintFile( LayoutNavEntry *lne);
218 static ClassDef* findArchitecture(const ClassDef *cd);
219 static ClassDef* findArchitecture(QCString identifier, QCString entity_name);
222 static void writeSource(MemberDef *mdef,OutputList& ol,QCString & cname);
223 static void writeAlphbeticalClass(OutputList& ol,const ClassDef* cd,const QCString &);
225 static QCString parseForConfig(QCString & entity,QCString & arch);
226 static QCString parseForBinding(QCString & entity,QCString & arch);
227 static void addBaseClass(ClassDef* cd,ClassDef *ent);
228 static ClassDef* findVhdlClass(const char *className );
230 static void writeOverview(OutputList &ol);
231 static void writeOverview();
234 static void createFlowChart(const MemberDef*);
235 //static void addFlowImage(const FTextStream &,const QCString &);
237 static void setFlowMember( const MemberDef *flowMember);
238 static const MemberDef *getFlowMember();
240 static bool isVhdlClass (const Entry *cu)
242 return cu->spec==VhdlDocGen::ENTITY ||
243 cu->spec==VhdlDocGen::PACKAGE ||
244 cu->spec==VhdlDocGen::ARCHITECTURE ||
245 cu->spec==VhdlDocGen::PACKAGE_BODY;
248 static void resetCodeVhdlParserState();
251 static void findAllArchitectures(QList<QCString>& ql,const ClassDef *cd);
252 static bool compareArgList(ArgumentList*,ArgumentList*);
253 static void writeVhdlLink(const ClassDef* cdd ,OutputList& ol,QCString& type,QCString& name,QCString& beh);
254 static void writeStringLink(const MemberDef *mdef,QCString mem,OutputList& ol);
255 static void writeRecUnitDocu( const MemberDef *md, OutputList& ol,QCString largs);
256 static void writeRecorUnit(QCString & largs,OutputList& ol ,const MemberDef *mdef);
259 //-------------------------------------------------------------------------------------------------------------------
260 //-------------- VHDL Flowcharts -------------------------------------------------------------------------------
261 //-------------------------------------------------------------------------------------------------------------------
293 //---------- create svg -------------------------------------------------------------
294 static void createSVG();
295 static void startDot(FTextStream &t);
296 static void endDot(FTextStream &t);
297 static void codify(FTextStream &t,const char *str);
298 static void writeShape(FTextStream &t,const FlowChart* fl);
299 static void writeEdge(FTextStream &t,int fl_from,int fl_to,int i,bool bFrom=FALSE,bool bTo=FALSE);
300 static void writeEdge(FTextStream &t,const FlowChart* fl_from,const FlowChart* fl_to,int i);
301 static void writeFlowLinks(FTextStream &t);
303 static QCString getNodeName(int n);
304 static void colTextNodes();
306 static int getNextTextLink(const FlowChart* fl,uint index);
307 static int getNextIfLink(const FlowChart*,uint);
308 static int getNextNode(int,int);
309 static int findNode(int index,int stamp,int type);
310 static int findNode(int index,int type);
311 static int findNextLoop(int j,int stamp);
312 static int findPrevLoop(int j,int stamp,bool endif=FALSE);
313 static int findLabel(int j,QCString &);
314 static void delFlowList();
315 static const char* getNodeType(int c);
317 static void addFlowChart(int type,const char* text,const char* exp,const char * label=NULL);
318 static void moveToPrevLevel();
319 static int getTimeStamp();
320 static void writeFlowChart();
321 static void alignFuncProc(QCString & q,const ArgumentList* al,bool isFunc);
322 static QCString convertNameToFileName();
323 static void printNode(const FlowChart* n);
324 static void printFlowTree();
325 static void buildCommentNodes(FTextStream &t);
326 static void alignCommentNode(FTextStream &t,QCString com);
328 static QList<FlowChart> flowList;
330 FlowChart(int typ,const char* t,const char* ex,const char* label=0);