Global Api & Tools refactoring

.github/config.toml

@@ -1,7 +1,11 @@
 [unstable]
 unstable-options = true
 config-include = true
-# check-cfg = true # TODO: enable after stabilized definition
 panic-abort-tests = true
 mtime-on-use = true
 avoid-dev-deps = true
+profile-rustflags = true
+
+
+[env]
+MIRIFLAGS = "-Zmiri-symbolic-alignment-check -Zmiri-track-alloc-accesses -Zmiri-unique-is-unique -Zmiri-tree-borrows -Zmiri-strict-provenance"

.github/workflows/codeql.yml

@@ -163,7 +163,6 @@ jobs:
         env:
           CRATES: >-
             -p=playdate-color
-            -p=playdate-controls
             -p=playdate-display
             -p=playdate-fs
             -p=playdate-graphics
@@ -173,7 +172,7 @@ jobs:
             -p=playdate-sprite
             -p=playdate-system
             -p=playdate
-          FEATURES: --features=bindings-derive-debug,sys/bindings-documentation,sys/error-ctx
+          FEATURES: --all-features
         run: >-
           cargo llvm-cov test ${{ env.CRATES }}
           --lib --tests --no-default-features
@@ -183,7 +182,7 @@ jobs:
           --lcov --output-path api-no-default.lcov.info
 
           cargo llvm-cov test ${{ env.CRATES }}
-          --lib --tests --no-default-features ${{ env.FEATURES }}
+          --lib --tests ${{ env.FEATURES }}
           --no-fail-fast --ignore-rust-version --include-ffi
           --remap-path-prefix --show-instantiations
           --branch --mcdc
@@ -212,7 +211,6 @@ jobs:
         if: ""
         env:
           CRATES: -p=cargo-playdate
-          RUSTFLAGS: --cfg init_tests
         run: >-
           cargo llvm-cov test ${{ env.CRATES }}
           --bins --examples --all-targets --lib --tests

.github/workflows/dev-build.yml

@@ -99,7 +99,7 @@ jobs:
         continue-on-error: true
         run: >-
           cargo build --bin=pdbindgen --no-default-features
-          --features=cli,documentation,extra-codegen,logging,pretty-please,which-rustfmt,runtime
+          --features=cli,documentation,extra-codegen,logging,pretty,runtime
       - name: Upload
         uses: actions/upload-artifact@v4
         with:

.github/workflows/release.yml

@@ -67,7 +67,6 @@ jobs:
         continue-on-error: true
         run: rustup target add x86_64-apple-darwin
 
-
       - name: prepare names
         id: names
         shell: bash
@@ -77,12 +76,10 @@ jobs:
           echo "suffix=${{ (runner.os == 'Windows' && format('-{0}', runner.arch)) || format('-{0}-{1}', runner.os, runner.arch) }}" >> "$GITHUB_OUTPUT"
           echo "full=${{ (runner.os == 'Windows' && format('-{0}.exe', runner.arch)) || format('-{0}-{1}', runner.os, runner.arch) }}" >> "$GITHUB_OUTPUT"
 
-
       - name: prepare dir
         shell: bash
         run: mkdir -p target/upload
 
-
       - name: symbolizer ${{ runner.os == 'macOS' && '(both targets)' || '' }}
         id: symbolizer
         continue-on-error: true
@@ -115,7 +112,7 @@ jobs:
         continue-on-error: true
         run: >-
           cargo build --release --bin=pdbindgen --no-default-features
-          --features=cli,documentation,extra-codegen,logging,pretty-please,which-rustfmt,runtime
+          --features=cli,documentation,extra-codegen,logging,pretty,runtime
 
       - name: bindgen to upload
         if: steps.bindgen.outcome == 'success' && runner.os != 'macOS'
@@ -132,7 +129,6 @@ jobs:
         shell: bash
         run: cp target/release/cargo-playdate${{ steps.names.outputs.ext }} target/upload/cargo-playdate${{ steps.names.outputs.full }}
 
-
       - name: merge universal
         if: runner.os == 'macOS'
         continue-on-error: true
@@ -160,7 +156,6 @@ jobs:
           retention-days: 1
           overwrite: false
 
-
   build-universal:
     continue-on-error: true
     name: Build (macos-12)
@@ -191,7 +186,7 @@ jobs:
         continue-on-error: true
         run: >-
           cargo build --release --bin=pdbindgen
-          --features=cli,documentation,extra-codegen,logging,pretty-please,which-rustfmt,runtime
+          --features=cli,documentation,extra-codegen,logging,pretty,runtime
           --no-default-features
       # fallback: if build fails => upload downloaded build:
       - if: steps.bindgen.outcome == 'failure'

.github/workflows/tests-api.yml

