faudes::FunctionDefinition Class Reference

Detailed Description

A FunctionDefinition defines the interface to a faudes-function. The latter consists of a descriptive name to identify the function and a list of Signatures the function can operate on. Technically, the class FunctionDefinition is derived from Documentation and thereby inherits members for additional documentation-data.

Similar to Type and TypeDefinition, a FunctionDefinition uses a prototype object to provide the method NewFunction() which instantiates the corresponding Function object.

FunctionDefinition inherits the token io interface from Type, however, the class is not intended to register as a faudes type. The token io format is demonstrated by the following example:

<FunctionDefinition name="CoreFaudes::IntegerSum" ctype="faudes::IntegerSum">
 
<Documentation ref="integersum.html">
Returns the sum of integer arguments. 
<Documentation/>
 
<Keywords> "integer" "elemetary types" </Keywords>
 
<VariantSignatures>
 
<Signature name="Two arguments">
<Parameter name="Arg1" ftype="Integer" access="In">
<Parameter name="Arg2" ftype="Integer" access="In">
<Parameter name="Res"  ftype="Integer" access="Out" creturn="true">
</Signature>
 
<Signature name="Three arguments">
<Parameter name="Arg1" ftype="Integer" access="In">
<Parameter name="Arg2" ftype="Integer" access="In">
<Parameter name="Arg3" ftype="Integer" access="In">
<Parameter name="Res"  ftype="Integer" access="Out" creturn="true">
</Signature>
 
</VariantSignatures>
 
</FunctionDefinition>

Definition at line 419 of file cfl_functions.h.

#include <cfl_functions.h>

Public Member Functions
	FunctionDefinition (const std::string &name="")
	FunctionDefinition (const FunctionDefinition &rSrc)
virtual	~FunctionDefinition ()
virtual void	Clear (void)
virtual void	ClearVariants (void)
const Function *	Prototype (void) const
Function *	NewFunction () const
int	VariantsSize (void) const
bool	ExistsVariant (const std::string &varname) const
int	VariantIndex (const std::string &rName) const
const Signature &	Variant (const std::string &rName) const
const Signature &	Variant (int n) const
virtual void	AppendVariant (const Signature &pVar)
Public Member Functions inherited from faudes::Documentation
	Documentation (void)
	Documentation (const Documentation &rOther)
virtual	~Documentation (void)
const std::string &	Name (void) const
const std::string &	PlugIn (void) const
const std::string &	CType (void) const
const std::string &	TextDoc (void) const
const std::string &	HtmlDoc (void) const
const std::string &	Keywords (void) const
std::string	MatchKeyword (const std::string &rPattern) const
int	KeywordsSize (void) const
std::string	KeywordAt (int pos) const
bool	AutoRegistered (void) const
bool	ApplicationRegistered (void) const
virtual void	MergeDocumentation (TokenReader &rTr)
Type &	operator= (const Type &rSrc)
Type &	operator= (Type &&rSrc)
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
Public Member Functions inherited from faudes::Type
	Type (void)
	Type (const Type &rType)
virtual	~Type (void)
virtual Type *	New (void) const
virtual Type *	NewCpy (void) const
virtual const Type *	Cast (const Type *pOther) const
virtual bool	IsDefault (void) const
virtual Type &	Copy (const Type &rSrc)
virtual Type &	Move (Type &rSrc)
Type &	operator= (const Type &rSrc)
Type &	operator= (Type &&rSrc)
virtual bool	Equal (const Type &rOther) const
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
virtual const std::string &	TypeName (void) const
void	Write (const Type *pContext=0) const
void	Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
void	Write (const std::string &pFileName, std::ios::openmode openmode) const
void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
void	XWrite (const Type *pContext=0) const
void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
void	DWrite (const Type *pContext=0) const
void	DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
void	SWrite (TokenWriter &rTw) const
void	SWrite (void) const
std::string	ToSText (void) const
void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Static Public Member Functions
template<class T >
static FunctionDefinition *	Constructor (const std::string &rFunctName="")
template<class T >
static FunctionDefinition *	FromFile (const std::string &rFileName)

