passing functor as function pointer

Question

I'm trying to use a C library in a C++ app and have found my self in the following situation (I know my C, but I'm fairly new to C++). On the C side I have a collection of functions that takes a function pointer as their argument. On the C++ side I have objects with a functor which has the same signature as the function pointer needed by the C function. Is there any way to use the C++ functor as a function pointer to pass to the C function?

Answer 1

You cannot directly pass a pointer to a C++ functor object as a function pointer to C code (or even to C++ code).

Additionally, to portably pass a callback to C code it needs to be at least declared as an extern "C" non-member function. At least, because some APIs require specific function call conventions and thus additional declaration modifiers.

In many environments C and C++ have the same calling conventions and differ only in name mangling, so any global function or static member will work. But you still need to wrap the call to operator() in a normal function.

• If your functor has no state (it is an object just to satisfy some formal requirements etc):

  class MyFunctor {
    // no state
   public:
    MyFunctor();
    int operator()(SomeType &param) const;
  }
  

  you can write a normal extern "C" function which creates the functor and executes its operator().

  extern "C" int MyFunctorInC(SomeType *param)
  {
    static MyFunctor my_functor;
    return my_functor(*param);
  }
  

• If your functor has state, eg:

  class MyFunctor {
    // Some fields here;
   public:
    MyFunctor(/* some parameters to set state */);
    int operator()(SomeType &param) const;
    // + some methods to retrieve result.
  }
  

  and the C callback function takes some kind of user state parameter (usually void *):

  void MyAlgorithmInC(SomeType *arr,
                      int (*fun)(SomeType *, void *),
                      void *user_state);
  

  you can write a normal extern "C" function which casts its state parameter to your functor object:

  extern "C" int MyFunctorInC(SomeType *param, void *user_state)
  {
    MyFunctor *my_functor = (MyFunctor *)user_state;
    return (*my_functor)(*param);
  }
  

  and use it like this:

  MyFunctor my_functor(/* setup parameters */);
  MyAlgorithmInC(input_data, MyFunctorInC, &my_functor);
  

• Otherwise the only normal way to do it (normal as in "without generating machine code at runtime" etc.) is to use some static (global) or thread local storage to pass the functor to an extern "C" function. This limits what you can do with your code and is ugly but will work.

Answer 2

I found this "gem" using google. Apparently possible but I sure wouldn't recommend it. Direct link to example source code.

Answer 3

No, of course. The signature of your C function take an argument as function.

void f(void (*func)())
{
  func(); // Only void f1(), void F2(), ....
}

All tricks with functors are used by template functions:

template<class Func>
void f (Func func)
{
    func(); // Any functor
}

Answer 4

A C callback function written in C++ must be declared as an extern "C" function - so using a functor directly is out. You'll need to write some sort of wrapper function to use as that callback and have that wrapper call the functor. Of course, the callback protocol will need to have some way of passing context to the function so it can get to the functor, or the task becomes quite tricky. Most callback schemes have a way to pass context, but I've worked with some brain-dead ones that don't.

See this answer for some more details (and look in the comments for anecdotal evidence that the callback must be extern "C" and not just a static member function):

• C++ Using Class Method as a Function Pointer Type

Answer 5

I don't think you can: operator() in a function object is really a member function, and C doesn't know anything about those.

What you should be able to use are free C++ functions, or static functions of classes.

Answer 6

GCC allows you to convert member function pointers to plain function pointers (the first argument of the function called by the plain function pointer then is this).

Check out the respective link in the manual.

This requires the -Wno-pmf-conversions flag in order to silence the respective warning for the decidedly non-standard feature. Very convenient for interfacing C style libraries with C++ style programming. When the member function pointer is a constant, this does not even need to generate any code at all: the API would use that argument order anyway.

If you already have a functor, flattening the functor in that manner will likely mean flattening its operator(), giving you a function that has to be called with a functor class pointer itself as its first argument. Which does not necessarily help all that much but at least has C linkage.

But at least when you are not going through functors this is helpful and provides a no-nonsense C linkage replacement for std::mem_fn from <functional>.

Answer 7

It depends if this is a static or instance method, if it is static then you can pass through the function as className::functionName, if it is an instance method it is fair more complicated, because you obviously need to tie to a certain instance but can't do it in the same way as you would with delegates in C# etc.

The best way I've found of doing this is to create a holding class which is instantiated with the instance of the object as well as the function pointer, the holding class can then invoke the function directly.

Answer 8

I would say no, because a C++ functor has an overloaded operator () which is a member function, and would thus require a member function pointer. This is a totally different data type than a normal C function pointer, since it cannot be invoked without an instance of the class. You'd need to pass a normal function or a static member function to the C library. Since an overloaded () operator can't be static, you can't do it. You'd need to pass the C-library a normal, non-member function or static member function, from which you can then invoke the C++ functor.

Answer 9

Hm, maybe you could write a free template function that wraps around your function-objects. If they all have the same signature, this should work. Like this (not tested):

template<class T>
int function_wrapper(int a, int b) {
    T function_object_instance;

    return funcion_object_instance( a, b );
}

This would do for all function that take two ints and return an int.

Answer 10

Many C APIs that take function pointer callbacks have a void* parameter for user state. If you've got one of those, you're in luck - you can use an exterm C function that treats the user data as some sort of reference or key to lookup the functor, then execute it.

Otherwise, no.