rwtMakeFunctor2


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

rwtMakeFunctor2()
rwtMakeFunctor2G()

rwtMakeFunctor2GA1()
rwtMakeFunctor2GA2()

rwtMakeFunctor2M()
rwtMakeFunctor2MA1()

rwtMakeFunctor2MA2()

Package

Functor

Header File

#include <rw/functor/functor2.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 rwtMakeFunctor2 functions and macros are provided to construct functors based on the RWTFunctor2<S1,S2> class. The RWTFunctor2<S1,S2> class acts as the handle for a family of functor implementation classes based on the RWTFunctor2Imp<S1,S2> class. A functor based on RWTFunctor2<S1,S2> is invoked with two arguments and returns no value, but the implementation classes can accept functions with up to two additional arguments and any return type. 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 rwtMakeFunctor2 function or macro instantiates and constructs an appropriate functor implementation class instance and returns an RWTFunctor2<S1,S2> handle that is bound to that instance.

rwtMakeFunctor2 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 rwtMakeFunctor2, 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 additional arguments. Otherwise we add one of A1 or A2 for functions with 1 or 2 additional arguments respectively. For example, you will use macro rwtMakeFunctor2G to create a functor that calls a global function that takes no additional arguments. The macro rwtMakeFunctor2MA2 will create a functor that calls a member function that takes two additional arguments.

Example Using Templates

class A {
public:
  int bar(char,int);  // Member function with 2 args 
                      // (no additional)
};


A a;                  // an instance of class A

float s1;
int   s2;

char  c1, c2;

// Global function with 3 args (1 additional):
int foo(double, long, char); 

// Create an rwTFunctor2 set to call foo(s1,s2,11):
RWTFunctor2<float,int> t1 
      = rwtMakeFunctor2((void(*)(float,int))NULL, foo, 11);

// Create an rwTFunctor2 set to call a.bar(c1,c2):
RWTFunctor2<char,char> t2 
      = rwtMakeFunctor2((void(*)(char,char))NULL, a, &A::bar);

s1 = 3.14; s2 = 1.41;
c1 = 'x';  c2 = 'y';

t1(s1,s2);              // calls foo(s1,s2,11);
t2(c1,c2);              // calls a.bar(c1,c2);

Example Using Macros

class A {
public:
  int bar(char,int);    // Member function with 2 args 
                        // (no additional)
};

A a;                    // an instance of class A

float s1;
int   s2;

char  c1, c2;

// Global function with 3 arguments (1 additional)
int foo(double, long, char);  

// Create an rwTFunctor2 set to call foo(s1,s2,11):
RWTFunctor2<float,int> t1
  = rwtMakeFunctor2GA1(float,int,int,foo,double,long,char,11);

// Create an rwTFunctor2 set to call a.bar(c1,c2):
RWTFunctor2<char,char> t2
  = rwtMakeFunctor2M(char,char,A,a,int,&A::bar,char,int);

s1 = 3.14; s2 = 1.41;
c1 = 'x';  c2 = 'y';

t1(s1,s2);  // calls foo(s1,s2,11);
t2(c1,c2);  // calls a.bar(c1,c2);

Global Function Templates

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

s1 and s2 refer to the arguments passed when invoking the functor via RWTFunctor2<S1,S2>::operator()(S1,S2). These arguments will be passed through to the associated function.
The invokeAs parameter is used only to allow the compiler to deduce types S1 and S2. 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.
Types S1 and S2 must be convertible to D1 and D2 respectively.
Where applicable, a1 and a2 must be convertible to instances of types A1 and A2 respectively.

template <class S1, class S2, class DR, class D1, class D2>
RWTFunctor2<S1,S2> 
rwtMakeFunctor2(void (*invokeAs)(S1,S2), 
               DR (*function)(D1,D2));

Creates an RWTFunctor2<S1,S2> set to call function(s1,s2).

template <class S1, class S2, 
           class DR, class D1, class D2, class A1, class AA1>
RWTFunctor2<S1,S2> 
rwtMakeFunctor2(void (*invokeAs)(S1,S2),
               DR (*function)(D1,D2,A1), AA1 a1)

Creates an RWTFunctor2<S1,S2> set to call function(s1,s2,a1).

template <class S1, class S2, class DR, class D1, class D2, 
          class A1, class A2, class AA1, class AA2>
RWTFunctor2<S1,S2> 
rwtMakeFunctor2(void (*invokeAs)(S1,S2), 
               DR (*function)(D1,D2,A1,A2), AA1 a1, AA2 a2)

Creates an RWTFunctor2<S1,S2> set to call function(s1,s2,a1,a2).

template <class S1, class S2, 
          class Callee, class DR, class D1, class D2>
RWTFunctor2<S1,S2> 
rwtMakeFunctor2(void(*invokeAs)(S1,S2), Callee& callee,
               DR (Callee::*function)(D1,D2))

Creates an RWTFunctor2<S1,S2> set to call callee.function(s1,s2).

template <class S1, class S2, class Callee, class DR, 
          class D1, class D2, class A1, class AA1>
RWTFunctor2<S1,S2>
rwtMakeFunctor2(void(*invokeAs)(S1,S2), Callee& callee,
               DR (Callee::*function)(D1,D2,A1), AA1 a1)

Creates an RWTFunctor2<S1,S2> set to call callee.function(s1,s2,a1).

template <class S1, class S2, class Callee, 
          class DR, class D1, class D2,
          class A1, class A2, class AA1, class AA2>
RWTFunctor2<S1,S2> 
rwtMakeFunctor2(void(*invokeAs)(S1,S2), Callee& callee,
               DR (Callee::*function)(A1,A2), AA1 a1, AA2 a2)

Creates an RWTFunctor2<S1,S2> set to call callee.function(s1,s2,a1,a2).

Macros for Use With Global Functions

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

`S1`	Type name of the first argument that will be expected when invoking the functor via `RWTFunctor2<S1,S2>::operator()(S1,S2)`. `S1` must be convertible to `D1`.
`S2`	Type name of the second argument that will be expected when invoking the functor via `RWTFunctor2<S1,S2>::operator()(S1,S2)`. `S2` must be convertible to `D2`.
`DR`	Type name of the function return value.
`function`	Global function pointer.
`D1`	Type name of the first argument of the function.
`D2`	Type name of the second argument of the function.
`A1`	Type name of the first additional argument.
`a1`	Expression that can be converted to an instance of `A1`.
`A2`	Type name of the second additional argument.
`a2`	Expression that can be converted to an instance of `A2`.
`s1`	Argument of type `S1` that will be passed when invoking the functor.
`s2`	Argument of type `S2` that will be passed when invoking the functor.

rwtMakeFunctor2G(S1,S2,DR,function,D1,D2)

Creates an RWTFunctor2 set to call function(s1,s2).
function must have signature DR (*)(D1,D2).

rwtMakeFunctor2GA1(S1,S2,DR,function,D1,D2,A1,a1)

Creates an RWTFunctor2 set to call function(s1,s2,a1).
function must have signature DR (*)(D1,D2,A1).

rwtMakeFunctor2GA2(S1,S2,DR,function,D1,D2,A1,a1,A2,a2)

Creates an RWTFunctor2 set to call function(s1,s2,a1,a2).
function must have signature DR (*)(D1,D2,A1,A2).

Macros for Use With Member Functions

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

`S1`	Type name of the first argument that will be expected when invoking the functor via RWTFu`nctor2<S1,S2>::operator()(S1,S2)`; `S1` must be convertible to `D1`.
`S2`	Type name of the second argument that will be expected when invoking the functor via `RWTFunctor2<S1,S2>::operator()(S1,S2)`; `S2` must be convertible to `D2`.
`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.
`function`	Pointer to member function of class Callee.
`D1`	Type name of the first argument of the function.
`D2`	Type name of the second argument of the function.
`A1`	Type name of the first additional argument.
`a1`	Expression that can be converted to an instance of `A1`.
`A2`	Type name of the second additional argument.
`a2`	Expression that can be converted to an instance of `A2`.
`s1`	Argument of type `S1` that will be passed when invoking the functor.
`s2`	Argument of type `S2` that will be passed when invoking the functor.

rwtMakeFunctor2M(S1,S2,Callee,callee,DR,function,D1,D2)

Creates an RWTFunctor2<S1,S2> set to call callee.function(s1,s2).
function must have signature DR (Caller::*)(D1,D2).

rwtMakeFunctor2MA1(S1,S2,Callee,callee,DR,function,D1,D2,A1,a1)

Creates an RWTFunctor2<S1,S2> set to call
callee.function(s1,s2,a1). function must have signature DR (Caller::*)(D1,D2,A1).

rwtMakeFunctor2MA2(S1,S2,Callee,callee,DR,
                   function,D1,D2,A1,a1,A2,a2)

Creates an RWTFunctor2<S1,S2> set to call callee.function(s1,s2,a1,a2). function must have signature DR (Caller::*)(D1,D2,A1,A2).