src/libsyntax/ptr.rs

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