Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_OpaqueWrapper.hpp
Go to the documentation of this file.
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 
00239 template <class Opaque>
00240 class OpaqueWrapper {
00241 public:
00246   OpaqueWrapper( Opaque opaque )
00247     : opaque_(opaque)
00248     {}
00263   operator Opaque () const
00264     { return opaque_; }
00270   Opaque operator()() const
00271     { return opaque_; }
00272 protected:
00279   Opaque  opaque_;
00280 private:
00281   OpaqueWrapper(); // Not defined
00282   OpaqueWrapper(const OpaqueWrapper&); // Not defined
00283   OpaqueWrapper& operator=(const OpaqueWrapper&); // Not defined
00284 };
00285 
00311 template <class Opaque, class OpaqueFree>
00312 class OpaqueWrapperWithFree : public OpaqueWrapper<Opaque> {
00313 public:
00315   OpaqueWrapperWithFree( Opaque opaque, OpaqueFree opaqueFree )
00316     : OpaqueWrapper<Opaque>(opaque), opaqueFree_(opaqueFree)
00317   {}
00319   ~OpaqueWrapperWithFree()
00320   {
00321     // FIXME (mfh 10 Sep 2012) This only works if the free function is
00322     // a raw function pointer, not if it is a general "function object"
00323     // (i.e., something callable via operator()).
00324     if(opaqueFree_) {
00325 #ifdef TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00326       Teuchos::RCP<Teuchos::FancyOStream>
00327   out = Teuchos::VerboseObjectBase::getDefaultOStream();
00328       Teuchos::OSTab tab(out);
00329       *out << "\nOpaqueWrapperWithFree::~OpaqueWrapperWithFree(): Freeing opaque object"
00330      << " of type " << TypeNameTraits<Opaque>::name() << "!\n";
00331 #endif // TEUCHOS_OPAQUE_WRAPPER_ANNOUNCE_FREE
00332       opaqueFree_(&this->opaque_);
00333     }
00334   }
00335 private:
00337   OpaqueFree opaqueFree_;
00338   OpaqueWrapperWithFree(); // Not defined
00339   OpaqueWrapperWithFree(const OpaqueWrapperWithFree&); // Not defined
00340   OpaqueWrapperWithFree& operator=(const OpaqueWrapperWithFree&); // Not defined
00341 };
00342 
00343 
00351 template <class Opaque>
00352 inline
00353 RCP<OpaqueWrapper<Opaque> >
00354 opaqueWrapper( Opaque opaque)
00355 {
00356   return rcp(new OpaqueWrapper<Opaque>(opaque));
00357 }
00358 
00359 
00367 template <class Opaque, class OpaqueFree>
00368 inline
00369 RCP<OpaqueWrapper<Opaque> >
00370 opaqueWrapper( Opaque opaque, OpaqueFree opaqueFree)
00371 {
00372   return rcp(new OpaqueWrapperWithFree<Opaque,OpaqueFree>(opaque,opaqueFree));
00373 }
00374 
00375 
00376 } // namespace Teuchos
00377 
00378 
00379 #endif  // TEUCHOS_OPAQUE_WRAPPER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines