1 //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains some templates that are useful if you are working with the
13 // No library is required when using these functinons.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_ADT_STLEXTRAS_H
18 #define LLVM_ADT_STLEXTRAS_H
21 #include <utility> // for std::pair
22 #include <cstring> // for std::size_t
23 #include "llvm/ADT/iterator.h"
27 //===----------------------------------------------------------------------===//
28 // Extra additions to <functional>
29 //===----------------------------------------------------------------------===//
32 struct greater_ptr : public std::binary_function<Ty, Ty, bool> {
33 bool operator()(const Ty* left, const Ty* right) const {
34 return *right < *left;
38 // deleter - Very very very simple method that is used to invoke operator
39 // delete on something. It is used like this:
41 // for_each(V.begin(), B.end(), deleter<Interval>);
44 static inline void deleter(T *Ptr) {
50 //===----------------------------------------------------------------------===//
51 // Extra additions to <iterator>
52 //===----------------------------------------------------------------------===//
54 // mapped_iterator - This is a simple iterator adapter that causes a function to
55 // be dereferenced whenever operator* is invoked on the iterator.
57 template <class RootIt, class UnaryFunc>
58 class mapped_iterator {
62 typedef typename std::iterator_traits<RootIt>::iterator_category
64 typedef typename std::iterator_traits<RootIt>::difference_type
66 typedef typename UnaryFunc::result_type value_type;
69 //typedef typename UnaryFunc::result_type *pointer;
70 typedef void reference; // Can't modify value returned by fn
72 typedef RootIt iterator_type;
73 typedef mapped_iterator<RootIt, UnaryFunc> _Self;
75 inline const RootIt &getCurrent() const { return current; }
76 inline const UnaryFunc &getFunc() const { return Fn; }
78 inline explicit mapped_iterator(const RootIt &I, UnaryFunc F)
79 : current(I), Fn(F) {}
80 inline mapped_iterator(const mapped_iterator &It)
81 : current(It.current), Fn(It.Fn) {}
83 inline value_type operator*() const { // All this work to do this
84 return Fn(*current); // little change
87 _Self& operator++() { ++current; return *this; }
88 _Self& operator--() { --current; return *this; }
89 _Self operator++(int) { _Self __tmp = *this; ++current; return __tmp; }
90 _Self operator--(int) { _Self __tmp = *this; --current; return __tmp; }
91 _Self operator+ (difference_type n) const {
92 return _Self(current + n, Fn);
94 _Self& operator+= (difference_type n) { current += n; return *this; }
95 _Self operator- (difference_type n) const {
96 return _Self(current - n, Fn);
98 _Self& operator-= (difference_type n) { current -= n; return *this; }
99 reference operator[](difference_type n) const { return *(*this + n); }
101 inline bool operator!=(const _Self &X) const { return !operator==(X); }
102 inline bool operator==(const _Self &X) const { return current == X.current; }
103 inline bool operator< (const _Self &X) const { return current < X.current; }
105 inline difference_type operator-(const _Self &X) const {
106 return current - X.current;
110 template <class _Iterator, class Func>
111 inline mapped_iterator<_Iterator, Func>
112 operator+(typename mapped_iterator<_Iterator, Func>::difference_type N,
113 const mapped_iterator<_Iterator, Func>& X) {
114 return mapped_iterator<_Iterator, Func>(X.getCurrent() - N, X.getFunc());
118 // map_iterator - Provide a convenient way to create mapped_iterators, just like
119 // make_pair is useful for creating pairs...
121 template <class ItTy, class FuncTy>
122 inline mapped_iterator<ItTy, FuncTy> map_iterator(const ItTy &I, FuncTy F) {
123 return mapped_iterator<ItTy, FuncTy>(I, F);
127 // next/prior - These functions unlike std::advance do not modify the
128 // passed iterator but return a copy.
130 // next(myIt) returns copy of myIt incremented once
131 // next(myIt, n) returns copy of myIt incremented n times
132 // prior(myIt) returns copy of myIt decremented once
133 // prior(myIt, n) returns copy of myIt decremented n times
135 template <typename ItTy, typename Dist>
136 inline ItTy next(ItTy it, Dist n)
142 template <typename ItTy>
143 inline ItTy next(ItTy it)
148 template <typename ItTy, typename Dist>
149 inline ItTy prior(ItTy it, Dist n)
151 std::advance(it, -n);
155 template <typename ItTy>
156 inline ItTy prior(ItTy it)
161 //===----------------------------------------------------------------------===//
162 // Extra additions to <utility>
163 //===----------------------------------------------------------------------===//
165 // tie - this function ties two objects and returns a temporary object
166 // that is assignable from a std::pair. This can be used to make code
167 // more readable when using values returned from functions bundled in
168 // a std::pair. Since an example is worth 1000 words:
170 // typedef std::map<int, int> Int2IntMap;
173 // Int2IntMap::iterator where;
175 // tie(where, inserted) = myMap.insert(std::make_pair(123,456));
184 template <typename T1, typename T2>
186 typedef T1 &first_type;
187 typedef T2 &second_type;
192 tier(first_type f, second_type s) : first(f), second(s) { }
193 tier& operator=(const std::pair<T1, T2>& p) {
201 template <typename T1, typename T2>
202 inline tier<T1, T2> tie(T1& f, T2& s) {
203 return tier<T1, T2>(f, s);
206 //===----------------------------------------------------------------------===//
207 // Extra additions to arrays
208 //===----------------------------------------------------------------------===//
210 /// Find where an array ends (for ending iterators)
211 /// This returns a pointer to the byte immediately
212 /// after the end of an array.
213 template<class T, std::size_t N>
214 inline T *array_endof(T (&x)[N]) {
218 /// Find the length of an array.
219 template<class T, std::size_t N>
220 inline size_t array_lengthof(T (&x)[N]) {
224 } // End llvm namespace