compiler/rustc_ast/src/ptr.rs

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