MetaParameter.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/MetaParameter.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_MetaParameter_h
#define __PCL_MetaParameter_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/MetaObject.h>
#include <pcl/String.h>
 
#include <float.h> // DBL_MAX
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaProcess;
class PCL_CLASS MetaTable;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaParameter : public MetaObject
{
public:
 
   MetaParameter( MetaProcess* P );
 
   MetaParameter( MetaTable* T );
 
   ~MetaParameter() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const = 0;
 
   virtual IsoString Aliases() const
   {
      return IsoString();
   }
 
   virtual bool NeedsUnlocking() const
   {
      return false;
   }
 
   virtual bool NeedsValidation() const
   {
      return false;
   }
 
   // ### Undocumented
   virtual uint32 FirstProcessVersion() const
   {
      return 0;
   }
 
   // ### Undocumented
   virtual uint32 LastProcessVersion() const
   {
      return 0;
   }
 
   virtual bool IsRequired() const
   {
      return false;
   }
 
   virtual bool IsReadOnly() const
   {
      return false;
   }
 
   virtual String Description() const
   {
      return String();
   }
 
   virtual String Comment() const
   {
      return String();
   }
 
   virtual bool IsNumeric() const
   {
      return false;
   }
 
   virtual bool IsBoolean() const
   {
      return false;
   }
 
   virtual bool IsEnumeration() const
   {
      return false;
   }
 
   virtual bool IsVariableLength() const
   {
      return false;
   }
 
   virtual bool IsString() const
   {
      return false;
   }
 
   virtual bool IsTable() const
   {
      return false;
   }
 
   virtual bool IsBlock() const
   {
      return false;
   }
 
protected:
 
   void PerformAPIDefinitions() const override;
 
   virtual void PerformTypeAPIDefinitions() const
   {
   }
 
   virtual uint32 APIParType() const = 0;
 
   static bool inTableDefinition;
 
