Doxygen
scanner.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 
18 #ifndef SCANNER_H
19 #define SCANNER_H
20 
21 #include "parserintf.h"
22 
23 /** \brief C-like language parser using state-based lexical scanning.
24  *
25  * This is the language parser for doxygen. It is somewhat fuzzy and
26  * supports C++ and various languages that are closely related to C++,
27  * such as C, C#, Objective-C, Java, PHP, and IDL.
28  */
30 {
31  public:
33  virtual ~COutlineParser();
34  void parseInput(const QCString &fileName,
35  const char *fileBuf,
36  const std::shared_ptr<Entry> &root,
37  ClangTUParser *clangParser);
38  bool needsPreprocessing(const QCString &extension) const;
39  void parsePrototype(const QCString &text);
40  private:
41  struct Private;
42  std::unique_ptr<Private> p;
43 };
44 
45 
46 #endif
COutlineParser::parsePrototype
void parsePrototype(const QCString &text)
Callback function called by the comment block scanner.
COutlineParser::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.
Private
@ Private
Definition: types.h:26
COutlineParser
C-like language parser using state-based lexical scanning.
Definition: scanner.h:29
COutlineParser::COutlineParser
COutlineParser()
parserintf.h
COutlineParser::p
std::unique_ptr< Private > p
Definition: scanner.h:56
COutlineParser::~COutlineParser
virtual ~COutlineParser()
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
COutlineParser::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...
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108