翻訳が中途半端につきTranslate.png
この記事には翻訳されていない箇所があります。
どなたでも翻訳にご協力いただくことができます。
◆原文へのリンク : w:c:dev:Lua reference manual/Standard libraries
ご協力お願いします

目次

The standard Lua libraries provide essential services and performance-critical functions to Lua. この記事では、主にScribunto上でも使用できる標準ライブラリについて記述します。

Aviutl.pngこのアイコンがある物はAviUtl上での事について記述されています。
Wiki.pngこのアイコンがある物はWikia上での事について記述されています。

基本ライブラリ[編集 | ソースを編集]

_G[編集 | ソースを編集]

グローバル変数を全て含むテーブルです。_G自身も含まれます。

foo = 1
mw.log( foo ) -- logs "1"
_G.foo = 2
mw.log( foo ) -- logs "2"
_G = {}       -- _Gの中に_Gを作成した事になるが・・・
_G.foo = 3
mw.log( foo ) -- 表示されるのは"2"のまま

_G自身をテーブルとして使用する例です。

-- Call a function whose name is stored in a variable
_G[var]()
-- Log the names and stringified values of all global variables
for k, v in pairs( _G ) do
   mw.log( k, v )
end
-- Log the creation of new global variables
setmetatable( _G, {
    __newindex = function ( t, k, v )
         mw.log( "Creation of new global variable '" .. k .. "'" )
         rawset( t, k, v )
    end
} )

_VERSION[編集 | ソースを編集]

Luaのバージョンを示す文字列です。

Aviutl.png拡張編集 0.90d3時点での内容は"Lua 5.1"です。

assert[編集 | ソースを編集]

assert(v[, mes])

vnil か false だった時、エラーメッセージmesを送出します
mes省略時のエラーメッセージは "assertion failed!" になります

もしそうでなかった場合、そこに記述された引数をそのまま返します。中に関数を記述した場合、その返す値でassertを実行します。
-- This doesn't check for errors
local result1, result2, etc = func( ... )

-- This works the same, but does check for errors
local result1, result2, etc = assert( func( ... ) )

error[編集 | ソースを編集]

error(mes[, level])

エラーメッセージmesを送出します

levelはエラーメッセージに付加する位置情報を指定します
1ならerror関数を呼び出した位置
2ならerror関数を呼び出した関数を呼び出した位置
levelが0か関数呼び出しの深度以上の場合、位置情報は付加されません

getfenv[編集 | ソースを編集]

getfenv(f)

※Lua 5.2では削除されます。エンジン設定のallowEnvFuncsによって異なります。

指定された関数の現在の環境を返します。fにはLuaの関数かスタックレベルを指定します。

  • 1、nil、または省略された場合、getfenvを呼び出す関数の環境を返します。多くの場合、これは_Gと同じになります。
  • 整数2〜10は、呼び出しスタックの上位にある関数の環境を返します。たとえば、2は現在の関数を呼び出した関数の環境を返し、3はその関数を呼び出す関数の環境を返します。値がスタック内の関数呼び出しの数よりも大きい場合、またはターゲットのスタックレベルが末尾呼び出しで返された場合は、エラーが発生します。
  • 関数を渡すと、その関数が呼び出されたときに使用される環境が返されます。

Wiki.pngすべての標準ライブラリ関数とScribuntoライブラリ関数によって使用される環境は保護されています。getfenvを使ってこれらの環境にアクセスしようとすると、代わりにnilが返されます。

getmetatable[編集 | ソースを編集]

getmetatable(t)

tメタテーブルを返します
tのメタテーブルが__metatableメソッドを持ってたら、その値を返します
nilを返す事もあります

Wiki.pngセキュリティの事情でテーブル型以外の値にメタテーブルを設定できないためテーブル型以外では返せません。

ipairs[編集 | ソースを編集]

ipairs(t)

イテレータ関数、t、0の3つの値を返します。

for i, v in ipairs( t ) do
    -- block
end

上のコードは 1 から連続する t の正の整数のインデックスの要素すべてに対して処理を行います
iはインデックス、vはその値です

Wiki.pngeメタテーブル__ipairsメソッドを持っていたら、そちらを呼び出します

next[編集 | ソースを編集]

next(t[, i])

テーブルtの要素iの次の要素の名前と値を返します
iがnilもしくは未定義の値ならtの最初の要素の名前と値を返します
最後のインデックスで呼び出すか、空のテーブルに対してnilで呼び出すと、nextはnilを返す。 二番目の引数が省略された場合はnilと解釈される。 特に、next( t ) == nilを使うとテーブルが空かどうか調べることができる。

Luaにはフィールドの宣言がない。テーブル内にフィールドが存在しないのと、nil値が格納されたフィールドには、何の違いも無い。ゆえに、nextnilでない値を持つフィールドのみを考慮する。インデックスが列挙される順番は、数値のインデックスに対しても、不定である (数値順にテーブルを巡回するには、数値用のfor文ipairs関数を使う)。

テーブルの巡回中に、もし存在していないフィールドに新たに値が割り当てられたら、nextの動作は未定義である。しかし既存のフィールドは変更してもよい。特に、既存のフィールドを消去するのは構わない。

