luaur-analysis 0.1.3

Luau type checker and type inference (Rust).
Documentation
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use crate::enums::polarity::Polarity;
use crate::enums::unify_result::UnifyResult;
use crate::functions::find_unique_types_ast_utils_alt_d::find_unique_types;
use crate::functions::flatten_type_pack::flatten_type_pack_id;
use crate::functions::follow_type::follow_type_id;
use crate::functions::follow_type_pack::follow_type_pack_id;
use crate::functions::get_approximate_return_type_for_function_call_type_utils_alt_b::get_approximate_return_type_for_function_call_type_id;
use crate::functions::get_mutable_type::get_mutable_type_id;
use crate::functions::get_type_alt_j::get_type_id;
use crate::functions::instantiate_2_instantiation_2::instantiate_2 as instantiate_2_type_id;
use crate::functions::instantiate_2_instantiation_2_alt_b::instantiate_2;
use crate::functions::shallow_clone_clone_alt_b::shallow_clone;
use crate::functions::track_interior_free_type::track_interior_free_type;
use crate::functions::track_interior_free_type_pack::track_interior_free_type_pack;
use crate::records::any_type::AnyType;
use crate::records::builtin_types::BuiltinTypes;
use crate::records::clone_state::CloneState;
use crate::records::constraint::Constraint;
use crate::records::constraint_solver::ConstraintSolver;
use crate::records::free_type::FreeType;
use crate::records::function_call_constraint::FunctionCallConstraint;
use crate::records::function_type::FunctionType;
use crate::records::generic_type_visitor::GenericTypeVisitorTrait;
use crate::records::instantiation_queuer::InstantiationQueuer;
use crate::records::instantiation_queuer_deprecated::InstantiationQueuerDeprecated;
use crate::records::internal_error_reporter::InternalErrorReporter;
use crate::records::intersection_type::IntersectionType;
use crate::records::iterative_type_visitor::IterativeTypeVisitorTrait;
use crate::records::magic_function_call_context::MagicFunctionCallContext;
use crate::records::magic_refinement_context::MagicRefinementContext;
use crate::records::never_type::NeverType;
use crate::records::occurs_check_failed::OccursCheckFailed;
use crate::records::overload_resolver::OverloadResolver;
use crate::records::subtyping::Subtyping;
use crate::records::unification_too_complex::UnificationTooComplex;
use crate::records::unifier_2::Unifier2;
use crate::records::union_type::UnionType;
use crate::records::unknown_type::UnknownType;
use crate::type_aliases::error_type::ErrorType;
use crate::type_aliases::type_id::TypeId;
use core::ptr::NonNull;
use luaur_ast::records::ast_node::AstNode;
use luaur_common::records::dense_hash_map::DenseHashMap;
use luaur_common::records::dense_hash_set::DenseHashSet;
use luaur_common::FFlag;

impl ConstraintSolver {
    pub fn try_dispatch_function_call_constraint_not_null_constraint_bool(
        &mut self,
        c: &FunctionCallConstraint,
        constraint: *const Constraint,
        _force: bool,
    ) -> bool {
        let mut fn_ty = unsafe { follow_type_id(c.fn_type) };
        let args_pack = unsafe { follow_type_pack_id(c.args_pack) };
        let result = unsafe { follow_type_pack_id(c.result) };

        if self.is_blocked_type_id(fn_ty) {
            return self.block_type_id_not_null_constraint(c.fn_type, constraint);
        }

        if unsafe { !get_type_id::<AnyType>(fn_ty).is_null() } {
            self.bind_not_null_constraint_type_pack_id_type_pack_id(constraint, c.result, unsafe {
                (*self.builtin_types).anyTypePack
            });
            self.fill_in_discriminant_types(constraint, &c.discriminant_types);
            return true;
        }

        if unsafe { !get_type_id::<ErrorType>(fn_ty).is_null() } {
            self.bind_not_null_constraint_type_pack_id_type_pack_id(constraint, c.result, unsafe {
                (*self.builtin_types).errorTypePack
            });
            self.fill_in_discriminant_types(constraint, &c.discriminant_types);
            return true;
        }

        if unsafe { !get_type_id::<NeverType>(fn_ty).is_null() } {
            self.bind_not_null_constraint_type_pack_id_type_pack_id(constraint, c.result, unsafe {
                (*self.builtin_types).neverTypePack
            });
            self.fill_in_discriminant_types(constraint, &c.discriminant_types);
            return true;
        }

        let (args_head, args_tail) = flatten_type_pack_id(args_pack);
        let mut blocked = false;

        for arg in args_head {
            if self.is_blocked_type_id(arg) {
                self.block_type_id_not_null_constraint(arg, constraint);
                blocked = true;
            }
        }

        if let Some(tail) = args_tail {
            if self.is_blocked_type_pack_id(tail) {
                self.block_type_pack_id_not_null_constraint(tail, constraint);
                blocked = true;
            }
        }

        if blocked {
            return false;
        }

        let scope = unsafe { (*constraint).scope };
        let location = unsafe { (*constraint).location };

        let mut args_pack = args_pack;

        fn collapse(parts: &[TypeId]) -> Option<TypeId> {
            let first = parts.first().copied()?;
            let first = unsafe { follow_type_id(first) };

            for part in parts {
                if unsafe { follow_type_id(*part) } != first {
                    return None;
                }
            }

            Some(first)
        }

        if let Some(utv) = unsafe { get_type_id::<UnionType>(fn_ty).as_ref() } {
            fn_ty = collapse(&utv.options).unwrap_or(fn_ty);
        } else if let Some(itv) = unsafe { get_type_id::<IntersectionType>(fn_ty).as_ref() } {
            fn_ty = collapse(&itv.parts).unwrap_or(fn_ty);
        }

        let mut used_magic = false;
        if let Some(ftv) = unsafe { get_type_id::<FunctionType>(fn_ty).as_ref() } {
            if let Some(magic) = &ftv.magic {
                if !c.call_site.is_null() {
                    used_magic = (magic.infer)(&MagicFunctionCallContext {
                        solver: NonNull::new(self as *mut ConstraintSolver).unwrap(),
                        constraint: NonNull::new(constraint as *mut Constraint).unwrap(),
                        call_site: NonNull::new(c.call_site).unwrap(),
                        arguments: c.args_pack,
                        result,
                    });
                    (magic.refine)(&MagicRefinementContext {
                        scope,
                        call_site: c.call_site,
                        discriminant_types: c.discriminant_types.clone(),
                    });
                }
            }
        }

        if luaur_common::FFlag::LuauExplicitTypeInstantiationSupport.get()
            && (!c.type_arguments.is_empty() || !c.type_pack_arguments.is_empty())
        {
            fn_ty = self.instantiate_function_type(
                c.fn_type,
                &c.type_arguments,
                &c.type_pack_arguments,
                scope,
                &location,
            );
        }

        self.fill_in_discriminant_types(constraint, &c.discriminant_types);

        let mut overload_to_use = fn_ty;

        if unsafe { get_type_id::<FunctionType>(overload_to_use).is_null() } {
            let mut resolver = OverloadResolver::new(
                self.builtin_types,
                self.arena,
                self.normalizer,
                self.type_function_runtime,
                scope,
                &mut self.ice_reporter as *mut InternalErrorReporter,
                &mut self.limits as *mut _,
                location,
            );

            let mut unique_types: DenseHashSet<TypeId> = DenseHashSet::new(core::ptr::null_mut());
            if !c.call_site.is_null() {
                if let Some(module) = &self.module {
                    let module_ptr = alloc::sync::Arc::as_ptr(module);
                    unsafe {
                        find_unique_types(
                            &mut unique_types as *mut DenseHashSet<TypeId>,
                            (*c.call_site).args.as_slice(),
                            &(*module_ptr).ast_types as *const _,
                        );
                    }
                }
            }

            let resolution = resolver.resolve_overload(
                overload_to_use,
                args_pack,
                if c.call_site.is_null() {
                    luaur_ast::records::location::Location::default()
                } else {
                    unsafe { (*(*c.call_site).func).base.location }
                },
                &mut unique_types as *mut DenseHashSet<TypeId>,
                true,
            );

            let selected = resolution.get_unambiguous_overload();
            if let Some(overload) = selected.overload {
                overload_to_use = overload;
            } else {
                self.bind_not_null_constraint_type_pack_id_type_pack_id(
                    constraint,
                    c.result,
                    unsafe { (*self.builtin_types).errorTypePack },
                );
                return true;
            }

            if resolution.metamethods.contains(&overload_to_use) {
                args_pack = unsafe {
                    (*self.arena).add_type_pack_vector_type_id_optional_type_pack_id(
                        alloc::vec![fn_ty],
                        Some(args_pack),
                    )
                };
            }
        }

        let ret_tp = unsafe { (*self.arena).fresh_type_pack(scope, Polarity::Positive) };
        track_interior_free_type_pack(scope, ret_tp);

        let inferred_ty = unsafe {
            (*self.arena).add_type(FunctionType::function_type_new(
                args_pack, ret_tp, None, false,
            ))
        };

        let mut u2 = Unifier2::unifier_2_not_null_type_arena_not_null_builtin_types_not_null_scope_not_null_internal_error_reporter(
            NonNull::new(self.arena).unwrap(),
            NonNull::new(self.builtin_types).unwrap(),
            NonNull::new(scope).unwrap(),
            NonNull::new(&self.ice_reporter as *const InternalErrorReporter as *mut InternalErrorReporter).unwrap(),
        );

        let unify_result = u2.unify(overload_to_use, inferred_ty);

        for free_ty in u2.new_fresh_types.iter().copied() {
            track_interior_free_type(scope, free_ty);
        }
        for free_tp in u2.new_fresh_type_packs.iter().copied() {
            track_interior_free_type_pack(scope, free_tp);
        }

        let mut result_tp = ret_tp;
        if !u2.generic_substitutions.empty() || !u2.generic_pack_substitutions.empty() {
            let mut subtyping = Subtyping::subtyping_owned(
                self.builtin_types,
                self.arena,
                self.normalizer,
                self.type_function_runtime,
                &self.ice_reporter as *const InternalErrorReporter as *mut InternalErrorReporter,
            );

            let mut has_bound = false;
            for (_, ty) in u2.generic_substitutions.iter() {
                if let Some(ftv) = unsafe { get_type_id::<FreeType>(*ty).as_ref() } {
                    let lower_bound = unsafe { follow_type_id(ftv.lower_bound) };
                    let upper_bound = unsafe { follow_type_id(ftv.upper_bound) };
                    has_bound = unsafe { get_type_id::<NeverType>(lower_bound).is_null() }
                        || unsafe { get_type_id::<UnknownType>(upper_bound).is_null() };

                    if has_bound {
                        break;
                    }
                }
            }

            if unsafe { !get_type_id::<FunctionType>(overload_to_use).is_null() } && has_bound {
                let mut clone_state = CloneState {
                    builtin_types: self.builtin_types,
                    seen_types: DenseHashMap::new(core::ptr::null()),
                    seen_type_packs: DenseHashMap::new(core::ptr::null()),
                };

                let cloned_ty = shallow_clone(
                    overload_to_use,
                    unsafe { &mut *self.arena },
                    &mut clone_state,
                    true,
                );
                let cloned_fn = unsafe { get_mutable_type_id::<FunctionType>(cloned_ty) };
                unsafe {
                    (*cloned_fn).generics.clear();
                    (*cloned_fn).generic_packs.clear();
                }

                if let Some(subst) = instantiate_2_type_id(
                    self.arena,
                    u2.generic_substitutions.clone(),
                    u2.generic_pack_substitutions.clone(),
                    &mut subtyping as *mut Subtyping,
                    scope,
                    cloned_ty,
                ) {
                    overload_to_use = unsafe { follow_type_id(subst) };

                    if let Some(instantiated_fn) =
                        unsafe { get_type_id::<FunctionType>(overload_to_use).as_ref() }
                    {
                        result_tp = unsafe { follow_type_pack_id(instantiated_fn.ret_types) };
                    } else {
                        self.report_error_type_error_data_location(
                            crate::records::code_too_complex::CodeTooComplex::default().into(),
                            &location,
                        );
                        result_tp = unsafe { (*self.builtin_types).errorTypePack };
                    }
                } else {
                    self.report_error_type_error_data_location(
                        crate::records::code_too_complex::CodeTooComplex::default().into(),
                        &location,
                    );
                    result_tp = unsafe { (*self.builtin_types).errorTypePack };
                }
            } else {
                let approximate_ret =
                    get_approximate_return_type_for_function_call_type_id(overload_to_use)
                        .unwrap_or(unsafe { (*self.builtin_types).errorTypePack });

                if let Some(subst) = instantiate_2(
                    self.arena,
                    u2.generic_substitutions.clone(),
                    u2.generic_pack_substitutions.clone(),
                    &mut subtyping as *mut Subtyping,
                    scope,
                    approximate_ret,
                ) {
                    result_tp = subst;
                } else {
                    self.report_error_type_error_data_location(
                        crate::records::code_too_complex::CodeTooComplex::default().into(),
                        &location,
                    );
                    result_tp = unsafe { (*self.builtin_types).errorTypePack };
                }
            }
        }

        if !used_magic {
            self.bind_not_null_constraint_type_pack_id_type_pack_id(
                constraint, c.result, result_tp,
            );
        }

        for (expanded, additions) in u2.expanded_free_types.iter() {
            for addition in additions {
                self.upper_bound_contributors
                    .get_or_insert(*expanded)
                    .push((location, *addition));
            }
        }

        match unify_result {
            UnifyResult::Ok => {
                if !c.call_site.is_null() && !c.ast_overload_resolved_types.is_null() {
                    unsafe {
                        *(*c.ast_overload_resolved_types)
                            .get_or_insert(c.call_site as *const AstNode) = if used_magic {
                            inferred_ty
                        } else {
                            overload_to_use
                        };
                    }
                }
            }
            UnifyResult::TooComplex => self.report_error_type_error_data_location(
                UnificationTooComplex::default().into(),
                &location,
            ),
            UnifyResult::OccursCheckFailed => self.report_error_type_error_data_location(
                OccursCheckFailed::default().into(),
                &location,
            ),
        }

        if FFlag::LuauIterativeInstantiationQueuer.get() {
            let mut queuer = InstantiationQueuer::instantiation_queuer(
                NonNull::new(scope).unwrap(),
                &location,
                self as *mut ConstraintSolver,
            );
            queuer.run_type_id(overload_to_use);
            if FFlag::LuauAlsoInstantiateInferredArguments.get() {
                queuer.run_type_pack_id(args_pack);
            }
            queuer.run_type_pack_id(result);
        } else {
            let mut queuer = InstantiationQueuerDeprecated::instantiation_queuer_deprecated_instantiation_queuer_deprecated(
                NonNull::new(scope).unwrap(),
                &location,
                self as *mut ConstraintSolver,
            );
            queuer.traverse_type_id(overload_to_use);
            if FFlag::LuauAlsoInstantiateInferredArguments.get() {
                queuer.traverse_type_pack_id(args_pack);
            }
            queuer.traverse_type_pack_id(result);
        }

        if !FFlag::LuauConstraintGraph.get() {
            self.unblock_type_pack_id_location(c.result, location);
        }

        true
    }
}