emmylua_ls 0.25.1

A language server for emmylua.
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
use std::str::FromStr;

use emmylua_code_analysis::{
    LuaBuiltinAttributeKind, LuaCompilation, LuaDeclId, LuaFieldAccessorConvention, LuaMemberId,
    LuaMemberInfo, LuaMemberKey, LuaMemberOwner, LuaSemanticDeclId, LuaType, LuaTypeDeclId,
    SemanticDeclLevel, SemanticModel,
};
use emmylua_parser::{
    LuaAstNode, LuaAstToken, LuaCallExpr, LuaExpr, LuaIndexExpr, LuaReturnStat, LuaStringToken,
    LuaSyntaxToken, LuaTableExpr, LuaTableField,
};
use itertools::Itertools;
use lsp_types::{GotoDefinitionResponse, Location, Position, Range, Uri};

use crate::{
    handlers::{
        common::{find_all_same_named_members, find_member_origin_owner},
        definition::goto_function::{
            find_function_call_origin, find_matching_function_definitions,
        },
    },
    util::{to_camel_case, to_pascal_case, to_snake_case},
};

pub fn goto_def_definition(
    semantic_model: &SemanticModel,
    compilation: &LuaCompilation,
    semantic_id: LuaSemanticDeclId,
    trigger_token: &LuaSyntaxToken,
) -> Option<GotoDefinitionResponse> {
    // 首先检查属性源位置
    if let Some(property) = semantic_model
        .get_db()
        .get_property_index()
        .get_property(&semantic_id)
        && let Some(source) = property.source()
        && let Some(location) = goto_source_location(source)
    {
        return Some(GotoDefinitionResponse::Scalar(location));
    }

    // 根据不同的语义声明类型处理
    match semantic_id {
        LuaSemanticDeclId::LuaDecl(decl_id) => handle_decl_definition(
            semantic_model,
            compilation,
            trigger_token,
            &semantic_id,
            &decl_id,
        ),
        LuaSemanticDeclId::Member(member_id) => {
            handle_member_definition(semantic_model, compilation, trigger_token, &member_id)
        }
        LuaSemanticDeclId::TypeDecl(type_decl_id) => {
            handle_type_decl_definition(semantic_model, &type_decl_id)
        }
        _ => None,
    }
}

fn handle_decl_definition(
    semantic_model: &SemanticModel,
    compilation: &LuaCompilation,
    trigger_token: &LuaSyntaxToken,
    property_owner: &LuaSemanticDeclId,
    decl_id: &LuaDeclId,
) -> Option<GotoDefinitionResponse> {
    // 尝试查找函数调用的原始定义
    if let Some(match_semantic_decl) =
        find_function_call_origin(semantic_model, compilation, trigger_token, property_owner)
        && let LuaSemanticDeclId::LuaDecl(matched_decl_id) = match_semantic_decl
    {
        if let Some(location) = get_decl_location(semantic_model, &matched_decl_id) {
            return Some(GotoDefinitionResponse::Scalar(location));
        }
    }

    // 返回声明的位置
    if let Some(location) = get_decl_location(semantic_model, decl_id) {
        return Some(GotoDefinitionResponse::Scalar(location));
    }

    // 如果不等于当前文件, 那么我们可能是引用了其他文件的导出
    if decl_id.file_id != semantic_model.get_file_id()
        && let Some(semantic_decl) =
            semantic_model.find_decl(trigger_token.clone().into(), SemanticDeclLevel::NoTrace)
        && let LuaSemanticDeclId::LuaDecl(decl_id) = semantic_decl
        && let Some(location) = get_decl_location(semantic_model, &decl_id)
    {
        return Some(GotoDefinitionResponse::Scalar(location));
    }

    None
}

fn handle_member_definition(
    semantic_model: &SemanticModel,
    compilation: &LuaCompilation,
    trigger_token: &LuaSyntaxToken,
    member_id: &LuaMemberId,
) -> Option<GotoDefinitionResponse> {
    let mut same_named_members =
        find_all_same_named_members(semantic_model, &Some(LuaSemanticDeclId::Member(*member_id)))?;
    same_named_members.retain(|semantic_decl| {
        semantic_model.is_semantic_visible(trigger_token.clone(), semantic_decl.clone())
    });

    let mut locations: Vec<Location> = Vec::new();

    // 尝试寻找函数调用时最匹配的定义
    if let Some(match_members) = find_matching_function_definitions(
        semantic_model,
        compilation,
        trigger_token,
        &same_named_members,
    ) {
        process_matched_members(semantic_model, &match_members, &mut locations);
        if !locations.is_empty() {
            return Some(GotoDefinitionResponse::Array(locations));
        }
    }

    // 添加原始成员的位置
    for member in same_named_members {
        if let LuaSemanticDeclId::Member(member_id) = member
            && let Some(location) = get_member_location(semantic_model, &member_id)
        {
            // 尝试添加访问器的位置
            try_set_accessor_locations(semantic_model, &member, &mut locations);
            locations.push(location);
        }
    }

    // 处理实例表成员
    add_instance_table_member_locations(semantic_model, trigger_token, member_id, &mut locations);

    if !locations.is_empty() {
        Some(GotoDefinitionResponse::Array(
            locations.into_iter().unique().collect(),
        ))
    } else {
        None
    }
}

