├── LICENSE.txt ├── README.md ├── after └── plugin │ └── cmp_digraphs.lua └── lua └── cmp_digraphs.lua /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cmp-digraphs 2 | 3 | A [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) source for completing [digraphs](https://vimhelp.org/digraph.txt.html) (both built-in and custom ones). 4 | 5 | ## Usage 6 | 7 | ```lua 8 | local cmp = require('cmp') 9 | cmp.setup({ 10 | sources = { 11 | { name = 'digraphs' }, 12 | }, 13 | }) 14 | ``` 15 | 16 | ## Configuration 17 | 18 | ### `cache_digraphs_on_start` 19 | 20 | **Type:** `boolean` 21 | **Default:** `true` 22 | 23 | The code which gets a list of digraphs and formats it into completion items takes a significant amount of time (15-20 milliseconds), but digraphs don't really change at all while the editor is running, so by default this source will query the digraphs only once when it is invoked for the first time (meaning that it will see the custom digraphs defined in the vimrc). Disable this option only if you are for whatever reason adding digraphs at runtime. 24 | 25 | ### `filter` 26 | 27 | **Type:** `function` 28 | **Default:** `function(item) return item.charnr >= 0x20 end` 29 | 30 | Some characters (by default: ASCII control characters) are known to cause issues with nvim-cmp or Nvim itself, so they are not shown in the completion results. This function receives a table with the following keys and must return `true` if the digraph should be shown: 31 | 32 | - `digraph` - Two characters that the user must type to enter the digraph. 33 | - `char` - The character that will be inserted. 34 | - `charnr` - The index of that character in the Unicode table. 35 | -------------------------------------------------------------------------------- /after/plugin/cmp_digraphs.lua: -------------------------------------------------------------------------------- 1 | require('cmp').register_source('digraphs', require('cmp_digraphs')) 2 | -------------------------------------------------------------------------------- /lua/cmp_digraphs.lua: -------------------------------------------------------------------------------- 1 | local source = {} 2 | 3 | local option_defaults = { 4 | cache_digraphs_on_start = true, 5 | filter = function(item) return item.charnr >= 0x20 end, 6 | } 7 | 8 | function source.new() 9 | local self = setmetatable({}, { __index = source }) 10 | self._cached_items = nil 11 | return self 12 | end 13 | 14 | function source:get_keyword_pattern() 15 | return [[.\{1,2}]] 16 | end 17 | 18 | function source:complete(params, callback) 19 | local opts = vim.tbl_deep_extend('keep', params.option, option_defaults) 20 | vim.validate({ 21 | cache_digraphs_on_start = {opts.cache_digraphs_on_start, 'boolean'}, 22 | filter = {opts.filter, 'function'}, 23 | }) 24 | 25 | local items 26 | if opts.cache_digraphs_on_start then 27 | if self._cached_items == nil then 28 | self._cached_items = self:_get_completion_items(opts) 29 | end 30 | -- Just in case our tables are modified down the line. 31 | items = vim.deepcopy(self._cached_items) 32 | else 33 | items = self:_get_completion_items() 34 | end 35 | 36 | callback({ items = items }) 37 | end 38 | 39 | function source:_get_completion_items(opts) 40 | local items = {} 41 | -- Let's not create unnecessary garbage. 42 | local item_for_filter = { digraph = nil, char = nil, charnr = nil } 43 | for _, digraph_and_char in ipairs(self._get_digraphs_list()) do 44 | local digraph, char = unpack(digraph_and_char, 1, 2) 45 | local charnr = vim.fn.char2nr(char) 46 | item_for_filter.digraph = digraph 47 | item_for_filter.char = char 48 | item_for_filter.charnr = charnr 49 | if opts.filter(item_for_filter) then 50 | items[#items + 1] = { 51 | label = digraph .. ' ' .. vim.fn.strtrans(char), 52 | labelDetails = { detail = string.format('U+%04X', charnr) }, 53 | filterText = digraph, 54 | insertText = char, 55 | } 56 | end 57 | end 58 | return items 59 | end 60 | 61 | if vim.fn.exists('*digraph_getlist') ~= 0 then 62 | -- The digraphs API is a fairly new addition to Vim (patch 8.2.3184, commited 63 | -- on 2021-07-19), and, as of writing, hasn't been ported to Nvim yet. 64 | -- 65 | function source._get_digraphs_list() 66 | -- The boolean flag specifies whether we want to receive built-in digraphs 67 | -- or just the custom ones. 68 | return vim.fn.digraph_getlist(true) 69 | end 70 | elseif vim.fn.exists('*getdigraphlist') ~= 0 then 71 | -- Oh, and also its functions have been renamed (patch 8.2.3226, commited on 72 | -- 2021-07-26), so let's account for that, just in case. 73 | -- 74 | function source._get_digraphs_list() 75 | return vim.fn.getdigraphlist(true) 76 | end 77 | else 78 | 79 | -- Lastly, an implementation for the current version of Neovim (0.6.0). Based 80 | -- on . 81 | function source._get_digraphs_list() 82 | local output = vim.api.nvim_exec('digraphs', true) 83 | local list = {} 84 | 85 | local search_idx = 0 86 | local regex = [[(\S\S) %(\<\x\x\>|.) +(\d+)]] 87 | local regex_search, regex_groups = '\\v' .. regex, '\\v^' .. regex .. '$' 88 | while search_idx < #output do 89 | local match_str, match_start, match_end = unpack(vim.fn.matchstrpos(output, regex_search, search_idx), 1, 3) 90 | if not (match_start >= 0 and match_end >= 0) then break end 91 | search_idx = match_end 92 | local groups = vim.fn.matchlist(match_str, regex_groups) 93 | 94 | local digraph = groups[2] 95 | local char = vim.fn.nr2char(tonumber(groups[3], 10)) 96 | list[#list + 1] = { digraph, char } 97 | end 98 | 99 | return list 100 | end 101 | 102 | end 103 | 104 | return source 105 | --------------------------------------------------------------------------------