include/llvm/ADT/ImmutableMap.h

   1 //===--- ImmutableMap.h - Immutable (functional) map interface --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the ImmutableMap class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_IMMAP_H
  15 #define LLVM_ADT_IMMAP_H
  16
  17 #include "llvm/ADT/ImmutableSet.h"
  18
  19 namespace llvm {
  20
  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;
  32
  33   static inline key_type_ref KeyOfValue(value_type_ref V) {
  34     return V.first;
  35   }
  36
  37   static inline data_type_ref DataOfValue(value_type_ref V) {
  38     return V.second;
  39   }
  40
  41   static inline bool isEqual(key_type_ref L, key_type_ref R) {
  42     return ImutContainerInfo<T>::isEqual(L,R);
  43   }
  44   static inline bool isLess(key_type_ref L, key_type_ref R) {
  45     return ImutContainerInfo<T>::isLess(L,R);
  46   }
  47
  48   static inline bool isDataEqual(data_type_ref L, data_type_ref R) {
  49     return ImutContainerInfo<S>::isEqual(L,R);
  50   }
  51
  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);
  55   }
  56 };
  57
  58
  59 template <typename KeyT, typename ValT,
  60           typename ValInfo = ImutKeyValueInfo<KeyT,ValT> >
  61 class ImmutableMap {
  62 public:
  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;
  70
  71 protected:
  72   TreeTy* Root;
  73
  74 public:
  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(); }
  81   }
  82   ImmutableMap(const ImmutableMap &X) : Root(X.Root) {
  83     if (Root) { Root->retain(); }
  84   }
  85   ImmutableMap &operator=(const ImmutableMap &X) {
  86     if (Root != X.Root) {
  87       if (X.Root) { X.Root->retain(); }
  88       if (Root) { Root->release(); }
  89       Root = X.Root;
  90     }
  91     return *this;
  92   }
  93   ~ImmutableMap() {
  94     if (Root) { Root->release(); }
  95   }
  96
  97   class Factory {
  98     typename TreeTy::Factory F;
  99     const bool Canonicalize;
 100
 101   public:
 102     Factory(bool canonicalize = true)
 103       : Canonicalize(canonicalize) {}
 104
 105     Factory(BumpPtrAllocator& Alloc, bool canonicalize = true)
 106       : F(Alloc), Canonicalize(canonicalize) {}
 107
 108     ImmutableMap getEmptyMap() { return ImmutableMap(F.getEmptyTree()); }
 109
 110     ImmutableMap add(ImmutableMap Old, key_type_ref K, data_type_ref D) {
 111       TreeTy *T = F.add(Old.Root, std::make_pair<key_type,data_type>(K,D));
 112       return ImmutableMap(Canonicalize ? F.getCanonicalTree(T): T);
 113     }
 114
 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);
 118     }
 119
 120   private:
 121     Factory(const Factory& RHS); // DO NOT IMPLEMENT
 122     void operator=(const Factory& RHS); // DO NOT IMPLEMENT
 123   };
 124
 125   bool contains(key_type_ref K) const {
 126     return Root ? Root->contains(K) : false;
 127   }
 128
 129   bool operator==(const ImmutableMap &RHS) const {
 130     return Root && RHS.Root ? Root->isEqual(*RHS.Root) : Root == RHS.Root;
 131   }
 132
 133   bool operator!=(const ImmutableMap &RHS) const {
 134     return Root && RHS.Root ? Root->isNotEqual(*RHS.Root) : Root != RHS.Root;
 135   }
 136
 137   TreeTy* getRoot() const {
 138     if (Root) { Root->retain(); }
 139     return Root;
 140   }
 141
 142   bool isEmpty() const { return !Root; }
 143
 144   //===--------------------------------------------------===//
 145   // Foreach - A limited form of map iteration.
 146   //===--------------------------------------------------===//
 147
 148 private:
 149   template <typename Callback>
 150   struct CBWrapper {
 151     Callback C;
 152     void operator()(value_type_ref V) { C(V.first,V.second); }
 153   };
 154
 155   template <typename Callback>
 156   struct CBWrapperRef {
 157     Callback &C;
 158     CBWrapperRef(Callback& c) : C(c) {}
 159
 160     void operator()(value_type_ref V) { C(V.first,V.second); }
 161   };
 162
 163 public:
 164   template <typename Callback>
 165   void foreach(Callback& C) {
 166     if (Root) {
 167       CBWrapperRef<Callback> CB(C);
 168       Root->foreach(CB);
 169     }
 170   }
 171
 172   template <typename Callback>
 173   void foreach() {
 174     if (Root) {
 175       CBWrapper<Callback> CB;
 176       Root->foreach(CB);
 177     }
 178   }
 179
 180   //===--------------------------------------------------===//
 181   // For testing.
 182   //===--------------------------------------------------===//
 183
 184   void verify() const { if (Root) Root->verify(); }
 185
 186   //===--------------------------------------------------===//
 187   // Iterators.
 188   //===--------------------------------------------------===//
 189
 190   class iterator {
 191     typename TreeTy::iterator itr;
 192
 193     iterator() {}
 194     iterator(TreeTy* t) : itr(t) {}
 195     friend class ImmutableMap;
 196
 197   public:
 198     value_type_ref operator*() const { return itr->getValue(); }
 199     value_type*    operator->() const { return &itr->getValue(); }
 200
 201     key_type_ref getKey() const { return itr->getValue().first; }
 202     data_type_ref getData() const { return itr->getValue().second; }
 203
 204
 205     iterator& operator++() { ++itr; return *this; }
 206     iterator  operator++(int) { iterator tmp(*this); ++itr; return tmp; }
 207     iterator& operator--() { --itr; return *this; }
 208     iterator  operator--(int) { iterator tmp(*this); --itr; return tmp; }
 209     bool operator==(const iterator& RHS) const { return RHS.itr == itr; }
 210     bool operator!=(const iterator& RHS) const { return RHS.itr != itr; }
 211   };
 212
 213   iterator begin() const { return iterator(Root); }
 214   iterator end() const { return iterator(); }
 215
 216   data_type* lookup(key_type_ref K) const {
 217     if (Root) {
 218       TreeTy* T = Root->find(K);
 219       if (T) return &T->getValue().second;
 220     }
 221
 222     return 0;
 223   }
 224
 225   /// getMaxElement - Returns the <key,value> pair in the ImmutableMap for
 226   ///  which key is the highest in the ordering of keys in the map.  This
 227   ///  method returns NULL if the map is empty.
 228   value_type* getMaxElement() const {
 229     return Root ? &(Root->getMaxElement()->getValue()) : 0;
 230   }
 231
 232   //===--------------------------------------------------===//
 233   // Utility methods.
 234   //===--------------------------------------------------===//
 235
 236   unsigned getHeight() const { return Root ? Root->getHeight() : 0; }
 237
 238   static inline void Profile(FoldingSetNodeID& ID, const ImmutableMap& M) {
 239     ID.AddPointer(M.Root);
 240   }
 241
 242   inline void Profile(FoldingSetNodeID& ID) const {
 243     return Profile(ID,*this);
 244   }
 245 };
 246
 247 } // end namespace llvm
 248
 249 #endif