senf/Utils/TypeInfo.hh

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