diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml index 5e6285551..62fba096d 100644 --- a/doc/en/dev/plugin_c_api.en.xml +++ b/doc/en/dev/plugin_c_api.en.xml @@ -6345,7 +6345,7 @@ weechat_buffer_close (my_buffer); Prototype: -int weechat_buffer_integer (struct t_gui_buffer *buffer, const char *property); +int weechat_buffer_get_integer (struct t_gui_buffer *buffer, const char *property); @@ -6884,6 +6884,262 @@ free (str); + + +
+ Windows + + + Functions to query windows. + + +
+ weechat_current_windowr + + + Prototype: + +struct t_gui_window *weechat_current_window (); + + + + Return pointer to current window. + + + Return value: pointer to current window. + + + Example: + +struct t_gui_window *current_window = weechat_current_window (); + + +
+ +
+ weechat_window_get_integer + + + Prototype: + +int weechat_window_get_integer (struct t_gui_window *window, const char *property); + + + + Get integer value of a window property. + + + Arguments: + + + + : window pointer + + + + + : property name: + + + + + Name + Description + + + + + win_x + + X position of window in terminal (0 is first column) + + + + win_y + + Y position of window in terminal (0 is first column) + + + + win_width + width of window, in chars + + + win_height + height of window, in chars + + + win_width_pct + + percentage size, compared to parent window (if 50, + width is half) + + + + win_height_pct + + percentage size, compared to parent window (if 50, + height is half) + + + + win_chat_x + + X position of chat window in terminal (0 is first + column) + + + + win_chat_y + + Y position of chat window in terminal (0 is first + column) + + + + win_chat_width + width of chat window, in chars + + + win_chat_height + height of chat window, in chars + + + first_line_displayed + + 1 if first line of buffer is displayed on screen, + otherwise 0 + + + + scroll + + 1 if scroll is active on window (last line not + displayed) + + + + scroll_lines_after + + number of lines not displayed after last one displayed + (when scrolling) + + + + + + + + + + + Return value: integer value of property. + + + Example: + +weechat_printf (NULL, "current window is at position (x,y): (%d,%d)", + weechat_window_get_integer (weechat_current_window, "win_x"), + weechat_window_get_integer (weechat_current_window, "win_y")); + + +
+ +
+ weechat_window_get_string + + + Prototype: + +const char *weechat_window_get_string (struct t_gui_window *window, const char *property); + + + + Get string value of a window property. NOT USED TODAY, reserved for + future version. + + + Arguments: + + + + : window pointer + + + + + : property name + + + + + + Return value: string value of property. + +
+ +
+ weechat_window_get_pointer + + + Prototype: + +void *weechat_window_get_pointer (struct t_gui_window *window, const char *property); + + + + Get pointer value of a window property. + + + Arguments: + + + + : window pointer + + + + + : property name: + + + + + Name + Description + + + + + current + current window pointer + + + buffer + pointer to buffer displayed by window + + + + + + + + + + Return value: pointer value of property. + + + Example: + +weechat_printf (NULL, "current window pointer is: %lx, buffer displayed is: %lx", + weechat_window_get_pointer (NULL, "current"), + weechat_window_get_integer (weechat_current_window, "buffer")); + + +
+ +
+
diff --git a/src/gui/gui-window.c b/src/gui/gui-window.c index 02d9ce428..c4eb1be7a 100644 --- a/src/gui/gui-window.c +++ b/src/gui/gui-window.c @@ -291,6 +291,32 @@ gui_window_get_integer (struct t_gui_window *window, const char *property) { if (window && property) { + if (string_strcasecmp (property, "win_x") == 0) + return window->win_x; + if (string_strcasecmp (property, "win_y") == 0) + return window->win_y; + if (string_strcasecmp (property, "win_width") == 0) + return window->win_width; + if (string_strcasecmp (property, "win_height") == 0) + return window->win_height; + if (string_strcasecmp (property, "win_width_pct") == 0) + return window->win_width_pct; + if (string_strcasecmp (property, "win_height_pct") == 0) + return window->win_height_pct; + if (string_strcasecmp (property, "win_chat_x") == 0) + return window->win_chat_x; + if (string_strcasecmp (property, "win_chat_y") == 0) + return window->win_chat_y; + if (string_strcasecmp (property, "win_chat_width") == 0) + return window->win_chat_width; + if (string_strcasecmp (property, "win_chat_height") == 0) + return window->win_chat_height; + if (string_strcasecmp (property, "first_line_displayed") == 0) + return window->first_line_displayed; + if (string_strcasecmp (property, "scroll") == 0) + return window->scroll; + if (string_strcasecmp (property, "scroll_lines_after") == 0) + return window->scroll_lines_after; } return 0; diff --git a/src/plugins/aspell/weechat-aspell-config.c b/src/plugins/aspell/weechat-aspell-config.c index 7de2ffabd..57bd11033 100644 --- a/src/plugins/aspell/weechat-aspell-config.c +++ b/src/plugins/aspell/weechat-aspell-config.c @@ -107,7 +107,7 @@ weechat_aspell_config_change_default_dict (void *data, (void) data; (void) option; - weechat_aspell_create_spellers (weechat_current_buffer); + weechat_aspell_create_spellers (weechat_current_buffer ()); } /* @@ -122,7 +122,7 @@ weechat_aspell_config_dict_change (void *data, (void) data; (void) option; - weechat_aspell_create_spellers (weechat_current_buffer); + weechat_aspell_create_spellers (weechat_current_buffer ()); } /* @@ -141,7 +141,7 @@ weechat_aspell_config_dict_delete_option (void *data, (void) section; weechat_config_option_free (option); - weechat_aspell_create_spellers (weechat_current_buffer); + weechat_aspell_create_spellers (weechat_current_buffer ()); return WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED; } @@ -209,7 +209,7 @@ weechat_aspell_config_dict_create_option (void *data, option_name, value); } else - weechat_aspell_create_spellers (weechat_current_buffer); + weechat_aspell_create_spellers (weechat_current_buffer ()); return rc; } diff --git a/src/plugins/aspell/weechat-aspell.c b/src/plugins/aspell/weechat-aspell.c index 87c59f1a3..0b8558c73 100644 --- a/src/plugins/aspell/weechat-aspell.c +++ b/src/plugins/aspell/weechat-aspell.c @@ -970,7 +970,7 @@ weechat_plugin_init (struct t_weechat_plugin *plugin, int argc, char *argv[]) weechat_hook_modifier ("weechat_input_text_display", &weechat_aspell_modifier_cb, NULL); - weechat_aspell_create_spellers (weechat_current_buffer); + weechat_aspell_create_spellers (weechat_current_buffer ()); return WEECHAT_RC_OK; } diff --git a/src/plugins/fifo/fifo.c b/src/plugins/fifo/fifo.c index 321eadd38..c05caa765 100644 --- a/src/plugins/fifo/fifo.c +++ b/src/plugins/fifo/fifo.c @@ -185,7 +185,7 @@ fifo_exec (const char *text) if (text2[0] == '*') { pos_msg = text2 + 1; - ptr_buffer = weechat_current_buffer; + ptr_buffer = weechat_current_buffer (); } else { diff --git a/src/plugins/irc/irc-bar-item.c b/src/plugins/irc/irc-bar-item.c index 07ad3b140..e7946f64d 100644 --- a/src/plugins/irc/irc-bar-item.c +++ b/src/plugins/irc/irc-bar-item.c @@ -52,7 +52,7 @@ irc_bar_item_buffer_title (void *data, struct t_gui_bar_item *item, (void) max_height; if (!window) - window = weechat_current_window; + window = weechat_current_window (); buffer = weechat_window_get_pointer (window, "buffer"); @@ -93,7 +93,7 @@ irc_bar_item_buffer_name (void *data, struct t_gui_bar_item *item, (void) max_height; if (!window) - window = weechat_current_window; + window = weechat_current_window (); buf_name[0] = '\0'; modes[0] = '\0'; @@ -251,7 +251,7 @@ irc_bar_item_input_prompt (void *data, struct t_gui_bar_item *item, (void) max_height; if (!window) - window = weechat_current_window; + window = weechat_current_window (); buffer = weechat_window_get_pointer (window, "buffer"); diff --git a/src/plugins/scripts/lua/weechat-lua-api.c b/src/plugins/scripts/lua/weechat-lua-api.c index 338f721d5..51ebcd0c6 100644 --- a/src/plugins/scripts/lua/weechat-lua-api.c +++ b/src/plugins/scripts/lua/weechat-lua-api.c @@ -3748,7 +3748,7 @@ weechat_lua_api_current_buffer (lua_State *L) LUA_RETURN_EMPTY; } - result = script_ptr2str (weechat_current_buffer); + result = script_ptr2str (weechat_current_buffer ()); LUA_RETURN_STRING_FREE(result); } @@ -3984,6 +3984,29 @@ weechat_lua_api_buffer_set (lua_State *L) LUA_RETURN_OK; } +/* + * weechat_lua_api_current_window: get current window + */ + +static int +weechat_lua_api_current_window (lua_State *L) +{ + char *result; + + /* make C compiler happy */ + (void) L; + + if (!lua_current_script) + { + WEECHAT_SCRIPT_MSG_NOT_INITIALIZED("current_window"); + LUA_RETURN_EMPTY; + } + + result = script_ptr2str (weechat_current_window ()); + + LUA_RETURN_STRING_FREE(result); +} + /* * weechat_lua_api_window_get_integer: get a window property as integer */ @@ -5893,6 +5916,7 @@ const struct luaL_reg weechat_lua_api_funcs[] = { { "buffer_get_string", &weechat_lua_api_buffer_get_string }, { "buffer_get_pointer", &weechat_lua_api_buffer_get_pointer }, { "buffer_set", &weechat_lua_api_buffer_set }, + { "current_window", &weechat_lua_api_current_window }, { "window_get_integer", &weechat_lua_api_window_get_integer }, { "window_get_string", &weechat_lua_api_window_get_string }, { "window_get_pointer", &weechat_lua_api_window_get_pointer }, diff --git a/src/plugins/scripts/perl/weechat-perl-api.c b/src/plugins/scripts/perl/weechat-perl-api.c index 0c01452b1..f25824e3c 100644 --- a/src/plugins/scripts/perl/weechat-perl-api.c +++ b/src/plugins/scripts/perl/weechat-perl-api.c @@ -3173,7 +3173,7 @@ static XS (XS_weechat_api_current_buffer) PERL_RETURN_EMPTY; } - result = script_ptr2str (weechat_current_buffer); + result = script_ptr2str (weechat_current_buffer ()); PERL_RETURN_STRING_FREE(result); } @@ -3364,6 +3364,30 @@ static XS (XS_weechat_api_buffer_set) PERL_RETURN_OK; } +/* + * weechat::current_window: get current window + */ + +static XS (XS_weechat_api_current_window) +{ + char *result; + dXSARGS; + + /* make C compiler happy */ + (void) items; + (void) cv; + + if (!perl_current_script) + { + WEECHAT_SCRIPT_MSG_NOT_INITIALIZED("current_window"); + PERL_RETURN_EMPTY; + } + + result = script_ptr2str (weechat_current_window ()); + + PERL_RETURN_STRING_FREE(result); +} + /* * weechat::window_get_integer: get a window property as integer */ @@ -4633,6 +4657,7 @@ weechat_perl_api_init (pTHX) newXS ("weechat::buffer_get_string", XS_weechat_api_buffer_get_string, "weechat"); newXS ("weechat::buffer_get_pointer", XS_weechat_api_buffer_get_pointer, "weechat"); newXS ("weechat::buffer_set", XS_weechat_api_buffer_set, "weechat"); + newXS ("weechat::current_window", XS_weechat_api_current_window, "weechat"); newXS ("weechat::window_get_integer", XS_weechat_api_window_get_integer, "weechat"); newXS ("weechat::window_get_string", XS_weechat_api_window_get_string, "weechat"); newXS ("weechat::window_get_pointer", XS_weechat_api_window_get_pointer, "weechat"); diff --git a/src/plugins/scripts/python/weechat-python-api.c b/src/plugins/scripts/python/weechat-python-api.c index e299255bc..d4d5da1aa 100644 --- a/src/plugins/scripts/python/weechat-python-api.c +++ b/src/plugins/scripts/python/weechat-python-api.c @@ -3365,7 +3365,7 @@ weechat_python_api_current_buffer (PyObject *self, PyObject *args) PYTHON_RETURN_EMPTY; } - result = script_ptr2str (weechat_current_buffer); + result = script_ptr2str (weechat_current_buffer ()); PYTHON_RETURN_STRING_FREE(result); } @@ -3569,6 +3569,31 @@ weechat_python_api_buffer_set (PyObject *self, PyObject *args) PYTHON_RETURN_OK; } +/* + * weechat_python_api_current_window: get current window + */ + +static PyObject * +weechat_python_api_current_window (PyObject *self, PyObject *args) +{ + char *result; + PyObject *object; + + /* make C compiler happy */ + (void) self; + (void) args; + + if (!python_current_script) + { + WEECHAT_SCRIPT_MSG_NOT_INITIALIZED("current_window"); + PYTHON_RETURN_EMPTY; + } + + result = script_ptr2str (weechat_current_window ()); + + PYTHON_RETURN_STRING_FREE(result); +} + /* * weechat_python_api_window_get_integer get a window property as integer */ @@ -4922,6 +4947,7 @@ PyMethodDef weechat_python_funcs[] = { "buffer_get_string", &weechat_python_api_buffer_get_string, METH_VARARGS, "" }, { "buffer_get_pointer", &weechat_python_api_buffer_get_pointer, METH_VARARGS, "" }, { "buffer_set", &weechat_python_api_buffer_set, METH_VARARGS, "" }, + { "current_window", &weechat_python_api_current_window, METH_VARARGS, "" }, { "window_get_integer", &weechat_python_api_window_get_integer, METH_VARARGS, "" }, { "window_get_string", &weechat_python_api_window_get_string, METH_VARARGS, "" }, { "window_get_pointer", &weechat_python_api_window_get_pointer, METH_VARARGS, "" }, diff --git a/src/plugins/scripts/ruby/weechat-ruby-api.c b/src/plugins/scripts/ruby/weechat-ruby-api.c index 2d80aac8a..fd09a9e7f 100644 --- a/src/plugins/scripts/ruby/weechat-ruby-api.c +++ b/src/plugins/scripts/ruby/weechat-ruby-api.c @@ -3850,7 +3850,7 @@ weechat_ruby_api_current_buffer (VALUE class) RUBY_RETURN_EMPTY; } - result = script_ptr2str (weechat_current_buffer); + result = script_ptr2str (weechat_current_buffer ()); RUBY_RETURN_STRING_FREE(result); } @@ -4078,6 +4078,30 @@ weechat_ruby_api_buffer_set (VALUE class, VALUE buffer, VALUE property, RUBY_RETURN_OK; } +/* + * weechat_ruby_api_current_window: get current window + */ + +static VALUE +weechat_ruby_api_current_window (VALUE class) +{ + char *result; + VALUE return_value; + + /* make C compiler happy */ + (void) class; + + if (!ruby_current_script) + { + WEECHAT_SCRIPT_MSG_NOT_INITIALIZED("current_window"); + RUBY_RETURN_EMPTY; + } + + result = script_ptr2str (weechat_current_window ()); + + RUBY_RETURN_STRING_FREE(result); +} + /* * weechat_ruby_api_window_get_integer: get a window property as integer */ @@ -5653,6 +5677,7 @@ weechat_ruby_api_init (VALUE ruby_mWeechat) rb_define_module_function (ruby_mWeechat, "buffer_get_string", &weechat_ruby_api_buffer_get_string, 2); rb_define_module_function (ruby_mWeechat, "buffer_get_pointer", &weechat_ruby_api_buffer_get_pointer, 2); rb_define_module_function (ruby_mWeechat, "buffer_set", &weechat_ruby_api_buffer_set, 3); + rb_define_module_function (ruby_mWeechat, "current_window", &weechat_ruby_api_current_window, 0); rb_define_module_function (ruby_mWeechat, "window_get_integer", &weechat_ruby_api_window_get_integer, 2); rb_define_module_function (ruby_mWeechat, "window_get_string", &weechat_ruby_api_window_get_string, 2); rb_define_module_function (ruby_mWeechat, "window_get_pointer", &weechat_ruby_api_window_get_pointer, 2); diff --git a/src/plugins/scripts/tcl/weechat-tcl-api.c b/src/plugins/scripts/tcl/weechat-tcl-api.c index 59b9448c5..090f999dc 100644 --- a/src/plugins/scripts/tcl/weechat-tcl-api.c +++ b/src/plugins/scripts/tcl/weechat-tcl-api.c @@ -3605,7 +3605,7 @@ weechat_tcl_api_current_buffer (ClientData clientData, Tcl_Interp *interp, TCL_RETURN_EMPTY; } - result = script_ptr2str (weechat_current_buffer); + result = script_ptr2str (weechat_current_buffer ()); TCL_RETURN_STRING_FREE(result); } @@ -3818,6 +3818,33 @@ weechat_tcl_api_buffer_set (ClientData clientData, Tcl_Interp *interp, TCL_RETURN_OK; } +/* + * weechat_tcl_api_current_window: get current window + */ + +static int +weechat_tcl_api_current_window (ClientData clientData, Tcl_Interp *interp, + int objc, Tcl_Obj *CONST objv[]) +{ + Tcl_Obj *objp; + char *result; + + /* make C compiler happy */ + (void) clientData; + (void) objc; + (void) objv; + + if (!tcl_current_script) + { + WEECHAT_SCRIPT_MSG_NOT_INITIALIZED("current_window"); + TCL_RETURN_EMPTY; + } + + result = script_ptr2str (weechat_current_window ()); + + TCL_RETURN_STRING_FREE(result); +} + /* * weechat_tcl_api_window_get_integer: get a window property as integer */ @@ -5378,6 +5405,8 @@ void weechat_tcl_api_init (Tcl_Interp *interp) { weechat_tcl_api_buffer_get_pointer, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL); Tcl_CreateObjCommand (interp,"weechat::buffer_set", weechat_tcl_api_buffer_set, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL); + Tcl_CreateObjCommand (interp,"weechat::current_window", + weechat_tcl_api_current_window, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL); Tcl_CreateObjCommand (interp,"weechat::window_get_integer", weechat_tcl_api_window_get_integer, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL); Tcl_CreateObjCommand (interp,"weechat::window_get_string", diff --git a/src/plugins/weechat-plugin.h b/src/plugins/weechat-plugin.h index 551d55321..35d5c0439 100644 --- a/src/plugins/weechat-plugin.h +++ b/src/plugins/weechat-plugin.h @@ -930,7 +930,7 @@ extern int weechat_plugin_end (struct t_weechat_plugin *plugin); __close_callback, __close_callback_data) #define weechat_buffer_search(__plugin, __name) \ weechat_plugin->buffer_search(__plugin, __name) -#define weechat_current_buffer \ +#define weechat_current_buffer() \ weechat_plugin->buffer_search(NULL, NULL) #define weechat_buffer_clear(__buffer) \ weechat_plugin->buffer_clear(__buffer) @@ -956,7 +956,7 @@ extern int weechat_plugin_end (struct t_weechat_plugin *plugin); weechat_plugin->window_get_string(__window, __property) #define weechat_window_get_pointer(__window, __property) \ weechat_plugin->window_get_pointer(__window, __property) -#define weechat_current_window \ +#define weechat_current_window() \ weechat_plugin->window_get_pointer(NULL, "current") /* nicklist */