doxygen
Classes | Public Member Functions | List of all members
VHDLOutlineParser Class Reference

VHDL parser using state-based lexical scanning. More...

#include <vhdljjparser.h>

Inheritance diagram for VHDLOutlineParser:
Inheritance graph
[legend]
Collaboration diagram for VHDLOutlineParser:
Collaboration graph
[legend]

Classes

struct  Private
 

Public Member Functions

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. More...
 
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. More...
 
void parsePrototype (const QCString &text)
 Callback function called by the comment block scanner. More...
 
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. More...
 
int checkInlineCode (QCString &doc)
 

Detailed Description

VHDL parser using state-based lexical scanning.

This is the VHDL language parser for doxygen.

Member Function Documentation

◆ 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;

◆ 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.

See also
parseInput()

Implements OutlineParserInterface.

◆ 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.

Parameters
[in]fileNameThe full name of the file.
[in]fileBufThe contents of the file (zero terminated).
[in,out]rootThe root of the tree of Entry *nodes representing the information extracted from the file.
[in]clangParserThe clang translation unit parser object or nullptr if disabled.

Implements OutlineParserInterface.

◆ 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.

Implements OutlineParserInterface.


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