Added ARM support on Windows and Linux.

Author: agarny

.github/workflows/cd.yml

@@ -1,7 +1,6 @@
 name: CD
 
 on:
-  push:
   release:
     types: [created]
   workflow_dispatch:
@@ -14,14 +13,19 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: Windows
-            os: windows-latest
-          - name: Linux
-            os: ubuntu-latest
+          - name: Windows (Intel)
+            os: windows-2022
+          #---OPENCOR--- The below is to be enabled once GitHub Actions has Windows ARM runners.
+          # - name: Windows (ARM)
+          #   os: windows-2019
+          - name: Linux (Intel)
+            os: ubuntu-22.04
+          - name: Linux (ARM)
+            os: ubuntu-22.04-arm
           - name: macOS (Intel)
             os: macos-13
           - name: macOS (ARM)
-            os: macos-latest
+            os: macos-14
     env:
       APPLE_ID: ${{ secrets.APPLE_ID }}
       APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_APP_SPECIFIC_PASSWORD }}
@@ -42,14 +46,14 @@ jobs:
       - name: Check out OpenCOR
         uses: actions/checkout@v4
       - name: Retrieve the EV certificate (Windows only)
-        if: matrix.name == 'Windows'
+        if: ${{ (matrix.name == 'Windows (Intel)') || (matrix.name == 'Windows (ARM)') }}
         shell: bash
         run: |
           echo "CSC_LINK=$(echo $WINDOWS_CSC_LINK)" >> $GITHUB_ENV
           echo "CSC_KEY_PASSWORD=$(echo $WINDOWS_CSC_KEY_PASSWORD)" >> $GITHUB_ENV
           echo -n $EV_CERTIFICATE_BASE64 | base64 -d > $WINDOWS_CSC_LINK
       - name: Retrieve the Developer ID Application certificates (macOS only)
-        if: matrix.name == 'macOS (Intel)' || matrix.name == 'macOS (ARM)'
+        if: ${{ (matrix.name == 'macOS (Intel)') || (matrix.name == 'macOS (ARM)') }}
         run: |
           echo "CSC_LINK=$(echo $MACOS_CSC_LINK)" >> $GITHUB_ENV
           echo "CSC_KEY_PASSWORD=$(echo $MACOS_CSC_KEY_PASSWORD)" >> $GITHUB_ENV
@@ -60,10 +64,15 @@ jobs:
           node-version: 'lts/*'
       - name: Install pnpm
         run: npm install -g pnpm
-      - name: Package OpenCOR
+      - name: Install libopenjp2-tools (Linux ARM only)
+        if: matrix.name == 'Linux (ARM)'
         run: |
-          pnpm install
-          pnpm package
+          sudo apt update
+          sudo apt install libopenjp2-tools
+      - name: OpenCOR dependencies
+        run: pnpm install
+      - name: Package OpenCOR
+        run: pnpm package
       - name: Remove blockmap files
         shell: bash
         run: find ./dist -name '*.blockmap' -delete

.github/workflows/ci.yml

@@ -13,27 +13,28 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - name: Windows
-            os: windows-latest
-            build: ON
-          - name: Linux
-            os: ubuntu-latest
-            build: ON
+          - name: Windows (Intel)
+            os: windows-2022
+          #---OPENCOR--- The below is to be enabled once GitHub Actions has Windows ARM runners.
+          # - name: Windows (ARM)
+          #   os: windows-2019
+          - name: Linux (Intel)
+            os: ubuntu-22.04
+          - name: Linux (ARM)
+            os: ubuntu-22.04-arm
           - name: macOS (Intel)
             os: macos-13
-            build: ON
           - name: macOS (ARM)
-            os: macos-latest
-            build: ON
+            os: macos-14
           - name: Code formatting
-            os: ubuntu-latest
-            build: OFF
+            os: ubuntu-22.04
           - name: Linting
-            os: ubuntu-latest
-            build: OFF
+            os: ubuntu-22.04
     steps:
       - name: Check out OpenCOR
         uses: actions/checkout@v4
+      - name: Install CMake and Ninja
+        uses: lukka/get-cmake@latest
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
@@ -43,10 +44,10 @@ jobs:
       - name: OpenCOR dependencies
         run: pnpm install
       - name: Build OpenCOR
-        if: matrix.build == 'ON'
+        if: ${{ (matrix.name != 'Code formatting') && (matrix.name != 'Linting') }}
         run: pnpm build
       - name: Build OpenCOR's Web app
-        if: matrix.build == 'ON'
+        if: ${{ (matrix.name != 'Code formatting') && (matrix.name != 'Linting') }}
         run: pnpm build:web
       - name: Code formatting
         if: matrix.name == 'Code formatting'

.npmrc

@@ -1,2 +1,4 @@
 electron_mirror=https://npmmirror.com/mirrors/electron/
 electron_builder_binaries_mirror=https://npmmirror.com/mirrors/electron-builder-binaries/
+node-linker=hoisted
+public-hoist-pattern=*

CMakeLists.txt

@@ -1,14 +1,19 @@
 cmake_minimum_required(VERSION 3.15)
 
-project(libOpenCOR
-        VERSION 0.0.0)
+project(libOpenCOR VERSION 0.0.0)
 
 # Enable C++20.
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+# Some common CMake policies.
+
+foreach(POLICY CMP0042 CMP0091)
+    cmake_policy(SET ${POLICY} NEW)
+endforeach()
+
 # Get access to cmake-js.
 
 include_directories(${CMAKE_JS_INC})
@@ -17,24 +22,30 @@ include_directories(${CMAKE_JS_INC})
 
 if(WIN32)
     set(PLATFORM Windows)
-    set(ARCHITECTURE Intel)
     set(EXTENSION .zip)
 elseif(APPLE)
     set(PLATFORM macOS)
     set(EXTENSION .zip)
+else()
+    set(PLATFORM Linux)
+    set(EXTENSION .tar.gz)
+endif()
 
-    if("${CMAKE_HOST_SYSTEM_PROCESSOR}" STREQUAL "x86_64")
+if(WIN32)
+    if("${CMAKE_CXX_COMPILER_ARCHITECTURE_ID}" STREQUAL "x64")
         set(ARCHITECTURE Intel)
     else()
         set(ARCHITECTURE ARM)
     endif()
 else()
-    set(PLATFORM Linux)
-    set(ARCHITECTURE Intel)
-    set(EXTENSION .tar.gz)
+    if("${CMAKE_HOST_SYSTEM_PROCESSOR}" STREQUAL "x86_64")
+        set(ARCHITECTURE Intel)
+    else()
+        set(ARCHITECTURE ARM)
+    endif()
 endif()
 
-set(LIBOPENCOR_FILE_NAME_WE libOpenCOR-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}-${PLATFORM}-${ARCHITECTURE}-Shared)
+set(LIBOPENCOR_FILE_NAME_WE ${CMAKE_PROJECT_NAME}-${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}-${PLATFORM}-${ARCHITECTURE}-Shared)
 set(LIBOPENCOR_FILE_NAME ${LIBOPENCOR_FILE_NAME_WE}${EXTENSION})
 
 file(DOWNLOAD https://opencor.ws/libopencor/downloads/${LIBOPENCOR_FILE_NAME}
@@ -44,10 +55,14 @@ execute_process(COMMAND ${CMAKE_COMMAND} -E tar xvf ${CMAKE_BINARY_DIR}/${LIBOPE
                 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
                 OUTPUT_QUIET)
 
+execute_process(COMMAND ${CMAKE_COMMAND} -E rename ${LIBOPENCOR_FILE_NAME_WE} Shared
+                WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+                OUTPUT_QUIET)
+
 file(REMOVE ${CMAKE_BINARY_DIR}/${LIBOPENCOR_FILE_NAME})
 
-include_directories(${CMAKE_BINARY_DIR}/${LIBOPENCOR_FILE_NAME_WE}/include
-                    ${CMAKE_BINARY_DIR}/${LIBOPENCOR_FILE_NAME_WE}/include/libopencor/module)
+include_directories(${CMAKE_BINARY_DIR}/Shared/include
+                    ${CMAKE_BINARY_DIR}/Shared/include/libopencor/module)
 
 # Use the appropriate C runtime library.
 
@@ -106,42 +121,70 @@ set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES
                       PREFIX ""
                       SUFFIX ".node")
 
+# Generate node.lib.
+
+if(MSVC AND CMAKE_JS_NODELIB_DEF AND CMAKE_JS_NODELIB_TARGET)
+    execute_process(COMMAND ${CMAKE_AR} /def:${CMAKE_JS_NODELIB_DEF} /out:${CMAKE_JS_NODELIB_TARGET} ${CMAKE_STATIC_LINKER_FLAGS})
+endif()
+
 # Link cmake-js and libOpenCOR to our Node.js add-on.
 
 if(WIN32)
-    set(LIBOPENCOR_FILENAME libOpenCOR${CMAKE_IMPORT_LIBRARY_SUFFIX})
+    set(LIBOPENCOR_DIR bin)
+    set(FULL_LIBOPENCOR_FILENAME ${CMAKE_PROJECT_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX})
+else()
+    set(LIBOPENCOR_DIR lib)
+
+    if(APPLE)
+        set(FULL_LIBOPENCOR_FILENAME ${CMAKE_PROJECT_NAME}.${CMAKE_PROJECT_VERSION}${CMAKE_SHARED_LIBRARY_SUFFIX})
+    else()
+        set(FULL_LIBOPENCOR_FILENAME ${CMAKE_PROJECT_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX}.${CMAKE_PROJECT_VERSION})
+    endif()
+endif()
+
+execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/Shared/${LIBOPENCOR_DIR}/${FULL_LIBOPENCOR_FILENAME}
+                                                 ${CMAKE_BINARY_DIR}/../${FULL_LIBOPENCOR_FILENAME})
+
+if(WIN32)
+    set(LIBOPENCOR_FILENAME ${CMAKE_PROJECT_NAME}${CMAKE_IMPORT_LIBRARY_SUFFIX})
+
+    execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/Shared/lib/${LIBOPENCOR_FILENAME}
+                                                     ${CMAKE_BINARY_DIR}/../${LIBOPENCOR_FILENAME})
 else()
-    set(LIBOPENCOR_FILENAME libOpenCOR${CMAKE_SHARED_LIBRARY_SUFFIX})
+    set(LIBOPENCOR_FILENAME ${FULL_LIBOPENCOR_FILENAME})
 endif()
 
 target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE
                       ${CMAKE_JS_LIB}
-                      ${CMAKE_BINARY_DIR}/${LIBOPENCOR_FILE_NAME_WE}/lib/${LIBOPENCOR_FILENAME})
+                      ${CMAKE_BINARY_DIR}/../${LIBOPENCOR_FILENAME})
 
-# Include the Node-API wrappers.
+set(LIBOPENCOR_NODE_FILENAME ${CMAKE_BINARY_DIR}/../${CMAKE_PROJECT_NAME}.node)
 
-execute_process(COMMAND node -p "require('node-addon-api').include"
-                WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-                OUTPUT_VARIABLE NODE_ADDON_API_DIR)
+add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
+                   COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:${CMAKE_PROJECT_NAME}>
+                                                    ${LIBOPENCOR_NODE_FILENAME})
 
-string(REGEX REPLACE "[\r\n\"]" "" NODE_ADDON_API_DIR ${NODE_ADDON_API_DIR})
+# On Linux, replace the RUNPATH value with an RPATH value of $ORIGIN so that, once deployed, OpenCOR can find our C++
+# version of libOpenCOR.
 
-target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
-                           ${NODE_ADDON_API_DIR})
+if(NOT WIN32 AND NOT APPLE)
+    find_program(PATCHELF patchelf REQUIRED)
 
-add_definitions(-DNAPI_VERSION=3)
+    add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
+                       COMMAND ${PATCHELF} --set-rpath "\\$$ORIGIN" --force-rpath ${LIBOPENCOR_NODE_FILENAME})
+endif()
 
 # Configure our splash screen.
 
 string(TIMESTAMP CURRENT_YEAR "%Y")
 
-if(CURRENT_YEAR EQUAL 2024)
-    set(COPYRIGHT "2024")
+if(CURRENT_YEAR EQUAL 2025)
+    set(COPYRIGHT "2025")
 else()
-    set(COPYRIGHT "2024-${CURRENT_YEAR}")
+    set(COPYRIGHT "2025-${CURRENT_YEAR}")
 endif()
 
 set(VERSION ${PROJECT_VERSION})
 
 configure_file(src/main/assets/splashscreen.html.in
-               ${CMAKE_BINARY_DIR}/splashscreen.html)
+               ${CMAKE_BINARY_DIR}/../splashscreen.html)

README.md

@@ -4,19 +4,36 @@
 
 There are two versions of OpenCOR:
 
-1. **OpenCOR:** a desktop application that can be run on [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows), [Linux](https://en.wikipedia.org/wiki/Linux), and [macOS](https://en.wikipedia.org/wiki/MacOS); and
+1. **OpenCOR:** a desktop application that can be run on [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows), [Linux](https://en.wikipedia.org/wiki/Linux), and [macOS](https://en.wikipedia.org/wiki/MacOS) on [Intel](https://en.wikipedia.org/wiki/List_of_Intel_processors)/[ARM](https://en.wikipedia.org/wiki/ARM_architecture_family); and
 2. **OpenCOR's Web app:** a [Web app](https://en.wikipedia.org/wiki/Web_application) that can be run using a Web browser.
 
 The main difference between the two versions is that models in OpenCOR are, by default, compiled while they can only be interpreted in OpenCOR's Web app.
 
 ## Prerequisites
 
-To build OpenCOR, you need to install [node.js](https://nodejs.org/) and [npm](https://npmjs.com/), which you can do from [here](https://nodejs.org/en/download/package-manager). Then, you need to install [pnpm](https://pnpm.io/):
+To build OpenCOR and OpenCOR's Web app, you need to install [node.js](https://nodejs.org/) and [npm](https://npmjs.com/), which you can do from [here](https://nodejs.org/en/download/package-manager). Then, you need to install [pnpm](https://pnpm.io/):
 
 ```bash
-npm install -g pnpm
+npm -g install pnpm
 ```
 
+To build OpenCOR, you also need a C/C++ toolchain:
+
+- **[Windows](https://en.wikipedia.org/wiki/Microsoft_Windows):**
+  - **[Intel](https://en.wikipedia.org/wiki/List_of_Intel_processors):**
+    - [Visual Studio Community 2019](https://apps.microsoft.com/detail/xp8cdjnzkfm06w) (`Desktop development with C++` with `MSVC v142 - VS 2019 C++ x64/x86 build tools` and `Windows 10 SDK`); or
+    - [Visual Studio Community 2022](https://apps.microsoft.com/detail/xpdcfjdklzjlp8) (`Desktop development with C++` with `MSVC v143 - VS 2022 C++ x64/x86 build tools` and `Windows 11 SDK`);
+  - **[ARM](https://en.wikipedia.org/wiki/ARM_architecture_family):**
+    - [Visual Studio Community 2019](https://apps.microsoft.com/detail/xp8cdjnzkfm06w) (`Desktop development with C++` with `MSVC v142 - VS 2019 C++ ARM64 build tools` and `Windows 10 SDK`);
+- **[Linux](https://en.wikipedia.org/wiki/Linux):** G++ (`g++` package) on [Ubuntu 22.04 LTS](https://en.wikipedia.org/wiki/Ubuntu_version_history#2204)/[Ubuntu 24.04 LTS](https://en.wikipedia.org/wiki/Ubuntu_version_history#2404); and
+- **[macOS](https://en.wikipedia.org/wiki/MacOS):** [Xcode](https://developer.apple.com/xcode/) (including its [Command Line Tools](https://developer.apple.com/downloads/?q=Command%20Line%20Tools)).
+
+**Notes:**
+
+- Yes, OpenCOR for [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows) on [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family) can only be built using [Visual Studio Community 2019](https://apps.microsoft.com/detail/xp8cdjnzkfm06w) (this is because we must use `MSVC v142`; see [here](https://www.electronjs.org/docs/latest/tutorial/windows-arm#native-modules) for more information).
+- On Ubuntu on ARM, you need to install the `libopenjp2-tools` package so that [`electron-builder`](https://www.electron.build/) can get access to [`opj_decompress`](https://manpages.ubuntu.com/manpages/man1/opj_decompress.1.html).
+- On [Ubuntu 24.04 LTS](https://en.wikipedia.org/wiki/Ubuntu_version_history#2404), you need to deactivate restrictions using `sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0` (see [here](https://github.com/electron/electron/issues/42510) for more information).
+
 ## Scripts
 
 Before doing anything, you need to install all of OpenCOR's dependencies:
@@ -43,9 +60,6 @@ where `<script>` is one of the following:
 - `format:check`: check that OpenCOR's code and OpenCOR's Web app's code are properly formatted;
 - `lint`: lint OpenCOR's code and OpenCOR's Web app's code;
 - `package`: (build and) package OpenCOR for the current platform;
-- `package:linux`: (build and) package OpenCOR for Linux;
-- `package:mac`: (build and) package OpenCOR for macOS;
-- `package:win`: (build and) package OpenCOR for Windows;
 - `publish:web`: publish OpenCOR's Web app on [npm](https://npmjs.com/);
 - `start`: start OpenCOR in production mode; and
 - `start:web`: start OpenCOR's Web app in production mode.

electron-builder.yml

@@ -3,7 +3,7 @@ productName: OpenCOR
 win:
   artifactName: ${productName}-${version}-Windows.${ext}
   extraFiles:
-    - from: 'out/libOpenCOR/libOpenCOR-0.0.0-Windows-Intel-Shared/bin/libOpenCOR.dll'
+    - from: 'out/libOpenCOR.dll'
       to: 'libOpenCOR.dll'
   target:
     - nsis
@@ -15,11 +15,10 @@ linux:
   category: Utility
   executableName: OpenCOR
   extraFiles:
-    - from: 'out/libOpenCOR/libOpenCOR-0.0.0-Linux-Intel-Shared/lib/libOpenCOR.so.0.0.0'
+    - from: 'out/libOpenCOR.so.0.0.0'
       to: 'libOpenCOR.so.0.0.0'
   target:
     - AppImage
-    - deb
     - tar.gz
 mac:
   # - Code signing:
@@ -33,9 +32,7 @@ mac:
   #    - APPLE_TEAM_ID: an id that can be found in the top right corner of https://developer.apple.com/account/resources/certificates/list.
   artifactName: ${productName}-${version}-macOS-${arch}.${ext}
   extraFiles:
-    - from: 'out/libOpenCOR/libOpenCOR-0.0.0-macOS-Intel-Shared/lib/libOpenCOR.0.0.0.dylib'
-      to: 'Frameworks/libOpenCOR.0.0.0.dylib'
-    - from: 'out/libOpenCOR/libOpenCOR-0.0.0-macOS-ARM-Shared/lib/libOpenCOR.0.0.0.dylib'
+    - from: 'out/libOpenCOR.0.0.0.dylib'
       to: 'Frameworks/libOpenCOR.0.0.0.dylib'
   target:
     - dmg

electron.vite.config.ts

@@ -25,12 +25,7 @@ export default defineConfig({
             viteStaticCopy({
               targets: [
                 {
-                  src: normalizePath(
-                    path.resolve(
-                      import.meta.dirname,
-                      'out/libOpenCOR/libOpenCOR-0.0.0-Windows-Intel-Shared/bin/libOpenCOR.dll'
-                    )
-                  ),
+                  src: normalizePath(path.resolve(import.meta.dirname, 'out/libOpenCOR.dll')),
                   dest: 'chunks'
                 }
               ]