Doxygen
vhdlcode.h
浏览该文件的文档.
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 
21 class FileDef;
22 class MemberDef;
23 
24 void codeFreeVhdlScanner();
25 
27 {
28  public:
30  virtual ~VHDLCodeParser();
31  void parseCode(CodeOutputInterface &codeOutIntf,
32  const QCString &scopeName,
33  const QCString &input,
34  SrcLangExt lang,
35  bool isExampleBlock,
36  const QCString &exampleName=QCString(),
37  const FileDef *fileDef=0,
38  int startLine=-1,
39  int endLine=-1,
40  bool inlineFragment=FALSE,
41  const MemberDef *memberDef=0,
42  bool showLineNumbers=TRUE,
43  const Definition *searchCtx=0,
44  bool collectXRefs=TRUE
45  );
46  void resetCodeParserState();
47  private:
48  struct Private;
49  std::unique_ptr<Private> p;
50 };
51 
52 #endif
Definition
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
Private
@ Private
Definition: types.h:26
CodeParserInterface
Abstract interface for code parsers.
Definition: parserintf.h:83
VHDLCodeParser::parseCode
void parseCode(CodeOutputInterface &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef *fileDef=0, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef *memberDef=0, bool showLineNumbers=TRUE, const Definition *searchCtx=0, bool collectXRefs=TRUE)
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
SrcLangExt
SrcLangExt
Language as given by extension
Definition: types.h:41
VHDLCodeParser::p
std::unique_ptr< Private > p
Definition: vhdlcode.h:48
VHDLCodeParser::resetCodeParserState
void resetCodeParserState()
Resets the state of the code parser.
VHDLCodeParser::VHDLCodeParser
VHDLCodeParser()
VHDLCodeParser
Definition: vhdlcode.h:26
MemberDef
A model of a class/file/namespace member symbol.
Definition: memberdef.h:45
parserintf.h
TRUE
#define TRUE
Definition: qcstring.h:36
codeFreeVhdlScanner
void codeFreeVhdlScanner()
CodeOutputInterface
Output interface for code parser.
Definition: outputgen.h:61
VHDLCodeParser::~VHDLCodeParser
virtual ~VHDLCodeParser()
FileDef
A model of a file symbol.
Definition: filedef.h:73
FALSE
#define FALSE
Definition: qcstring.h:33
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108