aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/nvim/api/vim.c43
-rw-r--r--src/nvim/api/window.c27
-rw-r--r--src/nvim/window.c98
3 files changed, 81 insertions, 87 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 37bad4d517..223d90758b 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -1003,35 +1003,35 @@ Buffer nvim_create_buf(Boolean listed, Boolean scratch, Error *err)
/// Exactly one of `external` and `relative` must be specified.
///
/// @param buffer handle of buffer to be displayed in the window
-/// @param enter whether the window should be entered (made the current window)
-/// @param options dict of options for configuring window positioning
-/// accepts the following keys:
+/// @param enter whether the window should be entered (made the current window)
+/// @param config dictionary for the window configuration accepts these keys:
+///
/// `relative`: If set, the window becomes a floating window. The window
/// will be placed with row,col coordinates relative one of the
/// following:
/// "editor" the global editor grid
-/// "win" a window. Use 'win' option below to specify window id,
-/// or current window will be used by default.
+/// "win" a window. Use `win` to specify a window id,
+/// or the current window will be used by default.
/// "cursor" the cursor position in current window.
-/// `anchor`: the corner of the float that the row,col position defines
+/// `win`: When using relative='win', window id of the window where the
+/// position is defined.
+/// `anchor`: The corner of the float that the row,col position defines:
/// "NW" north-west (default)
/// "NE" north-east
/// "SW" south-west
/// "SE" south-east
-/// `focusable`: Whether window can be focused by wincmds and
-/// mouse events. Defaults to true. Even if set to false, the window
-/// can still be entered using |nvim_set_current_win()| API call.
-/// `height`: window height (in character cells). Cannot be smaller than 1.
-/// `width`: window width (in character cells). Cannot be smaller than 2.
-/// `row`: row position. Screen cell height are used as unit. Can be
+/// `height`: window height (in character cells). Minimum of 1.
+/// `width`: window width (in character cells). Minimum of 2.
+/// `row`: row position. Screen cell height are used as unit. Can be
/// floating point.
/// `col`: column position. Screen cell width is used as unit. Can be
/// floating point.
-/// `win`: when using relative='win', window id of the window where the
-/// position is defined.
-/// `external` GUI should display the window as an external
-/// top-level window. Currently accepts no other positioning options
-/// together with this.
+/// `focusable`: Whether window can be focused by wincmds and
+/// mouse events. Defaults to true. Even if set to false, the window
+/// can still be entered using |nvim_set_current_win()| API call.
+/// `external`: GUI should display the window as an external
+/// top-level window. Currently accepts no other positioning
+/// configuration together with this.
///
/// With editor positioning row=0, col=0 refers to the top-left corner of the
/// screen-grid and row=Lines-1, Columns-1 refers to the bottom-right corner.
@@ -1047,15 +1047,14 @@ Buffer nvim_create_buf(Boolean listed, Boolean scratch, Error *err)
///
/// @param[out] err Error details, if any
/// @return the window handle or 0 when error
-Window nvim_open_win(Buffer buffer, Boolean enter, Dictionary options,
- Error *err)
+Window nvim_open_win(Buffer buffer, Boolean enter, Dictionary config, Error *err)
FUNC_API_SINCE(6)
{
- FloatConfig config = FLOAT_CONFIG_INIT;
- if (!parse_float_config(options, &config, false, err)) {
+ FloatConfig fconfig = FLOAT_CONFIG_INIT;
+ if (!parse_float_config(config, &fconfig, false, err)) {
return 0;
}
- win_T *wp = win_new_float(NULL, config, err);
+ win_T *wp = win_new_float(NULL, fconfig, err);
if (!wp) {
return 0;
}
diff --git a/src/nvim/api/window.c b/src/nvim/api/window.c
index dd63dbbb4a..9e53a7bf14 100644
--- a/src/nvim/api/window.c
+++ b/src/nvim/api/window.c
@@ -438,17 +438,16 @@ Boolean nvim_win_is_valid(Window window)
/// floating and external windows (including changing a split window to these
/// types).
///
-/// See documentation at |nvim_open_win()|, for the meaning of parameters. Pass
-/// in 0 for `width` and `height` to keep existing size.
+/// See documentation at |nvim_open_win()|, for the meaning of parameters.
///
/// When reconfiguring a floating window, absent option keys will not be
/// changed. The following restriction apply: `row`, `col` and `relative`
/// must be reconfigured together. Only changing a subset of these is an error.
///
/// @param window Window handle
-/// @param options Dictionary of options
+/// @param config Dictionary of window configuration
/// @param[out] err Error details, if any
-void nvim_win_set_config(Window window, Dictionary options, Error *err)
+void nvim_win_set_config(Window window, Dictionary config, Error *err)
FUNC_API_SINCE(6)
{
win_T *win = find_window_by_handle(window, err);
@@ -457,34 +456,34 @@ void nvim_win_set_config(Window window, Dictionary options, Error *err)
}
bool new_float = !win->w_floating;
// reuse old values, if not overriden
- FloatConfig config = new_float ? FLOAT_CONFIG_INIT : win->w_float_config;
+ FloatConfig fconfig = new_float ? FLOAT_CONFIG_INIT : win->w_float_config;
- if (!parse_float_config(options, &config, !new_float, err)) {
+ if (!parse_float_config(config, &fconfig, !new_float, err)) {
return;
}
- config.height = config.height > 0 ? config.height : win->w_height;
- config.width = config.width > 0 ? config.width : win->w_width;
+ fconfig.height = fconfig.height > 0 ? fconfig.height : win->w_height;
+ fconfig.width = fconfig.width > 0 ? fconfig.width : win->w_width;
if (new_float) {
- if (!win_new_float(win, config, err)) {
+ if (!win_new_float(win, fconfig, err)) {
return;
}
redraw_later(NOT_VALID);
} else {
- win_config_float(win, config);
+ win_config_float(win, fconfig);
win->w_pos_changed = true;
}
}
/// Return window configuration.
///
-/// Return a dictionary containing the same options that can be given to
+/// Return a dictionary containing the same config that can be given to
/// |nvim_open_win()|.
///
-/// `relative` will be empty for normal windows.
+/// `relative` will be an empty string for normal windows.
///
-/// @param window Window handle
+/// @param window Window handle
/// @param[out] err Error details, if any
-/// @return Window configuration
+/// @return Window configuration
Dictionary nvim_win_get_config(Window window, Error *err)
FUNC_API_SINCE(6)
{
diff --git a/src/nvim/window.c b/src/nvim/window.c
index dc043c3c45..7acf2a7f7e 100644
--- a/src/nvim/window.c
+++ b/src/nvim/window.c
@@ -539,7 +539,7 @@ static void cmd_with_count(char *cmd, char_u *bufp, size_t bufsize,
/// float. It must then already belong to the current tabpage!
///
/// config must already have been validated!
-win_T *win_new_float(win_T *wp, FloatConfig config, Error *err)
+win_T *win_new_float(win_T *wp, FloatConfig fconfig, Error *err)
{
if (wp == NULL) {
wp = win_alloc(lastwin_nofloating(), false);
@@ -571,26 +571,26 @@ win_T *win_new_float(win_T *wp, FloatConfig config, Error *err)
// TODO(bfredl): use set_option_to() after merging #9110 ?
wp->w_p_nu = false;
wp->w_allbuf_opt.wo_nu = false;
- win_config_float(wp, config);
+ win_config_float(wp, fconfig);
wp->w_pos_changed = true;
redraw_win_later(wp, VALID);
return wp;
}
-void win_config_float(win_T *wp, FloatConfig config)
+void win_config_float(win_T *wp, FloatConfig fconfig)
{
- wp->w_width = MAX(config.width, 2);
- wp->w_height = MAX(config.height, 1);
+ wp->w_width = MAX(fconfig.width, 2);
+ wp->w_height = MAX(fconfig.height, 1);
- if (config.relative == kFloatRelativeCursor) {
- config.relative = kFloatRelativeWindow;
- config.row += curwin->w_wrow;
- config.col += curwin->w_wcol;
- config.window = curwin->handle;
+ if (fconfig.relative == kFloatRelativeCursor) {
+ fconfig.relative = kFloatRelativeWindow;
+ fconfig.row += curwin->w_wrow;
+ fconfig.col += curwin->w_wcol;
+ fconfig.window = curwin->handle;
}
- bool change_external = config.external != wp->w_float_config.external;
- wp->w_float_config = config;
+ bool change_external = fconfig.external != wp->w_float_config.external;
+ wp->w_float_config = fconfig;
if (!ui_has(kUIMultigrid)) {
wp->w_height = MIN(wp->w_height, Rows-1);
@@ -697,7 +697,7 @@ static bool parse_float_relative(String relative, FloatRelative *out)
return true;
}
-bool parse_float_config(Dictionary config, FloatConfig *out, bool reconf,
+bool parse_float_config(Dictionary config, FloatConfig *fconfig, bool reconf,
Error *err)
{
bool has_row = false, has_col = false, has_relative = false;
@@ -709,62 +709,62 @@ bool parse_float_config(Dictionary config, FloatConfig *out, bool reconf,
if (!strcmp(key, "row")) {
has_row = true;
if (val.type == kObjectTypeInteger) {
- out->row = val.data.integer;
+ fconfig->row = val.data.integer;
} else if (val.type == kObjectTypeFloat) {
- out->row = val.data.floating;
+ fconfig->row = val.data.floating;
} else {
api_set_error(err, kErrorTypeValidation,
- "'row' option has to be Integer or Float");
+ "'row' key must be Integer or Float");
return false;
}
} else if (!strcmp(key, "col")) {
has_col = true;
if (val.type == kObjectTypeInteger) {
- out->col = val.data.integer;
+ fconfig->col = val.data.integer;
} else if (val.type == kObjectTypeFloat) {
- out->col = val.data.floating;
+ fconfig->col = val.data.floating;
} else {
api_set_error(err, kErrorTypeValidation,
- "'col' option has to be Integer or Float");
+ "'col' key must be Integer or Float");
return false;
}
} else if (strequal(key, "width")) {
if (val.type == kObjectTypeInteger && val.data.integer >= 0) {
- out->width = val.data.integer;
+ fconfig->width = val.data.integer;
} else {
api_set_error(err, kErrorTypeValidation,
- "'width' option has to be a positive Integer");
+ "'width' key must be a positive Integer");
return false;
}
} else if (strequal(key, "height")) {
if (val.type == kObjectTypeInteger && val.data.integer >= 0) {
- out->height= val.data.integer;
+ fconfig->height= val.data.integer;
} else {
api_set_error(err, kErrorTypeValidation,
- "'height' option has to be a positive Integer");
+ "'height' key must be a positive Integer");
return false;
}
} else if (!strcmp(key, "anchor")) {
if (val.type != kObjectTypeString) {
api_set_error(err, kErrorTypeValidation,
- "'anchor' option has to be String");
+ "'anchor' key must be String");
return false;
}
- if (!parse_float_anchor(val.data.string, &out->anchor)) {
+ if (!parse_float_anchor(val.data.string, &fconfig->anchor)) {
api_set_error(err, kErrorTypeValidation,
- "Invalid value of 'anchor' option");
+ "Invalid value of 'anchor' key");
return false;
}
} else if (!strcmp(key, "relative")) {
has_relative = true;
if (val.type != kObjectTypeString) {
api_set_error(err, kErrorTypeValidation,
- "'relative' option has to be String");
+ "'relative' key must be String");
return false;
}
- if (!parse_float_relative(val.data.string, &out->relative)) {
+ if (!parse_float_relative(val.data.string, &fconfig->relative)) {
api_set_error(err, kErrorTypeValidation,
- "Invalid value of 'relative' option");
+ "Invalid value of 'relative' key");
return false;
}
} else if (!strcmp(key, "win")) {
@@ -772,62 +772,62 @@ bool parse_float_config(Dictionary config, FloatConfig *out, bool reconf,
if (val.type != kObjectTypeInteger
&& val.type != kObjectTypeWindow) {
api_set_error(err, kErrorTypeValidation,
- "'win' option has to be Integer or Window");
+ "'win' key must be Integer or Window");
return false;
}
- out->window = val.data.integer;
+ fconfig->window = val.data.integer;
} else if (!strcmp(key, "external")) {
if (val.type == kObjectTypeInteger) {
- out->external = val.data.integer;
+ fconfig->external = val.data.integer;
} else if (val.type == kObjectTypeBoolean) {
- out->external = val.data.boolean;
+ fconfig->external = val.data.boolean;
} else {
api_set_error(err, kErrorTypeValidation,
- "'external' option has to be Boolean");
+ "'external' key must be Boolean");
return false;
}
- has_external = out->external;
+ has_external = fconfig->external;
} else if (!strcmp(key, "focusable")) {
if (val.type == kObjectTypeInteger) {
- out->focusable = val.data.integer;
+ fconfig->focusable = val.data.integer;
} else if (val.type == kObjectTypeBoolean) {
- out->focusable = val.data.boolean;
+ fconfig->focusable = val.data.boolean;
} else {
api_set_error(err, kErrorTypeValidation,
- "'focusable' option has to be Boolean");
+ "'focusable' key must be Boolean");
return false;
}
} else {
api_set_error(err, kErrorTypeValidation,
- "Invalid options key '%s'", key);
+ "Invalid key '%s'", key);
return false;
}
}
- if (has_window && !(has_relative && out->relative == kFloatRelativeWindow)) {
+ if (has_window && !(has_relative && fconfig->relative == kFloatRelativeWindow)) {
api_set_error(err, kErrorTypeValidation,
- "'win' option is only valid with relative='win'");
+ "'win' key is only valid with relative='win'");
return false;
}
- if ((has_relative && out->relative == kFloatRelativeWindow)
- && (!has_window || out->window == 0)) {
- out->window = curwin->handle;
+ if ((has_relative && fconfig->relative == kFloatRelativeWindow)
+ && (!has_window || fconfig->window == 0)) {
+ fconfig->window = curwin->handle;
}
if (has_relative && has_external) {
api_set_error(err, kErrorTypeValidation,
- "Only one of 'relative' and 'external' should be used");
+ "Only one of 'relative' and 'external' must be used");
return false;
} else if (!reconf && !has_relative && !has_external) {
api_set_error(err, kErrorTypeValidation,
"One of 'relative' and 'external' must be used");
return false;
} else if (has_relative) {
- out->external = false;
+ fconfig->external = false;
}
- if (out->external && !ui_has(kUIMultigrid)) {
+ if (fconfig->external && !ui_has(kUIMultigrid)) {
api_set_error(err, kErrorTypeValidation,
"UI doesn't support external windows");
return false;
@@ -3819,8 +3819,6 @@ static void tabpage_check_windows(tabpage_T *old_curtab)
for (win_T *wp = firstwin; wp; wp = wp->w_next) {
if (wp->w_floating && !wp->w_float_config.external) {
- wp->w_float_config.width = wp->w_width;
- wp->w_float_config.height = wp->w_height;
win_config_float(wp, wp->w_float_config);
}
wp->w_pos_changed = true;
@@ -4756,7 +4754,6 @@ void win_setheight_win(int height, win_T *win)
if (win->w_floating) {
if (win->w_float_config.external) {
- win->w_float_config.width = win->w_width;
win->w_float_config.height = height;
win_config_float(win, win->w_float_config);
} else {
@@ -4964,7 +4961,6 @@ void win_setwidth_win(int width, win_T *wp)
if (wp->w_floating) {
if (wp->w_float_config.external) {
wp->w_float_config.width = width;
- wp->w_float_config.height = wp->w_height;
win_config_float(wp, wp->w_float_config);
} else {
beep_flush();
generated by cgit (git 2.34.1) at 2025-04-29 19:58:24 +0000