Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

シーン・単語レジストリとシーン検索

アンソニー(素)

同じ名前のシーンがいくつもございましたら、私ならくじ引きで決めてしまいそうでございます。

クローディア(驚き)

案外いい線を突いていますわね! pasta も、同じ名前の候補から乱数に従って 1 つを選びますのよ。

クローディア(素)

ただし、くじを引く前の段取りが肝心ですの。レジストリへの登録から辞書の確定、前方一致での候補集めまで、手際よくお連れいたしますわ。


この章では、シーン・単語のレジストリと、実行時のシーン検索・単語検索を扱う。

目的と責務

レジストリは、シーンと単語を名前で引ける形に集め、検索表へ変換する。検索表は前方一致で候補を集め、同名・同接頭辞の候補から 1 つを乱数に従って選ぶ。

この章が責務を持つのは次の事項である。

  • pasta_core のレジストリ(SceneRegistry・WordDefRegistry)と検索表(SceneTable・WordTable)、乱数の抽象(RandomSelector)
  • 検索キーの形式と、登録と検索が共有する照合規則(サニタイズ)、RadixMap による前方一致での候補の収集
  • 候補が複数あるときの選択(シャッフルと順次消費)と、その状態の持ち方
  • ローカル優先の検索順を、Lua 側の検索手順が @pasta_search の呼び出しでどう組み立てているか
  • 実行時の辞書確定のうち Rust 側の処理(finalize_scene による Lua 側の収集とレジストリの再構築)と、Lua 側との受け渡し
  • @pasta_search の実装(SearchContext)

辞書確定がトランスパイルからどうつながるか(2 段の段階構成)は トランスパイルパイプライン が権威を持ち、この章では再記述しない。Lua 側でシーン・単語を収集するテーブルの構造とモジュールの関数は Lua ランタイム内部モジュール で扱う。利用者から観測できる検索の挙動(スコープの優先順位・前方一致・シャッフル&順次消費)は、単語定義・Call / Jump・アクター辞書・@pasta_search が正である。

構成要素

pasta_core のレジストリと検索表

pasta_core は Lua に依存しないレジストリ層である。依存は thiserror・fast_radix_trie・rand だけである。

型所在役割
SceneRegistry・SceneEntrycrates/pasta_core/src/registry/scene_registry.rsシーンを登録順の Vec に集め、1 始まりの ID を振る。register_global・register_local はトランスパイル時の登録で、register_global は同名のグローバルシーンにサニタイズ後の名前ごとのカウンタで通し番号を振り、register_local は呼び出し側が渡すローカルの通し番号を使う。register_global_raw は辞書確定での登録で、通し番号付きの登録名をそのまま受け取る。registered_name は登録名を作り、split_registered_name は登録名を(名前, 通し番号)に分ける(登録名の構成)。merge_from はファイルごとのレジストリを統合する。sanitize_name は名前の英数字と _ 以外を _ に置き換える。登録と検索が共有する照合規則である(照合規則の共有)
SceneAliasTablecrates/pasta_core/src/registry/scene_alias.rsグローバルシーン名の別名表(別名 → 置き換え先)。resolve は書いた名前が別名に完全一致したときだけ置き換え先を返す(1 段だけ)。fingerprint はキャッシュの判定に使う正準な文字列を返す(トランスパイル結果キャッシュ)。builtin_default は内蔵の既定表(DEFAULT_ENTRIES の 7 件)を返し、with_written は [scene.alias] に書いた行をキーごとに既定表へ重ねる(書いた行だけを先に検証し、次に残った既定と合わせて検証する。既定とのぶつかりは ConflictsWithDefault・TargetIsDefaultAlias)。規則は シーン名の別名 が正である
ActorFont・FontInput・FontValue・FONT_ATTRIBUTEScrates/pasta_core/src/actor_font.rspasta.toml のアクターの装い(font)の検査と、\f[属性名,値] を書いた順に連ねたタグ列への変換。レジストリと検索表からは使わない。pasta.dll の設定読込(ローダ自己展開とモジュール解決)と pasta_check validate が、どちらもこの規則を使う。誤りは crates/pasta_core/src/error.rs の ActorFontError・FontValueProblem で返す。規則は 装い(font) が正である
SceneId・SceneScope・SceneInfocrates/pasta_core/src/registry/scene_types.rs検索表が持つシーン情報。SceneId は SceneTable 内の 0 始まりの添字である
SceneTablecrates/pasta_core/src/registry/scene_table.rsシーンの検索表。SceneInfo の Vec、前方一致の索引(RadixMap<Vec<SceneId>>)、選択状態のキャッシュ、RandomSelector を持つ。前方一致の resolve_scene_id_unified と完全一致の resolve_scene_id_exact の 2 つの解決と、指定したローカルシーンを持つグローバルシーンだけから選ぶ resolve_global_owning_local_exact を持つ
WordDefRegistry・WordEntrycrates/pasta_core/src/registry/word_registry.rs単語の定義を、検索キーと値のリストの組(WordEntry)として登録順に集める。グローバル・ローカル・アクターの 3 種の登録関数がキーの形式を決める
WordTable・WordCacheKeycrates/pasta_core/src/registry/word_table.rs単語の検索表。WordEntry の Vec、前方一致の索引(RadixMap<Vec<usize>>)、選択状態のキャッシュ、RandomSelector を持つ
RandomSelector・DefaultRandomSelector・MockRandomSelectorcrates/pasta_core/src/registry/random.rs乱数の抽象。トレイトが持つのは配列の並べ替え(shuffle_usize)1 つだけである。既定の実装はシステムの乱数で種を決めた StdRng でシャッフルし、モックは shuffle_usize で、渡された配列を指定列(位置の並び)に従って並べ替える
SceneTableError・WordTableErrorcrates/pasta_core/src/error.rs検索の失敗。シーンは SceneNotFound・NoMatchingScene・InvalidScene・RandomSelectionFailed などを返し、単語は WordNotFound だけを返す

レジストリは登録を集める側、検索表は検索する側である。SceneTable::from_scene_registry・WordTable::from_word_def_registry がレジストリを消費して検索表を作り、作った後の検索表は選択状態のキャッシュと RandomSelector 以外を変更しない。

@pasta_search の実装

要素所在役割
register・loadercrates/pasta_lua/src/search/mod.rs2 つのレジストリから SearchContext を作り、Lua のユーザーデータとして package.loaded["@pasta_search"] に置く
SearchContextcrates/pasta_lua/src/search/context.rsSceneTable と WordTable を 1 組ずつ所有する。Lua へ search_scene・search_scene_exact・search_local_scene_exact・search_word・set_scene_selector・set_word_selector・scene_aliases の 7 メソッドを公開する。scene_aliases は別名表を「置き換え先 → 別名の配列(辞書順)」の新しい表で返す(読み取り専用)。search_scene と search_scene_exact は本体(search_scene_by)を共有し、前方一致か完全一致かだけが異なる。search_scene・search_scene_exact の名前と search_word のスコープは、sanitize_name でサニタイズしてから検索表に渡す。別名表(SceneAliasTable)を 1 つ持ち、第 2 引数なしの search_scene・search_scene_exact でだけ使う(前方一致による候補の収集)
SearchErrorcrates/pasta_lua/src/search/error.rspasta_core のエラーを包み、Lua の RuntimeError に変換する

SearchContext は Lua VM ごとに 1 つであり、複数のランタイムの間で共有しない。

辞書確定(Rust 側)

crates/pasta_lua/src/runtime/finalize.rs が実行時の辞書確定を担う。

関数役割
register_finalize_sceneLua の pasta モジュールにあるスタブの finalize_scene を、Rust の関数で上書きする
finalize_scene_impl収集・レジストリの構築・@pasta_search の登録を順に行い、true を返す
collect_scenespasta.scene の get_all_scenes() から (グローバル名, ローカル名) の組を集める
collect_wordspasta.word の get_all_words() から、値のリスト 1 つにつき 1 つの WordCollectionEntry を作る
build_scene_registry・build_word_registry集めた組から SceneRegistry・WordDefRegistry を作る。build_scene_registry は登録の前に scene_order_key で(名前, 通し番号)の昇順に並べる

Lua 側の登録と検索の入口

モジュール所在この章に関わる役割
pasta.scenecrates/pasta_lua/pasta_scripts/pasta/scene.lua生成コードの create_scene でシーン関数を登録し、グローバル名の番号を振る。SCENE.search は search_scene の結果を、SCENE.co_exec_exact は search_scene_exact・search_local_scene_exact の結果をシーン関数に結び付ける
pasta.wordcrates/pasta_lua/pasta_scripts/pasta/word.lua生成コードの create_word などで単語の値を登録する
pastacrates/pasta_lua/pasta_scripts/pasta/init.luafinalize_scene のスタブを持つ(Rust が上書きする)
pasta.actcrates/pasta_lua/pasta_scripts/pasta/act.luafind_act_handler がローカル優先の検索順を組み立てる
pasta.actorcrates/pasta_lua/pasta_scripts/pasta/actor.luaアクタープロキシの find_actor_handler がアクター単語を検索する

これらのモジュールのフィールド・関数・データ構造は Lua ランタイム内部モジュール で扱う。

処理とデータの流れ

辞書確定

@pasta_search は 2 回登録される。1 回目は Lua VM の構築時(crates/pasta_lua/src/runtime/mod.rs)で、トランスパイル時の TranspileContext のレジストリから作られる。2 回目がここで述べる辞書確定で、検索の権威はこちらにある。どちらの登録も、RuntimeConfig.scene_aliases の同じ別名表を SearchContext に渡す。辞書確定へは、register_finalize_scene が受け取った表をクロージャに保持して渡す。ランタイムの構築(crates/pasta_lua/src/runtime/factory.rs)は、VM の構築とモジュールの登録の後に register_finalize_scene を呼び、main・pasta.shiori.entry を読み込んでから pasta.scene_dic を読み込む。scene_dic.lua は全シーンモジュールを require した後に require("pasta").finalize_scene() を呼び、ここで Rust の finalize_scene_impl が動く。

