doxygen
sqlcode.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 
16 
17 #ifndef SQLCODE_H
18 #define SQLCODE_H
19 
20 #include "parserintf.h"
21 
22 class FileDef;
23 class MemberDef;
24 class QCString;
25 class Definition;
26 
30 {
31  public:
32  SQLCodeParser();
33  ~SQLCodeParser() override;
34  NON_COPYABLE(SQLCodeParser)
35 
36  void parseCode(OutputCodeList &codeOutIntf,
37  const QCString &scopeName,
38  const QCString &input,
39  SrcLangExt,
40  bool isExampleBlock,
41  const QCString &exampleName=QCString(),
42  const FileDef *fileDef=nullptr,
43  int startLine=-1,
44  int endLine=-1,
45  bool inlineFragment=FALSE,
46  const MemberDef *memberDef=nullptr,
47  bool showLineNumbers=TRUE,
48  const Definition *searchCtx=nullptr,
49  bool collectXRefs=TRUE
50  ) override;
51  void resetCodeParserState() override;
52  private:
53  struct Private;
54  std::unique_ptr<Private> p;
55 };
56 
57 
58 #endif
The common base class of all entity definitions found in the sources.
Definition: definition.h:75
A model of a class/file/namespace member symbol.
Definition: memberdef.h:47
void resetCodeParserState() override
Resets the state of the code parser.
A model of a file symbol.
Definition: filedef.h:98
SrcLangExt
Language as given by extension.
Definition: types.h:41
void parseCode(OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt, 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...
Class representing a list of different code generators.
Definition: outputlist.h:199
SQL scanner.
Definition: sqlcode.h:29
This is an alternative implementation of QCString.
Definition: qcstring.h:93
Abstract interface for code parsers.
Definition: parserintf.h:82