]>
git.ipfire.org Git - thirdparty/git.git/blob - strvec.h
5 * The argv-array API allows one to dynamically build and store
6 * NULL-terminated lists. An argv-array maintains the invariant that the
7 * `argv` member always points to a non-NULL array, and that the array is
8 * always NULL-terminated at the element pointed to by `argv[argc]`. This
9 * makes the result suitable for passing to functions expecting to receive
12 * The string-list API (documented in string-list.h) is similar, but cannot be
13 * used for these purposes; instead of storing a straight string pointer,
14 * it contains an item structure with a `util` field that is not compatible
15 * with the traditional argv interface.
17 * Each `strvec` manages its own memory. Any strings pushed into the
18 * array are duplicated, and all memory is freed by strvec_clear().
21 extern const char *empty_strvec
[];
24 * A single array. This should be initialized by assignment from
25 * `STRVEC_INIT`, or by calling `strvec_init`. The `argv`
26 * member contains the actual array; the `argc` member contains the
27 * number of elements in the array, not including the terminating
36 #define STRVEC_INIT { empty_strvec, 0, 0 }
39 * Initialize an array. This is no different than assigning from
42 void strvec_init(struct strvec
*);
44 /* Push a copy of a string onto the end of the array. */
45 const char *strvec_push(struct strvec
*, const char *);
48 * Format a string and push it onto the end of the array. This is a
49 * convenience wrapper combining `strbuf_addf` and `strvec_push`.
51 __attribute__((format (printf
,2,3)))
52 const char *strvec_pushf(struct strvec
*, const char *fmt
, ...);
55 * Push a list of strings onto the end of the array. The arguments
56 * should be a list of `const char *` strings, terminated by a NULL
60 void strvec_pushl(struct strvec
*, ...);
62 /* Push a null-terminated array of strings onto the end of the array. */
63 void strvec_pushv(struct strvec
*, const char **);
66 * Remove the final element from the array. If there are no
67 * elements in the array, do nothing.
69 void strvec_pop(struct strvec
*);
71 /* Splits by whitespace; does not handle quoted arguments! */
72 void strvec_split(struct strvec
*, const char *);
75 * Free all memory associated with the array and return it to the
76 * initial, empty state.
78 void strvec_clear(struct strvec
*);
81 * Disconnect the `argv` member from the `strvec` struct and
82 * return it. The caller is responsible for freeing the memory used
83 * by the array, and by the strings it references. After detaching,
84 * the `strvec` is in a reinitialized state and can be pushed
87 const char **strvec_detach(struct strvec
*);
89 /* compatibility for historic argv_array interface */
90 #define argv_array strvec
91 #define ARGV_ARRAY_INIT STRVEC_INIT
92 #define argv_array_init strvec_init
93 #define argv_array_push strvec_push
94 #define argv_array_pushf strvec_pushf
95 #define argv_array_pushl strvec_pushl
96 #define argv_array_pushv strvec_pushv
97 #define argv_array_pop strvec_pop
98 #define argv_array_split strvec_split
99 #define argv_array_clear strvec_clear
100 #define argv_array_detach strvec_detach
102 #endif /* STRVEC_H */