X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fngircd%2Farray.h;h=fd428dbbd985990d87d034e2135f90537c7d5a93;hb=c8162a80beba80f3b1d04fdba8e74bf5366c47f7;hp=7a7e0d830c91d91323835575d68cb317e837ae45;hpb=ebbf92898e749da9341ebe3b7e71b96362161043;p=ngircd-alex.git diff --git a/src/ngircd/array.h b/src/ngircd/array.h index 7a7e0d83..fd428dbb 100644 --- a/src/ngircd/array.h +++ b/src/ngircd/array.h @@ -7,57 +7,62 @@ * * libarray - dynamically allocate arrays. * Copyright (c) 2005 Florian Westphal (westphal@foo.fh-furtwangen.de) - * - * $Id: array.h,v 1.1 2005/07/07 18:38:14 fw Exp $ */ #ifndef array_h_included #define array_h_included +/** + * @file + * Functions to dynamically allocate arrays (header). + */ + #include "portab.h" typedef struct { char * mem; - unsigned int allocated; - unsigned int used; + size_t allocated; + size_t used; } array; /* allocated: mem != NULL, used >= 0 && used <= allocated, allocated > 0 unallocated: mem == NULL, allocated == 0, used == 0 */ - #define array_unallocated(x) (array_bytes(x)==0) #define INIT_ARRAY { NULL, 0, 0 } +/* set all variables in a to 0 */ +extern void array_init PARAMS((array *a)); + /* allocates space for at least nmemb+1 elements of size bytes each. - return pointer to elem at pos, or NULL if realloc() fails */ -extern void * array_alloc PARAMS((array *a, unsigned int size, unsigned int pos)); + return pointer to elem at pos, or NULL if realloc() fails */ +extern void * array_alloc PARAMS((array *a, size_t size, size_t pos)); /* returns the number of initialized BYTES in a. */ #define array_bytes(array) ( (array)->used ) /* returns the number of initialized ELEMS in a. */ -extern unsigned int array_length PARAMS((const array* const a, unsigned int elemsize)); +extern size_t array_length PARAMS((const array* const a, size_t elemsize)); /* _copy functions: copy src to dest. -return true if OK, else false. (e.g. realloc failure, invalid src/dest array, ..) -In that case dest is left unchanged. */ + return true if OK, else false (e. g. realloc failure, invalid src/dest + array, ...). In that case dest is left unchanged. */ /* copy array src to dest */ extern bool array_copy PARAMS((array* dest, const array* const src)); /* copy len bytes from src to array dest. */ -extern bool array_copyb PARAMS((array* dest, const char* src, unsigned int len)); +extern bool array_copyb PARAMS((array* dest, const char* src, size_t len)); /* copy string to dest */ extern bool array_copys PARAMS((array* dest, const char* src)); /* _cat functions: append src to dest. -return true if OK, else false. (e.g. realloc failure, invalid src/dest array, ..) -In that case dest is left unchanged. */ + return true if OK, else false (e. g. realloc failure, invalid src/dest + array, ...). In that case dest is left unchanged. */ /* append len bytes from src to array dest. */ -extern bool array_catb PARAMS((array* dest, const char* src, unsigned int len)); +extern bool array_catb PARAMS((array* dest, const char* src, size_t len)); /* append string to dest */ extern bool array_cats PARAMS((array* dest, const char* src)); @@ -65,18 +70,21 @@ extern bool array_cats PARAMS((array* dest, const char* src)); /* append NUL byte to dest */ extern bool array_cat0 PARAMS((array* dest)); +/* append NUL byte to dest, but do not count null byte */ +extern bool array_cat0_temporary PARAMS((array* dest)); + /* append contents of array src to array dest. */ extern bool array_cat PARAMS((array* dest, const array* const src)); /* return pointer to element at pos. - return NULL if the array is unallocated or if pos is larger than the number - of elements stored int the array. */ -extern void* array_get PARAMS((array* a, unsigned int membersize, unsigned int pos)); + return NULL if the array is unallocated or if pos is larger than the number + of elements stored int the array. */ +extern void* array_get PARAMS((array* a, size_t membersize, size_t pos)); /* free the contents of this array. */ extern void array_free PARAMS((array* a)); -/* overwrite array with zeroes before free */ +/* overwrite array with zeros before free */ extern void array_free_wipe PARAMS((array* a)); /* return pointer to first element in this array */ @@ -86,10 +94,11 @@ extern void* array_start PARAMS((const array* const a)); extern void array_trunc PARAMS((array* a)); /* set number of used elements in this array to len */ -extern void array_truncate PARAMS((array* a, unsigned int membersize, unsigned int len)); +extern void array_truncate PARAMS((array* a, size_t membersize, size_t len)); /* move elements starting at pos to beginning of array */ -extern void array_moveleft PARAMS((array* a, unsigned int membersize, unsigned int pos)); +extern void array_moveleft PARAMS((array* a, size_t membersize, size_t pos)); #endif + /* -eof- */