vhdldocgen.cpp 文件参考

#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <string.h>
#include <map>
#include <algorithm>
#include "qcstring.h"
#include "vhdldocgen.h"
#include "message.h"
#include "config.h"
#include "doxygen.h"
#include "util.h"
#include "language.h"
#include "commentscan.h"
#include "index.h"
#include "definition.h"
#include "searchindex.h"
#include "outputlist.h"
#include "parserintf.h"
#include "layout.h"
#include "arguments.h"
#include "portable.h"
#include "memberlist.h"
#include "memberdef.h"
#include "groupdef.h"
#include "classlist.h"
#include "namespacedef.h"
#include "filename.h"
#include "membergroup.h"
#include "membername.h"
#include "plantuml.h"
#include "vhdljjparser.h"
#include "VhdlParser.h"
#include "regex.h"
#include "textstream.h"

vhdldocgen.cpp 的引用(Include)关系图:

浏览源代码.

宏定义
#define	theTranslator_vhdlType   theTranslator->trVhdlType
#define	STARTL
#define	DECLN
#define	STARTFIN   (FlowChart::START_NO | FlowChart::END_NO)
#define	LOOP
#define	ENDCL   (FlowChart::END_CASE | FlowChart::END_LOOP)
#define	EEND   (FlowChart::ENDIF_NO | FlowChart::ELSE_NO )
#define	IFF   (FlowChart::ELSIF_NO | FlowChart::IF_NO)
#define	EXITNEXT   (FlowChart::EXIT_NO | FlowChart::NEXT_NO )
#define	EMPTY   (EEND | FlowChart::ELSIF_NO)
#define	EE   (FlowChart::ELSE_NO | FlowChart::ELSIF_NO)
#define	EMPTNODE   (ENDCL | EEND | FlowChart::ELSIF_NO)
#define	FLOWLEN   (flowList.size()-1)

函数
static void	initUCF (Entry *root, const QCString &type, QCString &qcs, int line, const QCString &fileName, QCString &brief)
static void	writeUCFLink (const MemberDef *mdef, OutputList &ol)
static void	addInstance (ClassDefMutable *entity, ClassDefMutable *arch, ClassDefMutable *inst, const std::shared_ptr< Entry > &cur)
static void	createSVG ()
static void	startDot (TextStream &t)
static void	startTable (TextStream &t, const QCString &className)
static std::vector< const MemberDef * >	getPorts (const ClassDef *cd)
static void	writeVhdlEntityToolTip (TextStream &t, ClassDef *cd)
static void	endDot (TextStream &t)
static void	writeTable (const std::vector< const MemberDef * > &portList, TextStream &t)
static void	endTable (TextStream &t)
static void	writeClassToDot (TextStream &t, ClassDef *cd)
static void	writeVhdlDotLink (TextStream &t, const QCString &a, const QCString &b, const QCString &style)
static void	codify (TextStream &t, const QCString &str)
static void	writeLink (const MemberDef *mdef, OutputList &ol)
static void	startFonts (const QCString &q, const char *keyword, OutputList &ol)
static QCString	splitString (QCString &str, char c)
static int	compareString (const QCString &s1, const QCString &s2)
static QCString	formatBriefNote (const QCString &brief, ClassDef *cd)
static void	writeColumn (TextStream &t, const MemberDef *md, bool start)
static bool	membersHaveSpecificType (const MemberList *ml, uint64 type)
static const MemberDef *	findMemFlow (const MemberDef *mdef)
void	alignText (QCString &q)

变量
static const MemberDef *	flowMember =0
static const std::set< std::string >	g_vhdlKeyWordSet0
static const std::set< std::string >	g_vhdlKeyWordSet1
static const std::set< std::string >	g_vhdlKeyWordSet2
static const std::set< std::string >	g_vhdlKeyWordSet3
static std::map< std::string, const MemberDef * >	g_varMap
static std::vector< ClassDef * >	g_classList
static std::map< ClassDef *, std::vector< ClassDef * > >	g_packages
static int	recordCounter =0
static std::vector< const MemberDef * >	mdList
static int	ifcounter =0
static int	nodeCounter =0
struct {
const char *   textNodeLink
const char *   yesNodeLink
const char *   noNodeLink
const char *   comment
const char *   decisionNode
const char *   varNode
const char *   startEndNode
const char *   textNode
}	flowCol
std::vector< FlowChart >	flowList

