我们在上一篇中介绍了如何对文件中的文本进行操作,本篇主要来介绍关于文本的属性。
是的,文本也有属性。这里的文本属性有点类似于Word中的文字属性,文本中对应的字符只是文本属性的一种,它还包括文本大小、字体、颜色等等内容。Emacs中的文本也是类似的。于符号的属性类似,文本的属性也是由键值对构成。名 字和值都可以是一个 lisp 对象,但是通常名字都是一个符号,这样可以用这个 符号来查找相应的属性值。复制文本通常都会复制相应的字符的文本属性,但是 也可以用相应的函数只复制文本字符串,比如 substring-no-properties
、 insert-buffer-substring-no-properties
、buffer-substring-no-properties
。
产生一个带属性的字符串可以用 propertize
函数。
emacs-lisp">(propertize "abc" 'face 'bold) ;; ⇒ #("abc" 0 3 (face bold))
这里我们使用 face 来设置它的字体为粗体。或者我们可以使用C-x C-f
任意的打开或者创建一个文本文件,在文件中输入
emacs-lisp">(insert (propertize "abc" 'face 'bold))
我们可以看到它会在当前光标后面插入一个粗体的 abc
字符串。需要注意的是,我们在*scratch*
buffer 中是无法看到这个效果的。因为*scratch*
buffer 中开启了font-lock-mode
。正如它的名字表示的那样,它锁定了字体,它里面的字体属性都是实时计算出来的。在插入文本之后它的属性很快就被修改了。因为*scratch*
buffer 本质上还是一个elisp的编程环境,它里面有关于elisp的语法高亮、自动对齐等特性。它会自动的修改输入的文本属性。我们可以使用 (font-lock-mode - 1)
来关闭这个mode,然后执行上述代码就可以看到具体的效果了。
虽然文本属性的名字可以是任意的,但是一些名字是有特殊含义的。
属性名 | 含义 |
---|---|
category | 值必须是一个符号,这个符号的属性将作为这个字符的属性 |
face | 控制文本的字体和颜色 |
font-lock-face | 和 face 相似,可以作为 font-lock-mode 中静态文本的 face |
mouse-face | 当鼠标停在文本上时的文本 face |
fontified | 记录是否使用 font lock 标记了 face |
display | 改变文本的显示方式,比如高、低、长短、宽窄,或者用图片代替 |
help-echo | 鼠标停在文本上时显示的文字 |
keymap | 光标或者鼠标在文本上时使用的按键映射 |
local-map | 和 keymap 类似,通常只使用 keymap |
syntax-table | 字符的语法表 |
read-only | 不能修改文本,通过 stickness 来选择可插入的位置 |
invisible | 不显示在屏幕上 |
intangible | 把文本作为一个整体,光标不能进入 |
field | 一个特殊标记,有相应的函数可以操作带这个标记的文本 |
cursor | (不知道具体用途) |
pointer | 修改鼠标停在文本上时的图像 |
line-spacing | 新的一行的距离 |
line-height | 本行的高度 |
modification-hooks | 修改这个字符时调用的函数 |
insert-in-front-hooks | 与 modification-hooks 相似,在字符前插入调用的函数 |
insert-behind-hooks | 与 modification-hooks 相似,在字符后插入调用的函数 |
point-entered | 当光标进入时调用的函数 |
point-left | 当光标离开时调用的函数 |
composition | 将多个字符显示为一个字形 |
这些东西我觉得也不需要记住,在需要的时候查查文档就好了。但是我参考的教程把它列出来了,那么我也在这里列出来把。
由于字符串和缓冲区都可以有文本属性(如果没有特别指定文本对象的属性,那么默认使用缓冲区定义的文本属性),所以下面的函数通常不提供特定参数就是检 查当前缓冲区的文本属性,如果提供文本对象,则是操作对应的文本属性。
查看文本属性
查看文本对象在某处的文本属性可以用 get-text-property
函数。
emacs-lisp">(setq foo (propertize "abc" 'face 'bold)) ;; ⇒ #("abc" 0 3 (face bold))
(get-text-property 0 'face foo) ;; ⇒ bold
这里有两个问题需要注意一下,首先我们使用 propertize 为abc设置了文本属性face的值为bold,也就是将字符串设置为粗体。但是其中的0 和 3 代表什么呢?这里的0和3代表的是采用这个属性的字符在字符串中的范围,上面的代码中,整个abc字符串都采用整个属性,所以它的范围是[0, 3) 这个区间。要验证这一点我们可以使用下列代码
emacs-lisp">(setq foo (concat "abc"(propertize "cde" 'face 'bold))) ;; ⇒ #("abccde" 3 6 (face bold))
(insert foo)
我们插入foo发现,它会插入 “abccde” 这么几个字符串,但是只有 “cde” 三个是加粗的
根据这个提示,很明显的,get-text-property 中输入的0代表的就是“abc”字符串第0个,也就是字符a的属性。
get-char-property
和 get-text-property
相似,但是它是先查找 overlay
的 文本属性。overlay
是缓冲区文字在屏幕上的显示方式,它属于某个缓冲区,具 有起点和终点,也具有文本属性,可以修改缓冲区对应区域上文本的显示方式。
get-text-property
是查找某个属性的值,用 text-properties-at
可以得到某 个位置上文本的所有属性。
修改文本属性
put-text-property
可以给文本对象添加一个属性。它也是需要传入一个范围值,例如我们在前面foo
的基础上使用以下代码
emacs-lisp">(put-text-property 0 3 'face 'italic foo)
我们再针对 foo
执行插入操作,此时会发现 abc
这个子串变成斜体了。
和 put-text-property
类似,add-text-properties
可以给文本对象添加一系列的属性。和 add-text-properties
不同,可以用 set-text-properties
直接设置文本属性列表。你可以用 (set-text-properties start end nil)
来除去 某个区间上的文本属性。也可以用 remove-text-properties
和 remove-list-of-text-properties
来除去某个区域的指定文本属性。这两个函数的属性列表参数只有名字起作用,值是被忽略的。
以下的例子还是建立在之前的 foo
变量之上,此时它的值为 #("baccde" 0 3 (face italic) 3 6 (face bold))
。也就是前三个字符是斜体,后三个是加粗
emacs-lisp">(set-text-properties 0 1 nil foo)
;; 取消了 a 字符的文本属性
foo ;; ⇒ #("abccde" 1 3 (face italic) 3 6 (face bold))(remove-text-properties 2 4 '(face nil) foo)
foo ;; ⇒ #("abccde" 1 2 (face italic) 4 6 (face bold))(remove-list-of-text-properties 4 6 '(face nil) foo)
foo ;; ⇒ #("abccde" 1 2 (face italic))
查找文本属性
文本属性通常都是连成一个区域的,所以查找文本属性的函数是查找属性变化的 位置。这些函数一般都不作移动,只是返回查找到的位置。使用这些函数时最好 使用 LIMIT
参数,这样可以提高效率,因为有时一个属性直到缓冲区末尾也没 有变化,在这些文本中可能就是多余的。
next-property-change
查找从当前位置起任意一个文本属性发生改变的位置。 next-single-property-change
查找指定的一个文本属性改变的位置。 next-char-property-change
把 overlay 的文本属性考虑在内查找属性发生改 变的位置。next-single-property-change
类似的查找指定的一个考虑 overlay 后文本属性改变的位置。这四个函数都对应有 previous-
开头的函数,用于查找当前位置之前文本属性改变的位置
emacs-lisp">(setq foo (concat "abc"(propertize "edf" 'face 'bold)(propertize "hij" 'pointer 'hand))) ;; ⇒ #("abcdefhji" 3 6 (face italic) 6 9 (face bold))
(next-property-change 1 foo) ;; ⇒ 3
(next-single-property-change 1 'pointer foo) ;; ⇒ 6
text-property-any
查找区域内第一个指定属性值为给定值的字符位置。 text-property-not-all
和它相反,查找区域内第一个指定属性值不是给定值的 字符位置。
emacs-lisp">(text-property-any 0 9 'face 'bold foo) ;; ⇒ 3
(text-property-not-all 3 9 'face 'bold foo) ;; ⇒ 6