82 lines
3.2 KiB
Haxe
82 lines
3.2 KiB
Haxe
/*
|
|
* Copyright (C)2005-2019 Haxe Foundation
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
package sys.io;
|
|
|
|
extern class Process {
|
|
/**
|
|
Standard output. The output stream where a process writes its output data.
|
|
**/
|
|
var stdout(default, null):haxe.io.Input;
|
|
|
|
/**
|
|
Standard error. The output stream to output error messages or diagnostics.
|
|
**/
|
|
var stderr(default, null):haxe.io.Input;
|
|
|
|
/**
|
|
Standard input. The stream data going into a process.
|
|
**/
|
|
var stdin(default, null):haxe.io.Output;
|
|
|
|
/**
|
|
Construct a `Process` object, which run the given command immediately.
|
|
|
|
Command arguments can be passed in two ways: 1. using `args`, 2. appending to `cmd` and leaving `args` as `null`.
|
|
|
|
1. When using `args` to pass command arguments, each argument will be automatically quoted, and shell meta-characters will be escaped if needed.
|
|
`cmd` should be an executable name that can be located in the `PATH` environment variable, or a path to an executable.
|
|
|
|
2. When `args` is not given or is `null`, command arguments can be appended to `cmd`. No automatic quoting/escaping will be performed. `cmd` should be formatted exactly as it would be when typed at the command line.
|
|
It can run executables, as well as shell commands that are not executables (e.g. on Windows: `dir`, `cd`, `echo` etc).
|
|
|
|
`detached` allows the created process to be standalone. You cannot communicate with it but you can look at its exit code. Not supported on php.
|
|
|
|
`close()` should be called when the `Process` is no longer used.
|
|
**/
|
|
function new(cmd:String, ?args:Array<String>, ?detached:Bool):Void;
|
|
|
|
/**
|
|
Return the process ID.
|
|
**/
|
|
function getPid():Int;
|
|
|
|
/**
|
|
Query the exit code of the process.
|
|
If `block` is true or not specified, it will block until the process terminates.
|
|
If `block` is false, it will return either the process exit code if it's already terminated or null if it's still running.
|
|
If the process has already exited, return the exit code immediately.
|
|
**/
|
|
function exitCode(block:Bool = true):Null<Int>;
|
|
|
|
/**
|
|
Close the process handle and release the associated resources.
|
|
All `Process` fields should not be used after `close()` is called.
|
|
**/
|
|
function close():Void;
|
|
|
|
/**
|
|
Kill the process.
|
|
**/
|
|
function kill():Void;
|
|
}
|