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 DString &name, const OutlineParserFactory &outlineParserFactory, const CodeParserFactory &codeParserFactory)
	Registers an additional parser.
bool	registerExtension (const DString &extension, const DString &parserName)
	Registers a file extension with a parser with name parserName.
std::unique_ptr< OutlineParserInterface >	getOutlineParser (const DString &extension)
	Gets the interface to the parser associated with a given extension.
std::unique_ptr< CodeParserInterface >	getCodeParser (const DString &extension)
	Gets the interface to the parser associated with a given extension.
CodeParserFactory &	getCodeParserFactory (const DString &extension)
	Get the factory for create code parser objects with a given extension.
DString	getParserName (const DString &extension)
	Gets the name of the parser associated with given extension.

Private Member Functions
ParserPair &	getParsers (const DString &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 181 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 201 of file parserintf.h.

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

References m_defaultParsers.

Member Function Documentation

getCodeParser()

std::unique_ptr< CodeParserInterface > ParserManager::getCodeParser ( const DString & 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 253 of file parserintf.h.

    {
      return getCodeParserFactory(extension)();
    }

References getCodeParserFactory().

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

getCodeParserFactory()

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

inline

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

Definition at line 259 of file parserintf.h.

    {
      return getParsers(extension).codeParserFactory;
    }

References getParsers().

Referenced by DocVisitor::getCodeParser(), and getCodeParser().

getOutlineParser()

std::unique_ptr< OutlineParserInterface > ParserManager::getOutlineParser ( const DString & 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 244 of file parserintf.h.

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

References getParsers().

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

getParserName()

DString ParserManager::getParserName ( const DString & extension )

inline

Gets the name of the parser associated with given extension.

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

Definition at line 268 of file parserintf.h.

    {
      return getParsers(extension).parserName;
    }

References getParsers().

Referenced by convertFileNameFortranParserCode().

getParsers()

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

inlineprivate

Definition at line 274 of file parserintf.h.

    {
      DString ext = extension.lower();
      if (ext.empty()) 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 DString::data(), DString::empty(), DString::find(), DString::left(), DString::length(), DString::lower(), m_defaultParsers, and m_extensions.

Referenced by getCodeParserFactory(), getOutlineParser(), and getParserName().

registerExtension()

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

inline

Registers a file extension with a parser with name parserName.

Returns true if the extension was successfully registered.

Definition at line 224 of file parserintf.h.

    {
      if (parserName.empty() || extension.empty()) 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 DString::empty(), m_extensions, m_parsers, and DString::str().

registerParser()

void ParserManager::registerParser ( const DString & 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 215 of file parserintf.h.

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

References m_parsers, and DString::str().

Referenced by initDoxygen().

Member Data Documentation

m_defaultParsers

ParserPair ParserManager::m_defaultParsers

private

Definition at line 288 of file parserintf.h.

Referenced by getParsers(), and ParserManager().

m_extensions

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

private

Definition at line 287 of file parserintf.h.

Referenced by getParsers(), and registerExtension().

m_parsers

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

private

Definition at line 286 of file parserintf.h.

Referenced by registerExtension(), and registerParser().

---

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

• src/parserintf.h