SoRefCounter.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef SO_REF_COUNTER_H
#define SO_REF_COUNTER_H
 
#include <stdio.h>
#include <Inventor/SbBase.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/errors/SoDebugError.h>
#include <functional>
 
class SoRefCounter;
 
// callback function prototypes
typedef void SoBaseRefCountCB(void *userData, const SoRefCounter *base);
 

class  SoRefCounter
{
public:
    void ref() const;

    void unref() const;

    void unrefNoDelete() const;

    inline int getRefCount() const
    { return m_refcount; }

    inline void lock() const
    { m_refMutex.lock(); }

    inline void unlock() const
    { m_refMutex.unlock(); }
 
 
private:
    static void initClass();

    static void exitClass();
 
    struct OnDeleteCB{
      SoRefCounter* context;
      std::function<void(SoRefCounter* caller, SoRefCounter* context)> callback;
      bool isValid;
      OnDeleteCB(SoRefCounter* ptr, const std::function<void(SoRefCounter* caller, SoRefCounter* context)> &cb): context(ptr), callback(cb), isValid(true){}
    };

    static void setRefCountCallback(SoBaseRefCountCB *f)
    { s_refCountCBFunc = f; }

    void setRefCountCallbackData(void *userData = NULL)
    { m_refCountCBData = userData; }

    void invokeRefCountCB() const;

    static inline void setTraceRefs(const bool enable)
    { s_traceRefs = enable; }

    static inline SbBool getTraceRefs()
    { return s_traceRefs; }

    void setRefCount(const int count);
 
    // Add callback function called juste before object deletion. If a context is used, this callback is automaticaly removed when the context object is deleted.
    void addOnDeleteCB(SoRefCounter *context, const std::function<void()> &callBackFunction);
    void addOnDeleteCB(SoRefCounter *context, const std::function<void(SoRefCounter* caller)> &callBackFunction);
    void addOnDeleteCB(SoRefCounter *context, const std::function<void(SoRefCounter* caller, SoRefCounter* context)> &callBackFunction);
    void addOnDeleteCB(const std::function<void()> &callBackFunction);
    void addOnDeleteCB(const std::function<void(SoRefCounter* caller)> &callBackFunction);
 
 
  private:
    SoRefCounter();

    SoRefCounter(const SoRefCounter &);

    SoRefCounter & operator=(const SoRefCounter &)
    { return *this; }

    virtual ~SoRefCounter();
 

    virtual bool notifyDelete() const
    { return true; }

    virtual void destroy()
    { delete this; }
 
private:
  static bool s_traceRefs;

  static SoBaseRefCountCB* s_refCountCBFunc;
  void* m_refCountCBData;

  mutable int m_refcount;
  mutable SbThreadSpinlock m_refMutex;
 
  // OnDeleteCB handling
  std::vector<OnDeleteCB> *m_onDeleteCBVec;
  std::vector<SoRefCounter*> *m_contextVec;
  void cleanUpContextsCB();
  void cleanUpContextsLists();
 
};

#define SO_UNREF_RESET(object)\
{\
  if ( object )\
  {\
    object->unref();\
    object=NULL;\
  }\
}
 
// Included here to provide this service by default everywhere SoRefCounter 
// is already used, avoiding app to add a #include <Inventor/misc/SoAutoRef.h>
#include <Inventor/misc/SoAutoRef.h>
 
#endif // SO_REF_COUNTER_H