@toml

Claudia

文字列に書かれた TOML を、Lua の表に変える道具をご紹介いたしますわ。pasta.toml と同じ書式ですから、設定ファイルを書いたことのある方なら、もうお手のものですわね。

Anthony

では、JSON や YAML を読む道具はどちらに。

Claudia

ございませんわ。Pasta がデータを読み書きする書式は TOML ひとつ。その代わり、この子は最初からいつでも手元にございましてよ。

@toml は、TOML の文字列を Lua の表に変える（デコードする）モジュールである。持つ関数は decode の 1 つだけである。

local toml = require "@toml"

local t, err = toml.decode('name = "test"\nvalue = 42')
-- t.name == "test"、t.value == 42

読み込み方

require "@toml" で読む。設定は要らず、ランタイムの初期化の時（main.lua を読み込む前）から常に登録されている。

decode

toml.decode(text) は、TOML の文書を表す文字列 text を受け取り、一番外側のテーブルを Lua の表にして返す。

local toml = require "@toml"

local t = toml.decode([[
title = "設定"

[owner]
name = "クローディア"
born = 1979-05-27T07:32:00

[[items]]
id = 1

[[items]]
id = 2
]])

print(t.title)        -- 設定
print(t.owner.name)   -- クローディア
print(t.owner.born)   -- 1979-05-27T07:32:00（文字列）
print(t.items[2].id)  -- 2

TOML の型は、@pasta_config と同じ対応で Lua の値になる。

失敗の返し方

• TOML として正しくない文字列を渡すと、nil, エラーメッセージ の 2 値を返す。メッセージは誤りの位置を含み、複数行になることがある。
• 文字列でない引数（数値・表・nil など）を渡すと、戻り値ではなく Lua のエラーになる（bad argument #1 to 'decode' (string expected, got number) など）。

local t, err = toml.decode("key = ")
if not t then
    -- err に誤りの位置と理由が入る
end

encode は無い

@toml は encode を持たない。Lua の表を TOML の文字列に変える関数は無い。

JSON・YAML・正規表現の部品は無い

JSON・YAML を読み書きするモジュールと、正規表現のモジュールは無い。文字列は、Lua の標準の文字列の関数（string.find・string.match・string.gmatch・string.gsub）とそのパターンで調べる。使える標準ライブラリは Lua 標準ライブラリ にまとめてある。

Claudia

decode ひとつ、覚えることはそれだけですわ。失敗したら nil と理由が返ってまいりますから、確かめてから使ってくださいまし。

Anthony

書き出す道具が無いのは、少々寂しゅうございますね。

Claudia

読むだけで足りるよう、Pasta の側でセーブデータも設定も引き受けておりますの。あなたは中身を書くことに専念なさいまし。