pasta.scene_dic
 ├ require("pasta.scene.…") × 全モジュール
 │   生成コードの実行 → pasta.scene / pasta.word が Lua 側のテーブルに登録
 └ require("pasta").finalize_scene()          … Rust: finalize_scene_impl
     1. collect_scenes: get_all_scenes() を走査
          {グローバル名: {__global_name__, ローカル名: 関数, …}}
          → __global_name__ を除く全キーを (グローバル名, ローカル名) の組に
          (1 件も無ければ警告ログ)
     2. collect_words: get_all_words() の global / local / actor を走査
          {キー: {{値…}, {値…}}} → 値のリスト 1 つにつき WordCollectionEntry 1 つ
     3. build_scene_registry: グローバル名ごとにまとめ、グローバル名・ローカル名とも
                             (名前, 通し番号)の昇順に並べて register_global_raw(属性は空)
        build_word_registry: アクター → register_actor、ローカル → register_local、
                             それ以外 → register_global
     4. search::register: SearchContext::with_aliases(両検索表を既定の乱数で構築し、別名表を持たせる)
          → package.loaded["@pasta_search"] を置き換える

register_global_raw は、グローバル名(メイン_1 のように通し番号を含む登録名)から メイン_1::__start__ を作ってグローバルシーンとして登録し、__start__ 以外のローカル名ごとに メイン_1::選択肢_1 の形でローカルシーンを登録する。カウンタは使わず、名前を作り直さない。グローバル名の通し番号は Lua 側の create_scene が全モジュールを通して振ったものであり、ローカル名はトランスパイラが生成したシーン関数名(選択肢_1 の形)と、Lua ブロックで定義した関数の名前である。

登録の順序は build_scene_registry が決める。グローバル名を scene_order_key で並べ、同じグローバルシーンの中のローカル名も同じキーで並べてから登録する。scene_order_key は、split_registered_name で分けた(名前, 通し番号)と登録名そのものの組である。通し番号は数値で比べ、通し番号の無い名前(__start__・加算ループ など)は同じ名前の通し番号のある名前より前になる。(名前, 通し番号)が同じになる名前(_01 と _1 など)は登録名の文字列の順で決まる。この順序は HashMap の走査順や Lua の pairs の順に依存せず、同じ入力から同じ登録順になる。同じ検索キーに入る同名シーンが通し番号の小さい順に並ぶのはこの登録順による(メイン_2 は メイン_10 より前。前方一致による候補の収集)。

収集の失敗(Lua のエラー)は finalize_scene の Lua エラーになり、pasta.scene_dic の読み込みの失敗として起動を止める。起動モジュールの失敗の扱いは ローダ自己展開とモジュール解決 で扱う。

登録名の構成

シーンの登録名は、照合用の名前(sanitize_name でサニタイズした名前)・区切りの _・通し番号(1 から)の 3 つからなる。作る規則は Rust の SceneRegistry::registered_name と Lua の SCENE.create_scene(base_name .. "_" .. 番号)の 2 か所にあり、同じ文字列を作る(シーンテーブル)。

シーン照合用の名前通し番号の数え方登録名の例
グローバルシーン宣言名(別名を置き換えた後のシーン名)をサニタイズしたもの照合用の名前ごとに全ファイルを通して数える(実行時は create_scene)1 つ目の *メイン は メイン_1、1 つ目の *挨拶・朝 は 挨拶_朝_1。別名で宣言したシーンは置き換え後の名前から作る(既定の表のもとで *OnTalk の無いゴーストの 1 つ目の *会話 は OnTalk_1)
名前付きローカルシーンローカルシーン名をサニタイズしたもの同じグローバルシーンの中で、照合用の名前ごとに数える・選択肢 の 1 つ目は 選択肢_1。・挨拶・1 と ・挨拶_1 は 挨拶_1_1 と 挨拶_1_2
  • 無名の開始シーンは登録名を持たず、関数名は __start__ である。
  • ローカルシーンの通し番号は、crates/pasta_lua/src/context.rs の local_scene_counters だけが数える。生成器(crates/pasta_lua/src/code_gen/scope_gen.rs)の関数名と、トランスパイル時のレジストリの register_local(crates/pasta_lua/src/transpiler.rs)の両方がこの番号を使うため、トランスパイル時のレジストリのローカルシーンの登録名は生成コードの関数名と一致する。名前付きのローカルシーンは 1 から、開始シーンは 0 で、0 は名前に使わない。
  • 登録名を分ける規則は Rust の SceneRegistry::split_registered_name の 1 か所だけである。最後の _ の後ろが 1 文字以上の半角数字(0〜9)で、_ の前が空でないときだけ(名前, 通し番号)に分ける。それ以外(__start__・加算ループ・_1・全角数字で終わる名前・usize に収まらない数字列)は、全体を通し番号の無い名前として扱う。
  • 生成された名前と Lua ブロックで直接定義した関数の名前は見分けない。SCENE.step_2 は(step, 2)に分かれ、SCENE.加算ループ は分かれない。
  • 区切りがあるため、*A1 の 1 つ目(A1_1)と *A の 11 個目(A_11)は別の登録名になり、split_registered_name も(A1, 1)と(A, 11)に分ける。

