2 (C) Copyright 2009-2011 Frederic Bron.
3 Distributed under the Boost Software License, Version 1.0.
4 (See accompanying file LICENSE_1_0.txt or copy at
5 http://www.boost.org/LICENSE_1_0.txt).
8 [section:has_bit_or has_bit_or]
9 template <class Lhs, class Rhs=Lhs, class Ret=dont_care>
10 struct has_bit_or : public __tof {};
13 If (i) `lhs` of type `Lhs` and `rhs` of type `Rhs` can be used in expression `lhs|rhs`,
14 and (ii) `Ret=dont_care` or the result of expression `lhs|rhs` is convertible to `Ret`
15 then inherits from __true_type,
16 otherwise inherits from __false_type.
18 The default behaviour (`Ret=dont_care`) is to not check for the return value of binary `operator|`.
19 If `Ret` is different from the default `dont_care` type, the return value is checked to be convertible to `Ret`.
20 Convertible to `Ret` means that the return value of the operator can be used as argument to a function expecting `Ret`:
25 f(lhs|rhs); // is valid if has_bit_or<Lhs, Rhs, Ret>::value==true
27 If `Ret=void`, the return type is checked to be exactly `void`.
29 __header `#include <boost/type_traits/has_bit_or.hpp>` or `#include <boost/type_traits/has_operator.hpp>` or `#include <boost/type_traits.hpp>`
31 [has_binary_operator_compat]
35 [:`has_bit_or<Lhs, Rhs, Ret>::value_type` is the type `bool`.]
36 [:`has_bit_or<Lhs, Rhs, Ret>::value` is a `bool` integral constant expression.]
37 [:`has_bit_or<int>::value` is a `bool` integral constant expression that evaluates to `true`.]
38 [:`has_bit_or<long>` inherits from `__true_type`.]
40 [:`has_bit_or<int, int, int>` inherits from `__true_type`.]
41 [:`has_bit_or<const int, int>` inherits from `__true_type`.]
43 [:`has_bit_or<int, double, bool>` inherits from `__false_type`.]
44 [:`has_bit_or<int, int, std::string>` inherits from `__false_type`.]
47 [*See also:] [link boost_typetraits.category.value_traits.operators Operator Type Traits]
51 * This trait cannot detect whether binary `operator|` is public or not:
52 if `operator|` is defined as a private member of `Lhs` then
53 instantiating `has_bit_or<Lhs>` will produce a compiler error.
54 For this reason `has_bit_or` cannot be used to determine whether a type has a public `operator|` or not.
56 struct A { private: void operator|(const A&); };
57 boost::has_bit_or<A>::value; // error: A::operator|(const A&) is private
60 * There is an issue if the operator exists only for type `A` and `B` is
61 convertible to `A`. In this case, the compiler will report an ambiguous overload.
64 void operator|(const A&, const A&);
65 struct B { operator A(); };
66 boost::has_bit_or<A>::value; // this is fine
67 boost::has_bit_or<B>::value; // error: ambiguous overload
70 * There is an issue when applying this trait to template classes.
71 If `operator|` is defined but does not bind for a given template type,
72 it is still detected by the trait which returns `true` instead of `false`.
75 #include <boost/type_traits/has_bit_or.hpp>
79 struct contains { T data; };
82 bool operator|(const contains<T> &lhs, const contains<T> &rhs) {
83 return f(lhs.data, rhs.data);
88 bool f(const good&, const good&) { }
91 std::cout<<std::boolalpha;
92 // works fine for contains<good>
93 std::cout<<boost::has_bit_or< contains< good > >::value<<'\n'; // true
96 // does not work for contains<bad>
97 std::cout<<boost::has_bit_or< contains< bad > >::value<<'\n'; // true, should be false
99 b|b; // compile time error
104 * `volatile` qualifier is not properly handled and would lead to undefined behavior