Utils/TypeInfo.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 TypeInfo public header */
  25
  26 #ifndef HH_TypeInfo_
  27 #define HH_TypeInfo_ 1
  28
  29 // Custom includes
  30 #include <string>
  31 #include <typeinfo>
  32
  33 //#include "TypeInfo.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /** \brief Try to return readable type for given type_info
  39
  40         This function will try to return a demangled type name for the
  41         given type_info object. If the demangling fails, the possibly
  42         mangled name (type->name()) will be returned.
  43
  44         This function depends on the liberty library provided by the
  45         linux binutils or binutils-dev packages. It also depends on an
  46         internal header file. If the API should change, this header
  47         file (which resides in impl/demangle.h) must be updated from
  48         the binutils sources.
  49
  50         \param[in] type type_info object
  51         \returns type name, possibly demangled
  52      */
  53     std::string prettyName(std::type_info const & type);
  54
  55 }
  56
  57 ///////////////////////////////hh.e////////////////////////////////////////
  58 //#include "TypeInfo.cci"
  59 //#include "TypeInfo.ct"
  60 //#include "TypeInfo.cti"
  61 //#include "TypeInfo.mpp"
  62 #endif
  63
  64 \f
  65 // Local Variables:
  66 // mode: c++
  67 // fill-column: 100
  68 // c-file-style: "senf"
  69 // indent-tabs-mode: nil
  70 // ispell-local-dictionary: "american"
  71 // compile-command: "scons -u test"
  72 // comment-column: 40
  73 // End: