xmake-docs/docs/zh/api/scripts/builtin-modules/path.md

path

路径操作模块，实现跨平台的路径操作，这是 xmake 的一个自定义的模块。

path.new

• 创建新的路径实例

函数原型

::: tip API

path.new(p: <string>, transform?: <function>)

:::

参数说明

参数	描述
p	必需。路径字符串
transform	可选。路径转换函数

返回值说明

类型	描述
path	返回路径实例

用法说明

创建一个路径实例：

local p = path.new("/tmp/file.txt")
print(p:filename())  -- 输出: file.txt

使用转换函数：

local p = path.new("/tmp/a", function (raw_path)
    return "--key=" .. raw_path
end)
print(p:str())      -- 输出: --key=/tmp/a
print(p:rawstr())   -- 输出: /tmp/a

也可以直接调用构造函数：

local p = path("/tmp/file.txt")  -- 自动创建实例
print(p:filename())

path.normalize

• 规范化路径

函数原型

::: tip API

path.normalize(p: <string>)

:::

参数说明

参数	描述
p	必需。路径字符串

返回值说明

类型	描述
string	返回规范化后的路径字符串

用法说明

规范化路径（简化 . 和 ..）：

print(path.normalize("/tmp/./../file.txt"))  -- 输出: /file.txt
print(path.normalize("c:\\tmp\\..\\.."))     -- 在 Windows 上输出: c:\\..

path.join

• 拼接路径

函数原型

::: tip API

path.join(paths: <string|array>, ...)

:::

参数说明

参数	描述
paths	路径字符串或数组
...	可变参数，可传递多个路径字符串

用法说明

将多个路径项进行追加拼接，由于windows/unix风格的路径差异，使用api来追加路径更加跨平台，例如：

print(path.join("$(tmpdir)", "dir1", "dir2", "file.txt"))

上述拼接在unix上相当于：$(tmpdir)/dir1/dir2/file.txt，而在windows上相当于：$(tmpdir)\\dir1\\dir2\\file.txt

如果觉得这样很繁琐，不够清晰简洁，可以使用：path.translate方式，格式化转换路径字符串到当前平台支持的格式。

path.translate

• 转换路径到当前平台的路径风格

函数原型

::: tip API

path.translate(path: <string>)

:::

参数说明

参数	描述
path	要转换的路径字符串

用法说明

格式化转化指定路径字符串到当前平台支持的路径风格，同时支持windows/unix格式的路径字符串参数传入，甚至混合传入，例如：

print(path.translate("$(tmpdir)/dir/file.txt"))
print(path.translate("$(tmpdir)\\dir\\file.txt"))
print(path.translate("$(tmpdir)\\dir/dir2//file.txt"))

上面这三种不同格式的路径字符串，经过translate规范化后，就会变成当前平台支持的格式，并且会去掉冗余的路径分隔符。

path.basename

• 获取路径最后不带后缀的文件名

函数原型

::: tip API

path.basename(path: <string>)

:::

参数说明

参数	描述
path	路径字符串

用法说明

print(path.basename("$(tmpdir)/dir/file.txt"))

显示结果为：file

path.filename

• 获取路径最后带后缀的文件名

函数原型

::: tip API

path.filename(path: <string>)

:::

参数说明

参数	描述
path	路径字符串

用法说明

print(path.filename("$(tmpdir)/dir/file.txt"))

显示结果为：file.txt

path.extension

• 获取路径的后缀名

函数原型

::: tip API

path.extension(path: <string>)

:::

参数说明

参数	描述
path	路径字符串

用法说明

print(path.extension("$(tmpdir)/dir/file.txt"))

显示结果为：.txt

path.directory

• 获取路径的目录名

函数原型

::: tip API

path.directory(path: <string>)

:::

参数说明

参数	描述
path	路径字符串

用法说明

print(path.directory("$(tmpdir)/dir/file.txt"))

显示结果为：$(tmpdir)/dir

path.relative

• 转换成相对路径

函数原型

::: tip API

path.relative(path: <string>, rootdir: <string>)

:::

参数说明

参数	描述
path	要转换的路径字符串
rootdir	相对转换的根目录

用法说明

print(path.relative("$(tmpdir)/dir/file.txt", "$(tmpdir)"))

显示结果为：dir/file.txt

第二个参数是指定相对的根目录，如果不指定，则默认相对当前目录：

os.cd("$(tmpdir)")
print(path.relative("$(tmpdir)/dir/file.txt"))

这样结果是一样的。

path.absolute

• 转换成绝对路径

函数原型

::: tip API

path.absolute(path: <string>, rootdir: <string>)

:::

参数说明

参数	描述
path	要转换的路径字符串
rootdir	绝对转换的根目录

用法说明

print(path.absolute("dir/file.txt", "$(tmpdir)"))

显示结果为：$(tmpdir)/dir/file.txt

第二个参数是指定相对的根目录，如果不指定，则默认相对当前目录：

os.cd("$(tmpdir)")
print(path.absolute("dir/file.txt"))

这样结果是一样的。

path.is_absolute

• 判断是否为绝对路径

函数原型

::: tip API

path.is_absolute(path: <string>)

:::

参数说明

参数	描述
path	要检查的路径字符串

用法说明

if path.is_absolute("/tmp/file.txt") then
    -- 如果是绝对路径
end

path.splitenv

• 分割环境变量中的路径

函数原型

::: tip API

path.splitenv(envpath: <string>)

:::

参数说明

参数	描述
envpath	环境变量路径字符串

用法说明

local pathes = path.splitenv(vformat("$(env PATH)"))

-- for windows
local pathes = path.splitenv("C:\\Windows;C:\\Windows\\System32")
-- got { "C:\\Windows", "C:\\Windows\\System32" }

-- for *nix
local pathes = path.splitenv("/usr/bin:/usr/local/bin")
-- got { "/usr/bin", "/usr/local/bin" }

结果为一个包含了输入字符串中路径的数组。