pairs[編集 | ソースを編集]

pairs(t)

next関数、tnilの3つの値を返します

for k, v in pairs( t ) do
    -- block
end

上のコードはtの要素すべてに対して処理を行います
 k は要素名、v はその値です

巡回中にテーブルを変更する際の注意はnextを参照。

Wiki.pngeメタテーブル__pairsメソッドを持っていたら、そちらを呼び出します

pcall[編集 | ソースを編集]

pcall(f,[ ...]) 関数fに指定された引数を(protected modeで)渡して実行します。
関数f内でエラーが発生してもプログラムを中断せずに、falseとエラーコードを返します。
成功時はtrueと関数fの戻り値を返します。

Wiki.png特定の内部エラーを傍受することはできません。

関数の実行中にエラーが発生した場合、通常は呼び出し元までエラーが伝搬し、そこで実行を止めてしまう。しかし、アプリケーション組み込みのスクリプトでは特に、エラーが発生しても止まってほしくないことがある。そこで、単に関数を呼び出す代わりに pcall() という関数を使って関数を呼び出す。

擬似コードでは、pcallは次のようになります:

function pcall( f, ... )
    try
        return true, f( ... )
    catch ( message )
        return false, message
    end
end

rawequal[編集 | ソースを編集]

rawequal(a, b)

__eqメタメソッドを呼ばずにaとbが等しいか調べます。戻り値はブーリアンです

rawget[編集 | ソースを編集]

rawget(t, i)

__indexメタメソッドを呼ばずに t[i] の値を取得します。t はテーブルでなければなりません

rawset[編集 | ソースを編集]

rawset(t, i, v)

__newindexメタメソッドを呼ばずに t[i] に v を代入します。t はテーブルでなければなりません

select[編集 | ソースを編集]

select(i, ...)

iが整数なら[i+1]番目以降の引数の値を全て返します iが文字列'#'ならiを除く引数の数を返します

