#include <vhdldocgen.h>

FlowChart 的协作图:

Public 类型
enum	nodeTypes { IF_NO = 1<<1, ELSIF_NO = 1<<2, ELSE_NO = 1<<3, CASE_NO = 1<<4, WHEN_NO = 1<<5, EXIT_NO = 1<<6, END_NO = 1<<7, TEXT_NO = 1<<8, START_NO = 1<<9, ENDIF_NO = 1<<10, FOR_NO = 1<<11, WHILE_NO = 1<<12, END_LOOP = 1<<13, END_CASE = 1<<14, VARIABLE_NO = 1<<15, RETURN_NO = 1<<16, LOOP_NO = 1<<17, NEXT_NO = 1<<18, EMPTY_NO = 1<<19, COMMENT_NO = 1<<20, BEGIN_NO = 1<<21 }

Public 成员函数
	FlowChart (int typ, const QCString &t, const QCString &ex, const QCString &label=QCString())

	~FlowChart ()

静态 Public 成员函数
static void	createSVG ()

static void	startDot (TextStream &t)

static void	endDot (TextStream &t)

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

static void	writeShape (TextStream &t, const FlowChart &fl)

static void	writeEdge (TextStream &t, int fl_from, int fl_to, int i, bool bFrom=FALSE, bool bTo=FALSE)

static void	writeEdge (TextStream &t, const FlowChart &fl_from, const FlowChart &fl_to, int i)

static void	writeFlowLinks (TextStream &t)

static QCString	getNodeName (int n)

static void	colTextNodes ()

static size_t	getNextIfLink (const FlowChart &, size_t)

static size_t	getNextNode (size_t index, int stamp)

static size_t	findNode (size_t index, int stamp, int type)

static size_t	findNode (size_t index, int type)

static size_t	findNextLoop (size_t j, int stamp)

static size_t	findPrevLoop (size_t j, int stamp, bool endif=FALSE)

static size_t	findLabel (size_t j, const QCString &)

static void	delFlowList ()

static const char *	getNodeType (int c)

static void	addFlowChart (int type, const QCString &text, const QCString &exp, const QCString &label=QCString())

static void	moveToPrevLevel ()

static int	getTimeStamp ()

static void	writeFlowChart ()

static void	alignFuncProc (QCString &q, const ArgumentList &al, bool isFunc)

static QCString	convertNameToFileName ()

static void	printNode (const FlowChart &n)

static void	printFlowTree ()

static void	buildCommentNodes (TextStream &t)

static void	alignCommentNode (TextStream &t, QCString com)

static void	printUmlTree ()

static QCString	printPlantUmlNode (const FlowChart &flo, bool, bool)

Private 属性
int	id = 0

int	stamp = 0

int	type = 0

int	line = 0

QCString	label

QCString	text

QCString	exp

详细描述

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

成员枚举类型说明

◆ nodeTypes

enum FlowChart::nodeTypes

枚举值
IF_NO
ELSIF_NO
ELSE_NO
CASE_NO
WHEN_NO
EXIT_NO
END_NO
TEXT_NO
START_NO
ENDIF_NO
FOR_NO
WHILE_NO
END_LOOP
END_CASE
VARIABLE_NO
RETURN_NO
LOOP_NO
NEXT_NO
EMPTY_NO
COMMENT_NO
BEGIN_NO

在文件 vhdldocgen.h 第 265 行定义.

                    {
       IF_NO        = 1<<1,
       ELSIF_NO     = 1<<2,
       ELSE_NO      = 1<<3,
       CASE_NO      = 1<<4,
       WHEN_NO      = 1<<5,
       EXIT_NO      = 1<<6,
       END_NO       = 1<<7,
       TEXT_NO      = 1<<8,
       START_NO     = 1<<9,
       ENDIF_NO     = 1<<10,
       FOR_NO       = 1<<11,
       WHILE_NO     = 1<<12,
       END_LOOP     = 1<<13,
       END_CASE     = 1<<14,
       VARIABLE_NO  = 1<<15,
       RETURN_NO    = 1<<16,
       LOOP_NO      = 1<<17,
       NEXT_NO      = 1<<18,
       EMPTY_NO     = 1<<19,
       COMMENT_NO   = 1<<20,
       BEGIN_NO     = 1<<21
     };

构造及析构函数说明

◆ FlowChart()

FlowChart::FlowChart	(	int	typ,
		const QCString &	t,
		const QCString &	ex,
		const QCString &	label = `QCString()`
	)

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

 {
   stamp=ifcounter;
  
   if (typ & STARTL)
   {
     ifcounter++;
   }
  
   text=t;
   exp=ex;
   type=typ;
   label=lab;
  
   if (typ & (ELSE_NO | ELSIF_NO))
   {
     stamp--;
   }
  
   if (typ & (START_NO | END_NO | VARIABLE_NO))
   {
     stamp=0;
   }
  
   id=nodeCounter++;
 }

引用了 ELSE_NO, ELSIF_NO, END_NO, exp, ifcounter, label, nodeCounter, stamp, START_NO, STARTL, text, type , 以及 VARIABLE_NO.

◆ ~FlowChart()

FlowChart::~FlowChart ( )

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

3205 {

3206 }

成员函数说明

◆ addFlowChart()

void FlowChart::addFlowChart	(	int	type,
		const QCString &	text,
		const QCString &	exp,
		const QCString &	label = `QCString()`
	)

static

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

 {
   if (!VhdlDocGen::getFlowMember()) return;
  
   QCString typeString(text);
   QCString expression(exp);
  
  
   if (!text.isEmpty())
   {
     typeString=substitute(typeString,";","\n");
   }
  
   if (!exp.isEmpty())
   {
     expression=substitute(expression,"\"","\\\"");
   }
  
   if (type & (START_NO | VARIABLE_NO))
   {
     flowList.insert(flowList.begin(),FlowChart(type,typeString,expression,label));
     flowList.front().line=1; // TODO: use getLine(); of the parser
   }
   else
   {
     flowList.emplace_back(type,typeString,expression,label);
     flowList.back().line=1;  // TODO: use getLine(); of the parser
   }
 }

引用了 exp, flowList, VhdlDocGen::getFlowMember(), QCString::isEmpty(), label, START_NO, substitute(), text, type , 以及 VARIABLE_NO.

被这些函数引用 VHDLOutlineParser::createFlow() , 以及 VHDLOutlineParser::handleFlowComment().

◆ alignCommentNode()

void FlowChart::alignCommentNode	(	TextStream &	t,
		QCString	com
	)

static

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

 {
   uint max=0;
   QCString s;
   StringVector ql=split(com.str(),"\n");
   for (size_t j=0;j<ql.size();j++)
   {
     s=ql[j];
     if (max<s.length()) max=s.length();
   }
  
   s=ql.back();
   int diff=max-s.length();
  
   QCString n(1);
   if (diff>0)
   {
     n.fill(' ',2*diff);
     n.append(".");
     s+=n;
     ql.pop_back();
     ql.push_back(s.str());
   }
  
   for (size_t j=0;j<ql.size();j++)
   {
     s=ql[j];
     if (j<ql.size()-1)
     {
       s+="\n";
     }
     FlowChart::codify(t,s);
   }
 }

引用了 QCString::append(), codify(), QCString::fill(), QCString::length(), split() , 以及 QCString::str().

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

◆ alignFuncProc()

void FlowChart::alignFuncProc	(	QCString &	q,
		const ArgumentList &	al,
		bool	isFunc
	)

static

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

 {
   size_t index=al.size();
   if (index==0) return;
  
   int len=q.length()+VhdlDocGen::getFlowMember()->name().length();
   QCString prev,temp;
   prev.fill(' ',len+1);
  
   q+="\n";
   for (const Argument &arg : al)
   {
     QCString attl=arg.defval+" ";
     attl+=arg.name+" ";
  
     if (!isFunc)
     {
       attl+=arg.attrib+" ";
     }
     else
     {
       attl+=" in ";
     }
     attl+=arg.type;
     if (--index) attl+=",\n"; else attl+="\n";
  
     attl.prepend(prev);
     temp+=attl;
   }
  
   q+=temp;
 }

引用了 QCString::fill(), VhdlDocGen::getFlowMember(), QCString::length(), Definition::name(), QCString::prepend() , 以及 ArgumentList::size().

被这些函数引用 VHDLOutlineParser::createFlow().

◆ buildCommentNodes()

void FlowChart::buildCommentNodes ( TextStream & t )

static

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

 {
   size_t size=flowList.size();
   bool begin=false;
  
   if (size>0)
   {
     for (uint j=0;j < size-1 ;j++)
     {
       FlowChart &fll = flowList[j];
       if (fll.type & COMMENT_NO)
       {
         FlowChart &to=flowList[j+1];
         if (to.type & COMMENT_NO)
         {
           to.label = fll.label+"\n"+to.label;
           flowList.erase(flowList.begin()+j);
           if (size>0) size--;
           if (j>0) j--;
         }
       }
     }// for
   }
  
   for (size_t j=0;j <flowList.size() ;j++)
   {
     const FlowChart &fll=flowList[j];
  
     if (fll.type & BEGIN_NO)
     {
       begin = true;
       continue;
     }
  
     if (fll.type & COMMENT_NO)
     {
       const FlowChart *to;
       if (!begin)
       {
         //  comment between function/process .. begin is linked to start node
         to = &flowList[0];
       }
       else if (j>0 && flowList[j-1].line==fll.line)
       {
         to = &flowList[j-1];
       }
       else
       {
         to = &flowList[j+1];
       }
       t << getNodeName(fll.id);
       t << "[shape=none, label=<\n";
       t << "<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"2\" >\n ";
       t << "<TR><TD BGCOLOR=\"";
       t << flowCol.comment;
       t << "\" > ";
  
       FlowChart::alignCommentNode(t,fll.label);
       t << " </TD></TR></TABLE>>];";
       writeEdge(t,fll.id,to->id,2);
     }
   }// for
  
   // delete comment nodes;
   size=flowList.size();
   for (size_t j=0; j<size; j++)
   {
     FlowChart &fll=flowList[j];
     if (fll.type & (COMMENT_NO | BEGIN_NO))
     {
       size_t diff=FLOWLEN-(j+1);
  
       if ((fll.type & COMMENT_NO) && diff > 1)
       {
         flowList[j+1].label = fll.label;
       }
  
       flowList.erase(flowList.begin()+j);
  
       if (size>0) size--;
       if (j>0) j--;
     }
   }// for;
 }

引用了 alignCommentNode(), begin(), BEGIN_NO, COMMENT_NO, flowCol, FLOWLEN, flowList, getNodeName(), id, label, line, type , 以及 writeEdge().

被这些函数引用 writeFlowChart().

◆ codify()

void FlowChart::codify	(	TextStream &	t,
		const QCString &	str
	)

static

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

 {
   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;
         case '\n': t <<"<BR ALIGN=\"LEFT\"/>"; break;
         default:   t << c; break;
       }
     }
   }
 }//codify

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

被这些函数引用 alignCommentNode().

◆ colTextNodes()

void FlowChart::colTextNodes ( )

static

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

 {
   FlowChart *flno = nullptr;
   bool found=FALSE;
   for (size_t j=0;j<flowList.size();j++)
   {
     FlowChart &flo = flowList[j];
     if (flo.type&TEXT_NO)
     {
       if (!found)
       {
         flno=&flo;
       }
       else
       {
         flno->text+=flo.text;
         flowList.erase(flowList.begin()+j);
         if (j>0) j=j-1;
       }
       found=TRUE;
     }
     else
     {
       found=FALSE;
     }
   }
  
   // find if..endif without text
   //       if..elseif without text
   if (!flowList.empty())
   {
     for (size_t j=0;j<flowList.size()-1;j++)
     {
       const FlowChart &flo = flowList[j];
       int kind = flo.type;
       if ( (kind & IFF) || (flo.type & ELSE_NO))
       {
         const FlowChart &ftemp = flowList[j+1];
         if (ftemp.type & EMPTY)
         {
           FlowChart fc(TEXT_NO,"empty ",QCString());
           fc.stamp = flo.stamp;
           flowList.insert(flowList.begin()+j+1,fc);
         }
       }
     }
   }
  
 }// colTextNode

引用了 ELSE_NO, EMPTY, FALSE, flowList, IFF, stamp, text, TEXT_NO, TRUE , 以及 type.

被这些函数引用 writeFlowChart().

◆ convertNameToFileName()

QCString FlowChart::convertNameToFileName ( )

static

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

 {
   return VhdlDocGen::getFlowMember()->name();
 }

引用了 VhdlDocGen::getFlowMember() , 以及 Definition::name().

被这些函数引用 createSVG(), printUmlTree() , 以及 HtmlDocVisitor::visitPre().

◆ createSVG()

void FlowChart::createSVG ( )

