hx-lsp 0.2.11

One LSP server support snippets and actions for helix editor.
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
use std::fmt::Write;
use std::{
    collections::HashMap,
    path::{Path, PathBuf},
    sync::OnceLock,
};

use aho_corasick::{AhoCorasick, PatternID};
use parking_lot::Mutex;
use rand::Rng;
use time::{
    OffsetDateTime, UtcOffset,
    format_description::{self, BorrowedFormatItem, OwnedFormatItem},
};
use uuid::Uuid;

use crate::encoding::char_is_word;

pub fn init() {
    init_time_offset();
    init_time_formats();
    init_variable_automaton();
}

#[derive(Debug, Default)]
pub struct VariableInit {
    pub file_path: PathBuf,
    pub work_path: PathBuf,
    pub line_text: String,
    pub current_word: String,
    pub selected_text: String,
    pub line_pos: usize,
    pub cursor_pos: usize,
    pub clipboard: Option<String>,
}

/// 兼容 [vscode snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables)
#[derive(Debug, Clone)]
pub enum Variables {
    TmSelectedText,
    TmCurrentLine,
    TmCurrentWord,
    TmLineIndex,
    TmLineNumber,
    TmFilename,
    TmFilenameBase,
    TmDirectory,
    TmFilepath,
    RelativeFilepath,
    Clipboard,
    WorkspaceName,
    WorkspaceFolder,
    CursorIndex,
    CursorNumber,

    CurrentYear,
    CurrentYearShort,
    CurrentMonth,
    CurrentMonthName,
    CurrentMonthNameShort,
    CurrentDate,
    CurrentDayName,
    CurrentDayNameShort,
    CurrentHour,
    CurrentMinute,
    CurrentSecond,
    CurrentSecondsUnix,
    CurrentTimezoneOffset,

    // 时间
    Random,
    RandomHex,
    Uuid,

    // 注释
    BlockCommentStart,
    BlockCommentEnd,
    LineComment,
}

impl std::fmt::Display for Variables {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Variables::TmSelectedText => "TM_SELECTED_TEXT",
                Variables::TmCurrentLine => "TM_CURRENT_LINE",
                Variables::TmCurrentWord => "TM_CURRENT_WORD",
                Variables::TmLineIndex => "TM_LINE_INDEX",
                Variables::TmLineNumber => "TM_LINE_NUMBER",
                Variables::TmFilename => "TM_FILENAME",
                Variables::TmFilenameBase => "TM_FILENAME_BASE",
                Variables::TmDirectory => "TM_DIRECTORY",
                Variables::TmFilepath => "TM_FILEPATH",
                Variables::RelativeFilepath => "RELATIVE_FILEPATH",
                Variables::Clipboard => "CLIPBOARD",
                Variables::WorkspaceName => "WORKSPACE_NAME",
                Variables::WorkspaceFolder => "WORKSPACE_FOLDER",
                Variables::CursorIndex => "CURSOR_INDEX",
                Variables::CursorNumber => "CURSOR_NUMBER",

                Variables::CurrentYear => "CURRENT_YEAR",
                Variables::CurrentYearShort => "CURRENT_YEAR_SHORT",
                Variables::CurrentMonth => "CURRENT_MONTH",
                Variables::CurrentMonthName => "CURRENT_MONTH_NAME",
                Variables::CurrentMonthNameShort => "CURRENT_MONTH_NAME_SHORT",
                Variables::CurrentDate => "CURRENT_DATE",
                Variables::CurrentDayName => "CURRENT_DAY_NAME",
                Variables::CurrentDayNameShort => "CURRENT_DAY_NAME_SHORT",
                Variables::CurrentHour => "CURRENT_HOUR",
                Variables::CurrentMinute => "CURRENT_MINUTE",
                Variables::CurrentSecond => "CURRENT_SECOND",
                Variables::CurrentSecondsUnix => "CURRENT_SECONDS_UNIX",
                Variables::CurrentTimezoneOffset => "CURRENT_TIMEZONE_OFFSET",

                Variables::Random => "RANDOM",
                Variables::RandomHex => "RANDOM_HEX",
                Variables::Uuid => "UUID",

                Variables::BlockCommentStart => "BLOCK_COMMENT_START",
                Variables::BlockCommentEnd => "BLOCK_COMMENT_END",
                Variables::LineComment => "LINE_COMMENT",
            }
        )
    }
}

