chiark - git - mdw - disorder/blob - lib/sink.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2004 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20
  21 #ifndef SINK_H
  22 #define SINK_H
  23
  24 /* a sink is something you write to (the opposite would be a source) */
  25
  26 struct dynstr;
  27
  28 struct sink {
  29   int (*write)(struct sink *s, const void *buffer, int nbytes);
  30   /* return >= 0 on success, -1 on error */
  31 };
  32
  33 struct sink *sink_stdio(const char *name, FILE *fp);
  34 /* return a sink which writes to @fp@.  If @name@ is not a null
  35  * pointer, it will be used in (fatal) error messages; if it is a null
  36  * pointer then errors will be signalled by returning -1. */
  37
  38 struct sink *sink_dynstr(struct dynstr *output);
  39 /* return a sink which appends to @output@. */
  40
  41 int sink_vprintf(struct sink *s, const char *fmt, va_list ap);
  42 int sink_printf(struct sink *s, const char *fmt, ...)
  43   attribute((format (printf, 2, 3)));
  44 /* equivalent of vfprintf/fprintf for sink @s@ */
  45
  46 static inline int sink_write(struct sink *s, const void *buffer, int nbytes) {
  47   return s->write(s, buffer, nbytes);
  48 }
  49
  50 static inline int sink_writes(struct sink *s, const char *str) {
  51   return s->write(s, str, strlen(str));
  52 }
  53
  54 static inline int sink_writec(struct sink *s, char c) {
  55   return s->write(s, &c, 1);
  56 }
  57
  58 #endif /* SINK_H */
  59
  60
  61 /*
  62 Local Variables:
  63 c-basic-offset:2
  64 comment-column:40
  65 End:
  66 */
  67 /* arch-tag:2f4f2c2a4e65aef8f7c59b4785121083 */