/*
 *  Open BEAGLE
 *  Copyright (C) 2001-2007 by Christian Gagne and Marc Parizeau
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact:
 *  Laboratoire de Vision et Systemes Numeriques
 *  Departement de genie electrique et de genie informatique
 *  Universite Laval, Quebec, Canada, G1K 7P4
 *  http://vision.gel.ulaval.ca
 *
 */

/*!
 *  \file   beagle/castObjectT.hpp
 *  \brief  Implementation of castObjectT templated functions.
 *  \author Christian Gagne
 *  \author Marc Parizeau
 *  $Revision: 1.5.2.1 $
 *  $Date: 2007/05/09 01:51:18 $
 */

#ifndef Beagle_castObjectT_hpp
#define Beagle_castObjectT_hpp

#include <typeinfo>
#include <string>

#include "beagle/config.hpp"
#include "beagle/macros.hpp"
#include "beagle/Object.hpp"
#include "beagle/Pointer.hpp"
#include "beagle/BadCastException.hpp"


namespace Beagle {


/*!
 *  \brief   Cast a Beagle::Object pointer into a CastType pointer.
 *  \param   inObject Object pointer to be casted.
 *  \return  Casted pointer to the object.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 *  \warning If RTTI is enabled and the typecast is invalid, the function return a NULL pointer.
 */
template <class CastPointerType>
inline CastPointerType castObjectT(Beagle::Object* inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<CastPointerType>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  return dynamic_cast<CastPointerType>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<CastPointerType>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("CastPointerType castObjectT<CastPointerType>(Object* inObject)");
}


/*!
 *  \brief   Cast a Beagle::Object constant pointer into a CastType constant pointer.
 *  \param   inObject Object constant pointer to be casted.
 *  \return  Casted constant pointer to the object.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 *  \warning If RTTI is enabled and the typecast is invalid, the function return a NULL pointer.
 */
template <class CastPointerType>
inline CastPointerType castObjectT(const Beagle::Object* inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<CastPointerType>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  return dynamic_cast<CastPointerType>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<CastPointerType>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("CastPointerType castObjectT<CastPointerType>(const Object* inObject)");
}


/*!
 *  \brief   Cast a Beagle::Object reference into a CastType reference.
 *  \param   inObject Object reference to be casted.
 *  \return  Casted reference to the object.
 *  \throw   Beagle::BadCastException If RTTI is enabled and the typecast is invalid.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 */
template <class CastRefType>
inline CastRefType castObjectT(Beagle::Object& inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<CastRefType>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  try {
    return dynamic_cast<CastRefType>(inObject);
  } catch(...) {
    string lMessage("Unable to cast object reference into desired type! ");
    lMessage += "Type of the object to cast: ";
    lMessage += typeid(inObject).name();
    lMessage += ", \t";
    lMessage += "Desired type cast: ";
    lMessage += typeid(CastRefType).name();
    lMessage += ".";
    throw Beagle_BadCastExceptionM(lMessage);
  }
  return static_cast<CastRefType>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<CastRefType>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("CastRefType castObjectT<CastRefType>(Object& inObject)");
}


/*!
 *  \brief   Cast a Beagle::Object constant reference into a CastType constant reference.
 *  \param   inObject Object constant reference to be casted.
 *  \return  Casted constant reference to the object.
 *  \throw   Beagle::BadCastException If RTTI is enabled and the typecast is invalid.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 */
template <class CastConstRefType>
inline CastConstRefType castObjectT(const Beagle::Object& inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<CastConstRefType>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  try {
    return dynamic_cast<CastConstRefType>(inObject);
  } catch(...) {
    string lMessage("Unable to cast object reference into desired type! ");
    lMessage += "Type of the object to cast: ";
    lMessage += typeid(inObject).name();
    lMessage += ", \t";
    lMessage += "Desired type cast: ";
    lMessage += typeid(CastConstRefType).name();
    lMessage += ".";
    throw Beagle_BadCastExceptionM(lMessage);
  }
  return static_cast<CastConstRefType>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<CastConstRefType>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("CastConstRefType castObjectT<CastConstRefType>(const Object& inObject)");
}


/*!
 *  \brief   Cast a Beagle::Object smart pointer into a CastType handle type.
 *  \param   inObject Object smart pointer to be casted.
 *  \return  Casted smart pointer to the object.
 *  \throw   Beagle::BadCastException If RTTI is enabled and the typecast is invalid.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 */
template <class CastType>
inline typename CastType::Handle& castHandleT(Beagle::Object::Handle& inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<typename CastType::Handle&>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  if(inObject.getPointer()) {
    if( dynamic_cast<CastType*>(inObject.getPointer()) == NULL ) {
      string lMessage("Unable to cast object handle into desired type! ");
      lMessage += "Type of the object to cast: ";
      lMessage += typeid(*inObject).name();
      lMessage += ", \t";
      lMessage += "Desired type cast: ";
      lMessage += typeid(CastType).name();
      lMessage += ".";
      throw Beagle_BadCastExceptionM(lMessage);
    }
  }
  return static_cast<typename CastType::Handle&>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<typename CastType::Handle&>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("CastType::Handle& castHandleT<CastType>(Object::Handle& inObject)");
}


/*!
 *  \brief   Cast a constant Beagle::Object smart pointer into a constant CastType handle type.
 *  \param   inObject Constant Object smart pointer to be casted.
 *  \return  Casted constant smart pointer to the object.
 *  \throw   Beagle::BadCastException If RTTI is enabled and the typecast is invalid.
 *  \relates Beagle::Object
 *  \ingroup ObjPt
 */
template <class CastType>
inline const typename CastType::Handle& castHandleT(const Beagle::Object::Handle& inObject)
{
  Beagle_StackTraceBeginM();
#ifdef BEAGLE_NDEBUG
  return static_cast<const typename CastType::Handle&>(inObject);
#else // BEAGLE_NDEBUG
#ifdef BEAGLE_HAVE_DYNAMIC_CAST
  if(inObject.getPointer()) {
    if( dynamic_cast<const CastType*>(inObject.getPointer()) == NULL ) {
      string lMessage("Unable to cast object handle into desired type! ");
      lMessage += "Type of the object to cast: ";
      lMessage += typeid(*inObject).name();
      lMessage += ", \t";
      lMessage += "Desired type cast: ";
      lMessage += typeid(CastType).name();
      lMessage += ".";
      throw Beagle_BadCastExceptionM(lMessage);
    }
  }
  return static_cast<const typename CastType::Handle&>(inObject);
#else // BEAGLE_HAVE_DYNAMIC_CAST
  return static_cast<const typename CastType::Handle&>(inObject);
#endif // BEAGLE_HAVE_DYNAMIC_CAST
#endif // BEAGLE_NDEBUG
  Beagle_StackTraceEndM("const CastType::Handle& castHandleT<CastType>(const Object::Handle& inObject)");
}

}

#endif // Beagle_castObjectT_hpp
