drobilla / zix

A lightweight C library of portability wrappers and data structures

Zix

Zix is a lightweight C library of portability wrappers and data structures.

Components

• Allocation

  • ZixAllocator: A customizable allocator.
    • ZixBumpAllocator: A simple realtime-safe "bump-pointer" allocator.

• Algorithms

  • zix/digest.h: Digest functions suitable for hashing arbitrary data.

• Data Structures

  • ZixBTree: A page-allocated B-tree.
  • ZixHash: An open-addressing hash table.
  • ZixRing: A lock-free realtime-safe ring buffer.
  • ZixTree: A binary search tree.

• Threading

  • ZixSem: A portable semaphore wrapper.
  • ZixThread: A portable thread wrapper.

• File System

  • zix/filesystem.h: Functions for working with filesystems.
  • zix/path.h: Functions for working with filesystem paths lexically.

Platforms

Zix is continually tested on:

• Debian GNU/Linux 11 (x86, x64, arm32, and arm64)
• Fedora 36 (x64)
• FreeBSD 13.2 (x64)
• MacOS 11.7 (x64)
• Node 12 (as wasm via emscripten)
• Windows 10 (x86)

Dependencies

None, except the C standard library, and some POSIX and platform-specific APIs where necessary.

Documentation

• Installation Instructions
• API reference (single page)
• API reference (paginated)
• Test Coverage

-- David Robillard [email protected]

zix's Issues

Invalid #include when linking and compiling.

Getting a number of these errors when trying to link and build with the library installed:

 `/usr/include/zix-0/zix/ring.h:7:10: fatal error: zix/allocator.h: No such file or directory
   7 | #include "zix/allocator.h" `

I was able to get it to work by removing the leading "zix/" for the various files:

  `#include "zix/allocator.h"  >> #include "allocator.h"`

It seems the #include files are in the same directory and the "zix/" is confusing things.

Occurs on Manjaro, Ubuntu Studio, OpenSuse Tumbleweed and Fedora 36.

Built and installed from this repository as well as used the arch/aur package with same result.

Thanks.

semaphore API is skipped when tests are disabled

I get the following when using as a subproject with tests disabled:

zix| Dependency threads skipped: feature tests disabled

This seems to be the cause

thread_dep = dependency('threads', required: get_option('tests'))

Document additional dependency requirements

• glib

https://github.com/NixOS/nixpkgs/blob/750f196b393267d4d2bc6ce625767754287d72b2/pkgs/development/libraries/zix/default.nix