Protected Member Functions
void	DoCopy (const FunctionDefinition &rSrc)
bool	DoEqual (const FunctionDefinition &rOther) const
virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
virtual void	DoReadCore (TokenReader &rTr)
virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoWriteCore (TokenWriter &rTw) const
virtual void	Prototype (Function *pFunc)
Protected Member Functions inherited from faudes::Documentation
void	Name (const std::string &name)
void	PlugIn (const std::string &plugin)
void	CType (const std::string &name)
void	TextDoc (const std::string &textdoc)
void	AutoRegistered (bool flag)
void	ApplicationRegistered (bool flag)
void	HtmlDoc (const std::string &fname)
void	AddKeyword (const std::string &rKeyword)
void	DoCopy (const Documentation &rSrc)
bool	DoEqual (const Documentation &rOther) const
Protected Member Functions inherited from faudes::Type
void	DoCopy (const Type &rSrc)
void	DoMove (Type &rSrc)
bool	DoEqual (const Type &rOther) const
virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoSWrite (TokenWriter &rTw) const
virtual const TypeDefinition *	TypeDefinitionp (void) const
virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Protected Attributes
Function *	mpFunction
std::vector< faudes::Signature >	mVariants
std::map< std::string, int >	mVariantIndexMap
Protected Attributes inherited from faudes::Documentation
std::string	mName
std::string	mPlugIn
std::string	mCType
std::string	mTextDoc
std::string	mHtmlDoc
std::string	mKeywords
bool	mAutoRegistered
bool	mApplicationRegistered

Additional Inherited Members
Static Protected Attributes inherited from faudes::Documentation
static const char	mDelim = ';'

Constructor & Destructor Documentation

FunctionDefinition() [1/2]

faudes::FunctionDefinition::FunctionDefinition

(

const std::string &

name = ""

)

Constructor

The default constructor instantiates an invalid function definition without prototype. To construct a valid function definition, use the static Constructor() template function.

Definition at line 358 of file cfl_functions.cpp.

FunctionDefinition() [2/2]

faudes::FunctionDefinition::FunctionDefinition

(

const FunctionDefinition &

rSrc

)

Copy Constructor

The copy constructor copies all members one-to-one, except for the prototype object. The latter is re-created using its factory function.

Definition at line 366 of file cfl_functions.cpp.

~FunctionDefinition()

virtual faudes::FunctionDefinition::~FunctionDefinition ( )

inlinevirtual

Destructor

Definition at line 450 of file cfl_functions.h.

Member Function Documentation

AppendVariant()

void faudes::FunctionDefinition::AppendVariant ( const Signature &  pVar )

virtual

Add Signature to function definition.

Parameters

pVar	Signature to insert

Exceptions

Exception

Signature with same name exists (id 47)

Definition at line 460 of file cfl_functions.cpp.

Clear()

void faudes::FunctionDefinition::Clear ( void  )

virtual

Clear documentation-data and signature (keep prototype)

Reimplemented from faudes::Documentation.

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 399 of file cfl_functions.cpp.

ClearVariants()

void faudes::FunctionDefinition::ClearVariants ( void  )

virtual

Clear variants (keep docu and prototype)

Definition at line 409 of file cfl_functions.cpp.

Constructor()

template<class T >

FunctionDefinition * faudes::FunctionDefinition::Constructor ( const std::string &  rFunctName = "" )

static

Construct empty FunctionDefinition object. The given template parameter denotes a Function class. Member variable (mpFunction) is set to a new instance of that class whereas the name is set as specified. No further documentation or signatures are recorded.

Template Parameters

T	Actual function class, derived from Function

Parameters

rFunctName

Name to identify this faudes-function

Returns

Newly constructed function definition.

Definition at line 1046 of file cfl_functions.h.

DoCopy()

void faudes::FunctionDefinition::DoCopy ( const FunctionDefinition &  rSrc )

protected

Std faudes type interface: assignment.

Parameters

rSrc	Source to copy from

Definition at line 374 of file cfl_functions.cpp.

DoEqual()

bool faudes::FunctionDefinition::DoEqual ( const FunctionDefinition &  rOther ) const

protected

Std faudes type interface: test equality

Parameters

rOther

Other object to compare with.

Returns

True on match.

Definition at line 390 of file cfl_functions.cpp.

DoRead()

void faudes::FunctionDefinition::DoRead ( TokenReader &  rTr, const std::string &  rLabel = "", const Type *  pContext = 0  )

protectedvirtual

Read configuration data of this object from TokenReader. Actual reading is done by DoReadCore.

The section defaults to "FunctionDefinition", context ignored.

Parameters

rTr	TokenReader to read from
rLabel	Section to read
pContext	Read context to provide contextual information (ignored)

Exceptions

Exception

Token mismatch (id 50, 51, 52) IO error (id 1)

Reimplemented from faudes::Documentation.

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 499 of file cfl_functions.cpp.

DoReadCore()

void faudes::FunctionDefinition::DoReadCore ( TokenReader &  rTr )

protectedvirtual

Read configuration data of this object from TokenReader.

This method reads members only, it does not read the section.

Parameters

rTr	TokenReader to read from

Exceptions

Exception

Token mismatch (id 50, 51, 52) IO error (id 1)

Reimplemented from faudes::Documentation.

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 512 of file cfl_functions.cpp.

DoWrite()

void faudes::FunctionDefinition::DoWrite ( TokenWriter &  rTw, const std::string &  rLabel = "", const Type *  pContext = 0  ) const

protectedvirtual

Write configuration data of this object to TokenWriter.

The section defaults to "FunctionDefinition", context ignored.

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Documentation.

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 531 of file cfl_functions.cpp.

DoWriteCore()

void faudes::FunctionDefinition::DoWriteCore ( TokenWriter &  rTw ) const

protectedvirtual

Write configuration data of this object to TokenWriter.

This method writes plain member data, the section lables are not written.

Parameters

rTw	Reference to TokenWriter

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Documentation.

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 540 of file cfl_functions.cpp.

ExistsVariant()

bool faudes::FunctionDefinition::ExistsVariant

(

const std::string &

varname

)

const

Test existence of variant by its name.

Returns

True if variant exists

Definition at line 448 of file cfl_functions.cpp.

FromFile()

template<class T >

FunctionDefinition * faudes::FunctionDefinition::FromFile ( const std::string &  rFileName )

static

Construct FunctionDefinition object and get name and docu from file.

The member variable mpFunction is set to a new instance of class T. which must be derived from Function. The function name, any documentation as well as supported signatures are read from the specified file.

Template Parameters

T	Actual function class, derived from Function

Parameters

rFileName

File to read documentation and signatures from.

Returns

Newly constructed function definition.

Definition at line 1063 of file cfl_functions.h.

NewFunction()

Function * faudes::FunctionDefinition::NewFunction

(

)

const

Construct function on heap. Return pointer to new instance of assigned Function class.

Note: If no prototype is installed, NULL is returned.

Returns

Pointer to new Function instance.

Definition at line 435 of file cfl_functions.cpp.

Prototype() [1/2]

void faudes::FunctionDefinition::Prototype ( Function *  pFunc )

protectedvirtual

Copy prototype object

Parameters

pFunc

Function instance

Reimplemented in faudes::LuaFunctionDefinition.

Definition at line 423 of file cfl_functions.cpp.

Prototype() [2/2]

const Function * faudes::FunctionDefinition::Prototype

(

void

)

const

Return pointer to function object prototype

Note: this method is meant for inspection only, control over the prototype remains with the FunctionDefinition. Use NewFunction() to instantiate a new function object.

Returns

Reference to prototype function.

Definition at line 418 of file cfl_functions.cpp.

Variant() [1/2]

const Signature & faudes::FunctionDefinition::Variant

(

const std::string &

rName

)

const

Return reference to Signature by name.

Parameters

rName

Name of signature to search.

Returns

Reference to Signature

Exceptions

Exception

No such signature (id 47)

Definition at line 475 of file cfl_functions.cpp.

Variant() [2/2]

const Signature & faudes::FunctionDefinition::Variant

(

int

n

)

const

Return reference to Signature by index.

Parameters

n	Index to look up

Returns

Reference to Signature

Exceptions

Exception

Index out of range (id 47)

Definition at line 487 of file cfl_functions.cpp.

VariantIndex()

int faudes::FunctionDefinition::VariantIndex

(

const std::string &

rName

)

const

Return index of Signature by name.

Parameters

rName

Name of signature to search.

Returns

Index of signature, or -1 if not existant

Definition at line 453 of file cfl_functions.cpp.

VariantsSize()

int faudes::FunctionDefinition::VariantsSize

(

void

)

const

Return number of supported Signature instances.

Returns

Size of signature vector.

Definition at line 443 of file cfl_functions.cpp.

Member Data Documentation

mpFunction

Function* faudes::FunctionDefinition::mpFunction

protected

Prototype instance

Definition at line 675 of file cfl_functions.h.

mVariantIndexMap

std::map<std::string,int> faudes::FunctionDefinition::mVariantIndexMap

protected

Variant name to index map

Definition at line 681 of file cfl_functions.h.

mVariants

std::vector<faudes::Signature> faudes::FunctionDefinition::mVariants

protected

Vector containing all supported Signatures

Definition at line 678 of file cfl_functions.h.

---

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

• cfl_functions.h
• cfl_functions.cpp