Skip to main content

charon_lib/transform/normalize/
normalize_trait_refs.rs

1use crate::{
2    ast::*,
3    ids::{IndexMap, IndexVec},
4    transform::{TransformCtx, ctx::TransformPass},
5};
6
7const MAX_NORMALIZATION_STEPS: usize = 100;
8
9#[derive(Visitor)]
10struct NormalizeTraitRefs<'a> {
11    impl_parent_refs: &'a IndexMap<TraitImplId, IndexVec<TraitClauseId, TraitRef>>,
12    /// Charon can end up with self-referential clauses, see e.g.
13    /// `issue-1078-default-assoc-ty-self-ref-clause.rs`. Therefore we simply give up normalizing
14    /// after a number of steps.
15    steps: usize,
16}
17
18impl VisitAstMut for NormalizeTraitRefs<'_> {
19    fn visit_with_cached_type_info<T: AstVisitable>(
20        &mut self,
21        value: &mut WithCachedTypeInfo<T>,
22    ) -> ControlFlow<Self::Break> {
23        if value.type_info().is_normalized() {
24            ControlFlow::Continue(())
25        } else {
26            self.visit_inner(value)
27        }
28    }
29
30    fn exit_trait_ref(&mut self, tref: &mut TraitRef) {
31        if self.steps >= MAX_NORMALIZATION_STEPS {
32            return;
33        }
34        if let TraitRefKind::ParentClause(parent, clause_id) = &tref.kind {
35            *tref = match &parent.kind {
36                TraitRefKind::TraitImpl(impl_ref) => {
37                    let Some(proof) = self.impl_parent_refs.get(impl_ref.id) else {
38                        return;
39                    };
40                    let mut proof = ItemBinder::new(impl_ref.id, proof[*clause_id].clone())
41                        .substitute(ItemBinder::new(CurrentItem, &impl_ref.generics))
42                        .under_current_binder();
43                    if *tref == proof {
44                        return;
45                    }
46                    // Recursively normalize.
47                    self.steps += 1;
48                    self.visit(&mut proof);
49                    proof
50                }
51                TraitRefKind::BuiltinOrAuto {
52                    parent_trait_refs, ..
53                } => {
54                    let Some(proof) = parent_trait_refs.get(*clause_id) else {
55                        return;
56                    };
57                    proof.clone()
58                }
59                _ => return,
60            };
61        }
62    }
63}
64
65pub struct Transform;
66impl TransformPass for Transform {
67    fn should_run(&self, options: &crate::options::TranslateOptions) -> bool {
68        !options.no_normalize
69    }
70
71    fn transform_ctx(&self, ctx: &mut TransformCtx) {
72        // Items are temporarily removed from the crate while we mutate them, so keep the original
73        // impl proofs separately.
74        let impl_parent_refs = ctx
75            .translated
76            .trait_impls
77            .map_ref(|timpl| timpl.implied_trait_refs.clone());
78        ctx.for_each_item_mut(|_, mut item| {
79            let _ = item.drive_mut(&mut NormalizeTraitRefs {
80                impl_parent_refs: &impl_parent_refs,
81                steps: 0,
82            });
83        });
84    }
85}