   friend class MetaTable;
   friend class MetaProcess;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaNumeric : public MetaParameter
{
public:
 
   MetaNumeric( MetaProcess* P )
      : MetaParameter( P )
   {
   }
 
   MetaNumeric( MetaTable* T )
      : MetaParameter( T )
   {
   }
 
   ~MetaNumeric() noexcept( false ) override
   {
   }
 
   bool IsNumeric() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   virtual bool IsReal() const
   {
      return false;
   }
 
   virtual bool IsInteger() const
   {
      return false;
   }
 
   virtual double DefaultValue() const
   {
      return 0;
   }
 
   virtual double MinimumValue() const
   {
      return -DBL_MAX;
   }
 
   virtual double MaximumValue() const
   {
      return +DBL_MAX;
   }
 
protected:
 
   void PerformTypeAPIDefinitions() const override;
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaInteger : public MetaNumeric
{
public:
 
   MetaInteger( MetaProcess* P )
      : MetaNumeric( P )
   {
   }
 
   MetaInteger( MetaTable* T )
      : MetaNumeric( T )
   {
   }
 
   ~MetaInteger() noexcept( false ) override
   {
   }
 
   bool IsInteger() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   virtual bool IsSigned() const = 0;
 
private:
 
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaUnsignedInteger : public MetaInteger
{
public:
 
   MetaUnsignedInteger( MetaProcess* P )
      : MetaInteger( P )
   {
   }
 
   MetaUnsignedInteger( MetaTable* T )
      : MetaInteger( T )
   {
   }
 
   ~MetaUnsignedInteger() noexcept( false ) override
   {
   }
 
   bool IsSigned() const override
   {
      return false;
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaSignedInteger : public MetaInteger
{
public:
 
   MetaSignedInteger( MetaProcess* P )
      : MetaInteger( P )
   {
   }
 
   MetaSignedInteger( MetaTable* T )
      : MetaInteger( T )
   {
   }
 
   ~MetaSignedInteger() noexcept( false ) override
   {
   }
 
   bool IsSigned() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaUInt8 : public MetaUnsignedInteger
{
public:
 
   MetaUInt8( MetaProcess* P )
      : MetaUnsignedInteger( P )
   {
   }
 
   MetaUInt8( MetaTable* T )
      : MetaUnsignedInteger( T )
   {
   }
 
   ~MetaUInt8() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaUInt16 : public MetaUnsignedInteger
{
public:
 
   MetaUInt16( MetaProcess* P )
      : MetaUnsignedInteger( P )
   {
   }
 
   MetaUInt16( MetaTable* T )
      : MetaUnsignedInteger( T )
   {
   }
 
   ~MetaUInt16() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaUInt32 : public MetaUnsignedInteger
{
public:
 
   MetaUInt32( MetaProcess* P )
      : MetaUnsignedInteger( P )
   {
   }
 
   MetaUInt32( MetaTable* T )
      : MetaUnsignedInteger( T )
   {
   }
 
   ~MetaUInt32() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaUInt64 : public MetaUnsignedInteger
{
public:
 
   MetaUInt64( MetaProcess* P )
      : MetaUnsignedInteger( P )
   {
   }
 
   MetaUInt64( MetaTable* T )
      : MetaUnsignedInteger( T )
   {
   }
 
   ~MetaUInt64() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaInt8 : public MetaSignedInteger
{
public:
 
   MetaInt8( MetaProcess* P )
      : MetaSignedInteger( P )
   {
   }
 
   MetaInt8( MetaTable* T )
      : MetaSignedInteger( T )
   {
   }
 
   ~MetaInt8() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class MetaInt16 : public MetaSignedInteger
{
public:
 
   MetaInt16( MetaProcess* P )
      : MetaSignedInteger( P )
   {
   }
 
   MetaInt16( MetaTable* T )
      : MetaSignedInteger( T )
   {
   }
 
   ~MetaInt16() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaInt32 : public MetaSignedInteger
{
public:
 
   MetaInt32( MetaProcess* P )
      : MetaSignedInteger( P )
   {
   }
 
   MetaInt32( MetaTable* T )
      : MetaSignedInteger( T )
   {
   }
 
   ~MetaInt32() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaInt64 : public MetaSignedInteger
{
public:
 
   MetaInt64( MetaProcess* p )
      : MetaSignedInteger( p )
   {
   }
 
   MetaInt64( MetaTable* t )
      : MetaSignedInteger( t )
   {
   }
 
   ~MetaInt64() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaReal : public MetaNumeric
{
public:
 
   MetaReal( MetaProcess* P )
      : MetaNumeric( P )
   {
   }
 
   MetaReal( MetaTable* T )
      : MetaNumeric( T )
   {
   }
 
   ~MetaReal() noexcept( false ) override
   {
   }
 
   bool IsReal() const override
   {
      return true;
   }
 
   virtual int Precision() const
   {
      return -1; // printf's g format
   }
 
   virtual bool ScientificNotation() const
   {
      return false;
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   void PerformTypeAPIDefinitions() const override;
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaFloat : public MetaReal
{
public:
 
   MetaFloat( MetaProcess* P )
      : MetaReal( P )
   {
   }
 
   MetaFloat( MetaTable* T )
      : MetaReal( T )
   {
   }
 
   ~MetaFloat() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaDouble : public MetaReal
{
public:
 
   MetaDouble( MetaProcess* P )
      : MetaReal( P )
   {
   }
 
   MetaDouble( MetaTable* T )
      : MetaReal( T )
   {
   }
 
   ~MetaDouble() noexcept( false ) override
   {
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaBoolean : public MetaParameter
{
public:
 
   MetaBoolean( MetaProcess* P )
      : MetaParameter( P )
   {
   }
 
   MetaBoolean( MetaTable* T )
      : MetaParameter( T )
   {
   }
 
   ~MetaBoolean() noexcept( false ) override
   {
   }
 
   bool IsBoolean() const override
   {
      return true;
   }
 
   virtual bool DefaultValue() const
   {
      return false;
   }
 
   virtual IsoString Id() const override = 0;
 
private:
 
   void PerformTypeAPIDefinitions() const override;
   uint32 APIParType() const override;
};
 
class PCL_CLASS pcl_bool
{
public:
 
   pcl_bool() = default;
 
   template <typename T> pcl_bool( const T& value )
      : m_value( value ? 1 : 0 )
   {
   }
 
   template <typename T> pcl_bool& operator =( const T& value )
   {
      m_value = value ? 1 : 0;
      return *this;
   }
 
   constexpr operator bool() const
   {
      return m_value != 0;
   }
 
#ifndef _MSC_VER
 
   constexpr operator int() const
   {
      return int( m_value );
   }
 
#endif // !_MSC_VER
 
   constexpr bool operator ==( const pcl_bool& b ) const
   {
      return m_value == b.m_value;
   }
 
   constexpr bool operator <( const pcl_bool& b ) const
   {
      return m_value < b.m_value;
   }
 
private:
 
   int32 m_value = 0; // MetaBoolean equivalent type
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaEnumeration : public MetaParameter
{
public:
 
   MetaEnumeration( MetaProcess* P )
      : MetaParameter( P )
   {
   }
 
   MetaEnumeration( MetaTable* T )
      : MetaParameter( T )
   {
   }
 
   ~MetaEnumeration() noexcept( false ) override
   {
   }
 
   bool IsEnumeration() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   virtual size_type NumberOfElements() const = 0;
 
   virtual IsoString ElementId( size_type idx ) const = 0;
 
   virtual int ElementValue( size_type idx ) const = 0;
 
   virtual size_type DefaultValueIndex() const
   {
      return 0;
   }
 
   virtual IsoString ElementAliases() const
   {
      return IsoString();
   }
 
private:
 
   void PerformTypeAPIDefinitions() const override;
   uint32 APIParType() const override;
};
 
using pcl_enum = int32;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaVariableLengthParameter : public MetaParameter
{
public:
 
   MetaVariableLengthParameter( MetaProcess* P )
      : MetaParameter( P )
   {
   }
 
   MetaVariableLengthParameter( MetaTable* T )
      : MetaParameter( T )
   {
   }
 
   ~MetaVariableLengthParameter() noexcept( false ) override
   {
   }
 
   bool IsVariableLength() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   virtual size_type MinLength() const
   {
      return 0; // can be empty
   }
 
   virtual size_type MaxLength() const
   {
      return 0; // unlimited length
   }
 
private:
 
   virtual void PerformTypeAPIDefinitions() const override = 0;
   virtual uint32 APIParType() const override = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaString : public MetaVariableLengthParameter
{
public:
 
   MetaString( MetaProcess* P )
      : MetaVariableLengthParameter( P )
   {
   }
 
   MetaString( MetaTable* T )
      : MetaVariableLengthParameter( T )
   {
   }
 
   ~MetaString() noexcept( false ) override
   {
   }
 
   bool IsString() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   virtual String DefaultValue() const
   {
      return String();
   }
 
   virtual String AllowedCharacters() const
   {
      return String(); // any character is valid
   }
 
private:
 
   void PerformTypeAPIDefinitions() const override;
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaTable : public MetaVariableLengthParameter
{
public:
 
   MetaTable( MetaProcess* P )
      : MetaVariableLengthParameter( P )
   {
   }
 
   ~MetaTable() noexcept( false ) override
   {
   }
 
   bool IsTable() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   const MetaParameter* operator[]( size_type i ) const;
 
private:
 
   // Nested tables are not allowed.
   MetaTable( MetaTable* );
 
   void PerformTypeAPIDefinitions() const override;
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaBlock : public MetaVariableLengthParameter
{
public:
 
   MetaBlock( MetaProcess* p )
      : MetaVariableLengthParameter( p )
   {
   }
 
   MetaBlock( MetaTable* t )
      : MetaVariableLengthParameter( t )
   {
   }
 
   ~MetaBlock() noexcept( false ) override
   {
   }
 
   bool IsBlock() const override
   {
      return true;
   }
 
   virtual IsoString Id() const override = 0;
 
   enum data_interpretation
   {
      DataAsUInt8,   // 8-bit unsigned integers
      DataAsInt8,    // 8-bit signed integers
      DataAsUInt16,  // 16-bit unsigned integers
      DataAsInt16,   // 16-bit signed integers
      DataAsUInt32,  // 32-bit unsigned integers
      DataAsInt32,   // 32-bit signed integers
      DataAsUInt64,  // 64-bit unsigned integers
      DataAsInt64,   // 64-bit signed integers
      DataAsFloat,   // float (32-bit IEEE 754 floating point)
      DataAsDouble   // double (64-bit IEEE 754 floating point)
   };
 
   virtual data_interpretation DataInterpretation() const
   {
      return DataAsUInt8;
   }
 
private:
 
   void PerformTypeAPIDefinitions() const override;
   uint32 APIParType() const override;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_MetaParameter_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MetaParameter.h - Released 2024-01-13T15:47:58Z