Lua簡易リファレンス

• 基本ライブラリ
• assert
• collectgarbage
• dofile
• error
• _G
• getfenv
• getmetatable
• gcinfo
• ipairs
• loadfile
• loadlib
• loadstring
• next
• pairs
• pcall
• print
• rawequal
• rawget
• rawset
• require
• setfenv
• setmetatable
• tonumber
• tostring
• type
• unpack
• _VERSION
• xpcall
• 文字列操作
• テーブル操作
• 数学関数 (sin、logなど)
• 入出力
• OS機能
• デバッグ機能

基本ライブラリ

• 
  基本ライブラリはLuaへのコアな機能を提供する。
  アプリケーションにこのライブラリを含めない場合は、
  その機能を提供する代わりの実装を用意する必要があるか慎重に調べるべきである。

• assert (v [, message])
• 
  引数 v が nil か false であればエラーを発生させる。
  そうでなければ、v を返す。
  
  message はエラーメッセージを指定する。
  省略された場合は "assertion failed!" である。

• collectgarbage ([limit])
• 
  ガベージコレクションの閾値を指定されたlimit(キロバイト単位)に設定し、カウンタをチェックする。
  もし新しい閾値がカウンタよりも小さければ、Luaはすぐにガベージコレクタを走らせる。
  limit が省略された場合は 0 になる (つまり強制的にガベージコレクションを起こす)。

• dofile (filename)
• 
  ファイルを開き、その内容をLuaチャンクとして実行する。
  引数が指定されなければ、標準入力(stdin)から読み取って実行する。
  dofileはチャンクから返された値をそのまま返す。
  エラーが起きた場合は、呼び出し側に伝搬される (つまり保護モードではない)。

• error (message [, level])
• 
  最後に保護された関数呼び出しを終了し、message をエラーメッセージとして返す。
  関数 error は戻らない。
  
  level 引数は、エラーメッセージがエラーを指し示す場所を指定する。
  レベル1(デフォルト)では、error 関数を呼んだ場所がエラー位置である。
  レベル2は error を呼んだ関数を呼んだ位置を指す。以下同様である。

• _G
• 
  グローバル環境を保持するグローバル変数である(関数ではない)。
  つまり、_G._G = _G である。
  Lua自身はこの変数を使用しないので、この値を変更しても環境には何の影響もない。
  (環境を変えるにはsetfenvを使う)

• getfenv (f)
• 
  関数の現在の環境を返す。
  f はLuaの関数か、関数のスタックレベルを示す数値である。
  レベル1はgetfenvを呼んだ関数である。
  もし与えられた関数がLuaの関数でなかったり、fが0の場合は、getfenv はグローバル環境を返す。
  f のデフォルト値は1である。
  もしその環境が "__fenv" フィールドを持っていたら、環境の代わりにその値を返す。

• getmetatable (object)
• 
  もしobjectがメタテーブルを持っていなければ nil を返す。
  もしobjectのメタテーブルが "__metatable" フィールドを持っていれば、その値を返す。
  そうでなければobjectのメタテーブルを返す。

• gcinfo ()
• 
  この関数は2つの値を返す。
  Luaが使用中の動的メモリの量と、現在のガベージコレクタの閾値である。
  共にキロバイト単位である。

• ipairs (t)
• 
  イテレータ関数と、テーブル t と、0を返す。

• for i,v in ipairs(t) do ... end

• は (1,t[1])、(2,t[2])、…のペアを、最初に値にnilが現れるまで繰り返す。

• loadfile (filename)
• 
  ファイルを(実行せずに)Luaチャンクとして読み込む。
  エラーがなければ、コンパイルされたチャンクが関数として返され、
  そうでなければ nil とエラーメッセージが返される。
  返された関数の環境はグローバル環境である。

• loadlib (libname, funcname)
• 
  Cのダイナミックライブラリ libname をリンクする。
  このライブラリの内部で関数 funcname を検索し、この関数をCの関数として返す。
  
  libname はCのライブラリの、パスや拡張子を含む完全なファイル名でなければならない。
  
  この関数は ANSI C の範囲ではサポートされていない。
  いくつかのプラットフォーム(Winows, Linux, Solarix, BSD,
  dlfcn 標準をサポートする他のUnixシステム)でのみ利用可能である。

• loadstring (string [, chunkname])
• 
  文字列を(実行せずに)Luaのチャンクとしてロードする。
  エラーがなければ、コンパイルされたチャンクが関数として返され、
  そうでなければ、nilとエラーメッセージが返される。
  返された関数の環境はグローバル環境である。
  省略可能な引数 chunkname は、エラーメッセージやデバッグ情報で使われる名前である。
  
  与えられた文字列をロードして実行するには、以下の慣用句を使う。

• assert(loadstring(s))()

• next (table [, index])
• 
  テーブルの全フィールドを巡回するための関数である。
  最初の引数はテーブルを、二番目の引数はこのテーブルのインデックスを渡す。
  next はテーブル内の次のインデックスと、そのインデックスに関連付けられた値を返す。
  二番目の引数に nil を渡すと、テーブル内の最初のインデックスとその値が返される。
  最後のインデックスで呼び出すか、空のテーブルに対して nil で呼び出すと、 next は nil を返す。
  二番目の引数が省略された場合は nil と解釈される。
  
  Luaにはフィールド定義がない。
  テーブル内にフィールドが存在しないのと、nil 値が格納されたフィールドには、何の違いも無い。
  ゆえに、next は nil でない値を持つフィールドのみを考慮する。
  インデックスが列挙される順番は、数値のインデックスに対しても、不定である。
  (数値順にテーブルを巡回するには、数値用の for 文や ipairs 関数を使う)
  
  テーブルの巡回中に、もし存在していないフィールドに新たに値が割り当てられたら、next の動作は 未定義 である。

• pairs (t)
• 
  next 関数とテーブル t (と、加えて nil) を返す。

• for k,v in pairs(t) do ... end

• はテーブル t のすべてのキー・値ペアについて繰り返す。

• pcall (f, arg1, arg2, ...)
• 
  保護モードで、与えられた引数で f を呼び出す。
  つまり f の内部で発生したエラーは伝搬されず、代わりに pcall がエラーを捕らえ、ステータスコードを返す。
  最初の引数はステータスコード (ブーリアン型) で、エラーなしに呼び出しが成功したときは true を返す。
  その場合、f の戻り値もすべて、最初の戻り値に続いて返される。
  エラーが起こった場合、pcall は false とエラーメッセージを返す。

• print (e1, e2, ...)
• 
  引数をいくつでも取ることができ、それらの値をtostringで文字列に変換してから標準出力(stdout)に表示する。
  この関数は書式化出力を意図したものではなく、典型的にはデバッグのために、
  値を表示する簡単な方法として用意されているだけである。
  書式化出力にはformatを使う。

• rawequal (v1, v2)
• 
  メタメソッドを呼ぶことなしに v1 と v2 が等しいかどうか調べる。
  ブーリアンを返す。

• rawget (table, index)
• 
  メタメソッドを呼ぶことなしに table[index] の本当の値を得る。
  table はテーブルでなければならない。
  index は nil 以外のどんな値でも良い。

• rawset (table, index, value)
• 
  メタメソッドを呼ぶことなしに table[index] に value をセットする。
  table はテーブルでなければならない。
  index は nil 以外のどんな値でも良い。
  value はどんなLuaの値でも良い。

• require (packagename)
• 
  指定されたパッケージをロードする。
  この関数はまず _LOADED テーブルを検索し、packagename がすでにロードされているか確認する。
  もしロードされていれば、require は最初にロードされたパッケージを返す。
  ロードされていなければ、ファイルを検索してロードする。
  
  グローバル変数 LUA_PATH が文字列であれば、それは検索パスである。
  そうでなければ、require は環境変数 LUA_PATH を試してみる。
  最後の手段として、定義済みのパス "?;?.lua" を使う。
  
  パスはセミコロンで区切られた テンプレート の連なりである。
  各テンプレートに対して、テンプレート内の疑問符を packagename に置換し、
  その結果のファイル名でロードを試みる。
  例を挙げると、パスが

• "./?.lua;./?.lc;/usr/local/?/?.lua;/lasttry"

