diff options
Diffstat (limited to 'webrtc/base/array_view.h')
-rw-r--r-- | webrtc/base/array_view.h | 75 |
1 files changed, 62 insertions, 13 deletions
diff --git a/webrtc/base/array_view.h b/webrtc/base/array_view.h index 019bd8b6c6..a7ca66cc95 100644 --- a/webrtc/base/array_view.h +++ b/webrtc/base/array_view.h @@ -11,18 +11,63 @@ #ifndef WEBRTC_BASE_ARRAY_VIEW_H_ #define WEBRTC_BASE_ARRAY_VIEW_H_ -#include <vector> - #include "webrtc/base/checks.h" namespace rtc { -// Keeps track of an array (a pointer and a size) that it doesn't own. -// ArrayView objects are immutable except for assignment, and small enough to -// be cheaply passed by value. +// Many functions read from or write to arrays. The obvious way to do this is +// to use two arguments, a pointer to the first element and an element count: +// +// bool Contains17(const int* arr, size_t size) { +// for (size_t i = 0; i < size; ++i) { +// if (arr[i] == 17) +// return true; +// } +// return false; +// } +// +// This is flexible, since it doesn't matter how the array is stored (C array, +// std::vector, rtc::Buffer, ...), but it's error-prone because the caller has +// to correctly specify the array length: +// +// Contains17(arr, arraysize(arr)); // C array +// Contains17(&arr[0], arr.size()); // std::vector +// Contains17(arr, size); // pointer + size +// ... +// +// It's also kind of messy to have two separate arguments for what is +// conceptually a single thing. +// +// Enter rtc::ArrayView<T>. It contains a T pointer (to an array it doesn't +// own) and a count, and supports the basic things you'd expect, such as +// indexing and iteration. It allows us to write our function like this: +// +// bool Contains17(rtc::ArrayView<const int> arr) { +// for (auto e : arr) { +// if (e == 17) +// return true; +// } +// return false; +// } // -// Note that ArrayView<T> and ArrayView<const T> are distinct types; this is -// how you would represent mutable and unmutable views of an array. +// And even better, because a bunch of things will implicitly convert to +// ArrayView, we can call it like this: +// +// Contains17(arr); // C array +// Contains17(arr); // std::vector +// Contains17(rtc::ArrayView<int>(arr, size)); // pointer + size +// ... +// +// One important point is that ArrayView<T> and ArrayView<const T> are +// different types, which allow and don't allow mutation of the array elements, +// respectively. The implicit conversions work just like you'd hope, so that +// e.g. vector<int> will convert to either ArrayView<int> or ArrayView<const +// int>, but const vector<int> will convert only to ArrayView<const int>. +// (ArrayView itself can be the source type in such conversions, so +// ArrayView<int> will convert to ArrayView<const int>.) +// +// Note: ArrayView is tiny (just a pointer and a count) and trivially copyable, +// so it's probably cheaper to pass it by value than by const reference. template <typename T> class ArrayView final { public: @@ -50,17 +95,12 @@ class ArrayView final { // std::vector). template <typename U> ArrayView(U& u) : ArrayView(u.data(), u.size()) {} - // TODO(kwiberg): Remove the special case for std::vector (and the include of - // <vector>); it is handled by the general case in C++11, since std::vector - // has a data() method there. - template <typename U> - ArrayView(std::vector<U>& u) - : ArrayView(u.empty() ? nullptr : &u[0], u.size()) {} // Indexing, size, and iteration. These allow mutation even if the ArrayView // is const, because the ArrayView doesn't own the array. (To prevent // mutation, use ArrayView<const T>.) size_t size() const { return size_; } + bool empty() const { return size_ == 0; } T* data() const { return data_; } T& operator[](size_t idx) const { RTC_DCHECK_LT(idx, size_); @@ -72,6 +112,15 @@ class ArrayView final { const T* cbegin() const { return data_; } const T* cend() const { return data_ + size_; } + // Comparing two ArrayViews compares their (pointer,size) pairs; it does + // *not* dereference the pointers. + friend bool operator==(const ArrayView& a, const ArrayView& b) { + return a.data_ == b.data_ && a.size_ == b.size_; + } + friend bool operator!=(const ArrayView& a, const ArrayView& b) { + return !(a == b); + } + private: // Invariant: !data_ iff size_ == 0. void CheckInvariant() const { RTC_DCHECK_EQ(!data_, size_ == 0); } |