static

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

 {
   QCString qcs("/");
   QCString ov = Config_getString(HTML_OUTPUT);
  
   qcs+=FlowChart::convertNameToFileName()+".svg";
  
   //const  MemberDef *m=VhdlDocGen::getFlowMember();
   //if (m)
   //  fprintf(stderr,"\n creating flowchart  : %s  %s in file %s \n",theTranslator->trVhdlType(m->getMemberSpecifiers(),TRUE),qPrint(m->name()),qPrint(m->getFileDef()->name()));
  
   QCString dir=" -o \""+ov+qcs+"\"";
   ov+="/flow_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, convertNameToFileName(), err() , 以及 Portable::system().

被这些函数引用 writeFlowChart().

◆ delFlowList()

void FlowChart::delFlowList ( )

static

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

 {
   ifcounter=0;
   nodeCounter=0;
   flowList.clear();
 }

引用了 flowList, ifcounter , 以及 nodeCounter.

被这些函数引用 writeFlowChart().

◆ endDot()

void FlowChart::endDot ( TextStream & t )

static

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

 {
   t << " } \n";
 }

被这些函数引用 writeFlowChart().

◆ findLabel()

size_t FlowChart::findLabel	(	size_t	j,
		const QCString &	label
	)

static

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

 {
   for (size_t j=index;j>0;j--)
   {
     const FlowChart &flo = flowList[j];
     if ((flo.type & LOOP) && !flo.label.isEmpty() && qstricmp(flo.label,label)==0)
     {
       return j;
     }
   }
   err("could not find label: %s",qPrint(label));
   return 0;
 }

引用了 err(), flowList, QCString::isEmpty(), label, LOOP, qPrint(), qstricmp() , 以及 type.

被这些函数引用 writeFlowLinks().

◆ findNextLoop()

size_t FlowChart::findNextLoop	(	size_t	j,
		int	stamp
	)

static

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

 {
   for (size_t j=index+1; j<flowList.size(); j++)
   {
     const FlowChart &flo = flowList[j];
     if (flo.stamp==stamp)
     {
       continue;
     }
     if (flo.type&END_LOOP)
     {
       return j;
     }
   }
   return flowList.size()-1;
 }

引用了 END_LOOP, flowList, stamp , 以及 type.

被这些函数引用 writeFlowLinks().

◆ findNode() [1/2]

size_t FlowChart::findNode	(	size_t	index,
		int	stamp,
		int	type
	)

static

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

 {
   for (size_t j=index+1; j<flowList.size(); j++)
   {
     const FlowChart &flo = flowList[j];
     if (flo.type==type && flo.stamp==stamp)
     {
       return j;
     }
   }
   return 0;
 }// findNode

引用了 flowList, stamp , 以及 type.

被这些函数引用 getNextIfLink(), getNextNode() , 以及 writeFlowLinks().

◆ findNode() [2/2]

static size_t FlowChart::findNode	(	size_t	index,
		int	type
	)

static

◆ findPrevLoop()

size_t FlowChart::findPrevLoop	(	size_t	j,
		int	stamp,
		bool	endif = `FALSE`
	)

static

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

 {
   for (size_t j=index;j>0;j--)
   {
     const FlowChart &flo = flowList[j];
     if (flo.type & LOOP)
     {
       if (flo.stamp==stamp && endif)
       {
         return j;
       }
       else
       {
         if (flo.stamp<stamp)
         {
           return j;
         }
       }
     }
   }
   return flowList.size()-1;
 }

引用了 flowList, LOOP, stamp , 以及 type.

被这些函数引用 writeFlowLinks().

◆ getNextIfLink()

size_t FlowChart::getNextIfLink	(	const FlowChart &	fl,
		size_t	index
	)

static

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

 {
   int stamp=fl.stamp;
   size_t start = index+1;
   size_t endifNode  = findNode(start,stamp,ENDIF_NO);
   size_t elseifNode = findNode(start,stamp,ELSIF_NO);
   size_t elseNode   = findNode(start,stamp,ELSE_NO);
  
   if (elseifNode>0 && elseifNode<endifNode)
   {
     return elseifNode;
   }
  
   if (elseNode>0 && elseNode<endifNode)
   {
     return elseNode+1;
   }
  
   stamp=flowList[endifNode].stamp;
   return getNextNode(endifNode,stamp);
 }

引用了 ELSE_NO, ELSIF_NO, ENDIF_NO, findNode(), flowList, getNextNode() , 以及 stamp.

被这些函数引用 writeFlowLinks().

◆ getNextNode()

size_t FlowChart::getNextNode	(	size_t	index,
		int	stamp
	)

static

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

 {
   for (size_t j=index+1; j<flowList.size(); j++)
   {
     const FlowChart &flo = flowList[j];
     int kind = flo.type;
     int s    = flo.stamp;
     if (s>stamp)
     {
       continue;
     }
     if (kind & ENDIF_NO)
     {
       if (s<stamp && stamp>0)
       {
         stamp--;
         continue;
       }
     }
     if (kind & (ELSE_NO | ELSIF_NO))
     {
       if (s<stamp && stamp>0)
       {
         stamp--;
       }
       j=findNode(j,stamp,ENDIF_NO);
       continue;
     }
     if (kind & WHEN_NO)
     {
       if (s<stamp && stamp>0)
       {
         stamp--;
       }
       return findNode(j,stamp-1,END_CASE);
     }
     return j;
   }
   return FLOWLEN;
 }

引用了 ELSE_NO, ELSIF_NO, END_CASE, ENDIF_NO, findNode(), FLOWLEN, flowList, stamp, type , 以及 WHEN_NO.

被这些函数引用 getNextIfLink() , 以及 writeFlowLinks().

◆ getNodeName()

QCString FlowChart::getNodeName ( int n )

static

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

 {
   QCString node;
   node.setNum(n);
   return node.prepend("node");
 }

引用了 QCString::prepend() , 以及 QCString::setNum().

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

◆ getNodeType()

const char * FlowChart::getNodeType ( int c )

static

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

 {
   switch(c)
   {
     case IF_NO:        return "if ";
     case ELSIF_NO:     return "elsif ";
     case ELSE_NO:      return "else ";
     case CASE_NO:      return "case ";
     case WHEN_NO:      return "when ";
     case EXIT_NO:      return "exit ";
     case END_NO:       return "end ";
     case TEXT_NO:      return "text ";
     case START_NO:     return "start  ";
     case ENDIF_NO:     return "endif  ";
     case FOR_NO:       return "for ";
     case WHILE_NO:     return "while  ";
     case END_LOOP:     return "end_loop  ";
     case END_CASE:     return "end_case  ";
     case VARIABLE_NO:  return "variable_decl  ";
     case RETURN_NO:    return "return  ";
     case LOOP_NO:      return "infinite loop  ";
     case NEXT_NO:      return "next  ";
     case COMMENT_NO:   return "comment  ";
     case EMPTY_NO:     return "empty  ";
     case BEGIN_NO:     return "<begin>  ";
     default: return "--failure--";
   }
 }

引用了 BEGIN_NO, CASE_NO, COMMENT_NO, ELSE_NO, ELSIF_NO, EMPTY_NO, END_CASE, END_LOOP, END_NO, ENDIF_NO, EXIT_NO, FOR_NO, IF_NO, LOOP_NO, NEXT_NO, RETURN_NO, START_NO, TEXT_NO, VARIABLE_NO, WHEN_NO , 以及 WHILE_NO.

被这些函数引用 printNode().

◆ getTimeStamp()

static int FlowChart::getTimeStamp ( )

static

◆ moveToPrevLevel()

void FlowChart::moveToPrevLevel ( )

static

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

 {
   if (!VhdlDocGen::getFlowMember()) return;
   ifcounter--;
 }

引用了 VhdlDocGen::getFlowMember() , 以及 ifcounter.

◆ printFlowTree()

void FlowChart::printFlowTree ( )

static

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

 {
   for (const auto &flowChart : flowList)
   {
     printNode(flowChart);
   }
 }

引用了 flowList , 以及 printNode().

被这些函数引用 writeFlowChart().

◆ printNode()

void FlowChart::printNode ( const FlowChart & n )

static

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

 {
   QCString ui="-";
   std::string q;
   std::string t;
  
   ui.fill('-',255);
  
   if (flo.type & STARTL)
   {
     if (flo.stamp>0)
     {
       q=ui.left(2*flo.stamp).str();
     }
     else
     {
       q=" ";
     }
     QCString nn=flo.exp.stripWhiteSpace();
     printf("\nYES: %s%s[%d,%d]",qPrint(q),qPrint(nn),flo.stamp,flo.id);
   }
   else
   {
     if (flo.type & COMMENT_NO)
     {
       t=flo.label.str();
     }
     else
     {
       t=flo.text.str();
     }
     static const reg::Ex ep(R"(\s)");
     t = reg::replace(t,ep,std::string());
     if (t.empty())
     {
       t=" ";
     }
     if (flo.stamp>0)
     {
       q=ui.left(2*flo.stamp).str();
     }
     else
     {
       q=" ";
     }
     if (flo.type & EMPTNODE)
     {
       printf("\n NO: %s%s[%d,%d]",q.c_str(),FlowChart::getNodeType(flo.type),flo.stamp,flo.id);
     }
     else if (flo.type & COMMENT_NO)
     {
       printf("\n NO: %s%s[%d,%d]",t.c_str(),FlowChart::getNodeType(flo.type),flo.stamp,flo.id);
     }
     else
     {
       printf("\n NO: %s[%d,%d]",t.c_str(),flo.stamp,flo.id);
     }
   }
 }

引用了 COMMENT_NO, EMPTNODE, exp, QCString::fill(), getNodeType(), id, label, QCString::left(), qPrint(), reg::replace(), stamp, STARTL, QCString::str(), QCString::stripWhiteSpace(), text , 以及 type.

被这些函数引用 printFlowTree().

◆ printPlantUmlNode()

QCString FlowChart::printPlantUmlNode	(	const FlowChart &	flo,
		bool	ca,
		bool	endL
	)

static

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

 {
   QCString t;
   QCString exp=flo.exp.stripWhiteSpace();
   QCString text=flo.text.stripWhiteSpace();
   switch (flo.type)
   {
     case START_NO:   t=":"+text+"|"; break;
     case IF_NO :     t="\nif ("+exp+") then (yes)"; break;
     case ELSIF_NO:   t="\nelseif ("+exp+") then (yes)"; break;
     case ELSE_NO:    t="\nelse"; break;
     case CASE_NO:    t="\n:"+exp+";"; break;
     case WHEN_NO:    t="\n";
                      if (!ca) t+="else";
                      t+="if ("+exp+") then (yes)";
                      break;
     case EXIT_NO:    break;
     case END_NO:     if (text.contains(" function")==0) t="\n:"+text+";";
                      break;
     case TEXT_NO:    t="\n:"+text+"]"; break;
     case ENDIF_NO:   t="\nendif"; break;
     case FOR_NO:     t="\nwhile ("+exp+") is (yes)"; break;
     case WHILE_NO:   t="\nwhile ("+exp+") is (yes)"; break;
     case END_LOOP:   t="\nendwhile"; break;
     case END_CASE:   t="\nendif\n:end case;"; break;
     case VARIABLE_NO:t="\n:"+text+";"; break;
     case RETURN_NO:  t="\n:"+text+";";
                      if (!endL) t+="\nstop";
                      break;
     case LOOP_NO:    t="\nwhile (infinite loop)"; break;
     case NEXT_NO:    break;
     case EMPTY_NO:   break;
     case COMMENT_NO: t="\n note left \n "+flo.label+"\nend note \n"; break;
     case BEGIN_NO:   t="\n:begin;"; break;
     default:         assert(false); break;
   }
   return t;
 }

引用了 BEGIN_NO, CASE_NO, COMMENT_NO, QCString::contains(), ELSE_NO, ELSIF_NO, EMPTY_NO, END_CASE, END_LOOP, END_NO, ENDIF_NO, EXIT_NO, exp, FOR_NO, IF_NO, label, LOOP_NO, NEXT_NO, RETURN_NO, START_NO, QCString::stripWhiteSpace(), text, TEXT_NO, type, VARIABLE_NO, WHEN_NO , 以及 WHILE_NO.

被这些函数引用 printUmlTree().

◆ printUmlTree()

void FlowChart::printUmlTree ( )

static

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

 {
   int caseCounter = 0;
   int whenCounter = 0;
  
   QCString qcs;
   size_t size=flowList.size();
   for (size_t j=0;j<size;j++)
   {
     bool endList = j==FLOWLEN;
     const FlowChart &flo = flowList[j];
     if (flo.type==CASE_NO)
     {
       caseCounter++;
       whenCounter=0;
     }
  
     if (flo.type==END_CASE)
     {
       caseCounter--;
     }
  
     bool ca = (caseCounter>0 && whenCounter==0);
  
     qcs+=printPlantUmlNode(flo,ca,endList);
  
     if (flo.type==WHEN_NO)
     {
       whenCounter++;
     }
  
   }
   qcs+="\n";
  
   QCString htmlOutDir = Config_getString(HTML_OUTPUT);
  
   QCString n=convertNameToFileName();
   n=PlantumlManager::instance().writePlantUMLSource(htmlOutDir,n,qcs,PlantumlManager::PUML_SVG,"uml",n,1);
   PlantumlManager::instance().generatePlantUMLOutput(n,htmlOutDir,PlantumlManager::PUML_SVG);
 }

引用了 CASE_NO, Config_getString, convertNameToFileName(), END_CASE, FLOWLEN, flowList, PlantumlManager::generatePlantUMLOutput(), PlantumlManager::instance(), printPlantUmlNode(), PlantumlManager::PUML_SVG, type, WHEN_NO , 以及 PlantumlManager::writePlantUMLSource().

被这些函数引用 writeFlowChart().

◆ startDot()

void FlowChart::startDot ( TextStream & t )

static

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

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

被这些函数引用 writeFlowChart().

◆ writeEdge() [1/2]

void FlowChart::writeEdge	(	TextStream &	t,
		const FlowChart &	fl_from,
		const FlowChart &	fl_to,
		int	i
	)

static

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

 {
   bool b=fl_from.type & STARTL;
   bool c=fl_to.type & STARTL;
  
 #ifdef DEBUGFLOW
   QCString s1(getNodeName(fl_from.id));
   QCString s2(getNodeName(fl_to.id));
   auto it = g_keyMap.find(s1.str());
   auto it1 = g_keyMap.find(s2.str());
   // checks if the link is connected to a valid node
   assert(it!=g_keyMap.end());
   assert(it1!=g_keyMap.end());
 #endif
  
   writeEdge(t,fl_from.id,fl_to.id,i,b,c);
 }

引用了 getNodeName(), id, STARTL, QCString::str(), type , 以及 writeEdge().

◆ writeEdge() [2/2]

void FlowChart::writeEdge	(	TextStream &	t,
		int	fl_from,
		int	fl_to,
		int	i,
		bool	bFrom = `FALSE`,
		bool	bTo = `FALSE`
	)

static

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

 {
   QCString label,col;
  
   if (i==0)
   {
     col=flowCol.yesNodeLink;
     label="yes";
   }
   else if (i==1)
   {
     col=flowCol.noNodeLink;
     label="no";
   }
   else
   {
     col=flowCol.textNodeLink;
     label="";
   }
  
   t << "edge [color=\""+col+"\",label=\""+label+"\"]\n";
   t << getNodeName(fl_from);
   if (bFrom) t << ":s";
   t << "->";
   t << getNodeName(fl_to);
   if (bTo) t << ":n";
   t << "\n";
 }

引用了 flowCol, getNodeName() , 以及 label.

被这些函数引用 buildCommentNodes(), writeEdge() , 以及 writeFlowLinks().

◆ writeFlowChart()

void FlowChart::writeFlowChart ( )

static

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

 {
   //  assert(VhdlDocGen::flowMember);
  
   QCString ov = Config_getString(HTML_OUTPUT);
   QCString fileName = ov+"/flow_design.dot";
   std::ofstream f(fileName.str(),std::ofstream::out | std::ofstream::binary);
   if (!f.is_open())
   {
     err("Cannot open file %s for writing\n",qPrint(fileName));
     return;
   }
   TextStream t(&f);
  
   colTextNodes();
   //  buildCommentNodes(t);
  
 #ifdef DEBUGFLOW
    printFlowTree();
 #endif
  
   if (!Config_getString(PLANTUML_JAR_PATH).isEmpty())
   {
     printUmlTree();
     delFlowList();
     t.flush();
     f.close();
     return;
   }
  
   startDot(t);
   buildCommentNodes(t);
   for (const auto &fll : flowList)
   {
     writeShape(t,fll);
   }
   writeFlowLinks(t);
  
   FlowChart::endDot(t);
   delFlowList();
   t.flush();
   f.close();
   FlowChart::createSVG();
 }// writeFlowChart

引用了 buildCommentNodes(), colTextNodes(), Config_getString, createSVG(), delFlowList(), endDot(), err(), flowList, TextStream::flush(), printFlowTree(), printUmlTree(), qPrint(), startDot(), QCString::str(), writeFlowLinks() , 以及 writeShape().

被这些函数引用 VHDLOutlineParser::createFlow().

◆ writeFlowLinks()

void FlowChart::writeFlowLinks ( TextStream & t )

static

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

 {
   size_t size=flowList.size();
   if (size<2) return;
  
   // write start link
   writeEdge(t,flowList[0],flowList[1],2);
  
   for (size_t j=0;j<size;j++)
   {
     const FlowChart &fll = flowList[j];
     int kind  = fll.type;
     int stamp = fll.stamp;
     if (kind & EEND)
     {
       continue;
     }
  
     if (kind & IFF)
     {
       writeEdge(t,fll,flowList[j+1],0);
       size_t z=getNextIfLink(fll,j);
       // assert(z>-1);
       writeEdge(t,fll,flowList[z],1);
     }
     else if (kind & LOOP_NO)
     {
       writeEdge(t,fll,flowList[j+1],2);
       continue;
     }
     else if (kind & (CASE_NO | FOR_NO | WHILE_NO))
     {
       if (kind & CASE_NO)
       {
         writeEdge(t,fll,flowList[j+1],2);
         continue;
       }
       else
       {
         writeEdge(t,fll,flowList[j+1],0);
       }
  
       kind=END_LOOP;
       size_t z=findNode(j+1,fll.stamp,kind);
       z=getNextNode(z,flowList[z].stamp);
  
       // assert(z>-1);
       writeEdge(t,fll,flowList[z],1);
       continue;
     }
     else if (kind & (TEXT_NO | VARIABLE_NO))
     {
       size_t z=getNextNode(j,stamp);
       writeEdge(t,fll,flowList[z],2);
     }
     else if (kind & WHEN_NO)
     {
       // default value
       if (qstricmp(fll.text.simplifyWhiteSpace(),"others")==0)
       {
         writeEdge(t,fll,flowList[j+1],2);
         continue;
       }
  
  
       writeEdge(t,fll,flowList[j+1],0);
       size_t u=findNode(j,stamp,WHEN_NO);
       size_t v=findNode(j,stamp-1,END_CASE);
  
       if (u>0 && u<v)
       {
         writeEdge(t,fll,flowList[u],1);
       }
       else
       {
         writeEdge(t,fll,flowList[v],1);
       }
     }
     else if (kind & END_CASE)
     {
       size_t z=FlowChart::getNextNode(j,fll.stamp);
       writeEdge(t,fll,flowList[z],2);
     }
     else if (kind & END_LOOP)
     {
       size_t z=findPrevLoop(j,fll.stamp,true);
       writeEdge(t,fll,flowList[z],2);
     }
     else if (kind & RETURN_NO)
     {
       writeEdge(t,fll,flowList[size-1],2);
     }
     else if (kind & (EXIT_NO | NEXT_NO))
     {
       size_t z;
       bool b = kind==NEXT_NO;
       if (!fll.exp.isEmpty())
       {
         writeEdge(t,fll,flowList[j+1],1);
       }
       if (!fll.label.isEmpty())
       {
         z=findLabel(j,fll.label);
         if (b)
         {
           writeEdge(t,fll,flowList[z],0);
         }
         else
         {
           z=findNode(z,flowList[z].stamp,END_LOOP);
           z=getNextNode(z,flowList[z].stamp);
           writeEdge(t,fll,flowList[z],0);
         }
         continue;
       }
       else
       {
         if (b)
         {
           z=findPrevLoop(j,fll.stamp);
           writeEdge(t,fll,flowList[z],0);
           continue;
         }
         else
         {
           z =findNextLoop(j,fll.stamp-1);
         }
         z=getNextNode(z,flowList[z].stamp);
       }
       writeEdge(t,fll,flowList[z],0);
     }
   } //for
 } //writeFlowLinks

引用了 CASE_NO, EEND, END_CASE, END_LOOP, EXIT_NO, exp, findLabel(), findNextLoop(), findNode(), findPrevLoop(), flowList, FOR_NO, getNextIfLink(), getNextNode(), IFF, QCString::isEmpty(), label, LOOP_NO, NEXT_NO, qstricmp(), RETURN_NO, QCString::simplifyWhiteSpace(), stamp, text, TEXT_NO, type, VARIABLE_NO, WHEN_NO, WHILE_NO , 以及 writeEdge().

被这些函数引用 writeFlowChart().

◆ writeShape()

void FlowChart::writeShape	(	TextStream &	t,
		const FlowChart &	fl
	)

static

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

 {
   if (fl.type & EEND) return;
   QCString var;
   if (fl.type & LOOP)
   {
     var=" loop";
   }
   else if (fl.type & IFF)
   {
     var=" then";
   }
   else
   {
     var="";
   }
  
   t << getNodeName(fl.id);
  
 #ifdef DEBUGFLOW
   QCString qq(getNodeName(fl.id));
   g_keyMap.insert({qq.str(),fl.id});
 #endif
  
   bool dec=(fl.type & DECLN);
   bool exit=(fl.type & EXITNEXT);
   if (exit && !fl.exp.isEmpty())
   {
     dec=TRUE;
   }
   if (dec)
   {
     QCString exp=fl.exp;
     alignText(exp);
  
     t << " [shape=diamond,style=filled,color=\"";
     t << flowCol.decisionNode;
     t << "\",label=\" ";
     QCString kl;
     if (exit) kl=fl.text+"  ";
  
     if (!fl.label.isEmpty())
     {
       kl+=fl.label+":"+exp+var;
     }
     else
     {
       kl+=exp+var;
     }
  
     FlowChart::alignCommentNode(t,kl);
     t << "\"]\n";
   }
   else if (fl.type & ENDCL)
   {
     QCString val=fl.text;
     t << " [shape=ellipse ,label=\""+val+"\"]\n";
   }
   else if (fl.type & STARTFIN)
   {
     QCString val=fl.text;
     t << "[shape=box , style=rounded label=<\n";
     t << "<TABLE BORDER=\"0\" CELLBORDER=\"0\" CELLSPACING=\"0\" CELLPADDING=\"0\" >\n ";
     t << "<TR><TD BGCOLOR=\"";
     t<< flowCol.startEndNode;
     t<< "\"> ";
     FlowChart::alignCommentNode(t,val);
     t << " </TD></TR></TABLE>>];";
   }
   else
   {
     if (fl.text.isEmpty()) return;
     bool isVar=(fl.type & FlowChart::VARIABLE_NO);
     QCString q=fl.text;
  
     if (exit)
     {
       q+=" "+fl.label;
     }
  
     int z=q.findRev("\n");
  
     if (z==(int)q.length()-1)
     {
       q=q.remove(z,2);
     }
     t << "[shape=none margin=0.1, label=<\n";
     t << "<TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"2\" >\n ";
     if (isVar)
     {
       t << "<TR><TD BGCOLOR=\"" << flowCol.varNode << "\" > ";
     }
     else
     {
       t << "<TR><TD BGCOLOR=\"" << flowCol.textNode << "\" > ";
     }
     FlowChart::alignCommentNode(t,q);
     t << " </TD></TR></TABLE>>];";
   }
 }

引用了 alignCommentNode(), alignText(), DECLN, EEND, ENDCL, EXITNEXT, exp, QCString::findRev(), flowCol, getNodeName(), id, IFF, QCString::isEmpty(), label, QCString::length(), LOOP, QCString::remove(), STARTFIN, QCString::str(), text, TRUE, type , 以及 VARIABLE_NO.

被这些函数引用 writeFlowChart().

类成员变量说明

◆ exp

QCString FlowChart::exp

private

在文件 vhdldocgen.h 第 338 行定义.

被这些函数引用 addFlowChart(), FlowChart(), printNode(), printPlantUmlNode(), writeFlowLinks() , 以及 writeShape().

◆ id

int FlowChart::id = 0

private

在文件 vhdldocgen.h 第 330 行定义.

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

◆ label

QCString FlowChart::label

private

在文件 vhdldocgen.h 第 336 行定义.

被这些函数引用 addFlowChart(), buildCommentNodes(), findLabel(), FlowChart(), printNode(), printPlantUmlNode(), writeEdge(), writeFlowLinks() , 以及 writeShape().

◆ line

int FlowChart::line = 0

private

在文件 vhdldocgen.h 第 334 行定义.

被这些函数引用 buildCommentNodes().

◆ stamp

int FlowChart::stamp = 0

private

在文件 vhdldocgen.h 第 331 行定义.

被这些函数引用 colTextNodes(), findNextLoop(), findNode(), findPrevLoop(), FlowChart(), getNextIfLink(), getNextNode(), printNode() , 以及 writeFlowLinks().

◆ text

QCString FlowChart::text

private

在文件 vhdldocgen.h 第 337 行定义.

被这些函数引用 addFlowChart(), colTextNodes(), FlowChart(), printNode(), printPlantUmlNode(), writeFlowLinks() , 以及 writeShape().

◆ type

int FlowChart::type = 0

private

在文件 vhdldocgen.h 第 332 行定义.

被这些函数引用 addFlowChart(), buildCommentNodes(), colTextNodes(), findLabel(), findNextLoop(), findNode(), findPrevLoop(), FlowChart(), getNextNode(), printNode(), printPlantUmlNode(), printUmlTree(), writeEdge(), writeFlowLinks() , 以及 writeShape().

该类的文档由以下文件生成:

src/vhdldocgen.h
src/vhdldocgen.cpp

Public 类型

Public 成员函数

静态 Public 成员函数

Private 属性

详细描述

成员枚举类型说明

◆ nodeTypes

构造及析构函数说明

◆ FlowChart()

◆ ~FlowChart()

成员函数说明

◆ addFlowChart()

◆ alignCommentNode()

◆ alignFuncProc()

◆ buildCommentNodes()

◆ codify()

◆ colTextNodes()

◆ convertNameToFileName()

◆ createSVG()

◆ delFlowList()

◆ endDot()

◆ findLabel()

◆ findNextLoop()

◆ findNode() [1/2]

◆ findNode() [2/2]

◆ findPrevLoop()

◆ getNextIfLink()

◆ getNextNode()

◆ getNodeName()

◆ getNodeType()

◆ getTimeStamp()

◆ moveToPrevLevel()

◆ printFlowTree()

◆ printNode()

◆ printPlantUmlNode()

◆ printUmlTree()

◆ startDot()

◆ writeEdge() [1/2]

◆ writeEdge() [2/2]

◆ writeFlowChart()

◆ writeFlowLinks()

◆ writeShape()

类成员变量说明

◆ exp

◆ id

◆ label

◆ line

◆ stamp

◆ text

◆ type