Unreviewed, rolling out r234489.
[WebKit-https.git] / Source / WTF / wtf / ListDump.h
1 /*
2  * Copyright (C) 2013, 2015 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ListDump_h
27 #define ListDump_h
28
29 #include "CommaPrinter.h"
30 #include "PrintStream.h"
31 #include "StringPrintStream.h"
32
33 namespace WTF {
34
35 template<typename T>
36 class ListDump {
37 public:
38     ListDump(const T& list, const char* comma)
39         : m_list(list)
40         , m_comma(comma)
41     {
42     }
43     
44     void dump(PrintStream& out) const
45     {
46         for (auto iter = m_list.begin(); iter != m_list.end(); ++iter)
47             out.print(m_comma, *iter);
48     }
49
50 private:
51     const T& m_list;
52     CommaPrinter m_comma;
53 };
54
55 template<typename T>
56 class PointerListDump {
57 public:
58     PointerListDump(const T& list, const char* comma)
59         : m_list(list)
60         , m_comma(comma)
61     {
62     }
63     
64     void dump(PrintStream& out) const
65     {
66         for (auto iter = m_list.begin(); iter != m_list.end(); ++iter)
67             out.print(m_comma, pointerDump(*iter));
68     }
69
70 private:
71     const T& m_list;
72     CommaPrinter m_comma;
73 };
74
75 template<typename T>
76 class MapDump {
77 public:
78     MapDump(const T& map, const char* arrow, const char* comma)
79         : m_map(map)
80         , m_arrow(arrow)
81         , m_comma(comma)
82     {
83     }
84     
85     void dump(PrintStream& out) const
86     {
87         for (auto iter = m_map.begin(); iter != m_map.end(); ++iter)
88             out.print(m_comma, iter->key, m_arrow, iter->value);
89     }
90     
91 private:
92     const T& m_map;
93     const char* m_arrow;
94     CommaPrinter m_comma;
95 };
96
97 template<typename T>
98 ListDump<T> listDump(const T& list, const char* comma = ", ")
99 {
100     return ListDump<T>(list, comma);
101 }
102
103 template<typename T>
104 PointerListDump<T> pointerListDump(const T& list, const char* comma = ", ")
105 {
106     return PointerListDump<T>(list, comma);
107 }
108
109 template<typename T, typename Comparator>
110 CString sortedListDump(const T& list, const Comparator& comparator, const char* comma = ", ")
111 {
112     Vector<typename T::ValueType> myList;
113     myList.appendRange(list.begin(), list.end());
114     std::sort(myList.begin(), myList.end(), comparator);
115     StringPrintStream out;
116     CommaPrinter commaPrinter(comma);
117     for (unsigned i = 0; i < myList.size(); ++i)
118         out.print(commaPrinter, myList[i]);
119     return out.toCString();
120 }
121
122 template<typename T>
123 CString sortedListDump(const T& list, const char* comma = ", ")
124 {
125     return sortedListDump(list, std::less<typename T::ValueType>(), comma);
126 }
127
128 template<typename T>
129 MapDump<T> mapDump(const T& map, const char* arrow = "=>", const char* comma = ", ")
130 {
131     return MapDump<T>(map, arrow, comma);
132 }
133
134 template<typename T, typename Comparator>
135 CString sortedMapDump(const T& map, const Comparator& comparator, const char* arrow = "=>", const char* comma = ", ")
136 {
137     Vector<typename T::KeyType> keys;
138     for (auto iter = map.begin(); iter != map.end(); ++iter)
139         keys.append(iter->key);
140     std::sort(keys.begin(), keys.end(), comparator);
141     StringPrintStream out;
142     CommaPrinter commaPrinter(comma);
143     for (unsigned i = 0; i < keys.size(); ++i)
144         out.print(commaPrinter, keys[i], arrow, map.get(keys[i]));
145     return out.toCString();
146 }
147
148 template<typename T, typename U>
149 class ListDumpInContext {
150 public:
151     ListDumpInContext(const T& list, U* context, const char* comma)
152         : m_list(list)
153         , m_context(context)
154         , m_comma(comma)
155     {
156     }
157     
158     void dump(PrintStream& out) const
159     {
160         for (auto iter = m_list.begin(); iter != m_list.end(); ++iter)
161             out.print(m_comma, inContext(*iter, m_context));
162     }
163
164 private:
165     const T& m_list;
166     U* m_context;
167     CommaPrinter m_comma;
168 };
169
170 template<typename T, typename U>
171 ListDumpInContext<T, U> listDumpInContext(
172     const T& list, U* context, const char* comma = ", ")
173 {
174     return ListDumpInContext<T, U>(list, context, comma);
175 }
176
177 } // namespace WTF
178
179 using WTF::listDump;
180 using WTF::listDumpInContext;
181 using WTF::mapDump;
182 using WTF::pointerListDump;
183 using WTF::sortedListDump;
184 using WTF::sortedMapDump;
185
186 #endif // ListDump_h
187