《elisp 每日一练》——文本属性

在前面的例子中，我们已经见识过文本属性。我们通过将buffer、file-name、line-number 等信息作为属性附加到字符串上，在用户选择了这个字符串执行跳转时又读取它的属性，找到之前保存的信息，从而完成了跳转。

背景知识

从上面的例子中我们知道，属性实际上是一个标签，也可以是一个信息存储的媒介。既可以存储官方支持的属性，也可以存储自定义的属性。

我们可以通过 add-text-properties 来添加一个属性。它的定义如下:

(add-text-properties START END PROPERTIES &optional OBJECT)

各个参数的含义如下:

• START和 END ：表示一个范围，给这个范围内的字符串添加属性
• PROPERTIES: 是一个表示各种属性的列表
• OBJECT: 是一个buffer，表示往哪个buffer中的字符串添加属性，默认不填的话表示当前buffer

PROPERTIES 是一个属性列表，它的形式为 (prop1 value1 prop2 value2 ...) 。

在Emacs中，可以通过设置buffer中字符串的相关属性实现例如文本高亮、交互效果等操作。这些都可以通过设置官方提供的属性来支持。官方提供的常用效果有：

1. 文本显示效果的有：

2. 交互与提示的属性有:

3. 显示控制的属性

4. 编译与移动控制的属性

5. 其他常用属性

add-text-properties 可以一次性设置多个属性，而且前面设置的属性，后面可以通过该函数修改。如果调用该函数发生了属性修改，则函数返回 t 否则返回 nil

除了该函数，关于属性设置的函数还有:

• put-text-property 只设置一个属性
• remove-text-properties 删除指定属性
• set-text-properties 完全替换整段文本的所有属性，如果为 nil 则表示清空所有属性
• add-face-text-property 专门用来添加 face 属性

另外我们可以通过 get-text-property 来获取属性值。

练习

不知道各位读者是否还记得，关于buffer的综合练习中的 App-Log 的内容。今天的练习我尝试对log函数进行一些改进，根据log等级来用不同的颜色显示，我这里规定：红色表示error、黄色表示warning、绿色表示debug、灰色表示info。

(defun my/log(level message)
  (let* ((level-sym (if (stringp level) (intern (upcase level)) level))
     (src-buf (current-buffer))
     (file-or-buf (or (buffer-file-name) (buffer-name)))
     (line-num (line-number-at-pos))
     (log-buf (get-buffer-create "*App-Log*"))
     ;; 定义不同等级日志的字体颜色
     (level-face (pcase level-sym
		   ('ERROR '(:foreground "red" :weight bold))
		   ('WARNING '(:foreground "orange" :weight bold))
		   ('DEBUG '(:foreground "green"))
		   ('INFO '(:foreground "gray50")))))
    (with-current-buffer log-buf
      (let ((inhibit-read-only t))
    (goto-char (point-max))
    (let ((start-pos (point)))
      ;; 格式 [LEVEL][buffer-name][line-number]:message
      (insert (format "[%s][%s][%d]: %s\n"
              level-sym file-or-buf line-num message))
      ;;为了便于后续跳转回来，这里我们保存一些隐藏信息
      (add-text-properties start-pos (point)
			   `(log-file ,file-or-buf
			     face ,level-face
			     log-line ,line-num
			     log-buf ,src-buf)))))))

这里使用了一个 pcase 宏用来作为条件判断，与 cond 相比它更为灵活，写出来的代码更加简洁。我们通过 pcase 判断当前等级，根据等级进行匹配，最终找到合适的颜色。

在设置属性的时候我们将属性添加进来，同样的需要使用 , 对属性值的变量进行求值并替换。

总结

本篇我们了解了属性的相关概念和应用，下面是今天提到的一些api函数

• add-text-properties
• put-text-property
• remove-text-properties
• set-text-properties
• add-face-text-property
• get-text-property