(C) Zeriph Enterprises, LLC
omni/generic_ptr_safe.hpp
001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
117:
118:
119:
120:
121:
122:
123:
124:
125:
126:
127:
128:
129:
130:
131:
132:
133:
134:
135:
136:
137:
138:
139:
140:
141:
142:
143:
144:
145:
146:
147:
148:
149:
150:
151:
152:
153:
154:
155:
156:
157:
158:
159:
160:
161:
162:
163:
164:
165:
166:
167:
168:
169:
/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef OMNI_SAFE_GEN_PTR_HPP
#define OMNI_SAFE_GEN_PTR_HPP 1
#include <omni/defs/class_macros.hpp>
#include <omni/type.hpp>
#include <omni/sync/scoped_lock.hpp>

namespace omni {
    class generic_ptr_safe
    {
        public:
            generic_ptr_safe() :
                OMNI_CTOR_FW(omni::generic_ptr_safe)
                m_ptr(0), m_id(0), m_mtx()
            {
                omni::sync::mutex_init(this->m_mtx);
                OMNI_D5_FW("created");
            }

            template < typename T >
            generic_ptr_safe(T *const obj) :
                OMNI_CTOR_FW(omni::generic_ptr_safe)
                m_ptr(obj), m_id(omni::type_id<T>()), m_mtx()
            {
                omni::sync::mutex_init(this->m_mtx);
                OMNI_DV5_FW("created with id of ", this->m_id);
            }

            generic_ptr_safe(const generic_ptr_safe &o) :
                OMNI_CTOR_FW(omni::generic_ptr_safe)
                m_ptr(o.m_ptr), m_id(o.m_id), m_mtx()
            {
                omni::sync::mutex_init(this->m_mtx);
                OMNI_DV5_FW("coppied with id of ", this->m_id);
            }
            
            ~generic_ptr_safe()
            {
                OMNI_DTOR_FW
                omni::sync::mutex_lock(this->m_mtx);
                this->m_ptr = 0;
                this->m_id = 0;
                omni::sync::mutex_unlock(this->m_mtx);
                omni::sync::mutex_destroy(this->m_mtx);
                OMNI_D5_FW("destroyed");
            }

            bool valid() const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                return (this->m_ptr != 0);
            }
            
            operator bool() const
            {
                return this->valid();
            }
            
            bool operator!() const
            {
                return (!operator bool());
            }
            
            generic_ptr_safe& operator=(const generic_ptr_safe &o)
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> a1(&this->m_mtx);
                omni::sync::scoped_lock<omni::sync::mutex_t> a2(&o.m_mtx);
                this->m_ptr = o.m_ptr;
                this->m_id = o.m_id;
                return *this;
            }

            template < typename T >
            const generic_ptr_safe& operator=(T *const obj)
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                this->m_ptr = obj;
                this->m_id = omni::type_id<T>();
                OMNI_DV5_FW("set type id ", this->m_id);
                return *this;
            }

            template < typename T >
            operator T *const() const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                if (this->m_id != omni::type_id<T>()) {
                    OMNI_ERR_RETV_FW("invalid cast detected", omni::invalid_type_cast(), 0)
                }
                return static_cast<T *const>(
                    const_cast<void *const>(this->m_ptr)
                );
            }

            template < typename T >
            operator const T *const() const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                if ((this->m_id != omni::type_id<T>()) && (this->m_id != omni::type_id<const T>())) {
                    OMNI_ERR_RETV_FW("invalid cast detected", omni::invalid_type_cast(), 0);
                }
                return static_cast<const T *const>(this->m_ptr);
            }
            
            operator void *const() const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                return const_cast<void*>(this->m_ptr);
            }
            
            operator const void *const() const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
                return this->m_ptr;
            }
            
            bool operator==(const generic_ptr_safe& o) const
            {
                omni::sync::scoped_lock<omni::sync::mutex_t> a1(&this->m_mtx);
                omni::sync::scoped_lock<omni::sync::mutex_t> a2(&o.m_mtx);
                return (this->m_ptr == o.m_ptr && this->m_id == o.m_id);
            }
            
            bool operator!=(const generic_ptr_safe& o) const
            {
                return !(*this == o);
            }
            
            OMNI_MEMBERS_FW(omni::generic_ptr_safe) // disposing,name,type(),hash()
                
        private:
            #if defined(OMNI_TYPE_INFO)
                omni::type<omni::generic_ptr_safe> m_type;
            #endif
            const void* m_ptr;
            std::size_t m_id;
            mutable omni::sync::mutex_t m_mtx;
    };
}

#endif // OMNI_SAFE_GEN_PTR_HPP