MetaModule.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/MetaModule.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_MetaModule_h
#define __PCL_MetaModule_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/MetaObject.h>
#include <pcl/String.h>
#include <pcl/Variant.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class MetaModule : public MetaObject
{
public:
 
   MetaModule();
 
   ~MetaModule() override;
 
   MetaModule( const MetaModule& ) = delete;
 
   MetaModule& operator =( const MetaModule& ) = delete;
 
   virtual const char* UniqueId() const;
 
   virtual const char* Version() const = 0;
 
   void GetVersion( int& major, int& minor, int& release, int& build,
                            IsoString& language, IsoString& status ) const;
 
   IsoString ReadableVersion() const;
 
   virtual IsoString Name() const = 0;
 
   virtual String Description() const
   {
      return String();
   }
 
   virtual String Company() const
   {
      return String();
   }
 
   virtual String Author() const
   {
      return String();
   }
 
   virtual String Copyright() const
   {
      return String();
   }
 
   virtual String TradeMarks() const
   {
      return String();
   }
 
   virtual String OriginalFileName() const
   {
      return String();
   }
 
   virtual void GetReleaseDate( int& year, int& month, int& day ) const
   {
      year = month = day = 0; // unspecified
   }
 
   bool GetPhysicalMemoryStatus( size_type& totalBytes, size_type& availableBytes ) const;
 
   size_type AvailablePhysicalMemory() const
   {
      size_type dum, availableBytes;
      if ( GetPhysicalMemoryStatus( dum, availableBytes ) )
         return availableBytes;
      return 0;
   }
 
   float PhysicalMemoryLoad() const
   {
      size_type totalBytes, availableBytes;
      if ( GetPhysicalMemoryStatus( totalBytes, availableBytes ) )
         return float( 1 - double( availableBytes )/totalBytes );
      return 0;
   }
 
   virtual void* Allocate( size_type sz )
   {
      PCL_PRECONDITION( sz != 0 )
      return reinterpret_cast<void*>( ::operator new( sz ) );
   }
 
   virtual void Deallocate( void* p )
   {
      PCL_PRECONDITION( p != nullptr )
      ::operator delete( p );
   }
 
   virtual void OnLoad()
   {
   }
 
   virtual void OnUnload()
   {
   }
 
   bool IsInstalled() const;
 
   void ProcessEvents( bool excludeUserInputEvents = false );
 
   void LoadResource( const String& filePath, const String& rootPath = String() );
 
   void UnloadResource( const String& filePath, const String& rootPath = String() );
 
   Variant EvaluateScript( const String& sourceCode, const IsoString& language = IsoString() );
 
   bool HasEntitlement( const IsoString& entitlement );
 
private:
 
   void PerformAPIDefinitions() const override;
 
   friend class APIInitializer;
};
 
// ----------------------------------------------------------------------------
 
extern MetaModule* Module;
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace InstallMode
{
   enum value_type
   {
      FullInstall,     // Normal, full installation
      QueryModuleInfo, // Temporary load to gather module properties
      VerifyModule     // Temporary load to verify module integrity
   };
}
 
// ----------------------------------------------------------------------------
 
#define PCL_MODULE_UNIQUE_ID( uid ) \
               ("PIXINSIGHT_MODULE_UNIQUE_ID_" PCL_STRINGIFY( uid ))
 
#define PCL_MODULE_VERSION( MM, mm, rr, bbbb, lan )   \
               ("PIXINSIGHT_MODULE_VERSION_"          \
                PCL_STRINGIFY( MM )    "."            \
                PCL_STRINGIFY( mm )    "."            \
                PCL_STRINGIFY( rr )    "."            \
                PCL_STRINGIFY( bbbb )  "."            \
                PCL_STRINGIFY( lan ))
 
#define PCL_MODULE_VERSION_S( MM, mm, rr, bbbb, lan, status ) \
               ("PIXINSIGHT_MODULE_VERSION_"          \
                PCL_STRINGIFY( MM )    "."            \
                PCL_STRINGIFY( mm )    "."            \
                PCL_STRINGIFY( rr )    "."            \
                PCL_STRINGIFY( bbbb )  "."            \
                PCL_STRINGIFY( lan )   "."            \
                PCL_STRINGIFY( status ))
 
// ----------------------------------------------------------------------------
 
} // pcl
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
// end global namespace
 
#endif   // __PCL_MetaModule_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MetaModule.h - Released 2024-01-13T15:47:58Z