Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamchatka-volcano/sfun
Stuff from unnamed namespace
https://github.com/kamchatka-volcano/sfun
cpp17 header-only utilities-library
Last synced: about 1 month ago
JSON representation
Stuff from unnamed namespace
- Host: GitHub
- URL: https://github.com/kamchatka-volcano/sfun
- Owner: kamchatka-volcano
- License: ms-pl
- Created: 2021-08-25T20:16:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T09:16:05.000Z (4 months ago)
- Last Synced: 2024-10-30T02:03:28.116Z (about 2 months ago)
- Topics: cpp17, header-only, utilities-library
- Language: C++
- Homepage:
- Size: 65.4 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## sfun
[](https://github.com/kamchatka-volcano/sfun/actions/workflows/build_and_test.yml)
**sfun** - is a header-only collection of utilities for string manipulation, metaprogramming, core guidelines support
and other general-purpose tasks.
### Contents
* `contract.h` - Macros for contract programming, violations lead to `std::terminate()` (the implementation is copied
from [GSL](https://github.com/microsoft/GSL))
* `functional.h` - Metaprogramming and other helpers for functions and callable objects;
* `interface.h` - `sfun::interface`, a private base class that brings the properties for virtual interfaces recommended
by Core Guidelines (non-copyable, non-movable, has virtual destructor); `sfun::access_permission` - a restricted
member access alternative to the `friend` keyword, based on
the [badge pattern](https://awesomekling.github.io/Serenity-C++-patterns-The-Badge/) idea.
* `member.h` - A wrapper that allows storing const and reference types members without affecting the parent class's copy
and move properties (as recommended by Core Guidelines).
* `optional_ref.h` - A non-rebindable optional reference wrapper implementation.
* `path.h` - Helpers to follow [ut8everywhere manifesto](https://utf8everywhere.org) by storing UTF-16
inside `std::filesystem::path` on Windows and UTF-8 on other platforms. All `std::filesystem::path` objects should be
constructed with `sfun::make_path` and converted to a string with `sfun::path_string`.
* `precondition.h` - Precondition wrappers for function arguments, based on the idea of
the [`precond`](https://github.com/denniskb/precond) library.
* `string_utils.h` - Basic string utils based on STL algorithms.
* `type_list.h` - A basic type list for metaprogramming.
* `type_traits.h` - A collection of type traits.
* `utility.h` - Miscellaneous helpers, some are from the standard library newer than C++17.
* `wstringconv.h` - UTF-16 to UTF-8 string conversion for Windows, provided by
the [`utfcpp`](https://github.com/nemtrif/utfcpp) library bundled in the `detail/` directory.
### Installation
Download and link the library from your project's CMakeLists.txt:
```
cmake_minimum_required(VERSION 3.14)
include(FetchContent)
FetchContent_Declare(sfun
GIT_REPOSITORY "https://github.com/kamchatka-volcano/sfun.git"
GIT_TAG "origin/master"
)
#uncomment if you need to install sfun with your target
#set(INSTALL_SFUN ON)
FetchContent_MakeAvailable(sfun)
add_executable(${PROJECT_NAME})
target_link_libraries(${PROJECT_NAME} PRIVATE sfun::sfun)
```
To install the library system-wide, use the following commands:
```
git clone https://github.com/kamchatka-volcano/sfun.git
cd sfun
cmake -S . -B build
cmake --build build
cmake --install build
```
After installation, you can use the `find_package()` command to make the installed library available inside your
project:
```
find_package(sfun 1.0 REQUIRED)
target_link_libraries(${PROJECT_NAME} PRIVATE sfun::sfun)
```
### Running tests
```
cd sfun
cmake -S . -B build -DENABLE_TESTS=ON
cmake --build build
cd build/tests && ctest
```
### License
**sfun** is licensed under the [MS-PL license](/LICENSE.md)