FlowChart Class Reference

#include <src/vhdldocgen.h>

Collaboration diagram for FlowChart:

Public Types

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 Member Functions
	FlowChart (int typ, const DString &t, const DString &ex, const DString &label=DString())

Static Public Member Functions
static void	createSVG ()
static void	startDot (TextStream &t)
static void	endDot (TextStream &t)
static void	codify (TextStream &t, const DString &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 DString	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 DString &)
static void	delFlowList ()
static const char *	getNodeType (int c)
static void	addFlowChart (int type, const DString &text, const DString &exp, const DString &label=DString())
static void	moveToPrevLevel ()
static int	getTimeStamp ()
static void	writeFlowChart ()
static void	alignFuncProc (DString &q, const ArgumentList &al, bool isFunc)
static DString	convertNameToFileName ()
static void	printNode (const FlowChart &n)
static void	printFlowTree ()
static void	buildCommentNodes (TextStream &t)
static void	alignCommentNode (TextStream &t, DString com)
static void	printUmlTree ()
static DString	printPlantUmlNode (const FlowChart &flo, bool, bool)

Private Attributes
int	id = 0
int	stamp = 0
int	type = 0
int	line = 0
DString	label
DString	text
DString	exp

Detailed Description

Definition at line 238 of file vhdldocgen.h.

Member Enumeration Documentation

nodeTypes

enum FlowChart::nodeTypes

Enumerator
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

Definition at line 241 of file vhdldocgen.h.

                   {
      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
    };

Constructor & Destructor Documentation

FlowChart()

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

Definition at line 2858 of file vhdldocgen.cpp.

{
  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++;
}

References ELSE_NO, ELSIF_NO, END_NO, exp, ifcounter, label, nodeCounter, stamp, START_NO, STARTL, text, type, and VARIABLE_NO.

Referenced by addFlowChart(), buildCommentNodes(), colTextNodes(), findLabel(), findNextLoop(), findNode(), findPrevLoop(), getNextIfLink(), getNextNode(), getTimeStamp(), printNode(), printPlantUmlNode(), printUmlTree(), writeEdge(), writeFlowLinks(), and writeShape().

Member Function Documentation

addFlowChart()

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

static

Definition at line 2885 of file vhdldocgen.cpp.

{
  if (!VhdlDocGen::getFlowMember()) return;
 
  DString typeString(text);
  DString expression(exp);
 
 
  if (!text.empty())
  {
    typeString=substitute(typeString,";","\n");
  }
 
  if (!exp.empty())
  {
    expression=substitute(expression,"\"","\\\"");
  }
 
  if (type & VARIABLE_NO)
  {
  // Ignore the empty section of the VHDL variable definition.
  // This is section between `process` and `begin` keywords, where any source text is missing, probably a bug in the VHDL source parser.
    if(text.empty()) return;
 
    flowList.insert(flowList.begin(),FlowChart(type,typeString,expression,label));
    flowList.front().line=1; // TODO: use getLine(); of the parser
  }
  else if (type & START_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
  }
}

References DString::empty(), exp, FlowChart(), flowList, VhdlDocGen::getFlowMember(), label, START_NO, substitute(), text, type, and VARIABLE_NO.

Referenced by VHDLOutlineParser::createFlow(), findNode(), and VHDLOutlineParser::handleFlowComment().

alignCommentNode()

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

static

Definition at line 2715 of file vhdldocgen.cpp.

{
  size_t max=0;
  DString 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=static_cast<int>(max-s.length());
 
  DString n;
  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);
  }
}

References DString::append(), codify(), DString::fill(), DString::length(), split(), and DString::str().

Referenced by buildCommentNodes(), getTimeStamp(), and writeShape().

alignFuncProc()

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

static

Definition at line 3276 of file vhdldocgen.cpp.

