Process.h

#pragma once
 
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/Strings/String.h>
#include <Foundation/Strings/StringView.h>
#include <Foundation/Time/Time.h>
#include <Foundation/Types/Bitflags.h>
#include <Foundation/Types/Delegate.h>
#include <Foundation/Types/UniquePtr.h>
 
using plOsProcessHandle = void*;
using plOsProcessID = plUInt32;
 
#if PL_ENABLED(PL_SUPPORTS_PROCESSES)
enum class plProcessState
{
  NotStarted,
  Running,
  Finished
};
 
struct PL_FOUNDATION_DLL plProcessOptions
{
  plString m_sProcess;
 
  plString m_sWorkingDirectory;
 
  plHybridArray<plString, 8> m_Arguments;
 
  bool m_bHideConsoleWindow = true;
 
  plDelegate<void(plStringView)> m_onStdOut;
 
  plDelegate<void(plStringView)> m_onStdError;
 
  void AddArgument(const plFormatString& arg);
 
  template <typename... ARGS>
  void AddArgument(plStringView sFormat, ARGS&&... args)
  {
    AddArgument(plFormatStringImpl<ARGS...>(sFormat, std::forward<ARGS>(args)...));
  }
 
  void AddCommandLine(plStringView sCmdLine);
 
  void BuildCommandLineString(plStringBuilder& out_sCmdLine) const;
};
 
struct plProcessLaunchFlags
{
  using StorageType = plUInt32;
 
  enum Enum
  {
    None = 0,
    Detached = PL_BIT(0),  
    Suspended = PL_BIT(1), 
    Default = None
  };
 
  struct Bits
  {
    StorageType Detached : 1;
    StorageType Suspended : 1;
  };
};
 
PL_DECLARE_FLAGS_OPERATORS(plProcessLaunchFlags);
 
class PL_FOUNDATION_DLL plProcess
{
  PL_DISALLOW_COPY_AND_ASSIGN(plProcess);
 
public:
  plProcess();
  plProcess(plProcess&& rhs);
 
  ~plProcess();
 
  static plResult Execute(const plProcessOptions& opt, plInt32* out_pExitCode = nullptr);
 
  plResult Launch(const plProcessOptions& opt, plBitflags<plProcessLaunchFlags> launchFlags = plProcessLaunchFlags::None);
 
  plResult ResumeSuspended();
 
  plResult WaitToFinish(plTime timeout = plTime::MakeZero());
 
  plResult Terminate();
 
  plInt32 GetExitCode() const;
 
  plProcessState GetState() const;
 
  void Detach();
 
  plOsProcessHandle GetProcessHandle() const;
 
  plOsProcessID GetProcessID() const;
 
  static plOsProcessID GetCurrentProcessID();
 
private:
  void BuildFullCommandLineString(const plProcessOptions& opt, plStringView sProcess, plStringBuilder& cmd) const;
 
  plUniquePtr<struct plProcessImpl> m_pImpl;
 
  // the default value is used by GetExitCode() to determine whether it has to be reevaluated
  mutable plInt32 m_iExitCode = -0xFFFF;
 
  plString m_sProcess;
  plDelegate<void(plStringView)> m_OnStdOut;
  plDelegate<void(plStringView)> m_OnStdError;
  mutable plTime m_ProcessExited = plTime::MakeZero();
};
#endif