cxx_build/syntax/
map.rs

1use std::borrow::Borrow;
2use std::hash::Hash;
3use std::ops::Index;
4
5pub(crate) use self::ordered::OrderedMap;
6pub(crate) use self::unordered::UnorderedMap;
7pub(crate) use std::collections::hash_map::Entry;
8
9mod ordered {
10    use indexmap::Equivalent;
11    use std::hash::Hash;
12
13    pub(crate) struct OrderedMap<K, V>(indexmap::IndexMap<K, V>);
14
15    impl<K, V> OrderedMap<K, V> {
16        pub(crate) fn new() -> Self {
17            OrderedMap(indexmap::IndexMap::new())
18        }
19
20        #[allow(dead_code)] // only used by cxx-build, not cxxbridge-macro
21        pub(crate) fn keys(&self) -> indexmap::map::Keys<K, V> {
22            self.0.keys()
23        }
24
25        pub(crate) fn contains_key<Q>(&self, key: &Q) -> bool
26        where
27            Q: ?Sized + Hash + Equivalent<K>,
28        {
29            self.0.contains_key(key)
30        }
31    }
32
33    impl<K, V> OrderedMap<K, V>
34    where
35        K: Hash + Eq,
36    {
37        pub(crate) fn insert(&mut self, key: K, value: V) -> Option<V> {
38            self.0.insert(key, value)
39        }
40
41        pub(crate) fn entry(&mut self, key: K) -> indexmap::map::Entry<K, V> {
42            self.0.entry(key)
43        }
44    }
45
46    impl<'a, K, V> IntoIterator for &'a OrderedMap<K, V> {
47        type Item = (&'a K, &'a V);
48        type IntoIter = indexmap::map::Iter<'a, K, V>;
49        fn into_iter(self) -> Self::IntoIter {
50            self.0.iter()
51        }
52    }
53}
54
55mod unordered {
56    use crate::syntax::set::UnorderedSet;
57    use std::borrow::Borrow;
58    use std::collections::hash_map::{Entry, HashMap};
59    use std::hash::Hash;
60
61    // Wrapper prohibits accidentally introducing iteration over the map, which
62    // could lead to nondeterministic generated code.
63    pub(crate) struct UnorderedMap<K, V>(HashMap<K, V>);
64
65    impl<K, V> UnorderedMap<K, V> {
66        pub(crate) fn new() -> Self {
67            UnorderedMap(HashMap::new())
68        }
69    }
70
71    impl<K, V> UnorderedMap<K, V>
72    where
73        K: Hash + Eq,
74    {
75        pub(crate) fn insert(&mut self, key: K, value: V) -> Option<V> {
76            self.0.insert(key, value)
77        }
78
79        pub(crate) fn contains_key<Q>(&self, key: &Q) -> bool
80        where
81            K: Borrow<Q>,
82            Q: ?Sized + Hash + Eq,
83        {
84            self.0.contains_key(key)
85        }
86
87        pub(crate) fn get<Q>(&self, key: &Q) -> Option<&V>
88        where
89            K: Borrow<Q>,
90            Q: ?Sized + Hash + Eq,
91        {
92            self.0.get(key)
93        }
94
95        pub(crate) fn entry(&mut self, key: K) -> Entry<K, V> {
96            self.0.entry(key)
97        }
98
99        #[allow(dead_code)] // only used by cxx-build, not cxxbridge-macro
100        pub(crate) fn remove<Q>(&mut self, key: &Q) -> Option<V>
101        where
102            K: Borrow<Q>,
103            Q: ?Sized + Hash + Eq,
104        {
105            self.0.remove(key)
106        }
107
108        pub(crate) fn keys(&self) -> UnorderedSet<K>
109        where
110            K: Copy,
111        {
112            let mut set = UnorderedSet::new();
113            for key in self.0.keys() {
114                set.insert(*key);
115            }
116            set
117        }
118    }
119}
120
121impl<K, V> Default for UnorderedMap<K, V> {
122    fn default() -> Self {
123        UnorderedMap::new()
124    }
125}
126
127impl<Q, K, V> Index<&Q> for UnorderedMap<K, V>
128where
129    K: Borrow<Q> + Hash + Eq,
130    Q: ?Sized + Hash + Eq,
131{
132    type Output = V;
133
134    fn index(&self, key: &Q) -> &V {
135        self.get(key).unwrap()
136    }
137}