feat: implement native KV3 parsing and property tree planning

- Added support for native KV3 document parsing using worker threads, improving performance for large documents.
- Introduced a new IPC handler for parsing KV3 documents and building initial property trees off the main thread.
- Enhanced the document manager to utilize native parsing when applicable, providing a fallback to JavaScript parsing.
- Implemented a busy cursor to improve user experience during asynchronous operations.
- Updated the build process to include native addon support for KV3 parsing.

These changes aim to enhance the efficiency and responsiveness of the VDataEditor during document handling and editing.

Author: dertwist

.github/workflows/build.yml

@@ -25,6 +25,12 @@ jobs:
       - name: Install dependencies
         run: npm install
 
+      - name: Build native KV3 addon (x64)
+        run: node scripts/build-kv3-addon.js --arch=x64
+
+      - name: Run tests
+        run: npm test
+
       - name: Build Windows installer
         run: npm run build:win
 
@@ -39,3 +45,41 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  build-macos:
+    name: Build macOS (universal .dmg)
+    runs-on: macos-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build native KV3 addon (x64)
+        run: node scripts/build-kv3-addon.js --arch=x64
+
+      - name: Build native KV3 addon (arm64)
+        run: node scripts/build-kv3-addon.js --arch=arm64
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build macOS installer
+        run: npm run build:mac
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || 'latest-build' }}
+          name: ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || 'Latest Build' }}
+          prerelease: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          files: dist/*.dmg, dist/*.zip
+          body: ${{ github.event.head_commit.message }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.gitignore

@@ -1,4 +1,9 @@
 node_modules/
 dist/
 out/
-.DS_Store
+.DS_Store
+
+# Native addon build artifacts (C++/N-API)
+native/**/build/
+native/**/prebuilds/
+native/**/*.node

main.js

@@ -1,4 +1,5 @@
 const { app, BrowserWindow, ipcMain, Menu, dialog } = require('electron/main')
+const { Worker } = require('node:worker_threads')
 const path = require('node:path')
 const fs = require('fs')
 
@@ -125,6 +126,88 @@ if (!gotLock) {
 
 const SCHEMA_BUNDLE_GAMES = new Set(['cs2', 'dota2', 'deadlock'])
 
+// ── KV3 native parsing worker (off main thread) ────────────────────────────
+let _kv3ParseWorker = null
+let _kv3ParseNextId = 0
+const _kv3ParsePending = new Map()
+
+function getKv3ParseWorker() {
+  if (_kv3ParseWorker) return _kv3ParseWorker
+  const workerPath = path.join(__dirname, 'src', 'kv3-native-parse-worker.js')
+  _kv3ParseWorker = new Worker(workerPath)
+  _kv3ParseWorker.on('message', (msg) => {
+    const p = _kv3ParsePending.get(msg.id)
+    if (!p) return
+    _kv3ParsePending.delete(msg.id)
+    if (msg.ok) p.resolve(msg.parsed)
+    else p.reject(new Error(msg.error || 'kv3 native parse failed'))
+  })
+  _kv3ParseWorker.on('error', (err) => {
+    _kv3ParsePending.forEach((p) => {
+      try {
+        p.reject(err)
+      } catch (_) {}
+    })
+    _kv3ParsePending.clear()
+    _kv3ParseWorker = null
+  })
+  _kv3ParseWorker.on('exit', (code) => {
+    if (code === 0) return
+    const err = new Error('kv3 native parse worker exited with code ' + code)
+    _kv3ParsePending.forEach((p) => {
+      try {
+        p.reject(err)
+      } catch (_) {}
+    })
+    _kv3ParsePending.clear()
+    _kv3ParseWorker = null
+  })
+  return _kv3ParseWorker
+}
+
+// ── Prop-tree initial plan worker (off main thread) ─────────────────────────
+let _propTreePlanWorker = null
+let _propTreePlanNextId = 0
+const _propTreePlanPending = new Map()
+
+function getPropTreePlanWorker() {
+  if (_propTreePlanWorker) return _propTreePlanWorker
+  const workerPath = path.join(__dirname, 'src', 'prop-tree-plan-worker.js')
+  _propTreePlanWorker = new Worker(workerPath)
+
+  _propTreePlanWorker.on('message', (msg) => {
+    const p = _propTreePlanPending.get(msg.id)
+    if (!p) return
+    _propTreePlanPending.delete(msg.id)
+    if (msg.ok) p.resolve(msg.plan)
+    else p.reject(new Error(msg.error || 'prop-tree initial plan failed'))
+  })
+
+  _propTreePlanWorker.on('error', (err) => {
+    _propTreePlanPending.forEach((p) => {
+      try {
+        p.reject(err)
+      } catch (_) {}
+    })
+    _propTreePlanPending.clear()
+    _propTreePlanWorker = null
+  })
+
+  _propTreePlanWorker.on('exit', (code) => {
+    if (code === 0) return
+    const err = new Error('prop-tree initial plan worker exited with code ' + code)
+    _propTreePlanPending.forEach((p) => {
+      try {
+        p.reject(err)
+      } catch (_) {}
+    })
+    _propTreePlanPending.clear()
+    _propTreePlanWorker = null
+  })
+
+  return _propTreePlanWorker
+}
+
 ipcMain.handle('read-schema-bundle', async (_e, game) => {
   const g = typeof game === 'string' ? game.toLowerCase() : 'cs2'
   if (!SCHEMA_BUNDLE_GAMES.has(g)) {
@@ -147,6 +230,46 @@ ipcMain.handle('read-file', async (_e, filePath) => {
   return await fs.promises.readFile(filePath, 'utf-8')
 })
 
+ipcMain.handle('parse-kv3-native', async (_e, payload) => {
+  const p = payload && typeof payload === 'object' ? payload : {}
+  const text = p.text
+  const hintFileName = p.hintFileName
+
+  if (typeof text !== 'string') {
+    throw new Error('parse-kv3-native: text must be a string')
+  }
+
+  const worker = getKv3ParseWorker()
+  const id = _kv3ParseNextId++
+  return await new Promise((resolve, reject) => {
+    _kv3ParsePending.set(id, { resolve, reject })
+    try {
+      worker.postMessage({ id, text, hintFileName })
+    } catch (e) {
+      _kv3ParsePending.delete(id)
+      reject(e)
+    }
+  })
+})
+
+ipcMain.handle('build-prop-tree-initial-plan', async (_e, payload) => {
+  const p = payload && typeof payload === 'object' ? payload : {}
+  const root = p.root
+  const options = p.options && typeof p.options === 'object' ? p.options : {}
+
+  const worker = getPropTreePlanWorker()
+  const id = _propTreePlanNextId++
+  return await new Promise((resolve, reject) => {
+    _propTreePlanPending.set(id, { resolve, reject })
+    try {
+      worker.postMessage({ id, root, options })
+    } catch (e) {
+      _propTreePlanPending.delete(id)
+      reject(e)
+    }
+  })
+})
+
 ipcMain.handle('save-file', async (_e, filePath, content) => {
   await fs.promises.writeFile(filePath, content, 'utf-8')
   pushRecent(filePath)

native/kv3-addon/binding.gyp

@@ -0,0 +1,26 @@
+{
+  "targets": [
+    {
+      "target_name": "kv3addon",
+      "sources": ["kv3-addon.cpp"],
+      "cflags_cc!": ["-fno-exceptions"],
+      "conditions": [
+        [
+          "OS=='mac'",
+          {
+            "xcode_settings": {
+              "CLANG_CXX_LANGUAGE_STANDARD": "c++17"
+            }
+          }
+        ],
+        [
+          "OS!='mac'",
+          {
+            "cflags_cc": ["-std=c++17"]
+          }
+        ]
+      ]
+    }
+  ]
+}
+