X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=string.c;h=8c97ccf75e22397fe3929e84340a05f00b43003c;hp=78b862c933ced61396aadb6df04f43d8185eee21;hb=4591d3022ef21b5148a604d1099eacd85570bde0;hpb=69f0930489da9ace5af8aee104ad21d188aed387 diff --git a/string.c b/string.c index 78b862c9..8c97ccf7 100644 --- a/string.c +++ b/string.c @@ -1,19 +1,7 @@ /* - * Copyright (C) 2004-2006 Andre Noll + * Copyright (C) 2004-2007 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file string.c memory allocation and string handling functions */ @@ -22,7 +10,6 @@ #include "string.h" #include /* gettimeofday */ -#include #include #include /* uname() */ #include @@ -37,6 +24,10 @@ * * A wrapper for realloc(3). It calls \p exit(\p EXIT_FAILURE) on errors, * i.e. there is no need to check the return value in the caller. + * + * \return A pointer to the newly allocated memory, which is suitably aligned + * for any kind of variable and may be different from \p p. + * * \sa realloc(3) */ __must_check __malloc void *para_realloc(void *p, size_t size) @@ -45,8 +36,10 @@ __must_check __malloc void *para_realloc(void *p, size_t size) * No need to check for NULL pointers: If p is NULL, the call * to realloc is equivalent to malloc(size) */ + assert(size); if (!(p = realloc(p, size))) { - PARA_EMERG_LOG("%s", "realloc failed, aborting\n"); + PARA_EMERG_LOG("realloc failed (size = %zu), aborting\n", + size); exit(EXIT_FAILURE); } return p; @@ -58,14 +51,20 @@ __must_check __malloc void *para_realloc(void *p, size_t size) * \param size desired new size * * A wrapper for malloc(3) which exits on errors. + * + * \return A pointer to the allocated memory, which is suitably aligned for any + * kind of variable. + * * \sa malloc(3) */ __must_check __malloc void *para_malloc(size_t size) { + assert(size); void *p = malloc(size); if (!p) { - PARA_EMERG_LOG("%s", "malloc failed, aborting\n"); + PARA_EMERG_LOG("malloc failed (size = %zu), aborting\n", + size); exit(EXIT_FAILURE); } return p; @@ -77,6 +76,10 @@ __must_check __malloc void *para_malloc(size_t size) * \param size desired new size * * A wrapper for calloc(3) which exits on errors. + * + * \return A pointer to the allocated and zeroed-out memory, which is suitably + * aligned for any kind of variable. + * * \sa calloc(3) */ __must_check __malloc void *para_calloc(size_t size) @@ -90,12 +93,13 @@ __must_check __malloc void *para_calloc(size_t size) /** * paraslash's version of strdup() * - * \param s: string to be duplicated + * \param s string to be duplicated + * + * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e. + * there is no need to check the return value in the caller. * - * A wrapper for strdup(3). It calls exit(EXIT_FAILURE) on - * errors, i.e. there is no need to check the return value in the caller. - * Moreover, this wrapper checks for \a s being NULL and returns an empty - * string in this case. + * \return A pointer to the duplicated string. If \p s was the NULL pointer, + * an pointer to an empty string is returned. * * \sa strdup(3) */ @@ -114,9 +118,11 @@ __must_check __malloc char *para_strdup(const char *s) * * \param fmt usual format string * - * Produce output according to \a fmt. No artificial bound on the length of the - * resulting string is imposed. This function either returns a pointer to a - * string that must be freed by the caller or aborts without returning. + * Produce output according to \p fmt. No artificial bound on the length of the + * resulting string is imposed. + * + * \return This function either returns a pointer to a string that must be + * freed by the caller or aborts without returning. * * \sa printf(3) */ @@ -134,10 +140,12 @@ __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...) * \param a string to be appended to * \param b string to append * - * Append \a b to \a a. If \a a is NULL, return a copy of \a b, i.e. - * para_strcat(NULL, b) is equivalent to para_strdup(b). If \a b is NULL, - * return \a a without making a copy of \a a. Otherwise, construct the - * concatenation \a c, free \a a (but not \a b) and return \a c. + * Append \p b to \p a. + * + * \return If \p a is NULL, return a pointer to a copy of \p b, i.e. + * para_strcat(NULL, b) is equivalent to para_strdup(b). If \p b is NULL, + * return \p a without making a copy of \p a. Otherwise, construct the + * concatenation \p c, free \p a (but not \p b) and return \p c. * * \sa strcat(3) */ @@ -157,11 +165,13 @@ __must_check __malloc char *para_strcat(char *a, const char *b) /** * paraslash's version of dirname() * - * \param name pointer to The full path + * \param name pointer to the full path + * + * Compute the directory component of \p name * - * If \a name is \þ NULL or the empty string, return \p NULL, Otherwise, Make a - * copy of \a name and return its directory component. Caller is responsible to - * free the result. + * \return If \p name is \þ NULL or the empty string, return \p NULL. + * Otherwise, Make a copy of \p name and return its directory component. Caller + * is responsible to free the result. */ __must_check __malloc char *para_dirname(const char *name) { @@ -183,9 +193,11 @@ __must_check __malloc char *para_dirname(const char *name) * * \param name Pointer to the full path * - * If \a name is \p NULL or the empty string, return \p NULL, Otherwise, make a - * copy of \a name and return its filename component. Caller is responsible to - * free the result. + * Compute the filename component of \p name + * + * \return If \p name is \p NULL or the empty string, return \p NULL, + * Otherwise, make a copy of \p name and return its filename component. Caller + * is responsible to free the result. */ __must_check __malloc char *para_basename(const char *name) { @@ -202,95 +214,12 @@ __must_check __malloc char *para_basename(const char *name) return para_strdup(p); } -/** - * simple search and replace routine - * - * \param src source string - * \param macro_name the name of the macro - * \param replacement the replacement format string - * - * Replace \a macro_name(arg) by \a replacement. \a replacement is a format - * string which may contain a single string conversion specifier which gets - * replaced by 'arg'. - * - * \return A string in which all matches in \a src are replaced, or NULL if an - * syntax error was encountered. Caller must free the result. - * - * \sa regcomp(3) - */ -__must_check __malloc char *s_a_r(const char *src, const char* macro_name, - const char *replacement) -{ - regex_t preg; - size_t nmatch = 1; - regmatch_t pmatch[1]; - int eflags = 0; - char *dest = NULL; - const char *bufptr = src; - - if (!macro_name || !replacement || !src) - return para_strdup(src); - regcomp(&preg, macro_name, 0); - while (regexec(&preg, bufptr, nmatch, pmatch, eflags) - != REG_NOMATCH) { - char *tmp, *arg, *o_bracket, *c_bracket; - - o_bracket = strchr(bufptr + pmatch[0].rm_so, '('); - c_bracket = o_bracket? strchr(o_bracket, ')') : NULL; - if (!c_bracket) - goto out; - tmp = para_strdup(bufptr); - tmp[pmatch[0].rm_so] = '\0'; - dest = para_strcat(dest, tmp); - free(tmp); - - arg = para_strdup(o_bracket + 1); - arg[c_bracket - o_bracket - 1] = '\0'; - tmp = make_message(replacement, arg); - free(arg); - dest = para_strcat(dest, tmp); - free(tmp); - bufptr = c_bracket; - bufptr++; - } - dest = para_strcat(dest, bufptr); -// PARA_DEBUG_LOG("%s: returning %s\n", __func__, dest); -out: - regfree(&preg); - return dest; -} - -/** - * replace a string according to a list of macros - * - * \param macro_list the array containing a macro/replacement pairs. - * \param src the source string - * - * This function just calls s_a_r() for each element of \a macro_list. - */ -__must_check __malloc char *s_a_r_list(struct para_macro *macro_list, char *src) -{ - struct para_macro *mp = macro_list; - char *ret = NULL, *tmp = para_strdup(src); - - while (mp->name) { - ret = s_a_r(tmp, mp->name, mp->replacement); - free(tmp); - if (!ret) /* syntax error */ - return NULL; - tmp = ret; - mp++; - } - //PARA_DEBUG_LOG("%s: returning %s\n", __func__, dest); - return ret; -} - /** * cut trailing newline * * \param buf the string to be chopped. * - * Replace the last character in \a buf by zero if it is euqal to + * Replace the last character in \p buf by zero if it is euqal to * the newline character. */ void chop(char *buf) @@ -306,14 +235,20 @@ void chop(char *buf) * get a random filename * * This is by no means a secure way to create temporary files in a hostile - * direcory like /tmp. However, it is OK to use for temp files, fifos, sockets - * that are created in ~/.paraslash. Result must be freed by the caller. + * direcory like \p /tmp. However, it is OK to use for temp files, fifos, + * sockets that are created in ~/.paraslash. Result must be freed by the + * caller. + * + * \return a pointer to a random filename. */ __must_check __malloc char *para_tmpname(void) { struct timeval now; + unsigned int seed; + gettimeofday(&now, NULL); - srand(now.tv_usec); + seed = now.tv_usec; + srand(seed); return make_message("%08i", rand()); } @@ -325,7 +260,8 @@ __must_check __malloc char *para_tmpname(void) * * This wrapper for mkstemp additionally uses fchmod() to * set the given mode of the tempfile if mkstemp() returned success. - * Return value: The file descriptor of the temp file just created on success. + * + * \return The file descriptor of the temp file just created on success. * On errors, -E_MKSTEMP or -E_FCHMOD is returned. */ __must_check int para_mkstemp(char *template, mode_t mode) @@ -348,6 +284,8 @@ __must_check int para_mkstemp(char *template, mode_t mode) * \return A dynammically allocated string that must be freed by the caller. On * errors, the string "unknown user" is returned, i.e. this function never * returns NULL. + * + * \sa getpwuid(3) */ __must_check __malloc char *para_logname(void) { @@ -375,28 +313,32 @@ __must_check __malloc char *para_homedir(void) * \param delim delimiter * * This function modifies \a args by replacing each occurance of \a delim by - * zero. A NULL-terminated array of pointers to char* is allocated dynamically + * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically * and these pointers are initialized to point to the broken-up substrings * within \a args. A pointer to this array is returned via \a argv_ptr. It's OK - * to call this function with \a args == NULL. + * to call this function with \a args \a == \p NULL. * * \return The number of substrings found in \a args. */ - -__must_check unsigned split_args(char *args, char ***argv_ptr, const char *delim) +__must_check unsigned split_args(char *args, char *** const argv_ptr, const char *delim) { char *p = args; char **argv; size_t n = 0, i, j; - while ((i = strcspn(p, delim)) && (p += i)) { - p += strspn(p, delim); + p = args + strspn(args, delim); + for (;;) { + i = strcspn(p, delim); + if (!i) + break; + p += i; n++; + p += strspn(p, delim); } *argv_ptr = para_malloc((n + 1) * sizeof(char *)); argv = *argv_ptr; i = 0; - p = args; + p = args + strspn(args, delim); while (p) { argv[i] = p; j = strcspn(p, delim); @@ -451,3 +393,230 @@ __malloc char *para_hostname(void) uname(&u); return para_strdup(u.nodename); } + +/** + * Used to distinguish between read-only and read-write mode. + * + * \sa for_each_line(), for_each_line_ro(). + */ +enum for_each_line_modes{ + /** Activate read-only mode. */ + LINE_MODE_RO, + /** Activate read-write mode. */ + LINE_MODE_RW +}; + +static int for_each_complete_line(enum for_each_line_modes mode, char *buf, + size_t size, line_handler_t *line_handler, void *private_data) +{ + char *start = buf, *end; + int ret, i, num_lines = 0; + +// PARA_NOTICE_LOG("buf: %s\n", buf); + while (start < buf + size) { + char *next_null; + char *next_cr; + + next_cr = memchr(start, '\n', buf + size - start); + next_null = memchr(start, '\0', buf + size - start); + if (!next_cr && !next_null) + break; + if (next_cr && next_null) { + end = next_cr < next_null? next_cr : next_null; + } else if (next_null) { + end = next_null; + } else + end = next_cr; + num_lines++; + if (!line_handler) { + start = ++end; + continue; + } + if (mode == LINE_MODE_RO) { + size_t s = end - start; + char *b = para_malloc(s + 1); + memcpy(b, start, s); + b[s] = '\0'; +// PARA_NOTICE_LOG("b: %s, start: %s\n", b, start); + ret = line_handler(b, private_data); + free(b); + } else { + *end = '\0'; + ret = line_handler(start, private_data); + } + if (ret < 0) + return ret; + start = ++end; + } + if (!line_handler || mode == LINE_MODE_RO) + return num_lines; + i = buf + size - start; + if (i && i != size) + memmove(buf, start, i); + return i; +} + +/** + * Call a custom function for each complete line. + * + * \param buf The buffer containing data seperated by newlines. + * \param size The number of bytes in \a buf. + * \param line_handler The custom function. + * \param private_data Pointer passed to \a line_handler. + * + * If \p line_handler is \p NULL, the function returns the number of complete + * lines in \p buf. Otherwise, \p line_handler is called for each complete + * line in \p buf. The first argument to \p line_handler is the current line, + * and \p private_data is passed as the second argument. The function returns + * if \p line_handler returns a negative value or no more lines are in the + * buffer. The rest of the buffer (last chunk containing an incomplete line) + * is moved to the beginning of the buffer. + * + * \return If \p line_handler is not \p NULL, this function returns the number + * of bytes not handled to \p line_handler on success, or the negative return + * value of the \p line_handler on errors. + * + * \sa for_each_line_ro(). + */ +int for_each_line(char *buf, size_t size, line_handler_t *line_handler, + void *private_data) +{ + return for_each_complete_line(LINE_MODE_RW, buf, size, line_handler, + private_data); +} + +/** + * Call a custom function for each complete line. + * + * \param buf Same meaning as in \p for_each_line(). + * \param size Same meaning as in \p for_each_line(). + * \param line_handler Same meaning as in \p for_each_line(). + * \param private_data Same meaning as in \p for_each_line(). + * + * This function behaves like \p for_each_line(), but \a buf is left unchanged. + * + * \return On success, the function returns the number of complete lines in \p + * buf, otherwise the (negative) return value of \p line_handler is returned. + * + * \sa for_each_line(). + */ +int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler, + void *private_data) +{ + return for_each_complete_line(LINE_MODE_RO, buf, size, line_handler, + private_data); +} + +/** + * Safely print into a buffer at a given offset + * + * \param b Determines the buffer, its size, and the offset. + * \param fmt The format string. + * + * This function prints into the buffer given by \a b at the offset which is + * also given by \a b. If there is not enough space to hold the result, the + * buffer size is doubled until the underlying call to vsnprintf() succeeds. + * Upon return, the offset of \a b is adjusted accordingly so that subsequent + * calls to this function append data to what is already contained in the + * buffer. + * + * It's OK to call this function with \p b->buf being \p NULL. In this case, an + * initial buffer is allocated. + * + * \return The number of bytes printed into the buffer (not including the + * therminating \p NULL byte). + * + * \sa make_message(), vsnprintf(3). + */ +__printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...) +{ + int ret; + + if (!b->buf) { + b->buf = para_malloc(128); + b->size = 128; + b->offset = 0; + } else if (b->size <= b->offset + 1) { + b->size *= 2; + b->buf = para_realloc(b->buf, b->size); + } + while (1) { + char *p = b->buf + b->offset; + size_t size = b->size - b->offset; + va_list ap; + va_start(ap, fmt); + ret = vsnprintf(p, size, fmt, ap); + va_end(ap); + if (ret > -1 && ret < size) { /* success */ + b->offset += ret; + break; + } + /* try again with more space */ + b->size *= 2; + b->buf = para_realloc(b->buf, b->size); + } + return ret; +} + +/** \cond LLONG_MAX and LLONG_LIN might not be defined. */ +#ifndef LLONG_MAX +#define LLONG_MAX (1 << (sizeof(long) - 1)) +#endif +#ifndef LLONG_MIN +#define LLONG_MIN (-LLONG_MAX - 1LL) +#endif +/** \endcond */ + +/** + * Convert a string to a 64-bit signed integer value. + * + * \param str The string to be converted. + * \param value Result pointer. + * + * \return Positive on success, negative on errors. + * + * \sa para_atoi32(), strtol(3), atoi(3). + */ +int para_atoi64(const char *str, int64_t *value) +{ + char *endptr; + long long tmp; + + errno = 0; /* To distinguish success/failure after call */ + tmp = strtoll(str, &endptr, 10); + if (errno == ERANGE && (tmp == LLONG_MAX || tmp == LLONG_MIN)) + return -E_ATOI_OVERFLOW; + if (errno != 0 && tmp == 0) /* other error */ + return -E_STRTOLL; + if (endptr == str) + return -E_ATOI_NO_DIGITS; + if (*endptr != '\0') /* Further characters after number */ + return -E_ATOI_JUNK_AT_END; + *value = tmp; + return 1; +} + +/** + * Convert a string to a 32-bit signed integer value. + * + * \param str The string to be converted. + * \param value Result pointer. + * + * \return Positive on success, negative on errors. + * + * \sa para_atoi64(). +*/ +int para_atoi32(const char *str, int32_t *value) +{ + int64_t tmp; + int ret; + const int32_t max = 2147483647; + + ret = para_atoi64(str, &tmp); + if (ret < 0) + return ret; + if (tmp > max || tmp < -max - 1) + return -E_ATOI_OVERFLOW; + *value = tmp; + return 1; +}