]>
Commit | Line | Data |
---|---|---|
b1bf95bb JW |
1 | #ifndef RUN_COMMAND_H |
2 | #define RUN_COMMAND_H | |
3 | ||
f1000898 SP |
4 | struct 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; |
8dba1e63 | 36 | unsigned use_shell:1; |
ccf08bc3 | 37 | void (*preexec_cb)(void); |
f1000898 SP |
38 | }; |
39 | ||
ebcb5d16 SP |
40 | int start_command(struct child_process *); |
41 | int finish_command(struct child_process *); | |
f1000898 SP |
42 | int run_command(struct child_process *); |
43 | ||
ae98a008 SB |
44 | extern int run_hook(const char *index_file, const char *name, ...); |
45 | ||
95d3c4f5 | 46 | #define RUN_COMMAND_NO_STDIN 1 |
77cb17e9 | 47 | #define RUN_GIT_CMD 2 /*If this is to be git sub-command */ |
cd83c74c | 48 | #define RUN_COMMAND_STDOUT_TO_STDERR 4 |
c024beb5 | 49 | #define RUN_SILENT_EXEC_FAILURE 8 |
8dba1e63 | 50 | #define RUN_USING_SHELL 16 |
9b0b5093 | 51 | int run_command_v_opt(const char **argv, int opt); |
3427b375 AR |
52 | |
53 | /* | |
54 | * env (the environment) is to be formatted like environ: "VAR=VALUE". | |
55 | * To unset an environment variable use just "VAR". | |
56 | */ | |
ee493148 | 57 | int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env); |
b1bf95bb | 58 | |
2d22c208 JS |
59 | /* |
60 | * The purpose of the following functions is to feed a pipe by running | |
61 | * a function asynchronously and providing output that the caller reads. | |
62 | * | |
63 | * It is expected that no synchronization and mutual exclusion between | |
64 | * the caller and the feed function is necessary so that the function | |
65 | * can run in a thread without interfering with the caller. | |
66 | */ | |
67 | struct async { | |
68 | /* | |
ae6a5609 EFL |
69 | * proc reads from in; closes it before return |
70 | * proc writes to out; closes it before return | |
2d22c208 JS |
71 | * returns 0 on success, non-zero on failure |
72 | */ | |
ae6a5609 | 73 | int (*proc)(int in, int out, void *data); |
2d22c208 | 74 | void *data; |
ae6a5609 | 75 | int in; /* caller writes here and closes it */ |
2d22c208 | 76 | int out; /* caller reads from here and closes it */ |
71064e3f | 77 | #ifndef WIN32 |
2d22c208 | 78 | pid_t pid; |
618ebe9f JS |
79 | #else |
80 | HANDLE tid; | |
ae6a5609 EFL |
81 | int proc_in; |
82 | int proc_out; | |
618ebe9f | 83 | #endif |
2d22c208 JS |
84 | }; |
85 | ||
86 | int start_async(struct async *async); | |
87 | int finish_async(struct async *async); | |
88 | ||
b1bf95bb | 89 | #endif |