rwtMakeFunctorR0


Global Functions and Macros

Data Type and Member Function Indexes
Package
Header File
Description
Example Using Templates
Example Using Macros
Global Function Templates
Macros for Use With
Global Functions
Macros for Use With Member Functions
See Also

Data Type and Member Function Indexes
(exclusive of constructors and destructors)

Member Functions

rwtMakeFunctorR0()
rwtMakeFunctorR0G()
rwtMakeFunctorR0GA1()

rwtMakeFunctorR0GA2()
rwtMakeFunctorR0GA3()
rwtMakeFunctorR0M()

rwtMakeFunctorR0MA1()
rwtMakeFunctorR0MA2()
rwtMakeFunctorR0MA3()

Package

Functor

Header File

#include <rw/functor/functorR0.h>

Description

A function object, or functor, is an object that encapsulates a call to an associated global or member function. When a functor is invoked, it calls the associated function.

The rwtMakeFunctorR0 functions and macros are provided to construct functors based on the RWTFunctorR0<SR> class. The RWTFunctorR0<SR> class acts as the handle for a family of functor implementation classes based on the RWTFunctorR0Imp<SR> class. A functor based on RWTFunctorR0<SR> is invoked with no arguments and returns a value of type SR, but the implementation classes can accept functions with up to three arguments. The values for the additional arguments are defined when an implementation class instance is constructed, and are passed to the function each time the functor is invoked.

Each rwtMakeFunctorR0 function or macro instantiates and constructs an appropriate functor implementation class instance and returns an RWTFunctorR0<SR> handle that is bound to that instance.

rwtMakeFunctorR0 comes in two flavors. First, there is a set of overloaded global function templates. Since not all compilers are able to handle templates to the degree required by these functions, we also provide a corresponding set of macros. The template functions are slightly easier to use and you only have to remember one name. The macros are more portable but they do require more arguments; and because we cannot overload macros, each must have a unique name.

In naming the macros we have employed a convention to make the names easier to remember. Each name begins with rwtMakeFunctorR0, which will be followed by either a G if the macro is expecting a global function, or an M if it is expecting a member function. At that point the name is complete if the associated global or member function takes no arguments. Otherwise we add one of A1, A2, or A3 for functions with 1, 2, or 3 arguments respectively. For example, you will use macro rwtMakeFunctorR0G to create a functor that calls a global function that takes no arguments. The macro rwtMakeFunctorR0MA2 will create a functor that calls a member function that takes two arguments.

Example Using Templates

#include <rw/functor/functorR0.h>

class A {
public:
  int bar(char);         // Member function with 1 argument
};

int main()
{
  A a;                    // an instance of class A
  
  int foo(double, long);  // Global function with 2 arguments
  
  // Create an RWTFunctorR0 set to call foo(3.14,11):
  RWTFunctorR0<int> t1 
        = rwtMakeFunctorR0((int(*)(void))NULL, foo, 3.14, 11);
  
  // Create an RWTFunctorR0 set to call a.bar('x'):
  RWTFunctorR0<int> t2 
        = rwtMakeFunctorR0((int(*)(void))NULL, a, &A::bar, 'x');

  int result1 = t1();
  int result2 = t2();
}

Example Using Macros

#include <rw/functor/functorR0.h>

class A {
public:
  int bar(char);  // Member function with 1 argument
};

int main()
{
  A a;  // an instance of class A
  
  int foo(double, long);  // Global function with 2 arguments
  
  // Create an RWTFunctorR0 set to call foo(3.14,11):
  RWTFunctorR0<int> t1
    = rwtMakeFunctorR0GA2(int, int, foo, double, 3.14, long, 11);
  
  // Create an RWTFunctorR0 set to call a.bar('x'):
  RWTFunctorR0<int> t2
    = rwtMakeFunctorR0MA1(int, A, a, int, &A::bar, char, 'x');

  int result1 = t1();
  int result2 = t2();
}

Global Function Templates

The following information applies to each of the function templates in this section:

The invokeAs parameter is used only to allow the compiler to deduce type SR. You may use any function with an appropriate signature or simply pass a NULL pointer cast to the appropriate type as done in the example above.
DR must be convertible to SR.
Where applicable, a1, a2 and a3 must be convertible to instances of types A1, A2 and A3 respectively.

template <class SR, class DR>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), DR (*function)(void));

Creates an RWTFunctorR0<SR> set to call function().

template <class SR, class DR, class A1, class AA1>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), DR (*function)(A1), 
                AA1 a1)

Creates an RWTFunctorR0<SR> set to call function(a1).

template <class SR, class DR, 
           class A1, class A2, class AA1, class AA2>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), 
                DR (*function)(A1,A2), AA1 a1, AA2 a2)

