run-command: Allow stderr to be a caller supplied pipe
[git/git.git] / run-command.h
CommitLineData
b1bf95bb
JW
1#ifndef RUN_COMMAND_H
2#define RUN_COMMAND_H
3
f1000898
SP
4struct child_process {
5 const char **argv;
ebcb5d16 6 pid_t pid;
c20181e3
JS
7 /*
8 * Using .in, .out, .err:
9 * - Specify 0 for no redirections (child inherits stdin, stdout,
10 * stderr from parent).
11 * - Specify -1 to have a pipe allocated as follows:
12 * .in: returns the writable pipe end; parent writes to it,
13 * the readable pipe end becomes child's stdin
14 * .out, .err: returns the readable pipe end; parent reads from
15 * it, the writable pipe end becomes child's stdout/stderr
16 * The caller of start_command() must close the returned FDs
17 * after it has completed reading from/writing to it!
18 * - Specify > 0 to set a channel to a particular FD as follows:
19 * .in: a readable FD, becomes child's stdin
20 * .out: a writable FD, becomes child's stdout/stderr
4f41b611 21 * .err: a writable FD, becomes child's stderr
c20181e3
JS
22 * The specified FD is closed by start_command(), even in case
23 * of errors!
24 */
4919bf03 25 int in;
f4bba25b 26 int out;
f3b33f1d 27 int err;
1568fea0 28 const char *dir;
ee493148 29 const char *const *env;
f1000898 30 unsigned no_stdin:1;
e4507ae8 31 unsigned no_stdout:1;
b73a4397 32 unsigned no_stderr:1;
f1000898 33 unsigned git_cmd:1; /* if this is to be git sub-command */
c024beb5 34 unsigned silent_exec_failure:1;
f1000898 35 unsigned stdout_to_stderr:1;
ccf08bc3 36 void (*preexec_cb)(void);
f1000898
SP
37};
38
ebcb5d16
SP
39int start_command(struct child_process *);
40int finish_command(struct child_process *);
f1000898
SP
41int run_command(struct child_process *);
42
ae98a008
SB
43extern int run_hook(const char *index_file, const char *name, ...);
44
95d3c4f5 45#define RUN_COMMAND_NO_STDIN 1
77cb17e9 46#define RUN_GIT_CMD 2 /*If this is to be git sub-command */
cd83c74c 47#define RUN_COMMAND_STDOUT_TO_STDERR 4
c024beb5 48#define RUN_SILENT_EXEC_FAILURE 8
9b0b5093 49int run_command_v_opt(const char **argv, int opt);
3427b375
AR
50
51/*
52 * env (the environment) is to be formatted like environ: "VAR=VALUE".
53 * To unset an environment variable use just "VAR".
54 */
ee493148 55int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
b1bf95bb 56
2d22c208
JS
57/*
58 * The purpose of the following functions is to feed a pipe by running
59 * a function asynchronously and providing output that the caller reads.
60 *
61 * It is expected that no synchronization and mutual exclusion between
62 * the caller and the feed function is necessary so that the function
63 * can run in a thread without interfering with the caller.
64 */
65struct async {
66 /*
67 * proc writes to fd and closes it;
68 * returns 0 on success, non-zero on failure
69 */
70 int (*proc)(int fd, void *data);
71 void *data;
72 int out; /* caller reads from here and closes it */
71064e3f 73#ifndef WIN32
2d22c208 74 pid_t pid;
618ebe9f
JS
75#else
76 HANDLE tid;
77 int fd_for_proc;
78#endif
2d22c208
JS
79};
80
81int start_async(struct async *async);
82int finish_async(struct async *async);
83
b1bf95bb 84#endif