[thirdparty/git.git] / strvec.h

#ifndef STRVEC_H
#define STRVEC_H

/**
 * The strvec API allows one to dynamically build and store
 * NULL-terminated arrays of strings. A strvec maintains the invariant that the
 * `items` member always points to a non-NULL array, and that the array is
 * always NULL-terminated at the element pointed to by `items[nr]`. This
 * makes the result suitable for passing to functions expecting to receive
 * argv from main().
 *
 * The string-list API (documented in string-list.h) is similar, but cannot be
 * used for these purposes; instead of storing a straight string pointer,
 * it contains an item structure with a `util` field that is not compatible
 * with the traditional argv interface.
 *
 * Each `strvec` manages its own memory. Any strings pushed into the
 * array are duplicated, and all memory is freed by strvec_clear().
 */

extern const char *empty_strvec[];

/**
 * A single array. This should be initialized by assignment from
 * `STRVEC_INIT`, or by calling `strvec_init`. The `items`
 * member contains the actual array; the `nr` member contains the
 * number of elements in the array, not including the terminating
 * NULL.
 */
struct strvec {
	const char **v;
	int nr;
	int alloc;
};

#define STRVEC_INIT { empty_strvec, 0, 0 }

/**
 * Initialize an array. This is no different than assigning from
 * `STRVEC_INIT`.
 */
void strvec_init(struct strvec *);

/* Push a copy of a string onto the end of the array. */
const char *strvec_push(struct strvec *, const char *);

/**
 * Format a string and push it onto the end of the array. This is a
 * convenience wrapper combining `strbuf_addf` and `strvec_push`.
 */
__attribute__((format (printf,2,3)))
const char *strvec_pushf(struct strvec *, const char *fmt, ...);

/**
 * Push a list of strings onto the end of the array. The arguments
 * should be a list of `const char *` strings, terminated by a NULL
 * argument.
 */
LAST_ARG_MUST_BE_NULL
void strvec_pushl(struct strvec *, ...);

/* Push a null-terminated array of strings onto the end of the array. */
void strvec_pushv(struct strvec *, const char **);

/**
 * Remove the final element from the array. If there are no
 * elements in the array, do nothing.
 */
void strvec_pop(struct strvec *);

/* Splits by whitespace; does not handle quoted arguments! */
void strvec_split(struct strvec *, const char *);

/**
 * Free all memory associated with the array and return it to the
 * initial, empty state.
 */
void strvec_clear(struct strvec *);

/**
 * Disconnect the `items` member from the `strvec` struct and
 * return it. The caller is responsible for freeing the memory used
 * by the array, and by the strings it references. After detaching,
 * the `strvec` is in a reinitialized state and can be pushed
 * into again.
 */
const char **strvec_detach(struct strvec *);

#endif /* STRVEC_H */
Commit	Line	Data
	1	#ifndef STRVEC_H
	2	#define STRVEC_H
	3
	4	/**
	5	* The strvec API allows one to dynamically build and store
	6	* NULL-terminated arrays of strings. A strvec maintains the invariant that the
	7	* `items` member always points to a non-NULL array, and that the array is
	8	* always NULL-terminated at the element pointed to by `items[nr]`. This
	9	* makes the result suitable for passing to functions expecting to receive
	10	* argv from main().
	11	*
	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.
	16	*
	17	* Each `strvec` manages its own memory. Any strings pushed into the
	18	* array are duplicated, and all memory is freed by strvec_clear().
	19	*/
	20
	21	extern const char *empty_strvec[];
	22
	23	/**
	24	* A single array. This should be initialized by assignment from
	25	* `STRVEC_INIT`, or by calling `strvec_init`. The `items`
	26	* member contains the actual array; the `nr` member contains the
	27	* number of elements in the array, not including the terminating
	28	* NULL.
	29	*/
	30	struct strvec {
	31	const char **v;
	32	int nr;
	33	int alloc;
	34	};
	35
	36	#define STRVEC_INIT { empty_strvec, 0, 0 }
	37
	38	/**
	39	* Initialize an array. This is no different than assigning from
	40	* `STRVEC_INIT`.
	41	*/
	42	void strvec_init(struct strvec *);
	43
	44	/* Push a copy of a string onto the end of the array. */
	45	const char strvec_push(struct strvec , const char *);
	46
	47	/**
	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`.
	50	*/
	51	__attribute__((format (printf,2,3)))
	52	const char strvec_pushf(struct strvec , const char *fmt, ...);
	53
	54	/**
	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
	57	* argument.
	58	*/
	59	LAST_ARG_MUST_BE_NULL
	60	void strvec_pushl(struct strvec *, ...);
	61
	62	/* Push a null-terminated array of strings onto the end of the array. */
	63	void strvec_pushv(struct strvec , const char *);
	64
	65	/**
	66	* Remove the final element from the array. If there are no
	67	* elements in the array, do nothing.
	68	*/
	69	void strvec_pop(struct strvec *);
	70
	71	/* Splits by whitespace; does not handle quoted arguments! */
	72	void strvec_split(struct strvec , const char );
	73
	74	/**
	75	* Free all memory associated with the array and return it to the
	76	* initial, empty state.
	77	*/
	78	void strvec_clear(struct strvec *);
	79
	80	/**
	81	* Disconnect the `items` 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
	85	* into again.
	86	*/
	87	const char *strvec_detach(struct strvec );
	88
	89	#endif /* STRVEC_H */