xenia/home
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify parameters in json-rpc

Browse Source
This commit is contained in:
Enrico Lumetti 2017-01-06 22:21:14 +01:00
parent 0fad62d6b1
commit a64ef12d2b
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/json_ui.asciidoc
View File

@ -9,11 +9,11 @@ json-rpc requests on stdin. Errors will be reported on stderr (not in
json format). json format).
Kakoune requests are always using positional parameters, never named, and Kakoune requests are always using positional parameters, never named, and
Kakoune wont be able to parse named parameters in requests. Kakoune won't be able to parse named parameters in requests.
Here are the data structures used: Here are the data structures used:
* Color: a string, either a named color, or #rrggbb * Color: a string, either a named color, or #rrggbb, or 'default'
* Attribute: one of {exclusive, underline, reverse, blink, bold, dim, italic} * Attribute: one of {exclusive, underline, reverse, blink, bold, dim, italic}
* Face { Color fg; Color bg; Array<Attribute> attributes; } * Face { Color fg; Color bg; Array<Attribute> attributes; }
* Atom { Face face; String contents; } * Atom { Face face; String contents; }
@ -23,9 +23,11 @@ Here are the data structures used:
Here are the requests that can be written by the json ui on stdout: Here are the requests that can be written by the json ui on stdout:
* draw(Array<Line> lines, Face default_face, Face padding_face) * draw(Array<Line> lines, Face default_face, Face padding_face)
padding_face is the face of the padding characters '~' in the
terminal UI.
* draw_status(Line status_line, Line mode_line, * draw_status(Line status_line, Line mode_line,
Face default_face) Face default_face)
* menu_show(Array<Line> items, Coord anchor, Face fg, Face bg, * menu_show(Array<Line> items, Coord anchor, Face selected_item_face, Face menu_face,
String style) String style)
style can be: style can be:
- prompt: display the menu as a prompt menu (anchor is ignored) - prompt: display the menu as a prompt menu (anchor is ignored)