add currentFunction variable

CHANGELOG.md

@@ -5,7 +5,11 @@ 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.0.0] - 2024-06-08
+## [4.0.0] - 2024-07-06
+### Added
+ - Current function interpreter variables with the function containing the
+   current address.
+
 ### Changed
  - Upgrade to JRuby 9.4.7.0 (Ruby 3.1.4)
  - Upgrade to Groovy 4.0.21

src/main/help/help/topics/Clojure/interpreter.html

@@ -31,12 +31,14 @@ <H2>Environment</H2>
 
     The same variables that are available in Ghidra's native Java and Python
     environments are also available in the Clojure interpreter as global
-    variables, both for interactive sessions and scripts. These are all added
-    to the ghidra namespace:
+    variables, both for interactive sessions and scripts. There are also some
+    extra variables for commonly needed values such as the current function.
+    These are all added to the ghidra namespace:
     </P>
 
     <PRE>
     ghidra/current-address
+    ghidra/current-function
     ghidra/current-highlight
     ghidra/current-location
     ghidra/current-program

src/main/help/help/topics/Groovy/interpreter.html

@@ -29,11 +29,13 @@ <H2>Environment</H2>
 
     The same variables that are available in Ghidra's native Java and Python
     environments are also available in the Groovy interpreter as global
-    variables, both for interactive sessions and scripts:
+    variables, both for interactive sessions and scripts. There are also some
+    extra variables for commonly needed values such as the current function.
     </P>
 
     <PRE>
     currentAddress
+    currentFunction
     currentHighlight
     currentLocation
     currentProgram

src/main/help/help/topics/JShell/interpreter.html

@@ -32,11 +32,13 @@ <H2>Environment</H2>
 
     The same variables that are available in Ghidra's Java and Python
     environments are also available in the JShell interpreter as global
-    variables:
+    variables. There are also some extra variables for commonly needed
+    values such as the current function.
     </P>
 
     <PRE>
     currentAddress
+    currentFunction
     currentHighlight
     currentLocation
     currentProgram

src/main/help/help/topics/Kotlin/interpreter.html

@@ -29,11 +29,13 @@ <H2>Environment</H2>
 
     The same variables that are available in Ghidra's native Java and Python
     environments are also available in the Kotlin interpreter as global
-    variables, both for interactive sessions and scripts:
+    variables, both for interactive sessions and scripts. There are also some
+    extra variables for commonly needed values such as the current function.
     </P>
 
     <PRE>
     currentAddress
+    currentFunction
     currentHighlight
     currentLocation
     currentProgram

src/main/help/help/topics/Ruby/interpreter.html

@@ -35,11 +35,13 @@ <H2>Environment</H2>
 
     The same variables that are available in Ghidra's Java and Python
     environments are also available in the Ruby interpreter as global variables,
-    both for interactive sessions and scripts:
+    both for interactive sessions and scripts. There are also some extra
+    variables, for commonly needed values such as the current function.
     </P>
 
     <PRE>
     $current_address
+    $current_function
     $current_highlight
     $current_location
     $current_program

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

@@ -46,6 +46,8 @@
  */
 public abstract class GhidraInterpreter implements Disposable {
 
+	private FlatProgramAPI api = null;
+
 	/**
 	 * Imports all of the classes listed in the auto import list by calling
 	 * importClass for each one.
@@ -122,6 +124,17 @@ public String getCurrentAPIName() {
 		return "currentAPI";
 	}
 
+	/**
+	 * The default name for the current function variable.
+	 *
+	 * @return The default name for the current function variable.
+	 *
+	 * @since 4.0.0
+	 */
+	public String getCurrentFunctionName() {
+		return "currentFunction";
+	}
+
 	/**
 	 * The default name for the current highlight variable.
 	 *
@@ -293,6 +306,7 @@ public void setStreams(InterpreterConsole console) {
 	 */
 	public void updateAddress(Address address) {
 		setVariable(getCurrentAddressName(), address);
+		setVariable(getCurrentFunctionName(), api.getFunctionContaining(address));
 	}
 
 	/**
@@ -328,7 +342,8 @@ public void updateLocation(ProgramLocation loc) {
 	public void updateProgram(Program program) {
 		if (program != null) {
 			setVariable(getCurrentProgramName(), program);
-			setVariable(getCurrentAPIName(), new FlatProgramAPI(program));
+			api = new FlatProgramAPI(program);
+			setVariable(getCurrentAPIName(), api);
 		}
 	}
 

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

@@ -142,6 +142,18 @@ public String getCurrentAPIName() {
 		return "current-api";
 	}
 
+	/**
+	 * The name for the current function variable.
+	 *
+	 * @return The name for the current function variable.
+	 *
+	 * @since 4.0.0
+	 */
+	@Override
+	public String getCurrentFunctionName() {
+		return "current-function";
+	}
+
 	/**
 	 * The name for the current highlight variable.
 	 *

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

@@ -167,6 +167,18 @@ public String getCurrentAPIName() {
 		return "$current_api";
 	}
 
+	/**
+	 * The name for the current function variable.
+	 *
+	 * @return The name for the current function variable.
+	 *
+	 * @since 4.0.0
+	 */
+	@Override
+	public String getCurrentFunctionName() {
+		return "$current_function";
+	}
+
 	/**
 	 * The name for the current highlight variable.
 	 *