algorithm.h 10.8 KB
Newer Older
1
2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3
4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
5
6
7
8
9
10
11
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
Eike Ziller's avatar
Eike Ziller committed
12
13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15
16
17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
Eike Ziller's avatar
Eike Ziller committed
25
26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
27
28
29
30
31
32
33
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef ALGORITHM_H
#define ALGORITHM_H

Christian Kandeler's avatar
Christian Kandeler committed
34
35
#include <qcompilerdetection.h> // for Q_REQUIRED_RESULT

36
#include <algorithm>
37
#include <functional>
38
#include <QStringList>
39
40
41

namespace Utils
{
42
43
44
45
46
47
48
49
50
51
//////////////////
// anyOf
/////////////////

// anyOf taking a member function pointer
template<typename T, typename R, typename S>
bool anyOf(const T &container, R (S::*predicate)() const)
{
    return std::any_of(container.begin(), container.end(), std::mem_fn(predicate));
}
52

53
54
55
56
57
58
template<typename T, typename F>
bool anyOf(const T &container, F predicate)
{
    return std::any_of(container.begin(), container.end(), predicate);
}

59
60
61
62
63
64
template<typename T, typename F>
int count(const T &container, F predicate)
{
    return std::count_if(container.begin(), container.end(), predicate);
}

65
66
67
//////////////////
// allOf
/////////////////
68
69
70
71
72
73
template<typename T, typename F>
bool allOf(const T &container, F predicate)
{
    return std::all_of(container.begin(), container.end(), predicate);
}

74
75
76
//////////////////
// erase
/////////////////
77
78
79
80
81
82
83
template<typename T, typename F>
void erase(QList<T> &container, F predicate)
{
    container.erase(std::remove_if(container.begin(), container.end(), predicate),
                    container.end());
}

84
85
86
//////////////////
// contains
/////////////////
87
88
89
90
91
92
93
94
95
96
template<typename T, typename F>
bool contains(const T &container, F function)
{
    typename T::const_iterator end = container.end();
    typename T::const_iterator begin = container.begin();

    typename T::const_iterator it = std::find_if(begin, end, function);
    return it != end;
}

97
98
99
//////////////////
// findOr
/////////////////
100
101
102
103
104
105
106
107
108
109
110
111
template<typename T, typename F>
typename T::value_type findOr(const T &container, typename T::value_type other, F function)
{
    typename T::const_iterator end = container.end();
    typename T::const_iterator begin = container.begin();

    typename T::const_iterator it = std::find_if(begin, end, function);
    if (it == end)
        return other;
    return *it;
}

112
113
114
115
116
117
118
template<typename T, typename R, typename S>
typename T::value_type findOr(const T &container, typename T::value_type other, R (S::*function)() const)
{
    return findOr(container, other, std::mem_fn(function));
}


Eike Ziller's avatar
Eike Ziller committed
119
120
121
122
123
124
125
126
127
128
129
130
template<typename T, typename F>
int indexOf(const T &container, F function)
{
    typename T::const_iterator end = container.end();
    typename T::const_iterator begin = container.begin();

    typename T::const_iterator it = std::find_if(begin, end, function);
    if (it == end)
        return -1;
    return it - begin;
}

131
template<typename T, typename F>
132
typename T::value_type findOrDefault(const T &container, F function)
133
{
134
135
    return findOr(container, typename T::value_type(), function);
}
136

137
138
139
140
141
142
template<typename T, typename R, typename S>
typename T::value_type findOrDefault(const T &container, R (S::*function)() const)
{
    return findOr(container, typename T::value_type(), function);
}

143
144
145
146
147
148
149
//////////////////
// find helpers
//////////////////
template<typename R, typename S, typename T>
auto equal(R (S::*function)() const, T value)
    -> decltype(std::bind<bool>(std::equal_to<T>(), value, std::bind(function, std::placeholders::_1)))
{
150
151
    // This should use std::equal_to<> instead of std::eqaul_to<T>,
    // but that's not supported everywhere yet, since it is C++14
152
153
154
    return std::bind<bool>(std::equal_to<T>(), value, std::bind(function, std::placeholders::_1));
}

155
156
157
158
159
160
161
162
template<typename R, typename S, typename T>
auto equal(R S::*member, T value)
    -> decltype(std::bind<bool>(std::equal_to<T>(), value, std::bind(member, std::placeholders::_1)))
{
    return std::bind<bool>(std::equal_to<T>(), value, std::bind(member, std::placeholders::_1));
}


163
164
165
166
//////////////////
// transform
/////////////////

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
namespace {
/////////////////
// helper code for transform to use back_inserter and thus push_back for everything
// and insert for QSet<>
//

// QSetInsertIterator, straight from the standard for insert_iterator
// just without the additional parameter to insert
template <class Container>
  class QSetInsertIterator :
    public std::iterator<std::output_iterator_tag,void,void,void,void>
{
protected:
  Container *container;

public:
  typedef Container container_type;
  explicit QSetInsertIterator (Container &x)
    : container(&x) {}
  QSetInsertIterator<Container> &operator=(const typename Container::value_type &value)
    { container->insert(value); return *this; }
  QSetInsertIterator<Container> &operator= (typename Container::value_type &&value)
    { container->insert(std::move(value)); return *this; }
  QSetInsertIterator<Container >&operator*()
    { return *this; }
  QSetInsertIterator<Container> &operator++()
    { return *this; }
  QSetInsertIterator<Container> operator++(int)
    { return *this; }
};

// inserter helper function, returns a std::back_inserter for most containers
// and is overloaded for QSet<> to return a QSetInsertIterator
template<typename C>
inline std::back_insert_iterator<C>
inserter(C &container)
{
    return std::back_inserter(container);
}

template<typename X>
inline QSetInsertIterator<QSet<X>>
inserter(QSet<X> &container)
{
    return QSetInsertIterator<QSet<X>>(container);
}

214
// decay_t is C++14, so provide it here, remove once we require C++14
215
template<typename T>
216
using decay_t = typename std::decay<T>::type;
217

218
219
220
// abstraction to treat Container<T> and QStringList similarly
template<typename T>
struct ContainerType
221
{
222

223
224
};

225
226
227
228
229
230
231
232
233
234
// specialization for qt container T_Container<T_Type>
template<template<typename> class T_Container, typename T_Type>
struct ContainerType<T_Container<T_Type>> {
    typedef T_Type ElementType;

    template<class NewElementType>
    struct WithElementType
    {
        typedef T_Container<NewElementType> type;
    };
235
236
237
238
239
240
241
242
243
244
245
246

    template<class F, template<typename> class C = T_Container>
    struct ResultOfTransform
    {
        typedef C<decay_t<typename std::result_of<F (ElementType)>::type>> type;
    };

    template<class R>
    struct ResultOfTransformPMF
    {
        typedef typename WithElementType<decay_t<R>>::type type;
    };
247
248
249
250
};

// specialization for QStringList
template<>
251
struct ContainerType<QStringList> : ContainerType<QList<QString>>
252
{
253
};
254

255
256
}

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
// actual implementation of transform
template<typename C, // result container type
         typename SC> // input container type
struct TransformImpl {
    template <typename F>
    Q_REQUIRED_RESULT
    static C call(const SC &container, F function)
    {
        C result;
        std::transform(container.begin(), container.end(),
                       inserter(result),
                       function);
        return result;
    }

    template <typename R, typename S>
    Q_REQUIRED_RESULT
    static C call(const SC &container, R (S::*p)() const)
    {
        return call(container, std::mem_fn(p));
    }

};

// same container type for input and output, e.g. transforming a QList<QString> into QList<int>
// or QStringList -> QList<>
template<typename C, // container
         typename F>
285
Q_REQUIRED_RESULT
286
auto transform(const C &container, F function)
287
-> typename ContainerType<C>::template ResultOfTransform<F>::type
288
{
289
    return TransformImpl<
290
                typename ContainerType<C>::template ResultOfTransform<F>::type,
291
292
                C
            >::call(container, function);
293
294
}

295
296
297
298
// same container type for member function pointer
template<typename C,
        typename R,
        typename S>
299
Q_REQUIRED_RESULT
300
auto transform(const C &container, R (S::*p)() const)
301
    ->typename ContainerType<C>::template ResultOfTransformPMF<R>::type
302
{
303
    return TransformImpl<
304
                typename ContainerType<C>::template ResultOfTransformPMF<R>::type,
305
306
                C
            >::call(container, p);
307
308
309
310
}

// different container types for input and output, e.g. transforming a QList into a QSet
template<template<typename> class C, // result container type
311
         typename SC, // input container type
312
313
         typename F> // function type
Q_REQUIRED_RESULT
314
auto transform(const SC &container, F function)
315
     -> typename ContainerType<SC>::template ResultOfTransform<F, C>::type
316
{
317
    return TransformImpl<
318
                typename ContainerType<SC>::template ResultOfTransform<F, C>::type,
319
320
                SC
            >::call(container, function);
321
322
}

323
324
// different container types for input and output, e.g. transforming a QList into a QSet
// for member function pointers
325
template<template<typename> class C, // result container type
326
327
328
         typename SC, // input container type
         typename R,
         typename S>
329
Q_REQUIRED_RESULT
330
auto transform(const SC &container, R (S::*p)() const)
331
     -> C<decay_t<R>>
332
{
333
    return TransformImpl<
334
                C<decay_t<R>>,
335
336
                SC
            >::call(container, p);
337
338
}

339
340
341
342
//////////////////
// filtered
/////////////////
template<typename C, typename F>
343
Q_REQUIRED_RESULT
344
345
346
347
348
349
350
351
C filtered(const C &container, F predicate)
{
  C out;
  std::copy_if(container.begin(), container.end(),
               inserter(out), predicate);
  return out;
}

352
353
354
355
356
357
358
359
360
361
template<typename C, typename R, typename S>
Q_REQUIRED_RESULT
C filtered(const C &container, R (S::*predicate)() const)
{
  C out;
  std::copy_if(container.begin(), container.end(),
               inserter(out), std::mem_fn(predicate));
  return out;
}

362
363
364
//////////////////
// sort
/////////////////
365
366
367
368
369
370
371
372
373
374
375
376
template <typename Container>
inline void sort(Container &c)
{
    std::sort(c.begin(), c.end());
}

template <typename Container, typename Predicate>
inline void sort(Container &c, Predicate p)
{
    std::sort(c.begin(), c.end(), p);
}

377
378
379
}

#endif // ALGORITHM_H