string: Add discard feature for for_each_line().

[paraslash.git] / string.h

diff --git a/string.h b/string.h
index e91a140be0ae6c8dc2371e027d5326d470209f68..230f654b67a8e553e37e2f7635fbfe057e63cfca 100644 (file)
--- a/string.h
+++ b/string.h
@@ -1,11 +1,17 @@
 /*
- * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file string.h exported sybmols from string.c */
 
+/** Flags that change how content is printed into the buffer. */
+enum para_buffer_flags {
+       /** Prefix each buffer with its length. */
+       PBF_SIZE_PREFIX = 1,
+};
+
 /** A string buffer used for para_printf(). */
 struct para_buffer {
        /** The buffer. May be \p NULL. */
@@ -14,6 +20,8 @@ struct para_buffer {
        size_t size;
        /** The maximal size this buffer may grow. Zero means unlimited. */
        size_t max_size;
+       /** \sa para_buffer_flags. */
+       unsigned flags;
        /** The next para_printf() will write at this offset. */
        size_t offset;
        /**
@@ -26,26 +34,71 @@ struct para_buffer {
        void *private_data;
 };
 
+/**
+ * Controls the behavior of for_each_line().
+ *
+ * \sa for_each_line().
+ */
+enum for_each_line_flags {
+       /** Activate read-only mode. */
+       FELF_READ_ONLY = 1 << 0,
+       /** Don't call line handler for the first input line. */
+       FELF_DISCARD_FIRST = 1 << 1,
+};
+
+/** Used for \ref for_each_line(). */
+typedef int line_handler_t(char *, void *);
+int for_each_line(unsigned flags, char *buf, size_t size,
+               line_handler_t *line_handler, void *private_data);
+
+/**
+  * Write the contents of a status item to a para_buffer.
+  *
+  * \param b The para_buffer.
+  * \param n The number of the status item.
+  * \param f A format string.
+  *
+  * \return The return value of the underlying call to para_printf().
+  */
+#define WRITE_STATUS_ITEM(b, n, f, ...) (\
+{ \
+       int _ret; \
+       if ((b)->flags & PBF_SIZE_PREFIX) { \
+               _ret = para_printf((b), "%02x:" f, n, ## __VA_ARGS__); \
+       } else { \
+               _ret = para_printf((b), "%s: " f, status_item_list[(n)], \
+                       ## __VA_ARGS__); \
+       } \
+       _ret; \
+} \
+)
+
 __must_check __malloc void *para_realloc(void *p, size_t size);
 __must_check __malloc void *para_malloc(size_t size);
 __must_check __malloc void *para_calloc(size_t size);
 __must_check __malloc char *para_strdup(const char *s);
+
+__printf_2_0 unsigned xvasprintf(char **result, const char *fmt, va_list ap);
+__printf_2_3 unsigned xasprintf(char **result, const char *fmt, ...);
 __must_check __malloc __printf_1_2 char *make_message(const char *fmt, ...);
 __must_check __malloc char *para_strcat(char *a, const char *b);
 __must_check __malloc char *para_dirname(const char *name);
-__must_check const char *para_basename(const char *name);
+__must_check char *para_basename(const char *name);
 void chop(char *buf);
-__must_check __malloc char *para_tmpname(void);
 __must_check __malloc char *para_logname(void);
 __must_check __malloc char *para_homedir(void);
-__must_check unsigned split_args(char *args, char *** const argv_ptr, const char *delim);
 __malloc char *para_hostname(void);
 __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...);
-/** Used for for_each_line() and for_each_line_ro(). */
-typedef int line_handler_t(char *, void *);
-int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
-       void *private_data);
-int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
-       void *private_data);
 int para_atoi64(const char *str, int64_t *result);
 int para_atoi32(const char *str, int32_t *value);
+int get_loglevel_by_name(const char *txt);
+int read_size_header(const char *buf);
+int create_argv(const char *buf, const char *delim, char ***result);
+int create_shifted_argv(const char *buf, const char *delim, char ***result);
+int find_arg(const char *arg, char **argv);
+void free_argv(char **argv);
+int para_regcomp(regex_t *preg, const char *regex, int cflags);
+void freep(void *arg);
+int compute_word_num(const char *buf, const char *delim, int offset);
+char *safe_strdup(const char *src, size_t len);
+char *key_value_copy(const char *src, size_t len, const char *key);