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 
00209 template <class Opaque>
00210 class OpaqueWrapper {
00211 public:
00216   OpaqueWrapper( Opaque opaque )
00217     : opaque_(opaque)
00218     {}
00233   operator Opaque () const
00234     { return opaque_; }
00240   Opaque operator()() const
00241     { return opaque_; }
00242 protected:
00249   Opaque  opaque_;
00250 private:
00251   OpaqueWrapper(); // Not defined
00252   OpaqueWrapper(const OpaqueWrapper&); // Not defined
00253   OpaqueWrapper& operator=(const OpaqueWrapper&); // Not defined
00254 };
00255 
00282 template <class Opaque, class OpaqueFree>
00283 class OpaqueWrapperWithFree : public OpaqueWrapper<Opaque> {
00284 public:
00286   OpaqueWrapperWithFree( Opaque opaque, OpaqueFree opaqueFree )
00287     : OpaqueWrapper<Opaque>(opaque), opaqueFree_(opaqueFree)
00288   {}
00290   ~OpaqueWrapperWithFree()
00291   {
00292     // FIXME (mfh 10 Sep 2012) This only works if the free function is
00293     // a raw function pointer, not if it is a general "function object"
00294     // (i.e., something callable via operator()).
00295     if(opaqueFree_) {
00296 #ifdef TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00297       Teuchos::RCP<Teuchos::FancyOStream>
00298   out = Teuchos::VerboseObjectBase::getDefaultOStream();
00299       Teuchos::OSTab tab(out);
00300       *out << "\nOpaqueWrapperWithFree::~OpaqueWrapperWithFree(): Freeing opaque object"
00301      << " of type " << TypeNameTraits<Opaque>::name() << "!\n";
00302 #endif // TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00303       opaqueFree_(&this->opaque_);
00304     }
00305   }
00306 private:
00308   OpaqueFree opaqueFree_;
00309   OpaqueWrapperWithFree(); // Not defined
00310   OpaqueWrapperWithFree(const OpaqueWrapperWithFree&); // Not defined
00311   OpaqueWrapperWithFree& operator=(const OpaqueWrapperWithFree&); // Not defined
00312 };
00313 
00314 
00322 template <class Opaque>
00323 inline
00324 RCP<OpaqueWrapper<Opaque> >
00325 opaqueWrapper( Opaque opaque)
00326 {
00327   return rcp(new OpaqueWrapper<Opaque>(opaque));
00328 }
00329 
00330 
00338 template <class Opaque, class OpaqueFree>
00339 inline
00340 RCP<OpaqueWrapper<Opaque> >
00341 opaqueWrapper( Opaque opaque, OpaqueFree opaqueFree)
00342 {
00343   return rcp(new OpaqueWrapperWithFree<Opaque,OpaqueFree>(opaque,opaqueFree));
00344 }
00345 
00346 
00347 } // namespace Teuchos
00348 
00349 
00350 #endif  // TEUCHOS_OPAQUE_WRAPPER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines