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::iter::FromIterator;
  26 use std::ops::{Deref, DerefMut};
  27 use std::{slice, vec};
  28
  29 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
  30
  31 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  32 /// An owned smart pointer.
  33 pub struct P<T: ?Sized> {
  34     ptr: Box<T>,
  35 }
  36
  37 /// Construct a `P<T>` from a `T` value.
  38 #[allow(non_snake_case)]
  39 pub fn P<T: 'static>(value: T) -> P<T> {
  40     P { ptr: Box::new(value) }
  41 }
  42
  43 impl<T: 'static> P<T> {
  44     /// Move out of the pointer.
  45     /// Intended for chaining transformations not covered by `map`.
  46     pub fn and_then<U, F>(self, f: F) -> U
  47     where
  48         F: FnOnce(T) -> U,
  49     {
  50         f(*self.ptr)
  51     }
  52
  53     /// Equivalent to `and_then(|x| x)`.
  54     pub fn into_inner(self) -> T {
  55         *self.ptr
  56     }
  57
  58     /// Produce a new `P<T>` from `self` without reallocating.
  59     pub fn map<F>(mut self, f: F) -> P<T>
  60     where
  61         F: FnOnce(T) -> T,
  62     {
  63         let x = f(*self.ptr);
  64         *self.ptr = x;
  65
  66         self
  67     }
  68
  69     /// Optionally produce a new `P<T>` from `self` without reallocating.
  70     pub fn filter_map<F>(mut self, f: F) -> Option<P<T>>
  71     where
  72         F: FnOnce(T) -> Option<T>,
  73     {
  74         *self.ptr = f(*self.ptr)?;
  75         Some(self)
  76     }
  77 }
  78
  79 impl<T: ?Sized> Deref for P<T> {
  80     type Target = T;
  81
  82     fn deref(&self) -> &T {
  83         &self.ptr
  84     }
  85 }
  86
  87 impl<T: ?Sized> DerefMut for P<T> {
  88     fn deref_mut(&mut self) -> &mut T {
  89         &mut self.ptr
  90     }
  91 }
  92
  93 impl<T: 'static + Clone> Clone for P<T> {
  94     fn clone(&self) -> P<T> {
  95         P((**self).clone())
  96     }
  97 }
  98
  99 impl<T: ?Sized + Debug> Debug for P<T> {
 100     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 101         Debug::fmt(&self.ptr, f)
 102     }
 103 }
 104
 105 impl<T: Display> Display for P<T> {
 106     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 107         Display::fmt(&**self, f)
 108     }
 109 }
 110
 111 impl<T> fmt::Pointer for P<T> {
 112     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 113         fmt::Pointer::fmt(&self.ptr, f)
 114     }
 115 }
 116
 117 impl<D: Decoder, T: 'static + Decodable<D>> Decodable<D> for P<T> {
 118     fn decode(d: &mut D) -> P<T> {
 119         P(Decodable::decode(d))
 120     }
 121 }
 122
 123 impl<S: Encoder, T: Encodable<S>> Encodable<S> for P<T> {
 124     fn encode(&self, s: &mut S) {
 125         (**self).encode(s);
 126     }
 127 }
 128
 129 impl<T> P<[T]> {
 130     pub const fn new() -> P<[T]> {
 131         P { ptr: Box::default() }
 132     }
 133
 134     #[inline(never)]
 135     pub fn from_vec(v: Vec<T>) -> P<[T]> {
 136         P { ptr: v.into_boxed_slice() }
 137     }
 138
 139     #[inline(never)]
 140     pub fn into_vec(self) -> Vec<T> {
 141         self.ptr.into_vec()
 142     }
 143 }
 144
 145 impl<T> Default for P<[T]> {
 146     /// Creates an empty `P<[T]>`.
 147     fn default() -> P<[T]> {
 148         P::new()
 149     }
 150 }
 151
 152 impl<T: Clone> Clone for P<[T]> {
 153     fn clone(&self) -> P<[T]> {
 154         P::from_vec(self.to_vec())
 155     }
 156 }
 157
 158 impl<T> From<Vec<T>> for P<[T]> {
 159     fn from(v: Vec<T>) -> Self {
 160         P::from_vec(v)
 161     }
 162 }
 163
 164 impl<T> Into<Vec<T>> for P<[T]> {
 165     fn into(self) -> Vec<T> {
 166         self.into_vec()
 167     }
 168 }
 169
 170 impl<T> FromIterator<T> for P<[T]> {
 171     fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> P<[T]> {
 172         P::from_vec(iter.into_iter().collect())
 173     }
 174 }
 175
 176 impl<T> IntoIterator for P<[T]> {
 177     type Item = T;
 178     type IntoIter = vec::IntoIter<T>;
 179
 180     fn into_iter(self) -> Self::IntoIter {
 181         self.into_vec().into_iter()
 182     }
 183 }
 184
 185 impl<'a, T> IntoIterator for &'a P<[T]> {
 186     type Item = &'a T;
 187     type IntoIter = slice::Iter<'a, T>;
 188     fn into_iter(self) -> Self::IntoIter {
 189         self.ptr.into_iter()
 190     }
 191 }
 192
 193 impl<S: Encoder, T: Encodable<S>> Encodable<S> for P<[T]> {
 194     fn encode(&self, s: &mut S) {
 195         Encodable::encode(&**self, s);
 196     }
 197 }
 198
 199 impl<D: Decoder, T: Decodable<D>> Decodable<D> for P<[T]> {
 200     fn decode(d: &mut D) -> P<[T]> {
 201         P::from_vec(Decodable::decode(d))
 202     }
 203 }
 204
 205 impl<CTX, T> HashStable<CTX> for P<T>
 206 where
 207     T: ?Sized + HashStable<CTX>,
 208 {
 209     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
 210         (**self).hash_stable(hcx, hasher);
 211     }
 212 }