common/buffer.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS   */
  20 /*  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED         */
  21 /*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE    */
  22 /*  DISCLAIMED.  IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY         */
  23 /*  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL        */
  24 /*  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS   */
  25 /*  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     */
  26 /*  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       */
  27 /*  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  */
  28 /*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           */
  29 /*  POSSIBILITY OF SUCH DAMAGE.                                               */
  30 /*                                                                            */
  31 /*   Copyright (c) 2006-2008 the Authors                                      */
  32 /*   see AUTHORS and source files for details                                 */
  33 /******************************************************************************/
  34
  35 /*
  36  * Copyright © 2006-2007 Pierre Habouzit
  37  */
  38
  39 #ifndef PFIXTOOLS_BUFFER_H
  40 #define PFIXTOOLS_BUFFER_H
  41
  42 #include <stdarg.h>
  43 #include "mem.h"
  44 #include "str.h"
  45 #include "array.h"
  46
  47 typedef A(char) buffer_t;
  48
  49 #define BUFFER_INIT ARRAY_INIT
  50
  51 DO_INIT(buffer_t, buffer);
  52 static inline void buffer_wipe(buffer_t *buf) {
  53     p_delete(&buf->data);
  54 }
  55 DO_NEW(buffer_t, buffer);
  56 DO_DELETE(buffer_t, buffer);
  57
  58 static inline void buffer_reset(buffer_t *buf) {
  59     buf->data[buf->len = 0] = '\0';
  60 }
  61
  62 static inline char *buffer_unwrap(buffer_t **buf) {
  63     char *res = (*buf)->data;
  64     (*buf)->data = NULL;
  65     buffer_delete(buf);
  66     return res;
  67 }
  68
  69 #define buffer_resize(buffer, newsize)                                         \
  70   array_ensure_exact_capacity(*(buffer), (newsize) + 1)
  71
  72 static inline void buffer_ensure(buffer_t *buf, int extra) {
  73     assert (extra >= 0);
  74     if (buf->len + extra >= buf->size) {
  75         buffer_resize(buf, buf->len + extra);
  76     }
  77 }
  78 static inline void buffer_extend(buffer_t *buf, int extra) {
  79     buffer_ensure(buf, extra);
  80     buf->len += extra;
  81     buf->data[buf->len] = '\0';
  82 }
  83 static inline void buffer_extendch(buffer_t *buf, int extra, int c) {
  84     buffer_ensure(buf, extra);
  85     memset(buf->data + buf->len, c, extra);
  86     buf->len += extra;
  87     buf->data[buf->len] = '\0';
  88 }
  89
  90
  91 static inline void buffer_add(buffer_t *buf, const void *data, int len) {
  92     buffer_ensure(buf, len);
  93     memcpy(buf->data + buf->len, data, len);
  94     buf->len += len;
  95     buf->data[buf->len] = '\0';
  96 }
  97 static inline void buffer_addstr(buffer_t *buf, const char *s) {
  98     buffer_add(buf, s, m_strlen(s));
  99 }
 100 static inline void buffer_addbuf(buffer_t *buf, buffer_t *buf2) {
 101     buffer_add(buf, buf2->data, buf2->len);
 102 }
 103 static inline void buffer_addch(buffer_t *buf, int c) {
 104     buffer_extendch(buf, 1, c);
 105 }
 106
 107 __attribute__((format(printf,2,0)))
 108 int buffer_addvf(buffer_t *, const char *fmt, va_list);
 109
 110 static inline __attribute__((format(printf,2,3)))
 111 int buffer_addf(buffer_t *buf, const char *fmt, ...)
 112 {
 113     int res;
 114     va_list args;
 115     va_start(args, fmt);
 116     res = buffer_addvf(buf, fmt, args);
 117     va_end(args);
 118     return res;
 119 }
 120
 121 void buffer_consume(buffer_t *buf, int len);
 122
 123 int buffer_read(buffer_t *buf, int fd, int count);
 124 int buffer_write(buffer_t *buf, int fd);
 125
 126 #endif /* PFIXTOOLS_BUFFER_H */