Inventor/SbPImpl.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/

#ifndef HIDDEN_FROM_DOC

#ifndef _SB_PIMPL_MACRO_H_
#define _SB_PIMPL_MACRO_H_


// Define supported C++ level for PIMPL design, not that
// C++ 11 is fully supported if __cplusplus >= 201103L.
// This value defines the way we store the implementation class:
// "0", using SoRef
// "1", using std::auto_ptr
// "2", using std::unique_ptr (c++ 11 should be at least partially supported)
#define OIV_PIMPL_CXX11 0

#if !(OIV_PIMPL_CXX11)
#include <Inventor/misc/SoRefCounter.h>
#else
#include <memory>
#endif

namespace inventor
{
namespace impl
{

template<typename PublicType>
#if !(OIV_PIMPL_CXX11)
class SbPImpl : public SoRefCounter
#else
class SbPImpl
#endif
{
public:

  SbPImpl( PublicType* p ) : m_public(p) {}

  virtual ~SbPImpl() {}

  template<typename SuperPublicType>
  SuperPublicType* getPublic () const { return static_cast<SuperPublicType*>(m_public); }

private:

  // public node
  PublicType* m_public;

private:

  // force using constructor with parameter
  SbPImpl () {}
};

} // namespace impl
} // namespace inventor

#define SO_PIMPL_PUBLIC_DECLARATION(Class) \
namespace inventor\
{\
namespace impl\
{\
class Class##Impl;\
}\
}

#define SO_PIMPL_BASE_PUBLIC_DECLARATION(Class) SO_PIMPL_PUBLIC_DECLARATION(Class)

#define SO_PIMPL_PUBLIC_HEADER(Class) \
SoINTERNAL private:\
  friend class inventor::impl::Class##Impl;\

  Class(inventor::impl::Class##Impl *impl);

#define SO_PIMPL_ABSTRACT_PUBLIC_HEADER(Class, ParentClass) \
SoINTERNAL private:\

  Class(inventor::impl::ParentClass##Impl *impl);

#define SO_PIMPL_FINAL_PUBLIC_HEADER(Class) \
SoINTERNAL private:\
  friend class inventor::impl::Class##Impl;

#if OIV_PIMPL_CXX11 == 0
#define SO_PIMPL_BASE_PUBLIC_HEADER(Class) \
SO_PIMPL_PUBLIC_HEADER(Class) \
  SoRef< inventor::impl::SbPImpl< Class > > m_impl; \

  template<typename ImplType> \
  ImplType* getImpl() const { \
    assert(m_impl->getPublic< Class >() == this); \
    return static_cast< ImplType *>(m_impl.ptr()); \
  } \

  void setImpl( inventor::impl::SbPImpl< Class >* impl ) { m_impl = impl; }
#elif OIV_PIMPL_CXX11 == 1
#define SO_PIMPL_BASE_PUBLIC_HEADER(Class) \
SO_PIMPL_PUBLIC_HEADER(Class) \
  std::auto_ptr< inventor::impl::SbPImpl< Class > > m_impl; \

  template<typename ImplType> \
  ImplType* getImpl() const { \
    assert(m_impl->getPublic< Class >() == this); \
    return static_cast< ImplType *>(m_impl.ptr()); \
  } \

  void setImpl ( inventor::impl::SbPImpl< Class >* impl ) { m_impl.reset(impl); }
#else
#define SO_PIMPL_BASE_PUBLIC_HEADER(Class) \
SO_PIMPL_PUBLIC_HEADER(Class);\
  std::unique_ptr< inventor::impl::SbPImpl< Class > > m_impl; \

  template<typename ImplType> \
  ImplType* getImpl() const { \
    assert(m_impl->getPublic< Class >() == this); \
    return static_cast< ImplType *>(m_impl.ptr()); \
  } \

  void setImpl( inventor::impl::SbPImpl< Class >* impl ) { m_impl.reset( impl ); }
#endif

#endif //_SB_PIMPL_MACRO_H_

#endif // HIDDEN_FROM_DOC

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/