《elisp 每日一练》—— overlay 机制 在之前的文章中，我们利用 walk-windows 和 completing-read 实现了一个可以跳转到任意窗口的程序。但是我们通过 buffer + window 的方式进行显示，如果buffer不重名还好，用户可以根据buffer名称来选择，而当buffer有重名，用户没办法直观的看出哪个项对应哪个窗口。如果读者尝试过配置自己的Emacs，在管理窗口方面一定绕不开 ace-window这个插件，它提供了一个非常优雅高效的方式。今天将介绍overlay机制，并且利用该机制实现一个类似的跳转功能。背景知识介绍对于buffer的显示效果，Emacs提供了两种改变的机制，一种是通过设置 Text properties 来改变文本的字号、字体大小等属性，是 buffer 文本的一部分，会随文本一起复制、保存。另一个就是 Overlay 机制，它只影响显示，不进入 undo 列表，也不随文本复制。对于 Overlay 官方给它的定位是:You can use overlays to alter the appearance of a buffer’s text on the screen, for the sake of presentation features. An overlay is an object that belongs to a particular buffer, and has a specified beginning and end.你可以将它想象成一个贴在buffer上的便利贴。如果要使用的话，我们首先要创建一个便利贴、然后决定便利贴的位置，最后在不需要时销毁它。并且Emacs还提供了一些操作它的函数。下面我们来列举一些重要的函数。创建可以使用函数 make-overlay，它的原形如下:(make-overlay BEG END &optional BUFFER FRONT-ADVANCE REAR-ADVANCE)函数的相关参数如下:BEG 和 END : 指定overlay起始位置和终点位置BUFFER : 指定叠加层属于哪个缓冲区, 默认为当前缓冲区FRONT-ADVANCE 和 REAR-ADVANCE 表示当开头或者结尾被插入新字符时，overlay 该如何变化我们来了解一下最后两个参数的含义。我们还是将它想象成一个便利贴。假设便利贴我们从头到尾写满了文字，这个时候我们想要在便利贴开始位置或者结束位置写一个新的内容，该怎么办？ FRONT-ADVANCE 和 REAR-ADVANCE 就是来处理这种情况的。一种办法是丢失这些内容，纸张的大小不变，这个时候对应着 FRONT-ADVANCE 为非 nil 而 REAR-ADVANCE 为 nil。还有一种办法就是纸张大小改变，我们在前面和后面插入内容，此时对应着 FRONT-ADVANCE 为 nil 而 REAR-ADVANCE 为非 nil关于属性，我们有 overlay-put 和 overlay-get 来设置或者获取属性。面对一个陌生的，不是我们创建的 overlay，我们可以通过 overlay-start 和 overlay-end 来获取它的起始和结束位置另外我们可以通过 overlays-at 和 overlays-in 来获取区域内的所有 overlay。我们常用的属性有:face 设置样式，包括背景色、前景色、字体等display : 替换overlay中的的显示内容priority : 重叠时的 z序window : 限定只在指定窗口生效overlay 实际是对于 buffer 的修改，所以默认情况下，如果多个窗口都显示同一个buffer，那么每个窗口都会显示这样的内容，我们可以通过 window 属性，限定只在指定的窗口中显示例如我们可以尝试写下如下代码，来创造一个显示内容为 "标记" 的黄低红色的标记，并且通过 window 属性指定只在当前窗口显示(let ((overlay (make-overlay (point-min) (+ 10 (point-min))))) (overlay-put overlay 'window (selected-window)) (overlay-put overlay 'face '(:background "red" :foreground "yellow")) (overlay-put overlay 'display "A"))练习到此我们差不多已经掌握了 overlay 的绝大部分用法了。可以开始我们的改造行动了。我们的思路仍然是先遍历，然后给每个窗口打上标签，并且记录到一个列表中，列表中每项的内容为 (LABLE . window) 后续根据用户输入的字母或者数字来找到窗口并跳转。(defvar my/all-window-list '() "保存窗口字典的列表") (defun my/show-overlay(label win) "在左上角创建显示字母的 overlay" (with-selected-window win (let* ((pos (window-start)) (ol (make-overlay pos (+ 10 pos) (window-buffer win)))) (overlay-put ol 'display label) (overlay-put ol 'face '(:foreground "red" :weight bold :background "yellow")) (overlay-put ol 'window win) ol))) ;; 返回 ol 用于清理 (defun my/jump-to-selected-window() "根据用户按下的字母标签进行跳转" (interactive) (let*((chars (mapcar #'identity "abcdefghijklmnopqrstuvwxyz")) ;; 构建一个字母的字典 (overlays '()) ;; 保存所有的overlay 方便后面删除 (index 0)) ;; 存储当前使用的字母的索引 (walk-windows (lambda(win) (when (< index (length chars)) (let* ((ch (nth index chars)) (ol (my/show-overlay (string ch) win))) (when ol (push ol overlays) (push (cons ch win) my/all-window-list))) (setq index (1+ index))))) ;; 读取用户按键并跳转 (unwind-protect (let* ((char (read-char "选择窗口: ")) (win (cdr (assoc char my/all-window-list)))) (if win (select-window win) (message "没有选择对应的窗口"))) ;;清理资源 (mapc #'delete-overlay overlays) (setq overlays nil))))上述代码中使用了一个新的宏 unwind-protect。它的作用与try...catch 中的 finally 类似，它的定义如下:(unwind-protect body-form cleanup-forms...)它主要执行body-form 中的内容，并且保证会执行 cleanup-forms 中的清理代码。总结本节我们学习了如何给buffer 加上 overlay ,用来展示一些信息。本节介绍的函数有make-overlayoverlay-put 和 overlay-getoverlay-start 和 overlay-endoverlays-at 和 overlays-in

