Checkorder tool to keep functions in original binary order (#228)

* First commit of order tool

* More flexible match on module name. Bugfix on blank_or_comment

* Report inexact offset comments in verbose mode. Bugfix for exact regex

* Refactor checkorder into reusable isledecomp module

* Find bad comments in one pass, add awareness of TEMPLATE

* Refactor of state machine to prepare for reccmp integration

* Use isledecomp lib in reccmp

* Build isledecomp in GH actions, fix mypy complaint

* Ensure unit test cpp files will be ignored by reccmp

* Allow multiple offset markers, pep8 cleanup

* Remove unused variable

* Code style, remove unneeded module and TODO

* Final renaming and type hints

* Fix checkorder issues, add GH action and enforce (#2)

* Fix checkorder issues

* Add GH action

* Test error case

* Works

* Fixes

---------

Co-authored-by: Christian Semmler <mail@csemmler.com>

.github/workflows/build.yml

@@ -70,6 +70,11 @@ jobs:
         path: legobin
         key: legobin
 
+    - name: Build isledecomp library
+      shell: bash
+      run: |
+        pip install tools/isledecomp
+
     - name: Summarize Accuracy
       shell: bash
       run: |

.github/workflows/order.yml

@@ -0,0 +1,20 @@
+name: Check order
+
+on: [push, pull_request]
+
+jobs:
+  checkorder:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build isledecomp library
+      run: |
+        pip install tools/isledecomp
+
+    - name: Run checkorder.py
+      run: |
+        pip install -r tools/checkorder/requirements.txt
+        python3 tools/checkorder/checkorder.py --verbose --enforce ISLE
+        python3 tools/checkorder/checkorder.py --verbose --enforce LEGO1