Package ghidra.app.services

Interface StringTranslationService

public interface StringTranslationService
Interface for providing string translating services.

Implementations of this interface are usually done via a Plugin and then registered via Plugin's registerServiceProvided().

  • Method Details

    • getCurrentStringTranslationServices

      static List<StringTranslationService> getCurrentStringTranslationServices(PluginTool tool)
      Returns a sorted list of the currently enabled StringTranslationService service providers.
      Parameters:
      tool - PluginTool
      Returns:
      sorted list of currently enabled StringTranslationServices

    • getTranslationServiceName

      String getTranslationServiceName()
      Returns the name of this translation service. Used when building menus to allow the user to pick a translation service.
      Returns:
      string name.

    • getHelpLocation

      default HelpLocation getHelpLocation()
      Returns the HelpLocation instance that describes where to direct the user for help when they hit f1.
      Returns:
      HelpLocation instance or null.

    • translate

      void translate(Program program, List<ProgramLocation> stringLocations, StringTranslationService.TranslateOptions options)
      Requests this translation service to translate the specified string data instances.

      The implementation generally should not block when performing this action.

      Parameters:
      program - the program containing the data instances.
      stringLocations - List of string locations.

    • createStringTranslationServiceHelpLocation

      static HelpLocation createStringTranslationServiceHelpLocation(Class<? extends Plugin> pluginClass, StringTranslationService sts)
      Helper that creates a HelpLocation based on the plugin and sts.
      Parameters:
      pluginClass - Plugin that provides the string translation service
      sts - StringTranslationService
      Returns:
      HelpLocation with topic equal to the plugin name and anchor something like "MyTranslationServiceName_String_Translation_Service".