Settings.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Settings.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_Settings_h
#define __PCL_Settings_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ByteArray.h>
#include <pcl/String.h>
 
#ifndef __PCL_NO_FLAGS_SETTINGS_IO
#  include <pcl/Flags.h>
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Settings
{
public:
 
   Settings() = delete;
 
   Settings( const Settings& ) = delete;
 
   Settings& operator =( const Settings& ) = delete;
 
   ~Settings() = delete;
 
   static bool Read( const IsoString& key, ByteArray& b );
 
   static bool ReadGlobal( const IsoString& key, ByteArray& b );
 
   static bool Read( const IsoString& key, String& s );
 
   static bool ReadGlobal( const IsoString& key, String& s );
 
   static bool Read( const IsoString& key, bool& b );
 
   static bool ReadGlobal( const IsoString& key, bool& b );
 
   static bool Read( const IsoString& key, int& i );
 
   static bool ReadGlobal( const IsoString& key, int& i );
 
   static bool Read( const IsoString& key, unsigned& u );
 
   static bool ReadGlobal( const IsoString& key, unsigned& u );
 
   static bool Read( const IsoString& key, double& f );
 
   static bool ReadGlobal( const IsoString& key, double& f );
 
   static bool Read( const IsoString& key, float& f )
   {
      double d; Read( key, d );
      if ( LastReadOK() ) { f = float( d ); return true; }
      return false;
   }
 
   static bool ReadGlobal( const IsoString& key, float& f )
   {
      double d; ReadGlobal( key, d );
      if ( LastReadOK() ) { f = float( d ); return true; }
      return false;
   }
 
#ifndef __PCL_NO_SETTINGS_TEMPLATES
 
   template <typename T>
   static bool ReadI( const IsoString& key, T& t )
   {
      int i; Read( key, i );
      if ( LastReadOK() ) { t = T( i ); return true; }
      return false;
   }
 
 
   template <typename T>
   static bool ReadU( const IsoString& key, T& t )
   {
      unsigned u; Read( key, u );
      if ( LastReadOK() ) { t = T( u ); return true; }
      return false;
   }
 
#endif
 
#ifndef __PCL_NO_FLAGS_SETTINGS_IO
 
   template <typename E>
   static bool Read( const IsoString& key, Flags<E>& f )
   {
      return Read( key, f.m_flags );
   }
 
   template <typename E>
   static bool ReadGlobal( const IsoString& key, Flags<E>& f )
   {
      return ReadGlobal( key, f.m_flags );
   }
 
#endif
 
   static bool LastReadOK();
 
   static void Write( const IsoString& key, const ByteArray& b );
 
   static void WriteGlobal( const IsoString& key, const ByteArray& b );
 
   static void Write( const IsoString& key, const String& s );
 
   static void WriteGlobal( const IsoString& key, const String& s );
 
   static void Write( const IsoString& key, bool b );
 
   static void WriteGlobal( const IsoString& key, bool b );
 
   static void Write( const IsoString& key, int i );
 
   static void WriteGlobal( const IsoString& key, int i );
 
   static void Write( const IsoString& key, unsigned u );
 
   static void WriteGlobal( const IsoString& key, unsigned u );
 
   static void Write( const IsoString& key, double f );
 
   static void WriteGlobal( const IsoString& key, double f );
 
   static void Write( const IsoString& key, float f )
   {
      Write( key, double( f ) );
   }
 
   static void WriteGlobal( const IsoString& key, float f )
   {
      WriteGlobal( key, double( f ) );
   }
 
#ifndef __PCL_NO_SETTINGS_TEMPLATES
 
   template <typename T>
   static void WriteI( const IsoString& key, T t )
   {
      Write( key, int( t ) );
   }
 
   template <typename T>
   static void WriteU( const IsoString& key, T t )
   {
      Write( key, unsigned( t ) );
   }
 
#endif
 
#ifndef __PCL_NO_FLAGS_SETTINGS_IO
 
   template <typename E>
   static void Write( const IsoString& key, Flags<E> f )
   {
      Write( key, f.m_flags );
   }
 
   template <typename E>
   static void WriteGlobal( const IsoString& key, Flags<E> f )
   {
      WriteGlobal( key, f.m_flags );
   }
 
#endif
 
   static void Remove( const IsoString& key );
 
   static void RemoveGlobal( const IsoString& key );
 
   static bool CanReadGlobal( const IsoString& key );
 
   static bool CanWriteGlobal( const IsoString& key );
 
   static void SetGlobalKeyAccess( const IsoString& key, bool allowRead, bool allowWrite );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_Settings_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Settings.h - Released 2024-01-13T15:47:58Z