fn handle_type_decl_definition(
    semantic_model: &SemanticModel,
    type_decl_id: &LuaTypeDeclId,
) -> Option<GotoDefinitionResponse> {
    let type_decl = semantic_model
        .get_db()
        .get_type_index()
        .get_type_decl(type_decl_id)?;

    let mut locations: Vec<Location> = Vec::new();
    for lua_location in type_decl.get_locations() {
        let document = semantic_model.get_document_by_file_id(lua_location.file_id)?;
        let location = document.to_lsp_location(lua_location.range)?;
        locations.push(location);
    }

    Some(GotoDefinitionResponse::Array(locations))
}

fn process_matched_members(
    semantic_model: &SemanticModel,
    match_members: &[LuaSemanticDeclId],
    locations: &mut Vec<Location>,
) {
    for member in match_members {
        match member {
            LuaSemanticDeclId::Member(member_id) => {
                if should_trace_member(semantic_model, member_id).unwrap_or(false) {
                    // 尝试搜索这个成员最原始的定义
                    match find_member_origin_owner(semantic_model, *member_id) {
                        Some(LuaSemanticDeclId::Member(origin_member_id)) => {
                            if let Some(location) =
                                get_member_location(semantic_model, &origin_member_id)
                            {
                                locations.push(location);
                                continue;
                            }
                        }
                        Some(LuaSemanticDeclId::LuaDecl(origin_decl_id)) => {
                            if let Some(location) =
                                get_decl_location(semantic_model, &origin_decl_id)
                            {
                                locations.push(location);
                                continue;
                            }
                        }
                        _ => {}
                    }
                }
                if let Some(location) = get_member_location(semantic_model, member_id) {
                    locations.push(location);
                }
            }
            LuaSemanticDeclId::LuaDecl(decl_id) => {
                if let Some(location) = get_decl_location(semantic_model, decl_id) {
                    locations.push(location);
                }
            }
            _ => {}
        }
    }
}

fn add_instance_table_member_locations(
    semantic_model: &SemanticModel,
    trigger_token: &LuaSyntaxToken,
    member_id: &LuaMemberId,
    locations: &mut Vec<Location>,
) {
    /* 对于实例的处理, 对于实例 obj
    ```lua
        ---@class T
        ---@field func fun(a: int)
        ---@field func fun(a: string)

        ---@type T
        local obj = {
            func = function() end  -- 点击`func`时需要寻找`T`的定义
        }
        obj:func(1) -- 点击`func`时, 不止需要寻找`T`的定义也需要寻找`obj`实例化时赋值的`func`
    ```
     */
    if let Some(table_field_infos) =
        find_instance_table_member(semantic_model, trigger_token, member_id)
    {
        for table_field_info in table_field_infos {
            if let Some(LuaSemanticDeclId::Member(table_member_id)) =
                table_field_info.property_owner_id
                && let Some(location) = get_member_location(semantic_model, &table_member_id)
            {
                locations.push(location);
            }
        }
    }
}

fn goto_source_location(source: &str) -> Option<Location> {
    let source_parts = source.split('#').collect::<Vec<_>>();
    if source_parts.len() == 2 {
        let uri = source_parts[0];
        let range = source_parts[1];
        let range_parts = range.split(':').collect::<Vec<_>>();
        if range_parts.len() == 2 {
            let mut line_str = range_parts[0];
            if line_str.to_ascii_lowercase().starts_with("l") {
                line_str = &line_str[1..];
            }
            let line = line_str.parse::<u32>().ok()?;
            let col = range_parts[1].parse::<u32>().ok()?;
            let range = Range {
                start: Position::new(line, col),
                end: Position::new(line, col),
            };
            return Some(Location {
                uri: Uri::from_str(uri).ok()?,
                range,
            });
        }
    }

    None
}

