[RDY] menu_get() / export menus #6322

teto · 2017-03-21T02:25:00Z

adds export_menu that saves menus to a dict.
let l = export_menus("")
With json_encode, this allows UIs to retrieve the menus (likewise for plugins, eg, a certain "palette")

Crashes for now.

teto · 2017-03-21T17:14:46Z

Removed the crash.
In my init.vim, I have:
menu Spell.FR :setlocal spell spelllang=fr_fr<CR>
If you run :echo export_menus(""); it get exported as "ncommand": ":setlocal spell spelllang=fr_fr\r", I wonder if the \r can be a problem ?

teto · 2017-04-02T18:44:43Z

I use a function to test locally:

function! ExportMenus(path, modes)
	" export all for now
	let m = export_menus(a:path, 'n')
	let r =  json_encode(m)
	" put =r " to display in current buffer
	call writefile([r], "menus.txt")
endfunc

So far it generates:

[
    {
        "enabled": 0,
        "hidden": 0,
        "hint": 0,
        "name": "Spell",
        "priority": 500,
        "shortcut": 0,
        "submenus": [
            {
                "enabled": 0,
                "hidden": 0,
                "hint": 0,
                "implementations": [
                    {
                        "noremap": 0,
                        "rhs": ":setlocal spell spelllang=en_us | call histadd('cmd', 'setlocal spell spelllang=en_us')\r",
                        "sid": 0,
                        "silent": 0
                    }
                ],
                "name": "EN_US",
                "priority": 500,
                "shortcut": 0
            },
            {
                "enabled": 0,
                "hidden": 0,
                "hint": 0,
                "implementations": [
                    {
                        "noremap": 0,
                        "rhs": ":setlocal spell spelllang=fr_fr\r",
                        "sid": 0,
                        "silent": 0
                    }
                ],
                "name": "FR",
                "priority": 500,
                "shortcut": 0
            }
        ]
    },
    {
        "enabled": 0,
        "hidden": 0,
        "hint": 0,
        "name": "Trans",
        "priority": 500,
        "shortcut": 0,
        "submenus": [
            {
                "enabled": 0,
                "hidden": 0,
                "hint": 0,
                "implementations": [
                    {
                        "noremap": 0,
                        "rhs": ":te trans :fr <cword>\r",
                        "sid": 0,
                        "silent": 0
                    }
                ],
                "name": "FR",
                "priority": 500,
                "shortcut": 0
            }
        ]
    },
    {
        "enabled": 0,
        "hidden": 0,
        "hint": 0,
        "name": "Search",
        "priority": 500,
        "shortcut": 0,
        "submenus": [
            {
                "enabled": 0,
                "hidden": 0,
                "hint": 0,
                "implementations": [
                    {
                        "noremap": 0,
                        "rhs": ":exe Grepper -grepprg rg --vimgrep $* $.",
                        "sid": 0,
                        "silent": 0
                    }
                ],
                "name": "CurrentBuffer",
                "priority": 500,
                "shortcut": 0
            },
            {
                "enabled": 0,
                "hidden": 0,
                "hint": 0,
                "implementations": [
                    {
                        "noremap": 0,
                        "rhs": ":exe Grepper -grepprg rg --vimgrep $* $+",
                        "sid": 0,
                        "silent": 0
                    }
                ],
                "name": "AllBuffers",
                "priority": 500,
                "shortcut": 0
            }
        ]
    },

It doesn't handle icons as neovim removed support for icons and it feels too much to have neovim handle icons IMO.

if that's ok I can proceed to clean up & write the tests ? any advice as how to write the advice ? I believe I can compare a lua table against the expored json ?

    local m = funcs.export_menus("","")
    m = funcs.json_encode(m)

justinmk · 2017-04-02T19:36:02Z

export_menus() doesn't seem the right name. Currently we have foo_encode(), foo_dump(), and foo_get(). Let's not add "export". I would think menu_get() is fine, as Bram mentioned in the Vim ticket.
If gVim has icon support for menus, we should restore that (at least as far as providing a field in the dictionary and :menu; how/if it is supported is decided by UIs). Not necessarily in this PR, but just FYI.

I believe I can compare a lua table against the expored json ?

If you get the map through a API function (e.g. nvim_get_menu()/nvim_buf_get_menu() pair, just like nvim_[buf_]get_keymap() in @tjdevries PR), it will automatically marshall to a Lua table which can be compared using helpers.eq().

Note: dict_T can be converted to a Dictionary easily using vim_to_object(). https://github.com/neovim/neovim/pull/6236/files#diff-09dda282c4c37768c819b2661ed15f14R729

teto

I will complete the tests when the form of the exported dict seems correct, maybe the mnemonic should be converted back to a chracter ?

teto · 2017-04-03T19:51:29Z

runtime/doc/eval.txt

@@ -5449,6 +5449,30 @@ max({list})	Return the maximum value of all items in {list}.
 		be used as a Number this results in an error.
 		An empty |List| results in zero.

+menu_get({path}, {modes})				*dump_menu()*


dump_menu => menu_get

teto · 2017-04-03T19:52:37Z

runtime/doc/eval.txt

+ilent': 0, 'sid': 1, 'rhs': 'x'}, 'i': {'noremap': 1, 'enabled': 1, 'silent': 0, 'sid': 1, 'rhs': 'insert'},
+ 'n': {'noremap': 1, 'enabled': 1, 'silent': 0, 'sid': 1, 'rhs': 'inormal'}}}], 'name': 'Test', 'priority':
+500, 'shortcut': 84}
+]


