senf/Utils/IgnoreValue.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2010
   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 IgnoreValue public header */
  30
  31 #ifndef HH_SENF_senf_Utils_IgnoreValue_
  32 #define HH_SENF_senf_Utils_IgnoreValue_ 1
  33
  34 // Custom includes
  35
  36 //#include "IgnoreValue.mpp"
  37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  38
  39 namespace senf {
  40
  41     /** \brief Explicitly ignore a value
  42
  43         To explicitly ignore a value (e.g. the return value of a function), pass that value to
  44         senf::IGNORE(). This has the added benefit of silencing \em any warnings about ignored
  45         values by g++.
  46      */
  47     template <class T>
  48     void IGNORE(T const &);
  49     template <class T>
  50     void IGNORE(T const *);
  51
  52 }
  53
  54 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  55 //#include "IgnoreValue.cci"
  56 //#include "IgnoreValue.ct"
  57 #include "IgnoreValue.cti"
  58 #endif
  59
  60 \f
  61 // Local Variables:
  62 // mode: c++
  63 // fill-column: 100
  64 // comment-column: 40
  65 // c-file-style: "senf"
  66 // indent-tabs-mode: nil
  67 // ispell-local-dictionary: "american"
  68 // compile-command: "scons -u test"
  69 // End: