# UGLy - An Unsafe Generic LibrarY

UGLy is a C library used to apply the DRY principle and avoid re-implementing the same common data structures, procedures and macros everywhere.

You can check out the open-source project on GitLab.
Contributions are welcome, check out our issue board.

## Unsafe?

It uses “unsafe” generics (void *) in the sense that all data types are seen as a sequence of bytes and the user is responsible for making sure they are properly interpreted (and memory aligned). It should be noted that the library’s containers always use copy semantics and will never call free on a stored pointer, meaning the user is still expected to manage the lifetimes of dynamically allocated objects.

In summary: “you allocate it, you free it”.

The suggested use of UGLy would be as internal implementation for libraries which wrap it in a more “type-and-memory safe” API.

## Features

### Generic data structures / containers

Currently implemented generic data structures:

• list_t: dynamically sized sequence of fixed-size elements which are contiguously allocated and indexed in O(1) time. Insertions and remotions have amortized O(1) complexity when done at the end of the list and O(n) otherwise.
• map_t: dynamically sized mapping between fixed-size keys and values. All operations have an amortized average constant complexity when using a proper hashing function.
• stack_t: dynamic LIFO structure for fixed-size elements. All operations have O(1) complexity (amortized in the case of insertions and deletions).

### Custom memory allocator support

Whenever memory allocations are needed, the user can choose to provide his own custom allocator or use one of the generic, built-in ones (most of which allocate on a user-provided buffer):

• STDLIB_ALLOCATOR: simply calls malloc, realloc and free from stdlib.
• pool_allocator_t: fixed max allocation size and no external fragmentation while supporting deallocations in any order.
• stack_allocator_t: variable allocation size, can free and do in-place reallocations but only in Last-In-First-Out fashion.
• bump_allocator_t: variable allocation size, zero memory overhead, never frees.

### Descriptive type definitions

Instead of using primitives for everything, UGLy defines some core types which should elucidate their intended semantics in procedure signatures.

### Useful macros

We also include some macros which tend to be needed every now and then when programming in C, like containerof.

### Unsafe but not untested

We have an automatic CTest suite set up on CI to ensure new changes don’t cause major breaks.

Tags:

Updated: