Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramirisu/gul
header-only general utilities library for C++11
https://github.com/ramirisu/gul
cpp cpp11 header-only
Last synced: about 1 month ago
JSON representation
header-only general utilities library for C++11
- Host: GitHub
- URL: https://github.com/ramirisu/gul
- Owner: Ramirisu
- License: bsl-1.0
- Created: 2022-10-26T18:52:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-31T08:32:25.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T01:15:54.068Z (almost 2 years ago)
- Topics: cpp, cpp11, header-only
- Language: C++
- Homepage:
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE_1_0.txt
Awesome Lists containing this project
README
# GUL
[](https://github.com/Ramirisu/gul/actions/workflows/build_matrix.yml)
[](https://codecov.io/gh/Ramirisu/gul)
[](https://github.com/Ramirisu/gul/actions/workflows/codeql.yml)
gul is an open-source library providing general utilities for c++11. Many of them are backported from later standard version.
## Features
* Header-only, no external dependencies.
* Support exceptions disabled with `-fno-exceptions`.
| Utility Class | Description | From std? |
| :----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ |
| `byte` | A type represents the byte concept. | [c++17](https://en.cppreference.com/w/cpp/types/byte) |
| `optional` | A type either holds a value of type `T`, or is in *valueless* state.
Extensions:
- `optional`
- `optional`
- `optional::to_expected_or`
| `expected` | A type either holds a value of type `T`, or an *unexpected* value of type `E`.
Extensions:
- `expected`
- `expected::value_to_optional`
- `expected::error_to_optional`
| `integer_sequence` | A compile-time sequence of integers. | [c++14](https://en.cppreference.com/w/cpp/utility/integer_sequence) |
| Utility Function | Description | From std? |
| :----------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------- | :--------------------------------------------------------------: |
| `exchange` | Replaces the argument with a new value and returns its previous value. | [c++14, 23](https://en.cppreference.com/w/cpp/utility/exchange) |
| `as_const` | Obtains a reference to const to its argument. | [c++17](https://en.cppreference.com/w/cpp/utility/as_const) |
| `cmp_equal`
`cmp_not_equal`
`cmp_less`
`cmp_greater`
`cmp_less_equal`
`cmp_greater_equal` | Compares two integer values without value change caused by conversion. | [c++20](https://en.cppreference.com/w/cpp/utility/intcmp) |
| `to_underlying` | Converts an enumeration to its underlying type. | [c++23](https://en.cppreference.com/w/cpp/utility/to_underlying) |
| Functional | From std? |
| :----------------------: | :------------------------------------------------------------------: |
| `invoke`
`invoke_r` | [c++17](https://en.cppreference.com/w/cpp/utility/functional/invoke) |
| Memory | From std? |
| :----------------------------: | :-----------------------------------------------------------: |
| `out_ptr`
`out_ptr_t` | [c++23](https://en.cppreference.com/w/cpp/memory/out_ptr_t) |
| `inout_ptr`
`inout_ptr_t` | [c++23](https://en.cppreference.com/w/cpp/memory/inout_ptr_t) |
| Container | Description | From std? |
| :---------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------: |
| `string_view`
`wstring_view`
`u16string_view`
`u32string_view` | A non-owning type can refer to a constant contiguous sequence of `char`-like objects with the first element of the sequence at position zero.
Extensions:
- `basic_string_view::first`
- `basic_string_view::last`
| `span` | A type can refer to a contiguous sequence of objects with the first element of the sequence at position zero. | [c++20](https://en.cppreference.com/w/cpp/container/span) |
| `fifo_map` | An associative container that contains key-value pairs with unique keys. `Key`s are sorted by insertion order. | none |
| `lru_map` | An associative container that contains key-value pairs with at most `capacity` unique keys. The least recently used `Key` will be purged when the map is full during insertion. | none |
| Type Traits | From std? |
| :--------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------: |
| `is_null_pointer` | [c++14](https://en.cppreference.com/w/cpp/types/is_null_pointer) |
| `is_nothrow_convertible` | [c++20](https://en.cppreference.com/w/cpp/types/is_convertible) |
| `is_swappable_with`
`is_swappable`
`is_nothrow_swappable_with`
`is_nothrow_swappable` | [c++17](https://en.cppreference.com/w/cpp/types/is_swappable) |
| `is_bounded_array` | [c++20](https://en.cppreference.com/w/cpp/types/is_bounded_array) |
| `is_unbounded_array` | [c++20](https://en.cppreference.com/w/cpp/types/is_unbounded_array) |
| `is_scoped_enum` | [c++23](https://en.cppreference.com/w/cpp/types/is_scoped_enum) |
| `is_invocable`
`is_invocable_r` | [c++17](https://en.cppreference.com/w/cpp/types/is_invocable) |
| `is_specialization_of` | none |
| `conjunction`
`conjunction_t` | [c++17](https://en.cppreference.com/w/cpp/types/conjunction) |
| `disjunction`
`disjunction_t` | [c++17](https://en.cppreference.com/w/cpp/types/disjunction) |
| `negation`
`negation_t` | [c++17](https://en.cppreference.com/w/cpp/types/negation) |
| `invoke_result`
`invoke_result_t` | [c++17](https://en.cppreference.com/w/cpp/types/result_of) |
| `void_t` | [c++17](https://en.cppreference.com/w/cpp/types/void_t) |
| `remove_cvref`
`remove_cvref_t` | [c++20](https://en.cppreference.com/w/cpp/types/remove_cvref) |
| `type_identity`
`type_identity_t` | [c++20](https://en.cppreference.com/w/cpp/types/type_identity) |
| `function_traits` | none |
## Integration
Requirements
* CMake 3.15 (or later)
* GCC 4.8 (or later)
* Clang 3.5 (or later)
* MSVC 2015 v140 (or later)
* Apple Clang 12 (or later)
CMake
```cmake
add_executable(name)
target_link_libraries(name PRIVATE gul)
```
gul is header-only. Just `#include` the header file `all.hpp` to utilize all features.
```cpp
#include
```
## Building tests
CMake
| Option | Description | Value | Default |
| :----------------- | :------------------------- | :----: | :-----: |
| GUL_BUILD_TESTS | Build tests | ON/OFF | OFF |
| GUL_ENABLE_CODECOV | Enable code coverage build | ON/OFF | OFF |
```sh
cd gul/
cmake -B build -DGUL_BUILD_TESTS=ON
cmake --build build
cd build && ctest && cd ..
```
## License
This project is distributed under the [Boost Software License 1.0](https://www.boost.org/LICENSE_1_0.txt).