《elisp 每日一练》——显示buffer的新姿势 上一篇提到，可以使用 split-window 来创建新的窗口，也区分了buffer和窗口的概念，同时也知道如何获取、修改窗口展示的buffer。split-window 创建的窗口有一个特点：它需要我们自己指定新窗口的摆放位置，窗口位置由我们自己维护。一般情况下，在编程或者做工程化的项目时引入 workspace 的概念，我们规定如何划分窗口区间是有利的，但是有些窗口像 *Help*、*Messages* 、Shell 这类窗口我们经常看一眼或者临时需要打开，如果将它纳入自主的窗口管理就不合适了。本节我们来解决这个问题知识铺垫Emacs 中提供了两个函数 display-buffer 和 pop-to-buffer。我们先从 display-buffer 开始。它的函数原形为(display-buffer BUFFER-OR-NAME &optional ACTION FRAME)它会根据我们已有的窗口布局来选择合适的窗口显示对应的buffer内容，也就是说它不一定会创建新的窗口，它只是根据用户需求选择合适的窗口来显示。如果没有合适的则创建，有则利用已有的窗口来显示。我们可以通过 ACTION 参数来定义它的行为。它只负责显示buffer，而不会跳转光标，这种一般用于设置查看日志但是不操作buffer内容的场合。如果我们希望在显示buffer之后光标也跟着跳转，可以使用函数 pop-to-buffer。它们显示buffer的行为完全一样，但是 pop-to-buffer 会移动光标到新的buffer所所在窗口中。(pop-to-buffer BUFFER-OR-NAME &optional ACTION NORECORD)我们看到它的函数参数中，也有一个 ACTION 参数。我们可以通过这个参数来实现自定义显示行为。一个标准的ACTION是 '(FUNCTIONS . ALIST) 的结构。其中 FUNCTION 表示函数或者函数列表，Emacs 在显示时会Emacs 会从左到右依次尝试这些函数，直到其中有一个成功找到或创建了窗口为止。ALIST 是一个由 (属性 . 值) 构建的关联列表。用来微调上述函数执行时的行为（如窗口高度、分屏方向、是否专有等）。各位读者看到这些结构也不必惊慌，Emacs为我们提供了一些常用的通用封装。对于function来说，有以下常用的预定义函数:display-buffer-reuse-window : 重用已有窗口, 如果该 Buffer 已经在某个窗口显示了，直接使用该窗口。display-buffer-same-window : 占用当前窗口, 直接在当前光标所在的窗口中显示该 Buffer。display-buffer-pop-up-window : 切分新窗口, 根据 split-height-threshold 或 split-width-threshold 在周围切出一个新窗口。display-buffer-below-selected : 在下方切分, 在当前窗口的正下方新建或重用一个窗口。display-buffer-at-bottom : 底部全宽弹出, 在当前 Frame（或屏幕）的最底部创建一个跨越整宽的窗口。display-buffer-in-side-window : 侧边栏/侧边窗口, 在 Frame 的四周（left/right/top/bottom）作为 Sidebar 弹出（通常搭配专属属性）。display-buffer-pop-up-frame : 弹出新 Frame , 直接新建一个独立的 OS 窗口（Frame）。对于 ACTION 中的 ALIST 也有一些预定义的属性(window-height . N) : 设置弹出窗口的高度。整数（如 15）表示固定行数；浮点数（如 0.3）表示占当前/全屏高度的比例。(window-width . N) : 设置弹出窗口的宽度。整数表示列数；浮点数表示宽度比例。(side . left/right/top/bottom) : 指定侧边栏弹出的位置，可以与上述 display-buffer-in-side-window 搭配使用(slot . N) : 侧边栏的位置，用于同侧有多个窗口的情况，(reusable-frames . val) : 寻找可重用窗口时的范围：t（所有 Frame）、visible（所有可见 Frame）、0（当前及当前可见 Frame）、nil（仅当前 Frame）。(inhibit-same-window . t): 明确要求绝对不能占用当前窗口。(dedicated . t) : 将新创建的窗口标记为专有（Dedicated）。专有窗口在用户切换其他 Buffer 时不会被轻易替换。有了这些知识，我们可以对显示messages buffer给出简单的定义，例如我希望message buffer永远只出现在最底部，并且占用整个底部。就可以有下面的代码:(defun my/show-messages-buffer() (interactive) (display-buffer "*Messages*" ;; 底部全宽显示 '((display-buffer-at-bottom) ;;ALIST 参数， 高度为30，强制不覆盖当前窗口 (window-height 30) (inhibit-same-window . t))))实际上除了在 ACTION 参数中设置这些属性外，还可以通过全局变量 display-buffer-alist 来设置这里的 ACTION 参数。它与这里通过参数设置的方式相比，优势在于它可以通过正则表达式来匹配一次性定义一堆buffer的显示方式。它的数据结构为:((CONDITION . ACTION) (CONDITION . ACTION) ...)上一节我们提到，可以使用 quit-window 和 delete-window 删除窗口，但是没有讲它们的区别，因为那个时候还没有引入这种显示buffer的新姿势。现在有了这些知识就可以来说说它们的区别了。今天的新姿势对比之前来讲，最大的区别就是不一定要创建新窗口，它可以重用现在的窗口来显示新内容。quit-window 是一种温和的删除窗口的方式，对于这种重用的状态，它只是不显示新buffer的内容但是会酌情保留原来的窗口。而 delete-window 来说就比较不讲情面了，它不管你还需不需要用这个窗口，直接删除。练习今天的练习，我们来实现一个查看message、log这种buffer的功能，我们希望通过 display-buffer-alist 设置全局的，对于这种窗口我们采用底部显示的方式，取底部35%的区域进行显示。(add-to-list 'display-buffer-alist '("\\*.*\\(?:log\\|messages\\).*\\*" (display-buffer-reuse-window display-buffer-at-bottom);; 优先重用已打开的对应窗口；若未打开，则在当前 Frame 的最底部弹出 (window-height . 0.35) ;; 占用25%的空间 (reusable-frames . visible))) ;; 允许在当前可见的其他Frame中搜寻 (display-buffer "*Messages*")总结本篇我们了解了另一种通过window 显示buffer的方式，主要的函数有:display-bufferpop-to-buffer

