Merge branch 'DelSkayn:master' into refcount

Author: makindotcc

.clippy.toml

@@ -0,0 +1 @@
+doc-valid-idents = ["QuickJS", ".."]

.github/workflows/ci.yml

@@ -3,9 +3,13 @@ on:
   push:
     branches:
       - "*"
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+"
   pull_request:
+
+# Only run on the latest ref
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   format:
     runs-on: ubuntu-latest
@@ -54,7 +58,7 @@ jobs:
       - name: Documentation
         env:
           DOCS_RS: 1
-        run: cargo doc --features full-async,parallel,doc-cfg
+        run: cargo doc --no-deps --features full-async,parallel,doc-cfg
       - name: Upload docs
         uses: actions/upload-artifact@v3
         with:
@@ -87,16 +91,70 @@ jobs:
         with:
           path: target
           key: ${{ runner.os }}-build-rust_nightly-check-${{ hashFiles('**/Cargo.lock') }}
-      - uses: actions-rs/clippy-check@v1
+      - name: Cargo clippy
+        run: cargo clippy --all --all-targets --features full-async
+
+  msrv:
+    # Check to see if rquickjs builds on minimal supported Rust version.
+    runs-on: ubuntu-latest
+    # we use a matrix here just because env can't be used in job names
+    # https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability
+    strategy:
+      matrix:
+        msrv: [1.65.0] # 1.65.0 introduced GAT stabilization
+    name: ubuntu / ${{ matrix.msrv }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Install ${{ matrix.msrv }}
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.msrv }}
+      - name: cargo +${{ matrix.msrv }} check
+        run: cargo check
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: nightly
+          components: clippy
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Build cache
+        uses: actions/cache@v3
+        with:
+          path: target
+          key: ${{ runner.os }}-build-rust_nightly-check-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get -y update
+          sudo apt-get -y install protobuf-compiler libprotobuf-dev
+
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+
+      - name: Run cargo test coverage
+        run: RUST_BACKTRACE=1 cargo llvm-cov --html --no-default-features --features full-async,compile-tests --workspace
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v3
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all --all-targets --features full-async
+            name: code-coverage-report
+            path: target/llvm-cov/html/
+            retention-days: 5
 
   test:
     needs:
       - format
       - doc
       - check
+      - msrv
+      - coverage
     strategy:
       fail-fast: ${{ startsWith(github.ref, 'refs/tags/') }}
       matrix:
@@ -120,6 +178,12 @@ jobs:
             target: x86_64-apple-darwin
             features: full-async
             optimization: false
+          - task: bindings
+            os: macos-latest
+            rust: stable
+            target: aarch64-apple-darwin
+            features: full-async
+            optimization: false
           - task: bindings
             os: windows-latest
             rust: stable
@@ -162,6 +226,12 @@ jobs:
             target: aarch64-unknown-linux-musl
             features: full-async
             optimization: false
+          - task: bindings
+            os: ubuntu-latest
+            rust: stable
+            target: aarch64-unknown-linux-gnu
+            features: full-async
+            optimization: false
           # Test features
           - task: features
             os: ubuntu-latest
@@ -230,7 +300,7 @@ jobs:
         with:
           submodules: true
       - name: Setup cross linux toolchain
-        if: contains(matrix.target, '-linux-') && !startsWith(matrix.target, 'x86_64-') && !endsWith(matrix.target, '-musl')
+        if: contains(matrix.target, '-linux-') && !startsWith(matrix.target, 'aarch64') && !startsWith(matrix.target, 'x86_64-') && !endsWith(matrix.target, '-musl')
         run: |
           case "${{ matrix.target }}" in
             i686-*) SYSTEM_ARCH=i386 ;;
@@ -245,7 +315,7 @@ jobs:
         if: startsWith(matrix.target, 'x86_64-') && endsWith(matrix.target, '-musl')
         run: sudo apt-get update -y && sudo apt-get install -y musl-tools
       - name: Setup musl aarch64
-        if: startsWith(matrix.target, 'aarch64') && endsWith(matrix.target, '-musl')
+        if: startsWith(matrix.target, 'aarch64') && contains(matrix.target, '-linux-')
         run: |
           sudo apt-get update -y
           sudo apt-get install -y \
@@ -266,12 +336,24 @@ jobs:
           echo "CXX_aarch64_unknown_linux_musl=aarch64-linux-musl-g++" >> $GITHUB_ENV
           echo "AR_aarch64_unknown_linux_musl=aarch64-linux-musl-ar" >> $GITHUB_ENV
           echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER=aarch64-linux-musl-gcc" >> $GITHUB_ENV
+          echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_RUNNER=qemu-aarch64" >> $GITHUB_ENV
+
+          echo "CC_aarch64_unknown_linux_gnu=aarch64-linux-gnu-gcc" >> $GITHUB_ENV
+          echo "CXX_aarch64_unknown_linux_gnu=aarch64-linux-gnu-g++" >> $GITHUB_ENV
+          echo "AR_aarch64_unknown_linux_gnu=aarch64-linux-gnu-ar" >> $GITHUB_ENV
+          echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER=aarch64-linux-gnu-gcc" >> $GITHUB_ENV
+          echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_RUNNER=qemu-aarch64" >> $GITHUB_ENV
+
+          echo "LD_LIBRARY_PATH=/usr/aarch64-linux-gnu/lib" >> $GITHUB_ENV
+
+          sudo ln -s /usr/aarch64-linux-gnu/lib/ld-linux-aarch64.so.1 /lib/ld-linux-aarch64.so.1
 
           mkdir -p ~/.cargo/
           echo "[target.aarch64-unknown-linux-musl]" >> ~/.cargo/config.toml
           echo 'rustflags = ["-C", "link-self-contained=yes","-C", "linker=rust-lld"]' >> ~/.cargo/config.toml
+          echo "[target.aarch64-unknown-linux-gnu]" >> ~/.cargo/config.toml
+          echo 'rustflags = ["-C", "linker=aarch64-linux-gnu-gcc"]' >> ~/.cargo/config.toml
 
-          echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_RUNNER=qemu-aarch64" >> $GITHUB_ENV
           echo "/musl/bin" >> $GITHUB_PATH
       - name: Setup msys2 toolchains
         if: startsWith(matrix.os, 'windows') && endsWith(matrix.target, '-gnu')
@@ -329,6 +411,8 @@ jobs:
       - name: Build
         run: cargo build ${{ matrix.optimization && '--release' || '' }} --target ${{ matrix.target }} --no-default-features --features ${{ matrix.features }}
       - name: Test
+        if: |
+          matrix.target != 'aarch64-apple-darwin'
         timeout-minutes: 12
         env:
           RUST_BACKTRACE: full
@@ -356,25 +440,3 @@ jobs:
           title: Update bindings
           body: |
             Bindings should be updated to be consistent with latest changes
-  publish:
-    if: (github.repository == 'DelSkayn/rquickjs' || github.repository == 'katyo/rquickjs') && startsWith(github.ref, 'refs/tags/')
-    needs:
-      - format
-      - doc
-      - check
-      - test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: true
-      - name: Setup Rust
-        uses: dtolnay/rust-toolchain@v1
-        with:
-          toolchain: stable
-      - name: Publish crates
-        uses: katyo/publish-crates@v1
-        with:
-          registry-token: ${{ secrets.CRATES_TOKEN }}
-          no-verify: true
-          #dry-run: true

.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  publish:
+    if: github.repository == 'DelSkayn/rquickjs' || github.repository == 'katyo/rquickjs'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: stable
+      - name: Publish crates
+        uses: katyo/publish-crates@v1
+        with:
+          registry-token: ${{ secrets.CRATES_TOKEN }}
+          no-verify: true
+          #dry-run: true

.gitignore

@@ -1,3 +1,4 @@
 target
 .ccls-cache
 Cargo.lock
+.gdb_history

Cargo.toml

@@ -1,27 +1,28 @@
 [package]
 name = "rquickjs"
-version = "0.3.1"
+version = "0.5.1"
 authors = ["Mees Delzenne <[email protected]>", "K. <[email protected]>"]
-edition = "2018"
+edition = "2021"
+rust-version = "1.65"
 license = "MIT"
 readme = "README.md"
-description = "High level bindings to the QuickJS javascript engine"
+description = "High level bindings to the QuickJS JavaScript engine"
 keywords = ["quickjs", "ecmascript", "javascript", "es6", "es2020"]
 categories = ["api-bindings"]
 repository = "https://github.com/DelSkayn/rquickjs.git"
 
 [dependencies.rquickjs-core]
-version = "0.3.1"
+version = "0.5.1"
 path = "core"
 
 [dependencies.rquickjs-macro]
-version = "0.3.1"
+version = "0.5.1"
 path = "macro"
 optional = true
 
 [dependencies.indexmap-rs]
 package = "indexmap"
-version = "1"
+version = "2"
 optional = true
 
 [dependencies.either-rs]
@@ -61,7 +62,7 @@ phf = ["rquickjs-core/phf", "rquickjs-macro/phf"]
 
 # Use bindgen to generate bindings at compile-type
 # otherwise bundled bindings will be used
-bindgen = ["rquickjs-core/bindgen"]
+bindgen = ["rquickjs-core/bindgen", "rquickjs-macro?/bindgen"]
 
 # Enable support of parallel execution
 parallel = ["rquickjs-core/parallel"]
@@ -94,21 +95,13 @@ array-buffer = ["rquickjs-core/array-buffer"]
 # Enable helper macros
 macro = ["rquickjs-macro"]
 
+# Allows transferring objects between different contexts of the same runtime.
+# Disabled for now as it can be used to create unsound code.
+# multi-ctx = ["rquickjs-core/multi-ctx"]
+
 # Enable interop between Rust futures and JS Promises
 futures = ["rquickjs-core/futures"]
 
-# Max number of function args
-max-args-7 = ["rquickjs-core/max-args-7"]
-max-args-8 = ["rquickjs-core/max-args-7"]
-max-args-9 = ["rquickjs-core/max-args-8"]
-max-args-10 = ["rquickjs-core/max-args-9"]
-max-args-11 = ["rquickjs-core/max-args-10"]
-max-args-12 = ["rquickjs-core/max-args-11"]
-max-args-13 = ["rquickjs-core/max-args-12"]
-max-args-14 = ["rquickjs-core/max-args-13"]
-max-args-15 = ["rquickjs-core/max-args-14"]
-max-args-16 = ["rquickjs-core/max-args-15"]
-
 # Enable QuickJS dumps for debug
 dump-bytecode = ["rquickjs-core/dump-bytecode"]
 dump-gc = ["rquickjs-core/dump-gc"]
@@ -130,5 +123,8 @@ compile-tests = ["rquickjs-core/compile-tests"]
 # Enable unstable doc-cfg feature (for docs.rs)
 doc-cfg = ["rquickjs-core/doc-cfg"]
 
+[dev-dependencies]
+trybuild = "1.0.82"
+
 [package.metadata.docs.rs]
 features = ["full-async", "parallel", "doc-cfg"]

README.md

@@ -5,10 +5,10 @@
 [![docs](https://img.shields.io/badge/docs.rs-rquickjs-66c2a5?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/rquickjs)
 [![status](https://img.shields.io/github/actions/workflow/status/DelSkayn/rquickjs/ci.yml?branch=master&style=for-the-badge&logo=github-actions&logoColor=white)](https://github.com/DelSkayn/rquickjs/actions?query=workflow%3ARust)
 
-This library is a high level bindings the [QuickJS](https://bellard.org/quickjs/) javascript engine.
+This library is a high level bindings the [QuickJS](https://bellard.org/quickjs/) JavaScript engine.
 Its goal is to be an easy to use, and safe wrapper similar to the rlua library.
 
-**QuickJS** is a small and embeddable Javascript engine. It supports the _ES2020_ specification including modules, asynchronous generators, proxies and BigInt.
+**QuickJS** is a small and embeddable JavaScript engine. It supports the _ES2020_ specification including modules, asynchronous generators, proxies and BigInt.
 It optionally supports mathematical extensions such as big decimal floating point numbers (BigDecimal), big binary floating point numbers (BigFloat) and operator overloading.
 
 ## Main features of QuickJS
@@ -18,10 +18,10 @@ It optionally supports mathematical extensions such as big decimal floating poin
   The complete life cycle of a runtime instance completes in less than 300 microseconds.
 - Almost complete ES2020 support including modules, asynchronous generators and full Annex B support (legacy web compatibility).
 - Passes nearly 100% of the ECMAScript Test Suite tests when selecting the ES2020 features. A summary is available at Test262 Report.
-- Can compile Javascript sources to executables with no external dependency.
+- Can compile JavaScript sources to executables with no external dependency.
 - Garbage collection using reference counting (to reduce memory usage and have deterministic behavior) with cycle removal.
 - Mathematical extensions: BigDecimal, BigFloat, operator overloading, bigint mode, math mode.
-- Command line interpreter with contextual colorization implemented in Javascript.
+- Command line interpreter with contextual colorization implemented in JavaScript.
 - Small built-in standard library with C library wrappers.
 
 ## Features provided by this crate