検索キーの形式

検索表は、レジストリの各項目から次の形式の検索キーを作り、RadixMap に入れる。シーンは SceneTable::from_scene_registry が関数名(fn_name)から fn_name_to_search_key で変換し、単語は WordDefRegistry の登録時にキーが決まる。辞書確定後の例を示す。

種類関数名(シーン)検索キー登録
グローバルシーンメイン_1::__start__メイン(:: より前の登録名から通し番号を除いた名前)register_global_raw
ローカルシーンメイン_1::選択肢_1:メイン_1:選択肢(:+親の登録名+:+ローカルの登録名から通し番号を除いた名前)register_global_raw
Lua ブロックで定義したシーン関数メイン_1::加算ループ・メイン_1::step_2:メイン_1:加算ループ・:メイン_1:stepregister_global_raw
グローバル単語—挨拶(単語名)register_global
ローカル単語—:メイン_1:場所(:+サニタイズしたシーンの登録名+:+単語名)register_local
アクター単語—:__actor_さくら__:通常(:__actor_+サニタイズしたアクター名+__:+単語名)register_actor
  • シーンの検索キーの名前の部分は、split_registered_name で登録名から通し番号を除いた照合用の名前である。分けられない名前は全体がキーになる。親の部分は登録名のままである(検索側は親の登録名で引くため)。
  • 同名のシーンは同じ検索キーに入る。*メイン が 10 個あれば、メイン_1〜メイン_10 はすべて検索キー メイン の項目になる。

ローカルとアクターのキーは : で始まり、グローバルのキーは : で始まらない。前方一致の範囲は、この先頭の : とスコープ名の後ろの : で区切られる。たとえば :メイン_1: で始まるキーに :メイン_10:… は含まれない。同じ単語キーに entry を複数回呼ぶと、同じキーの WordEntry が複数でき、索引の同じキーに登録順で並ぶ。

照合規則の共有

登録と検索は、同じ照合規則 SceneRegistry::sanitize_name を共有する。sanitize_name は、Unicode の英字・数字(char::is_alphanumeric。かな・漢字を含む)と _ 以外の文字を 1 文字ずつ _ に置き換える(WordDefRegistry::sanitize_name は同じ関数を呼ぶ)。利用者向けの章が「照合用の名前」と呼ぶものは、この関数でサニタイズした名前である(シーン名の照合)。

側サニタイズする名前サニタイズする所
登録グローバルシーンの基本名、名前付きローカルシーンの名前(_番号 を付ける前)生成器(crates/pasta_lua/src/code_gen/scope_gen.rs)。トランスパイル時の register_global・register_local も同じ
登録ローカル単語・アクター単語のスコープ名WordDefRegistry::register_local・register_actor
検索search_scene の第 1 引数(シーン名)SearchContext::search_scene の入口
検索search_word の第 2 引数(スコープ)SearchContext::search_word の入口
  • サニタイズしないのは、search_scene の第 2 引数(親のグローバル名)、単語キー(search_word の第 1 引数と、登録の単語名)、register_global_raw が受け取る番号付きの名前である。第 2 引数と register_global_raw には、サニタイズ済みの基本名から作った登録名(メイン_1)が渡る。
  • サニタイズは何度かけても結果が変わらない。そのため、登録名(メイン_1)をスコープとして search_word に渡しても、照合する名前は変わらない(_ はサニタイズで置き換わらない)。
  • A2 のスコープ名("__actor_" .. アクター名 .. "__")は元のアクター名から作られるが、search_word の入口でサニタイズされて __actor_+サニタイズしたアクター名+__ になり、register_actor のキーのスコープと一致する。
  • サニタイズ後の名前が同じになるグローバルシーン名・アクター名は、同じ名前として扱われる。グローバルシーンは同じ基本名のもとで通し番号が振られて同じ名前の候補になり、アクター単語は同じスコープのキーに入る。

前方一致による候補の収集

SearchContext の検索メソッドは、第 2 引数(親のグローバル名)の有無で検索表の呼び分けを変える。

