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 and
22 /// 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 bool isEqual(key_type_ref L, key_type_ref R) {
38 return ImutContainerInfo<T>::isEqual(L,R);
41 static inline bool isLess(key_type_ref L, key_type_ref R) {
42 return ImutContainerInfo<T>::isLess(L,R);
45 static inline void Profile(FoldingSetNodeID& ID, value_type_ref V) {
46 ImutContainerInfo<T>::Profile(ID, V.first);
47 ImutContainerInfo<S>::Profile(ID, V.second);
52 template <typename KeyT, typename ValT,
53 typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
56 typedef typename ValInfo::value_type value_type;
57 typedef typename ValInfo::value_type_ref value_type_ref;
58 typedef typename ValInfo::key_type key_type;
59 typedef typename ValInfo::key_type_ref key_type_ref;
60 typedef typename ValInfo::data_type data_type;
61 typedef typename ValInfo::data_type_ref data_type_ref;
62 typedef ImutAVLTree<ValInfo> TreeTy;
68 /// Constructs a map from a pointer to a tree root. In general one
69 /// should use a Factory object to create maps instead of directly
70 /// invoking the constructor, but there are cases where make this
71 /// constructor public is useful.
72 explicit ImmutableMap(TreeTy* R) : Root(R) {}
75 typename TreeTy::Factory F;
80 ImmutableMap GetEmptyMap() { return ImmutableMap(F.GetEmptyTree()); }
82 ImmutableMap Add(ImmutableMap Old, key_type_ref K, data_type_ref D) {
83 return ImmutableMap(F.Add(Old.Root,
84 std::make_pair<key_type,data_type>(K,D)));
87 ImmutableMap Remove(ImmutableMap Old, key_type_ref K) {
88 return ImmutableMap(F.Remove(Old.Root,K));
92 Factory(const Factory& RHS) {};
93 void operator=(const Factory& RHS) {};
98 bool contains(key_type_ref K) const {
99 return Root ? Root->contains(K) : false;
102 data_type* find(key_type_ref K) const {
104 TreeTy* T = Root->find(K);
105 if (T) return &T->getValue().second;
111 bool operator==(ImmutableMap RHS) const {
112 return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
115 bool operator!=(ImmutableMap RHS) const {
116 return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
119 TreeTy* getRoot() const { return Root; }
121 bool isEmpty() const { return !Root; }
123 //===--------------------------------------------------===//
124 // Foreach - A limited form of map iteration.
125 //===--------------------------------------------------===//
128 template <typename Callback>
131 void operator()(value_type_ref V) { C(V.first,V.second); }
134 template <typename Callback>
135 struct CBWrapperRef {
137 CBWrapperRef(Callback& c) : C(c) {}
139 void operator()(value_type_ref V) { C(V.first,V.second); }
143 template <typename Callback>
144 void foreach(Callback& C) {
146 CBWrapperRef<Callback> CB(C);
151 template <typename Callback>
154 CBWrapper<Callback> CB;
159 //===--------------------------------------------------===//
161 //===--------------------------------------------------===//
163 void verify() const { if (Root) Root->verify(); }
165 //===--------------------------------------------------===//
167 //===--------------------------------------------------===//
170 typename TreeTy::iterator itr;
173 iterator(TreeTy* t) : itr(t) {}
174 friend class ImmutableSet<ValT,ValInfo>;
177 inline value_type_ref operator*() const { return itr->getValue(); }
178 inline key_type_ref getKey() const { return itr->getValue().first; }
179 inline data_type_ref getData() const { return itr->getValue().second; }
181 inline iterator& operator++() { ++itr; return *this; }
182 inline iterator operator++(int) { iterator tmp(*this); ++itr; return tmp; }
183 inline iterator& operator--() { --itr; return *this; }
184 inline iterator operator--(int) { iterator tmp(*this); --itr; return tmp; }
185 inline bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
186 inline bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
189 iterator begin() const { return iterator(Root); }
190 iterator end() const { return iterator(); }
192 //===--------------------------------------------------===//
194 //===--------------------------------------------------===//
196 inline unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
198 static inline void Profile(FoldingSetNodeID& ID, const ImmutableMap& M) {
199 ID.AddPointer(M.Root);
202 inline void Profile(FoldingSetNodeID& ID) const {
203 return Profile(ID,*this);
207 } // end namespace llvm