Doxygen
Toggle main menu visibility
Loading...
Searching...
No Matches
pycode.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
/* This code is based on the work done by the MoxyPyDoxy team
16
* (Linda Leong, Mike Rivera, Kim Truong, and Gabriel Estrada)
17
* in Spring 2005 as part of CS 179E: Compiler Design Project
18
* at the University of California, Riverside; the course was
19
* taught by Peter H. Froehlich <phf@acm.org>.
20
*/
21
22
23
#ifndef PYCODE_H
24
#define PYCODE_H
25
26
#include "
parserintf.h
"
27
28
class
FileDef
;
29
class
MemberDef
;
30
class
QCString
;
31
class
Definition
;
32
33
class
PythonCodeParser
:
public
CodeParserInterface
34
{
35
public
:
36
PythonCodeParser
();
37
~PythonCodeParser
()
override
;
38
NON_COPYABLE
(
PythonCodeParser
)
39
40
void
parseCode
(
OutputCodeList
&codeOutIntf,
41
const
QCString
&scopeName,
42
const
QCString
&input,
43
SrcLangExt
lang,
44
bool
stripCodeComments,
45
const
CodeParserOptions
&options
46
)
override
;
47
void
resetCodeParserState
()
override
;
48
private
:
49
struct
Private
;
50
std::unique_ptr<Private>
p
;
51
};
52
53
54
#endif
CodeParserInterface
Abstract interface for code parsers.
Definition
parserintf.h:142
Definition
The common base class of all entity definitions found in the sources.
Definition
definition.h:77
FileDef
A model of a file symbol.
Definition
filedef.h:99
MemberDef
A model of a class/file/namespace member symbol.
Definition
memberdef.h:48
OutputCodeList
Class representing a list of different code generators.
Definition
outputlist.h:165
PythonCodeParser::resetCodeParserState
void resetCodeParserState() override
Resets the state of the code parser.
Definition
pycode.l:1513
PythonCodeParser::~PythonCodeParser
~PythonCodeParser() override
Definition
pycode.l:1508
PythonCodeParser::parseCode
void parseCode(OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &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
pycode.l:1525
PythonCodeParser::PythonCodeParser
PythonCodeParser()
Definition
pycode.l:1499
PythonCodeParser::p
std::unique_ptr< Private > p
Definition
pycode.h:50
QCString
This is an alternative implementation of QCString.
Definition
qcstring.h:101
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:78
PythonCodeParser::Private
Definition
pycode.l:1494
SrcLangExt
SrcLangExt
Definition
types.h:207
src
pycode.h
Generated by
1.17.0