* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
+/** @file lib/sink.c
+ * @brief Abstract output sink type
+ */
#include <config.h>
#include "types.h"
#include "log.h"
#include "printf.h"
+/** @brief Formatted output to a sink
+ * @param s Sink to write to
+ * @param fmt Format string
+ * @param ap Argument list
+ * @return Number of bytes written on success, -1 on error
+ */
int sink_vprintf(struct sink *s, const char *fmt, va_list ap) {
return byte_vsinkprintf(s, fmt, ap);
}
+/** @brief Formatted output to a sink
+ * @param s Sink to write to
+ * @param fmt Format string
+ * @return Number of bytes written on success, -1 on error
+ */
int sink_printf(struct sink *s, const char *fmt, ...) {
va_list ap;
int n;
/* stdio sink *****************************************************************/
+/** @brief Sink that writes to a stdio @c FILE */
struct stdio_sink {
+ /** @brief Base member */
struct sink s;
+
+ /** @brief Filename */
const char *name;
+
+ /** @brief Stream to write to */
FILE *fp;
};
+/** @brief Reinterpret a @ref sink as a @ref stdio_sink */
#define S(s) ((struct stdio_sink *)s)
+/** @brief Write callback for @ref stdio_sink */
static int sink_stdio_write(struct sink *s, const void *buffer, int nbytes) {
int n = fwrite(buffer, 1, nbytes, S(s)->fp);
if(n < nbytes) {
return n;
}
+/** @brief Create a sink that writes to a stdio stream
+ * @param name Filename for use in error messages
+ * @param fp Stream to write to
+ * @return Pointer to new sink
+ */
struct sink *sink_stdio(const char *name, FILE *fp) {
struct stdio_sink *s = xmalloc(sizeof *s);
/* dynstr sink ****************************************************************/
+/** @brief Sink that writes to a dynamic string */
struct dynstr_sink {
+ /** @brief Base member */
struct sink s;
+ /** @brief Pointer to dynamic string to append to */
struct dynstr *d;
};
+/** @brief Write callback for @ref dynstr_sink */
static int sink_dynstr_write(struct sink *s, const void *buffer, int nbytes) {
dynstr_append_bytes(((struct dynstr_sink *)s)->d, buffer, nbytes);
return nbytes;
}
+/** @brief Create a sink that appends to a @ref dynstr
+ * @param output Dynamic string to append to
+ * @return Pointer to new sink
+ */
struct sink *sink_dynstr(struct dynstr *output) {
struct dynstr_sink *s = xmalloc(sizeof *s);
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
+/** @file lib/sink.h
+ * @brief Abstract output sink type
+ */
#ifndef SINK_H
#define SINK_H
-/* a sink is something you write to (the opposite would be a source) */
-
struct dynstr;
+/** @brief Sink type
+ *
+ * A sink is something you write bytes to; the opposite would be a
+ * source. We provide sink_stdio() and sink_dynstr() to create sinks
+ * to write to stdio streams and dynamic strings.
+ */
struct sink {
+ /** @brief Write callback
+ * @param s Sink to write to
+ * @param buffer First byte to write
+ * @param nbytes Number of bytes to write
+ * @return non-negative on success, -1 on error
+ */
int (*write)(struct sink *s, const void *buffer, int nbytes);
- /* return >= 0 on success, -1 on error */
};
struct sink *sink_stdio(const char *name, FILE *fp);
attribute((format (printf, 2, 3)));
/* equivalent of vfprintf/fprintf for sink @s@ */
+/** @brief Write bytes to a sink
+ * @param s Sink to write to
+ * @param buffer First byte to write
+ * @param nbytes Number of bytes to write
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_write(struct sink *s, const void *buffer, int nbytes) {
return s->write(s, buffer, nbytes);
}
+/** @brief Write string to a sink
+ * @param s Sink to write to
+ * @param str String to write
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_writes(struct sink *s, const char *str) {
return s->write(s, str, strlen(str));
}
+/** @brief Write one byte to a sink
+ * @param s Sink to write to
+ * @param c Byte to write (as a @c char)
+ * @return non-negative on success, -1 on error
+ */
static inline int sink_writec(struct sink *s, char c) {
return s->write(s, &c, 1);
}
#include "selection.h"
#include "syscalls.h"
#include "kvp.h"
+#include "sink.h"
static int tests, errors;
static int fail_first;
"abc%25%20%2b%0a");
}
+static void test_sink(void) {
+ struct sink *s;
+ struct dynstr d[1];
+ FILE *fp;
+ char *l;
+
+ fprintf(stderr, "test_sink\n");
+
+ fp = tmpfile();
+ assert(fp != 0);
+ s = sink_stdio("tmpfile", fp);
+ insist(sink_printf(s, "test: %d\n", 999) == 10);
+ insist(sink_printf(s, "wibble: %s\n", "foobar") == 15);
+ rewind(fp);
+ insist(inputline("tmpfile", fp, &l, '\n') == 0);
+ check_string(l, "test: 999");
+ insist(inputline("tmpfile", fp, &l, '\n') == 0);
+ check_string(l, "wibble: foobar");
+ insist(inputline("tmpfile", fp, &l, '\n') == -1);
+
+ dynstr_init(d);
+ s = sink_dynstr(d);
+ insist(sink_printf(s, "test: %d\n", 999) == 10);
+ insist(sink_printf(s, "wibble: %s\n", "foobar") == 15);
+ dynstr_terminate(d);
+ check_string(d->vec, "test: 999\nwibble: foobar\n");
+}
+
int main(void) {
fail_first = !!getenv("FAIL_FIRST");
insist('\n' == 0x0A);
/* printf.c */
/* queue.c */
/* sink.c */
+ test_sink();
/* snprintf.c */
/* split.c */
/* syscalls.c */