Elisp 03：变量

Posted 2021-09-15 garfileo

前言：不知多久能学会 Elisp

上一章：文本解析

上一章实现的解析器程序——当然仅仅是玩具，有几处颇为丑陋，还有一处存在着安全问题。

全局变量

安全第一。先从安全问题开始。观察以下代码：

(defun text-match (src dest)
  (setq n (length dest))
  (if (< (length src) n)
      nil
    (string= (substring src 0 n) dest)))

上述代码定义的这个函数可判断字符串对对象 src 的内容是否以字符串对象 dest 的内容作为开头，例如

(princ\\\' (text-match "I have a dream!" "I have"))

输出 t。这不是问题。问题在于倘若紧接着执行

(princ\\\' n)

输出 6。

问题是什么呢？在 text-match 这个函数定义的外部，能够访问在函数的定义内部的一个变量，宛若他人的手指可以触及我的内脏……这是不是一个安全问题？

这种匪夷所思的现象之所以出现，是因为 setq 定义的变量是全局变量。在一个程序里，倘若有一个全局变量，那么在这个程序的任何一个角落皆能访问和修改这个变量。

全局变量不可以没有，但不可滥用。对于 text-match 这样的函数，在其定义里使用全局变量，属于滥用。

局部变量

回忆一下 simple-md-parser.el 里的代码里 every-line 函数的定义：

(defun every-line (result in-code-block)
  (if (= (point) (point-max))
      result
    (progn
      (if (text-match (current) "```")
          (progn
            (if in-code-block
                (progn
                  (setq result (cons \'代码块结束 result))
                  (setq in-code-block nil))
              (progn
                (setq result (cons \'代码块开始 result))
                (setq in-code-block t))))
        (progn
          (if in-code-block
              (setq result (cons \'代码块 result))
            (setq result (cons \'未知 result)))))
      (forward-line 1)
      (every-line result in-code-blcok))))

在这个函数里，我在多处用 setq 反复定义了两个变量 result 和 in-code-block，但是倘若调用这个函数之后再执行以下程序

(princ\\\' result)
(princ\\\' in-code-block)

Elisp 解释器在对 (princ\\\' result) 进行求值时会出错，它会抱怨：

Symbol’s value as variable is void: result

意思是，result 这个变量未被定义。为什么会这样呢？

原因是它们也都是函数的参数，在函数定义的内部可以访问和修改它们，而在函数定义的外部却不能。因此，函数的参数是局部变量。

Elisp 语言以及其他 Lisp 方言，正是基于函数的参数构造了局部变量，并且为了简化构造过程，提供了 let 表达式。

let 表达式可以初始化局部变量，并将限定其生存范围。例如

(let ((a 1)
      (b "Hello")
      (c \'世界))
  (princ\\\' a)
  (princ\\\' b)
  (princ\\\' c))

可定义三个局部变量 a，b 和 c，它们仅在 let 表达式内部有效——可以使用，也可以修改。

使用 let 表达式，可以让不安全的 text-match 函数规矩一些：

(defun text-match (src dest)
  (let ((n (length dest)))
    (if (< (length src) n)
        nil
      (string= (substring src 0 n) dest))))

现在，倘若再执行

(princ\\\' (text-match "I have a dream!" "I have"))
(princ\\\' n)

Elisp 解释器在对 (princ\\\' n) 求值时会抱怨变量 n 未定义，然后终止。

在 let 表达式里，也可以不对局部变量进行初始化。例如

(let (a b c)
  (princ\\\' a)
  (princ\\\' b)
  (princ\\\' c))

结果输出：

nil
nil
nil

未进行初始化的局部变量，Elisp 解释器会认为它们的值是 nil。

美颜

局部变量不仅能让函数更为安全，甚至对函数的定义和调用也能产生一些美容效果。

simple-md-parser.el 里定义的 every-line 函数，其调用形式是

(every-line \'() nil)

需要给它两个初始的参数值，它方能得以运行。虽然它能正确地解决问题，但是却不美观，犹如一件电器，它能正常工作，只是有两个线头露在了外面。基于 let 表达式，在函数的定义可以去掉这两个参数。例如：

(let ((result \'())
      (in-code-block nil))
  (defun every-line ()
    (if (= (point) (point-max))
        result
      (progn
        (if (text-match (current) "```")
            (progn
              (if in-code-block
                  (progn
                    (setq result (cons \'代码块结束 result))
                    (setq in-code-block nil))
                (progn
                  (setq result (cons \'代码块开始 result))
                  (setq in-code-block t))))
          (progn
            (if in-code-block
                (setq result (cons \'代码块 result))
              (setq result (cons \'未知 result)))))
        (forward-line 1)
        (every-line))))
  (every-line))

上述代码由于略微复杂，导致程序结构不够清晰，倘若隐去一些代码，便清楚得多。例如

(let ((result \'())
      (in-code-block nil))
  (defun every-line ()
    ... 省略的代码 ...)
  (every-line))

所表达的主要含义是：在 let 表达式里定义了函数 every-line，然后调用该函数。注意观察，此时，该函数是没有任何参数。

不过，将函数的定义放到 let 表达式内，这个函数会被 Elisp 就地求值了。倘若依然希望它保持函数的尊严，而不是每次使用它都要背负一个冗长的 let 表达式，只需将整个 let 表达式封装为一个函数即可。例如

(defun every-line\\\' ()
  (let ((result \'())
        (in-code-block nil))
    (defun every-line ()
      ... 省略的代码 ...)
    (every-line)))

上述代码不仅彰显了可以在 let 表达式里定义一个函数，也彰显了可以在一个函数的定义里定义一个函数。不过，我认为内外两个函数的名字最好换一下，即

(defun every-line ()
  (let ((result \'())
        (in-code-block nil))
    (defun every-line\\\' ()
      ... 省略的代码 ...)
    (every-line\\\')))

现在，我觉得美观多了。因为 simple-md-parser.el 的最后两行代码，现在可以写成

(find-file "foo.md")
(princ\\\' (every-line))

对于上一章实现的列表反转函数也可以采用类似的办法予以美化。例如

(defun reverse-list (x)
  (let ((y \'()))
    (defun reverse-list\\\' ()
      (if (null x)
          y
        (progn
          (setq y (cons (car x) y))
          (reverse-list\\\' (cdr x)))))
    (reverse-list\\\')))

如此，之前的代码

(setq x \'(5 4 3 2 1))
(princ\\\' (reverse-list x \'()))

现在可写成

(setq x \'(5 4 3 2 1))
(princ\\\' (reverse-list x))

结语

局部变量可让程序更安全，也更优雅。

下一章：迭代