mapfile-parser 2.7.5__tar.gz → 2.8.0__tar.gz

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/CHANGELOG.md

@@ -7,6 +7,67 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.8.0] - 2025-05-20
+
+### Added
+
+- `File::symbol_match_state_iter()` function. Returns an iterator over
+  `SymbolDecompState`, which allows to know if a symbol is considered decompiled
+  or not decompiled yet.
+- `Section::is_fill`. `true` if the section is a `*fill*` entry.
+- `MapFile::get_every_section_except_section_type`. Provides the same
+  functionallity as the old `MapFile::get_every_file_except_section_type`
+  function.
+- `Segment::get_every_section_except_section_type`. Provides the same
+  functionallity as the old `Segment::get_every_file_except_section_type`
+  function.
+- `MapFile::new_from_map_file`, `MapFile::new_from_map_str`,
+  `MapFile::new_from_gnu_map_str` and `MapFile::new_from_lld_map_str`.
+- `Symbol::nonmatching_sym_exists`. This will be set to `true` if a symbol with
+  the same name but with a `.NON_MATCHING` suffix is found on the same section.
+  - The other suffixed symbol (`.NON_MATCHING`) is still retained in the section.
+  - The suffixed symbol will have this member set to `false`.
+- Add support for the `decomp.yaml` specification from the
+  [`decomp_settings`](https://github.com/ethteck/decomp_settings) project on all
+  the provided CLI utilities.
+  - If a `decomp.yaml` file is detected, then every CLI argument that can be
+    inferred from that file will be be considered optional instead.
+  - Most CLI utilites will also add a new optional "version" argument to allow
+    picking the version to process from the `decomp.yaml` file. It defaults to
+    the first listed version.
+
+### Changed
+
+- Change `Symbol.size` to `u64` from `Option<u64>`.
+- Rename `File` to `Section`.
+  - `File` is still available as an alias to `Section`, but it is recommended to
+    use the new name instead.
+- Detect `.NON_MATCHING` symbols and fix the size of both the real symbol and
+  the `.NON_MATCHING` one during parsing.
+
+### Deprecated
+
+- `File`. Use `Section` instead.
+- `MapFile::get_every_file_except_section_type`. Use
+  `MapFile::get_every_section_except_section_type` instead.
+- `Segment::get_every_file_except_section_type`. Use
+  `Segment::get_every_section_except_section_type` instead.
+- `MapFile::new`. Use either `MapFile::new_from_map_file` or
+  `MapFile::new_from_map_str` instead.
+- `MapFile::read_map_file`. Use either `MapFile::new_from_map_file` instead.
+- `MapFile::parse_map_contents`. Use either `MapFile::new_from_map_str` instead.
+- `MapFile::parse_map_contents_gnu`. Use either `MapFile::new_from_gnu_map_str`
+  instead.
+- `MapFile::parse_map_contents_lld`. Use either `MapFile::new_from_lld_map_str`
+  instead.
+- Deprecate `MapFile::fixup_non_matching_symbols` and family. This functionality
+  is perform automatically during parsing now.
+  - Calling this function is effectively a no-op now.
+
+### Fixed
+
+- Avoid pointless internal copy during the parsing of GNU mapfiles.
+
 ## [2.7.5] - 2025-05-08
 
 ### Fixed
@@ -468,6 +529,7 @@ Full changes: <https://github.com/Decompollaborate/mapfile_parser/compare/702a73
 - Initial release
 
 [unreleased]: https://github.com/Decompollaborate/mapfile_parser/compare/master...develop
+[2.8.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.7.5...2.8.0
 [2.7.5]: https://github.com/Decompollaborate/mapfile_parser/compare/2.7.4...2.7.5
 [2.7.4]: https://github.com/Decompollaborate/mapfile_parser/compare/2.7.3...2.7.4
 [2.7.3]: https://github.com/Decompollaborate/mapfile_parser/compare/2.7.2...2.7.3

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/Cargo.lock

@@ -49,7 +49,7 @@ checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c"
 
 [[package]]
 name = "mapfile_parser"
-version = "2.7.5"
+version = "2.8.0"
 dependencies = [
  "lazy_static",
  "pyo3",

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "mapfile_parser"
-version = "2.7.5"
+version = "2.8.0"
 edition = "2021"
 rust-version = "1.65.0"
 authors = ["Anghelo Carvajal <angheloalf95@gmail.com>"]
@@ -21,12 +21,15 @@ name = "mapfile_parser"
 path = "src/rs/lib.rs"
 crate-type = ["cdylib", "staticlib", "rlib"]
 
+[features]
+default = []
+
+serde = ["dep:serde"]
+
+python_bindings = ["dep:pyo3"]
+
 [dependencies]
 regex = "1.10.2"
-pyo3 = { version = "0.23.5", optional = true, features = ["extension-module"]}
 lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"], optional = true }
-
-[features]
-python_bindings = ["dep:pyo3"]
-serde = ["dep:serde"]
+pyo3 = { version = "0.23.5", optional = true, features = ["extension-module"]}

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: mapfile_parser
-Version: 2.7.5
+Version: 2.8.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Dist: requests
+Requires-Dist: decomp-settings==0.0.7
 License-File: LICENSE
 Summary: Map file parser library focusing decompilation projects
 Keywords: mapfile,parser,decomp,decompilation
@@ -53,7 +54,7 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-mapfile_parser>=2.7.5,<3.0.0
+mapfile_parser>=2.8.0,<3.0.0
 ```
 
 #### Development version
@@ -92,7 +93,7 @@ cargo add mapfile_parser
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-mapfile_parser = "2.7.5"
+mapfile_parser = "2.8.0"
 ```
 
 ## Versioning and changelog

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/README.md

@@ -35,7 +35,7 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-mapfile_parser>=2.7.5,<3.0.0
+mapfile_parser>=2.8.0,<3.0.0
 ```
 
 #### Development version
@@ -74,7 +74,7 @@ cargo add mapfile_parser
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-mapfile_parser = "2.7.5"
+mapfile_parser = "2.8.0"
 ```
 
 ## Versioning and changelog

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/pyproject.toml

@@ -3,12 +3,13 @@
 
 [project]
 name = "mapfile_parser"
-version = "2.7.5"
+version = "2.8.0"
 description = "Map file parser library focusing decompilation projects"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [
-    "requests"
+    "requests",
+    "decomp-settings==0.0.7",
 ]
 classifiers = [
     "Programming Language :: Rust",

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/__init__.py

@@ -5,15 +5,15 @@
 
 from __future__ import annotations
 
-__version_info__ = (2, 7, 5)
-__version__ = ".".join(map(str, __version_info__))# + "-dev0"
+__version_info__ = (2, 8, 0)
+__version__ = ".".join(map(str, __version_info__)) # + "-dev0"
 __author__ = "Decompollaborate"
 
 from . import utils as utils
 
 from .mapfile import MapFile as MapFile
 from .mapfile import Symbol as Symbol
-from .mapfile import File as File
+from .mapfile import Section as Section
 from .mapfile import Segment as Segment
 from .mapfile import FoundSymbolInfo as FoundSymbolInfo
 from .mapfile import SymbolComparisonInfo as SymbolComparisonInfo
@@ -22,3 +22,6 @@ from .mapfile import MapsComparisonInfo as MapsComparisonInfo
 from .progress_stats import ProgressStats as ProgressStats
 
 from . import frontends as frontends
+
+# Renamed types
+from .mapfile import Section as File

mapfile_parser-2.8.0/src/mapfile_parser/__main__.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: © 2022-2024 Decompollaborate
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import argparse
+import decomp_settings # type:ignore
+
+import mapfile_parser
+
+
+def mapfileParserMain():
+    try:
+        decompConfig = decomp_settings.scan_for_config()
+    except:
+        decompConfig = None
+
+    description = description="""\
+Interface to call any of the mapfile_parser's CLI utilities.
+
+All the CLI utilities support the `decomp.yaml` specification from the
+[`decomp_settings`](https://github.com/ethteck/decomp_settings) project.
+
+If a `decomp.yaml` file is detected, then every CLI argument that can be
+inferred from that file will be be considered optional instead.
+
+Most CLI utilites will also add a new optional "version" argument to allow
+picking the version to process from the `decomp.yaml` file. It defaults to the
+first listed version.
+"""
+    parser = argparse.ArgumentParser(
+        description=description,
+        prog="mapfile_parser",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {mapfile_parser.__version__}")
+
+    subparsers = parser.add_subparsers(description="action", help="the action to perform", required=True)
+
+    mapfile_parser.frontends.bss_check.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.first_diff.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.jsonify.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.pj64_syms.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.progress.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.sym_info.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.symbol_sizes_csv.addSubparser(subparsers, decompConfig)
+    mapfile_parser.frontends.upload_frogress.addSubparser(subparsers, decompConfig)
+
+    args = parser.parse_args()
+    args.func(args, decompConfig)
+
+
+if __name__ == "__main__":
+    mapfileParserMain()

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/bss_check.py

@@ -13,7 +13,7 @@ from .. import mapfile
 from .. import utils
 
 
-def getComparison(mapPath: Path, expectedMapPath: Path, *, reverseCheck: bool=True) -> mapfile.MapsComparisonInfo:
+def getComparison(mapPath, expectedMapPath, *, reverseCheck: bool=True) -> mapfile.MapsComparisonInfo:
     buildMap = mapfile.MapFile()
     buildMap.readMapFile(mapPath)
     buildMap = buildMap.filterBySectionType(".bss")
@@ -126,7 +126,7 @@ def printFileComparison(comparisonInfo: mapfile.MapsComparisonInfo):
         utils.eprint("Some files appear to be missing symbols. Have they been renamed or declared as static? You may need to remake 'expected'")
 
 
-def doBssCheck(mapPath: Path, expectedMapPath: Path, *, printAll: bool=False, reverseCheck: bool=True) -> int:
+def doBssCheck(mapPath, expectedMapPath, *, printAll: bool=False, reverseCheck: bool=True) -> int:
     if not mapPath.exists():
         utils.eprint(f"{mapPath} must exist")
         return 1
@@ -147,9 +147,15 @@ def doBssCheck(mapPath: Path, expectedMapPath: Path, *, printAll: bool=False, re
     return 0
 
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
-    expectedMapPath: Path = args.expectedmap
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        expectedDir = Path(version.paths["expected_dir"])
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+        expectedMapPath = args.expectedmap if args.expectedmap is not None else expectedDir / mapPath
+    else:
+        mapPath = args.mapfile
+        expectedMapPath = args.expectedmap
 
     printAll: bool = args.print_all
     reverseCheck: bool = not args.no_reverse_check
@@ -157,11 +163,19 @@ def processArguments(args: argparse.Namespace):
     exit(doBssCheck(mapPath, expectedMapPath, printAll=printAll, reverseCheck=reverseCheck))
 
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("bss_check", help="Check that globally visible bss has not been reordered.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
-    parser.add_argument("expectedmap", help="Path to the map file in the expected dir", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("expectedmap", help="Path to the map file in the expected dir. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
 
     parser.add_argument("-a", "--print-all", help="Print all bss, not just non-matching.", action="store_true")
     parser.add_argument("--no-reverse-check", help="Disable looking for symbols on the expected map that are missing on the built map file.", action="store_true")

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/first_diff.py

@@ -13,7 +13,7 @@ from .. import mapfile
 from .. import utils
 
 
-def doFirstDiff(mapPath: Path, expectedMapPath: Path, romPath: Path, expectedRomPath: Path, diffCount: int=5, mismatchSize: bool=False, addColons: bool=True, bytesConverterCallback:Callable[[bytes, mapfile.MapFile],str|None]|None=None, endian: Literal["big", "little"] ="big") -> int:
+def doFirstDiff(mapPath, expectedMapPath, romPath, expectedRomPath, diffCount: int=5, mismatchSize: bool=False, addColons: bool=True, bytesConverterCallback:Callable[[bytes, mapfile.MapFile],str|None]|None=None, endian: Literal["big", "little"] ="big") -> int:
     if not mapPath.exists():
         print(f"{mapPath} must exist")
         return 1
@@ -139,11 +139,19 @@ def doFirstDiff(mapPath: Path, expectedMapPath: Path, romPath: Path, expectedRom
     return 0
 
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
-    expectedMapPath: Path = args.expectedmap
-    romPath: Path = args.rompath
-    expectedRomPath: Path = args.expectedrom
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        expectedDir = Path(version.paths["expected_dir"])
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+        expectedMapPath = args.expectedmap if args.expectedmap is not None else expectedDir / mapPath
+        romPath = Path(args.rompath if args.rompath is not None else version.paths.get("build"))
+        expectedRomPath = args.expectedrom if args.expectedrom is not None else expectedDir / romPath
+    else:
+        mapPath = args.mapfile
+        expectedMapPath = args.expectedmap
+        romPath = args.rompath
+        expectedRomPath = args.expectedrom
 
     diffCount: int = args.count
     mismatchSize: bool = args.mismatch_size
@@ -153,13 +161,21 @@ def processArguments(args: argparse.Namespace):
     exit(doFirstDiff(mapPath, expectedMapPath, romPath, expectedRomPath, diffCount, mismatchSize, endian=endian))
 
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("first_diff", help="Find the first difference(s) between the built ROM and the base ROM.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
-    parser.add_argument("expectedmap", help="Path to the map file in the expected dir", type=Path)
-    parser.add_argument("rompath", help="Path to built ROM", type=Path)
-    parser.add_argument("expectedrom", help="Path to the expected ROM", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("expectedmap", help="Path to the map file in the expected dir. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("rompath", help="Path to built ROM. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("expectedrom", help="Path to the expected ROM. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
 
     parser.add_argument("-c", "--count", type=int, default=5, help="find up to this many instruction difference(s)")
     parser.add_argument("-m", "--mismatch-size", help="Do not exit early if the ROM sizes does not match", action="store_true")

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/jsonify.py

@@ -19,8 +19,6 @@ def doJsonify(mapPath: Path, outputPath: Path|None, humanReadable: bool=True, ap
 
     mapFile = mapfile.MapFile()
     mapFile.readMapFile(mapPath)
-    if applyFixes:
-        mapFile = mapFile.fixupNonMatchingSymbols()
 
     jsonStr = json.dumps(mapFile.toJson(humanReadable=humanReadable), indent=4)
 
@@ -33,20 +31,33 @@ def doJsonify(mapPath: Path, outputPath: Path|None, humanReadable: bool=True, ap
     return 0
 
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+    else:
+        mapPath = args.mapfile
+
     outputPath: Path|None = Path(args.output) if args.output is not None else None
     machine: bool = args.machine
     applyFixes: bool = args.apply_fixes
 
     exit(doJsonify(mapPath, outputPath, humanReadable=not machine, applyFixes=applyFixes))
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("jsonify", help="Converts a mapfile into a json format.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
     parser.add_argument("-o", "--output", help="Output path of for the generated json. If omitted then stdout is used instead.")
     parser.add_argument("-m", "--machine", help="Emit numbers as numbers instead of outputting them as pretty strings.", action="store_true")
-    parser.add_argument("-f", "--apply-fixes", help="Apply certain fixups, like fixing size calculation of because of the existence of fake `.NON_MATCHING` symbols.", action="store_true")
+    parser.add_argument("-f", "--apply-fixes", help="DEPRECATED, this is applied automatically now. Apply certain fixups, like fixing size calculation of because of the existence of fake `.NON_MATCHING` symbols.", action="store_true")
 
     parser.set_defaults(func=processArguments)

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/pj64_syms.py

@@ -36,16 +36,29 @@ def doPj64Syms(mapPath: Path, outputPath: Path|None) -> int:
 
     return 0
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+    else:
+        mapPath = args.mapfile
+
     outputPath: Path = args.output
 
     exit(doPj64Syms(mapPath, outputPath))
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("pj64_syms", help="Produce a PJ64 compatible symbol map.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
     parser.add_argument("output", help="Path to output file. If omitted then output will be written to stdout", type=Path, nargs="?")
 
     parser.set_defaults(func=processArguments)

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/progress.py

@@ -19,7 +19,7 @@ def getProgress(mapPath: Path, asmPath: Path, nonmatchingsPath: Path, pathIndex:
     mapFile.debugging = debugging
     mapFile.readMapFile(mapPath)
 
-    return mapFile.filterBySectionType(".text").fixupNonMatchingSymbols().getProgress(asmPath, nonmatchingsPath, pathIndex=pathIndex, checkFunctionFiles=checkFunctionFiles)
+    return mapFile.filterBySectionType(".text").getProgress(asmPath, nonmatchingsPath, pathIndex=pathIndex, checkFunctionFiles=checkFunctionFiles)
 
 def doProgress(mapPath: Path, asmPath: Path, nonmatchingsPath: Path, pathIndex: int=2, checkFunctionFiles: bool=True, print_json: bool=False, debugging: bool=False) -> int:
     if not mapPath.exists():
@@ -40,10 +40,17 @@ def doProgress(mapPath: Path, asmPath: Path, nonmatchingsPath: Path, pathIndex:
     return 0
 
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
-    asmPath: Path = args.asmpath
-    nonmatchingsPath: Path = args.nonmatchingspath
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+        asmPath = Path(args.asmpath if args.asmpath is not None else version.paths.get("asm"))
+        nonmatchingsPath = Path(args.nonmatchingspath if args.nonmatchingspath is not None else version.paths.get("nonmatchings"))
+    else:
+        mapPath = args.mapfile
+        asmPath = args.asmpath
+        nonmatchingsPath = args.nonmatchingspath
+
     pathIndex: int = args.path_index
     checkFunctionFiles: bool = not args.avoid_function_files
     debugging: bool = args.debugging #! @deprecated
@@ -51,12 +58,20 @@ def processArguments(args: argparse.Namespace):
 
     exit(doProgress(mapPath, asmPath, nonmatchingsPath, pathIndex=pathIndex, checkFunctionFiles=checkFunctionFiles, print_json=print_json, debugging=debugging))
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("progress", help="Computes current progress of the matched functions. Relies on a splat (https://github.com/ethteck/splat) folder structure and matched functions not longer having a file.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
-    parser.add_argument("asmpath", help="Path to asm folder", type=Path)
-    parser.add_argument("nonmatchingspath", help="Path to nonmatchings folder", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("asmpath", help="Path to asm folder. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
+    parser.add_argument("nonmatchingspath", help="Path to nonmatchings folder. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
     parser.add_argument("-i", "--path-index", help="Specify the index to start reading the file paths. Defaults to 2", type=int, default=2)
     parser.add_argument("-f", "--avoid-function-files", help="Avoid checking if the assembly file for a function exists as a way to determine if the function has been matched or not", action="store_true")
     parser.add_argument("-d", "--debugging", help="Enable debugging prints. This option is deprecated", action="store_true")

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/sym_info.py

@@ -20,7 +20,7 @@ def doSymInfo(mapPath: Path, symName: str, *, as_vram: bool=False, as_vrom: bool
     mapFile = mapfile.MapFile()
     mapFile.readMapFile(mapPath)
 
-    possibleFiles: list[mapfile.File] = []
+    possibleFiles: list[mapfile.Section] = []
 
     if as_vram:
         address = int(symName, 0)
@@ -52,8 +52,13 @@ def doSymInfo(mapPath: Path, symName: str, *, as_vram: bool=False, as_vrom: bool
     return 1
 
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+    else:
+        mapPath = args.mapfile
+
     symName: str = args.symname
     as_vram: bool = args.vram
     as_vrom: bool = args.vrom
@@ -61,10 +66,18 @@ def processArguments(args: argparse.Namespace):
 
     exit(doSymInfo(mapPath, symName, as_vram=as_vram, as_vrom=as_vrom, as_name=as_name))
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("sym_info", help="Display various information about a symbol or address.")
 
-    parser.add_argument("mapfile", help="Path to a map file.", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
     parser.add_argument("symname", help="Symbol name or VROM/VRAM address to lookup. How to treat this argument will be guessed.")
 
     vram_vrom_group = parser.add_mutually_exclusive_group()

{mapfile_parser-2.7.5 → mapfile_parser-2.8.0}/src/mapfile_parser/frontends/symbol_sizes_csv.py

@@ -38,8 +38,13 @@ def doSymbolSizesCsv(mapPath: Path, outputPath: Path|None, filterSection: str|No
 
     return 0
 
-def processArguments(args: argparse.Namespace):
-    mapPath: Path = args.mapfile
+def processArguments(args: argparse.Namespace, decompConfig=None):
+    if decompConfig is not None:
+        version = decompConfig.get_version_by_name(args.version)
+        mapPath = Path(args.mapfile if args.mapfile is not None else version.paths.get("map"))
+    else:
+        mapPath = args.mapfile
+
     outputPath: Path|None = Path(args.output) if args.output is not None else None
     filterSection: str|None = args.filter_section
     sameFolder: bool = args.same_folder
@@ -48,10 +53,18 @@ def processArguments(args: argparse.Namespace):
 
     exit(doSymbolSizesCsv(mapPath, outputPath, filterSection, sameFolder, symbolsSummary, allFiles))
 
-def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
+def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig=None):
     parser = subparser.add_parser("symbol_sizes_csv", help="Produces a csv summarizing the files sizes by parsing a map file.")
 
-    parser.add_argument("mapfile", help="Path to a map file", type=Path)
+    nargs: str|int = 1
+    if decompConfig is not None:
+        nargs = "?"
+        versions = []
+        for version in decompConfig.versions:
+            versions.append(version.name)
+        parser.add_argument("-v", "--version", help="Version to process from the decomp.yaml file", type=str, choices=versions, default=versions[0])
+
+    parser.add_argument("mapfile", help="Path to a map file. This argument is optional if an `decomp.yaml` file is detected on the current project.", type=Path, nargs=nargs)
     parser.add_argument("-o", "--output", help="Output path of for the generated csv. If omitted then stdout is used instead.")
     parser.add_argument("--same-folder", help="Mix files in the same folder.", action="store_true")
     parser.add_argument("--symbols", help="Prints the size of every symbol instead of a summary.", action="store_true")