《elisp 每日一练》——窗口操作 经过之前两篇，我们差不多把buffer相关的内容都了解了，主要是buffer的创建、删除、获取以及buffer属性的变动。本篇我们将开始讨论关于窗口的话题背景知识首先需要了解的是窗口和buffer不是一个概念，窗口是用来显示buffer内容的，而buffer只是保存文本信息。并且多个窗口可以显示同一个buffer的内容，但是不同的buffer不能由同一个Window显示。创建一个窗口可以通过函数 split-window ，默认它会在光标所在窗口的右侧新建一个窗口，而新老窗口显示的是同一个buffer。它的函数原形如下:(split-window &optional WINDOW SIZE SIDE PIXELWISE)WINDOW 具体要分隔的是哪个窗口，默认不填的话就是当前窗口SIZE 新窗口的大小（行数或列数）, 如果为正数则表示新窗口的宽或者高，负数则表示留给原窗口的宽或者高SIDE 分割方向below 或 t 在下方创建新窗口above 在上方创建新窗口right 在右侧创建新窗口left 在左侧创建新窗口PIXELWISE 表示 SIZE 参数的单位, 若为非 nil，SIZE 的单位将从字符行列数变为像素单位它返回新创建的窗口对象。因为它默认只能显示当前buffer，一般来讲我们会在创建的时候指定它要显示的buffer，修改窗口显示的buffer使用函数 set-window-buffer 它需要接收至少两个参数，分别是窗口和buffer(或者buffer的名称)而我们如果希望获取window中显示的buffer可以使用函数 window-buffer, 它返回当前窗口中显示的buffer 对象。一般在日常使用中将它们搭配使用(defun my/show-message-buffer() (interactive) (let ((new-window (split-window nil 20 'below))) ;; 在当前窗口下方新建一个高度为20行的新窗口 (set-window-buffer new-window "*Messages*"))) ;; 新窗口中显示 *Messages* buffer上述例子执行之后我们发现，光标仍然停留在之前的窗口上，想要修改光标所在的窗口可以使用 select-window，它接收一个window对象表示要将光标移动到哪个窗口，或者说当前要激活哪个窗口。因此我们可以改进一下上述函数，做到立即跳转光标到新窗口。这里就不给代码了，读者可以自行尝试。如果我们想遍历当前窗口可以使用 walk-windows ，它主要接受一个函数，每当遍历一个窗口时调用该函数。最后再介绍一下删除窗口的操作。删除窗口操作可以使用 delete-window 和 quit-window, 一般而言quit-window 较为温和，而 delete-window 粗暴一些。 quit-window 用于删除一些临时性的或者弹出式窗口，而delete-window 用于删除其他窗口。练习本次的练习，我们结合 walk-windows 和 completing-read 函数做一个遍历所有窗口并根据用户显示来将光标跳转到指定窗口的小功能。(defun my/jump-to-selected-window () "遍历所有窗口并通过补全进行跳转（支持同名 Buffer 区分）。" (interactive) (let ((window-collections '())) (walk-windows (lambda (win) (let* ((buffer (window-buffer win)) (bname (buffer-name buffer)) ;; 生成格式如: "*scratch* [win #<window 3 on *scratch*>]" (label (format "%s [%s]" bname win))) (push (cons label win) window-collections)))) (let ((selected (completing-read "请选择要跳转的窗口: " window-collections nil t))) (when (and selected (assoc selected window-collections)) (select-window (cdr (assoc selected window-collections)))))))上述代码我们考虑了多个window显示同一个buffer的问题，以buffer和window对象的字符串作为主键，后续根据用户选择来执行 select-window 操作。总结本篇我们介绍了基础的窗口操作，本篇介绍的函数如下:split-window 创建新窗口set-window-buffer 设置窗口显示的bufferwindow-buffer 获取窗口显示的buffer对象select-window 激活指定的窗口对象walk-windows 遍历当前所有窗口delete-window 和 quit-window 关闭窗口

《elisp 每日一练》——buffer属性 前面我们介绍了buffer相关的操作，主要有buffer的获取、创建、删除、设置当前buffer。我们再最开始的时候为了方便理解buffer的概念，让大家将它类比成 char* const 类型，主要用来保存文本数据的缓冲。这条对也不对，buffer是Emacs维护的一个复杂的结构，可不单单是有个缓冲区的指针那么简单。它除了保存了文本的缓冲，也有各种属性。本篇我们将来介绍一些常用的属性背景知识铺垫首先是buffer的名称。我们在创建的时候都会给一个名称，后续也可以根据名称来获取buffer对象。可以说名称似乎就是获取buffer的 primary key。获取名称可以使用 buffer-name ，而修改名称可以使用 rename-buffer。rename-buffer 有一个名为 UNIQUE的可选参数，表示是否允许名称重复，如果允许的话，在重名的情况下会在buffer名称后加上数字后缀，如果不允许也就是值为 nil 的时候，给出重复名称时会报错。buffer-name 可以传入buffer 对象来获取不同buffer的名称，而 rename-buffer 只能修改当前buffer的名称。第二个属性是它关联的文件。一般来讲如果我们希望修改的内容能持久化的保存，需要将buffer与磁盘上的物理文件关联，并在Emacs退出前进行保存。buffer-file-name 可以帮助我们获取当前buffer关联的文件的物理路径。如果我们要修改/设置某个buffer关联的物理文件，可以使用 set-visited-file-name。第三个属性是修改状态。当Emacs打开一个文件时，会将文件的内容加载到buffer中，并将二者进行关联。此时buffer处于未修改或者说干净的状态。如果我们执行操作修改了文件内容，那么此时buffer会变成修改但未保存到文件的状态，或者说是脏页状态。我们手动执行保存操作之后buffer又会恢复干净的状态。如果我们关闭Emacs时，Emacs默认会遍历当前打开的buffer，对于哪些处于修改状态的buffer会弹出提示框询问我们是否需要保存。但是对于那些没有关联到文件上的则省去了询问的过程。我们可以通过 buffer-modified-p 来查看当前buffer 是否被修改了。也可以通过 set-buffer-modified-p 来设置它的状态。第四个属性是只读属性。如果尝试修改它会报错。我们可以通过 buffer-read-only 这个变量来确定当前buffer是否是只读的。例如我们可以写一个简单的函数来判断指定buffer是只读状态(defun my/buffer-read-only-p (bname) (interactive "B输入对应的buffer:") (let ((buffer (get-buffer bname))) (if buffer (with-current-buffer buffer (if buffer-read-only (message "buffer %s 是只读的" bname) (message "buffer %s 不是只读" bname))) (message "未找到指定名称的buffer"))))我们可以通过设置当前buffer的 inhibit-read-only 变量为t来临时的取消buffer的只读状态，例如我们可以尝试通过以下代码清空 Messages buffer(defun my/clear-messages-buffer() (interactive) (let ((message-buffer (get-buffer "*Messages*"))) (if message-buffer (with-current-buffer message-buffer (let ((inhibit-read-only t)) (erase-buffer))))))请注意我们这里使用的是 let 设置的变量值，而没有使用 setq。我们这里实际上创建的是同名的临时变量，用临时变量覆盖了buffer的“全局变量”。在临时变量存在的时候Emacs读取的是这个临时变量的值，此举会短暂性的将buffer修改为可写状态。在代码跳出let的作用域之后临时变量被销毁，inhibit-read-only 又恢复了初始值。而setq 就达不到这个效果。在 Emacs Lisp 官方开发规范中，临时修改只读 Buffer 最标准的做法就是利用 let 绑定 inhibit-read-only练习有了这些基础，我们可以写一个批量保存的小工具。我们可以遍历当前所有打开的buffer，判断buffer是否是修改状态，如果被修改并且绑定到了具体的物理文件则执行保存操作。保存buffer到文件可以使用 save-buffer 函数(defun my/save-all-buffers() (interactive) (dolist (buffer (buffer-list)) (with-current-buffer buffer (when (and (buffer-modified-p) (buffer-file-name)) (save-buffer)))))总结本篇我们介绍了，Emacs中关于buffer的一些常用属性，以及修改它们的函数或者变量。下面我将其列举出来buffer-name 和 rename-bufferbuffer-file-name 和 set-visited-file-namebuffer-modified-p 和 set-buffer-modified-pbuffer-read-only 和 inhibit-read-only

《elisp 每日一练》——buffer 操作 在前面关于buffer 的介绍中，我们都是在操作当前buffer。但是Emacs里面有许多buffer，同时也允许我们创建不同的buffer。本篇我们将进入buffer操作的环节。看看如何在Emacs中管理buffer。背景知识buffer的操作与文本操作类似，无外乎也就是增删改查四个大的内容。我们按照这个顺序来介绍。首先是buffer的创建，可以使用 get-buffer-create 来完成，它接收一个buffer 名称的字符串作为参数，如果当前名称的buffer已经存在则直接获取该buffer的对象，否则创建一个新的buffer。如果我们无论如何都要创建新buffer，而不管名称是否存在，可以使用 generate-new-buffer，该函数会无条件的创建新的buffer，如果当前名称的buffer已经存在，它会创建一个带数字后缀名称的新buffer。而如果我们仅仅获取已经存在的buffer，可以通过函数 get-buffer，当buffer不存在时会返回nil删除一个buffer 可以使用 kill-buffer，它接收一个buffer对象或者buffer名称的字符串作为参数，来删除一个buffer。修改buffer，实际上我个人认为分成两个层面，一个是修改buffer的内容，也就是前面我们提到的goto-char、delete-region 之类的文本操作。而另一个就是修改buffer的属性。其中有一个就是修改当前buffer，在这个层面可以使用函数 set-buffer。这里可能要稍微补充一下什么是当前缓冲，用面向对象的角度来讲，我们调用操作对象的方法总的有一个被操作的对象，而C/C++ 中这个对象实际上通过类函数中的this 指针进行绑定。而我们调用 goto-char、insert、delete-region 等函数，操作的是当前buffer，如果我们希望这些函数操作另外的buffer，那么就需要通过 set-buffer 修改默认buffer。一般来讲，我们通过 set-buffer 切换到别的buffer中进行操作实际上是一个临时性的动作，因为用户此时的注意力完全在当前显示的buffer上，我们只会短暂的切换，而后续又会切换回来。因此这里涉及到一个关于buffer的保存和恢复现场的概念。保存和恢复buffer的现场，用的是 with-current-buffer。witch-current-buffer 会切换到一个已存在的buffer，而事后并不会主动清理无效的buffer。也是说我们在使用前要先确保当前buffer存在，然后使用。但是有时候我们仅仅只需要一个临时的buffer，用后直接删除，此时可以使用 with-temp-buffer到此为止我们已经有4个保存和恢复现场的函数了。我们一般的顺序是 with-current-buffer、save-excursion、save-restriction，至于 save-match-data ，用的不如前面一个广泛。查询buffer，我们可以通过 buffer-name 获取指定buffer的名称，它接收一个buffer对象，或者默认获取当前buffer的名称。我们也可以通过 buffer-list 来获取所有buffer 的列表。最后我们判断一个buffer是否有效时可以使用 buffer-live-p练习buffer的内容可能没有之前介绍文本操作时那么详细，因为我觉得buffer比较简单，实际上我们只要理解buffer是Emacs存放文本的一个内存缓冲区，我们的这些操作实际上就是在修改保留这块内存的变量的属性。而且如果读者对一些文本编辑器有一定的了解，会发现大多数文本编辑器都有buffer的概念。本次的练习我们来尝试将用户选定的buffer中的文本拷贝到当前buffer最后面。它经历的流程如下：通过交互式命令让用户输入对应的buffer名称通过名称获取buffer对象，如果对象不存在则输出错误信息切换当前buffer直接通过 buffer-substring 获取整个buffer的拷贝切换回当前buffer调用insert插入对应的文本最终我实现的代码如下:(defun my/append-string-to-buffer(bname) (interactive "B您要拷贝哪个buffer的内容:") (let ((src-buffer (get-buffer bname))) (if src-buffer ;; buffer有效 (let (src-string) (with-current-buffer src-buffer (save-restriction (widen) (setq src-string (buffer-substring (point-min) (point-max))))) (push-mark) (goto-char (point-max)) (newline) (insert src-string)) (message "无效的buffer名称"))))当前例子中的代码还是有一些问题的，例如我们没有判断当前所在的buffer是否是只读类型的。只读类型只是buffer的一个属性，关于buffer中的相关属性将在后面的内容进行讨论。本篇我们介绍的函数如下:get-buffer-creategenerate-new-bufferget-bufferkill-bufferset-bufferwith-current-bufferwith-temp-bufferbuffer-namebuffer-listbuffer-live-p

《elisp 每日一练》——阶段性总结与练习 在之前的一系列文章中，我们已经详细介绍了关于文本和光标的一些操作以及对应的API。我们先回顾一下之前介绍的内容前期内容回顾我们先介绍了有关光标位置和移动光标的一些函数:point-min 和 point-maxline-beginning-position 和 line-end-positiongoto-charforward-line以及拷贝对应区域文本的函数 buffer-substring接着又介绍了有关恢复光标位置相关的API函数markpush-mark 和 pop-marksave-excursion而Emacs内部维护 mark 的方式被称为 mark-ring，有关 mark-ring 的函数与变量如下:mark-ringmarker-positionline-number-at-posmarker-buffermark 与 Point 能构成一个 Region，关于 Region 的函数如下:region-beginning 和 region-endactivate-markuse-region-p因为 region 本身不具备区域保护的功能，它无法限制我们仅仅操作某个区间的文本，所以Emacs又提供了 Narrowing 和 Widen 机制。narrow-to-regionwidensave-restriction之后我们正式进入了对文本的增删改查的学习。相关API内容如下:insertdelete-regionsearch-forward 和 re-search-forward 以及反向的 search-backward 和 re-search-backwardmatch-stringsave-match-datastring-matchstring-match-pmatch-beginning 和 match-endreplace-match综合练习本次练习，我们结合之前介绍的相关API来写一个综合性的功能。我们平时在写代码时经常会写各种各样的注释，有些注释有一些固定的写法, 例如我经常写 TODO 表示这部分功能没有加，后面加上， FIXME 这部分实现的比较粗糙，后面在进行重构或者精细化处理。虽然未来大概率就不了了之了，但是留下这些注释显得比较专业(不是)我们现在要做的就是收集 TODO 和 FIXME 开头的这些注释，然后将它们加入到minibuffer 中，显示，在用户选择对应的注释之后跳转到buffer对应的位置(defvar my/todo-mark-list '() "保存全局的todo列表，格式为(SUMMARY-TEXT . marker)") ;; 收集todo/fixme 数据 (defun my/code-todo-list-collect() (interactive) (setq my/todo-mark-list '()) (save-excursion (save-restriction (widen) (goto-char (point-min)) ;;遍历并收集数据 (while (re-search-forward "//\\s-*\\(todo\\|fixme\\):?\\s-*\\(.*\\)$" nil t) (let* ((raw-content (match-string 2)) ;; 准备数据 (m (copy-marker (match-beginning 0)))) (push (cons raw-content m) my/todo-mark-list)))))) (defun my/jump-to-next-todo() (interactive) (save-restriction (widen) (if (null my/todo-mark-list) (message "当前没有待修正的任务") (let* ((selected (completing-read "请选择要跳转的位置: " my/todo-mark-list nil t))) (when selected (let ((target (cdr (assoc selected my/todo-mark-list)))) (push-mark) (switch-to-buffer (marker-buffer target)) (goto-char target)))))))本次的练习，我们分了两个函数，一个用于收集信息，另一个用于在minibuffer 进行交互。在收集信息时我们仍然采用之前的写法，将string 放在CELL的最外层，这样 completing-read 可以正常读取出对应的字符串提示信息并且显示。而后面我们仍然是通过二者的关联性快速执行跳转。虽然我将它称之为综合练习，但是目前我们还有有些内容没有涉及到，比如说修改注释，我们可以做的更复杂一些，将这种注释修改为更加标准的内容。后面我们学习了buffer、file相关的操作之后就可以做的更复杂一些，例如对搜索的结果进行持久化，又或者搜集整个工程中的待办事项。总结到此位置关于操作文本相关的内容我们都已经涉及到了，后面我们会开始进入有关 buffer 和 window 专题讨论相关的操作

《elisp 每日一练》——文本插入、删除、替换 对于文本操作的增删改查，我在前一天已经了解了关于查相关的操作。今天我们来了解增删改。背景知识文本增删比较简单，我们只需要确定光标位置，然后调用相关函数即可。文本的增加或者说插入我们通过函数 insert 来执行。它的函数原型如下:(insert &rest ARGS)它用来在光标所在位置之后插入对应文本，从函数定义上，我们知道这个函数后面可以跟一个或者多个参数。也是就是说我们实际上可以一次插入多个字符串。我们需要注意的是光标和mark的变化，插入结束之后，光标位于插入文本的末尾，而mark由Emacs维护，它会随着文本的变化而变化。删除我们使用函数 delete-region 它的函数原型如下:(delete-region START END)它用来删除从 START 到 END 区域内的文本。而光标位置会在原来的基础上减去被删除的字符数。而 mark 因为是由Emacs自己维护的，所以如果 mark 位于 START 之前，那么它的位置不会发生变化，在END 之后，它的位置会相应的减去 END - START 的值。如果在 START 和 END之间，那么它会被放到 START的位置。增加和删除比较简单，光标和 mark 位置的变化也跟我们平时使用编辑器的习惯一致。这个部分稍微复杂一些的操作是修改。一般来讲，修改之前会进行查找并且对匹配上的部分进行修改，所以它天然的就离不开正则表达式。Emacs 中，通过函数 replace-match 来进行。它的函数原型如下:(replace-match NEWTEXT &optional FIXEDCASE LITERAL STRING SUBEXP)它的核心参数为:NEWTEXT : 替换后的新文本FIXEDCASE : 如果为 nil Emacs在替换时采用智能大小写机制。(例如原词是大写，替换词也会自动转大写)，如果为 t 会强制按照 NEWTEXT 的原始值LITERAL : 若为 t 则 NEXTTEXT 被视为纯文本，否则允许在 NEWTEXT 中使用 \1 、\2 来引用正则捕获组SUBEXP : 指定只替换第 N 个捕获组，而不是整个匹配项另外在上一篇我们知道，Emacs中匹配结果非常脆弱，它永远只保留最近一次匹配的结果。我们应该即时通过 match-string 获取并保存结果。但是如果我们确实需要在后续再重新获取怎么办？Emacs提供了一个保护现场的函数 save-match-data。到这里我们已经知道了三个保存现场的函数 save-excursion 、 save-restriction 、save-match-data 。练习到这里我们已经可以尝试对文本进行操作了。我们来尝试一下将所有 foo_ 为前缀的函数替换为 my/foo_ 。因为Emacs 中的函数定义以 (defun 开头，所以我们实际上匹配的就是 (defun foo_下面是我的实现(defun my/profix-internal-functions() (interactive) (let ((count 0)) (save-excursion (save-restriction (widen) (goto-char (point-min)) (while (re-search-forward "(defun \\(foo_[a-zA-Z0-9-]+\\)" nil t) (setq count (1+ count)) ;; 用 \1 引用捕获匹配到的函数名称, 参数t表示维持原来的大小写 参数3为nil表示替换的字符串中允许使用 \1 这种来匹配原来的捕获 (replace-match "(defun my/\\1" t nil)))) (message "重构完成，共修改 %d 个函数名" count)))到此我们已经掌握了移动光标和操作文本的大部分操作了。基于此我们就可以完成日常操作文本的任务了。后面我们将对之前的内容进行一个总结，并完成一个基础的小功能。敬请期待！

《elisp 每日一练》——Narrowing与Widen 在前面我们介绍了Region的概念，它就是由 marker 和 point 构成的一个区域。Region 是一种极度临时的状态——我们可以通过移动光标随时修改它的区域，或者激活/取消激活。光标可以随意移动出Region所在区域，以后如果基于这个条件进行操作时容易造成误操作Region 可以说只有在激活那一刻才有效，后续如果改变了point 或者 marker 就会造成改变为了应对这些问题，Eamcs中又有了 narrowing和widen 机制。它能将 Buffer 的可视与操作范围强制限制在特定区域内，为你提供一个安全、持久的局部编辑“沙盒”。背景知识铺垫Emacs 中允许我们通过 Narrowing 机制将注意力只集中在 Buffer 的某一部分，而把其余所有的文本暂时“隐身”。这样即使某些操作全局的函数此时也只能操作该范围内的文本。首先，Narrowing 会改变 (point-max) 、(point-min) 的值，在默认没有 Narrwoing 的情况下, point-min 总是返回1，而 point-max 返回buffer中最后一个字符所在的索引。但一旦对 Buffer 施加了 Narrowing, point-min 、point-max 的值就与我们设置的可见区域的区间有关了。我们可以通过 (narrow-to-region START END) 将buffer的可见区域设置为从 START 到 END之间的区域。通过 (widen) 来解除所有之前设置的 narrowing。实际上于 mark 、point 类似，对于 Narrowing 我们也要考虑备份和恢复现场的情况，保存和恢复现场使用的函数是 save-restriction。在一些插件的代码中我们经常看到 save-restriction 和 save-excursion 成对出现。它们的用法也是类似的。既然它们一般是成对出现的，我们不妨考虑一下它们两个谁在外层，谁在内层呢？假如 save-restriction 在外层，而 save-excursion 在内层, 也就是这样;; 假设当前光标位于位置 (Point = 400) (save-restriction (save-excursion (widen) ;; 暂时恢复可见区间为整个buffer (narrow-to-region (point-min) 200) (goto-char (point-max)) ;; 执行其他操作 ))上述例子中，我们通过 narrow-to-region 将可见区域限制在 1 到 200 这个区间。然后执行一些操作。当要恢复时先调用 save-excursion 尝试恢复光标位置到最初的 400时发现它的可见区域最多到200，此时光标位置可能被置于200位置。最后执行 save-restriction 恢复可见区域，但是此时光标已经回不到最初的 400位置了。从上面可以看到最好是将 save-excursion 放在外层。练习本次的例子，我们实现一个简单的统计指定行中单词的个数。这次用到的函数为 count-words ， 它的原形如下:(count-words START END &optional TOTALS)它主要接收两个参数：统计的起始位置和结束位置。获取行的区间坐标可以通过 forword-line 移动光标到指定行，然后通过 line-beginning-position 和 line-end-position 获取行首和行尾位置的 point值利用今天所学的内容可以写下如下的代码:(defun my/count-words-in-line(line) ;; 获取行首和行尾位置 (save-excursion (save-restriction (widen) ;; 先取消之前所设置的可见区间恢复整个buffer可见 (goto-char (point-min)) (forward-line (1- line)) ;; 移动到对应行 (narrow-to-region (line-beginning-position) (line-end-position)) (count-words (point-min) (point-max)) )))总结本次我们了解了 Emacs 中的 Narrowing与Widen 机制。后面我们写代码操作文本时可以先直接默认操作整个区域，而在需要关注操作区间时通过 narrow-to-region 设置可见区间。不过不要忘了通过 save-restriction 恢复之前设置的可见区间。本次我们介绍的api函数有：narrow-to-region 设置可见区间widen 取消之前设置的所有可见区间save-restriction 恢复调用之前的可见区间

《elisp 每日一练》—— Region 在关于保存和恢复现场的例子中，我们了解了 marker 相关的概念。 marker 与 point 都是一个表示位置的整数，不同的是marker 是动态的，由Emacs 内部根据buffer内容变化进行维护，而 point 是静态的。它们两个结合可以构成我们今天要讨论的内容——Region知识铺垫在图形界面编辑器中，我们经常用鼠标拖拽高亮一段文字，这叫“选中文本”。而在 Emacs 中，这个概念叫 Region（选区）。Region 是一个区间，它由 marker 和 point 组成的闭区间。我们可以使用这样一个公式来描述区间的组成： $\text{Region} = [\min(\text{point}, \text{mark}), \max(\text{point}, \text{mark})]$也就是说，起始位置是从 marker 和当前 point 中找到最小值，终点位置是二者的最大值。所以我们需要注意，在编写有关 Region 的代码时绝对不能假设使用 marker 或者 point 作为起点，或者终点。实际上为了解决这个问题，Emacs 提供了两个函数 region-beginning 和 region-end 来获取Region的开始和结束位置我们如何激活一个区域呢？可以通过 activate-mark 函数来激活当前选取。又或者可以通过 push-mark 在创建 marker 的同时进行激活。实际上 push-mark 的函数原形为:(push-mark &optional LOCATION NOMSG ACTIVATE)后面几个参数是可选的，它们分别代表:LOCATION: 表示作为新 marker 位置的 point 值，默认是当前光标所在位置NOMSG : 是否在minibuffer 中显示 Mark set 字样, 默认为 nil 也就是不显示ACTIVATE : 是否激活当前 Region，默认为 nil 不激活我们可以用一个例子测试一下(defun my/select-whole-buffer() (interactive) (goto-char (point-min)) (push-mark (point-max) nil t))上述例子我们将整个buffer的内容进行全选。另外，在操作 Region 时我们经常需要判断当前 Region 是否出于激活状态。因为前面介绍过实际上 marker 和 point 天然就构成一个 Region。如果不进行判断，用户想要进行某些操作时会出现不可预料的情况。例如如果用户想在选中区域进行查找，或者在当前行查找，如果不进行判断，有可能用户没有进行选区操作但是查找时却因为隐藏的region 导致查找发生在region中我们可以通过 use-region-p 来判断用户是否激活了选取练习我们实现一个函数，如果用户选择了一个区域，那么将区域中的所有字母大写，否则将光标所在单词的字母转换为大写。将单个单词大写可以使用函数 upcase-region，而将单词大写可以使用 upcase-word。upcase-region 接收一个起始位置和结束位置，将这个区间内的字母都转化为大写upcase-word 接收一个整数，表示将光标所在位置之后(正数)、或者之前(负数参数)的多少个单词转化为大写upcase-word 仅仅只能将光标所在位置到单词结尾位置的字母大写，我们还需要一个方法来获取单词首部，然后通过 goto-char 的方式移动光标到词首，最后执行 upcase-word。当然有了范围也可以使用 upcase-region获取光标所在单词的范围可以使用 bounds-of-thing-at-point。他的函数原形如下:(bounds-of-thing-at-point THING)它支持的 THING 非常多，有 word 、list、symbol、number、filename 等等。这里我们使用 word 就行。它返回的格式是 (START . END)。结合之前介绍的CELL的操作就可以获得START 的值。我们可以做一个快速选择光标所在单词的函数来看看它的用法(defun my/select-the-word() (interactive) (let ((bound (bounds-of-thing-at-point 'word))) (progn (goto-char (car bound)) (push-mark (cdr bound)) (activate-mark))))这里我们确实需要改变mark栈来和当前光标位置组成一个新的区域，所以不适合使用 save-excursion 来保存和还原现场。另外这里也演示了如何通过 activate-mark 来激活一个选区。有了这些函数的辅助，最终我的实现如下:(defun my/upcase-target() (interactive) (if (use-region-p) ;;用户选中区域，转换区域内文本 (upcase-region (region-beginning) (region-end)) ;;用户未选中文本，直接转换单词 (save-excursion ;; 考虑保存和恢复现场 (let ((bound (bounds-of-thing-at-point 'word))) (if bound (progn (goto-char (car bound)) (upcase-word 1)))))))至于如何使用 upcase-region 来实现将光标所在单词转化为大写的功能，读者可以自行尝试。总结本篇我们了解了 Region 的概念，以及可以使用Region做一些事情。后续很多高级的功能都可以依赖region 来实现，例如在选区中搜索、替换文本。今天介绍的函数有：region-beginning 和 region-end 获取选区的区间activate-mark 激活选区use-region-p 判断选区是否激活upcase-word 将光标所在位置之后的单词转化为大写upcase-region 将对应区间的单词转化为大写bounds-of-thing-at-point 获取指定事物所在的区间

《elisp 每日一练》——现场保护与还原 在第二天里面，我们介绍了光标移动和行索引区间的api函数，并且学会了如何移动光标。实际上在操作Emacs进行文本编译的动作时很多时候都在移动光标，只是我们感觉不到。如果我们随意的移动光标就容易带来一个问题，我们执行某个操作之后找不到光标在哪了，如果我们还要花时间找光标在哪，就很浪费效率背景知识铺垫如果我们自己实现一个简单的版本，我们可能会考虑使用 let ((old-point (point))) 这样的语句来先保存最后通过 (goto-char old-point) 来进行设置。这个思路是对的，但是它主要的问题是point记录的是当前位置的索引，如果我们在当前光标位置之前插入了字符串改变了光标所在文本的索引，那么根据之前保存的位置值就是一个错误的值。为了解决上一个问题，Emacs引入了 marker 的概念。与 point 不同，marker 是指向 Buffer 中特定位置的指针。如果在 Marker 之前插入或删除了文本，Emacs 的 C 语言底层会自动更新 Marker 的数值，使其依然指向原本对应的那个文字点。我们可以通过 push-mark 和 pop-mark 来保存和恢复一个mark。从名字上可以看出来它是一个栈操作。需要注意的是，出栈时并不会返回栈顶存储的值，我们可以通过 mark 函数来获取栈顶的值。为了清楚的体现第二个区别，我们可以写这样一个例子(defun my/test-point() (interactive) (let ((old-point (point))) (goto-char (point-min)) (insert "this is a test for point") (goto-char old-point))) (defun my/test-mark() (interactive) (push-mark) (goto-char (point-min)) (insert "this is a test for point") (goto-char (mark)) ;; 通过栈顶记录的marker 值来恢复光标位置 (pop-mark))到这里我们似乎解决问题了。我们可以通过管理marker 栈来实现保存和恢复现场。但是我们没有考虑一种情况：如果在push 之后 pop 恢复之前程序出错了，怎么办？我们要为这段代码加一个异常处理机制。到这里我们就可以请出今天的主角了—— save-excursion 。这是一个用C实现的底层函数，用于保证在任何情况下都能恢复现场。你可以将它理解为底层通过try catch 包装了的 push-mark 和 pop-mark。根据这点我们可以知道它需要注意的点：它只用来还原光标现场，而不会还原中间对文本执行的插入、删除操作避免在大的循环中使用，多次进行 push-mark和 pop-mark 会不断制造和销毁临时的marker资源，影响性能它的定义如下:(save-excursion &rest BODY)我们可以将上面的例子做一个改动(defun my/test-mark() (interactive) (save-excursion (goto-char (point-min)) (insert "this is a test for marker")))有了这个函数，我们能从繁琐的现场保存与恢复中解放出来，将注意力集中在具体功能的实现上。练习这次的练习比较简单，我们就简单的为上一次的复制行的函数加一个恢复现场的功能(defun my/duplicate-current-line() (interactive) (save-excursion (let ((line-next (buffer-substring (line-beginning-position) (line-end-position)))) (goto-char (line-end-position)) (newline) (insert line-next))))总结本篇我们讨论了Emacs中保护和还原现场，提到了 marker 和 point。同时也引入了 save-excursion 来保护和还原现场。既然本篇章提到了 marker，Emacs中 marker 和 point 组成了一个很重要的概念—— region。一般我们叫它选区，也就是在编辑器中我们看到的用户选中区域。这部分内容将在后面进行介绍。