aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.buffer.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2014-03-23 15:33:59 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2014-03-23 15:33:59 -0400
commit3d671602edd945202afaa50febddfa79a6d71f3b (patch)
tree44f1cc38535c520f800d76022519283894e01a23 /core/.buffer.luadoc
parent3a7c5d60c3c7362473e904548576884367b2475f (diff)
Updated to Scintilla 3.4.0 and LuaJIT 2.0.3.
Diffstat (limited to 'core/.buffer.luadoc')
-rw-r--r--core/.buffer.luadoc514
1 files changed, 257 insertions, 257 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc
index 56df6c93..2f95c878 100644
--- a/core/.buffer.luadoc
+++ b/core/.buffer.luadoc
@@ -876,9 +876,11 @@
-- * `buffer.WRAP_NONE`
-- Long lines are not wrapped.
-- * `buffer.WRAP_WORD`
--- Wrap long lines at word boundaries.
+-- Wrap long lines at word and style boundaries.
-- * `buffer.WRAP_CHAR`
-- Wrap long lines at character boundaries.
+-- * `buffer.WRAP_WHITESPACE`
+-- Wrap long lines at word boundaries, ignoring style boundaries.
--
-- The default value is `buffer.WRAP_NONE`.
-- @field wrap_start_indent (number)
@@ -927,7 +929,7 @@ module('buffer')
-- main selection, retaining all other selections as additional selections.
-- Since an empty selection still counts as a selection, use
-- `buffer:set_selection()` first when setting a list of selections.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param end_pos The caret position of the range of text to select in *buffer*.
-- @param start_pos The anchor position of the range of text to select in
-- *buffer*.
@@ -936,7 +938,7 @@ function add_selection(buffer, end_pos, start_pos) end
---
-- Adds string *text* to the buffer at the caret position and moves the caret to
-- the end of the added text without scrolling it into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to add.
function add_text(buffer, text) end
@@ -944,7 +946,7 @@ function add_text(buffer, text) end
-- Allocates an additional *num_styles* number of styles for use by margins or
-- annotations and returns the starting style number of the new range.
-- These styles are outside the 0..255 range used by lexers.
--- @param buffer The buffer
+-- @param buffer A buffer
-- @param num_styles The number of additional styles to allocate.
-- @return number
-- @see annotation_style_offset
@@ -953,43 +955,43 @@ function allocate_extended_styles(buffer, num_styles) end
---
-- Clears annotations from all lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function annotation_clear_all(buffer) end
---
-- Appends string *text* to the end of the buffer without modifying any existing
-- selections or scrolling the text into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to append.
function append_text(buffer, text) end
---
-- Returns whether or not an autocompletion or user list is visible.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return bool
function auto_c_active(buffer) end
---
-- Cancels an autocompletion or user list.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function auto_c_cancel(buffer) end
---
-- Completes the current word with the one selected in an autocompletion list.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function auto_c_complete(buffer) end
---
-- Returns the position where autocompletion started or where a user list was
-- shown.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return number
function auto_c_pos_start(buffer) end
---
-- Selects the first item that starts with string *prefix* in an autocompletion
-- or user list, using the case sensitivity setting `buffer.auto_c_ignore_case`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param prefix The item in the list to select.
function auto_c_select(buffer, prefix) end
@@ -1000,7 +1002,7 @@ function auto_c_select(buffer, prefix) end
-- autocompleted.
-- The sorted order of *items* (`buffer.auto_c_order`) must have already been
-- defined.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param len_entered The number of characters before the caret used to provide
-- the context.
-- @param items The sorted string of words to show, separated by
@@ -1011,27 +1013,27 @@ function auto_c_show(buffer, len_entered, items) end
-- Allows the user to type any character in string set *chars* in order to
-- cancel an autocompletion or user list.
-- The default set is empty.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param chars The string of characters that cancel autocompletion. This string
-- is empty by default.
function auto_c_stops(buffer, chars) end
---
-- Un-indents the text on the selected lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function back_tab(buffer) end
---
-- Starts a sequence of actions to be undone or redone as a single action.
-- May be nested.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function begin_undo_action(buffer) end
---
-- Highlights the character at position *pos* as an unmatched brace character
-- using the `'style.bracebad'` style.
-- Removes highlighting when *pos* is `-1`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to highlight, or `-1` to remove the
-- highlight.
function brace_bad_light(buffer, pos) end
@@ -1040,7 +1042,7 @@ function brace_bad_light(buffer, pos) end
-- Highlights unmatched brace characters with indicator number *indicator*, in
-- the range of `0` to `31`, instead of the
-- `buffer.STYLE_BRACEBAD` style if *use_indicator* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_indicator Whether or not to use an indicator.
-- @param indicator The indicator number to use.
function brace_bad_light_indicator(buffer, use_indicator, indicator) end
@@ -1050,7 +1052,7 @@ function brace_bad_light_indicator(buffer, use_indicator, indicator) end
-- using the `'style.bracelight'` style.
-- If indent guides are enabled, locates the column with `buffer.column` and
-- sets `buffer.highlight_guide` in order to highlight the indent guide.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos1 The first position in *buffer* to highlight.
-- @param pos2 The second position in *buffer* to highlight.
function brace_highlight(buffer, pos1, pos2) end
@@ -1059,7 +1061,7 @@ function brace_highlight(buffer, pos1, pos2) end
-- Highlights matching brace characters with indicator number *indicator*, in
-- the range of `0` to `31`, instead of the
-- `buffer.STYLE_BRACELIGHT` style if *use_indicator* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_indicator Whether or not to use an indicator.
-- @param indicator The indicator number to use.
function brace_highlight_indicator(buffer, use_indicator, indicator) end
@@ -1069,32 +1071,32 @@ function brace_highlight_indicator(buffer, use_indicator, indicator) end
-- position *pos*, taking nested braces into account, or `-1`.
-- The brace characters recognized are '(', ')', '[', ']', '{', '}', '<', and
-- '>' and must have the same style.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position of the brace in *buffer* to match.
-- @return number
function brace_match(buffer, pos) end
---
-- Returns whether or not a call tip is visible.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return bool
function call_tip_active(buffer) end
---
-- Removes a call tip from view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function call_tip_cancel(buffer) end
---
-- Returns a call tip's display position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return number
function call_tip_pos_start(buffer) end
---
-- Highlights a call tip's text between positions *start_pos*, starting from
-- zero, to *end_pos* with the color `buffer.call_tip_fore_hlt`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position in a call tip text to highlight.
-- @param end_pos The end position in a call tip text to highlight.
function call_tip_set_hlt(buffer, start_pos, end_pos) end
@@ -1105,108 +1107,108 @@ function call_tip_set_hlt(buffer, start_pos, end_pos) end
-- Any "\001" or "\002" bytes in *text* are replaced by clickable up or down
-- arrow visuals, respectively. These may be used to indicate that a symbol has
-- more than one call tip, for example.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to show a call tip at.
-- @param text The call tip text to show.
function call_tip_show(buffer, pos, text) end
---
-- Returns whether or not there is an action to be redone.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return bool
function can_redo(buffer) end
---
-- Returns whether or not there is an action to be undone.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return bool
function can_undo(buffer) end
---
-- Cancels the active selection mode, autocompletion or user list, call tip,
-- etc.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function cancel(buffer) end
---
-- Moves the caret left one character.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_left(buffer) end
---
-- Moves the caret left one character, extending the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_left_extend(buffer) end
---
-- Moves the caret left one character, extending the rectangular selection to
-- the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_left_rect_extend(buffer) end
---
-- Moves the caret right one character.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_right(buffer) end
---
-- Moves the caret right one character, extending the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_right_extend(buffer) end
---
-- Moves the caret right one character, extending the rectangular selection to
-- the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function char_right_rect_extend(buffer) end
---
-- Identifies the current horizontal caret position as the caret's preferred
-- horizontal position when moving between lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see caret_sticky
function choose_caret_x(buffer) end
---
-- Deletes the selected text or the character at the caret.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function clear(buffer) end
---
-- Deletes the buffer's text.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function clear_all(buffer) end
---
-- Clears all styling and folding information.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function clear_document_style(buffer) end
---
-- Clears all images registered using `buffer:register_image()` and
-- `buffer:register_rgba_image()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function clear_registered_images(buffer) end
---
-- Removes the alternate string representation for character *char*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param char The character in `buffer.representations` to remove the alternate
-- string representation for.
function clear_representation(buffer, char) end
---
-- Removes all selections and moves the caret to the beginning of the buffer.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function clear_selections(buffer) end
---
-- Instructs the lexer to style and mark fold points in the range of text
-- between *start_pos* and *end_pos*.
-- If *end_pos* is `-1`, styles and marks to the end of the buffer.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to
-- process.
-- @param end_pos The end position of the range of text in *buffer* to process,
@@ -1216,14 +1218,14 @@ function colourise(buffer, start_pos, end_pos) end
---
-- Returns the line number of the next contracted fold point starting from line
-- number *line*, or `-1` if none exists.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to start at.
-- @return number
function contracted_fold_next(buffer, line) end
---
-- Converts all end of line characters to those in end of line mode *mode*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param mode The end of line mode to convert to. Valid values are:
-- * `buffer.EOL_CRLF`
-- * `buffer.EOL_CR`
@@ -1235,32 +1237,32 @@ function convert_eols(buffer, mode) end
-- Multiple selections are copied in order with no delimiters. Rectangular
-- selections are copied from top to bottom with end of line characters. Virtual
-- space is not copied.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function copy(buffer) end
---
-- Copies the selected text or the current line to the clipboard.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function copy_allow_line(buffer) end
---
-- Copies the range of text between positions *start_pos* and *end_pos* to the
-- clipboard.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to copy.
-- @param end_pos The end position of the range of text in *buffer* to copy.
function copy_range(buffer, start_pos, end_pos) end
---
-- Copies string *text* to the clipboard.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to copy.
function copy_text(buffer, text) end
---
-- Returns the number of whole characters (taking multi-byte characters into
-- account) between positions *start_pos* and *end_pos*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to start
-- counting at.
-- @param end_pos The end position of the range of text in *buffer* to stop
@@ -1273,57 +1275,57 @@ function count_characters(buffer, start_pos, end_pos) end
-- Multiple selections are copied in order with no delimiters. Rectangular
-- selections are copied from top to bottom with end of line characters. Virtual
-- space is not copied.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function cut(buffer) end
---
-- Deletes the range of text from the caret to the beginning of the current
-- line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function del_line_left(buffer) end
---
-- Deletes the range of text from the caret to the end of the current line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function del_line_right(buffer) end
---
-- Deletes the word to the left of the caret, including any leading non-word
-- characters.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function del_word_left(buffer) end
---
-- Deletes the word to the right of the caret, including any trailing non-word
-- characters.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function del_word_right(buffer) end
---
-- Deletes the word to the right of the caret, excluding any trailing non-word
-- characters.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function del_word_right_end(buffer) end
---
-- Deletes the character behind the caret if no text is selected.
-- Otherwise, deletes the selected text.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function delete_back(buffer) end
---
-- Deletes the character behind the caret unless either the caret is at the
-- beginning of a line or text is selected.
-- If text is selected, deletes it.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function delete_back_not_line(buffer) end
---
-- Deletes the range of text from position *pos* to *pos* + *length*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to delete.
-- @param length The number of characters in the range of text to delete.
function delete_range(buffer, pos, length) end
@@ -1334,57 +1336,57 @@ function delete_range(buffer, pos, length) end
-- If *display_line* is less than or equal to zero, returns `0`. If
-- *display_line* is greater than or equal to the number of displayed lines,
-- returns `buffer.line_count`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param display_line The display line number to use.
-- @return number
function doc_line_from_visible(buffer, display_line) end
---
-- Moves the caret to the end of the buffer.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function document_end(buffer) end
---
-- Moves the caret to the end of the buffer, extending the selected text to the
-- new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function document_end_extend(buffer) end
---
-- Moves the caret to the beginning of the buffer.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function document_start(buffer) end
---
-- Moves the caret to the beginning of the buffer, extending the selected text
-- to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function document_start_extend(buffer) end
---
-- Drops existing selection number *n*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param n The number of the existing selection.
function drop_selection_n(buffer, n) end
---
-- Toggles `buffer.overtype`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function edit_toggle_overtype(buffer) end
---
-- Deletes the undo and redo history.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function empty_undo_buffer(buffer) end
---
-- Ends a sequence of actions to be undone or redone as a single action.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function end_undo_action(buffer) end
---
-- Ensures line number *line* is visible by expanding any fold points hiding it.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to ensure visible.
function ensure_visible(buffer, line) end
@@ -1392,7 +1394,7 @@ function ensure_visible(buffer, line) end
-- Ensures line number *line* is visible by expanding any fold points hiding it
-- based on the vertical caret policy previously defined in
-- `buffer:set_visible_policy()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to ensure visible.
function ensure_visible_enforce_policy(buffer, line) end
@@ -1400,7 +1402,7 @@ function ensure_visible_enforce_policy(buffer, line) end
-- Returns the position of column number *column* on line number *line* (taking
-- tab and multi-byte characters into account), or the position at the end of
-- line *line*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @param column The column number to use.
function find_column(buffer, line, column) end
@@ -1409,7 +1411,7 @@ function find_column(buffer, line, column) end
-- Contracts, expands, or toggles all fold points, depending on *action*.
-- When toggling, the state of the first fold point determines whether to
-- expand or contract.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param action The fold action to perform. Valid values are:
-- * `buffer.FOLDACTION_CONTRACT`
-- * `buffer.FOLDACTION_EXPAND`
@@ -1419,7 +1421,7 @@ function fold_all(buffer, action) end
---
-- Contracts, expands, or toggles the fold point on line number *line*, as well
-- as all of its children, depending on *action*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to set the fold states for.
-- @param action The fold action to perform. Valid values are:
-- * `buffer.FOLDACTION_CONTRACT`
@@ -1430,7 +1432,7 @@ function fold_children(buffer, line, action) end
---
-- Contracts, expands, or toggles the fold point on line number *line*,
-- depending on *action*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to set the fold state for.
-- @param action The fold action to perform. Valid values are:
-- * `buffer.FOLDACTION_CONTRACT`
@@ -1440,25 +1442,25 @@ function fold_line(buffer, line, action) end
---
-- Types a Form Feed character ("\f") at the caret position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function form_feed(buffer) end
---
-- Returns the current line's text and the caret's position on that line,
-- starting from zero.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return string, number
function get_cur_line(buffer) end
---
-- Returns the numeric background color of active hotspots.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return number
function get_hotspot_active_back(buffer) end
---
-- Returns the numeric foreground color of active hotspots.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return number
function get_hotspot_active_fore(buffer) end
@@ -1466,14 +1468,14 @@ function get_hotspot_active_fore(buffer) end
-- Returns the line number of the last line after line number *line* whose fold
-- level is greater than *level*.
-- If *level* is `-1`, returns the level of *line*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* of a header line.
-- @param level The fold level, or `-1` for the level of *line*.
function get_last_child(buffer, line, level) end
---
-- Returns the text on line number *line*, including end of line characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @return string, number
function get_line(buffer, line) end
@@ -1481,14 +1483,14 @@ function get_line(buffer, line) end
---
-- Returns the position of the end of the selected text on line number *line*,
-- or `-1` if *line* has no selection.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
function get_line_sel_end_position(buffer, line) end
---
-- Returns the position of the beginning of the selected text on line number
-- *line*, or `-1` if *line* has no selection.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
function get_line_sel_start_position(buffer, line) end
@@ -1497,25 +1499,25 @@ function get_line_sel_start_position(buffer, line) end
-- Multiple selections are included in order with no delimiters. Rectangular
-- selections are included from top to bottom with end of line characters.
-- Virtual space is not included.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @return string, number
function get_sel_text(buffer) end
---
-- Returns the buffer's text.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function get_text(buffer) end
---
-- Moves the caret to the beginning of line number *line* and scrolls it into
-- view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to go to.
function goto_line(buffer, line) end
---
-- Moves the caret to position *pos* and scrolls it into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to go to.
function goto_pos(buffer, pos) end
@@ -1523,60 +1525,60 @@ function goto_pos(buffer, pos) end
-- Hides the range of lines between line numbers *start_line* to *end_line*.
-- This has no effect on fold levels or fold flags and the first line cannot be
-- hidden.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_line The start line of the range of lines in *buffer* to hide.
-- @param end_line The end line of the range of lines in *buffer* to hide.
function hide_lines(buffer, start_line, end_line) end
---
-- Do not highlight selected text if *hide* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param hide Whether or not to hide the selection.
function hide_selection(buffer, hide) end
---
-- Moves the caret to the beginning of the current line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_display(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line, extending the
-- selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_display_extend(buffer) end
---
-- Moves the caret to the beginning of the current line, extending the selected
-- text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_extend(buffer) end
---
-- Moves the caret to the beginning of the current line, extending the
-- rectangular selection to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_rect_extend(buffer) end
---
-- Moves the caret to the beginning of the current wrapped line or, if already
-- there, to the beginning of the actual line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_wrap(buffer) end
---
-- Like `buffer:home_wrap()`, but extends the selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function home_wrap_extend(buffer) end
---
-- Returns a bit-mask that represents which indicators are on at position *pos*.
-- Bit 0 is set if indicator 0 is on, bit 1 for indicator 1, etc.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to get indicators at.
-- @return number
function indicator_all_on_for(buffer, pos) end
@@ -1584,7 +1586,7 @@ function indicator_all_on_for(buffer, pos) end
---
-- Clears indicator number `buffer.indicator_current` over the range of text
-- from position *pos* to *pos* + *length*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to clear
-- indicators over.
-- @param length The number of characters in the range of text to clear
@@ -1595,7 +1597,7 @@ function indicator_clear_range(buffer, pos, length) end
-- Returns the next boundary position, starting from position *pos*, of
-- indicator number *indicator*, in the range of `0` to `31`.
-- Returns `buffer.length` if *indicator* was not found.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param indicator An indicator number in the range of `0` to `31`.
-- @param pos The position in *buffer* of the indicator.
function indicator_end(buffer, indicator, pos) end
@@ -1603,7 +1605,7 @@ function indicator_end(buffer, indicator, pos) end
---
-- Fills the range of text from position *pos* to *pos* + *length* with
-- indicator number `buffer.indicator_current`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The start position of the range of text in *buffer* to set
-- indicators over.
-- @param length The number of characters in the range of text to set indicators
@@ -1614,7 +1616,7 @@ function indicator_fill_range(buffer, pos, length) end
-- Returns the previous boundary position, starting from position *pos*, of
-- indicator number *indicator*, in the range of `0` to `31`.
-- Returns `0` if *indicator* was not found.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param indicator An indicator number in the range of `0` to `31`.
-- @param pos The position in *buffer* of the indicator.
function indicator_start(buffer, indicator, pos) end
@@ -1624,7 +1626,7 @@ function indicator_start(buffer, indicator, pos) end
-- If *pos* is `-1`, inserts *text* at the caret position.
-- If the caret is after the *pos*, it is moved appropriately, but not scrolled
-- into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to insert text at, or `-1` for the
-- current position.
-- @param text The text to insert.
@@ -1632,86 +1634,86 @@ function insert_text(buffer, pos, text) end
---
-- Copies the current line to the clipboard.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_copy(buffer) end
---
-- Cuts the current line to the clipboard.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_cut(buffer) end
---
-- Deletes the current line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_delete(buffer) end
---
-- Moves the caret down one line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_down(buffer) end
---
-- Moves the caret down one line, extending the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_down_extend(buffer) end
---
-- Moves the caret down one line, extending the rectangular selection to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_down_rect_extend(buffer) end
---
-- Duplicates the current line on a new line below.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_duplicate(buffer) end
---
-- Moves the caret to the end of the current line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end(buffer) end
---
-- Moves the caret to the end of the current wrapped line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_display(buffer) end
---
-- Moves the caret to the end of the current wrapped line, extending the
-- selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_display_extend(buffer) end
---
-- Moves the caret to the end of the current line, extending the selected text
-- to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_extend(buffer) end
---
-- Moves the caret to the end of the current line, extending the rectangular
-- selection to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_rect_extend(buffer) end
---
-- Moves the caret to the end of the current wrapped line or, if already there,
-- to the end of the actual line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_wrap(buffer) end
---
-- Like `buffer:line_end_wrap()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_end_wrap_extend(buffer) end
---
-- Returns the line number of the line that contains position *pos*.
-- Returns `0` if *pos* is less than 0 or `buffer.line_count` if *pos* is
-- greater than `buffer.length`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the line number of.
-- @return number
function line_from_position(buffer, pos) end
@@ -1721,7 +1723,7 @@ function line_from_position(buffer, pos) end
-- characters.
-- To get line length excluding end of line characters, use
-- `buffer.line_end_position[line] - buffer:position_from_line(line)`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to get the length of.
-- @return number
function line_length(buffer, line) end
@@ -1729,65 +1731,65 @@ function line_length(buffer, line) end
---
-- Scrolls the buffer right *columns* columns and down *lines* lines.
-- Negative values are allowed.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param columns The number of columns to scroll horizontally.
-- @param lines The number of lines to scroll vertically.
function line_scroll(buffer, columns, lines) end
---
-- Scrolls the buffer down one line, keeping the caret visible.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_scroll_down(buffer) end
---
-- Scrolls the buffer up one line, keeping the caret visible.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_scroll_up(buffer) end
---
-- Swaps the current line with the previous one.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_transpose(buffer) end
---
-- Moves the caret up one line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_up(buffer) end
---
-- Moves the caret up one line, extending the selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_up_extend(buffer) end
---
-- Moves the caret up one line, extending the rectangular selection to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function line_up_rect_extend(buffer) end
---
-- Joins the lines in the target range, inserting spaces between the words
-- joined at line boundaries.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function lines_join(buffer) end
---
-- Splits the lines in the target range into lines *width* pixels wide.
-- If *width* is `0`, splits the lines in the target range into lines as wide as
-- the view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param width The pixel width to split lines at. When `0`, uses the width of
-- the view.
function lines_split(buffer, pixel_width) end
---
-- Converts the selected text to lower case letters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function lower_case(buffer) end
---
-- Clears all text in text margins.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function margin_text_clear_all(buffer) end
---
@@ -1795,7 +1797,7 @@ function margin_text_clear_all(buffer) end
-- *line*, returning the added marker's handle which can be used in
-- `buffer:marker_delete_handle()` and `buffer:marker_line_from_handle()`, or
-- `0` if *line* is invalid.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number to add the marker on.
-- @param marker The marker number in the range of `0` to `31` to add.
-- @return number
@@ -1806,7 +1808,7 @@ function marker_add(buffer, line, marker) end
-- *line*.
-- The first bit is set to add marker number 0, the second bit for marker number
-- 1, and so on up to marker number 31.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number to add the markers on.
-- @param marker_mask The mask of markers to set. Set bit 0 to set marker 0, bit
-- 1 for marker 1 and so on.
@@ -1817,7 +1819,7 @@ function marker_add_set(buffer, line, marker_mask) end
-- to `31`.
-- *symbol* is shown in marker symbol margins next to lines marked with
-- *marker*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param marker The marker number in the range of `0` to `31` to set *symbol*
-- for.
-- @param symbol The marker symbol: `buffer.MARK_*`.
@@ -1830,7 +1832,7 @@ function marker_define(buffer, marker, symbol) end
-- The `buffer.MARK_PIXMAP` marker symbol must be assigned to *marker*.
-- *pixmap* is shown in marker symbol margins next to lines marked with
-- *marker*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param marker The marker number in the range of `0` to `31` to define
-- pixmap *pixmap* for.
-- @param pixmap The string pixmap data.
@@ -1845,7 +1847,7 @@ function marker_define_pixmap(buffer, marker, pixmap) end
-- image line by line starting at the top-left pixel.
-- The `buffer.MARK_RGBAIMAGE` marker symbol must be assigned to *marker*.
-- *pixels* is shown in symbol margins next to lines marked with *marker*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param marker The marker number in the range of `0` to `31` to define RGBA
-- data *pixels* for.
-- @param pixels The string sequence of 4 byte pixel values starting with the
@@ -1860,7 +1862,7 @@ function marker_define_rgba_image(buffer, marker, pixels) end
---
-- Deletes marker number *marker*, in the range of `0` to `31`, from line number
-- *line*. If *marker* is `-1`, deletes all markers from *line*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number to delete the marker on.
-- @param marker The marker number in the range of `0` to `31` to delete from
-- *line*, or `-1` to delete all markers from the line.
@@ -1870,21 +1872,21 @@ function marker_delete(buffer, line, marker) end
-- Deletes marker number *marker*, in the range of `0` to `31`, from any line
-- that has it.
-- If *marker* is `-1`, deletes all markers from all lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param marker The marker number in the range of `0` to `31` to delete from
-- all lines, or `-1` to delete all markers from all lines.
function marker_delete_all(buffer, marker) end
---
-- Deletes the marker with handle *handle* returned by `buffer:marker_add()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param handle The identifier of a marker returned by `buffer:marker_add()`.
function marker_delete_handle(buffer, handle) end
---
-- Highlights the margin fold markers for the current fold block if *enabled* is
-- `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param enabled Whether or not to enable highlight.
function marker_enable_highlight(buffer, enabled) end
@@ -1893,7 +1895,7 @@ function marker_enable_highlight(buffer, enabled) end
-- *line*.
-- The first bit is set if marker number 0 is present, the second bit for marker
-- number 1, and so on.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number to get markers on.
-- @return number
function marker_get(buffer, line) end
@@ -1901,7 +1903,7 @@ function marker_get(buffer, line) end
---
-- Returns the line number that marker handle *handle*, returned by
-- `buffer:marker_add()`, was added to, or `-1` if the line was not found.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param handle The identifier of a marker returned by `buffer:marker_add()`.
-- @return number
function marker_line_from_handle(buffer, handle) end
@@ -1911,7 +1913,7 @@ function marker_line_from_handle(buffer, handle) end
-- all of the markers represented by marker bit-mask *marker_mask* added to it.
-- Returns `-1` if no line was found.
-- Bit 0 is set if marker 0 is set, bit 1 for marker 1, etc., up to marker 31.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The start line to search from.
-- @param marker_mask The mask of markers to find. Set bit 0 to find marker 0,
-- bit 1 for marker 1 and so on.
@@ -1923,7 +1925,7 @@ function marker_next(buffer, line, marker_mask) end
-- all of the markers represented by marker bit-mask *marker_mask* added to it.
-- Returns `-1` if no line was found.
-- Bit 0 is set if marker 0 is set, bit 1 for marker 1, etc., up to marker 31.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The start line to search from.
-- @param marker_mask The mask of markers to find. Set bit 0 to find marker 0,
-- bit 1 for marker 1 and so on.
@@ -1934,7 +1936,7 @@ function marker_previous(buffer, line, marker_mask) end
-- Returns the symbol assigned to marker number *marker*, in the range of `0` to
-- `31`, used in `buffer:marker_define()`,
-- `buffer:marker_define_pixmap()`, or `buffer:marker_define_rgba_image()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param marker The marker number in the range of `0` to `31` to get the symbol
-- of.
-- @return number
@@ -1942,95 +1944,95 @@ function marker_symbol_defined(buffer, marker) end
---
-- Moves the caret into view if it is not already, removing any selections.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function move_caret_inside_view(buffer) end
---
-- Shifts the selected lines down one line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function move_selected_lines_down(buffer) end
---
-- Shifts the selected lines up one line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function move_selected_lines_up(buffer) end
---
-- Types a new line at the caret position according to
-- [`buffer.eol_mode`](#eol_mode).
--- @param buffer The buffer.
+-- @param buffer A buffer.
function new_line(buffer) end
---
-- Moves the caret down one page.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_down(buffer) end
---
-- Moves the caret down one page, extending the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_down_extend(buffer) end
---
-- Moves the caret down one page, extending the rectangular selection to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_down_rect_extend(buffer) end
---
-- Moves the caret up one page.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_up(buffer) end
---
-- Moves the caret up one page, extending the selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_up_extend(buffer) end
---
-- Moves the caret up one page, extending the rectangular selection to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function page_up_rect_extend(buffer) end
---
-- Moves the caret down one paragraph.
-- Paragraphs are surrounded by one or more blank lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function para_down(buffer) end
---
-- Moves the caret down one paragraph, extending the selected text to the new
-- position.
-- Paragraphs are surrounded by one or more blank lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function para_down_extend(buffer) end
---
-- Moves the caret up one paragraph.
-- Paragraphs are surrounded by one or more blank lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function para_up(buffer) end
---
-- Moves the caret up one paragraph, extending the selected text to the new
-- position.
-- Paragraphs are surrounded by one or more blank lines.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function para_up_extend(buffer) end
---
-- Pastes the clipboard's contents into the buffer, replacing any selected text
-- according to `buffer.multi_paste`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function paste(buffer) end
---
-- Returns the position of the character after position *pos* (taking multi-byte
-- characters into account), or `buffer.length` if there is no character after
-- *pos*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the position after from.
function position_after(buffer, pos) end
@@ -2038,7 +2040,7 @@ function position_after(buffer, pos) end
-- Returns the position of the character before position *pos* (taking
-- multi-byte characters into account), or `0` if there is no character before
-- *pos*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the position before from.
-- @return number
function position_before(buffer, pos) end
@@ -2046,7 +2048,7 @@ function position_before(buffer, pos) end
---
-- Returns the position at the beginning of line number *line*.
-- Returns `-1` if *line* is greater than `buffer.line_count`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to get the beginning position for.
-- @return number
function position_from_line(buffer, line) end
@@ -2056,7 +2058,7 @@ function position_from_line(buffer, line) end
-- multi-byte characters into account.
-- Returns `0` if the position is less than 0 or `buffer.length` if the position
-- is greater than `buffer.length`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the relative position from.
-- @param n The relative number of characters to get the position for. A
-- negative number indicates a position before while a positive number
@@ -2066,13 +2068,13 @@ function position_relative(buffer, pos, n) end
---
-- Redoes the next undone action.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function redo(buffer) end
---
-- Registers XPM image *xpm_data* to type number *type* for use in
-- autocompletion and user lists.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param type Integer type to register the image with.
-- @param xpm_data The XPM data as described in `buffer:marker_define_pixmap()`.
function register_image(buffer, type, xpm_data) end
@@ -2084,7 +2086,7 @@ function register_image(buffer, type, xpm_data) end
-- `buffer.rgba_image_height`) must have already been defined. *pixels* is a
-- sequence of 4 byte pixel values (red, blue, green, and alpha) defining the
-- image line by line starting at the top-left pixel.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param type Integer type to register the image with.
-- @param pixels The RGBA data as described in
-- `buffer:marker_define_rgba_image()`.
@@ -2092,13 +2094,13 @@ function register_rgba_image(buffer, type, pixels) end
---
-- Releases all styles allocated with `buffer:allocate_extended_styles()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see allocate_extended_styles
function release_all_extended_styles(buffer) end
---
-- Replaces the selected text with string *text*, scrolling the caret into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to replace the selected text with.
function replace_sel(buffer, text) end
@@ -2107,7 +2109,7 @@ function replace_sel(buffer, text) end
-- selections or scrolling the view.
-- Setting the target and calling this function with an empty string is another
-- way to delete text.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to replace the target range with.
-- @return number
function replace_target(buffer, text) end
@@ -2117,20 +2119,20 @@ function replace_target(buffer, text) end
-- any "\d" sequences with the text of capture number *d* from the regular
-- expression (or the entire match for *d* = 0), and then returns the
-- replacement text's length.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to replace the target range with.
-- @return number
function replace_target_re(buffer, text) end
---
-- Designates the next additional selection to be the main selection.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function rotate_selection(buffer) end
---
-- Scrolls the caret into view based on the policies previously defined in
-- `buffer:set_x_caret_policy()` and `buffer:set_y_caret_policy()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see set_x_caret_policy
-- @see set_y_caret_policy
function scroll_caret(buffer) end
@@ -2141,25 +2143,25 @@ function scroll_caret(buffer) end
-- Similar to `buffer:scroll_caret()`, but with *primary_pos* instead of
-- `buffer.current_pos`.
-- This is useful for scrolling search results into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param secondary_pos The secondary range position to scroll into view.
-- @param primary_pos The primary range position to scroll into view.
function scroll_range(buffer, secondary_pos, primary_pos) end
---
-- Scrolls to the end of the buffer without moving the caret.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function scroll_to_end(buffer) end
---
-- Scrolls to the beginning of the buffer without moving the caret.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function scroll_to_start(buffer) end
---
-- Anchors the position that `buffer:search_next()` and `buffer:search_prev()`
-- start at to the caret position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function search_anchor(buffer) end
---
@@ -2167,7 +2169,7 @@ function search_anchor(buffer) end
-- bounded by `buffer.target_start` and `buffer.target_end` using search flags
-- `buffer.search_flags` and, if found, sets the new target range to that
-- occurrence, returning its position or `-1` if *text* was not found.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to search the target range for.
-- @return number
-- @see search_flags
@@ -2178,7 +2180,7 @@ function search_in_target(buffer, text) end
-- the search anchor using search flags *flags*, returning that occurrence's
-- position or `-1` if *text* was not found.
-- Selected text is not scrolled into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param flags The search flags to use. See `buffer.search_flags`.
-- @param text The text to search for.
-- @return number
@@ -2189,7 +2191,7 @@ function search_next(buffer, flags, text) end
-- Searches for and selects the last occurrence of string *text* before the
-- search anchor using search flags *flags*, returning that occurrence's
-- position or `-1` if *text* was not found.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param flags The search flags to use. See `buffer.search_flags`.
-- @param text The text to search for.
-- @return number
@@ -2198,19 +2200,19 @@ function search_prev(buffer, flags, text) end
---
-- Selects all of the buffer's text without scrolling the view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function select_all(buffer) end
---
-- Duplicates the selected text to its right.
-- If no text is selected, duplicates the current line on a new line below.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function selection_duplicate(buffer) end
---
-- Resets `buffer.word_chars`, `buffer.whitespace_chars`, and
-- `buffer.punctuation_chars` to their respective defaults.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see word_chars
-- @see whitespace_chars
-- @see punctuation_chars
@@ -2219,7 +2221,7 @@ function set_chars_default(buffer) end
---
-- Moves the caret to position *pos* without scrolling the view and removes any
-- selections.
--- @param buffer The buffer
+-- @param buffer A buffer
-- @param pos The position in *buffer* to move to.
function set_empty_selection(buffer, pos) end
@@ -2227,7 +2229,7 @@ function set_empty_selection(buffer, pos) end
-- Overrides the fold margin's default color with color *color*, in "0xBBGGRR"
-- format,
-- if *use_setting* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_fold_margin_colour(buffer, use_setting, color) end
@@ -2235,7 +2237,7 @@ function set_fold_margin_colour(buffer, use_setting, color) end
---
-- Overrides the fold margin's default highlight color with color *color*, in
-- "0xBBGGRR" format, if *use_setting* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_fold_margin_hi_colour(buffer, use_setting, color) end
@@ -2243,7 +2245,7 @@ function set_fold_margin_hi_colour(buffer, use_setting, color) end
---
-- Overrides the default background color of active hotspots with color *color*,
-- in "0xBBGGRR" format, if *use_setting* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_hotspot_active_back(buffer, use_setting, color) end
@@ -2251,20 +2253,20 @@ function set_hotspot_active_back(buffer, use_setting, color) end
---
-- Overrides the default foreground color of active hotspots with color *color*,
-- in "0xBBGGRR" format, if *use_setting* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_hotspot_active_fore(buffer, use_setting, color) end
---
-- Indicates the buffer has no unsaved changes.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function set_save_point(buffer) end
---
-- Selects the range of text between positions *start_pos* and *end_pos*,
-- scrolling the selected text into view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position of the range of text in *buffer* to
-- select. If negative, it means the end of the buffer.
-- @param end_pos The end position of the range of text in *buffer* to select.
@@ -2276,7 +2278,7 @@ function set_sel(buffer, start_pos, end_pos) end
-- Overrides the selection's default background color with color *color*, in
-- "0xBBGGRR" format, if *use_setting* is `true`.
-- Overwrites any existing `buffer.additional_sel_back` color.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_sel_back(buffer, use_setting, color) end
@@ -2285,7 +2287,7 @@ function set_sel_back(buffer, use_setting, color) end
-- Overrides the selection's default foreground color with color *color*, in
-- "0xBBGGRR" format, if *use_setting* is `true`.
-- Overwrites any existing `buffer.additional_sel_fore` color.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_sel_fore(buffer, use_setting, color) end
@@ -2293,7 +2295,7 @@ function set_sel_fore(buffer, use_setting, color) end
---
-- Selects the range of text between positions *start_pos* to *end_pos*,
-- removing all other selections.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param end_pos The caret position of the range of text to select in *buffer*.
-- @param start_pos The anchor position of the range of text to select in
-- *buffer*.
@@ -2303,14 +2305,14 @@ function set_selection(buffer, end_pos, start_pos) end
-- Assigns style number *style*, in the range from `0` to `255`, to the next
-- *length* characters, starting from the current styling position, and
-- increments the styling position by *length*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param length The number of characters to style.
-- @param style The style number to set.
function set_styling(buffer, length, style) end
---
-- Replaces the buffer's text with string *text*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param text The text to set.
function set_text(buffer, text) end
@@ -2319,7 +2321,7 @@ function set_text(buffer, text) end
-- caret *y* number of lines away from the vertical margins as
-- `buffer:ensure_visible_enforce_policy()` redisplays hidden or folded lines.
-- It is similar in operation to `buffer:set_y_caret_policy()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param policy The combination of `buffer.VISIBLE_SLOP` and
-- `buffer.VISIBLE_STRICT` policy flags to set.
-- @param y The number of lines from the vertical margins to keep the caret.
@@ -2328,7 +2330,7 @@ function set_visible_policy(buffer, policy, y) end
---
-- Overrides the background color of whitespace with color *color*, in
-- "0xBBGGRR" format, if *use_setting* is `true`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param use_setting Whether or not to use *color*.
-- @param color The color in "0xBBGGRR" format.
function set_whitespace_back(buffer, use_setting, color) end
@@ -2343,7 +2345,7 @@ function set_whitespace_fore(buffer, use_setting, color) end
---
-- Defines scrolling policy bit-mask *policy* as the policy for keeping the
-- caret *x* number of pixels away from the horizontal margins.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param policy The combination of `buffer.CARET_SLOP`, `buffer.CARET_STRICT`,
-- `buffer.CARET_EVEN`, and `buffer.CARET_JUMPS` policy flags to set.
-- @param x The number of pixels from the horizontal margins to keep the caret.
@@ -2352,7 +2354,7 @@ function set_x_caret_policy(buffer, policy, x) end
---
-- Defines scrolling policy bit-mask *policy* as the policy for keeping the
-- caret *y* number of lines away from the vertical margins.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param policy The combination of `buffer.CARET_SLOP`, `buffer.CARET_STRICT`,
-- `buffer.CARET_EVEN`, and `buffer.CARET_JUMPS` policy flags to set.
-- @param y The number of lines from the vertical margins to keep the caret.
@@ -2362,7 +2364,7 @@ function set_y_caret_policy(buffer, policy, y) end
-- Shows the range of lines between line numbers *start_line* to *end_line*.
-- This has no effect on fold levels or fold flags and the first line cannot be
-- hidden.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_line The start line of the range of lines in *buffer* to show.
-- @param end_line The end line of the range of lines in *buffer* to show.
function show_lines(buffer, start_line, end_line) end
@@ -2371,7 +2373,7 @@ function show_lines(buffer, start_line, end_line) end
-- Begins styling at position *position* with styling bit-mask *styling_mask*.
-- *styling_mask* specifies which style bits can be set with
-- `buffer:set_styling()`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param position The position in *buffer* to start styling at.
-- @param styling_mask The bit mask of style bits that can be set when styling.
-- @usage buffer:start_styling(0, 0xFF)
@@ -2380,56 +2382,56 @@ function start_styling(buffer, position, style_mask) end
---
-- Moves the caret to the bottom of the page or, if already there, down one
-- page.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function stuttered_page_down(buffer) end
---
-- Like `buffer:stuttered_page_down()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function stuttered_page_down_extend(buffer) end
---
-- Moves the caret to the top of the page or, if already there, up one page.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function stuttered_page_up(buffer) end
---
-- Like `buffer:stuttered_page_up()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function stuttered_page_up_extend(buffer) end
---
-- Reverts all styles to having the same properties as `buffer.STYLE_DEFAULT`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function style_clear_all(buffer) end
---
-- Resets `buffer.STYLE_DEFAULT` to its initial state.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function style_reset_default(buffer) end
---
-- Swaps the main selection's beginning and end positions.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function swap_main_anchor_caret(buffer) end
---
-- Indents the text on the selected lines or types a Tab character ("\t") at
-- the caret position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function tab(buffer) end
---
-- Defines the target range's beginning and end positions as the beginning and
-- end positions of the main selection, respectively.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function target_from_selection(buffer) end
---
-- Returns the pixel height of line number *line*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to get the pixel height of.
-- @return number
function text_height(buffer, line) end
@@ -2437,7 +2439,7 @@ function text_height(buffer, line) end
---
-- Returns the pixel width string *text* would have when styled with style
-- number *style_num*, in the range of `0` to `255`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param style_num The style number between `0` and `255` to use.
-- @param text The text to measure the width of.
-- @return number
@@ -2446,7 +2448,7 @@ function text_width(buffer, style_num, text) end
---
-- Cycles between `buffer.caret_sticky` option settings `buffer.CARETSTICKY_ON`
-- and `buffer.CARETSTICKY_OFF`.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see caret_sticky
function toggle_caret_sticky(buffer) end
@@ -2454,18 +2456,18 @@ function toggle_caret_sticky(buffer) end
-- Toggles the fold point on line number *line* between expanded (where all of
-- its child lines are displayed) and contracted (where all of its child lines
-- are hidden).
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to toggle the fold on.
function toggle_fold(buffer, line) end
---
-- Undoes the most recent action.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function undo(buffer) end
---
-- Converts the selected text to upper case letters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function upper_case(buffer) end
---
@@ -2475,7 +2477,7 @@ function upper_case(buffer) end
-- The sorted order of *items* (`buffer.auto_c_order`) must have already been
-- defined. When the user selects an item, *id* is sent in a
-- `USER_LIST_SELECTION` event along with the selection.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param id The list identifier number greater than zero to use.
-- @param items The sorted string of words to show, separated by
-- `buffer.auto_c_separator` characters (initially spaces).
@@ -2485,47 +2487,47 @@ function user_list_show(buffer, id, items) end
---
-- Moves the caret to the first visible character on the current line or, if
-- already there, to the beginning of the current line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home(buffer) end
---
-- Moves the caret to the first visible character on the current wrapped line,
-- or if already there, to the beginning of the current wrapped line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_display(buffer) end
---
-- Like `buffer:vc_home_display()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_display_extend(buffer) end
---
-- Like `buffer:vc_home()`, but extends the selected text to the new position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_extend(buffer) end
---
-- Like `buffer:vc_home()`, but extends the rectangular selection to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_rect_extend(buffer) end
---
-- Moves the caret to the first visible character on the current wrapped line,
-- or if already there, to the beginning of the actual line.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_wrap(buffer) end
---
-- Like `buffer:vc_home_wrap()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vc_home_wrap_extend(buffer) end
---
-- Centers current line in the view.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function vertical_centre_caret(buffer) end
---
@@ -2533,7 +2535,7 @@ function vertical_centre_caret(buffer) end
-- lines into account, or `-1` if *line* is outside the range of lines in the
-- buffer.
-- Lines can occupy more than one display line if they wrap.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @return number
function visible_from_doc_line(buffer, line) end
@@ -2543,7 +2545,7 @@ function visible_from_doc_line(buffer, line) end
-- `buffer.word_chars` contains word characters. If *pos* has a non-word
-- character to its right and *only_word_chars* is `false`, returns the first
-- word character's position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* of the word.
-- @param only_word_chars If `true`, stops searching at the first non-word
-- character in the search direction. Otherwise, the first character in the
@@ -2555,27 +2557,27 @@ function word_end_position(buffer, pos, only_word_chars) end
---
-- Moves the caret left one word.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_left(buffer) end
---
-- Moves the caret left one word, positioning it at the end of the previous
-- word.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_left_end(buffer) end
---
-- Like `buffer:word_left_end()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_left_end_extend(buffer) end
---
-- Moves the caret left one word, extending the selected text to the new
-- position.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_left_extend(buffer) end
---
@@ -2583,7 +2585,7 @@ function word_left_extend(buffer) end
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_part_left(buffer) end
---
@@ -2592,7 +2594,7 @@ function word_part_left(buffer) end
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_part_left_extend(buffer) end
---
@@ -2600,7 +2602,7 @@ function word_part_left_extend(buffer) end
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_part_right(buffer) end
---
@@ -2609,33 +2611,33 @@ function word_part_right(buffer) end
-- Word parts are delimited by underscore characters or changes in
-- capitalization.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_part_right_extend(buffer) end
---
-- Moves the caret right one word.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_right(buffer) end
---
-- Moves the caret right one word, positioning it at the end of the current
-- word.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_right_end(buffer) end
---
-- Like `buffer:word_right_end()`, but extends the selected text to the new
-- position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_right_end_extend(buffer) end
---
-- Moves the caret right one word, extending the selected text to the new
-- position.
-- `buffer.word_chars` contains word characters.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function word_right_extend(buffer) end
---
@@ -2643,7 +2645,7 @@ function word_right_extend(buffer) end
-- `buffer.word_chars` contains word characters. If *pos* has a non-word
-- character to its left and *only_word_chars* is `false`, returns the last word
-- character's position.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param pos The position in *buffer* of the word.
-- @param only_word_chars If `true`, stops searching at the first non-word
-- character in the search direction. Otherwise, the first character in the
@@ -2655,19 +2657,19 @@ function word_start_position(buffer, pos, only_word_chars) end
---
-- Returns the number of wrapped lines needed to fully display line number
-- *line*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param line The line number in *buffer* to use.
-- @return number
function wrap_count(buffer, line) end
---
-- Increases the size of all fonts by one point, up to 20.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function zoom_in(buffer) end
---
-- Decreases the size of all fonts by one point, down to -10.
--- @param buffer The buffer.
+-- @param buffer A buffer.
function zoom_out(buffer) end
-- External functions.
@@ -2676,7 +2678,7 @@ function zoom_out(buffer) end
-- Deletes the buffer.
-- **Do not call this function.** Call `buffer:close()` instead. Emits a
-- `BUFFER_DELETED` event.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @see events.BUFFER_DELETED
function delete(buffer) end
@@ -2690,7 +2692,7 @@ function new() end
---
-- Returns the range of text between positions *start_pos* and *end_pos*.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param start_pos The start position of the range of text to get in *buffer*.
-- @param end_pos The end position of the range of text to get in *buffer*.
function text_range(buffer, start_pos, end_pos) end
@@ -2699,7 +2701,7 @@ function text_range(buffer, start_pos, end_pos) end
-- Returns the buffer's lexer name.
-- If *current* is `true`, returns the name of the lexer under the caret in
-- a multiple-language lexer.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param current Whether or not to get the lexer at the current caret position
-- in multi-language lexers. The default is `false` and returns the parent
-- lexer.
@@ -2708,7 +2710,7 @@ function get_lexer(buffer, current) end
---
-- Associates lexer name *lexer* or the auto-detected lexer name with the buffer
-- and then loads the appropriate language module if that module exists.
--- @param buffer The buffer.
+-- @param buffer A buffer.
-- @param lexer Optional string lexer name to set. If `nil`, attempts to
-- auto-detect the buffer's lexer.
-- @usage buffer.set_lexer(buffer, 'lexer_name')
@@ -2724,29 +2726,29 @@ function set_lexer(buffer, lexer) end
-- * control_char_symbol
-- * direct_function
-- * direct_pointer
--- * distance_to_secondary_styles+
+-- * distance_to_secondary_styles
-- * doc_pointer
-- * focus
-- * font_quality
-- * gap_position
-- * identifier
--- * identifiers+
+-- * identifiers
-- * indicator_value
-- * keys_unicode
-- * key_words
-- * layout_cache
-- * lexer
-- * lexer_language
--- * line_end_types_active+
--- * line_end_types_allowed+
--- * line_end_types_supported+
+-- * line_end_types_active
+-- * line_end_types_allowed
+-- * line_end_types_supported
-- * margin_styles
-- * mod_event_mask
-- * modify
-- * mouse_down_captures
-- * paste_convert_endings
-- * position_cache
--- * primary_style_from_style+
+-- * primary_style_from_style
-- * print_colour_mode
-- * print_magnification
-- * print_wrap_mode
@@ -2754,12 +2756,12 @@ function set_lexer(buffer, lexer) end
-- * style_bits
-- * style_bits_needed
-- * style_character_set
--- * style_from_sub_style+
+-- * style_from_sub_style
-- * style_size_fractional
-- * style_weight
--- * sub_style_bases+
--- * sub_styles_length+
--- * sub_styles_start+
+-- * sub_style_bases
+-- * sub_styles_length
+-- * sub_styles_start
-- * technology
-- * use_palette
@@ -2768,7 +2770,7 @@ function set_lexer(buffer, lexer) end
-- * add_styled_text
-- * add_undo_action
-- * allocate
--- * allocate_sub_styles+
+-- * allocate_sub_styles
-- * assign_cmd_key
-- * can_paste
-- * change_lexer_state
@@ -2787,7 +2789,7 @@ function set_lexer(buffer, lexer) end
-- * find_indicator_show
-- * find_text
-- * format_range
--- * free_sub_styles+
+-- * free_sub_styles
-- * get_range_pointer
-- * get_styled_text
-- * grab_focus
@@ -2808,5 +2810,3 @@ function set_lexer(buffer, lexer) end
-- * stop_record
-- * target_as_utf8
-- * use_pop_up
---
--- + provisional features