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

use lsp_types::request::Request;
use lsp_types::{Position, TextDocumentIdentifier};
use serde::{Deserialize, Serialize};

use glua_code_analysis::{DEFAULT_DETAIL_MEMBER_DISPLAY_COUNT, LuaType, SemanticModel};
use glua_parser::LuaAstNode;
use rowan::TokenAtOffset;

// ── LSP request type ────────────────────────────────────────────────────────

#[derive(Debug)]
pub enum GluaHoverExpandRequest {}

impl Request for GluaHoverExpandRequest {
    type Params = HoverExpandParams;
    type Result = Option<HoverExpandResponse>;
    const METHOD: &'static str = "gluals/hoverExpand";
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HoverExpandParams {
    pub text_document: TextDocumentIdentifier,
    pub position: Position,
    /// Verbosity level. 0 = default compact member count, higher = more members.
    pub level: Option<u32>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HoverExpandResponse {
    /// Full hover markdown content.
    pub content: lsp_types::HoverContents,
    /// The range in the document this hover applies to.
    pub range: Option<lsp_types::Range>,
    /// Maximum verbosity level available for this symbol.
    pub max_level: u32,
}

// ── Verbosity level helpers ─────────────────────────────────────────────────

/// Maps a verbosity level to the max number of class members to display.
pub fn level_to_display_count(level: u32) -> usize {
    match level {
        0 => DEFAULT_DETAIL_MEMBER_DISPLAY_COUNT, // default — compact, fits in hover popup
        1 => 12,                                  // more detail
        2 => 24,                                  // verbose
        3 => 50,                                  // very verbose
        4 => 100,                                 // extremely verbose
        _ => usize::MAX,                          // level 5+ - show everything
    }
}

/// Computes the maximum verbosity level for a given total member count.
///
/// Returns 0 when all members fit at the default display count (no + button).
pub fn compute_max_level(total: usize) -> u32 {
    (0..)
        .find(|level| level_to_display_count(*level) >= total)
        .unwrap_or(0)
}

fn compute_max_level_for_type(semantic_model: &SemanticModel, typ: &LuaType) -> u32 {
    let total = match typ {
        LuaType::Def(_)
        | LuaType::Ref(_)
        | LuaType::TableConst(_)
        | LuaType::MergedTable(_)
        | LuaType::Instance(_) => semantic_model
            .get_member_infos(typ)
            .map(|members| members.len())
            .unwrap_or(0),
        LuaType::Object(object) => object.get_fields().len(),
        _ => 0,
    };
    compute_max_level(total)
}

/// Computes the maximum verbosity level for the type at the given position.
///
/// Returns non-zero for rendered table-like hovers that can show more members.
pub fn compute_max_level_at_position(semantic_model: &SemanticModel, position: Position) -> u32 {
    let document = semantic_model.get_document();
    let Some(offset) = document.get_offset(position.line as usize, position.character as usize)
    else {
        return 0;
    };
    let root = semantic_model.get_root();
    let token = match root.syntax().token_at_offset(offset) {
        TokenAtOffset::Single(t) => t,
        TokenAtOffset::Between(l, _) => l,
        TokenAtOffset::None => return 0,
    };

    let semantic_info = semantic_model.get_semantic_info(token.into());
    let typ = match semantic_info {
        Some(info) => info.typ,
        None => return 0,
    };

    compute_max_level_for_type(semantic_model, &typ)
}

#[cfg(test)]
mod tests {
    use crate::handlers::test_lib::check;

    use glua_code_analysis::{LuaType, LuaTypeDeclId, RenderLevel, VirtualWorkspace};
    use googletest::prelude::*;
    use lsp_types::HoverContents;
    use rowan::TextSize;

    use super::{
        compute_max_level, compute_max_level_at_position, compute_max_level_for_type,
        level_to_display_count,
    };

    #[gtest]
    fn max_level_display_count_covers_large_member_count() {
        let total = 501;
        let max_level = compute_max_level(total);

        assert_that!(level_to_display_count(max_level), ge(total));
    }

    #[gtest]
    fn default_level_display_count_is_compact() {
        assert_that!(level_to_display_count(0), eq(6));
        assert_that!(compute_max_level(6), eq(0));
        assert_that!(compute_max_level(7), eq(1));
    }

    #[gtest]
    fn def_type_hover_reports_expandable_max_level() -> Result<()> {
        let mut ws = VirtualWorkspace::new();
        let file_id = ws.def_file(
            "lua/entities/base_glide.lua",
            r#"
                ---@class base_glide
                ---@field crosshair table?
                ---@field _playerListExpanded any
                ---@field weaponSwitchNotification table?
                ---@field _expandTimer number
                ---@field AutomaticFrameAdvance boolean
                ---@field _hasBothSpriteBeams boolean?
                ---@field EnableCrosshair function
            "#,
        );
        let semantic_model = check!(ws.analysis.compilation.get_semantic_model(file_id));

        assert_that!(
            compute_max_level_for_type(
                &semantic_model,
                &LuaType::Def(LuaTypeDeclId::global("base_glide")),
            ),
            eq(1)
        );
        Ok(())
    }

    #[gtest]
    fn table_const_field_hover_reports_expandable_max_level() -> Result<()> {
        let mut ws = VirtualWorkspace::new();
        let content = r#"
            local ENT = {}
            ENT.SuspensionPoseParameters = {
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
            }
        "#;
        let file_id = ws.def_file("lua/entities/fl_audi_r8.lua", content);
        let semantic_model = check!(ws.analysis.compilation.get_semantic_model(file_id));
        let document = semantic_model.get_document();
        let name_offset = check!(content.find("SuspensionPoseParameters"));
        let position = check!(document.to_lsp_position(TextSize::new(name_offset as u32)));

        assert_that!(
            compute_max_level_at_position(&semantic_model, position),
            eq(2)
        );
        Ok(())
    }

    #[gtest]
    fn default_table_const_field_hover_renders_six_rows() -> Result<()> {
        let mut ws = VirtualWorkspace::new();
        let content = r#"
            local ENT = {}
            ENT.SuspensionPoseParameters = {
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
            }
        "#;
        let file_id = ws.def_file("lua/entities/fl_audi_r8.lua", content);
        let semantic_model = check!(ws.analysis.compilation.get_semantic_model(file_id));
        let document = semantic_model.get_document();
        let name_offset = check!(content.find("SuspensionPoseParameters"));
        let position = check!(document.to_lsp_position(TextSize::new(name_offset as u32)));

        let hover = check!(crate::handlers::hover::hover(
            &ws.analysis,
            file_id,
            position,
            None,
        ));
        let HoverContents::Markup(markup) = hover.contents else {
            return fail!("expected HoverContents::Markup");
        };

        verify_that!(markup.value.as_str(), contains_substring("[6]"))?;
        verify_that!(markup.value.as_str(), not(contains_substring("[7]")))?;
        verify_that!(markup.value.as_str(), contains_substring("    ..."))?;
        Ok(())
    }

    #[gtest]
    fn expanded_table_const_field_hover_renders_more_rows() -> Result<()> {
        let mut ws = VirtualWorkspace::new();
        let content = r#"
            local ENT = {}
            ENT.SuspensionPoseParameters = {
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
                { parameter = "vehicle_wheel_fr_height", wheel = 2 },
                { parameter = "vehicle_wheel_rl_height", wheel = 3 },
                { parameter = "vehicle_wheel_rr_height", wheel = 4 },
                { parameter = "vehicle_wheel_fl_height", wheel = 1 },
            }
        "#;
        let file_id = ws.def_file("lua/entities/fl_audi_r8.lua", content);
        let semantic_model = check!(ws.analysis.compilation.get_semantic_model(file_id));
        let document = semantic_model.get_document();
        let name_offset = check!(content.find("SuspensionPoseParameters"));
        let position = check!(document.to_lsp_position(TextSize::new(name_offset as u32)));

        let hover = check!(crate::handlers::hover::hover(
            &ws.analysis,
            file_id,
            position,
            Some(RenderLevel::DetailedCount(24)),
        ));
        let HoverContents::Markup(markup) = hover.contents else {
            return fail!("expected HoverContents::Markup");
        };

        verify_that!(markup.value.as_str(), contains_substring("[13]"))?;
        verify_that!(markup.value.as_str(), not(contains_substring("    ...")))?;
        Ok(())
    }
}