Doxygen
fileparser.h
浏览该文件的文档.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2015 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 #ifndef FILEPARSER_H
17 #define FILEPARSER_H
18 
19 #include "parserintf.h"
20 
21 /** @brief Generic code parser */
23 {
24  public:
25  virtual ~FileCodeParser() {}
26  void parseCode(CodeOutputInterface &codeOutIntf,
27  const QCString &scopeName,
28  const QCString &input,
29  SrcLangExt lang,
30  bool isExampleBlock,
31  const QCString &exampleName=QCString(),
32  const FileDef *fileDef=0,
33  int startLine=-1,
34  int endLine=-1,
35  bool inlineFragment=FALSE,
36  const MemberDef *memberDef=0,
37  bool showLineNumbers=TRUE,
38  const Definition *searchCtx=0,
39  bool collectXRefs=TRUE
40  );
41  void resetCodeParserState() {}
42 };
43 
44 #endif
Definition
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
CodeParserInterface
Abstract interface for code parsers.
Definition: parserintf.h:83
SrcLangExt
SrcLangExt
Language as given by extension
Definition: types.h:41
FileCodeParser::parseCode
void parseCode(CodeOutputInterface &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, 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.
Definition: fileparser.cpp:19
FileCodeParser
Generic code parser
Definition: fileparser.h:22
MemberDef
A model of a class/file/namespace member symbol.
Definition: memberdef.h:45
parserintf.h
TRUE
#define TRUE
Definition: qcstring.h:36
FileCodeParser::~FileCodeParser
virtual ~FileCodeParser()
Definition: fileparser.h:38
FileCodeParser::resetCodeParserState
void resetCodeParserState()
Resets the state of the code parser.
Definition: fileparser.h:54
CodeOutputInterface
Output interface for code parser.
Definition: outputgen.h:61
FileDef
A model of a file symbol.
Definition: filedef.h:73
FALSE
#define FALSE
Definition: qcstring.h:33
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108