impl Variables {
    /// 获取所有支持的变量类型
    fn all() -> impl Iterator<Item = Self> {
        use Variables::*;
        [
            // 基础变量
            TmSelectedText,
            TmCurrentLine,
            TmCurrentWord,
            TmLineIndex,
            TmLineNumber,
            TmFilename,
            TmFilenameBase,
            TmDirectory,
            TmFilepath,
            RelativeFilepath,
            Clipboard,
            WorkspaceName,
            WorkspaceFolder,
            CursorIndex,
            CursorNumber,
            // 时间相关
            CurrentYear,
            CurrentYearShort,
            CurrentMonth,
            CurrentMonthName,
            CurrentMonthNameShort,
            CurrentDate,
            CurrentDayName,
            CurrentDayNameShort,
            CurrentHour,
            CurrentMinute,
            CurrentSecond,
            CurrentSecondsUnix,
            CurrentTimezoneOffset,
            // 随机值
            Random,
            RandomHex,
            Uuid,
            // 注释
            BlockCommentStart,
            BlockCommentEnd,
            LineComment,
        ]
        .into_iter()
    }

    /// 解析变量值
    pub(crate) fn resolve(&self, init: &VariableInit) -> String {
        match self {
            // 基础变量
            Self::TmSelectedText => init.selected_text.clone(),
            Self::TmCurrentLine => init.line_text.clone(),
            Self::TmCurrentWord => init.current_word.clone(),
            Self::TmLineIndex => init.line_pos.to_string(),
            Self::TmLineNumber => (init.line_pos + 1).to_string(),
            Self::TmFilename => file_name(&init.file_path),
            Self::TmFilenameBase => file_name_base(&init.file_path),
            Self::TmDirectory => file_directory(&init.file_path),
            Self::TmFilepath => path_to_str(&init.file_path),
            Self::RelativeFilepath => path_to_str(&init.file_path), // TODO: 实现相对路径
            Self::Clipboard => init.clipboard.clone().unwrap_or_default(),
            Self::WorkspaceName => file_name(&init.work_path),
            Self::WorkspaceFolder => path_to_str(&init.work_path),
            Self::CursorIndex => init.cursor_pos.to_string(),
            Self::CursorNumber => (init.cursor_pos + 1).to_string(),

            // 时间相关
            Self::CurrentYear => time_format(&self.to_string()),
            Self::CurrentYearShort => time_format(&self.to_string()),
            Self::CurrentMonth => time_format(&self.to_string()),
            Self::CurrentMonthName => time_format(&self.to_string()),
            Self::CurrentMonthNameShort => time_format(&self.to_string()),
            Self::CurrentDate => time_format(&self.to_string()),
            Self::CurrentDayName => time_format(&self.to_string()),
            Self::CurrentDayNameShort => time_format(&self.to_string()),
            Self::CurrentHour => time_format(&self.to_string()),
            Self::CurrentMinute => time_format(&self.to_string()),
            Self::CurrentSecond => time_format(&self.to_string()),
            Self::CurrentSecondsUnix => time_format(&self.to_string()),
            Self::CurrentTimezoneOffset => current_timezone_offset(),

            // 随机值
            Self::Random => random_base10(6),
            Self::RandomHex => random_hex(6),
            Self::Uuid => Uuid::new_v4().to_string(),

            // 注释(需要语言上下文)
            Self::BlockCommentStart => self.to_string(), // 示例值,需根据语言调整
            Self::BlockCommentEnd => self.to_string(),
            Self::LineComment => self.to_string(),
        }
    }

    /// 批量替换文本中的变量
    pub fn replace_all(text: &str, init: &VariableInit) -> String {
        let automaton = init_variable_automaton();
        let mut replacements = Vec::new();

        for mat in automaton.find_iter(text) {
            let var = match Self::from_pattern_id(mat.pattern()) {
                Some(v) => v,
                None => continue,
            };
            let replacement = var.resolve(init);
            replacements.push((mat.range(), replacement));
        }

        build_replaced_string(text, replacements)
    }

    /// 从模式ID解析变量类型
    fn from_pattern_id(id: PatternID) -> Option<Self> {
        let index = id.as_usize() / 2; // 每个变量有2个模式
        Self::all().nth(index)
    }
}

/// 构建替换后的字符串(无锁操作)
fn build_replaced_string(
    text: &str,
    replacements: Vec<(std::ops::Range<usize>, String)>,
) -> String {
    let mut result = String::with_capacity(text.len());
    let mut last_end = 0;

    for (range, replacement) in replacements {
        result.push_str(&text[last_end..range.start]);
        result.push_str(&replacement);
        last_end = range.end;
    }

    result.push_str(&text[last_end..]);
    result
}

/// 初始化时区偏移
fn init_time_offset() -> &'static UtcOffset {
    // 时区偏移缓存
    // time local offset not support multi-thread
    static TIME_OFFSET: OnceLock<UtcOffset> = OnceLock::new();

    TIME_OFFSET.get_or_init(|| {
        OffsetDateTime::now_local()
            .unwrap_or_else(|_| OffsetDateTime::now_utc())
            .offset()
    })
}

/// 初始化时间格式缓存
fn init_time_formats() -> &'static Mutex<HashMap<&'static str, Vec<OwnedFormatItem>>> {
    // 时间格式
    static TIME_FORMAT_CACHE: OnceLock<Mutex<HashMap<&'static str, Vec<OwnedFormatItem>>>> =
        OnceLock::new();
    TIME_FORMAT_CACHE.get_or_init(|| {
        let mut map = HashMap::new();
        let formats = [
            ("CURRENT_YEAR", "[year]"),
            ("CURRENT_YEAR_SHORT", "[year repr:last_two]"),
            ("CURRENT_MONTH", "[month]"),
            ("CURRENT_MONTH_NAME", "[month repr:long]"),
            ("CURRENT_MONTH_NAME_SHORT", "[month repr:short]"),
            ("CURRENT_DATE", "[day]"),
            ("CURRENT_DAY_NAME", "[weekday repr:long]"),
            ("CURRENT_DAY_NAME_SHORT", "[weekday repr:short]"),
            ("CURRENT_HOUR", "[hour repr:24]"),
            ("CURRENT_MINUTE", "[minute]"),
            ("CURRENT_SECOND", "[second]"),
            (
                "CURRENT_SECONDS_UNIX",
                "[unix_timestamp precision:nanosecond]",
            ),
        ];

        for (key, fmt) in formats {
            if let Ok(parsed) = format_description::parse(fmt) {
                // 转换为拥有所有权的格式项
                let v = convert_to_owned(parsed);
                map.insert(key, v);
            }
        }
        Mutex::new(map)
    })
}

/// 将 BorrowedFormatItem 转换为 OwnedFormatItem
fn convert_to_owned(items: Vec<BorrowedFormatItem>) -> Vec<OwnedFormatItem> {
    items.iter().map(|item| item.into()).collect()
}

/// 获取当前时间(带缓存时区)
fn current_time() -> OffsetDateTime {
    OffsetDateTime::now_utc().to_offset(*init_time_offset())
}

fn current_timezone_offset() -> String {
    current_time().offset().to_string()
}

fn time_format(fmt: &str) -> String {
    let cache = init_time_formats();
    let lock = cache.lock();

    if let Some(format) = lock.get(fmt) {
        // 使用 OwnedFormatItem 进行格式化
        current_time()
            .format(&format)
            .unwrap_or_else(|_| String::from(fmt))
    } else {
        fmt.to_owned()
    }
}

/// 初始化变量自动机
fn init_variable_automaton() -> &'static AhoCorasick {
    // 变量自动机缓存
    static VARIABLE_AUTOMATON: OnceLock<AhoCorasick> = OnceLock::new();

    VARIABLE_AUTOMATON.get_or_init(|| {
        let patterns: Vec<String> = Variables::all()
            .flat_map(|var| [format!("${var}"), format!("${{{var}}}")])
            .collect();

        AhoCorasick::builder()
            .ascii_case_insensitive(true)
            .match_kind(aho_corasick::MatchKind::LeftmostLongest)
            .build(patterns)
            .expect("Failed to build Aho-Corasick automaton")
    })
}

/// 生成指定位数的随机数
fn random_base10(len: usize) -> String {
    let mut rng = rand::rng();
    (0..len)
        .map(|_| rng.random_range(0..=9).to_string())
        .collect()
}

/// 生成指定位数的十六进制随机数
fn random_hex(len: usize) -> String {
    let mut rng = rand::rng();
    (0..len).fold(String::new(), |mut output, _buf| {
        write!(output, "{:x}", rng.random_range(0..16)).unwrap();
        output
    })
}

/// 安全获取路径文件名
fn file_name(path: &Path) -> String {
    path.file_name()
        .and_then(|n| n.to_str())
        .unwrap_or_default()
        .to_string()
}

/// 获取无扩展名的文件名
fn file_name_base(path: &Path) -> String {
    let name = file_name(path);
    name.chars()
        .take_while(|&c| char_is_word(c) && c != '.')
        .collect()
}

fn file_directory(path: &Path) -> String {
    path.parent()
        .and_then(|p| p.to_str())
        .unwrap_or("")
        .to_owned()
}

/// 路径转字符串
fn path_to_str(path: &Path) -> String {
    path.to_str().unwrap_or_default().to_string()
}

#[cfg(test)]
mod test {
    use copypasta::{ClipboardContext, ClipboardProvider};

    use super::init_variable_automaton;

    #[test]
    fn test_var() {
        init_variable_automaton();
    }

    #[test]
    fn test_clipboard() {
        // 如果未设置 DISPLAY 环境变量或在 CI 中,跳过测试
        if std::env::var("DISPLAY").is_err() || std::env::var("CI").is_ok() {
            println!("Skipping clipboard test in headless environment.");
            return;
        }
        let mut ctx = ClipboardContext::new().unwrap();
        let msg = "Hello!";
        ctx.set_contents(msg.to_owned()).unwrap();
        let content = ctx.get_contents().unwrap();
        assert_eq!(msg, content, "{msg},{content}");
    }
}