Doxygen
Loading...
Searching...
No Matches
CodeParserOptions Struct Reference

Options to configure the code parser. More...

#include <src/parserintf.h>

Collaboration diagram for CodeParserOptions:

Public Member Functions

bool isExample () const
DString exampleName () const
const FileDef * fileDef () const
int startLine () const
int endLine () const
bool inlineFragment () const
const MemberDef * memberDef () const
bool showLineNumbers () const
const Definition * searchCtx () const
bool collectXRefs () const
CodeParserOptions & setExample (bool isExample, const DString &name)
 Associate this comment block with a given example.
CodeParserOptions & setFileDef (const FileDef *fd)
CodeParserOptions & setStartLine (int lineNr)
CodeParserOptions & setEndLine (int lineNr)
CodeParserOptions & setInlineFragment (bool enable)
CodeParserOptions & setMemberDef (const MemberDef *md)
CodeParserOptions & setShowLineNumbers (bool enable)
CodeParserOptions & setSearchCtx (const Definition *d)
CodeParserOptions & setCollectXRefs (bool enable)

Private Attributes

bool m_isExample = false
DString m_exampleName
const FileDef * m_fileDef = nullptr
int m_startLine = -1
int m_endLine = -1
bool m_inlineFragment = false
const MemberDef * m_memberDef = nullptr
bool m_showLineNumbers = true
const Definition * m_searchCtx = nullptr
bool m_collectXRefs = true

Detailed Description

Options to configure the code parser.

Definition at line 76 of file parserintf.h.

Member Function Documentation

◆ collectXRefs()

bool CodeParserOptions::collectXRefs ( ) const
inline

Definition at line 89 of file parserintf.h.

89{ return m_collectXRefs; }

References m_collectXRefs.

Referenced by CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), and PythonCodeParser::parseCode().

◆ endLine()

int CodeParserOptions::endLine ( ) const
inline

Definition at line 84 of file parserintf.h.

84{ return m_endLine; }

References m_endLine.

Referenced by CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ exampleName()

DString CodeParserOptions::exampleName ( ) const
inline

Definition at line 81 of file parserintf.h.

81{ return m_exampleName; }
CodeParserOptions::m_exampleName
DString m_exampleName
Definition parserintf.h:123

References m_exampleName.

Referenced by CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ fileDef()

const FileDef * CodeParserOptions::fileDef ( ) const
inline

Definition at line 82 of file parserintf.h.

82{ return m_fileDef; }
CodeParserOptions::m_fileDef
const FileDef * m_fileDef
Definition parserintf.h:124

References m_fileDef.

Referenced by CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ inlineFragment()

bool CodeParserOptions::inlineFragment ( ) const
inline

Definition at line 85 of file parserintf.h.

85{ return m_inlineFragment; }

References m_inlineFragment.

Referenced by CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ isExample()

bool CodeParserOptions::isExample ( ) const
inline

Definition at line 80 of file parserintf.h.

80{ return m_isExample; }

References m_isExample.

Referenced by CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), XMLCodeParser::parseCode(), and setExample().

◆ memberDef()

const MemberDef * CodeParserOptions::memberDef ( ) const
inline

Definition at line 86 of file parserintf.h.

86{ return m_memberDef; }
CodeParserOptions::m_memberDef
const MemberDef * m_memberDef
Definition parserintf.h:128

References m_memberDef.

Referenced by CCodeParser::parseCode(), LexCodeParser::parseCode(), and VHDLCodeParser::parseCode().

◆ searchCtx()

const Definition * CodeParserOptions::searchCtx ( ) const
inline

Definition at line 88 of file parserintf.h.

88{ return m_searchCtx; }
CodeParserOptions::m_searchCtx
const Definition * m_searchCtx
Definition parserintf.h:130

References m_searchCtx.

Referenced by CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ setCollectXRefs()

CodeParserOptions & CodeParserOptions::setCollectXRefs ( bool enable)
inline

Definition at line 118 of file parserintf.h.

119 { m_collectXRefs = enable; return *this; }

References m_collectXRefs.

Referenced by handleCCode(), and CodeFragmentManager::parseCodeFragment().

◆ setEndLine()

CodeParserOptions & CodeParserOptions::setEndLine ( int lineNr)
inline

Definition at line 103 of file parserintf.h.

104 { m_endLine = lineNr; return *this; }

References m_endLine.

Referenced by DefinitionImpl::writeInlineCode(), and VhdlDocGen::writeSource().

◆ setExample()

CodeParserOptions & CodeParserOptions::setExample ( bool isExample,
const DString & name )
inline

Associate this comment block with a given example.

Definition at line 94 of file parserintf.h.