宏定义说明

DECLN

#define DECLN

值:

                  (FlowChart::WHEN_NO      | \
                  FlowChart::ELSIF_NO     | FlowChart::IF_NO    | \
                  FlowChart::FOR_NO       | FlowChart::WHILE_NO | \
                  FlowChart::CASE_NO      | FlowChart::LOOP_NO )

在文件 vhdldocgen.cpp 第 2843 行定义.

EE

#define EE   (FlowChart::ELSE_NO | FlowChart::ELSIF_NO)

在文件 vhdldocgen.cpp 第 2855 行定义.

EEND

#define EEND   (FlowChart::ENDIF_NO | FlowChart::ELSE_NO )

在文件 vhdldocgen.cpp 第 2851 行定义.

EMPTNODE

#define EMPTNODE   (ENDCL | EEND | FlowChart::ELSIF_NO)

在文件 vhdldocgen.cpp 第 2856 行定义.

EMPTY

#define EMPTY   (EEND | FlowChart::ELSIF_NO)

在文件 vhdldocgen.cpp 第 2854 行定义.

ENDCL

#define ENDCL   (FlowChart::END_CASE | FlowChart::END_LOOP)

在文件 vhdldocgen.cpp 第 2850 行定义.

EXITNEXT

#define EXITNEXT   (FlowChart::EXIT_NO | FlowChart::NEXT_NO )

在文件 vhdldocgen.cpp 第 2853 行定义.

FLOWLEN

#define FLOWLEN   (flowList.size()-1)

在文件 vhdldocgen.cpp 第 2857 行定义.

IFF

#define IFF   (FlowChart::ELSIF_NO | FlowChart::IF_NO)

在文件 vhdldocgen.cpp 第 2852 行定义.

LOOP

#define LOOP

值:

                  (FlowChart::FOR_NO       | FlowChart::WHILE_NO | \
                  FlowChart::LOOP_NO )

在文件 vhdldocgen.cpp 第 2848 行定义.

STARTFIN

#define STARTFIN   (FlowChart::START_NO | FlowChart::END_NO)

在文件 vhdldocgen.cpp 第 2847 行定义.

STARTL

#define STARTL

值:

                  (FlowChart::WHILE_NO     | FlowChart::IF_NO    | \
                  FlowChart::FOR_NO       | FlowChart::CASE_NO  | \
                  FlowChart::LOOP_NO      | WHEN_NO)

在文件 vhdldocgen.cpp 第 2840 行定义.

theTranslator_vhdlType

#define theTranslator_vhdlType   theTranslator->trVhdlType

在文件 vhdldocgen.cpp 第 66 行定义.

函数说明

addInstance()

static void addInstance ( ClassDefMutable *  entity, ClassDefMutable *  arch, ClassDefMutable *  inst, const std::shared_ptr< Entry > &  cur  )

static

在文件 vhdldocgen.cpp 第 2541 行定义.

