Merge pull request #153 from Decompollaborate/develop

1.22.0

Author: AngheloAlf

.github/workflows/ci.yml

@@ -9,15 +9,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
       - name: Install build module
-        run: pip install build
+        run: pip install -U build
 
       - name: Build wheel and source
         run: python -m build --sdist --wheel --outdir dist/ .
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4.3.1
         with:
           path: dist/*
 
@@ -26,12 +27,12 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4.1.2
         with:
           name: artifact
           path: dist
 
-      - uses: pypa/gh-action-pypi-publish@v1.4.2
+      - uses: pypa/gh-action-pypi-publish@v1.8.11
         with:
           user: __token__
           password: ${{ secrets.pypi_password }}

.github/workflows/mypy.yml

@@ -8,14 +8,18 @@ jobs:
     runs-on: ubuntu-latest
     name: mypy
     steps:
-    - uses: actions/checkout@v1
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
     - name: Set up Python 3.7
       uses: actions/setup-python@v1
       with:
         python-version: 3.7
+
     - name: Install Dependencies
       run: |
         pip install -r requirements.txt
         pip install mypy -U
+
     - name: mypy
       run: mypy --show-column-numbers --hide-error-context .

CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.22.0] - 2024-03-08
+
+### Added
+
+- New options:
+  - Add `ASM_GLOBALIZE_TEXT_LABELS_REFERENCED_BY_NON_JUMPTABLE`.
+    - Forces the use of `ASM_JTBL_LABEL` on text labels that are referenced by
+      non jumptables.
+    - Turned off by default.
+      - Not enabled by default since this may be a symptom of something
+        misconfigured or fake refences, since nothing besides jumptables should
+        be able to reference labels inside a function.
+- Add libleo (64DD) hardware registers to the list of known N64 hardware
+  registers.
+
+### Changed
+
+- Change the logic for emitting the alignment directives.
+  - Now the address of the symbol must be aligned relative to the file where
+    the symbol is, instead of requiring both the symbol and the file to be
+    aligned independently.
+  - This should be specially useful for PSX projects, since the compiler aligns
+    jumptables to 8, but it doesn't impose alignment restrictions on files,
+    meaning the files (and those jumptables) may end up aligned to a lower
+    alignment.
+- Avoid filtering out user declared symbols when they are outside the valid
+  address space.
+
+### Fixed
+
+- Fix missing type hints
+
 ## [1.21.0] - 2024-02-08
 
 ### Added
@@ -1390,6 +1422,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Version 1.0.0
 
 [unreleased]: https://github.com/Decompollaborate/spimdisasm/compare/master...develop
+[1.22.0]: https://github.com/Decompollaborate/spimdisasm/compare/1.21.1...1.22.0
 [1.21.0]: https://github.com/Decompollaborate/spimdisasm/compare/1.20.1...1.21.0
 [1.20.1]: https://github.com/Decompollaborate/spimdisasm/compare/1.20.0...1.20.1
 [1.20.0]: https://github.com/Decompollaborate/spimdisasm/compare/1.19.0...1.20.0

README.md

@@ -68,7 +68,7 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-spimdisasm>=1.21.0,<2.0.0
+spimdisasm>=1.22.0,<2.0.0
 ```
 
 ### Development version

mypy.ini

@@ -1,3 +1,9 @@
 [mypy]
 python_version = 3.7
 check_untyped_defs = True
+disallow_untyped_defs = True
+disallow_any_unimported = True
+no_implicit_optional = True
+warn_return_any = True
+show_error_codes = True
+warn_unused_ignores = True

pyproject.toml

@@ -4,7 +4,7 @@
 [project]
 name = "spimdisasm"
 # Version should be synced with spimdisasm/__init__.py
-version = "1.21.0"
+version = "1.22.0"
 description = "MIPS disassembler"
 readme = "README.md"
 license = {file = "LICENSE"}

spimdisasm/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-__version_info__: tuple[int, int, int] = (1, 21, 0)
+__version_info__: tuple[int, int, int] = (1, 22, 0)
 __version__ = ".".join(map(str, __version_info__))
 __author__ = "Decompollaborate"
 

spimdisasm/common/Context.py

@@ -34,8 +34,14 @@ def increaseEnd(self, address: int) -> None:
             self.end = address
         return None
 
+    def __str__(self) -> str:
+        return f"AddressRange(0x{self.start:08X}, 0x{self.end:08X})"
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
 class SymbolsRanges:
-    def __init__(self, start: int, end: int):
+    def __init__(self, start: int, end: int) -> None:
         self.mainAddressRange = AddressRange(start, end)
         self.specialRanges: list[AddressRange] = list()
 
@@ -63,6 +69,12 @@ def addSpecialRange(self, start: int, end: int) -> AddressRange|None:
         self.specialRanges.append(addrRange)
         return addrRange
 
+    def __str__(self) -> str:
+        ret = f"MainRange: {self.mainAddressRange}\n"
+        for i, spRange in enumerate(self.specialRanges):
+            ret += f"    {i}'th special: {spRange}\n"
+        return ret
+
 class Context:
     N64DefaultBanned = {
         0x7FFFFFE0, # osInvalICache
@@ -72,7 +84,7 @@ class Context:
         0x80000020,
     }
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Arbitrary initial range
         self.globalSegment = SymbolsSegment(self, 0x0, 0x1000, 0x80000000, 0x80001000, overlayCategory=None)
         # For symbols that we don't know where they come from
@@ -95,7 +107,7 @@ def __init__(self):
         self.gpAccesses = GpAccessContainer()
 
 
-    def changeGlobalSegmentRanges(self, vromStart: int, vromEnd: int, vramStart: int, vramEnd: int):
+    def changeGlobalSegmentRanges(self, vromStart: int, vromEnd: int, vramStart: int, vramEnd: int) -> None:
         if vromStart == vromEnd:
             Utils.eprint(f"Warning: globalSegment's will has its vromStart equal to the vromEnd (0x{vromStart:X})")
         if vramStart == vramEnd:
@@ -130,33 +142,33 @@ def addSpecialVramRange(self, start: int, end: int) -> AddressRange|None:
         return self.totalVramRange.addSpecialRange(start, end)
 
 
-    def initGotTable(self, pltGot: int, localsTable: list[int], globalsTable: list[int]):
+    def initGotTable(self, pltGot: int, localsTable: list[int], globalsTable: list[int]) -> None:
         self.gpAccesses.initGotTable(pltGot, localsTable, globalsTable)
 
         for gotEntry in self.gpAccesses.got.globalsTable:
             contextSym = self.globalSegment.addSymbol(gotEntry)
             contextSym.isUserDeclared = True
             contextSym.isGotGlobal = True
 
-    def addSmallSection(self, address: int, size: int):
+    def addSmallSection(self, address: int, size: int) -> None:
         self.gpAccesses.addSmallSection(address, size)
 
 
-    def fillDefaultBannedSymbols(self):
+    def fillDefaultBannedSymbols(self) -> None:
         self.bannedSymbols |= self.N64DefaultBanned
 
 
     def isAddressInGlobalRange(self, address: int) -> bool:
         return self.totalVramRange.isInRange(address)
 
 
-    def addBannedSymbol(self, address: int):
+    def addBannedSymbol(self, address: int) -> None:
         self.bannedSymbols.add(address)
 
-    def addBannedSymbolRange(self, rangeStart: int, rangeEnd: int):
+    def addBannedSymbolRange(self, rangeStart: int, rangeEnd: int) -> None:
         self.bannedRangedSymbols.append(AddressRange(rangeStart, rangeEnd))
 
-    def addBannedSymbolRangeBySize(self, rangeStart: int, size: int):
+    def addBannedSymbolRangeBySize(self, rangeStart: int, size: int) -> None:
         self.bannedRangedSymbols.append(AddressRange(rangeStart, rangeStart + size))
 
     def isAddressBanned(self, address: int) -> bool:
@@ -172,7 +184,7 @@ def addGlobalReloc(self, vromAddres: int, relocType: RelocType, symbol: ContextS
         self.globalRelocationOverrides[vromAddres] = reloc
         return reloc
 
-    def saveContextToFile(self, contextPath: Path):
+    def saveContextToFile(self, contextPath: Path) -> None:
         with contextPath.open("w") as f:
             self.globalSegment.saveContextToFile(f)
 
@@ -191,7 +203,7 @@ def saveContextToFile(self, contextPath: Path):
 
 
     @staticmethod
-    def addParametersToArgParse(parser: argparse.ArgumentParser):
+    def addParametersToArgParse(parser: argparse.ArgumentParser) -> None:
         contextParser = parser.add_argument_group("Context configuration")
 
         contextParser.add_argument("--save-context", help="Saves the context to a file", metavar="FILENAME")
@@ -214,7 +226,7 @@ def addParametersToArgParse(parser: argparse.ArgumentParser):
         symbolsConfig.add_argument("--named-hardware-regs", help="Use actual names for the hardware registers", action=Utils.BooleanOptionalAction)
 
 
-    def parseArgs(self, args: argparse.Namespace):
+    def parseArgs(self, args: argparse.Namespace) -> None:
         if args.default_banned != False:
             self.fillDefaultBannedSymbols()
         if args.libultra_syms != False:

spimdisasm/common/ContextSymbols.py

@@ -58,7 +58,7 @@ class AccessTypeInfo:
     typeUnsigned: str|None
     typeNameAliases: set[str] = dataclasses.field(default_factory=set)
 
-    def typeMatchesAccess(self, typename) -> bool:
+    def typeMatchesAccess(self, typename: SymbolSpecialType|str|None) -> bool:
         if typename is None:
             return False
         if typename == self.typeSigned:
@@ -222,7 +222,7 @@ def size(self) -> int|None:
 
     #! @deprecated
     @size.setter
-    def size(self, value: int|None):
+    def size(self, value: int|None) -> None:
         self.userDeclaredSize = value
 
     #! @deprecated
@@ -232,7 +232,7 @@ def type(self) -> SymbolSpecialType|str|None:
 
     #! @deprecated
     @type.setter
-    def type(self, value: SymbolSpecialType|str|None):
+    def type(self, value: SymbolSpecialType|str|None) -> None:
         self.setTypeSpecial(value, self.isAutogenerated)
 
     def hasNoType(self) -> bool:
@@ -574,7 +574,7 @@ def getType(self) -> str:
             return currentType.toStr()
         return currentType
 
-    def setTypeSpecial(self, newType: SymbolSpecialType|str|None, isAutogenerated: bool):
+    def setTypeSpecial(self, newType: SymbolSpecialType|str|None, isAutogenerated: bool) -> None:
         if isAutogenerated:
             self.autodetectedType = newType
         else:
@@ -727,5 +727,5 @@ def __eq__(self, other: object) -> bool:
         return self.address == other.address and self.vromAddress == other.vromAddress
 
     # https://stackoverflow.com/a/56915493/6292472
-    def __hash__(self):
+    def __hash__(self) -> int:
         return hash((self.address, self.vromAddress))

spimdisasm/common/ElementBase.py

@@ -18,7 +18,7 @@ class ElementBase:
     """Represents the base class used for most file sections and symbols.
     """
 
-    def __init__(self, context: Context, vromStart: int, vromEnd: int, inFileOffset: int, vram: int, name: str, words: list[int], sectionType: FileSectionType, segmentVromStart: int, overlayCategory: str|None):
+    def __init__(self, context: Context, vromStart: int, vromEnd: int, inFileOffset: int, vram: int, name: str, words: list[int], sectionType: FileSectionType, segmentVromStart: int, overlayCategory: str|None) -> None:
         """Constructor
 
         Args:
@@ -68,10 +68,10 @@ def vramEnd(self) -> int:
         return self.vram + self.sizew * 4
 
 
-    def setVram(self, vram: int):
+    def setVram(self, vram: int) -> None:
         self.vram = vram
 
-    def setCommentOffset(self, commentOffset: int):
+    def setCommentOffset(self, commentOffset: int) -> None:
         self.commentOffset = commentOffset
 
     def getName(self) -> str:
@@ -106,7 +106,7 @@ def getLabelFromSymbol(self, sym: ContextSymbol|None, symName: str|None) -> str:
         return ""
 
 
-    def analyze(self):
+    def analyze(self) -> None:
         """Scans the words of this element, gathering as much info as possible.
 
         This method should be called only once for each element.
@@ -306,7 +306,7 @@ def addJumpTableLabel(self, vramAddress: int, *, isAutogenerated: bool=False, sy
         return segment.addJumpTableLabel(vramAddress, isAutogenerated=isAutogenerated, vromAddress=symbolVrom)
 
 
-    def removeSymbol(self, vramAddress: int, *, symbolVrom: int|None=None):
+    def removeSymbol(self, vramAddress: int, *, symbolVrom: int|None=None) -> None:
         if symbolVrom is not None:
             segment = self.getSegmentForVrom(symbolVrom)
         else:

spimdisasm/common/FileSplitFormat.py

@@ -6,13 +6,14 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Generator
 
 from . import Utils
 from .FileSectionType import FileSectionType
 
 
 class FileSplitEntry:
-    def __init__(self, offset: int, vram: int, fileName: str, section: FileSectionType, nextOffset: int, isHandwritten: bool, isRsp: bool):
+    def __init__(self, offset: int, vram: int, fileName: str, section: FileSectionType, nextOffset: int, isHandwritten: bool, isRsp: bool) -> None:
         self.offset: int = offset
         self.vram: int = vram
         self.fileName: str = fileName
@@ -23,16 +24,16 @@ def __init__(self, offset: int, vram: int, fileName: str, section: FileSectionTy
 
 
 class FileSplitFormat:
-    def __init__(self, csvPath: Path|None = None):
+    def __init__(self, csvPath: Path|None = None) -> None:
         self.splits: list[list[str]] = list()
 
         if csvPath is not None:
             self.readCsvFile(csvPath)
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self.splits)
 
-    def __iter__(self):
+    def __iter__(self) -> Generator[FileSplitEntry, None, None]:
         section = FileSectionType.Invalid
 
         for i, row in enumerate(self.splits):
@@ -72,11 +73,11 @@ def __iter__(self):
 
             yield FileSplitEntry(offset, vram, fileName, section, nextOffset, isHandwritten, isRsp)
 
-    def readCsvFile(self, csvPath: Path):
+    def readCsvFile(self, csvPath: Path) -> None:
         self.splits = Utils.readCsv(csvPath)
         self.splits = [x for x in self.splits if len(x) > 0]
 
-    def append(self, element: FileSplitEntry | list[str]):
+    def append(self, element: FileSplitEntry | list[str]) -> None:
         if isinstance(element, FileSplitEntry):
 
             offset = f"{element.offset:X}"
@@ -108,5 +109,5 @@ def append(self, element: FileSplitEntry | list[str]):
             # TODO: error message
             raise TypeError()
 
-    def appendEndSection(self, offset: int, vram: int):
+    def appendEndSection(self, offset: int, vram: int) -> None:
         self.splits.append([f"{offset:X}", f"{vram:X}", ".end"])