include/llvm/ADT/ArrayRef.h

   1 //===--- ArrayRef.h - Array Reference Wrapper -------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_ADT_ARRAYREF_H
  11 #define LLVM_ADT_ARRAYREF_H
  12
  13 #include "llvm/ADT/None.h"
  14 #include "llvm/ADT/SmallVector.h"
  15 #include <vector>
  16
  17 namespace llvm {
  18
  19   /// ArrayRef - Represent a constant reference to an array (0 or more elements
  20   /// consecutively in memory), i.e. a start pointer and a length.  It allows
  21   /// various APIs to take consecutive elements easily and conveniently.
  22   ///
  23   /// This class does not own the underlying data, it is expected to be used in
  24   /// situations where the data resides in some other buffer, whose lifetime
  25   /// extends past that of the ArrayRef. For this reason, it is not in general
  26   /// safe to store an ArrayRef.
  27   ///
  28   /// This is intended to be trivially copyable, so it should be passed by
  29   /// value.
  30   template<typename T>
  31   class ArrayRef {
  32   public:
  33     typedef const T *iterator;
  34     typedef const T *const_iterator;
  35     typedef size_t size_type;
  36
  37     typedef std::reverse_iterator<iterator> reverse_iterator;
  38
  39   private:
  40     /// The start of the array, in an external buffer.
  41     const T *Data;
  42
  43     /// The number of elements.
  44     size_type Length;
  45
  46   public:
  47     /// @name Constructors
  48     /// @{
  49
  50     /// Construct an empty ArrayRef.
  51     /*implicit*/ ArrayRef() : Data(nullptr), Length(0) {}
  52
  53     /// Construct an empty ArrayRef from None.
  54     /*implicit*/ ArrayRef(NoneType) : Data(nullptr), Length(0) {}
  55
  56     /// Construct an ArrayRef from a single element.
  57     /*implicit*/ ArrayRef(const T &OneElt)
  58       : Data(&OneElt), Length(1) {}
  59
  60     /// Construct an ArrayRef from a pointer and length.
  61     /*implicit*/ ArrayRef(const T *data, size_t length)
  62       : Data(data), Length(length) {}
  63
  64     /// Construct an ArrayRef from a range.
  65     ArrayRef(const T *begin, const T *end)
  66       : Data(begin), Length(end - begin) {}
  67
  68     /// Construct an ArrayRef from a SmallVector. This is templated in order to
  69     /// avoid instantiating SmallVectorTemplateCommon<T> whenever we
  70     /// copy-construct an ArrayRef.
  71     template<typename U>
  72     /*implicit*/ ArrayRef(const SmallVectorTemplateCommon<T, U> &Vec)
  73       : Data(Vec.data()), Length(Vec.size()) {
  74     }
  75
  76     /// Construct an ArrayRef from a std::vector.
  77     template<typename A>
  78     /*implicit*/ ArrayRef(const std::vector<T, A> &Vec)
  79       : Data(Vec.data()), Length(Vec.size()) {}
  80
  81     /// Construct an ArrayRef from a C array.
  82     template <size_t N>
  83     /*implicit*/ LLVM_CONSTEXPR ArrayRef(const T (&Arr)[N])
  84       : Data(Arr), Length(N) {}
  85
  86 #if LLVM_HAS_INITIALIZER_LISTS
  87     /// Construct an ArrayRef from a std::initializer_list.
  88     /*implicit*/ ArrayRef(const std::initializer_list<T> &Vec)
  89     : Data(Vec.begin() == Vec.end() ? (T*)0 : Vec.begin()),
  90       Length(Vec.size()) {}
  91 #endif
  92
  93     /// @}
  94     /// @name Simple Operations
  95     /// @{
  96
  97     iterator begin() const { return Data; }
  98     iterator end() const { return Data + Length; }
  99
 100     reverse_iterator rbegin() const { return reverse_iterator(end()); }
 101     reverse_iterator rend() const { return reverse_iterator(begin()); }
 102
 103     /// empty - Check if the array is empty.
 104     bool empty() const { return Length == 0; }
 105
 106     const T *data() const { return Data; }
 107
 108     /// size - Get the array size.
 109     size_t size() const { return Length; }
 110
 111     /// front - Get the first element.
 112     const T &front() const {
 113       assert(!empty());
 114       return Data[0];
 115     }
 116
 117     /// back - Get the last element.
 118     const T &back() const {
 119       assert(!empty());
 120       return Data[Length-1];
 121     }
 122
 123     // copy - Allocate copy in Allocator and return ArrayRef<T> to it.
 124     template <typename Allocator> ArrayRef<T> copy(Allocator &A) {
 125       T *Buff = A.template Allocate<T>(Length);
 126       std::copy(begin(), end(), Buff);
 127       return ArrayRef<T>(Buff, Length);
 128     }
 129
 130     /// equals - Check for element-wise equality.
 131     bool equals(ArrayRef RHS) const {
 132       if (Length != RHS.Length)
 133         return false;
 134       return std::equal(begin(), end(), RHS.begin());
 135     }
 136
 137     /// slice(n) - Chop off the first N elements of the array.
 138     ArrayRef<T> slice(unsigned N) const {
 139       assert(N <= size() && "Invalid specifier");
 140       return ArrayRef<T>(data()+N, size()-N);
 141     }
 142
 143     /// slice(n, m) - Chop off the first N elements of the array, and keep M
 144     /// elements in the array.
 145     ArrayRef<T> slice(unsigned N, unsigned M) const {
 146       assert(N+M <= size() && "Invalid specifier");
 147       return ArrayRef<T>(data()+N, M);
 148     }
 149
 150     /// @}
 151     /// @name Operator Overloads
 152     /// @{
 153     const T &operator[](size_t Index) const {
 154       assert(Index < Length && "Invalid index!");
 155       return Data[Index];
 156     }
 157
 158     /// @}
 159     /// @name Expensive Operations
 160     /// @{
 161     std::vector<T> vec() const {
 162       return std::vector<T>(Data, Data+Length);
 163     }
 164
 165     /// @}
 166     /// @name Conversion operators
 167     /// @{
 168     operator std::vector<T>() const {
 169       return std::vector<T>(Data, Data+Length);
 170     }
 171
 172     /// @}
 173   };
 174
 175   /// MutableArrayRef - Represent a mutable reference to an array (0 or more
 176   /// elements consecutively in memory), i.e. a start pointer and a length.  It
 177   /// allows various APIs to take and modify consecutive elements easily and
 178   /// conveniently.
 179   ///
 180   /// This class does not own the underlying data, it is expected to be used in
 181   /// situations where the data resides in some other buffer, whose lifetime
 182   /// extends past that of the MutableArrayRef. For this reason, it is not in
 183   /// general safe to store a MutableArrayRef.
 184   ///
 185   /// This is intended to be trivially copyable, so it should be passed by
 186   /// value.
 187   template<typename T>
 188   class MutableArrayRef : public ArrayRef<T> {
 189   public:
 190     typedef T *iterator;
 191
 192     typedef std::reverse_iterator<iterator> reverse_iterator;
 193
 194     /// Construct an empty MutableArrayRef.
 195     /*implicit*/ MutableArrayRef() : ArrayRef<T>() {}
 196
 197     /// Construct an empty MutableArrayRef from None.
 198     /*implicit*/ MutableArrayRef(NoneType) : ArrayRef<T>() {}
 199
 200     /// Construct an MutableArrayRef from a single element.
 201     /*implicit*/ MutableArrayRef(T &OneElt) : ArrayRef<T>(OneElt) {}
 202
 203     /// Construct an MutableArrayRef from a pointer and length.
 204     /*implicit*/ MutableArrayRef(T *data, size_t length)
 205       : ArrayRef<T>(data, length) {}
 206
 207     /// Construct an MutableArrayRef from a range.
 208     MutableArrayRef(T *begin, T *end) : ArrayRef<T>(begin, end) {}
 209
 210     /// Construct an MutableArrayRef from a SmallVector.
 211     /*implicit*/ MutableArrayRef(SmallVectorImpl<T> &Vec)
 212     : ArrayRef<T>(Vec) {}
 213
 214     /// Construct a MutableArrayRef from a std::vector.
 215     /*implicit*/ MutableArrayRef(std::vector<T> &Vec)
 216     : ArrayRef<T>(Vec) {}
 217
 218     /// Construct an MutableArrayRef from a C array.
 219     template <size_t N>
 220     /*implicit*/ LLVM_CONSTEXPR MutableArrayRef(T (&Arr)[N])
 221       : ArrayRef<T>(Arr) {}
 222
 223     T *data() const { return const_cast<T*>(ArrayRef<T>::data()); }
 224
 225     iterator begin() const { return data(); }
 226     iterator end() const { return data() + this->size(); }
 227
 228     reverse_iterator rbegin() const { return reverse_iterator(end()); }
 229     reverse_iterator rend() const { return reverse_iterator(begin()); }
 230
 231     /// front - Get the first element.
 232     T &front() const {
 233       assert(!this->empty());
 234       return data()[0];
 235     }
 236
 237     /// back - Get the last element.
 238     T &back() const {
 239       assert(!this->empty());
 240       return data()[this->size()-1];
 241     }
 242
 243     /// slice(n) - Chop off the first N elements of the array.
 244     MutableArrayRef<T> slice(unsigned N) const {
 245       assert(N <= this->size() && "Invalid specifier");
 246       return MutableArrayRef<T>(data()+N, this->size()-N);
 247     }
 248
 249     /// slice(n, m) - Chop off the first N elements of the array, and keep M
 250     /// elements in the array.
 251     MutableArrayRef<T> slice(unsigned N, unsigned M) const {
 252       assert(N+M <= this->size() && "Invalid specifier");
 253       return MutableArrayRef<T>(data()+N, M);
 254     }
 255
 256     /// @}
 257     /// @name Operator Overloads
 258     /// @{
 259     T &operator[](size_t Index) const {
 260       assert(Index < this->size() && "Invalid index!");
 261       return data()[Index];
 262     }
 263   };
 264
 265   /// @name ArrayRef Convenience constructors
 266   /// @{
 267
 268   /// Construct an ArrayRef from a single element.
 269   template<typename T>
 270   ArrayRef<T> makeArrayRef(const T &OneElt) {
 271     return OneElt;
 272   }
 273
 274   /// Construct an ArrayRef from a pointer and length.
 275   template<typename T>
 276   ArrayRef<T> makeArrayRef(const T *data, size_t length) {
 277     return ArrayRef<T>(data, length);
 278   }
 279
 280   /// Construct an ArrayRef from a range.
 281   template<typename T>
 282   ArrayRef<T> makeArrayRef(const T *begin, const T *end) {
 283     return ArrayRef<T>(begin, end);
 284   }
 285
 286   /// Construct an ArrayRef from a SmallVector.
 287   template <typename T>
 288   ArrayRef<T> makeArrayRef(const SmallVectorImpl<T> &Vec) {
 289     return Vec;
 290   }
 291
 292   /// Construct an ArrayRef from a SmallVector.
 293   template <typename T, unsigned N>
 294   ArrayRef<T> makeArrayRef(const SmallVector<T, N> &Vec) {
 295     return Vec;
 296   }
 297
 298   /// Construct an ArrayRef from a std::vector.
 299   template<typename T>
 300   ArrayRef<T> makeArrayRef(const std::vector<T> &Vec) {
 301     return Vec;
 302   }
 303
 304   /// Construct an ArrayRef from a C array.
 305   template<typename T, size_t N>
 306   ArrayRef<T> makeArrayRef(const T (&Arr)[N]) {
 307     return ArrayRef<T>(Arr);
 308   }
 309
 310   /// @}
 311   /// @name ArrayRef Comparison Operators
 312   /// @{
 313
 314   template<typename T>
 315   inline bool operator==(ArrayRef<T> LHS, ArrayRef<T> RHS) {
 316     return LHS.equals(RHS);
 317   }
 318
 319   template<typename T>
 320   inline bool operator!=(ArrayRef<T> LHS, ArrayRef<T> RHS) {
 321     return !(LHS == RHS);
 322   }
 323
 324   /// @}
 325
 326   // ArrayRefs can be treated like a POD type.
 327   template <typename T> struct isPodLike;
 328   template <typename T> struct isPodLike<ArrayRef<T> > {
 329     static const bool value = true;
 330   };
 331 }
 332
 333 #endif