src/cpp-common/bt2/integer-range.hpp

   1 /*
   2  * Copyright (c) 2020 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * SPDX-License-Identifier: MIT
   5  */
   6
   7 #ifndef BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_HPP
   8 #define BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_HPP
   9
  10 #include <cstdint>
  11 #include <type_traits>
  12
  13 #include <babeltrace2/babeltrace.h>
  14
  15 #include "borrowed-object.hpp"
  16
  17 namespace bt2 {
  18 namespace internal {
  19
  20 template <typename ValueT>
  21 struct ConstIntegerRangeSpec;
  22
  23 /* Functions specific to unsigned integer ranges */
  24 template <>
  25 struct ConstIntegerRangeSpec<const bt_integer_range_unsigned> final
  26 {
  27     static std::uint64_t lower(const bt_integer_range_unsigned * const libRangePtr) noexcept
  28     {
  29         return bt_integer_range_unsigned_get_lower(libRangePtr);
  30     }
  31
  32     static std::uint64_t upper(const bt_integer_range_unsigned * const libRangePtr) noexcept
  33     {
  34         return bt_integer_range_unsigned_get_upper(libRangePtr);
  35     }
  36
  37     static bool isEqual(const bt_integer_range_unsigned * const libRangePtrA,
  38                         const bt_integer_range_unsigned * const libRangePtrB) noexcept
  39     {
  40         return static_cast<bool>(bt_integer_range_unsigned_is_equal(libRangePtrA, libRangePtrB));
  41     }
  42 };
  43
  44 /* Functions specific to signed integer ranges */
  45 template <>
  46 struct ConstIntegerRangeSpec<const bt_integer_range_signed> final
  47 {
  48     static std::int64_t lower(const bt_integer_range_signed * const libRangePtr) noexcept
  49     {
  50         return bt_integer_range_signed_get_lower(libRangePtr);
  51     }
  52
  53     static std::int64_t upper(const bt_integer_range_signed * const libRangePtr) noexcept
  54     {
  55         return bt_integer_range_signed_get_upper(libRangePtr);
  56     }
  57
  58     static bool isEqual(const bt_integer_range_signed * const libRangePtrA,
  59                         const bt_integer_range_signed * const libRangePtrB) noexcept
  60     {
  61         return static_cast<bool>(bt_integer_range_signed_is_equal(libRangePtrA, libRangePtrB));
  62     }
  63 };
  64
  65 } /* namespace internal */
  66
  67 template <typename LibObjT>
  68 class ConstIntegerRange final : public BorrowedObject<LibObjT>
  69 {
  70 private:
  71     using typename BorrowedObject<LibObjT>::_ThisBorrowedObject;
  72
  73 public:
  74     using typename BorrowedObject<LibObjT>::LibObjPtr;
  75
  76     using Value =
  77         typename std::conditional<std::is_same<LibObjT, const bt_integer_range_unsigned>::value,
  78                                   std::uint64_t, std::int64_t>::type;
  79
  80 public:
  81     explicit ConstIntegerRange(const LibObjPtr libObjPtr) noexcept : _ThisBorrowedObject {libObjPtr}
  82     {
  83     }
  84
  85     bool operator==(const ConstIntegerRange& other) const noexcept
  86     {
  87         return internal::ConstIntegerRangeSpec<LibObjT>::isEqual(this->libObjPtr(),
  88                                                                  other.libObjPtr());
  89     }
  90
  91     bool operator!=(const ConstIntegerRange& other) const noexcept
  92     {
  93         return !(*this == other);
  94     }
  95
  96     Value lower() const noexcept
  97     {
  98         return internal::ConstIntegerRangeSpec<LibObjT>::lower(this->libObjPtr());
  99     }
 100
 101     Value upper() const noexcept
 102     {
 103         return internal::ConstIntegerRangeSpec<LibObjT>::upper(this->libObjPtr());
 104     }
 105 };
 106
 107 using ConstUnsignedIntegerRange = ConstIntegerRange<const bt_integer_range_unsigned>;
 108 using ConstSignedIntegerRange = ConstIntegerRange<const bt_integer_range_signed>;
 109
 110 } /* namespace bt2 */
 111
 112 #endif /* BABELTRACE_CPP_COMMON_BT2_INTEGER_RANGE_HPP */