Emacs Lisp编程实践——同时支持操作字符串、region或thing-at-point

参考：http://ergoemacs.org/emacs/elisp_command_working_on_string_or_region.html

在使用elisp（Emacs Lisp）编程的时候，有时会需要写这样一类函数，同时支持操作传入的字符串，或当前选中的region，或当前光标所在处的单词。本文就探讨怎样实现这样一个函数。

下面的my-org-delete-text函数就可以实现这样一个功能：在org-mode删除传入的字符串、选中的region或光标处的字符串（即在区域的首、尾各插入一个+字符），代码中有详细的注释，理解起来应该难度不大：

(defun my-org-delete-text (str &optional from to)
  "org-mode删除一个字符串，按照org-mode的语法，即在字符串的首、尾各插入一个`+'号。
支持在代码中调用该函数删除一个字符串，或interactive调用该函数，可以删除当前选中的region、或当前所在位置的单词。"
  (interactive
   ;; 判断当前是否选中了一个region，如果选中则获取region的起、始位置，并赋值给from、to；如果没有选中region则获取当前单词的起、始位置并赋值给from、to
   (if (use-region-p)
       (list nil (region-beginning) (region-end))
     (let ((bounds (bounds-of-thing-at-point 'word)))
       (list nil (car bounds) (cdr bounds)))))
  ;; 设置一个标志变量use-str-p，用于后续判断是否要操作region
  (let (use-str-p input-str output-str)
    (setq use-str-p (if str t nil))
    ;; 设置输入字符串的值，如果输入的字符串不为空，则设置为开始位置为from、结束位置为to的region的值
    (if use-str-p
    (setq input-str str)
      (setq input-str (buffer-substring-no-properties from to)))
    (setq output-str (concat " +" input-str "+ "))
    ;; 如果输入的字符串不为空，则直接返回output-str
    (if use-str-p output-str
              ;; 如果输入的字符串为空，则改变from到to这个范围内的region字符串的值为output-str
      (progn
        (save-excursion
      (delete-region from to)
      (goto-char from)
      (insert output-str))
        (goto-char (+ to 4))))))
;; 将my-org-delete-text函数绑定到org-mode-hook并设置快捷键
(add-hook 'org-mode-hook
      (lambda ()
        (local-set-key (kbd "C-c d") 'my-org-delete-text)))

上面的代码可以直接拿来放在Emacs配置文件中，加载之后在org-mode只需按C-c d快捷键就可以删除指定的区域。

受上面函数的启发，来扩展一下思路，除了删除一个区域之外，在org-mode还经常有这样的诉求：把一个区域引用起来（即在区域的首、尾各插入一个~字符），下面继续来写一个函数my-org-insert-str-to-head-tail来完成这样场景的诉求：

(defun my-org-insert-str-to-head-tail (flag)
  "操作一个region，或光标所在处的单词，在其首、尾各插入一个字符。
如果flag为`d'，则在操作区域的首、尾各插入一个`+'字符，用于org-mode删除字符串；
如果flag尾`q'，则在操作区域的首、尾各插入一个`~'字符，用于org-mode引用一段代码。"
  (interactive "sPlease input operate flag(`d' for delete a string, `q' for quote a string): ")
  (let (from to input-str output-str)
    ;; 如果当前选中了region，则操作region
    (if (use-region-p)
    (progn
      (setq from (region-beginning))
      (setq to (region-end))
      (setq input-str (buffer-substring-no-properties from to)))
      ;; 如果当前没有选中region，则操作光标所在处的单词
      (progn
    (setq bounds (bounds-of-thing-at-point 'word))
    (setq from (car bounds))
    (setq to (cdr bounds))
    (setq input-str (buffer-substring-no-properties from to))))
    ;; 根据命令标志flag值的不同，插入不同的字符串
    (cond
     ((string-equal flag "d") (setq output-str (concat " +" input-str "+ ")))
     ((string-equal flag "q") (setq output-str (concat " ~" input-str "~ "))))
    ;; 操作字符串区域
    (progn
      (delete-region from to)
      (goto-char from)
      (insert output-str)
      (goto-char (+ to 4)))))
;; 绑定my-org-insert-str-to-head-tail函数到org-mode-hook并设置快捷键
(add-hook 'org-mode-hook
      (lambda ()
        (local-set-key (kbd "C-c a") 'my-org-insert-str-to-head-tail)))

将上述代码放到Emacs配置文件，加载之后，就可以使用快捷键C-c a方便地删除或引用指定的区域了。如果后续还想快速插入其他字符，也可以方便地修改代码来满足需求。