ParserManager Class Reference

Manages programming language parsers. More...

#include <src/parserintf.h>

Collaboration diagram for ParserManager:

Classes
struct	ParserPair

Public Member Functions
	ParserManager (const OutlineParserFactory &outlineParserFactory, const CodeParserFactory &codeParserFactory)
	Create the parser manager.
void	registerParser (const QCString &name, const OutlineParserFactory &outlineParserFactory, const CodeParserFactory &codeParserFactory)
	Registers an additional parser.
bool	registerExtension (const QCString &extension, const QCString &parserName)
	Registers a file extension with a parser with name parserName.
std::unique_ptr< OutlineParserInterface >	getOutlineParser (const QCString &extension)
	Gets the interface to the parser associated with a given extension.
std::unique_ptr< CodeParserInterface >	getCodeParser (const QCString &extension)
	Gets the interface to the parser associated with a given extension.
CodeParserFactory &	getCodeParserFactory (const QCString &extension)
	Get the factory for create code parser objects with a given extension.
QCString	getParserName (const QCString &extension)
	Gets the name of the parser associated with given extension.

Private Member Functions
ParserPair &	getParsers (const QCString &extension)

Private Attributes
std::map< std::string, ParserPair >	m_parsers
std::map< std::string, ParserPair & >	m_extensions
ParserPair	m_defaultParsers

Detailed Description

Manages programming language parsers.

This class manages the language parsers in the system. One can register parsers, and obtain a parser given a file extension.

Definition at line 144 of file parserintf.h.

Constructor & Destructor Documentation

ParserManager()

ParserManager::ParserManager ( const OutlineParserFactory & outlineParserFactory, const CodeParserFactory & codeParserFactory )

inline

Create the parser manager.

Parameters

outlineParserFactory	the fallback outline parser factory to use for unknown extensions
codeParserFactory	the fallback code parser factory to use for unknown extensions

Definition at line 164 of file parserintf.h.

      : m_defaultParsers(outlineParserFactory,codeParserFactory, QCString())
    {
    }

Member Function Documentation

getCodeParser()

std::unique_ptr< CodeParserInterface > ParserManager::getCodeParser ( const QCString & extension )

inline

Gets the interface to the parser associated with a given extension.

If there is no parser explicitly registered for the supplied extension, the interface to the default parser will be returned.

Definition at line 216 of file parserintf.h.

    {
      auto factory = getCodeParserFactory(extension);
      return factory();
    }

Referenced by MemberDefImpl::_writeMultiLineInitializer(), generateExampleDocs(), CodeFragmentManager::parseCodeFragment(), FileDefImpl::parseSource(), ConceptDefImpl::writeDefinition(), DefinitionImpl::writeInlineCode(), VhdlDocGen::writeSource(), FileDefImpl::writeSourceBody(), and writeXMLCodeBlock().

getCodeParserFactory()

CodeParserFactory & ParserManager::getCodeParserFactory ( const QCString & extension )

inline

Get the factory for create code parser objects with a given extension.

Definition at line 223 of file parserintf.h.

    {
      return getParsers(extension).codeParserFactory;
    }

Referenced by DocVisitor::getCodeParser().

getOutlineParser()

std::unique_ptr< OutlineParserInterface > ParserManager::getOutlineParser ( const QCString & extension )

inline

Gets the interface to the parser associated with a given extension.

If there is no parser explicitly registered for the supplied extension, the interface to the default parser will be returned.

Definition at line 207 of file parserintf.h.

    {
      return getParsers(extension).outlineParserFactory();
    }

Referenced by VhdlDocGen::createFlowChart(), getParserForFile(), and MarkdownOutlineParser::parsePrototype().

getParserName()

QCString ParserManager::getParserName ( const QCString & extension )

inline

Gets the name of the parser associated with given extension.

If there is no parser explicitly registered for the supplied extension, te empty string will be reurned.

Definition at line 232 of file parserintf.h.

    {
      return getParsers(extension).parserName;
    }

Referenced by convertFileNameFortranParserCode().

getParsers()

ParserPair & ParserManager::getParsers ( const QCString & extension )

inlineprivate

Definition at line 238 of file parserintf.h.

    {
      QCString ext = extension.lower();
      if (ext.isEmpty()) ext=".no_extension";
      auto it = m_extensions.find(ext.data());
      if (it==m_extensions.end() && ext.length()>4)
      {
        it = m_extensions.find(ext.left(4).data());
      }
      return it!=m_extensions.end() ? it->second : m_defaultParsers;
    }

References QCString::data(), QCString::find(), QCString::isEmpty(), QCString::left(), QCString::length(), and QCString::lower().

registerExtension()

bool ParserManager::registerExtension ( const QCString & extension, const QCString & parserName )

inline

Registers a file extension with a parser with name parserName.

Returns TRUE if the extension was successfully registered.

Definition at line 187 of file parserintf.h.

    {
      if (parserName.isEmpty() || extension.isEmpty()) return FALSE;
 
      const auto &parserIt = m_parsers.find(parserName.str());
      if (parserIt == m_parsers.end()) return FALSE;
 
      auto extensionIt = m_extensions.find(extension.str());
      if (extensionIt != m_extensions.end()) // extension already exists
      {
        m_extensions.erase(extensionIt); // remove it (e.g. user specified extension overrules built in one)
      }
      m_extensions.emplace(extension.str(),parserIt->second); // add new mapping
      return TRUE;
    }

References FALSE, QCString::isEmpty(), QCString::str(), and TRUE.

registerParser()

void ParserManager::registerParser ( const QCString & name, const OutlineParserFactory & outlineParserFactory, const CodeParserFactory & codeParserFactory )

inline

Registers an additional parser.

Parameters

[in]	name	A symbolic name of the parser, i.e. "c", "python", "fortran", "vhdl", ...
[in]	outlineParserFactory	A factory method to create a language parser (scanner) that is to be used for the given name.
[in]	codeParserFactory	A factory method to create a code parser that is to be used for the given name.

Definition at line 178 of file parserintf.h.

    {
      m_parsers.emplace(name.str(),ParserPair(outlineParserFactory,codeParserFactory,name));
    }

References QCString::str().

Referenced by initDoxygen().

Member Data Documentation

m_defaultParsers

ParserPair ParserManager::m_defaultParsers

private

Definition at line 252 of file parserintf.h.

m_extensions

std::map<std::string,ParserPair &> ParserManager::m_extensions

private

Definition at line 251 of file parserintf.h.

m_parsers

std::map<std::string,ParserPair> ParserManager::m_parsers

private

Definition at line 250 of file parserintf.h.

---

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

• src/parserintf.h