Rewrite in N-API; add Wayland support

.github/workflows/ci.yml

@@ -17,18 +17,54 @@ jobs:
           - windows-latest
         node_version:
           - 16
+          - 20
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install dependencies
+        if: ${{ runner.os == 'Linux' }}
+        run: sudo apt-get update && sudo apt-get install libx11-dev libxkbfile-dev libwayland-dev libxkbcommon-dev libxkbcommon-x11-dev libxkbcommon0 xkb-data
+
+      - name: Set up locale
+        if: ${{ runner.os == 'Linux' }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y locales
+          sudo locale-gen fr_FR.UTF-8  # Example: French locale
+          sudo update-locale LANG=fr_FR.UTF-8 LC_ALL=fr_FR.UTF-8
+          echo "LANG=fr_FR.UTF-8" | sudo tee -a /etc/environment
+          echo "LC_ALL=fr_FR.UTF-8" | sudo tee -a /etc/environment
+          # Apply and verify the change
+          source /etc/environment
+          locale
+
+      - name: Set keyboard layout
+        if: ${{ runner.os == 'Linux' }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y console-setup keyboard-configuration
+          # Set keyboard layout non-interactively
+          sudo sed -i 's/XKBLAYOUT=.*/XKBLAYOUT="fr"/' /etc/default/keyboard
+          sudo dpkg-reconfigure -f noninteractive keyboard-configuration
+          # Apply the changes
+          sudo setupcon
+          echo "Current locale:"
+          locale
+          echo "Current keyboard layout:"
+          cat /etc/default/keyboard | grep XKBLAYOUT
+
+      - name: Report session type
+        if: ${{ runner.os == 'Linux' }}
+        run: |
+          echo "X or Wayland? $XKB_SESSION_TYPE"
+          echo "WAYLAND_DISPLAY? $WAYLAND_DISPLAY"
+          echo "DISPLAY?: $DISPLAY"
+
       - name: Install Node ${{ matrix.node }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node_version }}
 
-      - name: Install dependencies (Linux)
-        run: sudo apt install libx11-dev libxkbfile-dev
-        if: "contains(matrix.os, 'ubuntu')"
-
       - name: Install Python setuptools
         # This is needed for Python 3.12+, since many versions of node-gyp
         # are incompatible with Python 3.12+, which no-longer ships 'distutils'

.github/workflows/publish.yml

@@ -15,16 +15,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
-        uses: GabrielBB/xvfb-action@v1
         with:
           node-version: ${{ env.NODE_VERSION }}
+      - uses: GabrielBB/xvfb-action@v1
       - run: sudo apt install libx11-dev libxkbfile-dev
       - run: python3 -m pip install setuptools
       - run: npm ci
       - run: npm test
 
   publish:
-    needs: build
+    needs: test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
+.atom
 .DS_Store
 npm-debug.log
 *.swp

README.md

@@ -1,33 +1,23 @@
 # keyboard-layout
-[![CI](https://github.com/atom/keyboard-layout/actions/workflows/ci.yml/badge.svg)](https://github.com/atom/keyboard-layout/actions/workflows/ci.yml)
 
 Read and observe the current keyboard layout.
 
-To get the current keyboard layout, call `getCurrentKeyboardLayout`. It returns
-the string identifier of the current layout based on the value returned by the
-operating system.
+To get the current keyboard layout, call `getCurrentKeyboardLayout`. It returns the string identifier of the current layout based on the value returned by the operating system.
 
 ```js
 const KeyboardLayout = require('keyboard-layout')
 KeyboardLayout.getCurrentKeyboardLayout() // => "com.apple.keylayout.Dvorak"
 ```
 
-If you want to watch for layout changes, use `onDidChangeCurrentKeyboardLayout`
-or `observeCurrentKeyboardLayout`. They work the same, except
-`observeCurrentKeyboardLayout` invokes the given callback immediately with the
-current layout value and then again next time it changes, whereas
-`onDidChangeCurrentKeyboardLayout` only invokes the callback on the next
-change.
+If you want to watch for layout changes, use `onDidChangeCurrentKeyboardLayout` or `observeCurrentKeyboardLayout`. They work the same, except `observeCurrentKeyboardLayout` invokes the given callback immediately with the current layout value and then again next time it changes, whereas `onDidChangeCurrentKeyboardLayout` only invokes the callback on the next change.
 
 ```js
 const KeyboardLayout = require('keyboard-layout')
 subscription = KeyboardLayout.observeCurrentKeyboardLayout((layout) => console.log(layout))
 subscription.dispose() // to unsubscribe later
 ```
 
-To return characters for various modifier states based on a DOM 3
-`KeyboardEvent.code` value and the current system keyboard layout, use
-`getCurrentKeymap()`:
+To return characters for various modifier states based on a DOM 3 `KeyboardEvent.code` value and the current system keyboard layout, use `getCurrentKeymap()`:
 
 ```js
 const KeyboardLayout = require('keyboard-layout')
@@ -42,3 +32,29 @@ On a US layout, this returns:
 }
 */
 ```
+
+
+## Caveats
+
+### All platforms
+
+* Having an active layout change listener (via `onDidChangeCurrentKeyboardLayout` or `observeCurrentKeyboardLayout`) will not prevent the process from exiting.
+
+### Linux
+
+On Linux, there is minimal X11 support and somewhat more comprehensive Wayland support.
+
+#### Both Wayland and X11
+
+* There is no distinction between `getCurrentKeyboardLayout` and `getCurrentKeyboardLanguage`; the latter is an alias of the former.
+
+#### X11
+
+* `onDidChangeCurrentKeyboardLayout` and `observeCurrentKeyboardLayout` are no-ops; we do not receive notifications when the keyboard layout changes. If you want to detect if the keyboard layout has changed, you must poll periodically.
+* `getCurrentKeymap` will return objects with only two properties: `unmodified` and `withShift`. Information is not available about which characters would be produced if `AltGr` or `AltGr+Shift` were pressed.
+
+#### Wayland
+
+* When Wayland support is enabled (as it will be if `libwayland-client` and `libxkbcommon` are present), this library will assume a Wayland environment is present, then fall back to X11 if Wayland setup fails in any way.
+* In a Wayland environment, `observeCurrentKeyboardLayout` works. However…
+* …the Wayland server (as implemented by your window manager) is the authority on when keyboard layouts change, and this might not align with your expectations. For instance, GNOME will change the active layout if you have several layouts and reorder them in your settings; it _will not_ change the active layout if you use keyboard shortcuts to switch “input sources” on the fly. Other window mangers may behave differently.

binding.gyp

@@ -2,11 +2,21 @@
   "targets": [
     {
       "target_name": "keyboard-layout-manager",
+      "cflags!": ["-fno-exceptions"],
+      "cflags_cc!": ["-fno-exceptions"],
+      "xcode_settings": {
+        "GCC_ENABLE_CPP_EXCEPTIONS": "YES",
+        "CLANG_CXX_LIBRARY": "libc++",
+        "MACOSX_DEPLOYMENT_TARGET": "10.7",
+      },
+      "msvs_settings": {
+        "VCCLCompilerTool": {"ExceptionHandling": 1},
+      },
       "sources": [
         "src/keyboard-layout-manager.cc"
       ],
       "include_dirs": [
-        "<!(node -e \"require('nan')\")",
+        "<!(node -p \"require('node-addon-api').include_dir\")",
         "chrome_headers",
       ],
       "conditions": [
@@ -48,21 +58,42 @@
           "sources": [
             "src/keyboard-layout-manager-linux.cc",
           ],
-          "link_settings": {
-            "libraries": [
-              "-lX11", "-lxkbfile"
-            ]
-          }
+          "cflags_cc": ["-std=c++17"],
+          "variables": {
+            "wayland_available%": "<!(pkg-config --exists wayland-client && echo 1 || echo 0)"
+          },
+          "conditions": [
+            ["wayland_available==1", {
+              "link_settings": {
+                "libraries": [
+                  "-lX11",
+                  "-lxkbfile",
+                  "-lxkbcommon",
+                  "-lwayland-client"
+                ]
+              },
+              "defines": ["HAS_WAYLAND=1"]
+            }, {
+              "link_settings": {
+                "libraries": [
+                  "-lX11",
+                  "-lxkbfile"
+                ]
+              },
+              "defines": ["HAS_WAYLAND=0"]
+            }]
+          ]
         }],  # OS=="linux"
         ['OS=="freebsd"', {
           "sources": [
             "src/keyboard-layout-manager-linux.cc",
           ],
           "include_dirs": [
+            "<!(node -p \"require('node-addon-api').include_dir\")",
             "/usr/local/include", "/usr/local/include/X11",
           ],
           "ldflags": [
-            "-lX11", "-lxkbfile", "-L/usr/local/lib",
+            "-lX11", "-lxkbfile", "-lxkbcommon", "-L/usr/local/lib",
           ],
         }],  # OS=="posix"
       ]

lib/keyboard-layout.js

@@ -7,7 +7,8 @@ const emitter = new Emitter()
 const keymapsByLayoutName = new Map()
 
 const manager = new KeyboardLayoutManager(() => {
-  emitter.emit('did-change-current-keyboard-layout', getCurrentKeyboardLayout())
+  let current = getCurrentKeyboardLayout();
+  emitter.emit('did-change-current-keyboard-layout', current)
 })
 
 function getCurrentKeymap () {
@@ -29,13 +30,13 @@ function getCurrentKeyboardLanguage () {
 }
 
 function getInstalledKeyboardLanguages () {
-  var languages = {}
+  var languages = new Set();
 
   for (var language of (manager.getInstalledKeyboardLanguages() || [])) {
-    languages[language] = true
+    languages.add(language)
   }
 
-  return Object.keys(languages)
+  return Array.from(languages)
 }
 
 function onDidChangeCurrentKeyboardLayout (callback) {
@@ -48,10 +49,10 @@ function observeCurrentKeyboardLayout (callback) {
 }
 
 module.exports = {
-  getCurrentKeymap: getCurrentKeymap,
-  getCurrentKeyboardLayout: getCurrentKeyboardLayout,
-  getCurrentKeyboardLanguage: getCurrentKeyboardLanguage,
-  getInstalledKeyboardLanguages: getInstalledKeyboardLanguages,
-  onDidChangeCurrentKeyboardLayout: onDidChangeCurrentKeyboardLayout,
-  observeCurrentKeyboardLayout: observeCurrentKeyboardLayout
+  getCurrentKeymap,
+  getCurrentKeyboardLayout,
+  getCurrentKeyboardLanguage,
+  getInstalledKeyboardLanguages,
+  onDidChangeCurrentKeyboardLayout,
+  observeCurrentKeyboardLayout
 }