UIObject.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/UIObject.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_UIObject_h
#define __PCL_UIObject_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Relational.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS UIObject
{
public:
 
   virtual ~UIObject() noexcept( false );
 
   bool IsNull() const
   {
      return handle == nullptr;
   }
 
   static UIObject& Null();
 
   size_type RefCount() const;
 
   bool IsUnique() const
   {
      return RefCount() < 2;
   }
 
   bool IsAlias() const
   {
      return alias;
   }
 
   bool IsGarbage() const
   {
      return RefCount() < 1;
   }
 
   bool IsSameObject( const UIObject& o ) const
   {
      return handle == o.handle;
   }
 
   virtual void EnsureUnique();
 
   bool operator ==( const UIObject& o ) const
   {
      return IsSameObject( o );
   }
 
   bool operator <( const UIObject& o ) const
   {
      return handle < o.handle;
   }
 
   IsoString ObjectType() const;
 
   String ObjectId() const;
 
   void SetObjectId( const String& id );
 
protected:
 
   void* handle = nullptr;
   bool  alias  = false;
 
   UIObject() = default;
 
   UIObject( const UIObject& x );
 
   UIObject( UIObject&& x )
      : handle( x.handle )
      , alias( x.alias )
   {
      x.handle = nullptr;
      x.alias = false;
   }
 
   UIObject& operator =( const UIObject& x )
   {
      Assign( x );
      return *this;
   }
 
   UIObject& operator =( UIObject&& x )
   {
      Transfer( x );
      return *this;
   }
 
   UIObject( void* );
 
   UIObject( const void* );
 
   UIObject( std::nullptr_t )
   {
   }
 
   void SetHandle( void* );
 
   void TransferHandle( void* );
 
   virtual void* CloneHandle() const
   {
      return nullptr;
   }
 
   bool Assign( const UIObject& x )
   {
      if ( x.handle != handle )
      {
         SetHandle( x.handle );
         return true;
      }
      return false;
   }
 
   bool Transfer( UIObject& x )
   {
      if ( &x != this )
      {
         SetHandle( nullptr );
         handle = x.handle;
         alias = x.alias;
         x.handle = nullptr;
         x.alias = false;
         return true;
      }
      return false;
   }
 
   friend class UIObjectIndex;
   friend class UIEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_UIObject_h
 
// ----------------------------------------------------------------------------
// EOF pcl/UIObject.h - Released 2024-01-13T15:47:58Z