Doxygen
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
20class FileDef;
21class MemberDef;
22
24
26{
27 public:
29 ~VHDLCodeParser() override;
31
32 void parseCode(OutputCodeList &codeOutIntf,
33 const QCString &scopeName,
34 const QCString &input,
35 SrcLangExt lang,
36 bool stripCodeComments,
37 bool isExampleBlock,
38 const QCString &exampleName=QCString(),
39 const FileDef *fileDef=nullptr,
40 int startLine=-1,
41 int endLine=-1,
42 bool inlineFragment=FALSE,
43 const MemberDef *memberDef=nullptr,
44 bool showLineNumbers=TRUE,
45 const Definition *searchCtx=nullptr,
46 bool collectXRefs=TRUE
47 ) override;
48 void resetCodeParserState() override;
49 private:
50 struct Private;
51 std::unique_ptr<Private> p;
52};
53
54#endif
Abstract interface for code parsers.
Definition parserintf.h:83
A model of a file symbol.
Definition filedef.h:99
A model of a class/file/namespace member symbol.
Definition memberdef.h:48
void parseCode(OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool stripCodeComments, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef *fileDef=nullptr, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef *memberDef=nullptr, bool showLineNumbers=TRUE, const Definition *searchCtx=nullptr, bool collectXRefs=TRUE) override
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
Definition vhdlcode.l:1651
void resetCodeParserState() override
Resets the state of the code parser.
Definition vhdlcode.l:1646
~VHDLCodeParser() override
Definition vhdlcode.l:1641
std::unique_ptr< Private > p
Definition vhdlcode.h:51
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
SrcLangExt
Language as given by extension.
Definition types.h:42
void codeFreeVhdlScanner()