2025-01-03    2025-01-23    4886 字  10 分钟
OLs

最近配置 [[Rime_JK 指尖上的旋律|Rime]] 的时候遇到了不少 lua 脚本,加上比较流行的 Neovim 也是使用的这个嵌入式脚本,Java 和一些游戏中也使用了这个脚本语言……

![[assets/Pasted image 20250103183548.png|500]]

这难免让人想要多了解一下她,不是吗?所以,让我们开始吧 🎉

📘 Lua 5.3 参考手册
📗 Lua 教程 | 菜鸟教程

这里我们以实用性为中心,简要了解一下其基本用法 ~

基本概念

注释 以两个连字符 -- 开头。

1
2
3
4
5
6
-- 单行注释

--[[
 多行注释
 多行注释
 --]]

标识符 以一个字母 A-Za-z 或下划线 _ 开头后加上 0 个或多个字母,下划线,数字(0 到 9),且区分大小写。

⚠️ Lua 不允许使用特殊字符如 @$, 和 % 来定义标识符。

Lua 中有 8 个 基本类型 分别为: nilbooleannumberstringuserdatafunctionthread table

可以使用 type 函数测试给定变量或者值的类型。

字符串 由一对双引号或单引号来表示,可以用 2 个方括号 [[]] 来表示"一块"字符串。字符串连接使用的是 .. ,使用 # 来计算字符串的长度,放在字符串前面,如:#"www.runoob.com"

在 Lua 里,table 的创建是通过"构造表达式"来完成,其实是一个"关联数组"(associative arrays),数组的索引可以是数字或者是字符串。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
-- 创建一个空的 table
local tbl1 = {}
 
-- 直接初始表
local tbl2 = {"apple", "pear", "orange", "grape"}
local tal3 = {key1="val1",key2="val2"}

-- 使用 for...in 来遍历
for k, v in pairs(a) do  
    print(k .. " : " .. v)  
end

对 table 的索引使用方括号 [],也提供了 . 操作。

userdata 是一种用户自定义数据,用于表示一种由应用程序或 C/C++ 语言库所创建的类型,可以将任意 C/C++ 的任意数据类型的数据(通常是 struct 和 指针)存储到 Lua 变量中调用。

Lua 变量 有三种类型:全局变量、局部变量、表中的域。

⚠️ Lua 中的变量全是全局变量,哪怕是语句块或是函数里,除非用 local 显式声明为局部变量。

局部变量的作用域为从声明位置开始到所在语句块结束。默认值均为 nil

Lua 语言提供了以下几种循环处理方式:

while (条件) do...end;
for...do...end;
repeat...until (条件);

可以使用 break 退出当前循环,也可以使用 goto 将程序的控制点转移到一个标签处。

Lua 提供了以下控制结构语句:

if (条件) then ... end
if ... else ...
if ... else if ...

在 Lua 中,函数 是对语句和表达式进行抽象的主要方法。可以返回多个值,每个值以逗号隔开。

Lua 提供了以下几种运算符类型:

  • 算术运算符
  • 关系运算符
  • 逻辑运算符
  • 其他运算符(.. 连接字符串,# 返回字符串或表的长度)

大多数与其它编程语言大同小异,其中使用 ~= 表示不等于,而非 !=

字符串

:: 字符串、数组、表是最最常用的数据结构了。

在 Lua 中,字符串可以使用以下三种方式来表示:

- 单引号间的一串字符
- 双引号间的一串字符
- [[ 与 ]] 间的一串字符

要计算字符串的长度(即字符串中字符的个数),包含中文的一般用 utf8.lenstring.len 函数用于计算只包含 ASCII 字符串的长度。

我们主要来看一下字符串的相关操作。

字符串截取

string.sub(s, i [, j])

其中:

  • s 表示要截取的字符串;
  • i 截取开始的位置;
  • j 截取结束的位置,默认为 -1 - 最后一个字符。

字符串替换

string.gsub(mainString,findString,replaceString,num)

在字符串中替换,其中:

  • mainString 为要操作的字符串;
  • findString 为被替换的字符;
  • replaceString 为要替换的字符;
  • num 替换次数(可以忽略,忽略则全部替换)。
1
2
string.gsub("aaaa", "a", "z", 3);
--- zzza    3

字符串查找(匹配)

¹ 返回匹配子串的索引位置

在一个指定的目标字符串 str 中搜索指定的内容 substr,如果找到了一个匹配的子串,就会返回这个子串的起始索引和结束索引,不存在则返回 nil

string.find (str, substr, [init, [plain]])

其中:

  • str 目标字符串(要在这个字符串中搜索);
  • substr 要匹配的子串;
  • init 搜索的起始位置,默认为 1,可以是一个负数,表示从后往前的字符个数;
  • plain ,默认为 false ,表示使用正则模式匹配;true 表示只作简单的查找子串的操作。
1
2
string.find("Hello Lua user", "Lua", 1) 
-- 7    9

² 返回匹配的子串

string.match(str, pattern, init)

string.match() 只寻找源字符串 str 中的第一个配对,参数 init 可选, 指定搜寻过程的起点, 默认为 1

在成功匹配时,函数将返回配对表达式中的所有捕获结果;如果没有设置捕获标记,则返回整个配对字符串。

如果没有成功的配对呢?返回 nil

1
2
3
4
5
string.match("I have a questions for you.", "%d+ %a+")
-- 2 questions

string.format("%d, %q", string.match("I have 2 questions for you.", "(%d+) (%a+)"))
-- 2, "questions"

³ 返回迭代器函数

那么, string.gmatch() 呢?

string.gmatch(str, pattern)

它并不返回字符串,而是返回一个迭代器函数,每一次调用这个函数,返回一个在字符串 str 找到的下一个符合 pattern 描述的子串。如果参数 pattern 描述的字符串没有找到,迭代函数返回 nil

1
2
3
4
5
6
7
for word in string.gmatch("Hello Lua user", "%a+") do
  print(word)
end

--- Hello
--- Lua
--- user

匹配模式

Lua 中的匹配模式直接用常规的字符串来描述,它用于模式匹配函数 string.findstring.matchstring.gmatchstring.gsub

还可以在模式串中使用字符类。什么是 字符类 呢?

字符类指可以匹配一个特定字符集合内任何字符的模式项,比如,字符类 %d 匹配任意数字。下面的表列出了 Lua 支持的所有字符类:

单个字符(除 ^$()%.[]*+-? 外): 与该字符自身配对

- .(点): 与任何字符配对
- %a: 与任何字母配对
- %c: 与任何控制符配对(例如\n)
- %d: 与任何数字配对
- %l: 与任何小写字母配对
- %p: 与任何标点(punctuation)配对
- %s: 与空白字符配对
- %u: 与任何大写字母配对
- %w: 与任何字母/数字配对
- %x: 与任何十六进制数配对
- %z: 与任何代表 0 的字符配对
- %x(此处x是非字母非数字字符): 与字符x配对. 主要用来处理表达式中有功能的字符(^$()%.[]*+-?)的配对问题, 例如%%与%配对
- [数个字符类]: 与任何[]中包含的字符类配对. 例如[%w_]与任何字母/数字, 或下划线符号(_)配对
- [^数个字符类]: 与任何不包含在[]中的字符类配对. 例如[^%s]与任何非空白字符配对

% ’ 用作特殊字符的转义字符,因此 ’ %. ’ 匹配点;’ %% ’ 匹配字符 ’ % ‘。转义字符 ’ % ‘不仅可以用来转义特殊字符,还可以用于所有的非字母的字符。

模式条目可以是:

  • 单个字符类匹配该类别中任意单个字符;
  • 单个字符类跟一个 ’ * ‘, 将匹配零或多个该类的字符。 这个条目总是匹配尽可能长的串;
  • 单个字符类跟一个 ’ + ‘, 将匹配一或更多个该类的字符。 这个条目总是匹配尽可能长的串;
  • 单个字符类跟一个 ’ - ‘, 将匹配零或更多个该类的字符。 和 ’ * ’ 不同, 这个条目总是匹配尽可能短的串;
  • 单个字符类跟一个 ’ ? ‘, 将匹配零或一个该类的字符。 只要有可能,它会匹配一个;
  • %n, 这里的 n 可以从 1 到 9; 这个条目匹配一个等于 n 号捕获物(后面有描述)的子串。
  • %bxy, 这里的 x 和 y 是两个明确的字符; 这个条目匹配以 x 开始 y 结束, 且其中 x 和 y 保持平衡的字符串。 意思是,如果从左到右读这个字符串,对每次读到一个 x 就 +1 ,读到一个 y 就 -1, 最终结束处的那个 y 是第一个记数到 0 的 y。 举个例子,条目 %b() 可以匹配到括号平衡的表达式。
  • %f[set], 指 边境模式; 这个条目会匹配到一个位于 set 内某个字符之前的一个空串, 且这个位置的前一个字符不属于 set 。 集合 set 的含义如前面所述。 匹配出的那个空串之开始和结束点的计算就看成该处有个字符 ’ \0 ’ 一样。

:: 哎哎呀,都什么乱七八糟的 👻

模式 指一个模式条目的序列。 在模式最前面加上符号 ^ 将锚定从字符串的开始处做匹配。 在模式最后面加上符号 $ 将使匹配过程锚定到字符串的结尾。 如果 ^$ 出现在其它位置,它们均没有特殊含义,只表示自身。

模式可以在内部用小括号括起一个子模式; 这些子模式被称为 捕获物

当匹配成功时,由捕获物匹配到的字符串中的子串被保存起来用于未来的用途。 捕获物以它们左括号的次序来编号。

例如,对于模式 “(a*(.)%w(%s*))” , 字符串中匹配到 “a*(.)%w(%s*)” 的部分保存在第一个捕获物中 (因此是编号 1 ); 由 “.” 匹配到的字符是 2 号捕获物, 匹配到 “%s*” 的那部分是 3 号。

作为一个特例,空的捕获 () 将捕获到当前字符串的位置(它是一个数字)。 例如,如果将模式 “()aa()” 作用到字符串 “flaaap” 上,将产生两个捕获物: 35

字符串格式化

Lua 提供了 string.format() 函数来生成具有特定格式的字符串, 函数的第一个参数是格式 , 之后是对应格式中每个代号的各种数据。

  • %c - 接受一个数字, 并将其转化为 ASCII 码表中对应的字符;
  • %d, %i - 接受一个数字并将其转化为有符号的整数格式;
  • %f - 接受一个数字并将其转化为浮点数格式;
  • %q - 接受一个字符串并将其转化为可安全被 Lua 编译器读入的格式;
  • %s - 接受一个字符串并按照给定的参数格式化该字符串。

数组

在 Lua 中,数组不是一种特定的数据类型,而是一种用来存储一组值的数据结构。实际上,Lua 中并没有专门的数组类型,而是使用一种被称为 “table” 的数据结构来实现数组的功能。

⚠️ 在 Lua 索引值是以 1 为起始,但你也可以指定 0 开始。

一维数组可以用 for 循环出数组中的元素,如下实例:

1
2
3
4
5
6
7
-- 创建一个数组
local myArray = {10, 20, 30, 40, 50}

-- 循环遍历数组
for i = 1, #myArray do
    print(myArray[i])
end

表 table

table 是 Lua 的一种数据结构用来帮助我们创建不同的数据类型,如:数组、字典等。

下面来看一些 Table 的常见操作:

❶ 连接

table.concat (table [, sep [, start [, end]]]):

table.concat() 函数列出参数中指定 table 的数组部分从 start 位置到 end 位置的所有元素, 元素间以指定的分隔符(sep)隔开。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
fruits = {"banana","orange","apple"}
-- 返回 table 连接后的字符串
print("连接后的字符串 ",table.concat(fruits))
-- 连接后的字符串     bananaorangeapple

-- 指定连接字符
print("连接后的字符串 ",table.concat(fruits,", "))
-- 连接后的字符串     banana, orange, apple

-- 指定索引来连接 table
print("连接后的字符串 ",table.concat(fruits,", ", 2,3))
-- 连接后的字符串     orange, apple

❷ 插入和移除

table.insert (table, [pos,] value)

table 的数组部分指定位置(pos)插入值为 value 的一个元素, pos 参数可选, 默认为数组部分末尾。

table.remove (table [, pos])

返回 table 数组部分位于 pos 位置的元素. 其后的元素会被前移。pos 参数可选, 默认为 table 长度, 即从最后一个元素删起。

❸ 排序

table.sort (table [, comp])

对给定的 table 进行升序排序。

文件 IO

Lua I/O 库用于读取和处理文件,分为简单模式(和 C 一样)、完全模式。

简单模式,拥有一个当前输入文件和一个当前输出文件,并且提供针对这些文件相关的操作。

完全模式,使用外部的文件句柄来实现。它以一种面对对象的形式,将所有的文件操作定义为文件句柄的方法。

简单模式在做一些简单的文件操作时较为合适,但在进行一些高级的文件操作的时候,就显得力不从心。如要同时读取多个文件这样的操作,使用完全模式则较为合适。

打开文件操作语句如下:

file = io.open(filename [, mode])

mode 的值有哪些呢?

- r  以只读方式打开文件(文件必须存在)
- w  以只写方式打开文件
- a  以附加方式打开只写文件
- r+ 以读写方式打开文件(文件必须存在)
- w+ 以读写方式打开文件
- a+ 以读写方式附加文件
- b  以二进制模式
- +  表示对 文件既可以读,也可以写

简单模式

简单模式使用标准的 I/O 或使用一个当前输入文件和一个当前输出文件。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
-- 以只读方式打开文件
ifile = io.open("input.lua", "r")
-- 设置默认输入文件为 input.lua
io.input(file)
-- 输出文件第一行
print(io.read())
-- 关闭打开的文件
io.close(file)

-- 以附加方式打开只写文件
ofile = io.open("output.lua", "a")
-- 设置默认输出文件为 output.lua
io.output(file)
-- 在文件最后一行添加 Lua 注释
io.write("-- output.lua 文件末尾注释")
-- 关闭打开的文件
io.close(file)

下面来看一些常用的 io 方法:

¹ io.read() 用来输出文件的一行,它也可以传入参数。

*n       - 读取一个数字并返回它,如 file.read("*n")
*a       - 从当前位置读取整个文件,如 file.read("*a")
*|       - (默认值)读取下一行,在文件尾(EOF)处返回 nil
number   - 返回一个指定字符个数的字符串,或在 EOF 时返回 nil

² io.tmpfile() 返回一个临时文件句柄,该文件以更新模式打开,程序结束时自动删除。

³ io.type(file) 检测 obj 是否一个可用的文件句柄。

io.flush() 向文件写入缓冲中的所有数据。

io.lines(optional file name) 返回一个迭代函数,每次调用将获得文件中的一行内容,到文件末尾时返回 nil,但不关闭文件。

完全模式

通常我们需要在同一时间处理多个文件。我们需要使用 file:function_name 来代替 io.function_name 方法。

1
2
3
4
5
6
7
ifile = io.open("input.lua", "r")
print(ifile:read())
ifile:close()

ofile = io.open("output.lua", "a")
ofile:write("--test")
ofile:close()

其中,read 的参数与简单模式一致。它还有以下几个常见的方法:

¹ file:seek(optional whence, optional offset) 设置和获取当前文件位置,成功则返回最终的文件位置(按字节),失败则返回 nil 加错误信息。其中,whence 值可以是:

- set    从文件头开始
- cur    从当前位置开始(默认)
- end    从文件尾开始
- offset 默认为 0

不带参数 file:seek() 则返回当前位置, file:seek("set") 则定位到文件头, file:seek("end") 则定位到文件尾并返回文件大小。

² file:flush() 向文件写入缓冲中的所有数据。

³ io.lines(optional file name) 打开指定的文件 filename 为读模式并返回一个迭代函数,每次调用将获得文件中的一行内容,当到文件尾时,将返回 nil ,并自动关闭文件。

不带参数时 io.lines() <=> io.input():lines(); 读取默认输入设备的内容,但结束时不关闭文件。