optional lite - A single-file header-only version of a C++17-like optional, a nullable object for C++98, C++11 and later
Contents
- Example usage
- In a nutshell
- License
- Dependencies
- Installation
- Synopsis
- Comparison of std::optional, optional lite and Boost.Optional
- Reported to work with
- Building the tests
- Implementation notes
- Other implementations of optional
- Notes and references
- Appendix
#include "optional.hpp"
#include <cstdlib>
#include <iostream>
using nonstd::optional;
using nonstd::nullopt;
optional<int> to_int( char const * const text )
{
char * pos = NULL;
const int value = strtol( text, &pos, 0 );
return pos == text ? nullopt : optional<int>( value );
}
int main( int argc, char * argv[] )
{
char * text = argc > 1 ? argv[1] : "42";
optional<int> oi = to_int( text );
if ( oi ) std::cout << "'" << text << "' is " << *oi;
else std::cout << "'" << text << "' isn't a number";
}prompt>g++ -Wall -Wextra -std=c++03 -I.. -o to_int.exe to_int.cpp && to_int x1
'x1' isn't a number
optional lite is a single-file header-only library to represent optional (nullable) objects and pass them by value. The library aims to provide a C++17-like optional for use with C++98 and later. If available, std::optional is used. There's also a simpler version, optional bare. Unlike optional lite, optional bare is limited to default-constructible and copyable types.
Features and properties of optional lite are ease of installation (single header), freedom of dependencies other than the standard library and control over object alignment (if needed). optional lite shares the approach to in-place tags with any-lite and with variant-lite and these libraries can be used together.
Not provided are reference-type optionals. optional lite doesn't handle overloaded address of operators.
For more examples, see this answer on StackOverflow [8] and the quick start guide [9] of Boost.Optional (note that its interface differs from optional lite).
optional lite uses the MIT license.
optional lite has no other dependencies than the C++ standard library.
optional lite is a single-file header-only library. Put optional.hpp in the include folder directly into the project source tree or somewhere reachable from your project.
Or, if you use the conan package manager, follow these steps:
-
Add nonstd-lite to the conan remotes:
conan remote add nonstd-lite https://api.bintray.com/conan/agauniyal/nonstd-lite -
Add a reference to optional-lite to the requires section of your project's
conanfile.txtfile:[requires] optional-lite/2.3.0@nonstd-lite/stable -
Run conan's install command:
conan install
Contents
Types in namespace nonstd
Interface of optional lite
Algorithms for optional lite
Macros to control alignment
| Purpose | Type | Object |
|---|---|---|
| To be, or not | template< typename T > class optional; |
|
| Disengaging | struct nullopt_t; | nullopt_t nullopt; |
| Error reporting | class bad_optional_access; | |
| In-place construction | struct in_place_tag | |
| in_place | select type or index for in-place construction | |
| in_place_type | select type for in-place construction | |
| (variant) | in_place_index | select index for in-place construction |
| nonstd_lite_in_place_type_t( T) | macro for alias template in_place_type_t<T> | |
| (variant) | nonstd_lite_in_place_index_t( T ) | macro for alias template in_place_index_t<T> |
| Kind | Std | Method | Result |
|---|---|---|---|
| Construction | optional() noexcept | default construct a nulled object | |
| optional( nullopt_t ) noexcept | explicitly construct a nulled object | ||
| optional( optional const & rhs ) | move-construct from an other optional | ||
| C++11 | optional( optional && rhs ) noexcept(...) | move-construct from an other optional | |
| optional( value_type const & value ) | copy-construct from a value | ||
| C++11 | optional( value_type && value ) | move-construct from a value | |
| C++11 | explicit optional( in_place_type_t<T>, Args&&... args ) | in-place-construct type T | |
| C++11 | explicit optional( in_place_type_t<T>, std::initializer_list<U> il, Args&&... args ) | in-place-construct type T | |
| Destruction | ~optional() | destruct current content, if any | |
| Assignment | optional & operator=( nullopt_t ) | null the object; destruct current content, if any |
|
| optional & operator=( optional const & rhs ) | copy-assign from other optional; destruct current content, if any |
||
| C++11 | optional & operator=( optional && rhs ) | move-assign from other optional; destruct current content, if any |
|
| C++11 | template< class U, ...> optional & operator=( U && v ) |
move-assign from a value; destruct current content, if any |
|
| C++11 | template< class... Args > void emplace( Args&&... args ) |
emplace type T | |
| C++11 | template< class U, class... Args > void emplace( std::initializer_list<U> il, Args&&... args ) |
emplace type T | |
| Swap | void swap( optional & rhs ) noexcept(...) | swap with rhs | |
| Content | value_type const * operator ->() const | pointer to current content (const); must contain value |
|
| value_type * operator ->() | pointer to current content (non-const); must contain value |
||
| value_type const & operator *() & | the current content (const ref); must contain value |
||
| value_type & operator *() & | the current content (non-const ref); must contain value |
||
| C++11 | value_type const & operator *() && | the current content (const ref); must contain value |
|
| C++11 | value_type & operator *() && | the current content (non-const ref); must contain value |
|
| State | operator bool() const | true if content is present | |
| bool has_value() const | true if content is present | ||
| value_type const & value() & | the current content (const ref); throws bad_optional_access if nulled |
||
| value_type & value() & | the current content (non-const ref); throws bad_optional_access if nulled |
||
| C++11 | value_type const & value() && | the current content (const ref); throws bad_optional_access if nulled |
|
| C++11 | value_type & value() && | the current content (non-const ref); throws bad_optional_access if nulled |
|
| <C++11 | value_type value_or( value_type const & default_value ) const | the value, or default_value if nulled value_type must be copy-constructible |
|
| C++11 | value_type value_or( value_type && default_value ) & | the value, or default_value if nulled value_type must be copy-constructible |
|
| C++11 | value_type value_or( value_type && default_value ) && | the value, or default_value if nulled value_type must be copy-constructible |
|
| Modifiers | void reset() noexcept | make empty |
| Kind | Std | Function |
|---|---|---|
| Relational operators | ||
| == | template< typename T > bool operator==( optional const & x, optional const & y ) |
|
| != | template< typename T > bool operator!=( optional const & x, optional const & y ) |
|
| < | template< typename T > bool operator<( optional const & x, optional const & y ) |
|
| > | template< typename T > bool operator>( optional const & x, optional const & y ) |
|
| <= | template< typename T > bool operator<=( optional const & x, optional const & y ) |
|
| >= | template< typename T > bool operator>=( optional const & x, optional const & y ) |
|
| Comparison with nullopt | ||
| == | template< typename T > bool operator==( optional const & x, nullopt_t ) noexcept |
|
| template< typename T > bool operator==( nullopt_t, optional const & x ) noexcept |
||
| != | template< typename T > bool operator!=( optional const & x, nullopt_t ) noexcept |
|
| template< typename T > bool operator!=( nullopt_t, optional const & x ) noexcept |
||
| < | template< typename T > bool operator<( optional const &, nullopt_t ) noexcept |
|
| template< typename T > bool operator<( nullopt_t, optional const & x ) noexcept |
||
| <= | template< typename T > bool operator<=( optional const & x, nullopt_t ) noexcept |
|
| template< typename T > bool operator<=( nullopt_t, optional const & ) noexcept |
||
| > | template< typename T > bool operator>( optional const & x, nullopt_t ) noexcept |
|
| template< typename T > bool operator>( nullopt_t, optional const & ) noexcept |
||
| >= | template< typename T > bool operator>=( optional const &, nullopt_t ) noexcept |
|
| template< typename T > bool operator>=( nullopt_t, optional const & x ) noexcept |
||
| Comparison with T | ||
| == | template< typename T > bool operator==( optional const & x, const T& v ) |
|
| template< typename T > bool operator==( T const & v, optional const & x ) |
||
| != | template< typename T > bool operator!=( optional const & x, const T& v ) |
|
| template< typename T > bool operator!=( T const & v, optional const & x ) |
||
| < | template< typename T > bool operator<( optional const & x, const T& v ) |
|
| template< typename T > bool operator<( T const & v, optional const & x ) |
||
| <= | template< typename T > bool operator<=( optional const & x, const T& v ) |
|
| template< typename T > bool operator<=( T const & v, optional const & x ) |
||
| > | template< typename T > bool operator>( optional const & x, const T& v ) |
|
| template< typename T > bool operator>( T const & v, optional const & x ) |
||
| >= | template< typename T > bool operator>=( optional const & x, const T& v ) |
|
| template< typename T > bool operator>=( T const & v, optional const & x ) |
||
| Specialized algorithms | ||
| swap | template< typename T > void swap( optional & x, optional & y ) noexcept(...) |
|
| create | <C++11 | template< typename T > optional<T> make_optional( T const & v ) |
| C++11 | template< class T > optional< typename std::decay<T>::type > make_optional( T && v ) |
|
| C++11 | template< class T, class...Args > optional<T> make_optional( Args&&... args ) |
|
| C++11 | template< class T, class U, class... Args > optional<T> make_optional( std::initializer_list<U> il, Args&&... args ) |
|
| hash | C++11 | template< class T > class hash< nonstd::optional<T> > |
If optional lite is compiled as C++11 or later, C++11 alignment facilities are used for storage of the underlying object. When compiled as pre-C++11, optional lite tries to determine proper alignment itself. If this doesn't work out, you can control alignment via the following macros. See also section Implementation notes.
-Doptional_CONFIG_MAX_ALIGN_HACK=0
Define this to 1 to use the max align hack for alignment. Default is 0.
-Doptional_CONFIG_ALIGN_AS=pod-type
Define this to the pod-type you want to align to (no default).
-Doptional_CONFIG_ALIGN_AS_FALLBACK=pod-type
Define this to the pod-type to use for alignment if the algorithm of optional lite cannot find a suitable POD type to use for alignment. Default is double.
optional lite is inspired on std::optional, which in turn is inspired on Boost.Optional. Here are the significant differences.
| Aspect | std::optional | optional lite | Boost.Optional |
|---|---|---|---|
| Move semantics | yes | C++11 | no |
| noexcept | yes | C++11 | no |
| Hash support | yes | C++11 | no |
| Throwing value accessor | yes | yes | no |
| Literal type | partially | C++11/14 | no |
| In-place construction | emplace, tag in_place | emplace, tag in_place | utility in_place_factory |
| Disengaged state tag | nullopt | nullopt | none |
| optional references | no | no | yes |
| Conversion from optional<U> to optional<T> |
no | no | yes |
| Duplicated interface functions 1) | no | no | yes |
| Explicit convert to ptr (get_ptr) | no | no | yes |
- is_initialized(), reset(), get().
The table below mentions the compiler versions optional lite is reported to work with.
| OS | Compiler | Versions |
|---|---|---|
| Windows | Clang/LLVM | ? |
| GCC | 5.2.0 | |
| Visual C++ (Visual Studio) |
8 (2005), 10 (2010), 11 (2012), 12 (2013), 14 (2015) |
|
| GNU/Linux | Clang/LLVM | 3.5.0 |
| GCC | 4.8.4 | |
| OS X | ? | ? |
To build the tests you need:
- CMake, version 2.8.12 or later to be installed and in your PATH.
- A suitable compiler.
The lest test framework is included in the test folder.
The following steps assume that the optional lite source code has been cloned into a directory named c:\optional-lite.
-
Create a directory for the build outputs for a particular architecture. Here we use c:\optional-lite\build-win-x86-vc10.
cd c:\optional-lite md build-win-x86-vc10 cd build-win-x86-vc10 -
Configure CMake to use the compiler of your choice (run
cmake --helpfor a list).cmake -G "Visual Studio 10 2010" .. -
Build the test suite in the Debug configuration (alternatively use Release).
cmake --build . --config Debug -
Run the test suite.
ctest -V -C Debug
All tests should pass, indicating your platform is supported and you are ready to use optional lite.
optional lite reserves POD-type storage for an object of the underlying type inside a union to prevent unwanted construction and uses placement new to construct the object when required. Using non-placement new (malloc) to obtain storage, ensures that the memory is properly aligned for the object's type, whereas that's not the case with placement new.
If you access data that's not properly aligned, it 1) may take longer than when it is properly aligned (on x86 processors), or 2) it may terminate the program immediately (many other processors).
Although the C++ standard does not guarantee that all user-defined types have the alignment of some POD type, in practice it's likely they do [8, part 2].
If optional lite is compiled as C++11 or later, C++11 alignment facilities are used for storage of the underlying object. When compiling as pre-C++11, optional lite tries to determine proper alignment using meta programming. If this doesn't work out, you can control alignment via three macros.
optional lite uses the following rules for alignment:
-
If the program compiles as C++11 or later, C++11 alignment facilities are used.
-
If you define -Doptional_CONFIG_MAX_ALIGN_HACK=1 the underlying type is aligned as the most restricted type in
struct max_align_t. This potentially wastes many bytes per optional if the actually required alignment is much less, e.g. 24 bytes used instead of the 2 bytes required. -
If you define -Doptional_CONFIG_ALIGN_AS=pod-type the underlying type is aligned as pod-type. It's your obligation to specify a type with proper alignment.
-
If you define -Doptional_CONFIG_ALIGN_AS_FALLBACK=pod-type the fallback type for alignment of rule 5 below becomes pod-type. It's your obligation to specify a type with proper alignment.
-
At default, optional lite tries to find a POD type with the same alignment as the underlying type.
The algorithm for alignment of 5. is:
- Determine the alignment A of the underlying type using
alignment_of<>. - Find a POD type from the list
alignment_typeswith exactly alignment A. - If no such POD type is found, use a type with a relatively strict alignment requirement such as double; this type is specified in
optional_CONFIG_ALIGN_AS_FALLBACK(default double).
- Determine the alignment A of the underlying type using
Note that the algorithm of 5. differs from the one Andrei Alexandrescu uses in [8, part 2].
The class template alignment_of<> is gleaned from Boost.TypeTraits, alignment_of [11]. The storage type storage_t<> is adapted from the one I created for spike-expected, expected lite [13].
For more information on constructed unions and alignment, see [8-12].
- Isabella Muerte. MNMLSTC Core (C++11).
- Andrzej Krzemieński. optional (nullable) objects for C++14. Reference implementation.
- Simon Brand. C++11/14/17 std::optional with functional-style extensions.
[1] CppReference. Optional.
[2] ISO/IEC WG21. N4606, section 20.6 Optional objects. July 2016.
[3] Fernando Cacciola, Andrzej Krzemieński. A proposal to add a utility class to represent optional objects (Revision 5).
[4] Andrzej Krzemieński. optional (nullable) objects for C++14. Reference implementation on GitHub.
[5] Simon Brand. P0798R0: Monadic operations for std::optional.
[6] Simon Brand. C++11/14/17 std::optional with functional-style extensions . Reference implementation on GitHub.
[7] Fernando Cacciola. Boost.Optional library.
[8] StackOverflow. How should one use std::optional?. Answer by Timothy Shields. 31 May 2013.
[9] Fernando Cacciola. Boost.Optional Quick start guide.
[10] Andrei Alexandrescu. Generic: Discriminated Unions part 1, part 2, part 3. April 2002.
[11] Herb Sutter. Style Case Study #3: Construction Unions. GotW #85. 2009
[12] Kevin T. Manley. Using Constructed Types in C++ Unions. C/C++ Users Journal, 20(8), August 2002.
[13] StackOverflow. Determining maximum possible alignment in C++.
[14] Boost.TypeTraits, alignment_of ( code ).
[15] Martin Moene. spike-expected (expected-lite.hpp).
union: A C++03 union can only contain POD types
optional: Allows to default construct an empty optional
optional: Allows to explicitly construct a disengaged, empty optional via nullopt
optional: Allows to default construct an empty optional with a non-default-constructible
optional: Allows to copy-construct from empty optional
optional: Allows to copy-construct from non-empty optional
optional: Allows to move-construct from optional (C++11)
optional: Allows to copy-construct from literal value
optional: Allows to copy-construct from value
optional: Allows to move-construct from value (C++11)
optional: Allows to in-place construct from literal value (C++11)
optional: Allows to in-place copy-construct from value (C++11)
optional: Allows to in-place move-construct from value (C++11)
optional: Allows to in-place copy-construct from initializer-list (C++11)
optional: Allows to in-place move-construct from initializer-list (C++11)
optional: Allows to assign nullopt to disengage
optional: Allows to copy-assign from/to engaged and disengaged optionals
optional: Allows to move-assign from/to engaged and disengaged optionals (C++11)
optional: Allows to copy-assign from literal value
optional: Allows to copy-assign from value
optional: Allows to move-assign from value (C++11)
optional: Allows to copy-emplace content from arguments (C++11)
optional: Allows to move-emplace content from arguments (C++11)
optional: Allows to copy-emplace content from intializer-list and arguments (C++11)
optional: Allows to move-emplace content from intializer-list and arguments (C++11)
optional: Allows to swap with other optional (member)
optional: Allows to obtain pointer to value via operator->()
optional: Allows to obtain value via operator*()
optional: Allows to obtain moved-value via operator*()
optional: Allows to obtain has_value() via operator bool()
optional: Allows to obtain value via value()
optional: Allows to obtain value or default via value_or()
optional: Allows to obtain moved-value or moved-default via value_or() (C++11)
optional: Throws bad_optional_access at disengaged access
optional: Allows to reset content
optional: Allows to swaps engage state and values (non-member)
optional: Provides relational operators
optional: Provides mixed-type relational operators
make_optional: Allows to copy-construct optional
make_optional: Allows to move-construct optional (C++11)
make_optional: Allows to in-place copy-construct optional from arguments (C++11)
make_optional: Allows to in-place move-construct optional from arguments (C++11)
make_optional: Allows to in-place copy-construct optional from initializer-list and arguments (C++11)
make_optional: Allows to in-place move-construct optional from initializer-list and arguments (C++11)