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方便地删除或引用指定的区域了。如果后续还想快速插入其他字符,也可以方便地修改代码来满足需求。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容