debugfuture.hh

Go to the documentation of this file.

#ifndef _DRAMA2_DEBUGFUTURE_INC
#define _DRAMA2_DEBUGFUTURE_INC
/*
 *  History:
      12-Jan-2017 - TJF - Original version.
 
 * The above ID is for Doxygen, this one has the format ACMM is looking for.
 * "@(#) $Id$"
 */
 
#include <drama.hh>
 
#include <future>
#include <typeinfo>
 
namespace drama {
    /* Used internally by Future - not for user access */
    extern bool _futureDebugGlobalLogDetails;
 
 
    template <class T>
    class Future : public  std::future<T> {
        using BaseFuture=std::future<T>;
    private:
        std::string _name;         // Name used in messages.
        std::string _type;
        bool _logDetails = false;  // Object specific log flag.
    public:
 
        void LogOn() {
            _logDetails = true;
        }
        static void GlobalLogOn() {
             _futureDebugGlobalLogDetails = true;
        }
        void LogOff() {
            _logDetails = false;
        }
        static void GlobalLogOff() {
             _futureDebugGlobalLogDetails = false;
        }
        static bool GetGlobalLogState()  {
            return _futureDebugGlobalLogDetails;
        }
        bool GetLogState() const {
            return _logDetails;
        }
        void SetName(const std::string &newName) {
            _name = newName;
        }
 
        Future(const std::string &name="unnamed", 
               bool logOn=false) noexcept : _name(name), _logDetails(logOn) {
                   T a;
                   _type = typeid(a).name();
        }
 
        Future(const Future&) = delete; 
 
 
        Future& operator=(Future &&rhs) noexcept  {
            *this = std::move(rhs);
            return *this;
        }
 
        Future& operator=( BaseFuture &&rhs) noexcept {
            *((BaseFuture *)(this)) = std::move(rhs);
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, "drama::Future<%> \"%\" assigned\n",
                                   _type, _name);
            return *this;
        }
 
 
        Future& operator=(const Future &)  = delete;
 
        T get() {
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, 
                                   "drama::Future<%> \"%\" get() invoked\n", 
                                   _type, _name);
            /*
             * Run get() on the base class.  This may throw and we
             * want to log that.
             */
            T result;
            try
            {
                result = ((BaseFuture *)(this))->get();
            }
            catch (...)
            {
                if ((_logDetails)||( _futureDebugGlobalLogDetails))
                    drama::TSafePrintf(std::cerr, 
                                       "drama::Future<%> \"%\" get() threw\n", 
                                       _type, _name);
                throw;
            }
            /*
             * did not throw.
             */
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, 
                                   "drama::Future<%> \"%\" get() returning\n", 
                                   _type, _name);
            return result;
        }
 
         ~Future() {
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, 
                                   "drama::Future<%> \"%\" destroyed\n", 
                                   _type, _name);
        }
 
    };
 
 
    template <>
    class Future<void> : public std::future<void> {
        using BaseFuture = std::future<void>;
    private:
        std::string _name;          // Name used in messages.
        bool _logDetails = false;   // Object specific log flag.
    public:
 
        void LogOn() {
            _logDetails = true;
        }
        static void GlobalLogOn() {
             _futureDebugGlobalLogDetails = true;
        }
        void LogOff() {
            _logDetails = false;
        }
        static void GlobalLogOff() {
            _futureDebugGlobalLogDetails = false;
        }
        static bool GetGlobalLogState()  {
            return _futureDebugGlobalLogDetails;
        }
        bool GetLogState() const {
            return _logDetails;
        }
        void SetName(const std::string &newName) {
            _name = newName;
        }
 
        Future(const std::string &name="unnamed", bool logOn=false) noexcept : _name(name), _logDetails(logOn) {}
        Future(const Future&) = delete; 
 
        Future& operator=(Future &&rhs) noexcept  {
            _name = std::move(rhs._name);
            _logDetails = rhs._logDetails;
            return *this;
        }
 
        Future& operator=(BaseFuture &&rhs) noexcept {
            *((BaseFuture *)(this)) = std::move(rhs);
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" assigned\n", _name);
            return *this;
        }
        Future& operator=(const Future &)  = delete;
 
        void get() {
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" get() invoked\n", _name);
            /*
             * Run get() on the base class.  This may throw and we
             * want to log that.
             */
            try
            {
                ((BaseFuture *)(this))->get();
            }
            catch (...)
            {
                if ((_logDetails)||( _futureDebugGlobalLogDetails))
                    drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" get() threw\n", _name);
                throw;
            }
            /*
             * did not throw.
             */
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
                drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" get() returning\n", _name);
        }
        ~Future() {
            if ((_logDetails)||( _futureDebugGlobalLogDetails))
            {
                if (valid())
                    drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" destroyed - but is still valid (which could be a problem)!!\n", _name);
                else
                    drama::TSafePrintf(std::cerr, "drama::Future<void> \"%\" destroyed - was not valid (which is ok).\n", _name);
            }
        }
 
    };
 
 
 
} // namespace drama
 
#endif  /* defined _DRAMA2_SDP_INC */