* Licensed under the GPL v2. For licencing details see COPYING.
*/
-/** \file string.c Memory allocation and string handling functions. */
+/** \file string.c \brief Memory allocation and string handling functions. */
#include "adu.h"
#include "string.h"
-
-#include <sys/time.h> /* gettimeofday */
-#include <pwd.h>
-#include <sys/utsname.h> /* uname() */
#include <string.h>
-
#include "error.h"
/**
- * Paraslash's version of realloc().
+ * Adu's version of realloc().
*
* \param p Pointer to the memory block, may be \p NULL.
* \param size The desired new size.
*
* \sa realloc(3).
*/
-__must_check __malloc void *para_realloc(void *p, size_t size)
+__must_check __malloc void *adu_realloc(void *p, size_t size)
{
/*
* No need to check for NULL pointers: If p is NULL, the call
}
/**
- * Paraslash's version of malloc().
+ * Adu's version of malloc().
*
* \param size The desired new size.
*
*
* \sa malloc(3).
*/
-__must_check __malloc void *para_malloc(size_t size)
+__must_check __malloc void *adu_malloc(size_t size)
{
assert(size);
void *p = malloc(size);
}
/**
- * Paraslash's version of calloc().
+ * Adu's version of calloc().
*
* \param size The desired new size.
*
*
* \sa calloc(3)
*/
-__must_check __malloc void *para_calloc(size_t size)
+__must_check __malloc void *adu_calloc(size_t size)
{
- void *ret = para_malloc(size);
+ void *ret = adu_malloc(size);
memset(ret, 0, size);
return ret;
}
/**
- * Paraslash's version of strdup().
+ * Adu's version of strdup().
*
* \param s The string to be duplicated.
*
*
* \sa strdup(3)
*/
-__must_check __malloc char *para_strdup(const char *s)
+__must_check __malloc char *adu_strdup(const char *s)
{
char *ret;
}
/**
- * Paraslash's version of strcat().
+ * adu's version of strcat().
*
* \param a String to be appended to.
* \param b String to append.
* 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.
*
- * \sa strcat(3)
+ * \sa strcat(3).
*/
-__must_check __malloc char *para_strcat(char *a, const char *b)
+__must_check __malloc char *adu_strcat(char *a, const char *b)
{
char *tmp;
if (!a)
- return para_strdup(b);
+ return adu_strdup(b);
if (!b)
return a;
tmp = make_message("%s%s", a, b);
return tmp;
}
-/**
- * Paraslash's version of dirname().
- *
- * \param name Pointer to the full path.
- *
- * Compute the directory component of \p name.
- *
- * \return If \a name is \p 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.
- */
-__must_check __malloc char *para_dirname(const char *name)
-{
- char *p, *ret;
-
- if (!name || !*name)
- return NULL;
- ret = para_strdup(name);
- p = strrchr(ret, '/');
- if (!p)
- *ret = '\0';
- else
- *p = '\0';
- return ret;
-}
-
-/**
- * Paraslash's version of basename().
- *
- * \param name Pointer to the full path.
- *
- * Compute the filename component of \a name.
- *
- * \return \p NULL if (a) \a name is the empty string or \p NULL, or (b) name
- * ends with a slash. Otherwise, a pointer within \a name is returned. Caller
- * must not free the result.
- */
-__must_check const char *para_basename(const char *name)
-{
- const char *ret;
-
- if (!name || !*name)
- return NULL;
- ret = strrchr(name, '/');
- if (!ret)
- return name;
- ret++;
- return ret;
-}
-
-/**
- * Cut trailing newline.
- *
- * \param buf The string to be chopped.
- *
- * Replace the last character in \p buf by zero if it is euqal to
- * the newline character.
- */
-void chop(char *buf)
-{
- int n = strlen(buf);
- if (!n)
- return;
- if (buf[n - 1] == '\n')
- buf[n - 1] = '\0';
-}
+/** \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 */
/**
- * Get a random filename.
- *
- * This is by no means a secure way to create temporary files in a hostile
- * 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.
+ * Convert a string to a 64-bit signed integer value.
*
- * \return A pointer to a random filename.
- */
-__must_check __malloc char *para_tmpname(void)
-{
- struct timeval now;
- unsigned int seed;
-
- gettimeofday(&now, NULL);
- seed = now.tv_usec;
- srand(seed);
- return make_message("%08i", rand());
-}
-
-/**
- * Get the logname of the current user.
+ * \param str The string to be converted.
+ * \param result Result pointer.
*
- * \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 \p NULL.
+ * \return Standard.
*
- * \sa getpwuid(3).
+ * \sa strtol(3), atoi(3).
*/
-__must_check __malloc char *para_logname(void)
+__must_check int atoi64(const char *str, int64_t *result)
{
- struct passwd *pw = getpwuid(getuid());
- return para_strdup(pw? pw->pw_name : "unknown_user");
-}
+ char *endptr;
+ long long tmp;
-/**
- * Get the home directory of the current user.
- *
- * \return A dynammically allocated string that must be freed by the caller. If
- * the home directory could not be found, this function returns "/tmp".
- */
-__must_check __malloc char *para_homedir(void)
-{
- struct passwd *pw = getpwuid(getuid());
- return para_strdup(pw? pw->pw_dir : "/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;
+ *result = tmp;
+ return 1;
}
/**
- * Split string and return pointers to its parts.
+ * Split a string and return pointers to its parts.
*
* \param args The string to be split.
* \param argv_ptr Pointer to the list of substrings.
* \param delim Delimiter.
*
* This function modifies \a args by replacing each occurance of \a delim by
- * zero. A \p 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.
*
n++;
p += strspn(p, delim);
}
- *argv_ptr = para_malloc((n + 1) * sizeof(char *));
+ *argv_ptr = adu_malloc((n + 1) * sizeof(char *));
argv = *argv_ptr;
i = 0;
p = args + strspn(args, delim);
return n;
}
-/**
- * Ensure that file descriptors 0, 1, and 2 are valid.
- *
- * Common approach that opens /dev/null until it gets a file descriptor greater
- * than two.
- *
- * \sa okir's Black Hats Manual.
- */
-void valid_fd_012(void)
-{
- while (1) {
- int fd = open("/dev/null", O_RDWR);
- if (fd < 0)
- exit(EXIT_FAILURE);
- if (fd > 2) {
- close(fd);
- break;
- }
- }
-}
-/**
- * Get the own hostname.
- *
- * \return A dynammically allocated string containing the hostname.
- *
- * \sa uname(2).
- */
-__malloc char *para_hostname(void)
+static int get_next_word(const char *line, char **word)
{
- struct utsname u;
-
- 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)
+ enum line_state_flags {LSF_HAVE_WORD = 1, LSF_BACKSLASH = 2,
+ LSF_QUOTE = 4};
+ const char *in;
+ char *out;
+ int ret, state = 0;
+
+ out = adu_malloc(strlen(line) + 1);
+ *out = '\0';
+ *word = out;
+ for (in = line; *in; in++) {
+ switch (*in) {
+ case '\\':
+ if (state & LSF_BACKSLASH) /* \\ */
+ break;
+ state |= LSF_BACKSLASH;
+ state |= LSF_HAVE_WORD;
+ continue;
+ case 'n':
+ case 't':
+ if (state & LSF_BACKSLASH) { /* \n or \t */
+ *out++ = (*in == 'n')? '\n' : '\t';
+ state &= ~LSF_BACKSLASH;
+ continue;
+ }
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;
+ case '"':
+ if (state & LSF_BACKSLASH) /* \" */
+ break;
+ if (state & LSF_QUOTE) {
+ state &= ~LSF_QUOTE;
+ continue;
+ }
+ state |= LSF_HAVE_WORD;
+ state |= LSF_QUOTE;
+ continue;
+ case ' ':
+ case '\t':
+ case '\n':
+ if (state & LSF_BACKSLASH)
+ break;
+ if (state & LSF_QUOTE)
+ break;
+ if (state & LSF_HAVE_WORD)
+ goto success;
+ /* ignore space at the beginning */
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;
+ /* copy char */
+ state |= LSF_HAVE_WORD;
+ *out++ = *in;
+ state &= ~LSF_BACKSLASH;
}
- 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
- * or the size of the buffer exceeds the maximal size specified in \a pb.
- *
- * In the latter case the unmodified \a buf and \a offset values as well as the
- * private_data pointer of \a b are passed to the \a max_size_handler of \a b.
- * If this function succeeds, i.e. returns a non-negative value, the offset of
- * \a b is reset to zero and the given data is written to the beginning of the
- * buffer.
- *
- * 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;
+ ret = 0;
+ if (!(state & LSF_HAVE_WORD))
+ goto out;
+ ret = -ERRNO_TO_ERROR(EINVAL);
+ if (state & LSF_BACKSLASH) {
+ ERROR_LOG("trailing backslash\n");
+ goto out;
}
- while (1) {
- char *p = b->buf + b->offset;
- size_t size = b->size - b->offset;
- va_list ap;
- if (size) {
- va_start(ap, fmt);
- ret = vsnprintf(p, size, fmt, ap);
- va_end(ap);
- if (ret > -1 && ret < size) { /* success */
- b->offset += ret;
- return ret;
- }
- }
- /* check if we may grow the buffer */
- if (!b->max_size || 2 * b->size < b->max_size) { /* yes */
- /* try again with more space */
- b->size *= 2;
- b->buf = para_realloc(b->buf, b->size);
- continue;
- }
- /* can't grow buffer */
- if (!b->offset || !b->max_size_handler) /* message too large */
- return -ERRNO_TO_ERROR(ENOSPC);
- ret = b->max_size_handler(b->buf, b->offset, b->private_data);
- if (ret < 0)
- return ret;
- b->offset = 0;
+ if (state & LSF_QUOTE) {
+ ERROR_LOG("unmatched quote character\n");
+ goto out;
}
+success:
+ *out = '\0';
+ return in - line;
+out:
+ free(*word);
+ *word = NULL;
+ 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.
+ * Free an array of words created by create_argv().
*
- * \return Standard.
- *
- * \sa para_atoi32(), strtol(3), atoi(3).
+ * \param argv A pointer previously obtained by \ref create_argv().
*/
-int para_atoi64(const char *str, int64_t *value)
+void free_argv(char **argv)
{
- char *endptr;
- long long tmp;
+ int i;
- 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;
+ for (i = 0; argv[i]; i++)
+ free(argv[i]);
+ free(argv);
}
/**
- * Convert a string to a 32-bit signed integer value.
+ * Split a line into words which are separated by whitespace.
*
- * \param str The string to be converted.
- * \param value Result pointer.
+ * In contrast to gengetopt's string parser, double quotes, backslash-escaped
+ * characters and special characters like \p \\n are honored. The result
+ * contains pointers to copies of the words contained in \a line and has to be
+ * freed by using \ref free_argv().
*
- * \return Standard.
+ * \param line The line to be split.
+ * \param result The array of words is returned here.
*
- * \sa para_atoi64().
-*/
-int para_atoi32(const char *str, int32_t *value)
+ * \return Number of words in \a line, negative on errors.
+ */
+int create_argv(const char *line, char ***result)
{
- int64_t tmp;
- int ret;
- const int32_t max = 2147483647;
+ char *word, **argv = adu_malloc(2 * sizeof(char *));
+ const char *p;
+ int ret, num_words;
- ret = para_atoi64(str, &tmp);
- if (ret < 0)
- return ret;
- if (tmp > max || tmp < -max - 1)
- return -E_ATOI_OVERFLOW;
- *value = tmp;
- return 1;
+ argv[0] = adu_strdup(line);
+ for (p = line, num_words = 1; ; p += ret, num_words++) {
+ ret = get_next_word(p, &word);
+ if (ret < 0)
+ goto err;
+ if (!ret)
+ break;
+ argv = adu_realloc(argv, (num_words + 2) * sizeof(char*));
+ argv[num_words] = word;
+ }
+ argv[num_words] = NULL;
+ *result = argv;
+ return num_words;
+err:
+ while (num_words > 0)
+ free(argv[--num_words]);
+ free(argv);
+ return ret;
}
projects / adu.git / blobdiff