emacs - 如何在 emacs lua 模式下配置缩进？

Question

这里是完整的 emacs 新手。

我在 Ubuntu 上使用 emacs 23.1.1 emacs starter kit 。我主要在 lua 模式下工作(使用 package-install lua-mode 安装)。

我需要调整缩进的工作方式，以便它符合我的编码指南。

指导方针是:

• 制表符到空格；
• 每个缩进两个空格；
• 每行最多 80 个字符，无尾随空格。

示例:

local foo = function()  print("Hello, world!")end

如果我不尝试使用 emacs 的自动缩进，我会得到什么:

local foo = function()               print("Hello, world")end

更新:

(这属于评论，但由于它需要额外的格式，所以我必须将其放在这里。)

如果我尝试托马斯的解决方案，我会得到这个:

local foo = function()               print("Hello, world")        end

请注意，end 缩进了一个制表符 和四个空格。不太有效...

更新2:

这件事也以错误的方式缩进:

local bar = foo(    "one",    "two",   baz(), -- Note three spaces   "quo")  

应该是:

local bar = foo(    "one",    "two",    baz(),    "quo"  )

更新3:

第三种错误缩进的情况:

local bar = foo(    "one",    "two"  )  local t = 5 -- This line should not be indented,               -- also note tab between local and t.

更新4:

这是我从 Thomas 那里得到的当前版本:

local foo = function()               print("Hello, world")        end            local bar = 5 -- Emacs put \t before 5            local zzz = foo( -- Emacs put \t before foo                "one", -- Pressed TAB here twice                "two",               three(),               "four"            )

除非明确指出，否则我没有对缩进进行任何操作，只是输入代码并在每行末尾按 RETURN 。我实际上没有输入任何评论。

它应该如下所示:

local foo = function()  print("Hello, world")endlocal bar = 5local zzz = foo(    "one",    "two",    three(),    "four"  )

更新5:

再一个错误的缩进案例:

local foo ={bar(); -- Did press a TAB here, but closing brace killed itbaz;}

应该是:

local foo ={  bar();  baz;}

更新6:

为了完整起见，以下是我通过 current Git HEAD of lua-mode 得到的结果，没有 Thomas 的配置调整:

local foo = function()               print("Hello, world!")            endlocal bar = 5local foo = bar(bar,   baz(),   quo(),aaa)local t ={"one",two(),}

调整后:

local foo = function()           print("Hello, world!")            end            local bar = 5            local foo = bar(            bar,               baz(),               quo(),               aaa            )            local t =            {            "one",            two(),         }

为了符合我的编码指南，它应该如下所示:

local foo = function()  print("Hello, world!")endlocal bar = 5local foo = bar(    bar,    baz(),    quo(),    aaa  )local t ={  "one",  two(),}

Answer 1

好吧，让我们再试一次...在浏览了 lua-mode 的源代码后，我想出了以下方法。

确实奇怪的默认缩进的原因是一个名为“lua-calculate-indentation”的函数，它计算当前行缩进的列。不幸的是，它返回的值与您想要的规范不匹配。

例如，如果您在新的 .lua 文件中输入一行，如下所示:

local foo = function()

然后按 Enter 将点移动到第二行，您可以通过输入 M-: (lua-calculate-indentation) 来调用上述函数。结果是 15，这意味着 lua-mode 会将第二个缩进到第 15 列。这就是您在原始问题中描述和举例说明的非正统缩进的原因。

现在，为了解决这个问题，我建议重新定义函数“lua-calculate-indentation”，以便它返回您想要的缩进。为此，请将以下代码放入一个空文件中，并将其以“my-lua.el”名称保存在“lua-mode.el”所在的同一目录中。

;; use an indentation width of two spaces
(setq lua-indent-level 2)

;; Add dangling '(', remove '='
(setq lua-cont-eol-regexp
      (eval-when-compile
        (concat
         "\\((\\|\\_<"
         (regexp-opt '("and" "or" "not" "in" "for" "while"
                       "local" "function") t)
         "\\_>\\|"
         "\\(^\\|[^" lua-operator-class "]\\)"
         (regexp-opt '("+" "-" "*" "/" "^" ".." "==" "<" ">" "<=" ">=" "~=") t)
         "\\)"
         "\\s *\\=")))

(defun lua-calculate-indentation (&optional parse-start)
  "Overwrites the default lua-mode function that calculates the
column to which the current line should be indented to."
  (save-excursion
    (when parse-start
      (goto-char parse-start))

    ;; We calculate the indentation column depending on the previous
    ;; non-blank, non-comment code line. Also, when the current line
    ;; is a continuation of that previous line, we add one additional
    ;; unit of indentation.
    (+ (if (lua-is-continuing-statement-p) lua-indent-level 0)
       (if (lua-goto-nonblank-previous-line)
           (+ (current-indentation) (lua-calculate-indentation-right-shift-next))
         0))))

(defun lua-calculate-indentation-right-shift-next (&optional parse-start)
  "Assuming that the next code line is not a block ending line,
this function returns the column offset that line should be
indented to with respect to the current line."
  (let ((eol)
        (token)
        (token-info)
        (shift 0))
    (save-excursion
      (when parse-start
        (goto-char parse-start))

      ; count the balance of block-opening and block-closing tokens
      ; from the beginning to the end of this line.
      (setq eol (line-end-position))
      (beginning-of-line)
      (while (and (lua-find-regexp 'forward lua-indentation-modifier-regexp)
                  (<= (point) eol)
                  (setq token (match-string 0))
                  (setq token-info (assoc token lua-block-token-alist)))
        ; we found a token. Now, is it an opening or closing token?
        (if (eq (nth 2 token-info) 'open)
            (setq shift (+ shift lua-indent-level))
          (when (or (> shift 0)
                    (string= token ")"))
            (setq shift (- shift lua-indent-level))))))
    shift))

此代码将缩进级别设置为两个空格(而不是 3 个)，修改用于检测语句是否跨多行的正则表达式，最后使用辅助函数重新定义缩进函数。

剩下要做的就是确保该代码确实已加载。这必须在加载原始 lua 模式之后发生，否则该代码将重新安装原始缩进功能。

我们这样做的方式有点hacky:我们安装了一个回调函数，每次缓冲区将其主模式更改为lua模式时都会调用该函数。然后它检查是否定义了前面提到的辅助函数 - 如果没有，它加载“my-lua.el”。这有点脆弱，但只要你不摆弄 lua 源代码，就应该没问题。

将以下行添加到您的 ~/emacs.d/agladysh.el 文件中(假设“agladysh”是您的用户名):

(add-hook 'lua-mode-hook 
          (lambda () (unless (fboundp 'lua-calculate-indentation-right-shift-next)
                       (load-file (locate-file "my-lua.el" load-path)))))

我假设 lua-mode 位于您的加载路径上，如果您遵循 lua-mode 的安装说明，它应该位于您的加载路径上。

希望这次对您有用，如果不行，请告诉我。