added ahk support for sending keystrokes & faster paste commands

Author: Caspar Gruijthuijsen

AutoMatlab.sublime-settings

@@ -43,6 +43,17 @@
     // help to extend the sleep time.
     "auto_hotkey_sleep_multiplier": 1,
 
+    // The AutoHotkey script to send commands to Matlab by default
+    // uses the clipboard to paste commands into Matlab (without
+    // affecting your current clipboard entry). While this is the 
+    // fastest method, updating the clipboard content can sometimes 
+    // take too long, making this method less reliable. To enhance 
+    // the reliability, the paste_commands option can be disabled, 
+    // making AutoHotkey simulate command typing (instead of 
+    // pasting). Alternatively, the reliability can be enhanced by 
+    // increasing the sleep_multiplier option.
+    "auto_hotkey_paste_commands": true,
+
     // Number of commands from the Matlab history to list in
     // the AutoMatlab command panel.
     "matlab_history_length": 200,

ahk/run_in_matlab.ahk

@@ -3,13 +3,29 @@
 ; SetWorkingDir %A_ScriptDir%  ; Ensures a consistent starting directory.
 SendMode Input  ; Recommended for new scripts due to its superior speed and reliability.
 
+; inputs
+; %1% - command to run in matlab
+; %2% - command type: insert, paste, key
+; %3% - return focus to sublime: (0) no, (1) yes
+; %4% - sleep time multiplier (might vary across systems)
+
 ; Get ID of the Sublime window and Matlab window
 SublimeID := WinExist("A")
 MatlabID := WinExist("ahk_exe matlab.exe")
 
-; Read sleep time multiplier
+; Read command type (as string)
+command_type = %2%
+
+; Read sleep time multiplier (as double)
 sleep_multiplier = %3%
 
+if (command_type = "paste") {
+    ; Copy command to clipboard
+    ; (do this first, as this might take some time to complete in the background)
+    SavedClip := ClipboardAll
+    Clipboard = %1%
+}
+
 ; Open Matlab window
 if WinExist("ahk_id" . MatlabID) {
     WinActivate, ahk_id %MatlabID%
@@ -18,27 +34,60 @@ if WinExist("ahk_id" . MatlabID) {
 }
 else {
     MsgBox,,Sublime AutoMatlab, AutoHotkey cannot find process matlab.exe.
+    if (command_type = "paste") {
+        Clipboard := SavedClip
+        SavedClip := ""
+    }
     Exit
 }
 
-; Focus the Command window
-if WinActive("ahk_id" . MatlabID) {
-    Send ^0
-    slp := 200 * sleep_multiplier
-    Sleep %slp%
+if (command_type = "key") {
+    ; Send keyboard command
+    if WinActive("ahk_id" . MatlabID) {
+        SendInput %1%
+        slp := 100 * sleep_multiplier
+        Sleep %slp%
+    }
 }
+else {
+    ; Send text command
 
-; Insert and submit command
-if WinActive("ahk_id" . MatlabID) {
-    SendInput {Text}%1%
-    SendInput {Enter}
-    slp := 200 * sleep_multiplier
-    Sleep %slp%
+    ; Focus the Matlab Command window
+    if WinActive("ahk_id" . MatlabID) {
+        Send ^0
+    }
+
+    if (command_type = "paste") {
+        ; Paste and submit text command
+        slp := 300 * sleep_multiplier
+        if WinActive("ahk_id" . MatlabID) {
+            Send ^v
+            SendInput {Enter}
+            slp := 100 * sleep_multiplier
+            Sleep %slp%
+        }
+    }
+    else {
+        ; Insert and submit text command
+        slp := 200 * sleep_multiplier
+        Sleep %slp%
+        if WinActive("ahk_id" . MatlabID) {
+            SendInput {Text}%1%
+            SendInput {Enter}
+            slp := 200 * sleep_multiplier
+            Sleep %slp%
+        }
+    }
 }
 
 ; Return to Sublime window
 if WinActive("ahk_id" . MatlabID) {
-    if %2% {
+    if %3% {
         WinActivate, ahk_id %SublimeID%
     }
 }
+
+if (command_type = "paste") {
+    Clipboard := SavedClip
+    SavedClip := ""
+}

auto_matlab_commands.py

@@ -98,7 +98,7 @@ def run(self, edit):
         else:
             # show quick panel with 'empty history' message
             self.view.window().show_quick_panel(
-                [config.EMPTY_MATLAB_HISTORY_MESSAGE], self.selected, 0,
+                ['Empty Matlab command history'], self.selected, 0,
                 0, self.highlighted)
 
     def selected(self, index):
@@ -238,7 +238,7 @@ class RunMatlabCommandCommand(sublime_plugin.WindowCommand):
     """Run a command in Matlab, via AutoHotkey
     """
 
-    def run(self, command):
+    def run(self, command, type='text'):
         """Run the provided command in Matlab, using AutoHotkey.
         Any sublime variable in the command will be replaced by its value.
         """
@@ -276,6 +276,13 @@ def run(self, command):
         ahk_path = settings.get('auto_hotkey_path', 'default')
         if ahk_path == 'default':
             ahk_path = config.DEFAULT_AUTO_HOTKEY_PATH
+        if type == 'key':
+            command_type = type
+        else:
+            if settings.get('auto_hotkey_paste_commands', True):
+                command_type = 'paste'
+            else:
+                command_type = 'insert'
 
         # check ahk path
         if not isfile(ahk_path):
@@ -312,6 +319,7 @@ def run(self, command):
         subprocess.Popen([ahk_path,
                           ahk_script_path,
                           command,
+                          command_type,
                           '1' if ahk_return_focus else '0',
                           str(ahk_sleep_multiplier)])
 

lib/config.py

@@ -7,8 +7,6 @@
     DEFAULT_AUTO_HOTKEY_PATH (str): Default path to AutoHotkey executable
     CONTENTS_NAME (str): Name of Matlab contents file
     SIGNATURES_NAME (str): Name of Matlab signatures file
-    EMPTY_MATLAB_HISTORY_MESSAGE (str): Message to show in command pael when 
-        no Matlab history was found.
     AUTO_HOTKEY_SCRIPT (str): Name of AutoHotkey script to run matlab commands
     MATLAB_COMPLETIONS_PATH (str): Path to AutoMatlab completions, generated 
         from Matlab installation
@@ -43,7 +41,6 @@
 SIGNATURES_NAME = 'functionSignatures.json'
 
 # AutoMatlab commands
-EMPTY_MATLAB_HISTORY_MESSAGE = 'Empty Matlab command history'
 AUTO_HOTKEY_SCRIPT = 'run_in_matlab.ahk'
 
 # AutoMatlab completions