Skip to main content

runec/
arguments.rs

1use crate::clientscript::hook_types;
2use crate::parser::Expr;
3use crate::symbol::{ReturnType, SymbolKind, SymbolRegistry, SymbolTable};
4use crate::types::{BaseVarType, Type};
5use std::collections::VecDeque;
6
7fn stack(ty: Type) -> usize {
8    match ty.base_type() {
9        BaseVarType::Integer => 0,
10        BaseVarType::String => 1,
11        BaseVarType::Long => 2,
12    }
13}
14
15pub fn expression_types(expr: &Expr, registry: &SymbolRegistry, locals: &SymbolTable) -> Vec<Type> {
16    let symbol = match expr {
17        Expr::Tuple(values) | Expr::MultiAssign(values, _) => {
18            return values
19                .iter()
20                .flat_map(|value| expression_types(value, registry, locals))
21                .collect();
22        }
23        Expr::StringLiteral(_) | Expr::JoinedString { .. } => return vec![Type::String],
24        Expr::LongLiteral(_) => return vec![Type::Long],
25        Expr::LocalVar(name, _) | Expr::ArrayAccess { name, .. } => locals.lookup(name),
26        Expr::GameVar(name, _) => registry.lookup_game_var(name.trim_start_matches('.')),
27        Expr::ConstantVar(name, _) => registry.lookup_constant(name),
28        Expr::CommandCall { name, args, .. } => return command_returns(registry, name, args),
29        Expr::Identifier(name) => registry
30            .lookup_command(name.trim_start_matches('.'))
31            .or_else(|| registry.lookup_constant(name)),
32        Expr::ProcCall { name, .. } => registry
33            .lookup_script_by_trigger("proc", name)
34            .or_else(|| registry.lookup_script_by_trigger("clientscript", name)),
35        Expr::Calc(value) | Expr::BinaryOp { lhs: value, .. } => {
36            return expression_types(value, registry, locals);
37        }
38        _ => None,
39    };
40    match symbol.map(|symbol| &symbol.kind) {
41        Some(SymbolKind::LocalVar { var_type, .. } | SymbolKind::GameVar { var_type, .. }) => {
42            vec![*var_type]
43        }
44        Some(SymbolKind::ScriptParam { param_type, .. }) => vec![*param_type],
45        Some(SymbolKind::Constant { const_type, .. }) => vec![*const_type],
46        Some(
47            SymbolKind::Command { return_types, .. } | SymbolKind::Script { return_types, .. },
48        ) => return_types.clone(),
49        _ => vec![Type::Int],
50    }
51}
52
53pub fn command_returns(registry: &SymbolRegistry, name: &str, args: &[Expr]) -> Vec<Type> {
54    let name = name.trim_start_matches('.');
55    let value = |index: usize, hint: Type| {
56        args.get(index).and_then(|arg| match arg {
57            Expr::IntLiteral(value) => Some(*value),
58            Expr::CharLiteral(value) => Some(*value as i32),
59            Expr::Identifier(name) => registry
60                .lookup_reference(name, hint)
61                .or_else(|| registry.type_chars.get(name).copied()),
62            Expr::ConstantVar(name, _) => registry.lookup_constant(name).and_then(|symbol| {
63                if let SymbolKind::Constant { int_value, .. } = symbol.kind {
64                    int_value
65                } else {
66                    None
67                }
68            }),
69            _ => None,
70        })
71    };
72    let dynamic = match registry.dynamic_returns.get(name) {
73        Some(ReturnType::TypeArgument(index)) => value(*index, Type::Int)
74            .and_then(|value| char::from_u32(value as u32))
75            .and_then(Type::from_char),
76        Some(ReturnType::ParamArgument(index)) => value(*index, Type::Param)
77            .map(|id| registry.param_types.get(&id).copied().unwrap_or(Type::Int)),
78        None => None,
79    };
80    if let Some(ty) = dynamic {
81        return vec![ty];
82    }
83    match registry.lookup_command(name).map(|symbol| &symbol.kind) {
84        Some(SymbolKind::Command { return_types, .. }) => return_types.clone(),
85        _ => Vec::new(),
86    }
87}
88
89pub fn command_hints(
90    registry: &SymbolRegistry,
91    name: &str,
92    args: &[Expr],
93    locals: &SymbolTable,
94) -> Vec<Option<Type>> {
95    let mut params = registry
96        .command_param_types
97        .get(name)
98        .cloned()
99        .unwrap_or_default();
100    if !registry.stack_commands.contains(name) {
101        return (0..args.len()).map(|i| params.get(i).copied()).collect();
102    }
103    // An enum's first argument names the type of its key.
104    if matches!(
105        registry.dynamic_returns.get(name),
106        Some(ReturnType::TypeArgument(1))
107    ) && let Some(Expr::Identifier(key)) = args.first()
108        && let Some(ty) = Type::from_name(key)
109        && let Some(slot) = params.last_mut()
110    {
111        *slot = ty;
112    }
113    if let Some(&explicit) = registry.hook_commands.get(name)
114        && let Some(signature) = args.iter().rev().find_map(|arg| match arg {
115            Expr::StringLiteral(value) => Some(value.as_str()),
116            _ => None,
117        })
118    {
119        let triggers = if signature.ends_with('Y') {
120            args.iter()
121                .rev()
122                .filter(|arg| {
123                    expression_types(arg, registry, locals)
124                        .first()
125                        .is_some_and(|ty| stack(*ty) == 0)
126                })
127                .nth(usize::from(explicit))
128                .and_then(|arg| match arg {
129                    Expr::IntLiteral(n) => usize::try_from(*n).ok(),
130                    _ => None,
131                })
132                .unwrap_or(0)
133        } else {
134            0
135        };
136        params = hook_types(signature, triggers, explicit);
137    }
138    stack_hints(registry, &params, args, locals)
139}
140
141pub fn proc_hints(
142    registry: &SymbolRegistry,
143    name: &str,
144    args: &[Expr],
145    locals: &SymbolTable,
146) -> Vec<Option<Type>> {
147    let symbol = registry
148        .lookup_script_by_trigger("proc", name)
149        .or_else(|| registry.lookup_script_by_trigger("clientscript", name));
150    let Some(SymbolKind::Script {
151        trigger,
152        param_types,
153        ..
154    }) = symbol.map(|symbol| &symbol.kind)
155    else {
156        return vec![None; args.len()];
157    };
158    if registry
159        .stack_scripts
160        .contains(&format!("{trigger}:{name}"))
161    {
162        stack_hints(registry, param_types, args, locals)
163    } else {
164        (0..args.len())
165            .map(|i| param_types.get(i).copied())
166            .collect()
167    }
168}
169
170pub fn stack_hints(
171    registry: &SymbolRegistry,
172    params: &[Type],
173    args: &[Expr],
174    locals: &SymbolTable,
175) -> Vec<Option<Type>> {
176    let mut pending: [VecDeque<Type>; 3] = Default::default();
177    for &ty in params {
178        pending[stack(ty)].push_back(ty);
179    }
180    args.iter()
181        .enumerate()
182        .map(|(i, arg)| {
183            let mut types = expression_types(arg, registry, locals);
184            // `null` is a string where the strings still to come can't fill the stack.
185            if matches!(arg, Expr::NullLiteral)
186                && (pending[0].is_empty()
187                    || pending[1].len()
188                        > args[i + 1..]
189                            .iter()
190                            .flat_map(|arg| expression_types(arg, registry, locals))
191                            .filter(|ty| stack(*ty) == 1)
192                            .count())
193            {
194                types = vec![Type::String];
195            }
196            if let Expr::StringLiteral(name) | Expr::Identifier(name) = arg
197                && let Some(&ty) = pending[0].front()
198                && registry.lookup_reference(name, ty).is_some()
199                && (matches!(arg, Expr::Identifier(_))
200                    || args[i..]
201                        .iter()
202                        .flat_map(|arg| expression_types(arg, registry, locals))
203                        .filter(|ty| stack(*ty) == 1)
204                        .count()
205                        > pending[1].len())
206            {
207                types = vec![ty];
208            }
209            let hint = types
210                .first()
211                .and_then(|ty| pending[stack(*ty)].front().copied());
212            for ty in types {
213                pending[stack(ty)].pop_front();
214            }
215            hint
216        })
217        .collect()
218}