1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* Iterator over ranges of integers */
#ifndef mozilla_IntegerRange_h
#define mozilla_IntegerRange_h
#include "mozilla/Assertions.h"
#include "mozilla/ReverseIterator.h"
#include <iterator>
#include <type_traits>
namespace mozilla {
namespace detail {
template <typename IntTypeT>
class IntegerIterator {
public:
// It is disputable whether these type definitions are correct, since
// operator* doesn't return a reference at all. Also, the iterator_category
// can be at most std::input_iterator_tag (rather than
// std::bidrectional_iterator_tag, as it might seem), because it is a stashing
// iterator. See also, e.g.,
// https://stackoverflow.com/questions/50909701/what-should-be-iterator-category-for-a-stashing-iterator
using value_type = const IntTypeT;
using pointer = const value_type*;
using reference = const value_type&;
using difference_type = std::make_signed_t<IntTypeT>;
using iterator_category = std::input_iterator_tag;
template <typename IntType>
explicit IntegerIterator(IntType aCurrent) : mCurrent(aCurrent) {}
template <typename IntType>
explicit IntegerIterator(const IntegerIterator<IntType>& aOther)
: mCurrent(aOther.mCurrent) {}
// This intentionally returns a value rather than a reference, to make
// mozilla::ReverseIterator work with it. Still, std::reverse_iterator cannot
// be used with IntegerIterator because it still is a "stashing iterator". See
// Bug 1175485.
IntTypeT operator*() const { return mCurrent; }
/* Increment and decrement operators */
IntegerIterator& operator++() {
++mCurrent;
return *this;
}
IntegerIterator& operator--() {
--mCurrent;
return *this;
}
IntegerIterator operator++(int) {
auto ret = *this;
++mCurrent;
return ret;
}
IntegerIterator operator--(int) {
auto ret = *this;
--mCurrent;
return ret;
}
/* Comparison operators */
friend bool operator==(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent == aIter2.mCurrent;
}
friend bool operator!=(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent != aIter2.mCurrent;
}
friend bool operator<(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent < aIter2.mCurrent;
}
friend bool operator<=(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent <= aIter2.mCurrent;
}
friend bool operator>(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent > aIter2.mCurrent;
}
friend bool operator>=(const IntegerIterator<IntTypeT>& aIter1,
const IntegerIterator<IntTypeT>& aIter2) {
return aIter1.mCurrent >= aIter2.mCurrent;
}
private:
IntTypeT mCurrent;
};
template <typename IntTypeT>
class IntegerRange {
public:
typedef IntegerIterator<IntTypeT> iterator;
typedef IntegerIterator<IntTypeT> const_iterator;
typedef ReverseIterator<IntegerIterator<IntTypeT>> reverse_iterator;
typedef ReverseIterator<IntegerIterator<IntTypeT>> const_reverse_iterator;
template <typename IntType>
explicit IntegerRange(IntType aEnd) : mBegin(0), mEnd(aEnd) {}
template <typename IntType1, typename IntType2>
IntegerRange(IntType1 aBegin, IntType2 aEnd) : mBegin(aBegin), mEnd(aEnd) {}
iterator begin() const { return iterator(mBegin); }
const_iterator cbegin() const { return begin(); }
iterator end() const { return iterator(mEnd); }
const_iterator cend() const { return end(); }
reverse_iterator rbegin() const { return reverse_iterator(iterator(mEnd)); }
const_reverse_iterator crbegin() const { return rbegin(); }
reverse_iterator rend() const { return reverse_iterator(iterator(mBegin)); }
const_reverse_iterator crend() const { return rend(); }
private:
IntTypeT mBegin;
IntTypeT mEnd;
};
} // namespace detail
template <typename IntType>
detail::IntegerRange<IntType> IntegerRange(IntType aEnd) {
static_assert(std::is_integral_v<IntType>, "value must be integral");
if constexpr (std::is_signed_v<IntType>) {
MOZ_ASSERT(aEnd >= 0, "Should never have negative value here");
}
return detail::IntegerRange<IntType>(aEnd);
}
template <typename IntType1, typename IntType2>
detail::IntegerRange<IntType2> IntegerRange(IntType1 aBegin, IntType2 aEnd) {
static_assert(std::is_integral_v<IntType1> && std::is_integral_v<IntType2>,
"values must both be integral");
static_assert(std::is_signed_v<IntType1> == std::is_signed_v<IntType2>,
"signed/unsigned mismatch");
MOZ_ASSERT(aEnd >= aBegin, "End value should be larger than begin value");
return detail::IntegerRange<IntType2>(aBegin, aEnd);
}
} // namespace mozilla
#endif // mozilla_IntegerRange_h
|