Emacs Helm: 使用关键字搜索、获取、执行任何东西

Helm 是一个emacs的软件包,定义了一个通用框架,交互式地、动态缩减式地使用关键字选择、获取、执行任何东西。比如:

  • 执行emacs 命令
  • 打开文件
  • 查看man文档
  • 执行grep操作
  • 执行apt命令
  • 相看imenu函数定义
  • 切换buffer

Helm软件包本身包含两部分,框架本身及应用。以上列表均为应用。基于框架,可以轻松创建新的应用。

基本原理

Helm的三个重要概念:candidate, narrowing, action.

Candidate

Candidate即候选值,是一个列表,保存所有可供选择的条目。对于打开文件的命令,candidate是所有的文件名称的列表。

Narrowing

Helm命令启动后,用户未输入任何关键字前,会将candidate中的所有条目显示出来,每行显示一个项,可通过'C-n', 'C-p'上下移动光标选择当前条目。

如果candidate的数目较少,此时没必要输入关键字,通过上下移动光标选择就行了;但如果candidate数目较多,目标条目没有被显示在第一页,可输入关键字,对candidate的条目进行筛选,只有匹配到关键字的条目才会被显示出来。这就是narrowing。

值得一提的是,这个过程是动态的,即每输入一个字符,candidate的条目都会被重新筛选。有时只输入了一个字符,目标条目已经显示在第一页,则可停止输入,通过移动光标选择当前条目;有时输入了一个关键字,目标条目仍然没有出现,则可按空格,继续输入另一个关键字,进行更精确的筛选,直到目标条目出现为止。

输入的关键字越多,candidate的数目会越少,目标条目出现在第一页第一个条目位置的机率就越大,进而选择也就越方便。

Action

当一个candidate被选中后,按下Enter后,就会有一个action被执行。对于打开文件,其action对应到emacs命令就是'find-file'。可以为一个条目定义多个action,如对于文件条目action可以为打开文件、重命令文件、删除文件等。 通过TAB键从多个action中选择,如果直接按Enter会执行第一个action.

定义一个新的helm应用

基本例子

要定义一个新的helm命令,只需定义一个变量指定candidate及对应的action,然后将其作为参数传给helm就可以了,以下为一个例子。

(setq some-helm-source
      '((name . "HELM at the Emacs")
        (candidates . (1 2 3 4))
        (action . (lambda (candidate)
                    (message-box "%s" candidate)))))

(helm :sources '(some-helm-source))

其中定义candidate、action的变量叫做source, 是一个assoc list。candidates是一个list, action是一个函数,action函数被调用时,当前选择的candidate会被作为参数传入。

定义多个action

上面的例子中action的值为一个匿名函数,如果要定义多个action,则需要将action的值设置为一个list,list的元素是一个cons:(说明 . 函数)。如下所示,定义了两个action。

(setq some-helm-source
      '((name . "HELM at the Emacs")
        (candidates . (1 2 3 4))
        (action .
                (("Display" .  (lambda (candidate)
                                 (message-box "%s" candidate)))
                 ("None" . identify)
                 ))
        ))
(helm :sources '(some-helm-source))

将candidate的选择值与真实值分离

有时候需要通过不同的值选择candidate,此时可将candidates设置为cons (KEY . VALUE)的list。其中KEY将用于选择,VALUE将作为action函数的输入参数值。

(setq some-helm-source
      '((name . "HELM at the Emacs")
        (candidates . (("one" . 1) 2 ("three" . 3) 4))
        (action .
                (("Display" .  (lambda (candidate)
                                 (message-box "%s" candidate)))
                 ("None" . identify)
                 ))
        ))
(helm :sources '(some-helm-source))

动态candidate

有时candidates需要动态计算,或者静态计算量会很大,此时可将candidates设置为一个函数,这个函数将被用于计算所有candidates的值。

(defun random-candidates ()
  "Return a list of 4 random numbers from 0 to 10"
  (loop for i below 4 collect (random 10)))

(setq some-helm-source
      '((name . "HELM at the Emacs")
        (candidates . random-candidates)
        (action . (lambda (candidate)
                    (message "%s" candidate)))))

(helm :sources '(some-helm-source))

添加一个persistent action

Persistent action是指执行action后,不退出helm,类似于预览功能,默认绑定在\C-z。通过'persistent-action'来指定,如果未指定,则与第一个action一样。

(setq some-helm-source
      '((name . "HELM at the Emacs")
        (candidates . (1 2 3 4))
        (persistent-action . (lambda (candidate) (message "%s" candidate)))
        (action . (lambda (candidate)
                    (message-box "%s" candidate)))))

(helm :sources '(some-helm-source))

helm-org-headlines的定义

这个命令由helm默认提供,其定义如下,可为实现新的命令提供参考。

(setq helm-source-org-headline
      `((name . "Org Headline")
        (headline
         ,@(mapcar
            (lambda (num)
              (format "^\\*\\{%d\\} \\(.+?\\)\\([ \t]*:[a-zA-Z0-9_@:]+:\\)?[ \t]*$"
                      num))
            (number-sequence 1 8)))
        (condition . (eq major-mode 'org-mode))
        (migemo)
        (subexp . 1)
        (persistent-action . (lambda (elm)
                               (helm-action-line-goto elm)
                               (org-cycle)))
        (action-transformer
         . (lambda (actions candidate)
             '(("Go to line" . helm-action-line-goto)
               ("Refile to this headline" . helm-org-headline-refile)
               ("Insert link to this headline"
                . helm-org-headline-insert-link-to-headline))))))

(defun helm-org-headlines ()
  "Preconfigured helm to show org headlines."
  (interactive)
  (helm-other-buffer 'helm-source-org-headline "*org headlines*"))

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏北京马哥教育

Linux自动化运维工具之ansible(二)

糖豆贴心提醒,本文阅读时间8分钟 YAML简介 YAML是一个可读性高的用来表达资料序列的格式。 YAML参考了其他多种语言,包括:XML、C语言、Pytho...

2686
来自专栏IMWeb前端团队

hapi vs. express [1] —— 路由

hapi vs. express [1] —— 路由 前言 express 与 hapi 是两个基于 nodejs 的 web server 开发框架,它们由于...

2005
来自专栏Django Scrapy

1.1 django model的增删改(1)

1585
来自专栏Java编程技术

白话网络通讯

无论你是纯socket通讯,还是应用层的http,Rpc协议进行通讯,本质底层都是传输二进制流

771
来自专栏Python绿色通道

Python的线程

Python的标准库提供了两个模块: thread 和threading,thread 是低级模块,threading是高级模块,对thread 进行了封装。绝...

1223
来自专栏我的博客

TP入门第七天

Trace信息无法显示,因为信息需要显示在body体内 1、创建数据 我们在php的action里面当然也可以使用$_POST以及$_GET获取变量,而TP提供...

2834
来自专栏轻量级微服务

微服务下跨语言 RPC 实现

目前主流的 Java 开发框架 Spring Boot,为了更方便集成 gRPC,自己开发了 spring-boot-starter-grpc,仅需简单的几行配...

1883
来自专栏思考的代码世界

Python基础学习09天

1616
来自专栏Core Net

ASP.NET Core 2.0 : 七.一张图看透启动背后的秘密

3555
来自专栏耕耘实录

几个Linux命令及脚本使用中的奇淫巧技

版权声明:本文为耕耘实录原创文章,各大自媒体平台同步更新。欢迎转载,转载请注明出处,谢谢

812

扫码关注云+社区