Next: , Previous: , Up: The Process Library   [Index]


13.11.5 X Shell Functions

xs_argv

list xs_argv(xshell xs);

is the command line of the process to execute for the xs shell. The list may be operated as any list library provided list, though the process library expects that only items of the intrinsic string type and the byte data library provided byte array type are present in the list when executing the process.

See The List Library.

See The Byte Data Library.

xs_exited

integer xs_exited(xshell xs, integer &sigexit);

is non zero if the last process executed for the xs shell has exited, 0 if it otherwise terminated, undefined if it did not complete or no process was executed for xs. Sets sigexit to the exit status of the executed process for the first case. Sets sigexit to the terminating signal if the last process executed for the xs shell was terminated by a signal. May set sigexit to a random value if neither is the case.

xs_fashion

xshell xs_fashion(xshell xs, integer s);

is xs, adds s to the xs shell flags set

See X Shell Flag Definitions.

xs_fold

xshell xs_fold(xshell xs, file f);

is xs, sets the file from which the process to be executed for the xs shell reads to f. The file is expect opened and readable.

xs_input

file xs_input(xshell xs);

is the file from which the process executed for the xs shell reads (same as ‘xs_write’)

xs_kill

xshell xs_kill(xshell xs, integer sig);

is xs, sends signal sig to the process associated with the xs shell, if any. Equivalent to:

    pid = xs.pid();
    if (pid != -1) {
	kill(pid, sig);
    }

See Operating System Functions.

xs_lead

xshell xs_lead(xshell xs);

is xs, starts execution of one process for the xs shell.

xs_mind

xshell xs_mind(xshell xs, file f);

is xs, sets the file to which the process to be executed for the xs shell writes error reports to f. The file is expect opened and writable.

xs_output

file xs_output(xshell xs);

is the file to which the process executed for the xs shell writes (same as ‘xs_read’)

xs_path

data xs_path(xshell xs);

is the path to the executable to execute for the xs shell. It is to be set before execution.

xs_pid

integer xs_pid(xshell xs);

is the process id of the process associated with the xs shell, -1 if no process associates xs. Subject to arrangements made with the application embedding the interpreter, it becomes -1 when the process started for xs terminates.

xs_pipe

xshell xs_pipe(xshell xs, file f);

is xs, sets the file to which the process to be executed for the xs shell writes to f. The file is expect opened and writable.

xs_plan

xshell xs_plan(xshell xs, ...);

is xs, appends its unnamed arguments to the list of arguments (i.e. the command line) of the process to execute. It is a convenience for changing the command line (accessible via ‘xs_argv’) with list specific methods.

xs_read

file xs_read(xshell xs);

is the file to which the process executed for the xs shell writes (same as ‘xs_output’)

xs_refine

xshell xs_refine(xshell xs, integer s);

is xs, removes s from the xs shell flags set

See X Shell Flag Definitions.

xs_set

xshell xs_set(xshell &xs, xshell xt);

is xt, sets the xs shell object as a reference of the xt shell object

xs_signaled

integer xs_signaled(xshell xs, integer &signal);

is non zero if the last process executed for the xs shell was terminated by a signal, 0 if it otherwise terminated, undefined if it did not complete or no process was executed for xs. Sets signal to the signal that terminated the process for the first case. May set signal to a random value if not the case.

xs_spend

xshell xs_spend(xshell xs);

is xs, waits for the process executed successfully for the xs shell

xs_waste

xshell xs_waste(xshell xs, integer second, integer microsecond);

is xs, waits for the process executed successfully for the xs shell up to second seconds and microsecond microseconds. The absolute value of microsecond is not restricted to the 0 .. 999999 range. Both second and microsecond may be negatively defined.

xs_write

file xs_write(xshell xs);

is the file from which the process executed for the xs shell reads (same as ‘xs_input’)

Process Execution

The path and command line of the executed process are expected set via the objects available through ‘xs_path’ and ‘xs_argv’, respectively. If the ‘ss_path’ set path has a zero bytes length, the first item in the command line is used instead.

The standard input, output and error for the new process are put in blocking mode.


Next: X Shell Constructor Functions, Previous: S Shell Flag Definitions, Up: The Process Library   [Index]