Fortran language parser using state-based lexical scanning. More...

#include <src/fortranscanner.h>

Inheritance diagram for FortranOutlineParser:

Collaboration diagram for FortranOutlineParser:

Classes
struct	Private

Public Member Functions
	FortranOutlineParser (FortranFormat format=FortranFormat::Unknown)
	~FortranOutlineParser () override
void	parseInput (const DString &fileName, const char fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser clangParser) override
	Parses a single input file with the goal to build an Entry tree.
bool	needsPreprocessing (const DString &extension) const override
	Returns true if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.
void	parsePrototype (const DString &text) override
	Callback function called by the comment block scanner.

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Fortran language parser using state-based lexical scanning.

This is the Fortran language parser for doxygen.

Definition at line 25 of file fortranscanner.h.

Constructor & Destructor Documentation

◆ FortranOutlineParser()

FortranOutlineParser::FortranOutlineParser ( FortranFormat format = FortranFormat::Unknown )

Definition at line 3437 of file fortranscanner.l.

   : p(std::make_unique<Private>(format))
{
}

References p.

Referenced by FortranOutlineParserFixed::FortranOutlineParserFixed(), FortranOutlineParserFree::FortranOutlineParserFree(), and ~FortranOutlineParser().

◆ ~FortranOutlineParser()

FortranOutlineParser::~FortranOutlineParser ( )

overridedefault

References FortranOutlineParser(), needsPreprocessing(), NON_COPYABLE, parseInput(), and parsePrototype().

Member Function Documentation

◆ needsPreprocessing()

bool FortranOutlineParser::needsPreprocessing ( const DString & extension ) const

overridevirtual

Returns true if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

See also: parseInput()

Implements OutlineParserInterface.

Definition at line 3457 of file fortranscanner.l.

{
  return extension!=extension.lower(); // use preprocessor only for upper case extensions
}

References DString::lower().

Referenced by ~FortranOutlineParser().

◆ parseInput()

void FortranOutlineParser::parseInput	(	const DString &	fileName,
		const char *	fileBuf,
		const std::shared_ptr< Entry > &	root,
		ClangTUParser *	clangParser )

overridevirtual

Parses a single input file with the goal to build an Entry tree.

Parameters

[in]	fileName	The full name of the file.
[in]	fileBuf	The contents of the file (zero terminated).
[in,out]	root	The root of the tree of Entry *nodes representing the information extracted from the file.
[in]	clangParser	The clang translation unit parser object or nullptr if disabled.

Implements OutlineParserInterface.

Definition at line 3444 of file fortranscanner.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  yyextra->thisParser = this;
 
  DebugLex debugLex(Debug::Lex_fortranscanner, __FILE__, qPrint(fileName));
 
  ::parseMain(p->yyscanner,fileName,fileBuf,root,p->format);
}

References Debug::Lex_fortranscanner, p, parseMain(), and qPrint().

Referenced by ~FortranOutlineParser().

◆ parsePrototype()

void FortranOutlineParser::parsePrototype ( const DString & text )

overridevirtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

Implements OutlineParserInterface.

Definition at line 3462 of file fortranscanner.l.

{
  struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
  pushBuffer(p->yyscanner,text);
  yyextra->parsingPrototype = true;
  BEGIN(Prototype);
  fortranscannerYYlex(p->yyscanner);
  yyextra->parsingPrototype = false;
  popBuffer(p->yyscanner);
}