X-Git-Url: https://git.chrismorgan.info/anymap/blobdiff_plain/a1dadf856e0f8e2d4c553f5832f5987e74987731..ec57ec49be65359fe10b09b9d2130e7a9481020b:/src/lib.rs diff --git a/src/lib.rs b/src/lib.rs index f5ee7b3..d2b85aa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,193 +1,508 @@ //! This crate provides the `AnyMap` type, a safe and convenient store for one value of each type. -#![crate_id = "anymap#0.9.0"] -#![crate_type = "rlib"] -#![crate_type = "dylib"] -#![feature(default_type_params)] -#![warn(unnecessary_qualification, non_uppercase_statics, - variant_size_difference, managed_heap_memory, unnecessary_typecast, - missing_doc, unused_result)] +#![cfg_attr(all(feature = "bench", test), feature(test))] +#![warn(missing_docs, unused_results)] -#[cfg(test)] +#[cfg(all(feature = "bench", test))] extern crate test; -use std::any::Any; -use std::intrinsics::TypeId; -use std::collections::{Collection, HashMap, Mutable}; -use std::hash::{Hash, Hasher, Writer}; -use std::mem::{transmute, transmute_copy}; -use std::raw::TraitObject; +use std::any::TypeId; +use std::marker::PhantomData; -struct TypeIdHasher; +use raw::RawMap; +use any::{UncheckedAnyExt, IntoBox, Any}; -struct TypeIdState { - value: u64, -} +macro_rules! impl_common_methods { + ( + field: $t:ident.$field:ident; + new() => $new:expr; + with_capacity($with_capacity_arg:ident) => $with_capacity:expr; + ) => { + impl $t { + /// Create an empty collection. + #[inline] + pub fn new() -> $t { + $t { + $field: $new, + } + } -impl Writer for TypeIdState { - #[inline(always)] - fn write(&mut self, bytes: &[u8]) { - // This expects to receive one and exactly one 64-bit value - debug_assert!(bytes.len() == 8); - unsafe { - std::ptr::copy_nonoverlapping_memory(&mut self.value, - transmute(&bytes[0]), - 1) - } - } -} + /// Creates an empty collection with the given initial capacity. + #[inline] + pub fn with_capacity($with_capacity_arg: usize) -> $t { + $t { + $field: $with_capacity, + } + } -impl Hasher for TypeIdHasher { - fn hash>(&self, value: &T) -> u64 { - let mut state = TypeIdState { - value: 0, - }; - value.hash(&mut state); - state.value - } -} + /// Returns the number of elements the collection can hold without reallocating. + #[inline] + pub fn capacity(&self) -> usize { + self.$field.capacity() + } -/// An extension of `AnyRefExt` allowing unchecked downcasting of trait objects to `&T`. -trait UncheckedAnyRefExt<'a> { - /// Returns a reference to the boxed value, assuming that it is of type `T`. This should only be - /// called if you are ABSOLUTELY CERTAIN of `T` as you will get really wacky output if it’s not. - unsafe fn as_ref_unchecked(self) -> &'a T; -} - -impl<'a> UncheckedAnyRefExt<'a> for &'a Any { - #[inline] - unsafe fn as_ref_unchecked(self) -> &'a T { - // Get the raw representation of the trait object - let to: TraitObject = transmute_copy(&self); + /// Reserves capacity for at least `additional` more elements to be inserted + /// in the collection. The collection may reserve more space to avoid + /// frequent reallocations. + /// + /// # Panics + /// + /// Panics if the new allocation size overflows `usize`. + #[inline] + pub fn reserve(&mut self, additional: usize) { + self.$field.reserve(additional) + } - // Extract the data pointer - transmute(to.data) - } -} + /// Shrinks the capacity of the collection as much as possible. It will drop + /// down as much as possible while maintaining the internal rules + /// and possibly leaving some space in accordance with the resize policy. + #[inline] + pub fn shrink_to_fit(&mut self) { + self.$field.shrink_to_fit() + } -/// An extension of `AnyMutRefExt` allowing unchecked downcasting of trait objects to `&mut T`. -trait UncheckedAnyMutRefExt<'a> { - /// Returns a reference to the boxed value, assuming that it is of type `T`. This should only be - /// called if you are ABSOLUTELY CERTAIN of `T` as you will get really wacky output if it’s not. - unsafe fn as_mut_unchecked(self) -> &'a mut T; -} + /// Returns the number of items in the collection. + #[inline] + pub fn len(&self) -> usize { + self.$field.len() + } -impl<'a> UncheckedAnyMutRefExt<'a> for &'a mut Any { - #[inline] - unsafe fn as_mut_unchecked(self) -> &'a mut T { - // Get the raw representation of the trait object - let to: TraitObject = transmute_copy(&self); + /// Returns true if there are no items in the collection. + #[inline] + pub fn is_empty(&self) -> bool { + self.$field.is_empty() + } - // Extract the data pointer - transmute(to.data) + /// Removes all items from the collection. Keeps the allocated memory for reuse. + #[inline] + pub fn clear(&mut self) { + self.$field.clear() + } + } } } -/// A map containing zero or one values for any given type and allowing convenient, +pub mod any; +pub mod raw; + +/// A collection containing zero or one values for any given type and allowing convenient, /// type-safe access to those values. /// +/// The type parameter `A` allows you to use a different value type; normally you will want it to +/// be `anymap::any::Any`, but there are other choices: +/// +/// - If you want the entire map to be cloneable, use `CloneAny` instead of `Any`. +/// - You can add on `+ Send` and/or `+ Sync` (e.g. `Map`) to add those bounds. +/// /// ```rust /// # use anymap::AnyMap; /// let mut data = AnyMap::new(); -/// assert_eq!(data.find(), None::<&int>); -/// data.insert(42i); -/// assert_eq!(data.find(), Some(&42i)); -/// data.remove::(); -/// assert_eq!(data.find::(), None); +/// assert_eq!(data.get(), None::<&i32>); +/// data.insert(42i32); +/// assert_eq!(data.get(), Some(&42i32)); +/// data.remove::(); +/// assert_eq!(data.get::(), None); /// -/// #[deriving(PartialEq, Show)] +/// #[derive(Clone, PartialEq, Debug)] /// struct Foo { /// str: String, /// } /// -/// assert_eq!(data.find::(), None); -/// data.insert(Foo { str: "foo".to_string() }); -/// assert_eq!(data.find(), Some(&Foo { str: "foo".to_string() })); -/// data.find_mut::().map(|foo| foo.str.push_char('t')); -/// assert_eq!(data.find::().unwrap().str.as_slice(), "foot"); +/// assert_eq!(data.get::(), None); +/// data.insert(Foo { str: format!("foo") }); +/// assert_eq!(data.get(), Some(&Foo { str: format!("foo") })); +/// data.get_mut::().map(|foo| foo.str.push('t')); +/// assert_eq!(&*data.get::().unwrap().str, "foot"); /// ``` /// /// Values containing non-static references are not permitted. -pub struct AnyMap { - data: HashMap, TypeIdHasher>, +#[derive(Debug)] +pub struct Map { + raw: RawMap, } -impl AnyMap { - /// Construct a new `AnyMap`. - pub fn new() -> AnyMap { - AnyMap { - data: HashMap::with_hasher(TypeIdHasher), +// #[derive(Clone)] would want A to implement Clone, but in reality it’s only Box that can. +impl Clone for Map where Box: Clone { + fn clone(&self) -> Map { + Map { + raw: self.raw.clone(), } } } -impl AnyMap { - /// Retrieve the value stored in the map for the type `T`, if it exists. - pub fn find<'a, T: 'static>(&'a self) -> Option<&'a T> { - self.data.find(&TypeId::of::()).map(|any| unsafe { any.as_ref_unchecked::() }) +/// The most common type of `Map`: just using `Any`. +/// +/// Why is this a separate type alias rather than a default value for `Map`? `Map::new()` +/// doesn’t seem to be happy to infer that it should go with the default value. +/// It’s a bit sad, really. Ah well, I guess this approach will do. +pub type AnyMap = Map; + +impl_common_methods! { + field: Map.raw; + new() => RawMap::new(); + with_capacity(capacity) => RawMap::with_capacity(capacity); +} + +impl Map { + /// Returns a reference to the value stored in the collection for the type `T`, if it exists. + pub fn get>(&self) -> Option<&T> { + self.raw.get(&TypeId::of::()) + .map(|any| unsafe { any.downcast_ref_unchecked::() }) + } + + /// Returns a mutable reference to the value stored in the collection for the type `T`, + /// if it exists. + pub fn get_mut>(&mut self) -> Option<&mut T> { + self.raw.get_mut(&TypeId::of::()) + .map(|any| unsafe { any.downcast_mut_unchecked::() }) } - /// Retrieve a mutable reference to the value stored in the map for the type `T`, if it exists. - pub fn find_mut<'a, T: 'static>(&'a mut self) -> Option<&'a mut T> { - self.data.find_mut(&TypeId::of::()).map(|any| unsafe { any.as_mut_unchecked::() }) + /// Sets the value stored in the collection for the type `T`. + /// If the collection already had a value of type `T`, that value is returned. + /// Otherwise, `None` is returned. + pub fn insert>(&mut self, value: T) -> Option { + unsafe { + self.raw.insert(TypeId::of::(), value.into_box()) + .map(|any| *any.downcast_unchecked::()) + } } - /// Set the value contained in the map for the type `T`. - /// This will override any previous value stored. - pub fn insert(&mut self, value: T) { - self.data.insert(TypeId::of::(), box value as Box); + /// Removes the `T` value from the collection, + /// returning it if there was one or `None` if there was not. + pub fn remove>(&mut self) -> Option { + self.raw.remove(&TypeId::of::()) + .map(|any| *unsafe { any.downcast_unchecked::() }) } - /// Remove the value for the type `T` if it existed. - pub fn remove(&mut self) { - self.data.remove(&TypeId::of::()); + /// Returns true if the collection contains a value of type `T`. + #[inline] + pub fn contains>(&self) -> bool { + self.raw.contains_key(&TypeId::of::()) + } + + /// Gets the entry for the given type in the collection for in-place manipulation + pub fn entry>(&mut self) -> Entry { + match self.raw.entry(TypeId::of::()) { + raw::Entry::Occupied(e) => Entry::Occupied(OccupiedEntry { + inner: e, + type_: PhantomData, + }), + raw::Entry::Vacant(e) => Entry::Vacant(VacantEntry { + inner: e, + type_: PhantomData, + }), + } } } -impl Collection for AnyMap { - fn len(&self) -> uint { - self.data.len() +impl AsRef> for Map { + fn as_ref(&self) -> &RawMap { + &self.raw } +} - fn is_empty(&self) -> bool { - self.data.is_empty() +impl AsMut> for Map { + fn as_mut(&mut self) -> &mut RawMap { + &mut self.raw } } -impl Mutable for AnyMap { - fn clear(&mut self) { - self.data.clear(); +impl Into> for Map { + fn into(self) -> RawMap { + self.raw } } -#[bench] -fn bench_insertion(b: &mut ::test::Bencher) { - b.iter(|| { - let mut data = AnyMap::new(); - for _ in range(0u, 100) { - data.insert(42i); - } - }) +/// A view into a single occupied location in an `Map`. +pub struct OccupiedEntry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { + inner: raw::OccupiedEntry<'a, A>, + type_: PhantomData, } -#[bench] -fn bench_find_missing(b: &mut ::test::Bencher) { - b.iter(|| { - let data = AnyMap::new(); - for _ in range(0u, 100) { - assert_eq!(data.find(), None::<&int>); +/// A view into a single empty location in an `Map`. +pub struct VacantEntry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { + inner: raw::VacantEntry<'a, A>, + type_: PhantomData, +} + +/// A view into a single location in an `Map`, which may be vacant or occupied. +pub enum Entry<'a, A: ?Sized + UncheckedAnyExt, V: 'a> { + /// An occupied Entry + Occupied(OccupiedEntry<'a, A, V>), + /// A vacant Entry + Vacant(VacantEntry<'a, A, V>), +} + +impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> Entry<'a, A, V> { + /// Ensures a value is in the entry by inserting the default if empty, and returns + /// a mutable reference to the value in the entry. + pub fn or_insert(self, default: V) -> &'a mut V { + match self { + Entry::Occupied(inner) => inner.into_mut(), + Entry::Vacant(inner) => inner.insert(default), } - }) + } + + /// Ensures a value is in the entry by inserting the result of the default function if empty, + /// and returns a mutable reference to the value in the entry. + pub fn or_insert_with V>(self, default: F) -> &'a mut V { + match self { + Entry::Occupied(inner) => inner.into_mut(), + Entry::Vacant(inner) => inner.insert(default()), + } + } +} + +impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> OccupiedEntry<'a, A, V> { + /// Gets a reference to the value in the entry + pub fn get(&self) -> &V { + unsafe { self.inner.get().downcast_ref_unchecked() } + } + + /// Gets a mutable reference to the value in the entry + pub fn get_mut(&mut self) -> &mut V { + unsafe { self.inner.get_mut().downcast_mut_unchecked() } + } + + /// Converts the OccupiedEntry into a mutable reference to the value in the entry + /// with a lifetime bound to the collection itself + pub fn into_mut(self) -> &'a mut V { + unsafe { self.inner.into_mut().downcast_mut_unchecked() } + } + + /// Sets the value of the entry, and returns the entry's old value + pub fn insert(&mut self, value: V) -> V { + unsafe { *self.inner.insert(value.into_box()).downcast_unchecked() } + } + + /// Takes the value out of the entry, and returns it + pub fn remove(self) -> V { + unsafe { *self.inner.remove().downcast_unchecked() } + } +} + +impl<'a, A: ?Sized + UncheckedAnyExt, V: IntoBox> VacantEntry<'a, A, V> { + /// Sets the value of the entry with the VacantEntry's key, + /// and returns a mutable reference to it + pub fn insert(self, value: V) -> &'a mut V { + unsafe { self.inner.insert(value.into_box()).downcast_mut_unchecked() } + } +} + +#[cfg(all(feature = "bench", test))] +mod bench { + use AnyMap; + use test::Bencher; + use test::black_box; + + #[bench] + fn insertion(b: &mut Bencher) { + b.iter(|| { + let mut data = AnyMap::new(); + for _ in 0..100 { + let _ = data.insert(42); + } + }) + } + + #[bench] + fn get_missing(b: &mut Bencher) { + b.iter(|| { + let data = AnyMap::new(); + for _ in 0..100 { + assert_eq!(data.get(), None::<&i32>); + } + }) + } + + #[bench] + fn get_present(b: &mut Bencher) { + b.iter(|| { + let mut data = AnyMap::new(); + let _ = data.insert(42); + // These inner loops are a feeble attempt to drown the other factors. + for _ in 0..100 { + assert_eq!(data.get(), Some(&42)); + } + }) + } + + macro_rules! big_benchmarks { + ($name:ident, $($T:ident)*) => ( + #[bench] + fn $name(b: &mut Bencher) { + $( + struct $T(&'static str); + )* + + b.iter(|| { + let mut data = AnyMap::new(); + $( + let _ = black_box(data.insert($T(stringify!($T)))); + )* + $( + let _ = black_box(data.get::<$T>()); + )* + }) + } + ); + } + + // Caution: if the macro does too much (e.g. assertions) this goes from being slow to being + // *really* slow (like add a minute for each assertion on it) and memory-hungry (like, adding + // several hundred megabytes to the peak for each assertion). + big_benchmarks! { + insert_and_get_on_260_types, + A0 B0 C0 D0 E0 F0 G0 H0 I0 J0 K0 L0 M0 N0 O0 P0 Q0 R0 S0 T0 U0 V0 W0 X0 Y0 Z0 + A1 B1 C1 D1 E1 F1 G1 H1 I1 J1 K1 L1 M1 N1 O1 P1 Q1 R1 S1 T1 U1 V1 W1 X1 Y1 Z1 + A2 B2 C2 D2 E2 F2 G2 H2 I2 J2 K2 L2 M2 N2 O2 P2 Q2 R2 S2 T2 U2 V2 W2 X2 Y2 Z2 + A3 B3 C3 D3 E3 F3 G3 H3 I3 J3 K3 L3 M3 N3 O3 P3 Q3 R3 S3 T3 U3 V3 W3 X3 Y3 Z3 + A4 B4 C4 D4 E4 F4 G4 H4 I4 J4 K4 L4 M4 N4 O4 P4 Q4 R4 S4 T4 U4 V4 W4 X4 Y4 Z4 + A5 B5 C5 D5 E5 F5 G5 H5 I5 J5 K5 L5 M5 N5 O5 P5 Q5 R5 S5 T5 U5 V5 W5 X5 Y5 Z5 + A6 B6 C6 D6 E6 F6 G6 H6 I6 J6 K6 L6 M6 N6 O6 P6 Q6 R6 S6 T6 U6 V6 W6 X6 Y6 Z6 + A7 B7 C7 D7 E7 F7 G7 H7 I7 J7 K7 L7 M7 N7 O7 P7 Q7 R7 S7 T7 U7 V7 W7 X7 Y7 Z7 + A8 B8 C8 D8 E8 F8 G8 H8 I8 J8 K8 L8 M8 N8 O8 P8 Q8 R8 S8 T8 U8 V8 W8 X8 Y8 Z8 + A9 B9 C9 D9 E9 F9 G9 H9 I9 J9 K9 L9 M9 N9 O9 P9 Q9 R9 S9 T9 U9 V9 W9 X9 Y9 Z9 + } + + big_benchmarks! { + insert_and_get_on_26_types, + A B C D E F G H I J K L M N O P Q R S T U V W X Y Z + } } -#[bench] -fn bench_find_present(b: &mut ::test::Bencher) { - b.iter(|| { - let mut data = AnyMap::new(); - data.insert(42i); - // These inner loops are a feeble attempt to drown the other factors. - for _ in range(0u, 100) { - assert_eq!(data.find(), Some(&42i)); +#[cfg(test)] +mod tests { + use {Map, AnyMap, Entry}; + use any::{Any, CloneAny}; + + #[derive(Clone, Debug, PartialEq)] struct A(i32); + #[derive(Clone, Debug, PartialEq)] struct B(i32); + #[derive(Clone, Debug, PartialEq)] struct C(i32); + #[derive(Clone, Debug, PartialEq)] struct D(i32); + #[derive(Clone, Debug, PartialEq)] struct E(i32); + #[derive(Clone, Debug, PartialEq)] struct F(i32); + #[derive(Clone, Debug, PartialEq)] struct J(i32); + + macro_rules! test_entry { + ($name:ident, $init:ty) => { + #[test] + fn $name() { + let mut map = <$init>::new(); + assert_eq!(map.insert(A(10)), None); + assert_eq!(map.insert(B(20)), None); + assert_eq!(map.insert(C(30)), None); + assert_eq!(map.insert(D(40)), None); + assert_eq!(map.insert(E(50)), None); + assert_eq!(map.insert(F(60)), None); + + // Existing key (insert) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(mut view) => { + assert_eq!(view.get(), &A(10)); + assert_eq!(view.insert(A(100)), A(10)); + } + } + assert_eq!(map.get::().unwrap(), &A(100)); + assert_eq!(map.len(), 6); + + + // Existing key (update) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(mut view) => { + let v = view.get_mut(); + let new_v = B(v.0 * 10); + *v = new_v; + } + } + assert_eq!(map.get::().unwrap(), &B(200)); + assert_eq!(map.len(), 6); + + + // Existing key (remove) + match map.entry::() { + Entry::Vacant(_) => unreachable!(), + Entry::Occupied(view) => { + assert_eq!(view.remove(), C(30)); + } + } + assert_eq!(map.get::(), None); + assert_eq!(map.len(), 5); + + + // Inexistent key (insert) + match map.entry::() { + Entry::Occupied(_) => unreachable!(), + Entry::Vacant(view) => { + assert_eq!(*view.insert(J(1000)), J(1000)); + } + } + assert_eq!(map.get::().unwrap(), &J(1000)); + assert_eq!(map.len(), 6); + + // Entry.or_insert on existing key + map.entry::().or_insert(B(71)).0 += 1; + assert_eq!(map.get::().unwrap(), &B(201)); + assert_eq!(map.len(), 6); + + // Entry.or_insert on nonexisting key + map.entry::().or_insert(C(300)).0 += 1; + assert_eq!(map.get::().unwrap(), &C(301)); + assert_eq!(map.len(), 7); + } } - }) + } + + test_entry!(test_entry_any, AnyMap); + test_entry!(test_entry_cloneany, Map); + + #[test] + fn test_clone() { + let mut map: Map = Map::new(); + let _ = map.insert(A(1)); + let _ = map.insert(B(2)); + let _ = map.insert(D(3)); + let _ = map.insert(E(4)); + let _ = map.insert(F(5)); + let _ = map.insert(J(6)); + let map2 = map.clone(); + assert_eq!(map2.len(), 6); + assert_eq!(map2.get::(), Some(&A(1))); + assert_eq!(map2.get::(), Some(&B(2))); + assert_eq!(map2.get::(), None); + assert_eq!(map2.get::(), Some(&D(3))); + assert_eq!(map2.get::(), Some(&E(4))); + assert_eq!(map2.get::(), Some(&F(5))); + assert_eq!(map2.get::(), Some(&J(6))); + } + + #[test] + fn test_varieties() { + fn assert_send() { } + fn assert_sync() { } + fn assert_clone() { } + fn assert_debug() { } + assert_send::>(); + assert_send::>(); + assert_sync::>(); + assert_sync::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + assert_send::>(); + assert_send::>(); + assert_sync::>(); + assert_sync::>(); + assert_clone::>(); + assert_clone::>(); + assert_clone::>(); + assert_clone::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + assert_debug::>(); + } }