path: root/modules/textadept/keys.lua

-- Copyright 2007-2012 Mitchell mitchell.att.foicica.com. See LICENSE.

local M = {}

--[[ This comment is for LuaDoc.
---
-- Defines key commands for Textadept.
-- This set of key commands is pretty standard among other text editors. If
-- applicable, load this module second to last in your *~/.textadept/init.lua*,
-- before `_M.textadept.menu`.
--
-- ## Key Bindings
--
-- Linux / Win32 | Mac OSX | Terminal | Command
-- --------------|---------|----------|--------
-- **File**      |         |          |
-- Ctrl+N        |⌘N       |M-^N      |New file
-- Ctrl+O        |⌘O       |^O        |Open file
-- Ctrl+Alt+O    |^⌘O      |M-^O      |Open recent file...
-- Ctrl+Shift+O  |⌘⇧O      |M-O       |Reload file
-- Ctrl+S        |⌘S       |^S        |Save file
-- Ctrl+Shift+S  |⌘⇧S      |M-^S      |Save file as..
-- Ctrl+W        |⌘W       |^W        |Close file
-- Ctrl+Shift+W  |⌘⇧W      |M-^W      |Close all files
-- None          |None     |None      |Load session...
-- None          |None     |None      |Load session...
-- Ctrl+Q        |⌘Q       |^Q        |Quit
-- **Edit**                |         |             |
-- Ctrl+Z<br/>Alt+Bksp     |⌘Z       |^Z           |Undo
-- Ctrl+Y<br/>Ctrl+Shift+Z |⌘⇧Z      |^Y           |Redo
-- Ctrl+X<br/>Shift+Del    |⌘X<br/>⇧⌦|^X           |Cut
-- Ctrl+C<br/>Ctrl+Ins     |⌘C       |^C           |Copy
-- Ctrl+V<br/>Shift+Ins    |⌘V       |^V           |Paste
-- Ctrl+D                  |⌘D       |None         |Duplicate line
-- Del                     |⌦<br/>^D |Del<br/>^D   |Delete
-- Alt+Del                 |^⌦       |M-Del<br/>M-D|Delete word
-- Ctrl+A                  |⌘A       |M-A          |Select all
-- Ctrl+M                  |^M       |M-M          |Match brace
-- Ctrl+Enter              |^⎋       |M-Enter      |Complete word
-- Ctrl+Alt+Shift+H        |⌘⇧H      |None         |Highlight word
-- Ctrl+/                  |^/       |M-/          |Toggle block comment
-- Ctrl+T                  |^T       |^T           |Transpose characters
-- Ctrl+Shift+J            |^J       |M-J          |Join lines
-- Ctrl+Shift+M            |^⇧M      |M-S-M        |Select to matching brace
-- Ctrl+<                  |⌘<       |M-<          |Select between XML tags
-- Ctrl+>                  |⌘>       |None         |Select in XML tag
-- Ctrl+"                  |⌘"       |M-"          |Select in double quotes
-- Ctrl+'                  |⌘'       |M-'          |Select in single quotes
-- Ctrl+(                  |⌘(       |M-(          |Select in parentheses
-- Ctrl+[                  |⌘[       |M-[          |Select in brackets
-- Ctrl+{                  |⌘{       |M-{          |Select in braces
-- Ctrl+Shift+D            |⌘⇧D      |M-S-W        |Select word
-- Ctrl+Shift+N            |⌘⇧N      |M-S-N        |Select line
-- Ctrl+Shift+P            |⌘⇧P      |M-S-P        |Select paragraph
-- Ctrl+Shift+I            |⌘⇧I      |M-S-I        |Select indented block
-- Ctrl+Alt+U              |^U       |M-^U         |Upper case selection
-- Ctrl+Alt+Shift+U        |^⇧U      |M-^L         |Lower case selection
-- Alt+<                   |^<       |M->          |Enclose as XML tags
-- Alt+>                   |^>       |None         |Enclose as single XML tag
-- Alt+"                   |^"       |None         |Enclose in double quotes
-- Alt+'                   |^'       |None         |Enclose in single quotes
-- Alt+(                   |^(       |M-)          |Enclose in parentheses
-- Alt+[                   |^[       |M-]          |Enclose in brackets
-- Alt+{                   |^{       |M-}          |Enclose in braces
-- Ctrl++                  |⌘+       |M-+          |Grow selection bounds by 1
-- Ctrl+\_                 |⌘\_      |M-\_         |Shrink selection bounds by 1
-- Ctrl+Shift+Up           |^⇧⇡      |S-^Up        |Move selected lines up
-- Ctrl+Shift+Down         |^⇧⇣      |S-^Down      |Move selected lines down
-- **Search**               |    |             |
-- Ctrl+F                   |⌘F  |M-F<br/>M-S-F|Find
-- Ctrl+G<br/>F3            |⌘G  |M-G          |Find next
-- Ctrl+Shift+G<br/>Shift+F3|⌘⇧G |M-S-G        |Find previous
-- Ctrl+Alt+R               |^R  |M-R          |Replace
-- Ctrl+Alt+Shift+R         |^⇧R |M-S-R        |Replace all
-- Ctrl+Alt+F               |^⌘F |M-^F         |Find incremental
-- Ctrl+Shift+F             |⌘⇧F |None         |Find in files
-- Ctrl+Alt+G               |^⌘G |None         |Goto next file found
-- Ctrl+Alt+Shift+G         |^⌘⇧G|None         |Goto previous file found
-- Ctrl+J                   |⌘J  |^J           |Jump to line
-- **Tools**       |       |             |
-- Ctrl+E          |⌘E     |M-C          |Command entry
-- Ctrl+Shift+E    |⌘⇧E    |M-S-C        |Select command
-- Ctrl+R          |⌘R     |^R           |Run
-- Ctrl+Shift+R    |⌘⇧R    |M-^R         |Compile
-- Ctrl+&#124;     |⌘&#124;|^\           |Filter text through
-- Ctrl+Space      |⌥⎋     |^Space       |Complete symbol
-- Ctrl+H          |^H     |M-H<br/>M-S-H|Show documentation
-- Tab             |⇥      |Tab          |Expand snippet or next placeholder
-- Ctrl+K          |⌥⇥     |M-K          |Insert snippet...
-- Shift+Tab       |⇧⇥     |S-Tab        |Previous snippet placeholder
-- Ctrl+Shift+K    |⌥⇧⇥    |M-S-K        |Cancel snippet
-- Ctrl+F2         |⌘F2    |F1           |Toggle bookmark
-- Ctrl+Shift+F2   |⌘⇧F2   |F6           |Clear bookmarks
-- F2              |F2     |F2           |Next bookmark
-- Shift+F2        |⇧F2    |F3           |Previous bookmark
-- Alt+F2          |⌥F2    |F4           |Goto bookmark...
-- Ctrl+U          |⌘U     |^U           |Snapopen `_USERHOME`
-- None            |None   |None         |Snapopen `_HOME`
-- Ctrl+Alt+Shift+O|^⌘⇧O   |M-S-O        |Snapopen current directory
-- Ctrl+I          |⌘I     |None         |Show style
-- **Buffer**      |      |             |
-- Ctrl+Tab        |^⇥    |M-N          |Next buffer
-- Ctrl+Shift+Tab  |^⇧⇥   |M-P          |Previous buffer
-- Ctrl+B          |⌘B    |M-B<br/>M-S-B|Switch to buffer...
-- None            |None  |None         |Tab width: 2
-- None            |None  |None         |Tab width: 3
-- None            |None  |None         |Tab width: 4
-- None            |None  |None         |Tab width: 8
-- Ctrl+Alt+Shift+T|^⇧T   |M-T<br/>M-S-T|Toggle use tabs
-- Ctrl+Alt+I      |^I    |M-I          |Convert indentation
-- None            |None  |None         |CR+LF EOL mode
-- None            |None  |None         |CR EOL mode
-- None            |None  |None         |LF EOL mode
-- None            |None  |None         |UTF-8 encoding
-- None            |None  |None         |ASCII encoding
-- None            |None  |None         |ISO-8859-1 encoding
-- None            |None  |None         |MacRoman encoding
-- None            |None  |None         |UTF-16 encoding
-- Ctrl+Shift+L    |⌘⇧L   |M-S-L        |Select lexer...
-- F5              |F5    |^L<br/>F5    |Refresh syntax highlighting
-- **View**                 |         |     |
-- Ctrl+Alt+N               |^⌥⇥      |N/A  |Next view
-- Ctrl+Alt+P               |^⌥⇧⇥     |N/A  |Previous view
-- Ctrl+Alt+S<br/>Ctrl+Alt+H|^S       |N/A  |Split view horizontally
-- Ctrl+Alt+V               |^V       |N/A  |Split view vertically
-- Ctrl+Alt+W               |^W       |N/A  |Unsplit view
-- Ctrl+Alt+Shift+W         |^⇧W      |N/A  |Unsplit all views
-- Ctrl+Alt++<br/>Ctrl+Alt+=|^+<br/>^=|N/A  |Grow view
-- Ctrl+Alt+-               |^-       |N/A  |Shrink view
-- Ctrl+*                   |⌘*       |M-*  |Toggle current fold
-- Ctrl+Alt+Enter           |^↩       |None |Toggle view EOL
-- Ctrl+Alt+\\              |^\\      |None |Toggle wrap mode
-- Ctrl+Alt+Shift+I         |^⇧I      |N/A  |Toggle show indent guides
-- Ctrl+Alt+Shift+S         |^⇧S      |None |Toggle view whitespace
-- Ctrl+Alt+Shift+V         |^⇧V      |None |Toggle virtual space
-- Ctrl+=                   |⌘=       |N/A  |Zoom in
-- Ctrl+-                   |⌘-       |N/A  |Zoom out
-- Ctrl+0                   |⌘0       |N/A  |Reset zoom
-- Ctrl+Shift+T             |⌘⇧T      |None |Select theme...
-- **Help**|    |    |
-- F1      |F1  |None|Open manual
-- Shift+F1|⇧F1 |None|Open LuaDoc
-- None    |None|None|About
-- **Movement**    |            |            |
-- Down            |⇣<br/>^N    |^N<br/>Down |Line down
-- Shift+Down      |⇧⇣<br/>^⇧N  |S-Down      |Line down extend selection
-- Ctrl+Down       |^⇣          |^Down       |Scroll line down
-- Alt+Shift+Down  |⌥⇧⇣         |M-S-Down    |Line down extend rect. selection
-- Up              |⇡<br/>^P    |^P<br/>Up   |Line up
-- Shift+Up        |⇧⇡<br/>^⇧P  |S-Up        |Line up extend selection
-- Ctrl+Up         |^⇡          |^Up         |Scroll line up
-- Alt+Shift+Up    |⌥⇧⇡         |M-S-Up      |Line up extend rect. selection
-- Left            |⇠<br/>^B    |^B<br/>Left |Char left
-- Shift+Left      |⇧⇠<br/>^⇧B  |S-Left      |Char left extend selection
-- Ctrl+Left       |^⇠<br/>^⌘B  |^Left       |Word left
-- Ctrl+Shift+Left |^⇧⇠<br/>^⌘⇧B|S-^Left     |Word left extend selection
-- Alt+Shift+Left  |⌥⇧⇠         |M-S-Left    |Char left extend rect. selection
-- Right           |⇢<br/>^F    |^F<br/>Right|Char right
-- Shift+Right     |⇧⇢<br/>^⇧F  |S-Right     |Char right extend selection
-- Ctrl+Right      |^⇢<br/>^⌘F  |^Right      |Word right
-- Ctrl+Shift+Right|^⇧⇢<br/>^⌘⇧F|S-^Right    |Word right extend selection
-- Alt+Shift+Right |⌥⇧⇢         |M-S-Right   |Char right extend rect. selection
-- Home            |⌘⇠<br/>^A   |^A<br/>Home |Line start
-- Shift+Home      |⌘⇧⇠<br/>^⇧A |M-S-A       |Line start extend selection
-- Ctrl+Home       |⌘⇡<br/>⌘↖   |M-^A        |Document start
-- Ctrl+Shift+Home |⌘⇧⇡<br/>⌘⇧↖ |None        |Document start extend selection
-- Alt+Shift+Home  |⌥⇧↖         |None        |Line start extend rect. selection
-- End             |⌘⇢<br/>^E   |^E<br/>End  |Line end
-- Shift+End       |⌘⇧⇢<br/>^⇧E |M-S-E       |Line end extend selection
-- Ctrl+End        |⌘⇣<br/>⌘↘   |M-^E        |Document end
-- Ctrl+Shift+End  |⌘⇧⇣<br/>⌘⇧↘ |None        |Document end extend selection
-- Alt+Shift+End   |⌥⇧↘         |None        |Line end extend rect. selection
-- PgUp            |⇞           |PgUp        |Page up
-- Shift+PgUp      |⇧⇞          |M-S-U       |Page up extend selection
-- Alt+Shift+PgUp  |⌥⇧⇞         |None        |Page up extend rect. selection
-- PgDn            |⇟           |PgDn        |Page down
-- Shift+PgDn      |⇧⇟          |M-S-D       |Page down extend selection
-- Alt+Shift+PgDn  |⌥⇧⇟         |None        |Page down extend rect. selection
-- Ctrl+Del        |⌘⌦          |^Del        |Delete word right
-- Ctrl+Shift+Del  |⌘⇧⌦         |S-^Del      |Delete line right
-- Ins             |Ins         |Ins         |Toggle overtype
-- Bksp            |⌫<br/>⇧⌫    |^H<br/>Bksp |Delete back
-- Ctrl+Bksp       |⌘⌫          |None        |Delete word left
-- Ctrl+Shift+Bksp |⌘⇧⌫         |None        |Delete line left
-- Tab             |⇥           |Tab<br/>^I  |Insert tab or indent
-- Shift+Tab       |⇧⇥          |S-Tab       |Dedent
-- None            |^K          |^K          |Cut to line end
-- None            |^L          |None        |Center line vertically
-- N/A             |N/A         |^^          |Mark text at the caret position
-- N/A             |N/A         |^]          |Swap caret and mark anchor
-- **Other**                |    |    |
-- Ctrl+Shift+U, xxxx, Enter|None|None|Input Unicode character U-xxxx.
-- **ncurses CDK Fields**|   |            |
-- N/A                   |N/A|^B<br/>Left |Cursor left
-- N/A                   |N/A|^F<br/>Right|Cursor right
-- N/A                   |N/A|Del         |Delete forward
-- N/A                   |N/A|^H<br/>Bksp |Delete back
-- N/A                   |N/A|^V          |Paste
-- N/A                   |N/A|^X          |Cut all
-- N/A                   |N/A|^Y          |Copy all
-- N/A                   |N/A|^U          |Erase all
-- N/A                   |N/A|^A          |Home
-- N/A                   |N/A|^E          |End
-- N/A                   |N/A|^T          |Transpose characters
-- N/A                   |N/A|^L          |Refresh
module('_M.textadept.keys')]]

-- Utility functions.
M.utils = {
  delete_word = function()
    _M.textadept.editing.select_word()
    buffer:delete_back()
  end,
  enclose_as_xml_tags = function()
    _M.textadept.editing.enclose('<', '>')
    local buffer = buffer
    local pos = buffer.current_pos
    while buffer.char_at[pos - 1] ~= 60 do pos = pos - 1 end -- '<'
    buffer:insert_text(-1, '</'..buffer:text_range(pos, buffer.current_pos))
  end,
  find_in_files = function()
    gui.find.in_files = true
    gui.find.focus()
  end,
  select_command = function() _M.textadept.menu.select_command() end,
  snapopen_filedir = function()
    if buffer.filename then
      _M.textadept.snapopen.open(buffer.filename:match('^(.+)[/\\]'))
    end
  end,
  show_style = function()
    local buffer = buffer
    local style = buffer.style_at[buffer.current_pos]
    local text = string.format("%s %s\n%s %s (%d)", _L['Lexer'],
                               buffer:get_lexer(true), _L['Style'],
                               buffer:get_style_name(style), style)
    buffer:call_tip_show(buffer.current_pos, text)
  end,
  set_indentation = function(i)
    buffer.tab_width = i
    events.emit(events.UPDATE_UI) -- for updating statusbar
  end,
  toggle_property = function(property, i)
    local state = buffer[property]
    if type(state) == 'boolean' then
      buffer[property] = not state
    elseif type(state) == 'number' then
      buffer[property] = buffer[property] == 0 and (i or 1) or 0
    end
    events.emit(events.UPDATE_UI) -- for updating statusbar
  end,
  set_encoding = function(encoding)
    buffer:set_encoding(encoding)
    events.emit(events.UPDATE_UI) -- for updating statusbar
  end,
  set_eol_mode = function(mode)
    buffer.eol_mode = mode
    buffer:convert_eo_ls(mode)
    events.emit(events.UPDATE_UI) -- for updating statusbar
  end,
  unsplit_all = function() while view:unsplit() do end end,
  grow = function() if view.size then view.size = view.size + 10 end end,
  shrink = function() if view.size then view.size = view.size - 10 end end,
  toggle_current_fold = function()
    local buffer = buffer
    buffer:toggle_fold(buffer:line_from_position(buffer.current_pos))
  end,
  reset_zoom = function() buffer.zoom = 0 end,
  open_webpage = function(url)
    local cmd
    if WIN32 then
      cmd = string.format('start "" "%s"', url)
      local p = io.popen(cmd)
      if not p then error(_L['Error loading webpage:']..url) end
      p:close()
    else
      cmd = string.format(OSX and 'open "file://%s"' or 'xdg-open "%s" &', url)
      local _, _, code = os.execute(cmd)
      if code ~= 0 then error(_L['Error loading webpage:']..url) end
    end
  end,
  cut_to_eol = function()
    _G.buffer:line_end_extend()
    _G.buffer:cut()
  end
}
-- The following buffer functions need to be constantized in order for menu
-- items to identify the key associated with the functions.
local menu_buffer_functions = {
  'undo', 'redo', 'cut', 'copy', 'paste', 'line_duplicate', 'clear',
  'select_all', 'upper_case', 'lower_case', 'move_selected_lines_up',
  'move_selected_lines_down', 'zoom_in', 'zoom_out', 'colourise'
}
local function constantize_menu_buffer_functions()
  local buffer = buffer
  for _, f in ipairs(menu_buffer_functions) do buffer[f] = buffer[f] end
end
events.connect(events.BUFFER_NEW, constantize_menu_buffer_functions)
-- Scintilla's first buffer does not have this.
if not RESETTING then constantize_menu_buffer_functions() end

local keys = keys
local io, gui, gui_find, buffer, view = io, gui, gui.find, buffer, view
local m_textadept, m_editing = _M.textadept, _M.textadept.editing
local m_bookmarks, m_snippets = m_textadept.bookmarks, m_textadept.snippets
local OSX, c = OSX, _SCINTILLA.constants
local utils = M.utils

-- Windows and Linux menu key commands.
--
-- Unassigned keys (~ denotes keys reserved by the operating system):
-- c:   A B C         H              p  Q       ~ V   X Y      ) ] }
-- a:  aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ_   ) ] }  *+-/=\n\s
-- ca: aAbBcCdDeE F      jJkKlLmM N   PqQ    t       xXy zZ_"'()[]{}<>*  /   \s
--
-- CTRL = 'c' (Control ^)
-- ALT = 'a' (Alt)
-- META = [unused]
-- SHIFT = 's' (Shift ⇧)
-- ADD = ''
-- Control, Alt, Shift, and 'a' = 'caA'
-- Control, Alt, Shift, and '\t' = 'cas\t'
--
-- Mac OSX menu key commands.
--
-- Unassigned keys (~ denotes keys reserved by the operating system):
-- m:   A B C        ~    JkK  ~M    p  ~    t  U V   XyY      ) ] }       ~~\n
-- c:      cC D    gG H  J K L    oO  qQ             xXyYzZ_   ) ] }  *  /
-- cm: aAbBcC~DeE F  ~HiIjJkKlL~MnN  pPq~rRsStTuUvVwWxXyYzZ_"'()[]{}<>*+-/=\t\n
--
-- CTRL = 'c' (Control ^)
-- ALT = 'a' (Alt/option ⌥)
-- META = 'm' (Command ⌘)
-- SHIFT = 's' (Shift ⇧)
-- ADD = ''
-- Command, Option, Shift, and 'a' = 'amA'
-- Command, Option, Shift, and '\t' = 'ams\t'
--
-- ncurses key commands.
--
-- The terminal keymap is much more limited and complicated:
--   * Control+[Shift+](digit/symbol) gives limited results.
--     Here are example keymaps for a US English keyboard:
--       Pressing Control+ `1234567890-=[]\;',./
--       Results in c:     @ @ \]^_   __ ]\ g
--       (e.g. `keys.c2` in the GUI would be `keys['c@']` in the terminal.)
--       Notes:
--         * Adding the Shift modifier to any of the above keys gives the same
--           result.
--         * Adding the Alt and/or Shift modifiers to any of the above keys also
--           gives the same result, but with only the Alt modifier being
--           recognized (e.g. `keys['ca$']` would be `keys['ca\']`).
--   * Control+[Alt+]Shift+letter does not report the upper case letter (e.g.
--     `keys.cA` in the GUI would be `keys.ca` in the terminal and similarly,
--     `keys.caA` would be `keys.caa`).
--   * No modifiers are recognized for the function keys (e.g. F1-F12).
--
-- Unassigned keys (~ denotes keys reserved by the operating system):
-- c:        g~~   ~
-- cm:  bcd  g~~ k ~  pq  t v xyz
-- m:          e          J            qQ  sS  u vVw xXyYzZ
-- Note: m[befhstv] may be used by GUI terminals.
--
-- CTRL = 'c' (Control ^)
-- ALT = [unused]
-- META = 'm' (Alt)
-- SHIFT = 's' (Shift ⇧)
-- ADD = ''
-- Control, Meta, and 'a' = 'cma'

-- File.
keys[not OSX and (not NCURSES and 'cn' or 'cmn') or 'mn'] = new_buffer
keys[not OSX and 'co' or 'mo'] = io.open_file
keys[not OSX and not NCURSES and 'cao' or 'cmo'] = io.open_recent_file
keys[not OSX and (not NCURSES and 'cO' or 'mo') or 'mO'] = buffer.reload
keys[not OSX and 'cs' or 'ms'] = buffer.save
keys[not OSX and (not NCURSES and 'cS' or 'cms') or 'mS'] = buffer.save_as
keys[not OSX and 'cw' or 'mw'] = buffer.close
keys[not OSX and (not NCURSES and 'cW' or 'cmw') or 'mW'] = io.close_all
-- TODO: m_textadept.sessions.load
-- TODO: m_textadept.sessions.save
keys[not OSX and 'cq' or 'mq'] = quit

-- Edit.
keys[not OSX and 'cz' or 'mz'] = buffer.undo
if not OSX then keys.cy = buffer.redo end
if not NCURSES then keys[not OSX and 'cZ' or 'mZ'] = buffer.redo end
keys[not OSX and 'cx' or 'mx'] = buffer.cut
keys[not OSX and 'cc' or 'mc'] = buffer.copy
keys[not OSX and 'cv' or 'mv'] = buffer.paste
if not NCURSES then keys[not OSX and 'cd' or 'md'] = buffer.line_duplicate end
keys.del = buffer.clear
keys[not OSX and (not NCURSES and 'adel' or 'mdel')
             or 'cdel'] = utils.delete_word
keys[not OSX and not NCURSES and 'ca' or 'ma'] = buffer.select_all
keys[not NCURSES and 'cm' or 'mm'] = m_editing.match_brace
keys[not OSX and (not NCURSES and 'c\n' or 'cmj')
             or 'cesc'] = {m_editing.autocomplete_word, '%w_'}
if not NCURSES then
  keys[not OSX and 'caH' or 'mH'] = m_editing.highlight_word
end
keys[not OSX and not NCURSES and 'c/' or 'm/'] = m_editing.block_comment
keys.ct = m_editing.transpose_chars
keys[not OSX and (not NCURSES and 'cJ' or 'mj') or 'cj'] = m_editing.join_lines
-- Select.
keys[not NCURSES and 'cM' or 'mM'] = {m_editing.match_brace, 'select'}
keys[not OSX and not NCURSES and 'c<'
                             or 'm<'] = {m_editing.select_enclosed, '>', '<'}
if not NCURSES then
  keys[not OSX and 'c>' or 'm>'] = {m_editing.select_enclosed, '<', '>'}
end
keys[not OSX and not NCURSES and "c'"
                             or "m'"] = {m_editing.select_enclosed, "'", "'"}
keys[not OSX and not NCURSES and 'c"'
                             or 'm"'] = {m_editing.select_enclosed, '"', '"'}
keys[not OSX and not NCURSES and 'c('
                             or 'm('] = {m_editing.select_enclosed, '(', ')'}
keys[not OSX and not NCURSES and 'c['
                             or 'm['] = {m_editing.select_enclosed, '[', ']'}
keys[not OSX and not NCURSES and 'c{'
                             or 'm{'] = {m_editing.select_enclosed, '{', '}'}
keys[not OSX and (not NCURSES and 'cD' or 'mW') or 'mD'] = m_editing.select_word
keys[not OSX and not NCURSES and 'cN' or 'mN'] = m_editing.select_line
keys[not OSX and not NCURSES and 'cP' or 'mP'] = m_editing.select_paragraph
keys[not OSX and not NCURSES and 'cI' or 'mI'] = m_editing.select_indented_block
-- Selection.
keys[not OSX and 'cau' or 'cu'] = buffer.upper_case
keys[not OSX and (not NCURSES and 'caU' or 'cml') or 'cU'] = buffer.lower_case
keys[not OSX and (not NCURSES and 'a<' or 'm>')
             or 'c<'] = utils.enclose_as_xml_tags
if not NCURSES then
  keys[not OSX and 'a>' or 'c>'] = {m_editing.enclose, '<', ' />'}
  keys[not OSX and "a'" or "c'"] = {m_editing.enclose, "'", "'"}
  keys[not OSX and 'a"' or 'c"'] = {m_editing.enclose, '"', '"'}
end
keys[not OSX and (not NCURSES and 'a(' or 'm)')
             or 'c('] = {m_editing.enclose, '(', ')'}
keys[not OSX and (not NCURSES and 'a[' or 'm]')
             or 'c['] = {m_editing.enclose, '[', ']'}
keys[not OSX and (not NCURSES and 'a{' or 'm}')
             or 'c{'] = {m_editing.enclose, '{', '}'}
keys[not OSX and not NCURSES and 'c+' or 'm+'] = {m_editing.grow_selection, 1}
keys[not OSX and not NCURSES and 'c_' or 'm_'] = {m_editing.grow_selection, -1}
keys.csup = buffer.move_selected_lines_up
keys.csdown = buffer.move_selected_lines_down

-- Search.
keys[not OSX and not NCURSES and 'cf' or 'mf'] = gui_find.focus
if NCURSES then keys.mF = keys.mf end -- in case mf is used by GUI terminals
keys[not OSX and not NCURSES and 'cg' or 'mg'] = gui_find.find_next
if not OSX and not NCURSES then keys.f3 = keys.cg end
keys[not OSX and not NCURSES and 'cG' or 'mG'] = gui_find.find_prev
if not OSX and not NCURSES then keys.sf3 = keys.cG end
keys[not OSX and (not NCURSES and 'car' or 'mr') or 'cr'] = gui_find.replace
keys[not OSX and (not NCURSES and 'caR' or 'mR') or 'cR'] = gui_find.replace_all
-- Find Next is an when find pane is focused in GUI.
-- Find Prev is ap when find pane is focused in GUI.
-- Replace is ar when find pane is focused in GUI.
-- Replace All is aa when find pane is focused in GUI.
keys[not OSX and not NCURSES and 'caf' or 'cmf'] = gui_find.find_incremental
if not NCURSES then keys[not OSX and 'cF' or 'mF'] = utils.find_in_files end
-- Find in Files is ai when find pane is focused in GUI.
if not NCURSES then
  keys[not OSX and 'cag' or 'cmg'] = {gui_find.goto_file_in_list, true}
  keys[not OSX and 'caG' or 'cmG'] = {gui_find.goto_file_in_list, false}
end
keys[not OSX and 'cj' or 'mj'] = m_editing.goto_line

-- Tools.
keys[not OSX and (not NCURSES and 'ce' or 'mc')
             or 'me'] = gui.command_entry.focus
keys[not OSX and (not NCURSES and 'cE' or 'mC')
             or 'mE'] = utils.select_command
keys[not OSX and 'cr' or 'mr'] = m_textadept.run.run
keys[not OSX and (not NCURSES and 'cR' or 'cmr')
             or 'mR'] = m_textadept.run.compile
keys[not OSX and (not NCURSES and 'c|' or 'c\\')
             or 'm|'] = m_textadept.filter_through.filter_through
-- Adeptsense.
keys[not OSX and (not NCURSES and 'c ' or 'c@')
             or 'aesc'] = m_textadept.adeptsense.complete
keys[not NCURSES and 'ch' or 'mh'] = m_textadept.adeptsense.show_apidoc
if NCURSES then keys.mH = keys.mh end -- in case mh is used by GUI terminals
-- Snippets.
keys[not OSX and (not NCURSES and 'ck' or 'mk') or 'a\t'] = m_snippets._select
keys['\t'] = m_snippets._insert
keys['s\t'] = m_snippets._previous
keys[not OSX and (not NCURSES and 'cK' or 'mK')
             or 'as\t'] = m_snippets._cancel_current
-- Bookmark.
keys[not OSX and (not NCURSES and 'cf2' or 'f1') or 'mf2'] = m_bookmarks.toggle
keys[not OSX and (not NCURSES and 'csf2' or 'f6') or 'msf2'] = m_bookmarks.clear
keys.f2 = m_bookmarks.goto_next
keys[not NCURSES and 'sf2' or 'f3'] = m_bookmarks.goto_prev
keys[not NCURSES and 'af2' or 'f4'] = m_bookmarks.goto_bookmark
-- Snapopen.
keys[not OSX and 'cu' or 'mu'] = {m_textadept.snapopen.open, _USERHOME}
-- TODO: {m_textadept.snapopen.open, _HOME}
keys[not OSX and (not NCURSES and 'caO' or 'mO')
             or 'cmO'] = utils.snapopen_filedir
if not NCURSES then keys[not OSX and 'ci' or 'mi'] = utils.show_style end

-- Buffer.
keys[not NCURSES and 'c\t' or 'mn'] = {view.goto_buffer, view, 1, true}
keys[not NCURSES and 'cs\t' or 'mp'] = {view.goto_buffer, view, -1, true}
keys[not OSX and not NCURSES and 'cb' or 'mb'] = gui.switch_buffer
if NCURSES then keys.mB = keys.mb end -- in case mb is used by GUI terminals
-- Indentation.
-- TODO: {utils.set_indentation, 2}
-- TODO: {utils.set_indentation, 3}
-- TODO: {utils.set_indentation, 4}
-- TODO: {utils.set_indentation, 8}
keys[not OSX and (not NCURSES and 'caT' or 'mt')
             or 'cT'] = {utils.toggle_property, 'use_tabs'}
if NCURSES then keys.mT = keys.mt end -- in case mt is used by GUI terminals
keys[not OSX and (not NCURSES and 'cai' or 'mi')
             or 'ci'] = m_editing.convert_indentation
-- EOL Mode.
-- TODO: {utils.set_eol_mode, c.SC_EOL_CRLF}
-- TODO: {utils.set_eol_mode, c.SC_EOL_CR}
-- TODO: {utils.set_eol_mode, c.SC_EOL_LF}
-- Encoding.
-- TODO: {utils.set_encoding, 'UTF-8'}
-- TODO: {utils.set_encoding, 'ASCII'}
-- TODO: {utils.set_encoding, 'ISO-8859-1'}
-- TODO: {utils.set_encoding, 'MacRoman'}
-- TODO: {utils.set_encoding, 'UTF-16LE'}
keys[not OSX and not NCURSES and 'cL'
                             or 'mL'] = m_textadept.mime_types.select_lexer
keys.f5 = {buffer.colourise, buffer, 0, -1}
if NCURSES then keys.cl = keys.f5 end

-- View.
if not NCURSES then
  keys[not OSX and 'can' or 'ca\t'] = {gui.goto_view, 1, true}
  keys[not OSX and 'cap' or 'cas\t'] = {gui.goto_view, -1, true}
  keys[not OSX and 'cas' or 'cs'] = {view.split, view}
  if not OSX then keys.cah = keys.cas end
  keys[not OSX and 'cav' or 'cv'] = {view.split, view, true}
  keys[not OSX and 'caw' or 'cw'] = {view.unsplit, view}
  keys[not OSX and 'caW' or 'cW'] = utils.unsplit_all
  keys[not OSX and 'ca+' or 'c+'] = {utils.grow, 10}
  keys[not OSX and 'ca=' or 'c='] = {utils.grow, 10}
  keys[not OSX and 'ca-' or 'c-'] = {utils.shrink, 10}
end
keys[not OSX and not NCURSES and 'c*' or 'm*'] = utils.toggle_current_fold
if not NCURSES then
  keys[not OSX and 'ca\n' or 'c\n'] = {utils.toggle_property, 'view_eol'}
  if not OSX then keys['ca\n\r'] = keys['ca\n'] end
  keys[not OSX and 'ca\\' or 'c\\'] = {utils.toggle_property, 'wrap_mode'}
  keys[not OSX and 'caI' or 'cI'] =
    {utils.toggle_property, 'indentation_guides'}
  keys[not OSX and 'caS' or 'cS'] = {utils.toggle_property, 'view_ws'}
  keys[not OSX and 'caV' or 'cV'] =
    {utils.toggle_property, 'virtual_space_options', c.SCVS_USERACCESSIBLE}
end
keys[not OSX and not NCURSES and 'c=' or 'm='] = buffer.zoom_in
keys[not OSX and not NCURSES and 'c-' or 'm-'] = buffer.zoom_out
keys[not OSX and not NCURSES and 'c0' or 'm0'] = utils.reset_zoom
if not NCURSES then keys[not OSX and 'cT' or 'mT'] = gui.select_theme end

-- Help.
if not NCURSES then
  keys.f1 = {utils.open_webpage, _HOME..'/doc/01_Introduction.html'}
  keys.sf1 = {utils.open_webpage, _HOME..'/doc/api/index.html'}
end
-- TODO: {gui.dialog, 'ok-msgbox', '--title', 'Textadept', '--informative-text',
--        _RELEASE, '--button1', _L['_OK'], '--no-cancel'}

-- Movement commands.
if OSX then
  keys.cf, keys.cF = buffer.char_right, buffer.char_right_extend
  keys.cmf, keys.cmF = buffer.word_right, buffer.word_right_extend
  keys.cb, keys.cB = buffer.char_left, buffer.char_left_extend
  keys.cmb, keys.cmB = buffer.word_left, buffer.word_left_extend
  keys.cn, keys.cN = buffer.line_down, buffer.line_down_extend
  keys.cp, keys.cP = buffer.line_up, buffer.line_up_extend
  keys.ca, keys.cA = buffer.vc_home, buffer.vc_home_extend
  keys.ce, keys.cE = buffer.line_end, buffer.line_end_extend
  keys.aright, keys.aleft = buffer.word_right, buffer.word_left
  keys.cd = buffer.clear
  keys.ck = utils.cut_to_eol
  keys.cl = buffer.vertical_centre_caret
  -- GTKOSX reports Fn-key as a single keycode which confuses Scintilla. Do
  -- not propagate it.
  keys.fn = function() return true end
elseif NCURSES then
  local mark_mode = false
  local function move(s) buffer[mark_mode and s..'_extend' or s](_G.buffer) end

  keys['c^'] = function() mark_mode = not mark_mode end
  keys['c]'] = buffer.swap_main_anchor_caret
  keys.cf, keys.cb = {move, 'char_right'}, {move, 'char_left'}
  keys.cn, keys.cp = {move, 'line_down'}, {move, 'line_up'}
  keys.ca, keys.ce = {move, 'vc_home'}, {move, 'line_end'}
  keys.mA, keys.mE = buffer.vc_home_extend, buffer.line_end_extend
  keys.right, keys.cright = keys.cf, {move, 'word_right'}
  keys.left, keys.cleft = keys.cb, {move, 'word_left'}
  keys.down, keys.up = keys.cn, keys.cp
  keys.home, keys['end'] = keys.ca, keys.ce
  keys.pgup, keys.mU = {move, 'page_up'}, buffer.page_up_extend
  keys.pgdn, keys.mD = {move, 'page_down'}, buffer.page_down_extend
  keys.cma = {move, 'document_start'}
  keys.cme = {move, 'document_end'}
  keys.cd, keys.md = buffer.clear, utils.delete_word
  keys.ck = utils.cut_to_eol

  local INS_OR_DEL = _SCINTILLA.constants.SC_MOD_INSERTTEXT +
                     _SCINTILLA.constants.SC_MOD_DELETETEXT
  events.connect(events.BUFFER_NEW,
                 function() _G.buffer.mod_event_mask = INS_OR_DEL end)
  -- Scintilla's first buffer does not have this.
  if not RESETTING then _G.buffer.mod_event_mask = INS_OR_DEL end

  local bit32_band = bit32.band
  -- Inserting or deleting text should cancel mark mode.
  events.connect(events.MODIFIED, function(modification_type)
    mark_mode = mark_mode and bit32_band(modification_type, INS_OR_DEL) == 0
  end)
end

return M