Add script for updating builtin_commands table

Make the script in #29 executable from shell script.

USAGE: ./scripts/update_builtin_commands.sh /path/to/vim/src/ex_cmds.h

Example:

$ ./scripts/update_builtin_commands.sh /home/haya14busa/src/github.com/vim/vim/src/ex_cmds.h
Append following lines to s:VimLParser.builtin_commands in autoload/vimlparser.vim

      \ {'flags': 'BANG|TRLBAR|SBOXOK|CMDWIN', 'minlen': 5, 'name': 'packloadall', 'parser': 'parse_cmd_common'},
      \ {'flags': 'RANGE|EXTRA|NEEDARG|CMDWIN', 'minlen': 3, 'name': 'pyx', 'parser': 'parse_cmd_common'},
      \ {'flags': 'RANGE|DFLALL|EXTRA|NEEDARG|CMDWIN', 'minlen': 4, 'name': 'pyxdo', 'parser': 'parse_cmd_common'},
      \ {'flags': 'RANGE|EXTRA|NEEDARG|CMDWIN', 'minlen': 7, 'name': 'pythonx', 'parser': 'parse_cmd_common'},
      \ {'flags': 'RANGE|FILE1|NEEDARG|CMDWIN', 'minlen': 4, 'name': 'pyxfile', 'parser': 'parse_cmd_common'},
      \ {'flags': 'TRLBAR|CMDWIN|SBOXOK', 'minlen': 3, 'name': 'smile', 'parser': 'parse_cmd_common'},

Author: haya14busa

autoload/vimlparser.vim

@@ -1859,6 +1859,8 @@ let s:VimLParser.neovim_removed_commands = [
       \ {"name":"tearoff", "minlen":2, "flags":"NEEDARG|EXTRA|TRLBAR|NOTRLCOM|CMDWIN", "parser":"parse_cmd_common"},
       \ {"name":"gvim", "minlen":2, "flags":"BANG|FILES|EDITCMD|ARGOPT|TRLBAR|CMDWIN", "parser":"parse_cmd_common"}]
 
+" To find new builtin_commands, run the below script.
+" $ scripts/update_builtin_commands.sh /path/to/vim/src/ex_cmds.h
 let s:VimLParser.builtin_commands = [
       \ {'name': 'append', 'minlen': 1, 'flags': 'BANG|RANGE|ZEROR|TRLBAR|CMDWIN|MODIFY', 'parser': 'parse_cmd_append'},
       \ {'name': 'abbreviate', 'minlen': 2, 'flags': 'EXTRA|TRLBAR|NOTRLCOM|USECTRLV|CMDWIN', 'parser': 'parse_cmd_common'},

scripts/update_builtin_commands.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+if [ $# -ne 1 ]; then
+  echo "USAGE: ./scripts/update_builtin_commands.sh /path/to/vim/src/ex_cmds.h"
+  exit 1
+fi
+
+vim -u NONE -i NONE -n -N -e -s \
+  --cmd "let &rtp .= ',' . getcwd()" \
+  --cmd "source scripts/update_builtin_commands.vim" \
+  --cmd "call g:VimLParserNewCmds('$1')" \
+  --cmd "qall!"
+echo

scripts/update_builtin_commands.vim

@@ -0,0 +1,138 @@
+" create builtin command table
+let s:Trie = {
+\   'data': {},
+\ }
+
+function! s:Trie.new() abort
+  return deepcopy(self)
+endfunction
+
+function! s:Trie.add(s) abort
+  let d = self.data
+  for c in split(a:s, '\zs')
+    if !has_key(d, c)
+      let d[c] = {}
+    endif
+    let d = d[c]
+  endfor
+endfunction
+
+function! s:Trie.in(s) abort
+  let d = self.data
+  for c in split(a:s, '\zs')
+    if has_key(d, c)
+      let d = d[c]
+    else
+      return v:false
+    endif
+  endfor
+  return v:true
+endfunction
+
+function! s:Trie.common(s) abort
+  let d = self.data
+  let common = []
+  for c in split(a:s, '\zs')
+    if has_key(d, c)
+      let common = add(common, c)
+      let d = d[c]
+    else
+      break
+    endif
+  endfor
+  return join(common, '')
+endfunction
+
+function! s:Trie.remove(s) abort
+  let d = self.data
+  let kss = [[]]
+  for c in split(a:s, '\zs')
+    if has_key(d, c)
+      let kss = add(kss, copy(kss[-1]) + [c])
+      let d = d[c]
+    else
+      return v:false
+    endif
+  endfor
+  let kss = kss[1:]
+  let kss = reverse(kss)
+  for ks in kss
+    let d = self.data
+    for [i, k] in map(copy(ks[:-2]), {i, k->[i,k]})
+      let pd = d
+      let nk = ks[i+1]
+      let d = d[k]
+    endfor
+    if empty(pd[k][nk])
+      unlet pd[k][nk]
+    else
+      return v:true
+    endif
+  endfor
+  return v:true
+endfunction
+
+function! s:gen(ex_cmds_h) abort
+  let lines = readfile(a:ex_cmds_h)
+
+  " { 'name': string, 'flags': string, 'minlen': int, 'parser': string}
+  let cmds = []
+
+  let trie = s:Trie.new()
+
+  let cumname = ''
+  for [i, line] in map(copy(lines), {i, l -> [i, l]})
+    if line =~# '^EX('
+      let name = matchstr(line, '"\zs.*\ze",')
+      let flags = matchstr(lines[i+1], '\t\+\zs.*\ze,$')
+
+      let minlen = len(trie.common(name)) + 1
+      call trie.add(name)
+
+      let cmd = {
+      \   'name': name,
+      \   'flags': flags,
+      \   'minlen': minlen,
+      \ }
+      let cmds = add(cmds, cmd)
+    endif
+  endfor
+  return cmds
+endfunction
+
+function! s:gen_new_builtin(existing, latest) abort
+  let existing_names = {}
+  for cmd in a:existing
+    let existing_names[cmd.name] = v:true
+  endfor
+  let newcmds = []
+  for cmd in filter(copy(a:latest), {_, c -> !has_key(existing_names, c.name)})
+    let newcmds = add(newcmds, extend(cmd, {'parser': 'parse_cmd_common'}))
+  endfor
+  return newcmds
+endfunction
+
+function! s:gen_viml(newcmds) abort
+  let lines = []
+  for c in a:newcmds
+    let lines = add(lines, '      \ ' . string(c) . ',')
+  endfor
+  return join(lines, "\n")
+endfunction
+
+" -- main
+
+" ex_cmds_h: path to vim/src/ex_cmds.h
+function! g:VimLParserNewCmds(ex_cmds_h) abort
+  let vimlparser = vimlparser#import()
+  let latest = s:gen(a:ex_cmds_h)
+  let new_cmds = s:gen_new_builtin(vimlparser#import().VimLParser.builtin_commands, latest)
+  let generated_text = s:gen_viml(new_cmds)
+  if generated_text == ''
+    verbose echo 's:VimLParser.builtin_commands in autoload/vimlparser.vim is up-to-date.'
+  else
+    verbose echo "Append following lines to s:VimLParser.builtin_commands in autoload/vimlparser.vim\n"
+    verbose echo generated_text
+  endif
+endfunction
+" call s:vimlparser_new_cmds('/home/haya14busa/src/github.com/vim/vim/src/ex_cmds.h')