PythonCodeParser Class Reference

#include <src/pycode.h>

Inheritance diagram for PythonCodeParser:

Collaboration diagram for PythonCodeParser:

Classes
struct	Private

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

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Definition at line 33 of file pycode.h.

Constructor & Destructor Documentation

PythonCodeParser()

PythonCodeParser::PythonCodeParser

(

)

Definition at line 1499 of file pycode.l.

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

References Debug::isFlagSet(), Debug::Lex_pycode, and p.

~PythonCodeParser()

PythonCodeParser::~PythonCodeParser ( )

override

Definition at line 1508 of file pycode.l.

{
  pycodeYYlex_destroy(p->yyscanner);
}

References p.

Member Function Documentation

parseCode()

void PythonCodeParser::parseCode ( OutputCodeList & codeOutList, const QCString & scopeName, const QCString & 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 1525 of file pycode.l.

{
  yyscan_t yyscanner = p->yyscanner;
  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
 
  //printf("***parseCode(%s)\n",qPrint(input));
 
  codeOutIntf.stripCodeComments(stripCodeComments);
  if (input.isEmpty()) return;
  DebugLex debugLex(Debug::Lex_pycode, __FILE__, options.fileDef() ? qPrint(options.fileDef()->fileName()): nullptr);
  yyextra->fileName      = options.fileDef() ? options.fileDef()->fileName():"";
  yyextra->code          = &codeOutIntf;
  yyextra->inputString   = input.data();
  yyextra->inputPosition = 0;
  yyextra->currentFontClass = nullptr;
  yyextra->insideCodeLine = FALSE;
  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->exampleBlock  = options.isExample();
  yyextra->exampleName   = options.exampleName();
  yyextra->sourceFileDef = options.fileDef();
  yyextra->symbolResolver.setFileScope(options.fileDef());
  yyextra->foldStack.clear();
  yyextra->insideSpecialComment = false;
 
  if (yyextra->exampleBlock && options.fileDef()==nullptr)
  {
    // create a dummy filedef for the example
    yyextra->exampleFileDef = createFileDef("",(!options.exampleName().isEmpty()?qPrint(options.exampleName()):"generated"));
    yyextra->sourceFileDef = yyextra->exampleFileDef.get();
  }
  if (yyextra->sourceFileDef)
  {
    setCurrentDoc(yyscanner,"l00001");
  }
 
  yyextra->includeCodeFragment = options.inlineFragment();
  // Starts line 1 on the output
  startCodeLine(yyscanner);
 
  pycodeYYrestart(nullptr,yyscanner);
 
  pycodeYYlex(yyscanner);
 
  if (!yyextra->indents.empty())
  {
    // printf("Exited pysourceparser in inconsistent state!\n");
  }
 
  if (yyextra->insideCodeLine)
  {
    endCodeLine(yyscanner);
  }
  if (Config_getBool(HTML_CODE_FOLDING))
  {
    while (!yyextra->foldStack.empty())
    {
      yyextra->code->endFold();
      yyextra->foldStack.pop_back();
    }
  }
  if (yyextra->exampleFileDef)
  {
    // delete the temporary file definition used for this example
    yyextra->exampleFileDef.reset();
    yyextra->sourceFileDef=nullptr;
  }
  // write the tooltips
  yyextra->tooltipManager.writeTooltips(codeOutIntf);
}

References CodeParserOptions::collectXRefs(), Config_getBool, countLines(), createFileDef(), QCString::data(), endCodeLine(), CodeParserOptions::endLine(), CodeParserOptions::exampleName(), FALSE, CodeParserOptions::fileDef(), FileDef::fileName(), CodeParserOptions::inlineFragment(), QCString::isEmpty(), CodeParserOptions::isExample(), Debug::Lex_pycode, p, qPrint(), CodeParserOptions::searchCtx(), setCurrentDoc(), startCodeLine(), CodeParserOptions::startLine(), and OutputCodeList::stripCodeComments().

resetCodeParserState()

void PythonCodeParser::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 1513 of file pycode.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  yyextra->codeClassMap.clear();
  yyextra->currentDefinition = nullptr;
  yyextra->currentMemberDef = nullptr;
  yyextra->doubleStringIsDoc = FALSE;
  yyextra->paramParens = 0;
  while (!yyextra->indents.empty()) yyextra->indents.pop();
  BEGIN( Body );
}

References FALSE, and p.

Member Data Documentation

p

std::unique_ptr<Private> PythonCodeParser::p

private

Definition at line 50 of file pycode.h.

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

---

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

• src/pycode.h
• src/pycode.l