[RFC] Implement rpc interface for setting external GUI features #431
Conversation
|
@equalsraf This should be ready for you to review. |
BoltsJ
changed the title
README.md
Outdated
| @@ -52,6 +52,10 @@ Commands for interacting with the GUI are regular commands, available in the doc | |||
|
|
|||
| You can set GUI options on startup, in the GUI configuration file (:help ginit.vim). | |||
|
|
|||
| To disable the GUI tabline and use the nvim TUI tabline, call | |||
|
|
|||
| :call rpcnotify(0, "Gui", "Option", "Tabline", 0) | |||
There was a problem hiding this comment.
Maybe it is worth it to add a command to the shim, instead of having the user call rpcnotify
There was a problem hiding this comment.
function s:GuiExtTabline(enable)
call rpcnotify(0, "Gui", "Option", "Tabline", a:enable)
endfunction
command -nargs=1 GuiExtTabline call s:GuiExtTabline(<args>)There was a problem hiding this comment.
I have added the command as GuiTabline.
src/gui/mainwindow.h
Outdated
| @@ -45,6 +45,7 @@ private slots: | |||
| void neovimIsUnsupported(); | |||
| void neovimShowtablineSet(int); | |||
| void neovimTablineUpdate(int64_t curtab, QList<Tab> tabs); | |||
| void neovimGuiOptionSet(const QString& name, const QVariant& value); | |||
There was a problem hiding this comment.
Instead of passing around the QVariant from Shell to the MainWindow, I would prefer to have per option signals/slots. For example this could be
void MainWindow::extTablineSet(bool);There was a problem hiding this comment.
Done. I changed the signal to Shell::neovimExtTablineSet and the matching slot to MainWindow::extTablineSet.
test/tst_shell.cpp
Outdated
| QSignalSpy onOptionSet(s, &Shell::extGuiOptionSet); | ||
| QVERIFY(onOptionSet.isValid()); | ||
| QVERIFY(SPYWAIT(onOptionSet)); | ||
| } |
There was a problem hiding this comment.
Perhaps add another test in guiShimCommands() that checks for the signal when using vim_command
diff --git a/test/tst_shell.cpp b/test/tst_shell.cpp
index b813494..89d583e 100644
--- a/test/tst_shell.cpp
+++ b/test/tst_shell.cpp
@@ -123,6 +123,12 @@ private slots:
checkCommand(c, "GuiFont DejaVu Sans Mono:h14:b:l", false);
QCOMPARE(s->shell()->fontDesc(), QString("DejaVu Sans Mono:h14:l"));
#endif
+
+ QSignalSpy onOptionSet(s->shell(), &Shell::extGuiOptionSet);
+ checkCommand(c, "call rpcnotify(0, \"Gui\", \"Option\", \"Tabline\", 0)", false);
+ QVERIFY(onOptionSet.isValid());
+ QVERIFY(SPYWAIT(onOptionSet));
+ qDebug() << onOptionSet << onOptionSet.size();
}
protected:
There was a problem hiding this comment.
I added your suggested test for the GuiTabline command.
|
Looks good. Can you rebase into a single commit so I can merge? |
|
I just realized that starting with |
Add handler for GUI option rpc notifications. Currently, only tabline is handled. Add signal for when nvim updates the value of ext_tabline and a matching slot to control visibility of the gui tabline. Add GuiTabline ex command to nvim_gui_shim.vim to enable and disable the GUI tabline. Document in runtime/doc/nvim_gui_shim.txt and README.md.
|
I fixed the empty tab bar and squashed the commits. Everything should be good to go. |
This will allow GUI options such as the GUI tabline, cmdline (#351), popupmenu (#349) and wildmenu to be enabled and disabled from
ginit.viminstead of command line switches.The interface will be
:call rpcnotify(0, "Gui", "Option", <option_name>, <value>), the same as neovim-gtk.Ref #361 #362 #366
TODO