2 * This file is part of DisOrder
3 * Copyright (C) 2004, 2007, 2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 * @brief Abstract output sink type
35 /** @brief Formatted output to a sink
36 * @param s Sink to write to
37 * @param fmt Format string
38 * @param ap Argument list
39 * @return Number of bytes written on success, -1 on error
41 int sink_vprintf(struct sink *s, const char *fmt, va_list ap) {
42 return byte_vsinkprintf(s, fmt, ap);
45 /** @brief Formatted output to a sink
46 * @param s Sink to write to
47 * @param fmt Format string
48 * @return Number of bytes written on success, -1 on error
50 int sink_printf(struct sink *s, const char *fmt, ...) {
55 n = byte_vsinkprintf(s, fmt, ap);
60 /* stdio sink *****************************************************************/
62 /** @brief Sink that writes to a stdio @c FILE */
64 /** @brief Base member */
67 /** @brief Filename */
70 /** @brief Stream to write to */
74 /** @brief Reinterpret a @ref sink as a @ref stdio_sink */
75 #define S(s) ((struct stdio_sink *)s)
77 /** @brief Write callback for @ref stdio_sink */
78 static int sink_stdio_write(struct sink *s, const void *buffer, int nbytes) {
79 int n = fwrite(buffer, 1, nbytes, S(s)->fp);
82 fatal(errno, "error writing to %s", S(s)->name);
89 /** @brief Create a sink that writes to a stdio stream
90 * @param name Filename for use in error messages
91 * @param fp Stream to write to
92 * @return Pointer to new sink
94 struct sink *sink_stdio(const char *name, FILE *fp) {
95 struct stdio_sink *s = xmalloc(sizeof *s);
97 s->s.write = sink_stdio_write;
100 return (struct sink *)s;
103 /* dynstr sink ****************************************************************/
105 /** @brief Sink that writes to a dynamic string */
107 /** @brief Base member */
109 /** @brief Pointer to dynamic string to append to */
113 /** @brief Write callback for @ref dynstr_sink */
114 static int sink_dynstr_write(struct sink *s, const void *buffer, int nbytes) {
115 dynstr_append_bytes(((struct dynstr_sink *)s)->d, buffer, nbytes);
119 /** @brief Create a sink that appends to a @ref dynstr
120 * @param output Dynamic string to append to
121 * @return Pointer to new sink
123 struct sink *sink_dynstr(struct dynstr *output) {
124 struct dynstr_sink *s = xmalloc(sizeof *s);
126 s->s.write = sink_dynstr_write;
128 return (struct sink *)s;
131 /* discard sink **************************************************************/
133 static int sink_discard_write(struct sink attribute((unused)) *s,
134 const void attribute((unused)) *buffer,
139 /** @brief Return a sink which discards all output */
140 struct sink *sink_discard(void) {
141 struct sink *s = xmalloc(sizeof *s);
143 s->write = sink_discard_write;
147 /* error sink **************************************************************/
149 static int sink_error_write(struct sink attribute((unused)) *s,
150 const void attribute((unused)) *buffer,
151 int attribute((unused)) nbytes) {
155 /** @brief Return a sink which discards all output */
156 struct sink *sink_error(void) {
157 struct sink *s = xmalloc(sizeof *s);
159 s->write = sink_error_write;