senf/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_SENF_Utils_TypeInfo_
  27 #define HH_SENF_Utils_TypeInfo_ 1
  28
  29 // Custom includes
  30 #include <string>
  31 #include <typeinfo>
  32
  33 //#include "TypeInfo.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  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 given type_info object. If
  41         the demangling fails, the possibly mangled name (type->name()) will be returned.
  42
  43         \param[in] type type_info object
  44         \returns type name, possibly demangled
  45      */
  46     std::string prettyName(std::type_info const & type);
  47
  48     /** \brief Try to return readable type name without namespace or template arguments
  49
  50         This function will try to return a demangled type name for the given type_info object. If
  51         the demangling fails, the possibly mangled name (type->name()) will be returned. The
  52         namespace prefix and template arguments will be stripped.
  53
  54         \param[in] type type_info object
  55         \returns type name, possibly demangled and without namespace or template args
  56      */
  57
  58     std::string prettyBaseName(std::type_info const & type);
  59
  60 }
  61
  62 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  63 //#include "TypeInfo.cci"
  64 //#include "TypeInfo.ct"
  65 //#include "TypeInfo.cti"
  66 //#include "TypeInfo.mpp"
  67 #endif
  68
  69 \f
  70 // Local Variables:
  71 // mode: c++
  72 // fill-column: 100
  73 // c-file-style: "senf"
  74 // indent-tabs-mode: nil
  75 // ispell-local-dictionary: "american"
  76 // compile-command: "scons -u test"
  77 // comment-column: 40
  78 // End: