LuaSTG-x Core API
Public Member Functions | List of all members
os Class Reference
Lua_Builtin

Public Member Functions

static function clock ()
 
static function date (local format, local time)
 
static function difftime (local t2, local t1)
 
static function execute (local command)
 
static function exit (local code, local close)
 
static function getenv (local varname)
 
static function remove (local filename)
 
static function rename (local oldname, local newname)
 
static function setlocale (local locale, local category)
 
static function time (local table)
 
static function tmpname ()
 

Detailed Description

操作系统库

这个库都通过表 os 实现。

Member Function Documentation

◆ clock()

static function clock ( )

返回程序使用的按秒计 CPU 时间的近似值。

Returns
number

◆ date()

static function date ( local  format,
local  time 
)

返回一个包含日期及时刻的字符串或表。

格式化方法取决于所给字符串 format。

如果提供了 time 参数，

格式化这个时间

（这个值的含义参见 os.time 函数）。

否则，date 格式化当前时间。

如果 format 以 '!' 打头，

日期以协调世界时格式化。

在这个可选字符项之后，

如果 format 为字符串 "*t"，

date 返回有后续域的表：

year （四位数字），month （1-12），day （1-31），

hour （0-23），min （0-59），sec （0-61），

wday （星期几，星期天为 1 ），

yday （当年的第几天），

以及 isdst （夏令时标记，一个布尔量）。

对于最后一个域，如果该信息不提供的话就不存在。

如果 format 并非 "`*t`"，

date 以字符串形式返回，

格式化方法遵循 ISO C 函数 strftime 的规则。

如果不传参数调用，

date 返回一个合理的日期时间串，

格式取决于宿主程序以及当前的区域设置

（即，os.date() 等价于 os.date("%c")）。

在非 POSIX 系统上，

由于这个函数依赖 C 函数 gmtime 和 localtime，

它可能并非线程安全的。

重载
fun():string|table
Parameters
formatstring
timenumber
Returns
string|table

◆ difftime()

static function difftime ( local  t2,
local  t1 
)

返回以秒计算的时刻 t1 到 t2 的差值。

（这里的时刻是由 os.time 返回的值）。

在 POSIX，Windows，和其它一些系统中，这个值就等于

t2-t1。

Parameters
t2number
t1number
Returns
number

◆ execute()

static function execute ( local  command)

这个函数等价于 ISO C 函数 system。

它调用系统解释器执行 command。

如果命令成功运行完毕，第一个返回值就是 **true**，

否则是 nil otherwise。

在第一个返回值之后，函数返回一个字符串加一个数字。如下：

**"exit"**: 命令正常结束；

接下来的数字是命令的退出状态码。

**"signal"**: 命令被信号打断；

接下来的数字是打断该命令的信号。

如果不带参数调用，

os.execute 在系统解释器存在的时候返回真。

重载
fun():string|number
Parameters
commandstring
Returns
string|number

◆ exit()

static function exit ( local  code,
local  close 
)

调用 ISO C 函数 exit 终止宿主程序。

如果 code 为 **true**，

返回的状态码是 EXIT_SUCCESS；

如果 code 为 **false**，

返回的状态码是 EXIT_FAILURE；

如果 code 是一个数字，

返回的状态码就是这个数字。

code 的默认值为 **true**。

如果第二个可选参数 close 为真，

在退出前关闭 Lua 状态机。

重载
fun():number
Parameters
codenumber
closeboolean
Returns
number

◆ getenv()

static function getenv ( local  varname)

返回进程环境变量 varname 的值，

如果该变量未定义，返回 nil 。

Parameters
varnamestring
Returns
string

◆ remove()

static function remove ( local  filename)

删除指定名字的文件（在 POSIX 系统上可以是一个空目录）

如果函数失败，返回 nil

加一个错误描述串及出错码。

Parameters
filenamestring
Returns
nil|string

◆ rename()

static function rename ( local  oldname,
local  newname 
)

将名字为 oldname 的文件或目录更名为 newname。

如果函数失败，返回 nil

加一个错误描述串及出错码。

Parameters
oldnamestring
newnamestring
Returns
nil|string

◆ setlocale()

static function setlocale ( local  locale,
local  category 
)

设置程序的当前区域。

locale 是一个区域设置的系统相关字符串；

category 是一个描述有改变哪个分类的可选字符串：

"all"，"collate"， "ctype"，

"monetary"， "numeric"， 或 "time"；

默认的分类为 "all"。

此函数返回新区域的名字。

如果请求未被获准，返回 nil 。

当 locale 是一个空串，

当前区域被设置为一个在实现中定义好的本地区域。

当 locale 为字符串 "C"，

当前区域被设置为标准 C 区域。

当第一个参数为 nil 时，

此函数仅返回当前区域指定分类的名字。

由于这个函数依赖 C 函数 setlocale，

它可能并非线程安全的。

重载
fun(locale:string):string|nil
Parameters
localestring
categorystring
Returns
string|nil

◆ time()

static function time ( local  table)

当不传参数时，返回当前时刻。

如果传入一张表，就返回由这张表表示的时刻。

这张表必须包含域 year，month，及 day；

可以包含有 hour （默认为 12 ），

min （默认为 0），

sec （默认为 0），以及 isdst （默认为 **nil**）。

关于这些域的详细描述，参见 os.date 函数。

When the function is called, the values in these fields do not need to be

inside their valid ranges. For instance, if sec is -10, it means 10 seconds

before the time specified by the other fields; if hour is 1000, it means

1000 hours after the time specified by the other fields.

返回值是一个含义由你的系统决定的数字。

在 POSIX，Windows，和其它一些系统中，

这个数字统计了从指定时间（"epoch"）开始经历的秒数。

对于另外的系统，其含义未定义，

你只能把 time 的返回数字用于 os.difftime 的参数。

When called with a table, os.time also normalizes all the fields

documented in the os.date function, so that they represent the same time

as before the call but with values inside their valid ranges.

重载
fun():number
Parameters
tabletable
Returns
number

◆ tmpname()

static function tmpname ( )

返回一个可用于临时文件的文件名字符串。

这个文件在使用前必须显式打开，不再使用时需要显式删除。

在 POSIX 系统上，这个函数会以此文件名创建一个文件以回避安全风险。

（别人可能未经允许在获取到这个文件名到创建该文件之间的时刻创建此文件。）

你依旧需要在使用它的时候先打开，并最后删除（即使你没使用到）。

只要有可能，你更应该使用 io.tmpfile，

因为该文件可以在程序结束时自动删除。

Returns
string
The documentation for this class was generated from the following file: