Andrew's git - gitweb.git/blob

   1#ifndef RUN_COMMAND_H
   2#define RUN_COMMAND_H
   3
   4struct child_process {
   5        const char **argv;
   6        pid_t pid;
   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
  21         *     .err: a writable FD, becomes child's stderr
  22         *   The specified FD is closed by start_command(), even in case
  23         *   of errors!
  24         */
  25        int in;
  26        int out;
  27        int err;
  28        const char *dir;
  29        const char *const *env;
  30        unsigned no_stdin:1;
  31        unsigned no_stdout:1;
  32        unsigned no_stderr:1;
  33        unsigned git_cmd:1; /* if this is to be git sub-command */
  34        unsigned silent_exec_failure:1;
  35        unsigned stdout_to_stderr:1;
  36        void (*preexec_cb)(void);
  37};
  38
  39int start_command(struct child_process *);
  40int finish_command(struct child_process *);
  41int run_command(struct child_process *);
  42
  43extern int run_hook(const char *index_file, const char *name, ...);
  44
  45#define RUN_COMMAND_NO_STDIN 1
  46#define RUN_GIT_CMD          2  /*If this is to be git sub-command */
  47#define RUN_COMMAND_STDOUT_TO_STDERR 4
  48#define RUN_SILENT_EXEC_FAILURE 8
  49int run_command_v_opt(const char **argv, int opt);
  50
  51/*
  52 * env (the environment) is to be formatted like environ: "VAR=VALUE".
  53 * To unset an environment variable use just "VAR".
  54 */
  55int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
  56
  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 reads from in; closes it before return
  68         * proc writes to out; closes it before return
  69         * returns 0 on success, non-zero on failure
  70         */
  71        int (*proc)(int in, int out, void *data);
  72        void *data;
  73        int in;         /* caller writes here and closes it */
  74        int out;        /* caller reads from here and closes it */
  75#ifndef WIN32
  76        pid_t pid;
  77#else
  78        HANDLE tid;
  79        int proc_in;
  80        int proc_out;
  81#endif
  82};
  83
  84int start_async(struct async *async);
  85int finish_async(struct async *async);
  86
  87#endif