Teuchos_RCPDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// 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
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_RCP_DECL_HPP
#define TEUCHOS_RCP_DECL_HPP

#include "Teuchos_any.hpp"

#ifdef REFCOUNTPTR_INLINE_FUNCS
#  define REFCOUNTPTR_INLINE inline
#else
#  define REFCOUNTPTR_INLINE
#endif

#ifdef TEUCHOS_DEBUG
#  define TEUCHOS_REFCOUNTPTR_ASSERT_NONNULL
#endif

namespace Teuchos {

namespace PrivateUtilityPack {
  class RCP_node;
}

enum ENull { null };

enum EPrePostDestruction { PRE_DESTROY, POST_DESTROY };

template<class T>
class RCP {
public:
  typedef T  element_type;
  RCP( ENull null_arg = null );
  explicit RCP( T* p, bool has_ownership = false );
  RCP(const RCP<T>& r_ptr);
  template<class T2>
  RCP(const RCP<T2>& r_ptr);
  ~RCP();
  RCP<T>& operator=(const RCP<T>& r_ptr);
  T* operator->() const;
  T& operator*() const;
  T* get() const;
  T* release();
  int count() const;
  void set_has_ownership();
  bool has_ownership() const;
  template<class T2>
  bool shares_resource(const RCP<T2>& r_ptr) const;
  const RCP<T>& assert_not_null() const;

public: // Bad bad bad

  // //////////////////////////////////////
  // Private types

  typedef PrivateUtilityPack::RCP_node      node_t;

private:

  // //////////////////////////////////////////////////////////////
  // Private data members

  T       *ptr_;  // NULL if this pointer is null
  node_t  *node_;  // NULL if this pointer is null

public: // Bad bad bad
#ifndef DOXYGEN_COMPILE
  // These constructors should be private but I have not had good luck making
  // this portable (i.e. using friendship etc.) in the past
  template<class Dealloc_T>
  RCP( T* p, Dealloc_T dealloc, bool has_ownership );
  // This is a very bad breach of encapsulation that is needed since MS VC++ 5.0 will
  // not allow me to declare template functions as friends.
  RCP( T* p, node_t* node);
  T*& access_ptr();
  node_t*& access_node();
  node_t* access_node() const;
#endif

};  // end class RCP<...>

template<typename T>
class TypeNameTraits<RCP<T> > {
public:
  static std::string name() { return "RCP<"+TypeNameTraits<T>::name()+">"; }
};


template<class T>
class DeallocDelete
{
public:
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) delete ptr; }
};

template<class T>
class DeallocArrayDelete
{
public:
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) delete [] ptr; }
};

template<class T, class DeleteFunctor>
class DeallocFunctorDelete
{
public:
  DeallocFunctorDelete( DeleteFunctor deleteFunctor ) : deleteFunctor_(deleteFunctor) {}
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) deleteFunctor_(ptr); }
private:
  DeleteFunctor deleteFunctor_;
  DeallocFunctorDelete(); // Not defined and not to be called!
};

template<class T, class DeleteFunctor>
DeallocFunctorDelete<T,DeleteFunctor>
deallocFunctorDelete( DeleteFunctor deleteFunctor )
{
  return DeallocFunctorDelete<T,DeleteFunctor>(deleteFunctor);
}

template<class T, class DeleteHandleFunctor>
class DeallocFunctorHandleDelete
{
public:
  DeallocFunctorHandleDelete( DeleteHandleFunctor deleteHandleFunctor )
    : deleteHandleFunctor_(deleteHandleFunctor) {}
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) { T **hdl = &ptr; deleteHandleFunctor_(hdl); } }
private:
  DeleteHandleFunctor deleteHandleFunctor_;
  DeallocFunctorHandleDelete(); // Not defined and not to be called!
};

template<class T, class DeleteHandleFunctor>
DeallocFunctorHandleDelete<T,DeleteHandleFunctor>
deallocFunctorHandleDelete( DeleteHandleFunctor deleteHandleFunctor )
{
  return DeallocFunctorHandleDelete<T,DeleteHandleFunctor>(deleteHandleFunctor);
}

template<class T>
RCP<T> rcp( T* p, bool owns_mem
#ifndef __sun
  = true
#endif
  );
#ifdef __sun // RAB: 20040303: Sun needs to fix their compiler
template<class T> inline RCP<T> rcp( T* p ) { return rcp(p,true); }
#endif

template<class T, class Dealloc_T>
RCP<T> rcp( T* p, Dealloc_T dealloc, bool owns_mem );

template<class T>
bool is_null( const RCP<T> &p );

template<class T>
bool operator==( const RCP<T> &p, ENull );

template<class T>
bool operator!=( const RCP<T> &p, ENull );

template<class T1, class T2>
bool operator==( const RCP<T1> &p1, const RCP<T2> &p2 );

template<class T1, class T2>
bool operator!=( const RCP<T1> &p1, const RCP<T2> &p2 );

template<class T2, class T1>
RCP<T2> rcp_implicit_cast(const RCP<T1>& p1);

template<class T2, class T1>
RCP<T2> rcp_static_cast(const RCP<T1>& p1);

template<class T2, class T1>
RCP<T2> rcp_const_cast(const RCP<T1>& p1);

template<class T2, class T1>
RCP<T2> rcp_dynamic_cast(
  const RCP<T1>& p1
  ,bool throw_on_fail
#ifndef __sun
  = false
#endif
  );
#ifdef __sun // RAB: 20041019: Sun needs to fix their compiler
template<class T2, class T1> inline RCP<T2> rcp_dynamic_cast( const RCP<T1>& p1 )
{ return rcp_dynamic_cast<T2>(p1,false); }
#endif

template<class T1, class T2>
void set_extra_data(
  const T1 &extra_data,
  const std::string& name, RCP<T2> *p,
  EPrePostDestruction destroy_when = POST_DESTROY,
  bool force_unique = true
  );

template<class T1, class T2>
T1& get_extra_data( RCP<T2>& p, const std::string& name );

template<class T1, class T2>
const T1& get_extra_data( const RCP<T2>& p, const std::string& name );

template<class T1, class T2>
T1* get_optional_extra_data( RCP<T2>& p, const std::string& name );

template<class T1, class T2>
const T1* get_optional_extra_data( const RCP<T2>& p, const std::string& name );

template<class Dealloc_T, class T>
Dealloc_T& get_dealloc( RCP<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T& get_dealloc( const RCP<T>& p );

template<class Dealloc_T, class T>
Dealloc_T* get_optional_dealloc( RCP<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T* get_optional_dealloc( const RCP<T>& p );

template<class T>
std::ostream& operator<<( std::ostream& out, const RCP<T>& p );

void print_active_RCP_nodes(std::ostream &out);

} // end namespace Teuchos

#endif  // TEUCHOS_RCP_DECL_HPP

---