VHDL parser using state-based lexical scanning. 更多...

#include <vhdljjparser.h>

类 VHDLOutlineParser 继承关系图:

VHDLOutlineParser 的协作图:

类
struct	Private

Public 成员函数
	VHDLOutlineParser ()

virtual	~VHDLOutlineParser ()

void	parseInput (const QCString &fileName, const char fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser clangParser)
	Parses a single input file with the goal to build an Entry tree. 更多...

bool	needsPreprocessing (const QCString &) const
	Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser. 更多...

void	parsePrototype (const QCString &text)
	Callback function called by the comment block scanner. 更多...

void	setLineParsed (int tok)

int	getLine (int tok)

int	getLine ()

void	lineCount (const char *)

void	lineCount ()

void	addProto (const char s1, const char s2, const char s3, const char s4, const char s5, const char s6)

void	createFunction (const char impure, uint64 spec, const char fname)

void	addVhdlType (const char n, int startLine, int section, uint64 spec, const char args, const char *type, Protection prot)

void	addCompInst (const char n, const char instName, const char *comp, int iLine)

void	handleCommentBlock (const QCString &doc, bool brief)

void	handleFlowComment (const char *)

void	initEntry (Entry *e)

void	newEntry ()

bool	isFuncProcProced ()

void	pushLabel (QCString &, QCString &)

QCString	popLabel (QCString &q)

bool	addLibUseClause (const QCString &type)

void	mapLibPackage (Entry *root)

void	createFlow ()

void	error_skipto (int kind)

void	oneLineComment (QCString qcs)

void	setMultCommentLine ()

bool	checkMultiComment (QCString &qcs, int line)

void	insertEntryAtLine (std::shared_ptr< Entry > ce, int line)

QCString	getNameID ()
	returns a unique id for each record member. 更多...

int	checkInlineCode (QCString &doc)

Public 成员函数继承自 OutlineParserInterface
virtual	~OutlineParserInterface ()

Private 属性
std::unique_ptr< Private >	p

详细描述

VHDL parser using state-based lexical scanning.

This is the VHDL language parser for doxygen.

在文件 vhdljjparser.h 第 27 行定义.

构造及析构函数说明

◆ VHDLOutlineParser()

VHDLOutlineParser::VHDLOutlineParser ( )

在文件 vhdljjparser.cpp 第 124 行定义.

                                      : p(std::make_unique<Private>())
 {
 }

◆ ~VHDLOutlineParser()

VHDLOutlineParser::~VHDLOutlineParser ( )

virtual

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

129 {

130 }

成员函数说明

◆ addCompInst()

void VHDLOutlineParser::addCompInst	(	const char *	n,
		const char *	instName,
		const char *	comp,
		int	iLine
	)

在文件 vhdljjparser.cpp 第 471 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   s->current->spec=VhdlDocGen::INSTANTIATION;
   s->current->section=Entry::VARIABLE_SEC;
   s->current->startLine=iLine;
   s->current->bodyLine=iLine;
   s->current->type=instName;                       // foo:instname e.g proto or work. proto(ttt)
   s->current->exception=s->genLabels.lower();         // |arch|label1:label2...
   s->current->name=n;                              // foo
   if (s->lastCompound)
   {
     s->current->args=s->lastCompound->name;             // architecture name
   }
   s->current->includeName=comp;                    // component/entity/configuration
   int u=s->genLabels.find("|",1);
   if (u>0)
   {
     s->current->write=s->genLabels.right(s->genLabels.length()-u);
     s->current->read=s->genLabels.left(u);
   }
   //printf  (" \n genlabel: [%s]  inst: [%s]  name: [%s] %d\n",n,instName,comp,iLine);
  
   if (s->lastCompound)
   {
     s->current->args=s->lastCompound->name;
     if (true) // !findInstant(current->type))
     {
       initEntry(s->current.get());
       // TODO: protect with mutex
       g_instFiles.emplace_back(std::make_shared<Entry>(*s->current));
       // TODO: end protect with mutex
     }
  
     s->current=std::make_shared<Entry>();
   }
   else
   {
     newEntry();
   }
 }

