summaryrefslogtreecommitdiff
path: root/README
blob: 5d5a7a912d2fa4671c3168f476f5c6cdda0f19d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
kit

A collection of cross-platform utility libraries.

Features
- Testing
  - Unit-tests
  - Microbenchmarks
- Algorithms and data types
  - Lower bound
  - Move back
  - Dynamic array
  - Big integer math
  - SHA-256
- System
  - Time
  - Atomics
  - Condition variables
  - Mutual exclusion
  - Threads
  - Filesystem
  - File mapping and shared memory
  - Shared mutex for interprocess synchronization
  - Sockets wrapper
- Misc
  - Input buffer
  - Random number generation
  - Async functions (coroutines)

Preprocessor options
- KIT_DISABLE_SHORT_NAMES                   - Disable short names for functions and types.
- KIT_DISABLE_SYSTEM_MALLOC                 - Disable system memory allocation functions.
- KIT_DISABLE_SYSTEM_THREADS                - Disable system multithreading functions.
- KIT_DISABLE_SYSTEM_SOCKETS                - Disable system socket library.
- KIT_ENABLE_CUSTOM_ALLOC_DISPATCH          - Enable custom allocation dispatch.
- KIT_ENABLE_CUSTOM_ASYNC_FUNCTION_DISPATCH - Enable custom async function dispatch.

C11 threads implementation was forked from the Mesa source code.
* https://gitlab.freedesktop.org/mesa/mesa

Folder "/include" contains single header-only version of this library.
Use "#define KIT_IMPLEMENTATION" to enable implementation code.