X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/fe9de6c9fbf52fa3a0eb0929fd18d615741f1d49..c97fbcf9622edc35b594bf574f553f7f13c21164:/buf.h diff --git a/buf.h b/buf.h index 84c4121..065db07 100644 --- a/buf.h +++ b/buf.h @@ -7,7 +7,7 @@ * (c) 2001 Straylight/Edgeware */ -/*----- Licensing notice --------------------------------------------------* +/*----- Licensing notice --------------------------------------------------* * * This file is part of Catacomb. * @@ -15,12 +15,12 @@ * it under the terms of the GNU Library General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) any later version. - * + * * Catacomb is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Library General Public License for more details. - * + * * You should have received a copy of the GNU Library General Public * License along with Catacomb; if not, write to the Free * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, @@ -36,9 +36,8 @@ /*----- Header files ------------------------------------------------------*/ -#include - #include +#include #ifndef CATACOMB_MP_H # include "mp.h" @@ -48,284 +47,8 @@ # include "ec.h" #endif -/*----- Data structures ---------------------------------------------------*/ - -/* --- Buffers --- * - * - * Buffers provide a simple stream-like interface for building and parsing - * packets. - */ - -typedef struct buf { - octet *base, *p, *limit; /* Pointers to the buffer */ - unsigned f; /* Various flags */ -} buf; - -#define BF_BROKEN 1u /* Buffer is broken */ - -/*----- Useful macros -----------------------------------------------------*/ - -#define BBASE(b) ((b)->base) -#define BLIM(b) ((b)->limit) -#define BCUR(b) ((b)->p) -#define BSZ(b) ((b)->limit - (b)->base) -#define BLEN(b) ((b)->p - (b)->base) -#define BLEFT(b) ((b)->limit - (b)->p) -#define BSTEP(b, sz) ((b)->p += (sz)) -#define BBAD(b) ((b)->f & BF_BROKEN) -#define BOK(b) (!BBAD(b)) - -#define BENSURE(b, sz) \ - (BBAD(b) ? -1 : (sz) > BLEFT(b) ? (b)->f |= BF_BROKEN, -1 : 0) - /*----- Functions provided ------------------------------------------------*/ -/* --- @buf_init@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @void *p@ = pointer to a buffer - * @size_t sz@ = size of the buffer - * - * Returns: --- - * - * Use: Initializes the buffer block appropriately. - */ - -extern void buf_init(buf */*b*/, void */*p*/, size_t /*sz*/); - -/* --- @buf_break@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * - * Returns: Some negative value. - * - * Use: Marks a buffer as broken. - */ - -extern int buf_break(buf */*b*/); - -/* --- @buf_flip@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * - * Returns: --- - * - * Use: Flips a buffer so that if you've just been writing to it, - * you can now read from the bit you've written. - */ - -extern void buf_flip(buf */*b*/); - -/* --- @buf_ensure@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @size_t sz@ = size of data wanted - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Ensures that there are @sz@ bytes still in the buffer. - */ - -extern int buf_ensure(buf */*b*/, size_t /*sz*/); - -/* --- @buf_get@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @size_t sz@ = size of the buffer - * - * Returns: Pointer to the place in the buffer. - * - * Use: Reserves a space in the buffer of the requested size, and - * returns its start address. - */ - -extern void *buf_get(buf */*b*/, size_t /*sz*/); - -/* --- @buf_put@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @const void *p@ = pointer to a buffer - * @size_t sz@ = size of the buffer - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Fetches data from some place and puts it in the buffer - */ - -extern int buf_put(buf */*b*/, const void */*p*/, size_t /*sz*/); - -/* --- @buf_getbyte@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * - * Returns: A byte, or less than zero if there wasn't a byte there. - * - * Use: Gets a single byte from a buffer. - */ - -extern int buf_getbyte(buf */*b*/); - -/* --- @buf_putbyte@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @int ch@ = byte to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a single byte in a buffer. - */ - -extern int buf_putbyte(buf */*b*/, int /*ch*/); - -/* --- @buf_getu16@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint16 *w@ = where to put the word - * - * Returns: Zero if OK, or nonzero if there wasn't a word there. - * - * Use: Gets a 16-bit word from a buffer. - */ - -extern int buf_getu16(buf */*b*/, uint16 */*w*/); - -/* --- @buf_putu16@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint16 w@ = word to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a 16-but word in a buffer. - */ - -extern int buf_putu16(buf */*b*/, uint16 /*w*/); - -/* --- @buf_getu32@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint32 *w@ = where to put the word - * - * Returns: Zero if OK, or nonzero if there wasn't a word there. - * - * Use: Gets a 32-bit word from a buffer. - */ - -extern int buf_getu32(buf */*b*/, uint32 */*w*/); - -/* --- @buf_putu32@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint32 w@ = word to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a 32-but word in a buffer. - */ - -extern int buf_putu32(buf */*b*/, uint32 /*w*/); - -/* --- @buf_getmem{8,16,32,z} --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @size_t *nn@ = where to put the length - * - * Returns: Pointer to the buffer data, or null. - * - * Use: Gets a chunk of memory from a buffer. The number, @16@ or - * @32@, is the width of the length; @z@ means null-terminated. - */ - -extern void *buf_getmem8(buf */*b*/, size_t */*nn*/); -extern void *buf_getmem16(buf */*b*/, size_t */*nn*/); -extern void *buf_getmem32(buf */*b*/, size_t */*nn*/); -extern void *buf_getmemz(buf */*b*/, size_t */*nn*/); - -/* --- @buf_putmem{8,16,32,z} --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @const void *p@ = pointer to data to write - * @size_t n@ = length to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Writes a chunk of data to a buffer. The number, @16@ or - * @32@, is the width of the length; @z@ means null-terminated. - */ - -extern int buf_putmem8(buf */*b*/, const void */*p*/, size_t /*n*/); -extern int buf_putmem16(buf */*b*/, const void */*p*/, size_t /*n*/); -extern int buf_putmem32(buf */*b*/, const void */*p*/, size_t /*n*/); -extern int buf_putmemz(buf */*b*/, const void */*p*/, size_t /*n*/); - -/* --- @buf_getbuf{8,16,32,z}@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @buf *bb@ = where to put the result - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Gets a block of data from a buffer, and writes its bounds to - * another buffer. The number, @16@ or @32@, is the width of - * the length; @z@ means null-terminated. - */ - -extern int buf_getbuf8(buf */*b*/, buf */*bb*/); -extern int buf_getbuf16(buf */*b*/, buf */*bb*/); -extern int buf_getbuf32(buf */*b*/, buf */*bb*/); -extern int buf_getbufz(buf */*b*/, buf */*bb*/); - -/* --- @buf_putbuf{8,16,32,z}@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @buf *bb@ = buffer to write - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Puts the contents of a buffer to a buffer. The number, @16@ - * or @32@, is the width of the length; @z@ means null- - * terminated. - */ - -extern int buf_putbuf8(buf */*b*/, buf */*bb*/); -extern int buf_putbuf16(buf */*b*/, buf */*bb*/); -extern int buf_putbuf32(buf */*b*/, buf */*bb*/); -extern int buf_putbufz(buf */*b*/, buf */*bb*/); - -/* --- @buf_getstr{8,16,32,z}@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @dstr *d@ = where to put the result - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Gets a block of data from a buffer, and writes its contents - * to a string. The number, @16@ or @32@, is the width of the - * length; @z@ means null-terminated. - */ - -extern int buf_getstr8(buf */*b*/, dstr */*d*/); -extern int buf_getstr16(buf */*b*/, dstr */*d*/); -extern int buf_getstr32(buf */*b*/, dstr */*d*/); -extern int buf_getstrz(buf */*b*/, dstr */*d*/); - -/* --- @buf_putstr{8,16,32,z}@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @dstr *d@ = string to write - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Puts a string to a buffer, and writes its bounds to - * another buffer. The number, @16@ or @32@, is the width of - * the length; @z@ means null-terminated. - */ - -extern int buf_putstr8(buf */*b*/, dstr */*d*/); -extern int buf_putstr16(buf */*b*/, dstr */*d*/); -extern int buf_putstr32(buf */*b*/, dstr */*d*/); -extern int buf_putstrz(buf */*b*/, dstr */*d*/); - /* --- @buf_getmp@ --- * * * Arguments: @buf *b@ = pointer to a buffer block