glua_ls 1.0.27

Language server for Garry's Mod Lua (GLua).
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use std::collections::HashSet;

use glua_code_analysis::{
    LuaCompilation, LuaDeclExtra, LuaDeclId, LuaMemberId, LuaMemberIndexItem, LuaMemberOwner,
    LuaSemanticDeclId, LuaType, LuaTypeDeclId, LuaUnionType, SemanticDeclLevel, SemanticModel,
};
use glua_parser::{LuaAssignStat, LuaAstNode, LuaSyntaxKind, LuaTableExpr, LuaTableField};
use rowan::TextSize;

#[derive(Debug, Clone)]
pub enum DeclOriginResult {
    Single(LuaSemanticDeclId),
    Multiple(Vec<LuaSemanticDeclId>),
}

impl DeclOriginResult {
    pub fn get_first(&self) -> Option<LuaSemanticDeclId> {
        match self {
            DeclOriginResult::Single(decl) => Some(decl.clone()),
            DeclOriginResult::Multiple(decls) => decls.first().cloned(),
        }
    }

    pub fn get_types(&self, semantic_model: &SemanticModel) -> Vec<(LuaSemanticDeclId, LuaType)> {
        let get_type = |decl: &LuaSemanticDeclId| -> Option<(LuaSemanticDeclId, LuaType)> {
            match decl {
                LuaSemanticDeclId::Member(member_id) => {
                    let typ = semantic_model.get_type((*member_id).into());
                    Some((decl.clone(), typ))
                }
                LuaSemanticDeclId::LuaDecl(decl_id) => {
                    let db = semantic_model.get_db();
                    let decl_info = db.get_decl_index().get_decl(decl_id)?;
                    let typ = if let LuaDeclExtra::Param {
                        idx, signature_id, ..
                    } = &decl_info.extra
                    {
                        db.get_signature_index()
                            .get(signature_id)?
                            .get_param_info_by_id(*idx)?
                            .type_ref
                            .clone()
                    } else {
                        semantic_model.get_type((*decl_id).into())
                    };
                    Some((decl.clone(), typ))
                }
                _ => None,
            }
        };

        match self {
            DeclOriginResult::Single(decl) => get_type(decl).into_iter().collect(),
            DeclOriginResult::Multiple(decls) => decls.iter().filter_map(get_type).collect(),
        }
    }
}

pub fn find_decl_origin_owners(
    compilation: &LuaCompilation,
    semantic_model: &SemanticModel,
    decl_id: LuaDeclId,
) -> DeclOriginResult {
    let node = semantic_model
        .get_db()
        .get_vfs()
        .get_syntax_tree(&decl_id.file_id)
        .and_then(|tree| {
            let root = tree.get_red_root();
            semantic_model
                .get_db()
                .get_decl_index()
                .get_decl(&decl_id)
                .and_then(|decl| decl.get_value_syntax_id())
                .and_then(|syntax_id| syntax_id.to_node_from_root(&root))
        });

    if let Some(node) = node {
        let semantic_decl = semantic_model.find_decl(node.into(), SemanticDeclLevel::default());
        match semantic_decl {
            Some(LuaSemanticDeclId::Member(member_id)) => {
                find_member_origin_owners(compilation, semantic_model, member_id, true, None)
            }
            Some(LuaSemanticDeclId::LuaDecl(decl_id)) => {
                DeclOriginResult::Single(LuaSemanticDeclId::LuaDecl(decl_id))
            }
            _ => DeclOriginResult::Single(LuaSemanticDeclId::LuaDecl(decl_id)),
        }
    } else {
        DeclOriginResult::Single(LuaSemanticDeclId::LuaDecl(decl_id))
    }
}

pub fn find_member_origin_owners(
    compilation: &LuaCompilation,
    semantic_model: &SemanticModel,
    member_id: LuaMemberId,
    find_all: bool,
    usage_position: Option<TextSize>,
) -> DeclOriginResult {
    const MAX_ITERATIONS: usize = 50;
    let mut visited_members = HashSet::new();

    let mut current_owner = resolve_member_owner(compilation, semantic_model, &member_id);
    let mut final_owner = current_owner.clone();
    let mut iteration_count = 0;

    while let Some(LuaSemanticDeclId::Member(current_member_id)) = &current_owner {
        if visited_members.contains(current_member_id) || iteration_count >= MAX_ITERATIONS {
            break;
        }

        visited_members.insert(*current_member_id);
        iteration_count += 1;

        match resolve_member_owner(compilation, semantic_model, current_member_id) {
            Some(next_owner) => {
                final_owner = Some(next_owner.clone());
                current_owner = Some(next_owner);
            }
            None => break,
        }
    }

    if final_owner.is_none() {
        final_owner = Some(LuaSemanticDeclId::Member(member_id));
    }

    if !find_all {
        return DeclOriginResult::Single(
            final_owner.unwrap_or_else(|| LuaSemanticDeclId::Member(member_id)),
        );
    }

    // 如果存在多个同名成员, 则返回多个成员
    if let Some(same_named_members) =
        find_all_same_named_members(semantic_model, &final_owner, usage_position)
        && same_named_members.len() > 1
    {
        return DeclOriginResult::Multiple(same_named_members);
    }
    // 否则返回单个成员
    DeclOriginResult::Single(final_owner.unwrap_or_else(|| LuaSemanticDeclId::Member(member_id)))
}

pub fn find_member_origin_owner(
    compilation: &LuaCompilation,
    semantic_model: &SemanticModel,
    member_id: LuaMemberId,
) -> Option<LuaSemanticDeclId> {
    find_member_origin_owners(compilation, semantic_model, member_id, false, None).get_first()
}

pub fn find_all_same_named_members(
    semantic_model: &SemanticModel,
    final_owner: &Option<LuaSemanticDeclId>,
    position_offset: Option<rowan::TextSize>,
) -> Option<Vec<LuaSemanticDeclId>> {
    let final_owner = final_owner.as_ref()?;
    let member_id = match final_owner {
        LuaSemanticDeclId::Member(id) => id,
        _ => return None,
    };

    let original_member = semantic_model
        .get_db()
        .get_member_index()
        .get_member(member_id)?;
    let is_scripted_class_assignment_file_define = original_member.get_feature().is_file_define()
        && original_member.get_syntax_id().get_kind() == LuaSyntaxKind::IndexExpr;

    let target_key = original_member.get_key().clone();
    let current_owner = semantic_model
        .get_db()
        .get_member_index()
        .get_current_owner(member_id)?;

    let mut seen_member_ids = HashSet::new();
    let mut same_named: Vec<LuaSemanticDeclId> = Vec::new();
    let mut push_member = |member_id: LuaMemberId| {
        if seen_member_ids.insert(member_id) {
            same_named.push(LuaSemanticDeclId::Member(member_id));
        }
    };

    let scoped_class_info = semantic_model
        .get_db()
        .get_gmod_infer_index()
        .get_scoped_class_info(&semantic_model.get_file_id());

    if is_scripted_class_assignment_file_define && scoped_class_info.is_some() {
        let mut owner_candidates = vec![current_owner.clone()];
        if let Some(scoped_class_info) = scoped_class_info {
            let scripted_owner =
                LuaMemberOwner::Type(LuaTypeDeclId::global(&scoped_class_info.class_name));
            if !owner_candidates.contains(&scripted_owner) {
                owner_candidates.push(scripted_owner);
            }
        }

        let mut matching_member_ids = owner_candidates
            .iter()
            .flat_map(|owner| {
                semantic_model
                    .get_db()
                    .get_member_index()
                    .get_members_for_owner_key(owner, &target_key)
                    .into_iter()
                    .map(|member| member.get_id())
                    .collect::<Vec<_>>()
            })
            .collect::<Vec<_>>();

        let same_file_member_ids = semantic_model
            .get_db()
            .get_member_index()
            .get_file_members(semantic_model.get_file_id())
            .into_iter()
            .filter(|member| {
                member.get_key() == &target_key
                    && member.get_feature().is_file_define()
                    && member.get_syntax_id().get_kind() == LuaSyntaxKind::IndexExpr
                    && semantic_model
                        .get_db()
                        .get_member_index()
                        .get_current_owner(&member.get_id())
                        .is_some_and(|owner| {
                            owner_candidates.iter().any(|candidate| candidate == owner)
                        })
            })
            .map(|member| member.get_id())
            .collect::<Vec<_>>();
        matching_member_ids.extend(same_file_member_ids);

        let mut matching_members =
            member_ids_to_visible_same_named(semantic_model, matching_member_ids, position_offset);
        matching_members.sort_by_key(|member_id| {
            (
                member_id.file_id != semantic_model.get_file_id(),
                member_id.get_position(),
            )
        });

        for member_id in matching_members {
            push_member(member_id);
        }
    } else {
        match current_owner {
            LuaMemberOwner::Type(type_decl_id) => {
                let members = if let Some(position_offset) = position_offset {
                    semantic_model.get_member_info_with_key_at_offset(
                        &LuaType::Def(type_decl_id.clone()),
                        target_key,
                        true,
                        position_offset,
                    )?
                } else {
                    semantic_model.get_member_info_with_key(
                        &LuaType::Def(type_decl_id.clone()),
                        target_key,
                        true,
                    )?
                };

                for member_info in members {
                    if let Some(LuaSemanticDeclId::Member(member_id)) =
                        member_info.property_owner_id
                    {
                        push_member(member_id);
                    }
                }
            }
            _ => {
                if let Some(member_item) = semantic_model
                    .get_db()
                    .get_member_index()
                    .get_member_item(current_owner, &target_key)
                {
                    let visible_member_ids = position_offset.map_or_else(
                        || {
                            member_item.visible_member_ids_with_realm(
                                semantic_model.get_db(),
                                &semantic_model.get_file_id(),
                            )
                        },
                        |position_offset| {
                            member_item.visible_member_ids_with_realm_at_offset(
                                semantic_model.get_db(),
                                &semantic_model.get_file_id(),
                                position_offset,
                            )
                        },
                    );

                    for member_id in visible_member_ids {
                        push_member(member_id);
                    }
                } else {
                    let all_members = semantic_model
                        .get_db()
                        .get_member_index()
                        .get_members(current_owner)?;
                    for member in all_members {
                        if member.get_key() == &target_key {
                            push_member(member.get_id());
                        }
                    }
                }
            }
        }
    }

    if same_named.is_empty() {
        None
    } else {
        Some(same_named)
    }
}

fn member_ids_to_visible_same_named(
    semantic_model: &SemanticModel,
    member_ids: Vec<LuaMemberId>,
    position_offset: Option<rowan::TextSize>,
) -> Vec<LuaMemberId> {
    let member_item = LuaMemberIndexItem::Many(member_ids);
    position_offset.map_or_else(
        || {
            member_item.visible_member_ids_with_realm(
                semantic_model.get_db(),
                &semantic_model.get_file_id(),
            )
        },
        |position_offset| {
            member_item.visible_member_ids_with_realm_at_offset(
                semantic_model.get_db(),
                &semantic_model.get_file_id(),
                position_offset,
            )
        },
    )
}

fn resolve_member_owner(
    compilation: &LuaCompilation,
    semantic_model: &SemanticModel,
    member_id: &LuaMemberId,
) -> Option<LuaSemanticDeclId> {
    // 通常来说, 即使需要跨文件也一般只会跨一个文件, 所有不需要缓存
    let semantic_model = if member_id.file_id == semantic_model.get_file_id() {
        semantic_model
    } else {
        &compilation.get_semantic_model(member_id.file_id)?
    };

    let root = semantic_model.get_root().syntax();
    let current_node = member_id.get_syntax_id().to_node_from_root(root)?;
    let result = match member_id.get_syntax_id().get_kind() {
        LuaSyntaxKind::TableFieldAssign => {
            if LuaTableField::can_cast(current_node.kind().into()) {
                let table_field = LuaTableField::cast(current_node.clone())?;
                // 如果表是类, 那么通过类型推断获取 owner
                if let Some(owner_id) =
                    resolve_table_field_through_type_inference(semantic_model, &table_field)
                {
                    return Some(owner_id);
                }
                // 非类, 那么通过右值推断
                let value_expr = table_field.get_value_expr()?;
                let value_node = value_expr.get_syntax_id().to_node_from_root(root)?;
                semantic_model.find_decl(value_node.into(), SemanticDeclLevel::default())
            } else {
                None
            }
        }
        LuaSyntaxKind::IndexExpr => {
            let assign_node = current_node.parent()?;
            let assign_stat = LuaAssignStat::cast(assign_node)?;
            let (vars, exprs) = assign_stat.get_var_and_expr_list();

            let mut result = None;
            for (var, expr) in vars.iter().zip(exprs.iter()) {
                if var.syntax().text_range() == current_node.text_range() {
                    let expr_node = expr.get_syntax_id().to_node_from_root(root)?;
                    result =
                        semantic_model.find_decl(expr_node.into(), SemanticDeclLevel::default());
                    break;
                }
            }
            result
        }
        _ => None,
    };

    // 禁止追溯到参数
    match result {
        Some(LuaSemanticDeclId::LuaDecl(decl_id)) => {
            let decl = semantic_model
                .get_db()
                .get_decl_index()
                .get_decl(&decl_id)?;
            if decl.is_param() {
                return None;
            }
            result
        }
        _ => result,
    }
}

// 判断`table`是否为类
fn table_is_class(table_type: &LuaType, depth: usize) -> bool {
    if depth > 10 {
        return false;
    }
    match table_type {
        LuaType::Ref(_) | LuaType::Def(_) | LuaType::Generic(_) => true,
        LuaType::Union(union) => match union.as_ref() {
            LuaUnionType::Nullable(t) => table_is_class(t, depth + 1),
            LuaUnionType::Multi(ts) => ts.iter().any(|t| table_is_class(t, depth + 1)),
        },
        _ => false,
    }
}

fn resolve_table_field_through_type_inference(
    semantic_model: &SemanticModel,
    table_field: &LuaTableField,
) -> Option<LuaSemanticDeclId> {
    let parent = table_field.syntax().parent()?;
    let table_expr = LuaTableExpr::cast(parent)?;
    let table_type = semantic_model.infer_table_should_be(table_expr)?;

    // 必须为类我们才搜索其成员
    if !table_is_class(&table_type, 0) {
        return None;
    }

    let field_key = table_field.get_field_key()?;
    let key = semantic_model.get_member_key(&field_key)?;
    let member_infos = semantic_model.get_member_info_with_key_at_offset(
        &table_type,
        key,
        false,
        table_field.syntax().text_range().start(),
    )?;
    member_infos
        .first()
        .cloned()
        .and_then(|m| m.property_owner_id)
}

#[allow(unused)]
pub fn replace_semantic_type(
    semantic_decls: &mut [(LuaSemanticDeclId, LuaType)],
    origin_type: &LuaType,
) {
    // `origin_type`不一定包含所有`semantic_decls`中的类型, 实际的推断可能非常复杂, 这里仅是临时方案.

    // 解开`origin_type`
    let mut type_vec = Vec::new();
    match origin_type {
        LuaType::Union(union) => {
            for typ in union.into_vec() {
                type_vec.push(typ);
            }
        }
        _ => {
            type_vec.push(origin_type.clone());
        }
    }
    if type_vec.len() != semantic_decls.len() {
        return;
    }

    // 判断是否存在泛型, 如果有任意类型不匹配我们就认为存在泛型
    let mut has_generic = false;
    let type_set: HashSet<_> = type_vec.iter().collect();
    for (_, typ) in semantic_decls.iter() {
        if !type_set.contains(&typ) {
            has_generic = true;
            break;
        }
    }
    if !has_generic {
        return;
    }

    // 替换`semantic_decls`中的类型
    for (i, (_, typ)) in semantic_decls.iter_mut().enumerate() {
        if i < type_vec.len() {
            *typ = type_vec[i].clone();
        }
    }
}