Merge branch 'maint-1.6.1' into maint-1.6.2
[git/mjg.git] / run-command.h
blobe3455028435eab958d5f86a3e86249f1704b9c1b
1 #ifndef RUN_COMMAND_H
2 #define RUN_COMMAND_H
4 enum {
5 ERR_RUN_COMMAND_FORK = 10000,
6 ERR_RUN_COMMAND_EXEC,
7 ERR_RUN_COMMAND_PIPE,
8 ERR_RUN_COMMAND_WAITPID,
9 ERR_RUN_COMMAND_WAITPID_WRONG_PID,
10 ERR_RUN_COMMAND_WAITPID_SIGNAL,
11 ERR_RUN_COMMAND_WAITPID_NOEXIT,
13 #define IS_RUN_COMMAND_ERR(x) (-(x) >= ERR_RUN_COMMAND_FORK)
15 struct child_process {
16 const char **argv;
17 pid_t pid;
19 * Using .in, .out, .err:
20 * - Specify 0 for no redirections (child inherits stdin, stdout,
21 * stderr from parent).
22 * - Specify -1 to have a pipe allocated as follows:
23 * .in: returns the writable pipe end; parent writes to it,
24 * the readable pipe end becomes child's stdin
25 * .out, .err: returns the readable pipe end; parent reads from
26 * it, the writable pipe end becomes child's stdout/stderr
27 * The caller of start_command() must close the returned FDs
28 * after it has completed reading from/writing to it!
29 * - Specify > 0 to set a channel to a particular FD as follows:
30 * .in: a readable FD, becomes child's stdin
31 * .out: a writable FD, becomes child's stdout/stderr
32 * .err > 0 not supported
33 * The specified FD is closed by start_command(), even in case
34 * of errors!
36 int in;
37 int out;
38 int err;
39 const char *dir;
40 const char *const *env;
41 unsigned no_stdin:1;
42 unsigned no_stdout:1;
43 unsigned no_stderr:1;
44 unsigned git_cmd:1; /* if this is to be git sub-command */
45 unsigned stdout_to_stderr:1;
46 void (*preexec_cb)(void);
49 int start_command(struct child_process *);
50 int finish_command(struct child_process *);
51 int run_command(struct child_process *);
53 extern int run_hook(const char *index_file, const char *name, ...);
55 #define RUN_COMMAND_NO_STDIN 1
56 #define RUN_GIT_CMD 2 /*If this is to be git sub-command */
57 #define RUN_COMMAND_STDOUT_TO_STDERR 4
58 int run_command_v_opt(const char **argv, int opt);
61 * env (the environment) is to be formatted like environ: "VAR=VALUE".
62 * To unset an environment variable use just "VAR".
64 int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
67 * The purpose of the following functions is to feed a pipe by running
68 * a function asynchronously and providing output that the caller reads.
70 * It is expected that no synchronization and mutual exclusion between
71 * the caller and the feed function is necessary so that the function
72 * can run in a thread without interfering with the caller.
74 struct async {
76 * proc writes to fd and closes it;
77 * returns 0 on success, non-zero on failure
79 int (*proc)(int fd, void *data);
80 void *data;
81 int out; /* caller reads from here and closes it */
82 #ifndef __MINGW32__
83 pid_t pid;
84 #else
85 HANDLE tid;
86 int fd_for_proc;
87 #endif
90 int start_async(struct async *async);
91 int finish_async(struct async *async);
93 #endif