berryObject.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef BERRYOBJECT_H_
#define BERRYOBJECT_H_
 
#include <org_blueberry_core_runtime_Export.h>
 
#include "berryMacros.h"
#include "berryMessage.h"
 
#include <berryConfig.h>
 
#include <QString>
#include <QMetaType>
#include <QMutex>
#include <QAtomicInt>
 
class QDebug;
class QTextStream;
 
namespace berry {
 
class org_blueberry_core_runtime_EXPORT Indent
{
 
public:
 
  typedef Indent  Self;
 
  Indent(int ind = 0) { m_Indent=ind; }
 
  Indent GetNextIndent();
 
  friend org_blueberry_core_runtime_EXPORT QDebug operator<<(QDebug os, const Indent& o);
 
private:
 
  int m_Indent;
};
 
 
class org_blueberry_core_runtime_EXPORT Object
{
 
private:
 
  mutable Message<> m_DestroyMessage;
 
public:
 
  typedef Object Self;
  typedef berry::SmartPointer<Self> Pointer;
  typedef berry::SmartPointer<const Self>  ConstPointer;
  typedef berry::WeakPointer<Self> WeakPtr;
  typedef berry::WeakPointer<const Self> ConstWeakPtr;
 
  static const char* GetStaticClassName();
  virtual QString GetClassName() const;
 
  static Reflection::TypeInfo GetStaticTypeInfo();
  virtual Reflection::TypeInfo GetTypeInfo() const;
 
  static QList<Reflection::TypeInfo> GetStaticSuperclasses();
  virtual QList<Reflection::TypeInfo> GetSuperclasses() const;
 
  virtual void Delete();
 
  QDebug Print(QDebug os, Indent Indent=0) const;
 
  virtual QString ToString() const;
 
  virtual uint HashCode() const;
 
  virtual bool operator<(const Object*) const;
 
  void Register() const;
 
  void UnRegister(bool del = true) const;
 
  int GetReferenceCount() const
  {
    return m_ReferenceCount.loadRelaxed();
  }
 
  void SetReferenceCount(int);
 
  inline void AddDestroyListener(const MessageAbstractDelegate<>& delegate) const
  { m_DestroyMessage += delegate; }
  inline void RemoveDestroyListener(const MessageAbstractDelegate<>& delegate) const
  { m_DestroyMessage -= delegate; }
 
 
  virtual bool operator==(const Object*) const;
 
#ifdef BLUEBERRY_DEBUG_SMARTPOINTER
  unsigned int GetTraceId() const;
private:
  unsigned int m_TraceId;
  unsigned int& GetTraceIdCounter() const;
public:
#endif
 
protected:
 
  friend struct QScopedPointerObjectDeleter;
 
  Object();
  virtual ~Object();
 
  virtual QDebug PrintSelf(QDebug os, Indent indent) const;
  virtual QDebug PrintHeader(QDebug os, Indent indent) const;
  virtual QDebug PrintTrailer(QDebug os, Indent indent) const;
 
  mutable QAtomicInt m_ReferenceCount;
 
  mutable QMutex m_ReferenceCountLock;
 
private:
 
  Object(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
 
};
 
// A custom deleter for QScopedPointer
// berry::Object instances in a QScopedPointer should have reference count one,
// such that they are not accidentally deleted when a temporary smart pointer
// pointing to it goes out of scope. This deleter fixes the reference count and
// always deletes the instance. Use a berry::SmartPointer if the lifetime should
// exceed the one of the pointer.
struct QScopedPointerObjectDeleter
{
  static inline void cleanup(Object* obj)
  {
    if (obj == nullptr) return;
    obj->UnRegister(false);
    delete obj;
  }
};
 
org_blueberry_core_runtime_EXPORT QDebug operator<<(QDebug os, const berry::Indent& o);
 
}
 
org_blueberry_core_runtime_EXPORT QDebug operator<<(QDebug os, const berry::Object& o);
org_blueberry_core_runtime_EXPORT QDebug operator<<(QDebug os, const berry::SmartPointer<const berry::Object>& o);
org_blueberry_core_runtime_EXPORT QDebug operator<<(QDebug os, const berry::SmartPointer<berry::Object>& o);
 
org_blueberry_core_runtime_EXPORT QTextStream& operator<<(QTextStream& os, const berry::Object& o);
org_blueberry_core_runtime_EXPORT QTextStream& operator<<(QTextStream& os, const berry::SmartPointer<const berry::Object>& o);
//org_blueberry_core_runtime_EXPORT QTextStream& operator<<(QTextStream& os, const berry::SmartPointer<berry::Object>& o);
 
Q_DECLARE_METATYPE(berry::Object::Pointer)
 
org_blueberry_core_runtime_EXPORT uint qHash(const berry::Object& o);
 
#endif /*BERRYOBJECT_H_*/