itkLightObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkLightObject_h
#define __itkLightObject_h

#include "itkMacro.h"
#include "itkSmartPointer.h"
#include "itkTimeStamp.h"
#include "itkIndent.h"
#include "itkSimpleFastMutexLock.h"

#include <iostream>
#include <typeinfo>

#if defined( _WIN32 )
// To get LONG defined
  #include "itkWindows.h"
#elif defined( __APPLE__ )
// To get MAC_OS_X_VERSION_MIN_REQUIRED defined
  #include <AvailabilityMacros.h>
#endif

namespace itk
{
class ITKCommon_EXPORT LightObject
{
public:
  typedef LightObject                Self;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  static Pointer New();

  virtual Pointer CreateAnother() const;

  itkCloneMacro(Self);

  virtual void Delete();

  virtual const char * GetNameOfClass() const
  { return "LightObject"; }

#ifdef _WIN32

  void * operator new(size_t);

  void * operator new[](size_t);

  void operator delete(void *);

  void operator delete[](void *, size_t);

#endif

  void Print(std::ostream & os, Indent indent = 0) const;

  static void BreakOnError();

  virtual void Register() const;

  virtual void UnRegister() const;

  virtual int GetReferenceCount() const
  { return static_cast< int >( m_ReferenceCount ); }

  virtual void SetReferenceCount(int);

protected:
  LightObject():m_ReferenceCount(1) {}
  virtual ~LightObject();

  virtual void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void PrintHeader(std::ostream & os, Indent indent) const;

  virtual void PrintTrailer(std::ostream & os, Indent indent) const;

  virtual LightObject::Pointer InternalClone() const;

#if ( defined( WIN32 ) || defined( _WIN32 ) )
  typedef LONG InternalReferenceCountType;
#elif defined( __APPLE__ ) && ( MAC_OS_X_VERSION_MIN_REQUIRED >= 1050 )
 #if defined ( __LP64__ ) && __LP64__
  typedef volatile int64_t InternalReferenceCountType;
 #else
  typedef volatile int32_t InternalReferenceCountType;
 #endif
#elif defined( __GLIBCPP__ ) || defined( __GLIBCXX__ )
  typedef _Atomic_word InternalReferenceCountType;
#else
  typedef int InternalReferenceCountType;
#endif


  mutable InternalReferenceCountType m_ReferenceCount;

  mutable SimpleFastMutexLock m_ReferenceCountLock;

private:
  LightObject(const Self &);    //purposely not implemented
  void operator=(const Self &); //purposely not implemented
};

std::ostream &
operator<<(std::ostream & os, const LightObject & o);

} // end namespace itk

#endif