annotate gcc/hash-set.h @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* A type-safe hash set.
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 This file is part of GCC.
kono
parents:
diff changeset
5
kono
parents:
diff changeset
6 GCC is free software; you can redistribute it and/or modify it under
kono
parents:
diff changeset
7 the terms of the GNU General Public License as published by the Free
kono
parents:
diff changeset
8 Software Foundation; either version 3, or (at your option) any later
kono
parents:
diff changeset
9 version.
kono
parents:
diff changeset
10
kono
parents:
diff changeset
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
kono
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
kono
parents:
diff changeset
14 for more details.
kono
parents:
diff changeset
15
kono
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
17 along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
18 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20
kono
parents:
diff changeset
21 #ifndef hash_set_h
kono
parents:
diff changeset
22 #define hash_set_h
kono
parents:
diff changeset
23
kono
parents:
diff changeset
24 template<typename KeyId, typename Traits = default_hash_traits<KeyId> >
kono
parents:
diff changeset
25 class hash_set
kono
parents:
diff changeset
26 {
kono
parents:
diff changeset
27 public:
kono
parents:
diff changeset
28 typedef typename Traits::value_type Key;
kono
parents:
diff changeset
29 explicit hash_set (size_t n = 13, bool ggc = false CXX_MEM_STAT_INFO)
kono
parents:
diff changeset
30 : m_table (n, ggc, GATHER_STATISTICS, HASH_SET_ORIGIN PASS_MEM_STAT) {}
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 /* Create a hash_set in gc memory with space for at least n elements. */
kono
parents:
diff changeset
33
kono
parents:
diff changeset
34 static hash_set *
kono
parents:
diff changeset
35 create_ggc (size_t n)
kono
parents:
diff changeset
36 {
kono
parents:
diff changeset
37 hash_set *set = ggc_alloc<hash_set> ();
kono
parents:
diff changeset
38 new (set) hash_set (n, true);
kono
parents:
diff changeset
39 return set;
kono
parents:
diff changeset
40 }
kono
parents:
diff changeset
41
kono
parents:
diff changeset
42 /* If key k isn't already in the map add it to the map, and
kono
parents:
diff changeset
43 return false. Otherwise return true. */
kono
parents:
diff changeset
44
kono
parents:
diff changeset
45 bool add (const Key &k)
kono
parents:
diff changeset
46 {
kono
parents:
diff changeset
47 Key *e = m_table.find_slot_with_hash (k, Traits::hash (k), INSERT);
kono
parents:
diff changeset
48 bool existed = !Traits::is_empty (*e);
kono
parents:
diff changeset
49 if (!existed)
kono
parents:
diff changeset
50 *e = k;
kono
parents:
diff changeset
51
kono
parents:
diff changeset
52 return existed;
kono
parents:
diff changeset
53 }
kono
parents:
diff changeset
54
kono
parents:
diff changeset
55 /* if the passed in key is in the map return its value otherwise NULL. */
kono
parents:
diff changeset
56
kono
parents:
diff changeset
57 bool contains (const Key &k)
kono
parents:
diff changeset
58 {
kono
parents:
diff changeset
59 Key &e = m_table.find_with_hash (k, Traits::hash (k));
kono
parents:
diff changeset
60 return !Traits::is_empty (e);
kono
parents:
diff changeset
61 }
kono
parents:
diff changeset
62
kono
parents:
diff changeset
63 void remove (const Key &k)
kono
parents:
diff changeset
64 {
kono
parents:
diff changeset
65 m_table.remove_elt_with_hash (k, Traits::hash (k));
kono
parents:
diff changeset
66 }
kono
parents:
diff changeset
67
kono
parents:
diff changeset
68 /* Call the call back on each pair of key and value with the passed in
kono
parents:
diff changeset
69 arg. */
kono
parents:
diff changeset
70
kono
parents:
diff changeset
71 template<typename Arg, bool (*f)(const typename Traits::value_type &, Arg)>
kono
parents:
diff changeset
72 void traverse (Arg a) const
kono
parents:
diff changeset
73 {
kono
parents:
diff changeset
74 for (typename hash_table<Traits>::iterator iter = m_table.begin ();
kono
parents:
diff changeset
75 iter != m_table.end (); ++iter)
kono
parents:
diff changeset
76 f (*iter, a);
kono
parents:
diff changeset
77 }
kono
parents:
diff changeset
78
kono
parents:
diff changeset
79 /* Return the number of elements in the set. */
kono
parents:
diff changeset
80
kono
parents:
diff changeset
81 size_t elements () const { return m_table.elements (); }
kono
parents:
diff changeset
82
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
83 /* Clear the hash table. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
84
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
85 void empty () { m_table.empty (); }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
86
111
kono
parents:
diff changeset
87 class iterator
kono
parents:
diff changeset
88 {
kono
parents:
diff changeset
89 public:
kono
parents:
diff changeset
90 explicit iterator (const typename hash_table<Traits>::iterator &iter) :
kono
parents:
diff changeset
91 m_iter (iter) {}
kono
parents:
diff changeset
92
kono
parents:
diff changeset
93 iterator &operator++ ()
kono
parents:
diff changeset
94 {
kono
parents:
diff changeset
95 ++m_iter;
kono
parents:
diff changeset
96 return *this;
kono
parents:
diff changeset
97 }
kono
parents:
diff changeset
98
kono
parents:
diff changeset
99 Key
kono
parents:
diff changeset
100 operator* ()
kono
parents:
diff changeset
101 {
kono
parents:
diff changeset
102 return *m_iter;
kono
parents:
diff changeset
103 }
kono
parents:
diff changeset
104
kono
parents:
diff changeset
105 bool
kono
parents:
diff changeset
106 operator != (const iterator &other) const
kono
parents:
diff changeset
107 {
kono
parents:
diff changeset
108 return m_iter != other.m_iter;
kono
parents:
diff changeset
109 }
kono
parents:
diff changeset
110
kono
parents:
diff changeset
111 private:
kono
parents:
diff changeset
112 typename hash_table<Traits>::iterator m_iter;
kono
parents:
diff changeset
113 };
kono
parents:
diff changeset
114
kono
parents:
diff changeset
115 /* Standard iterator retrieval methods. */
kono
parents:
diff changeset
116
kono
parents:
diff changeset
117 iterator begin () const { return iterator (m_table.begin ()); }
kono
parents:
diff changeset
118 iterator end () const { return iterator (m_table.end ()); }
kono
parents:
diff changeset
119
kono
parents:
diff changeset
120
kono
parents:
diff changeset
121 private:
kono
parents:
diff changeset
122
kono
parents:
diff changeset
123 template<typename T, typename U> friend void gt_ggc_mx (hash_set<T, U> *);
kono
parents:
diff changeset
124 template<typename T, typename U> friend void gt_pch_nx (hash_set<T, U> *);
kono
parents:
diff changeset
125 template<typename T, typename U> friend void gt_pch_nx (hash_set<T, U> *, gt_pointer_operator, void *);
kono
parents:
diff changeset
126
kono
parents:
diff changeset
127 hash_table<Traits> m_table;
kono
parents:
diff changeset
128 };
kono
parents:
diff changeset
129
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
130 /* Generic hash_set<TYPE> debug helper.
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
132 This needs to be instantiated for each hash_set<TYPE> used throughout
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
133 the compiler like this:
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
134
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
135 DEFINE_DEBUG_HASH_SET (TYPE)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
136
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
137 The reason we have a debug_helper() is because GDB can't
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
138 disambiguate a plain call to debug(some_hash), and it must be called
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
139 like debug<TYPE>(some_hash). */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
140 template<typename T>
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
141 void
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
142 debug_helper (hash_set<T> &ref)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
143 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
144 for (typename hash_set<T>::iterator it = ref.begin ();
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
145 it != ref.end (); ++it)
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
146 {
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
147 debug_slim (*it);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
148 fputc ('\n', stderr);
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
149 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
150 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
151
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
152 #define DEFINE_DEBUG_HASH_SET(T) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
153 template void debug_helper (hash_set<T> &); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
154 DEBUG_FUNCTION void \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
155 debug (hash_set<T> &ref) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
156 { \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
157 debug_helper <T> (ref); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
158 } \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
159 DEBUG_FUNCTION void \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
160 debug (hash_set<T> *ptr) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
161 { \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
162 if (ptr) \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
163 debug (*ptr); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
164 else \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
165 fprintf (stderr, "<nil>\n"); \
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
166 }
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
167
111
kono
parents:
diff changeset
168 /* ggc marking routines. */
kono
parents:
diff changeset
169
kono
parents:
diff changeset
170 template<typename K, typename H>
kono
parents:
diff changeset
171 static inline void
kono
parents:
diff changeset
172 gt_ggc_mx (hash_set<K, H> *h)
kono
parents:
diff changeset
173 {
kono
parents:
diff changeset
174 gt_ggc_mx (&h->m_table);
kono
parents:
diff changeset
175 }
kono
parents:
diff changeset
176
kono
parents:
diff changeset
177 template<typename K, typename H>
kono
parents:
diff changeset
178 static inline void
kono
parents:
diff changeset
179 gt_pch_nx (hash_set<K, H> *h)
kono
parents:
diff changeset
180 {
kono
parents:
diff changeset
181 gt_pch_nx (&h->m_table);
kono
parents:
diff changeset
182 }
kono
parents:
diff changeset
183
kono
parents:
diff changeset
184 template<typename K, typename H>
kono
parents:
diff changeset
185 static inline void
kono
parents:
diff changeset
186 gt_pch_nx (hash_set<K, H> *h, gt_pointer_operator op, void *cookie)
kono
parents:
diff changeset
187 {
kono
parents:
diff changeset
188 op (&h->m_table.m_entries, cookie);
kono
parents:
diff changeset
189 }
kono
parents:
diff changeset
190
kono
parents:
diff changeset
191 #endif