assyrianic / Harbol-V1

Harbol is a self-contained all-in-one STL-style data structure collection in C.

Harbol

Introduction

Harbol is a data structure collection, similar to C++ Boost and GLib, that is meant to be a smaller and more lightweight collection of data structures, code systems, and convenience software.

Features

• Object-oriented style Data Structures.
• Tagged union (Variant Type) to support any type of values and their type IDs.
• Convertible Data structures (data can be converted between applicable types).
• C++ style String.
• Vector / Dynamic Array.
• Hashmap.
• Singly Linked List.
• Doubly Linked List.
• Byte Buffer.
• Tuple type. (convertible to structs, can also be packed).
• Memory Pool - returns any size and can defrag itself.
• "general purpose" Graph. (edges support weight data)
• General Tree - each node supports an 'n' number of children nodes.
• Linked Hashmap (preserves insertion order).
• JSON-like Key-Value Configuration File Parser (allows retrieving data from keys through python-style pathing).
• General plugin system manager that is designed to be wrapped around to provide an easy-to-setup plugin API and plugin SDK.

Usage

#include "harbol.h"

int main(const int argc, char *argv[])
{
	HarbolString str; harbol_string_init_cstr(&str, "my initial string!");
	harbol_string_add_cstr(&str, "and another string concatenated!");
	harbol_string_del(&str);
	
	HarbolVector vec; harbol_vector_init(&vec);
	harbol_vector_insert(&vec, (HarbolValue){.Float=2.f});
	harbol_vector_insert(&vec, (HarbolValue){.Float=3.f});
	harbol_vector_insert(&vec, (HarbolValue){.Float=4.f});
	const float f = harbol_vector_get(&vec, 1).Float;
	harbol_vector_del(&vec, NULL);
	
	HarbolHashmap *ptrmap = harbol_hashmap_new();
	harbol_hashmap_insert(ptrmap, "style", (HarbolValue){.Float=2.3553f});
	harbol_hashmap_insert(ptrmap, "border", (HarbolValue){.Double=12.995});
	harbol_hashmap_free(&ptrmap, NULL);
}

Contributing

To submit a patch, first file an issue and/or present a pull request.

Help

If you need help or have any question, make an issue on the github repository. Simply drop a message or your question and you'll be reached in no time!

Installation

Requirements

C99 compliant compiler and libc implementation with stdlib.h, stdio.h, and stddef.h.

Installation

To build the library, simply run make harbol which will make the static library version of libharbol. for a shared library version, run make harbol_shared.

Testing

For testing code changes or additions, simply run make test with test_suite.c in the repository which will build an executable called harbol_testprogram.

Credits

• Khanno Hanna - main developer of libharbol.

Contact

I can be contacted at [e-mail]

License

This project is licensed under Apache License.