Doxygen
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
29{
30 public:
32 ~PythonCodeParser() override;
34
35 void parseCode(OutputCodeList &codeOutIntf,
36 const DString &scopeName,
37 const DString &input,
38 SrcLangExt lang,
39 bool stripCodeComments,
40 const CodeParserOptions &options
41 ) override;
42 void resetCodeParserState() override;
43 private:
44 struct Private;
45 std::unique_ptr<Private> p;
46};
47
48
49#endif
Abstract interface for code parsers.
Definition parserintf.h:141
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:88
Class representing a list of different code generators.
Definition outputlist.h:162
void resetCodeParserState() override
Resets the state of the code parser.
Definition pycode.l:1514
void parseCode(OutputCodeList &codeOutIntf, const DString &scopeName, const DString &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:1526
std::unique_ptr< Private > p
Definition pycode.h:45
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
Options to configure the code parser.
Definition parserintf.h:77
SrcLangExt
Definition types.h:207