如何在AvaloniaEdit中实现自定义语法高亮？

1. 安装依赖包 #

先给项目装上AvaloniaEdit.TextMate包，用NuGet命令行或者包管理器操作都可以：

dotnet add package AvaloniaEdit.TextMate

2. 实现IRegistryOptions接口 #

这是对接自定义语法的核心环节，你需要写一个类实现这个接口，用来告诉TextMate该加载哪些语法文件和主题。示例代码如下：

using AvaloniaEdit.TextMate;
using TextMateSharp.Grammars;
using System.Collections.Generic;
using System.IO;
using System.Reflection;

public class CustomRegistryOptions : IRegistryOptions
{
    // 返回自定义语法定义
    public IEnumerable<GrammarDefinition> GetGrammarDefinitions()
    {
        // 假设你的语法文件是嵌入资源，路径为"YourNamespace.MyLang.tmLanguage"
        var assembly = Assembly.GetExecutingAssembly();
        using var stream = assembly.GetManifestResourceStream("YourNamespace.MyLang.tmLanguage");
        if (stream != null)
        {
            // "source.mylang"是语法文件里定义的scope name，必须和文件内一致
            yield return new GrammarDefinition("source.mylang", stream);
        }
    }

    // 返回主题（可使用内置主题，也可替换成自定义.tmTheme文件）
    public IEnumerable<ThemeDefinition> GetThemeDefinitions()
    {
        // 这里用内置的Dark+主题，替换成自己的主题流即可实现自定义主题
        yield return ThemeDefinition.LoadFromStream(
            Assembly.GetAssembly(typeof(RegistryOptions))!
                .GetManifestResourceStream("TextMateSharp.Themes.dark_plus.tmTheme")!
        );
    }

    // 元数据定义一般留空即可
    public IEnumerable<MetadataDefinition> GetMetadataDefinitions()
    {
        yield break;
    }
}

注意：把YourNamespace.MyLang.tmLanguage替换成你实际的嵌入资源路径，语法文件的scope name必须和文件内部定义的完全匹配。

3. 绑定TextMate与AvaloniaEdit控件 #

在界面的后台代码（比如MainWindow.axaml.cs）里，找到你的TextEditor实例，完成绑定操作：

using AvaloniaEdit.TextMate;

public MainWindow()
{
    InitializeComponent();
    // 假设你的TextEditor控件名为"editor"
    var textMateEditor = new TextMateEditor(editor, new CustomRegistryOptions());
    // 设置要启用的语法，这里的scope name要和GetGrammarDefinitions里的一致
    textMateEditor.SetGrammar("source.mylang");
}

关键注意事项 #

• 语法文件必须符合TextMate规范，支持.tmLanguage（XML格式）或.tmLanguage.json格式。
• 如果语法文件是本地文件而非嵌入资源，直接用File.OpenRead()替换资源流即可。
• 主题文件同样可以用自定义的.tmTheme文件，替换GetThemeDefinitions里的流就能生效。

内容的提问来源于stack exchange，提问作者Nortia