include/llvm/ADT/STLExtras.h

   1 //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- 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 // This file contains some templates that are useful if you are working with the
  11 // STL at all.
  12 //
  13 // No library is required when using these functions.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ADT_STLEXTRAS_H
  18 #define LLVM_ADT_STLEXTRAS_H
  19
  20 #include <cstddef> // for std::size_t
  21 #include <cstdlib> // for qsort
  22 #include <functional>
  23 #include <iterator>
  24 #include <utility> // for std::pair
  25
  26 namespace llvm {
  27
  28 //===----------------------------------------------------------------------===//
  29 //     Extra additions to <functional>
  30 //===----------------------------------------------------------------------===//
  31
  32 template<class Ty>
  33 struct identity : public std::unary_function<Ty, Ty> {
  34   Ty &operator()(Ty &self) const {
  35     return self;
  36   }
  37   const Ty &operator()(const Ty &self) const {
  38     return self;
  39   }
  40 };
  41
  42 template<class Ty>
  43 struct less_ptr : public std::binary_function<Ty, Ty, bool> {
  44   bool operator()(const Ty* left, const Ty* right) const {
  45     return *left < *right;
  46   }
  47 };
  48
  49 template<class Ty>
  50 struct greater_ptr : public std::binary_function<Ty, Ty, bool> {
  51   bool operator()(const Ty* left, const Ty* right) const {
  52     return *right < *left;
  53   }
  54 };
  55
  56 // deleter - Very very very simple method that is used to invoke operator
  57 // delete on something.  It is used like this:
  58 //
  59 //   for_each(V.begin(), B.end(), deleter<Interval>);
  60 //
  61 template <class T>
  62 inline void deleter(T *Ptr) {
  63   delete Ptr;
  64 }
  65
  66
  67
  68 //===----------------------------------------------------------------------===//
  69 //     Extra additions to <iterator>
  70 //===----------------------------------------------------------------------===//
  71
  72 // mapped_iterator - This is a simple iterator adapter that causes a function to
  73 // be dereferenced whenever operator* is invoked on the iterator.
  74 //
  75 template <class RootIt, class UnaryFunc>
  76 class mapped_iterator {
  77   RootIt current;
  78   UnaryFunc Fn;
  79 public:
  80   typedef typename std::iterator_traits<RootIt>::iterator_category
  81           iterator_category;
  82   typedef typename std::iterator_traits<RootIt>::difference_type
  83           difference_type;
  84   typedef typename UnaryFunc::result_type value_type;
  85
  86   typedef void pointer;
  87   //typedef typename UnaryFunc::result_type *pointer;
  88   typedef void reference;        // Can't modify value returned by fn
  89
  90   typedef RootIt iterator_type;
  91   typedef mapped_iterator<RootIt, UnaryFunc> _Self;
  92
  93   inline const RootIt &getCurrent() const { return current; }
  94   inline const UnaryFunc &getFunc() const { return Fn; }
  95
  96   inline explicit mapped_iterator(const RootIt &I, UnaryFunc F)
  97     : current(I), Fn(F) {}
  98   inline mapped_iterator(const mapped_iterator &It)
  99     : current(It.current), Fn(It.Fn) {}
 100
 101   inline value_type operator*() const {   // All this work to do this
 102     return Fn(*current);         // little change
 103   }
 104
 105   _Self& operator++() { ++current; return *this; }
 106   _Self& operator--() { --current; return *this; }
 107   _Self  operator++(int) { _Self __tmp = *this; ++current; return __tmp; }
 108   _Self  operator--(int) { _Self __tmp = *this; --current; return __tmp; }
 109   _Self  operator+    (difference_type n) const {
 110     return _Self(current + n, Fn);
 111   }
 112   _Self& operator+=   (difference_type n) { current += n; return *this; }
 113   _Self  operator-    (difference_type n) const {
 114     return _Self(current - n, Fn);
 115   }
 116   _Self& operator-=   (difference_type n) { current -= n; return *this; }
 117   reference operator[](difference_type n) const { return *(*this + n); }
 118
 119   inline bool operator!=(const _Self &X) const { return !operator==(X); }
 120   inline bool operator==(const _Self &X) const { return current == X.current; }
 121   inline bool operator< (const _Self &X) const { return current <  X.current; }
 122
 123   inline difference_type operator-(const _Self &X) const {
 124     return current - X.current;
 125   }
 126 };
 127
 128 template <class _Iterator, class Func>
 129 inline mapped_iterator<_Iterator, Func>
 130 operator+(typename mapped_iterator<_Iterator, Func>::difference_type N,
 131           const mapped_iterator<_Iterator, Func>& X) {
 132   return mapped_iterator<_Iterator, Func>(X.getCurrent() - N, X.getFunc());
 133 }
 134
 135
 136 // map_iterator - Provide a convenient way to create mapped_iterators, just like
 137 // make_pair is useful for creating pairs...
 138 //
 139 template <class ItTy, class FuncTy>
 140 inline mapped_iterator<ItTy, FuncTy> map_iterator(const ItTy &I, FuncTy F) {
 141   return mapped_iterator<ItTy, FuncTy>(I, F);
 142 }
 143
 144 //===----------------------------------------------------------------------===//
 145 //     Extra additions to <utility>
 146 //===----------------------------------------------------------------------===//
 147
 148 /// \brief Function object to check whether the first component of a std::pair
 149 /// compares less than the first component of another std::pair.
 150 struct less_first {
 151   template <typename T> bool operator()(const T &lhs, const T &rhs) const {
 152     return lhs.first < rhs.first;
 153   }
 154 };
 155
 156 /// \brief Function object to check whether the second component of a std::pair
 157 /// compares less than the second component of another std::pair.
 158 struct less_second {
 159   template <typename T> bool operator()(const T &lhs, const T &rhs) const {
 160     return lhs.second < rhs.second;
 161   }
 162 };
 163
 164 //===----------------------------------------------------------------------===//
 165 //     Extra additions for arrays
 166 //===----------------------------------------------------------------------===//
 167
 168 /// Find where an array ends (for ending iterators)
 169 /// This returns a pointer to the byte immediately
 170 /// after the end of an array.
 171 template<class T, std::size_t N>
 172 inline T *array_endof(T (&x)[N]) {
 173   return x+N;
 174 }
 175
 176 /// Find the length of an array.
 177 template<class T, std::size_t N>
 178 inline size_t array_lengthof(T (&)[N]) {
 179   return N;
 180 }
 181
 182 /// array_pod_sort_comparator - This is helper function for array_pod_sort,
 183 /// which just uses operator< on T.
 184 template<typename T>
 185 inline int array_pod_sort_comparator(const void *P1, const void *P2) {
 186   if (*reinterpret_cast<const T*>(P1) < *reinterpret_cast<const T*>(P2))
 187     return -1;
 188   if (*reinterpret_cast<const T*>(P2) < *reinterpret_cast<const T*>(P1))
 189     return 1;
 190   return 0;
 191 }
 192
 193 /// get_array_pod_sort_comparator - This is an internal helper function used to
 194 /// get type deduction of T right.
 195 template<typename T>
 196 inline int (*get_array_pod_sort_comparator(const T &))
 197              (const void*, const void*) {
 198   return array_pod_sort_comparator<T>;
 199 }
 200
 201
 202 /// array_pod_sort - This sorts an array with the specified start and end
 203 /// extent.  This is just like std::sort, except that it calls qsort instead of
 204 /// using an inlined template.  qsort is slightly slower than std::sort, but
 205 /// most sorts are not performance critical in LLVM and std::sort has to be
 206 /// template instantiated for each type, leading to significant measured code
 207 /// bloat.  This function should generally be used instead of std::sort where
 208 /// possible.
 209 ///
 210 /// This function assumes that you have simple POD-like types that can be
 211 /// compared with operator< and can be moved with memcpy.  If this isn't true,
 212 /// you should use std::sort.
 213 ///
 214 /// NOTE: If qsort_r were portable, we could allow a custom comparator and
 215 /// default to std::less.
 216 template<class IteratorTy>
 217 inline void array_pod_sort(IteratorTy Start, IteratorTy End) {
 218   // Don't dereference start iterator of empty sequence.
 219   if (Start == End) return;
 220   qsort(&*Start, End-Start, sizeof(*Start),
 221         get_array_pod_sort_comparator(*Start));
 222 }
 223
 224 template <class IteratorTy>
 225 inline void array_pod_sort(
 226     IteratorTy Start, IteratorTy End,
 227     int (*Compare)(
 228         const typename std::iterator_traits<IteratorTy>::value_type *,
 229         const typename std::iterator_traits<IteratorTy>::value_type *)) {
 230   // Don't dereference start iterator of empty sequence.
 231   if (Start == End) return;
 232   qsort(&*Start, End - Start, sizeof(*Start),
 233         reinterpret_cast<int (*)(const void *, const void *)>(Compare));
 234 }
 235
 236 //===----------------------------------------------------------------------===//
 237 //     Extra additions to <algorithm>
 238 //===----------------------------------------------------------------------===//
 239
 240 /// For a container of pointers, deletes the pointers and then clears the
 241 /// container.
 242 template<typename Container>
 243 void DeleteContainerPointers(Container &C) {
 244   for (typename Container::iterator I = C.begin(), E = C.end(); I != E; ++I)
 245     delete *I;
 246   C.clear();
 247 }
 248
 249 /// In a container of pairs (usually a map) whose second element is a pointer,
 250 /// deletes the second elements and then clears the container.
 251 template<typename Container>
 252 void DeleteContainerSeconds(Container &C) {
 253   for (typename Container::iterator I = C.begin(), E = C.end(); I != E; ++I)
 254     delete I->second;
 255   C.clear();
 256 }
 257
 258 } // End llvm namespace
 259
 260 #endif