1 #ifndef BOOST_LEAF_ERROR_HPP_INCLUDED
2 #define BOOST_LEAF_ERROR_HPP_INCLUDED
4 // Copyright 2018-2022 Emil Dotchevski and Reverge Studios, Inc.
6 // Distributed under the Boost Software License, Version 1.0. (See accompanying
7 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
9 #include <boost/leaf/config.hpp>
10 #include <boost/leaf/detail/optional.hpp>
11 #include <boost/leaf/detail/demangle.hpp>
12 #include <boost/leaf/detail/function_traits.hpp>
13 #include <boost/leaf/detail/print.hpp>
15 #include <type_traits>
18 #if BOOST_LEAF_CFG_DIAGNOSTICS
24 #if BOOST_LEAF_CFG_STD_SYSTEM_ERROR
25 # include <system_error>
28 #if BOOST_LEAF_CFG_CAPTURE
32 #define BOOST_LEAF_TOKEN_PASTE(x, y) x ## y
33 #define BOOST_LEAF_TOKEN_PASTE2(x, y) BOOST_LEAF_TOKEN_PASTE(x, y)
34 #define BOOST_LEAF_TMP BOOST_LEAF_TOKEN_PASTE2(boost_leaf_tmp_, __LINE__)
36 #define BOOST_LEAF_ASSIGN(v,r)\
37 auto && BOOST_LEAF_TMP = r;\
38 static_assert(::boost::leaf::is_result_type<typename std::decay<decltype(BOOST_LEAF_TMP)>::type>::value,\
39 "BOOST_LEAF_ASSIGN/BOOST_LEAF_AUTO requires a result object as the second argument (see is_result_type)");\
40 if( !BOOST_LEAF_TMP )\
41 return BOOST_LEAF_TMP.error();\
42 v = std::forward<decltype(BOOST_LEAF_TMP)>(BOOST_LEAF_TMP).value()
44 #define BOOST_LEAF_AUTO(v, r)\
45 BOOST_LEAF_ASSIGN(auto v, r)
47 #if BOOST_LEAF_CFG_GNUC_STMTEXPR
49 #define BOOST_LEAF_CHECK(r)\
51 auto && BOOST_LEAF_TMP = (r);\
52 static_assert(::boost::leaf::is_result_type<typename std::decay<decltype(BOOST_LEAF_TMP)>::type>::value,\
53 "BOOST_LEAF_CHECK requires a result object (see is_result_type)");\
54 if( !BOOST_LEAF_TMP )\
55 return BOOST_LEAF_TMP.error();\
56 std::move(BOOST_LEAF_TMP);\
61 #define BOOST_LEAF_CHECK(r)\
63 auto && BOOST_LEAF_TMP = (r);\
64 static_assert(::boost::leaf::is_result_type<typename std::decay<decltype(BOOST_LEAF_TMP)>::type>::value,\
65 "BOOST_LEAF_CHECK requires a result object (see is_result_type)");\
66 if( !BOOST_LEAF_TMP )\
67 return BOOST_LEAF_TMP.error();\
72 #define BOOST_LEAF_NEW_ERROR ::boost::leaf::leaf_detail::inject_loc{__FILE__,__LINE__,__FUNCTION__}+::boost::leaf::new_error
74 namespace boost { namespace leaf {
80 struct BOOST_LEAF_SYMBOL_VISIBLE tls_tag_unexpected_enabled_counter;
81 struct BOOST_LEAF_SYMBOL_VISIBLE tls_tag_id_factory_current_id;
85 char const * const file;
87 char const * const fn;
90 friend T operator+( inject_loc loc, T && x ) noexcept
92 x.load_source_location_(loc.file, loc.line, loc.fn);
100 ////////////////////////////////////////
102 #ifdef BOOST_LEAF_NO_EXCEPTIONS
106 BOOST_LEAF_NORETURN void throw_exception( std::exception const & ); // user defined
109 namespace boost { namespace leaf {
112 BOOST_LEAF_NORETURN void throw_exception( T const & e )
114 ::boost::throw_exception(e);
121 namespace boost { namespace leaf {
124 BOOST_LEAF_NORETURN void throw_exception( T const & e )
133 ////////////////////////////////////////
135 namespace boost { namespace leaf {
137 #if BOOST_LEAF_CFG_DIAGNOSTICS
139 namespace leaf_detail
141 class BOOST_LEAF_SYMBOL_VISIBLE e_unexpected_count
145 char const * (*first_type)();
148 BOOST_LEAF_CONSTEXPR explicit e_unexpected_count(char const * (*first_type)()) noexcept:
149 first_type(first_type),
154 template <class CharT, class Traits>
155 void print( std::basic_ostream<CharT, Traits> & os ) const
157 BOOST_LEAF_ASSERT(first_type != 0);
158 BOOST_LEAF_ASSERT(count>0);
161 os << "1 attempt to communicate an unexpected error object";
163 os << count << " attempts to communicate unexpected error objects, the first one";
164 (os << " of type " << first_type() << '\n').flush();
169 struct diagnostic<e_unexpected_count, false, false>
171 static constexpr bool is_invisible = true;
173 template <class CharT, class Traits>
174 BOOST_LEAF_CONSTEXPR static void print( std::basic_ostream<CharT, Traits> &, e_unexpected_count const &) noexcept { }
177 class BOOST_LEAF_SYMBOL_VISIBLE e_unexpected_info
180 std::set<char const *(*)()> already_;
184 e_unexpected_info() noexcept
191 if( !diagnostic<E>::is_invisible && already_.insert(&type<E>).second )
194 diagnostic<E>::print(s,e);
200 template <class CharT, class Traits>
201 void print( std::basic_ostream<CharT, Traits> & os ) const
203 os << "Unhandled error objects:\n" << s_;
208 struct diagnostic<e_unexpected_info, false, false>
210 static constexpr bool is_invisible = true;
212 template <class CharT, class Traits>
213 BOOST_LEAF_CONSTEXPR static void print( std::basic_ostream<CharT, Traits> &, e_unexpected_info const &) noexcept { }
222 ////////////////////////////////////////
224 namespace boost { namespace leaf {
226 struct BOOST_LEAF_SYMBOL_VISIBLE e_source_location
230 char const * function;
232 template <class CharT, class Traits>
233 friend std::basic_ostream<CharT, Traits> & operator<<( std::basic_ostream<CharT, Traits> & os, e_source_location const & x )
235 return os << leaf::type<e_source_location>() << ": " << x.file << '(' << x.line << ") in function " << x.function;
239 ////////////////////////////////////////
241 namespace leaf_detail
244 class BOOST_LEAF_SYMBOL_VISIBLE slot:
247 slot( slot const & ) = delete;
248 slot & operator=( slot const & ) = delete;
250 using impl = optional<E>;
255 BOOST_LEAF_CONSTEXPR slot() noexcept:
260 BOOST_LEAF_CONSTEXPR slot( slot && x ) noexcept:
261 optional<E>(std::move(x)),
264 BOOST_LEAF_ASSERT(x.prev_==0);
267 BOOST_LEAF_CONSTEXPR void activate() noexcept
269 prev_ = tls::read_ptr<slot<E>>();
270 tls::write_ptr<slot<E>>(this);
273 BOOST_LEAF_CONSTEXPR void deactivate() noexcept
275 tls::write_ptr<slot<E>>(prev_);
278 BOOST_LEAF_CONSTEXPR void propagate( int err_id ) noexcept;
280 template <class CharT, class Traits>
281 void print( std::basic_ostream<CharT, Traits> & os, int key_to_print ) const
283 #if BOOST_LEAF_CFG_DIAGNOSTICS
284 if( !diagnostic<E>::is_invisible )
285 if( int k = this->key() )
289 if( key_to_print!=k )
293 os << '[' << k << ']';
294 diagnostic<E>::print(os, value(k));
295 (os << '\n').flush();
301 using impl::has_value;
305 #if BOOST_LEAF_CFG_DIAGNOSTICS
308 BOOST_LEAF_CONSTEXPR inline void load_unexpected_count( int err_id ) noexcept
310 if( slot<e_unexpected_count> * sl = tls::read_ptr<slot<e_unexpected_count>>() )
311 if( e_unexpected_count * unx = sl->has_value(err_id) )
314 sl->put(err_id, e_unexpected_count(&type<E>));
318 BOOST_LEAF_CONSTEXPR inline void load_unexpected_info( int err_id, E && e ) noexcept
320 if( slot<e_unexpected_info> * sl = tls::read_ptr<slot<e_unexpected_info>>() )
321 if( e_unexpected_info * unx = sl->has_value(err_id) )
322 unx->add(std::forward<E>(e));
324 sl->put(err_id, e_unexpected_info()).add(std::forward<E>(e));
328 BOOST_LEAF_CONSTEXPR inline void load_unexpected( int err_id, E && e ) noexcept
330 load_unexpected_count<E>(err_id);
331 load_unexpected_info(err_id, std::forward<E>(e));
337 BOOST_LEAF_CONSTEXPR inline void slot<E>::propagate( int err_id ) noexcept
339 if( this->key()!=err_id && err_id!=0 )
341 if( impl * p = tls::read_ptr<slot<E>>() )
342 *p = std::move(*this);
343 #if BOOST_LEAF_CFG_DIAGNOSTICS
346 int c = tls::read_uint32<tls_tag_unexpected_enabled_counter>();
347 BOOST_LEAF_ASSERT(c>=0);
349 load_unexpected(err_id, std::move(*this).value(err_id));
355 BOOST_LEAF_CONSTEXPR inline int load_slot( int err_id, E && e ) noexcept
357 static_assert(!std::is_pointer<E>::value, "Error objects of pointer types are not allowed");
358 static_assert(!std::is_same<typename std::decay<E>::type, error_id>::value, "Error objects of type error_id are not allowed");
359 using T = typename std::decay<E>::type;
360 BOOST_LEAF_ASSERT((err_id&3)==1);
361 if( slot<T> * p = tls::read_ptr<slot<T>>() )
362 (void) p->put(err_id, std::forward<E>(e));
363 #if BOOST_LEAF_CFG_DIAGNOSTICS
366 int c = tls::read_uint32<tls_tag_unexpected_enabled_counter>();
367 BOOST_LEAF_ASSERT(c>=0);
369 load_unexpected(err_id, std::forward<E>(e));
376 BOOST_LEAF_CONSTEXPR inline int accumulate_slot( int err_id, F && f ) noexcept
378 static_assert(function_traits<F>::arity==1, "Lambdas passed to accumulate must take a single e-type argument by reference");
379 using E = typename std::decay<fn_arg_type<F,0>>::type;
380 static_assert(!std::is_pointer<E>::value, "Error objects of pointer types are not allowed");
381 BOOST_LEAF_ASSERT((err_id&3)==1);
382 if( auto sl = tls::read_ptr<slot<E>>() )
383 if( auto v = sl->has_value(err_id) )
384 (void) std::forward<F>(f)(*v);
386 (void) std::forward<F>(f)(sl->put(err_id,E()));
391 ////////////////////////////////////////
393 namespace leaf_detail
395 template <class=void>
396 struct BOOST_LEAF_SYMBOL_VISIBLE id_factory
398 static atomic_unsigned_int counter;
400 BOOST_LEAF_CONSTEXPR static unsigned generate_next_id() noexcept
402 auto id = (counter+=4);
403 BOOST_LEAF_ASSERT((id&3)==1);
409 atomic_unsigned_int id_factory<T>::counter(-3);
411 inline int current_id() noexcept
413 auto id = tls::read_uint32<tls_tag_id_factory_current_id>();
414 BOOST_LEAF_ASSERT(id==0 || (id&3)==1);
418 inline int new_id() noexcept
420 auto id = id_factory<>::generate_next_id();
421 tls::write_uint32<tls_tag_id_factory_current_id>(id);
426 ////////////////////////////////////////
428 namespace leaf_detail
430 template <class T, int Arity = function_traits<T>::arity>
433 static_assert(Arity==0 || Arity==1, "If a functions is passed to new_error or load, it must take zero or one argument");
437 struct load_item<E, -1>
439 BOOST_LEAF_CONSTEXPR static int load( int err_id, E && e ) noexcept
441 return load_slot(err_id, std::forward<E>(e));
446 struct load_item<F, 0>
448 BOOST_LEAF_CONSTEXPR static int load( int err_id, F && f ) noexcept
450 return load_slot(err_id, std::forward<F>(f)());
455 struct load_item<F, 1>
457 BOOST_LEAF_CONSTEXPR static int load( int err_id, F && f ) noexcept
459 return accumulate_slot(err_id, std::forward<F>(f));
464 ////////////////////////////////////////
466 #if BOOST_LEAF_CFG_STD_SYSTEM_ERROR
467 namespace leaf_detail
469 class leaf_category final: public std::error_category
471 bool equivalent( int, std::error_condition const & ) const noexcept final override { return false; }
472 bool equivalent( std::error_code const &, int ) const noexcept final override { return false; }
473 char const * name() const noexcept final override { return "LEAF error"; }
474 std::string message( int condition ) const final override { return name(); }
476 ~leaf_category() noexcept final override { }
479 template <class=void>
480 struct get_error_category
482 static leaf_category cat;
486 leaf_category get_error_category<T>::cat;
488 inline int import_error_code( std::error_code const & ec ) noexcept
490 if( int err_id = ec.value() )
492 std::error_category const & cat = get_error_category<>::cat;
493 if( &ec.category()==&cat )
495 BOOST_LEAF_ASSERT((err_id&3)==1);
496 return (err_id&~3)|1;
501 (void) load_slot(err_id, ec);
502 return (err_id&~3)|1;
510 inline bool is_error_id( std::error_code const & ec ) noexcept
512 bool res = (&ec.category() == &leaf_detail::get_error_category<>::cat);
513 BOOST_LEAF_ASSERT(!res || !ec.value() || ((ec.value()&3)==1));
518 ////////////////////////////////////////
520 namespace leaf_detail
522 BOOST_LEAF_CONSTEXPR error_id make_error_id(int) noexcept;
525 class BOOST_LEAF_SYMBOL_VISIBLE error_id
527 friend error_id BOOST_LEAF_CONSTEXPR leaf_detail::make_error_id(int) noexcept;
531 BOOST_LEAF_CONSTEXPR explicit error_id( int value ) noexcept:
534 BOOST_LEAF_ASSERT(value_==0 || ((value_&3)==1));
539 BOOST_LEAF_CONSTEXPR error_id() noexcept:
544 #if BOOST_LEAF_CFG_STD_SYSTEM_ERROR
545 error_id( std::error_code const & ec ) noexcept:
546 value_(leaf_detail::import_error_code(ec))
548 BOOST_LEAF_ASSERT(!value_ || ((value_&3)==1));
551 template <class Enum>
552 error_id( Enum e, typename std::enable_if<std::is_error_code_enum<Enum>::value, Enum>::type * = 0 ) noexcept:
553 value_(leaf_detail::import_error_code(e))
557 std::error_code to_error_code() const noexcept
559 return std::error_code(value_, leaf_detail::get_error_category<>::cat);
563 BOOST_LEAF_CONSTEXPR error_id load() const noexcept
568 template <class... Item>
569 BOOST_LEAF_CONSTEXPR error_id load( Item && ... item ) const noexcept
571 if( int err_id = value() )
573 int const unused[ ] = { 42, leaf_detail::load_item<Item>::load(err_id, std::forward<Item>(item))... };
579 BOOST_LEAF_CONSTEXPR int value() const noexcept
583 BOOST_LEAF_ASSERT((v&3)==1);
590 BOOST_LEAF_CONSTEXPR explicit operator bool() const noexcept
595 BOOST_LEAF_CONSTEXPR friend bool operator==( error_id a, error_id b ) noexcept
597 return a.value_ == b.value_;
600 BOOST_LEAF_CONSTEXPR friend bool operator!=( error_id a, error_id b ) noexcept
605 BOOST_LEAF_CONSTEXPR friend bool operator<( error_id a, error_id b ) noexcept
607 return a.value_ < b.value_;
610 template <class CharT, class Traits>
611 friend std::basic_ostream<CharT, Traits> & operator<<( std::basic_ostream<CharT, Traits> & os, error_id x )
613 return os << x.value_;
616 BOOST_LEAF_CONSTEXPR void load_source_location_( char const * file, int line, char const * function ) const noexcept
618 BOOST_LEAF_ASSERT(file&&*file);
619 BOOST_LEAF_ASSERT(line>0);
620 BOOST_LEAF_ASSERT(function&&*function);
621 BOOST_LEAF_ASSERT(value_);
622 (void) load(e_source_location {file,line,function});
626 namespace leaf_detail
628 BOOST_LEAF_CONSTEXPR inline error_id make_error_id( int err_id ) noexcept
630 BOOST_LEAF_ASSERT(err_id==0 || (err_id&3)==1);
631 return error_id((err_id&~3)|1);
635 inline error_id new_error() noexcept
637 return leaf_detail::make_error_id(leaf_detail::new_id());
640 template <class... Item>
641 inline error_id new_error( Item && ... item ) noexcept
643 return leaf_detail::make_error_id(leaf_detail::new_id()).load(std::forward<Item>(item)...);
646 inline error_id current_error() noexcept
648 return leaf_detail::make_error_id(leaf_detail::current_id());
651 ////////////////////////////////////////////
653 class polymorphic_context
657 polymorphic_context() noexcept = default;
658 ~polymorphic_context() noexcept = default;
662 virtual error_id propagate_captured_errors() noexcept = 0;
663 virtual void activate() noexcept = 0;
664 virtual void deactivate() noexcept = 0;
665 virtual void propagate( error_id ) noexcept = 0;
666 virtual bool is_active() const noexcept = 0;
667 inline virtual void print( std::ostream & ) const { };
668 error_id captured_id_;
671 #if BOOST_LEAF_CFG_CAPTURE
672 using context_ptr = std::shared_ptr<polymorphic_context>;
675 ////////////////////////////////////////////
678 class context_activator
680 context_activator( context_activator const & ) = delete;
681 context_activator & operator=( context_activator const & ) = delete;
683 #if !defined(BOOST_LEAF_NO_EXCEPTIONS) && BOOST_LEAF_STD_UNCAUGHT_EXCEPTIONS
684 int const uncaught_exceptions_;
690 explicit BOOST_LEAF_CONSTEXPR BOOST_LEAF_ALWAYS_INLINE context_activator(Ctx & ctx) noexcept:
691 #if !defined(BOOST_LEAF_NO_EXCEPTIONS) && BOOST_LEAF_STD_UNCAUGHT_EXCEPTIONS
692 uncaught_exceptions_(std::uncaught_exceptions()),
694 ctx_(ctx.is_active() ? 0 : &ctx)
700 BOOST_LEAF_CONSTEXPR BOOST_LEAF_ALWAYS_INLINE context_activator( context_activator && x ) noexcept:
701 #if !defined(BOOST_LEAF_NO_EXCEPTIONS) && BOOST_LEAF_STD_UNCAUGHT_EXCEPTIONS
702 uncaught_exceptions_(x.uncaught_exceptions_),
709 BOOST_LEAF_ALWAYS_INLINE ~context_activator() noexcept
711 if( ctx_ && ctx_->is_active() )
717 BOOST_LEAF_CONSTEXPR BOOST_LEAF_ALWAYS_INLINE context_activator<Ctx> activate_context(Ctx & ctx) noexcept
719 return context_activator<Ctx>(ctx);
722 ////////////////////////////////////////////
725 struct is_result_type: std::false_type
730 struct is_result_type<R const>: is_result_type<R>