Merge branch 'main' into cppinterop-out

kr-2003 · web-flow · commit c34f786823a8 · 2025-10-29T00:31:24.000+05:30
diff --git a/.github/workflows/clang-format.yml b/.github/workflows/clang-format.yml
@@ -21,7 +21,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
 
diff --git a/.github/workflows/clang-tidy-review.yml b/.github/workflows/clang-tidy-review.yml
@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
 
diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml
@@ -34,7 +34,7 @@ jobs:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: '3.11'
 
diff --git a/.github/workflows/emscripten.yml b/.github/workflows/emscripten.yml
@@ -84,7 +84,7 @@ jobs:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: '3.11'
 
@@ -708,7 +708,7 @@ jobs:
         if [[ "${os}" != macos* ]] ; then
           EMCC_CORES=1 emmake make -j 1 check-cppinterop
         else
-          EMCC_CORES=2 emmake make -j 2 check-cppinterop
+          emmake make -j ${{ env.ncpus }} check-cppinterop
         fi
         cd ./unittests/CppInterOp/
         # Explaination of options for emrun
@@ -785,7 +785,13 @@ jobs:
         .\emsdk\emsdk_env.ps1
         $env:PWD_DIR= $PWD.Path
         $env:SYSROOT_PATH="$env:EMSDK/upstream/emscripten/cache/sysroot"
-        $env:PREFIX="%CONDA_PREFIX%/envs/CppInterOp-wasm"
+        echo "SYSROOT_PATH=$env:SYSROOT_PATH"
+        echo "SYSROOT_PATH=$env:SYSROOT_PATH" >> $env:GITHUB_ENV
+        
+        $env:PREFIX="$env:MAMBA_ROOT_PREFIX/envs/CppInterOp-wasm"
+        echo "PREFIX=$env:PREFIX"
+        echo "PREFIX=$env:PREFIX" >> $env:GITHUB_ENV
+        
         $env:CMAKE_PREFIX_PATH=$env:PREFIX
         $env:CMAKE_SYSTEM_PREFIX_PATH=$env:PREFIX
         
@@ -888,6 +894,11 @@ jobs:
         Error-OnFailure { emrun.bat --browser="chrome.exe" --kill_exit --timeout 60 --browser-args="--headless --no-sandbox"  DynamicLibraryManagerTests.html }
         cd ..\..
         Error-OnFailure { emmake make -j ${{ env.ncpus }} install }
+        echo "SYSROOT_PATH=$env:SYSROOT_PATH" >> $GITHUB_ENV
+        echo "CPPINTEROP_DIR=$env:CPPINTEROP_DIR" >> $GITHUB_ENV
+        echo "LLVM_BUILD_DIR=$env:LLVM_BUILD_DIR" >> $GITHUB_ENV
+        echo "CPLUS_INCLUDE_PATH=$env:CPLUS_INCLUDE_PATH" >> $GITHUB_ENV
+        echo "PREFIX=$env:PREFIX" >> $GITHUB_ENV
 
     - name: Build and Test/Install CppInterOp on Windows systems (static library)
       if: ${{ runner.os == 'windows' }}
@@ -990,7 +1001,7 @@ jobs:
         echo "Running DynamicLibraryManagerTests in Chromium"
         Error-OnFailure{ emrun.bat --browser="chrome.exe" --kill_exit --timeout 60 --browser-args="--headless --no-sandbox"  DynamicLibraryManagerTests.html }
 
-    - name: Build xeus-cpp
+    - name: Build xeus-cpp on Unix Systems
       if: ${{ runner.os != 'windows' }}
       shell: bash -l {0}
       run: |
@@ -1014,7 +1025,31 @@ jobs:
           ..
         emmake make -j ${{ env.ncpus }} install
 