95 { m_isExample=isExample; m_exampleName = name; return *this; }
CodeParserOptions::isExample
bool isExample() const
Definition parserintf.h:80

References isExample(), m_exampleName, and m_isExample.

◆ setFileDef()

CodeParserOptions & CodeParserOptions::setFileDef ( const FileDef * fd)
inline

Definition at line 97 of file parserintf.h.

98 { m_fileDef = fd; return *this; }

References m_fileDef.

Referenced by handleCCode(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), and XmlDocVisitor::operator()().

◆ setInlineFragment()

CodeParserOptions & CodeParserOptions::setInlineFragment ( bool enable)
inline

Definition at line 106 of file parserintf.h.

107 { m_inlineFragment = enable; return *this; }

References m_inlineFragment.

Referenced by handleCCode(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), CodeFragmentManager::parseCodeFragment(), DefinitionImpl::writeInlineCode(), and VhdlDocGen::writeSource().

◆ setMemberDef()

CodeParserOptions & CodeParserOptions::setMemberDef ( const MemberDef * md)
inline

Definition at line 109 of file parserintf.h.

110 { m_memberDef = md; return *this; }

References m_memberDef.

Referenced by handleCCode(), DefinitionImpl::writeInlineCode(), and VhdlDocGen::writeSource().

◆ setSearchCtx()

CodeParserOptions & CodeParserOptions::setSearchCtx ( const Definition * d)
inline

Definition at line 115 of file parserintf.h.

116 { m_searchCtx = d; return *this; }

References m_searchCtx.

Referenced by handleCCode(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), and HtmlDocVisitor::operator()().

◆ setShowLineNumbers()

CodeParserOptions & CodeParserOptions::setShowLineNumbers ( bool enable)
inline

Definition at line 112 of file parserintf.h.

113 { m_showLineNumbers = enable; return *this; }

References m_showLineNumbers.

Referenced by handleCCode(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), and XmlDocVisitor::operator()().

◆ setStartLine()

CodeParserOptions & CodeParserOptions::setStartLine ( int lineNr)
inline

Definition at line 100 of file parserintf.h.

101 { m_startLine = lineNr; return *this; }

References m_startLine.

Referenced by handleCCode(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), DefinitionImpl::writeInlineCode(), and VhdlDocGen::writeSource().

◆ showLineNumbers()

bool CodeParserOptions::showLineNumbers ( ) const
inline

Definition at line 87 of file parserintf.h.

87{ return m_showLineNumbers; }

References m_showLineNumbers.

Referenced by CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

◆ startLine()

int CodeParserOptions::startLine ( ) const
inline

Definition at line 83 of file parserintf.h.

83{ return m_startLine; }

References m_startLine.

Referenced by CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

Member Data Documentation

◆ m_collectXRefs

bool CodeParserOptions::m_collectXRefs = true
private

Definition at line 131 of file parserintf.h.

Referenced by collectXRefs(), and setCollectXRefs().

◆ m_endLine

int CodeParserOptions::m_endLine = -1
private

Definition at line 126 of file parserintf.h.

Referenced by endLine(), and setEndLine().

◆ m_exampleName

DString CodeParserOptions::m_exampleName
private

Definition at line 123 of file parserintf.h.

Referenced by exampleName(), and setExample().

◆ m_fileDef

const FileDef* CodeParserOptions::m_fileDef = nullptr
private

Definition at line 124 of file parserintf.h.

Referenced by fileDef(), and setFileDef().

◆ m_inlineFragment

bool CodeParserOptions::m_inlineFragment = false
private

Definition at line 127 of file parserintf.h.

Referenced by inlineFragment(), and setInlineFragment().

◆ m_isExample

bool CodeParserOptions::m_isExample = false
private

Definition at line 122 of file parserintf.h.

Referenced by isExample(), and setExample().

◆ m_memberDef

const MemberDef* CodeParserOptions::m_memberDef = nullptr
private

Definition at line 128 of file parserintf.h.

Referenced by memberDef(), and setMemberDef().

◆ m_searchCtx

const Definition* CodeParserOptions::m_searchCtx = nullptr
private

Definition at line 130 of file parserintf.h.

Referenced by searchCtx(), and setSearchCtx().

◆ m_showLineNumbers

bool CodeParserOptions::m_showLineNumbers = true
private

Definition at line 129 of file parserintf.h.

Referenced by setShowLineNumbers(), and showLineNumbers().

◆ m_startLine

int CodeParserOptions::m_startLine = -1
private

Definition at line 125 of file parserintf.h.

Referenced by setStartLine(), and startLine().

The documentation for this struct was generated from the following file: