wiretap/buffer.h

   1 /* buffer.h
   2  *
   3  * $Id$
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  */
  23
  24 #ifndef __W_BUFFER_H__
  25 #define __W_BUFFER_H__
  26
  27 #include <glib.h>
  28 #include "ws_symbol_export.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 #define SOME_FUNCTIONS_ARE_DEFINES
  35
  36 typedef struct Buffer {
  37         guint8  *data;
  38         gsize   allocated;
  39         gsize   start;
  40         gsize   first_free;
  41 } Buffer;
  42
  43 WS_DLL_PUBLIC
  44 void buffer_init(Buffer* buffer, gsize space);
  45 WS_DLL_PUBLIC
  46 void buffer_free(Buffer* buffer);
  47 WS_DLL_PUBLIC
  48 void buffer_assure_space(Buffer* buffer, gsize space);
  49 WS_DLL_PUBLIC
  50 void buffer_append(Buffer* buffer, guint8 *from, gsize bytes);
  51 WS_DLL_PUBLIC
  52 void buffer_remove_start(Buffer* buffer, gsize bytes);
  53
  54 #ifdef SOME_FUNCTIONS_ARE_DEFINES
  55 # define buffer_clean(buffer) buffer_remove_start((buffer), buffer_length(buffer))
  56 # define buffer_increase_length(buffer,bytes) (buffer)->first_free += (bytes)
  57 # define buffer_length(buffer) ((buffer)->first_free - (buffer)->start)
  58 # define buffer_start_ptr(buffer) ((buffer)->data + (buffer)->start)
  59 # define buffer_end_ptr(buffer) ((buffer)->data + (buffer)->first_free)
  60 # define buffer_append_buffer(buffer,src_buffer) buffer_append((buffer), buffer_start_ptr(src_buffer), buffer_length(src_buffer))
  61 #else
  62  void buffer_clean(Buffer* buffer);
  63  void buffer_increase_length(Buffer* buffer, unsigned int bytes);
  64  unsigned int buffer_length(Buffer* buffer);
  65  guint8* buffer_start_ptr(Buffer* buffer);
  66  guint8* buffer_end_ptr(Buffer* buffer);
  67  void buffer_append_buffer(Buffer* buffer, Buffer* src_buffer);
  68 #endif
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif /* __cplusplus */
  73
  74 #endif