aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-03-16 16:11:57 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-03-16 16:11:57 -0400
commit02b7d6e35fd12be808814f9dec29f897c9911539 (patch)
tree0129fd1292d4e6ff528804521ba6eed0148c995f
parentc8e73a92164fa17597985dd4f2d63ec2d91badd8 (diff)
Renamed `keys.MODE` to `keys.mode`.
-rw-r--r--core/keys.lua20
-rw-r--r--modules/textadept/command_entry.lua4
-rw-r--r--test/test.lua16
3 files changed, 20 insertions, 20 deletions
diff --git a/core/keys.lua b/core/keys.lua
index 2d5a1033..d115d2e4 100644
--- a/core/keys.lua
+++ b/core/keys.lua
@@ -64,7 +64,7 @@ local M = {}
--
-- ## Modes
--
--- Modes are groups of key bindings such that when a key [mode](#keys.MODE) is
+-- Modes are groups of key bindings such that when a key [mode](#keys.mode) is
-- active, Textadept ignores all key bindings defined outside the mode until the
-- mode is unset. Here is a simple vi mode example:
--
@@ -74,16 +74,16 @@ local M = {}
-- ['k'] = buffer.line_down,
-- ['l'] = buffer.char_right,
-- ['i'] = function()
--- keys.MODE = nil
+-- keys.mode = nil
-- ui.statusbar_text = 'INSERT MODE'
-- end
-- }
--- keys['esc'] = function() keys.MODE = 'command_mode' end
+-- keys['esc'] = function() keys.mode = 'command_mode' end
-- events.connect(events.UPDATE_UI, function()
--- if keys.MODE == 'command_mode' then return end
+-- if keys.mode == 'command_mode' then return end
-- ui.statusbar_text = 'INSERT MODE'
-- end)
--- keys.MODE = 'command_mode' -- default mode
+-- keys.mode = 'command_mode' -- default mode
--
-- ## Key Chains
--
@@ -101,9 +101,9 @@ local M = {}
-- The key that clears the current key chain.
-- It cannot be part of a key chain.
-- The default value is `'esc'` for the `Esc` key.
--- @field MODE (string)
+-- @field mode (string)
-- The current key mode.
--- When non-`nil`, all key bindings defined outside of `keys[MODE]` are
+-- When non-`nil`, all key bindings defined outside of `keys[mode]` are
-- ignored.
-- The default value is `nil`.
module('keys')]]
@@ -220,11 +220,11 @@ local function keypress(code, shift, control, alt, meta, caps_lock)
keychain[#keychain + 1] = key_seq
local status = PROPAGATE
- if not M.MODE then
+ if not M.mode then
status = key_command(buffer:get_lexer(true))
- if status <= PROPAGATE and not M.MODE then status = key_command() end
+ if status <= PROPAGATE and not M.mode then status = key_command() end
else
- status = key_command(M.MODE)
+ status = key_command(M.mode)
end
if status ~= CHAIN then clear_key_sequence() end
if status > PROPAGATE then return true end -- CHAIN or HALT
diff --git a/modules/textadept/command_entry.lua b/modules/textadept/command_entry.lua
index 5df63a25..f69a5644 100644
--- a/modules/textadept/command_entry.lua
+++ b/modules/textadept/command_entry.lua
@@ -181,13 +181,13 @@ function M.run(f, keys, lexer, height)
M.focus()
M:set_lexer(lexer or 'text')
M.height = M:text_height(0) * (height or 1)
- _G.keys._command_entry, _G.keys.MODE = keys, '_command_entry'
+ _G.keys._command_entry, _G.keys.mode = keys, '_command_entry'
end
-- Redefine ui.command_entry.focus() to clear any current key mode on hide/show.
local orig_focus = M.focus
M.focus = function()
- keys.MODE = nil
+ keys.mode = nil
orig_focus()
end
diff --git a/test/test.lua b/test/test.lua
index ba7354bd..8b00c1c7 100644
--- a/test/test.lua
+++ b/test/test.lua
@@ -529,7 +529,7 @@ function test_keys_propagation()
a = function() end, -- halt
b = function() return false end, -- propagate
c = function()
- keys.MODE = 'test_mode'
+ keys.mode = 'test_mode'
return false -- propagate
end
}
@@ -540,8 +540,8 @@ function test_keys_propagation()
assert(bar, 'bar set')
events.emit(events.KEYPRESS, string.byte('c'))
assert(not baz, 'baz set') -- mode changed, so cannot propagate to keys.c
- assert_equal(keys.MODE, 'test_mode')
- keys.MODE = nil
+ assert_equal(keys.mode, 'test_mode')
+ keys.mode = nil
keys.a, keys.b, keys.c, keys.cpp = nil, nil, nil, nil -- reset
io.close_buffer()
end
@@ -552,23 +552,23 @@ function test_keys_modes()
keys.a = function() foo = true end
keys.test_mode = {a = function()
bar = true
- keys.MODE = nil
+ keys.mode = nil
return false -- propagate
end}
- keys.cpp = {a = function() keys.MODE = 'test_mode' end}
+ keys.cpp = {a = function() keys.mode = 'test_mode' end}
events.emit(events.KEYPRESS, string.byte('a'))
assert(foo, 'foo not set')
- assert(not keys.MODE, 'key mode entered')
+ assert(not keys.mode, 'key mode entered')
assert(not bar, 'bar set outside mode')
foo = false
buffer:set_lexer('cpp')
events.emit(events.KEYPRESS, string.byte('a'))
- assert_equal(keys.MODE, 'test_mode')
+ assert_equal(keys.mode, 'test_mode')
assert(not foo, 'foo set outside mode')
assert(not bar, 'bar set outside mode')
events.emit(events.KEYPRESS, string.byte('a'))
assert(bar, 'bar not set')
- assert(not keys.MODE, 'key mode still active')
+ assert(not keys.mode, 'key mode still active')
assert(not foo, 'foo set') -- TODO: should this propagate?
keys.a, keys.test_mode, keys.cpp = nil, nil, nil -- reset
io.close_buffer()