FortranCodeParser Class Reference

#include <src/fortrancode.h>

Inheritance diagram for FortranCodeParser:

Collaboration diagram for FortranCodeParser:

Classes
struct	Private

Public Member Functions
	FortranCodeParser (FortranFormat format=FortranFormat::Unknown)
	~FortranCodeParser () 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 29 of file fortrancode.h.

Constructor & Destructor Documentation

FortranCodeParser()

FortranCodeParser::FortranCodeParser

(

FortranFormat

format = FortranFormat::Unknown

)

Definition at line 1453 of file fortrancode.l.

                                                         : p(std::make_unique<Private>())
{
  p->format = format;
  fortrancodeYYlex_init_extra(&p->state,&p->yyscanner);
#ifdef FLEX_DEBUG
  fortrancodeYYset_debug(Debug::isFlagSet(Debug::Lex_fortrancode)?1:0,p->yyscanner);
#endif
  resetCodeParserState();
}

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

Referenced by FortranCodeParserFixed::FortranCodeParserFixed(), and FortranCodeParserFree::FortranCodeParserFree().

~FortranCodeParser()

FortranCodeParser::~FortranCodeParser ( )

override

Definition at line 1463 of file fortrancode.l.

{
  fortrancodeYYlex_destroy(p->yyscanner);
}

References p.

Member Function Documentation

parseCode()

void FortranCodeParser::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 1478 of file fortrancode.l.

{
  yyscan_t yyscanner = p->yyscanner;
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  if (input.isEmpty()) return;
  DebugLex debugLex(Debug::Lex_fortrancode, __FILE__, options.fileDef() ? qPrint(options.fileDef()->fileName()): nullptr);
  codeOutIntf.stripCodeComments(stripCodeComments);
  yyextra->code               = &codeOutIntf;
  yyextra->inputString        = input.data();
  yyextra->inputPosition      = 0;
  yyextra->fileName           = options.fileDef() ? options.fileDef()->fileName():"";
  yyextra->isFixedForm        = recognizeFixedForm(input,p->format);
  yyextra->contLineNr         = 1;
  yyextra->hasContLine        = nullptr;
  if (yyextra->isFixedForm)
  {
    checkContLines(yyscanner,yyextra->inputString);
    yyextra->fixedCommentAfter = Config_getInt(FORTRAN_COMMENT_AFTER);
  }
  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->foldStack.clear();
  yyextra->insideSpecialComment = false;
  if (options.isExample() && options.fileDef()==nullptr)
  {
    // create a dummy filedef for the example
    yyextra->exampleFileDef = createFileDef(QCString(),options.exampleName());
    yyextra->sourceFileDef = yyextra->exampleFileDef.get();
  }
  if (yyextra->sourceFileDef)
  {
    setCurrentDoc(yyscanner,QCString("l00001"));
  }
  yyextra->currentDefinition = nullptr;
  yyextra->currentMemberDef = nullptr;
  if (!yyextra->exampleName.isEmpty())
  {
    yyextra->exampleFile = convertNameToFile(yyextra->exampleName+"-example");
  }
  yyextra->includeCodeFragment = options.inlineFragment();
  startCodeLine(yyscanner);
  fortrancodeYYrestart(nullptr, yyscanner);
  BEGIN( Start );
  fortrancodeYYlex(yyscanner);
  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;
  }
  if (yyextra->hasContLine) free(yyextra->hasContLine);
  yyextra->hasContLine = nullptr;
 
  // write the tooltips
  yyextra->tooltipManager.writeTooltips(codeOutIntf);
}

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

resetCodeParserState()

void FortranCodeParser::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 1468 of file fortrancode.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  yyextra->currentDefinition = nullptr;
  yyextra->currentMemberDef = nullptr;
  yyextra->currentFontClass = nullptr;
  yyextra->insideCodeLine = FALSE;
  BEGIN( Start );
}

References FALSE, and p.

Member Data Documentation

p

std::unique_ptr<Private> FortranCodeParser::p

private

Definition at line 47 of file fortrancode.h.

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

---

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

• src/fortrancode.h
• src/fortrancode.l