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);
58 template <typename KeyT, typename ValT,
59 typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
62 typedef typename ValInfo::value_type value_type;
63 typedef typename ValInfo::value_type_ref value_type_ref;
64 typedef typename ValInfo::key_type key_type;
65 typedef typename ValInfo::key_type_ref key_type_ref;
66 typedef typename ValInfo::data_type data_type;
67 typedef typename ValInfo::data_type_ref data_type_ref;
68 typedef ImutAVLTree<ValInfo> TreeTy;
74 /// Constructs a map from a pointer to a tree root. In general one
75 /// should use a Factory object to create maps instead of directly
76 /// invoking the constructor, but there are cases where make this
77 /// constructor public is useful.
78 explicit ImmutableMap(const TreeTy* R) : Root(const_cast<TreeTy*>(R)) {
79 if (Root) { Root->retain(); }
81 ImmutableMap(const ImmutableMap &X) : Root(X.Root) {
82 if (Root) { Root->retain(); }
84 ImmutableMap &operator=(const ImmutableMap &X) {
86 if (X.Root) { X.Root->retain(); }
87 if (Root) { Root->release(); }
93 if (Root) { Root->release(); }
97 typename TreeTy::Factory F;
98 const bool Canonicalize;
101 Factory(bool canonicalize = true) : Canonicalize(canonicalize) {}
103 Factory(BumpPtrAllocator &Alloc, bool canonicalize = true)
104 : F(Alloc), Canonicalize(canonicalize) {}
106 ImmutableMap getEmptyMap() { return ImmutableMap(F.getEmptyTree()); }
108 ImmutableMap add(ImmutableMap Old, key_type_ref K, data_type_ref D) {
109 TreeTy *T = F.add(Old.Root, std::pair<key_type,data_type>(K,D));
110 return ImmutableMap(Canonicalize ? F.getCanonicalTree(T): T);
113 ImmutableMap remove(ImmutableMap Old, key_type_ref K) {
114 TreeTy *T = F.remove(Old.Root,K);
115 return ImmutableMap(Canonicalize ? F.getCanonicalTree(T): T);
118 typename TreeTy::Factory *getTreeFactory() const {
119 return const_cast<typename TreeTy::Factory *>(&F);
123 Factory(const Factory& RHS) = delete;
124 void operator=(const Factory& RHS) = delete;
127 bool contains(key_type_ref K) const {
128 return Root ? Root->contains(K) : false;
131 bool operator==(const ImmutableMap &RHS) const {
132 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
135 bool operator!=(const ImmutableMap &RHS) const {
136 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
139 TreeTy *getRoot() const {
140 if (Root) { Root->retain(); }
144 TreeTy *getRootWithoutRetain() const { return Root; }
146 void manualRetain() {
147 if (Root) Root->retain();
150 void manualRelease() {
151 if (Root) Root->release();
154 bool isEmpty() const { return !Root; }
156 //===--------------------------------------------------===//
157 // Foreach - A limited form of map iteration.
158 //===--------------------------------------------------===//
161 template <typename Callback>
164 void operator()(value_type_ref V) { C(V.first,V.second); }
167 template <typename Callback>
168 struct CBWrapperRef {
170 CBWrapperRef(Callback& c) : C(c) {}
172 void operator()(value_type_ref V) { C(V.first,V.second); }
176 template <typename Callback>
177 void foreach(Callback& C) {
179 CBWrapperRef<Callback> CB(C);
184 template <typename Callback>
187 CBWrapper<Callback> CB;
192 //===--------------------------------------------------===//
194 //===--------------------------------------------------===//
196 void verify() const { if (Root) Root->verify(); }
198 //===--------------------------------------------------===//
200 //===--------------------------------------------------===//
202 class iterator : public ImutAVLValueIterator<ImmutableMap> {
203 iterator() = default;
204 explicit iterator(TreeTy *Tree) : iterator::ImutAVLValueIterator(Tree) {}
205 friend class ImmutableMap;
208 key_type_ref getKey() const { return (*this)->first; }
209 data_type_ref getData() const { return (*this)->second; }
212 iterator begin() const { return iterator(Root); }
213 iterator end() const { return iterator(); }
215 data_type* lookup(key_type_ref K) const {
217 TreeTy* T = Root->find(K);
218 if (T) return &T->getValue().second;
224 /// getMaxElement - Returns the <key,value> pair in the ImmutableMap for
225 /// which key is the highest in the ordering of keys in the map. This
226 /// method returns NULL if the map is empty.
227 value_type* getMaxElement() const {
228 return Root ? &(Root->getMaxElement()->getValue()) : nullptr;
231 //===--------------------------------------------------===//
233 //===--------------------------------------------------===//
235 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
237 static inline void Profile(FoldingSetNodeID& ID, const ImmutableMap& M) {
238 ID.AddPointer(M.Root);
241 inline void Profile(FoldingSetNodeID& ID) const {
242 return Profile(ID,*this);
246 // NOTE: This will possibly become the new implementation of ImmutableMap some day.
247 template <typename KeyT, typename ValT,
248 typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
249 class ImmutableMapRef {
251 typedef typename ValInfo::value_type value_type;
252 typedef typename ValInfo::value_type_ref value_type_ref;
253 typedef typename ValInfo::key_type key_type;
254 typedef typename ValInfo::key_type_ref key_type_ref;
255 typedef typename ValInfo::data_type data_type;
256 typedef typename ValInfo::data_type_ref data_type_ref;
257 typedef ImutAVLTree<ValInfo> TreeTy;
258 typedef typename TreeTy::Factory FactoryTy;
265 /// Constructs a map from a pointer to a tree root. In general one
266 /// should use a Factory object to create maps instead of directly
267 /// invoking the constructor, but there are cases where make this
268 /// constructor public is useful.
269 explicit ImmutableMapRef(const TreeTy *R, FactoryTy *F)
270 : Root(const_cast<TreeTy *>(R)), Factory(F) {
276 explicit ImmutableMapRef(const ImmutableMap<KeyT, ValT> &X,
277 typename ImmutableMap<KeyT, ValT>::Factory &F)
278 : Root(X.getRootWithoutRetain()),
279 Factory(F.getTreeFactory()) {
280 if (Root) { Root->retain(); }
283 ImmutableMapRef(const ImmutableMapRef &X) : Root(X.Root), Factory(X.Factory) {
289 ImmutableMapRef &operator=(const ImmutableMapRef &X) {
290 if (Root != X.Root) {
308 static inline ImmutableMapRef getEmptyMap(FactoryTy *F) {
309 return ImmutableMapRef(0, F);
312 void manualRetain() {
313 if (Root) Root->retain();
316 void manualRelease() {
317 if (Root) Root->release();
320 ImmutableMapRef add(key_type_ref K, data_type_ref D) const {
321 TreeTy *NewT = Factory->add(Root, std::pair<key_type, data_type>(K, D));
322 return ImmutableMapRef(NewT, Factory);
325 ImmutableMapRef remove(key_type_ref K) const {
326 TreeTy *NewT = Factory->remove(Root, K);
327 return ImmutableMapRef(NewT, Factory);
330 bool contains(key_type_ref K) const {
331 return Root ? Root->contains(K) : false;
334 ImmutableMap<KeyT, ValT> asImmutableMap() const {
335 return ImmutableMap<KeyT, ValT>(Factory->getCanonicalTree(Root));
338 bool operator==(const ImmutableMapRef &RHS) const {
339 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
342 bool operator!=(const ImmutableMapRef &RHS) const {
343 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
346 bool isEmpty() const { return !Root; }
348 //===--------------------------------------------------===//
350 //===--------------------------------------------------===//
352 void verify() const {
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 { return Profile(ID, *this); }
403 } // end namespace llvm