{
  size_t index=al.size();
  if (index==0) return;
 
  size_t len=q.length()+VhdlDocGen::getFlowMember()->name().length();
  DString prev,temp;
  prev.fill(' ',static_cast<int>(len)+1);
 
  q+="\n";
  for (const Argument &arg : al)
  {
    DString 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;
}

References DString::fill(), VhdlDocGen::getFlowMember(), DString::length(), Definition::name(), DString::prepend(), and ArgumentList::size().

Referenced by VHDLOutlineParser::createFlow(), and getTimeStamp().

buildCommentNodes()

void FlowChart::buildCommentNodes ( TextStream & t )

static

Definition at line 2751 of file vhdldocgen.cpp.

{
  size_t size=flowList.size();
  bool begin=false;
 
  if (size>0)
  {
    for (uint32_t 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 = nullptr;
      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;
}

References alignCommentNode(), begin(), BEGIN_NO, COMMENT_NO, FlowChart(), flowCol, FLOWLEN, flowList, getNodeName(), id, label, line, type, and writeEdge().

Referenced by getTimeStamp(), and writeFlowChart().

codify()

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

static

Definition at line 2836 of file vhdldocgen.cpp.

{
  if (!str.empty())
  {
    const char *p=str.data();
    while (*p)
    {
      char 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

References DString::data(), and DString::empty().

Referenced by alignCommentNode().

colTextNodes()

void FlowChart::colTextNodes ( )

static

Definition at line 2651 of file vhdldocgen.cpp.

{
  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 ",DString());
          fc.stamp = flo.stamp;
          flowList.insert(flowList.begin()+j+1,fc);
        }
      }
    }
  }
 
}// colTextNode

References DString::DString(), ELSE_NO, EMPTY, FlowChart(), flowList, IFF, stamp, text, TEXT_NO, and type.

Referenced by writeFlowChart().

convertNameToFileName()

DString FlowChart::convertNameToFileName ( )

static

Definition at line 3013 of file vhdldocgen.cpp.

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

References VhdlDocGen::getFlowMember(), and Definition::name().

Referenced by createSVG(), getTimeStamp(), HtmlDocVisitor::operator()(), and printUmlTree().

createSVG()

void FlowChart::createSVG ( )

static

Definition at line 3047 of file vhdldocgen.cpp.

{
  DString qcs("/");
  DString 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()));
 
  DString dir=" -o \""+ov+qcs+"\"";
  ov+="/flow_design.dot";
 
  DString vlargs="-Tsvg \""+ov+"\" "+dir ;
 
  if (Portable::system(Doxygen::verifiedDotPath,vlargs)!=0)
  {
    err("could not create dot file\n");
  }
}

References Config_getString, convertNameToFileName(), err, Portable::system(), and Doxygen::verifiedDotPath.

Referenced by writeFlowChart().

delFlowList()

void FlowChart::delFlowList ( )

static

Definition at line 2708 of file vhdldocgen.cpp.

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

References flowList, ifcounter, and nodeCounter.

Referenced by findNode(), and writeFlowChart().

endDot()

void FlowChart::endDot ( TextStream & t )

static

Definition at line 3077 of file vhdldocgen.cpp.

{
  t << " } \n";
}

Referenced by writeFlowChart().

findLabel()

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

static

Definition at line 3349 of file vhdldocgen.cpp.

{
  for (size_t j=index;j>0;j--)
  {
    const FlowChart &flo = flowList[j];
    if ((flo.type & LOOP) && !flo.label.empty() && dstricmp(flo.label,label)==0)
    {
      return j;
    }
  }
  err("could not find label: '{}'\n",label);
  return 0;
}

References dstricmp(), DString::empty(), err, FlowChart(), flowList, label, LOOP, and type.

Referenced by findNode(), and writeFlowLinks().

findNextLoop()

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

static

Definition at line 3309 of file vhdldocgen.cpp.

{
  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;
}

References END_LOOP, FlowChart(), flowList, stamp, and type.

Referenced by findNode(), and writeFlowLinks().

findNode() [1/2]

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

static

Definition at line 3363 of file vhdldocgen.cpp.

{
  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

References FlowChart(), flowList, stamp, and type.

Referenced by getNextIfLink(), getNextNode(), and writeFlowLinks().

findNode() [2/2]

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

static

References addFlowChart(), delFlowList(), exp, findLabel(), findNextLoop(), findPrevLoop(), getNodeType(), label, moveToPrevLevel(), stamp, text, and type.

findPrevLoop()

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

static

Definition at line 3326 of file vhdldocgen.cpp.

{
  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;
}

References FlowChart(), flowList, LOOP, stamp, and type.

Referenced by findNode(), and writeFlowLinks().

getNextIfLink()

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

static

Definition at line 3417 of file vhdldocgen.cpp.

{
  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);
}

References ELSE_NO, ELSIF_NO, ENDIF_NO, findNode(), FlowChart(), flowList, getNextNode(), and stamp.

Referenced by writeFlowLinks().

getNextNode()

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

static

Definition at line 3376 of file vhdldocgen.cpp.

{
  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;
}

References ELSE_NO, ELSIF_NO, END_CASE, ENDIF_NO, findNode(), FlowChart(), FLOWLEN, flowList, stamp, type, and WHEN_NO.

Referenced by getNextIfLink(), and writeFlowLinks().

getNodeName()

DString FlowChart::getNodeName ( int n )

static

Definition at line 2701 of file vhdldocgen.cpp.

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

References DString::prepend(), and DString::setNum().

Referenced by buildCommentNodes(), writeEdge(), writeEdge(), and writeShape().

getNodeType()

const char * FlowChart::getNodeType ( int c )

static

Definition at line 3018 of file vhdldocgen.cpp.

{
  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--";
  }
}

References 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, and WHILE_NO.

Referenced by findNode(), and printNode().

getTimeStamp()

int FlowChart::getTimeStamp ( )

static

References alignCommentNode(), alignFuncProc(), buildCommentNodes(), convertNameToFileName(), FlowChart(), label, printFlowTree(), printNode(), printPlantUmlNode(), printUmlTree(), and writeFlowChart().

moveToPrevLevel()

void FlowChart::moveToPrevLevel ( )

static

Definition at line 2924 of file vhdldocgen.cpp.

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

References VhdlDocGen::getFlowMember(), and ifcounter.

Referenced by findNode().

printFlowTree()

void FlowChart::printFlowTree ( )

static

Definition at line 2643 of file vhdldocgen.cpp.

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

References flowList, and printNode().

Referenced by getTimeStamp(), and writeFlowChart().

printNode()

void FlowChart::printNode ( const FlowChart & n )

static

Definition at line 2583 of file vhdldocgen.cpp.

{
  DString 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=" ";
    }
    DString 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]",qPrint(q),FlowChart::getNodeType(flo.type),flo.stamp,flo.id);
    }
    else if (flo.type & COMMENT_NO)
    {
      printf("\n NO: %s%s[%d,%d]",qPrint(t),FlowChart::getNodeType(flo.type),flo.stamp,flo.id);
    }
    else
    {
      printf("\n NO: %s[%d,%d]",qPrint(t),flo.stamp,flo.id);
    }
  }
}

References COMMENT_NO, EMPTNODE, exp, DString::fill(), FlowChart(), getNodeType(), id, label, DString::left(), qPrint(), reg::replace(), stamp, STARTL, DString::str(), DString::stripWhiteSpace(), text, and type.

Referenced by getTimeStamp(), and printFlowTree().

printPlantUmlNode()

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

static

Definition at line 2930 of file vhdldocgen.cpp.

{
  DString t;
  DString exp=flo.exp.stripWhiteSpace();
  DString 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;
}

References BEGIN_NO, CASE_NO, COMMENT_NO, DString::contains(), ELSE_NO, ELSIF_NO, EMPTY_NO, END_CASE, END_LOOP, END_NO, ENDIF_NO, EXIT_NO, exp, FlowChart(), FOR_NO, IF_NO, label, LOOP_NO, NEXT_NO, RETURN_NO, START_NO, DString::stripWhiteSpace(), text, TEXT_NO, type, VARIABLE_NO, WHEN_NO, and WHILE_NO.

Referenced by getTimeStamp(), and printUmlTree().

printUmlTree()

void FlowChart::printUmlTree ( )

static

Definition at line 2969 of file vhdldocgen.cpp.

{
  int caseCounter = 0;
  int whenCounter = 0;
 
  DString 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";
 
  DString htmlOutDir = Config_getString(HTML_OUTPUT);
 
  DString n=convertNameToFileName();
  auto baseNameVector=PlantumlManager::instance().writePlantUMLSource(htmlOutDir,n,qcs,PlantumlManager::PUML_SVG,"uml",n,1,true);
  for (const auto &baseName: baseNameVector)
  {
    PlantumlManager::instance().generatePlantUMLOutput(baseName,htmlOutDir,PlantumlManager::PUML_SVG,true);
  }
}

References CASE_NO, Config_getString, convertNameToFileName(), END_CASE, FlowChart(), FLOWLEN, flowList, PlantumlManager::generatePlantUMLOutput(), PlantumlManager::instance(), printPlantUmlNode(), PlantumlManager::PUML_SVG, type, WHEN_NO, and PlantumlManager::writePlantUMLSource().

Referenced by getTimeStamp(), and writeFlowChart().

startDot()

void FlowChart::startDot ( TextStream & t )

static

Definition at line 3069 of file vhdldocgen.cpp.

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

Referenced by writeFlowChart().

writeEdge() [1/2]

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

static

Definition at line 3229 of file vhdldocgen.cpp.

{
  bool b=fl_from.type & STARTL;
  bool c=fl_to.type & STARTL;
 
#ifdef DEBUGFLOW
  DString s1(getNodeName(fl_from.id));
  DString 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);
}

References FlowChart(), getNodeName(), id, STARTL, DString::str(), type, and writeEdge().

writeEdge() [2/2]

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

static

Definition at line 3247 of file vhdldocgen.cpp.

{
  DString 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";
}

References flowCol, getNodeName(), and label.

Referenced by buildCommentNodes(), writeEdge(), and writeFlowLinks().

writeFlowChart()

void FlowChart::writeFlowChart ( )

static

Definition at line 3082 of file vhdldocgen.cpp.

{
  //  assert(VhdlDocGen::flowMember);
 
  DString ov = Config_getString(HTML_OUTPUT);
  DString fileName = ov+"/flow_design.dot";
  std::ofstream f = Portable::openOutputStream(fileName);
  if (!f.is_open())
  {
    err("Cannot open file {} for writing\n",fileName);
    return;
  }
  TextStream t(&f);
 
  colTextNodes();
  //  buildCommentNodes(t);
 
#ifdef DEBUGFLOW
   printFlowTree();
#endif
 
  if (!Config_getString(PLANTUML_JAR_PATH).empty())
  {
    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

References buildCommentNodes(), colTextNodes(), Config_getString, createSVG(), delFlowList(), endDot(), err, flowList, TextStream::flush(), Portable::openOutputStream(), printFlowTree(), printUmlTree(), startDot(), writeFlowLinks(), and writeShape().

Referenced by VHDLOutlineParser::createFlow(), and getTimeStamp().

writeFlowLinks()

void FlowChart::writeFlowLinks ( TextStream & t )

static

Definition at line 3439 of file vhdldocgen.cpp.

{
  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 (dstricmp(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 = 0;
      bool b = kind==NEXT_NO;
      if (!fll.exp.empty())
      {
        writeEdge(t,fll,flowList[j+1],1);
      }
      if (!fll.label.empty())
      {
        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

References CASE_NO, dstricmp(), EEND, DString::empty(), END_CASE, END_LOOP, EXIT_NO, exp, findLabel(), findNextLoop(), findNode(), findPrevLoop(), FlowChart(), flowList, FOR_NO, getNextIfLink(), getNextNode(), IFF, label, LOOP_NO, NEXT_NO, RETURN_NO, DString::simplifyWhiteSpace(), stamp, text, TEXT_NO, type, VARIABLE_NO, WHEN_NO, WHILE_NO, and writeEdge().

Referenced by writeFlowChart().

writeShape()

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

static

Definition at line 3127 of file vhdldocgen.cpp.

{
  if (fl.type & EEND) return;
  DString var;
  if (fl.type & LOOP)
  {
    var=" loop";
  }
  else if (fl.type & IFF)
  {
    var=" then";
  }
  else
  {
    var="";
  }
 
  t << getNodeName(fl.id);
 
#ifdef DEBUGFLOW
  DString qq(getNodeName(fl.id));
  g_keyMap.emplace(qq.str(),fl.id);
#endif
 
  bool dec=(fl.type & DECLN);
  bool exit=(fl.type & EXITNEXT);
  if (exit && !fl.exp.empty())
  {
    dec=true;
  }
  if (dec)
  {
    DString exp=fl.exp;
    alignText(exp);
 
    t << " [shape=diamond,style=filled,color=\"";
    t << flowCol.decisionNode;
    t << "\",label=\" ";
    DString kl;
    if (exit) kl=fl.text+"  ";
 
    if (!fl.label.empty())
    {
      kl+=fl.label+":"+exp+var;
    }
    else
    {
      kl+=exp+var;
    }
 
    FlowChart::alignCommentNode(t,kl);
    t << "\"]\n";
  }
  else if (fl.type & ENDCL)
  {
    DString val=fl.text;
    t << " [shape=ellipse ,label=\""+val+"\"]\n";
  }
  else if (fl.type & STARTFIN)
  {
    DString 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.empty()) return;
    bool isVar=(fl.type & FlowChart::VARIABLE_NO);
    DString q=fl.text;
 
    if (exit)
    {
      q+=" "+fl.label;
    }
 
    size_t z=q.rfind('\n');
 
    if (z!=DString::npos && z==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>>];";
  }
}

References alignCommentNode(), alignText(), DECLN, EEND, DString::empty(), ENDCL, EXITNEXT, exp, FlowChart(), flowCol, getNodeName(), id, IFF, label, DString::length(), LOOP, DString::npos, DString::remove(), DString::rfind(), STARTFIN, DString::str(), text, type, and VARIABLE_NO.

Referenced by writeFlowChart().

Member Data Documentation

exp

DString FlowChart::exp

private

Definition at line 313 of file vhdldocgen.h.

Referenced by addFlowChart(), findNode(), FlowChart(), printNode(), printPlantUmlNode(), writeFlowLinks(), and writeShape().

id

int FlowChart::id = 0

private

Definition at line 305 of file vhdldocgen.h.

Referenced by buildCommentNodes(), printNode(), writeEdge(), and writeShape().

label

DString FlowChart::label

private

Definition at line 311 of file vhdldocgen.h.

Referenced by addFlowChart(), buildCommentNodes(), findLabel(), findNode(), FlowChart(), getTimeStamp(), printNode(), printPlantUmlNode(), writeEdge(), writeFlowLinks(), and writeShape().

line

int FlowChart::line = 0

private

Definition at line 309 of file vhdldocgen.h.

Referenced by buildCommentNodes().

stamp

int FlowChart::stamp = 0

private

Definition at line 306 of file vhdldocgen.h.

Referenced by colTextNodes(), findNextLoop(), findNode(), findNode(), findPrevLoop(), FlowChart(), getNextIfLink(), getNextNode(), printNode(), and writeFlowLinks().

text

DString FlowChart::text

private

Definition at line 312 of file vhdldocgen.h.

Referenced by addFlowChart(), colTextNodes(), findNode(), FlowChart(), printNode(), printPlantUmlNode(), writeFlowLinks(), and writeShape().

type

int FlowChart::type = 0

private

Definition at line 307 of file vhdldocgen.h.

Referenced by addFlowChart(), buildCommentNodes(), colTextNodes(), findLabel(), findNextLoop(), findNode(), findNode(), findPrevLoop(), FlowChart(), getNextNode(), printNode(), printPlantUmlNode(), printUmlTree(), writeEdge(), writeFlowLinks(), and writeShape().

---

The documentation for this class was generated from the following files:

• src/vhdldocgen.h
• src/vhdldocgen.cpp