 |
LArSoft
v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
|
|
LArSoft
v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
|
Simple traits for the implementation of other traits. More...
Namespaces | |
| util::details | |
Classes | |
| struct | util::self_type< T > |
| Trait returning the very same type as in the template argument. More... | |
| struct | util::always_false_type< typename > |
A std::false_type with a template argument. More... | |
| struct | util::always_true_type< typename > |
A std::true_type with a template argument. More... | |
| struct | util::find_next_type< T, StartFrom, Types > |
Trait: index of the first occurrence of T among the specified Types, starting from the one with index StartFrom. More... | |
| struct | util::is_any_of< T, Types > |
Trait: whether T is among the specified Types. More... | |
Typedefs | |
| template<typename T > | |
| using | util::self_t = typename self_type< T >::type |
| The very same type as in the template argument. More... | |
| template<typename A , typename B > | |
| using | util::is_not_same = std::negation< std::is_same< A, B >> |
The negation of std::is_same. More... | |
| template<typename T , typename... Types> | |
| using | util::find_type = find_next_type< T, 0U, Types... > |
Trait: index of the first occurrence of T among the specified Types. More... | |
Variables | |
| template<typename > | |
| constexpr bool | util::always_false_v = false |
| A templated constant, always false. More... | |
| template<typename > | |
| constexpr bool | util::always_true_v = true |
| A template constant always true. More... | |
| template<typename T , std::size_t StartFrom, typename... Types> | |
| constexpr std::size_t | util::find_next_type_v = find_next_type<T, StartFrom, Types...>::value |
| template<typename T , typename... Types> | |
| constexpr std::size_t | util::find_type_v = find_type<T, Types...>::value |
| template<typename T , typename... Types> | |
| constexpr bool | util::is_any_of_v = is_any_of<T, Types...>::value |
Whether T is among the specified Types (see util::is_any_of). More... | |
| template<typename T , typename U > | |
| constexpr auto | util::is_same_decay_v = std::is_same_v<std::decay_t<T>, std::decay_t<U>> |
Whether T and U are the same type, after being applied std::decay. More... | |
| template<typename T > | |
| void | util::staticDumpClassName () |
| Helper to determine the type of a variable at compilation time. More... | |
| template<typename T > | |
| void | util::staticDumpClassName (T) |
| Helper to determine the type of a variable at compilation time. More... | |
| template<typename Target , typename... T> | |
| using | util::count_type_in_list = details::count_type_in_list_impl< Target, T... > |
Returns how many of the types in T exactly match Target. More... | |
| template<std::size_t N, typename... T> | |
| using | util::typelist_element_type = std::tuple_element< N, std::tuple< T... >> |
Returns the N type of the type list. More... | |
| template<std::size_t N, typename... T> | |
| using | util::typelist_element_t = typename typelist_element_type< N, T... >::type |
Direct access to the value in typelist_element_type. More... | |
| template<typename Target , typename... T> | |
| using | util::type_is_in = details::type_is_in_impl< Target, T... > |
Holds whether the Target type is among the ones in the T pack. More... | |
| template<typename Target , typename... T> | |
| constexpr unsigned int | util::count_type_in_list_v = count_type_in_list<Target, T...>() |
Direct access to the value in count_type_in_list. More... | |
| template<typename Target , typename... T> | |
| constexpr bool | util::type_is_in_v = type_is_in<Target, T...>() |
Direct access to the value in type_is_in. More... | |
Simple traits for the implementation of other traits.
Class triggering a static_assert failure.
| T | type accompanying the assertion |
| Enable | assertion will fail only if Enable expands to true |
Instantiating this class anywhere (where it's legit) will trigger a static assertion failure. Since the error message emitted by the compiler usually contains an expansion of the template parameters, it is then possible to see the "value" of type T that was used when the assertion failed. The argument Enable allows to tune when the assertion should fail.
For the following example, we want to investigate the value of the type element_type, which is provided, among others, by std::unique_ptr. We want to find out the exact type element_type of the collection type passed to OurClass, but only when the collection type is, say, not constant:
(a working example is provided in DebugUtils_test.h). The output with GCC 7.2 is similar to the following: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In file included from larcorealg/test/CoreUtils/DebugUtils_test.cc:17:0: larcorealg/larcorealg/CoreUtils/DebugUtils.h: In instantiation of ‘struct lar::debug::details::THE_TYPE_IS<int [10]>’: larcorealg/larcorealg/CoreUtils/DebugUtils.h:476:29: required from ‘struct lar::debug::static_assert_on<int [10], true>’ larcorealg/test/CoreUtils/DebugUtils_test.cc:49:5: required from ‘struct OurClass<const std::unique_ptr<int [10]> >’ larcorealg/test/CoreUtils/DebugUtils_test.cc:61:51: required from here larcorealg/larcorealg/CoreUtils/DebugUtils.h:467:7: error: static assertion failed: static_assert_on<T>: check the error message ("THE_TYPE_IS<>") for expansion of type T. static_assert(util::always_false_v<T>, ^~~~~~~~~~~~~
In file included from larcorealg/test/CoreUtils/DebugUtils_test.cc:17: larcorealg/larcorealg/CoreUtils/DebugUtils.h:451:7: error: static_assert failed "static_assert_on<T>: check the error message (\"THE_TYPE_IS<>") for expansion of type `T`." static_assert(util::always_false_v<T>, ^ ~~~~~~~~~~~~~~~~~~~~~~~~~ larcorealg/larcorealg/CoreUtils/DebugUtils.h:460:29: note: in instantiation of template class 'lar::debug::details::THE_TYPE_IS<int [10]>' requested here details::THE_TYPE_IS<T> _; ^ larcorealg/test/CoreUtils/DebugUtils_test.cc:49:5: note: in instantiation of template class 'lar::debug::static_assert_on<int [10], true>' requested here debugVar; ^ larcorealg/test/CoreUtils/DebugUtils_test.cc:61:10: note: in instantiation of template class 'OurClass<const std::__1::unique_ptr<int [10], std::__1::default_delete<int [10]> > >' requested here (void) OurClass<std::unique_ptr<int[10]> const>(); ^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ where the type can be read in the message of the first note.
| using util::count_type_in_list = typedef details::count_type_in_list_impl<Target, T...> |
Returns how many of the types in T exactly match Target.
Definition at line 103 of file TupleLookupByTag.h.
| using util::find_type = typedef find_next_type<T, 0U, Types...> |
Trait: index of the first occurrence of T among the specified Types.
| T | the type of check the presence of |
| Types | the possible types T can match. |
util::find_next_typeThe value of the trait is the index of T within the specified list of Types (first type as index 0). The match is exact, as in std::is_same. If none of the Types exactly matches T, the trait value will be the number of types (i.e. sizeof...(Types)), which is the index after the last of the types.
This is a integral trait (type std::size_t): use it as std::integer_constant.
Definition at line 212 of file MetaUtils.h.
| using util::is_not_same = typedef std::negation<std::is_same<A, B>> |
The negation of std::is_same.
Definition at line 166 of file MetaUtils.h.
| using util::self_t = typedef typename self_type<T>::type |
The very same type as in the template argument.
Definition at line 66 of file MetaUtils.h.
| using util::type_is_in = typedef details::type_is_in_impl<Target, T...> |
Holds whether the Target type is among the ones in the T pack.
Definition at line 119 of file TupleLookupByTag.h.
| using util::typelist_element_t = typedef typename typelist_element_type<N, T...>::type |
Direct access to the value in typelist_element_type.
Definition at line 115 of file TupleLookupByTag.h.
| using util::typelist_element_type = typedef std::tuple_element<N, std::tuple<T...>> |
Returns the N type of the type list.
Definition at line 111 of file TupleLookupByTag.h.
| void util::staticDumpClassName | ( | ) |
Helper to determine the type of a variable at compilation time.
| T | type to be investigated |
It may be difficult to understand which type is being used in a failing static assertion or in some complicate metaprogramming code (is there any other kind?), especially when due to a compilation failure the code can't be run. This class is supposed to help by forcing the compiler to a halt, and it is devised so that the compiler should print in the error message what it thinks the type T is.
An example of usage:
For example, Clang 5.0.1 emits these errors:
From the first "note" we can see that the type of v is unsigned int. Note that if v is not copiable, an additional error will be emitted. To avoid that, the type can be specified as template parameter, as in util::staticDumpClassName<decltype(v)>(). The same program is processed by GNU GCC with an error message: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In file included from metatest.cpp:1:0: MetaUtils.h: In instantiation of ‘struct util::details::ClassNameStaticDumper<unsigned int>’: MetaUtils.h:248:48: required from ‘void util::staticDumpClassName() [with T = unsigned int]’ MetaUtils.h:215:68: required from ‘void util::staticDumpClassName(T) [with T = unsigned int]’ metatest.cpp:5:30: required from here MetaUtils.h:237:7: error: static assertion failed: ClassNameStaticDumper<T>: look for T in the error message context static_assert( ^~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ where the type is mentioned in all the three context lines.
Definition at line 886 of file MetaUtils.h.
| void util::staticDumpClassName | ( | T | ) |
Helper to determine the type of a variable at compilation time.
| T | type to be investigated |
It may be difficult to understand which type is being used in a failing static assertion or in some complicate metaprogramming code (is there any other kind?), especially when due to a compilation failure the code can't be run. This class is supposed to help by forcing the compiler to a halt, and it is devised so that the compiler should print in the error message what it thinks the type T is.
An example of usage:
For example, Clang 5.0.1 emits these errors:
From the first "note" we can see that the type of v is unsigned int. Note that if v is not copiable, an additional error will be emitted. To avoid that, the type can be specified as template parameter, as in util::staticDumpClassName<decltype(v)>(). The same program is processed by GNU GCC with an error message: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In file included from metatest.cpp:1:0: MetaUtils.h: In instantiation of ‘struct util::details::ClassNameStaticDumper<unsigned int>’: MetaUtils.h:248:48: required from ‘void util::staticDumpClassName() [with T = unsigned int]’ MetaUtils.h:215:68: required from ‘void util::staticDumpClassName(T) [with T = unsigned int]’ metatest.cpp:5:30: required from here MetaUtils.h:237:7: error: static assertion failed: ClassNameStaticDumper<T>: look for T in the error message context static_assert( ^~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ where the type is mentioned in all the three context lines.
Definition at line 302 of file MetaUtils.h.
| constexpr bool util::always_false_v = false |
A templated constant, always false.
This constant allows a static_assert to fail only when the template type it's in is being instantiated:
In this example, using std::false_type might have tipped the compiler to trigger the assertion failure even if the class is not instantiated.
Definition at line 115 of file MetaUtils.h.
| constexpr bool util::always_true_v = true |
A template constant always true.
This is one way to allow to specialize for classes with a certain type:
Definition at line 162 of file MetaUtils.h.
| constexpr unsigned int util::count_type_in_list_v = count_type_in_list<Target, T...>() |
Direct access to the value in count_type_in_list.
Definition at line 107 of file TupleLookupByTag.h.
| constexpr std::size_t util::find_next_type_v = find_next_type<T, StartFrom, Types...>::value |
Definition at line 192 of file MetaUtils.h.
| constexpr std::size_t util::find_type_v = find_type<T, Types...>::value |
Index of the first occurrence of T among the specified Types.
util::find_type Definition at line 217 of file MetaUtils.h.
| constexpr bool util::is_any_of_v = is_any_of<T, Types...>::value |
Whether T is among the specified Types (see util::is_any_of).
Definition at line 234 of file MetaUtils.h.
| constexpr auto util::is_same_decay_v = std::is_same_v<std::decay_t<T>, std::decay_t<U>> |
Whether T and U are the same type, after being applied std::decay.
Definition at line 239 of file MetaUtils.h.
| constexpr bool util::type_is_in_v = type_is_in<Target, T...>() |
Direct access to the value in type_is_in.
Definition at line 123 of file TupleLookupByTag.h.
1.8.11