Unnamed repository; edit this file 'description' to name the repository.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
//! Utilities for working with generics.
//!
//! The layout for generics as expected by chalk are as follows:
//! - Parent parameters
//! - Optional Self parameter
//! - Lifetime parameters
//! - Type or Const parameters
//!
//! where parent follows the same scheme.

use arrayvec::ArrayVec;
use hir_def::{
    ConstParamId, GenericDefId, GenericParamId, ItemContainerId, LifetimeParamId, Lookup,
    TypeOrConstParamId, TypeParamId,
    db::DefDatabase,
    expr_store::ExpressionStore,
    hir::generics::{
        GenericParamDataRef, GenericParams, LifetimeParamData, TypeOrConstParamData,
        TypeParamProvenance, WherePredicate,
    },
};

pub(crate) fn generics(db: &dyn DefDatabase, def: GenericDefId) -> Generics<'_> {
    let mut chain = ArrayVec::new();
    let mut parent_params_len = 0;
    if let Some(parent_def) = parent_generic_def(db, def) {
        let (parent_params, parent_store) = GenericParams::with_store(db, parent_def);
        chain.push(SingleGenerics {
            def: parent_def,
            params: parent_params,
            store: parent_store,
            preceding_params_len: 0,
        });
        parent_params_len = parent_params.len() as u32;
    }
    let (params, store) = GenericParams::with_store(db, def);
    chain.push(SingleGenerics { def, params, store, preceding_params_len: parent_params_len });
    Generics { chain }
}

#[derive(Debug)]
pub(crate) struct Generics<'db> {
    chain: ArrayVec<SingleGenerics<'db>, 2>,
}

#[derive(Debug)]
pub(crate) struct SingleGenerics<'db> {
    def: GenericDefId,
    preceding_params_len: u32,
    params: &'db GenericParams,
    store: &'db ExpressionStore,
}

impl<'db> SingleGenerics<'db> {
    pub(crate) fn def(&self) -> GenericDefId {
        self.def
    }

    pub(crate) fn store(&self) -> &'db ExpressionStore {
        self.store
    }

    pub(crate) fn where_predicates(&self) -> impl Iterator<Item = &WherePredicate> {
        self.params.where_predicates().iter()
    }

    pub(crate) fn has_no_params(&self) -> bool {
        self.params.is_empty()
    }

    pub(crate) fn len_lifetimes(&self) -> usize {
        self.params.len_lifetimes()
    }

    pub(crate) fn len(&self) -> usize {
        self.params.len()
    }

    fn iter_lifetimes(&self) -> impl Iterator<Item = (LifetimeParamId, &'db LifetimeParamData)> {
        let parent = self.def;
        self.params
            .iter_lt()
            .map(move |(local_id, data)| (LifetimeParamId { parent, local_id }, data))
    }

    pub(crate) fn iter_type_or_consts(
        &self,
    ) -> impl Iterator<Item = (TypeOrConstParamId, &'db TypeOrConstParamData)> {
        let parent = self.def;
        self.params
            .iter_type_or_consts()
            .map(move |(local_id, data)| (TypeOrConstParamId { parent, local_id }, data))
    }

    fn iter_type_or_consts_as_generic(
        &self,
    ) -> impl Iterator<Item = (GenericParamId, GenericParamDataRef<'db>)> {
        self.iter_type_or_consts().map(|(id, data)| match data {
            TypeOrConstParamData::TypeParamData(data) => (
                GenericParamId::TypeParamId(TypeParamId::from_unchecked(id)),
                GenericParamDataRef::TypeParamData(data),
            ),
            TypeOrConstParamData::ConstParamData(data) => (
                GenericParamId::ConstParamId(ConstParamId::from_unchecked(id)),
                GenericParamDataRef::ConstParamData(data),
            ),
        })
    }

    fn trait_self_and_others(
        &self,
    ) -> (
        Option<(GenericParamId, GenericParamDataRef<'db>)>,
        impl Iterator<Item = (GenericParamId, GenericParamDataRef<'db>)>,
    ) {
        let mut iter = self.iter_type_or_consts_as_generic();
        let trait_self = if let GenericDefId::TraitId(_) = self.def { iter.next() } else { None };
        (trait_self, iter)
    }

    pub(crate) fn iter(&self) -> impl Iterator<Item = (GenericParamId, GenericParamDataRef<'db>)> {
        let lifetimes = self.iter_lifetimes().map(|(id, data)| {
            (GenericParamId::LifetimeParamId(id), GenericParamDataRef::LifetimeParamData(data))
        });
        let (trait_self, type_and_consts) = self.trait_self_and_others();
        trait_self.into_iter().chain(lifetimes).chain(type_and_consts)
    }

    pub(crate) fn iter_with_idx(
        &self,
    ) -> impl Iterator<Item = (u32, GenericParamId, GenericParamDataRef<'db>)> {
        std::iter::zip(self.preceding_params_len.., self.iter())
            .map(|(index, (id, data))| (index, id, data))
    }

    pub(crate) fn iter_id(&self) -> impl Iterator<Item = GenericParamId> {
        self.iter().map(|(id, _)| id)
    }
}

impl<'db> Generics<'db> {
    pub(crate) fn iter_owners(&self) -> impl DoubleEndedIterator<Item = &SingleGenerics<'db>> {
        self.chain.iter()
    }

    fn owner(&self) -> &SingleGenerics<'db> {
        self.chain.last().expect("must have an owner params")
    }

    pub(crate) fn parent(&self) -> Option<&SingleGenerics<'db>> {
        match &*self.chain {
            [parent, _owner] => Some(parent),
            _ => None,
        }
    }

    pub(crate) fn has_no_params(&self) -> bool {
        self.iter_owners().all(|owner| owner.has_no_params())
    }

    pub(crate) fn def(&self) -> GenericDefId {
        self.owner().def
    }

    pub(crate) fn store(&self) -> &'db ExpressionStore {
        self.owner().store
    }

    pub(crate) fn iter_self(
        &self,
    ) -> impl Iterator<Item = (GenericParamId, GenericParamDataRef<'db>)> {
        self.owner().iter()
    }

    pub(crate) fn iter_self_with_idx(
        &self,
    ) -> impl Iterator<Item = (u32, GenericParamId, GenericParamDataRef<'db>)> {
        self.owner().iter_with_idx()
    }

    pub(crate) fn iter_parent_id(&self) -> impl Iterator<Item = GenericParamId> {
        self.parent().into_iter().flat_map(|parent| parent.iter_id())
    }

    pub(crate) fn iter_self_type_or_consts(
        &self,
    ) -> impl Iterator<Item = (TypeOrConstParamId, &'db TypeOrConstParamData)> {
        self.owner().iter_type_or_consts()
    }

    /// Iterate over the parent params followed by self params.
    #[cfg(test)]
    pub(crate) fn iter(&self) -> impl Iterator<Item = (GenericParamId, GenericParamDataRef<'_>)> {
        self.iter_owners().flat_map(|owner| owner.iter())
    }

    pub(crate) fn iter_id(&self) -> impl Iterator<Item = GenericParamId> {
        self.iter_owners().flat_map(|owner| owner.iter_id())
    }

    /// Returns total number of generic parameters in scope, including those from parent.
    pub(crate) fn len(&self) -> usize {
        match &*self.chain {
            [parent, owner] => parent.len() + owner.len(),
            [owner] => owner.len(),
            _ => unreachable!(),
        }
    }

    #[inline]
    pub(crate) fn len_parent(&self) -> usize {
        self.parent().map_or(0, SingleGenerics::len)
    }

    pub(crate) fn len_lifetimes_self(&self) -> usize {
        self.owner().len_lifetimes()
    }

    pub(crate) fn provenance_split(&self) -> ProvenanceSplit {
        let parent_total = self.len_parent();

        let owner = self.owner();
        let lifetimes = owner.params.len_lifetimes();

        let mut has_self_param = false;
        let mut non_impl_trait_type_params = 0;
        let mut impl_trait_type_params = 0;
        let mut const_params = 0;
        owner.params.iter_type_or_consts().for_each(|(_, data)| match data {
            TypeOrConstParamData::TypeParamData(p) => match p.provenance {
                TypeParamProvenance::TypeParamList => non_impl_trait_type_params += 1,
                TypeParamProvenance::TraitSelf => has_self_param |= true,
                TypeParamProvenance::ArgumentImplTrait => impl_trait_type_params += 1,
            },
            TypeOrConstParamData::ConstParamData(_) => const_params += 1,
        });

        ProvenanceSplit {
            parent_total,
            has_self_param,
            non_impl_trait_type_params,
            const_params,
            impl_trait_type_params,
            lifetimes,
        }
    }

    fn find_owner(&self, def: GenericDefId) -> &SingleGenerics<'db> {
        match &*self.chain {
            [parent, owner] => {
                if parent.def == def {
                    parent
                } else {
                    debug_assert_eq!(def, owner.def);
                    owner
                }
            }
            [owner] => {
                debug_assert_eq!(def, owner.def);
                owner
            }
            _ => unreachable!(),
        }
    }

    pub(crate) fn type_or_const_param_idx(&self, param: TypeOrConstParamId) -> u32 {
        let owner = self.find_owner(param.parent);
        let has_trait_self = matches!(owner.def, GenericDefId::TraitId(_));
        if has_trait_self && param.local_id == GenericParams::SELF_PARAM_ID_IN_SELF {
            owner.preceding_params_len
        } else {
            owner.preceding_params_len
                + owner.len_lifetimes() as u32
                + param.local_id.into_raw().into_u32()
        }
    }

    pub(crate) fn lifetime_param_idx(&self, param: LifetimeParamId) -> u32 {
        let owner = self.find_owner(param.parent);
        let has_trait_self = matches!(owner.def, GenericDefId::TraitId(_));
        owner.preceding_params_len
            + u32::from(has_trait_self)
            + param.local_id.into_raw().into_u32()
    }
}

pub(crate) struct ProvenanceSplit {
    pub(crate) parent_total: usize,
    // The rest are about self.
    pub(crate) has_self_param: bool,
    pub(crate) non_impl_trait_type_params: usize,
    pub(crate) const_params: usize,
    pub(crate) impl_trait_type_params: usize,
    pub(crate) lifetimes: usize,
}

fn parent_generic_def(db: &dyn DefDatabase, def: GenericDefId) -> Option<GenericDefId> {
    let container = match def {
        GenericDefId::FunctionId(it) => it.lookup(db).container,
        GenericDefId::TypeAliasId(it) => it.lookup(db).container,
        GenericDefId::ConstId(it) => it.lookup(db).container,
        GenericDefId::StaticId(_)
        | GenericDefId::AdtId(_)
        | GenericDefId::TraitId(_)
        | GenericDefId::ImplId(_) => return None,
    };

    match container {
        ItemContainerId::ImplId(it) => Some(it.into()),
        ItemContainerId::TraitId(it) => Some(it.into()),
        ItemContainerId::ModuleId(_) | ItemContainerId::ExternBlockId(_) => None,
    }
}