upgrade for 11.3

Version bumps, deprecations, and documentation
updates for Ghidra 11.3.

Author: goatshriek

.github/workflows/build.yml

@@ -12,30 +12,20 @@ jobs:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        ghidra: ["11.1", "11.1.1", "11.2.1"]
+        ghidra: ["11.3"]
         include:
-          - ghidra: "11.1"
-            ghidra-url: "https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.1_build/ghidra_11.1_PUBLIC_20240607.zip"
-            ghidra-sha256: "293f60e04fa480315d2c467f4b2b4b10b3b6b5c8a8416bf7167fe082406e3be8"
-            ghidra-filename: "ghidra_11.1_PUBLIC_20240607.zip"
-            ghidra-folder: "ghidra_11.1_PUBLIC"
-          - ghidra: "11.1.1"
-            ghidra-url: "https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.1.1_build/ghidra_11.1.1_PUBLIC_20240614.zip"
-            ghidra-sha256: "7fe8d9a6e7e5267f3cf487a0c046b21fb08d7a602facaa2e81ac2f09b5df2866"
-            ghidra-filename: "ghidra_11.1.1_PUBLIC_20240614.zip"
-            ghidra-folder: "ghidra_11.1.1_PUBLIC"
-          - ghidra: "11.2.1"
-            ghidra-url: "https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.2.1_build/ghidra_11.2.1_PUBLIC_20241105.zip"
-            ghidra-sha256: "ce4db5117da0fbaf8f33863fec4f40902f754f06b68945a59fb1c0f9b1bc461c"
-            ghidra-filename: "ghidra_11.2.1_PUBLIC_20241105.zip"
-            ghidra-folder: "ghidra_11.2.1_PUBLIC"
+          - ghidra: "11.3"
+            ghidra-url: "https://github.com/NationalSecurityAgency/ghidra/releases/download/Ghidra_11.3_build/ghidra_11.3_PUBLIC_20250205.zip"
+            ghidra-sha256: "73b42cec587f370bfef49809ae55d2c7a3db689e8f164a1e7d7b8de295b6359f"
+            ghidra-filename: "ghidra_11.3_PUBLIC_20250205.zip"
+            ghidra-folder: "ghidra_11.3_PUBLIC"
 
     env:
       GHIDRA_INSTALL_DIR: /home/runner/ghidra/${{ matrix.ghidra-folder }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Cache Ghidra
-        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
+        uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
         id: cache-ghidra
         with:
           path: ~/ghidra
@@ -46,23 +36,16 @@ jobs:
           wget -q ${{ matrix.ghidra-url }}
           echo "${{ matrix.ghidra-sha256 }} ${{ matrix.ghidra-filename }}" | sha256sum -c
           unzip ${{ matrix.ghidra-filename }} -d ~/ghidra
-      - uses: actions/setup-java@8df1039502a15bceb9433410b1a100fbe190c53b # v4.5.0
+      - uses: actions/setup-java@3a4f6e1af504cf6a31855fa899c6aa5355ba6c12 # v4.7.0
         with:
-          distribution: 'adopt'
-          java-version: '21'
-      - name: Set Up SDK Environment
-        run: |
-          curl -s "https://get.sdkman.io?rcupdate=false" | bash
-          source "/home/runner/.sdkman/bin/sdkman-init.sh"
-          sdk install gradle 8.8
-          sdk use gradle 8.8
-          sdk default gradle 8.8
+          distribution: "temurin"
+          java-version: "21"
+          cache: "gradle"
       - name: Run Unit Tests
         run: |
           echo "skipping gradle test due to inconsistencies in reliability"
       - name: Build and Install
         run: |
-          source "/home/runner/.sdkman/bin/sdkman-init.sh"
           gradle buildExtension
           rm -rf $GHIDRA_INSTALL_DIR/Ghidra/Extensions/ruby-dragon
           unzip dist/$(ls dist) -d $GHIDRA_INSTALL_DIR/Ghidra/Extensions

CHANGELOG.md

@@ -5,7 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [4.1.0] - 2024-11-8
+## [4.2.0] - 2025-02-14
+### Changed
+ - Upgrade to JRuby 9.4.12.0 (Ruby 3.1.4)
+ - Upgrade to Groovy 4.0.25
+ - Upgrade to Kotlin 2.1.10
+
+### Deprecated
+ - `DragonPlugin.getCompletions(String cmd)` in favor of
+   `DragonPlugin.getCompletions(String cmd, int caretPos)`. This mirrors the
+   deprecation of the same method in
+   `ghidra.app.plugin.core.interpreter.InterpreterConnection`.
+
+
+## [4.1.0] - 2024-11-08
 ### Changed
  - Upgrade to JRuby 9.4.9.0 (Ruby 3.1.4)
  - Upgrade to Clojure 1.12.0
@@ -27,6 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  - Warnings and `launch.properties` files for broken JRuby support in older
    versions of Ghidra.
 
+
 ## [3.3.0] - 2024-03-28
 ### Changed
  - Upgrade to JRuby 9.4.6.0 (Ruby 3.1.4)

build.gradle

@@ -19,12 +19,12 @@ plugins {
 }
 
 dependencies {
-	implementation('org.jruby:jruby-complete:9.4.9.0')
+	implementation('org.jruby:jruby-complete:9.4.12.0')
 	implementation('org.clojure:clojure:1.12.0')
-	implementation('org.apache.groovy:groovy:4.0.23')
-	implementation('org.apache.groovy:groovy-groovysh:4.0.23')
+	implementation('org.apache.groovy:groovy:4.0.25')
+	implementation('org.apache.groovy:groovy-groovysh:4.0.25')
 	testImplementation('junit:junit:4.13.2')
-	runtimeOnly('org.jetbrains.kotlin:kotlin-scripting-jsr223:2.0.21')
+	runtimeOnly('org.jetbrains.kotlin:kotlin-scripting-jsr223:2.1.10')
 }
 
 test {

src/main/java/com/goatshriek/rubydragon/DragonException.java

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /*
- * Copyright 2021-2022 Joel E. Anderson
+ * Copyright 2021-2025 Joel E. Anderson
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,12 +18,23 @@
 
 package com.goatshriek.rubydragon;
 
+/**
+ * A generic exception from RubyDragon.
+ *
+ * This class shouldn't be used directly, instead it should be extended and then
+ * the more specific child should be thrown instead.
+ */
 public class DragonException extends Exception {
 	/**
 	 * Auto-generated serial version UID.
 	 */
 	private static final long serialVersionUID = -7049257880213278474L;
 
+	/**
+	 * A new generic RubyDragon exception.
+	 *
+	 * @param message A description of the issue encountered.
+	 */
 	public DragonException(String message) {
 		super(message);
 	}

src/main/java/com/goatshriek/rubydragon/DragonPlugin.java

@@ -67,7 +67,7 @@ public abstract class DragonPlugin extends ProgramPlugin implements InterpreterC
 	 * @since 2.2.0
 	 */
 	public static final String OPTION_CATEGORY_NAME = "Ruby Dragon Interpreters";
-	
+
 	/**
 	 * The name of the plugin category used by DragonPlugins.
 	 *
@@ -197,12 +197,28 @@ public String getAutoImportOptionName() {
 	 * @param cmd The command to try to complete.
 	 *
 	 * @return A list of possible code completions.
+	 *
+	 * @deprecated Move to using {@link #getCompletions(String, int)}.
 	 */
-	@Override
+	@Deprecated
 	public List<CodeCompletion> getCompletions(String cmd) {
 		return getInterpreter().getCompletions(cmd);
 	}
 
+	/**
+	 * Gets a {@link List} of {@link CodeCompletion code completions} for the given
+	 * command relative to the given caret position.
+	 *
+	 * @param cmd      The command to get code completions for.
+	 * @param caretPos The position of the caret in cmd. It must satisfy the
+	 *                 constraint {@code 0 <= caretPos <= cmd.length()}.
+	 * @return A {@link List} of code completions for the given command.
+	 */
+	@Override
+	public List<CodeCompletion> getCompletions(String cmd, int caretPos) {
+		return getInterpreter().getCompletions(cmd.substring(0, caretPos));
+	}
+
 	/**
 	 * The icon for this plugin.
 	 */

src/main/java/com/goatshriek/rubydragon/MissingDragonDependency.java

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /*
- * Copyright 2021-2022 Joel E. Anderson
+ * Copyright 2021-2025 Joel E. Anderson
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,12 +18,21 @@
 
 package com.goatshriek.rubydragon;
 
+/**
+ * Used when a runtime dependency needed for some RubyDragon functionality is
+ * missing.
+ */
 public class MissingDragonDependency extends DragonException {
 	/**
 	 * Auto-generated serial version UID.
 	 */
 	private static final long serialVersionUID = -4736891692182929160L;
 
+	/**
+	 * Creates a new missing dependency message with the given message.
+	 *
+	 * @param message A message describing the missing dependency.
+	 */
 	public MissingDragonDependency(String message) {
 		super(message);
 	}

src/main/java/com/goatshriek/rubydragon/clojure/ClojureGhidraInterpreter.java

@@ -83,7 +83,7 @@ public ClojureGhidraInterpreter() {
 	 * the new interpreter.
 	 *
 	 * @param console      The console to bind to the interpreter streams.
-	 * @param parentPlugin The DragonPlugin instance owning this interpreter.
+	 * @param plugin The DragonPlugin instance owning this interpreter.
 	 */
 	public ClojureGhidraInterpreter(InterpreterConsole console, DragonPlugin plugin) {
 		this();

src/main/java/com/goatshriek/rubydragon/groovy/GroovyGhidraInterpreter.java

@@ -94,6 +94,7 @@ public GroovyGhidraInterpreter() {
 	 * @param in  The input stream to use for the interpeter.
 	 * @param out The output stream to use for the interpreter.
 	 * @param err The error stream to use for the interpreter.
+	 * @param plugin The plugin that manages this interpreter.
 	 */
 	public GroovyGhidraInterpreter(InputStream in, OutputStream out, OutputStream err, DragonPlugin plugin) {
 		inStream = in;

src/main/java/com/goatshriek/rubydragon/ruby/RubyGhidraInterpreter.java

@@ -80,6 +80,7 @@ public RubyGhidraInterpreter() {
 	 * the new interpreter.
 	 *
 	 * @param console The console to bind to the interpreter streams.
+	 * @param plugin The plugin that manages this interpreter.
 	 */
 	public RubyGhidraInterpreter(InterpreterConsole console, DragonPlugin plugin) {
 		this();

src/test/resources/expected/GhidraBasicsScript.txt

@@ -40,7 +40,7 @@ FUN_0040195b
 FUN_00401961
 FUN_0040196d
 FUN_00401970
-_guard_check_icall
+guard_check_icall
 FUN_00401994
 FUN_0040199a
 FUN_004019a0
@@ -62,28 +62,28 @@ Unwind@00401e57
 __current_exception
 __current_exception_context
 memset
-_except_handler4_common
+except_handler4_common
 _seh_filter_exe
 _set_app_type
 __setusermatherr
 _configure_narrow_argv
 _initialize_narrow_environment
-_get_initial_narrow_environment
-_initterm
-_initterm_e
+get_initial_narrow_environment
+initterm
+initterm_e
 exit
 _exit
 _set_fmode
 __p___argc
 __p___argv
 _cexit
 _c_exit
-_register_thread_local_exe_atexit_callback
+register_thread_local_exe_atexit_callback
 _configthreadlocale
 __p__commode
-_initialize_onexit_table
-_register_onexit_function
-_crt_atexit
+initialize_onexit_table
+register_onexit_function
+crt_atexit
 _controlfp_s
 terminate
 __filter_x86_sse2_floating_point_exception_default