mirror of
https://github.com/bryanthaboi/gen1recomp.git
synced 2026-08-25 23:11:15 +02:00
fix(mod-api): harden imported dataset views
This commit is contained in:
+15
-9
@@ -209,7 +209,7 @@ internals:
|
||||
```lua
|
||||
local gold, reason = mod.datasets:open("gold")
|
||||
if not gold then
|
||||
-- reason is "unknown_version" or "not_imported"
|
||||
-- reason is "unknown_version", "not_imported", or "invalid_cache"
|
||||
return
|
||||
end
|
||||
|
||||
@@ -223,15 +223,21 @@ end
|
||||
```
|
||||
|
||||
`view.version` and `view.generation` identify the selected dataset.
|
||||
`view.content` exposes the same registry names and generation-specific record
|
||||
shapes as `mod.content`, but only `get`, `has`, and `each`; returned
|
||||
records are detached copies and cannot mutate either dataset. Each open call
|
||||
receives an independent facade, so one mod cannot replace another mod view method. Engine-provided
|
||||
semantic records, such as `NORMAL>GHOST` type matchups, are included.
|
||||
`view.content` exposes the same registry names, aliases, generation routing,
|
||||
and data-only record shapes as `mod.content`, but only `get`, `has`, and
|
||||
`each`. Returned records are detached copies and cannot mutate either dataset.
|
||||
Records containing functions, userdata, threads, metatables, or cycles are not
|
||||
exposed. Each open call receives an independent facade, so one mod cannot
|
||||
replace another mod view method. Canonical boot shaping is included, such as
|
||||
Gen 1 defaults and Yellow corrections, and Gold's Foresight matchup rows and
|
||||
derived `held_items`.
|
||||
|
||||
Only a cache carrying the current engine completion marker is opened. Missing
|
||||
and stale imports both return `nil, "not_imported"`; no raw ROM bytes or
|
||||
generated Lua modules are exposed. `view.assets:path(relative)` and
|
||||
The marker and every required generated module for the selected version are
|
||||
rechecked on each open. Missing, partial, and stale imports return
|
||||
`nil, "not_imported"`; malformed or resource-limit-breaking generated data
|
||||
returns `nil, "invalid_cache"`. Generated modules are decoded with a bounded
|
||||
literal-only grammar and are never executed. No raw ROM bytes or generated
|
||||
source are exposed. `view.assets:path(relative)` and
|
||||
`view.assets:info(relative)` accept only `assets/generated/...` paths and
|
||||
keep them under the selected version cache prefix. The API never changes
|
||||
`mod.game`, the active `Data` table, `GameVersion`, or cache mount state.
|
||||
|
||||
@@ -342,6 +342,7 @@ accepted and merged as-is.
|
||||
| `source` | string |
|
||||
| `swarmGrass` | map of string -> {map?, rates, slots} |
|
||||
| `swarmWater` | map of string -> {map?, rate, slots} |
|
||||
| `timeFishGroups` | map of string | integer 0..255 -> {day, nite} |
|
||||
| `treeSets` | map of string -> {common, rare} |
|
||||
| `trees` | map of string -> string |
|
||||
| `water` | map of string -> {map?, rate, slots} |
|
||||
@@ -598,7 +599,7 @@ mod.content.map_songs:override("PALLET_TOWN", "Music_Routes1")
|
||||
| `id` | string | yes |
|
||||
| `index` | integer >= 0 | no |
|
||||
| `label` | string | no |
|
||||
| `objects` | list of any value | no |
|
||||
| `objects` | list of {pokemon?, ...} | no |
|
||||
| `palette` | string | no |
|
||||
| `signs` | list of any value | no |
|
||||
| `tileset` | tilesets id | yes |
|
||||
|
||||
+37
-20
@@ -1,4 +1,4 @@
|
||||
# RFC 0012: Read-only imported dataset views
|
||||
# RFC 0015: Read-only imported dataset views
|
||||
|
||||
## Status
|
||||
|
||||
@@ -15,10 +15,15 @@ generated Lua directly, or asking for a second raw-ROM import. They compose
|
||||
poorly with the active game, expose unstable import layout, and make safe
|
||||
read-only use impossible from the sandbox.
|
||||
|
||||
The immediate example is an optional content pack derived from an already
|
||||
verified Gold import while Red, Blue, or Yellow remains active. The capability
|
||||
is generic and useful to randomizers, compatibility inspectors, dex tools, and
|
||||
other cross-version content mods.
|
||||
The concrete consumer is **Adaptive Trainers**, whose approved Phase G Kanto+
|
||||
sidecar must derive nine Kanto-line continuations, Steel/type and move
|
||||
definitions, and generated sprites from the player's existing verified Gold
|
||||
cache while Red, Blue, or Yellow remains active. `mod.content` exposes only the
|
||||
active R/B/Y dataset; `mod.imports` can read only separately declared raw mod
|
||||
imports; and `mod.cache` is mod-private generated output. None can inspect the
|
||||
launcher-owned Gold semantic dataset without a second ROM import and mod-side
|
||||
ROM interpretation. The engine API remains generic and contains no Adaptive
|
||||
Trainers policy.
|
||||
|
||||
## Decision and plan extended
|
||||
|
||||
@@ -59,7 +64,8 @@ view = {
|
||||
}
|
||||
```
|
||||
|
||||
`get` returns a detached copy or nil. `has` reports semantic presence.
|
||||
`get` returns a bounded detached data-only copy or nil. `has` reports data-only
|
||||
semantic presence.
|
||||
`each` returns ids in lexical order and detached values. The registries use
|
||||
the selected version's generation routing and the engine's existing
|
||||
`Schemas`, `Registry`, and `Builtins` normalization, so structured sources
|
||||
@@ -74,10 +80,16 @@ accept only relative paths below `assets/generated/`, reject control
|
||||
characters, absolute paths, backslashes, and traversal, and expose no byte
|
||||
reader.
|
||||
|
||||
An unknown version returns `nil, "unknown_version"`. A missing or stale
|
||||
completion marker returns `nil, "not_imported"`. Generated tables are parsed
|
||||
under an empty environment and cached per version; the API never exposes raw
|
||||
ROM bytes, generated source, host paths, or a cache mount.
|
||||
An unknown version returns `nil, "unknown_version"`. A missing, partial, or
|
||||
stale cache returns `nil, "not_imported"`. A required module that is malformed
|
||||
or exceeds the limits (8 MiB per module, 48 MiB aggregate, depth 64, 500,000
|
||||
values, 2 MiB per string, or 250,000 entries per table) returns
|
||||
`nil, "invalid_cache"`; actionable detail is engine-logged but not exposed to
|
||||
the mod. Generated Lua is decoded with the existing restricted
|
||||
literal grammar and never executed. Functions, userdata, threads, metatables,
|
||||
cycles, non-table roots, binary chunks, and trailing syntax cannot cross the
|
||||
facade. Successful roots are decoded lazily and cached per selected version.
|
||||
The API never exposes raw ROM bytes, generated source, host paths, or a mount.
|
||||
|
||||
## Migration and compatibility
|
||||
|
||||
@@ -90,23 +102,28 @@ Opening a view does not change `GameVersion`, `CacheFs.prefix`, the active
|
||||
`Data` table, PhysFS mounts, save state, or the selected game's behavior.
|
||||
Red, Blue, Yellow, Gold, and Silver keep their existing active data paths.
|
||||
|
||||
The completion-marker format moves to the pure `CacheFormat` helper shared by
|
||||
the importer and dataset service. The literal marker and import readiness
|
||||
behavior are unchanged.
|
||||
The completion marker and per-version required-file rules live in the pure,
|
||||
injected `CacheContract` shared by the importer and dataset service. It also
|
||||
defines source-tree behavior. Neither consumer mutates `CacheFs.prefix` while
|
||||
checking readiness. Every `open` revalidates the contract and required module
|
||||
shapes; a stale/remove/reimport transition evicts the previous semantic view.
|
||||
|
||||
## Verification
|
||||
|
||||
- `tests/modkit/cases/dataset_views.lua` loads a sandboxed fixture mod through
|
||||
the public API and covers Red, Blue, Yellow, and Gold independently.
|
||||
- `tests/modkit/cases/dataset_views.lua` loads sandboxed fixture mods through
|
||||
the public API and covers Red, Blue, Yellow, Gold, and Silver independently.
|
||||
- The test proves semantic registry normalization, deterministic iteration,
|
||||
detached records, read-only facades, cross-mod facade isolation,
|
||||
version-prefixed generated assets,
|
||||
traversal rejection, stable failure reasons, and stale-marker rejection.
|
||||
- The same test proves that cross-version reads do not change the active data,
|
||||
active game, or cache prefix, and that a no-mod boot performs zero
|
||||
cross-version cache reads.
|
||||
- The existing importer and engine/modkit suites prove unchanged marker
|
||||
readiness and no-mod behavior.
|
||||
- It also proves missing/empty/partial/stale/remove/reimport behavior, hostile
|
||||
generated-source rejection, canonical Gen 1/Yellow/Gold hydration, and the
|
||||
approved Kanto+ Gold records and assets.
|
||||
- `tests/modkit/cases/dataset_views_nontermination.lua` proves generated code
|
||||
is rejected rather than executed; `tests/engine/generated_data_decoder_test.lua`
|
||||
proves every decoder resource bound.
|
||||
- `tests/engine/dataset_views_no_mod_parity.lua` is the separate guarded no-mod
|
||||
parity suite and proves the service stays unallocated with zero cache reads.
|
||||
|
||||
## Deprecation etiquette
|
||||
|
||||
+9
-7
@@ -82,8 +82,9 @@ local function copy(value)
|
||||
return out
|
||||
end
|
||||
|
||||
function Data:applyVersionedFieldData()
|
||||
if require("src.core.GameVersion").isYellow() then
|
||||
function Data:applyVersionedFieldData(version)
|
||||
version = version or require("src.core.GameVersion").get()
|
||||
if version == "yellow" then
|
||||
self.field.trades = copy(YELLOW_TRADES)
|
||||
-- The old man's catch demo is a RATTATA in Yellow
|
||||
-- (scripts/ViridianCity.asm ViridianCityOldManStartCatchTrainingScript
|
||||
@@ -106,7 +107,8 @@ end
|
||||
|
||||
-- Fills only what the cache is missing, so an importer that learns to
|
||||
-- stamp one of these keys silently takes over from the engine.
|
||||
function Data:seedDefaults()
|
||||
function Data:seedDefaults(version)
|
||||
version = version or require("src.core.GameVersion").get()
|
||||
local constants = self.constants or {}
|
||||
self.constants = constants
|
||||
self.field = self.field or {}
|
||||
@@ -131,7 +133,7 @@ function Data:seedDefaults()
|
||||
if constants.dexDigits == nil then
|
||||
constants.dexDigits = math.max(3, #tostring(constants.dexSize))
|
||||
end
|
||||
self:applyVersionedFieldData()
|
||||
Data.applyVersionedFieldData(self, version)
|
||||
local boot = self.field.boot
|
||||
if boot == nil then
|
||||
boot = {}
|
||||
@@ -144,7 +146,7 @@ function Data:seedDefaults()
|
||||
-- only the un-overridden default flips, so a total conversion that set
|
||||
-- field.boot.screens.splash keeps its choice on any version.
|
||||
if boot.screens.splash == BOOT_DEFAULTS.screens.splash
|
||||
and require("src.core.GameVersion").isYellow() then
|
||||
and version == "yellow" then
|
||||
boot.screens.splash = "YellowIntro"
|
||||
end
|
||||
-- the naming screen presets the importer already extracts but nothing
|
||||
@@ -163,11 +165,11 @@ function Data:seedDefaults()
|
||||
-- extractor never writes headers for them. Seed the EVENT_BEAT_* /
|
||||
-- after-battle rows so Blaine's SetEventRange deactivation and talk
|
||||
-- after-text work like the other gyms (scripts/CinnabarGym.asm).
|
||||
self:seedCinnabarGymTrainerHeaders()
|
||||
Data.seedCinnabarGymTrainerHeaders(self)
|
||||
-- #197: the Fighting Dojo Karate Master is text_asm, so the extractor
|
||||
-- writes no header for him -- seed one so he engages on sight and has
|
||||
-- his defeat / re-talk lines (same idea as the Cinnabar seed above).
|
||||
self:seedFightingDojoKarateMaster()
|
||||
Data.seedFightingDojoKarateMaster(self)
|
||||
-- #189: 1F cabin door order vs rooms map (survey zoom)
|
||||
require("src.world.SsAnneLayout").apply(self.maps)
|
||||
end
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
-- Canonical pure shaping shared by the active boot and inactive dataset views.
|
||||
-- The caller supplies both the data table and selected version; no global
|
||||
-- GameVersion, cache prefix, mount, or active Data table is changed.
|
||||
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
|
||||
local DatasetHydration = {}
|
||||
|
||||
function DatasetHydration.applyGen2(data, moduleLoader)
|
||||
local chart = data.type_chart or {}
|
||||
chart.matchups = chart.matchups or {}
|
||||
for _, row in ipairs(chart.foresightMatchups or {}) do
|
||||
chart.matchups[#chart.matchups + 1] = row
|
||||
end
|
||||
data.type_chart = chart
|
||||
data.gen2HeldItems =
|
||||
(moduleLoader or require)("src.core.gen2.ItemEffects").heldItemsFrom(data.items)
|
||||
return data
|
||||
end
|
||||
|
||||
function DatasetHydration.apply(data, version, moduleLoader)
|
||||
if GameVersion.generation(version) == 2 then
|
||||
return DatasetHydration.applyGen2(data, moduleLoader)
|
||||
end
|
||||
require("src.core.Data").seedDefaults(data, version)
|
||||
return data
|
||||
end
|
||||
|
||||
return DatasetHydration
|
||||
+1
-5
@@ -894,10 +894,7 @@ function Game2:load()
|
||||
self.data.type_chart = loadGenerated("data/generated/type_chart.lua") or {}
|
||||
-- data/types/type_matchups.asm:112-116: the rows after the `db -2` marker
|
||||
-- apply by default; Foresight is what cuts the table short at it.
|
||||
local chart = self.data.type_chart
|
||||
for _, row in ipairs(chart.foresightMatchups or {}) do
|
||||
chart.matchups[#chart.matchups + 1] = row
|
||||
end
|
||||
require("src.core.DatasetHydration").applyGen2(self.data)
|
||||
-- The `held_items` registry's merge target: ItemAttributes' last two columns
|
||||
-- as their own table, so a mod can give an item a held behaviour without
|
||||
-- owning the whole item record. Built BEFORE mods:load so the registry
|
||||
@@ -906,7 +903,6 @@ function Game2:load()
|
||||
-- changed from what a mod reached through the shared `items` registry
|
||||
-- instead. Both halves live in src/core/gen2/ItemEffects.lua.
|
||||
local ItemEffects = require("src.core.gen2.ItemEffects")
|
||||
self.data.gen2HeldItems = ItemEffects.heldItemsFrom(self.data.items)
|
||||
local heldBefore = ItemEffects.heldSnapshot(self.data.gen2HeldItems)
|
||||
-- Gen 2-only tables the menus read. Namespaced so nothing collides with the
|
||||
-- Gen 1 keys of the same idea (data.palettes, data.icons).
|
||||
|
||||
+70
-15
@@ -70,9 +70,27 @@ local function fail(state, why)
|
||||
error(("parse error at byte %d: %s"):format(state.pos, why), 0)
|
||||
end
|
||||
|
||||
local function limit(state, name)
|
||||
return state.limits and state.limits[name]
|
||||
end
|
||||
|
||||
local function bumpNode(state)
|
||||
state.nodes = state.nodes + 1
|
||||
local maximum = limit(state, "maxNodes")
|
||||
if maximum and state.nodes > maximum then fail(state, "too many values") end
|
||||
end
|
||||
|
||||
local function skip(state)
|
||||
local _, last = state.src:find("^[ \t\r\n]*", state.pos)
|
||||
state.pos = last + 1
|
||||
while true do
|
||||
local _, last = state.src:find("^[ \t\r\n]*", state.pos)
|
||||
state.pos = last + 1
|
||||
if not (state.limits and state.limits.allowComments
|
||||
and state.src:sub(state.pos, state.pos + 1) == "--") then
|
||||
return
|
||||
end
|
||||
local newline = state.src:find("\n", state.pos + 2, true)
|
||||
state.pos = newline and newline + 1 or (#state.src + 1)
|
||||
end
|
||||
end
|
||||
|
||||
local function peek(state)
|
||||
@@ -90,7 +108,10 @@ local function readString(state)
|
||||
fail(state, "unterminated string")
|
||||
elseif c == '"' then
|
||||
state.pos = i + 1
|
||||
return table.concat(out)
|
||||
local value = table.concat(out)
|
||||
local maximum = limit(state, "maxStringBytes")
|
||||
if maximum and #value > maximum then fail(state, "string too long") end
|
||||
return value
|
||||
elseif c == "\\" then
|
||||
local nxt = src:sub(i + 1, i + 1)
|
||||
if nxt:match("%d") then
|
||||
@@ -136,10 +157,14 @@ end
|
||||
local readValue
|
||||
|
||||
local function readTable(state)
|
||||
bumpNode(state)
|
||||
state.depth = state.depth + 1
|
||||
if state.depth > MAX_DEPTH then fail(state, "table nesting too deep") end
|
||||
if state.depth > (limit(state, "maxDepth") or MAX_DEPTH) then
|
||||
fail(state, "table nesting too deep")
|
||||
end
|
||||
state.pos = state.pos + 1
|
||||
local out = {}
|
||||
local entries, nextArray = 0, 1
|
||||
skip(state)
|
||||
if peek(state) == "}" then
|
||||
state.pos = state.pos + 1
|
||||
@@ -148,7 +173,7 @@ local function readTable(state)
|
||||
end
|
||||
while true do
|
||||
skip(state)
|
||||
local key
|
||||
local key, value
|
||||
local c = peek(state)
|
||||
if c == "[" then
|
||||
state.pos = state.pos + 1
|
||||
@@ -156,15 +181,38 @@ local function readTable(state)
|
||||
skip(state)
|
||||
if peek(state) ~= "]" then fail(state, "expected ]") end
|
||||
state.pos = state.pos + 1
|
||||
skip(state)
|
||||
if peek(state) ~= "=" then fail(state, "expected =") end
|
||||
state.pos = state.pos + 1
|
||||
value = readValue(state)
|
||||
elseif c:match("[%a_]") then
|
||||
key = readIdent(state)
|
||||
local start = state.pos
|
||||
local ident = readIdent(state)
|
||||
skip(state)
|
||||
if peek(state) == "=" then
|
||||
key = ident
|
||||
state.pos = state.pos + 1
|
||||
value = readValue(state)
|
||||
elseif state.limits and state.limits.allowArray then
|
||||
state.pos = start
|
||||
key = nextArray
|
||||
value = readValue(state)
|
||||
else
|
||||
fail(state, "expected =")
|
||||
end
|
||||
elseif state.limits and state.limits.allowArray then
|
||||
key = nextArray
|
||||
value = readValue(state)
|
||||
else
|
||||
fail(state, "expected key")
|
||||
end
|
||||
skip(state)
|
||||
if peek(state) ~= "=" then fail(state, "expected =") end
|
||||
state.pos = state.pos + 1
|
||||
out[key] = readValue(state)
|
||||
if key == nil then fail(state, "nil table key") end
|
||||
if out[key] ~= nil then fail(state, "duplicate table key") end
|
||||
entries = entries + 1
|
||||
local maximum = limit(state, "maxTableEntries")
|
||||
if maximum and entries > maximum then fail(state, "too many table entries") end
|
||||
out[key] = value
|
||||
if type(key) == "number" and key == nextArray then nextArray = nextArray + 1 end
|
||||
skip(state)
|
||||
local sep = peek(state)
|
||||
if sep == "," then
|
||||
@@ -189,25 +237,30 @@ readValue = function(state)
|
||||
skip(state)
|
||||
local c = peek(state)
|
||||
if c == '"' then
|
||||
bumpNode(state)
|
||||
return readString(state)
|
||||
elseif c == "{" then
|
||||
return readTable(state)
|
||||
elseif c:match("[%a_]") then
|
||||
-- the only bare words in the grammar are the boolean literals
|
||||
local word = readIdent(state)
|
||||
if word == "true" then return true end
|
||||
if word == "false" then return false end
|
||||
if word == "true" then bumpNode(state); return true end
|
||||
if word == "false" then bumpNode(state); return false end
|
||||
state.pos = state.pos - #word
|
||||
fail(state, "unexpected name '" .. word .. "'")
|
||||
elseif c:match("[%-%d%.]") then
|
||||
bumpNode(state)
|
||||
return readNumber(state)
|
||||
end
|
||||
fail(state, c == "" and "unexpected end of input" or "unexpected character")
|
||||
end
|
||||
|
||||
function SaveSerializer.decode(str)
|
||||
function SaveSerializer.decode(str, limits)
|
||||
if type(str) ~= "string" then return nil, "save must be a string" end
|
||||
local state = { src = str, pos = 1, depth = 0 }
|
||||
if limits and limits.maxBytes and #str > limits.maxBytes then
|
||||
return nil, ("input is %d bytes (max %d)"):format(#str, limits.maxBytes)
|
||||
end
|
||||
local state = { src = str, pos = 1, depth = 0, nodes = 0, limits = limits }
|
||||
local ok, result = pcall(function()
|
||||
skip(state)
|
||||
local word = state.src:match("^[%a_][%w_]*", state.pos)
|
||||
@@ -219,7 +272,9 @@ function SaveSerializer.decode(str)
|
||||
return value
|
||||
end)
|
||||
if not ok then return nil, result end
|
||||
if type(result) ~= "table" then return nil, "save root must be a table" end
|
||||
if type(result) ~= "table" then
|
||||
return nil, (limits and limits.rootName or "save") .. " root must be a table"
|
||||
end
|
||||
return result
|
||||
end
|
||||
|
||||
|
||||
@@ -0,0 +1,160 @@
|
||||
-- Pure version-scoped readiness rules shared by the importer and read-only
|
||||
-- dataset consumers. Callers inject a filesystem; no global cache prefix or
|
||||
-- active game state is changed while inspecting another version.
|
||||
|
||||
local CacheFormat = require("src.import.CacheFormat")
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
|
||||
local CacheContract = {}
|
||||
|
||||
CacheContract.MARKER_PATH = "rom-cache.complete"
|
||||
|
||||
local REQUIRED_FILES = {
|
||||
"data/generated/constants.lua", "data/generated/maps.lua",
|
||||
"data/generated/text.lua", "data/generated/field.lua",
|
||||
"data/generated/battle_anims.lua",
|
||||
"assets/generated/title/pokemon_logo.png",
|
||||
"assets/generated/fonts/font.png",
|
||||
"assets/generated/battle/front/pikachu.png",
|
||||
"assets/generated/battle/anims/move_anim_0.png",
|
||||
"assets/generated/battle/anims/move_anim_1.png",
|
||||
"assets/generated/audio/programs.bin",
|
||||
"assets/generated/trade/game_boy.png",
|
||||
}
|
||||
|
||||
local VERSION_REQUIRED_FILES = {
|
||||
yellow = {
|
||||
"assets/generated/battle/trainers/jessie_james.png",
|
||||
"assets/generated/battle/profoakb.png",
|
||||
"assets/generated/pikachu/pikapic_1.png",
|
||||
},
|
||||
}
|
||||
|
||||
local GOLD_REQUIRED_FILES = {
|
||||
"data/generated/constants.lua", "data/generated/maps.lua",
|
||||
"data/generated/roofs.lua", "data/generated/sprites.lua",
|
||||
"data/generated/scripts.lua", "data/generated/text.lua",
|
||||
"data/generated/rom_text.lua",
|
||||
"data/generated/pokemon.lua", "data/generated/tilesets.lua",
|
||||
"data/generated/audio.lua", "data/generated/marts.lua",
|
||||
"assets/generated/fonts/font.png", "assets/generated/fonts/frames.png",
|
||||
"assets/generated/title/pokemon_logo.png",
|
||||
"assets/generated/title/title_screen.png", "assets/generated/title/hooh.png",
|
||||
"assets/generated/title/hooh_5.png", "assets/generated/title/clouds.png",
|
||||
"assets/generated/title/copyright_splash.png",
|
||||
"data/generated/oak_speech.lua", "assets/generated/intro/oak.png",
|
||||
"assets/generated/intro/cal.png", "assets/generated/tilesets/johto.png",
|
||||
"assets/generated/tilesets/roofs/new_bark.png",
|
||||
"assets/generated/sprites/chris.png",
|
||||
"assets/generated/battle/front/chikorita.png",
|
||||
"assets/generated/battle/front/pikachu.png",
|
||||
"assets/generated/battle/front/marill.png",
|
||||
"assets/generated/battle/trainers/falkner.png",
|
||||
"assets/generated/battle/hud/balls.png",
|
||||
"assets/generated/audio/programs.bin",
|
||||
"assets/generated/slots/gold_slots_1.png",
|
||||
"assets/generated/card_flip/card_flip_1.png",
|
||||
"assets/generated/pc/mail_item.png",
|
||||
}
|
||||
|
||||
local SEMANTIC_MODULES = {
|
||||
[1] = {
|
||||
"constants", "maps", "tilesets", "text", "text_pointers",
|
||||
"trainer_headers", "font", "sprites", "pokemon", "moves", "items",
|
||||
"type_chart", "trainers", "encounters", "field", "battle_anims",
|
||||
},
|
||||
[2] = {
|
||||
"pokemon", "moves", "items", "type_chart", "audio", "font", "maps",
|
||||
"tilesets", "text", "trainers", "encounters", "sprites", "palettes",
|
||||
"icons", "battle_anims", "constants", "landmarks",
|
||||
},
|
||||
}
|
||||
|
||||
local OPTIONAL_SEMANTIC_MODULES = { [1] = { "audio", "palettes", "icons" }, [2] = {} }
|
||||
|
||||
local function copy(values)
|
||||
local out = {}
|
||||
for index, value in ipairs(values or {}) do out[index] = value end
|
||||
return out
|
||||
end
|
||||
|
||||
function CacheContract.requiredFiles(version, semantic)
|
||||
local files
|
||||
if version == "gold" or version == "silver" then
|
||||
files = copy(GOLD_REQUIRED_FILES)
|
||||
else
|
||||
files = copy(REQUIRED_FILES)
|
||||
for _, path in ipairs(VERSION_REQUIRED_FILES[version] or {}) do
|
||||
files[#files + 1] = path
|
||||
end
|
||||
end
|
||||
if semantic then
|
||||
local generation = GameVersion.generation(version)
|
||||
for _, name in ipairs(SEMANTIC_MODULES[generation] or {}) do
|
||||
files[#files + 1] = "data/generated/" .. name .. ".lua"
|
||||
end
|
||||
end
|
||||
local unique, out = {}, {}
|
||||
for _, path in ipairs(files) do
|
||||
if not unique[path] then unique[path], out[#out + 1] = true, path end
|
||||
end
|
||||
return out
|
||||
end
|
||||
|
||||
function CacheContract.semanticModules(version)
|
||||
return copy(SEMANTIC_MODULES[GameVersion.generation(version)])
|
||||
end
|
||||
|
||||
function CacheContract.optionalSemanticModules(version)
|
||||
return copy(OPTIONAL_SEMANTIC_MODULES[GameVersion.generation(version)])
|
||||
end
|
||||
|
||||
local function isFile(fs, path)
|
||||
local info = fs.getInfo and fs.getInfo(path, "file")
|
||||
if info then return info.type == nil or info.type == "file" end
|
||||
return false
|
||||
end
|
||||
|
||||
local function hasFiles(version, fs, prefix, semantic)
|
||||
for _, path in ipairs(CacheContract.requiredFiles(version, semantic)) do
|
||||
if not isFile(fs, prefix .. path) then return false, path end
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
local function sourcePrefix(version)
|
||||
return version == "red" and "" or GameVersion.cachePrefix(version)
|
||||
end
|
||||
|
||||
local function sourceReady(version, fs, semantic)
|
||||
if not (fs.getRealDirectory and fs.getSource) then return nil end
|
||||
local prefix = sourcePrefix(version)
|
||||
local ok = hasFiles(version, fs, prefix, semantic)
|
||||
if not ok then return nil end
|
||||
local first = prefix .. CacheContract.requiredFiles(version, semantic)[1]
|
||||
if fs.getRealDirectory(first) ~= fs.getSource() then return nil end
|
||||
return { kind = "source", prefix = prefix }
|
||||
end
|
||||
|
||||
function CacheContract.inspect(version, fs, opts)
|
||||
opts = opts or {}
|
||||
if not (GameVersion.VERSIONS[version] and fs and fs.read and fs.getInfo) then
|
||||
return nil, "not_imported", "unsupported cache inspection"
|
||||
end
|
||||
if opts.allowSource then
|
||||
local source = sourceReady(version, fs, opts.semantic)
|
||||
if source then return source end
|
||||
end
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
local marker = fs.read(prefix .. CacheContract.MARKER_PATH)
|
||||
if not CacheFormat.matches(version, marker) then
|
||||
return nil, "not_imported", "completion marker is missing or stale"
|
||||
end
|
||||
local complete, missing = hasFiles(version, fs, prefix, opts.semantic)
|
||||
if not complete then
|
||||
return nil, "not_imported", "required cache file is missing: " .. missing
|
||||
end
|
||||
return { kind = "cache", prefix = prefix, marker = marker }
|
||||
end
|
||||
|
||||
return CacheContract
|
||||
+14
-5
@@ -324,9 +324,9 @@ function CacheFs.openWrite(rel)
|
||||
return file
|
||||
end
|
||||
|
||||
-- read cache-relative `rel`; returns the bytes or nil
|
||||
function CacheFs.read(rel)
|
||||
rel = withPrefix(rel)
|
||||
-- Read an exact version-qualified path without consulting CacheFs.prefix.
|
||||
-- Readiness checks use this to inspect another version without global state.
|
||||
function CacheFs.readAt(rel)
|
||||
local root = CacheFs.root()
|
||||
if root then
|
||||
local f = io.open(realPath(root, rel), "rb")
|
||||
@@ -341,6 +341,11 @@ function CacheFs.read(rel)
|
||||
return love.filesystem.read(rel)
|
||||
end
|
||||
|
||||
-- read cache-relative `rel`; returns the bytes or nil
|
||||
function CacheFs.read(rel)
|
||||
return CacheFs.readAt(withPrefix(rel))
|
||||
end
|
||||
|
||||
-- Read cache-relative `rel` for the active GameVersion when PhysFS may hide
|
||||
-- prefixed Blue/Yellow/Gold trees (fused NX mount hole). Same order Data:load
|
||||
-- already used: active version prefix with CacheFs.prefix cleared, then
|
||||
@@ -386,8 +391,7 @@ function CacheFs.loadActive(rel)
|
||||
end
|
||||
|
||||
-- does cache-relative `rel` exist as a file?
|
||||
function CacheFs.exists(rel)
|
||||
rel = withPrefix(rel)
|
||||
function CacheFs.existsAt(rel)
|
||||
local root = CacheFs.root()
|
||||
if root then
|
||||
local f = io.open(realPath(root, rel), "rb")
|
||||
@@ -398,6 +402,11 @@ function CacheFs.exists(rel)
|
||||
return love.filesystem.getInfo(rel, "file") ~= nil
|
||||
end
|
||||
|
||||
|
||||
function CacheFs.exists(rel)
|
||||
return CacheFs.existsAt(withPrefix(rel))
|
||||
end
|
||||
|
||||
-- remove a single cache-relative file
|
||||
function CacheFs.remove(rel)
|
||||
rel = withPrefix(rel)
|
||||
|
||||
+17
-166
@@ -1,5 +1,6 @@
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
local CacheFormat = require("src.import.CacheFormat")
|
||||
local CacheContract = require("src.import.CacheContract")
|
||||
local GamepadMap = require("src.core.GamepadMap")
|
||||
local Logger = require("src.core.Logger")
|
||||
local Strings = require("src.core.Strings")
|
||||
@@ -38,13 +39,13 @@ end
|
||||
-- the same unbootable save as before.
|
||||
-- Deliberately NOT bumped for the Gold trainer-pic gap: this tag invalidates
|
||||
-- every version at once, and that gap is Gold-only. A per-version marker in
|
||||
-- VERSION_REQUIRED_FILES_OVERRIDE.gold re-imports exactly the caches that lack
|
||||
-- the stage, which is what the Yellow markers below already do for #439/#557.
|
||||
-- CacheContract's Gold required-file list re-imports exactly the caches that
|
||||
-- lack the stage, the same per-version mechanism used for Yellow #439/#557.
|
||||
-- Reach for a bump when the change spans versions or has no single file to
|
||||
-- point at.
|
||||
-- The completion marker is written under each version's cache prefix
|
||||
-- (red/rom-cache.complete, blue/rom-cache.complete, ...).
|
||||
local MARKER_PATH = "rom-cache.complete"
|
||||
local MARKER_PATH = CacheContract.MARKER_PATH
|
||||
|
||||
-- The marker a finished import writes for a version: the generation tag plus
|
||||
-- that version's ROM hash, so both a format bump and a swapped ROM invalidate.
|
||||
@@ -56,109 +57,6 @@ local TRUST_WARNING = "if you did not get this from bryanthaboi's github " ..
|
||||
"or a link from the discord that bryanthaboi himself posted, just know " ..
|
||||
"it might have been tampered with. go to the discord to verify " ..
|
||||
COMMUNITY_URL .. " (or click the logo above)"
|
||||
local REQUIRED_FILES = {
|
||||
"data/generated/constants.lua",
|
||||
"data/generated/maps.lua",
|
||||
"data/generated/text.lua",
|
||||
"data/generated/field.lua",
|
||||
"data/generated/battle_anims.lua",
|
||||
"assets/generated/title/pokemon_logo.png",
|
||||
"assets/generated/fonts/font.png",
|
||||
"assets/generated/battle/front/pikachu.png",
|
||||
"assets/generated/battle/anims/move_anim_0.png",
|
||||
"assets/generated/battle/anims/move_anim_1.png",
|
||||
"assets/generated/audio/programs.bin",
|
||||
-- The trade cinematic's Game Boy / cable art. Caches built before #750
|
||||
-- carry none of it and fall back to plain rectangles, so listing one of
|
||||
-- the files re-imports them without a CACHE_FORMAT bump.
|
||||
"assets/generated/trade/game_boy.png",
|
||||
}
|
||||
|
||||
-- Files only one version's cache carries. A version that predates one of
|
||||
-- them re-imports on its own, without dragging the other versions through a
|
||||
-- CACHE_FORMAT bump.
|
||||
local VERSION_REQUIRED_FILES = {
|
||||
yellow = {
|
||||
"assets/generated/battle/trainers/jessie_james.png", -- #439
|
||||
-- Oak's own back pic and the pikapic base frames only exist in caches
|
||||
-- built after their manifest symbols landed, so an older Yellow cache
|
||||
-- has to re-import to stop falling back to the old man's back pic and
|
||||
-- to the battle front pic (#557, #561). Both are gated on manifest
|
||||
-- symbols in RomExtractor, so these markers must only ever list files
|
||||
-- tools/rom_manifest_yellow.json can actually produce -- otherwise the
|
||||
-- cache reads as incomplete and re-importing cannot clear it.
|
||||
"assets/generated/battle/profoakb.png",
|
||||
"assets/generated/pikachu/pikapic_1.png",
|
||||
},
|
||||
}
|
||||
|
||||
-- Gold Phase 1 writes a thinner cache than Gen 1 (no battle anim sheets,
|
||||
-- trade art, or field.lua payload yet -- see docs/gold-phase1.md). This
|
||||
-- list replaces REQUIRED_FILES entirely for that version so a successful
|
||||
-- Gen 2 extract is not stuck as "incomplete" waiting on Gen 1 markers.
|
||||
local VERSION_REQUIRED_FILES_OVERRIDE = {
|
||||
gold = {
|
||||
"data/generated/constants.lua",
|
||||
"data/generated/maps.lua",
|
||||
"data/generated/roofs.lua", -- Phase 2: forces re-import of Phase 1 caches
|
||||
"data/generated/sprites.lua", -- OW sheets (Chris + NPCs)
|
||||
"data/generated/scripts.lua", -- disassembled map scripts
|
||||
"data/generated/text.lua", -- decoded Gen 2 dialogue strings
|
||||
-- The engine's own strings, keyed by label rather than by address. A
|
||||
-- cache built before RomExtractorGen2:extractText has none, and every
|
||||
-- line that reads through src/core/RomText.lua would silently keep
|
||||
-- printing its Lua fallback, so this re-imports those caches rather than
|
||||
-- bumping CACHE_FORMAT and dragging Red, Blue and Yellow through it too.
|
||||
"data/generated/rom_text.lua",
|
||||
"data/generated/pokemon.lua",
|
||||
"data/generated/tilesets.lua",
|
||||
"data/generated/audio.lua",
|
||||
-- Mart shelves + the heal machine art ride the same import, so listing
|
||||
-- marts.lua alone re-imports the caches from before either existed
|
||||
-- (empty shop shelves, no Pokecenter light show).
|
||||
"data/generated/marts.lua",
|
||||
"assets/generated/fonts/font.png",
|
||||
"assets/generated/fonts/frames.png", -- the seven other OPTION textbox frames
|
||||
"assets/generated/title/pokemon_logo.png",
|
||||
"assets/generated/title/title_screen.png", -- TitleScreenTilemap composition
|
||||
"assets/generated/title/hooh.png",
|
||||
"assets/generated/title/hooh_5.png", -- wing-flap frames force re-import
|
||||
"assets/generated/title/clouds.png",
|
||||
"assets/generated/title/copyright_splash.png",
|
||||
"data/generated/oak_speech.lua", -- Oak texts + trainer pics
|
||||
"assets/generated/intro/oak.png",
|
||||
"assets/generated/intro/cal.png",
|
||||
"assets/generated/tilesets/johto.png",
|
||||
"assets/generated/tilesets/roofs/new_bark.png",
|
||||
"assets/generated/sprites/chris.png",
|
||||
"assets/generated/battle/front/chikorita.png",
|
||||
"assets/generated/battle/front/pikachu.png",
|
||||
"assets/generated/battle/front/marill.png", -- Oak speech demo mon
|
||||
-- The trainer class pics (TrainerPicPointers). FALKNER is row 0 of that
|
||||
-- table, so a cache that produced any class pic at all produced this one.
|
||||
-- Listed for the reason the Yellow markers above are: a cache built before
|
||||
-- the stage existed reads as INCOMPLETE and re-imports itself, so this
|
||||
-- particular gap cannot survive a tag bump being forgotten again. It
|
||||
-- costs nothing on a current cache and is the difference between every
|
||||
-- trainer battle opening with a picture and opening with none.
|
||||
"assets/generated/battle/trainers/falkner.png",
|
||||
-- BattleStart_TrainerHuds cannot draw its party rows from a cache made
|
||||
-- before the four ball tiles were extracted (#1502).
|
||||
"assets/generated/battle/hud/balls.png",
|
||||
"assets/generated/audio/programs.bin",
|
||||
-- Goldenrod Game Corner reel + board art (#1581). menu_gfx.lua used to
|
||||
-- advertise these paths even when Slots*LZ / CardFlip* were absent from
|
||||
-- the manifest, so a cache that never wrote the PNGs still looked
|
||||
-- complete and SlotMachine crashed on its labelled-cell fallback.
|
||||
"assets/generated/slots/gold_slots_1.png",
|
||||
"assets/generated/card_flip/card_flip_1.png",
|
||||
-- PCMailGFX (engine/pokemon/bills_pc.asm:2170-2173)
|
||||
"assets/generated/pc/mail_item.png",
|
||||
},
|
||||
}
|
||||
-- Same Gen 2 extract, so a Silver cache is complete when the same files exist.
|
||||
VERSION_REQUIRED_FILES_OVERRIDE.silver = VERSION_REQUIRED_FILES_OVERRIDE.gold
|
||||
|
||||
-- "Split-screen ROM selector" first-run palette (matches the FirstRun mockup):
|
||||
-- a dark neon arcade panel, one column per game.
|
||||
-- Red, Blue, and Yellow share the same importer flow once listed in
|
||||
@@ -211,58 +109,6 @@ local PAL = {
|
||||
chipInkGold = { 58, 44, 0 }, -- #3a2c00 dark "Y" on the gold chip
|
||||
}
|
||||
|
||||
-- Per-version required cache files. Gold replaces the Gen 1 list entirely
|
||||
-- (VERSION_REQUIRED_FILES_OVERRIDE); Yellow adds a few extra markers.
|
||||
local function requiredFilesFor(version)
|
||||
local override = VERSION_REQUIRED_FILES_OVERRIDE[version]
|
||||
if override then return override, true end
|
||||
return REQUIRED_FILES, false
|
||||
end
|
||||
|
||||
-- CacheFs.exists checks the game folder directly for a portable install,
|
||||
-- otherwise the save directory through love.filesystem. It honors
|
||||
-- CacheFs.prefix, so we point it at the version's cache subtree (red/,
|
||||
-- blue/, yellow/, gold/).
|
||||
local function allRequiredFilesExist(version)
|
||||
local CacheFs = require("src.import.CacheFs")
|
||||
local saved = CacheFs.prefix
|
||||
CacheFs.prefix = GameVersion.cachePrefix(version)
|
||||
local ok = true
|
||||
local required, isOverride = requiredFilesFor(version)
|
||||
for _, path in ipairs(required) do
|
||||
if not CacheFs.exists(path) then ok = false; break end
|
||||
end
|
||||
if ok and not isOverride then
|
||||
for _, path in ipairs(VERSION_REQUIRED_FILES[version] or {}) do
|
||||
if not CacheFs.exists(path) then ok = false; break end
|
||||
end
|
||||
end
|
||||
CacheFs.prefix = saved
|
||||
return ok
|
||||
end
|
||||
|
||||
-- A developer checkout / Python build leaves generated data in the physfs
|
||||
-- source: Red at the historical root, Blue/Yellow/Gold in their versioned
|
||||
-- trees. Imported Red caches still live under red/. Check source paths
|
||||
-- directly so that cache prefix cannot hide Red's source tree, and keep
|
||||
-- save-dir caches from counting as current source data.
|
||||
local function sourceTreeHasData(version)
|
||||
if not love.filesystem.getRealDirectory then return false end
|
||||
local prefix = version == "red" and "" or GameVersion.cachePrefix(version)
|
||||
local required, isOverride = requiredFilesFor(version)
|
||||
for _, path in ipairs(required) do
|
||||
if love.filesystem.getInfo(prefix .. path, "file") == nil then return false end
|
||||
end
|
||||
if not isOverride then
|
||||
for _, path in ipairs(VERSION_REQUIRED_FILES[version] or {}) do
|
||||
if love.filesystem.getInfo(prefix .. path, "file") == nil then return false end
|
||||
end
|
||||
end
|
||||
local path = prefix .. required[1]
|
||||
local real = love.filesystem.getRealDirectory(path)
|
||||
return real == love.filesystem.getSource()
|
||||
end
|
||||
|
||||
-- ------- ROM cache location
|
||||
--
|
||||
-- The extracted cache (data/generated, assets/generated) plus the
|
||||
@@ -318,7 +164,8 @@ local function purgeSaveDirCache()
|
||||
-- / yellow/ / gold/ prefix) so it cannot shadow the portable game-folder cache.
|
||||
for _, version in ipairs(GameVersion.ORDER) do
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
if saveDirHas(prefix .. MARKER_PATH) or saveDirHas(prefix .. REQUIRED_FILES[1]) then
|
||||
local probe = CacheContract.requiredFiles(version)[1]
|
||||
if saveDirHas(prefix .. MARKER_PATH) or saveDirHas(prefix .. probe) then
|
||||
removeTree(prefix .. "data/generated")
|
||||
removeTree(prefix .. "assets/generated")
|
||||
love.filesystem.remove(prefix .. MARKER_PATH)
|
||||
@@ -336,13 +183,17 @@ function RomImporter.isReady(version)
|
||||
-- save-directory copy that would otherwise shadow it at runtime.
|
||||
purgeSaveDirCache()
|
||||
end
|
||||
-- Generated data in a developer checkout / Python build is always current.
|
||||
if sourceTreeHasData(version) then return true end
|
||||
local saved = CacheFs.prefix
|
||||
CacheFs.prefix = GameVersion.cachePrefix(version)
|
||||
local marker = CacheFs.read(MARKER_PATH)
|
||||
CacheFs.prefix = saved
|
||||
return marker == markerFor(version) and allRequiredFilesExist(version)
|
||||
local backing = {
|
||||
read = CacheFs.readAt,
|
||||
getInfo = function(path)
|
||||
return CacheFs.existsAt(path) and { type = "file" } or nil
|
||||
end,
|
||||
}
|
||||
if love and love.filesystem then
|
||||
backing.getRealDirectory = love.filesystem.getRealDirectory
|
||||
backing.getSource = love.filesystem.getSource
|
||||
end
|
||||
return CacheContract.inspect(version, backing, { allowSource = true }) ~= nil
|
||||
end
|
||||
|
||||
function RomImporter.syncAndroidShortcuts(activeVersion)
|
||||
|
||||
@@ -163,8 +163,8 @@ end
|
||||
|
||||
-- a module the build dropped disables its registry rather than the game:
|
||||
-- the consumer still reads its own table, so vanilla keeps working
|
||||
local function load(path)
|
||||
local ok, module = pcall(require, path)
|
||||
local function load(path, moduleLoader)
|
||||
local ok, module = pcall(moduleLoader or require, path)
|
||||
if ok then return module end
|
||||
Logger.warn("builtin registrations skipped for %s (%s)", path, tostring(module))
|
||||
return nil
|
||||
@@ -187,14 +187,14 @@ local function isolate(registry)
|
||||
}, { __index = registry })
|
||||
end
|
||||
|
||||
function Builtins.install(content, data, generation)
|
||||
function Builtins.install(content, data, generation, moduleLoader)
|
||||
for _, entry in ipairs(registrantsFor(generation)) do
|
||||
local registry = content[entry.name] and isolate(content[entry.name])
|
||||
if registry then
|
||||
if entry.install then
|
||||
local modules, complete = {}, true
|
||||
for i, path in ipairs(entry.modules) do
|
||||
modules[i] = load(path)
|
||||
modules[i] = load(path, moduleLoader)
|
||||
if modules[i] == nil then complete = false end
|
||||
end
|
||||
-- data is the fourth argument, not the second, so the existing
|
||||
@@ -204,7 +204,7 @@ function Builtins.install(content, data, generation)
|
||||
entry.install(registry, modules, Builtins.OWNER, data)
|
||||
end
|
||||
else
|
||||
local module = load(entry.from)
|
||||
local module = load(entry.from, moduleLoader)
|
||||
-- entry.fn names the entry point for a module that owns more than one
|
||||
-- registry (Gold's Battle owns statuses and move_effects); the default
|
||||
-- is the registerInto every single-registry module exposes
|
||||
|
||||
+189
-81
@@ -1,21 +1,32 @@
|
||||
-- Read-only views over verified, version-scoped generated datasets.
|
||||
--
|
||||
-- A view reads semantic registry records from another imported version without
|
||||
-- changing GameVersion, CacheFs.prefix, the active Data table, or any PhysFS
|
||||
-- mount. Records are detached copies and generated assets stay under the
|
||||
-- selected version's virtual cache prefix.
|
||||
-- Read-only, bounded views over version-scoped generated datasets.
|
||||
|
||||
local CacheFormat = require("src.import.CacheFormat")
|
||||
local CacheContract = require("src.import.CacheContract")
|
||||
local DatasetHydration = require("src.core.DatasetHydration")
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
local Logger = require("src.core.Logger")
|
||||
local SaveSerializer = require("src.core.SaveSerializer")
|
||||
local Builtins = require("src.mods.Builtins")
|
||||
local Merge = require("src.mods.Merge")
|
||||
local Registry = require("src.mods.Registry")
|
||||
local Schemas = require("src.mods.Schemas")
|
||||
|
||||
local DatasetViews = {}
|
||||
DatasetViews.__index = DatasetViews
|
||||
|
||||
local GEN1_MODULES = {
|
||||
-- A generated module is ROM-sized data, never an arbitrary program. These
|
||||
-- caps bound both one malicious file and the aggregate work one open performs.
|
||||
local DECODE_LIMITS = {
|
||||
allowArray = true,
|
||||
allowComments = true,
|
||||
maxBytes = 8 * 1024 * 1024,
|
||||
maxDepth = 64,
|
||||
maxNodes = 500000,
|
||||
maxStringBytes = 2 * 1024 * 1024,
|
||||
maxTableEntries = 250000,
|
||||
rootName = "generated data",
|
||||
}
|
||||
local MAX_AGGREGATE_BYTES = 48 * 1024 * 1024
|
||||
|
||||
local GEN1_ROOTS = {
|
||||
constants = "constants", maps = "maps", tilesets = "tilesets",
|
||||
text = "text", text_pointers = "text_pointers",
|
||||
trainer_headers = "trainer_headers", font = "font", sprites = "sprites",
|
||||
@@ -26,7 +37,7 @@ local GEN1_MODULES = {
|
||||
palettes = "palettes", icons = "icons",
|
||||
}
|
||||
|
||||
local GEN2_MODULES = {
|
||||
local GEN2_ROOTS = {
|
||||
pokemon = "pokemon", moves = "moves", items = "items",
|
||||
type_chart = "type_chart", audio = "audio", font = "font",
|
||||
gen2Maps = "maps", gen2Tilesets = "tilesets", gen2Text = "text",
|
||||
@@ -36,22 +47,8 @@ local GEN2_MODULES = {
|
||||
gen2Constants = "constants", gen2Landmarks = "landmarks",
|
||||
}
|
||||
|
||||
local function compileTable(source, chunkname)
|
||||
if type(source) ~= "string" or source:byte(1) == 27 then return nil end
|
||||
local env = {}
|
||||
local chunk, err
|
||||
if setfenv then
|
||||
chunk, err = loadstring(source, chunkname)
|
||||
if chunk then setfenv(chunk, env) end
|
||||
else
|
||||
chunk, err = load(source, chunkname, "t", env)
|
||||
end
|
||||
if not chunk then return nil, err end
|
||||
local ok, value = pcall(chunk)
|
||||
if not ok or type(value) ~= "table" then
|
||||
return nil, ok and "generated module did not return a table" or value
|
||||
end
|
||||
return value
|
||||
local function decode(source)
|
||||
return SaveSerializer.decode(source, DECODE_LIMITS)
|
||||
end
|
||||
|
||||
local function resolvePath(root, suffix)
|
||||
@@ -82,38 +79,124 @@ local function assetRelative(path)
|
||||
return path
|
||||
end
|
||||
|
||||
function DatasetViews.new(fs)
|
||||
assert(fs and fs.read, "DatasetViews.new requires a readable filesystem")
|
||||
return setmetatable({ fs = fs, datasets = {} }, DatasetViews)
|
||||
local function copyData(value, state, depth)
|
||||
state = state or { seen = {}, nodes = 0 }
|
||||
state.nodes = state.nodes + 1
|
||||
if state.nodes > DECODE_LIMITS.maxNodes then return nil, false end
|
||||
local kind = type(value)
|
||||
if kind == "nil" or kind == "boolean" or kind == "number" then return value end
|
||||
if kind == "string" then
|
||||
if #value > DECODE_LIMITS.maxStringBytes then return nil, false end
|
||||
return value
|
||||
end
|
||||
if kind ~= "table" or getmetatable(value) ~= nil then return nil, false end
|
||||
depth = (depth or 0) + 1
|
||||
if depth > DECODE_LIMITS.maxDepth or state.seen[value] then return nil, false end
|
||||
state.seen[value] = true
|
||||
local out, entries = {}, 0
|
||||
for key, child in pairs(value) do
|
||||
entries = entries + 1
|
||||
if entries > DECODE_LIMITS.maxTableEntries then return nil, false end
|
||||
local keyCopy, keyOk = copyData(key, state, depth)
|
||||
local childCopy, childOk = copyData(child, state, depth)
|
||||
if keyOk == false or childOk == false or keyCopy == nil then return nil, false end
|
||||
out[keyCopy] = childCopy
|
||||
end
|
||||
state.seen[value] = nil
|
||||
return out, true
|
||||
end
|
||||
|
||||
local function isDataOnly(value, state, depth)
|
||||
state = state or { seen = {}, nodes = 0 }
|
||||
state.nodes = state.nodes + 1
|
||||
if state.nodes > DECODE_LIMITS.maxNodes then return false end
|
||||
local kind = type(value)
|
||||
if kind == "nil" or kind == "boolean" or kind == "number" then return true end
|
||||
if kind == "string" then return #value <= DECODE_LIMITS.maxStringBytes end
|
||||
if kind ~= "table" or getmetatable(value) ~= nil then return false end
|
||||
depth = (depth or 0) + 1
|
||||
if depth > DECODE_LIMITS.maxDepth or state.seen[value] then return false end
|
||||
state.seen[value] = true
|
||||
local entries = 0
|
||||
for key, child in pairs(value) do
|
||||
entries = entries + 1
|
||||
if entries > DECODE_LIMITS.maxTableEntries
|
||||
or not isDataOnly(key, state, depth)
|
||||
or not isDataOnly(child, state, depth) then
|
||||
return false
|
||||
end
|
||||
end
|
||||
state.seen[value] = nil
|
||||
return true
|
||||
end
|
||||
|
||||
function DatasetViews.new(fs, engineRequire)
|
||||
assert(fs and fs.read and fs.getInfo,
|
||||
"DatasetViews.new requires a readable filesystem")
|
||||
return setmetatable({ fs = fs, engineRequire = engineRequire or require,
|
||||
datasets = {} }, DatasetViews)
|
||||
end
|
||||
|
||||
function DatasetViews:_validate(version, inspected)
|
||||
local sources, aggregate = {}, 0
|
||||
local modules = CacheContract.semanticModules(version)
|
||||
for _, name in ipairs(CacheContract.optionalSemanticModules(version)) do
|
||||
local path = inspected.prefix .. "data/generated/" .. name .. ".lua"
|
||||
if self.fs.getInfo(path, "file") then modules[#modules + 1] = name end
|
||||
end
|
||||
for _, name in ipairs(modules) do
|
||||
local path = inspected.prefix .. "data/generated/" .. name .. ".lua"
|
||||
local info = self.fs.getInfo(path, "file")
|
||||
local size = info and info.size
|
||||
if size and size > DECODE_LIMITS.maxBytes then return nil, name .. ": size limit" end
|
||||
aggregate = aggregate + (size or 0)
|
||||
if aggregate > MAX_AGGREGATE_BYTES then return nil, "aggregate size limit" end
|
||||
end
|
||||
aggregate = 0
|
||||
for _, name in ipairs(modules) do
|
||||
local path = inspected.prefix .. "data/generated/" .. name .. ".lua"
|
||||
local source = self.fs.read(path)
|
||||
if type(source) ~= "string" then return nil, "missing " .. name end
|
||||
aggregate = aggregate + #source
|
||||
if aggregate > MAX_AGGREGATE_BYTES then return nil, "aggregate size limit" end
|
||||
local value, err = decode(source)
|
||||
if type(value) ~= "table" then
|
||||
return nil, name .. ": " .. tostring(err or "non-table root")
|
||||
end
|
||||
sources[name] = source
|
||||
end
|
||||
return sources
|
||||
end
|
||||
|
||||
function DatasetViews:_module(view, root)
|
||||
local moduleName = view.modules[root]
|
||||
if not moduleName then return nil end
|
||||
local source = view.sources[moduleName]
|
||||
if source == nil then return nil end
|
||||
local cached = view.moduleCache[moduleName]
|
||||
if cached ~= nil then return cached or nil end
|
||||
local path = view.prefix .. "data/generated/" .. moduleName .. ".lua"
|
||||
local source = self.fs.read(path)
|
||||
local value = compileTable(source, "@" .. path)
|
||||
view.moduleCache[moduleName] = value or false
|
||||
if cached and cached.source == source then return cached.value end
|
||||
local value = assert(decode(source))
|
||||
view.moduleCache[moduleName] = { source = source, value = value }
|
||||
return value
|
||||
end
|
||||
|
||||
function DatasetViews:_data(view)
|
||||
if view.data then return view.data end
|
||||
local data = {}
|
||||
for root in pairs(view.modules) do
|
||||
local value = self:_module(view, root)
|
||||
if value ~= nil then data[root] = value end
|
||||
end
|
||||
setmetatable(data, {
|
||||
__index = function(target, root)
|
||||
local value = self:_module(view, root)
|
||||
if value ~= nil then rawset(target, root, value) end
|
||||
return value
|
||||
end,
|
||||
})
|
||||
DatasetHydration.apply(data, view.version, self.engineRequire)
|
||||
view.data = data
|
||||
return data
|
||||
end
|
||||
|
||||
local function registryBase(data, target)
|
||||
return function()
|
||||
return resolvePath(data, target)
|
||||
end
|
||||
return function() return resolvePath(data, target) end
|
||||
end
|
||||
|
||||
function DatasetViews:_registries(view)
|
||||
@@ -123,10 +206,11 @@ function DatasetViews:_registries(view)
|
||||
for name, catalogSpec in pairs(Schemas.REGISTRIES) do
|
||||
local spec = Schemas.shapeFor(name, catalogSpec, view.generation)
|
||||
local registry = Registry.new(name, spec)
|
||||
if spec.target then registry.base = registryBase(data, spec.target) end
|
||||
local target = Schemas.targetFor(name, catalogSpec, view.generation)
|
||||
if target then registry.base = registryBase(data, target) end
|
||||
registries[name] = registry
|
||||
end
|
||||
Builtins.install(registries, data, view.generation)
|
||||
Builtins.install(registries, data, view.generation, self.engineRequire)
|
||||
for _, registry in pairs(registries) do registry:freeze() end
|
||||
view.registries = registries
|
||||
return registries
|
||||
@@ -134,26 +218,30 @@ end
|
||||
|
||||
function DatasetViews:_registry(view, name)
|
||||
local registry = self:_registries(view)[name]
|
||||
|
||||
local function valueAt(id)
|
||||
local function rawAt(id)
|
||||
local value = registry and registry:get(id)
|
||||
if value == nil then return nil end
|
||||
return Merge.deepCopy(value)
|
||||
if value == nil or not isDataOnly(value) then return nil end
|
||||
return value
|
||||
end
|
||||
local function valueAt(id)
|
||||
local value = rawAt(id)
|
||||
if value == nil then return nil end
|
||||
return (copyData(value))
|
||||
end
|
||||
|
||||
return {
|
||||
get = function(_, id)
|
||||
if type(id) ~= "string" or id == "" then return nil end
|
||||
return valueAt(id)
|
||||
end,
|
||||
has = function(_, id)
|
||||
return valueAt(id) ~= nil
|
||||
if type(id) ~= "string" or id == "" then return false end
|
||||
return rawAt(id) ~= nil
|
||||
end,
|
||||
each = function()
|
||||
local ids = {}
|
||||
if registry then
|
||||
for id in registry:each() do
|
||||
if type(id) == "string" then ids[#ids + 1] = id end
|
||||
for id, value in registry:each() do
|
||||
if type(id) == "string" and isDataOnly(value) then ids[#ids + 1] = id end
|
||||
end
|
||||
end
|
||||
table.sort(ids)
|
||||
@@ -171,20 +259,15 @@ end
|
||||
function DatasetViews:_assets(view)
|
||||
local service = self
|
||||
local assets = {}
|
||||
|
||||
function assets:path(path)
|
||||
return view.prefix .. assetRelative(path)
|
||||
end
|
||||
|
||||
function assets:path(path) return view.prefix .. assetRelative(path) end
|
||||
function assets:info(path)
|
||||
local full = self:path(path)
|
||||
local info = service.fs.getInfo and service.fs.getInfo(full, "file")
|
||||
if not info then return nil end
|
||||
local out = { type = info.type }
|
||||
if not info or (info.type and info.type ~= "file") then return nil end
|
||||
local out = { type = "file" }
|
||||
if info.size ~= nil then out.size = info.size end
|
||||
return out
|
||||
end
|
||||
|
||||
return assets
|
||||
end
|
||||
|
||||
@@ -192,28 +275,54 @@ function DatasetViews:open(version)
|
||||
if type(version) ~= "string" or not GameVersion.VERSIONS[version] then
|
||||
return nil, "unknown_version"
|
||||
end
|
||||
local internal = self.datasets[version]
|
||||
if not internal then
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
local marker = self.fs.read(prefix .. "rom-cache.complete")
|
||||
if not CacheFormat.matches(version, marker) then
|
||||
return nil, "not_imported"
|
||||
end
|
||||
|
||||
local generation = GameVersion.generation(version)
|
||||
internal = {
|
||||
version = version, generation = generation, prefix = prefix,
|
||||
modules = generation == 2 and GEN2_MODULES or GEN1_MODULES,
|
||||
moduleCache = {},
|
||||
}
|
||||
internal.registries = self:_registries(internal)
|
||||
self.datasets[version] = internal
|
||||
local inspected, reason, detail = CacheContract.inspect(version, self.fs, {
|
||||
allowSource = true, semantic = true,
|
||||
})
|
||||
if not inspected then
|
||||
self.datasets[version] = nil
|
||||
Logger.warn("dataset %s unavailable: %s", version, detail)
|
||||
return nil, reason
|
||||
end
|
||||
local view = {
|
||||
version = version,
|
||||
generation = internal.generation,
|
||||
content = {},
|
||||
}
|
||||
local sources, invalid = self:_validate(version, inspected)
|
||||
if not sources then
|
||||
self.datasets[version] = nil
|
||||
Logger.warn("dataset %s cache rejected: %s", version, invalid)
|
||||
return nil, "invalid_cache"
|
||||
end
|
||||
|
||||
local internal = self.datasets[version]
|
||||
local changed = not internal or internal.prefix ~= inspected.prefix
|
||||
if internal and not changed then
|
||||
for name, source in pairs(internal.sources) do
|
||||
if sources[name] ~= source then changed = true; break end
|
||||
end
|
||||
end
|
||||
if internal and not changed then
|
||||
for name, source in pairs(sources) do
|
||||
if internal.sources[name] ~= source then changed = true; break end
|
||||
end
|
||||
end
|
||||
if changed then
|
||||
internal = {
|
||||
version = version,
|
||||
generation = GameVersion.generation(version),
|
||||
prefix = inspected.prefix,
|
||||
modules = GameVersion.generation(version) == 2 and GEN2_ROOTS or GEN1_ROOTS,
|
||||
moduleCache = {}, sources = sources,
|
||||
}
|
||||
local ok, buildError = pcall(function() internal.registries = self:_registries(internal) end)
|
||||
if not ok then
|
||||
Logger.warn("dataset %s semantic hydration failed: %s", version,
|
||||
tostring(buildError))
|
||||
self.datasets[version] = nil
|
||||
return nil, "invalid_cache"
|
||||
end
|
||||
self.datasets[version] = internal
|
||||
else
|
||||
internal.sources = sources
|
||||
end
|
||||
|
||||
local view = { version = version, generation = internal.generation, content = {} }
|
||||
for name in pairs(Schemas.REGISTRIES) do
|
||||
view.content[name] = self:_registry(internal, name)
|
||||
end
|
||||
@@ -221,7 +330,6 @@ function DatasetViews:open(version)
|
||||
view.content[alias] = view.content[canonical]
|
||||
end
|
||||
view.assets = self:_assets(internal)
|
||||
|
||||
return view
|
||||
end
|
||||
|
||||
|
||||
+1
-1
@@ -987,7 +987,7 @@ function Loader:_api(mod)
|
||||
open = function(_, version)
|
||||
if not loader.datasetViews then
|
||||
local DatasetViews = engineRequire("src.mods.DatasetViews")
|
||||
loader.datasetViews = DatasetViews.new(loader.fs)
|
||||
loader.datasetViews = DatasetViews.new(loader.fs, engineRequire)
|
||||
end
|
||||
return loader.datasetViews:open(version)
|
||||
end,
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
-- Dedicated Route B no-mod parity: the additive facade remains cold.
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
local T = require("tests.modkit")
|
||||
|
||||
local reads = 0
|
||||
local fs = T.sdk.memfs({})
|
||||
local read = fs.read
|
||||
fs.read = function(path)
|
||||
if path:match("^[a-z]+/data/generated/")
|
||||
or path:match("^[a-z]+/rom%-cache%.complete$") then
|
||||
reads = reads + 1
|
||||
end
|
||||
return read(path)
|
||||
end
|
||||
local data = { pokemon = { ACTIVE = { id = "ACTIVE", nested = { n = 1 } } } }
|
||||
local run = T.sdk.loadNone({ fs = fs, data = data, generation = 1 })
|
||||
T.eq(#run.errors, 0, "no-mod load remains clean")
|
||||
T.eq(run.loader.datasetViews, nil, "no-mod load does not allocate dataset service")
|
||||
T.eq(reads, 0, "no-mod load performs no imported dataset reads")
|
||||
T.eq(data.pokemon.ACTIVE.nested.n, 1, "no-mod data remains unchanged")
|
||||
run.release()
|
||||
T.finish("dataset_views_no_mod_parity")
|
||||
@@ -0,0 +1,37 @@
|
||||
-- Restricted generated-data grammar and resource limits.
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
local T = require("tests.modkit")
|
||||
local SaveSerializer = require("src.core.SaveSerializer")
|
||||
|
||||
local limits = {
|
||||
allowArray = true, allowComments = true,
|
||||
maxBytes = 256, maxDepth = 4, maxNodes = 7,
|
||||
maxStringBytes = 8, maxTableEntries = 5, rootName = "generated data",
|
||||
}
|
||||
|
||||
local value, err = SaveSerializer.decode(
|
||||
'-- Generated by tools/build_data.py. DO NOT EDIT.\n'
|
||||
.. 'return { rows = { "A", "B" }, [3] = true }\n', limits)
|
||||
T.same(value, { rows = { "A", "B" }, [3] = true },
|
||||
"LuaWriter array and keyed-table grammar decodes as data")
|
||||
T.eq(err, nil, "valid generated data has no error")
|
||||
|
||||
local invalid = {
|
||||
{ "return function() end", "function literal" },
|
||||
{ "owned = true; return {}", "global assignment" },
|
||||
{ "return {}; print('x')", "trailing executable syntax" },
|
||||
{ string.char(27) .. "Lua", "binary chunk" },
|
||||
{ "return " .. string.rep(" ", 260) .. "{}", "source-size limit" },
|
||||
{ 'return { a = { b = { c = { d = { e = {} } } } } }', "depth limit" },
|
||||
{ 'return { a = "123456789" }', "string limit" },
|
||||
{ 'return { 1, 2, 3, 4, 5, 6 }', "table-entry limit" },
|
||||
{ 'return { a = 1, b = 2, c = 3, d = 4, e = { f = 6, g = 7 } }',
|
||||
"node limit" },
|
||||
{ "return 7", "non-table root" },
|
||||
}
|
||||
for _, row in ipairs(invalid) do
|
||||
local got = SaveSerializer.decode(row[1], limits)
|
||||
T.eq(got, nil, row[2] .. " fails closed")
|
||||
end
|
||||
|
||||
T.finish("generated_data_decoder")
|
||||
@@ -1,32 +1,36 @@
|
||||
-- sourceTreeHasData must use each version's required-file list. Gold's
|
||||
-- cache has no Gen 1 trade art / pikachu.png; validating it against
|
||||
-- REQUIRED_FILES made a Gold source tree look incomplete forever.
|
||||
-- Shared cache readiness uses the selected version's source-tree contract.
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
|
||||
local T = require("tests.harness")
|
||||
local check = T.check
|
||||
local CacheContract = require("src.import.CacheContract")
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
|
||||
local f = assert(io.open("src/import/RomImporter.lua", "r"))
|
||||
local src = f:read("*a")
|
||||
f:close()
|
||||
local present = {}
|
||||
for _, path in ipairs(CacheContract.requiredFiles("gold")) do
|
||||
present[GameVersion.cachePrefix("gold") .. path] = true
|
||||
end
|
||||
local fs = {
|
||||
read = function() return nil end,
|
||||
getInfo = function(path) return present[path] and { type = "file" } or nil end,
|
||||
getRealDirectory = function(path) return present[path] and "/source" or nil end,
|
||||
getSource = function() return "/source" end,
|
||||
}
|
||||
|
||||
local start = src:find("local function sourceTreeHasData", 1, true)
|
||||
check(start ~= nil, "sourceTreeHasData is defined")
|
||||
local finish = src:find("\nfunction RomImporter.isReady", start, true)
|
||||
check(finish ~= nil, "sourceTreeHasData ends before isReady")
|
||||
local body = src:sub(start, finish)
|
||||
local inspected = CacheContract.inspect("gold", fs, { allowSource = true })
|
||||
T.eq(inspected and inspected.kind, "source",
|
||||
"Gold source tree uses Gold's required-file contract")
|
||||
|
||||
check(body:find("requiredFilesFor", 1, true) ~= nil,
|
||||
"sourceTreeHasData uses requiredFilesFor (Gold override, not Gen 1 only)")
|
||||
check(body:find("ipairs(REQUIRED_FILES)", 1, true) == nil,
|
||||
"sourceTreeHasData does not iterate the Gen 1 REQUIRED_FILES list raw")
|
||||
present["gold/assets/generated/battle/hud/balls.png"] = nil
|
||||
T.eq(CacheContract.inspect("gold", fs, { allowSource = true }), nil,
|
||||
"missing Gold-only trainer HUD asset makes the source tree incomplete")
|
||||
|
||||
local helperStart = src:find("local function requiredFilesFor", 1, true)
|
||||
check(helperStart ~= nil, "requiredFilesFor helper exists")
|
||||
local helper = src:sub(helperStart, start)
|
||||
check(helper:find("VERSION_REQUIRED_FILES_OVERRIDE", 1, true) ~= nil,
|
||||
"requiredFilesFor consults VERSION_REQUIRED_FILES_OVERRIDE")
|
||||
check(src:find('"assets/generated/battle/hud/balls.png"', 1, true) ~= nil,
|
||||
"Gold caches require the trainer HUD ball sheet")
|
||||
local required = {}
|
||||
for _, path in ipairs(CacheContract.requiredFiles("gold")) do required[path] = true end
|
||||
T.eq(required["data/generated/rom_text.lua"], true,
|
||||
"Gold requires generated ROM text")
|
||||
T.eq(required["assets/generated/pc/mail_item.png"], true,
|
||||
"Gold requires PC mail art")
|
||||
T.eq(required["assets/generated/trade/game_boy.png"], nil,
|
||||
"Gold does not inherit the Gen 1 trade-art contract")
|
||||
|
||||
T.finish()
|
||||
|
||||
@@ -83,16 +83,12 @@ if extractor then
|
||||
"field.lua publishes tradeArt")
|
||||
end
|
||||
|
||||
-- a cache imported before #750 has none of the art; listing one of the
|
||||
-- files in REQUIRED_FILES is what makes it re-import
|
||||
local importer = readFile("src/import/RomImporter.lua")
|
||||
T.check(importer ~= nil, "src/import/RomImporter.lua is readable")
|
||||
if importer then
|
||||
local required = importer:match("local REQUIRED_FILES = {(.-)\n}")
|
||||
T.check(required ~= nil, "REQUIRED_FILES parses")
|
||||
T.check(required ~= nil and required:find(
|
||||
'"assets/generated/trade/game_boy.png"', 1, true) ~= nil,
|
||||
"REQUIRED_FILES makes pre-#750 caches re-import the trade art")
|
||||
end
|
||||
-- a cache imported before #750 has none of the art; the shared readiness
|
||||
-- contract is what makes it re-import.
|
||||
local CacheContract = require("src.import.CacheContract")
|
||||
local required = {}
|
||||
for _, path in ipairs(CacheContract.requiredFiles("red")) do required[path] = true end
|
||||
T.eq(required["assets/generated/trade/game_boy.png"], true,
|
||||
"required-file contract makes pre-#750 caches re-import the trade art")
|
||||
|
||||
T.finish("trade art import")
|
||||
|
||||
@@ -1,251 +1,288 @@
|
||||
-- Cross-version imported datasets through the public sandboxed mod API.
|
||||
-- The view is semantic and read-only: registry-shaped records in, detached
|
||||
-- copies out, with generated assets kept inside the selected version namespace.
|
||||
|
||||
-- Sandboxed public-API coverage for imported semantic dataset views.
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
|
||||
local T = require("tests.modkit")
|
||||
local Fixture = require("tests.modkit.dataset_view_fixture")
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
local CacheFs = require("src.import.CacheFs")
|
||||
local CacheFormat = require("src.import.CacheFormat")
|
||||
|
||||
local function serialized(value)
|
||||
local function encode(v)
|
||||
if type(v) == "string" then return string.format("%q", v) end
|
||||
if type(v) == "number" or type(v) == "boolean" then return tostring(v) end
|
||||
local keys = {}
|
||||
for key in pairs(v) do keys[#keys + 1] = key end
|
||||
table.sort(keys, function(a, b) return tostring(a) < tostring(b) end)
|
||||
local out = { "{" }
|
||||
for _, key in ipairs(keys) do
|
||||
out[#out + 1] = "[" .. encode(key) .. "]=" .. encode(v[key]) .. ","
|
||||
end
|
||||
out[#out + 1] = "}"
|
||||
return table.concat(out)
|
||||
end
|
||||
return "return " .. encode(value)
|
||||
end
|
||||
|
||||
local files = {
|
||||
["mods/dataset_probe/manifest.json"] = [[{
|
||||
"id": "dataset_probe",
|
||||
"name": "Dataset Probe",
|
||||
"version": "1.0.0",
|
||||
"entry": "main.lua",
|
||||
"api": 2,
|
||||
"games": ["all"]
|
||||
}]],
|
||||
["mods/dataset_probe/main.lua"] = [[
|
||||
local mod = ...
|
||||
local out = {}
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold" }) do
|
||||
local view, reason = mod.datasets:open(version)
|
||||
if not view then
|
||||
out[version] = { reason = reason }
|
||||
else
|
||||
local registry = view.content.pokemon
|
||||
local first = registry:get("FIXMON")
|
||||
first.name = "MUTATED"
|
||||
local ids = {}
|
||||
for id in registry:each() do ids[#ids + 1] = id end
|
||||
local immune = view.content.type_chart:get("NORMAL>GHOST")
|
||||
local steel = view.content.type_chart:get("STEEL")
|
||||
out[version] = {
|
||||
version = view.version,
|
||||
generation = view.generation,
|
||||
name = registry:get("FIXMON").name,
|
||||
has = registry:has("FIXMON"),
|
||||
ids = ids,
|
||||
writable = registry.register ~= nil or registry.patch ~= nil
|
||||
or registry.override ~= nil or registry.remove ~= nil,
|
||||
sprite = view.assets:path(registry:get("FIXMON").spriteFront),
|
||||
spriteInfo = view.assets:info(registry:get("FIXMON").spriteFront),
|
||||
normalGhost = immune and immune.multiplier,
|
||||
steelCategory = steel and steel.category,
|
||||
}
|
||||
end
|
||||
end
|
||||
local missing, missingReason = mod.datasets:open("silver")
|
||||
local unknown, unknownReason = mod.datasets:open("crystal")
|
||||
out.silver = { present = missing ~= nil, reason = missingReason }
|
||||
out.crystal = { present = unknown ~= nil, reason = unknownReason }
|
||||
local gold = mod.datasets:open("gold")
|
||||
out.assetEscape = pcall(function() gold.assets:path("../save.lua") end)
|
||||
out.rawAssetRead = gold.assets.read ~= nil
|
||||
mod.exports.result = out
|
||||
]],
|
||||
}
|
||||
|
||||
local isolationMods = {
|
||||
["mods/dataset_mutator/manifest.json"] = [[{
|
||||
"id": "dataset_mutator",
|
||||
"name": "Dataset Mutator",
|
||||
"version": "1.0.0",
|
||||
"entry": "main.lua",
|
||||
"api": 2,
|
||||
"games": ["all"]
|
||||
}]],
|
||||
["mods/dataset_mutator/main.lua"] = [[
|
||||
local mod = ...
|
||||
local view = assert(mod.datasets:open("red"))
|
||||
view.content.pokemon.get = function() return { name = "POISONED" } end
|
||||
]],
|
||||
["mods/dataset_observer/manifest.json"] = [[{
|
||||
"id": "dataset_observer",
|
||||
"name": "Dataset Observer",
|
||||
"version": "1.0.0",
|
||||
"entry": "main.lua",
|
||||
"api": 2,
|
||||
"games": ["all"],
|
||||
"dependencies": ["dataset_mutator"]
|
||||
}]],
|
||||
["mods/dataset_observer/main.lua"] = [[
|
||||
local mod = ...
|
||||
local view = assert(mod.datasets:open("red"))
|
||||
mod.exports.name = view.content.pokemon:get("FIXMON").name
|
||||
]],
|
||||
}
|
||||
|
||||
local labels = {
|
||||
red = "RED SOURCE", blue = "BLUE SOURCE",
|
||||
yellow = "YELLOW SOURCE", gold = "GOLD SOURCE",
|
||||
}
|
||||
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold" }) do
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
files[prefix .. "rom-cache.complete"] =
|
||||
"rom-cache-v10:" .. GameVersion.info(version).sha1
|
||||
files[prefix .. "data/generated/pokemon.lua"] = serialized({
|
||||
FIXMON = {
|
||||
id = "FIXMON", name = labels[version], dex = version == "gold" and 252 or 152,
|
||||
spriteFront = "assets/generated/battle/front/fixmon.png",
|
||||
},
|
||||
ALPHA = { id = "ALPHA", name = "ALPHA", dex = 1,
|
||||
spriteFront = "assets/generated/battle/front/alpha.png" },
|
||||
})
|
||||
files[prefix .. "data/generated/type_chart.lua"] = serialized({
|
||||
matchups = { { attacker = "NORMAL", defender = "GHOST", multiplier = 0 } },
|
||||
types = version == "gold" and {
|
||||
STEEL = { name = "STEEL", category = "physical", index = 9 },
|
||||
} or {},
|
||||
})
|
||||
files[prefix .. "assets/generated/battle/front/fixmon.png"] = "png-" .. version
|
||||
end
|
||||
|
||||
-- An otherwise plausible Silver tree has no completion marker. A view must
|
||||
-- not execute or expose it.
|
||||
files[GameVersion.cachePrefix("silver") .. "data/generated/pokemon.lua"] =
|
||||
serialized({ FIXMON = { id = "FIXMON", name = "UNVERIFIED" } })
|
||||
|
||||
T.eq(CacheFormat.markerFor("red"),
|
||||
"rom-cache-v10:" .. GameVersion.info("red").sha1,
|
||||
"cache marker follows the importer format and version hash")
|
||||
T.eq(CacheFormat.matches("silver", "rom-cache-v9:stale"), false,
|
||||
"stale cache formats are rejected")
|
||||
T.eq(CacheFormat.markerFor("crystal"), nil,
|
||||
"unknown versions have no valid cache marker")
|
||||
local Schemas = require("src.mods.Schemas")
|
||||
|
||||
local originalVersion = GameVersion.get()
|
||||
local originalPrefix = CacheFs.prefix
|
||||
GameVersion.set("red")
|
||||
|
||||
local function isVersionCachePath(path)
|
||||
for _, version in ipairs(GameVersion.ORDER) do
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
if path:sub(1, #prefix) == prefix then return true end
|
||||
end
|
||||
return false
|
||||
local files = {}
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold", "silver" }) do
|
||||
Fixture.cache(files, version)
|
||||
end
|
||||
local probe = Fixture.addMod(files, "dataset_probe", [[
|
||||
local mod = ...
|
||||
local out = {}
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold", "silver" }) do
|
||||
local view, reason = mod.datasets:open(version)
|
||||
local mon = view and view.content.pokemon:get("FIXMON")
|
||||
if mon then mon.name = "MUTATED" end
|
||||
local ids = {}
|
||||
if view then
|
||||
for id, value in view.content.pokemon:each() do
|
||||
ids[#ids + 1] = id
|
||||
if value then value.name = "EACH_MUTATED" end
|
||||
end
|
||||
end
|
||||
out[version] = {
|
||||
reason = reason, generation = view and view.generation,
|
||||
name = view and view.content.pokemon:get("FIXMON").name,
|
||||
has = view and view.content.pokemon:has("FIXMON"), ids = ids,
|
||||
aliasScripts = view and view.content.scripts == view.content.map_scripts,
|
||||
aliasUi = view and view.content.ui == view.content.screens,
|
||||
readOnly = view and view.content.pokemon.register == nil
|
||||
and view.content.pokemon.patch == nil and view.content.pokemon.remove == nil,
|
||||
}
|
||||
end
|
||||
local yellow = assert(mod.datasets:open("yellow"))
|
||||
out.yellowOldMan = yellow.content.field:get("oldManBattle")
|
||||
out.yellowBoot = yellow.content.field:get("boot")
|
||||
local red = assert(mod.datasets:open("red"))
|
||||
out.redBoot = red.content.field:get("boot")
|
||||
out.redConstants = red.content.constants:get("dexSize")
|
||||
local gold = assert(mod.datasets:open("gold"))
|
||||
out.registryCount = 0
|
||||
for _, registry in pairs(gold.content) do
|
||||
if type(registry) == "table" then out.registryCount = out.registryCount + 1 end
|
||||
end
|
||||
out.foresight = gold.content.type_chart:get("NORMAL>GHOST")
|
||||
out.held = gold.content.held_items:get("LEFTOVERS")
|
||||
out.continuations, out.moves, out.assets = {}, {}, {}
|
||||
for _, id in ipairs({ "CROBAT", "BELLOSSOM", "POLITOED", "SLOWKING",
|
||||
"STEELIX", "SCIZOR", "KINGDRA", "PORYGON2", "BLISSEY" }) do
|
||||
local row = gold.content.pokemon:get(id)
|
||||
out.continuations[id] = row and row.dex
|
||||
out.assets[id] = row and {
|
||||
gold.assets:info(row.spriteFront), gold.assets:info(row.spriteBack) }
|
||||
end
|
||||
for _, id in ipairs({ "IRON_TAIL", "METAL_CLAW", "STEEL_WING", "RAIN_DANCE",
|
||||
"SUNNY_DAY", "SANDSTORM", "SLUDGE_BOMB", "SHADOW_BALL" }) do
|
||||
out.moves[id] = gold.content.moves:has(id)
|
||||
end
|
||||
out.steel = gold.content.type_chart:has("STEEL")
|
||||
out.executableBuiltinHidden = gold.content.statuses:get("sleep") == nil
|
||||
out.assetDirectory = gold.assets:info("assets/generated/battle/front")
|
||||
out.assetRejects = {}
|
||||
for _, path in ipairs({ "/assets/generated/x", "assets\\generated\\x",
|
||||
"assets/generated/../x", "assets/generated/./x", "other/x",
|
||||
"assets/generated/x\1" }) do
|
||||
out.assetRejects[#out.assetRejects + 1] = pcall(gold.assets.path, gold.assets, path)
|
||||
end
|
||||
local unknown, unknownReason = mod.datasets:open("crystal")
|
||||
out.unknown = { unknown ~= nil, unknownReason }
|
||||
mod.exports.result = out
|
||||
]])
|
||||
|
||||
-- No mod means the new service is completely cold. Count only cross-version
|
||||
-- cache reads so the loader's ordinary discovery/state reads do not matter.
|
||||
local vanillaFiles = {}
|
||||
for path, body in pairs(files) do
|
||||
if not path:match("^mods/") then
|
||||
vanillaFiles[path] = body
|
||||
end
|
||||
end
|
||||
local vanillaFs = T.sdk.memfs(vanillaFiles)
|
||||
local vanillaReads = 0
|
||||
local vanillaRead = vanillaFs.read
|
||||
vanillaFs.read = function(path)
|
||||
if isVersionCachePath(path) then
|
||||
vanillaReads = vanillaReads + 1
|
||||
end
|
||||
return vanillaRead(path)
|
||||
end
|
||||
local vanillaData = { pokemon = { ACTIVE = { id = "ACTIVE", name = "ACTIVE" } } }
|
||||
local vanilla = T.sdk.loadNone({ fs = vanillaFs, data = vanillaData })
|
||||
T.eq(#vanilla.errors, 0, "no-mod loader remains clean")
|
||||
T.eq(vanillaReads, 0, "no mod performs no imported-dataset reads")
|
||||
T.eq(vanillaData.pokemon.ACTIVE.name, "ACTIVE",
|
||||
"no mod leaves the active dataset unchanged")
|
||||
vanilla.release()
|
||||
|
||||
local activeData = { pokemon = { ACTIVE = { id = "ACTIVE", name = "ACTIVE" } } }
|
||||
local run = T.sdk.loadMods({ "mods/dataset_probe" }, {
|
||||
fs = T.sdk.memfs(files), data = activeData, generation = 1,
|
||||
local active = { pokemon = { ACTIVE = { id = "ACTIVE", nested = { n = 1 } } } }
|
||||
local run = T.sdk.loadMods({ probe }, {
|
||||
fs = T.sdk.memfs(files), data = active, generation = 1,
|
||||
})
|
||||
T.eq(#run.errors, 0,
|
||||
"sandboxed dataset probe loads clean: " .. tostring(run.errors[1]))
|
||||
local out = run.loader.exports.dataset_probe
|
||||
and run.loader.exports.dataset_probe.result or {}
|
||||
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold" }) do
|
||||
local got = out[version] or {}
|
||||
T.eq(got.version, version, version .. " view reports its selected version")
|
||||
T.eq(got.generation, version == "gold" and 2 or 1,
|
||||
version .. " view reports the selected generation")
|
||||
T.eq(got.name, labels[version],
|
||||
version .. " returns its own semantic species record")
|
||||
T.eq(got.has, true, version .. " registry has() reads the imported view")
|
||||
T.same(got.ids, { "ALPHA", "FIXMON" },
|
||||
version .. " registry each() is deterministic")
|
||||
T.eq(got.writable, false, version .. " registry exposes no write verbs")
|
||||
T.eq(got.sprite,
|
||||
GameVersion.cachePrefix(version) .. "assets/generated/battle/front/fixmon.png",
|
||||
version .. " asset path stays in its cache namespace")
|
||||
T.same(got.spriteInfo, { type = "file" },
|
||||
version .. " asset info is sanitized metadata")
|
||||
T.eq(got.normalGhost, 0,
|
||||
version .. " exposes structured matchup ids semantically")
|
||||
T.eq(#run.errors, 0, "dataset public probe loads clean")
|
||||
local out = run.loader.exports.dataset_probe.result
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold", "silver" }) do
|
||||
T.eq(out[version].reason, nil, version .. " opens")
|
||||
T.eq(out[version].generation,
|
||||
(version == "gold" or version == "silver") and 2 or 1,
|
||||
version .. " reports selected generation")
|
||||
T.eq(out[version].name, "FIXMON", version .. " get/each values are detached")
|
||||
T.eq(out[version].has, true, version .. " has reads without exposing a copy")
|
||||
T.eq(out[version].aliasScripts, true, version .. " scripts alias is canonical")
|
||||
T.eq(out[version].aliasUi, true, version .. " ui alias is canonical")
|
||||
T.eq(out[version].readOnly, true, version .. " registry has no write verbs")
|
||||
end
|
||||
T.eq(out.gold and out.gold.steelCategory, "physical",
|
||||
"Gold exposes imported Steel as a semantic type record")
|
||||
|
||||
T.same(out.silver, { present = false, reason = "not_imported" },
|
||||
"an unverified cache is unavailable")
|
||||
T.same(out.crystal, { present = false, reason = "unknown_version" },
|
||||
"an unknown version fails with a stable reason")
|
||||
T.eq(out.assetEscape, false, "dataset asset paths reject traversal")
|
||||
T.eq(out.rawAssetRead, false, "dataset assets expose no raw byte reader")
|
||||
T.eq(activeData.pokemon.ACTIVE.name, "ACTIVE",
|
||||
"cross-version reads do not mutate the active game dataset")
|
||||
T.eq(activeData.pokemon.FIXMON, nil,
|
||||
"cross-version records are not merged into active game data")
|
||||
T.eq(GameVersion.get(), "red", "dataset reads do not switch the active game")
|
||||
T.eq(CacheFs.prefix, originalPrefix, "dataset reads do not change cache prefix state")
|
||||
|
||||
T.eq(out.redConstants, 1, "Red derives dexSize through canonical defaults")
|
||||
T.eq(out.redBoot and out.redBoot.screens and out.redBoot.screens.splash,
|
||||
"IntroMovie", "Red uses canonical boot defaults")
|
||||
T.eq(out.yellowOldMan and out.yellowOldMan.species, "RATTATA",
|
||||
"Yellow applies canonical correction")
|
||||
T.eq(out.yellowBoot and out.yellowBoot.screens and out.yellowBoot.screens.splash,
|
||||
"YellowIntro",
|
||||
"Yellow uses its canonical splash")
|
||||
T.eq(out.foresight and out.foresight.multiplier, 0,
|
||||
"Gold appends Foresight matchup rows")
|
||||
T.eq(out.held and out.held.heldEffect, "HELD_LEFTOVERS", "Gold derives held_items")
|
||||
for _, id in ipairs(Fixture.CONTINUATIONS) do
|
||||
T.check(out.continuations[id] ~= nil, "Gold exposes " .. id)
|
||||
T.same(out.assets[id], { { type = "file" }, { type = "file" } },
|
||||
"Gold exposes namespaced front/back assets for " .. id)
|
||||
end
|
||||
for _, id in ipairs(Fixture.MOVES) do T.eq(out.moves[id], true, "Gold exposes " .. id) end
|
||||
T.eq(out.steel, true, "Gold exposes Steel")
|
||||
local registryCount = 0
|
||||
for _ in pairs(Schemas.REGISTRIES) do registryCount = registryCount + 1 end
|
||||
for _ in pairs(Schemas.ALIASES) do registryCount = registryCount + 1 end
|
||||
T.eq(out.registryCount, registryCount,
|
||||
"view exposes every canonical registry and alias")
|
||||
T.eq(out.executableBuiltinHidden, true,
|
||||
"engine records containing closures do not cross the data-only facade")
|
||||
T.eq(out.assetDirectory, nil, "asset info does not expose directories")
|
||||
for index, accepted in ipairs(out.assetRejects) do
|
||||
T.eq(accepted, false, "asset rejection " .. index)
|
||||
end
|
||||
T.same(out.unknown, { false, "unknown_version" }, "unknown version fails stably")
|
||||
T.eq(active.pokemon.ACTIVE.nested.n, 1, "active Data stays unchanged")
|
||||
T.eq(active.pokemon.FIXMON, nil, "inactive records do not merge into active Data")
|
||||
T.eq(GameVersion.get(), "red", "active GameVersion stays unchanged")
|
||||
T.eq(CacheFs.prefix, originalPrefix, "CacheFs prefix stays unchanged")
|
||||
run.release()
|
||||
|
||||
local isolationFiles = {}
|
||||
for path, body in pairs(files) do
|
||||
if not path:match("^mods/") then
|
||||
isolationFiles[path] = body
|
||||
end
|
||||
end
|
||||
for path, body in pairs(isolationMods) do isolationFiles[path] = body end
|
||||
local isolationRun = T.sdk.loadMods({
|
||||
"mods/dataset_mutator", "mods/dataset_observer",
|
||||
}, { fs = T.sdk.memfs(isolationFiles),
|
||||
data = { pokemon = {} }, generation = 1 })
|
||||
T.eq(#isolationRun.errors, 0, "cross-mod isolation fixture loads cleanly")
|
||||
T.eq(isolationRun.loader.exports.dataset_observer
|
||||
and isolationRun.loader.exports.dataset_observer.name,
|
||||
labels.red, "one mod cannot mutate another mod dataset facade")
|
||||
-- Facade replacement and nested record mutation do not cross mod boundaries.
|
||||
local isolation = {}
|
||||
Fixture.cache(isolation, "red")
|
||||
local mutator = Fixture.addMod(isolation, "dataset_mutator", [[
|
||||
local mod = ...
|
||||
local view = assert(mod.datasets:open("red"))
|
||||
view.content.pokemon.get = function() return { name = "POISONED" } end
|
||||
local row = view.content.pokemon:get("FIXMON")
|
||||
if row then row.name = "CHANGED" end
|
||||
]])
|
||||
local observer = Fixture.addMod(isolation, "dataset_observer", [[
|
||||
local mod = ...
|
||||
local view = assert(mod.datasets:open("red"))
|
||||
mod.exports.name = view.content.pokemon:get("FIXMON").name
|
||||
]])
|
||||
isolation["mods/dataset_observer/manifest.json"] = [[{
|
||||
"id": "dataset_observer", "name": "dataset_observer", "version": "1.0.0",
|
||||
"entry": "main.lua", "api": 2, "games": ["all"],
|
||||
"dependencies": ["dataset_mutator"]
|
||||
}]]
|
||||
local isolationRun = T.sdk.loadMods({ mutator, observer }, {
|
||||
fs = T.sdk.memfs(isolation), data = { pokemon = {} }, generation = 1,
|
||||
})
|
||||
T.eq(isolationRun.loader.exports.dataset_observer.name, "FIXMON",
|
||||
"facade and record mutation cannot cross mods")
|
||||
isolationRun.release()
|
||||
|
||||
-- Marker-only, empty, partial, and stale-after-first-open caches fail closed.
|
||||
local readiness = {}
|
||||
local emptyPrefix = GameVersion.cachePrefix("red")
|
||||
readiness[emptyPrefix .. "rom-cache.complete"] =
|
||||
"rom-cache-v10:" .. GameVersion.info("red").sha1
|
||||
Fixture.cache(readiness, "blue")
|
||||
readiness[GameVersion.cachePrefix("blue") .. "data/generated/moves.lua"] = nil
|
||||
Fixture.cache(readiness, "gold")
|
||||
local staleReads = 0
|
||||
local readinessFs = T.sdk.memfs(readiness)
|
||||
local rawRead = readinessFs.read
|
||||
readinessFs.read = function(path)
|
||||
if path == GameVersion.cachePrefix("gold") .. "rom-cache.complete" then
|
||||
staleReads = staleReads + 1
|
||||
if staleReads > 1 then return "rom-cache-v9:stale" end
|
||||
end
|
||||
return rawRead(path)
|
||||
end
|
||||
local readinessMod = Fixture.addMod(readiness, "readiness_probe", [[
|
||||
local mod = ...
|
||||
local out = {}
|
||||
for _, version in ipairs({ "red", "blue" }) do
|
||||
local view, reason = mod.datasets:open(version)
|
||||
out[version] = { view ~= nil, reason }
|
||||
end
|
||||
local first, firstReason = mod.datasets:open("gold")
|
||||
local second, secondReason = mod.datasets:open("gold")
|
||||
out.gold = { first ~= nil, firstReason, second ~= nil, secondReason }
|
||||
mod.exports.result = out
|
||||
]])
|
||||
local readinessRun = T.sdk.loadMods({ readinessMod }, {
|
||||
fs = readinessFs, data = { pokemon = {} }, generation = 1,
|
||||
})
|
||||
local readyOut = readinessRun.loader.exports.readiness_probe.result
|
||||
T.same(readyOut.red, { false, "not_imported" }, "marker-only empty cache fails")
|
||||
T.same(readyOut.blue, { false, "not_imported" }, "partial cache fails")
|
||||
T.same(readyOut.gold, { true, nil, false, "not_imported" },
|
||||
"cached view is invalidated when marker becomes stale")
|
||||
readinessRun.release()
|
||||
|
||||
-- Removal followed by a fresh import cannot resurrect the pre-removal view.
|
||||
local transition = {}
|
||||
Fixture.cache(transition, "red")
|
||||
local transitionFs = T.sdk.memfs(transition)
|
||||
local transitionRead = transitionFs.read
|
||||
local transitionMarkers = 0
|
||||
local reimportedPokemon = require("src.import.LuaWriter").encode({
|
||||
FIXMON = { id = "FIXMON", name = "REIMPORTED", dex = 1,
|
||||
spriteFront = "assets/generated/battle/front/fixmon.png",
|
||||
spriteBack = "assets/generated/battle/back/fixmon.png", frontSize = 5 },
|
||||
})
|
||||
transitionFs.read = function(path)
|
||||
if path == GameVersion.cachePrefix("red") .. "rom-cache.complete" then
|
||||
transitionMarkers = transitionMarkers + 1
|
||||
if transitionMarkers == 2 then return nil end
|
||||
end
|
||||
local body = transitionRead(path)
|
||||
if transitionMarkers >= 3
|
||||
and path == GameVersion.cachePrefix("red") .. "data/generated/pokemon.lua" then
|
||||
return reimportedPokemon
|
||||
end
|
||||
return body
|
||||
end
|
||||
local transitionMod = Fixture.addMod(transition, "transition_probe", [[
|
||||
local mod = ...
|
||||
local out = {}
|
||||
for index = 1, 3 do
|
||||
local view, reason = mod.datasets:open("red")
|
||||
out[index] = { view and view.content.pokemon:get("FIXMON").name, reason }
|
||||
end
|
||||
mod.exports.result = out
|
||||
]])
|
||||
local transitionRun = T.sdk.loadMods({ transitionMod }, {
|
||||
fs = transitionFs, data = { pokemon = {} }, generation = 1,
|
||||
})
|
||||
T.same(transitionRun.loader.exports.transition_probe.result, {
|
||||
{ "FIXMON" }, { nil, "not_imported" }, { "REIMPORTED" },
|
||||
}, "remove and reimport transition rebuilds the semantic view")
|
||||
transitionRun.release()
|
||||
|
||||
-- Every hostile source is rejected as data, with one stable public reason.
|
||||
local hostile = {
|
||||
{ "red", "return { BAD = function() return 1 end }" },
|
||||
{ "blue", "owned = true; return {}" },
|
||||
{ "yellow", "return 7" },
|
||||
{ "gold", string.char(27) .. "Lua" },
|
||||
{ "silver", "return {}; while true do end" },
|
||||
}
|
||||
local hostileFiles, hostilePaths = {}, {}
|
||||
for _, row in ipairs(hostile) do
|
||||
Fixture.cache(hostileFiles, row[1], { pokemon = row[2] })
|
||||
end
|
||||
local hostileMod = Fixture.addMod(hostileFiles, "hostile_probe", [[
|
||||
local mod = ...
|
||||
local out = {}
|
||||
for _, version in ipairs({ "red", "blue", "yellow", "gold", "silver" }) do
|
||||
local view, reason = mod.datasets:open(version)
|
||||
out[version] = { view ~= nil, reason }
|
||||
end
|
||||
mod.exports.result = out
|
||||
]])
|
||||
hostilePaths[1] = hostileMod
|
||||
local previousHook, previousMask, previousCount
|
||||
local beforeHook
|
||||
if debug.gethook and debug.sethook then
|
||||
previousHook, previousMask, previousCount = debug.gethook()
|
||||
beforeHook = function() end
|
||||
debug.sethook(beforeHook, "", 1000)
|
||||
end
|
||||
local hostileRun = T.sdk.loadMods(hostilePaths, {
|
||||
fs = T.sdk.memfs(hostileFiles), data = { pokemon = {} }, generation = 1,
|
||||
})
|
||||
local hostileOut = hostileRun.loader.exports.hostile_probe.result
|
||||
for _, row in ipairs(hostile) do
|
||||
T.same(hostileOut[row[1]], { false, "invalid_cache" },
|
||||
row[1] .. " hostile generated source fails closed")
|
||||
end
|
||||
T.eq(debug.gethook and debug.gethook(), beforeHook,
|
||||
"dataset decoding preserves the caller debug hook")
|
||||
if debug.sethook then
|
||||
if previousHook then debug.sethook(previousHook, previousMask, previousCount)
|
||||
else debug.sethook() end
|
||||
end
|
||||
hostileRun.release()
|
||||
|
||||
GameVersion.set(originalVersion)
|
||||
CacheFs.prefix = originalPrefix
|
||||
|
||||
T.finish("dataset_views")
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
-- A generated chunk that would loop if executed must be rejected as syntax.
|
||||
package.path = "./?.lua;./?/init.lua;" .. package.path
|
||||
local T = require("tests.modkit")
|
||||
local Fixture = require("tests.modkit.dataset_view_fixture")
|
||||
|
||||
local files = {}
|
||||
Fixture.cache(files, "red", {
|
||||
pokemon = "while true do end; return {}",
|
||||
})
|
||||
local modPath = Fixture.addMod(files, "nontermination_probe", [[
|
||||
local mod = ...
|
||||
local view, reason = mod.datasets:open("red")
|
||||
mod.exports.result = { view ~= nil, reason }
|
||||
]])
|
||||
local run = T.sdk.loadMods({ modPath }, {
|
||||
fs = T.sdk.memfs(files), data = { pokemon = {} }, generation = 1,
|
||||
})
|
||||
T.same(run.loader.exports.nontermination_probe.result,
|
||||
{ false, "invalid_cache" }, "generated code is never executed")
|
||||
run.release()
|
||||
T.finish("dataset_views_nontermination")
|
||||
@@ -0,0 +1,121 @@
|
||||
local GameVersion = require("src.core.GameVersion")
|
||||
local LuaWriter = require("src.import.LuaWriter")
|
||||
local CacheContract = require("src.import.CacheContract")
|
||||
|
||||
local Fixture = {}
|
||||
|
||||
local GEN1_MODULES = {
|
||||
"constants", "maps", "tilesets", "text", "text_pointers",
|
||||
"trainer_headers", "font", "sprites", "pokemon", "moves", "items",
|
||||
"type_chart", "trainers", "encounters", "field", "battle_anims",
|
||||
}
|
||||
local GEN1_OPTIONAL_MODULES = { "audio", "palettes", "icons" }
|
||||
|
||||
local GEN2_MODULES = {
|
||||
"pokemon", "moves", "items", "type_chart", "audio", "font", "maps",
|
||||
"tilesets", "text", "trainers", "encounters", "sprites", "palettes",
|
||||
"icons", "battle_anims", "constants", "landmarks",
|
||||
}
|
||||
|
||||
local CONTINUATIONS = {
|
||||
"CROBAT", "BELLOSSOM", "POLITOED", "SLOWKING", "STEELIX",
|
||||
"SCIZOR", "KINGDRA", "PORYGON2", "BLISSEY",
|
||||
}
|
||||
|
||||
local MOVES = {
|
||||
"IRON_TAIL", "METAL_CLAW", "STEEL_WING", "RAIN_DANCE", "SUNNY_DAY",
|
||||
"SANDSTORM", "SLUDGE_BOMB", "SHADOW_BALL",
|
||||
}
|
||||
|
||||
local function species(id, dex, generation)
|
||||
local row = {
|
||||
id = id, name = id, dex = dex,
|
||||
spriteFront = "assets/generated/battle/front/" .. id:lower() .. ".png",
|
||||
spriteBack = "assets/generated/battle/back/" .. id:lower() .. ".png",
|
||||
}
|
||||
if generation == 2 then row.picSize = 5 else row.frontSize = 5 end
|
||||
return row
|
||||
end
|
||||
|
||||
local function defaults(version)
|
||||
local generation = GameVersion.generation(version)
|
||||
local pokemon = { FIXMON = species("FIXMON", 1, generation) }
|
||||
local moves = {}
|
||||
local items = {}
|
||||
local typeChart = {
|
||||
matchups = { { attacker = "NORMAL", defender = "ROCK", multiplier = 5 } },
|
||||
types = {},
|
||||
}
|
||||
if generation == 2 then
|
||||
for index, id in ipairs(CONTINUATIONS) do
|
||||
pokemon[id] = species(id, 168 + index, generation)
|
||||
end
|
||||
for index, id in ipairs(MOVES) do
|
||||
moves[id] = { id = id, name = id, index = index, type = "STEEL",
|
||||
power = 50, accuracy = 100, pp = 15, effect = "NO_ADDITIONAL_EFFECT" }
|
||||
end
|
||||
typeChart.types.STEEL = { name = "STEEL", category = "physical", index = 9 }
|
||||
typeChart.foresightMatchups = {
|
||||
{ attacker = "NORMAL", defender = "GHOST", multiplier = 0 },
|
||||
}
|
||||
items.LEFTOVERS = { id = "LEFTOVERS", name = "LEFTOVERS", price = 0,
|
||||
heldEffect = "HELD_LEFTOVERS", heldParameter = 0 }
|
||||
end
|
||||
return {
|
||||
constants = {}, maps = {}, tilesets = {}, text = {}, text_pointers = {},
|
||||
trainer_headers = {}, font = {}, sprites = {}, pokemon = pokemon,
|
||||
moves = moves, items = items, type_chart = typeChart, trainers = {},
|
||||
encounters = {}, field = { oakSpeech = {} }, battle_anims = {},
|
||||
audio = {}, palettes = {}, icons = {}, landmarks = {},
|
||||
}
|
||||
end
|
||||
|
||||
function Fixture.cache(files, version, overrides)
|
||||
local prefix = GameVersion.cachePrefix(version)
|
||||
local generation = GameVersion.generation(version)
|
||||
local values = defaults(version)
|
||||
for name, value in pairs(overrides or {}) do values[name] = value end
|
||||
files[prefix .. "rom-cache.complete"] =
|
||||
"rom-cache-v10:" .. GameVersion.info(version).sha1
|
||||
for _, name in ipairs(generation == 2 and GEN2_MODULES or GEN1_MODULES) do
|
||||
local value = values[name]
|
||||
files[prefix .. "data/generated/" .. name .. ".lua"] =
|
||||
type(value) == "string" and value or LuaWriter.encode(value or {})
|
||||
end
|
||||
if generation == 1 then
|
||||
for _, name in ipairs(GEN1_OPTIONAL_MODULES) do
|
||||
files[prefix .. "data/generated/" .. name .. ".lua"] =
|
||||
LuaWriter.encode(values[name] or {})
|
||||
end
|
||||
end
|
||||
for _, path in ipairs(CacheContract.requiredFiles(version)) do
|
||||
if files[prefix .. path] == nil then
|
||||
files[prefix .. path] = path:match("%.lua$") and LuaWriter.encode({}) or "fixture"
|
||||
end
|
||||
end
|
||||
if type(values.pokemon) == "table" then
|
||||
for _, row in pairs(values.pokemon) do
|
||||
if type(row) == "table" and row.spriteFront then
|
||||
files[prefix .. row.spriteFront] = "front"
|
||||
files[prefix .. row.spriteBack] = "back"
|
||||
end
|
||||
end
|
||||
end
|
||||
return files
|
||||
end
|
||||
|
||||
function Fixture.addMod(files, id, body)
|
||||
files["mods/" .. id .. "/manifest.json"] = ([[{
|
||||
"id": %q, "name": %q, "version": "1.0.0", "entry": "main.lua",
|
||||
"api": 2, "games": ["all"]
|
||||
}]]):format(id, id)
|
||||
files["mods/" .. id .. "/main.lua"] = body
|
||||
return "mods/" .. id
|
||||
end
|
||||
|
||||
Fixture.GEN1_MODULES = GEN1_MODULES
|
||||
Fixture.GEN2_MODULES = GEN2_MODULES
|
||||
Fixture.CONTINUATIONS = CONTINUATIONS
|
||||
Fixture.MOVES = MOVES
|
||||
|
||||
return Fixture
|
||||
Reference in New Issue
Block a user