为Emacs增加新语言支持

1. 入门
2. 完全的语法高亮
3. 缩进
4. 实时检查
5. 补全
6. Eldoc
7. 整合REPL
8. Polish

能否编写一个major mode是是否能称为elisp hacker的分水岭. 你早晚都会遇到一种编程语言或者一种配置格式是Emacs尚不支持的. 原因可能是它们是才出现不久,也可能是因为它们太小众了.

最终,你会决定卷起袖子开始填坑. 那么你该如何编写一个major mode呢? 怎样才算是一个好的major mode呢?

1 入门

创建一个最少功能的major mode,你只需要设置syntax table即可. 只要你的mode能高亮出注释和字符串,那就是有用的

下面是一个最简化的JS mode:

(defconst my-js-mode-syntax-table
  (let ((table (make-syntax-table)))
    ;; ' is a string delimiter
    (modify-syntax-entry ?' "\"" table)
    ;; " is a string delimiter too
    (modify-syntax-entry ?\" "\"" table)

    ;; / is punctuation, but // is a comment starter
    (modify-syntax-entry ?/ ". 12" table)
    ;; \n is a comment ender
    (modify-syntax-entry ?\n ">" table)
    table))

(define-derived-mode my-js-mode prog-mode "Simple JS Mode"
  :syntax-table my-js-mode-syntax-table
  (font-lock-fontify-buffer))

Here’s the result:

看起来并没有作什么工作,但对于配置文件来说,一般够用了.

恭喜你, 你现在已经是一名elisp hacker了! 将你的major mode发布到MELPA上吧,这样大家可以使用并贡献給你的新mode.

2 完全的语法高亮

从这里开始,存在一个很大的扩展空间了. 你需要看一下 sophisticated syntax highlighting ,这篇文章囊括了一门语言的所有语法说明.

随着你的major mode变得越来越复杂, 你应该开始考虑如何对它进行测试了. 虽说许多major mode确实都没有测试,但是像你这么一位自重的hacker是很乐意看到bug被修复的(but a self-respecting hacker like you likes bugs to stay fixed).

第一步是创建一个包含各种特殊语法情况的案例文件然后打开它. 这种方式很繁杂,最终你会想用程序来进行测试. puppet-mode就是一个很好的例子.

3 缩进

下一步该处理缩进的问题了. 用于希望Emacs在任何状态下都能正确地缩进代码. 你需要检查光标附近的语法然后计算出当前的嵌套层级.

为了计算当前的嵌套层级,你往往需要从光标当前位置向后搜索整个buffer,并计算出现 { (或其他等价的作用域分隔符)的次数. 然后再根据嵌套层级调整当前行的缩进位置(一般是将嵌套层级乘于 my-mode-tab-width). 若你仔细的处理了字符串和注释中的 { ,这种方式往往能行.

还有一种方法, Emacs提供了Simple Minded Indentation Engine (SMIE). 你只需要写好BNF语法,然后你就能生成基础的缩进与移动命令了.

You could be a total lunatic, and Emacs has to make you happy.

– Steve Yegge on indentation

在实际中,对什么才是正确的缩进是有争议的,因此为了适应不同的缩进风格,你可以需要提供一些配置项供用户自己调整. 若一切正常的话,你应该能做: 到从一个现存的项目中打开一个大文件,然后运行 (indent-region (point-min) (point-max)), 结果缩进并不会有什么改变.

缩进的逻辑测试起来很简单,你可以参见julia-mode 中的例子. 你还需要测试在大文件中缩进是否足够快速,因为一不小心就可能应用了缓慢的算法.