Creates an RWTFunctorR0<SR> set to call function(a1,a2).

template <class SR, class DR, class A1, class A2, class A3, 
          class AA1, class AA2, class AA3>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), 
                DR (*function)(A1,A2,A3), 
                AA1 a1, AA2 a2,AA3 a3)

Creates an RWTFunctorR0<SR> set to call function(a1,a2,a3).

template <class SR, class Callee, class DR>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), Callee& callee,
                DR (Callee::*function)(void))

Creates an RWTFunctorR0<SR> set to call callee.function().

template <class SR, class Callee, class DR, 
          class A1, class AA1>
RWTFunctorR0<SR>
rwtMakeFunctorR0(SR (*invokeAs)(void), Callee& callee,
                DR (Callee::*function)(A1), AA1 a1)

Creates an RWTFunctorR0<SR> set to call callee.function(a1).

template <class SR, class Callee, class DR, class A1, 
          class A2, class AA1, class AA2>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR (*invokeAs)(void), Callee& callee,
                DR (Callee::*function)(A1,A2), AA1 a1, AA2 a2)

Creates an RWTFunctorR0<SR> set to call callee.function(a1,a2).

template <class SR, class Callee, class DR, 
          class A1, class A2, class A3,
          class AA1, class AA2, class AA3>
RWTFunctorR0<SR> 
rwtMakeFunctorR0(SR(*invokeAs)(void), Callee& callee, 
                DR (Callee::*function)(A1,A2,A3), 
                AA1 a1, AA2 a2, AA3 a3)

Creates an RWTFunctorR0<SR> set to call callee.function(a1,a2,a3).

Macros for Use With
Global Functions

The macros in this section use the following naming conventions for the macro arguments:

`SR`	Actual type name to be used to instantiate the `RWTFunctorR0`.
`DR`	Type name of the function return value. `DR` must be convertible to `SR`.
`function`	Global function pointer.
`A1`	Type name of the first argument.
`a1`	Expression that can be converted to an instance of `A1`.
`A2`	Type name of the second argument.
`a2`	Expression that can be converted to an instance of `A2`.
`A3`	Type name of the third argument.
`a3`	Expression that can be converted to an instance of `A3`.

rwtMakeFunctorR0G(SR,DR,function)

Creates an RWTFunctorR0<SR> set to call function().
function must have signature DR (*)(void).

rwtMakeFunctorR0GA1(SR,DR,function,A1,a1)

Creates an RWTFunctorR0<SR> set to call function(a1).
function must have signature DR (*)(A1).

rwtMakeFunctorR0GA2(SR,DR,function,A1,a1,A2,a2)

Creates an RWTFunctorR0<SR> set to call function(a1,a2).
function must have signature DR (*)(A1,A2).

rwtMakeFunctorR0GA3(SR,DR,function,A1,a1,A2,a2,A3,a3)

Creates an RWTFunctorR0<SR> set to call function(a1,a2,a3).
function must have signature DR (*)(A1,A2,A3).

Macros for Use With Member Functions

The macros in this section use the following naming conventions for the macro arguments:

`SR`	The actual type name to be used to instantiate the `RWTFunctorR0`.
`Callee`	Type name of the function's class.
`callee`	Expression that results in a reference to a `Callee` instance.
`DR`	Type name of the function return value. `DR` must be convertible to `SR`.
`function`	Pointer to member function of class `Callee`.
`A1`	Type name of the first argument.
`a1`	Expression that can be converted to an instance of `A1`.
`A2`	Type name of the second argument.
`a2`	Expression that can be converted to an instance of `A2`.
`A3`	Type name of the second argument.
`a3`	Expression that can be converted to an instance of `A3`.

rwtMakeFunctorR0M(SR,Callee,callee,DR,function)

Creates an RWTFunctorR0<SR> set to call callee.function().
function must have signature DR (Caller::*)(void).

rwtMakeFunctorR0MA1(SR,Callee,callee,DR,function,A1,a1)

Creates an RWTFunctorR0<SR> set to call callee.function(a1).
function must have signature DR (Caller::*)(A1).

rwtMakeFunctorR0MA2(SR,Callee,callee,DR,function,A1,a1,A2,a2)

Creates an RWTFunctorR0<SR> set to call callee.function(a1,a2).
function must have signature DR (Caller::*)(A1,A2).

rwtMakeFunctorR0MA3(SR,Callee,callee,DR,function,
                   A1,a1,A2,a2,A3,a3)

Creates an RWTFunctorR0<SR> set to call callee.function(a1,a2,a3).
function must have signature DR (Caller::*)(A1,A2,A3).