senf/Utils/String.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   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 String public header */
  25
  26 #ifndef HH_SENF_Utils_String_
  27 #define HH_SENF_Utils_String_ 1
  28
  29 // Custom includes
  30 #include <string>
  31
  32 //#include "String.mpp"
  33 ///////////////////////////////hh.p////////////////////////////////////////
  34
  35 namespace senf {
  36
  37     /** \brief Join string range with separator into single string
  38
  39         This utility will build string by joining all elements of \a range into a single string
  40         using \a sep as separator. The \a range may contain values of any streamable type.
  41      */
  42     template <class ForwardReadableRange>
  43     std::string stringJoin(ForwardReadableRange const & range, std::string sep);
  44
  45     /** \brief Get string representation
  46
  47         Returns the result of streaming the argument into a standard library string-based
  48         stream and then out as a std::string object. The conversion is done with
  49         <tt>boost::lexical_cast</tt>. The call is equivalent to
  50         <pre>
  51             boost::lexical_cast<std::string>(t);
  52         </pre>
  53         \pre
  54             <tt>t</tt> must be <i>OutputStreamable</i>,
  55                 meaning that an <tt>operator\<\<</tt> is defined\n
  56             <tt>t</tt> must be <i>CopyConstructible</i>
  57
  58         \see <a href="http://www.boost.org/doc/libs/release/libs/conversion/lexical_cast.htm">
  59             boost::lexical_cast</a>
  60      */
  61     template <class T>
  62     std::string str(T const & t);
  63
  64     template <class Target, class Source>
  65     Target lexical_cast(Source const & arg);
  66
  67     namespace detail { template <class Target> class lexical_caster; }
  68
  69     template <class Target>
  70     detail::lexical_caster<Target> lexical_cast();
  71 }
  72
  73 ///////////////////////////////hh.e////////////////////////////////////////
  74 //#include "String.cci"
  75 #include "String.ct"
  76 #include "String.cti"
  77 #endif
  78
  79 \f
  80 // Local Variables:
  81 // mode: c++
  82 // fill-column: 100
  83 // comment-column: 40
  84 // c-file-style: "senf"
  85 // indent-tabs-mode: nil
  86 // ispell-local-dictionary: "american"
  87 // compile-command: "scons -u test"
  88 // End: