nps/darray.h

Go to the documentation of this file.

/*    -*- c++ -*- */

/* This file should be #included by a file that declares the type as a .h file.  
   The file f8_array.c #includes the f8_array.h file-- not this one.
   In this manner, we can have a set of .h files (or their corresponding .c files) #include a
   set of different dervived *_array.h files without conflict.

   See for example the f8_array.h file located in the same directory.

*/

#ifndef NPS_DARRAY_H
#define NPS_DARRAY_H
#endif

#include <stdlib.h>

/* Resize-able arrays (so-called "Dynamic Arrays")
   Caller is responsible for allocatino/de-allocation of contents (if necessary)

   data is sent to to the array has char * which whose value is copied into the array using
   memcpy. This allows us to hold (void *) or non-pointer types.

   Index bound error will be non-recoverable.
   Out of memory errors will be non-recoverable. 
*/

#ifndef T_
#error "T_ not defined"
#endif

#ifndef TY
#error "TY not defined"
#endif

#include "../error/error.h"

 #if !defined BUILDING_NPS_DARRAY && !defined NPS_SMALL && !defined DARRAY_LKG
 #    define DARRAY_LKG static inline
 #else
 #    define DARRAY_LKG 
 #endif

 typedef struct {
     unsigned long size;
     unsigned long length;
     TY *data;
 } T_(array_t);

 /* nps_array_new()
    length  - the starting length of the array
    size    - the amount of space that should be allocated initiall (units of ty_size)
    ty_size - the size of the data that will be stored
    initVal - the value to initialize the array with
   if length is 0, no initialization will occur.
 */
DARRAY_LKG T_(array_t) *T_(array_new)(unsigned long length, unsigned long size, TY *initVal);
DARRAY_LKG void T_(array_del)(T_(array_t) *a);
DARRAY_LKG int T_(array_append)(T_(array_t) *a, TY data, nps_error_t *error);
DARRAY_LKG TY T_(array_pop)(T_(array_t) *o);
DARRAY_LKG TY T_(array_get)(T_(array_t) *a, unsigned long ix);
DARRAY_LKG void T_(array_set)(T_(array_t) *a, unsigned long ix, TY value);

DARRAY_LKG int T_(array_resize)(T_(array_t) *a,unsigned long size, nps_error_t *error);
DARRAY_LKG void T_(array_iter)(T_(array_t) *o, void (*operator)(TY  ));
DARRAY_LKG void T_(array_sort)(T_(array_t) *o, int (*cmp)(const void *, const void *));
DARRAY_LKG int64_t T_(array_len)(T_(array_t) *o);

#ifndef NPS_DARRAY_H_KEEP
#undef T_
#undef TY
//#undef DARRAY_LKG
#endif
                          

/* #endif */

---