trustbridge/trustbridge: common/strhelp.h annotate

annotate common/strhelp.h @ 60:6acb1dae6185

Use strn functions and improve error handling. Even if we know the strings are NULL terminated we use length terminated string functions after a first strlen this makes it easier to assert that at one point we know the string is terminated and afterwards use the length of that.

author	Andre Heinecke <aheinecke@intevation.de>
date	Tue, 18 Mar 2014 11:28:02 +0000
parents	3f6378647371
children	80ab2168760f

rev	line source
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	1 #ifndef STRHELP_H
6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	2 #define STRHELP_H
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	3 /* @file Helper functions for c strings and memory management
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	4 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	5 * strhelp contains terminating memory allocation functions and
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	6 * some conveniance functions to work with c strings or arrays
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	7 * of c strings.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	8 */
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	9 void *xmalloc( size_t n );
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	10 void xrealloc( void a, size_t n );
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	11 void *xcalloc( size_t n, size_t m );
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	12 char xstrndup( const char string, const size_t len );
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	13
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	14 /**
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	15 * strv_length:
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	16 * @str_array: a %NULL-terminated array of strings
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	17 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	18 * Returns the length of the given %NULL-terminated
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	19 * string array @str_array.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	20 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	21 * Return value: length of @str_array.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	22 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	23 */
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	24 unsigned int strv_length (char **str_array);
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	25
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	26 /* @brief append a string to a NULL terminated array of strings.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	27 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	28 * @param[inout] array pointer to the NULL terminated list of string pointers.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	29 * @param[in] string pointer to the string to append to the list.
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	30 * @param[in] len length of the string to append to the list
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	31 * */
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	32 void array_append_str(char **pArray, const char string, const size_t len);
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	33
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	34 /* @brief append a string to another string.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	35 *
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	36 * @param[inout] pDst pointer to the string to be extended.
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	37 * @param[in] appendage pointer to the string to append.
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	38 * @param[in] len length of the string to append.
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	39 * */
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	40 void str_append_str(char *pDst, const char appendage, const size_t len);
59 3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	41
3f6378647371 Start work on cinst. Strhelp new helpers to work with C String Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	42 void strfreev (char **str_array);
60 6acb1dae6185 Use strn functions and improve error handling. Andre Heinecke <aheinecke@intevation.de> parents: 59 diff changeset	43 #endif

Mercurial > trustbridge > trustbridge

annotate common/strhelp.h @ 60:6acb1dae6185