1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
|
// Copyright 2015, Tobias Hermann and the FunctionalPlus contributors.
// https://github.com/Dobiasd/FunctionalPlus
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
#pragma once
#include <fplus/function_traits.hpp>
#include <fplus/compare.hpp>
#include <fplus/internal/composition.hpp>
#include <fplus/internal/asserts/composition.hpp>
#include <cassert>
#include <exception>
#include <functional>
#include <memory>
namespace fplus
{
// Can hold a value of type T or nothing.
template <typename T>
class maybe
{
public:
bool is_just() const { return is_present_; }
bool is_nothing() const { return !is_just(); }
const T& unsafe_get_just() const
{
assert(is_just());
return *reinterpret_cast<const T*>(&value_);
}
T& unsafe_get_just()
{
assert(is_just());
return *reinterpret_cast<T*>(&value_);
}
typedef T type;
maybe() : is_present_(false), value_() {};
~maybe()
{
destruct_content();
}
maybe(const T& val_just) : is_present_(true), value_()
{
new (&value_) T(val_just);
}
maybe(T&& val_just) : is_present_(true), value_() {
new (&value_) T(std::move(val_just));
}
maybe(const maybe<T>& other) : is_present_(other.is_just()), value_()
{
if (is_present_)
{
new (&value_) T(other.unsafe_get_just());
}
}
maybe(maybe<T>&& other) : is_present_(std::move(other.is_present_)), value_()
{
if (is_present_)
{
new (&value_) T(std::move(other.unsafe_get_just()));
}
}
maybe<T>& operator = (const T& other)
{
destruct_content();
is_present_ = true;
new (&value_) T(other);
return *this;
}
maybe& operator = (T&& other) {
destruct_content();
is_present_ = true;
new (&value_) T(std::move(other));
return *this;
}
maybe<T>& operator = (const maybe<T>& other)
{
destruct_content();
if (other.is_just())
{
is_present_ = true;
new (&value_) T(other.unsafe_get_just());
}
return *this;
}
maybe& operator = (maybe<T>&& other) {
destruct_content();
is_present_ = std::move(other.is_present_);
if (is_present_)
{
new (&value_) T(std::move(other.unsafe_get_just()));
}
return *this;
}
private:
void destruct_content()
{
if (is_present_)
{
is_present_ = false;
(*reinterpret_cast<const T*>(&value_)).~T();
}
}
bool is_present_;
typename std::aligned_storage<sizeof(T), alignof(T)>::type value_;
};
namespace internal
{
template <typename>
struct is_maybe : std::false_type
{
};
template <typename T>
struct is_maybe<maybe<T>> : std::true_type
{
};
}
// API search type: is_just : Maybe a -> Bool
// fwd bind count: 0
// Is not nothing?
template <typename T>
bool is_just(const maybe<T>& maybe)
{
return maybe.is_just();
}
// API search type: is_nothing : Maybe a -> Bool
// fwd bind count: 0
// Has no value?
template <typename T>
bool is_nothing(const maybe<T>& maybe)
{
return !is_just(maybe);
}
// API search type: unsafe_get_just : Maybe a -> a
// fwd bind count: 0
// Crashes if maybe is nothing!
template <typename T>
T unsafe_get_just(const maybe<T>& maybe)
{
return maybe.unsafe_get_just();
}
// API search type: just_with_default : (a, Maybe a) -> a
// fwd bind count: 0
// Get the value from a maybe or the default in case it is nothing.
template <typename T>
T just_with_default(const T& defaultValue, const maybe<T>& maybe)
{
if (is_just(maybe))
return unsafe_get_just(maybe);
return defaultValue;
}
// API search type: throw_on_nothing : (e, Maybe a) -> a
// fwd bind count: 1
// Throw exception if nothing. Return value if just.
template <typename E, typename T>
T throw_on_nothing(const E& e, const maybe<T>& maybe)
{
if (is_nothing(maybe))
throw e;
return unsafe_get_just(maybe);
}
// API search type: just : a -> Maybe a
// fwd bind count: 0
// Wrap a value in a Maybe as a Just.
template <typename T>
maybe<T> just(const T& val)
{
return val;
}
// API search type: as_just_if : ((a -> bool), a) -> Maybe a
// fwd bind count: 1
// Wrap a value in a Maybe as a Just if the given predicate is fulfilled.
// Otherwise a nothing is returned.
template <typename Pred, typename T>
maybe<T> as_just_if(Pred pred, const T& val)
{
internal::check_unary_predicate_for_type<Pred, T>();
if (pred(val))
return val;
else
return {};
}
// API search type: maybe_to_seq : Maybe a -> [a]
// fwd bind count: 0
// Converts a maybe to a sequence.
// singleton_seq(Just 3) == [3]
// singleton_seq(Nothing) == []
template <typename T, typename ContainerOut = std::vector<T>>
ContainerOut maybe_to_seq(const maybe<T>& maybe)
{
if (is_just(maybe))
return ContainerOut(1, unsafe_get_just(maybe));
return {};
}
// API search type: singleton_seq_as_maybe : [a] -> Maybe a
// fwd bind count: 0
// Converts a sequence to a maybe.
// singleton_seq([]) == Nothing
// singleton_seq([3]) == Just 3
// singleton_seq([3,4]) == Nothing
template <typename Container>
maybe<typename Container::value_type>
singleton_seq_as_maybe(const Container& xs)
{
if (xs.size() == 1)
return xs.front();
return {};
}
// API search type: nothing : () -> Maybe a
// Construct a nothing of a certain Maybe type.
template <typename T>
maybe<T> nothing()
{
return {};
}
// True if just values are the same or if both are nothing.
template <typename T>
bool operator == (const maybe<T>& x, const maybe<T>& y)
{
if (is_just(x) && is_just(y))
return unsafe_get_just(x) == unsafe_get_just(y);
return is_just(x) == is_just(y);
}
// False if just values are the same or if both are nothing.
template <typename T>
bool operator != (const maybe<T>& x, const maybe<T>& y)
{
return !(x == y);
}
// API search type: lift_maybe : ((a -> b), Maybe a) -> Maybe b
// fwd bind count: 1
// Lifts a function into the maybe functor.
// A function that for example was able to convert and int into a string,
// now can convert a Maybe<int> into a Maybe<string>.
// A nothing remains a nothing, regardless of the conversion.
template <typename F, typename A>
auto lift_maybe(F f, const maybe<A>& m)
{
internal::trigger_static_asserts<internal::check_arity_tag, F, A>();
using B = std::decay_t<internal::invoke_result_t<F, A>>;
if (is_just(m))
return just<B>(internal::invoke(f, unsafe_get_just(m)));
return nothing<B>();
}
// API search type: lift_maybe_def : (b, (a -> b), Maybe a) -> b
// fwd bind count: 2
// lift_maybe_def takes a default value and a function.
// It returns a function taking a Maybe value.
// This function returns the default value if the Maybe value is nothing.
// Otherwise it applies the function to the value inside the Just
// of the Maybe value and returns the result of this application.
template <typename F, typename A, typename Default>
auto lift_maybe_def(const Default& def, F f, const maybe<A>& m)
{
internal::trigger_static_asserts<internal::check_arity_tag, F, A>();
using B = std::decay_t<internal::invoke_result_t<F, A>>;
static_assert(
std::is_convertible<Default, B>::value,
"Default value must be convertible to Function's return type");
if (is_just(m))
return B(internal::invoke(f, unsafe_get_just(m)));
return B(def);
}
// API search type: lift_maybe_2 : (((a, b) -> c), Maybe a, Maybe b) -> Maybe c
// fwd bind count: 2
// Lifts a binary function into the maybe functor.
// Applies the function only if both arguments are justs.
// Otherwise returns a nothing.
template <typename F, typename A, typename B>
auto lift_maybe_2(F f, const maybe<A>& m_a, const maybe<B>& m_b)
{
internal::trigger_static_asserts<internal::check_arity_tag, F, A, B>();
using FOut = std::decay_t<internal::invoke_result_t<F, A, B>>;
if (is_just(m_a) && is_just(m_b))
{
return just<FOut>(
internal::invoke(f, unsafe_get_just(m_a), unsafe_get_just(m_b)));
}
return nothing<FOut>();
}
// API search type: lift_maybe_2_def : (c, ((a, b) -> c), Maybe a, Maybe b) -> c
// fwd bind count: 3
// lift_maybe_2_def takes a default value and a binary function.
// It returns a function taking a two Maybe values.
// This function returns the default value at least one of the
// Maybe values is nothing.
// Otherwise it applies the function to the two values inside the Justs
// and returns the result of this application.
template <typename F, typename A, typename B, typename Default>
auto lift_maybe_2_def(const Default& def,
F f,
const maybe<A>& m_a,
const maybe<B>& m_b)
{
internal::trigger_static_asserts<internal::check_arity_tag, F, A, B>();
using C = std::decay_t<internal::invoke_result_t<F, A, B>>;
static_assert(
std::is_convertible<Default, C>::value,
"Default value must be convertible to Function's return type");
if (is_just(m_a) && is_just(m_b))
return C(internal::invoke(f, unsafe_get_just(m_a), unsafe_get_just(m_b)));
return C(def);
}
// API search type: join_maybe : Maybe Maybe a -> Maybe a
// Flattens a nested maybe.
// join_maybe(Just Just x) == Just x
// join_maybe(Just Nothing) == Nothing
// join_maybe(Nothing) == Nothing
template <typename A>
maybe<A> join_maybe(const maybe<maybe<A>>& m)
{
if (is_just(m))
return unsafe_get_just(m);
else
return nothing<A>();
}
// API search type: and_then_maybe : ((a -> Maybe b), (Maybe a)) -> Maybe b
// fwd bind count: 1
// Monadic bind.
// Returns nothing if the maybe already is nothing.
// Otherwise return the result of applying
// the function to the just value of the maybe.
template <typename T, typename F>
auto and_then_maybe(F f, const maybe<T>& m)
{
internal::trigger_static_asserts<internal::check_arity_tag, F, T>();
using FOut = std::decay_t<internal::invoke_result_t<F, T>>;
static_assert(internal::is_maybe<FOut>::value,
"Function must return a maybe<> type");
if (is_just(m))
return internal::invoke(f, unsafe_get_just(m));
else
return nothing<typename FOut::type>();
}
// API search type: compose_maybe : ((a -> Maybe b), (b -> Maybe c)) -> (a -> Maybe c)
// Left-to-right Kleisli composition of monads.
// Composes multiple callables taking a value and returning Maybe.
// If the first callable returns a just, the value from the just
// is extracted and shoved into the next callable.
// If the first callable returns a nothing, it remains a nothing.
// The first callable can take a variadic number of parameters.
template <typename... Callables>
auto compose_maybe(Callables&&... callables)
{
auto bind_maybe = [](auto f, auto g) {
// next step would be to perfectly forward callables, as shown here:
// https://vittorioromeo.info/index/blog/capturing_perfectly_forwarded_objects_in_lambdas.html
return [f = std::move(f), g = std::move(g)](auto&&... args)
{
using FOut = std::decay_t<
internal::invoke_result_t<decltype(f), decltype(args)...>>;
static_assert(internal::is_maybe<FOut>::value,
"Functions must return a maybe<> type");
using GOut = std::decay_t<
internal::invoke_result_t<decltype(g), typename FOut::type>>;
static_assert(internal::is_maybe<GOut>::value,
"Functions must return a maybe<> type");
auto maybeB =
internal::invoke(f, std::forward<decltype(args)>(args)...);
if (is_just(maybeB))
return internal::invoke(g, unsafe_get_just(maybeB));
return GOut{};
};
};
return internal::compose_binary_lift(bind_maybe,
std::forward<Callables>(callables)...);
}
// API search type: flatten_maybe : (Maybe (Maybe a)) -> Maybe a
// fwd bind count: 0
// Also known as join.
template <typename T>
maybe<T> flatten_maybe(const maybe<maybe<T>>& maybe_maybe)
{
if (is_nothing(maybe_maybe))
return nothing<T>();
return unsafe_get_just(maybe_maybe);
}
} // namespace fplus
|