mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
![Aaron Schrab](/assets/img/avatar_default.png)
Create find_hook() function to determine if a given hook exists and is executable. If it is, the path to the script will be returned, otherwise NULL is returned. This encapsulates the tests that are used to check for the existence of a hook in one place, making it easier to modify those checks if that is found to be necessary. This also makes it simple for places that can use a hook to check if a hook exists before doing, possibly lengthy, setup work which would be pointless if no such hook is present. The returned value is left as a static value from get_pathname() rather than a duplicate because it is anticipated that the return value will either be used as a boolean, immediately added to an argv_array list which would result in it being duplicated at that point, or used to actually run the command without much intervening work. Callers which need to hold onto the returned value for a longer time are expected to duplicate the return value themselves. Signed-off-by: Aaron Schrab <aaron@schrab.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
96 lines
2.9 KiB
C
96 lines
2.9 KiB
C
#ifndef RUN_COMMAND_H
|
|
#define RUN_COMMAND_H
|
|
|
|
#ifndef NO_PTHREADS
|
|
#include <pthread.h>
|
|
#endif
|
|
|
|
struct child_process {
|
|
const char **argv;
|
|
pid_t pid;
|
|
/*
|
|
* Using .in, .out, .err:
|
|
* - Specify 0 for no redirections (child inherits stdin, stdout,
|
|
* stderr from parent).
|
|
* - Specify -1 to have a pipe allocated as follows:
|
|
* .in: returns the writable pipe end; parent writes to it,
|
|
* the readable pipe end becomes child's stdin
|
|
* .out, .err: returns the readable pipe end; parent reads from
|
|
* it, the writable pipe end becomes child's stdout/stderr
|
|
* The caller of start_command() must close the returned FDs
|
|
* after it has completed reading from/writing to it!
|
|
* - Specify > 0 to set a channel to a particular FD as follows:
|
|
* .in: a readable FD, becomes child's stdin
|
|
* .out: a writable FD, becomes child's stdout/stderr
|
|
* .err: a writable FD, becomes child's stderr
|
|
* The specified FD is closed by start_command(), even in case
|
|
* of errors!
|
|
*/
|
|
int in;
|
|
int out;
|
|
int err;
|
|
const char *dir;
|
|
const char *const *env;
|
|
unsigned no_stdin:1;
|
|
unsigned no_stdout:1;
|
|
unsigned no_stderr:1;
|
|
unsigned git_cmd:1; /* if this is to be git sub-command */
|
|
unsigned silent_exec_failure:1;
|
|
unsigned stdout_to_stderr:1;
|
|
unsigned use_shell:1;
|
|
unsigned clean_on_exit:1;
|
|
};
|
|
|
|
int start_command(struct child_process *);
|
|
int finish_command(struct child_process *);
|
|
int run_command(struct child_process *);
|
|
|
|
extern char *find_hook(const char *name);
|
|
extern int run_hook(const char *index_file, const char *name, ...);
|
|
|
|
#define RUN_COMMAND_NO_STDIN 1
|
|
#define RUN_GIT_CMD 2 /*If this is to be git sub-command */
|
|
#define RUN_COMMAND_STDOUT_TO_STDERR 4
|
|
#define RUN_SILENT_EXEC_FAILURE 8
|
|
#define RUN_USING_SHELL 16
|
|
#define RUN_CLEAN_ON_EXIT 32
|
|
int run_command_v_opt(const char **argv, int opt);
|
|
|
|
/*
|
|
* env (the environment) is to be formatted like environ: "VAR=VALUE".
|
|
* To unset an environment variable use just "VAR".
|
|
*/
|
|
int run_command_v_opt_cd_env(const char **argv, int opt, const char *dir, const char *const *env);
|
|
|
|
/*
|
|
* The purpose of the following functions is to feed a pipe by running
|
|
* a function asynchronously and providing output that the caller reads.
|
|
*
|
|
* It is expected that no synchronization and mutual exclusion between
|
|
* the caller and the feed function is necessary so that the function
|
|
* can run in a thread without interfering with the caller.
|
|
*/
|
|
struct async {
|
|
/*
|
|
* proc reads from in; closes it before return
|
|
* proc writes to out; closes it before return
|
|
* returns 0 on success, non-zero on failure
|
|
*/
|
|
int (*proc)(int in, int out, void *data);
|
|
void *data;
|
|
int in; /* caller writes here and closes it */
|
|
int out; /* caller reads from here and closes it */
|
|
#ifdef NO_PTHREADS
|
|
pid_t pid;
|
|
#else
|
|
pthread_t tid;
|
|
int proc_in;
|
|
int proc_out;
|
|
#endif
|
|
};
|
|
|
|
int start_async(struct async *async);
|
|
int finish_async(struct async *async);
|
|
|
|
#endif
|