src/carray.h

   1
   2 /*
   3  * libEtPan! -- a mail stuff library
   4  *
   5  * carray - Implements simple dynamic pointer arrays
   6  *
   7  * Copyright (c) 1999-2000, Gaël Roualland <gael.roualland@iname.com>
   8  * interface changes - 2002 - DINH Viet Hoa
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of the libEtPan! project nor the names of its
  20  *    contributors may be used to endorse or promote products derived
  21  *    from this software without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #ifndef CARRAY_H
  37 #define CARRAY_H
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 #include <inttypes.h>
  44
  45 struct carray_s {
  46   void ** array;
  47   uint32_t len;
  48   uint32_t max;
  49 };
  50
  51 typedef struct carray_s carray;
  52
  53 /* Creates a new array of pointers, with initsize preallocated cells */
  54 carray *   carray_new(uint32_t initsize);
  55
  56 /* Adds the pointer to data in the array.
  57    Returns the index of the pointer in the array or -1 on error */
  58 int       carray_add(carray * array, void * data, uint32_t * index);
  59
  60 int carray_set_size(carray * array, uint32_t new_size);
  61
  62 /* Removes the cell at this index position. Returns TRUE on success.
  63    Order of elements in the array IS changed. */
  64 int       carray_delete(carray * array, uint32_t indx);
  65
  66 /* Removes the cell at this index position. Returns TRUE on success.
  67    Order of elements in the array IS not changed. */
  68 int       carray_delete_slow(carray * array, uint32_t indx);
  69
  70 /* remove without decreasing the size of the array */
  71 int carray_delete_fast(carray * array, uint32_t indx);
  72
  73 /* Some of the following routines can be implemented as macros to
  74    be faster. If you don't want it, define NO_MACROS */
  75 #ifdef NO_MACROS
  76
  77 /* Returns the array itself */
  78 void **   carray_data(carray);
  79
  80 /* Returns the number of elements in the array */
  81 int       carray_count(carray);
  82
  83 /* Returns the contents of one cell */
  84 void *    carray_get(carray array, int indx);
  85
  86 /* Sets the contents of one cell */
  87 void      carray_set(carray array, int indx, void * value);
  88
  89 #else
  90 #define   carray_data(a)         (a->array)
  91 #define   carray_count(a)        (a->len)
  92 #define   carray_get(a, indx)    (a->array[indx])
  93 #define   carray_set(a, indx, v) do { a->array[indx]=v; } while(0)
  94 #endif
  95
  96 void carray_free(carray * array);
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif