Merge remote-tracking branch 'upstream/develop' into fmtlib

Author: ab9rf

.github/workflows/build-windows.yml

@@ -66,12 +66,15 @@ on:
 jobs:
   build-win64:
     name: Build win64
-    runs-on: ubuntu-22.04
+    runs-on: windows-2022
     steps:
-      - name: Install dependencies
+      - name: Install build dependencies
         run: |
-          sudo apt-get update
-          sudo apt-get install ccache
+          choco install sccache
+      - name: Install doc dependencies
+        if: inputs.docs
+        run: |
+          pip install sphinx
       - name: Clone DFHack
         uses: actions/checkout@v4
         with:
@@ -108,49 +111,82 @@ jobs:
           ref: main
           ssh-key: ${{ secrets.DFHACK_3RDPARTY_TOKEN }}
           path: depends/steam
+      - name: Prepare output directories
+        run: |
+          mkdir output
+          mkdir pdb
+      - name: Get sccache path
+        run: echo ("SCCACHE_DIR=" + $env:LOCALAPPDATA + "\Mozilla\sccache\cache") >> $env:GITHUB_ENV
       - name: Fetch ccache
         if: inputs.platform-files
         uses: actions/cache/restore@v4
         with:
-          path: build/win64-cross/ccache
+          path: ${{ env.SCCACHE_DIR }}
           key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
           restore-keys: |
             win-msvc-${{ inputs.cache-id }}
             win-msvc
-      - name: Cross-compile
+      - uses: ilammy/msvc-dev-cmd@v1
+      - name: Configure DFHack
+        run: |
+          cmake `
+            -S . `
+            -B build `
+            -GNinja `
+            -DDFHACK_BUILD_ARCH=64 `
+            -DCMAKE_BUILD_TYPE=Release `
+            -DCMAKE_INSTALL_PREFIX=output `
+            -DCMAKE_C_COMPILER_LAUNCHER=sccache `
+            -DCMAKE_CXX_COMPILER_LAUNCHER=sccache `
+            -DBUILD_PDBS:BOOL=${{ inputs.cache-id == 'release' }} `
+            -DDFHACK_RUN_URL='https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}' `
+            -DBUILD_LIBRARY=${{ inputs.platform-files }} `
+            -DBUILD_PLUGINS:BOOL=${{ inputs.platform-files && inputs.plugins }} `
+            -DBUILD_STONESENSE:BOOL=${{ inputs.stonesense }} `
+            -DBUILD_DOCS:BOOL=${{ inputs.docs }} `
+            -DBUILD_DOCS_NO_HTML:BOOL=${{ !inputs.html }} `
+            -DINSTALL_DATA_FILES:BOOL=${{ inputs.common-files }} `
+            -DBUILD_DFLAUNCH:BOOL=${{ inputs.launchdf }} `
+            -DBUILD_TESTS:BOOL=${{ inputs.tests }} `
+            -DBUILD_XMLDUMP:BOOL=${{ inputs.xml-dump-type-sizes }} `
+            ${{ inputs.xml-dump-type-sizes && '-DINSTALL_XMLDUMP:BOOL=1' || '' }}
+      - name: Build DFHack
         env:
-          CMAKE_EXTRA_ARGS: -DBUILD_PDBS:BOOL=${{ inputs.cache-id == 'release' }} -DDFHACK_RUN_URL='https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}' -DBUILD_LIBRARY=${{ inputs.platform-files }} -DBUILD_PLUGINS:BOOL=${{ inputs.platform-files && inputs.plugins }} -DBUILD_STONESENSE:BOOL=${{ inputs.stonesense }} -DBUILD_DOCS:BOOL=${{ inputs.docs }} -DBUILD_DOCS_NO_HTML:BOOL=${{ !inputs.html }} -DINSTALL_DATA_FILES:BOOL=${{ inputs.common-files }} -DINSTALL_SCRIPTS:BOOL=${{ inputs.common-files }} -DBUILD_DFLAUNCH:BOOL=${{ inputs.launchdf }} -DBUILD_TESTS:BOOL=${{ inputs.tests }} -DBUILD_XMLDUMP:BOOL=${{ inputs.xml-dump-type-sizes }} ${{ inputs.xml-dump-type-sizes && '-DINSTALL_XMLDUMP:BOOL=1' || '' }}
+          SCCACHE_CACHE_SIZE: 500M
         run: |
-          cd build
-          bash -x build-win64-from-linux.sh
+          ninja install -C build
       - name: Finalize cache
         run: |
           cd build
-          ccache -d win64-cross/ccache --show-stats --verbose
-          ccache -d win64-cross/ccache --max-size ${{ inputs.cache-id == 'release' && '500M' || '150M' }}
-          ccache -d win64-cross/ccache --cleanup
-          ccache -d win64-cross/ccache --max-size ${{ inputs.cache-id == 'release' && '2G' || '500M' }}
-          ccache -d win64-cross/ccache --zero-stats
+          sccache --show-stats
+          sccache --zero-stats
       - name: Save ccache
         if: inputs.platform-files && !inputs.cache-readonly
         uses: actions/cache/save@v4
         with:
-          path: build/win64-cross/ccache
+          path: ${{ env.SCCACHE_DIR }}
           key: win-msvc-${{ inputs.cache-id }}-${{ github.sha }}
       - name: Format artifact name
         if: inputs.artifact-name
         id: artifactname
         run: |
-          if test "false" = "${{ inputs.append-date-and-hash }}"; then
-            echo name=${{ inputs.artifact-name }} >> $GITHUB_OUTPUT
-          else
-            echo name=${{ inputs.artifact-name }}-$(date +%Y%m%d)-$(git rev-parse --short HEAD) >> $GITHUB_OUTPUT
-          fi
+          if ("${{ inputs.append-date-and-hash }}" -eq "false") {
+            "name=${{ inputs.artifact-name }}" | Out-File -Append $env:GITHUB_OUTPUT
+          } else {
+            $date = Get-Date -Format "yyyMMdd"
+            $hash = git rev-parse --short HEAD
+            "name=${{ inputs.artifact-name}}-$date-$hash" | Out-File -Append $env:GITHUB_OUTPUT
+          }
+      - name: Prep pdbs
+        if: inputs.artifact-name && inputs.cache-id == 'release'
+        run: |
+          Get-ChildItem -Recurse -File -Path "build" -Filter *.pdb |
+            Copy-Item -Destination "pdb"
       - name: Prep artifact
-        if: inputs.artifact-name
         run: |
-          cd build/win64-cross/output
-          tar cjf ../../../${{ steps.artifactname.outputs.name }}.tar.bz2 .
+          cd output
+          7z a -ttar -so -an . |
+            7z a -si -tbzip2 ../${{ steps.artifactname.outputs.name }}.tar.bz2
       - name: Upload artifact
         if: inputs.artifact-name
         uses: actions/upload-artifact@v4
@@ -162,4 +198,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifactname.outputs.name }}_pdb
-          path: build/win64-cross/pdb
+          path: pdb

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
       args: ['--fix=lf']
     - id: trailing-whitespace
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.34.1
+  rev: 0.35.0
   hooks:
     - id: check-github-workflows
 - repo: https://github.com/Lucas-C/pre-commit-hooks

docs/builtins/keybinding.rst

@@ -9,9 +9,9 @@ Like any other command, it can be used at any time from the console, but
 bindings are not remembered between runs of the game unless re-created in
 :file:`dfhack-config/init/dfhack.init`.
 
