Add utility function to allow easy reverse range-based iteration of a container
[WebKit-https.git] / Source / WTF / wtf / IteratorRange.h
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <iterator>
29
30 namespace WTF {
31
32 template<typename Iterator>
33 class IteratorRange {
34 public:
35     IteratorRange(Iterator begin, Iterator end)
36         : m_begin(WTFMove(begin))
37         , m_end(WTFMove(end))
38     {
39     }
40
41     Iterator begin() const { return m_begin; }
42     Iterator end() const { return m_end; }
43
44 private:
45     Iterator m_begin;
46     Iterator m_end;
47 };
48
49 template<typename Iterator>
50 IteratorRange<Iterator> makeIteratorRange(Iterator&& begin, Iterator&& end)
51 {
52     return IteratorRange<Iterator>(std::forward<Iterator>(begin), std::forward<Iterator>(end));
53 }
54
55 template<typename Container>
56 IteratorRange<typename Container::reverse_iterator> makeReversedRange(Container& container)
57 {
58     return makeIteratorRange(std::rbegin(container), std::rend(container));
59 }
60
61 template<typename Container>
62 IteratorRange<typename Container::const_reverse_iterator> makeReversedRange(const Container& container)
63 {
64     return makeIteratorRange(std::crbegin(container), std::crend(container));
65 }
66
67 template<typename Container, typename Iterator>
68 class SizedIteratorRange {
69 public:
70     SizedIteratorRange(const Container& container, Iterator begin, Iterator end)
71         : m_container(container)
72         , m_begin(WTFMove(begin))
73         , m_end(WTFMove(end))
74     {
75     }
76
77     auto size() const -> decltype(std::declval<Container>().size()) { return m_container.size(); }
78     bool isEmpty() const { return m_container.isEmpty(); }
79     Iterator begin() const { return m_begin; }
80     Iterator end() const { return m_end; }
81
82 private:
83     const Container& m_container;
84     Iterator m_begin;
85     Iterator m_end;
86 };
87
88 template<typename Container, typename Iterator>
89 SizedIteratorRange<Container, Iterator> makeSizedIteratorRange(const Container& container, Iterator&& begin, Iterator&& end)
90 {
91     return SizedIteratorRange<Container, Iterator>(container, std::forward<Iterator>(begin), std::forward<Iterator>(end));
92 }
93
94 } // namespace WTF