#include <cuformulaplugin.h>

Inheritance diagram for CuFormulaPlugin:

Public Member Functions
	CuFormulaPlugin (QObject *parent=nullptr)

virtual	~CuFormulaPlugin ()

QString	getName () const

Cumbia *	getCumbia () const

void	initialize (CumbiaPool *cu_poo, CuControlsFactoryPool &fpool)
	plugin is initialized with application wide CumbiaPool and CuControlsFactoryPool

CuControlsReaderFactoryI *	getFormulaReaderFactory () const

std::string	message () const

bool	error () const

std::vector< std::string >	srcPatterns () const
	CuFormulaPlugin::srcPatterns return the list of regular expression patterns defining a CuFormulaPlugin source pattern.

void	addSrcPattern (const std::string &pattern)
	CuFormulaPlugin::addSrcPattern add a regular expression pattern to the list of patterns.

CuFormulaParserI *	getFormulaParserInstance () const
	CuFormulaPlugin::getFormulaParserInstance returns a new instance of CuFormulaParser.

Constructor & Destructor Documentation

◆ CuFormulaPlugin()

CuFormulaPlugin::CuFormulaPlugin ( QObject * parent = nullptr )

References CuFormulasPluginPrivate::cu_f, CuFormulasPluginPrivate::err, CuFormulasPluginPrivate::patterns, and CuFormulasPluginPrivate::reader_f.

◆ ~CuFormulaPlugin()

CuFormulaPlugin::~CuFormulaPlugin ( )

virtual

References CuFormulasPluginPrivate::cu_f, and CuFormulasPluginPrivate::reader_f.

Member Function Documentation

◆ addSrcPattern()

void CuFormulaPlugin::addSrcPattern ( const std::string & pattern )

Parameters

pattern a new pattern to be added to the source patterns for the formula plugin

Note: The default pattern is *formula:// *

References CuFormulasPluginPrivate::patterns.

◆ error()

bool CuFormulaPlugin::error ( ) const

References CuFormulasPluginPrivate::err.

◆ getCumbia()

Cumbia * CuFormulaPlugin::getCumbia ( ) const

References CuFormulasPluginPrivate::cu_f.

◆ getFormulaParserInstance()

CuFormulaParserI * CuFormulaPlugin::getFormulaParserInstance ( ) const

Returns: a new CuFormulaParser

Note: The caller acquires the ownership of the new object.

◆ getFormulaReaderFactory()

CuControlsReaderFactoryI * CuFormulaPlugin::getFormulaReaderFactory ( ) const

References CuFormulasPluginPrivate::reader_f.

◆ getName()

QString CuFormulaPlugin::getName ( ) const

◆ initialize()

void CuFormulaPlugin::initialize	(	CumbiaPool *	cu_poo,
		CuControlsFactoryPool &	fpool )

Parameters

cu_poo	the application wide pointer to CumbiaPool
fpool	the application wide (non const) reference to CuControlFactoryPool

After plugin initialization, both pools will have the formula domain registered with the cuformula patterns (formula:// prefix).

Important note 1: CuFormulaPlugin::initialize shall be called before any source setup, so that the application wide pools will contain the formula domain with the necessary factories.

Important note 2: cu_poo and fpool shall be initialized with all other desired engines before this call.

References CuFormulasPluginPrivate::cu_f, CuFormulasPluginPrivate::patterns, and CuFormulasPluginPrivate::reader_f.

◆ message()

std::string CuFormulaPlugin::message ( ) const

References CuFormulasPluginPrivate::msg.

◆ srcPatterns()

std::vector< std::string > CuFormulaPlugin::srcPatterns ( ) const

Returns: the list of patterns

Default pattern: The default pattern for a CuFormulaPlugin source is *formula:// *