hirofa-quickjs-sys 0.14.0

QuickJS, QuickJS-NG Javascript Engine FFI bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
name: ci

on:
  pull_request:
    paths:
      - '**'
      - '!.gitignore'
      - '!LICENSE'
      - '!README.md'
      - '!docs/**'
      - '!examples/**'
      - '.github/workflows/ci.yml'
  push:
    branches:
      - master
    paths:
      - '**'
      - '!.gitignore'
      - '!LICENSE'
      - '!README.md'
      - '!docs/**'
      - '!examples/**'
      - '.github/workflows/ci.yml'

jobs:
  codegen:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: build
        run: |
          make codegen
      - name: Check if the git repository is clean
        run: (exit "$(git status --porcelain --untracked-files=no | head -255 | wc -l)") || (echo "Dirty git tree"; git diff; exit 1)

  ci:
    runs-on: ${{ matrix.config.os }}
    name: ${{ matrix.config.os }} (${{ matrix.config.configType }}${{ matrix.config.arch }})
    env:
      ASAN_OPTIONS: halt_on_error=1
      MSAN_OPTIONS: halt_on_error=1
      UBSAN_OPTIONS: halt_on_error=1
    defaults:
      run:
        shell: ${{ matrix.config.arch == '' && 'sh' || 'alpine.sh' }} {0}

    strategy:
      fail-fast: false
      matrix:
        config:
          # see https://github.com/quickjs-ng/quickjs/issues/879 - tl;dr flaky
          #- { os: ubuntu-24.04-arm, configType: Debug }
          #- { os: ubuntu-24.04-arm, configType: Release, runTest262: true }
          - { os: ubuntu-latest, configType: Debug }
          - { os: ubuntu-latest, configType: Release, runTest262: true }
          - { os: ubuntu-latest, configType: examples }
          - { os: ubuntu-latest, configType: shared }
          - { os: ubuntu-latest, configType: asan+ubsan, runTest262: true }
          - { os: ubuntu-latest, configType: msan }
          - { os: ubuntu-latest, configType: tcc }
          - { os: ubuntu-latest, arch: x86, runTest262: true }
          - { os: ubuntu-latest, arch: riscv64 }

          - { os: macos-14, configType: Debug }
          - { os: macos-14, configType: Release }
          - { os: macos-14, configType: examples }
          - { os: macos-14, configType: shared }
          - { os: macos-14, configType: asan+ubsan, runTest262: true }
    steps:
      - uses: actions/checkout@v6
        with:
          submodules: true

      - name: install TCC
        if: ${{ matrix.config.configType == 'tcc' }}
        run: |
          pushd /tmp
          git clone https://repo.or.cz/tinycc.git
          cd tinycc
          git checkout c21576f8a32715ab439690d18184b0e02022bbbd
          ./configure
          make
          sudo make install
          tcc -v
          popd
          echo "CC=tcc" >> $GITHUB_ENV;

      - name: Install extra dependencies
        if: ${{ matrix.config.arch != '' }}
        shell: 'sh'
        run: |
          sudo apt update && sudo apt install -y binfmt-support

      - name: Setup Alpine
        if: ${{ matrix.config.arch != '' }}
        uses: jirutka/setup-alpine@v1
        with:
          arch: ${{ matrix.config.arch }}
          packages: "build-base make cmake git"

      - name: uname
        run: uname -a

      - name: Set build ENV vars
        run: |
          if [ "${{ matrix.config.configType }}" = "Debug" ]; then
            echo "BUILD_TYPE=Debug" >> $GITHUB_ENV;
          elif [ "${{ matrix.config.configType }}" = "examples" ]; then
            echo "QJS_BUILD_EXAMPLES=ON" >> $GITHUB_ENV;
          elif [ "${{ matrix.config.configType }}" = "shared" ]; then
            echo "BUILD_SHARED_LIBS=ON" >> $GITHUB_ENV;
          elif [ "${{ matrix.config.configType }}" = "asan+ubsan" ]; then
            echo "BUILD_TYPE=RelWithDebInfo" >> $GITHUB_ENV;
            echo "QJS_ENABLE_ASAN=ON" >> $GITHUB_ENV;
            echo "QJS_ENABLE_UBSAN=ON" >> $GITHUB_ENV;
          elif [ "${{ matrix.config.configType }}" = "msan" ]; then
            echo "BUILD_TYPE=RelWithDebInfo" >> $GITHUB_ENV;
            echo "QJS_ENABLE_MSAN=ON" >> $GITHUB_ENV;
            echo "CC=clang" >> $GITHUB_ENV;
          fi

      - name: build
        run: |
          make \
            BUILD_TYPE=$BUILD_TYPE \
            QJS_BUILD_EXAMPLES=$QJS_BUILD_EXAMPLES \
            BUILD_SHARED_LIBS=$BUILD_SHARED_LIBS \
            QJS_ENABLE_ASAN=$QJS_ENABLE_ASAN \
            QJS_ENABLE_UBSAN=$QJS_ENABLE_UBSAN \
            QJS_ENABLE_MSAN=$QJS_ENABLE_MSAN

      - name: stats
        if: ${{ matrix.config.configType != 'examples' }}
        run: |
          make stats

      - name: cxxtest
        run: |
          make cxxtest

      - name: test
        if: ${{ matrix.config.configType != 'examples' }}
        run: |
          make test

      - name: test examples
        if: ${{ matrix.config.configType == 'examples' }}
        run: |
          cp build/fib.so examples/
          cp build/point.so examples/
          ./build/qjs examples/test_fib.js
          ./build/qjs examples/test_point.js
          ./build/qjs tests/test_bjson.js
          ./build/function_source

      - name: test 262
        if: ${{ matrix.config.runTest262 }}
        run: |
          git submodule update --init --checkout --depth 1
          make test262

      - name: test standalone
        run: |
          ./build/qjs -c examples/hello.js -o hello
          ./hello

      - name: test api
        run: |
          ./build/api-test

      - name: test lre
        run: |
          ./build/lre-test

  windows-msvc:
    runs-on: ${{ matrix.config.os }}
    strategy:
      fail-fast: false
      matrix:
        config:
          - { arch: x64, vsArch: x64, buildType: Debug, os: windows-latest }
          - { arch: x64, vsArch: x64, buildType: Release, os: windows-latest }
          - { arch: Win32, vsArch: x86, buildType: Debug, os: windows-latest }
          - { arch: Win32, vsArch: x86, buildType: Release, os: windows-latest }
          - { arch: ARM64, vsArch: arm64, buildType: Debug, os: windows-11-arm }
          - { arch: ARM64, vsArch: arm64, buildType: Release, os: windows-11-arm }
    steps:
      - uses: actions/checkout@v6
      - name: build
        run: |
          cmake -B build -DQJS_BUILD_WERROR=ON -DQJS_BUILD_EXAMPLES=ON -G "Visual Studio 17 2022" -A ${{matrix.config.arch}}
          cmake --build build --config ${{matrix.config.buildType}}
      - name: stats
        run: |
          build\${{matrix.config.buildType}}\qjs.exe -qd
      - name: test
        run: |
          cp build\${{matrix.config.buildType}}\fib.dll examples\
          cp build\${{matrix.config.buildType}}\point.dll examples\
          build\${{matrix.config.buildType}}\qjs.exe examples\test_fib.js
          build\${{matrix.config.buildType}}\qjs.exe examples\test_point.js
          build\${{matrix.config.buildType}}\run-test262.exe -c tests.conf
          build\${{matrix.config.buildType}}\function_source.exe
      - name: test standalone
        run: |
          build\${{matrix.config.buildType}}\qjs.exe -c examples\hello.js -o hello.exe
          .\hello.exe
      - name: test api
        run: |
          build\${{matrix.config.buildType}}\api-test.exe
      - name: test lre
        run: |
          build\${{matrix.config.buildType}}\lre-test.exe
      - name: Set up Visual Studio shell
        uses: egor-tensin/vs-shell@v2
        with:
          arch: ${{ matrix.config.vsArch }}
      - name: cxxtest
        run: |
          cl.exe /DJS_NAN_BOXING=0 /Zs cxxtest.cc
          cl.exe /DJS_NAN_BOXING=1 /Zs cxxtest.cc

  windows-clang:
    runs-on: windows-latest
    strategy:
      fail-fast: false
      matrix:
        buildType: [Debug, Release]
    steps:
      - uses: actions/checkout@v6
      - name: build
        run: |
          git submodule update --init --checkout --depth 1
          cmake -B build -DQJS_BUILD_WERROR=ON -DQJS_BUILD_EXAMPLES=ON -G "Visual Studio 17 2022" -T ClangCL
          cmake --build build --config ${{matrix.buildType}}
      - name: stats
        run: |
          build\${{matrix.buildType}}\qjs.exe -qd
      - name: cxxtest
        run: |
          clang-cl.exe /DJS_NAN_BOXING=0 /Zs cxxtest.cc
          clang-cl.exe /DJS_NAN_BOXING=1 /Zs cxxtest.cc
      - name: test
        run: |
          cp build\${{matrix.buildType}}\fib.dll examples\
          cp build\${{matrix.buildType}}\point.dll examples\
          build\${{matrix.buildType}}\qjs.exe examples\test_fib.js
          build\${{matrix.buildType}}\qjs.exe examples\test_point.js
          build\${{matrix.buildType}}\run-test262.exe -c tests.conf
          build\${{matrix.buildType}}\function_source.exe
      - name: test api
        run: |
          build\${{matrix.buildType}}\api-test.exe
      - name: test lre
        run: |
          build\${{matrix.buildType}}\lre-test.exe

  windows-ninja:
    runs-on: windows-latest
    strategy:
      fail-fast: false
      matrix:
        buildType: [Debug, Release]
    steps:
      - uses: actions/checkout@v6
      - name: install ninja
        run: |
          choco install ninja
          ninja.exe --version
      - name: build
        run: |
          git submodule update --init --checkout --depth 1
          cmake -B build -DQJS_BUILD_WERROR=ON -DQJS_BUILD_EXAMPLES=ON -DCMAKE_BUILD_TYPE=${{matrix.buildType}} -G "Ninja"
          cmake --build build
      - name: stats
        run: |
          build\qjs.exe -qd
      - name: test
        run: |
          cp build\fib.dll examples\
          cp build\point.dll examples\
          build\qjs.exe examples\test_fib.js
          build\qjs.exe examples\test_point.js
          build\run-test262.exe -c tests.conf
          build\function_source.exe
      - name: test api
        run: |
          build\api-test.exe
      - name: test lre
        run: |
          build\lre-test.exe

  windows-sdk:
    runs-on: windows-latest
    strategy:
      fail-fast: false
      matrix:
        arch: [x64, Win32]
        buildType: [Debug, Release]
    steps:
      - uses: actions/checkout@v6
      - name: Install windows sdk
        uses: ChristopheLav/windows-sdk-install@v1
        with:
          version-sdk: 26100
          features: 'OptionId.DesktopCPPx86,OptionId.DesktopCPPx64'
      - name: build
        run: |
          cmake -B build -DQJS_BUILD_WERROR=ON -DQJS_BUILD_EXAMPLES=ON -DCMAKE_SYSTEM_VERSION="10.0.26100.0" -A ${{matrix.arch}}
          cmake --build build --config ${{matrix.buildType}}
      - name: stats
        run: |
          build\${{matrix.buildType}}\qjs.exe -qd
      - name: test
        run: |
          cp build\${{matrix.buildType}}\fib.dll examples\
          cp build\${{matrix.buildType}}\point.dll examples\
          build\${{matrix.buildType}}\qjs.exe examples\test_fib.js
          build\${{matrix.buildType}}\qjs.exe examples\test_point.js
          build\${{matrix.buildType}}\run-test262.exe -c tests.conf
          build\${{matrix.buildType}}\function_source.exe
      - name: test api
        run: |
          build\${{matrix.buildType}}\api-test.exe
      - name: test lre
        run: |
          build\${{matrix.buildType}}\lre-test.exe

  windows-mingw:
    runs-on: windows-latest
    strategy:
      fail-fast: false
      matrix:
        buildType: [Debug, Release]
        sys:
          - mingw32
          - mingw64
          - clang64
          - ucrt64
    defaults:
      run:
        shell: msys2 {0}
    steps:
    - uses: actions/checkout@v6
    - name: Setup MSYS2
      uses: msys2/setup-msys2@v2
      with:
        update: true
        msystem: ${{matrix.sys}}
        install: >-
          git
          make
        pacboy: >-
          cmake:p
          ninja:p
          toolchain:p
    - name: build
      run: |
        make BUILD_TYPE=${{matrix.buildType}}
    - name: stats
      run: |
        make stats
        ldd build/qjs
    - name: cxxtest
      if: ${{ matrix.sys != 'clang64' }}
      run: |
        make cxxtest
    - name: cxxtest
      if: ${{ matrix.sys == 'clang64' }}
      run: |
        make cxxtest CXX=clang++
    - name: test
      run: |
        make test
    - name: test standalone
      run: |
        ./build/qjs -c examples/hello.js -o hello.exe
        ./hello
    - name: test api
      run: |
        ./build/api-test
    - name: test lre
      run: |
        ./build/lre-test
  windows-mingw-shared:
    runs-on: windows-latest
    defaults:
      run:
        shell: msys2 {0}
    steps:
      - uses: actions/checkout@v6
      - name: Setup MSYS2
        uses: msys2/setup-msys2@v2
        with:
          install: >-
            git
            make
          pacboy: >-
            cmake:p
            ninja:p
            toolchain:p
      - name: build
        run: |
          make BUILD_SHARED_LIBS=ON
          ldd build/qjs
      - name: stats
        run: |
          make stats

  emscripten:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: mymindstorm/setup-emsdk@v14
      - name: check emsdk
        run: emcc -v
      - name: build
        run: |
          emcmake cmake -B build -DQJS_BUILD_WERROR=ON -DQJS_BUILD_LIBC=ON
          emmake make -C build qjs_wasm "-j$(getconf _NPROCESSORS_ONLN)"
      - name: result
        run: ls -lh build
  wasi:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v6
      - uses: jcbhmr/setup-wasmtime@v2
      - name: setup wasi-sdk
        run: |
          wget -nv https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-29/wasi-sdk-29.0-x86_64-linux.deb -P /tmp
          sudo apt install /tmp/wasi-sdk*.deb
      - name: test
        run: |
          cmake -B build -DQJS_BUILD_WERROR=ON -DCMAKE_TOOLCHAIN_FILE=/opt/wasi-sdk/share/cmake/wasi-sdk.cmake
          make -C build qjs_exe
          wasmtime run build/qjs -qd
          echo "console.log('hello wasi!');" > t.js
          wasmtime run --dir . build/qjs t.js
      - name: build wasi reactor
        run: |
          cmake -B build -DQJS_BUILD_WERROR=ON -DCMAKE_TOOLCHAIN_FILE=/opt/wasi-sdk/share/cmake/wasi-sdk.cmake -DQJS_WASI_REACTOR=ON
          make -C build qjs_wasi
          ls -lh build/qjs.wasm

  cygwin:
    runs-on: windows-latest
    defaults:
      run:
        shell: C:\cygwin\bin\bash.exe --login --norc -eo pipefail -o igncr '{0}'
    env:
      CYGWIN_NOWINPATH: 1
      CHERE_INVOKING: 1
    steps:
      - name: Set up Cygwin
        uses: cygwin/cygwin-install-action@master
        with:
            packages: make cmake gcc-g++ bash

      - uses: actions/checkout@v6

      - name: build
        run: make

      - name: stats
        run: make stats

      - name: cxxtest
        run: |
          make cxxtest

      - name: test
        run: make test

      - name: test api
        run: |
          ./build/api-test

      - name: test lre
        run: |
          ./build/lre-test

  openbsd:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: build + test
        uses: vmactions/openbsd-vm@v1
        with:
          usesh: true
          prepare: |
            pkg_add cmake gmake
          run: |
            gmake
            gmake stats

  freebsd:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: build + test
        uses: vmactions/freebsd-vm@v1
        with:
          usesh: true
          prepare: |
            pkg install -y cmake gmake
          run: |
            gmake
            gmake stats

  android:
    runs-on: ubuntu-latest
    container: reactnativecommunity/react-native-android:v13.0
    steps:
      - uses: actions/checkout@v6
      - name: Configure android arm64
        # see build options you can use in https://developer.android.com/ndk/guides/cmake
        run: |
          mkdir build
          cd build
          "$ANDROID_HOME/cmake/3.22.1/bin/cmake" "-DCMAKE_TOOLCHAIN_FILE=$ANDROID_HOME/ndk/26.0.10792818/build/cmake/android.toolchain.cmake" -DCMAKE_BUILD_TYPE=Release -DANDROID_ABI="arm64-v8a" -DANDROID_PLATFORM=android-24 -DQJS_BUILD_LIBC=ON ..
      - name: Build android arm64
        run: |
          "$ANDROID_HOME/cmake/3.22.1/bin/cmake" --build build --target qjs
          ls -lh build

  ios:
    runs-on: macos-latest
    steps:
      - uses: actions/checkout@v6
      - name: configure
        run: |
          cmake -B build -GXcode -DQJS_BUILD_WERROR=ON -DCMAKE_SYSTEM_NAME:STRING=iOS -DCMAKE_XCODE_ATTRIBUTE_CODE_SIGNING_ALLOWED:BOOL=NO -DQJS_BUILD_LIBC=ON
      - name: build
        run: |
          cmake --build build --config Release --target qjs
          ls -lh build

  mimalloc-linux:
    runs-on: ubuntu-24.04
    env:
      QJS_BUILD_CLI_WITH_MIMALLOC: ON
      MIMALLOC_SHOW_STATS: 1
    steps:
      - uses: actions/checkout@v6
      - name: install dependencies
        run: |
          sudo apt update && sudo apt -y install libmimalloc-dev
      - name: build
        run: |
          make
      - name: cxxtest
        run: |
          make cxxtest
      - name: test
        run: |
          make test

  mimalloc-macos:
    runs-on: macos-latest
    env:
      QJS_BUILD_CLI_WITH_STATIC_MIMALLOC: ON
      MIMALLOC_SHOW_STATS: 1
    steps:
      - uses: actions/checkout@v6
      - name: install dependencies
        run: |
          brew install mimalloc
      - name: build
        run: |
          make
      - name: cxxtest
        run: |
          make cxxtest
      - name: test
        run: |
          make test

  amalgam:
    strategy:
      matrix:
        # TODO(bnoordhuis) test on windows
        config:
          - { os: ubuntu-latest }
          - { os: macos-latest }
    runs-on: ${{ matrix.config.os }}
    steps:
      - uses: actions/checkout@v6
      - name: build
        run: |
          make
      - name: create amalgamation
        run: |
          make amalgam
      - name: build amalgamation
        run: |
          unzip -d "$RUNNER_TEMP" build/quickjs-amalgam.zip
          cc -Wall -I. -o "$RUNNER_TEMP/run-test262.o" -c run-test262.c
          cc -Wall -I/ -DQJS_BUILD_LIBC -o "$RUNNER_TEMP/quickjs-amalgam.o" -c "$RUNNER_TEMP/quickjs-amalgam.c"
          cc -o "$RUNNER_TEMP/run-test262" "$RUNNER_TEMP/run-test262.o" "$RUNNER_TEMP/quickjs-amalgam.o" -lm
      - name: test
        run: |
          make test RUN262="$RUNNER_TEMP/run-test262"

  jscheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: jscheck
        run: |
          make jscheck

  parserless:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: build
        run: |
          make QJS_DISABLE_PARSER=ON QJS_BUILD_EXAMPLES=ON
      - name: test
        run: |
          ./build/hello
          ./build/hello_module


  meson:
    runs-on: ${{ matrix.platform }}
    name: meson on ${{ matrix.platform }} (${{ matrix.mode.name }} ${{ matrix.flavor }}, ${{ matrix.features.name }})
    strategy:
      fail-fast: false
      matrix:
        flavor:
          - debug
          - release
        features:
          - name: default
            args: ""
          - name: libc
            args: -Dlibc=true
          - name: mimalloc
            args: -Dcli_mimalloc=auto
        mode:
          - name: default
            args: -Dtests=enabled
            extra_envs: {}

          # Alternative compiler setups
          - name: gcc
            args: -Dtests=enabled
            extra_envs:
              CC: gcc
              CXX: g++
          - name: clang
            args: -Dtests=enabled
            extra_envs:
              CC: clang
              CXX: clang++

          - name: sanitize
            args: >-
              "-Db_sanitize=address,undefined"
            extra_envs: {}

          # This is for MSVC, which only supports AddressSanitizer.
          # https://learn.microsoft.com/en-us/cpp/sanitizers/
          - name: sanitize+asanonly
            args: -Db_sanitize=address
            extra_envs:
              ASAN_OPTIONS: report_globals=0:halt_on_error=1:abort_on_error=1:print_summary=1

          - name: clang+sanitize
            args: >-
              "-Db_sanitize=address,undefined"
              "-Db_lundef=false"
            extra_envs:
              CC: clang
              CXX: clang++
          - name: clang+msan
            args: >-
              "-Db_sanitize=memory"
              "-Db_lundef=false"
            extra_envs:
              CC: clang
              CXX: clang++

          # default clang on GitHub hosted runners is from MSYS2.
          # Use Visual Studio supplied clang-cl instead.
          - name: clang-cl+sanitize
            args: >-
              "-Db_sanitize=address,undefined"
              "-Db_lundef=false"
            extra_envs:
              CC: clang-cl
              CXX: clang-cl
        platform:
          - ubuntu-latest
          - windows-latest
          - macos-latest

        exclude:
          # clang-cl only makes sense on windows.
          - platform: ubuntu-latest
            mode:
              name: clang-cl+sanitize
          - platform: macos-latest
            mode:
              name: clang-cl+sanitize

          # Use clang-cl instead of MSYS2 clang.
          #
          # we already tested clang+sanitize on linux,
          # if this doesn't work, it should be an issue for MSYS2 team to consider.
          - platform: windows-latest
            mode:
              name: clang
          - platform: windows-latest
            mode:
              name: clang+sanitize
          - platform: windows-latest
            mode:
              name: clang+msan

          # MSVC-only sanitizers
          - platform: ubuntu-latest
            mode:
              name: sanitize+asanonly
          - platform: macos-latest
            mode:
              name: sanitize+asanonly
          - platform: windows-latest
            mode:
              name: sanitize

          # clang is the default on macos
          # also gcc is an alias to clang
          - platform: macos-latest
            mode:
              name: clang
          - platform: macos-latest
            mode:
              name: gcc

          # gcc is the default on linux
          - platform: ubuntu-latest
            mode:
              name: gcc

          # only run sanitizer tests on linux
          #
          # gcc/clang's codegen shouldn't massively change across platforms,
          # and linux supports most of the sanitizers.
          - platform: macos-latest
            mode:
              name: clang+sanitize
          - platform: macos-latest
            mode:
              # macos does not support msan
              name: clang+msan
          - platform: macos-latest
            mode:
              name: sanitize

    steps:
      - name: Setup meson
        run: |
          pipx install meson ninja
      - name: Install mimalloc
        if: ${{ matrix.platform == 'ubuntu-latest' && matrix.features.name == 'mimalloc' }}
        run: sudo apt update && sudo apt -y install libmimalloc-dev
      - name: Install mimalloc
        if: ${{ matrix.platform == 'macos-latest' && matrix.features.name == 'mimalloc' }}
        run: brew install mimalloc
      # TODO: Install mimalloc on Windows
      # You need to:
      # - checkout mimalloc
      # - `msbuild mimalloc\ide\vs2022\mimalloc.sln`
      #   - not cmake, because https://github.com/microsoft/mimalloc/issues/575#issuecomment-1112723975
      #   - it is possible to integrate vcpkg with meson, but:
      #     - 1. the above issue
      #     - 2. the vcpkg port of mimalloc is outdated, and still broken on server 2019
      #   - or maintain a meson port for mimalloc (and ensure it behaves correctly)
      # - Make it findable with cmake
      #   - not the simpler pkg-config. although there was pkg-config in PATH,
      #     but that was from strawberry perl and thus broken
      # ... good job, microsoft :))))

      - name: Checkout
        uses: actions/checkout@v6
      - name: Activate MSVC and Configure
        if: ${{ matrix.platform == 'windows-latest' }}
        env: ${{ matrix.mode.extra_envs }}
        run: |
          meson setup build-${{ matrix.flavor }} --buildtype=${{ matrix.flavor }} ${{ matrix.mode.args }} ${{ matrix.features.args }} --vsenv
      - name: Configuring
        if: ${{ matrix.platform != 'windows-latest' }}
        env: ${{ matrix.mode.extra_envs }}
        run: |
          meson setup build-${{ matrix.flavor }} --buildtype=${{ matrix.flavor }} ${{ matrix.mode.args }} ${{ matrix.features.args }}
      - name: Building
        run: |
          meson compile -C build-${{ matrix.flavor }}

      - name: Running tests
        env: ${{ matrix.mode.extra_envs }}
        run: |
          meson test -C build-${{ matrix.flavor }} --timeout-multiplier 5 --print-errorlogs
          meson test --benchmark -C build-${{ matrix.flavor }} --timeout-multiplier 5 --print-errorlogs
      - uses: actions/upload-artifact@v7
        if: ${{ failure() }}
        with:
          name: ${{ matrix.platform }}-${{ matrix.mode.name }}-${{ matrix.features.name }}-${{ matrix.flavor }}-logs
          path: build-${{ matrix.flavor }}/meson-logs