Cantera
3.1.0a1
|
Delegate member functions of a C++ class to externally-specified functions. More...
#include <Delegator.h>
Delegate member functions of a C++ class to externally-specified functions.
This base class provides functions for setting delegates for the member functions of a C++ class at runtime. The purpose of this capability is to allow the class to be extended using functions defined in any programming language that provides a C API for calling functions in that language.
Delegates are specified as std::function
objects that are responsible for encapsulating the data specific to the target language and calling the appropriate function in the target language. The std::function
has a modified function signature compared to the method that it is replacing or augmenting:
int
. The delegate should return zero if it does not set the arguments value, and a non-zero value if it does.std::array<size_t, N>
where N is the number of array arguments.Delegated methods can be specified to either "replace" the original class's method, or to run "before" or "after" the original method, using the when
parameter of the setDelegate
method. There are two special cases for delegates of methods with return values:
+
operator for the return type, for example addition for numeric types or concatenation for strings.Several functions and member variables are defined in this base class for each distinct function signature that can be delegated by a derived class such as ReactorDelegator. These are:
install
function stores the address of a function that will be called by a derived delegator class in the corresponding m_funcs_...
map, and sets the default implementation of this method (which should be to call the base class implementation). For delegates with a return type, a copy of this default implementation is also stored in the corresponding m_base_...
mapsetDelegate
function wraps the user-provided delegate in a function that handles whether the delegate is to be called before, after, or instead of the base class's implementation. This function is then stored at the address specified in the corresponding m_funcs_...
map.m_funcs_...
is a mapping between member function names and the addresses of the functions that will be called to implement these functions in the derived delegator class.m_base_...
is a mapping between member function names and the default implementations of these member functions, for delegates with return valuesAdditional implementation for each function type is specific to the programming language that the delegate is written in. For the Python delegates, see additional documentation in delegator.pyx
.
Beyond the implementation of particular function signatures, there are no elements of the Delegator class that are specific to individual delegated functions, which are handled by derived classes such as ReactorDelegator, which will also inherit from another base class such as Reactor.
Delegation of a member function (for example, Reactor::eval
) is handled by several elements:
std::function
member variable to hold a delegate function, or its default implementation. This function type includes the additional std::array
argument of array sizes for functions with array arguments.install
from the constructor of the derived delegator class, which takes the member function name, a reference to the std::function
member variable described above, and a lambda function that implements the default behavior, that is, calling the equivalent base class method.Additional implementation for each function is specific to the programming language that the delegate is written in. For Python delegates, see additional documentation in delegator.pyx
.
Definition at line 103 of file Delegator.h.
Public Member Functions | |
string | delegatorName () const |
Get the name of the user-defined class in the extension language. More... | |
void | setDelegatorName (const string &delegatorName) |
Set the name of the user-defined class in the extension language. More... | |
void | setDelegate (const string &name, const function< void()> &func, const string &when) |
Set delegates for member functions with the signature void() . More... | |
void | setDelegate (const string &name, const function< void(bool)> &func, const string &when) |
set delegates for member functions with the signature void(bool) More... | |
void | setDelegate (const string &name, const function< void(double)> &func, const string &when) |
set delegates for member functions with the signature void(double) More... | |
void | setDelegate (const string &name, const function< void(AnyMap &)> &func, const string &when) |
set delegates for member functions with the signature void(AnyMap&) More... | |
void | setDelegate (const string &name, const function< void(const AnyMap &, const UnitStack &)> &func, const string &when) |
set delegates for member functions with the signature void(AnyMap&, UnitStack&) More... | |
void | setDelegate (const string &name, const function< void(const string &, void *)> &func, const string &when) |
set delegates for member functions with the signature void(const string&, void*) More... | |
void | setDelegate (const string &name, const function< void(std::array< size_t, 1 >, double *)> &func, const string &when) |
Set delegates for member functions with the signature void(double*) More... | |
void | setDelegate (const string &name, const function< void(std::array< size_t, 1 >, double, double *)> &func, const string &when) |
Set delegates for member functions with the signature void(double, double*) More... | |
void | setDelegate (const string &name, const function< void(std::array< size_t, 2 >, double, double *, double *)> &func, const string &when) |
Set delegates for member functions with the signature void(double, double*, double*) More... | |
void | setDelegate (const string &name, const function< void(std::array< size_t, 3 >, double *, double *, double *)> &func, const string &when) |
Set delegates for member functions with the signature void(double*, double*, double*) More... | |
void | setDelegate (const string &name, const function< int(double &, void *)> &func, const string &when) |
set delegates for member functions with the signature double(void*) More... | |
void | setDelegate (const string &name, const function< int(string &, size_t)> &func, const string &when) |
Set delegates for member functions with the signature string(size_t) More... | |
void | setDelegate (const string &name, const function< int(size_t &, const string &)> &func, const string &when) |
Set delegates for member functions with the signature size_t(string) More... | |
void | holdExternalHandle (const string &name, const shared_ptr< ExternalHandle > &handle) |
Store a handle to a wrapper for the delegate from an external language interface. More... | |
shared_ptr< ExternalHandle > | getExternalHandle (const string &name) const |
Get the handle for a wrapper for the delegate from the external language interface specified by name. More... | |
Protected Member Functions | |
void | install (const string &name, function< void()> &target, const function< void()> &func) |
Install a function with the signature void() as being delegatable. More... | |
void | install (const string &name, function< void(bool)> &target, const function< void(bool)> &func) |
Install a function with the signature void(bool) as being delegatable. More... | |
void | install (const string &name, function< void(double)> &target, const function< void(double)> &func) |
Install a function with the signature void(double) as being delegatable. More... | |
void | install (const string &name, function< void(AnyMap &)> &target, const function< void(AnyMap &)> &func) |
Install a function with the signature void(AnyMap&) as being delegatable. More... | |
void | install (const string &name, function< void(const AnyMap &, const UnitStack &)> &target, const function< void(const AnyMap &, const UnitStack &)> &func) |
Install a function with the signature void(const AnyMap&, const UnitStack&) as being delegatable. More... | |
void | install (const string &name, function< void(const string &, void *)> &target, const function< void(const string &, void *)> &func) |
Install a function with the signature `void(const string&, void*) as being delegatable. More... | |
void | install (const string &name, function< void(std::array< size_t, 1 >, double *)> &target, const function< void(std::array< size_t, 1 >, double *)> &func) |
Install a function with the signature void(double*) as being delegatable. More... | |
void | install (const string &name, function< void(std::array< size_t, 1 >, double, double *)> &target, const function< void(std::array< size_t, 1 >, double, double *)> &func) |
Install a function with the signature void(double, double*) as being delegatable. More... | |
void | install (const string &name, function< void(std::array< size_t, 2 >, double, double *, double *)> &target, const function< void(std::array< size_t, 2 >, double, double *, double *)> &func) |
Install a function with the signature void(double, double*, double*) as being delegatable. More... | |
void | install (const string &name, function< void(std::array< size_t, 3 >, double *, double *, double *)> &target, const function< void(std::array< size_t, 3 >, double *, double *, double *)> &base) |
Install a function with the signature void(double*, double*, double*) as being delegatable. More... | |
void | install (const string &name, function< double(void *)> &target, const function< double(void *)> &func) |
Install a function with the signature double(void*) as being delegatable. More... | |
void | install (const string &name, function< string(size_t)> &target, const function< string(size_t)> &base) |
Install a function with the signature string(size_t) as being delegatable. More... | |
void | install (const string &name, function< size_t(const string &)> &target, const function< size_t(const string &)> &base) |
Install a function with the signature size_t(string) as being delegatable. More... | |
template<typename BaseFunc , class ... Args> | |
function< void(Args ...)> | makeDelegate (const function< void(Args ...)> &func, const string &when, BaseFunc base) |
Create a delegate for a function with no return value. More... | |
template<typename ReturnType , class ... Args> | |
function< ReturnType(Args ...)> | makeDelegate (const string &name, const function< int(ReturnType &, Args ...)> &func, const string &when, const function< ReturnType(Args ...)> &base) |
Create a delegate for a function with a return value. More... | |
Protected Attributes | |
map< string, shared_ptr< ExternalHandle > > | m_handles |
Handles to wrappers for the delegated object in external language interfaces. More... | |
string | m_delegatorName |
Name of the class in the extension language. More... | |
Containers for delegates and base class implementations. | |
Maps named For functions with a return value, These containers use a naming scheme based on the signature of the corresponding member functions. Following the prefix | |
map< string, function< void()> * > | m_funcs_v |
map< string, function< void(bool)> * > | m_funcs_v_b |
map< string, function< void(double)> * > | m_funcs_v_d |
map< string, function< void(AnyMap &)> * > | m_funcs_v_AMr |
map< string, function< void(const AnyMap &, const UnitStack &)> * > | m_funcs_v_cAMr_cUSr |
map< string, function< void(const string &, void *)> * > | m_funcs_v_csr_vp |
map< string, function< void(std::array< size_t, 1 >, double *)> * > | m_funcs_v_dp |
map< string, function< void(std::array< size_t, 1 >, double, double *)> * > | m_funcs_v_d_dp |
map< string, function< void(std::array< size_t, 2 >, double, double *, double *)> * > | m_funcs_v_d_dp_dp |
map< string, function< void(std::array< size_t, 3 >, double *, double *, double *)> * > | m_funcs_v_dp_dp_dp |
map< string, function< double(void *)> > | m_base_d_vp |
map< string, function< double(void *)> * > | m_funcs_d_vp |
map< string, function< string(size_t)> > | m_base_s_sz |
map< string, function< string(size_t)> * > | m_funcs_s_sz |
map< string, function< size_t(const string &)> > | m_base_sz_csr |
map< string, function< size_t(const string &)> * > | m_funcs_sz_csr |
|
inline |
Get the name of the user-defined class in the extension language.
Definition at line 107 of file Delegator.h.
|
inline |
Set the name of the user-defined class in the extension language.
Definition at line 112 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature void()
.
Definition at line 117 of file Delegator.h.
|
inline |
set delegates for member functions with the signature void(bool)
Definition at line 128 of file Delegator.h.
|
inline |
set delegates for member functions with the signature void(double)
Definition at line 139 of file Delegator.h.
|
inline |
set delegates for member functions with the signature void(AnyMap&)
Definition at line 150 of file Delegator.h.
|
inline |
set delegates for member functions with the signature void(AnyMap&, UnitStack&)
Definition at line 162 of file Delegator.h.
|
inline |
set delegates for member functions with the signature void(const string&, void*)
Definition at line 177 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature void(double*)
Definition at line 189 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature void(double, double*)
Definition at line 201 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature void(double, double*, double*)
Definition at line 216 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature void(double*, double*, double*)
Definition at line 231 of file Delegator.h.
|
inline |
set delegates for member functions with the signature double(void*)
Definition at line 245 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature string(size_t)
Definition at line 257 of file Delegator.h.
|
inline |
Set delegates for member functions with the signature size_t(string)
Definition at line 270 of file Delegator.h.
|
inline |
Store a handle to a wrapper for the delegate from an external language interface.
Definition at line 283 of file Delegator.h.
|
inline |
Get the handle for a wrapper for the delegate from the external language interface specified by name.
Returns a null pointer if the requested handle does not exist.
Definition at line 291 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void()
as being delegatable.
Definition at line 301 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(bool)
as being delegatable.
Definition at line 309 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(double)
as being delegatable.
Definition at line 317 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(AnyMap&)
as being delegatable.
Definition at line 325 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(const AnyMap&, const UnitStack&)
as being delegatable.
Definition at line 334 of file Delegator.h.
|
inlineprotected |
Install a function with the signature `void(const string&, void*) as being delegatable.
Definition at line 344 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(double*)
as being delegatable.
Definition at line 352 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(double, double*)
as being delegatable.
Definition at line 361 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(double, double*, double*)
as being delegatable.
Definition at line 371 of file Delegator.h.
|
inlineprotected |
Install a function with the signature void(double*, double*, double*)
as being delegatable.
Definition at line 381 of file Delegator.h.
|
inlineprotected |
Install a function with the signature double(void*)
as being delegatable.
Definition at line 390 of file Delegator.h.
|
inlineprotected |
Install a function with the signature string(size_t)
as being delegatable.
Definition at line 398 of file Delegator.h.
|
inlineprotected |
Install a function with the signature size_t(string)
as being delegatable.
Definition at line 408 of file Delegator.h.
|
inlineprotected |
Create a delegate for a function with no return value.
Definition at line 419 of file Delegator.h.
|
inlineprotected |
Create a delegate for a function with a return value.
Definition at line 447 of file Delegator.h.
|
protected |
Handles to wrappers for the delegated object in external language interfaces.
Used to provide access to these wrappers as well as managing cleanup functions called from the destructor of the derived ExternalHandle class.
Definition at line 550 of file Delegator.h.
|
protected |
Name of the class in the extension language.
Definition at line 553 of file Delegator.h.