Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vittorioromeo/unosolo
Work-in-progress Rust application that converts C++ header-only libraries to single self-contained headers.
https://github.com/vittorioromeo/unosolo
command cpp line rust tool
Last synced: 11 days ago
JSON representation
Work-in-progress Rust application that converts C++ header-only libraries to single self-contained headers.
- Host: GitHub
- URL: https://github.com/vittorioromeo/unosolo
- Owner: vittorioromeo
- License: mit
- Created: 2017-06-25T13:29:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-06T16:20:37.000Z (over 5 years ago)
- Last Synced: 2024-07-28T23:08:17.199Z (3 months ago)
- Topics: command, cpp, line, rust, tool
- Language: Rust
- Homepage: https://vittorioromeo.info
- Size: 29.3 KB
- Stars: 26
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeCppGameDev - unosolo - in-progress Rust application that converts C++ header-only libraries to single self-contained headers. (Rust)
README
# unosolo
> **Work-in-progress Rust application that converts C++ header-only libraries to single self-contained headers.**
[![stability][badge.stability]][stability]
[![license][badge.license]][license]
[![gratipay][badge.gratipay]][gratipay]
[badge.stability]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[badge.license]: http://img.shields.io/badge/license-mit-blue.svg?style=flat-square
[badge.gratipay]: https://img.shields.io/gratipay/user/SuperV1234.svg?style=flat-square
[stability]: http://github.com/badges/stability-badges
[license]: https://github.com/SuperV1234/unosolo/blob/master/LICENSE
[gratipay]: https://gratipay.com/~SuperV1234/
## Disclaimer
This is my first Rust project, mainly created to start getting used to the language. My intention is to improve `unosolo` as I get better with Rust and the final goal is being able to successfully use it on popular libraries. *(If you need a full-fledged customizable preprocessor implementation, check out [pcpp](https://pypi.python.org/pypi/pcpp).)*
I also do not encourage people to create single-header libraries and use those in their projects: they're mainly useful when dealing with very complicated build systems or when experimenting on an online compiler that doesn't allow users to easily import multiple files.
*Contributions and code reviews are welcome!*
## Build instructions
```bash
git clone https://github.com/SuperV1234/unosolo
cd unosolo
cargo build
```
* `cargo run -- args...` can be used to build&run `unosolo`.
* `cargo install` can be used to install `unosolo` on the user's system.
## Overview
Given a set of paths containing the C++ header-only library's header files and a "top-level include" file where the graph traversal will start from, `unosolo` outputs a self-contained single-header version of the library to `stdout`. Here's the [`clap-rs`](https://github.com/kbknapp/clap-rs) auto-generated help:
```
unosolo 0.1.1
Vittorio Romeo
transforms a C++ header-only library in a self-contained single header.
USAGE:
unosolo [FLAGS] [OPTIONS] --topinclude
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose Enable verbose mode
OPTIONS:
-p, --paths ... Include paths [default: .]
-t, --topinclude Top-level include file path (entrypoint)
```
## Use cases
### `scelta`
`unosolo` is currently able to transform [**`scelta`**](https://github.com/SuperV1234/scelta), my latest C++17 header-only library, to a single-header version. In fact, I've used `unosolo` to add two badges to `scelta`'s README that allow users to try the library either [on wandbox](https://wandbox.org/permlink/wSA55OCJz17k7Jtz) or [on godbolt](https://godbolt.org/g/4sQtkM). This idea was taken from Michael Park's excellent variant implementation: [`mpark::variant`](https://github.com/mpark/variant).
The command used to transform `scelta` was:
```bash
unosolo -p"./scelta/include" -v -t"./scelta/include/scelta.hpp" > scelta_single_header.hpp
```
It produced [this abomination](https://gist.github.com/SuperV1234/a5af0a8b92f75d83085a8e5fccf71d6a).
### `vrm_core` and `vrm_pp`
Since 0.1.1, `unosolo` supports multiple library include paths and "absolute `#include` directives". My [**`vrm_core`**](https://github.com/SuperV1234/vrm_core) library, which depends on [**`vrm_pp`**](https://github.com/SuperV1234/vrm_pp), can be transformed to a single header as follows:
```bash
git clone https://github.com/SuperV1234/vrm_pp.git
git clone https://github.com/SuperV1234/vrm_core.git
unosolo -p"./vrm_pp/include" "./vrm_core/include" -t"./vrm_core/include/vrm/core.hpp" > vrm_core_sh.hpp
```
It produced [this beauty](https://gist.github.com/SuperV1234/4f9ae8f99da72288c73ca643b101ed20).
### `boost::hana`
A single-header version of [**`boost::hana`**](https://github.com/boostorg/hana) can be created using `unosolo` as follows:
```bash
git clone https://github.com/boostorg/hana
unosolo -p"./hana/include" -t"./hana/include/boost/hana.hpp" > hana_sh.hpp
```
I haven't tested it very thorougly, but I compiled [the example on `hana`'s README](https://github.com/boostorg/hana#overview) without any hiccups.