sys/sys/sbuf.h

   1 /*-
   2  * Copyright (c) 2000 Poul-Henning Kamp and Dag-Erling Coïdan Smørgrav
   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  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  *      $FreeBSD$
  29  */
  30
  31 #ifndef _SYS_SBUF_H_
  32 #define _SYS_SBUF_H_
  33
  34 /*
  35  * Structure definition
  36  */
  37 struct sbuf {
  38         char            *s_buf;         /* storage buffer */
  39         struct sbuf     *s_next;        /* next in chain */
  40         int              s_size;        /* size of storage buffer */
  41         int              s_len;         /* current length of string */
  42 #define SBUF_AUTOEXTEND 0x00000001      /* automatically extend buffer */
  43 #define SBUF_DYNAMIC    0x00010000      /* s_buf must be freed */
  44 #define SBUF_FINISHED   0x00020000      /* set by sbuf_finish() */
  45 #define SBUF_OVERFLOWED 0x00040000      /* sbuf overflowed */
  46         int              s_flags;       /* flags */
  47 };
  48
  49 __BEGIN_DECLS
  50 /*
  51  * API functions
  52  */
  53 int      sbuf_new(struct sbuf *s, char *buf, int length, int flags);
  54 void     sbuf_clear(struct sbuf *s);
  55 int      sbuf_setpos(struct sbuf *s, int pos);
  56 int      sbuf_cat(struct sbuf *s, const char *str);
  57 int      sbuf_cpy(struct sbuf *s, const char *str);
  58 int      sbuf_printf(struct sbuf *s, char *fmt, ...);
  59 int      sbuf_putc(struct sbuf *s, int c);
  60 int      sbuf_overflowed(struct sbuf *s);
  61 void     sbuf_finish(struct sbuf *s);
  62 char    *sbuf_data(struct sbuf *s);
  63 int      sbuf_len(struct sbuf *s);
  64 void     sbuf_delete(struct sbuf *s);
  65 __END_DECLS
  66
  67 #endif