@@ -18,25 +18,32 @@ env:
   RUSTUP_MAX_RETRIES: 10
   CARGO_TERM_COLOR: always
   CARGO_TERM_PROGRESS_WHEN: never
+  MIRIFLAGS: -Zmiri-symbolic-alignment-check -Zmiri-track-alloc-accesses -Zmiri-unique-is-unique -Zmiri-tree-borrows -Zmiri-strict-provenance
 
 jobs:
   # Final no-op job as result of all deps-jobs, needed as finalisation step of complex/dynamic matrix.
-  success:
-    needs: sys
+  Success:
     name: Done
+    permissions:
+      contents: read
+    needs:
+      - Sys
+      - Mock
+      - Sys-Mock
+      - Sys-Miri
+      - Crates
     runs-on: ubuntu-latest
     steps:
       - name: success
         run: "true"
 
-  sys:
+  Sys:
     name: >-
       Sys (${{ matrix.os.name }}${{ matrix.bindgen.install && ' +bindgen' || '' }})
-      ${{ matrix.bindgen.features }}
+      ${{ matrix.features }}
+    permissions:
+      contents: read
     env:
-      FEATURES_1: bindgen-runtime
-      FEATURES_2: bindgen-runtime,bindings-derive-debug
-      FEATURES_3: bindgen-runtime,bindings-derive-debug,sys/bindings-documentation,sys/error-ctx
       BUILD_STD_ARGS: -Zbuild-std=core,alloc --target=thumbv7em-none-eabihf
     defaults:
       run:
@@ -47,26 +54,17 @@ jobs:
       matrix:
         os:
           - { name: mac, key: macos-14 }
-          - { name: win, key: windows-latest }
           - { name: linux, key: ubuntu-latest }
+          - { name: win, key: windows-latest }
         sdk:
           - ${{ inputs.sdk || 'latest' }}
+        features:
+          - "" # default
+          - bindgen
+          - alloc,lang-items,allocator-api,const-types
         bindgen:
           - install: false
-          - install: false
-            features: bindings-derive-debug
-          - install: false
-            features: bindgen-runtime
-          - install: false
-            features: bindgen-runtime,bindings-derive-debug
-          - install: true
-          - install: true
-            features: bindings-derive-debug
           - install: true
-            features: bindgen-runtime
-          - install: true
-            features: bindgen-runtime,bindings-derive-debug
-
     steps:
       - uses: actions/checkout@v4
         with:
@@ -87,18 +85,192 @@ jobs:
           win: ${{ secrets.SDK_BETA_WINDOWS }}
           linux: ${{ secrets.SDK_BETA_LINUX }}
 
-      - name: SDK ${{ steps.sdk.outputs.version }} installed
-        run: which pdc && pdc --version
-
       - name: Test (host)
-        run: cargo test -p=playdate-sys --features=${{ matrix.bindgen.features }} -- --nocapture
+        run: cargo test -p=playdate-sys --lib --features=${{ matrix.features }} -- --nocapture
 
       - name: Build (host)
         run: |
-          cargo build -p=playdate-sys --features=${{ matrix.bindgen.features }} --example=hello-world --features=lang-items
-          cargo build -p=playdate-sys --features=${{ matrix.bindgen.features }} --example=handler --features=lang-items,entry-point
+          cargo build -p=playdate-sys --features=${{ matrix.features }} --example=hello-world --features=lang-items
+          cargo build -p=playdate-sys --features=${{ matrix.features }} --example=handler --features=lang-items,entry-point
 
       - name: Build (device)
         run: |
