LexCodeParser Class Reference

LEX code scanner. More...

#include <src/lexcode.h>

Inheritance diagram for LexCodeParser:

Collaboration diagram for LexCodeParser:

Classes
struct	Private

Public Member Functions
	LexCodeParser ()
	~LexCodeParser () override
void	parseCode (OutputCodeList &codeOutIntf, const DString &scopeName, const DString &input, SrcLangExt, 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.

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

LEX code scanner.

Definition at line 24 of file lexcode.h.

Constructor & Destructor Documentation

LexCodeParser()

LexCodeParser::LexCodeParser

(

)

Definition at line 1174 of file lexcode.l.

                             : p(std::make_unique<Private>())
{
  lexcodeYYlex_init_extra(&p->state, &p->yyscanner);
#ifdef FLEX_DEBUG
  lexcodeYYset_debug(Debug::isFlagSet(Debug::Lex_lexcode)?1:0,p->yyscanner);
#endif
  resetCodeParserState();
}

References Debug::isFlagSet(), Debug::Lex_lexcode, p, and resetCodeParserState().

~LexCodeParser()

LexCodeParser::~LexCodeParser ( )

override

Definition at line 1183 of file lexcode.l.

{
  lexcodeYYlex_destroy(p->yyscanner);
}

References p.

Member Function Documentation

parseCode()

void LexCodeParser::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 1195 of file lexcode.l.

{
  yyscan_t yyscanner = p->yyscanner;
  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
 
  if (input.empty()) return;
 
  DebugLex debugLex(Debug::Lex_lexcode, __FILE__, options.fileDef() ? qPrint(options.fileDef()->fileName()) : nullptr);
 
  yyextra->code              = &codeOutIntf;
  yyextra->inputString       = input.data();
  yyextra->inputPosition     = 0;
  yyextra->fileName          = options.fileDef() ? options.fileDef()->fileName():"";
  yyextra->currentFontClass  = nullptr;
  yyextra->insideCodeLine    = false;
  yyextra->classScope        = scopeName;
  yyextra->currentMemberDef  = options.memberDef();
  yyextra->searchCtx         = options.searchCtx();
  yyextra->collectXRefs      = options.collectXRefs();
  yyextra->yyLineNr          = options.startLine()!=-1 ? options.startLine() : 1;
  yyextra->inputLines        = options.endLine()!=-1  ? options.endLine()+1 : yyextra->yyLineNr + countLines(yyscanner) - 1;
  yyextra->startCCodeLine    = yyextra->yyLineNr;
  yyextra->stripCodeComments = stripCodeComments;
  yyextra->exampleBlock      = options.isExample();
  yyextra->exampleName       = options.exampleName();
  yyextra->sourceFileDef     = options.fileDef();
  yyextra->lineNumbers       = options.fileDef()!=nullptr && options.showLineNumbers();
 
  if (options.isExample() && options.fileDef()==nullptr)
  {
    // create a dummy filedef for the example
    yyextra->exampleFileDef = createFileDef(DString(),!options.exampleName().empty() ? options.exampleName() : DString("generated"));
    yyextra->sourceFileDef = yyextra->exampleFileDef.get();
  }
 
  if (yyextra->sourceFileDef)
  {
    setCurrentDoc(yyscanner,"l00001");
  }
 
  yyextra->includeCodeFragment = options.inlineFragment();
  // Starts line 1 on the output
  startCodeLine(yyscanner);
 
  lexcodeYYrestart( nullptr, yyscanner );
  BEGIN( DefSection );
  lexcodeYYlex(yyscanner);
 
  if (yyextra->insideCodeLine)
  {
    endCodeLine(yyscanner);
  }
  if (yyextra->exampleFileDef)
  {
    // delete the temporary file definition used for this example
    yyextra->exampleFileDef.reset();
    yyextra->sourceFileDef=0;
  }
}

References CodeParserOptions::collectXRefs(), countLines(), createFileDef(), DString::data(), DString::empty(), endCodeLine(), CodeParserOptions::endLine(), CodeParserOptions::exampleName(), CodeParserOptions::fileDef(), FileDef::fileName(), CodeParserOptions::inlineFragment(), CodeParserOptions::isExample(), Debug::Lex_lexcode, CodeParserOptions::memberDef(), p, qPrint(), CodeParserOptions::searchCtx(), setCurrentDoc(), CodeParserOptions::showLineNumbers(), startCodeLine(), and CodeParserOptions::startLine().

resetCodeParserState()

void LexCodeParser::resetCodeParserState ( )

overridevirtual

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 1188 of file lexcode.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  yyextra->currentDefinition = nullptr;
  yyextra->currentMemberDef = nullptr;
}

References p.

Referenced by LexCodeParser().

Member Data Documentation

p

std::unique_ptr<Private> LexCodeParser::p

private

Definition at line 41 of file lexcode.h.

Referenced by LexCodeParser(), parseCode(), resetCodeParserState(), and ~LexCodeParser().

---

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

• src/lexcode.h
• src/lexcode.l