言い換えれば、select...にnil値が含まれていても正しく動作することを除けば、ほぼ次のようなものです(nilの問題については #unpackの項目をご覧ください)

function select( index, ... )
    local t = { ... }
    if index == '#' then
        return #t
    else
        return unpack( t, index )
    end
end

負の値を指定することも可能で、その場合末尾からの位置になります。

local secondToLast, last = select(2, "one", "two", "three", "four")

mw.log(secondToLast) --> "two"
mw.log(last)         --> "three"

local secondToLast, last = select(-2, "one", "two", "three", "four")

mw.log(secondToLast) --> "three"
mw.log(last)         --> "four"

setmetatable[編集 | ソースを編集]

setmetatable(t, meta)

テーブルtメタテーブルを設定します
もしmetanilであれば、テーブルtのメタテーブルは除去される。 元のメタテーブルが__metatableフィールドを持っていると、エラーになる。

Aviutl.pngテーブル型以外の値にメタテーブルを設定するには、C言語側で処理する必要があります

tonumber[編集 | ソースを編集]

tonumber(e[, base])

eが数値か、数値に変換可能な文字列なら数値を、それ以外ならnilを返します
base(省略時:10)にはeを変換する際に使う基数を 2~36 の範囲で指定します

基数10では値は小数部を持ったり、E表記で表されたり、基数16ではそれを示すために先行 "0x"を持つ可能性があります。他の基数では、符号なし整数のみが受け入れられます。

tostring[編集 | ソースを編集]

tostring(e)

eを文字列に変換します
それぞれの型がどのように変換されるかについての詳細はLuaのデータ型を見てください。

eメタテーブル__tostringメソッドを持っていたら、そちらを呼び出します

type[編集 | ソースを編集]

type(v)

vの型を文字列で返します。返される文字列は以下のどれかです

"nil"
"number"
"string"
"boolean"
"table"
"function"
Aviutl.png"thread"
Aviutl.png"userdata"

unpack[編集 | ソースを編集]

unpack(t[, i[, j]]

テーブルtの、i以上j以下の整数の要素すべてを返します
nilもしくは省略した時、iは 1、j#tの値になります

tシーケンスではなく、jnilまたは未指定の場合、結果は確定的ではありません。詳細は長さ演算子を見てください。

※Lua 5.2からはテーブルライブラリになり、table.unpackとなります

xpcall[編集 | ソースを編集]

xpcall(f, err) 関数 f を実行し、エラーが発生したらエラーメッセージを引数に関数 err を実行します。
関数 f 成功時は true と関数 f の戻り値を返します。
失敗時はfalseと関数errの戻り値を返します。

Wiki.png特定の内部エラーを傍受することはできません。

擬似コードでは、xpcallは次のようになります:

function xpcall( f, errhandler )
    try
        return true, f()
    catch ( message )
        message = errhandler( message )
        return false, message
    end
end

デバッグライブラリ[編集 | ソースを編集]

セキュリティーの都合上、Wiki.pngの無いコマンドはWikiaでは使用できません。

debug.debug[編集 | ソースを編集]

debug.debug()

ユーザーとの対話モードに入り、ユーザーが入力した文字列を実行する。単純なコマンドや他のデバッグ機能を使って、ユーザーはグローバル変数やローカル変数を調べたり値を変更したり式を評価したりその他ができる。ユーザーがcontだけの行を入力すると対話モードを終えて実行を継続する。

debug.debugで実行されるコマンドは、どの関数のレキシカルスコープにも入っていないので、ローカル変数へは直接アクセスできないことに注意。

debug.getmetatable[編集 | ソースを編集]

debug.getmetatable(object) object のメタテーブルを返します

debug.setmetatable[編集 | ソースを編集]

debug.setmetatable(object, t) object がテーブル型以外でもメタテーブルを設定します

debug.getlocal[編集 | ソースを編集]

debug.getlocal(level, i) スタックレベル level の i 番目のローカル変数の名前と値を返します

debug.setlocal[編集 | ソースを編集]

debug.setlocal(level, i, v) スタックレベル level の i 番目のローカル変数に v を代入します
i が存在しなければ nil を、そうでなければローカル変数の名前を返します

debug.getupvalue[編集 | ソースを編集]

debug.getupvalue(f, i) 関数 f の i 番目の上位値の名前と値を返します 上位値が存在しなければ nil を返します

debug.setupvalue[編集 | ソースを編集]

debug.setupvalue(f, i, v) 関数 f の i 番目の上位値に v を代入します i が存在しなければ nil を、そうでなければ上位値の名前を返します

debug.gethook[編集 | ソースを編集]

debug.gethook() 現在のフック関数、フックマスク、フックカウントを返します

debug.sethook[編集 | ソースを編集]

debug.sethook(hook, mask [, count]) フック関数をhook、フックマスクをmask、フックカウントをcount(もしくは)に設定します

debug.getfenv[編集 | ソースを編集]

debug.getfenv(o) オブジェクト o の環境を返す

debug.setfenv[編集 | ソースを編集]

debug.setfenv(object, table) 指定した object の環境を指定した table にする。

debug.getregistry[編集 | ソースを編集]

debug.getregistry() レジストリテーブルを返します

debug.getinfo[編集 | ソースを編集]

debug.getinfo(f [, what])

関数に関する情報をテーブルに入れて返す。 関数を直接指定するか数値を指定することができる。 数値は、関数が走っているコールスタックのレベルを意味し、 レベル0は現在の関数 (getinfo 自身)、 レベル1は getinfo を呼び出した関数で、以下同様。 function がアクティブな関数の数よりも大きい数値であれば getinfo は nil を返す。

what はどのフィールドを埋めるかを記述する文字列で、 戻り値のテーブルには lua_getinfo から返されるフィールドがすべて含まれている。 what のデフォルト値では有効なすべての情報を取得する。 もし存在すれば、`f´ オプションは func という名前のフィールドにその関数自身を入れる。

例えば、式 debug.getinfo(1,"n").name は現在の関数の名前を返す (もし適当な名前があれば)。 debug.getinfo(print) は print 関数に関するすべての利用可能な情報を持つテーブルを返す。

Wiki.pngdebug.traceback[編集 | ソースを編集]

debug.traceback([thread,] [message [, level]]) message が文字列でも nil でもなければ、 それ以上の処理をせずに message を返します。 そうでなければ、 スタックトレースの文字列を返します。 省略可能な文字列 message がトレースの先頭に追加されます。 省略可能な数値 level はトレースを開始するレベルを指定します (デフォルトは 1 で、 traceback を呼んだ関数です)。

数学ライブラリ[編集 | ソースを編集]

三角関数[編集 | ソースを編集]

math.pi[編集 | ソースを編集]

円周率()を表す定数です

小数点以下14桁目を四捨五入しているようです。

math.deg[編集 | ソースを編集]

math.deg(x)

ラジアンxを角度(°)に変換します

ってことです

math.rad[編集 | ソースを編集]

math.rad(x)

角度(x°)をラジアンに変換します

ってことです

math.sin[編集 | ソースを編集]

math.sin(x)

ラジアンxからサインの値を得ます

math.cos[編集 | ソースを編集]

math.cos(x)

ラジアンxからコサインの値を得ます

math.tan[編集 | ソースを編集]

math.tan(x)

ラジアンxからタンジェントの値を得ます

math.asin[編集 | ソースを編集]

math.asin(x)

サインxの値からラジアンを得ます。定義域は, 戻り値は

定義域外の値が渡されると戻り値はNaNになります

math.acos[編集 | ソースを編集]

math.acos(x)

コサインの値xからラジアンを得ます。定義域は, 戻り値は

定義域外の値が渡されると戻り値はNaNになります

math.atan[編集 | ソースを編集]

math.atan(x)

タンジェントの値xからラジアンを得ます。戻り値は

math.atan2[編集 | ソースを編集]

math.atan2(y, x)

座標からラジアンを得ます

言い換えるとすれば結果の象限を見つけるために両方のパラメータの符号を使って、y/xの逆正接(ラジアン)を返します。

math.sinh[編集 | ソースを編集]

math.sinh(x)

xの双曲線正弦の値を返します

math.cosh[編集 | ソースを編集]

math.cosh(x)

xの双曲線余弦の値を返します

math.tanh[編集 | ソースを編集]

math.tanh(x)

xの双曲線正接の値を返します

指数・対数[編集 | ソースを編集]

math.pow[編集 | ソースを編集]

math.pow(x, y)

xy乗の値を返します。x^yの式でも代用できます

Wiki.pngmath.exp[編集 | ソースを編集]

math.exp(x)

を返します

math.log[編集 | ソースを編集]

math.log(x[,base])

baseを底とするxの対数を返します。base省略時は自然対数を返します

math.log10[編集 | ソースを編集]

math.log10(x)

※この関数はLua 5.2で廃止予定です。
math.logでの代用を推奨します

math.log(x,10)と同じ値を返します

math.sqrt[編集 | ソースを編集]

math.sqrt(x)

xの平方根の値を返します。x^0.5の式でも代用できます

math.ldexp[編集 | ソースを編集]

math.ldexp(m, e)

の値を返します。(eが実数だと四捨五入されて整数にされるようです)

math.frexp[編集 | ソースを編集]

math.frexp(x)

meを返しますが・・・

  • x が0以外の有限:となるような meになります。m(0.5以上1未満)、eは整数です
  • xが0: meは0になります。
  • xがNaNもしくは無限大: mxeは未定義になります。

その他[編集 | ソースを編集]

math.abs[編集 | ソースを編集]

math.abs(x)

(xの絶対値)を返します

math.ceil[編集 | ソースを編集]

math.ceil(x)

xの小数点以下を切り上げて整数にします

math.floor[編集 | ソースを編集]

math.floor(x)

xの小数点以下を切り捨てて整数にします

math.fmod[編集 | ソースを編集]

math.fmod(x, y)

xyで割った余りを返します

x % yは、を返しますが、math.fmod(x,y)は、 を返します

y==0のときは、-1.#INFを返します

math.max[編集 | ソースを編集]

math.max(x, ...)

与えられた引数の中から最も大きい値を返します

NaNでの動作は指定されていません。現在の実装では、xがNaNの場合NaNが返されますが、それ以外のNaNは無視されます。

math.min[編集 | ソースを編集]

math.min(x, ...)

与えられた引数の中から最も小さい値を返します

NaNでの動作は指定されていません。現在の実装では、xがNaNの場合NaNが返されますが、それ以外のNaNは無視されます。

math.huge[編集 | ソースを編集]

正の無限大の値を表す定数です

math.modf[編集 | ソースを編集]

math.modf(x)

xの整数部と小数部の2つの値を返します

math.random[編集 | ソースを編集]

math.random([m[, n]])

乱数を返します

Aviutl.png拡張編集の乱数とは違い、呼び出し毎に値が変わります

mとnは整数を設定する事ができます

  • 引数なしで呼ぶと(0以上1未満)の実数を返します
  • 数値mを渡すと、(1以上m以下)の整数を返します
  • 数値mとnを渡すと、(m以上n以下)の整数を返します

math.randomseed[編集 | ソースを編集]

math.randomseed(x)

乱数のシード値をxに設定します

ちなみに、乱数といっても擬似乱数なので同じシードを設定すると同じ順番でmath.randomの返値を生成します

OS機能[編集 | ソースを編集]

セキュリティーの都合上、Wiki.pngの無いコマンドはWikiaでは使用できません。

Wiki.pngos.clock[編集 | ソースを編集]

os.clock()

Luaステートが初期化されてから経過した秒数を返します

Aviutl.pngAviUtl拡張編集のLuaステートの初期化は初めてスクリプトが実行される直前に行われるようです

Wiki.pngos.date[編集 | ソースを編集]

os.date([fmt [, time]]) os.date( format, time )

Language library's formatDate may be used for more comprehensive date formatting

Returns a string or a table containing date and time, formatted according to format. If the format is omitted or nil, "%c" is used.

If time is given, it is the time to be formatted (see os.time()). Otherwise the current time is used.

If format starts with '!', then the date is formatted in UTC rather than the server's local time. After this optional character, if format is the string "*t", then date returns a table with the following fields:

  • year (full)
  • month (1–12)
  • day (1–31)
  • hour (0–23)
  • min (0–59)
  • sec (0–60)
  • wday (weekday, Sunday is 1)
  • yday (day of the year)
  • isdst (daylight saving flag, a boolean; may be absent if the information is not available)

If format is not "*t", then date returns the date as a string, formatted according to the same rules as the C function strftime.

Wiki.pngos.difftime[編集 | ソースを編集]

os.difftime( t2, t1 )

時刻t1から時刻t2までの秒数を返します

Wiki.pngos.time[編集 | ソースを編集]

os.time( table )

Returns a number representing the current time.

When called without arguments, returns the current time. If passed a table, the time encoded in the table will be parsed. The table must have the fields "year", "month", and "day", and may also include "hour" (default 12), "min" (default 0), "sec" (default 0), and "isdst".

os.remove[編集 | ソースを編集]

os.remove(filename)

指定された名前のファイル、またはディレクトリを削除します

os.rename[編集 | ソースを編集]

os.rename(old, new)

名前がoldのファイル、またはディレクトリをnewにリネームします

os.tmpfile[編集 | ソースを編集]

os.tmpfile()

一時ファイルの名前として使えるファイル名を返します

os.getenv[編集 | ソースを編集]

os.getenv(varname)

プロセスの環境変数varnameの値を返します

os.setlocale[編集 | ソースを編集]

os.setlocale(locale [, category])

os.execute[編集 | ソースを編集]

os.execute([cmd])

OSのシェルに文字列 cmdを渡して実行します

cmd省略時には、シェルが利用可能ならば非ゼロ、そうでなければゼロを返します

os.exit[編集 | ソースを編集]

os.exit([code])

ホストプログラム(AviUtl)を終了させます

codeにはエラーがあればそのエラーコードを指定します 省略時は成功を表すコードです

パッケージライブラリ[編集 | ソースを編集]

セキュリティーの都合上、Wiki.pngの無いコマンドは使用できません。

Wiki.pngrequire[編集 | ソースを編集]

require( modulename )

この疑似コードを見てくれ。こいつをどう思う?

 function require(modname)
  	if(package.loaded[modname]~=nil)then
  		return package.loaded[modname]
  	end
  	
  	local mod
  	if(package.preload[modname]~=nil)then
     	mod=package.preload[modname]()
     
     --Luaのローダーを探す
     
     --本当はpackage.pathには複数のパスのデータが入りうる ;で区切られている
  	elseif(<package.path..modname..".lua"が存在する>)then
  		mod=dofile(package.path:gsub("?",modname))
  	 	_G[modname]=mod
  		package.loaded[modname]=mod
  		return mod
  	
  	else
  		--Cのローダーを探す
  		
  		-- -(ハイフン)までの文字は、-含め切り捨てて、.(ドット)は_(アンダースコア)に置換される
  		-- a.b-c.d は c_d になる
  		local c_loader_path=modname:match("%-(.+)"):gsub("%.","_")
  		
      	--package.cpathも同様
  		if(<package.cpath..c_loader_path..".dll"が存在する>)then
  			local mod=package.loadlib(
  				package.cpath:gsub("?",modname),
  				"luaopen_"..c_loader_path
  			)()
  	 		_G[modname]=mod
  			package.loaded[modname]=mod
  			return mod
  	
  		--オールインワンローダーを探す
  		else
  			-- 一番最初の.の直前までをファイル名にする a.b.cなら ~\a.dllを見に行く
  			if(<package.cpath..modname:match(".+%.")..".dll"が存在する>)then --同上
  				local mod=package.loadlib(
  					package.cpath:gsub("?",modname),
  					"luaopen_"..modname:gsub("%.","_")
  				)()
  	 			_G[modname]=mod
  				package.loaded[modname]=mod
  				return mod
  			end
  		
  		end
  	
  	end
  end

Loads the specified module.

First, it looks in package.loaded[modulename] to see if the module is already loaded. If so, returns package.loaded[modulename].

Otherwise, it calls each loader in the package.loaders sequence to attempt to find a loader for the module. If a loader is found, that loader is called. The value returned by the loader is stored into package.loaded[modulename] and is returned.

See the documentation for package.loaders for information on the loaders available.

Note that every required module is loaded in its own sandboxed environment, so it cannot export global variables as is sometimes done in Lua 5.1. Instead, everything that the module wishes to export should be included in the table returned by the module.

For example, if you have a module "Module:Giving" containing the following:

local p = {}

p.someDataValue = 'Hello!'

return p

You can load this in another module with code such as this:

local giving = require( "Module:Giving" )

local value = giving.someDataValue -- value is now 'Hello!'

Global modules[編集 | ソースを編集]

Modules hosted in dev.wikia.com are called global modules because they can be loaded by other modules using a similar syntax to loading local modules.[1] The correct syntax to use is require("Dev:ModuleName") . This is case sensitive. It should also be added to all modules hosted on dev.wikia or else it'll attempt to use a module in a local wiki (e.g. crocodile.wikia.com).

You can load this in another module from another wiki with code such as this:

local giving = require( "Dev:Giving" )

local value = giving.someDataValue -- value is now 'Hello!'

Wiki.pngpackage.loaded[編集 | ソースを編集]

This table holds the loaded modules. The keys are the module names, and the values are the values returned when the module was loaded.

Wiki.pngpackage.loaders[編集 | ソースを編集]

This table holds the sequence of searcher functions to use when loading modules. Each searcher function is called with a single argument, the name of the module to load. If the module is found, the searcher must return a function that will actually load the module and return the value to be returned by require. Otherwise, it must return nil.

Scribunto provides two searchers:

  1. Look in package.preload[modulename] for the loader function
  2. Look in the modules provided with Scribunto for the module name, and if that fails look in the Module: namespace. The "Module:" prefix must be provided.

Note that the standard Lua loaders are not included.

Wiki.pngpackage.preload[編集 | ソースを編集]

This table holds loader functions, used by the first searcher Scribunto includes in package.loaders.

Wiki.pngpackage.seeall[編集 | ソースを編集]

package.seeall( table )

Sets the __index metamethod for table to _G.

文字列ライブラリ[編集 | ソースを編集]

Luaの文字列のインデックス付けは、最初の文字が1の位置である (C、PHP、JavaScriptのように0ではない)。 文字列の末尾から逆方向にマイナス値で指定することもできる。 つまり、最後の文字は -1 の位置で示される。

『待った!』 この文字列ライブラリは1バイト専用と言ってもよく、 2バイト以上の文字に対応していません
Wiki.png2バイト以上の文字を含む場合は、ScribuntoのUstlingライブラリをご利用ください。

string.byte[編集 | ソースを編集]

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

文字列si番目からj番目までの文字コードの値を返します。 省略時iは1、jiと同じになります。 Identical to mw.ustring.byte().

string.char[編集 | ソースを編集]

string.char(...)

引数の数値と等しい文字コードの文字を連結した文字列を返します
See mw.ustring.char() for a similar function that uses Unicode codepoints rather than byte values.

string.find[編集 | ソースを編集]

string.find(s, p[, init[, plain]])

文字列s内でのパターンpの最初のマッチの開始位置と終了位置を返します。
マッチしなかった場合はnilを返します。init には検索開始位置を指定します。
plain が true の場合パターンマッチングは行われず、単純な部分文字列検索になります。
パターン内にキャプチャが指定されていた場合、その内容が3番目以降の戻り値として返されます。

See mw.ustring.find() for a similar function extended as described in Ustring patterns and where the init offset is in characters rather than bytes.

string.format[編集 | ソースを編集]

string.format(fmt, ...)

任意のフォーマットで記述します。書式文字列は標準C関数のprintfと同じ。

  • 認識されるフラグは '-'、'+'、''、'#'、および '0'。
  • 最大99までの整数フィールド幅がサポートされています。
  • 最大99までの整数精度がサポートされています。
    • どちらも'*'は未サポート。
  • 長さ指定子は全て未サポート。
  • 位置指定子("%2$s"みたいなの)も未サポート。
  • それ以外の 'c', 'd', 'i', 'o', 'u', 'x', 'X', 'e', 'E', 'f', 'g', 'G', 's', '%'と'q'はサポートされている。
    • 未サポート:*、l、L、n、p、h
    • 追加:q

q オプションは、Luaインタプリタで安全に読み戻せる適切な形式の文字列に書式化する。この時、文字列はダブルクォートの間に書かれ、文字列中のダブルクォート、改行、埋め込まれたゼロ、バックスラッシュは正しくエスケープされる。

c、d、E、e、f、g、G、i、o、u、X、x はすべて数値の引数を期待し、 q と s は文字列を期待する。

文字列と数値の間の変換はデータ型の指定に従って実行されます。他の型は自動的に文字列に変換されません。 NUL文字(バイト値0)を含む文字列は正しく処理されません。

Identical to mw.ustring.format().

string.gmatch[編集 | ソースを編集]

string.gmatch(s, p)

汎用 for 文で使用します。文字列s内の正規表現pにマッチする部分文字列を返すイテレータ関数を返します。patternにキャプチャが指定されていない場合は、各呼び出しで完全一致が生成されます。

この関数では、パターンの先頭にある '^'は、繰り返しを妨げるので魔法のようなものではありません。それはリテラル文字として扱われます。

See mw.ustring.gmatch() for a similar function for which the pattern is extended as described in Ustring patterns.

string.gsub[編集 | ソースを編集]

string.gsub(s, p, repl[, n])

文字列s内のパターンpにマッチする部分をreplで置換します。
replには文字列、テーブル、関数のいずれかを指定します。nには置換が行われる回数を指定します。

返値は実際に置換が行われた回数が入ります。

replが文字列の場合は、その文字列が置換に使われます。文字%はエスケープ文字として働きます。repl中の%n(ただしnは1から9)はd番目のキャプチャした部分文字列の値(以下参照)を表します。%0はマッチ全体を表し、%%は単一の%を表します。
replがテーブルの場合は、各マッチごとに最初のキャプチャをキーとしてテーブルを引きます。パターンにキャプチャがなければ、マッチ全体をキーとして使います。
replが関数の場合は、その関数はマッチが現れるたびに呼ばれ、すべてのキャプチャされた部分文字列が順番通りに引数として渡されます。パターンにキャプチャがなければ、マッチ全体が単一の引数として渡されます。
テーブル検索または関数呼び出しの戻り値が文字列または数値であれば、それが置換文字列として使われます。そうでなく、falseまたはnilであれば、置換されません(つまり、元のマッチがそのまま文字列中に保たれます)。

See mw.ustring.gsub() for a similar function in which the pattern is extended as described in Ustring patterns.

string.len[編集 | ソースを編集]

string.len(s) string.len(str) 文字列の長さを取得します。#sでも代用できます

空文字列 "" の長さは0である。 文字列中のゼロも数えるので、"a\000b\000c" の長さは5である。

See mw.ustring.len() for a similar function using Unicode codepoints rather than bytes.

string.lower[編集 | ソースを編集]

string.lower(s)

文字列s中のアルファベットを小文字にした文字列を返します
アルファベットと同じ値の2バイト文字も変換されるので注意

See mw.ustring.lower() for a similar function in which all characters with uppercase to lowercase definitions in Unicode are converted.

string.match[編集 | ソースを編集]

string.match(s, p[, init])

文字列s内のパターンpにマッチする部分文字列を返します。見つからなければnilを返します。
パターン内にキャプチャがあればそれを返します。init(省略時は1)は検索開始位置を指定します。

See mw.ustring.match() for a similar function in which the pattern is extended as described in Ustring patterns and the init offset is in characters rather than bytes.

string.rep[編集 | ソースを編集]

string.rep(s, n)

文字列sn回繰り返した文字列を返します。Identical to mw.ustring.rep().

string.reverse[編集 | ソースを編集]

string.reverse(s)

文字列sを逆にした文字列を返します
2バイト文字は正しく処理されません

string.sub[編集 | ソースを編集]

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

文字列si番目からj番目の文字までの部分文字列を返します。 j省略時は文字列の末尾になります。

特に、string.sub(s,1,j)sの先頭からj文字を取り出し、string.sub(s, -i)sの最後のi文字を取り出す。

See mw.ustring.sub() for a similar function in which the offsets are characters rather than bytes.

string.upper[編集 | ソースを編集]

string.upper(s)

文字列s中のアルファベットを大文字にした文字列を返します
アルファベットと同じ値の2バイト文字も変換されるので注意

See mw.ustring.upper() for a similar function in which all characters with uppercase to lowercase definitions in Unicode are converted.

Luaパターン[編集 | ソースを編集]

Luaパターンは正規表現のようでそうでない。特に、正規表現やPCREとの以下の違いに注意するように:

  • メタ文字にPerlなどの「\」ではなく、「%」を使う。
  • ドット(.)は改行コードもマッチ対象。
  • 文字クラスの小文字と大文字の関係は補集合となる。
  • 「複数の正規表現のいずれかにマッチ」する | は実装されていない。
  • 量指定子(*+?、および- )はグループを捕らえず、個々の文字または文字クラスにのみ適用できます。
  • -は0回以上の最短マッチ。(-は既存の正規表現でいうところの「*?」と思っておけばよいだろう。)
  • 一般化された有限数量詞はありません(例えば、PCREの {nm} 数量詞)。
  • 幅がゼロのアサーションは、^$、および%f[set] "frontier"パターンのみです。 PCREの\b(?=···)などのアサーションは存在しません。
  • パターン自体は '\''ddd'''のような文字エスケープを認識しません。ただし、パターンはstringsなので、これらの種類のエスケープは、pattern-stringを作成するために使用される文字列リテラルで使用できます。

パターンには途中にゼロ(ASCII NUL、"\0")を含むことができない。代わりに%zを使う。

Also see Ustring patterns for a similar pattern-matching scheme using Unicode characters.

文字クラス[編集 | ソースを編集]

文字クラス は文字の集合を表すために使われます。 文字クラスの記述では以下の組み合わせが使用できます。

x (xはメタ文字(^$()%.[]*+-?)以外)

文字xそれ自身を表す。

. (ドット)

すべての文字を表す。

%x (xは英数文字以外)

文字x自身を表す、文字のエスケープ。すべての句読点(メタでない文字も)は'%'を前置してパターン中でそれ自身を表すことができます。

集合 補集合 集合の内容
%a %A すべてのletter
%c %C すべての制御文字
%d %D すべての数字
%l %L すべての小文字
%p %P すべての区切り記号
%s %S すべての空白文字
%u %U すべての大文字
%w %W すべての英数文字
%x %X すべての十六進数字
%z %Z NULや0として表現される0バイト文字
[set] [^set] set内のすべての文字の和。最初の文字と最後の文字をマイナス(-)でつなぐことで文字の範囲を指定することもできます。set中の部品として上で説明した%xクラスもすべて使うことができますset中のそれ以外の文字はすべてそれ自身を表します。 例えば[%w_](または[_%w]) はすべての英数文字にアンダースコアを加えたものを表し、[0-7]は8進数字を表し、[0-7%l%-]は8進数字に小文字と'-'を加えたものを表します。

範囲を指定するときには、最初と最後の文字は同じ種類の文字(数字、英大文字、英小文字)でないといけません。
キャレット(^)を文字集合に含みたいときにはそれは先頭にあってはいけません。
閉じ角カッコ(])を集合に含む場合は、必ず最初の開き角カッコの直後におく必要があります。

パターンの要素[編集 | ソースを編集]

パターンの要素 は以下のいずれかである。

  • 単一の文字クラス
  • 単一の文字クラスに'*'が続いたもの。そのクラスの文字の0以上の繰り返しにマッチする。可能な限り長いシーケンスにマッチする。
  • 単一の文字クラスに'+'が続いたもの。そのクラスの文字の1以上の繰り返しにマッチする。可能な限り長いシーケンスにマッチする。
  • 単一の文字クラスに'-'が続いたもの。そのクラスの文字の0以上の繰り返しにマッチする。'*'と異なり、可能な限り短いシーケンスにマッチする。
  • 単一の文字クラスに'?'が続いたもの。そのクラスの文字の0回または1回の出現にマッチする。
  • %n(nは1から9)。これは、n番目にキャプチャされた文字列にマッチするような要素である (下の説明を参照)。
  • %bxy(xyは異なる文字)。これはxで始まってyで終わる文字列にマッチするような要素である。xyは対応が取れる。つまり、文字列を左から右に読んでいって、xが現れるたびにカウントを +1 し、yでは -1 したとき、最後のyはカウントが0になる最初のyである。例えば、要素%b()はカッコの対応が取れた式にマッチする。
  • %f[set](境界パターン)。この項目は、次の文字がsetに属し前の文字がsetに属さない場所で、空文字列にマッチします。集合setは上で述べたように解釈されます。対象の先頭および末尾では、文字 '\0' が存在するかのように扱われます。
    ※このパターンはLua5.1ではリファレンスに載っていなかったが、Lu5.2で追加された。ソース解析でこれを見つけた人に感謝。

^Pattern$[編集 | ソースを編集]

patternはパターン要素の列である。

パターンの最初に現れる'^'は対象文字列の先頭にマッチを固定する。パターンの最後に現れる'$'は対象文字列の最後にマッチを固定する。他の位置では、'^'や'$'は特別な意味を持たず、それ自身を表す。

キャプチャ[編集 | ソースを編集]

パターンは、カッコで囲まれたサブパターンを含むことができ、これをキャプチャと呼びます。パターンが合致したときには、キャプチャに相当する部分文字列は保存され、後で使用することができるようになります。キャプチャの順序は開きカッコの出現順です。たとえば、パターン"(a*(.)%w(%s*)),"において、最初のキャプチャはa*(.)%w(%s*)に相当する部分文字列であり、2番目のキャプチャは.に、3番目のキャプチャは%s*に相当する部分文字列となります。

Luaパターンの特殊なケースとして、空っぽのキャプチャ()は、その場所の文字列の中での位置をキャプチャします。たとえば、パターン"()aa()"を文字列"flaaap"に適用した場合、3と5がキャプチャされます。この空っぽのキャプチャは正規表現では使えません。


テーブルライブラリ[編集 | ソースを編集]

テーブルライブラリのほとんどの関数はテーブルがシーケンスである事を前提としています。

table.foreach()table.foreachi()table.getn()は使用非推奨のため記載していません。汎用for文とpairs()、汎用for文とipairs()、長さ演算子#で代用して下さい。

table.concat[編集 | ソースを編集]

table.concat(t[, sep[, i[, j]]])

テーブルti番目からj番目までの要素の間に文字列sepを挟み、 それら全てを連結した文字列を返します。
省略時、sepは空文字列、iは1、jはテーブルの長さになります。

Aviutl.pngconcatメタメソッドは呼ばれない?

table.insert[編集 | ソースを編集]

table.insert(t,[ n,] v)

テーブルtの位置nvを挿入します。 nの位置にすでに要素がある時は、それ以降の要素を1つ後ろにずらします。 n省略時はtの末尾に追加します。

#tまでの要素がシフトされます。テーブルがシーケンスでない場合の注意事項については、長さ演算子を参照してください。

table.maxn[編集 | ソースを編集]

table.maxn(t) テーブルtの正の最大の数値インデックスを返します。

※Lua 5.2で廃止

これを行うには、テーブル全体を反復処理します。これはほぼ次のものと同等です。

function table.maxn( table )
    local maxn, k = 0, nil
    repeat
        k = next( table, k )
        if type( k ) == 'number' and k > maxn then
            maxn = k
        end
    until not k
    return maxn
end

table.remove[編集 | ソースを編集]

table.remove(t[, n])

テーブルtの位置nの要素を削除して、それ以降の要素を1つ前にずらします。削除された要素を返します。n省略時はテーブルtの最後尾を削除する事になります。

#tまでの要素がシフトされます。テーブルがシーケンスでない場合の注意事項については、長さ演算子を参照してください。

table.sort[編集 | ソースを編集]

table.sort(t[, f])

テーブルtの1から連続した正の整数のインデックスの要素を並び替えます。 table.sorttの先頭から要素2つを関数tに渡して呼び出し、 関数fが偽の値を返したとき、2つの値の位置を入れ替えます。 f省略時は<演算子で比較した結果によってソートします。

ソートのアルゴリズムは安定ではない。つまり、指定された順序において等しいと考えられる要素は、ソートによってその相対位置が変わるかもしれない。

Optimization (Garbage Collector)[編集 | ソースを編集]

Methods for collecting and flushing garbage[2] are unavailable in Scribunto[3].

出典[編集 | ソースを編集]

特に記載のない限り、コミュニティのコンテンツはCC-BY-SAライセンスの下で利用可能です。