-          cargo build -p=playdate-sys --features=${{ matrix.bindgen.features }} ${{ env.BUILD_STD_ARGS }} --example=hello-world --features=lang-items
-          cargo build -p=playdate-sys --features=${{ matrix.bindgen.features }} ${{ env.BUILD_STD_ARGS }} --example=handler --features=lang-items,entry-point
+          cargo build -p=playdate-sys --features=${{ matrix.features }} ${{ env.BUILD_STD_ARGS }} --example=hello-world --features=lang-items
+          cargo build -p=playdate-sys --features=${{ matrix.features }} ${{ env.BUILD_STD_ARGS }} --example=handler --features=lang-items,entry-point
+
+  Sys-Miri:
+    name: "Sys: Miri"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+
+      - name: Config
+        uses: ./.github/actions/init-cfg
+
+      - name: Install miri
+        run: rustup component add miri
+
+      - name: Test (host)
+        run: cargo miri test --lib -p=playdate-sys --features=lang-items
+
+      - name: Test (host, all-features)
+        run: cargo miri test --lib -p=playdate-sys --all-features
+
+      - name: Run (host)
+        run: |
+          cargo miri run -p=playdate-sys --example=hello-world-bin --features=lang-items
+          cargo miri run -p=playdate-sys --example=handler-bin --features=lang-items,entry-point
+
+      - name: Run (device)
+        run: |
+          cargo miri run -p=playdate-sys --example=hello-world-bin --features=lang-items --target=thumbv7em-none-eabihf
+          cargo miri run -p=playdate-sys --example=handler-bin --features=lang-items,entry-point --target=thumbv7em-none-eabihf
+
+  Sys-Mock:
+    name: "Sys: Mock"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+
+      - name: Config
+        uses: ./.github/actions/init-cfg
+
+      - name: Test (mock on alloc)
+        env:
+          RUSTFLAGS: --cfg mockrt="alloc"
+        run: cargo test --lib -p=playdate-sys --features=lang-items
+
+      - name: Test (mock on std)
+        env:
+          RUSTFLAGS: --cfg mockrt="std"
+        run: cargo test --lib -p=playdate-sys --features=lang-items
+
+  Mock:
+    name: >-
+      Mock (${{ matrix.os.name }})
+      ${{ matrix.features }}
+    permissions:
+      contents: read
+    defaults:
+      run:
+        shell: bash
+    runs-on: ${{ matrix.os.key }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - { name: mac, key: macos-14 }
+          - { name: win, key: windows-latest }
+          - { name: linux, key: ubuntu-latest }
+        features:
+          - default
+          - sim
+          - std
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+
+      - name: Config
+        uses: ./.github/actions/init-cfg
+
+      - name: Test
+        run: cargo test -p=playdate-sys-mock --features=${{ matrix.features }}
+
+      - name: Install miri
+        run: rustup component add miri
+
+      - name: Test (miri)
+        run: cargo miri test -p=playdate-sys-mock --features=${{ matrix.features }}
+
+  # sys-dependers and other api-crates:
+  Crates:
+    name: ${{ matrix.crate.name }} (${{ matrix.os.name }}, ${{ matrix.features.name }} features)
+    permissions:
+      contents: read
+    env:
+      BUILD_STD_ARGS: -Zbuild-std=core,alloc --target=thumbv7em-none-eabihf
+    defaults:
+      run:
+        shell: bash
+    runs-on: ${{ matrix.os.key }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - { name: mac, key: macos-14 }
+          - { name: linux, key: ubuntu-latest }
+          - { name: win, key: windows-latest }
+        sdk:
+          - ${{ inputs.sdk || 'latest' }}
+        crate:
+          - name: playdate-color
+            miri-flags: -Zmiri-symbolic-alignment-check -Zmiri-track-alloc-accesses -Zmiri-report-progress -Zmiri-backtrace=full -Zmiri-permissive-provenance
+          - name: playdate-callback
+          - name: playdate-display
+          - name: playdate-fs
+          - name: playdate-graphics
+          - name: playdate-menu
+          - name: playdate-scoreboards
+          - name: playdate-sound
+          - name: playdate-sprite
+          - name: playdate-system
+          - name: playdate
+        features:
+          - { arg: "", name: default }
+          - { arg: --all-features, name: all }
+          - { arg: --no-default-features, name: "no" }
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+
+      - name: Config
+        uses: ./.github/actions/init-cfg
+
+      - name: Install bindgen
+        if: inputs.ref || (matrix.sdk != 'latest')
+        uses: ./.github/actions/install-bindgen
+
+      - name: Install SDK (${{ matrix.sdk }})
+        uses: ./.github/actions/install-sdk
+        with:
+          version: ${{ matrix.sdk }}
+          mac: ${{ secrets.SDK_BETA_MACOS }}
+          win: ${{ secrets.SDK_BETA_WINDOWS }}
+          linux: ${{ secrets.SDK_BETA_LINUX }}
+
+      - name: Build (host)
+        run: cargo build -p=${{ matrix.crate.name }} ${{ matrix.features.arg }} --examples --lib
+
+      - name: Build (device)
+        run: cargo build -p=${{ matrix.crate.name }} ${{ matrix.features.arg }} ${{ env.BUILD_STD_ARGS }} --examples --lib
+
+      - name: Test
+        run: cargo test -p=${{ matrix.crate.name }} ${{ matrix.features.arg }}
+
+      - name: Install miri
+        if: matrix.crate.miri-flags
+        run: rustup component add miri
+
+      - name: Test (miri)
+        if: matrix.crate.miri-flags
+        env:
+          # MIRIFLAGS: ${{ matrix.crate.miri-flags || env.MIRIFLAGS }}
+          MIRIFLAGS: ${{ matrix.crate.miri-flags }}
+        run: cargo miri test -p=${{ matrix.crate.name }} ${{ matrix.features.arg }}