2020-10-05 22:31:40 +00:00
|
|
|
|
/**
|
2020-10-24 21:45:32 +00:00
|
|
|
|
* providers/completion_item.ts
|
2020-10-05 22:31:40 +00:00
|
|
|
|
*
|
|
|
|
|
* @author CismonX <admin@cismon.net>
|
|
|
|
|
* @license MIT
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import * as vscode from 'vscode';
|
2020-10-26 19:37:05 +00:00
|
|
|
|
import Options from '../options';
|
|
|
|
|
import { CompletionItem } from '../utils/types';
|
2020-10-05 22:31:40 +00:00
|
|
|
|
|
2020-10-08 14:31:54 +00:00
|
|
|
|
/**
|
2020-10-18 17:31:43 +00:00
|
|
|
|
* Provide code completion info for Texinfo documents.
|
2020-10-08 14:31:54 +00:00
|
|
|
|
*/
|
2020-10-24 21:45:32 +00:00
|
|
|
|
export default class CompletionItemProvider implements vscode.CompletionItemProvider {
|
2020-10-05 22:31:40 +00:00
|
|
|
|
|
2020-10-26 19:37:05 +00:00
|
|
|
|
private completionItems?: CompletionItem[];
|
|
|
|
|
|
2020-10-18 15:51:00 +00:00
|
|
|
|
/**
|
|
|
|
|
* Full list of completion items.
|
|
|
|
|
*
|
|
|
|
|
* Excerpted from the {@link https://www.gnu.org/software/texinfo/manual/texinfo GNU Texinfo manual},
|
|
|
|
|
* which is licensed under the GNU Free Documentation License.
|
|
|
|
|
*/
|
2020-10-26 19:37:05 +00:00
|
|
|
|
private get values() {
|
|
|
|
|
const enableSnippets = Options.enableSnippets;
|
|
|
|
|
const hideSnippetCommands = Options.hideSnippetCommands;
|
|
|
|
|
return this.completionItems ??= [
|
|
|
|
|
command('ampchar', 'Insert an ampersand, "&"', { hasEmptyArguments: true }),
|
|
|
|
|
command('atchar', 'Insert an at sign, "@"', { hasEmptyArguments: true }),
|
|
|
|
|
command('backslashchar', 'Insert a blackslash, "\\"', { hasEmptyArguments: true }),
|
|
|
|
|
command('lbracechar', 'Insert a left brace, "{"', { hasEmptyArguments: true }),
|
|
|
|
|
command('rbracechar', 'Insert a right brace, "{"', { hasEmptyArguments: true }),
|
|
|
|
|
command('AA', 'Generate the uppercase Scandinavian A-ring letter, "Å"', { hasEmptyArguments: true }),
|
|
|
|
|
command('aa', 'Generate the lowercase Scandinavian A-ring letter, "å"', { hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('abbr', 'Indicate a general abbreviation', 1, 'abbreviation', 'meaning'),
|
|
|
|
|
...braceCommand('acronym', 'Indicate an acronym in all capital letters', 1, 'acronym', 'meaning'),
|
|
|
|
|
command('AE', 'Generate the uppercase AE ligatures, "Æ"', { hasEmptyArguments: true }),
|
|
|
|
|
command('ae', 'Generate the lowercase AE ligatures, "æ"', { hasEmptyArguments: true }),
|
|
|
|
|
command('afivepaper', 'Change page dimensions for the A5 paper size'),
|
|
|
|
|
command('afourlatex', 'Change page dimensions for the A4 paper size'),
|
|
|
|
|
command('afourpaper', 'Change page dimensions for the A4 paper size'),
|
|
|
|
|
command('afourwide', 'Change page dimensions for the A4 paper size'),
|
|
|
|
|
snippet('alias', 'alias', 'Defines a new command to be just like an existing one', 0,
|
|
|
|
|
'@alias new=existing', 'alias ${1:new}=${2:existing}'),
|
|
|
|
|
command('alias', 'Defines a new command to be just like an existing one', { snippet: true }),
|
|
|
|
|
...lineCommandEnum('allowcodebreaks', 'Control breaking at "-" and "_" in TeX', 'true', 'false'),
|
|
|
|
|
...braceCommand('anchor', 'Define current location for use as a cross-reference target', 1, 'name'),
|
|
|
|
|
...lineCommand('appendix', 'Begin an appendix', 'title'),
|
|
|
|
|
...lineCommand('appendixsec', 'Begin an appendix section within an appendix', 'title'),
|
|
|
|
|
...lineCommand('appendixsection', 'Begin an appendix section within an appendix', 'title'),
|
|
|
|
|
...lineCommand('appendixsubsec', 'Begin an appendix subsection', 'title'),
|
|
|
|
|
...lineCommand('appendixsubsubsec', 'Begin an appendix subsubsection', 'title'),
|
|
|
|
|
command('arrow', 'Generate a right arrow glyph, "→"', { hasEmptyArguments: true }),
|
|
|
|
|
command('asis', 'Print the table’s first column without highlighting'),
|
|
|
|
|
...lineCommand('author', 'Set the names of the author(s)', 'author-name'),
|
|
|
|
|
...braceCommand('b', 'Set text in a bold font', 1, 'text'),
|
|
|
|
|
...blockCommand('copying', 'Declare copying permissions'),
|
|
|
|
|
command('bullet', 'Generate a large round dot, "•"', { hasEmptyArguments: true }),
|
|
|
|
|
command('bye', 'Stop formatting'),
|
|
|
|
|
...lineCommand('c', 'Begin a line comment', 'comment'),
|
|
|
|
|
snippet('header', 'c', 'Declare header block', 2, '@c %**start of header\n\n@c %**end of header',
|
|
|
|
|
'c %**${1:start of header}\n$3\n@c %**${2:end of header}'),
|
|
|
|
|
...braceCommand('caption', 'Define the full caption for a @float', 1, 'definition'),
|
|
|
|
|
...blockCommand('cartouche', 'Highlight by drawing a box with rounded corners around it'),
|
|
|
|
|
...lineCommand('center', 'Center the line of text following the command', 'text-line'),
|
|
|
|
|
...lineCommand('centerchap', 'Like @chapter, but centers the chapter title', 'text-line'),
|
|
|
|
|
...lineCommand('chapheading', 'Print an unnumbered chapter-like heading', 'title'),
|
|
|
|
|
...lineCommand('chapter', 'Begin a numbered chapter', 'title'),
|
|
|
|
|
...lineCommand('cindex', 'Add entry to the index of concepts', 'entry'),
|
|
|
|
|
...braceCommand('cite', 'Highlight the name of a reference', 1, 'reference'),
|
|
|
|
|
...lineCommand('clear', 'Unset flag', 'flag'),
|
|
|
|
|
command('click', 'Represent a single "click" in a GUI', { hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('clicksequence', 'Represent a sequence of clicks in a GUI', 1, 'actions'),
|
|
|
|
|
...lineCommand('clickstyle', 'Execute command on each @click', '@command'),
|
|
|
|
|
...braceCommand('code', 'Indicate text which is a piece of code', 0, 'sample-code'),
|
|
|
|
|
...lineCommandEnum('codequotebacktick', 'Control output of "`" in code examples', 'on', 'off'),
|
|
|
|
|
...lineCommandEnum('codequoteundirected', 'Control output of "\'" in code examples', 'on', 'off'),
|
|
|
|
|
command('comma', 'Insert a comma character, ","', { hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('command', 'Indicate a command name', 1, 'command-name'),
|
|
|
|
|
...lineCommand('comment', 'Begin a line comment', 'comment'),
|
|
|
|
|
command('contents', "Print a complete table of contents."),
|
|
|
|
|
...blockCommand('copying', 'Specify copyright holders and copying conditions'),
|
|
|
|
|
command('copyright', 'The copyright symbol, "©"', { hasEmptyArguments: true }),
|
|
|
|
|
...lineCommand('defcodeindex', 'Define a new index, print entries in an @code font', 'index-name'),
|
|
|
|
|
...lineCommandX('defcv', 'Format a description for a variable associated with a class',
|
|
|
|
|
'category', 'class', 'name'),
|
|
|
|
|
...lineCommandX('deffn', 'Format a description for a function', 'category', 'name', 'arguments'),
|
|
|
|
|
...lineCommand('defindex', 'Define a new index, print entries in a roman font', 'index-name'),
|
|
|
|
|
...lineCommand('definfoenclose', 'Create a new command for Info that marks text by enclosing it in ' +
|
|
|
|
|
'strings that precede and follow the text.', 'newcmd', 'before', 'after'),
|
|
|
|
|
...lineCommandX('defivar', 'Format a description for an instance variable in object-oriented programming',
|
|
|
|
|
'class', 'instance-variable-name'),
|
|
|
|
|
...lineCommandX('defmac', 'Format a description for a macro', 'macroname', 'arguments'),
|
|
|
|
|
...lineCommandX('defmethod', 'Format a description for a method in object-oriented programming',
|
|
|
|
|
'class', 'method-name', 'arguments'),
|
|
|
|
|
...lineCommandX('defop', 'Format a description for an operation in object-oriented programming',
|
|
|
|
|
'category', 'class', 'name', 'arguments'),
|
|
|
|
|
...lineCommandX('defopt', 'Format a description for a user option', 'option-name'),
|
|
|
|
|
...lineCommandX('defspec', 'Format a description for a special form', 'special-form-name', 'arguments'),
|
|
|
|
|
...lineCommandX('deftp', 'Format a description for a data type', 'category', 'name-of-type', 'attributes'),
|
|
|
|
|
...lineCommandX('deftypecv', 'Format a description for a typed class variable in ' +
|
|
|
|
|
'object-oriented programming', 'category', 'class', 'data-type', 'name'),
|
|
|
|
|
...lineCommandX('deftypefn', 'Format a description for a function or similar entity that may ' +
|
|
|
|
|
'take arguments and that is typed', 'category', 'data-type', 'name', 'arguments'),
|
|
|
|
|
...lineCommandEnum('deftypefnnewline', 'Specifies whether return types for @deftypefn and similar ' +
|
|
|
|
|
'are printed on lines by themselves', 'on', 'off'),
|
|
|
|
|
...lineCommandX('deftypefun', 'Format a description for a function in a typed language',
|
|
|
|
|
'data-type', 'function-name', 'arguments'),
|
|
|
|
|
...lineCommandX('deftypeivar', 'Format a description for a typed instance variable in ' +
|
|
|
|
|
'object-oriented programming', 'class', 'data-type', 'variable-name'),
|
|
|
|
|
...lineCommandX('deftypemethod', 'Format a description for a typed method in object-oriented programming',
|
|
|
|
|
'class', 'data-type', 'method-name', 'arguments'),
|
|
|
|
|
...lineCommandX('deftypeop', 'Format a description for a typed operation in object-oriented programming',
|
|
|
|
|
'category', 'class', 'data-type', 'name', 'arguments'),
|
|
|
|
|
...lineCommandX('deftypevar', 'Format a description for a variable in a typed language',
|
|
|
|
|
'data-type', 'variable-name'),
|
|
|
|
|
...lineCommandX('deftypevr', 'Format a description for something like a variable in a typed language',
|
|
|
|
|
'category', 'data-type', 'name'),
|
|
|
|
|
...lineCommandX('defun', 'Format a description for a function', 'function-name', 'arguments'),
|
|
|
|
|
...lineCommandX('defvar', 'Format a description for a variable', 'variable-name'),
|
|
|
|
|
...lineCommandX('defvr', 'Format a description for any kind of variable', 'category', 'name'),
|
|
|
|
|
command('detailmenu', 'Mark the (optional) detailed node listing in a master menu'),
|
2020-11-04 07:07:54 +00:00
|
|
|
|
...braceCommand('dfn', 'Indicate the introductory or defining use of a term', 1, 'term'),
|
|
|
|
|
command('DH', 'Generate the uppercase Icelandic letter eth, "Ð", ð', { hasEmptyArguments: true }),
|
|
|
|
|
command('dh', 'Generate the lower Icelandic letter eth, "ð"', { hasEmptyArguments: true }),
|
|
|
|
|
...lineCommand('dircategory', "Specify a part of the Info directory menu where this file's entry should go",
|
|
|
|
|
'dirpart'),
|
|
|
|
|
...blockCommand('direntry', 'Begin the Info directory menu entry for this file'),
|
|
|
|
|
...blockCommand('display', 'Begin a kind of example'),
|
|
|
|
|
...braceCommand('dmn', 'Format a unit of measure, as in 12pt', 1, 'dimension'),
|
|
|
|
|
...blockCommand('docbook', 'Enter Docbook completely'),
|
|
|
|
|
...blockCommand('documentdescription', 'Set the document description text, included in the HTML output'),
|
|
|
|
|
...lineCommand('documentencoding', 'Declare the input encoding', 'enc'),
|
|
|
|
|
...lineCommand('documentlanguage', 'Declares the current document locale', 'll_CC'),
|
|
|
|
|
...braceCommand('dotaccent', 'Generate a dot accent over the character', 1, 'c'),
|
2020-11-05 07:24:06 +00:00
|
|
|
|
...braceCommandEnum('dotless', 'Generate dotless i, "ı", or dotless j, "ȷ"', 'i', 'j'),
|
|
|
|
|
command('dots', 'Generate an ellipsis, "…"', { hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('email', 'Indicate an electronic mail address', 1, 'address', 'displayed-text'),
|
|
|
|
|
...braceCommand('emph', 'Emphasize text', 1, 'text'),
|
|
|
|
|
...lineCommand('end', 'Ends a block command environment', 'environment'),
|
|
|
|
|
command('enddots', 'Generate an end-of-sentence ellipsis, "..."', { hasEmptyArguments: true }),
|
|
|
|
|
...blockCommand('enumerate', 'Begin a numbered list, using @item for each entry'),
|
|
|
|
|
...braceCommand('env', 'Indicate an environment variable name', 1, 'environment-variable'),
|
|
|
|
|
command('equiv', 'Insert a glyph indicating exact equivalence, "≡"', { hasEmptyArguments: true }),
|
|
|
|
|
command('error', 'Indicate that the following text is an error message, "error→"',
|
|
|
|
|
{ hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('errormsg', 'Report message as an error to standard error, and exit unsuccessfully',
|
|
|
|
|
1, 'msg'),
|
|
|
|
|
command('euro', 'Generate the Euro currency sign, "€"', { hasEmptyArguments: true }),
|
2020-11-13 11:02:34 +00:00
|
|
|
|
...headingFootingCommand('evenfooting', 'Generate page footers that are the same for even-numbered pages'),
|
|
|
|
|
...headingFootingCommand('evenheading', 'Generate page headers that are the same for even-numbered pages'),
|
|
|
|
|
...headingFootingCommand('everyfooting', 'Generate page footers that are the same for every pages'),
|
|
|
|
|
...headingFootingCommand('everyheading', 'Generate page headers that are the same for every pages'),
|
2020-11-05 07:24:06 +00:00
|
|
|
|
...blockCommand('example', 'Indicate an example'),
|
|
|
|
|
...lineCommand('exampleindent', 'Indent example-like environments by number of spaces', 'indent'),
|
|
|
|
|
command('exclamdown', 'Generate an upside-down exclamation mark, "¡"', { hasEmptyArguments: true }),
|
|
|
|
|
...lineCommand('exdent', 'Remove any indentation a line might have', 'line-of-text'),
|
|
|
|
|
command('expansion', 'Indicate the result of a macro expansion with a glyph, "→"',
|
|
|
|
|
{ hasEmptyArguments: true }),
|
|
|
|
|
...braceCommand('file', 'Highlight the name of a file', 1, 'filename'),
|
|
|
|
|
command('finalout', 'Prevent TeX from printing large black warning rectangles beside over-wide lines'),
|
|
|
|
|
...lineCommand('findex', 'Add entry to the index of functions', 'entry'),
|
|
|
|
|
...lineCommandEnum('firstparagraphindent', 'Control indentation of the first paragraph after ' +
|
|
|
|
|
'section headers', 'none', 'insert'),
|
|
|
|
|
...blockCommand('float', 'Environment to define floating material'),
|
|
|
|
|
...blockCommand('flushleft', 'Left justify every line while leaving the right end ragged'),
|
|
|
|
|
...blockCommand('flushright', 'Right justify every line while leaving the left end ragged'),
|
|
|
|
|
...lineCommandEnum('fonttextsize', 'Change the size of the main body font in the TeX output', '10', '11'),
|
|
|
|
|
...braceCommand('footnote', 'Enter a footnote', 1, 'footnote-text'),
|
|
|
|
|
...lineCommandEnum('footnotestyle', "Specify an Info file's footnote style", 'end', 'separate'),
|
|
|
|
|
...blockCommand('format', 'Begin a kind of example, but do not indent'),
|
|
|
|
|
...lineCommandEnum('frenchspacing', 'Control spacing after punctuation', 'on', 'off'),
|
2020-11-13 11:02:34 +00:00
|
|
|
|
...blockCommand('ftable', 'Begin a two-column table, using @item for each entry', 'formatting-command'),
|
2020-11-11 07:10:00 +00:00
|
|
|
|
command('geq', 'Generate a greater-than-or-equal sign, "≥"', { hasEmptyArguments: true }),
|
|
|
|
|
...blockCommand('group', 'Disallow page breaks within following text'),
|
|
|
|
|
command('guillemetleft', 'Double angle quotation mark, "«"', { hasEmptyArguments: true }),
|
|
|
|
|
command('guillemetright', 'Double angle quotation mark, "»"', { hasEmptyArguments: true }),
|
|
|
|
|
command('guillemotleft', 'Double angle quotation mark, "«"', { hasEmptyArguments: true }),
|
|
|
|
|
command('guillemotright', 'Double angle quotation mark, "»"', { hasEmptyArguments: true }),
|
|
|
|
|
command('guillemotleft', 'Single angle quotation mark, "‹"', { hasEmptyArguments: true }),
|
|
|
|
|
command('guillemotright', 'Single angle quotation mark, "›"', { hasEmptyArguments: true }),
|
|
|
|
|
command('hashchar', 'Insert a hash character, "#"', { hasEmptyArguments: true }),
|
|
|
|
|
...lineCommand('heading', 'Print an unnumbered section-like heading', 'title'),
|
|
|
|
|
...lineCommandEnum('headings', 'Turn page headings on or off, and/or specify single or double-sided ' +
|
|
|
|
|
'page headings for printing', 'on', 'single', 'double', 'singleafter', 'doubleafter', 'off'),
|
|
|
|
|
command('headitem', 'Begin a heading row in a multitable'),
|
|
|
|
|
...braceCommand('headitemfont', 'Set text in the font used for multitable heading rows', 1, 'text'),
|
|
|
|
|
...blockCommand('html', 'Enter HTML completely'),
|
|
|
|
|
...braceCommand('hyphenation', 'Tell TeX how to hyphenate words', 1, 'hy-phen-a-ted words'),
|
|
|
|
|
...braceCommand('i', 'Set text in an italic font', 1, 'text'),
|
2020-11-13 11:02:34 +00:00
|
|
|
|
...blockCommand('ifclear', 'If the Texinfo variable is not set, format the following text', 'txivar'),
|
|
|
|
|
...blockCommand('ifcommanddefined', 'If the Texinfo code is defined, format the follow text', 'txicmd'),
|
|
|
|
|
...blockCommand('ifcommandnotdefined', 'If the Texinfo code is not defined, format the follow text',
|
|
|
|
|
'txicmd'),
|
2020-11-11 07:10:00 +00:00
|
|
|
|
...blockCommand('ifdocbook', 'Begin text that will appear only in DocBook format'),
|
|
|
|
|
...blockCommand('ifhtml', 'Begin text that will appear only in HTML format'),
|
|
|
|
|
...blockCommand('ifinfo', 'Begin text that will appear only in Info format'),
|
|
|
|
|
...blockCommand('ifplaintext', 'Begin text that will appear only in plain text format'),
|
|
|
|
|
...blockCommand('iftex', 'Begin text that will appear only in TeX format'),
|
|
|
|
|
...blockCommand('ifxml', 'Begin text that will appear only in XML format'),
|
|
|
|
|
...blockCommand('ifnotdocbook', 'Begin text to be ignored in DocBook format'),
|
|
|
|
|
...blockCommand('ifnothtml', 'Begin text to be ignored in HTML format'),
|
|
|
|
|
...blockCommand('ifnotinfo', 'Begin text to be ignored in Info format'),
|
|
|
|
|
...blockCommand('ifnotplaintext', 'Begin text to be ignored in plain text format'),
|
|
|
|
|
...blockCommand('ifnottex', 'Begin text to be ignored in TeX format'),
|
|
|
|
|
...blockCommand('ifnotxml', 'Begin text to be ignored in XML format'),
|
|
|
|
|
...blockCommand('ignore', 'Begin text that will not appear in any output'),
|
|
|
|
|
...braceCommand('image', 'Insert an image', 1, 'filename', 'width', 'height', 'alt', 'ext'),
|
|
|
|
|
...lineCommand('include', 'Read the contents of Texinfo source file', 'filname'),
|
|
|
|
|
command('indent', 'Insert paragraph indentation'),
|
|
|
|
|
...blockCommand('indentedblock', 'Indent a block of arbitary text on the left'),
|
|
|
|
|
...braceCommand('indicateurl', 'Indicate text that is a URL', 1, 'URL'),
|
|
|
|
|
...braceCommand('inforef', 'Make a cross-reference to an Info file', 3, 'node-name',
|
|
|
|
|
'entry-name', 'info-file-name'),
|
|
|
|
|
...braceCommand('inlinefmt', 'Insert text only if the output format is fmt', 2, 'fmt', 'text'),
|
|
|
|
|
...braceCommand('inlinefmtifelse', 'Insert text if the output format is fmt, else else-text', 3,
|
|
|
|
|
'fmt', 'text', 'else-text'),
|
|
|
|
|
...braceCommand('inlineifclear', 'Insert text only if variable var is not set', 2, 'var', 'text'),
|
|
|
|
|
...braceCommand('inlineifset', 'Insert text only if variable var is set', 2, 'var', 'text'),
|
|
|
|
|
...braceCommand('inlineraw', 'Insert text as in a raw conditional, only if the output format is fmt', 2,
|
|
|
|
|
'fmt', 'raw-text'),
|
|
|
|
|
command('insertcopying', 'Insert previously defined @copying text'),
|
|
|
|
|
command('item', 'Indicate the beginning of a marked paragraph, or the beginning of the text of a ' +
|
|
|
|
|
'first column entry for a table'),
|
2020-11-13 11:02:34 +00:00
|
|
|
|
...blockCommand('itemize', 'Begin an unordered list', 'mark-generating-character-or-command'),
|
|
|
|
|
command('itemx', 'Like @item but do not generate extra vertical space above the item text'),
|
|
|
|
|
...braceCommand('kbd', 'Indicate characters of input to be typed by users', 1, 'keyboard-characters'),
|
|
|
|
|
...lineCommandEnum('kbdinputstyle', 'Specify when @kbd should use a font distinct from @code',
|
|
|
|
|
'code', 'distinct', 'example'),
|
|
|
|
|
...braceCommand('key', 'Indicate the name of a key on a keyboard', 1, 'key-name'),
|
|
|
|
|
...lineCommand('kindex', 'Add entry to the index of keys', 'entry'),
|
|
|
|
|
command('L', 'Generate the uppercase Polish suppressed-L letter, "Ł"', { hasEmptyArguments: true }),
|
|
|
|
|
command('l', 'Generate the lowercase Polish suppressed-L letter, "ł"', { hasEmptyArguments: true }),
|
|
|
|
|
command('LaTeX', 'Generate the LaTeX logo', { hasEmptyArguments: true }),
|
|
|
|
|
command('leq', 'Generate a less-than-or-equal sign, "≤"', { hasEmptyArguments: true }),
|
|
|
|
|
...blockCommand('lisp', 'Begin an example of Lisp code'),
|
|
|
|
|
command('listoffloats', 'Produce a table-of-contents-like listing of floats'),
|
|
|
|
|
command('lowersections', 'Change subsequent chapters to sections, sections to subsections'),
|
|
|
|
|
...blockCommand('macro', 'Define a new Texinfo command', 'macroname', 'params'),
|
2020-11-11 07:10:00 +00:00
|
|
|
|
|
2020-10-26 19:37:05 +00:00
|
|
|
|
...lineCommand('setfilename', 'Provide a name for the output files', 'info-file-name'),
|
|
|
|
|
...lineCommand('settitle', 'Specify the title for page headers', 'title'),
|
|
|
|
|
...blockCommand('titlepage', 'Declare title page'),
|
|
|
|
|
].filter(completionItem => {
|
|
|
|
|
if (!enableSnippets) return completionItem.kind === vscode.CompletionItemKind.Function;
|
|
|
|
|
return !hideSnippetCommands || !completionItem.snippet;
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private oldOptions?: Options;
|
2020-10-07 23:09:21 +00:00
|
|
|
|
|
2020-10-05 22:31:40 +00:00
|
|
|
|
provideCompletionItems(
|
|
|
|
|
document: vscode.TextDocument,
|
|
|
|
|
position: vscode.Position,
|
|
|
|
|
token: vscode.CancellationToken,
|
2020-10-08 14:31:54 +00:00
|
|
|
|
context: vscode.CompletionContext,
|
2020-10-05 22:31:40 +00:00
|
|
|
|
) {
|
2020-10-26 19:37:05 +00:00
|
|
|
|
const lineText = document.lineAt(position.line).text;
|
|
|
|
|
// Ignore comment line.
|
|
|
|
|
if (lineText.startsWith('@c ') || lineText.startsWith('@comment ')) return undefined;
|
2020-10-20 20:07:44 +00:00
|
|
|
|
// Triggered in the middle of a word.
|
2020-10-07 23:09:21 +00:00
|
|
|
|
if (context.triggerKind === vscode.CompletionTriggerKind.Invoke) {
|
|
|
|
|
const wordRange = document.getWordRangeAtPosition(position);
|
2020-10-20 20:07:44 +00:00
|
|
|
|
if (wordRange === undefined) return undefined;
|
|
|
|
|
// Normalize position so that it can be treated as triggered by '@' character.
|
2020-10-07 23:09:21 +00:00
|
|
|
|
position = wordRange.start;
|
2020-10-20 20:07:44 +00:00
|
|
|
|
if (document.getText(new vscode.Range(position.translate(0, -1), position)) !== '@') return undefined;
|
2020-10-07 23:09:21 +00:00
|
|
|
|
}
|
2020-10-26 19:37:05 +00:00
|
|
|
|
// Check whether options has changed.
|
|
|
|
|
if (this.oldOptions !== Options.instance) {
|
|
|
|
|
this.oldOptions = Options.instance;
|
|
|
|
|
this.completionItems = undefined;
|
|
|
|
|
}
|
|
|
|
|
if (position.character === 1) return this.values;
|
2020-10-20 20:07:44 +00:00
|
|
|
|
// Check whether the '@' character is escaped.
|
2020-10-07 23:09:21 +00:00
|
|
|
|
if (document.getText(new vscode.Range(position.translate(0, -2), position.translate(0, -1))) === '@') {
|
|
|
|
|
return undefined;
|
|
|
|
|
} else {
|
2020-10-26 19:37:05 +00:00
|
|
|
|
return this.values;
|
2020-10-07 23:09:21 +00:00
|
|
|
|
}
|
2020-10-05 22:31:40 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2020-10-08 14:31:54 +00:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Build the completion item for a Texinfo command.
|
|
|
|
|
*
|
|
|
|
|
* @param name The command name.
|
|
|
|
|
* @param detail The command description.
|
|
|
|
|
* @param extraArgs Extra arguments.
|
|
|
|
|
*/
|
|
|
|
|
function command(name: string, detail: string, extraArgs?: {
|
|
|
|
|
/**
|
2020-10-26 19:37:05 +00:00
|
|
|
|
* Whether this command has a snippet.
|
2020-10-08 14:31:54 +00:00
|
|
|
|
*/
|
2020-10-26 19:37:05 +00:00
|
|
|
|
snippet?: boolean,
|
2020-10-08 14:31:54 +00:00
|
|
|
|
/**
|
|
|
|
|
* Whether this command takes no arguments and braces are required.
|
|
|
|
|
*/
|
|
|
|
|
hasEmptyArguments?: boolean,
|
2020-10-26 19:37:05 +00:00
|
|
|
|
}): CompletionItem {
|
2020-10-08 14:31:54 +00:00
|
|
|
|
return {
|
|
|
|
|
label: '@' + name,
|
|
|
|
|
kind: vscode.CompletionItemKind.Function,
|
|
|
|
|
detail: detail,
|
2020-10-26 19:37:05 +00:00
|
|
|
|
sortText: name + (extraArgs?.snippet ? '1' : ''),
|
2020-10-08 14:31:54 +00:00
|
|
|
|
filterText: name,
|
2020-10-10 17:36:05 +00:00
|
|
|
|
insertText: name + (extraArgs?.hasEmptyArguments ? '{}' : ''),
|
2020-10-26 19:37:05 +00:00
|
|
|
|
snippet: extraArgs?.snippet,
|
2020-10-10 17:36:05 +00:00
|
|
|
|
};
|
2020-10-08 14:31:54 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-10-18 17:31:43 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a block command.
|
|
|
|
|
*
|
2020-10-19 17:29:01 +00:00
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
2020-11-13 11:02:34 +00:00
|
|
|
|
* @param args
|
2020-10-18 17:31:43 +00:00
|
|
|
|
*/
|
2020-11-13 11:02:34 +00:00
|
|
|
|
function blockCommand(name: string, detail: string, ...args: string[]) {
|
|
|
|
|
return [blockSnippet(name, detail, ...args), command(name, detail, { snippet: true })];
|
2020-10-18 15:51:00 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-10-18 17:31:43 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a brace command.
|
|
|
|
|
*
|
2020-10-19 17:29:01 +00:00
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
2020-11-13 11:02:34 +00:00
|
|
|
|
* @param args
|
2020-10-18 17:31:43 +00:00
|
|
|
|
*/
|
2020-10-18 15:51:00 +00:00
|
|
|
|
function braceCommand(name: string, detail: string, numArgsRequired: number, ...args: string[]) {
|
2020-10-26 19:37:05 +00:00
|
|
|
|
return [braceCommandSnippet(name, detail, numArgsRequired, ...args), command(name, detail, { snippet: true })];
|
2020-10-19 17:29:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-11-05 07:24:06 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a brace command where the argument is an enum.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
|
|
|
|
* @param items
|
|
|
|
|
*/
|
|
|
|
|
function braceCommandEnum(name: string, detail: string, ...items: string[]) {
|
|
|
|
|
return [
|
|
|
|
|
snippet(name, name, detail, 0, `@${name}{${items.join('/')}}`, `${name}{\${1|${items.join(',')}|}}`),
|
|
|
|
|
command(name, detail, { snippet: true }),
|
|
|
|
|
];
|
|
|
|
|
}
|
|
|
|
|
|
2020-10-19 17:29:01 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a line command with arguments.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
|
|
|
|
* @param args
|
|
|
|
|
*/
|
|
|
|
|
function lineCommand(name: string, detail: string, ...args: string[]) {
|
2020-10-26 19:37:05 +00:00
|
|
|
|
return [lineCommandSnippet(name, detail, ...args), command(name, detail, { snippet: true })];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a line command with arguments which has an x-form.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
|
|
|
|
* @param args
|
|
|
|
|
*/
|
|
|
|
|
function lineCommandX(name: string, detail: string, ...args: string[]) {
|
|
|
|
|
return [...lineCommand(name, detail, ...args), ...lineCommand(name + 'x', detail, ...args)];
|
2020-10-18 15:51:00 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-10-18 17:31:43 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for a line command where the argument is an enum.
|
|
|
|
|
*
|
2020-10-19 17:29:01 +00:00
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
2020-10-18 17:31:43 +00:00
|
|
|
|
*/
|
2020-10-18 15:51:00 +00:00
|
|
|
|
function lineCommandEnum(name: string, detail: string, ...items: string[]) {
|
|
|
|
|
return [
|
|
|
|
|
snippet(name, name, detail, 0, `@${name} ${items.join('/')}`, `${name} \${1|${items.join(',')}|}`),
|
2020-10-26 19:37:05 +00:00
|
|
|
|
command(name, detail, { snippet: true }),
|
2020-10-18 15:51:00 +00:00
|
|
|
|
];
|
|
|
|
|
}
|
|
|
|
|
|
2020-11-13 11:02:34 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion items for heading/footing commands.
|
|
|
|
|
*
|
|
|
|
|
* @param name
|
|
|
|
|
* @param detail
|
|
|
|
|
*/
|
|
|
|
|
function headingFootingCommand(name: string, detail: string) {
|
|
|
|
|
return [
|
|
|
|
|
snippet(name, name, detail, 0, `@${name} left @| center @| right`,
|
|
|
|
|
name + ' ${1:left} @| ${2:center} @| ${3:right}'),
|
|
|
|
|
command(name, detail, { snippet: true }),
|
|
|
|
|
];
|
|
|
|
|
}
|
|
|
|
|
|
2020-10-11 19:27:53 +00:00
|
|
|
|
/**
|
2020-10-18 17:31:43 +00:00
|
|
|
|
* Build the completion item for a snippet of a brace command.
|
2020-10-11 19:27:53 +00:00
|
|
|
|
*
|
|
|
|
|
* @param name The command name.
|
|
|
|
|
* @param detail The command description.
|
|
|
|
|
* @param numArgsRequired Number of required arguments.
|
|
|
|
|
* @param args Argument names.
|
|
|
|
|
*/
|
2020-10-19 17:29:01 +00:00
|
|
|
|
function braceCommandSnippet(name: string, detail: string, numArgsRequired: number, ...args: string[]) {
|
2020-10-11 19:27:53 +00:00
|
|
|
|
const documentation = `@${name}{${args.map((arg, idx) => idx < numArgsRequired ? arg : '?' + arg).join(', ')}}`;
|
|
|
|
|
const optionalArgs = args.splice(numArgsRequired).map((arg, idx) => `\${${numArgsRequired + idx + 2}:${arg}}`);
|
|
|
|
|
const requiredArgs = args.map((arg, idx) => `\${${idx + 1}:${arg}}`);
|
2020-10-18 15:51:00 +00:00
|
|
|
|
const optionalText = optionalArgs.length === 0 ? '' : `\${${numArgsRequired + 1}:, ${optionalArgs.join(', ')}}`;
|
|
|
|
|
const insertText = `${name}{${requiredArgs.join(', ')}${optionalText}}`;
|
2020-10-11 19:27:53 +00:00
|
|
|
|
return snippet(name, name, detail, 0, documentation, insertText);
|
|
|
|
|
}
|
|
|
|
|
|
2020-10-19 17:29:01 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion item for a snippet of a brace command.
|
|
|
|
|
*
|
|
|
|
|
* @param name The command name.
|
|
|
|
|
* @param detail The command description.
|
|
|
|
|
* @param args Argument names.
|
|
|
|
|
*/
|
|
|
|
|
function lineCommandSnippet(name: string, detail: string, ...args: string[]) {
|
2020-11-13 11:02:34 +00:00
|
|
|
|
const argsIndexed = args.map((arg, idx) => `\${${idx + 1}:${arg}}`).join(' ');
|
|
|
|
|
return snippet(name, name, detail, 0, `@${name} ${args.join(' ')}`, `${name} ${argsIndexed}`);
|
2020-10-19 17:29:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-10-11 19:27:53 +00:00
|
|
|
|
/**
|
|
|
|
|
* Build the completion item for a snippet of a block.
|
|
|
|
|
*
|
|
|
|
|
* @param name The snippet name.
|
|
|
|
|
* @param detail The snippet description.
|
|
|
|
|
*/
|
2020-11-13 11:02:34 +00:00
|
|
|
|
function blockSnippet(name: string, detail: string, ...args: string[]) {
|
|
|
|
|
const argsIndexed = args.map((arg, idx) => `\${${idx + 1}:${arg}}`).join(' ');
|
|
|
|
|
return snippet(name, name, detail, 0, `@${name} ${args.join(' ')}\n\n@end ${name}`,
|
|
|
|
|
`${name} ${argsIndexed}\n$${args.length + 1}\n@end ${name}`);
|
2020-10-08 14:31:54 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Build the completion item for a generic snippet.
|
|
|
|
|
*
|
|
|
|
|
* @param label The string showing up in the completion list.
|
|
|
|
|
* @param keyword The word typed by the user.
|
|
|
|
|
* @param detail The snippet description.
|
|
|
|
|
* @param sortOrder Sort order for this completion item when names collide.
|
|
|
|
|
* @param documentation The Markdown documentation for this snippet.
|
|
|
|
|
* @param insertText The text to replace current word when the item is selected.
|
|
|
|
|
*/
|
|
|
|
|
function snippet(
|
|
|
|
|
label: string,
|
|
|
|
|
keyword: string,
|
|
|
|
|
detail: string,
|
|
|
|
|
sortOrder: number,
|
|
|
|
|
documentation: string,
|
|
|
|
|
insertText: string,
|
2020-10-26 19:37:05 +00:00
|
|
|
|
): CompletionItem {
|
2020-10-08 14:31:54 +00:00
|
|
|
|
return {
|
|
|
|
|
label: label,
|
|
|
|
|
kind: vscode.CompletionItemKind.Snippet,
|
2020-10-26 19:37:05 +00:00
|
|
|
|
detail: detail,
|
2020-10-08 14:31:54 +00:00
|
|
|
|
documentation: snippetDocumentation(documentation),
|
|
|
|
|
sortText: keyword + sortOrder.toString(),
|
|
|
|
|
filterText: keyword,
|
|
|
|
|
insertText: new vscode.SnippetString(insertText),
|
2020-10-10 17:36:05 +00:00
|
|
|
|
};
|
2020-10-08 14:31:54 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Wraps Texinfo snippet code into a Markdown code block for documentation.
|
|
|
|
|
*
|
2020-10-19 17:29:01 +00:00
|
|
|
|
* @param snippet The snippet code.
|
2020-10-08 14:31:54 +00:00
|
|
|
|
*/
|
|
|
|
|
function snippetDocumentation(snippet: string) {
|
2020-10-10 17:36:05 +00:00
|
|
|
|
return new vscode.MarkdownString('```texinfo\n' + snippet + '\n```');
|
2020-10-08 14:31:54 +00:00
|
|
|
|
}
|