引用了 vhdl::parser::VhdlParser::SharedState::current, QCString::find(), g_instFiles, vhdl::parser::VhdlParser::SharedState::genLabels, initEntry(), VhdlDocGen::INSTANTIATION, vhdl::parser::VhdlParser::SharedState::lastCompound, QCString::left(), QCString::length(), QCString::lower(), newEntry(), p, QCString::right() , 以及 Entry::VARIABLE_SEC.

◆ addLibUseClause()

bool VHDLOutlineParser::addLibUseClause ( const QCString & type )

在文件 vhdljjparser.cpp 第 708 行定义.

 {
   static bool showIEEESTD=Config_getBool(FORCE_LOCAL_INCLUDES);
  
   if (showIEEESTD) // all standard packages and libraries will not be shown
   {
     if (type.lower().stripPrefix("ieee")) return FALSE;
     if (type.lower().stripPrefix("std")) return FALSE;
   }
   return TRUE;
 }

引用了 Config_getBool, FALSE, QCString::lower(), QCString::stripPrefix() , 以及 TRUE.

被这些函数引用 mapLibPackage().

◆ addProto()

void VHDLOutlineParser::addProto	(	const char *	s1,
		const char *	s2,
		const char *	s3,
		const char *	s4,
		const char *	s5,
		const char *	s6
	)

在文件 vhdljjparser.cpp 第 628 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   (void)s5; // avoid unused warning
   QCString name=s2;
   StringVector ql=split(name.str(),",");
  
   for (const auto &n : ql)
   {
     Argument arg;
     arg.name=n;
     if (s3)
     {
       arg.type=s3;
     }
     arg.type+=" ";
     arg.type+=s4;
     if (s6)
     {
       arg.type+=s6;
     }
     if (s->parse_sec==GEN_SEC && s->param_sec==0)
     {
       arg.defval="gen!";
     }
  
     if (s->parse_sec==PARAM_SEC)
     {
     //  assert(false);
     }
  
     arg.defval+=s1;
     arg.attrib="";//s6;
  
     s->current->argList.push_back(arg);
     s->current->args+=s2;
     s->current->args+=",";
   }
 }

引用了 Argument::attrib, vhdl::parser::VhdlParser::SharedState::current, Argument::defval, GEN_SEC, Argument::name, p, PARAM_SEC, vhdl::parser::VhdlParser::SharedState::param_sec, vhdl::parser::VhdlParser::SharedState::parse_sec, split(), QCString::str() , 以及 Argument::type.

◆ addVhdlType()

void VHDLOutlineParser::addVhdlType	(	const char *	n,
		int	startLine,
		int	section,
		uint64	spec,
		const char *	args,
		const char *	type,
		Protection	prot
	)

在文件 vhdljjparser.cpp 第 513 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   QCString name(n);
   if (isFuncProcProced() || VhdlDocGen::getFlowMember())  return;
  
   if (s->parse_sec==GEN_SEC)
   {
     spec= VhdlDocGen::GENERIC;
   }
  
   StringVector ql=split(name.str(),",");
  
   for (size_t u=0;u<ql.size();u++)
   {
     s->current->name=ql[u];
     s->current->startLine=startLine;
     s->current->bodyLine=startLine;
     s->current->section=section;
     s->current->spec=spec;
     s->current->fileName=p->yyFileName;
     if (s->current->args.isEmpty())
     {
       s->current->args=args;
     }
     s->current->type=type;
     s->current->protection=prot;
  
     if (!s->lastCompound && (section==Entry::VARIABLE_SEC) &&  (spec == VhdlDocGen::USE || spec == VhdlDocGen::LIBRARY) )
     {
       p->libUse.emplace_back(std::make_shared<Entry>(*s->current));
       s->current->reset();
     }
     newEntry();
   }
 }

引用了 vhdl::parser::VhdlParser::SharedState::current, GEN_SEC, VhdlDocGen::GENERIC, VhdlDocGen::getFlowMember(), isFuncProcProced(), vhdl::parser::VhdlParser::SharedState::lastCompound, VhdlDocGen::LIBRARY, newEntry(), p, vhdl::parser::VhdlParser::SharedState::parse_sec, split(), QCString::str(), VhdlDocGen::USE , 以及 Entry::VARIABLE_SEC.

◆ checkInlineCode()

