ITerminalProcess.h

Go to the documentation of this file.

#pragma once
 
#if EDITOR
 
#include "TerminalOutputBuffer.h"
 
#include <functional>
#include <string>
#include <utility>
#include <vector>
 
struct TerminalLaunchConfig
{
    std::string mExecutable;                                       // Absolute or PATH-resolvable path
    std::vector<std::string> mArgs;                                // Args (no quoting required)
    std::string mWorkingDir;                                       // Optional; empty = inherit parent
    std::vector<std::pair<std::string, std::string>> mEnv;         // Additive env vars
    int mGracefulShutdownMs = 2000;                                // Stop helper graceful timeout
};
 
class ITerminalProcess
{
public:
    using OutputCallback = std::function<void(TerminalEntryKind kind, std::string text)>;
    using ExitCallback = std::function<void(int exitCode)>;
 
    virtual ~ITerminalProcess() = default;
 
    virtual bool Start(const TerminalLaunchConfig& cfg, std::string& outError) = 0;
 
    virtual bool WriteStdin(const char* data, size_t len) = 0;
 
    virtual void RequestStop() = 0;
 
    virtual void ForceKill() = 0;
 
    virtual bool IsRunning() const = 0;
 
    virtual int GetExitCode() const = 0;
 
    virtual void Join() = 0;
 
    virtual bool IsTty() const = 0;
 
    void SetOutputCallback(OutputCallback cb) { mOnOutput = std::move(cb); }
    void SetExitCallback(ExitCallback cb) { mOnExit = std::move(cb); }
 
protected:
    OutputCallback mOnOutput;
    ExitCallback mOnExit;
};
 
ITerminalProcess* CreateTerminalProcess();
 
ITerminalProcess* CreateTerminalProcessConPTY();
 
#endif