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 
23 class FileDef;
24 class MemberDef;
25 class QCString;
26 class Definition;
27 
31 {
32  public:
33  SQLCodeParser();
34  virtual ~SQLCodeParser();
35  void parseCode(CodeOutputInterface &codeOutIntf,
36  const QCString &scopeName,
37  const QCString &input,
38  SrcLangExt,
39  bool isExampleBlock,
40  const QCString &exampleName=QCString(),
41  const FileDef *fileDef=0,
42  int startLine=-1,
43  int endLine=-1,
44  bool inlineFragment=FALSE,
45  const MemberDef *memberDef=0,
46  bool showLineNumbers=TRUE,
47  const Definition *searchCtx=0,
48  bool collectXRefs=TRUE
49  );
50  void resetCodeParserState();
51  private:
52  struct Private;
53  std::unique_ptr<Private> p;
54 };
55 
56 
57 #endif
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
A model of a class/file/namespace member symbol.
Definition: memberdef.h:45
void parseCode(CodeOutputInterface &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt, 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...
A model of a file symbol.
Definition: filedef.h:73
SrcLangExt
Language as given by extension.
Definition: types.h:41
SQL scanner.
Definition: sqlcode.h:30
This is an alternative implementation of QCString.
Definition: qcstring.h:108
Output interface for code parser.
Definition: outputgen.h:61
void resetCodeParserState()
Resets the state of the code parser.
Abstract interface for code parsers.
Definition: parserintf.h:83