/* * Copyright 2011-present Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // @author: Andrei Alexandrescu #pragma once #include #include #include #include #include // libc++ doesn't provide this header, nor does msvc #if __has_include() // This file appears in two locations: inside fbcode and in the // libstdc++ source code (when embedding fbstring as std::string). // To aid in this schizophrenic use, two macros are defined in // c++config.h: // _LIBSTDCXX_FBSTRING - Set inside libstdc++. This is useful to // gate use inside fbcode v. libstdc++ #include #endif #define FOLLY_CREATE_HAS_MEMBER_TYPE_TRAITS(classname, type_name) \ template \ struct classname##__folly_traits_impl__ { \ template \ static constexpr bool test(typename UTheClass_::type_name*) { \ return true; \ } \ template \ static constexpr bool test(...) { \ return false; \ } \ }; \ template \ using classname = typename std::conditional< \ classname##__folly_traits_impl__::template test( \ nullptr), \ std::true_type, \ std::false_type>::type #define FOLLY_CREATE_HAS_MEMBER_FN_TRAITS_IMPL(classname, func_name, cv_qual) \ template \ struct classname##__folly_traits_impl__< \ TTheClass_, \ RTheReturn_(TTheArgs_...) cv_qual> { \ template < \ typename UTheClass_, \ RTheReturn_ (UTheClass_::*)(TTheArgs_...) cv_qual> \ struct sfinae {}; \ template \ static std::true_type test(sfinae*); \ template \ static std::false_type test(...); \ } /* * The FOLLY_CREATE_HAS_MEMBER_FN_TRAITS is used to create traits * classes that check for the existence of a member function with * a given name and signature. It currently does not support * checking for inherited members. * * Such classes receive two template parameters: the class to be checked * and the signature of the member function. A static boolean field * named `value` (which is also constexpr) tells whether such member * function exists. * * Each traits class created is bound only to the member name, not to * its signature nor to the type of the class containing it. * * Say you need to know if a given class has a member function named * `test` with the following signature: * * int test() const; * * You'd need this macro to create a traits class to check for a member * named `test`, and then use this traits class to check for the signature: * * namespace { * * FOLLY_CREATE_HAS_MEMBER_FN_TRAITS(has_test_traits, test); * * } // unnamed-namespace * * void some_func() { * cout << "Does class Foo have a member int test() const? " * << boolalpha << has_test_traits::value; * } * * You can use the same traits class to test for a completely different * signature, on a completely different class, as long as the member name * is the same: * * void some_func() { * cout << "Does class Foo have a member int test()? " * << boolalpha << has_test_traits::value; * cout << "Does class Foo have a member int test() const? " * << boolalpha << has_test_traits::value; * cout << "Does class Bar have a member double test(const string&, long)? " * << boolalpha << has_test_traits::value; * } * * @author: Marcelo Juchem */ #define FOLLY_CREATE_HAS_MEMBER_FN_TRAITS(classname, func_name) \ template \ struct classname##__folly_traits_impl__; \ FOLLY_CREATE_HAS_MEMBER_FN_TRAITS_IMPL(classname, func_name, ); \ FOLLY_CREATE_HAS_MEMBER_FN_TRAITS_IMPL(classname, func_name, const); \ FOLLY_CREATE_HAS_MEMBER_FN_TRAITS_IMPL( \ classname, func_name, /* nolint */ volatile); \ FOLLY_CREATE_HAS_MEMBER_FN_TRAITS_IMPL( \ classname, func_name, /* nolint */ volatile const); \ template \ using classname = \ decltype(classname##__folly_traits_impl__:: \ template test(nullptr)) namespace folly { #if __cpp_lib_bool_constant || _MSC_VER using std::bool_constant; #else // mimic: std::bool_constant, C++17 template using bool_constant = std::integral_constant; #endif template using index_constant = std::integral_constant; /*** * _t * * Instead of: * * using decayed = typename std::decay::type; * * With the C++14 standard trait aliases, we could use: * * using decayed = std::decay_t; * * Without them, we could use: * * using decayed = _t>; * * Also useful for any other library with template types having dependent * member types named `type`, like the standard trait types. */ template using _t = typename T::type; /** * A type trait to remove all const volatile and reference qualifiers on a * type T */ template struct remove_cvref { using type = typename std::remove_cv::type>::type; }; template using remove_cvref_t = typename remove_cvref::type; namespace detail { template struct like_ { template using apply = Dst; }; template struct like_ { template using apply = Dst const; }; template struct like_ { template using apply = Dst volatile; }; template struct like_ { template using apply = Dst const volatile; }; template struct like_ { template using apply = typename like_::template apply&; }; template struct like_ { template using apply = typename like_::template apply&&; }; } // namespace detail // mimic: like_t, p0847r0 template using like_t = typename detail::like_::template apply>; // mimic: like, p0847r0 template struct like { using type = like_t; }; /** * type_t * * A type alias for the first template type argument. `type_t` is useful for * controlling class-template and function-template partial specialization. * * Example: * * template * class Container { * public: * template * Container( * type_t()...))>, * Args&&...); * }; * * void_t * * A type alias for `void`. `void_t` is useful for controling class-template * and function-template partial specialization. * * Example: * * // has_value_type::value is true if T has a nested type `value_type` * template * struct has_value_type * : std::false_type {}; * * template * struct has_value_type> * : std::true_type {}; */ /** * There is a bug in libstdc++, libc++, and MSVC's STL that causes it to * ignore unused template parameter arguments in template aliases and does not * cause substitution failures. This defect has been recorded here: * http://open-std.org/JTC1/SC22/WG21/docs/cwg_defects.html#1558. * * This causes the implementation of std::void_t to be buggy, as it is likely * defined as something like the following: * * template * using void_t = void; * * This causes the compiler to ignore all the template arguments and does not * help when one wants to cause substitution failures. Rather declarations * which have void_t in orthogonal specializations are treated as the same. * For example, assuming the possible `T` types are only allowed to have * either the alias `one` or `two` and never both or none: * * template ::one>* = nullptr> * void foo(T&&) {} * template ::two>* = nullptr> * void foo(T&&) {} * * The second foo() will be a redefinition because it conflicts with the first * one; void_t does not cause substitution failures - the template types are * just ignored. */ namespace traits_detail { template struct type_t_ { using type = T; }; } // namespace traits_detail template using type_t = typename traits_detail::type_t_::type; template using void_t = type_t; // Older versions of libstdc++ do not provide std::is_trivially_copyable #if defined(__clang__) && !defined(_LIBCPP_VERSION) template struct is_trivially_copyable : bool_constant<__is_trivially_copyable(T)> {}; #elif defined(__GNUC__) && !defined(__clang__) && __GNUC__ < 5 template struct is_trivially_copyable : std::is_trivial {}; #else template using is_trivially_copyable = std::is_trivially_copyable; #endif /** * IsRelocatable::value describes the ability of moving around * memory a value of type T by using memcpy (as opposed to the * conservative approach of calling the copy constructor and then * destroying the old temporary. Essentially for a relocatable type, * the following two sequences of code should be semantically * equivalent: * * void move1(T * from, T * to) { * new(to) T(from); * (*from).~T(); * } * * void move2(T * from, T * to) { * memcpy(to, from, sizeof(T)); * } * * Most C++ types are relocatable; the ones that aren't would include * internal pointers or (very rarely) would need to update remote * pointers to pointers tracking them. All C++ primitive types and * type constructors are relocatable. * * This property can be used in a variety of optimizations. Currently * fbvector uses this property intensively. * * The default conservatively assumes the type is not * relocatable. Several specializations are defined for known * types. You may want to add your own specializations. Do so in * namespace folly and make sure you keep the specialization of * IsRelocatable in the same header as SomeStruct. * * You may also declare a type to be relocatable by including * `typedef std::true_type IsRelocatable;` * in the class header. * * It may be unset in a base class by overriding the typedef to false_type. */ /* * IsZeroInitializable describes the property that default construction is the * same as memset(dst, 0, sizeof(T)). */ namespace traits_detail { #define FOLLY_HAS_TRUE_XXX(name) \ FOLLY_CREATE_HAS_MEMBER_TYPE_TRAITS(has_##name, name); \ template \ struct name##_is_true : std::is_same {}; \ template \ struct has_true_##name : std::conditional< \ has_##name::value, \ name##_is_true, \ std::false_type>::type {} FOLLY_HAS_TRUE_XXX(IsRelocatable); FOLLY_HAS_TRUE_XXX(IsZeroInitializable); #undef FOLLY_HAS_TRUE_XXX } // namespace traits_detail struct Ignore { Ignore() = default; template constexpr /* implicit */ Ignore(const T&) {} template const Ignore& operator=(T const&) const { return *this; } }; template using Ignored = Ignore; namespace traits_detail_IsEqualityComparable { Ignore operator==(Ignore, Ignore); template struct IsEqualityComparable : std::is_convertible< decltype(std::declval() == std::declval()), bool> {}; } // namespace traits_detail_IsEqualityComparable /* using override */ using traits_detail_IsEqualityComparable:: IsEqualityComparable; namespace traits_detail_IsLessThanComparable { Ignore operator<(Ignore, Ignore); template struct IsLessThanComparable : std::is_convertible< decltype(std::declval() < std::declval()), bool> {}; } // namespace traits_detail_IsLessThanComparable /* using override */ using traits_detail_IsLessThanComparable:: IsLessThanComparable; namespace traits_detail_IsNothrowSwappable { #if defined(__cpp_lib_is_swappable) || (_CPPLIB_VER && _HAS_CXX17) // MSVC 2015+ already implements the C++17 P0185R1 proposal which // adds std::is_nothrow_swappable, so use it instead if C++17 mode // is enabled. template using IsNothrowSwappable = std::is_nothrow_swappable; #elif _CPPLIB_VER // MSVC 2015+ defines the base even if C++17 is disabled, and // MSVC 2015 has issues with our fallback implementation due to // over-eager evaluation of noexcept. template using IsNothrowSwappable = std::_Is_nothrow_swappable; #else /* using override */ using std::swap; template struct IsNothrowSwappable : bool_constant::value&& noexcept( swap(std::declval(), std::declval()))> {}; #endif } // namespace traits_detail_IsNothrowSwappable /* using override */ using traits_detail_IsNothrowSwappable::IsNothrowSwappable; template struct IsRelocatable : std::conditional< traits_detail::has_IsRelocatable::value, traits_detail::has_true_IsRelocatable, // TODO add this line (and some tests for it) when we // upgrade to gcc 4.7 // std::is_trivially_move_constructible::value || is_trivially_copyable>::type {}; template struct IsZeroInitializable : std::conditional< traits_detail::has_IsZeroInitializable::value, traits_detail::has_true_IsZeroInitializable, bool_constant::value>>::type {}; template struct Conjunction : std::true_type {}; template struct Conjunction : T {}; template struct Conjunction : std::conditional, T>::type {}; template struct Disjunction : std::false_type {}; template struct Disjunction : T {}; template struct Disjunction : std::conditional>::type {}; template struct Negation : bool_constant {}; template struct Bools { using valid_type = bool; static constexpr std::size_t size() { return sizeof...(Bs); } }; // Lighter-weight than Conjunction, but evaluates all sub-conditions eagerly. template struct StrictConjunction : std::is_same, Bools<(Ts::value || true)...>> {}; template struct StrictDisjunction : Negation< std::is_same, Bools<(Ts::value && false)...>>> {}; } // namespace folly /** * Use this macro ONLY inside namespace folly. When using it with a * regular type, use it like this: * * // Make sure you're at namespace ::folly scope * template <> FOLLY_ASSUME_RELOCATABLE(MyType) * * When using it with a template type, use it like this: * * // Make sure you're at namespace ::folly scope * template * FOLLY_ASSUME_RELOCATABLE(MyType) */ #define FOLLY_ASSUME_RELOCATABLE(...) \ struct IsRelocatable<__VA_ARGS__> : std::true_type {} /** * The FOLLY_ASSUME_FBVECTOR_COMPATIBLE* macros below encode the * assumption that the type is relocatable per IsRelocatable * above. Many types can be assumed to satisfy this condition, but * it is the responsibility of the user to state that assumption. * User-defined classes will not be optimized for use with * fbvector (see FBVector.h) unless they state that assumption. * * Use FOLLY_ASSUME_FBVECTOR_COMPATIBLE with regular types like this: * * FOLLY_ASSUME_FBVECTOR_COMPATIBLE(MyType) * * The versions FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1, _2, _3, and _4 * allow using the macro for describing templatized classes with 1, 2, * 3, and 4 template parameters respectively. For template classes * just use the macro with the appropriate number and pass the name of * the template to it. Example: * * template class MyType { ... }; * ... * // Make sure you're at global scope * FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(MyType) */ // Use this macro ONLY at global level (no namespace) #define FOLLY_ASSUME_FBVECTOR_COMPATIBLE(...) \ namespace folly { \ template <> \ FOLLY_ASSUME_RELOCATABLE(__VA_ARGS__); \ } // Use this macro ONLY at global level (no namespace) #define FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1(...) \ namespace folly { \ template \ FOLLY_ASSUME_RELOCATABLE(__VA_ARGS__); \ } // Use this macro ONLY at global level (no namespace) #define FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(...) \ namespace folly { \ template \ FOLLY_ASSUME_RELOCATABLE(__VA_ARGS__); \ } // Use this macro ONLY at global level (no namespace) #define FOLLY_ASSUME_FBVECTOR_COMPATIBLE_3(...) \ namespace folly { \ template \ FOLLY_ASSUME_RELOCATABLE(__VA_ARGS__); \ } // Use this macro ONLY at global level (no namespace) #define FOLLY_ASSUME_FBVECTOR_COMPATIBLE_4(...) \ namespace folly { \ template \ FOLLY_ASSUME_RELOCATABLE(__VA_ARGS__); \ } /** * Instantiate FOLLY_ASSUME_FBVECTOR_COMPATIBLE for a few types. It is * safe to assume that pair is compatible if both of its components * are. Furthermore, all STL containers can be assumed to comply, * although that is not guaranteed by the standard. */ FOLLY_NAMESPACE_STD_BEGIN template struct pair; #ifndef _GLIBCXX_USE_FB FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN template class basic_string; FOLLY_GLIBCXX_NAMESPACE_CXX11_END #else template class basic_string; #endif template class vector; template class deque; template class set; template class map; template class shared_ptr; FOLLY_NAMESPACE_STD_END namespace folly { // STL commonly-used types template struct IsRelocatable> : bool_constant::value && IsRelocatable::value> {}; // Is T one of T1, T2, ..., Tn? template using IsOneOf = StrictDisjunction...>; /* * Complementary type traits for integral comparisons. * * For instance, `if(x < 0)` yields an error in clang for unsigned types * when -Werror is used due to -Wtautological-compare * * * @author: Marcelo Juchem */ namespace detail { template struct is_negative_impl { constexpr static bool check(T x) { return x < 0; } }; template struct is_negative_impl { constexpr static bool check(T) { return false; } }; // folly::to integral specializations can end up generating code // inside what are really static ifs (not executed because of the templated // types) that violate -Wsign-compare and/or -Wbool-compare so suppress them // in order to not prevent all calling code from using it. FOLLY_PUSH_WARNING FOLLY_GNU_DISABLE_WARNING("-Wsign-compare") #if __GNUC_PREREQ(5, 0) FOLLY_GNU_DISABLE_WARNING("-Wbool-compare") #endif FOLLY_MSVC_DISABLE_WARNING(4388) // sign-compare FOLLY_MSVC_DISABLE_WARNING(4804) // bool-compare template bool less_than_impl(LHS const lhs) { // clang-format off return rhs > std::numeric_limits::max() ? true : rhs <= std::numeric_limits::min() ? false : lhs < rhs; // clang-format on } template bool greater_than_impl(LHS const lhs) { // clang-format off return rhs > std::numeric_limits::max() ? false : rhs < std::numeric_limits::min() ? true : lhs > rhs; // clang-format on } FOLLY_POP_WARNING } // namespace detail // same as `x < 0` template constexpr bool is_negative(T x) { return folly::detail::is_negative_impl::value>::check(x); } // same as `x <= 0` template constexpr bool is_non_positive(T x) { return !x || folly::is_negative(x); } // same as `x > 0` template constexpr bool is_positive(T x) { return !is_non_positive(x); } // same as `x >= 0` template constexpr bool is_non_negative(T x) { return !x || is_positive(x); } template bool less_than(LHS const lhs) { return detail:: less_than_impl::type>(lhs); } template bool greater_than(LHS const lhs) { return detail:: greater_than_impl::type>( lhs); } } // namespace folly // Assume nothing when compiling with MSVC. #ifndef _MSC_VER // gcc-5.0 changed string's implementation in libstdc++ to be non-relocatable #if !_GLIBCXX_USE_CXX11_ABI FOLLY_ASSUME_FBVECTOR_COMPATIBLE_3(std::basic_string) #endif FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(std::vector) FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(std::deque) FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(std::unique_ptr) FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1(std::shared_ptr) FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1(std::function) #endif /* Some combinations of compilers and C++ libraries make __int128 and * unsigned __int128 available but do not correctly define their standard type * traits. * * If FOLLY_SUPPLY_MISSING_INT128_TRAITS is defined, we define these traits * here. * * @author: Phil Willoughby */ #if FOLLY_SUPPLY_MISSING_INT128_TRAITS FOLLY_NAMESPACE_STD_BEGIN template <> struct is_arithmetic<__int128> : ::std::true_type {}; template <> struct is_arithmetic : ::std::true_type {}; template <> struct is_integral<__int128> : ::std::true_type {}; template <> struct is_integral : ::std::true_type {}; template <> struct make_unsigned<__int128> { typedef unsigned __int128 type; }; template <> struct make_signed<__int128> { typedef __int128 type; }; template <> struct make_unsigned { typedef unsigned __int128 type; }; template <> struct make_signed { typedef __int128 type; }; template <> struct is_signed<__int128> : ::std::true_type {}; template <> struct is_unsigned : ::std::true_type {}; FOLLY_NAMESPACE_STD_END #endif // FOLLY_SUPPLY_MISSING_INT128_TRAITS