Class GroovyScriptProvider

java.lang.Object
ghidra.app.script.GhidraScriptProvider
rubydragon.groovy.GroovyScriptProvider
All Implemented Interfaces:
ghidra.util.classfinder.ExtensionPoint, Comparable<ghidra.app.script.GhidraScriptProvider>

public class GroovyScriptProvider extends ghidra.app.script.GhidraScriptProvider
Supports Groovy scripts within ghidra.
  • Constructor Details

    • GroovyScriptProvider

      public GroovyScriptProvider()
  • Method Details

    • createNewScript

      public void createNewScript(generic.jar.ResourceFile newScript, String category) throws IOException
      Creates a new script file for the given script and category.
      Specified by:
      createNewScript in class ghidra.app.script.GhidraScriptProvider
      Throws:
      IOException
    • getBlockCommentStart

      public Pattern getBlockCommentStart()
      Returns a Pattern that matches block comment openings. For Kotlin this is "/*".
      Overrides:
      getBlockCommentStart in class ghidra.app.script.GhidraScriptProvider
      Returns:
      the Pattern for Kotlin block comment openings
    • getBlockCommentEnd

      public Pattern getBlockCommentEnd()
      Returns a Pattern that matches block comment closings. In Kotlin this is an asterisk followed by a forward slash.
      Overrides:
      getBlockCommentEnd in class ghidra.app.script.GhidraScriptProvider
      Returns:
      the Pattern for Kotlin block comment closings
    • getCommentCharacter

      public String getCommentCharacter()
      The comment character for Groovy scripts.
      Specified by:
      getCommentCharacter in class ghidra.app.script.GhidraScriptProvider
    • getDescription

      public String getDescription()
      A short description of the type of scripts this provider supports.
      Specified by:
      getDescription in class ghidra.app.script.GhidraScriptProvider
    • getExtension

      public String getExtension()
      The extension of Groovy scripts, including the period.
      Specified by:
      getExtension in class ghidra.app.script.GhidraScriptProvider
    • getScriptInstance

      public ghidra.app.script.GhidraScript getScriptInstance(generic.jar.ResourceFile sourceFile, PrintWriter writer) throws ghidra.app.script.GhidraScriptLoadException
      Creates a new GroovyScript instance for the given file and returns it.
      Specified by:
      getScriptInstance in class ghidra.app.script.GhidraScriptProvider
      Throws:
      ghidra.app.script.GhidraScriptLoadException