ACE/ace/Auto_Functor.h

   1 // -*- C++ -*-
   2 //=============================================================================
   3 /**
   4  * @file Auto_Functor.h
   5  *
   6  * @author Carlos O'Ryan <coryan@atdesk.com>
   7  */
   8 //=============================================================================
   9 #ifndef ACE_AUTO_FUNCTOR_H
  10 #define ACE_AUTO_FUNCTOR_H
  11 #include /**/ "ace/pre.h"
  12
  13 #include /**/ "ace/config-all.h"
  14
  15 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  16 # pragma once
  17 #endif /* ACE_LACKS_PRAGMA_ONCE */
  18
  19 #include "ace/Global_Macros.h"
  20
  21 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  22
  23 namespace ACE_Utils
  24 {
  25 /**
  26  * @class Auto_Functor_Ref
  27  *
  28  * @brief Helper class to implement assignment and copy-construction
  29  *        as expected
  30  */
  31 template<typename X, typename Functor>
  32 struct Auto_Functor_Ref
  33 {
  34   X * p_;
  35   Functor f_;
  36
  37   Auto_Functor_Ref(X * p, Functor f);
  38 };
  39
  40 /**
  41  * @class Auto_Functor
  42  *
  43  * @brief Helper template to implement auto_ptr<>-like classes, but
  44  *    executing a functor in the destructor, instead of always
  45  *    deleting things.
  46  *
  47  * The functor is called in the destructor, and it must implement:
  48  *
  49  * Functor() noexcept;<BR>
  50  * Functor(Functor const &) noexcept;<BR>
  51  * Functor & operator=(Functor const &) noexcept;<BR>
  52  * void operator()(X * p) noexcept;<BR>
  53  */
  54 template<typename X, typename Functor>
  55 class Auto_Functor
  56 {
  57 public:
  58   typedef X element_type;
  59   typedef Functor functor_type;
  60
  61   /// Constructor
  62   explicit Auto_Functor (X * p = nullptr,
  63       Functor functor = Functor()); // noexcept
  64
  65   Auto_Functor (Auto_Functor & rhs); // noexcept
  66
  67   Auto_Functor<X,Functor>& operator= (Auto_Functor & rhs); // noexcept
  68
  69   template<typename Y>
  70   Auto_Functor(Auto_Functor<Y,Functor>& rhs); // noexcept
  71
  72   template<typename Y>
  73   Auto_Functor<X,Functor>& operator= (Auto_Functor<Y,Functor>& rhs); // noexcept
  74
  75   ~Auto_Functor(); // noexcept
  76
  77   X & operator*() const; // noexcept
  78
  79   X * operator->() const; // noexcept
  80
  81   X * get(); // noexcept
  82
  83   X * release(); // noexcept
  84
  85   void reset (X * p = nullptr); // noexcept
  86
  87   void reset (X * p, Functor f); // noexcept
  88
  89   Functor const & functor() const; // noexcept
  90
  91   Auto_Functor(Auto_Functor_Ref<X,Functor> rhs); // noexcept
  92
  93   Auto_Functor<X,Functor> & operator=(Auto_Functor_Ref<X,Functor> rhs); // noexcept
  94
  95   template<typename Y> operator Auto_Functor_Ref<Y,Functor>(); // noexcept
  96
  97   template<typename Y> operator Auto_Functor<Y,Functor>(); // noexcept
  98
  99 private:
 100   X * p_;
 101   Functor f_;
 102 };
 103 } // namespace ACE_Utils
 104
 105 ACE_END_VERSIONED_NAMESPACE_DECL
 106
 107 #if defined(__ACE_INLINE__)
 108 # include "ace/Auto_Functor.inl"
 109 #endif /* __ACE_INLINE__ */
 110
 111 #include "ace/Auto_Functor.cpp"
 112
 113 #include /**/ "ace/post.h"
 114 #endif /* ACE_AUTO_FUNCTOR_H*/