Doxygen
pyscanner.h
浏览该文件的文档.
1 /******************************************************************************
2  *
3  *
4  *
5  * Copyright (C) 1997-2015 by Dimitri van Heesch.
6  *
7  * Permission to use, copy, modify, and distribute this software and its
8  * documentation under the terms of the GNU General Public License is hereby
9  * granted. No representations are made about the suitability of this software
10  * for any purpose. It is provided "as is" without express or implied warranty.
11  * See the GNU General Public License for more details.
12  *
13  * Documents produced by Doxygen are derivative works derived from the
14  * input used in their production; they are not affected by this license.
15  *
16  */
17 /* This code is based on the work done by the MoxyPyDoxy team
18  * (Linda Leong, Mike Rivera, Kim Truong, and Gabriel Estrada)
19  * in Spring 2005 as part of CS 179E: Compiler Design Project
20  * at the University of California, Riverside; the course was
21  * taught by Peter H. Froehlich <phf@acm.org>.
22  */
23 
24 
25 #ifndef PYSCANNER_H
26 #define PYSCANNER_H
27 
28 #include "parserintf.h"
29 
30 /** \brief Python Language parser using state-based lexical scanning.
31  *
32  * This is the Python language parser for doxygen.
33  */
35 {
36  public:
38  virtual ~PythonOutlineParser();
39  void parseInput(const QCString &fileName,
40  const char *fileBuf,
41  const std::shared_ptr<Entry> &root,
42  ClangTUParser *clangParser);
43  bool needsPreprocessing(const QCString &extension) const;
44  void parsePrototype(const QCString &text);
45  private:
46  struct Private;
47  std::unique_ptr<Private> p;
48 };
49 
50 #endif
PythonOutlineParser::PythonOutlineParser
PythonOutlineParser()
Private
@ Private
Definition: types.h:26
PythonOutlineParser
Python Language parser using state-based lexical scanning.
Definition: pyscanner.h:34
PythonOutlineParser::p
std::unique_ptr< Private > p
Definition: pyscanner.h:61
PythonOutlineParser::needsPreprocessing
bool needsPreprocessing(const QCString &extension) const
Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed t...
parserintf.h
PythonOutlineParser::parsePrototype
void parsePrototype(const QCString &text)
Callback function called by the comment block scanner.
PythonOutlineParser::~PythonOutlineParser
virtual ~PythonOutlineParser()
OutlineParserInterface
Abstract interface for outline parsers.
Definition: parserintf.h:42
ClangTUParser
Clang parser object for a single translation unit, which consists of a source file and the directly o...
Definition: clangparser.h:21
PythonOutlineParser::parseInput
void parseInput(const QCString &fileName, const char *fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser *clangParser)
Parses a single input file with the goal to build an Entry tree.
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108