Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notixbit/ntbpp
NTB++ is a cross-platform header-only utility library for C++ >= 17
https://github.com/notixbit/ntbpp
c-plus-plus c-plus-plus-17 colors cplusplus cpp cpp17 cross-platform ctest header-only linux macos osx templates types unit-testing unix util utility vcpkg windows
Last synced: 2 days ago
JSON representation
NTB++ is a cross-platform header-only utility library for C++ >= 17
- Host: GitHub
- URL: https://github.com/notixbit/ntbpp
- Owner: notixbit
- License: mit
- Created: 2020-04-05T20:40:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T14:44:33.000Z (over 1 year ago)
- Last Synced: 2023-06-01T15:34:34.372Z (over 1 year ago)
- Topics: c-plus-plus, c-plus-plus-17, colors, cplusplus, cpp, cpp17, cross-platform, ctest, header-only, linux, macos, osx, templates, types, unit-testing, unix, util, utility, vcpkg, windows
- Language: C++
- Homepage: https://notixbit.github.io/ntbpp/namespaces.html
- Size: 561 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Notixbit C++ Utility Library (NTB++)
[](https://raw.githubusercontent.com/notixbit/ntbpp/master/LICENSE)
[](https://github.com/notixbit/ntbpp/actions/workflows/cmake-linux.yml)
[](https://github.com/notixbit/ntbpp/actions/workflows/cmake-win.yml)
[](https://github.com/notixbit/ntbpp/actions/workflows/cmake-macos.yml)
[](https://github.com/notixbit/ntbpp/actions/workflows/codeql-analysis.yml)
[](https://github.com/notixbit/ntbpp/actions/workflows/docs.yml)
NTB++ is a cross-platform header-only utility library for C++ >= 17.
It includes Colors, Templates & Types.
Useful for printing colors, ``std::map`` and ``std::vector`` into ``std::cout``.
A couple of common typealiases (typedefs) like ``String``, ``UInt``, ``StringMap``, ``StringMapOf`` are included as well.
Motivation:
We developed this lib as part of a program for a customer,
and we figured it might benefit other developers too.
## Table of contents
- [Namespaces](#namespaces)
- [Ntb](#ntb)
- [Ntb::Types](#ntbtypes)
- [Ntb::Templates](#ntbtemplates)
- [Ntb::Colors](#ntbcolors)
- [Build](#build)
- [Install](#install)
- [Testing](#testing)
- [Usage (Ntb::Colors)](#usage-ntbcolors)
- [Documentation](https://notixbit.github.io/ntbpp/namespaces.html)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
---
## Namespaces
### ``Ntb``
```cpp
using namespace Ntb;
```
Exposes the following namespaces:
```cpp
namespace Ntb::Types
namespace Ntb::Templates
namespace Ntb::Colors
```
---
### ``Ntb::Types``
```cpp
using namespace Ntb::Types;
```
Exposes the following types:
```cpp
using Bool
using Char
using UChar
using Short
using UShort
using Int
using UInt
using Long
using LongLong
using ULong
using ULongLong
using String
using MapOf
using StringMapOf
using StringMap
using Vector
```
---
### ``Ntb::Templates``
```cpp
using namespace Ntb::Templates;
```
Exposes the following templates:
```cpp
/**
* Overloads the '<<' cout operator to recognize vectors.
*
* @param The vector of type .
* @return ostream.
*/
std::ostream &operator<<(std::ostream &os, const Vector &v)
/**
* Overloads the '<<' cout operator to recognize maps.
*
* Prints a newline for all elements but the last.
*
* @param The map of type .
* @return ostream.
*/
std::ostream &operator<<(std::ostream &os, const MapOf &v)
```
> ``Ntb::Templates`` makes use of ``Ntb::Types`` and exposes it.
---
### ``Ntb::Colors``
```cpp
using namespace Ntb::Colors;
```
Exposes the following utilities for coloring ``std::cout`` output:
```cpp
enum Colors : const UInt
/** Color helpers (optional) */
const UInt Colors::RESET
const UInt Colors::BLACK
const UInt Colors::RED
const UInt Colors::GREEN
const UInt Colors::YELLOW
const UInt Colors::BLUE
const UInt Colors::MAGENTA
const UInt Colors::CYAN
const UInt Colors::WHITE
/**
* Color marker for foreground/background.
*
* @param color The color code.
* @return String with color marker.
*/
const String col(const UInt color = Colors::RESET)
/**
* Color marker for foreground, background and text.
*
* @param str The input text.
* @param front The foreground color code.
* @param back The background color code.
* @return Encapsulated string with color markers.
*/
const String col(const String str, const UInt front, const UInt back = Colors::RESET)
```
> ``Ntb::Colors`` makes use of ``Ntb::Types`` and exposes it.
---
## Build
Min Std: **C++17**
(structured bindings, inline, nested namespaces)
Tested against OS:
- Linux 4.14.154 Ubuntu 18.04.4 LTS x86_64 (Bionic Beaver)
- Windows 7 Home Premium SP1 64 bit
- Windows 10 Home/Pro
Tested against Compiler:
- Clang 9.0.0+
- MSVC 14.28.29910
- MSVC 19.28.29914
#### CMake
You can use ``cmake`` to install the include files.
```
cd ntbpp
mkdir build && cd build
cmake ..
make install
```
Include files will be placed into: ``${CMAKE_INSTALL_PREFIX}/include/notixbit/ntbpp``
---
## Install
You can use vcpkg, git clone or git submodule to install this library.
### vcpkg
Create/Edit the following files in your project:
**vcpkg.json**
```json
{
"name": "your-project",
"version": "0",
"dependencies": [
"ntbpp"
]
}
```
**vcpkg-configuration.json**
```json
{
"default-registry": {
"kind": "git",
"repository": "https://github.com/Microsoft/vcpkg",
"baseline": "e79c0d2b5d72eb3063cf32a1f7de1a9cf19930f3"
},
"registries": [
{
"kind": "git",
"repository": "https://github.com/notixbit/vcpkg-registry",
"baseline": "c4f78a946944d1a51e89bde41cd61b0460eb6a60",
"packages": [ "ntbpp" ]
}
]
}
```
Run: ``vcpkg install --feature-flags=registries,manifests``
### Git Clone
```
git clone
```
### Git Submodule
```
git submodule add
```
---
## Testing
Unit Testing Framework: CTest
```
make all test
```
---
## Usage (``Ntb::Colors``)
```cpp
#include
using namespace Ntb::Colors;
std::cout
<< col("Notixbit Creative", Colors::WHITE, Colors::RED)
<< std::endl << std::endl
<< col("====POLICE==LINE==DO==NOT==CROSS====", Colors::BLACK, Colors::YELLOW)
<< std::endl << std::endl;
```
Result:
---
## Contributing
You're very welcome and free to contribute. Thank you.
---
## License
[MIT](LICENSE)