Merge pull request #46 from Decompollaborate/develop

2.9.2

Author: AngheloAlf

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.9.2] - 2025-05-28
+
+### Changed
+
+- `objdiff_report`:
+  - Simplify emitted entries by avoiding using quotes as much as possible when
+    using the `--emit-categories` flag.
+  - Avoid printing the summary table when using the `--emit-categories`.
+  - Allow customizing the output of the summary table a little bit via the
+    Python API.
+
 ## [2.9.1] - 2025-05-27
 
 ### Added
@@ -595,6 +606,7 @@ Full changes: <https://github.com/Decompollaborate/mapfile_parser/compare/702a73
 - Initial release
 
 [unreleased]: https://github.com/Decompollaborate/mapfile_parser/compare/master...develop
+[2.9.2]: https://github.com/Decompollaborate/mapfile_parser/compare/2.9.0...2.9.2
 [2.9.1]: https://github.com/Decompollaborate/mapfile_parser/compare/2.9.0...2.9.1
 [2.9.0]: https://github.com/Decompollaborate/mapfile_parser/compare/2.8.1...2.9.0
 [2.8.1]: https://github.com/Decompollaborate/mapfile_parser/compare/2.8.0...2.8.1

Cargo.lock

@@ -3,7 +3,7 @@
 
 [package]
 name = "mapfile_parser"
-version = "2.9.1"
+version = "2.9.2"
 edition = "2021"
 rust-version = "1.74.0"
 authors = ["Anghelo Carvajal <angheloalf95@gmail.com>"]

Cargo.toml

@@ -36,7 +36,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.9.1,<3.0.0
+mapfile_parser>=2.9.2,<3.0.0
 ```
 
 #### Development version
@@ -75,7 +75,7 @@ cargo add mapfile_parser
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-mapfile_parser = "2.9.1"
+mapfile_parser = "2.9.2"
 ```
 
 ## Versioning and changelog

README.md

@@ -3,7 +3,7 @@
 
 [project]
 name = "mapfile_parser"
-version = "2.9.1"
+version = "2.9.2"
 description = "Map file parser library focusing decompilation projects"
 readme = "README.md"
 requires-python = ">=3.9"

pyproject.toml

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-__version_info__ = (2, 9, 1)
+__version_info__ = (2, 9, 2)
 __version__ = ".".join(map(str, __version_info__)) # + "-dev0"
 __author__ = "Decompollaborate"
 

src/mapfile_parser/__init__.py

@@ -16,6 +16,12 @@
 from ..internals import objdiff_report as report_internal
 
 
+@dataclasses.dataclass
+class SummaryTableConfig:
+    doUnits: bool = False
+    sort: bool = True
+    remaining: bool = False
+
 def doObjdiffReport(
         mapPath: Path,
         outputPath: Path,
@@ -27,6 +33,7 @@ def doObjdiffReport(
         nonmatchingsPath: Path|None=None,
         emitCategories: bool=False,
         quiet: bool=False,
+        summaryTableConfig: SummaryTableConfig|None=SummaryTableConfig(),
     ) -> int:
     if not mapPath.exists():
         print(f"Could not find mapfile at '{mapPath}'")
@@ -47,12 +54,16 @@ def doObjdiffReport(
         nonmatchingsPath=nonmatchingsPath,
     )
 
-    if not quiet:
+    if not quiet and summaryTableConfig is not None and not emitCategories:
         report = report_internal.Report.readFile(outputPath)
         if report is None:
             utils.eprint(f"Unable to read back the generated report at {outputPath}")
             return 1
-        table = report.asTableStr(sort=True)
+        table = report.asTableStr(
+            do_units=summaryTableConfig.doUnits,
+            sort=summaryTableConfig.sort,
+            remaining=summaryTableConfig.remaining,
+        )
         print(table, end="")
 
         # Output to GitHub Actions job summary, if available
@@ -241,18 +252,26 @@ def decide(old: str, prefixes: list[Path]) -> str:
       prefixes_to_trim:
 """, end="")
     for trim in prefixesToTrim:
-        print(f"        - \"{trim}\"")
+        print(f"        - {trim}")
 
     def printCategories(categories: list[Category]):
         for cat in categories:
+            ide = cat.ide
+            name = cat.name
+            if ide[0] in "0123456789":
+                ide = f'"{ide}"'
+            if name[0] in "0123456789":
+                name = f'"{name}"'
             print(f"""\
-        - id: "{cat.ide}"
-          name: "{cat.name}"
+        - id: {ide}
+          name: {name}
           paths:
 """, end="")
             for p in cat.paths:
+                if p[0] in "0123456789":
+                    p = f'"{p}"'
                 print(f"""\
-            - "{p}"
+            - {p}
 """, end="")
 
     print("      categories:")
@@ -323,7 +342,10 @@ def processArguments(args: argparse.Namespace, decompConfig: decomp_settings.Con
         nonmatchingsPath = args.nonmatchingspath
 
     emitCategories: bool = args.emit_categories
-    quiet: bool= args.quiet
+    if not args.quiet:
+        summaryTableConfig = SummaryTableConfig()
+    else:
+        summaryTableConfig = None
 
     exit(doObjdiffReport(
         mapPath,
@@ -334,7 +356,7 @@ def processArguments(args: argparse.Namespace, decompConfig: decomp_settings.Con
         pathIndex=pathIndex,
         nonmatchingsPath=nonmatchingsPath,
         emitCategories=emitCategories,
-        quiet=quiet
+        summaryTableConfig=summaryTableConfig,
     ))
 
 def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser], decompConfig: decomp_settings.Config|None=None):