1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
-- Copyright 2018 Mitchell mitchell.att.foicica.com. See LICENSE.
--[[ This comment is for LuaDoc.
---
-- A module for recording, playing, saving, and loading keyboard macros.
-- Menu commands are also recorded.
-- At this time, typing into multiple cursors during macro playback is not
-- supported.
module('textadept.macros')]]
local M = {}
local recording, macro
-- Commands bound to keys to ignore during macro recording, as the command(s)
-- ultimately executed will be recorded in some form.
local ignore
events.connect(events.INITIALIZED, function()
local m_tools = textadept.menu.menubar[_L['Tools']]
ignore = {
textadept.menu.menubar[_L['Search']][_L['Find']][2],
ui.find.find_incremental,
m_tools[_L['Select Command']][2],
m_tools[_L['Macros']][_L['Start/Stop Recording']][2]
}
end)
-- Event handlers for recording macro-able events.
local function event_recorder(event)
return function(...) macro[#macro + 1] = {event, ...} end
end
local event_recorders = {
[events.KEYPRESS] = function(code, shift, control, alt, meta)
-- Not every keypress should be recorded (e.g. toggling macro recording).
-- Use very basic key handling to try to identify key commands to ignore.
local key = code < 256 and string.char(code) or keys.KEYSYMS[code]
if key then
if shift and code >= 32 and code < 256 then shift = false end
local key_seq = string.format(
'%s%s%s%s%s', control and 'c' or '', alt and 'a' or '',
meta and OSX and 'm' or '', shift and 's' or '', key)
for i = 1, #ignore do if keys[key_seq] == ignore[i] then return end end
end
macro[#macro + 1] = {events.KEYPRESS, code, shift, control, alt, meta}
end,
[events.MENU_CLICKED] = event_recorder(events.MENU_CLICKED),
[events.CHAR_ADDED] = event_recorder(events.CHAR_ADDED),
[events.FIND] = event_recorder(events.FIND),
[events.REPLACE] = event_recorder(events.REPLACE),
[events.UPDATE_UI] = function()
if #keys.keychain == 0 then ui.statusbar_text = _L['Macro recording'] end
end
}
---
-- Toggles between starting and stopping macro recording.
-- @name record
function M.record()
if not recording then
macro = {}
for event, f in pairs(event_recorders) do events.connect(event, f, 1) end
ui.statusbar_text = _L['Macro recording']
else
for event, f in pairs(event_recorders) do events.disconnect(event, f) end
ui.statusbar_text = _L['Macro stopped recording']
end
recording = not recording
end
---
-- Plays a recorded or loaded macro.
-- @see load
-- @name play
function M.play()
if recording or not macro then return end
-- If this function is run as a key command, `keys.keychain` cannot be cleared
-- until this function returns. Emit 'esc' to forcibly clear it so subsequent
-- keypress events can be properly handled.
events.emit(events.KEYPRESS, not CURSES and 0xFF1B or 7) -- 'esc'
for _, event in ipairs(macro) do
if event[1] == events.CHAR_ADDED then
local f = buffer.selection_empty and buffer.add_text or buffer.replace_sel
f(buffer, utf8.char(event[2]))
end
events.emit(table.unpack(event))
end
end
---
-- Saves a recorded macro to file *filename* or the user-selected file.
-- @param filename Optional filename to save the recorded macro to. If `nil`,
-- the user is prompted for one.
-- @name save
function M.save(filename)
if recording or not macro then return end
if not assert_type(filename, 'string/nil', 1) then
filename = ui.dialogs.filesave{
title = _L['Save Macro'], with_directory = _USERHOME, with_extension = 'm'
}
if not filename then return end
end
local f = assert(io.open(filename, 'w'))
f:write('return {\n')
for _, event in ipairs(macro) do
f:write(string.format('{%q,', event[1]))
for i = 2, #event do
f:write(string.format(
type(event[i]) == 'string' and '%q,' or '%s,', event[i]))
end
f:write('},\n')
end
f:write('}\n'):close()
end
---
-- Loads a macro from file *filename* or the user-selected file.
-- @param filename Optional macro file to load. If `nil`, the user is prompted
-- for one.
-- @name load
function M.load(filename)
if recording then return end
if not assert_type(filename, 'string/nil', 1) then
filename = ui.dialogs.fileselect{
title = _L['Load Macro'], with_directory = _USERHOME, with_extension = 'm'
}
if not filename then return end
end
macro = assert(loadfile(filename, 't', {}))()
end
return M
|
