Doxygen
Loading...
Searching...
No Matches
code.h
Go to the documentation of this file.
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 CODE_H
19#define CODE_H
20
21#include "parserintf.h"
22#include "construct.h"
23
24class FileDef;
25class MemberDef;
26class QCString;
27class Definition;
28
30{
31 public:
33 ~CCodeParser() override;
35 void parseCode(OutputCodeList &codeOutIntf,
36 const QCString &scopeName,
37 const QCString &input,
38 SrcLangExt lang,
39 bool stripCodeComments,
40 bool isExampleBlock,
41 const QCString &exampleName=QCString(),
42 const FileDef *fileDef=nullptr,
43 int startLine=-1,
44 int endLine=-1,
45 bool inlineFragment=FALSE,
46 const MemberDef *memberDef=nullptr,
47 bool showLineNumbers=TRUE,
48 const Definition *searchCtx=nullptr,
49 bool collectXRefs=TRUE
50 ) override;
51 void resetCodeParserState() override;
52 void setInsideCodeLine(bool inp);
53 bool insideCodeLine() const;
54 private:
55 struct Private;
56 std::unique_ptr<Private> p;
57};
58
59#endif
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.
Definition code.l:4083
void resetCodeParserState() override
Resets the state of the code parser.
Definition code.l:4059
CCodeParser()
Definition code.l:4045
void setInsideCodeLine(bool inp)
Definition code.l:4071
~CCodeParser() override
Definition code.l:4054
std::unique_ptr< Private > p
Definition code.h:56
bool insideCodeLine() const
Definition code.l:4077
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
A model of a file symbol.
Definition filedef.h:99
A model of a class/file/namespace member symbol.
Definition memberdef.h:48
This is an alternative implementation of QCString.
Definition qcstring.h:101
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
SrcLangExt
Language as given by extension.
Definition types.h:42