senf/Utils/Tags.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief Tags public header */
  30
  31 #ifndef HH_SENF_Utils_Tags_
  32 #define HH_SENF_Utils_Tags_ 1
  33
  34 // Custom includes
  35
  36 //#include "Tags.mpp"
  37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  38
  39 /** \defgroup utils_tags Type tags
  40
  41     Type tags are used to select variants of a member, function, template or constructor. A Type tag
  42     always has only a single value which is passed wherever a parameter of that tag's type is
  43     needed.
  44
  45     The argument which expects a type-tag value will always be declared in such a way, that it is
  46     optional. Examples of type tag use are:
  47
  48     \code
  49     result = object.find<Foo>();                  // This call may throw
  50     result = object.find<Foo>(senf::nothrow);     // This call will not throw
  51     \endcode
  52
  53     Of course, this only works with objects which explicitly declare, that they take an optional
  54     senf::NoThrow_t type parameter.
  55  */
  56
  57 namespace senf {
  58
  59     /** \brief Type tag selecting non-throwing variant of something
  60
  61         This tag is used to select the non-throwing variant of a member, function, template or
  62         constructor. An argument of this type is always declared in such a way, that it is
  63         optional.
  64
  65         There is only a single value for this type: \ref senf::nothrow which is the value to pass
  66         wherever an (optional) senf::NoThrow_t parameter is requested.
  67
  68         \ingroup utils_tags
  69      */
  70     enum NoThrow_t { nothrow };
  71
  72     /** \brief Type tag selecting uninitialized variant of something
  73
  74         This tag is used to select the unititialized variant of a member, function, template or
  75         constructor (mostly a constructor). An argument of this type is always declared in such a
  76         way, that it is optional.
  77
  78         There is only a single value for this type: \ref senf::noinit which is the value to pass
  79         wherever an (optional) senf::NoInit_t parameter is requested.
  80
  81         \ingroup utils_tags
  82      */
  83     enum NoInit_t { noinit };
  84
  85 }
  86
  87 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  88 //#include "Tags.cci"
  89 //#include "Tags.ct"
  90 //#include "Tags.cti"
  91 #endif
  92
  93 \f
  94 // Local Variables:
  95 // mode: c++
  96 // fill-column: 100
  97 // comment-column: 40
  98 // c-file-style: "senf"
  99 // indent-tabs-mode: nil
 100 // ispell-local-dictionary: "american"
 101 // compile-command: "scons -u test"
 102 // End: