type_safe provides zero overhead abstractions that use the C++ type system to prevent bugs.
Zero overhead abstractions here and in following mean abstractions that have no cost with optimizations enabled, but may lead to slightly lower runtime in debug mode, especially when assertions for this library are enabled.
The library features cannot really be explained in the scope of this readme, I highly suggest that you check out the first and second blog post and the examples.
Sponsored by Embarcadero C++Builder. If you like this project, consider supporting me.
ts::integer<T>
- a zero overhead wrapper over a built-in integer type- no default constructor to force meaningful initialization
- no "lossy" conversions (i.e. from a bigger type or a type with a different signedness)
- no mixed arithmetic with floating points or integer types of a different signedness
- no mixed comparison with floating points
- over/underflow is undefined behavior in release mode - even for
unsigned
integers, enabling compiler optimizations
ts::floating_point<T>
- a zero overhead wrapper over a built-in floating point- no default constructor to force meaningful initialization
- no "lossy" conversion (i.e. from a bigger type)
- no "lossy" comparisons
- no mixed arithmetic/comparison with integers
ts::boolean
- a zero overhead wrapper overbool
- no default constructor to force meaningful initialization
- no conversion from integer values
- no arithmetic operators
- aliases like
ts::uint32_t
orts::size_t
that are either wrapper or built-in type depending on macro - literal operators for those aliases like
342_u32
or0_usize
ts::object_ref<T>
- a non-null pointerts::index_t
andts::distance_t
- index and distance integer types with only a subset of operations availablets::array_ref<T>
- non-null reference to contigous storagets::function_ref<T>
- non-null reference to a functionts::flag
- an improved flag type, better than a regularbool
orts::boolean
ts::flag_set<Enum>
- a set of flagsts::output_parameter<T>
- an improved output parameter compared to the naive lvalue reference
ts::basic_optional<StoragePolicy>
- a generic, improvedstd::optional
that is fully monadic, alsots::optional<T>
andts::optional_ref<T>
implementationsts::compact_optional
implementation for no space overhead optionalsts::basic_variant<VariantPolicy, Types...>
- a generic, improvedstd::variant
, alsots::variant
andts::fallback_variant
implementations
ts::constrained_type<T, Constraint, Verifier>
- a wrapper over some type that verifies that a certain constraint is always fulfilledts::constraints::*
- predefined constraints likenon_null
,non_empty
, ...ts::tagged_type<T, Constraint>
- constrained type without checking, useful for taggingts::bounded_type<T>
- constrained type that ensures a value in a certain intervalts::clamped_type<T>
- constrained type that clamps a value to ensure that it is in the certain interval
ts::strong_typedef
- a generic facility to create strong typedefs more easilyts::deferred_construction<T>
- create an object without initializing it yet
Header-only, just copy the files in your project.
You need to add the type_safe include
directory to your include path as well as make debug_assert.hpp available.
The repository is included.
You also need to enable C++11.
Behavior can be customized with the following macros:
TYPE_SAFE_ENABLE_ASSERTIONS
(default is1
): whether or not assertions are enabled in this libraryTYPE_SAFE_ENABLE_WRAPPER
(default is1
): whether or not the typedefs intype_safe/types.hpp
use the wrapper classesTYPE_SAFE_ARITHMETIC_POLICY
(ub
/checked
/default
, default isub
): whether under/overflow in the better integer types is UB, an exception, or the default behavior
If you're using CMake there is the target type_safe
available after you've called add_subdirectory(path/to/type_safe)
.
Simply link this target to your target and it will setup everything automagically.
For convenience the macros are also mapped to CMake options of the same name.
You can find the full documentation generated by standardese here.
This project is greatly supported by my patrons. In particular thanks to the individual supporters:
- Mark Atkinson
- Reiner Eiteljörge
And big thanks to the main contributors as well:
- Johel Ernesto Guerrero Peña @johelegp