tfbpseudo 0.1.1__tar.gz

tfbpseudo-0.1.1/.gitignore

@@ -0,0 +1,78 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyd
+
+# Virtual environments
+env/
+.venv/
+venv/
+
+# Python build/package output
+build/
+dist/
+*.egg-info/
+
+# uv
+# uv.lock is intentionally NOT ignored
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+.claude/
+
+# Environment / secrets
+.env
+.env.*
+!.env.example
+
+# OS
+.DS_Store
+Thumbs.db
+
+*.stream
+*.txd
+*.rws
+*.wav
+*.bsp
+*.dff
+
+Levels/
+
+
+# *.gig.* = Dont track this file
+**/*.gig.* 
+
+
+
+
+native/printhook
+native/mods
+
+# Local scratch drivers / experiments
+scratch/
+
+# Compiler output from examples/
+*.out.ai
+
+# mod build output (cli mod build)
+mods/*/build/
+
+# machine-specific settings (cli config)
+settings.toml
+
+mods/
+# tfbscript local data (game scripts, notes, decompiler output)
+packages/tfbscript/example_scripts/
+packages/tfbscript/my_scripts/
+packages/tfbscript/archive/
+packages/tfbscript/nopush.txt
+_MYNOTES.*
+*.decomp

tfbpseudo-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tfbpseudo-0.1.1/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.5
+Name: tfbpseudo
+Version: 0.1.1
+Summary: Compiler and decompiler for TfbPseudo, a text version of Madagascar AI scripts
+Project-URL: Repository, https://github.com/MaxStache/madagascar-game-asset-tools
+Project-URL: Issues, https://github.com/MaxStache/madagascar-game-asset-tools/issues
+Author: Max Stache
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.12
+Requires-Dist: tfbscript>=0.1.0
+Provides-Extra: editor
+Requires-Dist: pyside6>=6.11.2; extra == 'editor'
+Description-Content-Type: text/markdown
+
+# tfbpseudo
+
+Compiler and decompiler for **TfbPseudo**, a readable text form of the AI scripts (`.ai` files) in *Madagascar* (2005, PC).
+
+Decompile a script to text, edit it, and compile it back to a byte-compatible `.ai` file. The binary format itself is handled by [`tfbscript`](https://pypi.org/project/tfbscript/).
+
+```bash
+pip install tfbpseudo            # compiler + decompiler
+pip install "tfbpseudo[editor]"  # plus the Qt editor (tfbeditor)
+```
+
+```python
+from tfbscript import ScriptFile
+from tfbpseudo import compile_source, decompile_script
+
+source = decompile_script(ScriptFile.from_path("DG_Coin_Collectable.ai"))
+# ... edit source ...
+script = compile_source(source)
+with open("DG_Coin_Collectable.ai", "wb") as f:
+    script.write(f)
+```
+
+With the `editor` extra installed, `tfbeditor [FILE]` opens a TfbPseudo editor with syntax highlighting and completion.
+
+Part of the [madagascar-game-asset-tools](https://github.com/MaxStache/madagascar-game-asset-tools) monorepo.

tfbpseudo-0.1.1/README.md

@@ -0,0 +1,25 @@
+# tfbpseudo
+
+Compiler and decompiler for **TfbPseudo**, a readable text form of the AI scripts (`.ai` files) in *Madagascar* (2005, PC).
+
+Decompile a script to text, edit it, and compile it back to a byte-compatible `.ai` file. The binary format itself is handled by [`tfbscript`](https://pypi.org/project/tfbscript/).
+
+```bash
+pip install tfbpseudo            # compiler + decompiler
+pip install "tfbpseudo[editor]"  # plus the Qt editor (tfbeditor)
+```
+
+```python
+from tfbscript import ScriptFile
+from tfbpseudo import compile_source, decompile_script
+
+source = decompile_script(ScriptFile.from_path("DG_Coin_Collectable.ai"))
+# ... edit source ...
+script = compile_source(source)
+with open("DG_Coin_Collectable.ai", "wb") as f:
+    script.write(f)
+```
+
+With the `editor` extra installed, `tfbeditor [FILE]` opens a TfbPseudo editor with syntax highlighting and completion.
+
+Part of the [madagascar-game-asset-tools](https://github.com/MaxStache/madagascar-game-asset-tools) monorepo.

tfbpseudo-0.1.1/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "tfbpseudo"
+description = "Compiler and decompiler for TfbPseudo, a text version of Madagascar AI scripts"
+version = "0.1.1"
+requires-python = ">=3.12"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Max Stache" }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Topic :: Games/Entertainment",
+    "Topic :: Software Development :: Libraries",
+]
+
+dependencies = [
+    "tfbscript>=0.1.0",
+]
+
+[project.urls]
+Repository = "https://github.com/MaxStache/madagascar-game-asset-tools"
+Issues = "https://github.com/MaxStache/madagascar-game-asset-tools/issues"
+
+[project.optional-dependencies]
+# Only tfbpseudo.editor needs Qt; the compiler and decompiler do not.
+editor = [
+    "pyside6>=6.11.2",
+]
+
+[project.gui-scripts]
+tfbeditor = "tfbpseudo.editor:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv.sources]
+tfbscript = { workspace = true }

tfbpseudo-0.1.1/src/tfbpseudo/__init__.py

@@ -0,0 +1,29 @@
+from .compiler import Compiler, compile_source
+from .decompiler import Decompiler, decompile_script
+from .errors import CompileError, DecompileError, ParseError
+from .lexer import Token, tokenize
+from .nodes import Behavior, Block, Flow, Prescript, Script, Statement, Variable
+from .parser import Parser
+
+# Imported for its side effect: it declares every opcode in both directions.
+from . import methods  # noqa: E402,F401  isort:skip
+
+__all__ = [
+    "Behavior",
+    "Block",
+    "CompileError",
+    "Compiler",
+    "DecompileError",
+    "Flow",
+    "Decompiler",
+    "ParseError",
+    "Parser",
+    "Prescript",
+    "Script",
+    "Statement",
+    "Token",
+    "Variable",
+    "compile_source",
+    "decompile_script",
+    "tokenize",
+]

tfbpseudo-0.1.1/src/tfbpseudo/arguments.py

@@ -0,0 +1,271 @@
+"""Opcode arguments, spelled the same way by the compiler and the decompiler.
+
+Nearly every opcode is a fixed list of operands, so rather than writing the two
+directions out by hand for each one -- where they could drift apart -- an
+opcode declares its operands once in `methods.py` and both handlers are built
+from that declaration. Each Argument here knows how to read one argument's
+tokens into the opcode's fields and how to write those fields back out.
+
+An argument may be `optional`, in which case it is the trailing ones that go
+missing: `spawnActor` has a byte that is only in some files, `useCamera` has a
+second duration only for a real transition. `present` decides whether to write
+one back out, and everything after an absent argument is absent too.
+"""
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from enum import IntEnum
+from typing import TYPE_CHECKING, Any
+
+from tfbpseudo.errors import CompileError, DecompileError
+from tfbpseudo.lexer import Token, synth_token
+from tfbpseudo.rhs import REL_OP_BY_TOKEN, float_text
+from tfbscript.opcodes.base import Opcode
+from tfbscript.opcodes.enums import RelOp
+
+if TYPE_CHECKING:
+    from tfbpseudo.compiler import Compiler
+    from tfbpseudo.decompiler import Decompiler
+
+@dataclass(frozen=True)
+class Argument:
+    """One argument of an opcode."""
+
+    name: str  # the opcode field it sets, and what errors call it
+    optional: bool = False
+    default: Any = None  # what the field is when the argument is left out
+    # For the opcodes whose payload shape is recorded in a private field
+    # rather than shown by the argument's own value.
+    present_if: Callable[[Opcode], bool] | None = None
+
+    def read(
+        self, tokens: list[Token], compiler: "Compiler"
+    ) -> dict[str, object]:  # pragma: no cover - overridden
+        raise NotImplementedError
+
+    def write(
+        self, opcode: Opcode, decompiler: "Decompiler"
+    ) -> list[Token]:  # pragma: no cover - overridden
+        raise NotImplementedError
+
+    def absent(self) -> dict[str, object]:
+        """The fields to set when this argument is not written."""
+        return {self.name: self.default}
+
+    def present(self, opcode: Opcode) -> bool:
+        """Whether to write this argument back out."""
+        if self.present_if is not None:
+            return self.present_if(opcode)
+
+        return getattr(opcode, self.name) != self.default
+
+    def error(self, tokens: list[Token], msg: str) -> CompileError:
+        anchor = tokens[0] if tokens else Token("EOF", "", 0, 0)
+        return CompileError(f"{self.name}: {msg}", anchor.line, anchor.col)
+
+    def one_token(self, tokens: list[Token], kind: str, what: str) -> Token:
+        if len(tokens) != 1 or tokens[0].kind != kind:
+            raise self.error(tokens, f"expected {what}")
+
+        return tokens[0]
+
+
+@dataclass(frozen=True)
+class Ref(Argument):
+    """A reference: `Zoo Loop`, `@myself.health`, `players#first`.
+
+    `expects` is the kind of variable the opcode wants named here -- "sound"
+    for `playSound`, "set" for the membership ops -- where that is the same in
+    every script. It is what the editor completes, not a rule: a reference can
+    reach the right kind through a field of something else, so nothing here
+    refuses one that does not say so up front.
+    """
+
+    expects: str | None = None
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        return {self.name: compiler.get_ref_by_tokens(tokens)}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        return decompiler.ref_tokens(getattr(opcode, self.name))
+
+
+@dataclass(frozen=True)
+class Value(Argument):
+    """A right-hand side: an immediate, a reference, or an expression."""
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        return {self.name: compiler.get_rhs_by_tokens(tokens)}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        return decompiler.rhs_tokens(getattr(opcode, self.name))
+
+
+@dataclass(frozen=True)
+class Condition(Argument):
+    """`lhs <op> rhs` in one argument, setting three fields at once."""
+
+    rel_op_name: str = "rel_op"
+    rhs_name: str = "rhs"
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        lhs, rel_op, rhs = compiler.get_condition_by_tokens(tokens)
+        return {self.name: lhs, self.rel_op_name: rel_op, self.rhs_name: rhs}
+
+    def absent(self) -> dict[str, object]:
+        # All three fields keep whatever the opcode's dataclass defaults are.
+        return {}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        return decompiler.condition_tokens(
+            getattr(opcode, self.name),
+            getattr(opcode, self.rel_op_name),
+            getattr(opcode, self.rhs_name),
+        )
+
+
+@dataclass(frozen=True)
+class Comparison(Argument):
+    """A bare relational operator, for the ops that carry one on its own."""
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        if len(tokens) != 1 or tokens[0].value not in REL_OP_BY_TOKEN:
+            raise self.error(tokens, f"expected one of {' '.join(REL_OP_BY_TOKEN)}")
+
+        return {self.name: REL_OP_BY_TOKEN[tokens[0].value]}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        rel_op: RelOp = getattr(opcode, self.name)
+        return [synth_token("OP", rel_op.symbol())]
+
+
+@dataclass(frozen=True)
+class Choice(Argument):
+    """One of an enum's members, written by name -- `slow_move`, `randomly` --
+    or by its raw number when a file has one the enum has no name for."""
+
+    enum: type[IntEnum] = RelOp
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        if len(tokens) != 1 or tokens[0].kind not in ("NAME", "NUMBER", "STRING"):
+            raise self.error(tokens, f"expected one of {self.choices()}")
+
+        token = tokens[0]
+
+        if token.kind == "NUMBER":
+            try:
+                return {self.name: self.enum(int(token.value, 0))}
+            except ValueError:
+                raise self.error(
+                    tokens, f"{token.value} is not a {self.enum.__name__} value"
+                ) from None
+
+        folded = token.value.casefold()
+        for member in self.enum:
+            if member.name.casefold() == folded:
+                return {self.name: member}
+
+        raise self.error(
+            tokens, f"{token.value!r} is not one of {self.choices()}"
+        )
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        value = getattr(opcode, self.name)
+
+        if not isinstance(value, self.enum):
+            return [synth_token("NUMBER", str(int(value)))]
+
+        return [synth_token("NAME", value.name)]
+
+    def choices(self) -> str:
+        names = [member.name for member in self.enum]
+        if len(names) > 6:
+            return ", ".join(names[:6]) + f", ... ({len(names)} in all)"
+        return ", ".join(names)
+
+
+@dataclass(frozen=True)
+class Text(Argument):
+    """A quoted string the opcode stores verbatim."""
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        return {self.name: self.one_token(tokens, "STRING", "a quoted string").value}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        return [synth_token("STRING", getattr(opcode, self.name))]
+
+
+@dataclass(frozen=True)
+class Number(Argument):
+    """A plain number the opcode stores as-is, not a right-hand side."""
+
+    is_float: bool = False
+
+    def read(self, tokens: list[Token], compiler: "Compiler") -> dict[str, object]:
+        negative = False
+        rest = tokens
+
+        if tokens and tokens[0].kind == "OP" and tokens[0].value in ("+", "-"):
+            negative = tokens[0].value == "-"
+            rest = tokens[1:]
+
+        token = self.one_token(rest, "NUMBER", "a number")
+        text = token.value
+
+        if self.is_float:
+            value = float(text)
+        else:
+            if "." in text:
+                raise self.error(tokens, f"expected a whole number, got {text}")
+            value = int(text, 0)
+
+        return {self.name: -value if negative else value}
+
+    def write(self, opcode: Opcode, decompiler: "Decompiler") -> list[Token]:
+        value = getattr(opcode, self.name)
+        text = float_text(float(value)) if self.is_float else str(int(value))
+
+        return [synth_token("NUMBER", text)]
+
+
+def read_arguments(
+    arguments: list[list[Token]],
+    spec: list[Argument],
+    opcode: Opcode,
+    compiler: "Compiler",
+) -> None:
+    """Read each argument into `opcode`'s fields, filling in the ones that were
+    left out with their defaults."""
+    for index, argument in enumerate(spec):
+        if index < len(arguments):
+            fields = argument.read(arguments[index], compiler)
+        else:
+            fields = argument.absent()
+
+        for name, value in fields.items():
+            setattr(opcode, name, value)
+
+
+def write_arguments(
+    spec: list[Argument], opcode: Opcode, decompiler: "Decompiler"
+) -> list[list[Token]]:
+    """Write `opcode`'s fields back out, stopping at the first optional
+    argument that is not there -- nothing after it can be written either."""
+    out: list[list[Token]] = []
+
+    for argument in spec:
+        if argument.optional and not argument.present(opcode):
+            break
+
+        out.append(argument.write(opcode, decompiler))
+
+    for argument in spec[len(out) :]:
+        if not argument.optional:
+            raise DecompileError(
+                f"`{argument.name}` is not optional but comes after an argument "
+                + "that is missing, so this opcode cannot be written out"
+            )
+
+    return out
+
+