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_IMMAP_H
15 #define LLVM_ADT_IMMAP_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);
121 Factory(const Factory& RHS); // DO NOT IMPLEMENT
122 void operator=(const Factory& RHS); // DO NOT IMPLEMENT
125 bool contains(key_type_ref K) const {
126 return Root ? Root->contains(K) : false;
129 bool operator==(const ImmutableMap &RHS) const {
130 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
133 bool operator!=(const ImmutableMap &RHS) const {
134 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
137 TreeTy *getRoot() const {
138 if (Root) { Root->retain(); }
142 TreeTy *getRootWithoutRetain() const {
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 //===--------------------------------------------------===//
203 typename TreeTy::iterator itr;
206 iterator(TreeTy* t) : itr(t) {}
207 friend class ImmutableMap;
210 value_type_ref operator*() const { return itr->getValue(); }
211 value_type* operator->() const { return &itr->getValue(); }
213 key_type_ref getKey() const { return itr->getValue().first; }
214 data_type_ref getData() const { return itr->getValue().second; }
217 iterator& operator++() { ++itr; return *this; }
218 iterator operator++(int) { iterator tmp(*this); ++itr; return tmp; }
219 iterator& operator--() { --itr; return *this; }
220 iterator operator--(int) { iterator tmp(*this); --itr; return tmp; }
221 bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
222 bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
225 iterator begin() const { return iterator(Root); }
226 iterator end() const { return iterator(); }
228 data_type* lookup(key_type_ref K) const {
230 TreeTy* T = Root->find(K);
231 if (T) return &T->getValue().second;
237 /// getMaxElement - Returns the <key,value> pair in the ImmutableMap for
238 /// which key is the highest in the ordering of keys in the map. This
239 /// method returns NULL if the map is empty.
240 value_type* getMaxElement() const {
241 return Root ? &(Root->getMaxElement()->getValue()) : 0;
244 //===--------------------------------------------------===//
246 //===--------------------------------------------------===//
248 unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
250 static inline void Profile(FoldingSetNodeID& ID, const ImmutableMap& M) {
251 ID.AddPointer(M.Root);
254 inline void Profile(FoldingSetNodeID& ID) const {
255 return Profile(ID,*this);
259 } // end namespace llvm