ZyX-l suggested to add an example, too bad we can't generate it from the code. is there any vim-prettify that I could use to properly format this part ?

Heh. Sadly gqq can't format Vim's own syntax. But I would:

Join it to one line

json_encode() it: :put =json_encode(<C-R>=getline('.')<CR>)

Format it:
:setl formatprg=python\ -m\ json.tool gqq

(If it's just showing a generic map, doesn't matter if it's JSON or VimL, I suppose. Though in this case the JSON is valid VimL)

teto · 2017-04-03T19:52:54Z

src/nvim/eval.lua

@@ -85,6 +85,7 @@ return {
    exists={args=1},
    exp={args=1, func="float_op_wrapper", data="&exp"},
    expand={args={1, 3}},
+    menu_get={args={1, 2}},


Need to put in alphabetical order.

ZyX-I · 2017-04-03T23:36:04Z

AFAIR it was not me who suggested to add an example. Actually documentation I write tends to be more “raw description” then something with examples. (I am not saying that this is how documentation should be written, only how I normally write it.)

As for how you get the results: use [helpers.]funcs.menu_get(args) for VimL functions like now. I am rather unsure about adding API function in the PR: calling VimL function is basically just as easy and it makes overhead (converting VimL value while you can just create Array directly, theoretically even create msgpack directly (need serious refactoring, see #4971)) more obvious.

teto · 2017-04-04T00:11:45Z

Maybe I misunderstood; from vim/vim#1563:

An example in the docs would be very helpful.

whatever, the example is helpful anyway. I don't think adding API functions is helpful either.

Without further comments, I consider the PR ready (functional tests pass locallly, hopes it passes here), icons & hints can be added later when UIs need it.

ZyX-I · 2017-04-04T04:52:17Z

@teto You are referring to vim/vim#1563 (comment)? This is comment from Bram, he is quoting me.

You can try :PaletteMenu to just have menu items, :Palette should mix both neovim/neovim#6322

teto · 2017-07-24T21:25:07Z

I made a poc in this plugin (not optimized, still brittle but works locally) https://github.com/teto/nvim-palette. While waiting for #6288, I embed a copy https://github.com/teto/nvim-palette/tree/master/data in the plugin so the palette can load option descriptions.
Then if you use this PR with the plugin, you should have :PaletteMenu (only menu entries) working and :Palette should regroup both options and menu entries.

justinmk · 2017-07-24T22:35:54Z

runtime/doc/eval.txt

+    echo menu_get("")
+>
+should produce an output with a similar structure:
+<


I think these > ... < pairs are reversed.

For instance, executing: > nnoremenu &Test.Test inormal inoremenu Test.Test insert vnoremenu Test.Test x echo menu_get("") < should produce an output with a similar structure: >

The sample output could be abbreviated like this:

{ "hidden": 0, "name": "Test", "priority": 500, "shortcut": 84, "submenus": [ { "hidden": 0, "implementations": { "i": { "enabled": 1, "noremap": 1, "rhs": "insert", "sid": 1, "silent": 0 }, "n": { ... }, "s": { ... }, "v": { ... } }, "name": "Test", "priority": 500, "shortcut": 0 } ] }

several things were wrong with the doc ('>' pairs, spaces vs tabs, json format etc). I updated it and checked, I think it's fine now.

justinmk · 2017-07-24T22:46:44Z

Instead of "implementations", "definitions" or "mappings" would be a more familiar name (if either of those makes sense in context).

justinmk · 2017-07-24T22:47:06Z

I don't see any reason to keep this waiting. Anyone else have comments?

teto · 2017-07-25T00:03:02Z

rebased, renamed "implementations" to "mappings".

menu_get({path}, {modes}). See :h menu_get.

justinmk · 2017-07-28T00:47:29Z

merged. nicely done!

menu_get({path}, {modes}). See :h menu_get.

FEATURES: 0e873a3 Lua(Jit) built-in neovim#4411 5b32bce Windows: `:terminal` neovim#7007 7b0ceb3 UI/API: externalize cmdline neovim#7173 b67f58b UI/API: externalize wildmenu neovim#7454 b23aa1c UI: 'winhighlight' neovim#6597 17531ed UI: command-line coloring (`:help input()-highlight`) neovim#6364 244a1f9 API: execute lua directly from the remote api neovim#6704 45626de API: `get_keymap()` neovim#6236 db99982 API: `nvim_get_hl_by_name()`, `nvim_get_hl_by_id()` neovim#7082 dc68538 menu_get() function neovim#6322 9db42d4 :cquit : take an error code argument neovim#7336 9cc185d job-control: serverstart(): support ipv6 neovim#6680 1b7a9bf job-control: sockopen() neovim#6594 6efe84a clipboard: fallback to tmux clipboard neovim#6894 6016ac2 clipboard: customize clipboard with `g:clipboard` neovim#6030 3a86dd5 ruby: override ruby host via `g:ruby_host_prog` neovim#6841 16cce1a debug: $NVIM_LOG_FILE neovim#6827 0cba3da `:checkhealth` built-in, validates $VIMRUNTIME neovim#7399 FIXES: 105d680 TUI: more terminals, improve scroll/resize neovim#6816 cb912a3 :terminal : handle F1-F12, other keys neovim#7241 619838f inccommand: improve performance neovim#6949 04b3c32 inccommand: Fix matches for zero-width neovim#7487 60b1e8a inccommand: multiline, other fixes neovim#7315 f1f7f3b inccommand: Ignore leading modifiers in the command neovim#6967 1551f71 inccommand: fix 'gdefault' lockup neovim#7262 6338199 API: bufhl: support creating new groups neovim#7414 541dde3 API: allow K_EVENT during operator-pending 8c732f7 terminal: adjust for 'number' neovim#7440 5bec946 UI: preserve wildmenu during jobs/events neovim#7110 c349083 UI: disable 'lazyredraw' during ui_refresh. neovim#6259 51808a2 send FocusGained/FocusLost event instead of pseudokey neovim#7221 133f8bc shada: preserve unnamed register on restart neovim#4700 1b70a1d shada: avoid assertion on corrupt shada file neovim#6958 9f534f3 mksession: Restore tab-local working directory neovim#6859 de1084f fix buf_write() crash neovim#7140 7f76986 syntax: register 'Normal' highlight group neovim#6973 6e7a8c3 RPC: close channel if stream was closed neovim#7081 85f3084 clipboard: disallow recursion; show hint only once neovim#7203 8d1ccb6 clipboard: performance, avoid weird edge-cases neovim#7193 01487d4 'titleold' neovim#7358 01e53a5 Windows: better path-handling, separator (slash) hygiene neovim#7349 0f2873c Windows: multibyte startup arguments neovim#7060 CHANGES: 9ff0cc7 :terminal : start in normal-mode neovim#6808 032b088 lower priority of 'cursorcolumn', 'colorcolumn' neovim#7364 2a3bcd1 RPC: Don't delay notifications when request is pending neovim#6544 023f67c :terminal : Do not change 'number', 'relativenumber' neovim#6796 1ef2d76 socket.c: Disable Nagle's algorithm on TCP sockets neovim#6915 6720fe2 help: `K` tries Vim help instead of manpage neovim#3104 7068370 help, man.vim: change "outline" map to `gO` neovim#7405

marvim added the WIP label Mar 21, 2017

teto force-pushed the menus branch 2 times, most recently from 0b23039 to 8c196cd Compare March 21, 2017 15:46

teto mentioned this pull request Mar 21, 2017

Make menus available to scripts vim/vim#1563

Closed

teto force-pushed the menus branch 2 times, most recently from fb97fde to 869cea5 Compare April 2, 2017 18:36

teto force-pushed the menus branch from 869cea5 to 3f6a06f Compare April 3, 2017 18:45

teto commented Apr 3, 2017

View reviewed changes

teto force-pushed the menus branch from 3e173f0 to b8757a6 Compare April 3, 2017 23:27

teto changed the title ~~[WIP] Attempt at exporting menus~~ [RFC/RDY] Attempt at exporting menus Apr 4, 2017

justinmk added this to the 0.2.1 milestone Apr 4, 2017

teto force-pushed the menus branch 2 times, most recently from 7d0c93a to 6d7f1df Compare May 2, 2017 15:44

fmoralesc mentioned this pull request May 7, 2017

Make set mouse= or set mouse=c the default #5938

Closed

teto force-pushed the menus branch from 6d7f1df to 64ec478 Compare June 16, 2017 15:40

teto changed the title ~~[RFC/RDY] Attempt at exporting menus~~ [RDY] Attempt at exporting menus Jun 16, 2017

marvim added RDY and removed WIP labels Jun 18, 2017

fmoralesc mentioned this pull request Jul 1, 2017

Descriptive Maps #6123

Closed

teto force-pushed the menus branch from 64ec478 to af09658 Compare July 2, 2017 21:48

teto force-pushed the menus branch 2 times, most recently from 440e8ba to 670bebb Compare July 23, 2017 01:02

teto added a commit to teto/nvim-palette that referenced this pull request Jul 24, 2017

Now supports menu items

3dbd1e4

You can try :PaletteMenu to just have menu items, :Palette should mix both neovim/neovim#6322

justinmk reviewed Jul 24, 2017

View reviewed changes

teto force-pushed the menus branch from 670bebb to 6e25bd4 Compare July 25, 2017 00:00

Adds menu_get function to export menus to json

5021625

menu_get({path}, {modes}). See :h menu_get.

teto force-pushed the menus branch from 6e25bd4 to 5021625 Compare July 25, 2017 00:31

justinmk changed the title ~~[RDY] Attempt at exporting menus~~ [RDY] menu_get() / export menus Jul 25, 2017

justinmk mentioned this pull request Jul 27, 2017

rpc: close channel if stream was closed #7081

Merged

1 task

justinmk closed this Jul 28, 2017

justinmk pushed a commit that referenced this pull request Jul 28, 2017

viml: introduce menu_get() function #6322

dc68538

menu_get({path}, {modes}). See :h menu_get.

teto deleted the menus branch July 28, 2017 02:05

KillTheMule mentioned this pull request Sep 30, 2017

[RDY] menu_get: prettyprint special chars #7340

Merged

justinmk mentioned this pull request Nov 8, 2017

NVIM v0.2.1 #7505

Merged

Uh oh!

[RDY] menu_get() / export menus #6322

[RDY] menu_get() / export menus #6322

Uh oh!

Conversation

teto commented Mar 21, 2017

Uh oh!

teto commented Mar 21, 2017

Uh oh!

teto commented Apr 2, 2017

Uh oh!

justinmk commented Apr 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

teto left a comment

Choose a reason for hiding this comment

Uh oh!

teto Apr 3, 2017

Choose a reason for hiding this comment

Uh oh!

teto Apr 3, 2017

Choose a reason for hiding this comment

Uh oh!

justinmk Apr 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teto Apr 3, 2017

Choose a reason for hiding this comment

Uh oh!

ZyX-I commented Apr 3, 2017

Uh oh!

teto commented Apr 4, 2017

Uh oh!

ZyX-I commented Apr 4, 2017

Uh oh!

teto commented Jul 24, 2017

Uh oh!

justinmk Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

justinmk Jul 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teto Jul 25, 2017

Choose a reason for hiding this comment

Uh oh!

justinmk commented Jul 24, 2017

Uh oh!

justinmk commented Jul 24, 2017

Uh oh!

teto commented Jul 25, 2017

Uh oh!

justinmk commented Jul 28, 2017

Uh oh!

Uh oh!

justinmk commented Apr 2, 2017 •

edited

Loading

justinmk Apr 3, 2017 •

edited

Loading

justinmk Jul 24, 2017 •

edited

Loading