OFSubprocess.h

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
 
#include "objfw-defs.h"
 
#ifdef OF_HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif
 
#import "OFStream.h"
#import "OFKernelEventObserver.h"
#import "OFString.h"
 
#ifdef OF_WINDOWS
# include <windows.h>
#endif
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);

OF_SUBCLASSING_RESTRICTED
@interface OFSubprocess: OFStream
#ifndef OF_WINDOWS
    <OFReadyForReadingObserving, OFReadyForWritingObserving>
#endif
{
#ifndef OF_WINDOWS
    pid_t _pid;
    int _readPipe[2], _writePipe[2];
#else
    HANDLE _handle, _readPipe[2], _writePipe[2];
#endif
    int _status;
    bool _atEndOfStream;
}

+ (instancetype)subprocessWithProgram: (OFString *)program;

+ (instancetype)
    subprocessWithProgram: (OFString *)program
        arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments;

+ (instancetype)
    subprocessWithProgram: (OFString *)program
          programName: (OFString *)programName
        arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments;

+ (instancetype)
    subprocessWithProgram: (OFString *)program
          programName: (OFString *)programName
        arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments
          environment: (nullable OFDictionary
                   OF_GENERIC(OFString *, OFString *) *)environment;
 
- (instancetype)init OF_UNAVAILABLE;

- (instancetype)initWithProgram: (OFString *)program;

- (instancetype)
    initWithProgram: (OFString *)program
      arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments;

- (instancetype)
    initWithProgram: (OFString *)program
    programName: (OFString *)programName
      arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments;

- (instancetype)
    initWithProgram: (OFString *)program
    programName: (OFString *)programName
      arguments: (nullable OFArray OF_GENERIC(OFString *) *)arguments
    environment: (nullable OFDictionary
             OF_GENERIC(OFString *, OFString *) *)environment
    OF_DESIGNATED_INITIALIZER;

- (void)closeForWriting;

- (int)waitForTermination;
@end
 
OF_ASSUME_NONNULL_END