NAME

vt_instantiation - creating a type-specific, configured vector

DESCRIPTION

There are two kind of instantiations: inline and multifile.

The inline version creates private (static inline) functions in the source file that uses the given vector exclusively. The overhead is minimal, but the vector is not reusable outside of the compilation unit. A detailed example project can be found in doc/ctype_mini1/

A multifile instantiation creates a new .c and .h file for the new vector. This allows multiple compilation units to #include the same header and link the same vector object file that contains public (non-inline) functions. A detailed example project can be found in doc/struct0/

Multifile instantiation, configuration settings (hti0.h)

#include  <stdlib.h> 
 #include  <string.h> 
 
 /* Elem=int; init=0
    Int vector, all newly allocated bytes are set to 0 */
 
 /* all public symbols are wrapped in GVT() - see vt_t(7) */
 #define GVT(x) vti0_ ## x
 
 /* Array elem type - see vt_t(7) */
 #define GVT_ELEM_TYPE int
 
 /* Type that represents array lengths - see vt_t(7) */
 #define GVT_SIZE_TYPE size_t
 
 /* Below this length, always double allocation size when the array grows */
 #define GVT_DOUBLING_THRS 4096
 
 /* Initial array size when the first element is written */
 #define GVT_START_SIZE 32
 
 /* Optional terminator; when present, it is always appended at the end - see
    vt_term(7)*/
 /* #define GVT_TERM '\0' */
 
 /* Optional prefix for function definitions (e.g. static inline) */
 #define GVT_FUNC
 
 /* Enable this to set all new bytes ever allocated to this value - see
     vt_set_new_bytes_to(7) */
 #define GVT_SET_NEW_BYTES_TO 0
 
 /* Enable GVT_INIT_ELEM_FUNC and an user configured function is called
    for each new element allocated (even between used and alloced).
    See  vt_init_elem(7) */
 /*#define GVT_INIT_ELEM_FUNC*/
 
 /* Enable GVT_ELEM_CONSTRUCTOR and an user configured function is called
    for each element that is getting within the range of -> used.
    See  vt_construction(7) */
 /*#define GVT_ELEM_CONSTRUCTOR */
 
 /* Enable GVT_ELEM_DESTRUCTOR and an user configured function is called
    for each element that was once constructed and now getting beyong -> used.
    See  vt_construction(7) */
 /*#define GVT_ELEM_DESTRUCTOR */
 
 /* Enable GVT_ELEM_COPY and an user configured function is called
    for copying elements into the array.
    See  vt_construction(7) */
 /*#define GVT_ELEM_COPY */
 
 /* Optional extra fields in the vector struct - see  vt_user_fields(7) */
 /* #define GVT_USER_FIELDS int foo; char bar[12]; */
 
 /* Include the actual header implementation */
 #include  <genvector/genvector_impl.h> 
 
 /* Memory allocator - see  vt_allocation(7) */
 #define GVT_REALLOC(vect, ptr, size)  realloc(ptr, size)
 #define GVT_FREE(vect, ptr)           free(ptr)
 
 /* clean up #defines */
 #include  <genvector/genvector_undef.h> 

SEE ALSO

• vt_t(7)

vt_instantiation 7	2016-03-04	genvector manual