{
 
  QCString bName,n1;
  if (ar==0) return;
 
  if (classEntity==0)
  {
    //add component inst
    n1=cur->type;
    goto ferr;
  }
 
  if (classEntity==cd) return;
 
  bName=classEntity->name();
  // fprintf(stderr,"\naddInstance %s to %s %s %s\n",qPrint( classEntity->name()),qPrint(cd->name()),qPrint(ar->name()),cur->name);
  n1=classEntity->name();
 
  if (!cd->isBaseClass(classEntity, true, 0))
  {
    cd->insertBaseClass(classEntity,n1,Public,Normal,QCString());
  }
  else
  {
    VhdlDocGen::addBaseClass(cd,classEntity);
  }
 
  if (!VhdlDocGen::isSubClass(classEntity,cd,true,0))
  {
    classEntity->insertSubClass(cd,Public,Normal,QCString());
    classEntity->setLanguage(SrcLangExt_VHDL);
  }
 
ferr:
  QCString uu=cur->name;
  std::unique_ptr<MemberDefMutable> md { createMemberDef(
      ar->getDefFileName(), cur->startLine,cur->startColumn,
      n1,uu,uu, QCString(),
      Public, Normal, cur->stat,Member,
      MemberType_Variable,
      ArgumentList(),
      ArgumentList(),
      "") };
 
  if (!ar->getOutputFileBase().isEmpty())
  {
    TagInfo tg;
    tg.anchor = 0;
    tg.fileName = ar->getOutputFileBase();
    tg.tagName = 0;
    md->setTagInfo(&tg);
  }
 
  //fprintf(stderr,"\n%s%s%s\n",qPrint(md->name()),qPrint(cur->brief),qPrint(cur->doc));
 
  md->setLanguage(SrcLangExt_VHDL);
  md->setMemberSpecifiers(VhdlDocGen::INSTANTIATION);
  md->setBriefDescription(cur->brief,cur->briefFile,cur->briefLine);
  md->setBodySegment(cur->startLine,cur->startLine,-1) ;
  md->setDocumentation(cur->doc,cur->docFile,cur->docLine);
  FileDef *fd=ar->getFileDef();
  md->setBodyDef(fd);
  ar->insertMember(md.get());
  MemberName *mn = Doxygen::functionNameLinkedMap->add(uu);
  mn->push_back(std::move(md));
 
}

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), VhdlDocGen::addBaseClass(), TagInfo::anchor, createMemberDef(), TagInfo::fileName, Doxygen::functionNameLinkedMap, Definition::getDefFileName(), ClassDef::getFileDef(), ClassDef::getOutputFileBase(), ClassDefMutable::insertBaseClass(), ClassDefMutable::insertMember(), ClassDefMutable::insertSubClass(), VhdlDocGen::INSTANTIATION, ClassDef::isBaseClass(), QCString::isEmpty(), VhdlDocGen::isSubClass(), Member, MemberType_Variable, Definition::name(), Normal, Public, MemberName::push_back(), DefinitionMutable::setBodyDef(), DefinitionMutable::setLanguage(), SrcLangExt_VHDL , 以及 TagInfo::tagName.

被这些函数引用 VhdlDocGen::computeVhdlComponentRelations().

alignText()

void alignText

(

QCString &

q

)

在文件 vhdldocgen.cpp 第 2892 行定义.

{
  if (q.length()<=80) return;
 
  if (q.length()>200)
  {
    q.resize(200);
  }
 
  q.append(" ...");
 
  QCString str(q);
  QCString temp;
 
  while (str.length()>80)
  {
    int j=std::max(str.findRev(' ',80),str.findRev('|',80));
    if (j<=0)
    {
      temp+=str;
      q=temp;
      return;
    }
    else
    {
      QCString qcs=str.left(j);
      temp+=qcs+"\\";
      temp+="n";
      str.remove(0,j);
    }
  }//while
 
 q=temp+str;
// #endif
}

引用了 QCString::append(), QCString::findRev(), QCString::left(), QCString::length(), QCString::remove() , 以及 QCString::resize().

被这些函数引用 FlowChart::writeShape().

codify()

static void codify ( TextStream &  t, const QCString &  str  )

static

在文件 vhdldocgen.cpp 第 100 行定义.

{
  if (!str.isEmpty())
  {
    const char *p=str.data();
    char c;
    while (*p)
    {
      c=*p++;
      switch(c)
      {
        case '<':  t << "&lt;";
                   break;
        case '>':  t << "&gt;";
                   break;
        case '&':  t << "&amp;";
                   break;
        case '\'': t << "&#39;";
                   break;
        case '"':  t << "&quot;";
                   break;
        default:   t << c;
                   break;
      }
    }
  }
}

引用了 QCString::data() , 以及 QCString::isEmpty().

被这些函数引用 writeColumn().

compareString()

static int compareString ( const QCString &  s1, const QCString &  s2  )

static

在文件 vhdldocgen.cpp 第 155 行定义.

{
  return qstricmp(s1.stripWhiteSpace(),s2.stripWhiteSpace());
}

引用了 qstricmp() , 以及 QCString::stripWhiteSpace().

被这些函数引用 VhdlDocGen::findFunction().

createSVG()

static void createSVG ( )

static

在文件 vhdldocgen.cpp 第 160 行定义.

{
    QCString ov =Config_getString(HTML_OUTPUT);
    QCString dir="-o \""+ov+"/vhdl_design_overview.html\"";
    ov+="/vhdl_design.dot";
 
    QCString vlargs="-Tsvg \""+ov+"\" "+dir ;
 
    if (Portable::system(Config_getString(DOT_PATH) + "dot",vlargs)!=0)
    {
      err("could not create dot file");
    }
}

引用了 Config_getString, err() , 以及 Portable::system().

被这些函数引用 VhdlDocGen::writeOverview().

endDot()

static void endDot ( TextStream &  t )

static

在文件 vhdldocgen.cpp 第 251 行定义.

{
  t <<" } \n";
}

被这些函数引用 VhdlDocGen::writeOverview().

endTable()

static void endTable ( TextStream &  t )

static

在文件 vhdldocgen.cpp 第 396 行定义.

{
  t << "</TABLE>>\n";
  t << "] \n";
}

被这些函数引用 VhdlDocGen::writeOverview().

findMemFlow()

static const MemberDef* findMemFlow ( const MemberDef *  mdef )

static

在文件 vhdldocgen.cpp 第 2730 行定义.

{
  for (const auto &md : mdList)
  {
    if (md->name()==mdef->name() &&  md->getStartBodyLine()==mdef->getStartBodyLine())
    {
      return md;
    }
  }
  return 0;
}

引用了 Definition::getStartBodyLine(), mdList , 以及 Definition::name().

被这些函数引用 VhdlDocGen::createFlowChart().

formatBriefNote()

static QCString formatBriefNote ( const QCString &  brief, ClassDef *  cd  )

static

在文件 vhdldocgen.cpp 第 274 行定义.

{
  QCString vForm;
  QCString repl("<BR ALIGN=\"LEFT\"/>");
  QCString file=cd->getDefFileName();
 
  int k=cd->briefLine();
 
  auto qsl=split(brief.str(),"\n");
  for(const auto &line : qsl)
  {
    vForm+=parseCommentAsText(cd,NULL,line.c_str(),file,k);
    k++;
    vForm+=repl;
  }
  return vForm;
}

引用了 Definition::briefLine(), Definition::getDefFileName(), parseCommentAsText(), split() , 以及 QCString::str().

被这些函数引用 writeVhdlEntityToolTip().

getPorts()

static std::vector< const MemberDef * > getPorts ( const ClassDef *  cd )

static

在文件 vhdldocgen.cpp 第 416 行定义.

{
  MemberList *ml = cd->getMemberList(MemberListType_variableMembers);
  std::vector<const MemberDef *> portList;
 
  if (ml==0)
  {
    return portList;
  }
 
  for (const auto &md : *ml)
  {
    if (md->getMemberSpecifiers()==VhdlDocGen::PORT)
    {
      portList.push_back(md);
    }
  }
  return portList;
}

引用了 ClassDef::getMemberList(), MemberListType_variableMembers, VhdlDocGen::PORT , 以及 MemberVector::push_back().

被这些函数引用 VhdlDocGen::writeOverview().

initUCF()

static void initUCF ( Entry *  root, const QCString &  type, QCString &  qcs, int  line, const QCString &  fileName, QCString &  brief  )

static

在文件 vhdldocgen.cpp 第 2323 行定义.

{
  if (qcs.isEmpty())return;
  QCString n;
 
  VhdlDocGen::deleteAllChars(qcs,';');
  qcs=qcs.stripWhiteSpace();
 
  static const reg::Ex reg(R"([\s=])");
  int i = findIndex(qcs.str(),reg);
  if (i<0) return;
  if (i==0)
  {
    n=type;
    VhdlDocGen::deleteAllChars(n,'#');
  }
  else
  {
    n=qcs.left(i);
  }
  qcs=qcs.remove(0,i+1);
  //  qcs.prepend("|");
 
  qcs.stripPrefix("=");
 
  std::shared_ptr<Entry> current = std::make_shared<Entry>();
  current->spec=VhdlDocGen::UCF_CONST;
  current->section=Entry::VARIABLE_SEC;
  current->bodyLine=line;
  current->fileName=fileName;
  current->type="ucf_const";
  current->args+=qcs;
  current->lang=  SrcLangExt_VHDL ;
 
  // adding dummy name for constraints like VOLTAGE=5,TEMPERATURE=20 C
  if (n.isEmpty())
  {
    n="dummy";
    n+=VhdlDocGen::getRecordNumber();
  }
 
  current->name= n+"_";
  current->name.append(VhdlDocGen::getRecordNumber());
 
  if (!brief.isEmpty())
  {
    current->brief=brief;
    current->briefLine=line;
    current->briefFile=fileName;
    brief.resize(0);
  }
 
  root->moveToSubEntryAndKeep(current);
}