-    - name: Test xeus-cpp C++ Emscripten
+    - name: Build xeus-cpp on Windows systems
+      if: ${{ runner.os == 'windows' }}
+      shell: powershell
+      run: |
+        .\emsdk\emsdk activate ${{matrix.emsdk_ver}}
+        .\emsdk\emsdk_env.ps1
+        micromamba activate CppInterOp-wasm
+        git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
+        cd .\xeus-cpp
+        mkdir build
+        pushd build
+        $env:CMAKE_PREFIX_PATH="${{ env.PREFIX }}"
+        $env:CMAKE_SYSTEM_PREFIX_PATH="${{ env.PREFIX }}"
+        emcmake cmake `
+          -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}          `
+          -DCMAKE_PREFIX_PATH=${{ env.PREFIX }}             `
+          -DCMAKE_INSTALL_PREFIX=${{ env.PREFIX }}          `
+          -DXEUS_CPP_EMSCRIPTEN_WASM_BUILD=ON               `
+          -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            `
+          -DXEUS_CPP_RESOURCE_DIR=${{ env.LLVM_BUILD_DIR }}\lib\clang\${{ matrix.clang-runtime }} `
+          -DSYSROOT_PATH=${{ env.SYSROOT_PATH }}                `
+          ..
+        emmake make -j ${{ env.ncpus }} install
+
+    - name: Test xeus-cpp C++ Emscripten on Unix Systems
       if: ${{ runner.os != 'windows' }}
       shell: bash -l {0}
       run: |
@@ -1023,6 +1058,30 @@ jobs:
         cd ./xeus-cpp/build/test
         node test_xeus_cpp.js
 
+    - name: Test xeus-cpp C++ Emscripten on Windows Systems
+      if: ${{ runner.os == 'windows' }}
+      shell: powershell
+      run: |
+        function Error-OnFailure {
+          param (
+              [Parameter(Mandatory)]
+              [ScriptBlock]$Command
+          )
+
+         & $Command
+
+         if ($LASTEXITCODE -ne 0) {
+            exit $LASTEXITCODE
+         }
+        }
+        micromamba activate CppInterOp-wasm
+        cd .\xeus-cpp\build\test
+        node test_xeus_cpp.js
+        echo "Running test_xeus_cpp in Firefox"
+        Error-OnFailure { emrun.bat --browser="firefox.exe" --kill_exit --timeout 60 --browser-args="--headless"  test_xeus_cpp.html }
+        echo "Running test_xeus_cpp in Chromium"
+        Error-OnFailure { emrun.bat --browser="chrome.exe" --kill_exit --timeout 60 --browser-args="--headless --no-sandbox"  test_xeus_cpp.html }
+
     - name: Jupyter Lite integration
       if: ${{ runner.os != 'windows' }}
       shell: bash -l {0}
@@ -1031,3 +1090,12 @@ jobs:
           micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyterlite-xeus jupyter_server jupyterlab notebook python-libarchive-c -c conda-forge
           micromamba activate xeus-lite-host
           jupyter lite build --XeusAddon.prefix=${{ env.PREFIX }} --contents notebooks/xeus-cpp-lite-demo.ipynb --contents notebooks/smallpt.ipynb --contents notebooks/images/marie.png --contents notebooks/audio/audio.wav --output-dir dist
+
+    - name: Jupyter Lite integration
+      if: ${{ runner.os == 'windows' }}
+      shell: powershell
+      run: |
+          cd .\xeus-cpp\
+          micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyterlite-xeus jupyter_server jupyterlab notebook python-libarchive-c -c conda-forge
+          micromamba activate xeus-lite-host
+          jupyter lite build --XeusAddon.prefix=${{ env.PREFIX }} --contents notebooks/xeus-cpp-lite-demo.ipynb --contents notebooks/smallpt.ipynb --contents notebooks/images/marie.png --contents notebooks/audio/audio.wav --output-dir dist
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -225,7 +225,7 @@ jobs:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: '3.11'
 
@@ -282,10 +282,13 @@ jobs:
         # Create lcov report
         # capture coverage info
         vers="${CC#*-}"
