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
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
use glua_code_analysis::{
    DbIndex, FileId, GmodRealm, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId, LuaType,
    LuaTypeDeclId, SemanticModel, enum_variable_is_param, get_tpl_ref_extend_type,
};
use glua_parser::{
    LuaAstNode, LuaAstToken, LuaComment, LuaCommentOwner, LuaDocTag, LuaDocTagRealm, LuaExpr,
    LuaFuncStat, LuaIndexExpr, LuaLocalFuncStat, LuaNameExpr, LuaStringToken, PathTrait,
};
use rowan::TextSize;
use smol_str::SmolStr;
use std::collections::{HashMap, HashSet};

use crate::handlers::completion::{
    add_completions::{CompletionTriggerStatus, add_member_completion_with_description_hint},
    completion_builder::CompletionBuilder,
};

pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
    if builder.is_cancelled() {
        return None;
    }

    let index_expr = LuaIndexExpr::cast(builder.trigger_token.parent()?)?;
    let index_token = index_expr.get_index_token()?;
    let completion_status = if index_token.is_dot() {
        CompletionTriggerStatus::Dot
    } else if index_token.is_colon() {
        CompletionTriggerStatus::Colon
    } else if LuaStringToken::can_cast(builder.trigger_token.kind().into()) {
        CompletionTriggerStatus::InString
    } else {
        CompletionTriggerStatus::LeftBracket
    };

    let prefix_expr = index_expr.get_prefix_expr()?;
    let prefix_type = match builder
        .semantic_model
        .infer_expr(prefix_expr.clone())
        .ok()?
    {
        LuaType::TplRef(tpl) => get_tpl_ref_extend_type(
            builder.semantic_model.get_db(),
            &mut builder.semantic_model.get_cache().borrow_mut(),
            &LuaType::TplRef(tpl.clone()),
            prefix_expr.clone(),
            0,
        )?,
        prefix_type => prefix_type,
    };
    // 如果是枚举类型且为函数参数, 则不进行补全
    if enum_variable_is_param(
        builder.semantic_model.get_db(),
        &mut builder.semantic_model.get_cache().borrow_mut(),
        &index_expr,
        &prefix_type,
    )
    .is_some()
    {
        return None;
    }

    let mut member_info_map = builder
        .semantic_model
        .get_member_info_map_at_offset(&prefix_type, builder.position_offset)
        .unwrap_or_default();
    extend_global_path_members(builder, &prefix_expr, &mut member_info_map);
    let gmod_owner_name = gmod_hook_owner_name(&prefix_expr, &prefix_type);
    let gmod_fallback_owner = if builder.semantic_model.get_emmyrc().gmod.enabled {
        gmod_owner_name
            .as_deref()
            .and_then(gmod_hook_fallback_owner)
    } else {
        None
    };
    extend_gmod_hook_fallback_members(builder, gmod_fallback_owner, &mut member_info_map);

    add_completions_for_members_with_gmod_owner(
        builder,
        &member_info_map,
        completion_status,
        gmod_fallback_owner,
    )
}

fn extend_global_path_members(
    builder: &CompletionBuilder,
    prefix_expr: &LuaExpr,
    members: &mut HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
) {
    let Some(prefix_path) = global_expr_access_path(&builder.semantic_model, prefix_expr) else {
        return;
    };

    let namespace_type = LuaType::Namespace(SmolStr::new(prefix_path).into());
    let Some(global_path_members) = builder
        .semantic_model
        .get_member_info_map_at_offset(&namespace_type, builder.position_offset)
    else {
        return;
    };

    let mut existing = collect_member_identities(members);

    for (key, infos) in global_path_members {
        for info in infos {
            push_unique_member_info(members, &mut existing, key.clone(), info);
        }
    }
}

fn global_expr_access_path(semantic_model: &SemanticModel, expr: &LuaExpr) -> Option<String> {
    if !expr_root_is_global(semantic_model, expr) {
        return None;
    }

    match expr {
        LuaExpr::NameExpr(name_expr) => name_expr.get_access_path(),
        LuaExpr::IndexExpr(index_expr) => index_expr.get_access_path(),
        _ => None,
    }
}

fn expr_root_is_global(semantic_model: &SemanticModel, expr: &LuaExpr) -> bool {
    let Some(root_name) = expr_root_name(expr) else {
        return false;
    };

    let db = semantic_model.get_db();
    let Some(decl_id) = db
        .get_reference_index()
        .get_var_reference_decl(&semantic_model.get_file_id(), root_name.get_range())
    else {
        return true;
    };

    db.get_decl_index()
        .get_decl(&decl_id)
        .is_some_and(|decl| decl.is_global() || decl.is_module_scoped())
}

fn expr_root_name(expr: &LuaExpr) -> Option<LuaNameExpr> {
    match expr {
        LuaExpr::NameExpr(name_expr) => Some(name_expr.clone()),
        LuaExpr::IndexExpr(index_expr) => {
            let prefix_expr = index_expr.get_prefix_expr()?;
            expr_root_name(&prefix_expr)
        }
        _ => None,
    }
}

fn extend_gmod_hook_fallback_members(
    builder: &CompletionBuilder,
    fallback_owner: Option<GmodFallbackOwner<'_>>,
    members: &mut HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
) {
    let Some(fallback_owner) = fallback_owner else {
        return;
    };

    let mut existing = collect_member_identities(members);

    for owner_candidate in fallback_owner.candidates {
        let owner_type = LuaType::Ref(LuaTypeDeclId::global(owner_candidate));
        let Some(fallback_map) = builder
            .semantic_model
            .get_member_info_map_at_offset(&owner_type, builder.position_offset)
        else {
            continue;
        };

        for (key, fallback_infos) in fallback_map {
            for info in fallback_infos {
                push_unique_member_info(members, &mut existing, key.clone(), info);
            }
        }
    }
}

type MemberIdentityMap = HashMap<LuaMemberKey, HashSet<MemberInfoIdentity>>;

#[derive(Clone, Debug, Eq, Hash, PartialEq)]
struct MemberInfoIdentity {
    property_owner_id: Option<LuaSemanticDeclId>,
    overload_index: Option<usize>,
}

impl From<&LuaMemberInfo> for MemberInfoIdentity {
    fn from(info: &LuaMemberInfo) -> Self {
        Self {
            property_owner_id: info.property_owner_id.clone(),
            overload_index: info.overload_index,
        }
    }
}

fn collect_member_identities(
    members: &HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
) -> MemberIdentityMap {
    let mut existing: MemberIdentityMap = HashMap::new();
    for (key, infos) in members {
        let entry = existing.entry(key.clone()).or_default();
        entry.extend(infos.iter().map(MemberInfoIdentity::from));
    }
    existing
}

fn push_unique_member_info(
    members: &mut HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
    existing: &mut MemberIdentityMap,
    key: LuaMemberKey,
    info: LuaMemberInfo,
) {
    let identities = existing.entry(key.clone()).or_default();
    if identities.insert(MemberInfoIdentity::from(&info)) {
        members.entry(key).or_default().push(info);
    }
}

fn gmod_hook_owner_name(prefix_expr: &LuaExpr, prefix_type: &LuaType) -> Option<String> {
    match prefix_type {
        LuaType::Ref(owner_type_decl_id) => Some(owner_type_decl_id.get_simple_name().to_string()),
        _ => match prefix_expr {
            LuaExpr::NameExpr(name_expr) => name_expr.get_name_text(),
            _ => None,
        },
    }
}

#[derive(Clone, Copy)]
struct GmodFallbackOwner<'a> {
    owner_name: &'a str,
    candidates: &'static [&'static str],
}

fn gmod_hook_fallback_owner(owner_name: &str) -> Option<GmodFallbackOwner<'_>> {
    let candidates = gmod_hook_owner_candidates(owner_name);
    if candidates.is_empty() {
        None
    } else {
        Some(GmodFallbackOwner {
            owner_name,
            candidates,
        })
    }
}

fn gmod_hook_owner_candidates(owner_name: &str) -> &'static [&'static str] {
    if owner_name.eq_ignore_ascii_case("GM") || owner_name.eq_ignore_ascii_case("GAMEMODE") {
        &["GM", "GAMEMODE", "SANDBOX"]
    } else if owner_name.eq_ignore_ascii_case("PLUGIN") {
        &["PLUGIN", "GM", "GAMEMODE", "SANDBOX"]
    } else if owner_name.eq_ignore_ascii_case("SANDBOX") {
        &["SANDBOX", "GM", "GAMEMODE"]
    } else {
        &[]
    }
}

pub fn add_completions_for_members(
    builder: &mut CompletionBuilder,
    members: &HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
    completion_status: CompletionTriggerStatus,
) -> Option<()> {
    add_completions_for_members_with_gmod_owner(builder, members, completion_status, None)
}

fn add_completions_for_members_with_gmod_owner(
    builder: &mut CompletionBuilder,
    members: &HashMap<LuaMemberKey, Vec<LuaMemberInfo>>,
    completion_status: CompletionTriggerStatus,
    gmod_fallback_owner: Option<GmodFallbackOwner<'_>>,
) -> Option<()> {
    // 排序
    let mut sorted_entries: Vec<_> = members.iter().collect();
    sorted_entries.sort_unstable_by_key(|(name, _)| *name);

    for (_, member_infos) in sorted_entries {
        add_resolve_member_infos(
            builder,
            member_infos,
            completion_status,
            gmod_fallback_owner,
        );
    }

    Some(())
}

fn add_resolve_member_infos(
    builder: &mut CompletionBuilder,
    member_infos: &Vec<LuaMemberInfo>,
    completion_status: CompletionTriggerStatus,
    gmod_fallback_owner: Option<GmodFallbackOwner<'_>>,
) -> Option<()> {
    if member_infos.len() == 1 {
        let member_info = &member_infos[0];
        if !is_member_realm_compatible(builder, member_info) {
            return Some(());
        }
        let overload_count = match &member_info.typ {
            LuaType::DocFunction(_) => None,
            LuaType::Signature(id) => {
                if let Some(signature) = builder
                    .semantic_model
                    .get_db()
                    .get_signature_index()
                    .get(id)
                {
                    let count = signature.overloads.len();
                    if count == 0 { None } else { Some(count) }
                } else {
                    None
                }
            }
            _ => None,
        };
        let description_hint =
            gmod_fallback_description_hint(builder, gmod_fallback_owner, member_info);
        add_member_completion_with_description_hint(
            builder,
            member_info.clone(),
            completion_status,
            overload_count,
            description_hint.as_deref(),
        );
        return Some(());
    }

    let (filtered_member_infos, overload_count) =
        filter_member_infos(&builder.semantic_model, member_infos)?;

    let resolve_state = get_resolve_state(builder.semantic_model.get_db(), &filtered_member_infos);

    for member_info in filtered_member_infos {
        if !is_member_realm_compatible(builder, member_info) {
            continue;
        }

        match resolve_state {
            MemberResolveState::All => {
                let description_hint =
                    gmod_fallback_description_hint(builder, gmod_fallback_owner, member_info);
                add_member_completion_with_description_hint(
                    builder,
                    member_info.clone(),
                    completion_status,
                    overload_count,
                    description_hint.as_deref(),
                );
            }
            MemberResolveState::Meta => {
                if let Some(feature) = member_info.feature
                    && feature.is_meta_decl()
                {
                    let description_hint =
                        gmod_fallback_description_hint(builder, gmod_fallback_owner, member_info);
                    add_member_completion_with_description_hint(
                        builder,
                        member_info.clone(),
                        completion_status,
                        overload_count,
                        description_hint.as_deref(),
                    );
                }
            }
            MemberResolveState::FileDecl => {
                if let Some(feature) = member_info.feature
                    && feature.is_file_decl()
                {
                    let description_hint =
                        gmod_fallback_description_hint(builder, gmod_fallback_owner, member_info);
                    add_member_completion_with_description_hint(
                        builder,
                        member_info.clone(),
                        completion_status,
                        overload_count,
                        description_hint.as_deref(),
                    );
                }
            }
        }
    }

    Some(())
}

fn gmod_fallback_description_hint(
    builder: &CompletionBuilder,
    fallback_owner: Option<GmodFallbackOwner<'_>>,
    member_info: &LuaMemberInfo,
) -> Option<String> {
    let fallback_owner = fallback_owner?;
    let source_owner = get_owner_type_id(builder.semantic_model.get_db(), member_info)?;
    let source_owner_name = source_owner.get_simple_name();
    if source_owner_name.eq_ignore_ascii_case(fallback_owner.owner_name)
        || !fallback_owner
            .candidates
            .iter()
            .any(|candidate| candidate.eq_ignore_ascii_case(source_owner_name))
    {
        return None;
    }

    Some(format!("from {source_owner_name}"))
}

/// 过滤成员信息,返回需要的成员列表和重载数量
fn filter_member_infos<'a>(
    semantic_model: &SemanticModel,
    member_infos: &'a Vec<LuaMemberInfo>,
) -> Option<(Vec<&'a LuaMemberInfo>, Option<usize>)> {
    if member_infos.is_empty() {
        return None;
    }

    let mut file_decl_member: Option<&LuaMemberInfo> = None;
    let mut gmod_meta_member: Option<&LuaMemberInfo> = None;
    let mut member_with_owners: Vec<(&LuaMemberInfo, Option<LuaTypeDeclId>)> =
        Vec::with_capacity(member_infos.len());
    let mut all_doc_function = true;
    let mut overload_count = 0;

    // 一次遍历收集所有信息
    for member_info in member_infos {
        let owner_id = get_owner_type_id(semantic_model.get_db(), member_info);
        member_with_owners.push((member_info, owner_id.clone()));

        // 寻找第一个 file_decl 作为参考,如果没有则使用第一个
        if file_decl_member.is_none()
            && let Some(feature) = member_info.feature
            && feature.is_file_decl()
        {
            file_decl_member = Some(member_info);
        }

        if gmod_meta_member.is_none()
            && let Some(feature) = member_info.feature
            && feature.is_meta_decl()
            && is_gmod_hook_member_info(semantic_model.get_db(), member_info)
        {
            gmod_meta_member = Some(member_info);
        }

        // 检查是否全为 DocFunction,同时计算重载数量
        match &member_info.typ {
            LuaType::DocFunction(_) => {
                overload_count += 1;
            }
            LuaType::Signature(id) => {
                all_doc_function = false;
                overload_count += 1;
                if let Some(signature) = semantic_model.get_db().get_signature_index().get(id) {
                    overload_count += signature.overloads.len();
                }
            }
            _ => {
                all_doc_function = false;
            }
        }
    }

    // 确定最终使用的参考 owner
    let final_reference_owner = if let Some(meta_member_info) = gmod_meta_member {
        get_owner_type_id(semantic_model.get_db(), meta_member_info)
    } else if let Some(file_decl_member_info) = file_decl_member {
        // 与第一个成员进行类型检查, 确保子类成员的类型与父类成员的类型一致
        if let Some((first_member, first_owner)) = member_with_owners.first() {
            let type_check_result =
                semantic_model.type_check(&file_decl_member_info.typ, &first_member.typ);
            if type_check_result.is_ok() {
                get_owner_type_id(semantic_model.get_db(), file_decl_member_info)
            } else {
                first_owner.clone()
            }
        } else {
            get_owner_type_id(semantic_model.get_db(), file_decl_member_info)
        }
    } else {
        // 没有找到 file_decl,使用第一个成员作为参考
        member_with_owners
            .first()
            .and_then(|(_, owner)| owner.clone())
    };

    // 过滤出相同 owner_type_id 的成员
    let mut filtered_member_infos: Vec<&LuaMemberInfo> = member_with_owners
        .into_iter()
        .filter_map(|(member_info, owner_id)| {
            if owner_id == final_reference_owner {
                Some(member_info)
            } else {
                None
            }
        })
        .collect();

    // 处理重载计数
    let final_overload_count = if overload_count >= 1 {
        let count = overload_count - 1;
        if count == 0 { None } else { Some(count) }
    } else {
        None
    };

    // 如果全为 DocFunction, 只保留第一个
    if all_doc_function && !filtered_member_infos.is_empty() {
        filtered_member_infos.truncate(1);
    }

    Some((filtered_member_infos, final_overload_count))
}

enum MemberResolveState {
    All,
    Meta,
    FileDecl,
}

fn get_owner_type_id(db: &DbIndex, info: &LuaMemberInfo) -> Option<LuaTypeDeclId> {
    match &info.property_owner_id {
        Some(LuaSemanticDeclId::Member(member_id)) => {
            if let Some(owner) = db.get_member_index().get_current_owner(member_id) {
                return owner.get_type_id().cloned();
            }
            None
        }
        _ => None,
    }
}

fn get_resolve_state(db: &DbIndex, member_infos: &Vec<&LuaMemberInfo>) -> MemberResolveState {
    let mut resolve_state = MemberResolveState::All;
    if db.get_emmyrc().strict.meta_override_file_define {
        for member_info in member_infos.iter() {
            if let Some(feature) = member_info.feature {
                if feature.is_meta_decl() {
                    resolve_state = MemberResolveState::Meta;
                    break;
                } else if feature.is_file_decl() {
                    resolve_state = MemberResolveState::FileDecl;
                }
            }
        }
    }
    resolve_state
}

fn is_gmod_hook_member_info(db: &DbIndex, info: &LuaMemberInfo) -> bool {
    let Some(owner_type_id) = get_owner_type_id(db, info) else {
        return false;
    };

    let owner_name = owner_type_id.get_simple_name();
    owner_name.eq_ignore_ascii_case("GM")
        || owner_name.eq_ignore_ascii_case("GAMEMODE")
        || owner_name.eq_ignore_ascii_case("SANDBOX")
        || owner_name.eq_ignore_ascii_case("PLUGIN")
}

fn is_member_realm_compatible(builder: &CompletionBuilder, info: &LuaMemberInfo) -> bool {
    if !builder.semantic_model.get_emmyrc().gmod.enabled {
        return true;
    }

    let infer_index = builder.semantic_model.get_db().get_gmod_infer_index();
    let call_realm = infer_index.get_realm_at_offset(
        &builder.semantic_model.get_file_id(),
        builder.position_offset,
    );

    if !matches!(call_realm, GmodRealm::Client | GmodRealm::Server) {
        return true;
    }

    let Some(property_owner_id) = &info.property_owner_id else {
        return true;
    };
    let Some((decl_file_id, decl_offset)) = semantic_decl_position(property_owner_id) else {
        return true;
    };

    let decl_realm = resolve_decl_realm(&builder.semantic_model, property_owner_id)
        .unwrap_or_else(|| infer_index.get_realm_at_offset(&decl_file_id, decl_offset));
    !matches!(
        (call_realm, decl_realm),
        (GmodRealm::Client, GmodRealm::Server) | (GmodRealm::Server, GmodRealm::Client)
    )
}

fn semantic_decl_position(property_owner_id: &LuaSemanticDeclId) -> Option<(FileId, TextSize)> {
    match property_owner_id {
        LuaSemanticDeclId::LuaDecl(decl_id) => Some((decl_id.file_id, decl_id.position)),
        LuaSemanticDeclId::Member(member_id) => Some((member_id.file_id, member_id.get_position())),
        LuaSemanticDeclId::Signature(signature_id) => {
            Some((signature_id.get_file_id(), signature_id.get_position()))
        }
        LuaSemanticDeclId::TypeDecl(_) => None,
    }
}

fn resolve_decl_realm(
    semantic_model: &SemanticModel,
    property_owner_id: &LuaSemanticDeclId,
) -> Option<GmodRealm> {
    let (decl_file_id, decl_offset) = semantic_decl_position(property_owner_id)?;
    if let Some(annotation_realm) =
        resolve_decl_annotation_realm_at_offset(semantic_model, &decl_file_id, decl_offset)
    {
        return Some(annotation_realm);
    }

    Some(
        semantic_model
            .get_db()
            .get_gmod_infer_index()
            .get_realm_at_offset(&decl_file_id, decl_offset),
    )
}

fn resolve_decl_annotation_realm_at_offset(
    semantic_model: &SemanticModel,
    file_id: &FileId,
    offset: TextSize,
) -> Option<GmodRealm> {
    let tree = semantic_model.get_db().get_vfs().get_syntax_tree(file_id)?;
    for func_stat in tree.get_chunk_node().descendants::<LuaFuncStat>() {
        if func_stat.get_range().contains(offset)
            && let Some(comment) = func_stat.get_left_comment()
            && let Some(realm) = realm_from_doc_comment(&comment)
        {
            return Some(realm);
        }
    }

    for local_func_stat in tree.get_chunk_node().descendants::<LuaLocalFuncStat>() {
        if local_func_stat.get_range().contains(offset)
            && let Some(comment) = local_func_stat.get_left_comment()
            && let Some(realm) = realm_from_doc_comment(&comment)
        {
            return Some(realm);
        }
    }

    None
}

fn realm_from_doc_comment(comment: &LuaComment) -> Option<GmodRealm> {
    for tag in comment.get_doc_tags() {
        if let LuaDocTag::Realm(realm_tag) = tag
            && let Some(realm) = realm_from_doc_tag(&realm_tag)
        {
            return Some(realm);
        }
    }

    None
}

fn realm_from_doc_tag(tag: &LuaDocTagRealm) -> Option<GmodRealm> {
    let name = tag.get_name_token()?;
    match name.get_name_text() {
        "client" => Some(GmodRealm::Client),
        "server" => Some(GmodRealm::Server),
        "shared" => Some(GmodRealm::Shared),
        _ => None,
    }
}

#[cfg(test)]
mod tests {
    use googletest::prelude::*;

    use super::*;

    fn function_member(key: LuaMemberKey, overload_index: Option<usize>) -> LuaMemberInfo {
        LuaMemberInfo {
            property_owner_id: None,
            key,
            typ: LuaType::Function,
            feature: None,
            overload_index,
        }
    }

    #[gtest]
    fn push_unique_member_info_keeps_distinct_overload_indices() -> Result<()> {
        let key = LuaMemberKey::Name("lookup".into());
        let mut members = HashMap::new();
        let mut existing = collect_member_identities(&members);

        push_unique_member_info(
            &mut members,
            &mut existing,
            key.clone(),
            function_member(key.clone(), Some(0)),
        );
        push_unique_member_info(
            &mut members,
            &mut existing,
            key.clone(),
            function_member(key.clone(), Some(1)),
        );
        push_unique_member_info(
            &mut members,
            &mut existing,
            key.clone(),
            function_member(key.clone(), Some(1)),
        );

        let infos = members.get(&key).ok_or("missing member infos").or_fail()?;
        verify_eq!(infos.len(), 2)
    }
}