lib-lib/buffer.h

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 /*
  21  * Copyright notice from original mutt:
  22  * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
  23  *
  24  * This file is part of mutt-ng, see http://www.muttng.org/.
  25  * It's licensed under the GNU General Public License,
  26  * please see the file GPL in the top level source directory.
  27  */
  28
  29 #ifndef MUTT_LIB_LIB_BUFFER_H
  30 #define MUTT_LIB_LIB_BUFFER_H
  31
  32 #include <lib-lib/str.h>
  33
  34 /* flags for mutt_extract_token() */
  35 #define M_TOKEN_EQUAL           1       /* treat '=' as a special */
  36 #define M_TOKEN_CONDENSE        (1<<1)  /* ^(char) to control chars (macros) */
  37 #define M_TOKEN_SPACE           (1<<2)  /* don't treat whitespace as a term */
  38 #define M_TOKEN_QUOTE           (1<<3)  /* don't interpret quotes */
  39 #define M_TOKEN_PATTERN         (1<<4)  /* !)|~ are terms (for patterns) */
  40 #define M_TOKEN_COMMENT         (1<<5)  /* don't reap comments */
  41 #define M_TOKEN_SEMICOLON       (1<<6)  /* don't treat ; as special */
  42
  43
  44 typedef struct {
  45     char *data;          /* pointer to data */
  46     char *dptr;          /* current read/write position */
  47     size_t dsize;        /* length of data */
  48     int destroy;         /* destroy `data' when done? */
  49 } BUFFER;
  50
  51 BUFFER *mutt_buffer_init(BUFFER *);
  52 void mutt_buffer_free(BUFFER **);
  53
  54 BUFFER *mutt_buffer_from(BUFFER *, const char *);
  55 int mutt_extract_token(BUFFER *, BUFFER *, int);
  56
  57 void mutt_buffer_add(BUFFER *, const char *, size_t);
  58 static inline void mutt_buffer_addstr(BUFFER *b, const char *s) {
  59     mutt_buffer_add(b, s, m_strlen(s));
  60 }
  61
  62 static inline void mutt_buffer_addch(BUFFER *b, char c) {
  63     mutt_buffer_add(b, &c, 1);
  64 }
  65
  66 static inline void mutt_buffer_reset(BUFFER *b) {
  67     *(b->dptr = b->data) = '\0';
  68 }
  69
  70 #endif /* MUTT_LIB_LIB_BUFFER_H */