diff options
Diffstat (limited to 'core/ui.lua')
| -rw-r--r-- | core/ui.lua | 456 |
1 files changed, 456 insertions, 0 deletions
diff --git a/core/ui.lua b/core/ui.lua new file mode 100644 index 00000000..392b961f --- /dev/null +++ b/core/ui.lua @@ -0,0 +1,456 @@ +-- Copyright 2007-2013 Mitchell mitchell.att.foicica.com. See LICENSE. + +local ui = ui + +--[[ This comment is for LuaDoc. +--- +-- Utilities for interacting with Textadept's user interface. +-- @field title (string, Write-only) +-- The title of the Textadept window. +-- @field context_menu +-- The editor's context menu, a [`ui.menu()`](#menu). +-- This is a low-level field. You probably want to use the higher-level +-- `_M.textadept.menu.set_contextmenu()`. +-- @field clipboard_text (string, Read-only) +-- The text on the clipboard. +-- @field statusbar_text (string, Write-only) +-- The text displayed by the statusbar. +-- @field docstatusbar_text (string, Write-only) +-- The text displayed by the buffer statusbar. +-- @field maximized (bool) +-- Whether or not the Textadept window is maximized. +module('ui')]] + +local theme = package.searchpath(not CURSES and 'light' or 'term', + _USERHOME..'/themes/?.lua;'.. + _HOME..'/themes/?.lua') +local theme_props = {} + +-- Helper function for printing messages to buffers. +-- @see ui._print +local function _print(buffer_type, ...) + if buffer._type ~= buffer_type then + for i, view in ipairs(_VIEWS) do + if view.buffer._type == buffer_type then ui.goto_view(i) break end + end + if view.buffer._type ~= buffer_type then + view:split() + for i, buffer in ipairs(_BUFFERS) do + if buffer._type == buffer_type then view:goto_buffer(i) break end + end + if buffer._type ~= buffer_type then + buffer.new()._type = buffer_type + events.emit(events.FILE_OPENED) + end + end + end + local args, n = {...}, select('#', ...) + for i = 1, n do args[i] = tostring(args[i]) end + buffer:append_text(table.concat(args, '\t')) + buffer:append_text('\n') + buffer:goto_pos(buffer.length) + buffer:set_save_point() +end +--- +-- Helper function for printing messages to buffers. +-- Splits the view and opens a new buffer for printing messages to. If the +-- message buffer is already open in a view, the message is printed to that +-- view. Otherwise the view is split and the message buffer is opened or +-- displayed before being printed to. +-- @param buffer_type String type of message buffer. +-- @param ... Message strings. +-- @usage ui._print(_L['[Message Buffer]'], message) +-- @name _print +function ui._print(buffer_type, ...) pcall(_print, buffer_type, ...) end + +--- +-- Prints messages to the Textadept message buffer. +-- Opens a new buffer if one has not already been opened for printing messages. +-- @param ... Message strings. +-- @name print +function ui.print(...) ui._print(_L['[Message Buffer]'], ...) end + +--- +-- Convenience function for `ui.dialog('filteredlist', ...)` with "Ok" and +-- "Cancel" buttons that returns the text or index of the selection depending on +-- the boolean value of *int_return*. +-- *title* is the title of the dialog, *columns* is a list of column names, and +-- *items* is a list of items to show. +-- @param title The title for the filtered list dialog. +-- @param columns A column name or list of column names. +-- @param items An item or list of items. +-- @param int_return Optional flag indicating whether to return the integer +-- index of the selected item in the filtered list or the string selected +-- item. A `true` value is not compatible with the `'--select-multiple'` +-- option. The default value is `false`. +-- @param ... Optional additional parameters to pass to `ui.dialog()`. +-- @return Either a string or integer on success; `nil` otherwise. In strings, +-- multiple items are separated by newlines. +-- @usage ui.filteredlist('Title', 'Foo', {'Bar', 'Baz'}) +-- @usage ui.filteredlist('Title', {'Foo', 'Bar'}, {'a', 'b', 'c', 'd'}, false, +-- '--output-column', '2') +-- @see dialog +-- @name filteredlist +function ui.filteredlist(title, columns, items, int_return, ...) + local out = ui.dialog('filteredlist', + '--title', title, + '--button1', _L['_OK'], + '--button2', _L['_Cancel'], + '--no-newline', + int_return and '' or '--string-output', + '--columns', columns, + '--items', items, + ...) + local patt = int_return and '^(%-?%d+)\n(%d+)$' or '^([^\n]+)\n(.+)$' + local response, value = out:match(patt) + if response == (int_return and '1' or _L['_OK']) then + return not int_return and value or tonumber(value) + end +end + +--- +-- Prompts the user to select a buffer to switch to. +-- @name switch_buffer +function ui.switch_buffer() + local columns, items = {_L['Name'], _L['File']}, {} + for _, buffer in ipairs(_BUFFERS) do + local filename = buffer.filename or buffer._type or _L['Untitled'] + local basename = buffer.filename and filename:match('[^/\\]+$') or filename + items[#items + 1] = (buffer.dirty and '*' or '')..basename + items[#items + 1] = filename + end + local i = ui.filteredlist(_L['Switch Buffers'], columns, items, true, + CURSES and {'--width', ui.size[1] - 2} or '--') + if i then view:goto_buffer(i + 1) end +end + +--- +-- Goes to the buffer whose filename is *filename* in an existing view, +-- otherwise splitting the current view if *split* is `true` or going to the +-- next or *preferred_view* view instead of staying in the current one. +-- If *sloppy* is `true`, only the last part of *filename* is matched to a +-- buffer's `filename`. +-- @param filename The filename of the buffer to go to. +-- @param split Optional flag indicating whether or not to open the buffer in a +-- split view if there is only one view. The default value is `false`. +-- @param preferred_view Optional view to open the desired buffer in if the +-- buffer is not visible in any other view. +-- @param sloppy Optional flag indicating whether or not to not match *filename* +-- to `buffer.filename` exactly. When `true`, matches *filename* to only the +-- last part of `buffer.filename` This is useful for run and compile commands +-- which output relative filenames and paths instead of full ones and it is +-- likely that the file in question is already open. The default value is +-- `false`. +-- @name goto_file +function ui.goto_file(filename, split, preferred_view, sloppy) + local patt = '^'..filename..'$' + if sloppy then + local i = filename:reverse():find('[/\\]%.%.?') -- ./ or ../ + patt = i and filename:sub(-i + 1, -1)..'$' or filename..'$' + end + if #_VIEWS == 1 and split and not (view.buffer.filename or ''):find(patt) then + view:split() + else + local other_view = _VIEWS[preferred_view] + for i, v in ipairs(_VIEWS) do + if (v.buffer.filename or ''):find(patt) then ui.goto_view(i) return end + if not other_view and v ~= view then other_view = i end + end + if other_view then ui.goto_view(other_view) end + end + for i, buffer in ipairs(_BUFFERS) do + if (buffer.filename or ''):find(patt) then view:goto_buffer(i) return end + end + io.open_file(filename) +end + +--- +-- Sets the editor theme name to *name* and optionally sets key-value pair +-- argument properties. +-- User themes override Textadept's default themes when they have the same name. +-- If *name* contains slashes, it is assumed to be an absolute path to a theme +-- instead of a theme name. +-- @param name The name or absolute path of a theme to set. +-- @param ... Optional key-value argument pairs for theme properties to set. +-- These override the theme's defaults. +-- @usage ui.set_theme('light', 'font', 'Monospace', 'fontsize', 12) +-- @name set_theme +function ui.set_theme(name, ...) + if not name then return end + name = name:find('[/\\]') and name or + package.searchpath(name, _USERHOME..'/themes/?.lua;'.. + _HOME..'/themes/?.lua') + if not name or not lfs.attributes(name) then return end + local props = {...} + local current_buffer, current_view = _BUFFERS[buffer], _VIEWS[view] + for i = 1, #_BUFFERS do + view:goto_buffer(i) + dofile(name) + for j = 1, #props, 2 do buffer.property[props[j]] = props[j + 1] end + end + view:goto_buffer(current_buffer) + for i = 1, #_VIEWS do + ui.goto_view(i) + dofile(name) + for j = 1, #props, 2 do buffer.property[props[j]] = props[j + 1] end + end + ui.goto_view(current_view) + theme, theme_props = name, props +end + +local events, events_connect = events, events.connect + +-- Loads the theme and properties files. +local function load_theme_and_settings() + dofile(theme) + local props = theme_props + for i = 1, #props, 2 do buffer.property[props[i]] = props[i + 1] end + dofile(_HOME..'/properties.lua') + if lfs.attributes(_USERHOME..'/properties.lua') then + dofile(_USERHOME..'/properties.lua') + end +end + +-- Sets default properties for a Scintilla window. +events_connect(events.VIEW_NEW, function() + local buffer = buffer + -- Allow redefinitions of these Scintilla key commands. + local ctrl_keys = { + '[', ']', '/', '\\', 'Z', 'Y', 'X', 'C', 'V', 'A', 'L', 'T', 'D', 'U' + } + local ctrl_shift_keys = {'L', 'T', 'U', 'Z'} + for _, key in ipairs(ctrl_keys) do + buffer:clear_cmd_key(string.byte(key), buffer.SCMOD_CTRL) + end + for _, key in ipairs(ctrl_shift_keys) do + buffer:clear_cmd_key(string.byte(key), + buffer.SCMOD_CTRL + buffer.SCMOD_SHIFT) + end + -- Since BUFFER_NEW loads themes and settings on startup, only load them for + -- subsequent views. + if #_VIEWS > 1 then load_theme_and_settings() end +end) +events_connect(events.VIEW_NEW, function() events.emit(events.UPDATE_UI) end) + +local SETDIRECTFUNCTION = _SCINTILLA.properties.direct_function[1] +local SETDIRECTPOINTER = _SCINTILLA.properties.doc_pointer[2] +local SETLEXERLANGUAGE = _SCINTILLA.properties.lexer_language[2] +-- Sets default properties for a Scintilla document. +events_connect(events.BUFFER_NEW, function() + buffer.code_page = buffer.SC_CP_UTF8 + buffer.style_bits = 8 + buffer.lexer_language = 'lpeg' + buffer:private_lexer_call(SETDIRECTFUNCTION, buffer.direct_function) + buffer:private_lexer_call(SETDIRECTPOINTER, buffer.direct_pointer) + buffer.property['lexer.lpeg.home'] = _USERHOME..'/lexers/?.lua;'.. + _HOME..'/lexers' + load_theme_and_settings() + buffer:private_lexer_call(SETLEXERLANGUAGE, 'text') +end) + +-- Sets the title of the Textadept window to the buffer's filename. +-- @param buffer The global buffer. +local function set_title() + local filename = buffer.filename or buffer._type or _L['Untitled'] + local basename = buffer.filename and filename:match('[^/\\]+$') or filename + ui.title = string.format('%s %s Textadept (%s)', basename, + buffer.dirty and '*' or '-', filename) +end + +-- Changes Textadept title to show the buffer as being "clean". +events_connect(events.SAVE_POINT_REACHED, function() + buffer.dirty = false + set_title() +end) + +-- Changes Textadept title to show thee buffer as "dirty". +events_connect(events.SAVE_POINT_LEFT, function() + buffer.dirty = true + set_title() +end) + +-- Open uri(s). +events_connect(events.URI_DROPPED, function(utf8_uris) + for utf8_uri in utf8_uris:gmatch('[^\r\n]+') do + if utf8_uri:find('^file://') then + utf8_uri = utf8_uri:match('^file://([^\r\n]+)') + utf8_uri = utf8_uri:gsub('%%(%x%x)', function(hex) + return string.char(tonumber(hex, 16)) + end) + if WIN32 then utf8_uri = utf8_uri:sub(2, -1) end -- ignore leading '/' + local mode = lfs.attributes(utf8_uri:iconv(_CHARSET, 'UTF-8'), 'mode') + if mode and mode ~= 'directory' then io.open_file(utf8_uri) end + end + end +end) +events_connect(events.APPLEEVENT_ODOC, function(uri) + return events.emit(events.URI_DROPPED, 'file://'..uri) +end) + +local EOLs = {_L['CRLF'], _L['CR'], _L['LF']} +local GETLEXERLANGUAGE = _SCINTILLA.properties.lexer_language[1] +-- Sets docstatusbar text. +events_connect(events.UPDATE_UI, function() + local pos = buffer.current_pos + local line, max = buffer:line_from_position(pos) + 1, buffer.line_count + local col = buffer.column[pos] + 1 + local lexer = buffer:private_lexer_call(GETLEXERLANGUAGE):match('^[^/]+') + local eol = EOLs[buffer.eol_mode + 1] + local tabs = string.format('%s %d', buffer.use_tabs and _L['Tabs:'] or + _L['Spaces:'], buffer.tab_width) + local enc = buffer.encoding or '' + local text = not CURSES and '%s %d/%d %s %d %s %s %s %s' or + '%s %d/%d %s %d %s %s %s %s' + ui.docstatusbar_text = string.format(text, _L['Line:'], line, max, _L['Col:'], + col, lexer, eol, tabs, enc) +end) + +-- Updates the statusbar and titlebar for a new Scintilla document. +events_connect(events.BUFFER_NEW, function() events.emit(events.UPDATE_UI) end) +events_connect(events.BUFFER_NEW, function() set_title() end) + +-- Save buffer properties. +events_connect(events.BUFFER_BEFORE_SWITCH, function() + local buffer = buffer + -- Save view state. + buffer._anchor, buffer._current_pos = buffer.anchor, buffer.current_pos + buffer._first_visible_line = buffer.first_visible_line + -- Save fold state. + buffer._folds = {} + local folds, i = buffer._folds, buffer:contracted_fold_next(0) + while i >= 0 do + folds[#folds + 1], i = i, buffer:contracted_fold_next(i + 1) + end +end) + +-- Restore buffer properties. +events_connect(events.BUFFER_AFTER_SWITCH, function() + local buffer = buffer + if not buffer._folds then return end + -- Restore fold state. + for i = 1, #buffer._folds do buffer:toggle_fold(buffer._folds[i]) end + -- Restore view state. + buffer:set_sel(buffer._anchor, buffer._current_pos) + buffer:line_scroll(0, + buffer:visible_from_doc_line(buffer._first_visible_line) - + buffer.first_visible_line) +end) + +-- Updates titlebar and statusbar. +events_connect(events.BUFFER_AFTER_SWITCH, function() + set_title() + buffer:private_lexer_call(SETDIRECTPOINTER, buffer.direct_pointer) + events.emit(events.UPDATE_UI) +end) + +-- Updates titlebar and statusbar. +events_connect(events.VIEW_AFTER_SWITCH, function() + set_title() + events.emit(events.UPDATE_UI) +end) + +events_connect(events.RESET_AFTER, + function() ui.statusbar_text = 'Lua reset' end) + +-- Prompts for confirmation if any buffers are dirty. +events_connect(events.QUIT, function() + local list = {} + for _, buffer in ipairs(_BUFFERS) do + if buffer.dirty then + list[#list + 1] = buffer.filename or buffer._type or _L['Untitled'] + end + end + return #list < 1 or ui.dialog('msgbox', + '--title', _L['Quit without saving?'], + '--text', + _L['The following buffers are unsaved:'], + '--informative-text', table.concat(list, '\n'), + '--icon', 'gtk-dialog-question', + '--button1', _L['_Cancel'], + '--button2', _L['Quit _without saving'], + '--no-newline') == '2' +end) + +events_connect(events.ERROR, ui.print) + +--[[ The tables below were defined in C. + +--- +-- A table of menus defining a menubar. (Write-only) +-- @see _M.textadept.menu.set_menubar +-- @class table +-- @name menubar +local menubar + +--- +-- A table containing the width and height values of the Textadept window. +-- @class table +-- @name size +local size + +The functions below are Lua C functions. + +--- +-- Displays a *kind* [gtdialog][] with the given string arguments to pass to +-- the dialog and returns a formatted string of the dialog's output. +-- Table arguments containing strings are allowed and expanded in place. This is +-- useful for filtered list dialogs with many items. +-- For more information on gtdialog, see [http://foicica.com/gtdialog][]. +-- +-- [gtdialog]: http://foicica.com/gtdialog/02_Usage.html +-- [http://foicica.com/gtdialog]: http://foicica.com/gtdialog +-- @param kind The kind of gtdialog. +-- @param ... Parameters to the gtdialog. +-- @return string gtdialog result. +-- @class function +-- @name dialog +local dialog + +--- +-- Returns the current split view structure. +-- This is primarily used in session saving. +-- @return table of split views. Each split view entry is a table with 4 +-- fields: `1`, `2`, `vertical`, and `size`. `1` and `2` have values of either +-- nested split view entries or the views themselves; `vertical` is a flag +-- indicating if the split is vertical or not; and `size` is the integer +-- position of the split resizer. +-- @class function +-- @name get_split_table +local get_split_table + +--- +-- Goes to view number *n*. +-- If *relative* is `true`, *n* is an index relative to the index of the current +-- view in `_G._VIEWS` instead of an absolute index. +-- Emits `VIEW_BEFORE_SWITCH` and `VIEW_AFTER_SWITCH` events. +-- @param n A relative or absolute view index in `_G._VIEWS`. +-- @param relative Optional flag indicating whether *n* is a relative or +-- absolute index. The default value is `false`, for an absolute index. +-- @see _G._G._VIEWS +-- @see events.VIEW_BEFORE_SWITCH +-- @see events.VIEW_AFTER_SWITCH +-- @class function +-- @name goto_view +local goto_view + +--- +-- Low-level function for creating a menu from table *menu_table* and returning +-- the userdata. +-- You probably want to use the higher-level `_M.textadept.menu.set_menubar()` +-- or `_M.textadept.menu.set_contextmenu()` functions. Emits a `MENU_CLICKED` +-- event when a menu item is selected. +-- @param menu_table A table defining the menu. It is an ordered list of tables +-- with a string menu item, integer menu ID, and optional GDK keycode and +-- modifier mask. The latter two are used to display key shortcuts in the +-- menu. '_' characters are treated as a menu mnemonics. If the menu item is +-- empty, a menu separator item is created. Submenus are just nested +-- menu-structure tables. Their title text is defined with a `title` key. +-- @usage ui.menu{{'_New', 1}, {'_Open', 2}, {''}, {'_Quit', 4}} +-- @usage ui.menu{{'_New', 1, string.byte('n'), 4}} -- 'Ctrl+N' +-- @see events.MENU_CLICKED +-- @see _M.textadept.menu.set_menubar +-- @see _M.textadept.menu.set_contextmenu +-- @class function +-- @name menu +local menu +]] |