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 REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
  20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
  21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
  22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
  23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
  24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
  25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
  26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
  27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
  28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
  29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
  30 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2006-2007 Pierre Habouzit
  34  */
  35
  36 #ifndef PFIXTOOLS_BUFFER_H
  37 #define PFIXTOOLS_BUFFER_H
  38
  39 #include <stdarg.h>
  40 #include "mem.h"
  41 #include "str.h"
  42 #include "array.h"
  43
  44 typedef A(char) buffer_t;
  45
  46 #define BUFFER_INIT {NULL, 0, 0}
  47
  48 DO_INIT(buffer_t, buffer);
  49 static inline void buffer_wipe(buffer_t *buf) {
  50     p_delete(&buf->data);
  51 }
  52 DO_NEW(buffer_t, buffer);
  53 DO_DELETE(buffer_t, buffer);
  54
  55 static inline void buffer_reset(buffer_t *buf) {
  56     buf->data[buf->len = 0] = '\0';
  57 }
  58
  59 static inline char *buffer_unwrap(buffer_t **buf) {
  60     char *res = (*buf)->data;
  61     (*buf)->data = NULL;
  62     buffer_delete(buf);
  63     return res;
  64 }
  65
  66 #define buffer_resize(buffer, newsize)                                         \
  67   array_ensure_exact_capacity(*(buffer), (newsize) + 1)
  68
  69 static inline void buffer_ensure(buffer_t *buf, ssize_t extra) {
  70     assert (extra >= 0);
  71     if (buf->len + extra >= buf->size) {
  72         buffer_resize(buf, buf->len + extra);
  73     }
  74 }
  75 static inline void buffer_extend(buffer_t *buf, ssize_t extra) {
  76     buffer_ensure(buf, extra);
  77     buf->len += extra;
  78     buf->data[buf->len] = '\0';
  79 }
  80 static inline void buffer_extendch(buffer_t *buf, ssize_t extra, int c) {
  81     buffer_ensure(buf, extra);
  82     memset(buf->data + buf->len, c, extra);
  83     buf->len += extra;
  84     buf->data[buf->len] = '\0';
  85 }
  86
  87
  88 static inline void buffer_add(buffer_t *buf, const void *data, ssize_t len) {
  89     buffer_ensure(buf, len);
  90     memcpy(buf->data + buf->len, data, len);
  91     buf->len += len;
  92     buf->data[buf->len] = '\0';
  93 }
  94 static inline void buffer_addstr(buffer_t *buf, const char *s) {
  95     buffer_add(buf, s, m_strlen(s));
  96 }
  97 static inline void buffer_addbuf(buffer_t *buf, buffer_t *buf2) {
  98     buffer_add(buf, buf2->data, buf2->len);
  99 }
 100 static inline void buffer_addch(buffer_t *buf, int c) {
 101     buffer_extendch(buf, 1, c);
 102 }
 103
 104 __attribute__((format(printf,2,0)))
 105 ssize_t buffer_addvf(buffer_t *, const char *fmt, va_list);
 106
 107 static inline __attribute__((format(printf,2,3)))
 108 ssize_t buffer_addf(buffer_t *buf, const char *fmt, ...)
 109 {
 110     ssize_t res;
 111     va_list args;
 112     va_start(args, fmt);
 113     res = buffer_addvf(buf, fmt, args);
 114     va_end(args);
 115     return res;
 116 }
 117
 118 void buffer_consume(buffer_t *buf, ssize_t len);
 119
 120 ssize_t buffer_read(buffer_t *buf, int fd, ssize_t count);
 121 ssize_t buffer_write(buffer_t *buf, int fd);
 122
 123 #endif /* PFIXTOOLS_BUFFER_H */