diff options
Diffstat (limited to 'modules/textadept/snippets.lua')
| -rw-r--r-- | modules/textadept/snippets.lua | 334 |
1 files changed, 154 insertions, 180 deletions
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index 40d2febb..e900f2b4 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -8,57 +8,53 @@ local M = {} -- -- ### Overview -- --- Define snippets in the global `snippets` table in key-value pairs. Each pair --- consists of either a string trigger word and its snippet text, or a string --- lexer name (from the *lexers/* directory) with a table of trigger words and --- snippet texts. When searching for a snippet to insert based on a trigger --- word, Textadept considers snippets in the current lexer to have priority, --- followed by the ones in the global table. This means if there are two --- snippets with the same trigger word, Textadept inserts the one specific to --- the current lexer, not the global one. +-- Define snippets in the global `snippets` table in key-value pairs. Each pair consists of +-- either a string trigger word and its snippet text, or a string lexer name (from the *lexers/* +-- directory) with a table of trigger words and snippet texts. When searching for a snippet to +-- insert based on a trigger word, Textadept considers snippets in the current lexer to have +-- priority, followed by the ones in the global table. This means if there are two snippets +-- with the same trigger word, Textadept inserts the one specific to the current lexer, not +-- the global one. -- -- ### Special Sequences -- -- #### `%`*n*`(`*text*`)` -- --- Represents a placeholder, where *n* is an integer and *text* is default --- placeholder text. Textadept moves the caret to placeholders in numeric order --- each time it calls [`textadept.snippets.insert()`](), finishing at either --- the "%0" placeholder if it exists or at the end of the snippet. Examples are +-- Represents a placeholder, where *n* is an integer and *text* is default placeholder +-- text. Textadept moves the caret to placeholders in numeric order each time it calls +-- [`textadept.snippets.insert()`](), finishing at either the "%0" placeholder if it exists or +-- at the end of the snippet. Examples are -- -- snippets['foo'] = 'foobar%1(baz)' -- snippets['bar'] = 'start\n\t%0\nend' -- -- #### `%`*n*`{`*list*`}` -- --- Also represents a placeholder (where *n* is an integer), but presents a list --- of choices for placeholder text constructed from comma-separated *list*. --- Examples are +-- Also represents a placeholder (where *n* is an integer), but presents a list of choices for +-- placeholder text constructed from comma-separated *list*. Examples are -- -- snippets['op'] = 'operator(%1(1), %2(1), "%3{add,sub,mul,div}")' -- -- #### `%`*n* -- --- Represents a mirror, where *n* is an integer. Mirrors with the same *n* as a --- placeholder mirror any user input in the placeholder. If no placeholder --- exists for *n*, the first occurrence of that mirror in the snippet becomes --- the placeholder, but with no default text. Examples are +-- Represents a mirror, where *n* is an integer. Mirrors with the same *n* as a placeholder mirror +-- any user input in the placeholder. If no placeholder exists for *n*, the first occurrence +-- of that mirror in the snippet becomes the placeholder, but with no default text. Examples are -- -- snippets['foo'] = '%1(mirror), %1, on the wall' -- snippets['q'] = '"%1"' -- -- #### `%`*n*`<`*Lua code*`>`<br/>`%`*n*`[`*Shell code*`]` -- --- Represents a transform, where *n* is an integer that has an associated --- placeholder, *Lua code* is arbitrary Lua code, and *Shell code* is arbitrary --- Shell code. Textadept executes the code as text is typed into placeholder --- *n*. If the transform omits *n*, Textadept executes the transform's code the --- moment the editor inserts the snippet. +-- Represents a transform, where *n* is an integer that has an associated placeholder, *Lua code* +-- is arbitrary Lua code, and *Shell code* is arbitrary Shell code. Textadept executes the code +-- as text is typed into placeholder *n*. If the transform omits *n*, Textadept executes the +-- transform's code the moment the editor inserts the snippet. -- --- Textadept runs Lua code in its Lua State and replaces the transform with the --- code's return text. The code may use the temporary `text` and `selected_text` --- global variables which contain placeholder *n*'s text and the text originally --- selected when the snippet was inserted, respectively. An example is +-- Textadept runs Lua code in its Lua State and replaces the transform with the code's return +-- text. The code may use the temporary `text` and `selected_text` global variables which +-- contain placeholder *n*'s text and the text originally selected when the snippet was inserted, +-- respectively. An example is -- -- snippets['attr'] = [[ -- %1(int) %2(foo) = %3; @@ -71,29 +67,27 @@ local M = {} -- } -- ]] -- --- Textadept executes shell code using Lua's [`io.popen()`][] and replaces the --- transform with the process' standard output (stdout). The code may use a `%` --- character to represent placeholder *n*'s text. An example is +-- Textadept executes shell code using Lua's [`io.popen()`][] and replaces the transform with the +-- process' standard output (stdout). The code may use a `%` character to represent placeholder +-- *n*'s text. An example is -- -- snippets['env'] = '$%1(HOME) = %1[echo $%]' -- -- #### `%%` -- --- Stands for a single '%' since '%' by itself has a special meaning in --- snippets. +-- Stands for a single '%' since '%' by itself has a special meaning in snippets. -- -- #### `%(`<br/>`%{` -- --- Stands for a single '(' or '{', respectively, after a `%`*n* mirror. --- Otherwise, the mirror would be interpreted as a placeholder or transform. --- Note: it is currently not possible to escape a '<' or '[' immediately after --- a `%`*n* mirror due to `%<...>` and `%[...]` sequences being interpreted as --- code to execute. +-- Stands for a single '(' or '{', respectively, after a `%`*n* mirror. Otherwise, the mirror +-- would be interpreted as a placeholder or transform. Note: it is currently not possible to +-- escape a '<' or '[' immediately after a `%`*n* mirror due to `%<...>` and `%[...]` sequences +-- being interpreted as code to execute. -- -- #### `\t` -- --- A single unit of indentation based on the buffer's indentation settings --- ([`buffer.use_tabs`]() and [`buffer.tab_width`]()). +-- A single unit of indentation based on the buffer's indentation settings ([`buffer.use_tabs`]() +-- and [`buffer.tab_width`]()). -- -- #### `\n` -- @@ -112,12 +106,12 @@ M.INDIC_PLACEHOLDER = _SCINTILLA.next_indic_number() --- -- List of directory paths to look for snippet files in. --- Filenames are of the form *lexer.trigger.ext* or *trigger.ext* (*.ext* is an --- optional, arbitrary file extension). If the global `snippets` table does not --- contain a snippet for a given trigger, this table is consulted for a matching --- filename, and the contents of that file is inserted as a snippet. --- Note: If a directory has multiple snippets with the same trigger, the snippet --- chosen for insertion is not defined and may not be constant. +-- Filenames are of the form *lexer.trigger.ext* or *trigger.ext* (*.ext* is an optional, +-- arbitrary file extension). If the global `snippets` table does not contain a snippet for +-- a given trigger, this table is consulted for a matching filename, and the contents of that +-- file is inserted as a snippet. +-- Note: If a directory has multiple snippets with the same trigger, the snippet chosen for +-- insertion is not defined and may not be constant. -- @class table -- @name paths M.paths = {} @@ -125,37 +119,35 @@ M.paths = {} local INDIC_SNIPPET = _SCINTILLA.next_indic_number() local INDIC_CURRENTPLACEHOLDER = _SCINTILLA.next_indic_number() - --- Map of snippet triggers with their snippet text or functions that return such --- text, with language-specific snippets tables assigned to a lexer name key. +-- LuaFormatter off +-- Map of snippet triggers with their snippet text or functions that return such text, with +-- language-specific snippets tables assigned to a lexer name key. -- @class table -- @name snippets -- @see _G.snippets local snippets = {actionscript={},ada={},apdl={},ansi_c={},antlr={},apl={},applescript={},asp={},autoit={},awk={},b_lang={},bash={},batch={},bibtex={},boo={},chuck={},clojure={},cmake={},coffeescript={},context={},cpp={},crystal={},csharp={},css={},cuda={},desktop={},django={},dmd={},dockerfile={},dot={},eiffel={},elixir={},elm={},erlang={},fantom={},faust={},fennel={},fish={},forth={},fortran={},fsharp={},fstab={},gap={},gettext={},gherkin={},glsl={},gnuplot={},go={},groovy={},gtkrc={},haskell={},html={},icon={},idl={},inform={},ini={},Io={},java={},javascript={},jq={},json={},jsp={},julia={},latex={},ledger={},less={},lilypond={},lisp={},logtalk={},lua={},makefile={},matlab={},meson={},moonscript={},myrddin={},nemerle={},networkd={},nim={},nsis={},objective_c={},pascal={},perl={},php={},pico8={},pike={},pkgbuild={},pony={},prolog={},props={},protobuf={},ps={},pure={},python={},rails={},rc={},reason={},rebol={},rest={},rexx={},rhtml={},routeros={},rstats={},ruby={},rust={},sass={},scala={},scheme={},smalltalk={},sml={},snobol4={},spin={},sql={},systemd={},tcl={},tex={},text={},toml={},typescript={},vala={},vb={},vbscript={},verilog={},vhdl={},wsf={},xml={},xs={},xtend={},yaml={},zig={}} - --- Finds the snippet assigned to the trigger word behind the caret and returns --- the trigger word and snippet text. If *grep* is `true`, returns a table of --- snippets (trigger-text key-value pairs) that match the trigger word --- instead of snippet text. --- Snippets are searched for in the global snippets table followed by snippet --- directories. Lexer-specific snippets are preferred. --- @param grep Flag that indicates whether or not to return a table of snippets --- that match the trigger word. --- @param no_trigger Flag that indicates whether or not to ignore the trigger --- word and return all snippets. +-- LuaFormatter on + +-- Finds the snippet assigned to the trigger word behind the caret and returns the trigger word +-- and snippet text. +-- If *grep* is `true`, returns a table of snippets (trigger-text key-value pairs) that match +-- the trigger word instead of snippet text. Snippets are searched for in the global snippets +-- table followed by snippet directories. Lexer-specific snippets are preferred. +-- @param grep Flag that indicates whether or not to return a table of snippets that match the +-- trigger word. +-- @param no_trigger Flag that indicates whether or not to ignore the trigger word and return +-- all snippets. -- @return trigger word, snippet text or table of matching snippets local function find_snippet(grep, no_trigger) local matching_snippets = {} - local trigger = not no_trigger and buffer:text_range( - buffer:word_start_position(buffer.current_pos), buffer.current_pos) or '' + local trigger = not no_trigger and + buffer:text_range(buffer:word_start_position(buffer.current_pos), buffer.current_pos) or '' if no_trigger then grep = true end local lang = buffer:get_lexer(true) local name_patt = '^' .. trigger -- Search in the snippet tables. local snippet_tables = {snippets} - if type(snippets[lang]) == 'table' then - table.insert(snippet_tables, 1, snippets[lang]) - end + if type(snippets[lang]) == 'table' then table.insert(snippet_tables, 1, snippets[lang]) end for _, snippets in ipairs(snippet_tables) do if not grep and snippets[trigger] then return trigger, snippets[trigger] end if not grep then goto continue end @@ -169,14 +161,12 @@ local function find_snippet(grep, no_trigger) -- Search in snippet files. for i = 1, #M.paths do for basename in lfs.dir(M.paths[i]) do - -- Snippet files are either of the form "lexer.trigger.ext" or - -- "trigger.ext". Prefer "lexer."-prefixed snippets. + -- Snippet files are either of the form "lexer.trigger.ext" or "trigger.ext". Prefer + -- "lexer."-prefixed snippets. local p1, p2, p3 = basename:match('^([^.]+)%.?([^.]*)%.?([^.]*)$') - if not grep and - (p1 == lang and p2 == trigger or p1 == trigger and p3 == '') or - grep and - (p1 == lang and p2 and p2:find(name_patt) or - p1 and p1:find(name_patt) and p3 == '') then + if not grep and (p1 == lang and p2 == trigger or p1 == trigger and p3 == '') or + (grep and + (p1 == lang and p2 and p2:find(name_patt) or p1 and p1:find(name_patt) and p3 == '')) then local f = io.open(string.format('%s/%s', M.paths[i], basename)) text = f:read('a') f:close() @@ -185,26 +175,25 @@ local function find_snippet(grep, no_trigger) end end end - if not grep then return nil, nil else return trigger, matching_snippets end + if not grep then return nil, nil end + return trigger, matching_snippets end -- A snippet object. -- @field trigger The word that triggered this snippet. --- @field original_sel_text The text originally selected when this snippet was --- inserted. +-- @field original_sel_text The text originally selected when this snippet was inserted. -- @field start_pos This snippet's start position. --- @field end_pos This snippet's end position. This is a metafield that is --- computed based on the `INDIC_SNIPPET` sentinel. --- @field placeholder_pos The beginning of the current placeholder in this --- snippet. This is used by transforms to identify text to transform. This is --- a metafield that is computed based on `INDIC_CURRENTPLACEHOLDER`. +-- @field end_pos This snippet's end position. This is a metafield that is computed based on the +-- `INDIC_SNIPPET` sentinel. +-- @field placeholder_pos The beginning of the current placeholder in this snippet. This is used +-- by transforms to identify text to transform. This is a metafield that is computed based on +-- `INDIC_CURRENTPLACEHOLDER`. -- @field index This snippet's current placeholder index. -- @field max_index The number of different placeholders in this snippet. --- @field snapshots A record of this snippet's text over time. The snapshot for --- a given placeholder index contains the state of the snippet with all --- placeholders of that index filled in (prior to moving to the next --- placeholder index). Snippet state consists of a `text` string field and a --- `placeholders` table field. +-- @field snapshots A record of this snippet's text over time. The snapshot for a given +-- placeholder index contains the state of the snippet with all placeholders of that index +-- filled in (prior to moving to the next placeholder index). Snippet state consists of a +-- `text` string field and a `placeholders` table field. -- @class table -- @name snippet local snippet = {} @@ -218,8 +207,8 @@ local stack = {} function snippet.new(text, trigger) local snip = setmetatable({ trigger = trigger, original_sel_text = buffer:get_sel_text(), - start_pos = buffer.selection_start - (trigger and #trigger or 0), index = 0, - max_index = 0, snapshots = {} + start_pos = buffer.selection_start - (trigger and #trigger or 0), index = 0, max_index = 0, + snapshots = {} }, snippet) -- Convert and match indentation. @@ -246,10 +235,10 @@ function snippet.new(text, trigger) local C, Cp, Ct, Cg, Cc = lpeg.C, lpeg.Cp, lpeg.Ct, lpeg.Cg, lpeg.Cc local patt = P{ V('plain_text') * V('placeholder') * Cp() + V('plain_text') * -1, - plain_text = C(((P(1) - '%' + '%' * S('({'))^1 + '%%')^0), - placeholder = Ct( - '%' * (V('index')^-1 * (V('angles') + V('brackets') + V('braces')) * - V('transform') + V('index') * (V('parens') + V('simple')))), + plain_text = C(((P(1) - '%' + '%' * S('({'))^1 + '%%')^0), -- LuaFormatter + placeholder = Ct('%' * + (V('index')^-1 * (V('angles') + V('brackets') + V('braces')) * V('transform') + V('index') * + (V('parens') + V('simple')))), -- LuaFormatter index = Cg(R('09')^1 / tonumber, 'index'), parens = '(' * Cg((1 - S('()') + V('parens'))^0, 'default') * ')', simple = Cg(Cc(true), 'simple'), transform = Cg(Cc(true), 'transform'), @@ -259,22 +248,21 @@ function snippet.new(text, trigger) } -- A snippet placeholder. -- Each placeholder is stored in a snippet snapshot. - -- @field id This placeholder's unique ID. This field is used as an - -- indicator's value for identification purposes. + -- @field id This placeholder's unique ID. This field is used as an indicator's value for + -- identification purposes. -- @field index This placeholder's index. -- @field default This placeholder's default text, if any. - -- @field transform Whether or not this placeholder is a transform (containing - -- either Lua or Shell code). + -- @field transform Whether or not this placeholder is a transform (containing either Lua or + -- Shell code). -- @field lua_code The Lua code of this transform. -- @field sh_code The Shell code of this transform. -- @field choice A list of options to insert from an autocompletion list. - -- @field position This placeholder's initial position in its snapshot. This - -- field will not update until the next snapshot is taken. Use - -- `snippet:each_placeholder()` to determine a placeholder's current - -- position. - -- @field length This placeholder's initial length in its snapshot. This field - -- will never update. Use `buffer:indicator_end()` in conjunction with - -- `snippet:each_placeholder()` to determine a placeholder's current length. + -- @field position This placeholder's initial position in its snapshot. This field will not + -- update until the next snapshot is taken. Use `snippet:each_placeholder()` to determine + -- a placeholder's current position. + -- @field length This placeholder's initial length in its snapshot. This field will never + -- update. Use `buffer:indicator_end()` in conjunction with `snippet:each_placeholder()` + -- to determine a placeholder's current length. -- @class table -- @name placeholder local text_part, placeholder, e = patt:match(text) @@ -285,17 +273,14 @@ function snippet.new(text, trigger) placeholder.id = #snapshot.placeholders + 1 snapshot.placeholders[#snapshot.placeholders + 1] = placeholder end - if text_part ~= '' then - snapshot.text = snapshot.text .. text_part:gsub('%%(%p)', '%1') - end + if text_part ~= '' then snapshot.text = snapshot.text .. text_part:gsub('%%(%p)', '%1') end placeholder.position = #snapshot.text if placeholder.default then if placeholder.default:find('%%%d+') then - -- Parses out embedded placeholders, adding them to this snippet's - -- snapshot. + -- Parses out embedded placeholders, adding them to this snippet's snapshot. -- @param s The placeholder string to parse. - -- @param start_pos The absolute position in the snippet `s` starts - -- from. All computed positions are anchored from here. + -- @param start_pos The absolute position in the snippet `s` starts from. All computed + -- positions are anchored from here. -- @return plain text from `s` (i.e. no placeholder markup) local function process_placeholders(s, start_pos) -- Processes a placeholder capture from LPeg. @@ -306,8 +291,7 @@ function snippet.new(text, trigger) position = start_pos + position - 1 if default then -- Process sub-placeholders starting at the index after '%n('. - default = process_placeholders( - default:sub(2, -2), position + #index + 2) + default = process_placeholders(default:sub(2, -2), position + #index + 2) end index = tonumber(index) if index > snip.max_index then snip.max_index = index end @@ -323,8 +307,7 @@ function snippet.new(text, trigger) parens = '(' * (1 - S('()') + V('parens'))^0 * ')' }, s) end - placeholder.default = process_placeholders( - placeholder.default, placeholder.position) + placeholder.default = process_placeholders(placeholder.default, placeholder.position) end snapshot.text = snapshot.text .. placeholder.default elseif placeholder.transform and not placeholder.index then @@ -336,9 +319,7 @@ function snippet.new(text, trigger) placeholder.position = snip.start_pos + placeholder.position -- absolute text_part, placeholder, e = patt:match(text, e) end - if text_part ~= '' then - snapshot.text = snapshot.text .. text_part:gsub('%%(%p)', '%1') - end + if text_part ~= '' then snapshot.text = snapshot.text .. text_part:gsub('%%(%p)', '%1') end snip.snapshots[0] = snapshot -- Insert the snippet into the buffer and mark its end position. @@ -359,20 +340,19 @@ function snippet:__index(k) local end_pos = buffer:indicator_end(INDIC_SNIPPET, self.start_pos) return end_pos > self.start_pos and end_pos or self.start_pos elseif k == 'placeholder_pos' then - -- Normally the marker is one character behind the placeholder. However - -- it will not exist at all if the placeholder is at the beginning of the - -- snippet. Also account for the marker being at the beginning of the - -- snippet. (If so, pos will point to the correct position.) + -- Normally the marker is one character behind the placeholder. However it will not exist + -- at all if the placeholder is at the beginning of the snippet. Also account for the marker + -- being at the beginning of the snippet. (If so, pos will point to the correct position.) local pos = buffer:indicator_end(INDIC_CURRENTPLACEHOLDER, self.start_pos) if pos == 1 then pos = self.start_pos end - return buffer:indicator_all_on_for(pos) & - 1 << INDIC_CURRENTPLACEHOLDER - 1 > 0 and pos + 1 or pos + return buffer:indicator_all_on_for(pos) & 1 << INDIC_CURRENTPLACEHOLDER - 1 > 0 and pos + 1 or + pos end return getmetatable(self)[k] end --- Inserts the current snapshot (based on `self.index`) of this snippet into --- the buffer and marks placeholders. +-- Inserts the current snapshot (based on `self.index`) of this snippet into the buffer and +-- marks placeholders. function snippet:insert() buffer:set_target_range(self.start_pos, self.end_pos) buffer:replace_target(self.snapshots[self.index].text) @@ -383,22 +363,19 @@ function snippet:insert() end end --- Jumps to the next placeholder in this snippet and adds additional carets --- at mirrors. +-- Jumps to the next placeholder in this snippet and adds additional carets at mirrors. function snippet:next() if buffer:auto_c_active() then buffer:auto_c_complete() end - -- Take a snapshot of the current state in order to restore it later if - -- necessary. + -- Take a snapshot of the current state in order to restore it later if necessary. if self.index > 0 and self.start_pos < self.end_pos then local text = buffer:text_range(self.start_pos, self.end_pos) local placeholders = {} for pos, ph in self:each_placeholder() do - -- Only the position of placeholders changes between snapshots; save it - -- and keep all other existing properties. - -- Note that nested placeholders will return the same placeholder id - -- twice: once before a nested placeholder, and again after. (e.g. - -- [foo[bar]baz] will will return the '[foo' and 'baz]' portions of the - -- same placeholder.) Only process the first occurrence. + -- Only the position of placeholders changes between snapshots; save it and keep all + -- other existing properties. + -- Note that nested placeholders will return the same placeholder id twice: once before + -- a nested placeholder, and again after. (e.g. [foo[bar]baz] will will return the '[foo' + -- and 'baz]' portions of the same placeholder.) Only process the first occurrence. if placeholders[ph.id] then goto continue end placeholders[ph.id] = setmetatable({position = pos}, { __index = self.snapshots[self.index - 1].placeholders[ph.id] @@ -413,8 +390,11 @@ function snippet:next() local ph = select(2, self:each_placeholder(self.index, 'default')()) or select(2, self:each_placeholder(self.index, 'choice')()) or select(2, self:each_placeholder(self.index, 'simple')()) or - self.index == 0 and {position = self.end_pos, length = 0} - if not ph then self:next() return end -- try next placeholder + (self.index == 0 and {position = self.end_pos, length = 0}) + if not ph then + self:next() -- try next placeholder + return + end -- Mark the position of the placeholder so transforms can identify it. buffer.indicator_current = INDIC_CURRENTPLACEHOLDER @@ -461,10 +441,13 @@ function snippet:next() if self.index == 0 then self:finish() end end --- Jumps to the previous placeholder in this snippet and restores the state --- associated with that placeholder. +-- Jumps to the previous placeholder in this snippet and restores the state associated with +-- that placeholder. function snippet:previous() - if self.index < 2 then self:finish(true) return end + if self.index < 2 then + self:finish(true) + return + end self.index = self.index - 2 self:insert() self:next() @@ -472,8 +455,8 @@ end -- Finishes or cancels this snippet depending on boolean *canceling*. -- The snippet cleans up after itself regardless. --- @param canceling Whether or not to cancel inserting this snippet. When --- `true`, the buffer is restored to its state prior to snippet expansion. +-- @param canceling Whether or not to cancel inserting this snippet. When `true`, the buffer +-- is restored to its state prior to snippet expansion. function snippet:finish(canceling) local s, e = self.start_pos, self.end_pos if e ~= s then buffer:delete_range(e, 1) end -- clear initial padding space @@ -487,47 +470,42 @@ function snippet:finish(canceling) stack[#stack] = nil end --- Returns a generator that returns each placeholder's position and state for --- all placeholders in this snippet. --- DO NOT modify the buffer while this generator is running. Doing so will --- affect the generator's state and cause errors. Re-run the generator each --- time a buffer edit is made (e.g. via `goto`). +-- Returns a generator that returns each placeholder's position and state for all placeholders +-- in this snippet. +-- DO NOT modify the buffer while this generator is running. Doing so will affect the generator's +-- state and cause errors. Re-run the generator each time a buffer edit is made (e.g. via `goto`). -- @param index Optional placeholder index to constrain results to. -- @param type Optional placeholder type to constrain results to. function snippet:each_placeholder(index, type) - local snapshot = - self.snapshots[self.index > 0 and self.index - 1 or #self.snapshots] + local snapshot = self.snapshots[self.index > 0 and self.index - 1 or #self.snapshots] local i = self.start_pos return function() local s = buffer:indicator_end(M.INDIC_PLACEHOLDER, i) while s > 1 and s <= self.end_pos do if buffer:indicator_all_on_for(i) & 1 << M.INDIC_PLACEHOLDER - 1 > 0 then - -- This next indicator comes directly after the previous one; adjust - -- start and end positions to compensate. + -- This next indicator comes directly after the previous one; adjust start and end + -- positions to compensate. s, i = buffer:indicator_start(M.INDIC_PLACEHOLDER, i), s else i = buffer:indicator_end(M.INDIC_PLACEHOLDER, s) end local id = buffer:indicator_value_at(M.INDIC_PLACEHOLDER, s) local ph = snapshot.placeholders[id] - if ph and (not index or ph.index == index) and (not type or ph[type]) then - return s, ph - end + if ph and (not index or ph.index == index) and (not type or ph[type]) then return s, ph end s = buffer:indicator_end(M.INDIC_PLACEHOLDER, i) end end end --- Returns the result of executing Lua or Shell code, in placeholder table --- *placeholder*, in the context of this snippet. +-- Returns the result of executing Lua or Shell code, in placeholder table *placeholder*, +-- in the context of this snippet. -- @param placeholder The placeholder that contains code to execute. function snippet:execute_code(placeholder) local s, e = self.placeholder_pos, buffer.selection_end if s > e then s, e = e, s end local text = self.index and buffer:text_range(s, e) or '' -- %<...>, %[...] if placeholder.lua_code then - local env = setmetatable( - {text = text, selected_text = self.original_sel_text}, {__index = _G}) + local env = setmetatable({text = text, selected_text = self.original_sel_text}, {__index = _G}) local f, result = load('return ' .. placeholder.lua_code, nil, 't', env) return f and select(2, pcall(f)) or result or '' elseif placeholder.sh_code then @@ -571,13 +549,11 @@ function snippet:update_transforms() end --- --- Inserts snippet text *text* or the snippet assigned to the trigger word --- behind the caret. --- Otherwise, if a snippet is active, goes to the active snippet's next --- placeholder. Returns `false` if no action was taken. --- @param text Optional snippet text to insert. If `nil`, attempts to insert a --- new snippet based on the trigger, the word behind caret, and the current --- lexer. +-- Inserts snippet text *text* or the snippet assigned to the trigger word behind the caret. +-- Otherwise, if a snippet is active, goes to the active snippet's next placeholder. Returns +-- `false` if no action was taken. +-- @param text Optional snippet text to insert. If `nil`, attempts to insert a new snippet +-- based on the trigger, the word behind caret, and the current lexer. -- @return `false` if no action was taken; `nil` otherwise. -- @see buffer.word_chars -- @name insert @@ -589,17 +565,18 @@ function M.insert(text) assert_type(text, 'string/nil', trigger or '?') end if text then snippet.new(text, trigger) end - if #stack > 0 then stack[#stack]:next() else return false end + if #stack == 0 then return false end + stack[#stack]:next() end --- --- Jumps back to the previous snippet placeholder, reverting any changes from --- the current one. +-- Jumps back to the previous snippet placeholder, reverting any changes from the current one. -- Returns `false` if no snippet is active. -- @return `false` if no snippet is active; `nil` otherwise. -- @name previous function M.previous() - if #stack > 0 then stack[#stack]:previous() else return false end + if #stack == 0 then return false end + stack[#stack]:previous() end --- @@ -608,12 +585,13 @@ end -- @return `false` if no snippet is active; `nil` otherwise. -- @name cancel_current function M.cancel_current() - if #stack > 0 then stack[#stack]:finish(true) else return false end + if #stack == 0 then return false end + stack[#stack]:finish(true) end --- --- Prompts the user to select a snippet to insert from a list of global and --- language-specific snippets. +-- Prompts the user to select a snippet to insert from a list of global and language-specific +-- snippets. -- @name select function M.select() local all_snippets, items = {}, {} @@ -625,8 +603,7 @@ function M.select() items[#items + 1], items[#items + 2] = trigger, all_snippets[trigger] end local button, i = ui.dialogs.filteredlist{ - title = _L['Select Snippet'], columns = {_L['Trigger'], _L['Snippet Text']}, - items = items + title = _L['Select Snippet'], columns = {_L['Trigger'], _L['Snippet Text']}, items = items } if button == 1 and i then M.insert(items[i * 2]) end end @@ -634,9 +611,7 @@ end -- Update snippet transforms when text is added or deleted. events.connect(events.UPDATE_UI, function(updated) if #stack == 0 then return end - if updated & buffer.UPDATE_CONTENT > 0 then - stack[#stack]:update_transforms() - end + if updated & buffer.UPDATE_CONTENT > 0 then stack[#stack]:update_transforms() end if #keys.keychain == 0 then ui.statusbar_text = _L['Snippet active'] end end) @@ -645,8 +620,7 @@ events.connect(events.VIEW_NEW, function() view.indic_style[INDIC_CURRENTPLACEHOLDER] = view.INDIC_HIDDEN end) --- Returns for the word behind the caret a list of snippet trigger word --- completions. +-- Returns for the word behind the caret a list of snippet trigger word completions. -- @see textadept.editing.autocomplete textadept.editing.autocompleters.snippet = function() local list, trigger, snippets = {}, find_snippet(true) @@ -657,8 +631,8 @@ textadept.editing.autocompleters.snippet = function() end --- --- Map of snippet triggers with their snippet text or functions that return such --- text, with language-specific snippets tables assigned to a lexer name key. +-- Map of snippet triggers with their snippet text or functions that return such text, with +-- language-specific snippets tables assigned to a lexer name key. -- @class table -- @name _G.snippets _G.snippets = snippets |