[RDY] allow external ui to draw tabline #6170

dzhou121 · 2017-02-24T09:36:05Z

Part of PR #5686

justinmk · 2017-02-27T17:55:47Z

runtime/doc/msgpack_rpc.txt

@@ -413,5 +417,9 @@ of update.
 ["popupmenu_hide"]
 	The popupmenu is hidden.

+["tabline", curtab, tabs]


An event is something that happens. Let's name this something more granular, e.g. "tabline_update". That follows the pattern of the existing "bg_update" and similar events.

justinmk · 2017-02-27T18:00:55Z

src/nvim/window.c

@@ -5158,6 +5160,9 @@ static void last_status_rec(frame_T *fr, int statusline)
 */
 int tabline_height(void)
 {
+  if (tabline_external) {


Can this query the UI structure instead of storing extra state in window.c? E.g. ui_is_widget_external(kUITabline), where the parameter is a enum like:

enum {
kUITabline,
kUIStatusline,
kUICmdline,
...
}

justinmk · 2017-02-28T09:06:01Z

src/nvim/ui.c

@@ -53,6 +53,10 @@ static bool pending_cursor_update = false;
 static int busy = 0;
 static int height, width;

+static bool tabline_external = false;
+static bool cmdline_external = false;
+static bool wildmenu_external = false;


I'm confused about why this extra state is needed. Can the uis be iterated to find the flag instead?

I see that it's because we are worried about the possibility that a UI might connect that doesn't support a externalized widget. Hmmm... ok.

So shall I keep these as is?

Yes it's fine.

justinmk · 2017-02-28T09:08:28Z

src/nvim/ui.c

+    case kUIWildmenu:
+      return wildmenu_external;
+    default:
+      return false;


Leave out the default case. Our build settings will catch a missing case at compile-time. But for that to work, the enum needs to be typedef'd.

justinmk · 2017-02-28T09:09:28Z

src/nvim/ui.h

+  kUITabline = 0
+  , kUICmdline
+  , kUIWildmenu
+};


Should be a named type, e.g. UIWidget

typedef enum { ... } UIWidget;

justinmk · 2017-02-28T09:10:40Z

src/nvim/ui.c

@@ -548,3 +555,31 @@ static void ui_mode_change(void)
  conceal_check_cursur_line();
 }

+bool ui_is_widget_external(int widget)


parameter should be UIWidget widget

justinmk · 2017-02-28T09:19:33Z

src/nvim/screen.c

@@ -6888,6 +6889,30 @@ static void draw_tabline(void)
  int use_sep_chars = (t_colors < 8
                       );

+  if (ui_is_widget_external(kUITabline)) {


Let's factor this out to a new function, draw_tabline_ext().

if (ui_is_widget_external(kUITabline)) { draw_tabline_ext(); return; }

If possible, try to follow a similar pattern for other externalized widgets.

justinmk · 2017-02-28T09:23:43Z

The built-in tabline supports mouse-clicks which run a user-defined VimL function (see kStlClickFuncRun, and the @ entry in :help 'statusline').

What are your thoughts about how externalized tabline widget can support that?

dzhou121 · 2017-02-28T09:57:34Z

The only way I can think of is that we output the raw format string to external ui and external ui can call the vimscript directly if that filed is clicked.

put draw_tabline_ext to a function

justinmk · 2017-02-28T10:47:02Z

The only way I can think of is that we output the raw format string to external ui and external ui can call the vimscript directly if that filed is clicked.

Searching for kStlClickFuncRun looks useful.

In the "tabline_update" event, I think we need to include StlClickRecord info (build_stl_str_hl() parses the tab expression and then stores it. draw_tabline() can access this info via tab_page_click_defs.) It is handled in do_mouse(). The logic in do_mouse for handling tab-clicks can probably be extracted and wrapped in a new API function, nvim_tabpage_select().

We don't have to do that right now. The only thing we need to do is make sure the tabline_update event is flexible enough for future enhancements, so that UIs (in the future) can get the data they need to call nvim_tabpage_select() correctly.

I think that means for the ["tabline_update", curtab, tabs] event, tabs should be structured like this:

[[ {tabid}, {dict} ], ... ]

where {dict} may contain new fields in the future.

justinmk · 2017-02-28T10:48:25Z

runtime/doc/msgpack_rpc.txt

@@ -413,5 +417,9 @@ of update.
 ["popupmenu_hide"]
 	The popupmenu is hidden.

+["tabline_update", curtab, tabs]
+	Nvim will send this event when drawing tabline. curtab is the tab id
+	of the current tab. tabs is an arrays of the form [tabid, tabname].


tabs is an arrays of the form [tabid, { "name": name } ].

Then we can add new fields later.

dzhou121 · 2017-03-09T14:01:02Z

Anything else I need to improve to get this merged, cause I'm waiting to use the enum here for other external widgets.

justinmk · 2017-04-25T01:36:20Z

@dzhou121 Now that :help api-contract has been established we can accelerate the addition of new externalized UI widgets. I made some changes in #6583 , let me know what you think.

justinmk · 2017-04-27T19:35:36Z

Merged in #6583. Thank you @dzhou121 !

dzhou121 added 2 commits February 24, 2017 09:35

allow external ui to draw tabline

9e8e3fc

doc

532d7d8

dzhou121 mentioned this pull request Feb 24, 2017

[RFC] External ui #5686

Closed

marvim added the RFC label Feb 24, 2017

dzhou121 added 2 commits February 24, 2017 10:09

function prototype fix

e0fe37e

lint

c7355e4

justinmk reviewed Feb 27, 2017

View reviewed changes

dzhou121 added 2 commits February 28, 2017 06:12

store external state to ui

acbbc22

test update

8fb64bc

justinmk reviewed Feb 28, 2017

View reviewed changes

dzhou121 added 2 commits February 28, 2017 09:59

change to UIWidget

6100e5f

put draw_tabline_ext to a function

fix ui_is_widget_external

d94023b

justinmk reviewed Feb 28, 2017

View reviewed changes

change the format of tabline_update

bd98171

dzhou121 changed the title ~~[RFC] allow external ui to draw tabline~~ [RDY] allow external ui to draw tabline Mar 4, 2017

marvim added RDY and removed RFC labels Mar 4, 2017

dzhou121 closed this Mar 9, 2017

jszakmeister removed the RDY label Mar 9, 2017

dzhou121 reopened this Mar 9, 2017

marvim added the RDY label Mar 9, 2017

justinmk mentioned this pull request Apr 25, 2017

external UI: tabline #6583

Merged

justinmk closed this Apr 27, 2017

justinmk removed the RDY label Apr 27, 2017

Uh oh!

[RDY] allow external ui to draw tabline #6170

[RDY] allow external ui to draw tabline #6170

Uh oh!

Conversation

dzhou121 commented Feb 24, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justinmk Feb 28, 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!

justinmk Feb 28, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

dzhou121 commented Feb 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

justinmk commented Feb 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhou121 commented Mar 9, 2017

Uh oh!

justinmk commented Apr 25, 2017

Uh oh!

justinmk commented Apr 27, 2017

Uh oh!

Uh oh!

justinmk Feb 28, 2017 •

edited

Loading

justinmk Feb 28, 2017 •

edited

Loading

justinmk commented Feb 28, 2017 •

edited

Loading

dzhou121 commented Feb 28, 2017 •

edited

Loading