process.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-System.
 *
 * StormByte-System original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-System source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte Base tree), which
 * remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-System is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-System. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#pragma once
 
#include <StormByte/cstring.hxx>
#include <StormByte/error.hxx>
#include <StormByte/string/string.hxx>
#include <StormByte/system/visibility.h>
 
#include <chrono>
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
#ifdef WINDOWS
#include <windows.h>
#else
#include <unistd.h>
#endif
 
namespace StormByte::System {
    class Pipe;
    class ProcessImplementation;
 
    struct {} typedef _EoF;
 
    static constexpr const _EoF EoF = {};
 
    class STORMBYTE_SYSTEM_PUBLIC Process {
        public:
            enum class Error {
                Success = 0,            
                ExecutableNotFound,     
                CreationFailed,         
                Permission,             
                NotRunning,             
                AlreadyExited,          
                TimedOut,               
                BrokenPipe,             
                Canceled                
            };
 
            enum class Status: unsigned short {
                RUNNING,    
                SUSPENDED,  
                TERMINATED  
            };
 
            Process(const std::filesystem::path& prog, const std::vector<StormByte::String::String>& args = {}) noexcept;
 
            Process(std::filesystem::path&& prog, std::vector<StormByte::String::String>&& args = {}) noexcept;
 
            Process(const Process& proc) = delete;
 
            Process(Process&& proc) noexcept;
 
            Process& operator=(const Process& proc) = delete;
 
            Process& operator=(Process&& proc) noexcept;
 
            virtual ~Process() noexcept;
 
            explicit operator bool() const noexcept;
 
            StormByte::Error::Fault Fault() const noexcept;
 
            #ifdef UNIX
            int Wait() noexcept;
 
            int Wait(std::chrono::milliseconds timeout) noexcept;
 
            pid_t Pid() noexcept;
            #else
            DWORD Wait() noexcept;
 
            DWORD Wait(std::chrono::milliseconds timeout) noexcept;
 
            PROCESS_INFORMATION Pid();
            #endif
 
            void Suspend();
 
            void Resume();
 
            Process& operator>>(Process& proc);
 
            StormByte::String::String& operator>>(StormByte::String::String& str) const;
 
            StormByte::String::String& Stderr(StormByte::String::String& str) const;
 
            STORMBYTE_FORCE_INLINE friend std::ostream& operator<<(std::ostream& ostream, const Process& proc) {
                StormByte::String::String owned;
                proc >> owned;
                return ostream << static_cast<std::string>(owned);
            }
 
            Process& operator<<(std::string_view str);
 
            Process& operator<<(const StormByte::String::String& str);
 
            Process& operator<<(const StormByte::CString& str);
 
            void operator<<(const System::_EoF& eof);
 
        private:
            #ifdef WINDOWS
            static std::string QuoteWindowsArgument(std::string_view argument);
 
            std::wstring FullCommand() const;
            #endif
 
            void Send(std::string_view str);
 
            void Run();
 
            void ReleaseOwnership() noexcept;
 
            void JoinForwarder() noexcept;
 
            void StopForwarder(bool close_source_read) noexcept;
 
            std::unique_ptr<ProcessImplementation> m_implementation;
    };
 
}
 
template<>
struct StormByte::Error::Domain<StormByte::System::Process::Error> {
    static constexpr const char* Name = "StormByte.System.Process"; 
 
    static std::string Message(StormByte::System::Process::Error e) {
        switch (e) {
            case StormByte::System::Process::Error::Success:
                return "Success";
            case StormByte::System::Process::Error::ExecutableNotFound:
                return "Executable not found";
            case StormByte::System::Process::Error::CreationFailed:
                return "Process creation failed";
            case StormByte::System::Process::Error::Permission:
                return "Process permission denied";
            case StormByte::System::Process::Error::NotRunning:
                return "Process is not running";
            case StormByte::System::Process::Error::AlreadyExited:
                return "Process has already exited";
            case StormByte::System::Process::Error::TimedOut:
                return "Process wait timed out";
            case StormByte::System::Process::Error::BrokenPipe:
                return "Process pipe is broken";
            case StormByte::System::Process::Error::Canceled:
                return "Process operation canceled";
        }
        return "Unknown Process error";
    }
};
 
namespace StormByte::System {
    STORMBYTE_SYSTEM_PUBLIC const StormByte::Error::Category<Process::Error>& process_category() noexcept;
 
    STORMBYTE_SYSTEM_PUBLIC std::error_code make_error_code(Process::Error e) noexcept;
}
 
namespace std {
    template<>
    struct is_error_code_enum<StormByte::System::Process::Error>: true_type {};
}