ExternalProcess.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/ExternalProcess.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_ExternalProcess_h
#define __PCL_ExternalProcess_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Control.h>
#include <pcl/Flags.h>
#include <pcl/UIObject.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace ExternalProcessError
{
   enum value_type
   {
      FailedToStart,
      Crashed,
      TimedOut,
      ReadError,
      WriteError,
      UnknownError
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ExternalProcess : public UIObject
{
public:
 
#ifndef __PCL_WINDOWS
 
   using pid_type = int64;
#else
   using pid_type = void*;
#endif
 
   using error_code = ExternalProcessError::value_type;
 
   ExternalProcess();
 
   ~ExternalProcess() override
   {
   }
 
   ExternalProcess( const ExternalProcess& ) = delete;
 
   ExternalProcess& operator =( const ExternalProcess& ) = delete;
 
   ExternalProcess( ExternalProcess&& ) = delete;
 
   ExternalProcess& operator =( ExternalProcess&& ) = delete;
 
   void EnsureUnique() override
   {
   }
 
   static ExternalProcess& Null();
 
   void Start( const String& program, const StringList& arguments = StringList() );
 
   bool WaitForStarted( int ms = 6000 );
 
   bool WaitForFinished( int ms = 6000 );
 
   bool WaitForDataAvailable( int ms = 6000 );
 
   bool WaitForDataWritten( int ms = 6000 );
 
   void Terminate();
 
   void Kill();
 
   void CloseStandardInput();
 
   void CloseStandardOutput();
 
   void CloseStandardError();
 
   void RedirectStandardOutput( const String& filePath, bool append = false );
 
   void RedirectStandardOutput( ExternalProcess& process );
 
   void RedirectStandardError( const String& filePath, bool append = false );
 
   void RedirectStandardInput( const String& filePath );
 
   String WorkingDirectory() const;
 
   void SetWorkingDirectory( const String& dirPath );
 
   bool IsRunning() const;
 
   bool IsStarting() const;
 
   bool HasCrashed() const;
 
   pid_type PID() const;
 
   int ExitCode() const;
 
   size_type BytesAvailable() const;
 
   size_type BytesToWrite() const;
 
   ByteArray StandardOutput();
 
   ByteArray StandardError();
 
   ByteArray Read();
 
   void Write( const ByteArray& data );
 
   void Write( const String& text );
 
   void Write( const IsoString& text );
 
   void Write( const char* text );
 
   void Write( const void* data, size_type count );
 
   StringList Environment() const;
 
   void SetEnvironment( const StringList& environment );
 
   using process_event_handler = void (Control::*)( ExternalProcess& sender );
 
   using process_exit_event_handler = void (Control::*)( ExternalProcess& sender, int exitCode, bool exitOk );
 
   using process_error_event_handler = void (Control::*)( ExternalProcess& sender, error_code error );
 
   void OnStarted( process_event_handler handler, Control& receiver );
 
   void OnFinished( process_exit_event_handler handler, Control& receiver );
 
   void OnStandardOutputDataAvailable( process_event_handler handler, Control& receiver );
 
   void OnStandardErrorDataAvailable( process_event_handler handler, Control& receiver );
 
   void OnError( process_error_event_handler handler, Control& receiver );
 
   static int ExecuteProgram( const String& program, const StringList& arguments = StringList() );
 
   static pid_type StartProgram( const String& program,
                                 const StringList& arguments = StringList(),
                                 const String& workingDirectory = String() );
 
private:
 
   struct EventHandlers
   {
      process_event_handler       onStarted                     = nullptr;
      process_exit_event_handler  onFinished                    = nullptr;
      process_event_handler       onStandardOutputDataAvailable = nullptr;
      process_event_handler       onStandardErrorDataAvailable  = nullptr;
      process_error_event_handler onError                       = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   ExternalProcess( void* );
   void* CloneHandle() const override;
 
   friend class ExternalProcessPrivate;
   friend class ExternalProcessEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ExternalProcess_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ExternalProcess.h - Released 2024-01-13T15:47:58Z