Utils/mpl.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   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 mpl public header */
  25
  26 #ifndef HH_mpl_
  27 #define HH_mpl_ 1
  28
  29 // Custom includes
  30 #include "../config.hh"
  31
  32 //#include "mpl.mpp"
  33 #include "mpl.ih"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace mpl {
  38
  39     /** \defgroup senfmpl Low-level template meta programming helpers
  40      */
  41
  42     /** \brief Return-value type used to implement overload selection
  43
  44         The senf::mpl::rv type is used together with \ref SENF_MPL_RV() to select template
  45         specializations based on a set of overloads:
  46
  47         \code
  48         template <unsigned _> struct select {};
  49
  50         // Case 0
  51         template <>
  52         struct select<0> {
  53             static bool const has_int_value = true;
  54             void frobble();
  55         };
  56         template <class T>
  57         senf::mpl::rv<0> select_(int, senf::mpl::take_int<T::value> * = 0);
  58
  59         // Case 1
  60         template <>
  61         struct select<1> {
  62             static bool const has_int_value = false;
  63             void dazzle();
  64         };
  65         template <class T>
  66         senf::mpl::rv<1> select_(...);
  67
  68         template <class T>
  69         struct choice : public select<SENF_MPL_RV( select_<T>(0) )> {};
  70
  71         struct A { static const int value = 0; };
  72         struct B {};
  73
  74         choice<A> a; a.frobble();
  75         choice<B> b; b.dazzle();
  76         \endcode
  77
  78         The selection is always based on two components: A selector class specialized for each of
  79         the possible choices and an overloaded function (only signatures, no implementation needed)
  80         to provide the conditions.
  81
  82         When instantiatinv <tt>choice<T></tt>, we forward \a T to the <tt>select_</tt> set of
  83         overloads. Because of <a href="http://en.wikipedia.org/wiki/SFINAE">SFINAE</a>, the overload
  84         set will only contain those instantiations, for which template expansion does not fail.
  85
  86         So, if \a T has an integer \c value member, both \c select_ overloads are ok and the call
  87         <tt>select_<T>(0)</tt> will choose the first (case 0) variant, since the argument \c 0 is
  88         better matched by \c int than by <tt>...</tt>.
  89
  90         However, if \a T does not have an integer \c value member, expansion for the first overload
  91         fails and the overload set only contains the second case.
  92
  93         \ref SENF_MPL_RV() internally uses \c sizeof to find out, \e which overload was selected
  94         and returns the senf::mpl::rv-argument of that overloads return type. For this to work, the
  95         \c select_ functions need not be implemented since no code is generated and \c select_ is
  96         never called.
  97
  98         This number is than forwarded as template argument to \c select which is specialized for
  99         each case. Therefore, <tt>choice<A></tt> has a \c frobble() member whereas
 100         <tt>choice<B></tt> has a \c dazzle() member.
 101
 102         \see \ref SENF_MPL_RV
 103         \ingroup senfmpl
 104      */
 105     template <unsigned n>
 106     struct rv {
 107         char _[SENF_MPL_RV_ALIGNMENT][n+1];
 108     };
 109
 110     /** \brief Get return value of overload selector
 111
 112         Used together with senf::mpl::rv to implement overload selection.
 113
 114         \see \ref senf::mpl::rv
 115         \ingroup senfmpl
 116         \hideinitializer
 117      */
 118 #   define SENF_MPL_RV(expr) (sizeof(expr)/SENF_MPL_RV_ALIGNMENT-1)
 119
 120     /** \brief Take an arbitrary unsigned integer template argument
 121
 122         Used together with <a href="http://en.wikipedia.org/wiki/SFINAE">SFINAE</a>: The expression
 123         <tt>take_uint<</tt> \a expr <tt>></tt> is only valid if \a expr is valid and returns a value
 124         convertible to an unsigned integer.
 125
 126         \ingroup senfmpl
 127      */
 128     template <unsigned long _> struct take_uint {};
 129
 130     /** \brief Take an arbitrary integer template argument
 131
 132         Used together with <a href="http://en.wikipedia.org/wiki/SFINAE">SFINAE</a>: The expression
 133         <tt>take_int<</tt> \a expr <tt>></tt> is only valid if \a expr is valid and returns a value
 134         convertible to an integer.
 135
 136         \ingroup senfmpl
 137      */
 138     template <long _> struct take_int {};
 139
 140     /** \brief Take an arbitrary type template argument
 141
 142         Used together with <a href="http://en.wikipedia.org/wiki/SFINAE">SFINAE</a>: The expression
 143         <tt>take_class<</tt> \a expr <tt>></tt> is only valid if \a expr is valid and is a type.
 144
 145         \ingroup senfmpl
 146      */
 147     template <class _> struct take_class {};
 148
 149     /** \brief Define MPL slot
 150
 151         The slot macros \ref SENF_MPL_SLOT_DEF(), \ref SENF_MPL_SLOT_SET() and \ref
 152         SENF_MPL_SLOT_GET() provide a facility to get the last unsigned integer value assigned to
 153         the slot before the current point in the current class.
 154         \code
 155         struct Foo
 156         {
 157             // Define SLOT slot named 'accum' initialized to 0
 158             SENF_MPL_SLOT_DEF(accum, 0);
 159
 160             // Add 2 to 'accum'
 161             SENF_MPL_SLOT_SET(accum, SENF_MPL_SLOT_GET(accum) + 2);
 162
 163             // Multiply 'accum' by 3
 164             SENF_MPL_SLOT_SET(accum, SENF_MPL_SLOT_GET(accum) * 3);
 165
 166             // Define the result as a constant expression. result is now 6
 167             static unsigned result = SENF_MPL_SLOT_GET(accum);
 168         };
 169         \endcode
 170         Of course, it does not make sense to use these macros for simple arithmetic as in the
 171         example. The SENF_MPL_SLOT macros allow to define macros which pass information from one
 172         macro invocation to the next.
 173
 174         \implementation The implementation is based on __LINE__: We check backwards for a value
 175             defined on a previous line. The check is limited to 80 lines backwards.
 176
 177         \ingroup senfmpl
 178         \hideinitializer
 179      */
 180 #   define SENF_MPL_SLOT_DEF(name,value)                                                          \
 181         template <class _>                                                                        \
 182         static senf::mpl::rv<0> _SENF_MPL_SLOT_ ## name (_);                                      \
 183         SENF_MPL_SLOT_SET(name,value)
 184
 185     /** \brief Set MPL slot
 186         \see \ref SENF_MPL_SLOT_DEF()
 187         \ingroup senfmpl
 188         \hideinitializer
 189      */
 190 #   define SENF_MPL_SLOT_SET(name,value)                                                          \
 191         static senf::mpl::rv<unsigned(value)+1>                                                   \
 192             _SENF_MPL_SLOT_ ## name (senf::mpl::take_int<__LINE__>)
 193
 194     /** \brief Get current MPL slot value
 195         \see \ref SENF_MPL_SLOT_DEF()
 196         \ingroup senfmpl
 197         \hideinitializer
 198      */
 199 #   define SENF_MPL_SLOT_GET(name)                                                                \
 200         SENF_MPL_SLOT_I_GET(name)
 201
 202 }}
 203
 204 ///////////////////////////////hh.e////////////////////////////////////////
 205 //#include "mpl.cci"
 206 //#include "mpl.ct"
 207 //#include "mpl.cti"
 208 #endif
 209
 210 \f
 211 // Local Variables:
 212 // mode: c++
 213 // fill-column: 100
 214 // comment-column: 40
 215 // c-file-style: "senf"
 216 // indent-tabs-mode: nil
 217 // ispell-local-dictionary: "american"
 218 // compile-command: "scons -u test"
 219 // End: