SettingsData.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.9.3
// ----------------------------------------------------------------------------
// pcl/SettingsData.h - Released 2025-02-21T12:13:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2025 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_SettingsData_h
#define __PCL_SettingsData_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Variant.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
struct SettingsTree;
 
class PCL_CLASS SettingsData
{
public:
 
   SettingsData( const IsoString& identifier, bool universal = false );
 
   virtual ~SettingsData();
 
   bool IsUniversal() const
   {
      return m_universal;
   }
 
   bool IsEmpty() const;
 
   fsize_type FileSize() const;
 
   void Clear();
 
   bool Add( const IsoString& key, const Variant& value );
 
   bool Remove( const IsoString& key );
 
   Variant Search( const IsoString& key ) const;
 
   IsoStringList Keys( const IsoString& key ) const;
 
   IsoStringList AllKeys() const;
 
   bool IsMinifiedXMLEnabled() const
   {
      return m_minifyXML;
   }
 
   void EnableMinifiedXML( bool enable = true )
   {
      m_minifyXML = enable;
   }
 
   void DisableMinifiedXML( bool disable = true )
   {
      EnableMinifiedXML( !disable );
   }
 
   bool IsBlockCompressionEnabled() const
   {
      return m_compressBlocks;
   }
 
   void EnableBlockCompression( bool enable = true )
   {
      m_compressBlocks = enable;
   }
 
   void DisableBlockCompression( bool disable = true )
   {
      EnableBlockCompression( !disable );
   }
 
   unsigned CompressionThreshold() const
   {
      return m_compressionThreshold;
   }
 
   void SetCompressionThreshold( unsigned threshold )
   {
      m_compressionThreshold = Range( threshold, 256u, 65536u );
   }
 
   int ModifiedCount() const
   {
      return m_modifiedCount;
   }
 
   bool IsModified() const
   {
      return m_modifiedCount > 0;
   }
 
   virtual void Load();
 
   virtual void Save() const;
 
   virtual void Purge();
 
protected:
 
           AutoPointer<SettingsTree> m_root;
           IsoString                 m_identifier;
           bool                      m_universal = false;
           String                    m_filePath;
           bool                      m_minifyXML = true;
           bool                      m_compressBlocks = true;
           unsigned                  m_compressionThreshold = 4096;
   mutable Mutex                     m_mutex;
   mutable int                       m_modifiedCount = 0;
 
   static IsoStringList TokenizedKey( const IsoString& );
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_SettingsData_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SettingsData.h - Released 2025-02-21T12:13:32Z