引用了 QCString::append(), VhdlDocGen::deleteAllChars(), findIndex(), VhdlDocGen::getRecordNumber(), QCString::isEmpty(), QCString::left(), Entry::moveToSubEntryAndKeep(), QCString::remove(), QCString::resize(), SrcLangExt_VHDL, QCString::str(), QCString::stripPrefix(), QCString::stripWhiteSpace(), VhdlDocGen::UCF_CONST , 以及 Entry::VARIABLE_SEC.

被这些函数引用 VhdlDocGen::parseUCF().

membersHaveSpecificType()

static bool membersHaveSpecificType ( const MemberList *  ml, uint64  type  )

static

在文件 vhdldocgen.cpp 第 2078 行定义.

{
  if (ml==0) return FALSE;
  for (const auto &mdd : *ml)
  {
    if (mdd->getMemberSpecifiers()==type) //is type in class
    {
      return TRUE;
    }
  }
  for (const auto &mg : ml->getMemberGroupList())
  {
    if (!mg->members().empty())
    {
      if (membersHaveSpecificType(&mg->members(),type)) return TRUE;
    }
  }
  return FALSE;
}

引用了 FALSE , 以及 TRUE.

被这些函数引用 VhdlDocGen::writeVHDLDeclarations().

splitString()

static QCString splitString ( QCString &  str, char  c  )

static

在文件 vhdldocgen.cpp 第 143 行定义.

{
  QCString n=str;
  int i=str.find(c);
  if (i>0)
  {
    n=str.left(i);
    str=str.remove(0,i+1);
  }
  return n;
}

引用了 QCString::find(), QCString::left() , 以及 QCString::remove().

被这些函数引用 writeUCFLink().

startDot()

static void startDot ( TextStream &  t )

static

在文件 vhdldocgen.cpp 第 243 行定义.

{
  t << " digraph G { \n";
  t << "rankdir=LR \n";
  t << "concentrate=TRUE\n";
  t << "stylesheet=\"doxygen.css\"\n";
}

被这些函数引用 VhdlDocGen::writeOverview().

startFonts()

static void startFonts ( const QCString &  q, const char *  keyword, OutputList &  ol  )

static

在文件 vhdldocgen.cpp 第 136 行定义.

{
  ol.startFontClass(keyword);
  ol.docify(q);
  ol.endFontClass();
}

引用了 OutputList::docify(), OutputList::endFontClass() , 以及 OutputList::startFontClass().