pub fn goto_str_tpl_ref_definition(
    semantic_model: &SemanticModel,
    string_token: LuaStringToken,
) -> Option<GotoDefinitionResponse> {
    let name = string_token.get_value();
    let call_expr = string_token.ancestors::<LuaCallExpr>().next()?;
    let arg_exprs = call_expr.get_args_list()?.get_args().collect::<Vec<_>>();
    let string_token_idx = arg_exprs.iter().position(|arg| {
        if let LuaExpr::LiteralExpr(literal_expr) = arg {
            literal_expr
                .syntax()
                .text_range()
                .contains(string_token.get_range().start())
        } else {
            false
        }
    })?;
    let func = semantic_model.infer_call_expr_func(call_expr.clone(), None)?;
    let params = func.get_params();

    let target_param = match (func.is_colon_define(), call_expr.is_colon_call()) {
        (false, true) => params.get(string_token_idx + 1),
        (true, false) => {
            if string_token_idx > 0 {
                params.get(string_token_idx - 1)
            } else {
                None
            }
        }
        _ => params.get(string_token_idx),
    }?;
    // 首先尝试直接匹配StrTplRef类型
    if let Some(locations) =
        try_extract_str_tpl_ref_locations(semantic_model, &target_param.1, &name)
    {
        return Some(GotoDefinitionResponse::Array(locations));
    }

    // 如果参数类型是union,尝试从中提取StrTplRef类型
    if let Some(LuaType::Union(union_type)) = target_param.1.clone() {
        for union_member in union_type.into_vec().iter() {
            if let Some(locations) = try_extract_str_tpl_ref_locations(
                semantic_model,
                &Some(union_member.clone()),
                &name,
            ) {
                return Some(GotoDefinitionResponse::Array(locations));
            }
        }
    }

    None
}

pub fn find_instance_table_member(
    semantic_model: &SemanticModel,
    trigger_token: &LuaSyntaxToken,
    member_id: &LuaMemberId,
) -> Option<Vec<LuaMemberInfo>> {
    let member_key = semantic_model
        .get_db()
        .get_member_index()
        .get_member(member_id)?
        .get_key();
    let parent = trigger_token.parent()?;

    match parent {
        expr_node if LuaIndexExpr::can_cast(expr_node.kind().into()) => {
            let index_expr = LuaIndexExpr::cast(expr_node)?;
            let prefix_expr = index_expr.get_prefix_expr()?;

            let decl = semantic_model.find_decl(
                prefix_expr.syntax().clone().into(),
                SemanticDeclLevel::default(),
            );

            if let Some(LuaSemanticDeclId::LuaDecl(decl_id)) = decl {
                return find_member_in_table_const(semantic_model, &decl_id, member_key);
            }
        }
        table_field_node if LuaTableField::can_cast(table_field_node.kind().into()) => {
            let table_field = LuaTableField::cast(table_field_node)?;
            let table_expr = table_field.get_parent::<LuaTableExpr>()?;
            let typ = semantic_model.infer_table_should_be(table_expr)?;
            return semantic_model.get_member_info_with_key(&typ, member_key.clone(), true);
        }
        _ => {}
    }

    None
}

fn find_member_in_table_const(
    semantic_model: &SemanticModel,
    decl_id: &LuaDeclId,
    member_key: &LuaMemberKey,
) -> Option<Vec<LuaMemberInfo>> {
    let root = semantic_model
        .get_db()
        .get_vfs()
        .get_syntax_tree(&decl_id.file_id)?
        .get_red_root();

    let node = semantic_model
        .get_db()
        .get_decl_index()
        .get_decl(decl_id)?
        .get_value_syntax_id()?
        .to_node_from_root(&root)?;

    let table_expr = LuaTableExpr::cast(node)?;
    let typ = semantic_model
        .infer_expr(LuaExpr::TableExpr(table_expr))
        .ok()?;

    semantic_model.get_member_info_with_key(&typ, member_key.clone(), true)
}

/// 是否对 member 启动追踪
fn should_trace_member(semantic_model: &SemanticModel, member_id: &LuaMemberId) -> Option<bool> {
    let root = semantic_model
        .get_db()
        .get_vfs()
        .get_syntax_tree(&member_id.file_id)?
        .get_red_root();
    let node = member_id.get_syntax_id().to_node_from_root(&root)?;
    let parent = node.parent()?.parent()?;
    // 如果成员在返回语句中, 则需要追踪
    if LuaReturnStat::can_cast(parent.kind().into()) {
        return Some(true);
    } else {
        let typ = semantic_model.get_type((*member_id).into());
        if typ.is_signature() {
            return Some(true);
        }
    }
    None
}

fn get_member_location(
    semantic_model: &SemanticModel,
    member_id: &LuaMemberId,
) -> Option<Location> {
    let document = semantic_model.get_document_by_file_id(member_id.file_id)?;
    document.to_lsp_location(member_id.get_syntax_id().get_range())
}

fn get_decl_location(semantic_model: &SemanticModel, decl_id: &LuaDeclId) -> Option<Location> {
    let decl = semantic_model.get_db().get_decl_index().get_decl(decl_id)?;
    let document = semantic_model.get_document_by_file_id(decl_id.file_id)?;
    let location = document.to_lsp_location(decl.get_range())?;
    Some(location)
}

fn try_extract_str_tpl_ref_locations(
    semantic_model: &SemanticModel,
    param_type: &Option<LuaType>,
    name: &str,
) -> Option<Vec<Location>> {
    if let Some(LuaType::StrTplRef(str_tpl)) = param_type {
        let prefix = str_tpl.get_prefix();
        let suffix = str_tpl.get_suffix();
        let type_decl_id = LuaTypeDeclId::global(format!("{}{}{}", prefix, name, suffix).as_str());
        let type_decl = semantic_model
            .get_db()
            .get_type_index()
            .get_type_decl(&type_decl_id)?;
        let mut locations = Vec::new();
        for lua_location in type_decl.get_locations() {
            let document = semantic_model.get_document_by_file_id(lua_location.file_id)?;
            let location = document.to_lsp_location(lua_location.range)?;
            locations.push(location);
        }
        return Some(locations);
    }
    None
}

fn try_set_accessor_locations(
    semantic_model: &SemanticModel,
    semantic_decl_id: &LuaSemanticDeclId,
    locations: &mut Vec<Location>,
) -> Option<()> {
    let member_id = match semantic_decl_id {
        LuaSemanticDeclId::Member(id) => id,
        _ => return None,
    };
    let current_owner = semantic_model
        .get_db()
        .get_member_index()
        .get_current_owner(member_id)?;
    let prefix_type = match current_owner {
        LuaMemberOwner::Type(id) => LuaType::Ref(id.clone()),
        _ => return None,
    };
    let property = semantic_model
        .get_db()
        .get_property_index()
        .get_property(&semantic_decl_id)?;

    let field_accessor = property
        .find_builtin_attribute(LuaBuiltinAttributeKind::FieldAccessor)?
        .as_field_accessor()?;
    let has_getter = field_accessor.getter.is_some_and(|getter| {
        try_add_accessor_location(semantic_model, &prefix_type, getter.to_string(), locations)
    });
    let has_setter = field_accessor.setter.is_some_and(|setter| {
        try_add_accessor_location(semantic_model, &prefix_type, setter.to_string(), locations)
    });

    // 显式指定了获取器与设置器, 则不需要根据规则处理
    if has_getter && has_setter {
        return Some(());
    }

    let Some(original_name) = semantic_model
        .get_db()
        .get_member_index()
        .get_member(member_id)?
        .get_key()
        .get_name()
    else {
        return Some(());
    };

    if !has_getter {
        if let Some(getter_name) =
            build_accessor_name(field_accessor.convention, "get", original_name)
        {
            try_add_accessor_location(semantic_model, &prefix_type, getter_name, locations);
        }
    }

    if !has_setter {
        if let Some(setter_name) =
            build_accessor_name(field_accessor.convention, "set", original_name)
        {
            try_add_accessor_location(semantic_model, &prefix_type, setter_name, locations);
        }
    }

    Some(())
}

fn build_accessor_name(
    convention: LuaFieldAccessorConvention,
    prefix: &str,
    field_name: &str,
) -> Option<String> {
    if field_name.is_empty() {
        return None;
    }

    let full_name = format!("{}_{}", prefix, field_name);
    let name = match convention {
        LuaFieldAccessorConvention::CamelCase => to_camel_case(&full_name),
        LuaFieldAccessorConvention::SnakeCase => to_snake_case(&full_name),
        LuaFieldAccessorConvention::PascalCase => to_pascal_case(&full_name),
    };
    Some(name)
}

/// 尝试添加访问器位置到位置列表中
fn try_add_accessor_location(
    semantic_model: &SemanticModel,
    prefix_type: &LuaType,
    accessor_name: String,
    locations: &mut Vec<Location>,
) -> bool {
    let accessor_key = LuaMemberKey::Name(accessor_name.as_str().into());
    if let Some(member_infos) =
        semantic_model.get_member_info_with_key(prefix_type, accessor_key, false)
    {
        if let Some(member_info) = member_infos.first()
            && let Some(LuaSemanticDeclId::Member(accessor_id)) = member_info.property_owner_id
            && let Some(location) = get_member_location(semantic_model, &accessor_id)
        {
            locations.push(location);
            return true;
        }
    }
    false
}