splat64 0.36.0__tar.gz → 0.36.1__tar.gz

{splat64-0.36.0 → splat64-0.36.1}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # splat Release Notes
 
+### 0.36.1
+* Files generated with `generate_asm_macros_files` will not be overwritten if they already exist on disk unchanged.
+* Updated GTE macros to better document opcode encodings
+
 ### 0.36.0
 
 * New symbol attribute: `align`.

{splat64-0.36.0 → splat64-0.36.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splat64
-Version: 0.36.0
+Version: 0.36.1
 Summary: A binary splitting tool to assist with decompilation and modding projects
 Project-URL: Repository, https://github.com/ethteck/splat
 Project-URL: Issues, https://github.com/ethteck/splat/issues
@@ -76,7 +76,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.36.0,<1.0.0
+splat64[mips]>=0.36.1,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.36.0 → splat64-0.36.1}/README.md

@@ -21,7 +21,7 @@ The brackets corresponds to the optional dependencies to install while installin
 If you use a `requirements.txt` file in your repository, then you can add this library with the following line:
 
 ```txt
-splat64[mips]>=0.36.0,<1.0.0
+splat64[mips]>=0.36.1,<1.0.0
 ```
 
 ### Optional dependencies

{splat64-0.36.0 → splat64-0.36.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "splat64"
 # Should be synced with src/splat/__init__.py
-version = "0.36.0"
+version = "0.36.1"
 description = "A binary splitting tool to assist with decompilation and modding projects"
 readme = "README.md"
 license = {file = "LICENSE"}

{splat64-0.36.0 → splat64-0.36.1}/src/splat/__init__.py

@@ -1,7 +1,7 @@
 __package_name__ = __name__
 
 # Should be synced with pyproject.toml
-__version__ = "0.36.0"
+__version__ = "0.36.1"
 __author__ = "ethteck"
 
 from . import util as util

{splat64-0.36.0 → splat64-0.36.1}/src/splat/util/file_presets.py

@@ -24,6 +24,12 @@ def write_all_files():
 def _write(filepath: str, contents: str):
     p = Path(os.path.normpath(options.opts.base_path / filepath))
     p.parent.mkdir(parents=True, exist_ok=True)
+
+    if p.exists():
+        with p.open("r", encoding="UTF-8") as f:
+            existing_contents = f.read()
+        if existing_contents == contents:
+            return
     with p.open("w", encoding="UTF-8", newline="\n") as f:
         f.write(contents)
 
@@ -339,92 +345,99 @@ def write_gte_macros():
     # Taken directly from https://github.com/Decompollaborate/rabbitizer/blob/develop/docs/r3000gte/gte_macros.s
     # Please try to upstream any fix/update done here.
     gte_macros = """
-## GTE instructions macros
-## This macros are meant to be used with GAS and avoid using DMPSX
+.ifndef .L_GTE_MACRO_INC
+.L_GTE_MACRO_INC:
+
+## GTE instruction macros
+## These are meant for use with GAS and replace DMPSX
+
+.macro cop2op pseudo, op, sf = 1, mx = 0, v = 0, cv = 0, lm = 0
+    cop2 \\pseudo << 20 | \\sf << 19 | \\mx << 17 | \\v << 15 | \\cv << 13 | \\lm << 10 | \\op
+.endm
 
 /*  RTPS    15      0x4A180001  Perspective transform */
 .macro rtps
-    .word 0x4A180001
+    cop2op 0x01, 0x01
 .endm
 
 /*  RTPT    23      0x4A280030  Perspective transform on 3 points */
 .macro rtpt
-    .word 0x4A280030
+    cop2op 0x02, 0x30
 .endm
 
 /*  DPCL    8       0x4A680029  Depth Cue Color light */
 .macro dpcl
-    .word 0x4A680029
+    cop2op 0x06, 0x29
 .endm
 
 /*  DPCS    8       0x4A780010  Depth Cueing */
 .macro dpcs
-    .word 0x4A780010
+    cop2op 0x07, 0x10
 .endm
 
-/*  DPCT    17      0x4AF8002A  Depth cue color RGB0,RGB1,RGB2 */
+/*  DPCT    17      0x4A88002A  Depth cue color RGB0,RGB1,RGB2 */
 .macro dpct
-    .word 0x4AF8002A
+    cop2op 0x08, 0x2A
 .endm
 
 /*  INTPL   8       0x4A980011  Interpolation of vector and far color */
 .macro intpl
-    .word 0x4A980011
+    cop2op 0x09, 0x11
 .endm
 
 /*  NCS     14      0x4AC8041E  Normal color v0 */
 .macro ncs
-    .word 0x4AC8041E
+    cop2op 0x0C, 0x1E, lm = 1
 .endm
 
 /*  NCT     30      0x4AD80420  Normal color v0, v1, v2 */
 .macro nct
-    .word 0x4AD80420
+    cop2op 0x0D, 0x20, lm = 1
 .endm
 
 /*  NCDS    19      0x4AE80413  Normal color depth cuev0 */
 .macro ncds
-    .word 0x4AE80413
+    cop2op 0x0E, 0x13, lm = 1
 .endm
 
 /*  NCDT    44      0x4AF80416  Normal color depth cue v0, v1, v2 */
 .macro ncdt
-    .word 0x4AF80416
+    cop2op 0x0F, 0x16, lm = 1
 .endm
 
 /*  NCCS    17      0x4B08041B  Normal color col. v0 */
 .macro nccs
-    .word 0x4B08041B
+    cop2op 0x10, 0x1B, lm = 1
 .endm
 
 /*  NCCT    39      0x4B18043F  Normal color col.v0, v1, v2 */
 .macro ncct
-    .word 0x4B18043F
+    cop2op 0x11, 0x3F, lm = 1
 .endm
 
 /*  CDP     13      0x4B280414  Color Depth Queue */
 .macro cdp
-    .word 0x4B280414
+    cop2op 0x12, 0x14, lm = 1
 .endm
 
 /*  CC      11      0x4B38041C  Color Col. */
 .macro cc
-    .word 0x4B38041C
+    cop2op 0x13, 0x1C, lm = 1
 .endm
 
 /*  NCLIP   8       0x4B400006  Normal clipping */
 .macro nclip
-    .word 0x4B400006
+    cop2op 0x14, 0x06, sf = 0
 .endm
 
 /*  AVSZ3   5       0x4B58002D  Average of three Z values */
 .macro avsz3
-    .word 0x4B58002D
+    cop2op 0x15, 0x2D
 .endm
 
 /*  AVSZ4   6       0x4B68002E  Average of four Z values */
 .macro avsz4
-    .word 0x4B68002E
+    cop2op 0x16, 0x2E
 .endm
 
 
@@ -435,29 +448,29 @@ def write_gte_macros():
 # cv : arg is 2 bit wide
 # lm : arg is 1 bit wide
 
-/*  MVMVA   8       0x4A400012  Multiply vector by matrix and vector addition. */
+/*  mvmva   8       0x4A4nnn12  Multiply vector by matrix and vector addition. */
 .macro mvmva sf, mx, v, cv, lm
-    .word 0x4A400012 | (\\sf & 0x1) << 19 | (\\mx & 0x3) << 17 | (\\v & 0x3) << 15 | (\\cv & 0x3) << 13 | (\\lm & 0x1) << 10
+    cop2op 0x04, 0x12, sf = \\sf, mx = \\mx, v = \\v, cv = \\cv, lm = \\lm
 .endm
 
-/*  SQR     5       0x4AA00428  Square of vector */
+/*  SQR     5       0x4AAn0428  Square of vector */
 .macro sqr sf
-    .word 0x4AA00428 | (\\sf & 0x1) << 19
+    cop2op 0x0A, 0x28, sf = \\sf, lm = 1
 .endm
 
-/*  OP      6       0x4B70000C  Outer Product */
+/*  OP      6       0x4B7n000C  Outer Product */
 .macro op sf
-    .word 0x4B70000C | (\\sf & 0x1) << 19
+    cop2op 0x17, 0x0C, sf = \\sf
 .endm
 
-/*  GPF     6       0x4B90003D  General purpose interpolation */
+/*  GPF     6       0x4B9n003D  General purpose interpolation */
 .macro gpf sf
-    .word 0x4B90003D | (\\sf & 0x1) << 19
+    cop2op 0x19, 0x3D, sf = \\sf
 .endm
 
-/*  GPL     5       0x4BA0003E  general purpose interpolation */
+/*  GPL     5       0x4BAn003E  general purpose interpolation */
 .macro gpl sf
-    .word 0x4BA0003E | (\\sf & 0x1) << 19
+    cop2op 0x1A, 0x3E, sf = \\sf
 .endm
 
 
@@ -466,284 +479,286 @@ def write_gte_macros():
 /*  rtv0    -       0x4A486012  v0 * rotmatrix */
 .macro rtv0
     # .word 0x4A486012
-    MVMVA       1, 0, 0, 3, 0
+    mvmva       1, 0, 0, 3, 0
 .endm
 
 /*  rtv1    -       0x4A48E012  v1 * rotmatrix */
 .macro rtv1
     # .word 0x4A48E012
-    MVMVA       1, 0, 1, 3, 0
+    mvmva       1, 0, 1, 3, 0
 .endm
 
 /*  rtv2    -       0x4A496012  v2 * rotmatrix */
 .macro rtv2
     # .word 0x4A496012
-    MVMVA       1, 0, 2, 3, 0
+    mvmva       1, 0, 2, 3, 0
 .endm
 
 /*  rtir12  -       0x4A49E012  ir * rotmatrix */
 .macro rtir12
     # .word 0x4A49E012
-    MVMVA       1, 0, 3, 3, 0
+    mvmva       1, 0, 3, 3, 0
 .endm
 
 /*  rtir0   -       0x4A41E012  ir * rotmatrix */
 .macro rtir0
     # .word 0x4A41E012
-    MVMVA       0, 0, 3, 3, 0
+    mvmva       0, 0, 3, 3, 0
 .endm
 
 /*  rtv0tr  -       0x4A480012  v0 * rotmatrix + tr vector */
 .macro rtv0tr
     # .word 0x4A480012
-    MVMVA       1, 0, 0, 0, 0
+    mvmva       1, 0, 0, 0, 0
 .endm
 
 /*  rtv1tr  -       0x4A488012  v1 * rotmatrix + tr vector */
 .macro rtv1tr
     # .word 0x4A488012
-    MVMVA       1, 0, 1, 0, 0
+    mvmva       1, 0, 1, 0, 0
 .endm
 
 /*  rtv2tr  -       0x4A490012  v2 * rotmatrix + tr vector */
 .macro rtv2tr
     # .word 0x4A490012
-    MVMVA       1, 0, 2, 0, 0
+    mvmva       1, 0, 2, 0, 0
 .endm
 
 /*  rtirtr  -       0x4A498012  ir * rotmatrix + tr vector */
 .macro rtirtr
     # .word 0x4A498012
-    MVMVA       1, 0, 3, 0, 0
+    mvmva       1, 0, 3, 0, 0
 .endm
 
 /*  rtv0bk  -       0x4A482012  v0 * rotmatrix + bk vector */
 .macro rtv0bk
     # .word 0x4A482012
-    MVMVA       1, 0, 0, 1, 0
+    mvmva       1, 0, 0, 1, 0
 .endm
 
 /*  rtv1bk  -       0x4A48A012  v1 * rotmatrix + bk vector */
 .macro rtv1bk
     # .word 0x4A48A012
-    MVMVA       1, 0, 1, 1, 0
+    mvmva       1, 0, 1, 1, 0
 .endm
 
 /*  rtv2bk  -       0x4A492012  v2 * rotmatrix + bk vector */
 .macro rtv2bk
     # .word 0x4A492012
-    MVMVA       1, 0, 2, 1, 0
+    mvmva       1, 0, 2, 1, 0
 .endm
 
 /*  rtirbk  -       0x4A49A012  ir * rotmatrix + bk vector */
 .macro rtirbk
     # .word 0x4A49A012
-    MVMVA       1, 0, 3, 1, 0
+    mvmva       1, 0, 3, 1, 0
 .endm
 
 /*  ll      -       0x4A4A6412  v0 * light matrix. Lower limit result to 0 */
 .macro ll
     # .word 0x4A4A6412
-    MVMVA       1, 1, 0, 3, 1
+    mvmva       1, 1, 0, 3, 1
 .endm
 
 /*  llv0    -       0x4A4A6012  v0 * light matrix */
 .macro llv0
     # .word 0x4A4A6012
-    MVMVA       1, 1, 0, 3, 0
+    mvmva       1, 1, 0, 3, 0
 .endm
 
 /*  llv1    -       0x4A4AE012  v1 * light matrix */
 .macro llv1
     # .word 0x4A4AE012
-    MVMVA       1, 1, 1, 3, 0
+    mvmva       1, 1, 1, 3, 0
 .endm
 
 /*  llv2    -       0x4A4B6012  v2 * light matrix */
 .macro llv2
     # .word 0x4A4B6012
-    MVMVA       1, 1, 2, 3, 0
+    mvmva       1, 1, 2, 3, 0
 .endm
 
 /*  llvir   -       0x4A4BE012  ir * light matrix */
 .macro llvir
     # .word 0x4A4BE012
-    MVMVA       1, 1, 3, 3, 0
+    mvmva       1, 1, 3, 3, 0
 .endm
 
 /*  llv0tr  -       0x4A4A0012  v0 * light matrix + tr vector */
 .macro llv0tr
     # .word 0x4A4A0012
-    MVMVA       1, 1, 0, 0, 0
+    mvmva       1, 1, 0, 0, 0
 .endm
 
 /*  llv1tr  -       0x4A4A8012  v1 * light matrix + tr vector */
 .macro llv1tr
     # .word 0x4A4A8012
-    MVMVA       1, 1, 1, 0, 0
+    mvmva       1, 1, 1, 0, 0
 .endm
 
 /*  llv2tr  -       0x4A4B0012  v2 * light matrix + tr vector */
 .macro llv2tr
     # .word 0x4A4B0012
-    MVMVA       1, 1, 2, 0, 0
+    mvmva       1, 1, 2, 0, 0
 .endm
 
 /*  llirtr  -       0x4A4B8012  ir * light matrix + tr vector */
 .macro llirtr
     # .word 0x4A4B8012
-    MVMVA       1, 1, 3, 0, 0
+    mvmva       1, 1, 3, 0, 0
 .endm
 
 /*  llv0bk  -       0x4A4A2012  v0 * light matrix + bk vector */
 .macro llv0bk
     # .word 0x4A4A2012
-    MVMVA       1, 1, 0, 1, 0
+    mvmva       1, 1, 0, 1, 0
 .endm
 
 /*  llv1bk  -       0x4A4AA012  v1 * light matrix + bk vector */
 .macro llv1bk
     # .word 0x4A4AA012
-    MVMVA       1, 1, 1, 1, 0
+    mvmva       1, 1, 1, 1, 0
 .endm
 
 /*  llv2bk  -       0x4A4B2012  v2 * light matrix + bk vector */
 .macro llv2bk
     # .word 0x4A4B2012
-    MVMVA       1, 1, 2, 1, 0
+    mvmva       1, 1, 2, 1, 0
 .endm
 
 /*  llirbk  -       0x4A4BA012  ir * light matrix + bk vector */
 .macro llirbk
     # .word 0x4A4BA012
-    MVMVA       1, 1, 3, 1, 0
+    mvmva       1, 1, 3, 1, 0
 .endm
 
 /*  lc      -       0x4A4DA412  v0 * color matrix, Lower limit clamped to 0 */
 .macro lc
     # .word 0x4A4DA412
-    MVMVA       1, 2, 3, 1, 1
+    mvmva       1, 2, 3, 1, 1
 .endm
 
 /*  lcv0    -       0x4A4C6012  v0 * color matrix */
 .macro lcv0
     # .word 0x4A4C6012
-    MVMVA       1, 2, 0, 3, 0
+    mvmva       1, 2, 0, 3, 0
 .endm
 
 /*  lcv1    -       0x4A4CE012  v1 * color matrix */
 .macro lcv1
     # .word 0x4A4CE012
-    MVMVA       1, 2, 1, 3, 0
+    mvmva       1, 2, 1, 3, 0
 .endm
 
 /*  lcv2    -       0x4A4D6012  v2 * color matrix */
 .macro lcv2
     # .word 0x4A4D6012
-    MVMVA       1, 2, 2, 3, 0
+    mvmva       1, 2, 2, 3, 0
 .endm
 
 /*  lcvir   -       0x4A4DE012  ir * color matrix */
 .macro lcvir
     # .word 0x4A4DE012
-    MVMVA       1, 2, 3, 3, 0
+    mvmva       1, 2, 3, 3, 0
 .endm
 
 /*  lcv0tr  -       0x4A4C0012  v0 * color matrix + tr vector */
 .macro lcv0tr
     # .word 0x4A4C0012
-    MVMVA       1, 2, 0, 0, 0
+    mvmva       1, 2, 0, 0, 0
 .endm
 
 /*  lcv1tr  -       0x4A4C8012  v1 * color matrix + tr vector */
 .macro lcv1tr
     # .word 0x4A4C8012
-    MVMVA       1, 2, 1, 0, 0
+    mvmva       1, 2, 1, 0, 0
 .endm
 
 /*  lcv2tr  -       0x4A4D0012  v2 * color matrix + tr vector */
 .macro lcv2tr
     # .word 0x4A4D0012
-    MVMVA       1, 2, 2, 0, 0
+    mvmva       1, 2, 2, 0, 0
 .endm
 
 /*  lcirtr  -       0x4A4D8012  ir * color matrix + tr vector */
 .macro lcirtr
     # .word 0x4A4D8012
-    MVMVA       1, 2, 3, 0, 0
+    mvmva       1, 2, 3, 0, 0
 .endm
 
 /*  lev0bk  -       0x4A4C2012  v0 * color matrix + bk vector */
 .macro lev0bk
     # .word 0x4A4C2012
-    MVMVA       1, 2, 0, 1, 0
+    mvmva       1, 2, 0, 1, 0
 .endm
 
 /*  lev1bk  -       0x4A4CA012  v1 * color matrix + bk vector */
 .macro lev1bk
     # .word 0x4A4CA012
-    MVMVA       1, 2, 1, 1, 0
+    mvmva       1, 2, 1, 1, 0
 .endm
 
 /*  lev2bk  -       0x4A4D2012  v2 * color matrix + bk vector */
 .macro lev2bk
     # .word 0x4A4D2012
-    MVMVA       1, 2, 2, 1, 0
+    mvmva       1, 2, 2, 1, 0
 .endm
 
 /*  leirbk  -       0x4A4DA012  ir * color matrix + bk vector */
 .macro leirbk
     # .word 0x4A4DA012
-    MVMVA       1, 2, 3, 1, 0
+    mvmva       1, 2, 3, 1, 0
 .endm
 
 /*  sqr12   -       0x4AA80428  square of ir    1,19,12 */
 # .macro sqr12
 #     # .word 0x4AA80428
-#     SQR         1
+#     sqr         1
 # .endm
 
-/*  sqr0    -       0x4AA80428  square of ir    1,31, 0 */
+/*  sqr0    -       0x4AA00428  square of ir    1,31, 0 */
 # .macro sqr0
-#     # .word 0x4AA80428
-#     SQR         1
+#     # .word 0x4AA00428
+#     sqr         0
 # .endm
 
 /*  op12    -       0x4B78000C  outer product   1,19,12 */
 .macro op12
     # .word 0x4B78000C
-    OP          1
+    op          1
 .endm
 
 /*  op0     -       0x4B70000C  outer product   1,31, 0 */
 .macro op0
     # .word 0x4B70000C
-    OP          0
+    op          0
 .endm
 
 /*  gpf12   -       0x4B98003D  general purpose interpolation   1,19,12 */
 .macro gpf12
     # .word 0x4B98003D
-    GPF         1
+    gpf         1
 .endm
 
 /*  gpf0    -       0x4B90003D  general purpose interpolation   1,31, 0 */
 .macro gpf0
     # .word 0x4B90003D
-    GPF         0
+    gpf         0
 .endm
 
 /*  gpl12   -       0x4BA8003E  general purpose interpolation   1,19,12 */
 .macro gpl12
     # .word 0x4BA8003E
-    GPL         1
+    gpl         1
 .endm
 
 /*  gpl0    -       0x4BA0003E  general purpose interpolation   1,31, 0 */
 .macro gpl0
     # .word 0x4BA0003E
-    GPL         0
+    gpl         0
 .endm
+
+.endif
 """
 
     _write("include/gte_macros.inc", gte_macros)