-Hotkeys can be any combinations of Ctrl/Alt/Shift with A-Z, 0-9, F1-F12, or `
-(the key below the :kbd:`Esc` key on most keyboards). You can also represent
-mouse buttons beyond the first three with ``MOUSE4`` through ``MOUSE15``.
+Hotkeys can be any combinations of Ctrl/Alt/Super/Shift with any key recognized by SDL.
+You can also represent mouse buttons beyond the first three with ``MOUSE4``
+through ``MOUSE15``.
 
 Usage
 -----
@@ -27,12 +27,13 @@ Usage
 ``keybinding set <key> "<cmdline>" ["<cmdline>" ...]``
     Clear, and then add bindings for the specified key.
 
-The ``<key>`` parameter above has the following **case-sensitive** syntax::
+The ``<key>`` parameter above has the following case-insensitive syntax::
 
-    [Ctrl-][Alt-][Shift-]KEY[@context[|context...]]
+    [Ctrl-][Alt-][Super-][Shift-]KEY[@context[|context...]]
 
 where the ``KEY`` part can be any recognized key and :kbd:`[`:kbd:`]` denote
-optional parts.
+optional parts. It is important to note that the key is the non-shifted version
+of the key. For example ``!`` would be defined as ``Shift-0``.
 
 DFHack commands can advertise the contexts in which they can be usefully run.
 For example, a command that acts on a selected unit can tell `keybinding` that

docs/changelog.txt

@@ -55,18 +55,33 @@ Template for new versions:
 # Future
 
 ## New Tools
+- ``edgescroll``: Introduced plugin to pan the view automatically when the mouse reaches the screen border.
 
 ## New Features
+- `sort`: Places search widget can search "Siege engines" subtab by name, loaded status, and operator status
 
 ## Fixes
+- `sort`: Using the squad unit selector will no longer cause Dwarf Fortress to crash on exit
+- `sort`: Places search widget moved to account for DF's new "Siege engines" subtab
 
 ## Misc Improvements
+- `createitem`: created items can now be placed onto/into tables, nests, bookcases, display cases, and altars
+- `keybinding`: keybinds may now include the super key, and are no longer limited to particular keys ranges of keys, allowing any recognized by SDL.
+- The ``fpause`` console command can now be used to force world generation to pause (as it did prior to version 50).
 
 ## Documentation
 
 ## API
+- ``Hotkey``: New module for hotkey functionality
 
 ## Lua
+- The ``Lua interactive interpreter`` banner now documents keywords such as ``unit`` and ``item`` which reference the currently-selected object in the DF UI.
+- ``dfhack.hotkey.addKeybind``: Creates new keybindings
+- ``dfhack.hotkey.removeKeybind``: Removes existing keybindings
+- ``dfhack.hotkey.listActiveKeybinds``: Lists all keybinds for the current context
+- ``dfhack.hotkey.listAllKeybinds``: Lists all keybinds for all contexts
+- ``dfhack.hotkey.requestKeybindingInput``: Requests the next keybind-compatible input is saved
+- ``dfhack.hotkey.getKeybindingInput``: Reads the input saved in response to a request.
 
 ## Removed
 
@@ -77,7 +92,6 @@ Template for new versions:
 ## New Features
 
 ## Fixes
-- `sort`: Using the squad unit selector will no longer cause Dwarf Fortress to crash on exit
 
 ## Misc Improvements
 
@@ -98,6 +112,7 @@ Template for new versions:
 - compatibility with 53.05
 
 ## Fixes
+- `sort`: Using the squad unit selector will no longer cause Dwarf Fortress to crash on exit
 
 ## Misc Improvements
 

docs/dev/Lua API.rst

@@ -1430,6 +1430,53 @@ Job module
 
   Returns the job's description, as seen in the Units and Jobs screens.
 
+Hotkey module
+-------------
+
+* ``dfhack.hotkey.addKeybind(keyspec, command)``
+
+  Creates a new keybind with the provided keyspec (see the `keybinding` documentation
+  for details on format).
+  Returns false on failure to create keybind.
+
+* ``dfhack.hotkey.removeKeybind(keyspec, [match_focus=true, command])``
+
+  Removes keybinds matching the provided keyspec.
+  If match_focus is set, the focus portion of the keyspec is matched against.
+  If command is provided and not an empty string, the command is matched against.
+  Returns false if no keybinds were removed.
+
+* ``dfhack.hotkey.listActiveKeybinds()``
+
+  Returns a list of keybinds active within the current context.
+  The items are tables with the following attributes:
+  :spec: The keyspec for the hotkey
+  :command: The command the hotkey runs when pressed
+
+* ``dfhack.hotkey.listAllKeybinds()``
+
+  Returns a list of all keybinds currently registered.
+  The items are tables with the following attributes:
+  :spec: The keyspec for the hotkey
+  :command: The command the hotkey runs when pressed
+
+* ``dfhack.hotkey.requestKeybindingInput([cancel=false])``
+
+  Enqueues or cancels a request that the next hotkey-compatible input is saved
+  and not processed, retrievable with ``dfhack.hotkey.getKeybindingInput()``.
+  If cancel is true, any current request is cancelled.
+
+* ``dfhack.hotkey.getKeybindingInput()``
+
+  Reads the latest saved keybind input that was requested.
+  Returns a keyspec string for the input, or nil if no input has been saved.
+
+* ``dfhack.hotkey.isDisruptiveKeybind(keyspec)``
+
+  Determines if the provided keyspec could be disruptive to the game experience.
+  This includes the majority of standard characters and special keys such as escape,
+  backspace, and return when lacking modifiers other than Shift.
+
 Units module
 ------------
 
@@ -3494,7 +3541,7 @@ and are only documented here for completeness:
 * ``dfhack.internal.getModifiers()``
 
   Returns the state of the keyboard modifier keys in a table of string ->
-  boolean. The keys are ``ctrl``, ``shift``, and ``alt``.
+  boolean. The keys are ``ctrl``, ``shift``, ``super``, and ``alt``.
 
 * ``dfhack.internal.getSuppressDuplicateKeyboardEvents()``
 * ``dfhack.internal.setSuppressDuplicateKeyboardEvents(suppress)``
@@ -7468,6 +7515,15 @@ Importing scripts
 
       --@ module = true
 
+     In order to be recognized, this line **must** begin with ``--@`` with no
+     whitespace characters before it::
+
+      --@ module = true   OK
+      --@module = true    OK
+      -- @module = true   NOT OK (no --@ found due to space after --)
+       --@module = true   NOT OK (leading space, --@ is not at the beginning of the line)
+      ---@module = true   NOT OK (leading dash, --@ is not at the beginning of the line)
+
   2. Include a check for ``dfhack_flags.module``, and avoid running any code
      that has side-effects if this flag is true. For instance::
 

docs/plugins/edgescroll.rst

@@ -0,0 +1,13 @@
+edgescroll
+==========
+
+.. dfhack-tool::
+   :summary: Scroll the game world and region maps when the mouse reaches the window border.
+   :tags: interface
+
+Usage
+-----
+
+::
+
+    enable edgescroll

library/CMakeLists.txt

@@ -48,6 +48,7 @@ set(MAIN_HEADERS
     include/DFHackVersion.h
     include/BitArray.h
     include/ColorText.h
+    include/Commands.h
     include/Console.h
     include/Core.h
     include/CoreDefs.h
@@ -67,6 +68,7 @@ set(MAIN_HEADERS
     include/MiscUtils.h
     include/Module.h
     include/MemAccess.h
+    include/MemoryPatcher.h
     include/ModuleFactory.h
     include/PluginLua.h
     include/PluginManager.h
@@ -89,6 +91,7 @@ set(MAIN_HEADERS_WINDOWS
 set(MAIN_SOURCES
     Core.cpp
     ColorText.cpp
+    Commands.cpp
     CompilerWorkAround.cpp
     DataDefs.cpp
     DataIdentity.cpp
@@ -101,6 +104,7 @@ set(MAIN_SOURCES
     LuaApi.cpp
     DataStatics.cpp
     DataStaticsCtor.cpp
+    MemoryPatcher.cpp
     MiscUtils.cpp
     Types.cpp
     PluginManager.cpp
@@ -157,6 +161,7 @@ set(MODULE_HEADERS
     include/modules/Graphic.h
     include/modules/Gui.h
     include/modules/GuiHooks.h
+    include/modules/Hotkey.h
     include/modules/Items.h
     include/modules/Job.h
     include/modules/Kitchen.h
@@ -187,6 +192,7 @@ set(MODULE_SOURCES
     modules/Filesystem.cpp
     modules/Graphic.cpp
     modules/Gui.cpp
+    modules/Hotkey.cpp
     modules/Items.cpp
     modules/Job.cpp
     modules/Kitchen.cpp