CVector  3.0
A C++ style vector library in strict ANSI C (C89)
CVector notes

Intro

This is a relatively simple ANSI compliant C vector library with specific structures and functions for int's, double's and string's and support for all other types using a generic structure where the type is passed in as void* and stored in a byte array (to avoid dereferencing void* warnings and frequent casting) . The generic vector is very flexible and allows you to provide free and init functions if you like that it will call at appropriate times similar to the way C++ containers will call destructors.

Other modifiable parameters are at the top of vector_*.c

size_t CVEC_I_START_SZ = 50;
size_t CVEC_D_START_SZ = 50;
size_t CVEC_STR_START_SZ = 20;
size_t CVEC_VOID_START_SZ = 20;
#define CVEC_I_ALLOCATOR(x) ((x) * 2)
#define CVEC_D_ALLOCATOR(x) ((x) * 2)
#define CVEC_STR_ALLOCATOR(x) ((x) * 2)
#define CVEC_VOID_ALLOCATOR(x) ((x) * 2)

The allocator macros are used in all functions that increase the size by 1. In others (constructors, insert_array, reserve) VEC_X_START_SZ is the amount extra allocated.

There are also 2 templates, one for basic types and one for types that contain dynamically allocated memory and you might want a free and/or init function. In other words the first template is based off vector_i and the second is based off of vector_void, so look at the corresponding documentation for behavior. There are actually 2 varieties of each template, one all-in-one header variety that works like cvector.h, and the other generates a matching c/h pair.

They are located in vector_template.h, vector_template2.h, vector_template3.c/h and vector_template4.c/h.

To generate your own vector files for a type just run:

python3 generate_code.py yourtype

which will generate the results for all templates so just delete the ones you don't want.

vector_short and vector_f_struct are examples of the process and how to add it to the testing.

Design Notes

Memory allocations are checked and asserted. If not in debug mode (ie NDEBUG is defined) 0 is returned on allocation failure.

No other error checking is performed. If you pass bad parameters, bad things will probably happen. This is consistent with my belief that it is the caller's responsibility to pass valid arguments and library code shouldn't be larger/uglier/slower for everyone just to pretty print errors. This is also consistent with the C standard library where, for the most part, passing invalid parameters results in undefined behavior (see section 4.1.6 in C89, 7.1.4 in C99 and C11).

The back functions simply return the address of size - 1. This is fine even if your size is zero for the use of <= back_i(myvec) since the beginning of the array will already be > back. If I were to return NULL in the case of size 0, you'd just exchange a possible size check before the call for a possible NULL check after the call. I choose this way because it doesn't add an if check to the function so it's smaller/faster, I think the <= use case is more likely, and it's easier and more normal to know when your vector is empty than to remember to check for NULL after the fact.

The insert functions (insert_i and insert_array_i for example) do allow you to insert at the end. The memmove inside the functions will simply move 0 bytes if you pass the current size as the index. C99 and C11 guarrantee this behavior in the standard (and thus C++ does as well). Though I wrote this library to be compliant with C89, which does not guarrantee this behavior, I think it's safe to assume they'd use the same implementation since it doesn't contradict C89 and it just makes sense.

Building

I use premake to generate the make files in the build directory. The command is premake5 gmake. cd into build and run make or make config=release. I have not tried it on windows though it should work (well I'm not sure about CUnit ...).

There is no output of any kind, no errors or warnings.

It has been relatively well tested using Cunit tests which all pass. I've also run it under valgrind and there are no memory leaks.

valgrind --leak-check=full -v ./vector
==35463== 
==35463== HEAP SUMMARY:
==35463==     in use at exit: 0 bytes in 0 blocks
==35463==   total heap usage: 6,285 allocs, 6,285 frees, 996,013 bytes allocated
==35463== 
==35463== All heap blocks were freed -- no leaks are possible
==35463== 
==35463== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)
==35463== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

You can probably get Cunit from your package manager but if you want to get the most up to date version of CUnit go here:

http://cunit.sourceforge.net/index.html http://sourceforge.net/projects/cunit/

I'm using version 2.1-3.

Usage

To actually use the library just copy the appropriate c/h file pair(s) to your project or just use cvector.h. To get a good idea of how to use the library and see it in action and how it should behave, look at vector_tests.c

LICENSE

CVector is licensed under the MIT License.

Copyright (c) 2011-2016 Robert Winkler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.