Merge pull request #493 from memo33/redundant-adjacencies-removal

[DLL] Remove redundant RUL2 adjacencies

For integration with the DLL-based RUL2 engine, this PR aims to remove a lot of RUL2 code made redundant by the adjacency handling of the DLL.

### DLL-based adjacencies in a nutshell

Whenever you have two adjacent tiles `A | B`, the engine looks for an _orthogonal_ surrogate tile `S` and matching RUL2 rules `A | S ⇒ A' | S'` as well as `S' | B ⇒ S" | B'` that make an override carry over from `A` to `S` to `B`. It then applies the result to the original tiles `A | B` directly, effectively applying a "virtual" rule `A | B ⇒ A' | B'`.

This means you only need to write RUL2 code that connects to pure orthogonals (in and out), but no adjacencies.

Diagonals work similarly, except they use _two_ _diagonal_ surrogate tiles. The effect is the same in that you only write RUL2 code connecting to pure diagonals (in and out).

(The orthogonal and diagonal surrogate tiles are chosen from a hard-coded list of IIDs.)

### Goals of this PR

- [x] Write a [script](https://github.com/NAMTeam/Network-Addon-Mod/blob/7d2db2d9e33ec8f16ee0fc8a316c83d6123aa600/src/main/scala/scripts/RedundantAdjacenciesChecker.scala) to identify redundant RUL2 code (i.e. covered by DLL + other RUL2 code).
- [x] Remove adjacencies from metarules:
  - [x] [FlexFlyRuleGenerator](https://github.com/NAMTeam/Network-Addon-Mod/blob/staging/src/main/scala/module/flexfly/FlexFlyRuleGenerator.scala)
  - [x] [OST generator](https://github.com/NAMTeam/Network-Addon-Mod/blob/staging/src/main/scala/module/onslope.scala)
  - [x] [RhwRuleGenerator](https://github.com/NAMTeam/Network-Addon-Mod/blob/staging/src/main/scala/module/RhwRuleGenerator.scala)
  - [x] [RealRailwayRuleGenerator](https://github.com/NAMTeam/Network-Addon-Mod/blob/staging/src/main/scala/module/RealRailwayRuleGenerator.scala) (contained no adjacencies in the first place)
  - [x] [SamRuleGenerator](https://github.com/NAMTeam/Network-Addon-Mod/blob/staging/src/main/scala/module/SamRuleGenerator.scala) (covered by [meta-sam](staging...meta-sam) branch)

- [x] Run removal script and regenerate metarule-based RUL2 code (needs to rerun after previous step is complete).
- [x] Sight the remaining RUL2 code in the repository and remove redundant parts _manually_:
  - [x]  Some files seem to consist of almost entirely adjacencies only, for example:
    * [Controller/RUL2/07_RHW/Sec7b_BaseNetwork](https://github.com/NAMTeam/Network-Addon-Mod/tree/staging/Controller/RUL2/07_RHW/Sec7b_BaseNetwork/)
    * [Controller/RUL2/08_NWM/](https://github.com/NAMTeam/Network-Addon-Mod/tree/staging/Controller/RUL2/08_NWM/)

    Partially scripted, see [remove-rhw-adjacencies.py](https://github.com/NAMTeam/Network-Addon-Mod/blob/9c1152880f93843277df3a3d33e6168958dc904e/src/scripts/remove-rhw-adjacencies.py) and [remove-nwm-adjacencies.py](https://github.com/NAMTeam/Network-Addon-Mod/blob/9c1152880f93843277df3a3d33e6168958dc904e/src/scripts/remove-nwm-adjacencies.py).

  - [x] Some of the handwritten adjacency code seems to have some bugs in it.
    Partially scripted, see [SegmentOrientationChecker](https://github.com/NAMTeam/Network-Addon-Mod/blob/9c1152880f93843277df3a3d33e6168958dc904e/src/main/scala/scripts/SegmentOrientationChecker.scala) and [MissingInstanceChecker](https://github.com/NAMTeam/Network-Addon-Mod/blob/9c1152880f93843277df3a3d33e6168958dc904e/src/main/scala/scripts/MissingInstanceChecker.scala).

Author: memo33

.github/workflows/scala.yml

@@ -34,6 +34,8 @@ jobs:
       run: sbt generateLocales
     - name: Check for new conflicting RUL2 overrides
       run: SBT_OPTS="-Xmx2G" sbt conflictingOverridesCheck
+    - name: Check for new segment orientation issues in RUL2 overrides
+      run: sbt "runMain com.sc4nam.scripts.SegmentOrientationChecker"
 
   lint:
     runs-on: ubuntu-latest

Controller/INRULs/RULConfig.txt

@@ -59,11 +59,17 @@ Source: RoadAdvanced/RUL08_Road_Advanced.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x00000009
 Compressed: 1
-Source: StreetBasic/RUL09_Street_Basic.rul
+Source: StreetBasic/RUL09_Street_Basic_Header.rul
+Source: StreetBasic/StreetBasic.rul
+Source: StreetBasic/FractionalAngle.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x0000000A
 Compressed: 1
-Source: StreetAdvanced/RUL0A_Street_Advanced.rul
+Source: StreetAdvanced/RUL0A_Street_Advanced_Header.rul
+Source: StreetAdvanced/FractionalAngle.rul
+Source: StreetAdvanced/Roundabouts.rul
+Source: StreetAdvanced/WideRadiusCurves.rul
+Source: StreetAdvanced/Miscellaneous.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x0000000B
 Compressed: 1
@@ -165,11 +171,17 @@ Source: RoadAdvanced/RUL08_Road_Advanced.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x00000009
 Compressed: 1
-Source: StreetBasic/RUL09_Street_Basic.rul
+Source: StreetBasic/RUL09_Street_Basic_Header.rul
+Source: StreetBasic/StreetBasic.rul
+Source: StreetBasic/FractionalAngle.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x0000000A
 Compressed: 1
-Source: StreetAdvanced/RUL0A_Street_Advanced.rul
+Source: StreetAdvanced/RUL0A_Street_Advanced_Header.rul
+Source: StreetAdvanced/FractionalAngle.rul
+Source: StreetAdvanced/Roundabouts.rul
+Source: StreetAdvanced/WideRadiusCurves.rul
+Source: StreetAdvanced/Miscellaneous.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x0000000B
 Compressed: 1
@@ -261,7 +273,10 @@ Source: RoadAdvanced/RUL08_Road_Advanced_Lite.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x00000009
 Compressed: 1
-Source: StreetBasic/RUL09_Street_Basic.rul
+Source: StreetBasic/RUL09_Street_Basic_Header.rul
+Source: StreetBasic/LegacyDiagonalStreets.rul
+Source: StreetBasic/StreetBasic.rul
+Source: StreetBasic/FractionalAngle.rul
 
 TGI: 0x0A5BCF4B 0xAA5BCF57 0x0000000A
 Compressed: 1

Controller/INRULs/RoadAdvanced/RUL08_Road_Advanced.rul

@@ -3212,59 +3212,55 @@
 2,5,2,2,?,?
 3,0,0x5F06BA00,3,0
 ;
-;Configurations for orthogonal road piece flipped; 5F06BB00
-;
 1,2,0,2,2
 2,5,2,?,?,2
 2,6,2,2,?,?
 2,7,?,2,2,?
-3,0,0x5F06BB00,3,0
+3,0,0x5F06BA00,1,1
 ;
 1,2,2,0,2
 2,7,2,2,?,?
 2,8,?,2,2,?
 2,1,?,?,2,2
-3,0,0x5F06BB00,0,0
+3,0,0x5F06BA00,0,1
 ;
 1,2,2,2,0
 2,1,?,2,2,?
 2,2,?,?,2,2
 2,3,2,?,?,2
-3,0,0x5F06BB00,1,0
+3,0,0x5F06BA00,3,1
 ;
 1,0,2,2,2
 2,3,?,?,2,2
 2,4,2,?,?,2
 2,5,2,2,?,?
-3,0,0x5F06BB00,2,0
+3,0,0x5F06BA00,2,1
 ;
-;Configurations for right-hook diagonal road piece; 5F06BF00
+;Configurations for diagonal (away) road piece; 5F06BE00
 ;
 1,13,0,2,2
 2,5,2,?,?,2
 2,6,2,2,?,?
 2,7,?,2,2,?
-3,0,0x5F06BF00,3,0
+3,0,0x5F06BE00,1,1
 ;
 1,2,13,0,2
 2,7,2,2,?,?
 2,8,?,2,2,?
 2,1,?,?,2,2
-3,0,0x5F06BF00,0,0
+3,0,0x5F06BE00,0,1
 ;
 1,2,2,13,0
 2,1,?,2,2,?
 2,2,?,?,2,2
 2,3,2,?,?,2
-3,0,0x5F06BF00,1,0
+3,0,0x5F06BE00,3,1
 ;
 1,0,2,2,13
 2,3,?,?,2,2
 2,4,2,?,?,2
 2,5,2,2,?,?
-3,0,0x5F06BF00,2,0
-;
-;Configurations for right-hook diagonal road piece flipped; 5F06BE00
+3,0,0x5F06BE00,2,1
 ;
 1,0,11,2,2
 2,5,2,?,?,2
@@ -3290,33 +3286,31 @@
 2,5,2,2,?,?
 3,0,0x5F06BE00,3,0
 ;
-;Configurations for left-hook diagonal road piece; 5F06B900
+;Configurations for diagonal (back) road piece; 5F06B800
 ;
 1,11,0,2,2
 2,5,2,?,?,2
 2,6,2,2,?,?
 2,7,?,2,2,?
-3,0,0x5F06B900,3,0
+3,0,0x5F06B800,1,1
 ;
 1,2,11,0,2
 2,7,2,2,?,?
 2,8,?,2,2,?
 2,1,?,?,2,2
-3,0,0x5F06B900,0,0
+3,0,0x5F06B800,0,1
 ;
 1,2,2,11,0
 2,1,?,2,2,?
 2,2,?,?,2,2
 2,3,2,?,?,2
-3,0,0x5F06B900,1,0
+3,0,0x5F06B800,3,1
 ;
 1,0,2,2,11
 2,3,?,?,2,2
 2,4,2,?,?,2
 2,5,2,2,?,?
-3,0,0x5F06B900,2,0
-;
-;Configurations for left-hook diagonal road piece flipped; 5F06B800
+3,0,0x5F06B800,2,1
 ;
 1,0,13,2,2
 2,5,2,?,?,2