plonk_SmartPointer.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 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 University of the West of England, Bristol 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 THE COPYRIGHT HOLDERS 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 UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL 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. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_SMARTPOINTER_H
#define PLONK_SMARTPOINTER_H

#include "plonk_CoreForwardDeclarations.h"
#include "../containers/plonk_ContainerForwardDeclarations.h"
#include "../containers/plonk_Atomic.h"

#define PLONK_SMARTPOINTER_DEBUG 0
#define PLONK_SMARTPOINTER_DEBUGLOG 0

#ifndef PLONK_SMARTPOINTER_DEBUG
    #ifdef PLONK_DEBUG
        #define PLONK_SMARTPOINTER_DEBUG 1
        #ifndef PLONK_SMARTPOINTER_DEBUGLOG
            #define PLONK_SMARTPOINTER_DEBUGLOG 1
        #endif
    #else
        #define PLONK_SMARTPOINTER_DEBUG 0
        #ifndef PLONK_SMARTPOINTER_DEBUGLOG
            #define PLONK_SMARTPOINTER_DEBUGLOG 0
        #endif
    #endif
#endif

//------------------------------------------------------------------------------

#if PLONK_SMARTPOINTER_DEBUG
const Long getTotalSmartPointers() throw();
const Long getTotalSmartPointerCounters() throw();
#endif

class PlonkBase
{
public:
    PlonkBase() throw() { }
    ~PlonkBase() { } // doesn't need to be virtual as we never need to call delete on a PlonkBase pointer
    static void* operator new (size_t size); 
    static void operator delete (void* ptr);
    static void* operator new[] (size_t size); 
    static void operator delete[] (void* ptr);

};

class SmartPointer : public PlonkBase
{
public:
        
        
        SmartPointer (const bool allocateWeakPointer = true) throw();
    virtual ~SmartPointer(); // MUST be virtual unless PlonkBase gains the need to be virtual    
    
        void incrementRefCount() throw();    
    void decrementRefCount() throw();
    
        
        
//    inline void update (Text const& message, Dynamic const& payload) throw() { (void)message; (void)payload; } // needed as a dummy in place of Sender::update?
    void* getWeak() const throw();
    int getRefCount() const throw();
    
    virtual SmartPointer* deepCopy() const throw() { return 0; }
    
    
    friend class WeakPointer;
    
protected:    
    SmartPointerCounter* counter;
    AtomicValue<void*> weakPointer;
        
private:
        SmartPointer (const SmartPointer&);
    SmartPointer& operator= (const SmartPointer&);
};

//------------------------------------------------------------------------------

class SmartPointerCounter : public PlonkBase
{
public:
    SmartPointerCounter (SmartPointer* smartPointer) throw();    
    ~SmartPointerCounter();    
    
    SmartPointer* getSmartPointer() const throw();
    
    void incrementRefCount() throw();    
    void decrementRefCount() throw();
    int getRefCount() const throw();   
    
    void incrementWeakCount() throw();    
    void decrementWeakCount() throw();
    int getWeakCount() const throw();    

    void incrementCounts() throw();    
    void decrementCounts() throw();    

private:
    AtomicExtended<SmartPointer*> atom;
    
//    struct Counts
//    {
//        unsigned int refCount:PLONK_HALFWORDBITS;
//        unsigned int weakCount:PLONK_HALFWORDBITS;
//    };
//    
//    struct Parts
//    {
//        SmartPointer* smartPointer;
//        Counts counts;    
//    };
//    
//    struct Halves
//    {
//        SmartPointer* ptr;
//        Long extra;
//    };
//    
//    union Element
//    {
//        Parts parts;
//        Halves halves;
//    };        
};


//------------------------------------------------------------------------------


#endif // PLONK_SMARTPOINTER_H