Repository navigation
Expand file tree
/
Copy pathKeybindingLoader.cs
More file actions
310 lines (260 loc) · 9.58 KB
/
Copy pathKeybindingLoader.cs
File metadata and controls
310 lines (260 loc) · 9.58 KB
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
using OneCode.Core.Product;
using OneCode.Core.Keybindings;
namespace OneCode.Infrastructure.Keybindings;
/// <summary>
/// keybindings.json 文件的顶层 JSON 结构。
/// </summary>
internal sealed class KeybindingsConfig
{
[JsonPropertyName("$schema")]
public string? Schema { get; set; }
[JsonPropertyName("bindings")]
public List<KeybindingBlockJson>? Bindings { get; set; }
}
/// <summary>
/// JSON 中的绑定块结构。
/// </summary>
internal sealed class KeybindingBlockJson
{
[JsonPropertyName("context")]
public string Context { get; set; } = string.Empty;
[JsonPropertyName("bindings")]
public Dictionary<string, string?> Bindings { get; set; } = [];
}
/// <summary>
/// 用户配置加载器,从 ~/.onecode/keybindings.json 加载并合并默认绑定。
/// 支持热重载(FileSystemWatcher)。
/// </summary>
public sealed class KeybindingLoader : IDisposable
{
private const int FileStabilityThresholdMs = 500;
private readonly ILogger _logger;
private readonly string _keybindingsPath;
private FileSystemWatcher? _watcher;
private KeybindingEntry[]? _cachedBindings;
private KeybindingWarning[] _cachedWarnings = [];
private DateTime _lastReloadTime;
private readonly object _lock = new();
/// <summary>
/// 绑定变更事件,当文件变化重新加载后触发。
/// </summary>
public event Action<KeybindingsLoadResult>? BindingsChanged;
public KeybindingLoader(ILogger<KeybindingLoader> logger)
{
_logger = logger;
var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
_keybindingsPath = Path.Combine(home, ProductInfo.Default.ConfigDirName, "keybindings.json");
}
public string KeybindingsPath => _keybindingsPath;
public KeybindingEntry[]? CachedBindings => _cachedBindings;
/// <summary>
/// 获取缓存的验证警告。
/// </summary>
public KeybindingWarning[] CachedWarnings => _cachedWarnings;
/// <summary>
/// 异步加载键绑定配置,合并默认和用户绑定。
/// </summary>
public async Task<KeybindingsLoadResult> LoadAsync(CancellationToken ct = default)
{
var defaultBindings = KeybindingDefaults.GetDefaultParsedBindings();
if (!File.Exists(_keybindingsPath))
{
return new KeybindingsLoadResult([.. defaultBindings], []);
}
try
{
var content = await File.ReadAllTextAsync(_keybindingsPath, ct).ConfigureAwait(false);
var result = ParseAndMerge(content, defaultBindings);
lock (_lock)
{
_cachedBindings = result.Bindings;
_cachedWarnings = result.Warnings;
}
return result;
}
catch (Exception ex) when (ex is not OperationCanceledException)
{
_logger.LogWarning(ex, "Error loading keybindings from {Path}", _keybindingsPath);
return new KeybindingsLoadResult(
[.. defaultBindings],
[new KeybindingWarning(
KeybindingWarningType.ParseError,
KeybindingSeverity.Error,
$"Failed to parse keybindings.json: {ex.Message}")]);
}
}
/// <summary>
/// 同步加载键绑定配置(用于初始化渲染)。
/// 使用缓存值(如果可用)。
/// </summary>
public KeybindingsLoadResult LoadSync()
{
lock (_lock)
{
if (_cachedBindings is not null)
{
return new KeybindingsLoadResult(_cachedBindings, _cachedWarnings);
}
}
var defaultBindings = KeybindingDefaults.GetDefaultParsedBindings();
if (!File.Exists(_keybindingsPath))
{
var emptyResult = new KeybindingsLoadResult([.. defaultBindings], []);
lock (_lock)
{
_cachedBindings = emptyResult.Bindings;
_cachedWarnings = emptyResult.Warnings;
}
return emptyResult;
}
try
{
var content = File.ReadAllText(_keybindingsPath);
var result = ParseAndMerge(content, defaultBindings);
lock (_lock)
{
_cachedBindings = result.Bindings;
_cachedWarnings = result.Warnings;
}
return result;
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Error loading keybindings from {Path}", _keybindingsPath);
var errorResult = new KeybindingsLoadResult(
[.. defaultBindings],
[new KeybindingWarning(
KeybindingWarningType.ParseError,
KeybindingSeverity.Error,
$"Failed to parse keybindings.json: {ex.Message}")]);
lock (_lock)
{
_cachedBindings = errorResult.Bindings;
_cachedWarnings = errorResult.Warnings;
}
return errorResult;
}
}
/// <summary>
/// 初始化文件监视器以支持热重载。
/// </summary>
public void InitializeWatcher()
{
var watchDir = Path.GetDirectoryName(_keybindingsPath);
if (string.IsNullOrEmpty(watchDir) || !Directory.Exists(watchDir))
{
_logger.LogDebug("Not watching: {Dir} does not exist", watchDir);
return;
}
try
{
_watcher = new FileSystemWatcher(watchDir, Path.GetFileName(_keybindingsPath))
{
NotifyFilter = NotifyFilters.LastWrite | NotifyFilters.Size | NotifyFilters.FileName,
EnableRaisingEvents = true,
};
_watcher.Changed += OnFileChanged;
_watcher.Created += OnFileChanged;
_watcher.Deleted += OnFileDeleted;
_watcher.Renamed += OnFileDeleted;
_logger.LogDebug("Watching for changes to {Path}", _keybindingsPath);
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Failed to initialize file watcher for {Path}", _keybindingsPath);
}
}
/// <summary>
/// 重置内部状态(用于测试)。
/// </summary>
public void Reset()
{
lock (_lock)
{
_cachedBindings = null;
_cachedWarnings = [];
}
}
public void Dispose()
{
if (_watcher is not null)
{
_watcher.Changed -= OnFileChanged;
_watcher.Created -= OnFileChanged;
_watcher.Deleted -= OnFileDeleted;
_watcher.Renamed -= OnFileDeleted;
_watcher.Dispose();
_watcher = null;
}
}
private void OnFileChanged(object sender, FileSystemEventArgs e)
{
// 稳定阈值:等待文件写入完成
var elapsed = (DateTime.UtcNow - _lastReloadTime).TotalMilliseconds;
if (elapsed < FileStabilityThresholdMs)
{
return;
}
_lastReloadTime = DateTime.UtcNow;
_logger.LogDebug("Detected change to {Path}", e.FullPath);
try
{
var result = LoadSync();
BindingsChanged?.Invoke(result);
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Error reloading keybindings");
}
}
private void OnFileDeleted(object sender, FileSystemEventArgs e)
{
_logger.LogDebug("Detected deletion of {Path}", e.FullPath);
var defaultBindings = KeybindingDefaults.GetDefaultParsedBindings();
var result = new KeybindingsLoadResult([.. defaultBindings], []);
lock (_lock)
{
_cachedBindings = result.Bindings;
_cachedWarnings = [];
}
BindingsChanged?.Invoke(result);
}
private KeybindingsLoadResult ParseAndMerge(string content, List<KeybindingEntry> defaultBindings)
{
var config = JsonSerializer.Deserialize<KeybindingsConfig>(content);
if (config?.Bindings is null || config.Bindings.Count == 0)
{
return new KeybindingsLoadResult(
[.. defaultBindings],
[new KeybindingWarning(
KeybindingWarningType.ParseError,
KeybindingSeverity.Error,
"keybindings.json must have a \"bindings\" array",
Suggestion: "Use format: { \"bindings\": [ ... ] }")]);
}
var userBlocks = new List<KeybindingBlock>();
foreach (var block in config.Bindings)
{
if (string.IsNullOrEmpty(block.Context))
{
continue;
}
userBlocks.Add(new KeybindingBlock(block.Context, block.Bindings));
}
var userParsed = KeybindingParser.ParseBindings(userBlocks);
_logger.LogDebug("Loaded {Count} user bindings from {Path}", userParsed.Count, _keybindingsPath);
// 用户绑定追加在默认之后,后匹配的生效
var mergedBindings = new List<KeybindingEntry>(defaultBindings);
mergedBindings.AddRange(userParsed);
var duplicateKeyWarnings = KeybindingValidator.CheckDuplicateKeysInJson(content);
var validationWarnings = KeybindingValidator.ValidateBindings(userBlocks);
var allWarnings = new List<KeybindingWarning>();
allWarnings.AddRange(duplicateKeyWarnings);
allWarnings.AddRange(validationWarnings);
if (allWarnings.Count > 0)
{
_logger.LogDebug("Found {Count} validation issue(s)", allWarnings.Count);
}
return new KeybindingsLoadResult([.. mergedBindings], [.. allWarnings]);
}
}