VHDLLanguageScanner Class Reference

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

#include <vhdlscanner.h>

Inheritance diagram for VHDLLanguageScanner:

ParserInterface List of all members.

Public Member Functions

virtual ~VHDLLanguageScanner ()
void parseInput (const char *fileName, const char *fileBuf, Entry *root)
bool needsPreprocessing (const QCString &extension)
void parseCode (CodeOutputInterface &codeOutIntf, const char *scopeName, const QCString &input, bool isExampleBlock, const char *exampleName=0, FileDef *fileDef=0, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, MemberDef *memberDef=0)
void resetCodeParserState ()
void parsePrototype (const char *text)

Detailed Description

VHDL parser using state-based lexical scanning.

This is the VHDL language parser for doxygen.

Definition at line 62 of file vhdlscanner.h.


Constructor & Destructor Documentation

virtual VHDLLanguageScanner::~VHDLLanguageScanner (  )  [inline, virtual]

Definition at line 65 of file vhdlscanner.h.


Member Function Documentation

void VHDLLanguageScanner::parseInput ( const char *  fileName,
const char *  fileBuf,
Entry root 
) [virtual]

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

Parameters:
[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.

Implements ParserInterface.

Definition at line 4769 of file vhdlscanner.cpp.

References BEGIN, err(), groupEnterFile(), groupLeaveFile(), mapLibPackage(), QCString, Start, unput, vhdlscanYYin, vhdlscanYYlex(), and vhdlscanYYrestart().

bool VHDLLanguageScanner::needsPreprocessing ( const QCString &  extension  )  [virtual]

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

Definition at line 2226 of file vhdlscanner.cpp.

void VHDLLanguageScanner::parseCode ( CodeOutputInterface codeOutIntf,
const char *  scopeName,
const QCString &  input,
bool  isExampleBlock,
const char *  exampleName = 0,
FileDef fileDef = 0,
int  startLine = -1,
int  endLine = -1,
bool  inlineFragment = FALSE,
MemberDef memberDef = 0 
) [virtual]

Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.

Parameters:
[in] codeOutIntf Abstract interface for writing the result.
[in] scopeName Name of scope to which the code belongs.
[in] input Actual code in the form of a string
[in] isExampleBlock TRUE iff the code is part of an example.
[in] exampleName Name of the example.
[in] fileDef File definition to which the code is associated.
[in] startLine Starting line in case of a code fragment.
[in] endLine Ending line of the code fragment.
[in] inlineFragment Code fragment that is to be shown inline as part of the documentation.
[in] memberDef Member definition to which the code is associated (non null in case of an inline fragment for a member).

Implements ParserInterface.

Definition at line 4870 of file vhdlscanner.cpp.

References parseVhdlCode().

void VHDLLanguageScanner::resetCodeParserState (  )  [virtual]

Resets the state of the code parser. Since multiple code fragments can together form a single example, an explicit function is used to reset the code parser state.

See also:
parseCode()

Implements ParserInterface.

Definition at line 2232 of file vhdlscanner.cpp.

void VHDLLanguageScanner::parsePrototype ( const char *  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 ParserInterface.

Definition at line 4815 of file vhdlscanner.cpp.

References Entry::addSubEntry(), Entry::argList, Entry::args, Argument::attrib, VhdlDocGen::FUNCTION, Entry::MEMBERDOC_SEC, Argument::name, Entry::name, VhdlDocGen::parseFuncProto(), VhdlDocGen::PROCEDURE, QCString, Entry::section, Entry::spec, Entry::type, Argument::type, and Entry::VARIABLEDOC_SEC.


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



Generated on Mon Mar 31 10:59:17 2008 by  doxygen 1.5.1