2 * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
4 * SPDX-License-Identifier: MIT
7 #ifndef BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_SET_HPP
8 #define BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_SET_HPP
11 #include <type_traits>
13 #include <babeltrace2/babeltrace.h>
15 #include "borrowed-object-iterator.hpp"
16 #include "borrowed-object.hpp"
18 #include "integer-range.hpp"
19 #include "internal/utils.hpp"
20 #include "shared-object.hpp"
25 template <typename LibObjT>
26 struct IntegerRangeSetRefFuncs;
29 struct IntegerRangeSetRefFuncs<const bt_integer_range_set_unsigned> final
31 static void get(const bt_integer_range_set_unsigned * const libObjPtr) noexcept
33 bt_integer_range_set_unsigned_get_ref(libObjPtr);
36 static void put(const bt_integer_range_set_unsigned * const libObjPtr) noexcept
38 bt_integer_range_set_unsigned_put_ref(libObjPtr);
43 struct IntegerRangeSetRefFuncs<const bt_integer_range_set_signed> final
45 static void get(const bt_integer_range_set_signed * const libObjPtr) noexcept
47 bt_integer_range_set_signed_get_ref(libObjPtr);
50 static void put(const bt_integer_range_set_signed * const libObjPtr) noexcept
52 bt_integer_range_set_signed_put_ref(libObjPtr);
56 template <typename LibObjT>
57 struct CommonIntegerRangeSetSpec;
59 /* Functions specific to unsigned integer range sets */
61 struct CommonIntegerRangeSetSpec<const bt_integer_range_set_unsigned> final
63 static std::uint64_t length(const bt_integer_range_set_unsigned * const libRangePtr) noexcept
65 return bt_integer_range_set_get_range_count(
66 bt_integer_range_set_unsigned_as_range_set_const(libRangePtr));
69 static const bt_integer_range_unsigned *
70 rangeByIndex(const bt_integer_range_set_unsigned * const libRangePtr,
71 const std::uint64_t index) noexcept
73 return bt_integer_range_set_unsigned_borrow_range_by_index_const(libRangePtr, index);
76 static bool isEqual(const bt_integer_range_set_unsigned * const libRangePtrA,
77 const bt_integer_range_set_unsigned * const libRangePtrB) noexcept
79 return static_cast<bool>(
80 bt_integer_range_set_unsigned_is_equal(libRangePtrA, libRangePtrB));
83 static bt_integer_range_set_add_range_status
84 addRange(bt_integer_range_set_unsigned * const libRangePtr, const std::uint64_t lower,
85 const std::uint64_t upper) noexcept
87 return bt_integer_range_set_unsigned_add_range(libRangePtr, lower, upper);
90 static bt_integer_range_set_unsigned *create() noexcept
92 return bt_integer_range_set_unsigned_create();
96 /* Functions specific to signed integer range sets */
98 struct CommonIntegerRangeSetSpec<const bt_integer_range_set_signed> final
100 static std::uint64_t length(const bt_integer_range_set_signed * const libRangePtr) noexcept
102 return bt_integer_range_set_get_range_count(
103 bt_integer_range_set_signed_as_range_set_const(libRangePtr));
106 static const bt_integer_range_signed *
107 rangeByIndex(const bt_integer_range_set_signed * const libRangePtr,
108 const std::uint64_t index) noexcept
110 return bt_integer_range_set_signed_borrow_range_by_index_const(libRangePtr, index);
113 static bool isEqual(const bt_integer_range_set_signed * const libRangePtrA,
114 const bt_integer_range_set_signed * const libRangePtrB) noexcept
116 return static_cast<bool>(bt_integer_range_set_signed_is_equal(libRangePtrA, libRangePtrB));
119 static bt_integer_range_set_add_range_status
120 addRange(bt_integer_range_set_signed * const libRangePtr, const std::int64_t lower,
121 const std::int64_t upper) noexcept
123 return bt_integer_range_set_signed_add_range(libRangePtr, lower, upper);
126 static bt_integer_range_set_signed *create() noexcept
128 return bt_integer_range_set_signed_create();
132 } /* namespace internal */
134 template <typename LibObjT>
135 class CommonIntegerRangeSet final : public BorrowedObject<LibObjT>
138 using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
139 using typename BorrowedObject<LibObjT>::_LibObjPtr;
140 using _ConstLibObjT = typename std::add_const<LibObjT>::type;
141 using _Spec = internal::CommonIntegerRangeSetSpec<_ConstLibObjT>;
144 using Shared = SharedObject<CommonIntegerRangeSet, LibObjT,
145 internal::IntegerRangeSetRefFuncs<_ConstLibObjT>>;
147 using Range = typename std::conditional<
148 std::is_same<_ConstLibObjT, const bt_integer_range_set_unsigned>::value,
149 ConstUnsignedIntegerRange, ConstSignedIntegerRange>::type;
151 using Value = typename Range::Value;
152 using Iterator = BorrowedObjectIterator<CommonIntegerRangeSet>;
154 explicit CommonIntegerRangeSet(const _LibObjPtr libObjPtr) noexcept :
155 _ThisBorrowedObject {libObjPtr}
159 static Shared create()
161 const auto libObjPtr = _Spec::create();
163 internal::validateCreatedObjPtr(libObjPtr);
164 return CommonIntegerRangeSet::Shared::createWithoutRef(libObjPtr);
167 template <typename OtherLibObjT>
168 CommonIntegerRangeSet(const CommonIntegerRangeSet<OtherLibObjT> rangeSet) noexcept :
169 _ThisBorrowedObject {rangeSet}
173 template <typename OtherLibObjT>
174 CommonIntegerRangeSet operator=(const CommonIntegerRangeSet<OtherLibObjT> rangeSet) noexcept
176 _ThisBorrowedObject::operator=(rangeSet);
180 _ConstLibObjT asConst() const noexcept
182 return _ConstLibObjT {*this};
185 template <typename OtherLibObjT>
186 bool operator==(const CommonIntegerRangeSet<OtherLibObjT> other) const noexcept
188 return _Spec::isEqual(this->libObjPtr(), other.libObjPtr());
191 template <typename OtherLibObjT>
192 bool operator!=(const CommonIntegerRangeSet<OtherLibObjT> other) const noexcept
194 return !(*this == other);
197 void addRange(const Value lower, const Value upper) const
200 !std::is_const<LibObjT>::value,
201 "Not available with `bt2::ConstUnsignedIntegerRangeSet` or `bt2::ConstSignedIntegerRangeSet`.");
203 const auto status = _Spec::addRange(this->libObjPtr(), lower, upper);
205 if (status == BT_INTEGER_RANGE_SET_ADD_RANGE_STATUS_MEMORY_ERROR) {
206 throw MemoryError {};
210 std::uint64_t length() const noexcept
212 return _Spec::length(this->libObjPtr());
215 Range operator[](const std::uint64_t index) const noexcept
217 return Range {_Spec::rangeByIndex(this->libObjPtr(), index)};
220 Iterator begin() const noexcept
222 return Iterator {*this, 0};
225 Iterator end() const noexcept
227 return Iterator {*this, this->length()};
230 Shared shared() const noexcept
232 return Shared::createWithRef(*this);
236 using UnsignedIntegerRangeSet = CommonIntegerRangeSet<bt_integer_range_set_unsigned>;
237 using ConstUnsignedIntegerRangeSet = CommonIntegerRangeSet<const bt_integer_range_set_unsigned>;
238 using SignedIntegerRangeSet = CommonIntegerRangeSet<bt_integer_range_set_signed>;
239 using ConstSignedIntegerRangeSet = CommonIntegerRangeSet<const bt_integer_range_set_signed>;
243 struct UnsignedIntegerRangeSetTypeDescr
245 using Const = ConstUnsignedIntegerRangeSet;
246 using NonConst = UnsignedIntegerRangeSet;
250 struct TypeDescr<UnsignedIntegerRangeSet> : public UnsignedIntegerRangeSetTypeDescr
255 struct TypeDescr<ConstUnsignedIntegerRangeSet> : public UnsignedIntegerRangeSetTypeDescr
259 struct SignedIntegerRangeSetTypeDescr
261 using Const = ConstSignedIntegerRangeSet;
262 using NonConst = SignedIntegerRangeSet;
266 struct TypeDescr<SignedIntegerRangeSet> : public SignedIntegerRangeSetTypeDescr
271 struct TypeDescr<ConstSignedIntegerRangeSet> : public SignedIntegerRangeSetTypeDescr
275 } /* namespace internal */
276 } /* namespace bt2 */
278 #endif /* BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_SET_HPP */