luaur-analysis 0.1.2

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

use crate::enums::reduction::Reduction;
use crate::functions::compute_keys_of::compute_keys_of;
use crate::functions::follow_type::follow_type_id;
use crate::records::singleton_type::SingletonType;
use crate::records::string_singleton::StringSingleton;
use crate::records::type_function_context::TypeFunctionContext;
use crate::records::type_function_reduction_result::TypeFunctionReductionResult;
use crate::records::union_type::UnionType;
use crate::type_aliases::singleton_variant::SingletonVariant;
use crate::type_aliases::type_id::TypeId;
use crate::type_aliases::type_pack_id::TypePackId;
use alloc::collections::BTreeSet;
use alloc::vec::Vec;
use luaur_common::macros::luau_assert::LUAU_ASSERT;
use luaur_common::records::dense_hash_set::DenseHashSet;

pub fn keyof_function_impl(
    type_params: Vec<TypeId>,
    pack_params: Vec<TypePackId>,
    ctx: *mut TypeFunctionContext,
    is_raw: bool,
) -> TypeFunctionReductionResult {
    let ctx_ref = unsafe { &*ctx };
    if type_params.len() != 1 || !pack_params.is_empty() {
        unsafe {
            (*ctx_ref.ice.as_ptr()).ice_string(
                "keyof type function: encountered a type function instance without the required argument structure",
            )
        };
        LUAU_ASSERT!(false);
    }

    let make_result = |result, reduction_status| TypeFunctionReductionResult {
        result,
        reduction_status,
        blocked_types: Vec::new(),
        blocked_packs: Vec::new(),
        error: None,
        messages: Vec::new(),
    };

    let operand_ty = unsafe { follow_type_id(type_params[0]) };
    let Some(norm_ty) = (unsafe { (*ctx_ref.normalizer.as_ptr()).try_normalize(operand_ty) })
    else {
        return make_result(None, Reduction::MaybeOk);
    };

    if norm_ty.has_tables() == norm_ty.has_extern_types() {
        return make_result(None, Reduction::Erroneous);
    }

    if norm_ty.has_tops()
        || norm_ty.has_booleans()
        || norm_ty.has_errors()
        || norm_ty.has_nils()
        || norm_ty.has_numbers()
        || norm_ty.has_strings()
        || norm_ty.has_threads()
        || norm_ty.has_buffers()
        || norm_ty.has_functions()
        || norm_ty.has_tyvars()
    {
        return make_result(None, Reduction::Erroneous);
    }

    let mut keys = BTreeSet::new();

    if norm_ty.has_extern_types() {
        LUAU_ASSERT!(!norm_ty.has_tables());
        let mut seen: DenseHashSet<TypeId> = DenseHashSet::new(core::ptr::null());

        let mut extern_types = norm_ty.extern_types.ordering.iter().copied();
        let Some(first) = extern_types.next() else {
            return make_result(None, Reduction::Erroneous);
        };

        if !compute_keys_of(first, &mut keys, &mut seen, is_raw, ctx) {
            return make_result(
                Some(unsafe { ctx_ref.builtins.as_ref().stringType }),
                Reduction::MaybeOk,
            );
        }

        for extern_ty in extern_types {
            seen.clear();
            let mut local_keys = BTreeSet::new();
            if compute_keys_of(extern_ty, &mut local_keys, &mut seen, is_raw, ctx) {
                keys.retain(|key| local_keys.contains(key));
            }
        }
    }

    if norm_ty.has_tables() {
        LUAU_ASSERT!(!norm_ty.has_extern_types());
        let mut seen: DenseHashSet<TypeId> = DenseHashSet::new(core::ptr::null());

        let mut tables = norm_ty.tables.order.iter().copied();
        let Some(first) = tables.next() else {
            return make_result(None, Reduction::Erroneous);
        };

        if !compute_keys_of(first, &mut keys, &mut seen, is_raw, ctx) {
            return make_result(
                Some(unsafe { ctx_ref.builtins.as_ref().stringType }),
                Reduction::MaybeOk,
            );
        }

        for table in tables {
            seen.clear();
            let mut local_keys = BTreeSet::new();
            if compute_keys_of(table, &mut local_keys, &mut seen, is_raw, ctx) {
                keys.retain(|key| local_keys.contains(key));
            }
        }
    }

    if keys.is_empty() {
        return make_result(
            Some(unsafe { ctx_ref.builtins.as_ref().neverType }),
            Reduction::MaybeOk,
        );
    }

    let mut singletons = Vec::new();
    for key in keys {
        singletons.push(unsafe {
            (*ctx_ref.arena.as_ptr()).add_type(SingletonType::singleton_type(SingletonVariant::V1(
                StringSingleton::new(key),
            )))
        });
    }

    if singletons.len() == 1 {
        return make_result(Some(singletons[0]), Reduction::MaybeOk);
    }

    make_result(
        Some(unsafe {
            (*ctx_ref.arena.as_ptr()).add_type(UnionType {
                options: singletons,
            })
        }),
        Reduction::MaybeOk,
    )
}