ProcessImplementation.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/ProcessImplementation.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_ProcessImplementation_h
#define __PCL_ProcessImplementation_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/ImageWindow.h>
#include <pcl/MetaProcess.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MetaParameter;
class PCL_CLASS ProcessInterface;
class PCL_CLASS View;
class PCL_CLASS ImageWindow;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ProcessImplementation
{
public:
 
   ProcessImplementation( const MetaProcess* m )
      : meta( m )
   {
   }
 
   ProcessImplementation( const ProcessImplementation& ) = default;
 
   virtual ~ProcessImplementation()
   {
   }
 
   const MetaProcess* Meta() const
   {
      return meta;
   }
 
   uint32 Version() const;
 
   virtual void Initialize();
 
   virtual bool Validate( String& info );
 
   virtual void Assign( const ProcessImplementation& instance );
 
   virtual bool CanExecuteOn( const View& view, String& whyNot ) const;
 
   virtual bool IsHistoryUpdater( const View& view ) const
   {
      return true; // by default, all processes are supposed to update images.
   }
 
   virtual bool IsMaskable( const View& view, const ImageWindow& mask ) const
   {
      return true; // by default, all processes are supposed to be maskable.
   }
 
   virtual UndoFlags UndoMode( const View& view ) const
   {
      return UndoFlag::DefaultMode;
   }
 
   virtual bool BeforeExecution( View& view )
   {
      return true;
   }
 
   virtual bool ExecuteOn( View& view );
 
   virtual void AfterExecution( View& view )
   {
   }
 
   virtual bool CanExecuteOn( const ImageVariant& image, String& whyNot ) const;
 
   virtual bool ExecuteOn( ImageVariant& image, const IsoString& hints );
 
   virtual bool CanExecuteGlobal( String& whyNot ) const;
 
   virtual bool BeforeGlobalExecution()
   {
      return true;
   }
 
   virtual bool ExecuteGlobal();
 
   virtual void AfterGlobalExecution()
   {
   }
 
   virtual ProcessInterface* SelectInterface() const
   {
      return meta->DefaultInterface(); // by default, process instances use
                                       //   their default interfaces.
   }
 
   virtual bool IsValidInterface( const ProcessInterface* i ) const
   {
      return i == SelectInterface();
   }
 
   virtual bool BeforeReading()
   {
      return true;
   }
 
   virtual void AfterReading()
   {
   }
 
   virtual bool BeforeWriting() const
   {
      return true;
   }
 
   virtual void AfterWriting() const
   {
   }
 
   virtual void* LockParameter( const MetaParameter* p, size_type tableRow );
 
   virtual void UnlockParameter( const MetaParameter* p, size_type tableRow );
 
   virtual bool ValidateParameter( void* value, const MetaParameter* p, size_type tableRow ) const;
 
   virtual bool AllocateParameter( size_type sizeOrLength, const MetaParameter* p, size_type tableRow );
 
   virtual size_type ParameterLength( const MetaParameter* p, size_type tableRow ) const;
 
   void Launch() const;
 
   void LaunchInterface() const;
 
   void LaunchGlobal() const;
 
   void LaunchOnCurrentView() const;
 
   void LaunchOnCurrentWindow() const;
 
   void LaunchOn( View& ) const;
 
   void LaunchOn( ImageWindow& ) const;
 
protected:
 
   const MetaProcess* meta = nullptr;
 
private:
 
   mutable const void* m_serverHandle = nullptr;
 
   friend class ProcessContextDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ProcessImplementation_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ProcessImplementation.h - Released 2024-01-13T15:47:58Z