文書の出典
- 出典
- Lua 5.5.1 Documentation
- 上流バージョン
- Lua 5.5.1
- 文書状態
- 翻訳
5 – 補助ライブラリ
補助ライブラリは、CとLuaを接続するための便利な関数をいくつか提供します。基本APIがCとLuaの間のすべてのやり取りに必要な基本関数を提供する一方で、補助ライブラリは一般的な処理の一部に高水準の関数を提供します。
補助ライブラリのすべての関数と型はヘッダーファイルlauxlib.hで定義され、接頭辞luaL_を持ちます。
補助ライブラリのすべての関数は基本APIの上に構築されているため、基本APIで実現できないものは提供しません。それでも、補助ライブラリを使うことでコードの一貫性が高まります。
補助ライブラリのいくつかの関数は、内部で追加のスタックスロットを使います。補助ライブラリの関数が使うスロットが5個未満の場合、スタックサイズを確認せず、十分なスロットがあると単純に仮定します。
補助ライブラリのいくつかの関数は、C関数の引数を検査するために使われます。エラーメッセージが引数向けに整形される(例:“bad argument #1”)ため、これらの関数をほかのスタック値に使うべきではありません。
luaL_check*と呼ばれる関数は、検査を満たさない場合に常にエラーを発生させます。