wpsteak / collections-c

A library of generic data structures.

Collections-C

A library of generic data structures including a list, array, hashtable, deque etc..

Examples

Check the documentation page for mode detailed examples. (This is still in progress).
The source of the documentation can be found here.

HashTable:

// Crate a new table
HashTable *table
if (hashtable_new(&table) != CC_OK) {
    // something went wrong
    ...
}

// Add key-value pair
if (hashtable_add(table, "some_key", "some_value") != CC_OK) {
    // something went wrong
    ...
}

// Retrieve a value associated with a key
char *value;
if (hashtable_get(table, "some_key", (void*) &value) == CC_OK)
    printf("%s", value);

// Remove a key
hashtable_remove(table, "foo", NULL);

hashtable_destroy(table);

Array (dynamic array):

// Create a new array
Array *ar;
if (array_new(&ar) != CC_OK) {
    // something went wrong
    ...
}

// Add an element
enum cc_stat status = array_add(ar, "foo");
if (status == CC_OK) {
    ...
} else if (status == CC_ERR_ALLOC) {
    ...
} else {
    ...
}

// Retrieve a value
char *foo;
array_get_at(ar, 0, (void*) &foo);

// Remove a value
char *removed;
array_remove_at(ar, 0, (void*) &removed);

array_destroy(ar);

Installation

####Dependencies

• gcc
• autoconf
• automake
• libtool
• m4

These packages can usually be installed through your distributions package manager.

Building on windows requires MinGW which provides all the tools needed to build the project.

Building the project

In the project directory, run the following commands: ./autogen.sh then run ./configure. If autogen complains that it couldn't find a directory named "m4", run: mkdir m4 and then ./autogen.sh.

• note: Running configure with a prefix like: ./configure --prefix=/some/custom/path will cause make install to install the library to that directory instead of the default one.

At this point we should be able to build the project by running:

make

By default make builds a shared library. To build a static library, run make with "static" flag on: make CFLAGS=-static.

• note: When building for the 64 bit architecture, "ARCH_64" can be explicitly set like so: make CFLAGS=-DARCH_64. This will increase the maximum container capacity to ~2^64. Otherwise the maximum capacity defaults to ~2^32 elements regardless of the target architecture.

Installing the library:

make install

The tests can be run by:

make check

Compiling and linking a simple program

• hello.c

#include <stdio.h>
#include <array.h>

int main(int argc, char **argv) {
    Array *ar;
    array_new(&ar);
    array_add(ar, "Hello World!\n");
    
    char *str;
    array_get(ar, 0, (void*) &str);
    printf("%s", str);
    
    return 0;
}

We can now build and statically link the library to our program:

gcc hello.c -I/path/to/library/include/ -static -L/path/to/library/lib/ -lcollectc -o hello

Contributors

All contributions are welcome.

See CONTRIBUTING.md for details.