• であれば、require "mod" は以下のファイル名を順に試す。

• ./mod.lua ./mod.lc /usr/local/mod/mod.lua /lasttry

• ファイルがロードできたらそこで検索をやめて、ファイルを実行する。
  その後、_LOADED テーブルで、パッケージ名をキーにパッケージからの戻り値が関連付けられ、その値を返す。
  パッケージが nil を返した場合 (あるいは何も返さなかった場合)、require はこの値を true に変える。
  パッケージが false を返した場合、require も false を返す。
  この場合、_LOADED テーブルには false が格納され、再びファイルの再ロードを試みると、
  パッケージはロードされていないように振る舞う。(パッケージは再びロードされる)
  ファイルの再ロードを試みてもパッケージはロードされない。
  
  もしロードや実行の途中でエラーがおきたら、
  あるいはファイルがパス内に見つからなければ、require はエラーを発する。
  
  ファイルの実行中は、require はグローバル変数 _REQUIREDNAME を定義し、パッケージ名を格納する。
  ロードされたパッケージは常にグローバル環境内で実行される。

• setfenv (f, table)
• 
  指定された関数で使われる現在の環境を変更する。
  f はLuaの関数か、関数のスタックレベルを指定する数値である。
  レベル1は setfenv を呼び出した関数を示す。
  
  特殊なケースとして、fに0が与えられると、setfenv は走行中のスレッドのグローバル環境を変える。
  
  元の環境が "__fenv" フィールドを持っていると、setfenv はエラーを発生させる。

• setmetatable (table, metatable)
• 
  table のメタテーブルを変更する。(Luaからユーザーデータのメタテーブルを変更することはできない)
  もし metatable が nil であれば、table のメタテーブルは除去される。
  元のメタテーブルが "__metatable" フィールドを持っていると、エラーを発する。

• tonumber (e [, base])
• 
  引数を数値に変換しようとする。
  もし引数がすでに数値だったり、数値に変換可能な文字列であれば、tonumber は数値を返す。
  そうでなければ nil を返す。
  
  省略可能な引数は数値を解釈する際の基数を指定する。
  基数は2から36の整数を指定できる。
  10より大きい基数では、`A´が10を表し、`B´が11を表し、
  以下同様に続き、`Z´が35を表す。(大文字でも小文字でも良い)
  基数が10 (デフォルト) の場合 は、数値に小数部や指数部を付けることができる。
  他の基数では、符号なしの整数のみを受け付ける。

• tostring (e)
• 
  任意の型の引数を受け取り、理解しやすい形式の文字列に変換する。
  数値が変換される方法を完全にコントロールする場合は format を使う。
  
  もし e のメタテーブルが "__tostring" フィールドを持っていたら、
  e を引数に、その関連付けられた値が呼び出され、その戻り値が結果として使われる。

• type (v)
• 
  値の型を文字列で返す。
  この関数が返す値は以下のいずれかである。

• "nil" (という文字列。nil 値ではなく。) "number" "string" "boolean" "table" "function" "thread" "userdata"

• unpack (list)
• 
  与えられたリスト内のすべての要素を返す。
  この関数は、以下のコードには固定の n しか書けないことを除いて、以下のコードと等価である。

• return list[1], list[2], ..., list[n]

• 数値 n はリストの長さであり、table.getn 関数で定義される。

• _VERSION
• 
  現在のインタプリタのバージョン文字列を保持しているグローバル変数。(関数ではない)
  この文字列の内容は現在 "Lua 5.1" である。

• xpcall (f, err)
• 
  この関数は pcall に似ているが、エラーハンドラを指定できる点が異なる。
  
  xpcall は保護モードで f を呼び出し、 err をエラーハンドラとして使う。
  f の内部で発生したエラーは伝搬されない。
  代わりに、xpcall がエラーを捕らえ、エラーオブジェクトを引数に err を呼ぶ。
  最初の戻り値はステータスコード(ブーリアン型)で、エラーが起きなかった場合は true を返す。
  その場合、最初の戻り値に続いて f の戻り値もすべて返される。
  エラーが起きた場合、xpcall は false と err の戻り値を返す。