Teuchos - Trilinos Tools Package Version of the Day
Teuchos_OpaqueWrapper.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_OPAQUE_WRAPPER_HPP
00043 #define TEUCHOS_OPAQUE_WRAPPER_HPP
00044 
00045 
00046 #include "Teuchos_RCP.hpp"
00047 
00048 
00049 //#define TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00050 
00051 #ifdef TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00052 #  include "Teuchos_VerboseObject.hpp"
00053 #endif // TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00054 
00055 
00056 namespace Teuchos {
00057 
00058 
00122 template <class Opaque>
00123 class OpaqueWrapper {
00124 public:
00126   OpaqueWrapper( Opaque opaque )
00127     : opaque_(opaque)
00128     {}
00130   operator Opaque () const
00131     { return opaque_; }
00133   Opaque operator()() const
00134     { return opaque_; }
00135 protected:
00136   Opaque  opaque_; // Bad in general but ...
00137 private:
00138   OpaqueWrapper(); // Not defined
00139   OpaqueWrapper(const OpaqueWrapper&); // Not defined
00140   OpaqueWrapper& operator=(const OpaqueWrapper&); // Not defined
00141 }; 
00142 
00159 template <class Opaque, class OpaqueFree>
00160 class OpaqueWrapperWithFree : public OpaqueWrapper<Opaque> {
00161 public:
00162   OpaqueWrapperWithFree( Opaque opaque, OpaqueFree opaqueFree )
00163     : OpaqueWrapper<Opaque>(opaque), opaqueFree_(opaqueFree)
00164     {}
00165   ~OpaqueWrapperWithFree()
00166     {
00167       if(opaqueFree_) {
00168 #ifdef TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00169         Teuchos::RCP<Teuchos::FancyOStream>
00170           out = Teuchos::VerboseObjectBase::getDefaultOStream();
00171         Teuchos::OSTab tab(out);
00172         *out << "\nOpaqueWrapperWithFree::~OpaqueWrapperWithFree(): Freeing opaque object"
00173              << " of type " << TypeNameTraits<Opaque>::name() << "!\n";
00174 #endif // TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00175         opaqueFree_(&this->opaque_);
00176       }
00177     }
00178 private:
00179   OpaqueFree opaqueFree_;
00180   OpaqueWrapperWithFree(); // Not defined
00181   OpaqueWrapperWithFree(const OpaqueWrapperWithFree&); // Not defined
00182   OpaqueWrapperWithFree& operator=(const OpaqueWrapperWithFree&); // Not defined
00183 }; 
00184 
00185 
00191 template <class Opaque>
00192 inline
00193 RCP<OpaqueWrapper<Opaque> >
00194 opaqueWrapper( Opaque opaque)
00195 {
00196   return rcp(new OpaqueWrapper<Opaque>(opaque));
00197 }
00198 
00199 
00205 template <class Opaque, class OpaqueFree>
00206 inline
00207 RCP<OpaqueWrapper<Opaque> >
00208 opaqueWrapper( Opaque opaque, OpaqueFree opaqueFree)
00209 {
00210   return rcp(new OpaqueWrapperWithFree<Opaque,OpaqueFree>(opaque,opaqueFree));
00211 }
00212 
00213 
00214 } // namespace Teuchos
00215 
00216 
00217 #endif  // TEUCHOS_OPAQUE_WRAPPER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines