Doxygen
Toggle main menu visibility
Loading...
Searching...
No Matches
vhdlcode.h
Go to the documentation of this file.
1
/******************************************************************************
2
*
3
* Copyright (C) 1997-2020 by Dimitri van Heesch.
4
*
5
* Permission to use, copy, modify, and distribute this software and its
6
* documentation under the terms of the GNU General Public License is hereby
7
* granted. No representations are made about the suitability of this software
8
* for any purpose. It is provided "as is" without express or implied warranty.
9
* See the GNU General Public License for more details.
10
*
11
* Documents produced by Doxygen are derivative works derived from the
12
* input used in their production; they are not affected by this license.
13
*
14
*/
15
#ifndef VHDLCODE_H
16
#define VHDLCODE_H
17
18
#include "
parserintf.h
"
19
20
void
codeFreeVhdlScanner
();
21
22
class
VHDLCodeParser
final :
public
CodeParserInterface
23
{
24
public
:
25
VHDLCodeParser
();
26
~VHDLCodeParser
()
override
;
27
NON_COPYABLE
(
VHDLCodeParser
)
28
29
void
parseCode
(
OutputCodeList
&codeOutIntf,
30
const
DString
&scopeName,
31
const
DString
&input,
32
SrcLangExt
lang,
33
bool
stripCodeComments,
34
const
CodeParserOptions
&options
35
)
override
;
36
void
resetCodeParserState
()
override
;
37
private
:
38
struct
Private
;
39
std::unique_ptr<Private>
p
;
40
};
41
42
#endif
CodeParserInterface
Abstract interface for code parsers.
Definition
parserintf.h:141
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition
dstring.h:88
OutputCodeList
Class representing a list of different code generators.
Definition
outputlist.h:162
VHDLCodeParser::resetCodeParserState
void resetCodeParserState() override
Resets the state of the code parser.
Definition
vhdlcode.l:1651
VHDLCodeParser::VHDLCodeParser
VHDLCodeParser()
Definition
vhdlcode.l:1637
VHDLCodeParser::parseCode
void parseCode(OutputCodeList &codeOutIntf, const DString &scopeName, const DString &input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions &options) override
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
Definition
vhdlcode.l:1656
VHDLCodeParser::p
std::unique_ptr< Private > p
Definition
vhdlcode.h:39
NON_COPYABLE
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition
construct.h:37
parserintf.h
CodeParserOptions
Options to configure the code parser.
Definition
parserintf.h:77
VHDLCodeParser::Private
Definition
vhdlcode.l:1632
SrcLangExt
SrcLangExt
Definition
types.h:207
codeFreeVhdlScanner
void codeFreeVhdlScanner()
src
vhdlcode.h
Generated by
1.19.0