呼び出し検索表の処理候補
search_scene(名前, nil)別名表で 名前 を置き換え → SceneTable::resolve_scene_id_unified("", サニタイズした名前) → collect_scene_candidatesサニタイズした(置き換えた後の)名前 で前方一致したキーのうち : で始まらないもののシーン
search_scene(名前, 親)SceneTable::resolve_scene_id_unified(親, サニタイズした名前) → collect_scene_candidates:親:サニタイズした名前 で前方一致したローカルシーンだけ
search_scene_exact(名前, nil)別名表で 名前 を置き換え → SceneTable::resolve_scene_id_exact("", サニタイズした名前)キーがサニタイズした(置き換えた後の)名前 と等しいシーン。: で始まるキーは候補にしない
search_scene_exact(名前, 親)SceneTable::resolve_scene_id_exact(親, サニタイズした名前)キーが :親:サニタイズした名前 と等しいローカルシーンだけ
search_local_scene_exact(グローバル名, ローカル名)別名表で グローバル名 を置き換え → SceneTable::resolve_global_owning_local_exact(サニタイズしたグローバル名, サニタイズしたローカル名) で親を 1 つ選ぶ → search_scene_exact(サニタイズしたローカル名, 選んだ親)1 段目はキーがサニタイズした(置き換えた後の)グローバル名 と等しいグローバルシーンのうち、:登録名:サニタイズしたローカル名 と等しいキーのローカルシーンを持つものだけ。2 段目はそのグローバルシーンの中の、その名前のローカルシーンだけ
search_word(名前, nil)WordTable::search_word("", 名前) → collect_word_candidates名前 で前方一致したキーのうち : で始まらないものの値すべて
search_word(名前, 親)WordTable::search_word(サニタイズした親, 名前) → collect_word_candidates:サニタイズした親:名前 で前方一致したキーの値すべて
  • 第 2 引数なしの search_scene は、サニタイズの前に、第 1 引数が別名表の別名に完全一致すれば置き換え先の名前にする(SceneAliasTable::resolve)。置き換えた後の名前で見つからなければ、書いた名前と置き換えた後の名前の両方を記した警告ログ(Scene not found (alias applied))を出す。候補のキャッシュのキーは置き換えた後の名前であるため、既定の表のもとで search_scene("会話") と search_scene("OnTalk") は同じ順次消費の記録を進める。第 2 引数ありの search_scene と search_word は置き換えない。
  • search_scene の第 1 引数は、サニタイズしてからそのまま検索キーと前方一致させる。登録名から通し番号を除くことはしない。検索キーは通し番号を含まないため、登録名を渡してもその登録名のシーンは指さない。search_scene("メイン_1") は 1 つ目の *メイン(検索キー メイン)ではなく、検索キーが メイン_1 で始まるシーン(*メイン・1 など)を探す。第 2 引数を指定したときの第 1 引数(ローカルシーン名)も同じである。
  • search_scene_exact は、索引をキーで直接引き(prefix_index.get)、検索キーと等しいキーの項目だけを候補にする。*つっつき反応胸 と *つっつき反応胸右 があるとき、search_scene("つっつき反応胸") は両方を候補にするが、search_scene_exact("つっつき反応胸") は *つっつき反応胸 だけを候補にする。同じキーの中の順・属性フィルタ・選択の方式は前方一致と同じである。利用者向けの規則は search_scene_exact が正である。
  • search_local_scene_exact の 2 つの引数は、どちらも作者が書く名前としてサニタイズする(第 2 引数ありの search_scene_exact のように、親を登録名で受けることはしない)。別名表で置き換えるのはグローバル名だけである。1 段目でローカルシーンを持つかの判定は、各候補の関数名から登録名(最初の :: の前)を取り出し、索引に :登録名:ローカル名 のキーがあるかを prefix_index.get で見る。グローバルシーンが無ければ SceneNotFound を返し、SearchContext は Lua へ nil, "global" を返す(置き換えたときは search_scene と同じ警告ログも出す)。グローバルシーンはあるが、どれもローカルシーンを持たなければ Ok(None) を返し、SearchContext は nil, "local" を返す。利用者向けの規則は search_local_scene_exact が正である。
  • どの経路も、ローカルに候補が無いときにグローバルへ移ることはない。ローカルからグローバルへの順序は Lua 側の検索手順が組み立てる(後述「ローカル優先の検索順」)。
  • 候補は RadixMap の iter_prefix が列挙する順に集まる。RadixMap はキーのバイト列の辞書順で列挙する。同じキーに複数の項目があれば、その中は登録順である。辞書確定の登録順は(名前, 通し番号)の昇順であるため(辞書確定)、同名シーンは通し番号の小さい順に並ぶ。
  • 単語の候補は項目ではなく値である。前方一致したすべての項目の値のリストを、上の順で 1 本につなげたものが候補になる。
  • シーンでは、候補を集めた後に属性フィルタ(filter_by_attributes)をかける。SearchContext は常に空のフィルタを渡し、辞書確定は属性を空で登録するため、実行時の検索ではフィルタは候補を減らさない。
  • シーン名が空文字列なら InvalidScene になる。単語名は空文字列を検査しない。

search_scene は、選ばれたシーンの関数名を最初の :: で分け、(グローバル名, ローカル名) の 2 値を Lua へ返す。第 2 引数なしの検索ではローカル名を常に __start__ にする。候補が無い・フィルタで全滅したなどの「見つからない」エラーは、Lua には値を返さない(受け取る側は nil)形になる。それ以外のエラー(空の名前など)は Scene search error: … の Lua エラーになる。search_word は見つかれば値の文字列、見つからなければ何も返さない。

候補の選択と乱数

候補が複数ある場合の選択は、シャッフルした候補を先頭から 1 つずつ使う方式(シャッフルと順次消費)である。選択の状態は検索表の中のキャッシュに持つ。

シーン(SceneTable::select_from_cache)単語(WordTable::search_word)
キャッシュのキーSceneCacheKey(親のグローバル名・サニタイズした検索キー・整列したフィルタ・完全一致かどうか(exact)・ローカルシーンを持つかの判定に使ったローカル名(owning_local。resolve_global_owning_local_exact だけが持ち、ほかは None)。第 2 引数なしは親を空文字列)WordCacheKey(サニタイズしたスコープ名・検索キー。第 2 引数なしは空文字列)
初回候補の ID をシャッフルしてキャッシュし、先頭を返す候補を集めてシャッフルし、先頭を返して残りをキャッシュする
2 回目以降次の ID を返す候補を集め直さず、キャッシュの次の値を返す
一巡した後その呼び出しで集めた候補(収集した順)をシャッフルし直して先頭から使う候補を集め直してシャッフルし、新しいキャッシュで置き換える
  • 一巡するまで同じ候補は選ばれない。一巡の境目では、前の巡の最後と次の巡の最初が同じになりうる。
  • シーンのキャッシュは選んだ ID の履歴(history)も記録するが、選択には使わない。
  • キャッシュは SearchContext の寿命の間、イベントをまたいで保たれる。辞書確定で SearchContext が作り直されると消える。
  • 前方一致と完全一致は exact でキャッシュのキーが異なる。同じ名前を search_scene と search_scene_exact で引いても、候補の集まりが異なるため、2 つの選択状態は独立に進む。
  • resolve_global_owning_local_exact は owning_local でキャッシュのキーが異なる。同じグローバル名を search_scene_exact で引いても、ローカル名の違う search_local_scene_exact で引いても、選択状態はそれぞれ独立に進む。
  • 第 2 引数あり・なしはキャッシュのキーが異なる。ローカル優先の検索順で同じ名前をローカル・グローバルの順に引いても、2 つの選択状態は独立に進む。

乱数は RandomSelector の shuffle_usize だけを通して使う。検索表は巡の始まり(初回と一巡した後)ごとに、候補を収集した順に並べた配列を shuffle_usize に渡し、並べ替えた結果をその巡の順にする。シーンは候補の ID の配列を、単語は候補の値の添字(0 から候補数 − 1)の配列を渡す。SearchContext の構築(with_aliases。new は空の別名表で with_aliases を呼ぶ)は、シーンと単語にそれぞれ別の DefaultRandomSelector を与える。Lua の set_scene_selector(n1, …)・set_word_selector(n1, …) は、引数があれば MockRandomSelector、無ければ新しい DefaultRandomSelector を作り、検索表の replace_selector で差し替える。差し替えはキャッシュを消す。引数は差し替えの前に parse_selector_args が検査し、負の整数は expected non-negative integer argument、整数でない引数は expected integer argument の Lua エラーにする。エラーのときは差し替えず、キャッシュも消さない。

MockRandomSelector は Lua に渡された整数の列(指定列)を持つ。shuffle_usize は指定列の整数を、渡された配列の 0 始まりの位置として読む(配列の値としては読まない)。有効な位置の値を指定列の順に先に置き、残りを元の順(収集した順)に並べる。配列の長さ以上の位置と、その呼び出しですでに置いた位置は読み飛ばす。並べ替えは呼び出しごとに指定列の先頭から始まり、モックは指定列のほかに状態を持たない。そのため、キャッシュのキーごと(検索ごと)にも巡ごとにも同じ順が当てはまる。これが利用者向け章の、候補の並びの位置による指定(set_scene_selector(…) / set_word_selector(…))の仕組みである。検索表にはシャッフルの有無を切り替える set_shuffle_enabled もあり、false のときは shuffle_usize を呼ばないため、候補は収集した順のまま使われ、指定列は効かない。set_shuffle_enabled は Lua からは呼べない(テスト用)。

ローカル優先の検索順

Rust 側は 1 回の呼び出しで 1 つのスコープしか検索しないため、利用者向け章が定める検索順は Lua 側の検索手順が組み立てる。単語参照・Call・式関数の呼び出しは、いずれも ACT_IMPL.find_act_handler(mode, key, skip_methods) を通る(mode は "word"・"scene"・"expr"。skip_methods は後述「動的参照の検索」)。

ACT_IMPL.find_act_handler(mode, key, skip_methods)
  L1  current_scene[key]                             完全一致
  L2  ローカル辞書の前方一致                         @pasta_search があり、実行中のシーンがあるとき
        word        → SEARCH:search_word(key, グローバル名)
        scene/expr  → SCENE.search(key, グローバル名) → .func
  L3  self[key] が関数なら採用                       ACT のメソッド
  L4  GLOBAL[key]                                    完全一致
  L5  グローバル辞書の前方一致                       @pasta_search があるとき
        word        → SEARCH:search_word(key, nil)
        scene/expr  → SCENE.search(key, nil) → .func

PROXY_IMPL.find_handler(mode, key, skip_methods)     act:actor_proxy("アクター"):word(…) など
  A1  actor[key]                                     word モードだけ。完全一致
  A2  SEARCH:search_word(key, "__actor_" .. アクター名 .. "__")
                                                     word モードだけ
  →   act:find_act_handler(mode, key, skip_methods)  L1〜L5 へ委譲
  • L2 のグローバル名は、実行中のシーンテーブルの __global_name__(メイン_1 の形の登録名)である。ACT_IMPL.init_scene がシーン関数の先頭で current_scene を設定し、途中の Call(act:call_restore)と関数を呼ぶメソッドが、戻った後に呼ぶ前の値へ戻す(シーン文脈の復元)。これがローカルキー :メイン_1:… の前方一致になる。
  • A2 のスコープ名 __actor_アクター名__ は、search_word の入口でサニタイズされてから :__actor_サニタイズしたアクター名__:キー の前方一致になり、register_actor のキーの形式と対応する(照合規則の共有)。
  • @pasta_search の取得は、find_act_handler・find_actor_handler とも呼び出しごとの pcall(require, "@pasta_search") で行う。
  • 見つかった値の後処理(関数なら呼ぶ、それ以外は文字列にする、見つからなければ失敗の報告)は ACT_IMPL.word・ACT_IMPL.call・ACT_IMPL.expr_fn・ACT_IMPL.expr_fn_var と、PROXY 側の word・expr_fn・expr_fn_var が行う(名前の解決のメソッド)。
  • グローバル関数の呼び出し(@*名前(…))の生成コード act:global_fn("名前", …) は、この検索手順を通らず GLOBAL[名前] だけを引く(生成コード用のメソッド)。

ACT_IMPL.find_scene は第 2 引数のグローバル名を使わず find_handler("scene", key) に委ねる。そのため、親を指定してローカルシーンを引く必要がある選択肢イベント(crates/pasta_lua/pasta_scripts/pasta/shiori/event/choice_select.lua)は、SCENE.search(名前, 親) を直接呼んでコルーチンを作る。親は、選択肢を出したグローバルシーン(Reference2)か STORE.last_global_scene である(既定ハンドラ)。シーンキック(crates/pasta_lua/pasta_scripts/pasta/shiori/event/kick.lua)は検索を使わず、シーン表のキーとの完全一致(SCENE.get・SCENE.get_start)で引く(キックの保留と起動)。OnPastaSceneAt の既定ハンドラも検索を使わず、位置から引いた登録名の組で SCENE.co_exec_registered を呼ぶ(位置でのシーンの再生)。

動的参照の検索

動的参照(@$変数名・@$変数名(…))では、変数の値が検索キーになる。生成コードは word(値, "変数の経路")・expr_fn_var(値, "変数の経路", 引数…) を呼び、値は WORD.dynamic_key が検索キーに変換する(変換規則は WORD.dynamic_key(value, var_path, via, act)、置き場所は 動的参照のキー)。キーに変換した後は、skip_methods を真にして同じ検索手順を通る。

skip_methods が真のとき(動的参照)
  A1  rawget(actor, key)              アクターオブジェクト自身のフィールドだけ
  A2  静的と同じ
  L1  rawget(current_scene, key)      シーンテーブル自身のキー(__global_name__・シーン関数)だけ
  L2  静的と同じ
  L3  探さない
  L4  静的と同じ(GLOBAL[key])
  L5  静的と同じ
  • L3 を飛ばすのは、変数の値が ACT のメソッド名(talk・yield など)と一致しても、そのメソッドを呼ばないためである。L1・A1 を rawget で引くのは、シーンテーブルの SCENE_TABLE_IMPL・アクターオブジェクトの ACTOR_IMPL からメタテーブル経由で継承した create_word などに一致させないためである。
  • GLOBAL はメタテーブルを持たない表として、静的と同じく GLOBAL[key] で引く。値が GLOBAL のキー(ランタイムが登録する yield・チェイントーク・close_ghost・ゴースト終了・pause_auto_talk・自動トーク停止・resume_auto_talk・自動トーク再開 を含む)と一致すれば、その値が見つかる。
  • 前方一致の段(L2・L5・A2)に渡すキーは、静的な参照で同じ名前を書いた場合と同じ文字列である。選択状態のキャッシュのキーも同じになるため、@$x(値が 挨拶)と @挨拶 は同じスコープでは 1 つの巡回を共有する。

検索結果からシーン関数へ

SCENE.search(name, global_scene_name) は @pasta_search の search_scene が返した (グローバル名, ローカル名) で Lua 側のシーンテーブルから関数を引き、結果オブジェクトにして返す(手順と結果オブジェクトの形は search と結果オブジェクト)。Rust 側が返すのは名前だけであり、シーン関数そのものは Rust を通らない。SCENE.co_exec は act:find_scene で得た関数をコルーチンで包む。SCENE.co_exec_exact(name, local_name) は search_scene_exact(name, nil) か search_local_scene_exact(name, local_name) の結果を SCENE.co_exec_registered に渡し、SCENE.get で引いた関数を co_exec と同じ包み方(wrap_scene)でコルーチンにする(co_exec_exact・co_exec_registered)。コルーチンの実行は ランタイム実行モデル で扱う。

境界の受け渡し

