cvrClassName.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2004
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrClassName.h
 *         Defines the class className to gain the fully qualified name of
 *         a class inherited from cvr::object.
 * \author Jochen Wickel
 * \date   01.04.99
 *
 * $Id: cvrClassName.h,v 1.5 2005/01/17 13:57:18 alvarado Exp $
 */

#ifndef _CVR_CLASSNAME_H_
#define _CVR_CLASSNAME_H_

#include "cvrObject.h"
#include <string>

namespace cvr {
  /**
   * Provides methods for getting the class names of cvr::objects.
   *
   * This class uses the std::string container to avoid possible
   * memory leaks.
   */
  class className {
  public:
    /**
     * Default constructor
     */
    className();

    /**
     * Destructor
     */
    ~className();

    /**
     * Return the name of the given type.
     *
     * This class uses the std::typeinfo functions, but it "demangles" the
     * output to produce a valid C++ type name, i.e. the returned string
     * considers the template arguments and is usually fully qualified.
     *
     * The implementations should ensure that the returned name has the
     * following format:
     *
     * <namespace>::<classname>::<innerclassname>::...
     *
     * Example:
     * \code
     * cvr::boundingBox<double>::parameters
     * \endcode
     *
     * \warning The function returns a pointer to an internal class
     * member. So, the pointer is only valid for the lifetime of this
     * object or until the next time \c get is called, whatever occurs
     * first.
     */
    static std::string get(const object* o);

    /**
     * Return the name of the given object.
     *
     * @see get(const object*)
     */
    static std::string get(const object& o);

    /**
     * Return the name of the given type.
     *
     * This class uses the std::typeinfo functions, but it "demangles" the
     * output to produce a valid C++ type name, i.e. the returned string
     * considers the template arguments and is usually fully qualified.
     *
     * The implementations should ensure that the returned name has the
     * following format:
     *
     * <namespace>::<classname>::<innerclassname>::...
     *
     * Example:
     * \code
     * cvr::boundingBox<double>::parameters
     * \endcode
     *
     *
     * The name is returned in the result parameter. This is a much safer
     * method than the method returning a pointer.
     */
    static void get(const object& o, std::string& result);

    /**
     * Return the name of the given type.
     *
     * This class uses the std::typeinfo functions, but it "demangles" the
     * output to produce a valid C++ type name, i.e. the returned string
     * considers the template arguments and is usually fully qualified.
     *
     * The implementations should ensure that the returned name has the
     * following format:
     *
     * <namespace>::<classname>::<innerclassname>::...
     *
     * Example:
     * \code
     * cvr::boundingBox<double>::parameters
     * \endcode
     *
     * The name is returned in the result parameter. This is a much safer
     * method than the method returning a pointer.
     */
    static void get(const object* o, std::string& result);

    /**
     * Demangle
     *
     * You can use this methods to gain the name of a class that is not
     * inherited from cvr::object.
     *
     * The input is the one given by typeid().name()
     *
     * Example:
     * \code
     * cvr::point<float> p;
     * std::string typeOfP = className::demangle(typeid(p).name());
     * \endcode
     *
     * \warning Remember that the pointer returned by typeid belongs to the
     * system.  You should never delete that pointer.
     */
    static std::string demangle(const std::string& mangled);

  private:
    /**
     * Demangle the given string using OS/Compiler dependent code.
     *
     * This method is highly recursive, so that the current positions in the
     * source and destination strings have to be maintained.
     *
     * @param mangled mangled string
     * @param pos start position in \a mangled to be analyzed
     * @param demangled demangled string
     */
    static void decode(const std::string& mangled,
                       std::string& demangled);

    /**
     * Strip name.
     *
     * All spaces are eliminated
     */
    static void strip(std::string& complete);


  };
}

#endif