usr.bin/csup/stream.h

   1 /*-
   2  * Copyright (c) 2003-2006, Maxime Henrion <mux@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28 #ifndef _STREAM_H_
  29 #define _STREAM_H_
  30
  31 #include "misc.h"
  32
  33 /* Stream filters. */
  34 typedef enum {
  35         STREAM_FILTER_NULL,
  36         STREAM_FILTER_ZLIB,
  37         STREAM_FILTER_MD5,
  38         STREAM_FILTER_MD5RCS
  39 } stream_filter_t;
  40
  41 struct stream;
  42 struct buf;
  43
  44 typedef ssize_t stream_readfn_t(void *, void *, size_t);
  45 typedef ssize_t stream_writefn_t(void *, const void *, size_t);
  46 typedef int     stream_closefn_t(void *);
  47
  48 /* Convenience functions for handling file descriptors. */
  49 stream_readfn_t         stream_read_fd;
  50 stream_writefn_t        stream_write_fd;
  51 stream_closefn_t        stream_close_fd;
  52
  53 /* Convenience functions for handling character buffers. */
  54 stream_readfn_t         stream_read_buf;
  55 stream_writefn_t        stream_append_buf;
  56 stream_closefn_t        stream_close_buf;
  57
  58 struct stream   *stream_open(void *, stream_readfn_t *, stream_writefn_t *,
  59                      stream_closefn_t *);
  60 struct stream   *stream_open_fd(int, stream_readfn_t *, stream_writefn_t *,
  61                      stream_closefn_t *);
  62 struct stream   *stream_open_buf(struct buf *);
  63 struct stream   *stream_open_file(const char *, int, ...);
  64 int              stream_fileno(struct stream *);
  65 ssize_t          stream_read(struct stream *, void *, size_t);
  66 ssize_t          stream_read_blocking(struct stream *, void *, size_t);
  67 ssize_t          stream_write(struct stream *, const void *, size_t);
  68 char            *stream_getln(struct stream *, size_t *);
  69 int              stream_printf(struct stream *, const char *, ...)
  70                      __printflike(2, 3);
  71 int              stream_flush(struct stream *);
  72 int              stream_sync(struct stream *);
  73 int              stream_truncate(struct stream *, off_t);
  74 void             stream_truncate_buf(struct buf *, off_t);
  75 int              stream_truncate_rel(struct stream *, off_t);
  76 int              stream_rewind(struct stream *);
  77 int              stream_eof(struct stream *);
  78 int              stream_close(struct stream *);
  79 int              stream_filter_start(struct stream *, stream_filter_t, void *);
  80 void             stream_filter_stop(struct stream *);
  81
  82 struct buf      *buf_new(size_t);
  83 void             buf_free(struct buf *);
  84 #endif /* !_STREAM_H_ */