luaur-analysis 0.1.0

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

//! Node: `cxx:Function:Luau.Analysis:Analysis/src/ToString.cpp:1742:to_string_named_function`
//! Source: `Analysis/src/ToString.cpp:1742-1824` (hand-ported)

use crate::functions::begin_type_pack::begin;
use crate::functions::end_type_pack::end;
use crate::functions::finite::finite;
use crate::functions::follow_type_pack::follow_type_pack_id;
use crate::functions::get_type_pack::get;
use crate::functions::size_type_pack::size;
use crate::records::function_type::FunctionType;
use crate::records::stringifier_state::StringifierState;
use crate::records::to_string_options::ToStringOptions;
use crate::records::to_string_result::ToStringResult;
use crate::records::type_pack::TypePack;
use crate::records::type_stringifier::TypeStringifier;
use crate::records::variadic_type_pack::VariadicTypePack;
use alloc::format;
use alloc::string::String;

/// C++ `std::string toStringNamedFunction(const std::string& funcName, const FunctionType& ftv, ToStringOptions& opts)`.
pub fn to_string_named_function_string_function_type_to_string_options(
    func_name: &str,
    ftv: &FunctionType,
    opts: &mut ToStringOptions,
) -> String {
    unsafe {
        let mut result = ToStringResult::default();
        let mut state = StringifierState::stringifier_state_stringifier_state(
            opts as *mut ToStringOptions,
            &mut result as *mut ToStringResult,
        );
        let mut tvs = TypeStringifier {
            state: &mut state as *mut StringifierState,
        };

        state.emit(func_name);

        if !opts.hide_named_function_type_parameters {
            tvs.stringify_vector_type_id_vector_type_pack_id(&ftv.generics, &ftv.generic_packs);
        }

        state.emit("(");

        let mut arg_pack_iter = begin(ftv.arg_types);
        let end_iter = end(ftv.arg_types);

        let mut first = true;
        let mut idx: usize = 0;
        while arg_pack_iter.operator_ne(&end_iter) {
            // ftv takes a self parameter as the first argument, skip it if specified in option
            if idx == 0 && ftv.has_self && opts.hide_function_self_argument {
                arg_pack_iter.operator_inc();
                idx += 1;
                continue;
            }

            if !first {
                state.emit(", ");
            }
            first = false;

            // We don't respect opts.functionTypeArguments
            if idx < opts.named_function_override_arg_names.len() {
                state.emit(format!("{}: ", opts.named_function_override_arg_names[idx]).as_str());
            } else if idx < ftv.arg_names.len() && ftv.arg_names[idx].is_some() {
                state.emit(format!("{}: ", ftv.arg_names[idx].as_ref().unwrap().name).as_str());
            } else {
                state.emit("_: ");
            }
            tvs.stringify_type_id(*arg_pack_iter.operator_deref());

            arg_pack_iter.operator_inc();
            idx += 1;
        }

        if let Some(tail) = arg_pack_iter.tail() {
            let vtp = get::<VariadicTypePack>(tail);
            if vtp.is_null() || !(*vtp).hidden {
                if !first {
                    state.emit(", ");
                }

                state.emit("...: ");

                if !vtp.is_null() {
                    tvs.stringify_type_id((*vtp).ty);
                } else {
                    tvs.stringify_type_pack_id(tail);
                }
            }
        }

        state.emit("): ");

        let ret_size = size(ftv.ret_types, core::ptr::null_mut());
        let has_tail = !finite(ftv.ret_types, core::ptr::null_mut());
        let wrap = !get::<TypePack>(follow_type_pack_id(ftv.ret_types)).is_null()
            && (if has_tail {
                ret_size != 0
            } else {
                ret_size > 1
            });

        if wrap {
            state.emit("(");
        }

        tvs.stringify_type_pack_id(ftv.ret_types);

        if wrap {
            state.emit(")");
        }

        result.name
    }
}