Programming in Emacs Lisp笔记(三)编写函数

本文介绍了在Emacs Lisp中编写函数的原理和方法,包括defun的使用、函数参数、文档字符串、交互式函数的实现以及save-excursion等常见功能。通过示例展示了如何定义和安装函数,以及如何修改和调用函数,强调了函数参数的私有性和交互式函数的使用方式。
摘要由CSDN通过智能技术生成


编写函数
关于基本函数(Primitive Function)

除了少数C编写的基本函数外,所有的函数都是由其它函数语句定义的。当编写自己函数时,C所编写的函数与Emacs Lisp编写的函数看起来是一样的。

除非你想去考究,否则不需要知道知道一个函数是用Emacs Lisp编写的还是C编写的。
defun

在一个函数的定义中,在defun关键字后面有5个部分:

   1. 函数符号的名称
   2. 传递给函数的参数列表,如果没有参数则传递给函数的是一个空列表,()
   3. 描述函数的文档字符串。(可选)
   4. 当用户按M-x func_name以交互方式运行函数时的提示信息;或按键组合。(可选)
   5. 函数体

模板

(defun function-name (arguments...)
    "optional-documentation..."
    (interactive argument-passing-info) ; optional
    body...)

一个实例(非交互)

(defun multiply-by-seven (number)
  "Multiply NUMBER by seven."
  (* 7 number))

函数参数列表中的变量名对每个函数是私有的,不同函数的参数名可以相同。

参数列表后面是描述函数功能的文档字符串。也就是按C-h f name_of_function时所看到的信息。

在调用的时候使用

(multiply-by-seven 3)

尽管传递给函数的参数外面没有加括号。但函数能计算出来。

当对这个表达式求值时将出错。这是因为我们只编写了函数定义,但并未告诉机器在Emacs中安装(install/load)这个函数定义。
安装函数定义

将光标停留上节所写的函数定义的最后一个括号后面,按C-x C-e。这时回显区将显示multiply-by-seven(这表示函数定义被计算,计算的返回值是所定义的函数的名字)。这时函数就已经安装好,可以在像使用Emacs中其它函数一样使用了。
安装后的效果

可以在

(multiply-by-seven 3)

的最后一个括号后按C-x C-e,回显区将显示计算结果21。还可以查看函数帮助文档。按C-h f(describe-function) function_name,multiply-by-seven。y
修改函数定义

可以直接修改函数的定义,然后重新把光标停留在在函数定义的最后一个括号后面按C-x C-e。
制作交互式函数

用户可以通过按键或者M-x 函数名来调用。
交互式函数multiply-by-seven预览

交互式版本的multiply-by-seven:

(defun multiply-by-seven (number)
  "Multiply NUMBER by seven."
  (interactive "p")
  (message "The result is %d" (* 7 number)))

安装上面的函数后,可以使用C-u number参数,然后输入M-x multiply-by-seven然后回车。回显区将显示计算结果。

调用这个函数的两种方法:

   1. 输入前缀参数,然后输入M-x和函数名,比如C-u 3 M-x forward-sentence

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值