C++ Prelude#
Modern C++ makes me sad when I look at it. So this is my attempt to change several of the defaults we use to code in C++.
Types#
A mix of the naming scheme in Rust and HolyC is very aesthetically pleasing. Types become terse with only the information you need at a first glance. Furthermore, for consistency, all types should begin with capital letters.
Numeric Types#
| Prelude | Vanilla |
|---|---|
Size |
std::size_t |
U8 |
uint8_t |
U16 |
uint16_t |
U32 |
uint32_t |
U64 |
uint64_t |
I8 |
int8_t |
I16 |
int16_t |
I32 |
int32_t |
I64 |
int64_t |
F32 |
float |
F64 |
double |
These changes beg the question: What is wrong with int?
Well int would be a perfectly valid type if C++ supported Big Integers like
Java does. The problem is int is fixed to a type that is sometimes 32-bits
and other times something else. I think this is very inelegant and needlessly
terse. It is better to simply know what kind of integer and bit-width it takes
up.
The only exception to this rule being Size since we do want to preserve the
ability to scale depending on what system runs the binary.
Other Types#
| Prelude | Vanilla |
|---|---|
Unit |
void |
Void |
N/A |
Bool |
bool |
Char |
char |
Ptr<T> |
T* |
Ref<T> |
T& |
Vector |
std::vector<T> |
String |
std::string |
In most situations, it is clearer to write the type as a Ptr<T> than a T*.
Same goes for Ref<T>.
This also remains consistent with the implementation of smart pointers in the
standard library, for example std::unique_ptr<T>.
std::string_literals are enabled by default.
Keywords#
| Prelude | Vanilla |
|---|---|
let |
auto const |
var |
auto |
fn |
[[nodiscard, gnu::const]] auto |
proc |
[[nodiscard]] auto |
ignored = foo() |
static_cast<void>(foo()) |
fst |
std::get<0> |
snd |
std::get<1> |
thr |
std::get<2> |
You define terms as let x = 0;. If you need the term to be of any specific numeric type
then use suffixes like: let x = 0u; (x is unsigned).
If you need a variable term then use the var keyword instead. The motivation
for this is that you should prefer immutable terms before considering mutable
variables.
All functions should be [[nodiscard]] and be annotated with trailing return
types.
If you need to ignore the return value of a function then use ignore = ... to
explicitly ignore it.
Additionally, the term fn (function) should be used in its most literal
mathematical sense, for a given input it will always produce the same output.
If you want to do something that requires side effects then use the proc
(procedure) keyword instead.
fst, snd and thr naming conventions are taken from Haskell. The motivation
being that std::get<#> is extremely verbose for accessing the
first/second/third/etc members of that tuple.
Short example#
Solution for Rosetta Code "Balanced Brackets", using this prelude.
#include <algorithm>
#include <format>
#include <numeric>
#include <random>
#include "prelude.hpp"
proc generate(I32 n, Char left = '[', Char right = ']') -> String
{
var rd = std::random_device();
var str = std::string(n, left) + std::string(n, right);
std::shuffle(str.begin(), str.end(), std::mt19937(rd()));
return str;
}
fn balanced(std::string_view str, Char left = '[', Char right = ']') -> Bool
{
var count = 0;
for (let& ch : str) {
if (ch == left)
count++;
else if (ch == right)
if (--count < 0)
return false;
}
return count == 0;
}
proc main() -> I32
{
for (var i = 0; i < 9; ++i) {
let s = std::string(generate(i));
ignore = println(
std::format(" {}: {}", balanced(s) ? "ok" : "bad", s));
}
}
TODO:#
- Sensible IO operations
- [o] Add examples
- Define applicative operations for standard containers
- Improve declarative and pipeline-esque operations
- Add algorithms