Doxygen
Loading...
Searching...
No Matches
fileparser.h
Go to the documentation of this file.
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 void parseCode(OutputCodeList &codeOutIntf,
26 const QCString &scopeName,
27 const QCString &input,
28 SrcLangExt lang,
29 bool stripCodeComments,
30 bool isExampleBlock,
31 const QCString &exampleName=QCString(),
32 const FileDef *fileDef=nullptr,
33 int startLine=-1,
34 int endLine=-1,
35 bool inlineFragment=FALSE,
36 const MemberDef *memberDef=nullptr,
37 bool showLineNumbers=TRUE,
38 const Definition *searchCtx=nullptr,
39 bool collectXRefs=TRUE
40 ) override;
41 void resetCodeParserState() override {}
42};
43
44#endif
Abstract interface for code parsers.
Definition parserintf.h:83
The common base class of all entity definitions found in the sources.
Definition definition.h:76
Generic code parser.
Definition fileparser.h:23
void parseCode(OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool stripCodeComments, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef *fileDef=nullptr, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef *memberDef=nullptr, bool showLineNumbers=TRUE, const Definition *searchCtx=nullptr, bool collectXRefs=TRUE) override
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
void resetCodeParserState() override
Resets the state of the code parser.
Definition fileparser.h:41
A model of a file symbol.
Definition filedef.h:99
A model of a class/file/namespace member symbol.
Definition memberdef.h:48
Class representing a list of different code generators.
Definition outputlist.h:164
This is an alternative implementation of QCString.
Definition qcstring.h:101
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
SrcLangExt
Language as given by extension.
Definition types.h:42