被这些函数引用 VhdlDocGen::writeFormatString(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeProcedureProto() , 以及 VhdlDocGen::writeStringLink().

startTable()

static void startTable ( TextStream &  t, const QCString &  className  )

static

在文件 vhdldocgen.cpp 第 256 行定义.

{
  t << className <<" [ shape=none , fontname=\"arial\",  fontcolor=\"blue\" , \n";
  t << "label=<<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\">\n";
}

被这些函数引用 VhdlDocGen::writeOverview().

writeClassToDot()

static void writeClassToDot ( TextStream &  t, ClassDef *  cd  )

static

在文件 vhdldocgen.cpp 第 402 行定义.

{
  t << "<TR><TD COLSPAN=\"2\" BGCOLOR=\"yellow\" ";
  t << "PORT=\"";
  t << cd->name();
  t << "\" ";
  t << "href=\"";
  t << addHtmlExtensionIfMissing(cd->getOutputFileBase());
  t << "\" ";
  t << ">";
  t << cd->name();
  t << " </TD></TR>\n";
}

引用了 addHtmlExtensionIfMissing(), ClassDef::getOutputFileBase() , 以及 Definition::name().

被这些函数引用 VhdlDocGen::writeOverview().

writeColumn()

static void writeColumn ( TextStream &  t, const MemberDef *  md, bool  start  )

static

在文件 vhdldocgen.cpp 第 313 行定义.

{
  QCString toolTip;
 
  bool bidir=(md!=0 &&( qstricmp(md->typeString(),"inout")==0));
 
  if (md)
  {
    toolTip=md->briefDescriptionAsTooltip();
    if (!toolTip.isEmpty())
    {
      QCString largs = md->argsString();
      toolTip+=" [";
      toolTip+=substitute(largs,"%"," ");
      toolTip+="]";
    }
  }
  if (start)
  {
    t <<"<TR>\n";
  }
 
  t << "<TD ALIGN=\"LEFT\" ";
  if (md)
  {
    t << "href=\"";
    t << addHtmlExtensionIfMissing(md->getOutputFileBase());
    t << "#" << md->anchor();
    t<<"\" ";
 
    t<<" TOOLTIP=\"";
    if (!toolTip.isEmpty())
    {
      codify(t,toolTip);
    }
    else
    {
      QCString largs = md->argsString();
      if (!largs.isEmpty())
      {
        largs=substitute(largs,"%"," ");
        codify(t,largs);
      }
    }
    t << "\" ";
 
    t << " PORT=\"";
    t << md->name();
    t << "\" ";
  }
  if (!toolTip.isEmpty())
  {
    // if (!toolTip.isEmpty())
 
    if (bidir)
      t << "BGCOLOR=\"orange\">";
    else
      t << "BGCOLOR=\"azure\">";
  }
  else if (bidir)
  {
    t << "BGCOLOR=\"pink\">";
  }
  else
  {
    t << "BGCOLOR=\"lightgrey\">";
  }
  if (md)
  {
    t << md->name();
  }
  else
  {
    t << " \n";
  }
  t << "</TD>\n";
 
  if (!start)
  {
    t << "</TR>\n";
  }
}

引用了 addHtmlExtensionIfMissing(), MemberDef::anchor(), MemberDef::argsString(), Definition::briefDescriptionAsTooltip(), codify(), MemberDef::getOutputFileBase(), QCString::isEmpty(), Definition::name(), qstricmp(), substitute() , 以及 MemberDef::typeString().

被这些函数引用 writeTable().

writeLink()

static void writeLink ( const MemberDef *  mdef, OutputList &  ol  )

static

在文件 vhdldocgen.cpp 第 128 行定义.

{
  ol.writeObjectLink(mdef->getReference(),
      mdef->getOutputFileBase(),
      mdef->anchor(),
      mdef->name());
}

引用了 MemberDef::anchor(), MemberDef::getOutputFileBase(), MemberDef::getReference(), Definition::name() , 以及 OutputList::writeObjectLink().

被这些函数引用 VhdlDocGen::writeRecordUnit(), VhdlDocGen::writeSource(), VhdlDocGen::writeStringLink(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration() , 以及 VhdlDocGen::writeVHDLTypeDocumentation().

writeTable()

static void writeTable ( const std::vector< const MemberDef * > &  portList, TextStream &  t  )

static

在文件 vhdldocgen.cpp 第 438 行定义.

{
  std::vector<const MemberDef *> inPorts;
  std::vector<const MemberDef *> outPorts;
 
  for (const auto &md : portList)
  {
    QCString qc=md->typeString();
    if (qc=="in")
    {
      inPorts.push_back(md);
    }
    else
    {
      outPorts.push_back(md);
    }
  }
 
  size_t inp  = inPorts.size();
  size_t outp = outPorts.size();
  size_t maxLen;
 
  if (inp>=outp)
  {
    maxLen=inp;
  }
  else
  {
    maxLen=outp;
  }
 
  size_t i;
  for (i=0;i<maxLen;i++)
  {
    //write inports
    if (i<inp)
    {
      auto md = inPorts[i];
      writeColumn(t,md,TRUE);
    }
    else
    {
      writeColumn(t,NULL,TRUE);
    }
 
    if (i<outp)
    {
      auto md = outPorts[i];
      writeColumn(t,md,FALSE);
    }
    else
    {
      writeColumn(t,NULL,FALSE);
    }
  }
}

引用了 FALSE, QCString::size(), TRUE , 以及 writeColumn().

被这些函数引用 VhdlDocGen::writeOverview().

writeUCFLink()

static void writeUCFLink ( const MemberDef *  mdef, OutputList &  ol  )

static

在文件 vhdldocgen.cpp 第 2380 行定义.

{
 
  QCString largs(mdef->argsString());
  QCString n= splitString(largs, '#');
  // VhdlDocGen::adjustRecordMember(mdef);
  bool equ=(n.length()==largs.length());
 
  if (!equ)
  {
    ol.writeString(n);
    ol.docify(" ");
    ol.insertMemberAlign();
  }
 
  if (mdef->name().contains("dummy")==0)
  {
    writeLink(mdef,ol);
  }
  if (equ)
  {
    ol.insertMemberAlign();
  }
  ol.docify(" ");
  VhdlDocGen::formatString(largs,ol,mdef);
}

引用了 MemberDef::argsString(), QCString::contains(), OutputList::docify(), VhdlDocGen::formatString(), OutputList::insertMemberAlign(), QCString::length(), Definition::name(), splitString(), writeLink() , 以及 OutputList::writeString().

被这些函数引用 VhdlDocGen::writeVHDLDeclaration().

writeVhdlDotLink()

static void writeVhdlDotLink ( TextStream &  t, const QCString &  a, const QCString &  b, const QCString &  style  )

static

在文件 vhdldocgen.cpp 第 262 行定义.

{
  t << a << "->" << b;
  if (!style.isEmpty())
  {
    t << "[style=" << style << "];\n";
  }
  t << "\n";
}

引用了 QCString::isEmpty().

被这些函数引用 VhdlDocGen::writeOverview() , 以及 writeVhdlEntityToolTip().

writeVhdlEntityToolTip()

static void writeVhdlEntityToolTip ( TextStream &  t, ClassDef *  cd  )

static

在文件 vhdldocgen.cpp 第 292 行定义.

{
 
  QCString brief=cd->briefDescription();
 
  if (brief.isEmpty()) return;
 
  brief=formatBriefNote(brief,cd);
 
  QCString node="node";
  node+=VhdlDocGen::getRecordNumber();
  t << node <<"[shape=none margin=0.1, label=<\n";
  t << "<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"2\" >\n ";
  t << "<TR><TD BGCOLOR=\"lightcyan\"> ";
  t << brief;
  t << " </TD></TR></TABLE>>];";
  QCString dotn=cd->name()+":";
  dotn+=cd->name();
  writeVhdlDotLink(t,dotn,node,"dotted");
}

引用了 Definition::briefDescription(), formatBriefNote(), VhdlDocGen::getRecordNumber(), QCString::isEmpty(), Definition::name() , 以及 writeVhdlDotLink().

被这些函数引用 VhdlDocGen::writeOverview().

变量说明

comment

const char* comment

在文件 vhdldocgen.cpp 第 2870 行定义.

被这些函数引用 VhdlDocGen::parseUCF().

decisionNode

const char* decisionNode

在文件 vhdldocgen.cpp 第 2871 行定义.

flowCol

struct { ... } flowCol

初始值:

=
{ "green",       
  "red",         
  "black",       
  "khaki",       
  "0.7 0.3 1.0", 
  "lightyellow", 
  "white",       
  "lightcyan"    
}

被这些函数引用 FlowChart::buildCommentNodes(), FlowChart::writeEdge() , 以及 FlowChart::writeShape().

flowList

std::vector<FlowChart> flowList

在文件 vhdldocgen.cpp 第 2886 行定义.

被这些函数引用 FlowChart::addFlowChart(), FlowChart::buildCommentNodes(), FlowChart::colTextNodes(), FlowChart::delFlowList(), FlowChart::findLabel(), FlowChart::findNextLoop(), FlowChart::findNode(), FlowChart::findPrevLoop(), FlowChart::getNextIfLink(), FlowChart::getNextNode(), FlowChart::printFlowTree(), FlowChart::printUmlTree(), FlowChart::writeFlowChart() , 以及 FlowChart::writeFlowLinks().

flowMember

const MemberDef* flowMember =0

static

在文件 vhdldocgen.cpp 第 85 行定义.

被这些函数引用 VhdlDocGen::getFlowMember() , 以及 VhdlDocGen::setFlowMember().

g_classList

std::vector<ClassDef*> g_classList

static

在文件 vhdldocgen.cpp 第 595 行定义.

被这些函数引用 VhdlDocGen::findMemberDef() , 以及 VhdlDocGen::resetCodeVhdlParserState().

g_packages

std::map<ClassDef*,std::vector<ClassDef*> > g_packages

static

在文件 vhdldocgen.cpp 第 596 行定义.

被这些函数引用 VhdlDocGen::findAllPackages(), VhdlDocGen::findMember() , 以及 VhdlDocGen::resetCodeVhdlParserState().

g_varMap

std::map<std::string,const MemberDef*> g_varMap

static

在文件 vhdldocgen.cpp 第 594 行定义.

被这些函数引用 VhdlDocGen::findMemberDef() , 以及 VhdlDocGen::resetCodeVhdlParserState().

g_vhdlKeyWordSet0

const std::set< std::string > g_vhdlKeyWordSet0

static

初始值:

=
{
  "abs","access","after","alias","all","and","architecture","array","assert","assume","assume_guarantee","attribute",
  "begin","block","body","buffer","bus",
  "case","component","configuration","constant","context","cover",
  "default","disconnect","downto",
  "else","elsif","end","entity","exit",
  "fairness","file","for","force","function",
  "generate","generic","group","guarded",
  "if","impure","in","inertial","inout","is",
  "label","library","linkage","literal","loop",
  "map","mod",
  "nand","new","next","nor","not","null",
  "of","on","open","or","others","out",
  "package","parameter","port","postponed","procedure","process","property","protected","pure",
  "range","record","register","reject","release","restrict","restrict_guarantee","rem","report","rol","ror","return",
  "select","sequence","severity","signal","shared","sla","sll","sra","srl","strong","subtype",
  "then","to","transport","type",
  "unaffected","units","until","use",
  "variable","vmode","vprop","vunit",
  "wait","when","while","with",
  "xor","xnor"
}

在文件 vhdldocgen.cpp 第 507 行定义.

被这些函数引用 VhdlDocGen::findKeyWord().

g_vhdlKeyWordSet1

const std::set< std::string> g_vhdlKeyWordSet1

static

初始值:

=
{
  "natural","unsigned","signed","string","boolean", "bit","bit_vector","character",
  "std_ulogic","std_ulogic_vector","std_logic","std_logic_vector","integer",
  "real","float","ufixed","sfixed","time","positive"
}

在文件 vhdldocgen.cpp 第 533 行定义.

被这些函数引用 VhdlDocGen::findKeyWord().

g_vhdlKeyWordSet2

const std::set< std::string > g_vhdlKeyWordSet2

static

初始值:

=
{
  "abs","and","or","not","mod","xor","rem","xnor","ror","rol","sla","sll"
}

在文件 vhdldocgen.cpp 第 541 行定义.

被这些函数引用 VhdlDocGen::findKeyWord().

g_vhdlKeyWordSet3

const std::set< std::string > g_vhdlKeyWordSet3

static

初始值:

=
{
  "base","left","right","high","low","ascending",
  "image","value","pos","val","succ","pred","leftof","rightof","left","right","high","low",
  "range","reverse_range","length","ascending","delayed","stable","quiet","transaction","event",
  "active","last_event","last_active","last_value","driving","driving_value","simple_name","instance_name","path_name"
}

在文件 vhdldocgen.cpp 第 547 行定义.

被这些函数引用 VhdlDocGen::findKeyWord().

ifcounter

int ifcounter =0

static

在文件 vhdldocgen.cpp 第 2859 行定义.

被这些函数引用 FlowChart::delFlowList(), FlowChart::FlowChart() , 以及 FlowChart::moveToPrevLevel().

mdList

std::vector<const MemberDef*> mdList

static

在文件 vhdldocgen.cpp 第 2728 行定义.

被这些函数引用 VhdlDocGen::createFlowChart() , 以及 findMemFlow().

nodeCounter

int nodeCounter =0

static

在文件 vhdldocgen.cpp 第 2860 行定义.

被这些函数引用 FlowChart::delFlowList() , 以及 FlowChart::FlowChart().

noNodeLink

const char* noNodeLink

在文件 vhdldocgen.cpp 第 2867 行定义.

recordCounter

int recordCounter =0

static

在文件 vhdldocgen.cpp 第 1097 行定义.

被这些函数引用 VhdlDocGen::getRecordNumber().

startEndNode

const char* startEndNode

在文件 vhdldocgen.cpp 第 2873 行定义.

textNode

const char* textNode

在文件 vhdldocgen.cpp 第 2874 行定义.

textNodeLink

const char* textNodeLink

在文件 vhdldocgen.cpp 第 2865 行定义.

varNode

const char* varNode

在文件 vhdldocgen.cpp 第 2872 行定义.

yesNodeLink

const char* yesNodeLink

在文件 vhdldocgen.cpp 第 2866 行定义.