高亮多语言

Source: Dev.to

在此帖中解释的更改可以在 Kilo-go GitHub 仓库的 multilingual 分支中找到。

重构：将语法结构体移到独立的包

EditorSyntax 结构体被提取到独立的包中，以便编辑器可以使用其中定义的方法。

syntax/syntax.go

package syntax

import "github.com/alcb1310/kilo-go/utils"

var GO_HL_EXTENSIONS = []string{".go"}
var GO_HL_KEYWORDS = []string{
	"package", "import", "func", "type", "var", "const", "if", "else",
	"switch", "case", "default", "for", "range", "goto", "continue",
	"select", "return", "break",
}
var GO_HL_TYPES = []string{
	"bool", "byte", "error", "float32", "float64", "int", "int16", "int32",
	"int64", "int8", "rune", "string", "uint", "uint16", "uint32", "uint64", "uint8",
}

var GO_SYNTAX = EditorSyntax{
	Filetype:              "go",
	Filematch:             GO_HL_EXTENSIONS,
	Flags:                 utils.HL_HIGHLIGHT_NUMBER | utils.HL_HIGHLIGHT_STRING,
	SingleLineComment:     "//",
	MultiLineCommentStart: "/*",
	MultiLineCommentEnd:   "*/",
	Keywords:              GO_HL_KEYWORDS,
	Types:                 GO_HL_TYPES,
}

type EditorSyntax struct {
	Filetype              string
	Filematch             []string
	Flags                 uint
	SingleLineComment     string
	MultiLineCommentStart string
	MultiLineCommentEnd   string
	Keywords              []string
	Types                 []string
}

// HLDB holds all supported syntaxes.
var HLDB = []EditorSyntax{
	GO_SYNTAX,
	// C_SYNTAX will be added later.
}

编辑器中的更新引用

editor/editor.go

type EditorConfig struct {
	// …
	syntax *syntax.EditorSyntax
}

editor/output.go

func (e *EditorConfig) editorDrawStatusBar(abuf *ab.AppendBuffer) {
	// …
	if e.syntax != nil {
		filetype = "[" + e.syntax.Filetype + "]"
	}
	// …
}

editor/syntax.go

func (e *EditorConfig) editorUpdateSyntax(row *EditorRow) {
	// …
	scs := e.syntax.SingleLineComment
	mcs := e.syntax.MultiLineCommentStart
	mce := e.syntax.MultiLineCommentEnd
	keywords := e.syntax.Keywords
	types := e.syntax.Types
	// …
	if e.syntax.Flags&utils.HL_HIGHLIGHT_STRING == 2 {
		// handle strings
	}
	if e.syntax.Flags&utils.HL_HIGHLIGHT_NUMBER == 1 {
		// handle numbers
	}
	// …
}

添加 C/C++ 支持

通过定义一个新的 EditorSyntax 值来添加对 C/C++ 的支持。

syntax/go.go（保持不变）

package syntax

import "github.com/alcb1310/kilo-go/utils"

var GO_HL_EXTENSIONS = []string{".go"}
var GO_HL_KEYWORDS = []string{
	"package", "import", "func", "type", "var", "const", "if", "else",
	"switch", "case", "default", "for", "range", "goto", "continue",
	"select", "return", "break",
}
var GO_HL_TYPES = []string{
	"bool", "byte", "error", "float32", "float64", "int", "int16", "int32",
	"int64", "int8", "rune", "string", "uint", "uint16", "uint32", "uint64", "uint8",
}

var GO_SYNTAX = EditorSyntax{
	Filetype:              "go",
	Filematch:             GO_HL_EXTENSIONS,
	Flags:                 utils.HL_HIGHLIGHT_NUMBER | utils.HL_HIGHLIGHT_STRING,
	SingleLineComment:     "//",
	MultiLineCommentStart: "/*",
	MultiLineCommentEnd:   "*/",
	Keywords:              GO_HL_KEYWORDS,
	Types:                 GO_HL_TYPES,
}

syntax/c.go

package syntax

import "github.com/alcb1310/kilo-go/utils"

var C_HL_EXTENSIONS = []string{".c", ".h", ".cpp"}

var C_SYNTAX = EditorSyntax{
	Filetype:              "c",
	Filematch:             C_HL_EXTENSIONS,
	Flags:                 utils.HL_HIGHLIGHT_NUMBER | utils.HL_HIGHLIGHT_STRING,
	SingleLineComment:     "//",
	MultiLineCommentStart: "/*",
	MultiLineCommentEnd:   "*/",
	Keywords: []string{
		"switch", "if", "while", "for", "break", "continue", "return", "else",
		"struct", "union", "typedef", "static", "enum", "class", "case",
		"#include", "#define", "#ifndef", "#ifdef", "#endif", "#else",
	},
	Types: []string{
		"int", "long", "double", "float", "char", "unsigned", "signed", "void",
	},
}

更新 HLDB 以包含 C 语法

var HLDB = []EditorSyntax{
	GO_SYNTAX,
	C_SYNTAX,
}

语法选择的 Bug 修复

语法选择例程现在会遍历每种语言的所有文件匹配模式。

func (e *EditorConfig) editorSelectSyntaxHighlight() {
	// …
	for _, s := range syntax.HLDB {
		for j := range s.Filematch {
			isExt := s.Filematch[j][0] == '.'
			if (isExt && ext == s.Filematch[j]) ||
				(!isExt && strings.Contains(ext, s.Filematch[j])) {
				e.syntax = &s

				for _, row := range e.rows {
					e.editorUpdateSyntax(&row)
				}
				return
			}
		}
	}
}

在不修改编辑器的情况下实现多语言支持

无需为每种新语言重新编译二进制文件，语法定义可以放在用户的配置目录（${XDG_CONFIG}/kilo/highlight/）下，采用 TOML 文件形式。编辑器在启动时加载这些文件。

${XDG_CONFIG}/kilo/highlight/go.toml

number = true
string = true
filetype = "GO"
extensions = [".go"]
keywords = [
    "package", "import", "func", "type", "var", "const", "if", "else",
    "switch", "case", "default", "for", "range", "goto", "continue",
    "select", "return", "break",
]
types = [
    "bool", "byte", "error", "float32", "float64", "int", "int16", "int32",
    "nil", "int64", "int8", "rune", "string", "uint", "uint16", "uint32",
    "uint64", "uint8",
]
slc = "//"
mlcs = "/*"
mlce = "*/"

${XDG_CONFIG}/kilo/highlight/c.toml

number = true
string = true
filetype = "C/CPP"
extensions = [".c", ".h", ".cpp"]
keywords = [
    "switch", "if", "while", "for", "break", "continue", "return", "else",
    "struct", "union", "typedef", "static", "enum", "class", "case",
    "#include", "#define", "#ifndef", "#ifdef", "#endif", "#else"
]
types = ["int", "long", "double", "float", "char", "unsigned", "signed", "void", "NULL"]
slc = "//"
mlcs = "/*"
mlce = "*/"

加载语法定义

func init() {
	// …
	syntax.LoadSyntax() // reads all *.toml files from ${XDG_CONFIG}/kilo/highlight/
}

通过这种方式，添加新语言只需将符合格式的 TOML 文件放入 highlight 目录——无需对编辑器源码进行任何更改。