-        lcov --directory build/ --capture --output-file coverage.info --gcov-tool /usr/bin/gcov-${vers}
-        lcov --remove coverage.info '/usr/*' "${HOME}"'/.cache/*' ${{ github.workspace }}'/llvm-project/*' ${{ github.workspace }}'/unittests/*' --output-file coverage.info
+        lcov --directory build/ --capture --output-file coverage.info --gcov-tool /usr/bin/gcov-${vers} --ignore-errors mismatch
+        lcov --remove coverage.info '/usr/*' ${{ github.workspace }}'/llvm-project/*' --ignore-errors unused --output-file coverage.info
+        lcov --remove coverage.info '${{ github.workspace }}/unittests/*' --ignore-errors unused --output-file coverage.info
+        lcov --remove coverage.info  '${{ github.workspace }}/build/*' --ignore-errors unused --output-file coverage.info
         # output coverage data for debugging (optional)
         lcov --list coverage.info
+        rm -rf ./build/
 
     - name: Upload to codecov.io
       if: ${{ success() && (matrix.coverage == true) }}
@@ -310,4 +313,3 @@ jobs:
       uses: mxschmitt/action-tmate@v3
       # When debugging increase to a suitable value!
       timeout-minutes: 30
-
diff --git a/Emscripten-build-instructions.md b/Emscripten-build-instructions.md
@@ -178,7 +178,7 @@ export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX
 and
 
 ```powershell
-$env:PREFIX="%CONDA_PREFIX%/envs/CppInterOp-wasm"
+$env:PREFIX="$env:MAMBA_ROOT_PREFIX/envs/CppInterOp-wasm"
 $env:CMAKE_PREFIX_PATH=$env:PREFIX
 $env:CMAKE_SYSTEM_PREFIX_PATH=$env:PREFIX
 ```
@@ -337,7 +337,7 @@ emmake make -j $(nproc --all) install
 ## Xeus-cpp-lite Wasm Build Instructions
 
 A project which makes use of the wasm build of CppInterOp is xeus-cpp. xeus-cpp is a C++ Jupyter kernel. Assuming you are in  
-the CppInterOp build folder, you can build the wasm version of xeus-cpp by executing (replace LLVM_VERSION with the version
+the CppInterOp build folder, you can build the wasm version of xeus-cpp on Linux/MacOS by executing (replace LLVM_VERSION with the version
 of llvm you are building against)
 
 ```bash
@@ -359,7 +359,28 @@ emcmake cmake \
  emmake make -j $(nproc --all) install
 ```
 
-To build and test Jupyter Lite with this kernel locally you can execute the following
+and on Windows by executing
+
+```powershell
+cd ..\..
+git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
+$env:LLVM_VERSION=20
+cd .\xeus-cpp
+mkdir build
+cd build
+emcmake cmake `
+          -DCMAKE_BUILD_TYPE=Release                                     `
+          -DCMAKE_PREFIX_PATH="$env:PREFIX"                                    `
+          -DCMAKE_INSTALL_PREFIX="$env:PREFIX"                                 `
+          -DXEUS_CPP_EMSCRIPTEN_WASM_BUILD=ON                            `
+          -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON                         `
+          -DXEUS_CPP_RESOURCE_DIR="$env:LLVM_BUILD_DIR/lib/clang/$env:LLVM_VERSION" `
+          -DSYSROOT_PATH="$env:SYSROOT_PATH"                                   `
+          ..
+ emmake make -j $(nproc --all) install
+```
+
+To build and test Jupyter Lite with this kernel locally on Linux/MacOS you can execute the following
 
 ```bash
 cd ../..
@@ -373,3 +394,18 @@ jupyter lite serve --XeusAddon.prefix=$PREFIX \
                    --XeusAddon.mounts="$PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" \
                    --XeusAddon.mounts="$PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d"
 ```
+
+and on Windows execute
+
+```powershell
+cd ..\..
+micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyterlite-xeus jupyter_server jupyterlab notebook python-libarchive-c -c conda-forge
+micromamba activate xeus-lite-host
+jupyter lite serve --XeusAddon.prefix="$env:PREFIX" `
+                   --contents xeus-cpp/notebooks/xeus-cpp-lite-demo.ipynb `
+                   --contents xeus-cpp/notebooks/smallpt.ipynb `
+                   --contents xeus-cpp/notebooks/images/marie.png `
+                   --contents xeus-cpp/notebooks/audio/audio.wav `
+                   --XeusAddon.mounts="$env:PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" `
+                   --XeusAddon.mounts="$env:PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d"
+```
diff --git a/docs/Emscripten-build-instructions.rst b/docs/Emscripten-build-instructions.rst
@@ -203,7 +203,7 @@ and
 
 .. code:: powershell
 
-   $env:PREFIX="%CONDA_PREFIX%/envs/CppInterOp-wasm"
+   $env:PREFIX="$env:MAMBA_ROOT_PREFIX/envs/CppInterOp-wasm"
    $env:CMAKE_PREFIX_PATH=$env:PREFIX
    $env:CMAKE_SYSTEM_PREFIX_PATH=$env:PREFIX
 
@@ -358,8 +358,8 @@ Assuming it passes all test you can install by executing the following.
 
 A project which makes use of the wasm build of CppInterOp is xeus-cpp.
 xeus-cpp is a C++ Jupyter kernel. Assuming you are in the CppInterOp
-build folder, you can build the wasm version of xeus-cpp by executing
-(replace LLVM_VERSION with the version of llvm you are building against)
+build folder, you can build the wasm version of xeus-cpp on Linux/MacOS 
+by executing (replace LLVM_VERSION with the version of llvm you are building against)
 
 .. code:: bash
 
@@ -380,7 +380,28 @@ build folder, you can build the wasm version of xeus-cpp by executing
            ..
    emmake make -j $(nproc --all) install
 
-To build and test Jupyter Lite with this kernel locally you can execute the following
+and on Windows by executing 
+
+.. code:: powershell
+
+   cd ..\..
+   git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
+   $env:LLVM_VERSION=20
+   cd .\xeus-cpp
+   mkdir build
+   cd build
+   emcmake cmake `
+           -DCMAKE_BUILD_TYPE=Release                                     `
+           -DCMAKE_PREFIX_PATH="$env:PREFIX"                              `
+           -DCMAKE_INSTALL_PREFIX="$env:PREFIX"                           `
+           -DXEUS_CPP_EMSCRIPTEN_WASM_BUILD=ON                            `
+           -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON                         `
+	        -DXEUS_CPP_RESOURCE_DIR="$env:LLVM_BUILD_DIR/lib/clang/$env:LLVM_VERSION" `
+           -DSYSROOT_PATH="$env:SYSROOT_PATH"                              `
+           ..
+   emmake make -j $(nproc --all) install
+
+To build and test Jupyter Lite with this kernel locally on Linux/MacOS you can execute the following
 
 .. code:: bash
 
@@ -394,3 +415,18 @@ To build and test Jupyter Lite with this kernel locally you can execute the foll
                       --contents xeus-cpp/notebooks/audio/audio.wav \
                       --XeusAddon.mounts="$PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" \
                       --XeusAddon.mounts="$PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d"
+
+and on Windows execute
+
+.. code:: powershell
+
+   cd ..\..
+   micromamba create -n xeus-lite-host jupyterlite-core=0.6 jupyterlite-xeus jupyter_server jupyterlab notebook python-libarchive-c -c conda-forge
+   micromamba activate xeus-lite-host
+   jupyter lite serve --XeusAddon.prefix="$env:PREFIX" `
+                      --contents xeus-cpp/notebooks/xeus-cpp-lite-demo.ipynb `
+                      --contents xeus-cpp/notebooks/smallpt.ipynb `
+                      --contents xeus-cpp/notebooks/images/marie.png ` 
+                      --contents xeus-cpp/notebooks/audio/audio.wav `
+                      --XeusAddon.mounts="$env:PREFIX/share/xeus-cpp/tagfiles:/share/xeus-cpp/tagfiles" `
+                      --XeusAddon.mounts="$env:PREFIX/etc/xeus-cpp/tags.d:/etc/xeus-cpp/tags.d"
