// Protocol Buffers - Google's data interchange format // Copyright 2023 Google LLC. All rights reserved. // // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file or at // https://developers.google.com/open-source/licenses/bsd use crate::{ Mut, MutProxy, ProtoStr, Proxied, SettableValue, View, ViewProxy, __internal::Private, __runtime::{ MapInner, MapWithBoolKeyOps, MapWithI32KeyOps, MapWithI64KeyOps, MapWithProtoStrKeyOps, MapWithU32KeyOps, MapWithU64KeyOps, }, }; use paste::paste; use std::marker::PhantomData; #[repr(transparent)] pub struct MapView<'msg, K: ?Sized, V: ?Sized> { inner: MapInner<'msg, K, V>, } impl<'msg, K: ?Sized, V: ?Sized> MapView<'msg, K, V> { pub fn from_inner(_private: Private, inner: MapInner<'msg, K, V>) -> Self { Self { inner } } } impl<'msg, K: ?Sized, V: ?Sized> Copy for MapView<'msg, K, V> {} impl<'msg, K: ?Sized, V: ?Sized> Clone for MapView<'msg, K, V> { fn clone(&self) -> Self { *self } } unsafe impl<'msg, K: ?Sized, V: ?Sized> Sync for MapView<'msg, K, V> {} unsafe impl<'msg, K: ?Sized, V: ?Sized> Send for MapView<'msg, K, V> {} impl<'msg, K: ?Sized, V: ?Sized> std::fmt::Debug for MapView<'msg, K, V> { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_tuple("MapView") .field(&std::any::type_name::()) .field(&std::any::type_name::()) .finish() } } #[repr(transparent)] pub struct MapMut<'msg, K: ?Sized, V: ?Sized> { inner: MapInner<'msg, K, V>, } impl<'msg, K: ?Sized, V: ?Sized> MapMut<'msg, K, V> { pub fn from_inner(_private: Private, inner: MapInner<'msg, K, V>) -> Self { Self { inner } } } unsafe impl<'msg, K: ?Sized, V: ?Sized> Sync for MapMut<'msg, K, V> {} impl<'msg, K: ?Sized, V: ?Sized> std::fmt::Debug for MapMut<'msg, K, V> { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_tuple("MapMut") .field(&std::any::type_name::()) .field(&std::any::type_name::()) .finish() } } impl<'msg, K: ?Sized, V: ?Sized> std::ops::Deref for MapMut<'msg, K, V> { type Target = MapView<'msg, K, V>; fn deref(&self) -> &Self::Target { // SAFETY: // - `Map{View,Mut}<'msg, T>` are both `#[repr(transparent)]` over // `MapInner<'msg, T>`. // - `MapInner` is a type alias for `NonNull`. unsafe { &*(self as *const Self as *const MapView<'msg, K, V>) } } } // This is a ZST type so we can implement `Proxied`. Users will work with // `MapView` (`View<'_, Map>>) and `MapMut` (Mut<'_, Map>). pub struct Map(PhantomData, PhantomData); macro_rules! impl_proxied_for_map_keys { ($(key_type $t:ty;)*) => { paste! { $( impl] + Proxied + ?Sized> Proxied for Map<$t, V>{ type View<'msg> = MapView<'msg, $t, V> where V: 'msg; type Mut<'msg> = MapMut<'msg, $t, V> where V: 'msg; } impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> SettableValue> for MapView<'msg, $t, V> { fn set_on<'b>(self, _private: Private, mut mutator: Mut<'b, Map<$t, V>>) where Map<$t, V>: 'b { mutator.copy_from(self); } } impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> ViewProxy<'msg> for MapView<'msg, $t, V> { type Proxied = Map<$t, V>; fn as_view(&self) -> View<'_, Self::Proxied> { *self } fn into_view<'shorter>(self) -> View<'shorter, Self::Proxied> where 'msg: 'shorter, { MapView { inner: self.inner } } } impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> ViewProxy<'msg> for MapMut<'msg, $t, V> { type Proxied = Map<$t, V>; fn as_view(&self) -> View<'_, Self::Proxied> { **self } fn into_view<'shorter>(self) -> View<'shorter, Self::Proxied> where 'msg: 'shorter, { *self.into_mut::<'shorter>() } } impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> MutProxy<'msg> for MapMut<'msg, $t, V> { fn as_mut(&mut self) -> Mut<'_, Self::Proxied> { MapMut { inner: self.inner } } fn into_mut<'shorter>(self) -> Mut<'shorter, Self::Proxied> where 'msg: 'shorter, { MapMut { inner: self.inner } } } )* } } } impl_proxied_for_map_keys!( key_type i32; key_type u32; key_type i64; key_type u64; key_type bool; key_type ProtoStr; ); macro_rules! impl_scalar_map_keys { ($(key_type $t:ty;)*) => { paste! { $( impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> MapView<'msg, $t, V> { pub fn get<'b>(&self, key: $t) -> Option> { self.inner.get(key) } pub fn len(&self) -> usize { self.inner.size() } pub fn is_empty(&self) -> bool { self.len() == 0 } } impl<'msg, V: [< MapWith $t:camel KeyOps >] + Proxied + ?Sized + 'msg> MapMut<'msg, $t, V> { pub fn insert(&mut self, key: $t, value: V::Value<'_>) -> bool { self.inner.insert(key, value) } pub fn remove<'b>(&mut self, key: $t) -> bool { self.inner.remove(key) } pub fn clear(&mut self) { self.inner.clear() } pub fn copy_from(&mut self, _src: MapView<'_, $t, V>) { todo!("implement b/28530933"); } } )* } }; } impl_scalar_map_keys!( key_type i32; key_type u32; key_type i64; key_type u64; key_type bool; ); impl<'msg, V: MapWithProtoStrKeyOps + Proxied + ?Sized + 'msg> MapView<'msg, ProtoStr, V> { pub fn get(&self, key: impl Into<&'msg ProtoStr>) -> Option> { self.inner.get(key.into()) } pub fn len(&self) -> usize { self.inner.size() } pub fn is_empty(&self) -> bool { self.len() == 0 } } impl<'msg, V: MapWithProtoStrKeyOps + Proxied + ?Sized + 'msg> MapMut<'msg, ProtoStr, V> { pub fn insert(&mut self, key: impl Into<&'msg ProtoStr>, value: V::Value<'_>) -> bool { self.inner.insert(key.into(), value) } pub fn remove(&mut self, key: impl Into<&'msg ProtoStr>) -> bool { self.inner.remove(key.into()) } pub fn clear(&mut self) { self.inner.clear() } pub fn copy_from(&mut self, _src: MapView<'_, ProtoStr, V>) { todo!("implement b/28530933"); } } #[cfg(test)] mod tests { use super::*; use crate::__runtime::{new_map_i32_i64, new_map_str_str}; use googletest::prelude::*; #[test] fn test_proxied_scalar() { let mut map_mut = MapMut::from_inner(Private, new_map_i32_i64()); map_mut.insert(1, 2); let map_view_1 = map_mut.as_view(); assert_that!(map_view_1.len(), eq(1)); assert_that!(map_view_1.get(1), eq(Some(2))); map_mut.insert(3, 4); let map_view_2 = map_mut.into_view(); assert_that!(map_view_2.len(), eq(2)); assert_that!(map_view_2.get(3), eq(Some(4))); { let map_view_3 = map_view_2.as_view(); assert_that!(map_view_3.is_empty(), eq(false)); } let map_view_4 = map_view_2.into_view(); assert_that!(map_view_4.is_empty(), eq(false)); } #[test] fn test_proxied_str() { let mut map_mut = MapMut::from_inner(Private, new_map_str_str()); map_mut.insert("a", "b".into()); let map_view_1 = map_mut.as_view(); assert_that!(map_view_1.len(), eq(1)); assert_that!(map_view_1.get("a").unwrap(), eq("b")); map_mut.insert("c", "d".into()); let map_view_2 = map_mut.into_view(); assert_that!(map_view_2.len(), eq(2)); assert_that!(map_view_2.get("c").unwrap(), eq("d")); { let map_view_3 = map_view_2.as_view(); assert_that!(map_view_3.is_empty(), eq(false)); } let map_view_4 = map_view_2.into_view(); assert_that!(map_view_4.is_empty(), eq(false)); } #[test] fn test_dbg() { let map_view = MapView::from_inner(Private, new_map_i32_i64()); assert_that!(format!("{:?}", map_view), eq("MapView(\"i32\", \"i64\")")); } }