/*
* This file is part of DisOrder
- * Copyright (C) 2004 Richard Kettlewell
+ * Copyright (C) 2004, 2007-9, 2013 Richard Kettlewell
*
- * This program is free software; you can redistribute it and/or modify
+ * 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
+ * the Free Software Foundation, either version 3 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.
- *
+ *
+ * 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-1307
- * USA
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/sink.c
+ * @brief Abstract output sink type
*/
-#include <config.h>
-#include "types.h"
+#include "common.h"
-#include <stdio.h>
#include <stdarg.h>
-#include <string.h>
#include <errno.h>
#include "mem.h"
#include "vector.h"
-#include "sink.h"
+#include "socketio.h"
#include "log.h"
+#include "sink.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;
return n;
}
+static int sink_generic_flush(struct sink attribute((unused)) *s) {
+ return 0;
+}
+
+static int sink_generic_error(struct sink attribute((unused)) *s) {
+ return 0;
+}
+
/* 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;
+
+ int error;
};
+/** @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) {
+ S(s)->error = errno;
if(S(s)->name)
- fatal(errno, "error writing to %s", S(s)->name);
+ disorder_fatal(errno, "error writing to %s", S(s)->name);
else
return -1;
}
return n;
}
+static int sink_stdio_error(struct sink *s) {
+ return S(s)->error;
+}
+
+/** @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);
s->s.write = sink_stdio_write;
+ s->s.flush = sink_generic_flush;
+ s->s.error = sink_stdio_error;
+ s->s.eclass = ec_errno;
s->name = name;
s->fp = fp;
return (struct sink *)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);
s->s.write = sink_dynstr_write;
+ s->s.flush = sink_generic_flush;
+ s->s.error = sink_generic_error;
+ s->s.eclass = ec_errno;
s->d = output;
return (struct sink *)s;
}
+/* discard sink **************************************************************/
+
+static int sink_discard_write(struct sink attribute((unused)) *s,
+ const void attribute((unused)) *buffer,
+ int nbytes) {
+ return nbytes;
+}
+
+/** @brief Return a sink which discards all output */
+struct sink *sink_discard(void) {
+ struct sink *s = xmalloc(sizeof *s);
+
+ s->write = sink_discard_write;
+ s->flush = sink_generic_flush;
+ s->error = sink_generic_error;
+ s->eclass = ec_errno;
+ return s;
+}
+
+/* error sink **************************************************************/
+
+static int sink_error_write(struct sink attribute((unused)) *s,
+ const void attribute((unused)) *buffer,
+ int attribute((unused)) nbytes) {
+ return -1;
+}
+
+/** @brief Return a sink which discards all output */
+struct sink *sink_error(void) {
+ struct sink *s = xmalloc(sizeof *s);
+
+ s->write = sink_error_write;
+ s->flush = sink_generic_flush;
+ s->error = sink_generic_error;
+ s->eclass = ec_errno;
+ return s;
+}
+
+/* socket sink *************************************************************/
+
+/** @brief Sink that writes to a socket handle */
+struct socketio_sink {
+ /** @brief Base member */
+ struct sink s;
+
+ struct socketio *sio;
+};
+
+static int sink_socketio_flush(struct sink *s) {
+ struct socketio_sink *ss = (struct socketio_sink *)s;
+ return socketio_flush(ss->sio);
+}
+
+/** @brief Write callback for @ref stdio_sink */
+static int sink_socketio_write(struct sink *s, const void *buffer, int nbytes) {
+ struct socketio_sink *ss = (struct socketio_sink *)s;
+ return socketio_write(ss->sio, buffer, nbytes);
+}
+
+static int sink_socketio_error(struct sink *s) {
+ struct socketio_sink *ss = (struct socketio_sink *)s;
+ return socketio_error(ss->sio);
+}
+
+/** @brief Create a sink that writes to a socket
+ * @param sio Socket IO context
+ * @return Pointer to new sink
+ */
+struct sink *sink_socketio(struct socketio *sio) {
+ struct socketio_sink *s = xmalloc(sizeof *s);
+
+ s->s.write = sink_socketio_write;
+ s->s.flush = sink_socketio_flush;
+ s->s.error = sink_socketio_error;
+ s->s.eclass = ec_native;
+ s->sio = sio;
+ return &s->s;
+}
+
+/* stdio source *************************************************************/
+
+/** @brief Source that reads from a socket handle */
+struct stdio_source {
+ /** @brief Base member */
+ struct source s;
+
+ FILE *fp;
+};
+
+static int source_stdio_getc(struct source *s) {
+ return getc(((struct stdio_source *)s)->fp);
+}
+
+static int source_stdio_error(struct source *s) {
+ FILE *fp = ((struct stdio_source *)s)->fp;
+ if(ferror(fp)) {
+#if _WIN32
+ return GetLastError();
+#else
+ return errno;
+#endif
+ }
+ return 0;
+}
+
+static int source_stdio_eof(struct source *s) {
+ FILE *fp = ((struct stdio_source *)s)->fp;
+ return feof(fp);
+}
+
+struct source *source_stdio(FILE *fp) {
+ struct stdio_source *ss = xmalloc(sizeof *ss);
+ ss->s.getch = source_stdio_getc;
+ ss->s.error = source_stdio_error;
+ ss->s.eof = source_stdio_eof;
+ ss->s.eclass = ec_errno;
+ ss->fp = fp;
+ return (struct source *)ss;
+}
+
+/* socket source ***********************************************************/
+
+/** @brief Source that reads from a socket handle */
+struct socket_source {
+ /** @brief Base member */
+ struct source s;
+
+ struct socketio *sio;
+};
+
+static int source_socketio_getc(struct source *s) {
+ return socketio_getc(((struct socket_source *)s)->sio);
+}
+
+static int source_socketio_error(struct source *s) {
+ return socketio_error(((struct socket_source *)s)->sio);
+}
+static int source_socketio_eof(struct source *s) {
+ return socketio_eof(((struct socket_source *)s)->sio);
+}
+
+struct source *source_socketio(struct socketio *sio) {
+ struct socket_source *ss = xmalloc(sizeof *ss);
+ ss->s.getch = source_socketio_getc;
+ ss->s.error = source_socketio_error;
+ ss->s.eof = source_socketio_eof;
+ ss->s.eclass = ec_native;
+ ss->sio = sio;
+ return (struct source *)ss;
+}
+
/*
Local Variables:
c-basic-offset:2
~mdw / disorder / blobdiff