https://github.com/aziascreations/c99-utility-libraries
Small collection of utilities and libraries for C99 that aims to simplify some development tasks such as launch arguments parsing and double linked lists.
https://github.com/aziascreations/c99-utility-libraries
argument-parser c99 crc32 hashmap linked-list uuid uuid4
Last synced: 7 months ago
JSON representation
Small collection of utilities and libraries for C99 that aims to simplify some development tasks such as launch arguments parsing and double linked lists.
- Host: GitHub
- URL: https://github.com/aziascreations/c99-utility-libraries
- Owner: aziascreations
- License: cc0-1.0
- Created: 2023-03-30T20:49:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-20T09:52:47.000Z (about 1 year ago)
- Last Synced: 2025-01-23T12:46:16.307Z (9 months ago)
- Topics: argument-parser, c99, crc32, hashmap, linked-list, uuid, uuid4
- Language: C
- Homepage: https://aziascreations.github.io/C99-Utility-Libraries/
- Size: 1.48 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE-CC0
Awesome Lists containing this project
README
# NibblePoker's Clang Goodies
Small collection of utilities and libraries for C99 that aims to simplify some development tasks.
## Features
*  Robust launch arguments parsing & handling with verb support
*  Single & double linked lists with custom node support and QoL functions
*  Basic chained HashMaps
*  Various string utilities
*  Toggleable debugging output functions
*  Completely macro-able `char`↔`wchar_t` support
*  Small extras like UUID4, CRC32B & platform detection
*  Supports [a wide variety of OS, CPU ISA & Compilers](platforms.md)
*  Other features to come as needed or requested
## Planned Features
* More HashMap types & hashing/UUID algorithms & more utilities
## Usage
### Preamble
**Requirements:**
● CMake 3.13+
● [Qt's Jom](https://wiki.qt.io/Jom) *(ReactOS only, replaces nmake)*
**Supported OS:**
Windows, Cygwin, Linux & ReactOS
**Supported Compilers:**
MSVC, CLang, GCC, MinGW & TinyCC
**Supported CPU architectures:**
x86, x64, ARM & ARM64
 Check [platforms.md](platforms.md) for more info on the platform detector.
 Check [definitions.md](definitions.md) for a complete listing of the configuration definitions.
### CMake's FetchContent
Firstly, insert the following lines into your `CMakeLists.txt`:
```cmake
# Including the `FetchContent` directives.
include(FetchContent)
# Configuring the library. (Optional)
set(NP_GOODIES_BUILD_BENCHMARKS OFF CACHE BOOL "" FORCE) # OFF by default.
set(NP_GOODIES_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE) # OFF by default.
set(NP_GOODIES_BUILD_TESTS OFF CACHE BOOL "" FORCE) # OFF by default.
# Downloading the library in the build folder.
FetchContent_Declare(
np_clang_goodies
GIT_REPOSITORY "https://github.com/aziascreations/C99-Utility-Libraries.git"
GIT_TAG "master"
GIT_PROGRESS TRUE
)
FetchContent_MakeAvailable(np_clang_goodies)
# Moving the library into the build folder's root. (Optional)
set_target_properties(lib_np_clang_goodies PROPERTIES ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/")
set_target_properties(lib_np_clang_goodies PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/")
set_target_properties(lib_np_clang_goodies PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/")
```
Finally, configure your targets like so:
```cmake
# Configuring out target
add_executable(MyApp src/main.c) # Use your setup, only the target's name matters.
target_include_directories(MyApp PRIVATE ${PROJECT_INCLUDE}) # May be useless.
target_link_libraries(MyApp PRIVATE lib_np_clang_goodies)
add_dependencies(MyApp lib_np_clang_goodies) # Does nothing in my tests, but it can't hurt.
# Optional per-target config
target_compile_definitions(MyApp PUBLIC NP_DEBUG_LOGGING) # Enables debugging and optional error logging.
```
### CMake's Include
The `Include` directive isn't supported yet.
The included project doesn't detect that it's being included properly like `FetchContent` does.
### CMake's `add_subdirectory` command
The `add_subdirectory` command works by isn't thoroughly tested yet.
Firstly, add this repository as a submodule in your project and checkout to a specific tag or commit:
```bash
git submodule add https://github.com/aziascreations/C99-Utility-Libraries.git libs/nibblepoker-c-goodies
git -C libs/nibblepoker-c-goodies checkout
```
Afterward, add the following lines in your *CMakeLists.txt*:
```cmake
add_subdirectory(libs/np_clang_goodies)
# This one may not be required, needs more testing.
file(GLOB_RECURSE src_nibblepoker_c_goodies CONFIGURE_DEPENDS "libs/nibblepoker-c-goodies/src/*.h" "libs/nibblepoker-c-goodies/src/*.c")
```
Finally, modify you targets to add `${src_nibblepoker_c_goodies}` like so:
```cmake
add_executable(my_app src/main.c ${src_nibblepoker_c_goodies} ...)
```
### CMake Manual Import
In order to use this library in your projects via a manual import you need to do the following things:
Firstly, add this repository as a submodule in your project and checkout to a specific tag or commit:
```bash
git submodule add https://github.com/aziascreations/C99-Utility-Libraries.git libs/nibblepoker-c-goodies
git -C libs/nibblepoker-c-goodies checkout
```
Afterward, add the following lines in your *CMakeLists.txt*:
```cmake
file(
GLOB_RECURSE src_nibblepoker_c_goodies
CONFIGURE_DEPENDS "libs/nibblepoker-c-goodies/src/*.h" "libs/nibblepoker-c-goodies/src/*.c"
)
```
Finally, modify you targets to add `${src_nibblepoker_c_goodies}` like so:
```cmake
add_executable(my_app src/main.c ${src_nibblepoker_c_goodies} ...)
```
## Examples
Some examples that demonstrate how to use most of the functions this library provides can be found
in the [examples/](examples/) folder.
Alternatively, you can also check the [aziascreations/C99-Win32-Wifi-Utility](https://github.com/aziascreations/C99-Win32-Wifi-Utility)
repository for a complete example in a "fully-fledged" Windows application.
### Launch arguments
* [Basic usage with `char` & `wchar_t` support](examples/arguments_basic.c)
* Define `NP_GOODIES_ARGUMENTS_USE_WCHAR` to support `wchar_t` instead of `char`.
### Debugging Utilities
* [Complete usage](examples/debug_logging.c)
* You may need to define `NP_DEBUG_LOGGING` to enable the special prints.
### Double Linked Lists
* [Basic operations](examples/dllist_basic.c)
* Creating a list, adding, accessing & iteration over values and basic freeing call.
* [Custom freeing operation](examples/dllist_custom_free.c)
* Same as above while using structured data that needs to be freed in a specific way.
* [Custom list nodes](examples/dllist_custom_node.c)
* Same as above while using a custom superset of the standard list node in order to better suit some edge cases.
* [Functions specific to double linked lists](examples/dllist_specific.c)
* Testing functions that have a `dllist`-specific implementation.
### Hashing
* [CRC32B hashing](examples/crc32.c)
* Basic example of hashing data with CRC32B.
### HashMaps
* [Basic Chained HashMap](examples/hashmap_chained_basic.c)
* Basic HashMap usage with strings, CRC32B key hashing and full collision detection.
### UUID
* [UUID4 generation](examples/uuid_all.c)
* Rudimentary RNG setup & UUID4 generation.
* [UUID4 generation with Win32API](examples/uuid_win32.c)
* Safe RNG setup with Win32APIs & UUID4 generation.
### Text
**TODO**
## Documentation
### Viewing
You can consult the documentation at the following URL:
https://aziascreations.github.io/C99-Utility-Libraries/
It is automatically updated when a commit is pushed onto the `master` branch.
### Building
If you want to build the documentation, you need to do the following things:
* Install [Doxygen](https://www.doxygen.nl/) on your system.
* Clone the git submodules with `git submodule update --init --recursive`.
* Run the [make-doc.bat](https://github.com/aziascreations/C99-Utility-Libraries/blob/master/make-doc.bat) script.
* Go into `docs/html` and open the `index.html` file.
## Benchmarks
This project provides a couple of benchmarks in order to justify some of the design choices I made.
Please refer to the [Benchmarks](benchmarks/readme.md) page for more information.
## Licenses
This project is dual-licensed under the following open-source licenses.
You can choose the one that best suits your needs:
1. [MIT License](LICENSE-MIT)
● Just include the `LICENSE-MIT` file and be done with it while using an OSI license.
2. [CC0 1.0 Universal (CC0 1.0) (Public Domain)](LICENSE-CC0)
● Do whatever you want with it.
● No credit, mentions or anything else is needed.
● Just have fun programming :)
Keep in mind, the [doxygen-awesome-css](https://github.com/jothepro/doxygen-awesome-css) submodule repository uses an
[MIT license](https://github.com/jothepro/doxygen-awesome-css/blob/main/LICENSE).
You can either not clone it or fork the project and remove it to be 100% safe if you use the `CC0 1.0` license.
The documentation will still build without it, but it will have a "worse-looking" UI.