int VHDLOutlineParser::checkInlineCode ( QCString & doc )

在文件 vhdljjparser.cpp 第 273 行定义.

 {
   static const reg::Ex csRe(R"([\\@]code)");
   static const reg::Ex cendRe(R"(\s*[\\@]endcode)");
   static const reg::Ex cbriefRe(R"([\\@]brief)");
  
   // helper to simulate behavior of QString.find(const QRegExp &re,int pos)
   auto findRe = [](const QCString &str,const reg::Ex &re,int pos=0) -> int
   {
     if ((int)str.length()<pos) return -1;
     reg::Match match;
     const std::string s = str.str();
     if (reg::search(s,match,re,pos)) // match found
     {
       return (int)match.position();
     }
     else // not found
     {
       return -1;
     }
   };
   auto replaceRe = [](const QCString &str,const reg::Ex &re,const QCString &replacement) -> QCString
   {
     return reg::replace(str.str(), re, replacement.str());
   };
  
   int index = findRe(doc,csRe);
  
   if (findRe(doc,cendRe)!=-1)
     return 1;
  
   if (index < 0)
     return index;
  
   VhdlParser::SharedState *s = &p->shared;
   p->strComment += doc;
   p->code = findRe(p->inputString,csRe, p->code + 1);
   int com = p->inputString.find(p->strComment.data());
   int ref = findRe(p->inputString,cendRe, p->code + 1);
   int len = p->strComment.size();
  
   int ll = com + len;
   int diff = ref - ll - 3;
   QCString code = p->inputString.mid(ll, diff);
   int iLine = 0;
   code = stripLeadingAndTrailingEmptyLines(code, iLine);
   int val = code.contains('\n');
   VhdlDocGen::prepareComment(p->strComment);
   StringVector ql = split(p->strComment.str(),"\n");
  
   QCString co;
   QCString na;
   for (const auto &qcs_ : ql)
   {
     QCString qcs(qcs_);
     qcs = qcs.simplifyWhiteSpace();
     if (findRe(qcs,csRe)!=-1)
     {
       int i = qcs.find('{');
       int j = qcs.find('}');
       if (i > 0 && j > 0 && j > i)
       {
         na = qcs.mid(i + 1, (j - i - 1));
       }
       continue;
     }
     qcs = replaceRe(qcs,cbriefRe, "");
     co += qcs;
     co += '\n';
   }
  
   VhdlDocGen::prepareComment(co);
  
   Entry gBlock;
   if (!na.isEmpty())
     gBlock.name = na;
   else
     gBlock.name = "misc" + VhdlDocGen::getRecordNumber();
   gBlock.startLine = p->yyLineNr+iLine-1;
   gBlock.bodyLine = p->yyLineNr+iLine-1 ;
   gBlock.doc = code;
   gBlock.inbodyDocs = code;
   gBlock.brief = co;
   gBlock.section = Entry::VARIABLE_SEC;
   gBlock.spec = VhdlDocGen::MISCELLANEOUS;
   gBlock.fileName = p->yyFileName;
   gBlock.endBodyLine = p->yyLineNr + val +iLine;
   gBlock.lang = SrcLangExt_VHDL;
   std::shared_ptr<Entry> compound;
  
   if (s->lastEntity)
     compound = s->lastEntity;
   else if (s->lastCompound)
     compound = s->lastCompound;
   else
     compound = 0;
  
   if (compound)
   {
     compound->copyToSubEntry(&gBlock);
   }
   else
   {
     gBlock.type = "misc"; // global code like library ieee...
     s->current_root->copyToSubEntry(&gBlock);
   }
   p->strComment.resize(0);
   return 1;
 }

引用了 Entry::bodyLine, Entry::brief, QCString::contains(), vhdl::parser::VhdlParser::SharedState::current_root, Entry::doc, Entry::endBodyLine, Entry::fileName, QCString::find(), VhdlDocGen::getRecordNumber(), Entry::inbodyDocs, QCString::isEmpty(), Entry::lang, vhdl::parser::VhdlParser::SharedState::lastCompound, vhdl::parser::VhdlParser::SharedState::lastEntity, QCString::length(), reg::match(), QCString::mid(), VhdlDocGen::MISCELLANEOUS, Entry::name, p, VhdlDocGen::prepareComment(), reg::replace(), reg::search(), Entry::section, QCString::simplifyWhiteSpace(), Entry::spec, split(), SrcLangExt_VHDL, Entry::startLine, QCString::str(), stripLeadingAndTrailingEmptyLines(), Entry::type , 以及 Entry::VARIABLE_SEC.

被这些函数引用 handleCommentBlock().

◆ checkMultiComment()

bool VHDLOutlineParser::checkMultiComment	(	QCString &	qcs,
		int	line
	)

在文件 vhdljjparser.cpp 第 806 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   insertEntryAtLine(s->current_root,line);
  
   if (p->lineEntry.empty()) return false;
  
   VhdlDocGen::prepareComment(qcs);
   while (!p->lineEntry.empty())
   {
     std::shared_ptr<Entry> e=p->lineEntry.back();
     e->briefLine=line;
     e->brief+=qcs;
  
     p->lineEntry.pop_back();
   }
   return true;
 }

引用了 vhdl::parser::VhdlParser::SharedState::current_root, insertEntryAtLine(), p , 以及 VhdlDocGen::prepareComment().

被这些函数引用 handleCommentBlock() , 以及 oneLineComment().

◆ createFlow()

void VHDLOutlineParser::createFlow ( )

在文件 vhdljjparser.cpp 第 740 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   if (!VhdlDocGen::getFlowMember())
   {
     return;
   }
   QCString q,ret;
  
   if (s->currP==VhdlDocGen::FUNCTION)
   {
     q=":function( ";
     FlowChart::alignFuncProc(q,s->tempEntry->argList,true);
     q+=")";
   }
   else if (s->currP==VhdlDocGen::PROCEDURE)
   {
     q=":procedure (";
     FlowChart::alignFuncProc(q,s->tempEntry->argList,false);
     q+=")";
   }
   else
   {
     q=":process( "+s->tempEntry->args;
     q+=")";
   }
  
   q.prepend(VhdlDocGen::getFlowMember()->name());
  
   FlowChart::addFlowChart(FlowChart::START_NO,q,QCString());
  
   if (s->currP==VhdlDocGen::FUNCTION)
   {
     ret="end function ";
   }
   else if (s->currP==VhdlDocGen::PROCEDURE)
   {
     ret="end procedure";
   }
   else
   {
     ret="end process ";
   }
  
   FlowChart::addFlowChart(FlowChart::END_NO,ret,QCString());
   //  FlowChart::printFlowList();
   FlowChart::writeFlowChart();
   s->currP=0;
 }

引用了 FlowChart::addFlowChart(), FlowChart::alignFuncProc(), vhdl::parser::VhdlParser::SharedState::currP, FlowChart::END_NO, VhdlDocGen::FUNCTION, VhdlDocGen::getFlowMember(), p, QCString::prepend(), VhdlDocGen::PROCEDURE, FlowChart::START_NO, vhdl::parser::VhdlParser::SharedState::tempEntry , 以及 FlowChart::writeFlowChart().

◆ createFunction()

void VHDLOutlineParser::createFunction	(	const char *	impure,
		uint64	spec,
		const char *	fname
	)

在文件 vhdljjparser.cpp 第 551 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   QCString impure(imp);
   QCString fname(fn);
   s->current->spec=spec;
   s->current->section=Entry::FUNCTION_SEC;
  
   if (impure=="impure" || impure=="pure")
   {
     s->current->exception=impure;
   }
  
   if (s->parse_sec==GEN_SEC)
   {
     s->current->spec= VhdlDocGen::GENERIC;
     s->current->section=Entry::FUNCTION_SEC;
   }
  
   if (s->currP==VhdlDocGen::PROCEDURE)
   {
     s->current->name=impure;
     s->current->exception="";
   }
   else
   {
     s->current->name=fname;
   }
  
   if (spec==VhdlDocGen::PROCESS)
   {
     s->current->args=fname;
     s->current->name=impure;
     VhdlDocGen::deleteAllChars(s->current->args,' ');
     if (!fname.isEmpty())
     {
       StringVector q1=split(fname.str(),",");
       for (const auto &name : q1)
       {
         Argument arg;
         arg.name=name;
         s->current->argList.push_back(arg);
       }
     }
   }
 }

引用了 vhdl::parser::VhdlParser::SharedState::current, vhdl::parser::VhdlParser::SharedState::currP, VhdlDocGen::deleteAllChars(), Entry::FUNCTION_SEC, GEN_SEC, VhdlDocGen::GENERIC, QCString::isEmpty(), Argument::name, p, vhdl::parser::VhdlParser::SharedState::parse_sec, VhdlDocGen::PROCEDURE, VhdlDocGen::PROCESS, split() , 以及 QCString::str().

◆ error_skipto()

void VHDLOutlineParser::error_skipto ( int kind )

在文件 vhdljjparser.cpp 第 844 行定义.

 {
   Token *op;
   do
   {
     p->vhdlParser->getNextToken();  // step to next token
     op=p->vhdlParser->getToken(1);  // get first token
     if (op==0) break;
     //fprintf(stderr,"\n %s",qPrint(t->image));
   } while (op->kind != kind);
   p->vhdlParser->clearError();
   // The above loop consumes tokens all the way up to a token of
   // "kind".  We use a do-while loop rather than a while because the
   // current token is the one immediately before the erroneous token
   // (in our case the token immediately before what should have been
   // "if"/"while".
 }

引用了 vhdl::parser::Token::kind , 以及 p.

◆ getLine() [1/2]

int VHDLOutlineParser::getLine ( )

在文件 vhdljjparser.cpp 第 720 行定义.

 {
   return p->yyLineNr;
 }

引用了 p.

◆ getLine() [2/2]

int VHDLOutlineParser::getLine ( int tok )

在文件 vhdljjparser.cpp 第 731 行定义.

 {
   int val=p->lineParse[tok];
   if (val<0) val=0;
   //assert(val>=0 && val<=yyLineNr);
   return val;
 }

引用了 p.

◆ getNameID()

QCString VHDLOutlineParser::getNameID ( )

returns a unique id for each record member.

type first_rec is record RE: data_type; end;

type second_rec is record RE: data_type; end;

在文件 vhdljjparser.cpp 第 255 行定义.

 {
   return QCString().setNum(idCounter++);
 }

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

◆ handleCommentBlock()

void VHDLOutlineParser::handleCommentBlock	(	const QCString &	doc,
		bool	brief
	)

在文件 vhdljjparser.cpp 第 383 行定义.

 {
   int position = 0;
   bool needsEntry = FALSE;
   VhdlParser::SharedState *s = &p->shared;
   QCString doc = doc1;
  
   if (doc.isEmpty())
     return;
  
   if (checkMultiComment(doc, p->yyLineNr))
   {
     p->strComment.resize(0);
     return;
   }
  
   if (checkInlineCode(doc) > 0)
   {
     return;
   }
  
   Protection protection = Public;
   VhdlDocGen::prepareComment(doc);
  
   if (p->oldEntry == s->current.get())
   {
     p->str_doc.doc = doc;
     p->str_doc.iDocLine = p->iDocLine;
     p->str_doc.brief = brief;
     p->str_doc.pending = TRUE;
     return;
   }
  
   p->oldEntry = s->current.get();
  
   if (brief)
   {
     s->current->briefLine = p->yyLineNr;
   }
   else
   {
     s->current->docLine = p->yyLineNr;
   }
  
  
  
   Markdown markdown(p->yyFileName,p->iDocLine);
   int lineNr = p->iDocLine;
   QCString processedDoc = Config_getBool(MARKDOWN_SUPPORT) ? markdown.process(doc,lineNr) : doc;
  
    while (p->commentScanner.parseCommentBlock(
       p->thisParser,
       s->current.get(),
       processedDoc,  // text
       p->yyFileName, // file
       lineNr,       // line of block start
       brief,
       0,
       FALSE,
       protection,
       position,
       needsEntry,
       Config_getBool(MARKDOWN_SUPPORT)))
   {
     if (needsEntry)
       newEntry();
   }
   if (needsEntry)
   {
     if (p->varr)
     {
       p->varr = FALSE;
       s->current->name = p->varName;
       s->current->section = Entry::VARIABLEDOC_SEC;
       p->varName = "";
     }
     newEntry();
   }
   p->iDocLine = -1;
   p->strComment.resize(0);
 }

引用了 checkInlineCode(), checkMultiComment(), Config_getBool, vhdl::parser::VhdlParser::SharedState::current, FALSE, QCString::isEmpty(), newEntry(), p, VhdlDocGen::prepareComment(), Markdown::process(), Public, TRUE , 以及 Entry::VARIABLEDOC_SEC.

被这些函数引用 initEntry() , 以及 oneLineComment().

◆ handleFlowComment()

void VHDLOutlineParser::handleFlowComment ( const char * doc )

在文件 vhdljjparser.cpp 第 260 行定义.

 {
   lineCount(doc);
  
   if (VhdlDocGen::getFlowMember())
   {
     QCString qcs(doc);
     qcs=qcs.stripWhiteSpace();
     qcs.stripPrefix("--#");
     FlowChart::addFlowChart(FlowChart::COMMENT_NO,QCString(),QCString(),qcs);
   }
 }

引用了 FlowChart::addFlowChart(), FlowChart::COMMENT_NO, VhdlDocGen::getFlowMember(), lineCount(), QCString::stripPrefix() , 以及 QCString::stripWhiteSpace().

◆ initEntry()

void VHDLOutlineParser::initEntry ( Entry * e )

在文件 vhdljjparser.cpp 第 195 行定义.

 {
   e->fileName = p->yyFileName;
   e->lang     = SrcLangExt_VHDL;
   if (p->str_doc.pending)
   {
     p->str_doc.pending=FALSE;
     p->oldEntry=0; // prevents endless recursion
     p->iDocLine=p->str_doc.iDocLine;
     handleCommentBlock(p->str_doc.doc,p->str_doc.brief);
     p->iDocLine=-1;
   }
   p->commentScanner.initGroupInfo(e);
 }

引用了 FALSE, Entry::fileName, handleCommentBlock(), Entry::lang, p , 以及 SrcLangExt_VHDL.

被这些函数引用 addCompInst(), newEntry() , 以及 parseInput().

◆ insertEntryAtLine()

void VHDLOutlineParser::insertEntryAtLine	(	std::shared_ptr< Entry >	ce,
		int	line
	)

在文件 vhdljjparser.cpp 第 826 行定义.

 {
   for (const auto &rt : ce->children())
   {
     if (rt->bodyLine==line)
     {
       p->lineEntry.push_back(rt);
     }
  
     insertEntryAtLine(rt,line);
   }
 }

引用了 p.

被这些函数引用 checkMultiComment().

◆ isFuncProcProced()

bool VHDLOutlineParser::isFuncProcProced ( )

在文件 vhdljjparser.cpp 第 599 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   if (s->currP==VhdlDocGen::FUNCTION  ||
       s->currP==VhdlDocGen::PROCEDURE ||
       s->currP==VhdlDocGen::PROCESS
      )
   {
     return TRUE;
   }
   return FALSE;
 }

引用了 vhdl::parser::VhdlParser::SharedState::currP, FALSE, VhdlDocGen::FUNCTION, p, VhdlDocGen::PROCEDURE, VhdlDocGen::PROCESS , 以及 TRUE.

被这些函数引用 addVhdlType().

◆ lineCount() [1/2]

void VHDLOutlineParser::lineCount ( )

在文件 vhdljjparser.cpp 第 182 行定义.

 {
   p->yyLineNr++;
 }

引用了 p.

被这些函数引用 handleFlowComment().

◆ lineCount() [2/2]

void VHDLOutlineParser::lineCount ( const char * text )

在文件 vhdljjparser.cpp 第 187 行定义.

 {
   for (const char* c=text ; *c ; ++c )
   {
     if (*c == '\n') p->yyLineNr++;
   }
 }

引用了 p.

◆ mapLibPackage()

void VHDLOutlineParser::mapLibPackage ( Entry * root )

在文件 vhdljjparser.cpp 第 681 行定义.

 {
   for (const auto &rt : p->libUse)
   {
     if (addLibUseClause(rt->name))
     {
       bool bFound=FALSE;
       for (const auto &current : root->children())
       {
         if (VhdlDocGen::isVhdlClass(current.get()))
         {
           if (current->startLine > rt->startLine)
           {
             bFound=TRUE;
             current->copyToSubEntry(rt);
             break;
           }
         }
       }//for
       if (!bFound)
       {
         root->copyToSubEntry(rt);
       }
     } //if
   }// for
 }//MapLib

引用了 addLibUseClause(), Entry::children(), Entry::copyToSubEntry(), FALSE, VhdlDocGen::isVhdlClass(), p , 以及 TRUE.

被这些函数引用 parseInput().

◆ needsPreprocessing()

bool VHDLOutlineParser::needsPreprocessing ( const QCString & extension ) const

inlinevirtual

Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

参见: parseInput()

实现了 OutlineParserInterface.

在文件 vhdljjparser.h 第 37 行定义.

37 { return TRUE; }

引用了 TRUE.

◆ newEntry()

void VHDLOutlineParser::newEntry ( )

在文件 vhdljjparser.cpp 第 210 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   p->previous = s->current.get();
   if (s->current->spec==VhdlDocGen::ENTITY ||
       s->current->spec==VhdlDocGen::PACKAGE ||
       s->current->spec==VhdlDocGen::ARCHITECTURE ||
       s->current->spec==VhdlDocGen::PACKAGE_BODY)
   {
     s->current_root->moveToSubEntryAndRefresh(s->current);
   }
   else
   {
     if (s->lastCompound)
     {
       s->lastCompound->moveToSubEntryAndRefresh(s->current);
     }
     else
     {
       if (s->lastEntity)
       {
         s->lastEntity->moveToSubEntryAndRefresh(s->current);
       }
       else
       {
         s->current_root->moveToSubEntryAndRefresh(s->current);
       }
     }
   }
   initEntry(s->current.get());
 }

引用了 VhdlDocGen::ARCHITECTURE, vhdl::parser::VhdlParser::SharedState::current, vhdl::parser::VhdlParser::SharedState::current_root, VhdlDocGen::ENTITY, initEntry(), vhdl::parser::VhdlParser::SharedState::lastCompound, vhdl::parser::VhdlParser::SharedState::lastEntity, p, VhdlDocGen::PACKAGE , 以及 VhdlDocGen::PACKAGE_BODY.

被这些函数引用 addCompInst(), addVhdlType() , 以及 handleCommentBlock().

◆ oneLineComment()

void VHDLOutlineParser::oneLineComment ( QCString qcs )

在文件 vhdljjparser.cpp 第 795 行定义.

 {
     int j=qcs.find("--!");
     qcs=qcs.right(qcs.length()-3-j);
     if (!checkMultiComment(qcs,p->iDocLine))
     {
       handleCommentBlock(qcs,TRUE);
     }
 }

引用了 checkMultiComment(), QCString::find(), handleCommentBlock(), QCString::length(), p, QCString::right() , 以及 TRUE.

◆ parseInput()

void VHDLOutlineParser::parseInput	(	const QCString &	fileName,
		const char *	fileBuf,
		const std::shared_ptr< Entry > &	root,
		ClangTUParser *	clangParser
	)

virtual

Parses a single input file with the goal to build an Entry tree.

参数

[in]	fileName	The full name of the file.
[in]	fileBuf	The contents of the file (zero terminated).
[in,out]	root	The root of the tree of Entry *nodes representing the information extracted from the file.
[in]	clangParser	The clang translation unit parser object or nullptr if disabled.

实现了 OutlineParserInterface.

在文件 vhdljjparser.cpp 第 132 行定义.

 {
   VhdlParser::SharedState *s = &p->shared;
   p->thisParser=this;
   p->inputString=fileBuf;
  
  // fprintf(stderr,"\n ============= %s\n ==========\n",fileBuf);
  
   bool inLine = fileName.isEmpty();
  
   p->yyFileName=fileName;
  
   bool xilinx_ucf=isConstraintFile(p->yyFileName,".ucf");
   bool altera_qsf=isConstraintFile(p->yyFileName,".qsf");
  
   // support XILINX(ucf) and ALTERA (qsf) file
  
   if (xilinx_ucf)
   {
     VhdlDocGen::parseUCF(fileBuf,root.get(),p->yyFileName,FALSE);
     return;
   }
   if (altera_qsf)
   {
     VhdlDocGen::parseUCF(fileBuf,root.get(),p->yyFileName,TRUE);
     return;
   }
   p->yyLineNr=1;
   s->current_root=root;
   s->lastCompound=0;
   s->lastEntity=0;
   s->lastEntity=0;
   p->oldEntry = 0;
   s->current=std::make_shared<Entry>();
   initEntry(s->current.get());
   p->commentScanner.enterFile(fileName,p->yyLineNr);
   p->lineParse.reserve(200);
   p->parseVhdlfile(fileName,fileBuf,inLine);
   p->commentScanner.leaveFile(fileName,p->yyLineNr);
  
   s->current.reset();
  
   if (!inLine)
   mapLibPackage(root.get());
  
   p->yyFileName.resize(0);
   p->libUse.clear();
 }

引用了 vhdl::parser::VhdlParser::SharedState::current, vhdl::parser::VhdlParser::SharedState::current_root, FALSE, initEntry(), isConstraintFile(), QCString::isEmpty(), vhdl::parser::VhdlParser::SharedState::lastCompound, vhdl::parser::VhdlParser::SharedState::lastEntity, mapLibPackage(), p, VhdlDocGen::parseUCF() , 以及 TRUE.

◆ parsePrototype()

void VHDLOutlineParser::parsePrototype ( const QCString & text )

virtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

实现了 OutlineParserInterface.

在文件 vhdljjparser.cpp 第 465 行定义.

 {
   p->varName=text;
   p->varr=TRUE;
 }

引用了 p , 以及 TRUE.

◆ popLabel()

QCString VHDLOutlineParser::popLabel ( QCString & q )

在文件 vhdljjparser.cpp 第 618 行定义.

 {
   int i=q.findRev("|");
   if (i<0) return QCString();
   q = q.left(i);
   return q;
 }

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

◆ pushLabel()

void VHDLOutlineParser::pushLabel	(	QCString &	label,
		QCString &	val
	)

在文件 vhdljjparser.cpp 第 612 行定义.

 {
   label+="|";
   label+=val;
 }

◆ setLineParsed()

void VHDLOutlineParser::setLineParsed ( int tok )

在文件 vhdljjparser.cpp 第 725 行定义.

 {
   if ((int)p->lineParse.size()<=tok) p->lineParse.resize(tok+1);
   p->lineParse[tok]=p->yyLineNr;
 }

引用了 p.

◆ setMultCommentLine()

void VHDLOutlineParser::setMultCommentLine ( )

在文件 vhdljjparser.cpp 第 790 行定义.

 {
   p->iDocLine=p->yyLineNr;
 }

引用了 p.

类成员变量说明

◆ p

std::unique_ptr<Private> VHDLOutlineParser::p

private

在文件 vhdljjparser.h 第 71 行定义.

被这些函数引用 addCompInst(), addProto(), addVhdlType(), checkInlineCode(), checkMultiComment(), createFlow(), createFunction(), error_skipto(), getLine(), handleCommentBlock(), initEntry(), insertEntryAtLine(), isFuncProcProced(), lineCount(), mapLibPackage(), newEntry(), oneLineComment(), parseInput(), parsePrototype(), setLineParsed() , 以及 setMultCommentLine().

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

src/vhdljjparser.h
src/vhdljjparser.cpp

类

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ VHDLOutlineParser()

◆ ~VHDLOutlineParser()

成员函数说明

◆ addCompInst()

◆ addLibUseClause()

◆ addProto()

◆ addVhdlType()

◆ checkInlineCode()

◆ checkMultiComment()

◆ createFlow()

◆ createFunction()

◆ error_skipto()

◆ getLine() [1/2]

◆ getLine() [2/2]

◆ getNameID()

◆ handleCommentBlock()

◆ handleFlowComment()

◆ initEntry()

◆ insertEntryAtLine()

◆ isFuncProcProced()

◆ lineCount() [1/2]

◆ lineCount() [2/2]

◆ mapLibPackage()

◆ needsPreprocessing()

◆ newEntry()

◆ oneLineComment()

◆ parseInput()

◆ parsePrototype()

◆ popLabel()

◆ pushLabel()

◆ setLineParsed()

◆ setMultCommentLine()

类成员变量说明

◆ p