src/libsyntax/ptr.rs

   1 //! The AST pointer.
   2 //!
   3 //! Provides `P<T>`, a frozen owned smart pointer, as a replacement for `@T` in
   4 //! the AST.
   5 //!
   6 //! # Motivations and benefits
   7 //!
   8 //! * **Identity**: sharing AST nodes is problematic for the various analysis
   9 //!   passes (e.g., one may be able to bypass the borrow checker with a shared
  10 //!   `ExprKind::AddrOf` node taking a mutable borrow). The only reason `@T` in the
  11 //!   AST hasn't caused issues is because of inefficient folding passes which
  12 //!   would always deduplicate any such shared nodes. Even if the AST were to
  13 //!   switch to an arena, this would still hold, i.e., it couldn't use `&'a T`,
  14 //!   but rather a wrapper like `P<'a, T>`.
  15 //!
  16 //! * **Immutability**: `P<T>` disallows mutating its inner `T`, unlike `Box<T>`
  17 //!   (unless it contains an `Unsafe` interior, but that may be denied later).
  18 //!   This mainly prevents mistakes, but can also enforces a kind of "purity".
  19 //!
  20 //! * **Efficiency**: folding can reuse allocation space for `P<T>` and `Vec<T>`,
  21 //!   the latter even when the input and output types differ (as it would be the
  22 //!   case with arenas or a GADT AST using type parameters to toggle features).
  23 //!
  24 //! * **Maintainability**: `P<T>` provides a fixed interface - `Deref`,
  25 //!   `and_then` and `map` - which can remain fully functional even if the
  26 //!   implementation changes (using a special thread-local heap, for example).
  27 //!   Moreover, a switch to, e.g., `P<'a, T>` would be easy and mostly automated.
  28
  29 use std::fmt::{self, Display, Debug};
  30 use std::iter::FromIterator;
  31 use std::ops::{Deref, DerefMut};
  32 use std::{slice, vec};
  33
  34 use rustc_serialize::{Encodable, Decodable, Encoder, Decoder};
  35
  36 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
  37                                            HashStable};
  38 /// An owned smart pointer.
  39 #[derive(Hash, PartialEq, Eq)]
  40 pub struct P<T: ?Sized> {
  41     ptr: Box<T>
  42 }
  43
  44 /// Construct a `P<T>` from a `T` value.
  45 #[allow(non_snake_case)]
  46 pub fn P<T: 'static>(value: T) -> P<T> {
  47     P {
  48         ptr: box value
  49     }
  50 }
  51
  52 impl<T: 'static> P<T> {
  53     /// Move out of the pointer.
  54     /// Intended for chaining transformations not covered by `map`.
  55     pub fn and_then<U, F>(self, f: F) -> U where
  56         F: FnOnce(T) -> U,
  57     {
  58         f(*self.ptr)
  59     }
  60
  61     /// Equivalent to `and_then(|x| x)`.
  62     pub fn into_inner(self) -> T {
  63         *self.ptr
  64     }
  65
  66     /// Produce a new `P<T>` from `self` without reallocating.
  67     pub fn map<F>(mut self, f: F) -> P<T> where
  68         F: FnOnce(T) -> T,
  69     {
  70         let x = f(*self.ptr);
  71         *self.ptr = x;
  72
  73         self
  74     }
  75
  76     /// Optionally produce a new `P<T>` from `self` without reallocating.
  77     pub fn filter_map<F>(mut self, f: F) -> Option<P<T>> where
  78         F: FnOnce(T) -> Option<T>,
  79     {
  80         *self.ptr = f(*self.ptr)?;
  81         Some(self)
  82     }
  83 }
  84
  85 impl<T: ?Sized> Deref for P<T> {
  86     type Target = T;
  87
  88     fn deref(&self) -> &T {
  89         &self.ptr
  90     }
  91 }
  92
  93 impl<T: ?Sized> DerefMut for P<T> {
  94     fn deref_mut(&mut self) -> &mut T {
  95         &mut self.ptr
  96     }
  97 }
  98
  99 impl<T: 'static + Clone> Clone for P<T> {
 100     fn clone(&self) -> P<T> {
 101         P((**self).clone())
 102     }
 103 }
 104
 105 impl<T: ?Sized + Debug> Debug for P<T> {
 106     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 107         Debug::fmt(&self.ptr, f)
 108     }
 109 }
 110
 111 impl<T: Display> Display for P<T> {
 112     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 113         Display::fmt(&**self, f)
 114     }
 115 }
 116
 117 impl<T> fmt::Pointer for P<T> {
 118     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 119         fmt::Pointer::fmt(&self.ptr, f)
 120     }
 121 }
 122
 123 impl<T: 'static + Decodable> Decodable for P<T> {
 124     fn decode<D: Decoder>(d: &mut D) -> Result<P<T>, D::Error> {
 125         Decodable::decode(d).map(P)
 126     }
 127 }
 128
 129 impl<T: Encodable> Encodable for P<T> {
 130     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 131         (**self).encode(s)
 132     }
 133 }
 134
 135 impl<T> P<[T]> {
 136     pub const fn new() -> P<[T]> {
 137         // HACK(eddyb) bypass the lack of a `const fn` to create an empty `Box<[T]>`
 138         // (as trait methods, `default` in this case, can't be `const fn` yet).
 139         P {
 140             ptr: unsafe {
 141                 use std::ptr::NonNull;
 142                 std::mem::transmute(NonNull::<[T; 0]>::dangling() as NonNull<[T]>)
 143             },
 144         }
 145     }
 146
 147     #[inline(never)]
 148     pub fn from_vec(v: Vec<T>) -> P<[T]> {
 149         P { ptr: v.into_boxed_slice() }
 150     }
 151
 152     #[inline(never)]
 153     pub fn into_vec(self) -> Vec<T> {
 154         self.ptr.into_vec()
 155     }
 156 }
 157
 158 impl<T> Default for P<[T]> {
 159     /// Creates an empty `P<[T]>`.
 160     fn default() -> P<[T]> {
 161         P::new()
 162     }
 163 }
 164
 165 impl<T: Clone> Clone for P<[T]> {
 166     fn clone(&self) -> P<[T]> {
 167         P::from_vec(self.to_vec())
 168     }
 169 }
 170
 171 impl<T> From<Vec<T>> for P<[T]> {
 172     fn from(v: Vec<T>) -> Self {
 173         P::from_vec(v)
 174     }
 175 }
 176
 177 impl<T> Into<Vec<T>> for P<[T]> {
 178     fn into(self) -> Vec<T> {
 179         self.into_vec()
 180     }
 181 }
 182
 183 impl<T> FromIterator<T> for P<[T]> {
 184     fn from_iter<I: IntoIterator<Item=T>>(iter: I) -> P<[T]> {
 185         P::from_vec(iter.into_iter().collect())
 186     }
 187 }
 188
 189 impl<T> IntoIterator for P<[T]> {
 190     type Item = T;
 191     type IntoIter = vec::IntoIter<T>;
 192
 193     fn into_iter(self) -> Self::IntoIter {
 194         self.into_vec().into_iter()
 195     }
 196 }
 197
 198 impl<'a, T> IntoIterator for &'a P<[T]> {
 199     type Item = &'a T;
 200     type IntoIter = slice::Iter<'a, T>;
 201     fn into_iter(self) -> Self::IntoIter {
 202         self.ptr.into_iter()
 203     }
 204 }
 205
 206 impl<T: Encodable> Encodable for P<[T]> {
 207     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 208         Encodable::encode(&**self, s)
 209     }
 210 }
 211
 212 impl<T: Decodable> Decodable for P<[T]> {
 213     fn decode<D: Decoder>(d: &mut D) -> Result<P<[T]>, D::Error> {
 214         Ok(P::from_vec(Decodable::decode(d)?))
 215     }
 216 }
 217
 218 impl<CTX, T> HashStable<CTX> for P<T>
 219     where T: ?Sized + HashStable<CTX>
 220 {
 221     fn hash_stable<W: StableHasherResult>(&self,
 222                                           hcx: &mut CTX,
 223                                           hasher: &mut StableHasher<W>) {
 224         (**self).hash_stable(hcx, hasher);
 225     }
 226 }