1 //===--- ImmutableMap.h - Immutable (functional) map interface --*- 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 defines the ImmutableMap class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_IMMUTABLEMAP_H
15 #define LLVM_ADT_IMMUTABLEMAP_H
17 #include "llvm/ADT/ImmutableSet.h"
21 /// ImutKeyValueInfo -Traits class used by ImmutableMap. While both the first
22 /// and second elements in a pair are used to generate profile information,
23 /// only the first element (the key) is used by isEqual and isLess.
24 template <typename T, typename S>
25 struct ImutKeyValueInfo {
26 typedef const std::pair<T,S> value_type;
27 typedef const value_type& value_type_ref;
28 typedef const T key_type;
29 typedef const T& key_type_ref;
30 typedef const S data_type;
31 typedef const S& data_type_ref;
33 static inline key_type_ref KeyOfValue(value_type_ref V) {
37 static inline data_type_ref DataOfValue(value_type_ref V) {
41 static inline bool isEqual(key_type_ref L, key_type_ref R) {
42 return ImutContainerInfo<T>::isEqual(L,R);
44 static inline bool isLess(key_type_ref L, key_type_ref R) {
45 return ImutContainerInfo<T>::isLess(L,R);
48 static inline bool isDataEqual(data_type_ref L, data_type_ref R) {
49 return ImutContainerInfo<S>::isEqual(L,R);
52 static inline void Profile(FoldingSetNodeID& ID, value_type_ref V) {
53 ImutContainerInfo<T>::Profile(ID, V.first);
54 ImutContainerInfo<S>::Profile(ID, V.second);
59 template <typename KeyT, typename ValT,
60 typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
63 typedef typename ValInfo::value_type value_type;
64 typedef typename ValInfo::value_type_ref value_type_ref;
65 typedef typename ValInfo::key_type key_type;
66 typedef typename ValInfo::key_type_ref key_type_ref;
67 typedef typename ValInfo::data_type data_type;
68 typedef typename ValInfo::data_type_ref data_type_ref;
69 typedef ImutAVLTree<ValInfo> TreeTy;
75 /// Constructs a map from a pointer to a tree root. In general one
76 /// should use a Factory object to create maps instead of directly
77 /// invoking the constructor, but there are cases where make this
78 /// constructor public is useful.
79 explicit ImmutableMap(const TreeTy* R) : Root(const_cast<TreeTy*>(R)) {
80 if (Root) { Root->retain(); }
82 ImmutableMap(const ImmutableMap &X) : Root(X.Root) {
83 if (Root) { Root->retain(); }
85 ImmutableMap &operator=(const ImmutableMap &X) {
87 if (X.Root) { X.Root->retain(); }
88 if (Root) { Root->release(); }
94 if (Root) { Root->release(); }
98 typename TreeTy::Factory F;
99 const bool Canonicalize;
102 Factory(bool canonicalize = true)
103 : Canonicalize(canonicalize) {}
105 Factory(BumpPtrAllocator& Alloc, bool canonicalize = true)
106 : F(Alloc), Canonicalize(canonicalize) {}
108 ImmutableMap getEmptyMap() { return ImmutableMap(F.getEmptyTree()); }
110 ImmutableMap add(ImmutableMap Old, key_type_ref K, data_type_ref D) {
111 TreeTy *T = F.add(Old.Root, std::pair<key_type,data_type>(K,D));
112 return ImmutableMap(Canonicalize ? F.getCanonicalTree(T): T);
115 ImmutableMap remove(ImmutableMap Old, key_type_ref K) {
116 TreeTy *T = F.remove(Old.Root,K);
117 return ImmutableMap(Canonicalize ? F.getCanonicalTree(T): T);
120 typename TreeTy::Factory *getTreeFactory() const {
121 return const_cast<typename TreeTy::Factory *>(&F);
125 Factory(const Factory& RHS) = delete;
126 void operator=(const Factory& RHS) = delete;
129 bool contains(key_type_ref K) const {
130 return Root ? Root->contains(K) : false;
133 bool operator==(const ImmutableMap &RHS) const {
134 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
137 bool operator!=(const ImmutableMap &RHS) const {
138 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
141 TreeTy *getRoot() const {
142 if (Root) { Root->retain(); }
146 TreeTy *getRootWithoutRetain() const {
150 void manualRetain() {
151 if (Root) Root->retain();
154 void manualRelease() {
155 if (Root) Root->release();
158 bool isEmpty() const { return !Root; }
160 //===--------------------------------------------------===//
161 // Foreach - A limited form of map iteration.
162 //===--------------------------------------------------===//
165 template <typename Callback>
168 void operator()(value_type_ref V) { C(V.first,V.second); }
171 template <typename Callback>
172 struct CBWrapperRef {
174 CBWrapperRef(Callback& c) : C(c) {}
176 void operator()(value_type_ref V) { C(V.first,V.second); }
180 template <typename Callback>
181 void foreach(Callback& C) {
183 CBWrapperRef<Callback> CB(C);
188 template <typename Callback>
191 CBWrapper<Callback> CB;
196 //===--------------------------------------------------===//
198 //===--------------------------------------------------===//
200 void verify() const { if (Root) Root->verify(); }
202 //===--------------------------------------------------===//
204 //===--------------------------------------------------===//
206 class iterator : public ImutAVLValueIterator<ImmutableMap> {
207 iterator() = default;
208 explicit iterator(TreeTy *Tree) : iterator::ImutAVLValueIterator(Tree) {}
209 friend class ImmutableMap;
212 key_type_ref getKey() const { return (*this)->first; }
213 data_type_ref getData() const { return (*this)->second; }
216 iterator begin() const { return iterator(Root); }
217 iterator end() const { return iterator(); }
219 data_type* lookup(key_type_ref K) const {
221 TreeTy* T = Root->find(K);
222 if (T) return &T->getValue().second;
228 /// getMaxElement - Returns the <key,value> pair in the ImmutableMap for
229 /// which key is the highest in the ordering of keys in the map. This
230 /// method returns NULL if the map is empty.
231 value_type* getMaxElement() const {
232 return Root ? &(Root->getMaxElement()->getValue()) : nullptr;
235 //===--------------------------------------------------===//
237 //===--------------------------------------------------===//
239 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
241 static inline void Profile(FoldingSetNodeID& ID, const ImmutableMap& M) {
242 ID.AddPointer(M.Root);
245 inline void Profile(FoldingSetNodeID& ID) const {
246 return Profile(ID,*this);
250 // NOTE: This will possibly become the new implementation of ImmutableMap some day.
251 template <typename KeyT, typename ValT,
252 typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
253 class ImmutableMapRef {
255 typedef typename ValInfo::value_type value_type;
256 typedef typename ValInfo::value_type_ref value_type_ref;
257 typedef typename ValInfo::key_type key_type;
258 typedef typename ValInfo::key_type_ref key_type_ref;
259 typedef typename ValInfo::data_type data_type;
260 typedef typename ValInfo::data_type_ref data_type_ref;
261 typedef ImutAVLTree<ValInfo> TreeTy;
262 typedef typename TreeTy::Factory FactoryTy;
269 /// Constructs a map from a pointer to a tree root. In general one
270 /// should use a Factory object to create maps instead of directly
271 /// invoking the constructor, but there are cases where make this
272 /// constructor public is useful.
273 explicit ImmutableMapRef(const TreeTy* R, FactoryTy *F)
274 : Root(const_cast<TreeTy*>(R)),
276 if (Root) { Root->retain(); }
279 explicit ImmutableMapRef(const ImmutableMap<KeyT, ValT> &X,
280 typename ImmutableMap<KeyT, ValT>::Factory &F)
281 : Root(X.getRootWithoutRetain()),
282 Factory(F.getTreeFactory()) {
283 if (Root) { Root->retain(); }
286 ImmutableMapRef(const ImmutableMapRef &X)
289 if (Root) { Root->retain(); }
292 ImmutableMapRef &operator=(const ImmutableMapRef &X) {
293 if (Root != X.Root) {
311 static inline ImmutableMapRef getEmptyMap(FactoryTy *F) {
312 return ImmutableMapRef(0, F);
315 void manualRetain() {
316 if (Root) Root->retain();
319 void manualRelease() {
320 if (Root) Root->release();
323 ImmutableMapRef add(key_type_ref K, data_type_ref D) const {
324 TreeTy *NewT = Factory->add(Root, std::pair<key_type, data_type>(K, D));
325 return ImmutableMapRef(NewT, Factory);
328 ImmutableMapRef remove(key_type_ref K) const {
329 TreeTy *NewT = Factory->remove(Root, K);
330 return ImmutableMapRef(NewT, Factory);
333 bool contains(key_type_ref K) const {
334 return Root ? Root->contains(K) : false;
337 ImmutableMap<KeyT, ValT> asImmutableMap() const {
338 return ImmutableMap<KeyT, ValT>(Factory->getCanonicalTree(Root));
341 bool operator==(const ImmutableMapRef &RHS) const {
342 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
345 bool operator!=(const ImmutableMapRef &RHS) const {
346 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
349 bool isEmpty() const { return !Root; }
351 //===--------------------------------------------------===//
353 //===--------------------------------------------------===//
355 void verify() const { if (Root) Root->verify(); }
357 //===--------------------------------------------------===//
359 //===--------------------------------------------------===//
361 class iterator : public ImutAVLValueIterator<ImmutableMapRef> {
362 iterator() = default;
363 explicit iterator(TreeTy *Tree) : iterator::ImutAVLValueIterator(Tree) {}
364 friend class ImmutableMapRef;
367 key_type_ref getKey() const { return (*this)->first; }
368 data_type_ref getData() const { return (*this)->second; }
371 iterator begin() const { return iterator(Root); }
372 iterator end() const { return iterator(); }
374 data_type* lookup(key_type_ref K) const {
376 TreeTy* T = Root->find(K);
377 if (T) return &T->getValue().second;
383 /// getMaxElement - Returns the <key,value> pair in the ImmutableMap for
384 /// which key is the highest in the ordering of keys in the map. This
385 /// method returns NULL if the map is empty.
386 value_type* getMaxElement() const {
387 return Root ? &(Root->getMaxElement()->getValue()) : 0;
390 //===--------------------------------------------------===//
392 //===--------------------------------------------------===//
394 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
396 static inline void Profile(FoldingSetNodeID& ID, const ImmutableMapRef &M) {
397 ID.AddPointer(M.Root);
400 inline void Profile(FoldingSetNodeID& ID) const {
401 return Profile(ID, *this);
405 } // end namespace llvm