charon_lib/ids/
mod.rs

1pub mod generator;
2pub mod index_map;
3pub mod index_vec;
4
5pub use generator::Generator;
6pub use index_map::IndexMap;
7pub use index_vec::{Idx, IndexVec};
8
9/// Generate an `Index` index type. We use it because we need manipulate a lot of different indices
10/// (for various kinds of declarations, variables, blocks, etc.).
11/// For sanity, we prevent any confusion between the different kinds of indices by using different
12/// types. The following macro allows us to easily derive those types.
13///
14/// The `name` parameter should contain the name of the module to declare. The `pretty_name`
15/// parameter is used to implement `Id::to_pretty_string`; if not provided, it defaults to `name`.
16#[macro_export]
17macro_rules! generate_index_type {
18    ($name:ident) => {
19        $crate::generate_index_type!($name, stringify!($name));
20    };
21    ($name:ident, $pretty_name:expr) => {
22        index_vec::define_index_type! {
23            #[derive(Default, derive_generic_visitor::Drive, derive_generic_visitor::DriveMut)]
24            #[drive(skip)]
25            pub struct $name = usize;
26            // Must fit in an u32 for serialization.
27            MAX_INDEX = u32::MAX as usize;
28        }
29
30        impl $name {
31            pub const ZERO: Self = Self { _raw: 0 };
32            pub const MAX: Self = Self {
33                _raw: Self::MAX_INDEX,
34            };
35            pub fn is_zero(&self) -> bool {
36                self.index() == 0
37            }
38            pub fn to_pretty_string(self) -> String {
39                format!("@{}{}", $pretty_name, self)
40            }
41        }
42
43        impl std::fmt::Display for $name {
44            fn fmt(
45                &self,
46                f: &mut std::fmt::Formatter<'_>,
47            ) -> std::result::Result<(), std::fmt::Error> {
48                f.write_str(self.index().to_string().as_str())
49            }
50        }
51
52        impl<State: ?Sized> serde_state::SerializeState<State> for $name {
53            fn serialize_state<S: serde::ser::Serializer>(
54                &self,
55                _state: &State,
56                serializer: S,
57            ) -> Result<S::Ok, S::Error> {
58                use serde::Serialize;
59                self.index().serialize(serializer)
60            }
61        }
62        impl<'de, State: ?Sized> serde_state::DeserializeState<'de, State> for $name {
63            fn deserialize_state<D: serde::de::Deserializer<'de>>(
64                _state: &State,
65                deserializer: D,
66            ) -> Result<Self, D::Error> {
67                use serde::Deserialize;
68                usize::deserialize(deserializer).map(Self::from_usize)
69            }
70        }
71    };
72}
charon_lib/ids/mod.rs

charon_lib/ids/
mod.rs
