Emacs Lisp编程实践——interactive的几种基本用法

在Emacs Lisp中,一个函数如果被定义为interactive的,那么它就可以通过M-xexecute-extened-command)进行调用,这样的函数也称为命令command)。

简而言之,interactive提供了一种让使用者可以交互式输入参数、调用函数的途径,本文就来探讨一下interactive的常见用法。

约定

本文用M-x hello RET表示使用execute-extened-command函数执行一个名为hellointeractive函数并按回车键,用=>表示输出调用结果,用C-u表示输入universal argument(前缀参数)。

下面是一个完整的例子:

C-u 7 M-x hello RET => hello, world!

表示先输入一个前缀参数7,然后执行了一个名为hello的函数,然后按回车键,得到输出结果为hello, world!

用法1:最简单的用法

(defun hello ()
  "Just say hello."
  (interactive)
  (message "Hello!"))

执行函数helloM-x hello RET => Hello!

用法2:传入一个交互式输入的参数

(defun hello2 (name)
  "Say hello to a person."
  (interactive "sPlease input person name: ")
  (message "Hello, %s!" name))

这个函数支持在minibuffer交互式输入一个参数,执行函数hello2M-x hello2 RET John RET => Hello, John!

用法3:传入多个交互式输入的参数

(defun hello3 (name age country)
  "Say hello to a person with more info."
  (interactive "sPlease input name: \nnage: \nscountry: ")
  (message "Hello, %s! age is: %d, country is: %s" name age country))

执行函数hello3M-x hello3 RET Tom RET 20 RET USA RET => Hello, Tom! age is: 20, country is: USA

用法4:传入region的起、始位置

(defun hello-use-region (start end)
  "Say hello, with output region info."
  (interactive "r")
  (message "Hello! region start: %d, end: %d" start end))

这种用法可以用于写一个操作选中的文本区域(region)的函数。

先选中一个区域,然后执行hello-use-region函数:M-x hello-use-region RET => Hello! region start: 1, end: 10

用法5:传入一个list参数

(defun hello-use-list-input (num1 num2 num3)
  "Say hello, with input list."
  (interactive
   (let ((nums (list 1 2 3)))
     ;; here cannot use num1, num2 or num3 directly
     (mapcar '1+ nums)))
  (message "Hello! 1+1=%d, 2+1=%d, 3+1=%d" num1 num2 num3))

这种用法要注意的是:在interactive语句块内部不能直接使用函数的入参(在这个例子中就是num1, num2和num3),否则会报错。

执行hello-use-list-input函数:M-x hello-use-list-input RET => Hello! 1+1=2, 2+1=3, 3+1=4

用法6:传入一个前缀参数

(defun hello-with-universal-arg (arg)
  "Say hello with input universal arg."
  (interactive "p")
  (message "Hello! universal arg = %s" arg))

前缀参数又叫做universal argument,用C-u快捷键输入,可以用于方便地给一个函数传入一个整形参数(可以为整数也可以为负数,如果不传,默认值是1)。

执行hello-with-universal-arg函数,不传入前缀参数:M-x hello-with-universal-arg RET => Hello! universal arg = 1

传入前缀参数:C-u -77 M-x hello-with-universal-arg RET => Hello! universal arg = -77

总结

本文总结了interactive的六种常见用法,可以满足大部分场景的需求,还有更多的用法可以通过C-h f interactive来查看文档。

你可能感兴趣的:(Emacs Lisp编程实践——interactive的几种基本用法)