SoDeviceContextSharedGroup.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-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Oct 2010)
**=======================================================================*/
 
#if !defined SO_DEVICE_CONTEXT_SHARE_GROUP_H
#define SO_DEVICE_CONTEXT_SHARE_GROUP_H
 
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/STL/set>
#include <Inventor/threads/SbThreadMutex.h>
#include <Inventor/devices/SoSharedGroupReferenceList.h>
#include <Inventor/SbEventHandler.h>
 
class SoDeviceContext;
class SoBaseContextCache;
class SoBaseContextObject;
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
class  SoDeviceContextSharedGroup : public SoRefCounter
{
public:
  typedef std::set<SoDeviceContext*> SoDeviceContextSet;
 
  SoDeviceContextSharedGroup();
 
  SoDeviceContextSharedGroup(int id);
 
  void add(SoDeviceContext* ctx);
 
  void remove(SoDeviceContext* ctx);
  
  void setId( int id );
 
  int getId() const;
 
  const SoDeviceContextSet& getContexts() const;
 
  SoDeviceContext* getPrimaryContext() const;
 
  bool contains(const SoDeviceContext* ctx) const;
  
  void ref(SoBaseContextCache* object = NULL);
 
  void unref(SoBaseContextCache* object = NULL);
 
 
  bool contains(SoBaseContextCache* object) const;
 
  virtual void dispose();
 
private:
  typedef int SharedGroupId;
 
  void setDisposeCallback(void (*f)(SoDeviceContextSharedGroup*));
 
  void setDestroyNotificationCallback(void (*f)(SoDeviceContextSharedGroup*));
  
  void setTargetMergedGroup(SoDeviceContextSharedGroup* sharedGroup);
 
  void addToPendingDeleteList(SoBaseContextObject *obj);
 
  static void checkRefIssues(SoBaseContextObject* object);
  static void checkRefIssues(SoBaseContextCache* cache);
 
  void clearPendingDeleteList();
 
  void setDisposing( bool b );
  
  SbThreadId_t getThreadId() const;
 
  static int getNewSharedIdGroup();
 
  static void printSharedGroups();
 
  bool hasValidContext() const;
 
  SoDeviceContext* getPrimaryValidContext() const;
 
  // return debugging trace level requested
  static int getDebuggingLevel()
  { return s_debuggingLevel; }
 
  inline static int getFallbackContextGlobalSharedId()
  {
    return -2;
  }
  
  static SoDeviceContextSharedGroup* getSharedGroupFromId( SharedGroupId id );
 
private:
 
  virtual ~SoDeviceContextSharedGroup();
 
  void forceReleaseAttachedObject();
 
  bool m_isDisposing;
 
private:
 
  void commonConstructor();
 
  // Returns the context to use for delete operation
  // - if currently binded context is in the shared group then use it
  // - else use the first available context in the group (getPrimaryValidContext())
  SoDeviceContext* getDeviceContextToBindForDelete() const;
 
  SoDeviceContextSet m_ctxSet;
  int m_id;
  SoDeviceContextSharedGroup* m_mergedGroup;
 
  typedef std::list<SoDeviceContextSharedGroup*> SoDeviceContexSharedGroupList;
  static SbThreadSpinlock s_sharedGroupListLock;
  static SoDeviceContexSharedGroupList s_sharedGroupList;
  static int s_sharedGroupId;
 
  typedef std::list<SoBaseContextCache*> SoBaseContextCacheList;
  SoBaseContextCacheList m_listContextedObject;
  bool m_isClearingPendingList;
 
  SoSharedGroupReferenceList m_intrusivelistContextedObject;
 
  typedef std::set<SoBaseContextObject*> SoBaseContextObjectList;
  SoBaseContextObjectList m_waitingToBeFreed;
 
  SbThreadId_t m_threadId;
  
  mutable SbThreadMutex m_sharedGroupMembersMutex;
 
  // Controlled by environment variable IV_DEBUG_SHARED_GROUP
  // 0 means disabled
  // 1 means show weird situation
  // 2 means show more trace
  static int s_debuggingLevel;
 
  SbEventHandler<SoDeviceContextSharedGroup*> m_destroyNotificationCallback;
  SbEventHandler<SoDeviceContextSharedGroup*> m_disposeNotificationCallback;
};
 
// INLINE METHODS
inline void SoDeviceContextSharedGroup::setDisposing( bool b )
{
  m_isDisposing = b;
}
  
inline SbThreadId_t SoDeviceContextSharedGroup::getThreadId() const
{
  return m_threadId;
}
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif // SO_DEVICE_CONTEXT_SHARE_GROUP_H