境界渡す側 → 受ける側渡すもの所有
Lua → Rust(辞書確定)pasta.scene・pasta.word → collect_scenes・collect_wordsget_all_scenes()・get_all_words() が返す Lua 側のテーブルテーブルは Lua 側が所有し続ける。Rust は読むだけで変更せず、名前と値を String に写して Vec に集める。シーン関数(Lua の関数)は写さない
辞書確定 → 検索build_scene_registry・build_word_registry → SearchContext::with_aliasesSceneRegistry・WordDefRegistry・SceneAliasTable値渡しで消費され、検索表に変換される
Rust → Lua(登録)search::register → Lua VMSearchContext のユーザーデータLua VM がユーザーデータを所有し、package.loaded["@pasta_search"] から参照される。置き換えられた古いユーザーデータは、Lua から参照されなくなれば回収される
Lua → Rust(検索)SCENE.search・SCENE.co_exec_exact(search_local_scene_exact を含む)・find_act_handler・find_actor_handler → SearchContext名前と親のグローバル名(search_local_scene_exact はグローバルシーン名とローカルシーン名。どちらも文字列)検索のたびに SearchContext のキャッシュを更新する(可変メソッド)
Rust → Lua(検索結果)SearchContext → 呼び出し側シーンは (グローバル名, ローカル名)、単語は値の文字列文字列の複製を返す。シーン関数への解決は Lua 側(SCENE.search)が行う
pasta_core ↔ pasta_luaレジストリ型と検索表の利用SceneRegistry・WordDefRegistry・SceneTable・WordTablepasta_core は Lua に依存しない。Lua との接続は pasta_lua の search と runtime/finalize.rs だけが持つ

不変条件と制約

  • 検索の権威は辞書確定後の SearchContext である。VM の構築から辞書確定までの間(main.lua・entry.lua の実行中)は、トランスパイル時のレジストリから作った SearchContext が登録されており、登録名の形式(メイン_1)と検索キー(通し番号を除いた照合用の名前)は確定後と同じだが、内容は確定後と異なる。トランスパイル時の通し番号はファイルごとに 1 から数えるため、複数のファイルにある同名のグローバルシーンは同じ登録名になる。キャッシュが使われて再トランスパイルされなかったファイルのシーンは入らない(@pasta_search の利用できる時期)。
  • 辞書確定は package.loaded["@pasta_search"] を新しいユーザーデータで置き換える。それ以前に require して保持した参照は古い SearchContext を指したままになる。ランタイムの Lua コードは、SCENE.search が呼び出し時に、find_act_handler・find_actor_handler が呼び出しごとに取得し直す。
  • Rust 側の検索は、1 回の呼び出しで 1 つのスコープだけを検索し、ローカルからグローバルへ移らない。
  • 第 2 引数なしの search_scene・search_scene_exact は、: で始まるローカルのキーを除外する。渡した名前の : はサニタイズで _ になるため、: で始まる名前を渡しても、ローカルシーンは候補にならない。
  • 登録キーと検索に使う名前は、同じ sanitize_name でサニタイズされる(照合規則の共有)。登録では、グローバルシーンの名前は生成コードがサニタイズした基本名に _ と通し番号を付けたもの、ローカルシーン名はサニタイズしたローカル名に _ と通し番号を付けたもの、ローカル単語・アクター単語のスコープ名は登録時にサニタイズされる。検索では、search_scene の名前と search_word のスコープが入口でサニタイズされる。search_scene の第 2 引数と単語キーはサニタイズされない。別名表は登録と検索で同じ表を使う。登録ではトランスパイラが宣言名を置き換え、検索では第 2 引数なしの search_scene がサニタイズの前に名前を置き換える。
  • 候補の列挙順はキーのバイト列の辞書順で決まり、同じキーの中は登録順(辞書確定では(名前, 通し番号)の昇順)である。
  • 検索表は構築後に項目を追加・削除しない。変化するのは選択状態のキャッシュと RandomSelector だけである。
  • SearchContext は Lua VM ごとに 1 つであり、検索表の選択状態はその VM の中だけで共有される。
  • 実行時の検索では属性フィルタは効かない(属性は空で登録され、フィルタも空で渡される)。

ソースの所在

  • crates/pasta_core/src/
  • crates/pasta_lua/src/search/
  • crates/pasta_lua/src/runtime/finalize.rs
  • crates/pasta_lua/pasta_scripts/pasta/scene.lua
  • crates/pasta_lua/pasta_scripts/pasta/word.lua

検索の入口として本文で参照した Lua 側の検索手順は crates/pasta_lua/pasta_scripts/pasta/act.lua・crates/pasta_lua/pasta_scripts/pasta/actor.lua に、finalize_scene のスタブは crates/pasta_lua/pasta_scripts/pasta/init.lua にあり、辞書確定を呼ぶ順序は crates/pasta_lua/src/runtime/factory.rs が決める。テストは crates/pasta_core/tests/word_table_test.rs、SceneTable のテストは crates/pasta_core/src/registry/scene_table_candidate_tests.rs・crates/pasta_core/src/registry/scene_table_resolve_filter_tests.rs にある。

経緯


クローディア(高笑い)

名前ひとつ引くのにも、これだけの段取りが控えておりますのよ! 奥が深いでしょう? 次は、見つけたシーンがどう動き出すのか、実行モデルへ参りましょう。

アンソニー(素)

表からは見えぬところで、ずいぶんと働いておるのでございますね。