Utils/membind.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief membind  public header */
  25
  26 /** \defgroup membind Bound Member Functions
  27
  28     The membind() family of function templates simplifies the creation of simple bound member
  29     function pointers:
  30
  31     \code
  32       struct Foo {
  33           int test(int x);
  34       };
  35
  36       Foo * foo = ...;
  37       boost::function<int (int)> f = senf::membind(&Foo::test,foo);
  38       int rv = f(1); // Calls foo->test(1)
  39     \endcode
  40
  41     senf::membind() takes either a pointer or an object as second argument. When passing an object,
  42     <em>that object will be copied into the bound member function returned.</em>
  43
  44     \idea Make the \a ob argument type an additional P template parameter (using call_traits for the
  45     exact arg type? Probably we'll get deduction problems then) . The only operation this object
  46     must support is ob->*fn. This would allow the use of smart pointers. We should keep the T &
  47     version to still support ob.*fn use.
  48  */
  49
  50 #ifndef HH_SENF_Utils_membind_
  51 #define HH_SENF_Utils_membind_ 1
  52
  53 // Custom includes
  54 #include <boost/bind.hpp>
  55 #include <boost/function.hpp>
  56 #include "../config.hh"
  57
  58 ///////////////////////////////hh.p////////////////////////////////////////
  59
  60 namespace senf {
  61
  62 #define scOBTYPE T *
  63 #include "../Utils/impl/membind.hh"
  64 #undef scOBTYPE
  65
  66 #define scOBTYPE T &
  67 #include "../Utils/impl/membind.hh"
  68 #undef scOBTYPE
  69
  70 #ifdef DOXYGEN
  71
  72     /// \addtogroup membind
  73     /// @{
  74
  75     /** \brief Build bound member function object
  76
  77         membind() supports up to 9 function parameters (represented as
  78         \a Args here). The \a ob argument can be either a pointer or a
  79         reference to \a T
  80         \param[in] fn member function pointer
  81         \param[in] ob object instance to bind this pointer to
  82         \returns Boost.Function object representing a bound call of \a
  83             fn on \a ob
  84      */
  85     template <typename R, typename T, typename Args>
  86     boost::function<R (Args)> membind(R (T::* fn)( Args ), T * ob);
  87
  88     /// @}
  89
  90 #endif
  91
  92 }
  93
  94 ///////////////////////////////hh.e////////////////////////////////////////
  95 //#include "membind.cci"
  96 //#include "membind.ct"
  97 //#include "membind.cti"
  98 #endif
  99
 100 \f
 101 // Local Variables:
 102 // mode: c++
 103 // fill-column: 100
 104 // c-file-style: "senf"
 105 // indent-tabs-mode: nil
 106 // ispell-local-dictionary: "american"
 107 // compile-command: "scons -u test"
 108 // comment-column: 40
 109 // End: