FileCodeParser Class Reference

Generic code parser. More...

#include <src/fileparser.h>

Inheritance diagram for FileCodeParser:

Collaboration diagram for FileCodeParser:

Public Member Functions
void	parseCode (OutputCodeList &codeOutIntf, const DString &scopeName, const DString &input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions &options) 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.

Detailed Description

Generic code parser.

Definition at line 22 of file fileparser.h.

Member Function Documentation

parseCode()

void FileCodeParser::parseCode ( OutputCodeList & codeOutList, const DString & scopeName, const DString & input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions & options )

overridevirtual

Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.

Parameters

[in]	codeOutList	interface for writing the result.
[in]	scopeName	Name of scope to which the code belongs.
[in]	input	Actual code in the form of a string
[in]	lang	The programming language of the code fragment.
[in]	stripCodeComments	signals whether or not for the code block the doxygen comments should be stripped.
[in]	options	Additional options to configure the parser.

Implements CodeParserInterface.

Definition at line 20 of file fileparser.cpp.

{
  int lineNr = options.startLine()!=-1 ? options.startLine() : 1;
  size_t length = input.length();
  size_t i=0;
  while (i<length && (options.endLine()==-1 || lineNr<=options.endLine()))
  {
    size_t j=i;
    while (j<length && input[j]!='\n') j++;
    DString lineStr = input.mid(i,j-i);
    codeOutIntf.startCodeLine(lineNr);
    if (options.fileDef() && options.showLineNumbers())
    {
      codeOutIntf.writeLineNumber(DString(),DString(),DString(),lineNr,!options.inlineFragment());
    }
    if (!lineStr.empty()) codeOutIntf.codify(lineStr.data());
    codeOutIntf.endCodeLine();
    lineNr++;
    i=j+1;
  }
}

References OutputCodeList::codify(), DString::data(), DString::DString(), DString::empty(), OutputCodeList::endCodeLine(), CodeParserOptions::endLine(), CodeParserOptions::fileDef(), CodeParserOptions::inlineFragment(), DString::length(), DString::mid(), CodeParserOptions::showLineNumbers(), OutputCodeList::startCodeLine(), CodeParserOptions::startLine(), and OutputCodeList::writeLineNumber().

resetCodeParserState()

void FileCodeParser::resetCodeParserState ( )

inlineoverridevirtual

Resets the state of the code parser.

Since multiple code fragments can together form a single example, an explicit function is used to reset the code parser state.

See also

parseCode()

Implements CodeParserInterface.

Definition at line 32 of file fileparser.h.

{}

---

The documentation for this class was generated from the following files:

• src/fileparser.h
• src/fileparser.cpp