pegasus/weechat
1
0
Fork 0
mirror of https://github.com/weechat/weechat.git synced 2026-07-09 11:13:12 +02:00
Code Activity

core, plugins: fix typos in comments on functions, use imperative

Browse Source
This commit is contained in:
Sébastien Helleu
2026-03-23 20:45:36 +01:00
parent d34eb40187
commit f53e7fb9ef
342 changed files with 6669 additions and 6729 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/gui/curses/gui-curses-bar-window.c
+9 -9
View File
@@ -49,9 +49,9 @@
/*
* Initializes Curses windows for bar window.
* Initialize Curses windows for bar window.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -76,7 +76,7 @@ gui_bar_window_objects_init (struct t_gui_bar_window *bar_window)
}
/*
* Frees Curses windows for a bar window.
* Free Curses windows for a bar window.
*/
void
@@ -98,7 +98,7 @@ gui_bar_window_objects_free (struct t_gui_bar_window *bar_window)
}
/*
* Creates curses window for bar.
* Create curses window for bar.
*/
void
@@ -160,9 +160,9 @@ gui_bar_window_create_win (struct t_gui_bar_window *bar_window)
}
/*
* Prints a string text on a bar window.
* Print a string text on a bar window.
*
* Returns:
* Return:
* 1: everything was printed
* 0: some text was not displayed (wrapped due to bar window width)
*/
@@ -427,7 +427,7 @@ gui_bar_window_print_string (struct t_gui_bar_window *bar_window,
}
/*
* Expands spacers using the sizes computed, replacing them by 0 to N spaces.
* Expand spacers using the sizes computed, replacing them by 0 to N spaces.
*
* Note: result must be freed after use.
*/
@@ -532,7 +532,7 @@ gui_bar_window_expand_spacers (const char *string, int length_on_screen,
}
/*
* Draws a bar for a window.
* Draw a bar for a window.
*/
void
@@ -963,7 +963,7 @@ gui_bar_window_draw (struct t_gui_bar_window *bar_window,
}
/*
* Prints bar window infos in WeeChat log file (usually for crash dump).
* Print bar window infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/curses/gui-curses-chat.c
+28 -28
View File
@@ -52,9 +52,9 @@
/*
* Gets real width for chat.
* Get real width for chat.
*
* Returns width - 1 if nicklist is at right, for good copy/paste (without
* Return width - 1 if nicklist is at right, for good copy/paste (without
* nicklist separator).
*/
@@ -74,9 +74,9 @@ gui_chat_get_real_width (struct t_gui_window *window)
}
/*
* Checks if marker must be displayed after this line.
* Check if marker must be displayed after this line.
*
* Returns:
* Return:
* 1: marker must be displayed after this line
* 0: marker must not be displayed after this line
*/
@@ -119,7 +119,7 @@ gui_chat_marker_for_line (struct t_gui_buffer *buffer, struct t_gui_line *line)
}
/*
* Resets style using color depending on window (active or not) and line (buffer
* Reset style using color depending on window (active or not) and line (buffer
* selected in merged buffer or not).
*/
@@ -158,7 +158,7 @@ gui_chat_reset_style (struct t_gui_window *window, struct t_gui_line *line,
}
/*
* Deletes all chars from the cursor to the end of the current line.
* Delete all chars from the cursor to the end of the current line.
*/
void
@@ -174,7 +174,7 @@ gui_chat_clrtoeol (struct t_gui_window *window)
}
/*
* Displays a new line.
* Display a new line.
*/
void
@@ -193,7 +193,7 @@ gui_chat_display_new_line (struct t_gui_window *window,
}
/*
* Displays an horizontal line (marker for data not read).
* Display an horizontal line (marker for data not read).
*/
void
@@ -229,7 +229,7 @@ gui_chat_display_horizontal_line (struct t_gui_window *window, int simulate)
}
/*
* Returns next char of a word (for display), special chars like
* Return next char of a word (for display), special chars like
* colors/attributes are skipped and optionally applied.
*/
@@ -369,10 +369,10 @@ gui_chat_string_next_char (struct t_gui_window *window, struct t_gui_line *line,
}
/*
* Displays word on chat buffer, letter by letter, special chars like
* Display word on chat buffer, letter by letter, special chars like
* colors/attributes are interpreted.
*
* Returns number of chars displayed on screen.
* Return number of chars displayed on screen.
*/
int
@@ -496,9 +496,9 @@ gui_chat_display_word_raw (struct t_gui_window *window, struct t_gui_line *line,
}
/*
* Displays the prefix_suffix in the beginning of a line.
* Display the prefix_suffix in the beginning of a line.
*
* Returns number of chars displayed on screen.
* Return number of chars displayed on screen.
*/
int
@@ -574,9 +574,9 @@ gui_chat_display_prefix_suffix (struct t_gui_window *window,
}
/*
* Displays a word on chat buffer.
* Display a word on chat buffer.
*
* Returns number of chars displayed on screen.
* Return number of chars displayed on screen.
*/
int
@@ -702,7 +702,7 @@ gui_chat_display_word (struct t_gui_window *window,
}
/*
* Displays a message when the day has changed.
* Display a message when the day has changed.
*/
void
@@ -775,9 +775,9 @@ gui_chat_display_day_changed (struct t_gui_window *window,
}
/*
* Checks if time on line is the same as time on previous line.
* Check if time on line is the same as time on previous line.
*
* Returns:
* Return:
* 1: time is same as time on previous line
* 0: time is different from time on previous line
*/
@@ -802,7 +802,7 @@ gui_chat_line_time_is_same_as_previous (struct t_gui_line *line)
}
/*
* Displays time, buffer name (for merged buffers) and prefix for a line.
* Display time, buffer name (for merged buffers) and prefix for a line.
*/
void
@@ -1368,14 +1368,14 @@ gui_chat_display_time_to_prefix (struct t_gui_window *window,
}
/*
* Displays a line in the chat window.
* Display a line in the chat window.
*
* If count == 0, display whole line.
* If count > 0, display 'count' lines (beginning from the end).
* If simulate == 1, nothing is displayed (for counting how many lines would
* have been displayed).
*
* Returns number of lines displayed (or simulated).
* Return number of lines displayed (or simulated).
*/
int
@@ -1737,7 +1737,7 @@ gui_chat_display_line (struct t_gui_window *window, struct t_gui_line *line,
}
/*
* Displays a line in the chat window (for a buffer with free content).
* Display a line in the chat window (for a buffer with free content).
*/
void
@@ -1803,7 +1803,7 @@ gui_chat_display_line_y (struct t_gui_window *window, struct t_gui_line *line,
}
/*
* Returns pointer to line & offset for a difference with given line.
* Return pointer to line & offset for a difference with given line.
*/
void
@@ -1915,7 +1915,7 @@ gui_chat_calculate_line_diff (struct t_gui_window *window,
}
/*
* Draws chat window for a formatted buffer.
* Draw chat window for a formatted buffer.
*/
void
@@ -2046,7 +2046,7 @@ gui_chat_draw_formatted_buffer (struct t_gui_window *window)
}
/*
* Draws chat window for a free buffer.
* Draw chat window for a free buffer.
*/
void
@@ -2093,7 +2093,7 @@ gui_chat_draw_free_buffer (struct t_gui_window *window, int clear_chat)
}
/*
* Gets line content in bare display.
* Get line content in bare display.
*
* Note: result must be freed after use.
*/
@@ -2150,7 +2150,7 @@ end:
}
/*
* Draws a buffer in bare display (not ncurses).
* Draw a buffer in bare display (not ncurses).
*/
void
@@ -2301,7 +2301,7 @@ gui_chat_draw_bare (struct t_gui_window *window)
}
/*
* Draws chat window for a buffer.
* Draw chat window for a buffer.
*/
void
src/gui/curses/gui-curses-color.c
+36 -37
View File
@@ -116,9 +116,9 @@ int gui_color_timer = 0; /* timer in seconds */
/*
* Searches for a color by name.
* Search for a color by name.
*
* Returns index of color in WeeChat colors table, -1 if not found.
* Return index of color in WeeChat colors table, -1 if not found.
*/
int
@@ -140,9 +140,9 @@ gui_color_search (const char *color_name)
}
/*
* Searches for a color by index.
* Search for a color by index.
*
* Returns name of color in WeeChat colors table, NULL if not found.
* Return name of color in WeeChat colors table, NULL if not found.
*/
const char *
@@ -214,9 +214,9 @@ gui_color_get_extended_flags (int attrs)
}
/*
* Assigns a WeeChat color (read from configuration).
* Assign a WeeChat color (read from configuration).
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -270,12 +270,12 @@ gui_color_assign (int *color, const char *color_name)
}
/*
* Assigns color by difference.
* Assign color by difference.
*
* It is called when a color option is set with value ++X or --X, to search
* another color (for example ++1 is next color/alias in list).
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -323,7 +323,7 @@ gui_color_assign_by_diff (int *color, const char *color_name, int diff)
}
/*
* Gets number of WeeChat colors.
* Get number of WeeChat colors.
*/
int
@@ -333,7 +333,7 @@ gui_color_get_weechat_colors_number (void)
}
/*
* Gets number of colors supported by terminal.
* Get number of colors supported by terminal.
*/
int
@@ -343,7 +343,7 @@ gui_color_get_term_colors (void)
}
/*
* Gets number of color pairs supported by terminal.
* Get number of color pairs supported by terminal.
*/
int
@@ -353,8 +353,7 @@ gui_color_get_term_color_pairs (void)
}
/*
* Gets current pairs as arrays (one array for foregrounds, another for
* backgrounds).
* Get current pairs as arrays (one array for foregrounds, another for backgrounds).
*
* Each array has "gui_color_num_pairs+1" entries. Pairs not used have value -2
* in both arrays.
@@ -414,7 +413,7 @@ error:
}
/*
* Displays a warning when no more pair is available in table.
* Display a warning when no more pair is available in table.
*/
int
@@ -435,11 +434,11 @@ gui_color_timer_warning_pairs_full (const void *pointer, void *data,
}
/*
* Gets a pair with given foreground/background colors.
* Get a pair with given foreground/background colors.
*
* If no pair is found for fg/bg, a new pair is created.
*
* Returns a value between 0 and COLOR_PAIRS-1.
* Return a value between 0 and COLOR_PAIRS-1.
*/
int
@@ -517,7 +516,7 @@ gui_color_get_pair (int fg, int bg)
}
/*
* Gets color pair with a WeeChat color number.
* Get color pair with a WeeChat color number.
*/
int
@@ -545,7 +544,7 @@ gui_color_weechat_get_pair (int weechat_color)
}
/*
* Gets color name.
* Get color name.
*/
const char *
@@ -592,7 +591,7 @@ gui_color_get_name (int num_color)
}
/*
* Builds a WeeChat color with foreground and background.
* Build a WeeChat color with foreground and background.
*
* Foreground and background must be >= 0 and can be a WeeChat or extended
* color, with optional attributes for foreground.
@@ -643,7 +642,7 @@ gui_color_build (int number, int foreground, int background)
}
/*
* Initializes color variables using terminal infos.
* Initialize color variables using terminal infos.
*/
void
@@ -703,7 +702,7 @@ gui_color_init_vars (void)
}
/*
* Frees color variables.
* Free color variables.
*/
void
@@ -722,7 +721,7 @@ gui_color_free_vars (void)
}
/*
* Initializes color pairs with terminal colors.
* Initialize color pairs with terminal colors.
*/
void
@@ -740,7 +739,7 @@ gui_color_init_pairs_terminal (void)
}
/*
* Initializes color pairs with WeeChat colors.
* Initialize color pairs with WeeChat colors.
*
* Pairs defined by WeeChat are set with their values (from pair 1 to pair N),
* and other pairs are set with terminal color and default background (-1).
@@ -771,7 +770,7 @@ gui_color_init_pairs_weechat (void)
}
/*
* Displays terminal colors.
* Display terminal colors.
*
* This is called by command line option "-c" / "--colors".
*/
@@ -830,7 +829,7 @@ gui_color_display_terminal_colors (void)
}
/*
* Displays line with terminal colors and timer (remaining time for display of
* Display line with terminal colors and timer (remaining time for display of
* terminal colors).
*/
@@ -864,7 +863,7 @@ gui_color_info_term_colors (char *buffer, int size)
}
/*
* Displays content of color buffer.
* Display content of color buffer.
*/
void
@@ -1168,7 +1167,7 @@ gui_color_timer_cb (const void *pointer, void *data, int remaining_calls)
}
/*
* Switches between WeeChat and terminal colors.
* Switch between WeeChat and terminal colors.
*/
void
@@ -1215,7 +1214,7 @@ gui_color_switch_colors (void)
}
/*
* Resets all color pairs (the next refresh will auto reallocate needed pairs).
* Reset all color pairs (the next refresh will auto reallocate needed pairs).
*
* It is useful when color pairs table is full, to remove non used pairs.
*/
@@ -1289,7 +1288,7 @@ gui_color_buffer_close_cb (const void *pointer, void *data,
}
/*
* Assigns color buffer to pointer if it is not yet set.
* Assign color buffer to pointer if it is not yet set.
*/
void
@@ -1307,7 +1306,7 @@ gui_color_buffer_assign (void)
}
/*
* Opens a buffer to display colors.
* Open a buffer to display colors.
*/
void
@@ -1349,7 +1348,7 @@ gui_color_buffer_open (void)
}
/*
* Adds an alias in hashtable with aliases.
* Add an alias in hashtable with aliases.
*/
void
@@ -1381,7 +1380,7 @@ gui_color_palette_add_alias_cb (void *data,
}
/*
* Builds aliases for palette.
* Build aliases for palette.
*/
void
@@ -1431,7 +1430,7 @@ gui_color_palette_build_aliases (void)
}
/*
* Creates a new color in palette.
* Create a new color in palette.
*/
struct t_gui_color_palette *
@@ -1523,7 +1522,7 @@ gui_color_palette_new (int number, const char *value)
}
/*
* Frees a color in palette.
* Free a color in palette.
*/
void
@@ -1538,7 +1537,7 @@ gui_color_palette_free (struct t_gui_color_palette *color_palette)
}
/*
* Initializes WeeChat colors.
* Initialize WeeChat colors.
*/
void
@@ -1612,7 +1611,7 @@ gui_color_init_weechat (void)
}
/*
* Allocates GUI colors.
* Allocate GUI colors.
*/
void
@@ -1630,7 +1629,7 @@ gui_color_alloc (void)
}
/*
* Dumps colors.
* Dump colors.
*/
void
src/gui/curses/gui-curses-key.c
+4 -4
View File
@@ -52,7 +52,7 @@
/*
* Creates key bind, only if it does not exist yet.
* Create key bind, only if it does not exist yet.
*/
void
@@ -67,7 +67,7 @@ gui_key_default_bind (int context, const char *key, const char *command,
}
/*
* Creates default key bindings for a given context.
* Create default key bindings for a given context.
*
* If create_option == 1, config options are created, otherwise keys are just
* added to linked list (gui_keys[]).
@@ -292,7 +292,7 @@ gui_key_default_bindings (int context, int create_option)
}
/*
* Flushes keyboard buffer.
* Flush keyboard buffer.
*/
void
@@ -511,7 +511,7 @@ gui_key_flush (int paste)
}
/*
* Reads keyboard chars.
* Read keyboard chars.
*/
int
src/gui/curses/gui-curses-main.c
+5 -5
View File
@@ -72,7 +72,7 @@ int gui_term_lines = 0; /* number of lines in terminal */
/*
* Gets a password from user (called on startup, when GUI is not initialized).
* Get a password from user (called on startup, when GUI is not initialized).
*
* The result is stored in "password" with max "size" bytes (including the
* final '\0').
@@ -161,7 +161,7 @@ gui_main_signal_sigint (int signo)
}
/*
* Initializes GUI.
* Initialize GUI.
*/
void
@@ -262,7 +262,7 @@ gui_main_signal_sigwinch (int signo)
}
/*
* Displays infos about ncurses lib.
* Display infos about ncurses lib.
*/
void
@@ -277,7 +277,7 @@ gui_main_debug_libs (void)
}
/*
* Refreshes for windows, buffers, bars.
* Refresh for windows, buffers, bars.
*/
void
@@ -464,7 +464,7 @@ gui_main_loop (void)
}
/*
* Ends GUI.
* End GUI.
*
* Argument "clean_exit" is 0 when WeeChat is crashing (we don't clean objects
* because WeeChat can crash again during this cleanup...).
src/gui/curses/gui-curses-mouse.c
+11 -11
View File
@@ -84,7 +84,7 @@ char *gui_mouse_button_utf8_codes[][2] =
/*
* Enables mouse.
* Enable mouse.
*/
void
@@ -99,7 +99,7 @@ gui_mouse_enable (void)
}
/*
* Disables mouse.
* Disable mouse.
*/
void
@@ -114,7 +114,7 @@ gui_mouse_disable (void)
}
/*
* Displays state of mouse.
* Display state of mouse.
*/
void
@@ -126,7 +126,7 @@ gui_mouse_display_state (void)
}
/*
* Initializes "grab mode".
* Initialize "grab mode".
*/
void
@@ -136,7 +136,7 @@ gui_mouse_grab_init (int area)
}
/*
* Gets area for input, according to (x,y) of mouse event.
* Get area for input, according to (x,y) of mouse event.
*
* For example: @item(buffer_nicklist)
* @bar(title)
@@ -181,7 +181,7 @@ gui_mouse_grab_event2input (void)
}
/*
* Ends "grab mode".
* End "grab mode".
*/
void
@@ -216,7 +216,7 @@ gui_mouse_grab_end (const char *mouse_key)
}
/*
* Returns size of mouse event (SGR and UTF-8 events are supported):
* Return size of mouse event (SGR and UTF-8 events are supported):
* -1: not a mouse event
* 0: incomplete mouse event
* > 0: complete mouse event
@@ -265,7 +265,7 @@ gui_mouse_event_size (const char *key)
}
/*
* Concatenates the mouse event gesture in a key (containing the button name).
* Concatenate the mouse event gesture in a key (containing the button name).
*
* Note: *key must be long enough for the gesture added by this function
* (see below).
@@ -349,7 +349,7 @@ gui_mouse_event_concat_gesture (char *key)
}
/*
* Gets mouse event name with a SGR mouse event.
* Get mouse event name with a SGR mouse event.
*/
const char *
@@ -482,7 +482,7 @@ error:
}
/*
* Gets mouse event name with a UTF-8 mouse event: if the key is invalid UTF-8,
* Get mouse event name with a UTF-8 mouse event: if the key is invalid UTF-8,
* use the 3 bytes, otherwise 3 UTF-8 chars.
*/
@@ -596,7 +596,7 @@ gui_mouse_event_name_utf8 (const char *key)
}
/*
* Processes a mouse event.
* Process a mouse event.
*/
void
src/gui/curses/gui-curses-term.c
+1 -1
View File
@@ -39,7 +39,7 @@
/*
* Sets "eat_newline_glitch" variable.
* Set "eat_newline_glitch" variable.
*
* With value 0, this is used to not auto insert newline char at end of lines
* displayed, so that long words like URLs are not cut when they are selected
src/gui/curses/gui-curses-window.c
+81 -82
View File
@@ -76,7 +76,7 @@ int gui_window_saved_style_index = 0; /* index in list of savec styles */
/*
* Gets screen width (terminal width in chars for Curses).
* Get screen width (terminal width in chars for Curses).
*/
int
@@ -86,7 +86,7 @@ gui_window_get_width (void)
}
/*
* Gets screen height (terminal height in chars for Curses).
* Get screen height (terminal height in chars for Curses).
*/
int
@@ -96,7 +96,7 @@ gui_window_get_height (void)
}
/*
* Reads terminal size.
* Read terminal size.
*/
void
@@ -120,9 +120,9 @@ gui_window_read_terminal_size (void)
}
/*
* Initializes Curses windows.
* Initialize Curses windows.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -145,7 +145,7 @@ gui_window_objects_init (struct t_gui_window *window)
}
/*
* Frees Curses windows for a window.
* Free Curses windows for a window.
*/
void
@@ -175,7 +175,7 @@ gui_window_objects_free (struct t_gui_window *window, int free_separators)
}
/*
* Clears a Curses window.
* Clear a Curses window.
*/
void
@@ -210,7 +210,7 @@ gui_window_clear (WINDOW *window, int fg, int bg)
}
/*
* Clears until end of line with current background.
* Clear until end of line with current background.
*/
void
@@ -230,7 +230,7 @@ gui_window_clrtoeol (WINDOW *window)
}
/*
* Saves current style.
* Save current style.
*/
void
@@ -259,7 +259,7 @@ gui_window_save_style (WINDOW *window)
}
/*
* Restores style values.
* Restore style values.
*/
void
@@ -290,7 +290,7 @@ gui_window_restore_style (WINDOW *window)
}
/*
* Resets style (color and attr) with a WeeChat color for a window.
* Reset style (color and attr) with a WeeChat color for a window.
*/
void
@@ -305,7 +305,7 @@ gui_window_reset_style (WINDOW *window, int weechat_color)
}
/*
* Resets color with a WeeChat color for a window.
* Reset color with a WeeChat color for a window.
*/
void
@@ -319,7 +319,7 @@ gui_window_reset_color (WINDOW *window, int weechat_color)
}
/*
* Sets style for color.
* Set style for color.
*/
void
@@ -330,7 +330,7 @@ gui_window_set_color_style (WINDOW *window, int style)
}
/*
* Removes style for color.
* Remove style for color.
*/
void
@@ -341,7 +341,7 @@ gui_window_remove_color_style (WINDOW *window, int style)
}
/*
* Sets color for a window.
* Set color for a window.
*/
void
@@ -354,7 +354,7 @@ gui_window_set_color (WINDOW *window, int fg, int bg)
}
/*
* Sets WeeChat color for window.
* Set WeeChat color for window.
*/
void
@@ -387,7 +387,7 @@ gui_window_set_weechat_color (WINDOW *window, int num_color)
}
/*
* Sets a custom color for a window (foreground only).
* Set a custom color for a window (foreground only).
*/
void
@@ -454,7 +454,7 @@ gui_window_set_custom_color_fg (WINDOW *window, int fg)
}
/*
* Sets a custom color for a window (background only).
* Set a custom color for a window (background only).
*/
void
@@ -483,7 +483,7 @@ gui_window_set_custom_color_bg (WINDOW *window, int bg)
}
/*
* Sets a custom color for a window (foreground and background).
* Set a custom color for a window (foreground and background).
*/
void
@@ -556,7 +556,7 @@ gui_window_set_custom_color_fg_bg (WINDOW *window, int fg, int bg,
}
/*
* Sets a custom color for a window (pair number).
* Set a custom color for a window (pair number).
*/
void
@@ -570,7 +570,7 @@ gui_window_set_custom_color_pair (WINDOW *window, int pair)
}
/*
* Toggles text emphasis.
* Toggle text emphasis.
*/
void
@@ -580,7 +580,7 @@ gui_window_toggle_emphasis (void)
}
/*
* Emphasizes some chars already displayed in a window, either using a color
* Emphasize some chars already displayed in a window, either using a color
* (from config options), or by doing an exclusive or (XOR) with attributes
* (like reverse video).
*
@@ -628,10 +628,10 @@ gui_window_emphasize (WINDOW *window, int x, int y, int count)
}
/*
* Applies foreground color code in string and moves string pointer after color
* Apply foreground color code in string and moves string pointer after color
* in string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -700,10 +700,10 @@ gui_window_string_apply_color_fg (unsigned char **string, WINDOW *window)
}
/*
* Applies background color code in string and moves string pointer after color
* Apply background color code in string and moves string pointer after color
* in string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -759,10 +759,10 @@ gui_window_string_apply_color_bg (unsigned char **string, WINDOW *window)
}
/*
* Applies foreground + background color code in string and moves string pointer
* Apply foreground + background color code in string and moves string pointer
* after color in string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -883,10 +883,10 @@ gui_window_string_apply_color_fg_bg (unsigned char **string, WINDOW *window)
}
/*
* Applies pair color code in string and moves string pointer after color in
* Apply pair color code in string and moves string pointer after color in
* string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -920,10 +920,10 @@ gui_window_string_apply_color_pair (unsigned char **string, WINDOW *window)
}
/*
* Applies weechat color code in string and moves string pointer after color in
* Apply weechat color code in string and moves string pointer after color in
* string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -957,10 +957,10 @@ gui_window_string_apply_color_weechat (unsigned char **string, WINDOW *window)
}
/*
* Applies "set attribute" color code in string and moves string pointer after
* Apply "set attribute" color code in string and moves string pointer after
* color in string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -1008,10 +1008,10 @@ gui_window_string_apply_color_set_attr (unsigned char **string, WINDOW *window)
}
/*
* Applies "remove attribute" color code in string and moves string pointer
* Apply "remove attribute" color code in string and moves string pointer
* after color in string.
*
* If window is NULL, no color is applied but string pointer is moved anyway.
* If window is NULL, do not apply colors but still move string pointer.
*/
void
@@ -1059,7 +1059,7 @@ gui_window_string_apply_color_remove_attr (unsigned char **string, WINDOW *windo
}
/*
* Calculates position and size for a buffer and subwindows.
* Calculate position and size for a buffer and subwindows.
*/
void
@@ -1100,10 +1100,10 @@ gui_window_calculate_pos_size (struct t_gui_window *window)
}
/*
* Draws a horizontal line (like ncurses function "mvwhline", but UTF-8 chars
* Draw a horizontal line (like ncurses function "mvwhline", but UTF-8 chars
* are supported).
*
* If "string" is NULL or empty, the ACS_HLINE char is used (plain line).
* If "string" is NULL or empty, use the ACS_HLINE char (plain line).
* If "string" is not NULL and not empty, its width on screen must be exactly
* one char.
*/
@@ -1127,10 +1127,10 @@ gui_window_hline (WINDOW *window, int x, int y, int width, const char *string)
}
/*
* Draws a vertical line (like ncurses function "mvwvline", but UTF-8 chars
* Draw a vertical line (like ncurses function "mvwvline", but UTF-8 chars
* are supported).
*
* If "string" is NULL or empty, the ACS_VLINE char is used (plain line).
* If "string" is NULL or empty, use the ACS_VLINE char (plain line).
* If "string" is not NULL and not empty, its width on screen must be exactly
* one char.
*/
@@ -1154,7 +1154,7 @@ gui_window_vline (WINDOW *window, int x, int y, int height, const char *string)
}
/*
* Draws window separators.
* Draw window separators.
*/
void
@@ -1246,7 +1246,7 @@ gui_window_draw_separators (struct t_gui_window *window)
}
/*
* Switches to another buffer in a window.
* Switch to another buffer in a window.
*/
void
@@ -1381,7 +1381,7 @@ gui_window_switch_to_buffer (struct t_gui_window *window,
}
/*
* Switches to another window.
* Switch to another window.
*/
void
@@ -1420,7 +1420,7 @@ gui_window_switch (struct t_gui_window *window)
}
/*
* Displays previous page on buffer.
* Display previous page on buffer.
*/
void
@@ -1471,7 +1471,7 @@ gui_window_page_up (struct t_gui_window *window)
}
/*
* Displays next page on buffer.
* Display next page on buffer.
*/
void
@@ -1530,7 +1530,7 @@ gui_window_page_down (struct t_gui_window *window)
}
/*
* Displays previous few lines in buffer.
* Display previous few lines in buffer.
*/
void
@@ -1575,7 +1575,7 @@ gui_window_scroll_up (struct t_gui_window *window)
}
/*
* Displays next few lines in buffer.
* Display next few lines in buffer.
*/
void
@@ -1628,7 +1628,7 @@ gui_window_scroll_down (struct t_gui_window *window)
}
/*
* Scrolls to top of buffer.
* Scroll to top of buffer.
*/
void
@@ -1662,7 +1662,7 @@ gui_window_scroll_top (struct t_gui_window *window)
}
/*
* Scrolls to bottom of buffer.
* Scroll to bottom of buffer.
*/
void
@@ -1704,7 +1704,7 @@ gui_window_scroll_bottom (struct t_gui_window *window)
}
/*
* Scrolls beyond the end of buffer (so that all lines become "hidden" above the
* Scroll beyond the end of buffer (so that all lines become "hidden" above the
* top of window).
*/
@@ -1724,11 +1724,11 @@ gui_window_scroll_beyond_end (struct t_gui_window *window)
}
/*
* Auto-resizes all windows, according to % of global size.
* Auto-resize all windows, according to % of global size.
*
* This function is called after a terminal resize.
*
* Returns:
* Return:
* 0: OK
* -1: all windows must be merged (not enough space)
*/
@@ -1806,7 +1806,7 @@ gui_window_auto_resize (struct t_gui_window_tree *tree,
}
/*
* Auto-resizes and refreshes all windows.
* Auto-resize and refreshes all windows.
*/
void
@@ -1876,9 +1876,9 @@ gui_window_refresh_windows (void)
}
/*
* Horizontally splits a window.
* Split a window horizontally.
*
* Returns pointer to new window, NULL if error.
* Return pointer to new window, NULL if error.
*/
struct t_gui_window *
@@ -1929,9 +1929,9 @@ gui_window_split_horizontal (struct t_gui_window *window, int percentage)
}
/*
* Vertically splits a window.
* Split a window vertically.
*
* Returns pointer to new window, NULL if error.
* Return pointer to new window, NULL if error.
*/
struct t_gui_window *
@@ -1981,7 +1981,7 @@ gui_window_split_vertical (struct t_gui_window *window, int percentage)
}
/*
* Resizes a window.
* Resize a window.
*/
void
@@ -2018,7 +2018,7 @@ gui_window_resize (struct t_gui_window_tree *tree, int percentage)
}
/*
* Resizes window using delta percentage.
* Resize a window using delta percentage.
*/
void
@@ -2059,9 +2059,9 @@ gui_window_resize_delta (struct t_gui_window_tree *tree, int delta_percentage)
}
/*
* Merges window with its sister.
* Merge a window with its sister.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2112,7 +2112,7 @@ gui_window_merge (struct t_gui_window *window)
}
/*
* Merges all windows into only one.
* Merge all windows into only one.
*/
void
@@ -2154,9 +2154,9 @@ gui_window_merge_all (struct t_gui_window *window)
}
/*
* Closes a window.
* Close a window.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2182,7 +2182,7 @@ gui_window_close (struct t_gui_window *window)
}
/*
* Returns a code about position of 2 windows:
* Return a code about position of 2 windows:
* 0 = they're not side by side
* 1 = side by side: win2 is over the win1
* 2 = side by side: win2 on the right
@@ -2245,7 +2245,7 @@ gui_window_side_by_side (struct t_gui_window *win1, struct t_gui_window *win2)
}
/*
* Searches and switches to a window over current window.
* Search and switch to a window over current window.
*/
void
@@ -2269,7 +2269,7 @@ gui_window_switch_up (struct t_gui_window *window)
}
/*
* Searches and switches to a window below current window.
* Search and switch to a window below current window.
*/
void
@@ -2293,7 +2293,7 @@ gui_window_switch_down (struct t_gui_window *window)
}
/*
* Searches and switches to a window on the left of current window.
* Search and switch to a window on the left of current window.
*/
void
@@ -2317,7 +2317,7 @@ gui_window_switch_left (struct t_gui_window *window)
}
/*
* Searches and switches to a window on the right of current window.
* Search and switch to a window on the right of current window.
*/
void
@@ -2341,7 +2341,7 @@ gui_window_switch_right (struct t_gui_window *window)
}
/*
* Counts number of windows in a tree with a given split, for balancing windows.
* Count number of windows in a tree with a given split, for balancing windows.
*/
int
@@ -2367,9 +2367,9 @@ gui_window_balance_count (struct t_gui_window_tree *tree, int split_horizontal)
}
/*
* Balances windows (set all splits to 50%).
* Balance windows (set all splits to 50%).
*
* Returns:
* Return:
* 1: some windows have been balanced
* 0: nothing was changed
*/
@@ -2407,7 +2407,7 @@ gui_window_balance (struct t_gui_window_tree *tree)
}
/*
* Swaps buffers of two windows.
* Swap buffers of two windows.
*
* Argument "direction" can be:
* 0 = auto (swap with sister)
@@ -2510,7 +2510,7 @@ gui_window_bare_display_timer_cb (const void *pointer, void *data,
}
/*
* Toggles bare display.
* Toggle bare display.
*/
void
@@ -2562,7 +2562,7 @@ gui_window_bare_display_toggle (const char *delay)
}
/*
* Sets terminal title.
* Set terminal title.
*
* Note: the content of "title" (if not NULL) is evaluated, so variables like
* "${info:version}" can be used inside.
@@ -2635,7 +2635,7 @@ gui_window_set_title (const char *title)
}
/*
* Copies text to clipboard (sent to terminal).
* Copy text to clipboard (sent to terminal).
*/
void
@@ -2660,7 +2660,7 @@ gui_window_send_clipboard (const char *storage_unit, const char *text)
}
/*
* Enables/disables bracketed paste mode.
* Toggle bracketed paste mode.
*/
void
@@ -2683,7 +2683,7 @@ gui_window_set_bracketed_paste_mode (int enable)
}
/*
* Moves cursor on screen (for cursor mode).
* Move cursor on screen (for cursor mode).
*/
void
@@ -2697,7 +2697,7 @@ gui_window_move_cursor (void)
}
/*
* Displays some infos about terminal and colors.
* Display some infos about terminal and colors.
*/
void
@@ -2710,8 +2710,7 @@ gui_window_term_display_infos (void)
}
/*
* Prints window Curses objects infos in WeeChat log file (usually for crash
* dump).
* Print window Curses objects infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/curses/headless/main.c
+1 -1
View File
@@ -40,7 +40,7 @@
/*
* Daemonizes the process.
* Daemonize the process.
*/
void
src/gui/gui-bar-item-custom.c
+23 -23
View File
@@ -55,10 +55,10 @@ struct t_gui_bar_item_custom *last_gui_temp_custom_bar_item = NULL;
/*
* Checks if a custom bar item name is valid: it must not have any
* Check if a custom bar item name is valid: it must not have any
* space/period.
*
* Returns:
* Return:
* 1: name is valid
* 0: name is invalid
*/
@@ -82,9 +82,9 @@ gui_bar_item_custom_name_valid (const char *name)
}
/*
* Searches for a custom bar item option name.
* Search for a custom bar item option name.
*
* Returns index of option in enum t_gui_bar_item_custom_option,
* Return index of option in enum t_gui_bar_item_custom_option,
* -1 if not found.
*/
@@ -107,7 +107,7 @@ gui_bar_item_custom_search_option (const char *option_name)
}
/*
* Searches for a custom bar item by name.
* Search for a custom bar item by name.
*/
struct t_gui_bar_item_custom *
@@ -130,9 +130,9 @@ gui_bar_item_custom_search (const char *item_name)
}
/*
* Searches for a custom bar item with name of option (like "name.content").
* Search for a custom bar item with name of option (like "name.content").
*
* Returns pointer to custom bar item found, NULL if not found.
* Return pointer to custom bar item found, NULL if not found.
*/
struct t_gui_bar_item_custom *
@@ -185,9 +185,9 @@ gui_bar_item_custom_config_change (const void *pointer, void *data,
}
/*
* Creates an option for a custom bar item.
* Create an option for a custom bar item.
*
* Returns pointer to new option, NULL if error.
* Return pointer to new option, NULL if error.
*/
struct t_config_option *
@@ -240,7 +240,7 @@ gui_bar_item_custom_create_option (const char *item_name, int index_option,
}
/*
* Creates option for a temporary custom bar item (when reading configuration
* Create option for a temporary custom bar item (when reading configuration
* file).
*/
@@ -340,9 +340,9 @@ end:
}
/*
* Allocates and initializes new custom bar item structure.
* Allocate and initialize new custom bar item structure.
*
* Returns pointer to new custom bar item, NULL if error.
* Return pointer to new custom bar item, NULL if error.
*/
struct t_gui_bar_item_custom *
@@ -368,7 +368,7 @@ gui_bar_item_custom_alloc (const char *name)
}
/*
* Creates bar item in a custom bar item.
* Create bar item in a custom bar item.
*/
void
@@ -384,9 +384,9 @@ gui_bar_item_custom_create_bar_item (struct t_gui_bar_item_custom *item)
}
/*
* Creates a new custom bar item with options.
* Create a new custom bar item with options.
*
* Returns pointer to new bar, NULL if error.
* Return pointer to new bar, NULL if error.
*/
struct t_gui_bar_item_custom *
@@ -418,9 +418,9 @@ gui_bar_item_custom_new_with_options (const char *name,
}
/*
* Creates a new custom bar item.
* Create a new custom bar item.
*
* Returns pointer to new custom bar item, NULL if not found.
* Return pointer to new custom bar item, NULL if not found.
*/
struct t_gui_bar_item_custom *
@@ -486,7 +486,7 @@ error:
}
/*
* Uses temporary custom bar items (created by reading configuration file).
* Use temporary custom bar items (created by reading configuration file).
*/
void
@@ -538,9 +538,9 @@ gui_bar_item_custom_use_temp_items (void)
}
/*
* Renames a custom bar item.
* Rename a custom bar item.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -598,7 +598,7 @@ gui_bar_item_custom_rename (struct t_gui_bar_item_custom *item,
}
/*
* Frees data in a custom bar item.*
* Free data in a custom bar item.
*/
void
@@ -614,7 +614,7 @@ gui_bar_item_custom_free_data (struct t_gui_bar_item_custom *item)
}
/*
* Deletes a custom bar item.
* Delete a custom bar item.
*/
void
@@ -651,7 +651,7 @@ gui_bar_item_custom_free (struct t_gui_bar_item_custom *item)
}
/*
* Deletes all custom bar items.
* Delete all custom bar items.
*/
void
src/gui/gui-bar-item.c
+32 -33
View File
@@ -77,9 +77,9 @@ struct t_hook *gui_bar_item_timer_hotlist_resort = NULL;
/*
* Checks if a bar item pointer is valid.
* Check if a bar item pointer is valid.
*
* Returns:
* Return:
* 1: bar item exists
* 0: bar item does not exist
*/
@@ -104,9 +104,9 @@ gui_bar_item_valid (struct t_gui_bar_item *bar_item)
}
/*
* Searches for a default bar item by name.
* Search for a default bar item by name.
*
* Returns index in gui_bar_item_names[], -1 if not found.
* Return index in gui_bar_item_names[], -1 if not found.
*/
int
@@ -128,7 +128,7 @@ gui_bar_item_search_default (const char *item_name)
}
/*
* Searches for a bar item by name.
* Search for a bar item by name.
*/
struct t_gui_bar_item *
@@ -150,12 +150,12 @@ gui_bar_item_search (const char *item_name)
}
/*
* Searches for a bar item in a plugin.
* Search for a bar item in a plugin.
*
* If exact_plugin == 1, then searches only for this plugin, otherwise, if
* If exact_plugin == 1, search only for this plugin, otherwise, if
* plugin is not found, function may return item for core (plugin == NULL).
*
* Returns pointer to bar item found, NULL if not found.
* Return pointer to bar item found, NULL if not found.
*/
struct t_gui_bar_item *
@@ -197,9 +197,9 @@ gui_bar_item_search_with_plugin (struct t_weechat_plugin *plugin,
/*
* Check if an item is used in a bar.
*
* If partial_name == 1, then searches if an item begins with "item_name".
* If partial_name == 1, search if an item begins with "item_name".
*
* Returns:
* Return:
* 1: bar item is used in the bar
* 0: bar item is not used in the bar
*/
@@ -239,12 +239,11 @@ gui_bar_item_used_in_bar (struct t_gui_bar *bar, const char *item_name,
}
/*
* Checks if a bar item is used in at least one bar.
* Check if a bar item is used in at least one bar.
*
* If partial_name == 1, then searches a bar that contains item beginning with
* "item_name".
* If partial_name == 1, search a bar that contains item beginning with "item_name".
*
* Returns:
* Return:
* 1: bar item is used in at least one bar
* 0: bar item is not used in a bar
*/
@@ -295,7 +294,7 @@ gui_bar_item_used_in_at_least_one_bar (const char *item_name, int partial_name,
}
/*
* Gets buffer, prefix, name and suffix for an item.
* Get buffer, prefix, name and suffix for an item.
*
* Examples:
* - item name "[time]" returns:
@@ -372,14 +371,14 @@ gui_bar_item_get_vars (const char *item_name,
}
/*
* Returns value of a bar item.
* Return value of a bar item.
*
* Run callbacks if a name exists, then concatenates:
* Run callbacks if a name exists, then concatenate:
* prefix + return of callback + suffix
*
* For example: if item == "[time]"
* returns: color(delimiter) + "[" +
* (value of item "time") + color(delimiter) + "]"
* return: color(delimiter) + "[" +
* (value of item "time") + color(delimiter) + "]"
*
* Note: result must be freed after use.
*/
@@ -539,7 +538,7 @@ gui_bar_item_get_value (struct t_gui_bar *bar, struct t_gui_window *window,
}
/*
* Counts number of lines in item.
* Count number of lines in item.
*/
int
@@ -563,9 +562,9 @@ gui_bar_item_count_lines (char *string)
}
/*
* Creates a new bar item.
* Create a new bar item.
*
* Returns pointer to new bar item, NULL if not found.
* Return pointer to new bar item, NULL if not found.
*/
struct t_gui_bar_item *
@@ -615,7 +614,7 @@ gui_bar_item_new (struct t_weechat_plugin *plugin, const char *name,
}
/*
* Updates an item on all bars displayed on screen.
* Update an item on all bars displayed on screen.
*/
void
@@ -707,7 +706,7 @@ gui_bar_item_update (const char *item_name)
}
/*
* Deletes a bar item.
* Delete a bar item.
*/
void
@@ -737,7 +736,7 @@ gui_bar_item_free (struct t_gui_bar_item *item)
}
/*
* Deletes all bar items.
* Delete all bar items.
*/
void
@@ -750,7 +749,7 @@ gui_bar_item_free_all (void)
}
/*
* Deletes all bar items for a plugin.
* Delete all bar items for a plugin.
*/
void
@@ -2285,7 +2284,7 @@ gui_bar_item_timer_hotlist_resort_cb (const void *pointer, void *data,
return WEECHAT_RC_OK;
}
/*
* Callback when a signal is received: rebuilds an item.
* Callback when a signal is received: rebuild an item.
*/
int
@@ -2322,7 +2321,7 @@ gui_bar_item_signal_cb (const void *pointer, void *data,
}
/*
* Hooks a signal to update bar items.
* Hook a signal to update bar items.
*/
void
@@ -2342,7 +2341,7 @@ gui_bar_item_hook_signal (const char *signal, const char *item)
}
/*
* Initializes default items in WeeChat.
* Initialize default items in WeeChat.
*/
void
@@ -2554,7 +2553,7 @@ gui_bar_item_init (void)
}
/*
* Removes bar items and hooks.
* Remove bar items and hooks.
*/
void
@@ -2609,9 +2608,9 @@ gui_bar_item_hdata_bar_item_cb (const void *pointer, void *data,
}
/*
* Adds a bar item in an infolist.
* Add a bar item in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2644,7 +2643,7 @@ gui_bar_item_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints bar items infos in WeeChat log file (usually for crash dump).
* Print bar items infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-bar-window.c
+50 -50
View File
@@ -48,9 +48,9 @@
/*
* Checks if a bar window pointer is valid.
* Check if a bar window pointer is valid.
*
* Returns:
* Return:
* 1: bar window exists
* 0: bar window does not exist
*/
@@ -89,9 +89,9 @@ gui_bar_window_valid (struct t_gui_bar_window *bar_window)
}
/*
* Searches for a reference to a bar in a window.
* Search for a reference to a bar in a window.
*
* Returns pointer to bar window found, NULL if not found.
* Return pointer to bar window found, NULL if not found.
*/
struct t_gui_bar_window *
@@ -114,10 +114,10 @@ gui_bar_window_search_bar (struct t_gui_window *window, struct t_gui_bar *bar)
}
/*
* Gets bar_window pointer displayed at (x,y).
* Get bar_window pointer displayed at (x,y).
*
* If window is not NULL, search is done in bar windows of window.
* If window is NULL, search is done in root bar windows.
* If window is not NULL, search in bar windows of window.
* If window is NULL, search in root bar windows.
*/
void
@@ -276,9 +276,9 @@ gui_bar_window_search_by_xy (struct t_gui_window *window, int x, int y,
}
/*
* Gets total bar size (window bars) for a position.
* Get total bar size (window bars) for a position.
*
* Bar is optional, if not NULL, computes size from bar 1 to bar # - 1.
* Bar is optional, if not NULL, compute size from bar 1 to bar # - 1.
*/
int
@@ -328,7 +328,7 @@ gui_bar_window_get_size (struct t_gui_bar *bar, struct t_gui_window *window,
}
/*
* Calculates position and size of a bar.
* Calculate position and size of a bar.
*/
void
@@ -411,7 +411,7 @@ gui_bar_window_calculate_pos_size (struct t_gui_bar_window *bar_window,
}
/*
* Searches for position of a bar window (to keep list sorted by bar priority).
* Search for position of a bar window (to keep list sorted by bar priority).
*/
struct t_gui_bar_window *
@@ -435,7 +435,7 @@ gui_bar_window_find_pos (struct t_gui_bar *bar, struct t_gui_window *window)
}
/*
* Allocates content for a bar window.
* Allocate content for a bar window.
*/
void
@@ -544,7 +544,7 @@ error:
}
/*
* Frees content of a bar window.
* Free content of a bar window.
*/
void
@@ -583,7 +583,7 @@ gui_bar_window_content_free (struct t_gui_bar_window *bar_window)
}
/*
* Builds content of an item for a bar window.
* Build content of an item for a bar window.
*/
void
@@ -618,8 +618,8 @@ gui_bar_window_content_build_item (struct t_gui_bar_window *bar_window,
}
/*
* Builds content of a bar window: calls callback for each item, then
* concatenates values (according to bar position and filling).
* Build content of a bar window: call callback for each item, then
* concatenate values (according to bar position and filling).
*/
void
@@ -644,7 +644,7 @@ gui_bar_window_content_build (struct t_gui_bar_window *bar_window,
}
/*
* Gets item or subitem content (first rebuilds content if refresh is needed).
* Get item or subitem content (first rebuild content if refresh is needed).
*/
const char *
@@ -667,9 +667,9 @@ gui_bar_window_content_get (struct t_gui_bar_window *bar_window,
}
/*
* Checks if the item content is a spacer (bar item "spacer").
* Check if the item content is a spacer (bar item "spacer").
*
* Returns:
* Return:
* 1: item is a spacer
* 1: item is not a spacer
*/
@@ -685,7 +685,7 @@ gui_bar_window_item_is_spacer (const char *item)
}
/*
* Gets content of a bar window, formatted for display, according to filling
* Get content of a bar window, formatted for display, according to filling
* for bar position.
*
* The integer variable *num_spacers is set with the number of spacers found
@@ -989,10 +989,10 @@ gui_bar_window_content_get_with_filling (struct t_gui_bar_window *bar_window,
}
/*
* Checks if spacer can be used in the bar according to its position, filling
* Check if spacer can be used in the bar according to its position, filling
* and size.
*
* Returns:
* Return:
* 1: spacers can be used
* 0: spacers cannot be used
*/
@@ -1019,7 +1019,7 @@ gui_bar_window_can_use_spacer (struct t_gui_bar_window *bar_window)
}
/*
* Computes size of each spacer in the bar.
* Compute size of each spacer in the bar.
*
* Note: result must be freed after use.
*/
@@ -1063,7 +1063,7 @@ gui_bar_window_compute_spacers_size (int length_on_screen,
}
/*
* Adds coordinates (item index/subindex and x,y).
* Add coordinates (item index/subindex and x,y).
*/
void
@@ -1107,7 +1107,7 @@ gui_bar_window_coords_add (struct t_gui_bar_window *bar_window,
}
/*
* Frees coords of a bar window.
* Free coords of a bar window.
*/
void
@@ -1131,7 +1131,7 @@ gui_bar_window_coords_free (struct t_gui_bar_window *bar_window)
}
/*
* Inserts bar window in list of bar windows (at good position, according to
* Insert bar window in list of bar windows (at good position, according to
* priority).
*/
@@ -1177,9 +1177,9 @@ gui_bar_window_insert (struct t_gui_bar_window *bar_window,
}
/*
* Creates a new "window bar" for a bar, in screen or a window.
* Create a new "window bar" for a bar, in screen or a window.
*
* If window is not NULL, bar window will be in this window.
* If window is not NULL, create bar window in this window.
*/
void
@@ -1245,9 +1245,9 @@ gui_bar_window_new (struct t_gui_bar *bar, struct t_gui_window *window)
}
/*
* Gets current size of bar window.
* Get current size of bar window.
*
* Returns width or height, depending on bar position.
* Return width or height, depending on bar position.
*/
int
@@ -1257,7 +1257,7 @@ gui_bar_window_get_current_size (struct t_gui_bar_window *bar_window)
}
/*
* Returns max size for bar window in a window.
* Return max size for bar window in a window.
*/
int
@@ -1289,7 +1289,7 @@ gui_bar_window_get_max_size_in_window (struct t_gui_bar_window *bar_window,
}
/*
* Returns max size for bar window.
* Return max size for bar window.
*/
int
@@ -1323,7 +1323,7 @@ gui_bar_window_get_max_size (struct t_gui_bar_window *bar_window,
}
/*
* Sets current size of all bar windows for a bar.
* Set current size of all bar windows for a bar.
*/
void
@@ -1370,7 +1370,7 @@ gui_bar_window_set_current_size (struct t_gui_bar_window *bar_window,
}
/*
* Frees a bar window.
* Free a bar window.
*/
void
@@ -1410,12 +1410,12 @@ gui_bar_window_free (struct t_gui_bar_window *bar_window,
}
/*
* Removes unused bars, according to bars conditions.
* Remove unused bars, according to bars conditions.
*
* If window is NULL, unused root bars are removed.
* If window is not NULL, unused window bars in this window are removed.
* If window is NULL, remove unused root bars.
* If window is not NULL, remove unused window bars in this window.
*
* Returns:
* Return:
* 1: at least one bar was removed
* 0: no bar was removed
*/
@@ -1466,12 +1466,12 @@ gui_bar_window_remove_unused_bars (struct t_gui_window *window)
}
/*
* Adds missing bars, according to bars conditions.
* Add missing bars, according to bars conditions.
*
* If window is NULL, missing root bars are added.
* If window is not NULL, missing window bars in this window are added.
* If window is NULL, add missing root bars.
* If window is not NULL, add missing window bars in this window.
*
* Returns:
* Return:
* 1: at least one bar was created
* 0: no bar was created
*/
@@ -1517,11 +1517,11 @@ gui_bar_window_add_missing_bars (struct t_gui_window *window)
}
/*
* Scrolls a bar window with a value.
* Scroll a bar window with a value.
*
* If add == 1, then value is added (otherwise subtracted).
* If add_x == 1, then value is added to scroll_x (otherwise scroll_y).
* If percent == 1, then value is a percentage (otherwise number of chars).
* If add == 1, add value (otherwise subtract).
* If add_x == 1, add value to scroll_x (otherwise scroll_y).
* If percent == 1, value is a percentage (otherwise number of chars).
*/
void
@@ -1633,7 +1633,7 @@ gui_bar_window_update_cb (void *data, struct t_hdata *hdata, void *pointer,
}
/*
* Returns hdata for bar window.
* Return hdata for bar window.
*/
struct t_hdata *
@@ -1677,9 +1677,9 @@ gui_bar_window_hdata_bar_window_cb (const void *pointer, void *data,
}
/*
* Adds a bar window in an infolist.
* Add a bar window in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1748,7 +1748,7 @@ gui_bar_window_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints bar window infos in WeeChat log file (usually for crash dump).
* Print bar window infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-bar.c
+63 -64
View File
@@ -103,9 +103,9 @@ void gui_bar_free_bar_windows (struct t_gui_bar *bar);
/*
* Checks if a bar pointer is valid.
* Check if a bar pointer is valid.
*
* Returns:
* Return:
* 1: bar exists
* 0: bar does not exist
*/
@@ -129,9 +129,9 @@ gui_bar_valid (struct t_gui_bar *bar)
}
/*
* Searches for a default bar name.
* Search for a default bar name.
*
* Returns index of default bar in enum t_gui_bar_default, -1 if not found.
* Return index of default bar in enum t_gui_bar_default, -1 if not found.
*/
int
@@ -153,9 +153,9 @@ gui_bar_search_default_bar (const char *bar_name)
}
/*
* Searches for a bar option name.
* Search for a bar option name.
*
* Returns index of option in enum t_gui_bar_option, -1 if not found.
* Return index of option in enum t_gui_bar_option, -1 if not found.
*/
int
@@ -177,9 +177,9 @@ gui_bar_search_option (const char *option_name)
}
/*
* Searches for a bar type.
* Search for a bar type.
*
* Returns index of type in enum t_gui_bar_type, -1 if not found.
* Return index of type in enum t_gui_bar_type, -1 if not found.
*/
int
@@ -201,9 +201,9 @@ gui_bar_search_type (const char *type)
}
/*
* Searches for a bar position.
* Search for a bar position.
*
* Returns index of position in enum t_gui_bar_position, -1 if not found.
* Return index of position in enum t_gui_bar_position, -1 if not found.
*/
int
@@ -225,9 +225,9 @@ gui_bar_search_position (const char *position)
}
/*
* Checks if "add_size" is OK for bar.
* Check if "add_size" is OK for bar.
*
* Returns:
* Return:
* 1: new size is OK
* 0: new size is too big
*/
@@ -272,8 +272,7 @@ gui_bar_check_size_add (struct t_gui_bar *bar, int add_size)
}
/*
* Returns filling option for bar, according to filling for current bar
* position.
* Return filling option for bar, according to filling for current bar position.
*/
enum t_gui_bar_filling
@@ -287,7 +286,7 @@ gui_bar_get_filling (struct t_gui_bar *bar)
}
/*
* Searches for position of a bar in list (to keep list sorted by priority).
* Search for position of a bar in list (to keep list sorted by priority).
*/
struct t_gui_bar *
@@ -306,7 +305,7 @@ gui_bar_find_pos (struct t_gui_bar *bar)
}
/*
* Inserts a bar to the list (at good position, according to priority).
* Insert a bar to the list (at good position, according to priority).
*/
void
@@ -347,11 +346,11 @@ gui_bar_insert (struct t_gui_bar *bar)
}
/*
* Checks if bar must be displayed in window according to conditions.
* Check if bar must be displayed in window according to conditions.
*
* If window is NULL (case of root bars), the current window is used.
* If window is NULL (case of root bars), use the current window.
*
* Returns:
* Return:
* 1: bar must be displayed
* 0: bar must not be displayed
*/
@@ -452,7 +451,7 @@ gui_bar_check_conditions (struct t_gui_bar *bar,
}
/*
* Gets total bar size ("root" type) for a position.
* Get total bar size ("root" type) for a position.
*/
int
@@ -483,9 +482,9 @@ gui_bar_root_get_size (struct t_gui_bar *bar, enum t_gui_bar_position position)
}
/*
* Searches for a bar by name.
* Search for a bar by name.
*
* Returns pointer to bar found, NULL if not found.
* Return pointer to bar found, NULL if not found.
*/
struct t_gui_bar *
@@ -507,9 +506,9 @@ gui_bar_search (const char *name)
}
/*
* Searches for a bar with name of option (like "status.type").
* Search for a bar with name of option (like "status.type").
*
* Returns pointer to bar found, NULL if not found.
* Return pointer to bar found, NULL if not found.
*/
struct t_gui_bar *
@@ -542,7 +541,7 @@ gui_bar_search_with_option_name (const char *option_name)
}
/*
* Rebuilds content of bar windows for a bar.
* Rebuild content of bar windows for a bar.
*/
void
@@ -574,7 +573,7 @@ gui_bar_content_build_bar_windows (struct t_gui_bar *bar)
}
/*
* Asks refresh for bar.
* Ask refresh for bar.
*/
void
@@ -584,7 +583,7 @@ gui_bar_ask_refresh (struct t_gui_bar *bar)
}
/*
* Asks for bar refresh on screen (for all windows where bar is).
* Ask for bar refresh on screen (for all windows where bar is).
*/
void
@@ -605,7 +604,7 @@ gui_bar_refresh (struct t_gui_bar *bar)
}
/*
* Draws a bar.
* Draw a bar.
*/
void
@@ -641,7 +640,7 @@ gui_bar_draw (struct t_gui_bar *bar)
}
/*
* Applies new size for all bar windows of bar.
* Apply new size for all bar windows of bar.
*/
void
@@ -676,7 +675,7 @@ gui_bar_apply_current_size (struct t_gui_bar *bar)
}
/*
* Frees arrays with items for a bar.
* Free arrays with items for a bar.
*/
void
@@ -733,7 +732,7 @@ gui_bar_free_items_arrays (struct t_gui_bar *bar)
}
/*
* Builds array with items for a bar.
* Build array with items for a bar.
*/
void
@@ -806,7 +805,7 @@ gui_bar_set_items_array (struct t_gui_bar *bar, const char *items)
/*
* Callback for checking bar type before changing it.
*
* Returns always 0 because changing the type of a bar is not allowed.
* Return always 0 because changing the type of a bar is not allowed.
*/
int
@@ -1008,7 +1007,7 @@ gui_bar_config_change_filling (const void *pointer, void *data,
/*
* Callback for checking bar size before changing it.
*
* Returns:
* Return:
* 1: new size is OK
* 0: new size is NOT OK
*/
@@ -1195,7 +1194,7 @@ gui_bar_config_change_items (const void *pointer, void *data,
}
/*
* Sets name for a bar.
* Set name for a bar.
*/
void
@@ -1219,9 +1218,9 @@ gui_bar_set_name (struct t_gui_bar *bar, const char *name)
}
/*
* Sets a property for a bar.
* Set a property for a bar.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1318,9 +1317,9 @@ gui_bar_set (struct t_gui_bar *bar, const char *property, const char *value)
}
/*
* Creates an option for a bar.
* Create an option for a bar.
*
* Returns pointer to new option, NULL if error.
* Return pointer to new option, NULL if error.
*/
struct t_config_option *
@@ -1520,7 +1519,7 @@ gui_bar_create_option (const char *bar_name, int index_option, const char *value
}
/*
* Creates option for a temporary bar (when reading configuration file).
* Create option for a temporary bar (when reading configuration file).
*/
void
@@ -1540,9 +1539,9 @@ gui_bar_create_option_temp (struct t_gui_bar *temp_bar, int index_option,
}
/*
* Allocates and initializes new bar structure.
* Allocate and initializes new bar structure.
*
* Returns pointer to new bar, NULL if error.
* Return pointer to new bar, NULL if error.
*/
struct t_gui_bar *
@@ -1575,7 +1574,7 @@ gui_bar_alloc (const char *name)
}
/*
* Sets default value for a bar option.
* Set default value for a bar option.
*/
void
@@ -1600,9 +1599,9 @@ gui_bar_set_default_value (struct t_gui_bar *bar, int index_option,
}
/*
* Creates a new bar with options.
* Create a new bar with options.
*
* Returns pointer to new bar, NULL if error.
* Return pointer to new bar, NULL if error.
*/
struct t_gui_bar *
@@ -1681,9 +1680,9 @@ gui_bar_new_with_options (const char *name,
}
/*
* Creates a new bar.
* Create a new bar.
*
* Returns pointer to new bar, NULL if error.
* Return pointer to new bar, NULL if error.
*/
struct t_gui_bar *
@@ -1805,9 +1804,9 @@ gui_bar_new (const char *name, const char *hidden, const char *priority,
}
/*
* Creates a default bar.
* Create a default bar.
*
* Returns pointer to new bar, NULL if error.
* Return pointer to new bar, NULL if error.
*/
struct t_gui_bar *
@@ -1833,7 +1832,7 @@ gui_bar_new_default (enum t_gui_bar_default bar)
}
/*
* Uses temporary bars (created by reading configuration file).
* Use temporary bars (created by reading configuration file).
*/
void
@@ -1906,7 +1905,7 @@ gui_bar_use_temp_bars (void)
}
/*
* Creates default input bar if it does not exist.
* Create default input bar if it does not exist.
*/
void
@@ -1950,7 +1949,7 @@ gui_bar_create_default_input (void)
}
/*
* Creates default title bar if it does not exist.
* Create default title bar if it does not exist.
*/
void
@@ -1972,7 +1971,7 @@ gui_bar_create_default_title (void)
}
/*
* Creates default status bar if it does not exist.
* Create default status bar if it does not exist.
*/
void
@@ -1994,7 +1993,7 @@ gui_bar_create_default_status (void)
}
/*
* Creates default nicklist bar if it does not exist.
* Create default nicklist bar if it does not exist.
*/
void
@@ -2016,7 +2015,7 @@ gui_bar_create_default_nicklist (void)
}
/*
* Creates default bars if they do not exist.
* Create default bars if they do not exist.
*/
void
@@ -2029,7 +2028,7 @@ gui_bar_create_default (void)
}
/*
* Updates a bar on screen.
* Update a bar on screen.
*/
void
@@ -2051,9 +2050,9 @@ gui_bar_update (const char *name)
}
/*
* Scrolls a bar.
* Scroll a bar.
*
* Returns:
* Return:
* 1: scroll OK
* 0: error
*/
@@ -2169,7 +2168,7 @@ gui_bar_scroll (struct t_gui_bar *bar, struct t_gui_window *window,
}
/*
* Deletes a bar.
* Delete a bar.
*/
void
@@ -2211,7 +2210,7 @@ gui_bar_free (struct t_gui_bar *bar)
}
/*
* Deletes all bars.
* Delete all bars.
*/
void
@@ -2224,7 +2223,7 @@ gui_bar_free_all (void)
}
/*
* Frees bar windows for a bar.
* Free bar windows for a bar.
*/
void
@@ -2256,7 +2255,7 @@ gui_bar_free_bar_windows (struct t_gui_bar *bar)
}
/*
* Returns hdata for bar.
* Return hdata for bar.
*/
struct t_hdata *
@@ -2292,9 +2291,9 @@ gui_bar_hdata_bar_cb (const void *pointer, void *data, const char *hdata_name)
}
/*
* Adds a bar in an infolist.
* Add a bar in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2381,7 +2380,7 @@ gui_bar_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints bar infos in WeeChat log file (usually for crash dump).
* Print bar infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-buffer.c
+148 -149
View File
File diff suppressed because it is too large Load Diff
src/gui/gui-chat.c
+38 -40
View File
@@ -83,7 +83,7 @@ char *gui_chat_pipe_color_string[GUI_CHAT_PIPE_NUM_COLORS] =
/*
* Initializes some variables for chat area (called before reading WeeChat
* Initialize some variables for chat area (called before reading WeeChat
* configuration file).
*/
@@ -112,7 +112,7 @@ gui_chat_init (void)
}
/*
* Builds prefix with colors (called after reading WeeChat configuration file).
* Build prefix with colors (called after reading WeeChat configuration file).
*/
void
@@ -149,7 +149,7 @@ gui_chat_prefix_build (void)
}
/*
* Returns number of char in a string (special chars like colors/attributes are
* Return number of char in a string (special chars like colors/attributes are
* ignored).
*/
@@ -173,7 +173,7 @@ gui_chat_strlen (const char *string)
}
/*
* Returns number of char needed on screen to display a word (special chars like
* Return number of char needed on screen to display a word (special chars like
* colors/attributes are ignored).
*/
@@ -199,7 +199,7 @@ gui_chat_strlen_screen (const char *string)
}
/*
* Moves forward N chars in a string, skipping all formatting chars (like
* Move forward N chars in a string, skipping all formatting chars (like
* colors/attributes).
*/
@@ -221,7 +221,7 @@ gui_chat_string_add_offset (const char *string, int offset)
}
/*
* Moves forward N chars (using size on screen) in a string, skipping all
* Move forward N chars (using size on screen) in a string, skipping all
* formatting chars (like colors/attributes).
*/
@@ -251,15 +251,14 @@ gui_chat_string_add_offset_screen (const char *string, int offset_screen)
}
/*
* Gets real position in string (ignoring formatting chars like
* colors/attributes).
* Get real position in string (ignoring formatting chars like colors/attributes).
*
* If argument "use_screen_size" is 0, the "pos" argument is a number of UTF-8
* chars.
* If argument "use_screen_size" is 1, the "pos" argument is the width of UTF-8
* chars on screen.
*
* Returns real position, in bytes.
* Return real position, in bytes.
*/
int
@@ -295,10 +294,9 @@ gui_chat_string_real_pos (const char *string, int pos, int use_screen_size)
}
/*
* Gets real position in string (ignoring formatting chars like
* colors/attributes).
* Get real position in string (ignoring formatting chars like colors/attributes).
*
* Returns position, in number of UTF-8 chars.
* Return position, in number of UTF-8 chars.
*/
int
@@ -325,9 +323,10 @@ gui_chat_string_pos (const char *string, int real_pos)
}
/*
* Returns info about next word: beginning, end, length.
* Return info about next word: beginning, end, length.
*
* Stops before the first newline character, even if no characters or only spaces and color codes precede it.
* Stop before the first newline character, even if no characters or only spaces
* and color codes precede it.
*
* Note: the word_{start|end}_offset are in bytes, but word_length(_with_spaces)
* are in number of chars on screen.
@@ -405,7 +404,7 @@ gui_chat_get_word_info (struct t_gui_window *window,
}
/*
* Gets time string, for display (with colors).
* Get time string, for display (with colors).
*
* Note: result must be freed after use.
*/
@@ -522,7 +521,7 @@ gui_chat_get_time_string (time_t date, int date_usec, int highlight)
}
/*
* Calculates time length with a time format (format can include color codes
* Calculate time length with a time format (format can include color codes
* with format ${name}).
*/
@@ -551,7 +550,7 @@ gui_chat_get_time_length (void)
}
/*
* Changes time format for all lines of all buffers.
* Change time format for all lines of all buffers.
*/
void
@@ -579,10 +578,10 @@ gui_chat_change_time_format (void)
}
/*
* Checks if the buffer pointer is valid for printing a chat message,
* Check if the buffer pointer is valid for printing a chat message,
* according to buffer type.
*
* Returns:
* Return:
* 1: buffer is valid
* 0: buffer is not valid
*/
@@ -612,9 +611,9 @@ gui_chat_buffer_valid (struct t_gui_buffer *buffer,
}
/*
* Searches for a pipe color name.
* Search for a pipe color name.
*
* Returns index of color in enum t_gui_chat_pipe_color, -1 if not found.
* Return index of color in enum t_gui_chat_pipe_color, -1 if not found.
*/
int
@@ -636,7 +635,7 @@ gui_chat_pipe_search_color (const char *color)
}
/*
* Converts color in a message, according to variable gui_chat_pipe_color.
* Convert color in a message, according to variable gui_chat_pipe_color.
*
* Note: result must be freed after use.
*/
@@ -663,7 +662,7 @@ gui_chat_pipe_convert_color (const char *data)
}
/*
* Builds a message with a line: "<prefix> <message>" or "<message>" if there
* Build a message with a line: "<prefix> <message>" or "<message>" if there
* is no prefix.
*
* Note: result must be freed after use.
@@ -693,7 +692,7 @@ gui_chat_pipe_build_message (struct t_gui_line *line)
}
/*
* Sends data to a buffer (command `/pipe -o`).
* Send data to a buffer (command `/pipe -o`).
*/
void
@@ -732,9 +731,9 @@ gui_chat_pipe_send_buffer_input (struct t_gui_buffer *buffer, const char *data)
}
/*
* Handles a redirection with /pipe command.
* Handle a redirection with /pipe command.
*
* Returns:
* Return:
* 1: line has been handled and must NOT be displayed
* 0: line has NOT been handled and must be displayed
*/
@@ -805,7 +804,7 @@ gui_chat_pipe_handle_line (struct t_gui_line *line)
}
/*
* Ends pipe and flushes concatenated lines to a buffer or a file
* End pipe and flushes concatenated lines to a buffer or a file
* (if command `/pipe -g` was used).
*/
@@ -886,9 +885,9 @@ gui_chat_pipe_end (void)
}
/*
* Displays a message in a buffer with optional date and tags.
* This function is called internally by the function
* gui_chat_printf_date_tags.
* Display a message in a buffer with optional date and tags.
*
* This function is called internally by the function gui_chat_printf_date_tags.
*/
void
@@ -1105,7 +1104,7 @@ no_print:
}
/*
* Adds a line when WeeChat is waiting for the core buffer.
* Add a line when WeeChat is waiting for the core buffer.
*
* The line is stored in an internal buffer area and will be displayed later
* in the core buffer.
@@ -1128,12 +1127,11 @@ gui_chat_add_line_waiting_buffer (const char *message)
}
/*
* Displays lines that are waiting for buffer.
* Display lines that are waiting for buffer.
*
* If "f" is not NULL, the lines are written in this file (which is commonly
* stdout or stderr).
* If "f" is NULL, the lines are displayed in core buffer if the GUI is
* initialized (gui_init_ok == 1), otherwise on stdout.
* If "f" is not NULL, write lines in this file (which is commonly stdout or stderr).
* If "f" is NULL, display lines in core buffer if the GUI is initialized
* (gui_init_ok == 1), otherwise on stdout.
*/
void
@@ -1170,7 +1168,7 @@ gui_chat_print_lines_waiting_buffer (FILE *f)
}
/*
* Displays a message in a buffer with optional date and tags.
* Display a message in a buffer with optional date and tags.
*
* Note: this function works only with formatted buffers (not buffers with free
* content).
@@ -1253,7 +1251,7 @@ gui_chat_printf_datetime_tags (struct t_gui_buffer *buffer,
}
/*
* Displays a message on a line in a buffer with free content.
* Display a message on a line in a buffer with free content.
*
* Note: this function works only with free content buffers (not formatted
* buffers).
@@ -1388,7 +1386,7 @@ end:
}
/*
* Quotes a line.
* Quote a line.
*/
int
@@ -1492,7 +1490,7 @@ gui_chat_hsignal_quote_line_cb (const void *pointer, void *data,
}
/*
* Frees some variables allocated for chat area.
* Free some variables allocated for chat area.
*/
void
src/gui/gui-color.c
+35 -36
View File
@@ -115,9 +115,9 @@ char *gui_color_ansi[16] =
/*
* Returns a color code from an option, which can be a color or a string.
* Return a color code from an option, which can be a color or a string.
*
* Returns NULL if the option has a wrong type.
* Return NULL if the option has a wrong type.
*/
const char *
@@ -146,9 +146,9 @@ gui_color_from_option (struct t_config_option *option)
}
/*
* Searches for a color with configuration option name.
* Search for a color with configuration option name.
*
* Returns color string, NULL if not found.
* Return color string, NULL if not found.
*/
const char *
@@ -181,9 +181,9 @@ gui_color_search_config (const char *color_name)
}
/*
* Returns flag for attribute char of a color.
* Return flag for attribute char of a color.
*
* Returns 0 if char is unknown.
* Return 0 if char is unknown.
*/
int
@@ -214,7 +214,7 @@ gui_color_attr_get_flag (char c)
}
/*
* Builds string with attributes of color.
* Build string with attributes of color.
*
* The str_attr must be at least 6 bytes long (5 for attributes + final '\0').
*/
@@ -245,7 +245,7 @@ gui_color_attr_build_string (int color, char *str_attr)
}
/*
* Gets a custom color with a name.
* Get a custom color with a name.
*/
const char *
@@ -539,9 +539,9 @@ gui_color_get_custom (const char *color_name)
}
/*
* Converts a terminal color to its RGB value.
* Convert a terminal color to its RGB value.
*
* Returns a RGB color as integer.
* Return a RGB color as integer.
*/
int
@@ -554,13 +554,13 @@ gui_color_convert_term_to_rgb (int color)
}
/*
* Converts a RGB color to the closest terminal color.
* Convert a RGB color to the closest terminal color.
*
* Argument "limit" is the number of colors to check in the table of terminal
* colors (starting from 0). So for example 256 will return any of the 256
* colors, 16 will return a color between 0 and 15.
*
* Returns the closest terminal color (0-255).
* Return the closest terminal color (0-255).
*/
int
@@ -601,14 +601,13 @@ gui_color_convert_rgb_to_term (int rgb, int limit)
}
/*
* Returns the size (in bytes) of the WeeChat color code at the beginning
* Return the size (in bytes) of the WeeChat color code at the beginning
* of "string".
*
* If "string" is NULL, empty or does not start with a color code,
* it returns 0.
* Return 0 if "string" is NULL, empty or does not start with a color code.
*
* If "string" begins with multiple color codes, only the size of the first
* one is returned.
* Return the size of the first color code if "string" begins with multiple
* color codes.
*/
int
@@ -777,7 +776,7 @@ gui_color_code_size (const char *string)
}
/*
* Removes WeeChat color codes from a message and optionally replaces them
* Remove WeeChat color codes from a message and optionally replaces them
* by a string.
*
* Note: result must be freed after use.
@@ -965,7 +964,7 @@ gui_color_decode (const char *string, const char *replacement)
}
/*
* Converts ANSI color codes to WeeChat colors (or removes them).
* Convert ANSI color codes to WeeChat colors (or removes them).
*
* This callback is called by gui_color_decode_ansi, it must not be called
* directly.
@@ -1189,7 +1188,7 @@ end:
}
/*
* Converts ANSI color codes to WeeChat colors (or removes them).
* Convert ANSI color codes to WeeChat colors (or removes them).
*
* Note: result must be freed after use.
*/
@@ -1220,7 +1219,7 @@ gui_color_decode_ansi (const char *string, int keep_colors)
}
/*
* Adds an ANSI color code with a WeeChat attribute flag.
* Add an ANSI color code with a WeeChat attribute flag.
*/
void
@@ -1253,9 +1252,9 @@ gui_color_add_ansi_flag (char **output, int flag)
}
/*
* Converts a WeeChat color number to an ANSI color number.
* Convert a WeeChat color number to an ANSI color number.
*
* Returns -1 if the color is not found.
* Return -1 if the color is not found.
*/
int
@@ -1279,7 +1278,7 @@ gui_color_weechat_to_ansi (int color)
}
/*
* Replaces WeeChat colors by ANSI colors.
* Replace WeeChat colors by ANSI colors.
*
* Note: result must be freed after use.
*/
@@ -1726,12 +1725,12 @@ gui_color_encode_ansi (const char *string)
}
/*
* Emphasizes a string or regular expression in a string (which can contain
* Emphasize a string or regular expression in a string (which can contain
* colors).
*
* Argument "case_sensitive" is used only for "search", if the "regex" is NULL.
*
* Returns string with the search string/regex emphasized, NULL if error.
* Return string with the search string/regex emphasized, NULL if error.
*
* Note: result must be freed after use.
*/
@@ -1883,7 +1882,7 @@ gui_color_emphasize (const char *string,
}
/*
* Frees a color.
* Free a color.
*/
void
@@ -1916,7 +1915,7 @@ gui_color_palette_free_value_cb (struct t_hashtable *hashtable,
}
/*
* Allocates hashtables and lists for palette.
* Allocate hashtables and lists for palette.
*/
void
@@ -1946,9 +1945,9 @@ gui_color_palette_alloc_structs (void)
}
/*
* Gets color pair number with alias.
* Get color pair number with alias.
*
* Returns -1 if alias is not found.
* Return -1 if alias is not found.
*/
int
@@ -1968,7 +1967,7 @@ gui_color_palette_get_alias (const char *alias)
}
/*
* Gets a color palette with number.
* Get a color palette with number.
*/
struct t_gui_color_palette *
@@ -1982,7 +1981,7 @@ gui_color_palette_get (int number)
}
/*
* Adds a color in palette.
* Add a color in palette.
*/
void
@@ -2007,7 +2006,7 @@ gui_color_palette_add (int number, const char *value)
}
/*
* Removes a color in palette.
* Remove a color in palette.
*/
void
@@ -2032,7 +2031,7 @@ gui_color_palette_remove (int number)
}
/*
* Frees hashtables and lists for palette.
* Free hashtables and lists for palette.
*/
void
@@ -2044,7 +2043,7 @@ gui_color_palette_free_structs (void)
}
/*
* Initializes colors.
* Initialize colors.
*/
void
@@ -2059,7 +2058,7 @@ gui_color_init (void)
}
/*
* Ends GUI colors.
* End GUI colors.
*/
void
src/gui/gui-completion.c
+42 -42
View File
@@ -59,7 +59,7 @@ int gui_completion_freeze = 0; /* 1 to freeze completions (do not */
/*
* Compares two words in completion list.
* Compare two words in completion list.
*/
int
@@ -85,7 +85,7 @@ gui_completion_word_compare_cb (void *data,
}
/*
* Frees a word in completion list.
* Free a word in completion list.
*/
void
@@ -107,7 +107,7 @@ gui_completion_word_free_cb (void *data,
}
/*
* Initializes completion.
* Initialize completion.
*/
void
@@ -148,9 +148,9 @@ gui_completion_init (struct t_gui_completion *completion,
}
/*
* Creates a new completion.
* Create a new completion.
*
* Returns pointer to completion, NULL if error.
* Return pointer to completion, NULL if error.
*/
struct t_gui_completion *
@@ -181,9 +181,9 @@ gui_completion_new (struct t_weechat_plugin *plugin,
}
/*
* Adds an item to partial completion list.
* Add an item to partial completion list.
*
* Returns pointer to new item, NULL if error.
* Return pointer to new item, NULL if error.
*/
struct t_gui_completion_word *
@@ -206,7 +206,7 @@ gui_completion_partial_list_add (struct t_gui_completion *completion,
}
/*
* Frees data in completion.
* Free data in completion.
*/
void
@@ -238,7 +238,7 @@ gui_completion_free_data (struct t_gui_completion *completion)
}
/*
* Frees completion.
* Free completion.
*/
void
@@ -270,7 +270,7 @@ gui_completion_free (struct t_gui_completion *completion)
}
/*
* Frees all completions created by a plugin.
* Free all completions created by a plugin.
*/
void
@@ -289,7 +289,7 @@ gui_completion_free_all_plugin (struct t_weechat_plugin *plugin)
}
/*
* Stops completion (for example after 1 argument of command with 1 argument).
* Stop completion (for example after 1 argument of command with 1 argument).
*/
void
@@ -310,9 +310,9 @@ gui_completion_stop (struct t_gui_completion *completion)
}
/*
* Checks if nick has one or more ignored chars (for nick comparison).
* Check if nick has one or more ignored chars (for nick comparison).
*
* Returns:
* Return:
* 1: nick has one or more ignored chars
* 0: nick has no ignored chars
*/
@@ -341,7 +341,7 @@ gui_completion_nick_has_ignored_chars (const char *string)
}
/*
* Duplicates a nick and ignores some chars.
* Duplicate a nick and ignores some chars.
*
* Note: result must be freed after use.
*/
@@ -379,7 +379,7 @@ gui_completion_nick_strdup_ignore_chars (const char *string)
* Locale and case independent string comparison with max length for nicks
* (alpha or digits only).
*
* Returns:
* Return:
* < 0: base_word < nick
* 0: base_word == nick
* > 0: base_word > nick
@@ -417,9 +417,9 @@ gui_completion_nickncmp (const char *base_word, const char *nick, int max)
}
/*
* Compares two strings (follows case-sensitive flag in completion structure).
* Compare two strings (follows case-sensitive flag in completion structure).
*
* Returns:
* Return:
* < 0: string1 < string2
* 0: string1 == string2
* > 0: string1 > string2
@@ -437,10 +437,10 @@ gui_completion_strcmp (struct t_gui_completion *completion,
}
/*
* Compares two strings with max length (follows case-sensitive flag in
* Compare two strings with max length (follows case-sensitive flag in
* completion structure).
*
* Returns:
* Return:
* < 0: string1 < string2
* 0: string1 == string2
* > 0: string1 > string2
@@ -459,9 +459,9 @@ gui_completion_strncmp (struct t_gui_completion *completion,
}
/*
* Checks if a nick is ignored from completion (no completion with this nick).
* Check if a nick is ignored from completion (no completion with this nick).
*
* Returns:
* Return:
* 1: nick ignored
* 0: nick NOT ignored (can be used in completion)
*/
@@ -497,7 +497,7 @@ gui_completion_nick_ignored (const char *nick)
}
/*
* Adds a word to completion list.
* Add a word to completion list.
*/
void
@@ -573,7 +573,7 @@ gui_completion_custom (struct t_gui_completion *completion,
}
/*
* Builds data list according to a template.
* Build data list according to a template.
*/
void
@@ -657,7 +657,7 @@ gui_completion_build_list_template (struct t_gui_completion *completion,
}
/*
* Gets template matching arguments for command.
* Get template matching arguments for command.
*/
int
@@ -718,9 +718,9 @@ gui_completion_get_matching_template (struct t_gui_completion *completion,
}
/*
* Searches for a command hook.
* Search for a command hook.
*
* Returns pointer to hook found, NULL if not found.
* Return pointer to hook found, NULL if not found.
*/
struct t_hook *
@@ -773,7 +773,7 @@ gui_completion_search_command (struct t_gui_completion *completion,
}
/*
* Gets template according to user arguments for command.
* Get template according to user arguments for command.
*/
char *
@@ -821,7 +821,7 @@ gui_completion_get_template_for_args (struct t_gui_completion *completion,
}
/*
* Builds data list according to command and argument index.
* Build data list according to command and argument index.
*/
void
@@ -896,7 +896,7 @@ gui_completion_build_list (struct t_gui_completion *completion)
}
/*
* Finds context for completion.
* Find context for completion.
*/
void
@@ -1102,9 +1102,9 @@ gui_completion_find_context (struct t_gui_completion *completion,
}
/*
* Finds common prefix size in matching items (case is ignored).
* Find common prefix size in matching items (case is ignored).
*
* If utf_char is not null, only words beginning with this char are compared
* If utf_char is not null, compare only words beginning with this char
* (all other words are ignored).
*
* For example with items:
@@ -1151,7 +1151,7 @@ gui_completion_common_prefix_size (struct t_arraylist *list,
}
/*
* Builds list with possible completions when a partial completion occurs.
* Build list with possible completions when a partial completion occurs.
*/
void
@@ -1233,7 +1233,7 @@ gui_completion_partial_build_list (struct t_gui_completion *completion,
}
/*
* Completes word using matching items.
* Complete word using matching items.
*/
void
@@ -1395,7 +1395,7 @@ gui_completion_complete (struct t_gui_completion *completion)
}
/*
* Completes a command.
* Complete a command.
*/
void
@@ -1423,7 +1423,7 @@ gui_completion_command (struct t_gui_completion *completion)
}
/*
* Gets default completion template: from buffer local variable
* Get default completion template: from buffer local variable
* "completion_default_template" if defined, or the value of option
* "weechat.completion.default_template".
*
@@ -1495,7 +1495,7 @@ gui_completion_auto (struct t_gui_completion *completion)
}
/*
* Completes word according to context.
* Complete word according to context.
*/
int
@@ -1630,7 +1630,7 @@ gui_completion_search (struct t_gui_completion *completion, const char *data,
}
/*
* Gets a completion property as string.
* Get a completion property as string.
*/
const char *
@@ -1651,7 +1651,7 @@ gui_completion_get_string (struct t_gui_completion *completion,
}
/*
* Sets a completion property.
* Set a completion property.
*/
void
@@ -1668,7 +1668,7 @@ gui_completion_set (struct t_gui_completion *completion,
}
/*
* Returns hdata for completion.
* Return hdata for completion.
*/
struct t_hdata *
@@ -1715,7 +1715,7 @@ gui_completion_hdata_completion_cb (const void *pointer, void *data,
}
/*
* Returns hdata for completion word.
* Return hdata for completion word.
*/
struct t_hdata *
@@ -1739,7 +1739,7 @@ gui_completion_hdata_completion_word_cb (const void *pointer, void *data,
}
/*
* Prints list of completion words in WeeChat log file (usually for crash dump).
* Print list of completion words in WeeChat log file (usually for crash dump).
*/
void
@@ -1760,7 +1760,7 @@ gui_completion_list_words_print_log (struct t_arraylist *list,
}
/*
* Prints completion list in WeeChat log file (usually for crash dump).
* Print completion list in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-cursor.c
+10 -11
View File
@@ -50,7 +50,7 @@ int gui_cursor_y = 0; /* position of cursor in cursor mode */
/*
* Toggles cursor mode.
* Toggle cursor mode.
*/
void
@@ -84,7 +84,7 @@ gui_cursor_mode_toggle (void)
}
/*
* Stops cursor mode.
* Stop cursor mode.
*/
void
@@ -95,7 +95,7 @@ gui_cursor_mode_stop (void)
}
/*
* Sets debug for cursor mode.
* Set debug for cursor mode.
*/
void
@@ -113,7 +113,7 @@ gui_cursor_debug_set (int debug)
}
/*
* Displays debug info about (x,y) in input.
* Display debug info about (x,y) in input.
*/
void
@@ -151,7 +151,7 @@ gui_cursor_display_debug_info (void)
}
/*
* Sets cursor at position (x,y).
* Set cursor at position (x,y).
*/
void
@@ -178,7 +178,7 @@ gui_cursor_move_xy (int x, int y)
}
/*
* Moves cursor by adding values to (x,y).
* Move cursor by adding values to (x,y).
*/
void
@@ -205,8 +205,7 @@ gui_cursor_move_add_xy (int add_x, int add_y)
}
/*
* Moves cursor to the given position: top_left, top_right, bottom_left or
* bottom_right.
* Move cursor to the given position: top_left, top_right, bottom_left or bottom_right.
*/
void
@@ -303,7 +302,7 @@ end:
}
/*
* Moves cursor to another area by adding values to (x,y).
* Move cursor to another area by adding values to (x,y).
*/
void
@@ -384,12 +383,12 @@ gui_cursor_move_area_add_xy (int add_x, int add_y)
}
/*
* Moves cursor to another area by name.
* Move cursor to another area by name.
*
* Parameter "position" can be "top_left", "top_right", "bottom_left" or
* "bottom_right" (if NULL, top left is the default position).
*
* Returns:
* Return:
* 1: OK
* 0: area not found
*/
src/gui/gui-filter.c
+22 -22
View File
@@ -51,9 +51,9 @@ int gui_filters_enabled = 1; /* filters enabled? */
/*
* Checks if a line must be displayed or not (filtered).
* Check if a line must be displayed or not (filtered).
*
* Returns:
* Return:
* 1: line must be displayed (not filtered)
* 0: line must be hidden (filtered)
*/
@@ -110,7 +110,7 @@ gui_filter_check_line (struct t_gui_line_data *line_data)
}
/*
* Filters a buffer, using message filters.
* Filter a buffer, using message filters.
*
* If line_data is NULL, filters all lines in buffer.
* If line_data is not NULL, filters only this line_data.
@@ -188,7 +188,7 @@ gui_filter_buffer (struct t_gui_buffer *buffer,
}
/*
* Filters all buffers, using message filters.
* Filter all buffers, using message filters.
*
* If filter is NULL, filters all buffers.
* If filter is not NULL, filters only buffers matched by this filter.
@@ -212,7 +212,7 @@ gui_filter_all_buffers (struct t_gui_filter *filter)
}
/*
* Enables message filtering.
* Enable message filtering.
*/
void
@@ -228,7 +228,7 @@ gui_filter_global_enable (void)
}
/*
* Disables message filtering.
* Disable message filtering.
*/
void
@@ -244,9 +244,9 @@ gui_filter_global_disable (void)
}
/*
* Searches for a filter by name.
* Search for a filter by name.
*
* Returns pointer to filter found, NULL if not found.
* Return pointer to filter found, NULL if not found.
*/
struct t_gui_filter *
@@ -269,7 +269,7 @@ gui_filter_search_by_name (const char *name)
}
/*
* Displays an error when a new filter is created.
* Display an error when a new filter is created.
*/
void
@@ -284,7 +284,7 @@ gui_filter_new_error (const char *name, const char *error)
}
/*
* Searches for position of filter in list (to keep filters sorted by name).
* Search for position of filter in list (to keep filters sorted by name).
*/
struct t_gui_filter *
@@ -304,7 +304,7 @@ gui_filter_find_pos (struct t_gui_filter *filter)
}
/*
* Adds a filter to the list of filters (sorted by name).
* Add a filter to the list of filters (sorted by name).
*/
void
@@ -338,7 +338,7 @@ gui_filter_add_to_list (struct t_gui_filter *filter)
}
/*
* Removes a filter from list of filters.
* Remove a filter from list of filters.
*/
void
@@ -355,9 +355,9 @@ gui_filter_remove_from_list (struct t_gui_filter *filter)
}
/*
* Creates a new filter.
* Create a new filter.
*
* Returns pointer to new filter, NULL if error.
* Return pointer to new filter, NULL if error.
*/
struct t_gui_filter *
@@ -500,9 +500,9 @@ gui_filter_new (int enabled, const char *name, const char *buffer_name,
}
/*
* Renames a filter.
* Rename a filter.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -527,7 +527,7 @@ gui_filter_rename (struct t_gui_filter *filter, const char *new_name)
}
/*
* Removes a filter.
* Remove a filter.
*/
void
@@ -565,7 +565,7 @@ gui_filter_free (struct t_gui_filter *filter)
}
/*
* Removes all filters.
* Remove all filters.
*/
void
@@ -578,7 +578,7 @@ gui_filter_free_all (void)
}
/*
* Returns hdata for filter.
* Return hdata for filter.
*/
struct t_hdata *
@@ -615,9 +615,9 @@ gui_filter_hdata_filter_cb (const void *pointer, void *data,
}
/*
* Adds a filter in an infolist.
* Add a filter in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -670,7 +670,7 @@ gui_filter_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints filter infos in WeeChat log file (usually for crash dump).
* Print filter infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-focus.c
+7 -7
View File
@@ -43,9 +43,9 @@
/*
* Gets info about what is pointed by cursor at (x,y).
* Get info about what is pointed by cursor at (x,y).
*
* Returns pointer to focus info, NULL if error.
* Return pointer to focus info, NULL if error.
*
* Note: focus info must be freed after use.
*/
@@ -96,7 +96,7 @@ gui_focus_get_info (int x, int y)
}
/*
* Frees a focus info structure.
* Free a focus info structure.
*/
void
@@ -116,7 +116,7 @@ gui_focus_free_info (struct t_gui_focus_info *focus_info)
}
/*
* Adds local variables of buffer in hashtable.
* Add local variables of buffer in hashtable.
*/
void
@@ -141,9 +141,9 @@ gui_focus_buffer_localvar_map_cb (void *data,
}
/*
* Adds focus info into hashtable.
* Add focus info into hashtable.
*
* Returns pointer to new hashtable.
* Return pointer to new hashtable.
*
* Note: result must be freed after use.
*/
@@ -272,7 +272,7 @@ gui_focus_to_hashtable (struct t_gui_focus_info *focus_info, const char *key)
}
/*
* Returns GUI focus info with hashtable "gui_focus_info".
* Return GUI focus info with hashtable "gui_focus_info".
*/
struct t_hashtable *
src/gui/gui-history.c
+14 -14
View File
@@ -51,7 +51,7 @@ int num_gui_history = 0;
/*
* Removes oldest history entry in a buffer.
* Remove oldest history entry in a buffer.
*/
void
@@ -78,7 +78,7 @@ gui_history_buffer_remove_oldest (struct t_gui_buffer *buffer)
}
/*
* Adds a text/command to buffer's history.
* Add a text/command to buffer's history.
*/
void
@@ -116,7 +116,7 @@ gui_history_buffer_add (struct t_gui_buffer *buffer, const char *string)
}
/*
* Removes oldest global history entry.
* Remove oldest global history entry.
*/
void
@@ -149,7 +149,7 @@ gui_history_global_remove_oldest (void)
}
/*
* Adds a text/command to global history.
* Add a text/command to global history.
*/
void
@@ -186,7 +186,7 @@ gui_history_global_add (const char *string)
}
/*
* Adds a text/command to buffer's history + global history.
* Add a text/command to buffer's history + global history.
*/
void
@@ -211,9 +211,9 @@ gui_history_add (struct t_gui_buffer *buffer, const char *string)
}
/*
* Searches for text in a history entry.
* Search for text in a history entry.
*
* Returns:
* Return:
* 1: text found in line
* 0: text not found in line
*/
@@ -253,9 +253,9 @@ gui_history_search_text (struct t_gui_buffer *buffer,
}
/*
* Searches in history using string in buffer input.
* Search in history using string in buffer input.
*
* Returns:
* Return:
* 1: an history was found
* 0: text not found
*/
@@ -298,7 +298,7 @@ gui_history_search (struct t_gui_buffer *buffer,
}
/*
* Frees global history.
* Free global history.
*/
void
@@ -321,7 +321,7 @@ gui_history_global_free (void)
/*
* Frees history for a buffer.
* Free history for a buffer.
*/
void
@@ -402,7 +402,7 @@ gui_history_hdata_history_update_cb (void *data,
}
/*
* Returns hdata for history.
* Return hdata for history.
*/
struct t_hdata *
@@ -429,9 +429,9 @@ gui_history_hdata_history_cb (const void *pointer, void *data,
}
/*
* Adds history in an infolist.
* Add history in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
src/gui/gui-hotlist.c
+29 -29
View File
@@ -61,7 +61,7 @@ char *gui_hotlist_priority_string[GUI_HOTLIST_NUM_PRIORITIES] =
/*
* Sends signal "hotlist_changed".
* Send signal "hotlist_changed".
*/
void
@@ -72,9 +72,9 @@ gui_hotlist_changed_signal (struct t_gui_buffer *buffer)
}
/*
* Searches for hotlist priority.
* Search for hotlist priority.
*
* Returns index of hotlist priority found, -1 if not found.
* Return index of hotlist priority found, -1 if not found.
*/
int
@@ -95,9 +95,9 @@ gui_hotlist_search_priority (const char *priority)
}
/*
* Searches for hotlist with buffer pointer.
* Search for hotlist with buffer pointer.
*
* Returns pointer to hotlist found, NULL if not found.
* Return pointer to hotlist found, NULL if not found.
*/
struct t_gui_hotlist *
@@ -115,9 +115,9 @@ gui_hotlist_search (struct t_gui_hotlist *hotlist, struct t_gui_buffer *buffer)
}
/*
* Duplicates a hotlist element.
* Duplicate a hotlist element.
*
* Returns pointer to new hotlist, NULL if error.
* Return pointer to new hotlist, NULL if error.
*/
struct t_gui_hotlist *
@@ -141,7 +141,7 @@ gui_hotlist_dup (struct t_gui_hotlist *hotlist)
}
/*
* Frees a hotlist and removes it from hotlist queue.
* Free a hotlist and removes it from hotlist queue.
*/
void
@@ -184,7 +184,7 @@ gui_hotlist_free (struct t_gui_hotlist **hotlist,
}
/*
* Frees all hotlists.
* Free all hotlists.
*/
void
@@ -199,9 +199,9 @@ gui_hotlist_free_all (struct t_gui_hotlist **hotlist,
}
/*
* Checks if a buffer must be added to hotlist, according to its notify level.
* Check if a buffer must be added to hotlist, according to its notify level.
*
* Returns:
* Return:
* 1: buffer must be added to hotlist
* 0: buffer must not be added to hotlist
*/
@@ -230,12 +230,12 @@ gui_hotlist_check_buffer_notify (struct t_gui_buffer *buffer,
}
/*
* Compares two hotlists in order to add them in the sorted list.
* Compare two hotlists in order to add them in the sorted list.
*
* The comparison is made using the list of fields defined in the option
* "weechat.look.hotlist_sort".
*
* Returns:
* Return:
* -1: hotlist1 < hotlist2
* 0: hotlist1 == hotlist2
* 1: hotlist1 > hotlist2
@@ -285,7 +285,7 @@ gui_hotlist_compare_hotlists (struct t_hdata *hdata_hotlist,
}
/*
* Searches for position of hotlist (to keep hotlist sorted).
* Search for position of hotlist (to keep hotlist sorted).
*/
struct t_gui_hotlist *
@@ -310,7 +310,7 @@ gui_hotlist_find_pos (struct t_gui_hotlist *hotlist,
}
/*
* Adds new hotlist in list.
* Add new hotlist in list.
*/
void
@@ -354,11 +354,11 @@ gui_hotlist_add_hotlist (struct t_gui_hotlist **hotlist,
}
/*
* Adds a buffer to hotlist, with priority.
* Add a buffer to hotlist, with priority.
*
* If creation_time is NULL, current time is used.
* If creation_time is NULL, use current time.
*
* Returns pointer to hotlist created or changed, NULL if no hotlist was
* Return pointer to hotlist created or changed, NULL if no hotlist was
* created/changed.
*/
@@ -495,7 +495,7 @@ gui_hotlist_add (struct t_gui_buffer *buffer,
}
/*
* Restores a hotlist that was removed from a buffer.
* Restore a hotlist that was removed from a buffer.
*/
void
@@ -523,7 +523,7 @@ gui_hotlist_restore_buffer (struct t_gui_buffer *buffer)
}
/*
* Restores latest hotlist removed in all buffers.
* Restore latest hotlist removed in all buffers.
*/
void
@@ -539,7 +539,7 @@ gui_hotlist_restore_all_buffers (void)
}
/*
* Resorts hotlist.
* Resort hotlist.
*/
void
@@ -577,7 +577,7 @@ gui_hotlist_resort (void)
}
/*
* Clears hotlist with a level mask (integer).
* Clear hotlist with a level mask (integer).
*
* Argument "level_mask" is a combination of:
* 1 = join/part
@@ -616,7 +616,7 @@ gui_hotlist_clear (int level_mask)
}
/*
* Clears hotlist with a level mask (string).
* Clear hotlist with a level mask (string).
*/
void
@@ -682,7 +682,7 @@ gui_hotlist_clear_level_string (struct t_gui_buffer *buffer,
}
/*
* Removes a buffer from hotlist.
* Remove a buffer from hotlist.
*/
void
@@ -734,7 +734,7 @@ gui_hotlist_remove_buffer (struct t_gui_buffer *buffer,
}
/*
* Returns hdata for hotlist.
* Return hdata for hotlist.
*/
struct t_hdata *
@@ -765,9 +765,9 @@ gui_hotlist_hdata_hotlist_cb (const void *pointer, void *data,
}
/*
* Adds a hotlist in an infolist.
* Add a hotlist in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -839,7 +839,7 @@ gui_hotlist_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints hotlist in WeeChat log file (usually for crash dump).
* Print hotlist in WeeChat log file (usually for crash dump).
*/
void
@@ -867,7 +867,7 @@ gui_hotlist_print_log (void)
}
/*
* Ends hotlist.
* End hotlist.
*/
void
src/gui/gui-input.c
+69 -73
View File
@@ -51,10 +51,9 @@ char *gui_input_clipboard = NULL; /* internal clipboard content */
/*
* Optimizes input buffer size by adding or deleting data block (predefined
* size).
* Optimize input buffer size by adding or deleting data block (predefined size).
*
* Returns:
* Return:
* 1: input size optimized
* 0: error (input and its size are not changed)
*/
@@ -87,7 +86,7 @@ gui_input_optimize_size (struct t_gui_buffer *buffer,
}
/*
* Replaces full input by another string, trying to keep cursor position if new
* Replace full input by another string, trying to keep cursor position if new
* string is long enough.
*/
@@ -121,7 +120,7 @@ gui_input_replace_input (struct t_gui_buffer *buffer, const char *new_input)
}
/*
* Sends signal "input_paste_pending".
* Send signal "input_paste_pending".
*/
void
@@ -138,7 +137,7 @@ gui_input_paste_pending_signal (void)
}
/*
* Sends modifier and signal "input_text_changed".
* Send modifier and signal "input_text_changed".
*/
void
@@ -188,7 +187,7 @@ gui_input_text_changed_modifier_and_signal (struct t_gui_buffer *buffer,
}
/*
* Sends signal "input_text_cursor_moved".
* Send signal "input_text_cursor_moved".
*/
void
@@ -205,7 +204,7 @@ gui_input_text_cursor_moved_signal (struct t_gui_buffer *buffer)
}
/*
* Sends signal "input_search".
* Send signal "input_search".
*/
void
@@ -221,7 +220,7 @@ gui_input_search_signal (struct t_gui_buffer *buffer)
}
/*
* Sets position in input line.
* Set position in input line.
*/
void
@@ -237,7 +236,7 @@ gui_input_set_pos (struct t_gui_buffer *buffer, int pos)
}
/*
* Inserts a string into the input buffer at cursor position.
* Insert a string into the input buffer at cursor position.
*/
void
@@ -278,7 +277,7 @@ gui_input_insert_string (struct t_gui_buffer *buffer, const char *string)
}
/*
* Copies string into the internal clipboard.
* Copy string into the internal clipboard.
*/
void
@@ -300,7 +299,7 @@ gui_input_clipboard_copy (const char *buffer, int size)
}
/*
* Pastes the internal clipboard at cursor pos in input line
* Paste the internal clipboard at cursor pos in input line
* (default key: ctrl-y).
*/
@@ -318,7 +317,7 @@ gui_input_clipboard_paste (struct t_gui_buffer *buffer)
}
/*
* Sends data to buffer:
* Send data to buffer:
* - saves text in history
* - stops completion
* - frees all undos
@@ -340,7 +339,7 @@ gui_input_send_data_to_buffer (struct t_gui_buffer *buffer, char *data)
}
/*
* Sends current input to buffer.
* Send current input to buffer.
*/
void
@@ -374,7 +373,7 @@ gui_input_return (struct t_gui_buffer *buffer)
}
/*
* Splits input on newlines then sends each line to buffer.
* Split input on newlines then sends each line to buffer.
*/
void
@@ -406,7 +405,7 @@ gui_input_split_return (struct t_gui_buffer *buffer)
}
/*
* Completes a word in input buffer.
* Complete a word in input buffer.
*/
void
@@ -493,7 +492,7 @@ gui_input_complete (struct t_gui_buffer *buffer)
}
/*
* Completes with next word (default key: tab).
* Complete with next word (default key: tab).
*/
void
@@ -517,7 +516,7 @@ gui_input_complete_next (struct t_gui_buffer *buffer)
}
/*
* Completes with previous word (default key: shift-tab).
* Complete with previous word (default key: shift-tab).
*/
void
@@ -541,7 +540,7 @@ gui_input_complete_previous (struct t_gui_buffer *buffer)
}
/*
* Searches for text in buffer at current position (default key: ctrl-r).
* Search for text in buffer at current position (default key: ctrl-r).
*/
void
@@ -559,7 +558,7 @@ gui_input_search_text_here (struct t_gui_buffer *buffer)
}
/*
* Searches for text in buffer.
* Search for text in buffer.
*/
void
@@ -576,7 +575,7 @@ gui_input_search_text (struct t_gui_buffer *buffer)
}
/*
* Searches for text in buffer/global command line history.
* Search for text in buffer/global command line history.
*/
void
@@ -593,7 +592,7 @@ gui_input_search_history (struct t_gui_buffer *buffer)
}
/*
* Compiles regex used to search text in buffer.
* Compile regex used to search text in buffer.
*/
void
@@ -629,7 +628,7 @@ gui_input_search_compile_regex (struct t_gui_buffer *buffer)
}
/*
* Switches case for search in buffer (default key: alt-c during search).
* Switch case for search in buffer (default key: alt-c during search).
*/
void
@@ -647,7 +646,7 @@ gui_input_search_switch_case (struct t_gui_buffer *buffer)
}
/*
* Switches string/regex for search in buffer (default key: ctrl-r during
* Switch string/regex for search in buffer (default key: ctrl-r during
* search).
*/
@@ -666,7 +665,7 @@ gui_input_search_switch_regex (struct t_gui_buffer *buffer)
}
/*
* Switches search in messages/prefixes (default key: tab during search).
* Switch search in messages/prefixes (default key: tab during search).
*/
void
@@ -708,7 +707,7 @@ gui_input_search_switch_where (struct t_gui_buffer *buffer)
}
/*
* Searches backward in buffer (default key: up during search).
* Search backward in buffer (default key: up during search).
*/
void
@@ -739,7 +738,7 @@ gui_input_search_previous (struct t_gui_buffer *buffer)
}
/*
* Searches forward in buffer (default key: down during search).
* Search forward in buffer (default key: down during search).
*/
void
@@ -770,7 +769,7 @@ gui_input_search_next (struct t_gui_buffer *buffer)
}
/*
* Stops text search at current position (default key: return during search).
* Stop text search at current position (default key: return during search).
*/
void
@@ -797,7 +796,7 @@ gui_input_search_stop_here (struct t_gui_buffer *buffer)
}
/*
* Stops text search (default key: ctrl-q during search).
* Stop text search (default key: ctrl-q during search).
*/
void
@@ -824,7 +823,7 @@ gui_input_search_stop (struct t_gui_buffer *buffer)
}
/*
* Deletes previous char (default key: backspace).
* Delete previous char (default key: backspace).
*/
void
@@ -856,7 +855,7 @@ gui_input_delete_previous_char (struct t_gui_buffer *buffer)
}
/*
* Deletes next char (default key: del).
* Delete next char (default key: del).
*/
void
@@ -894,8 +893,7 @@ gui_input_delete_next_char (struct t_gui_buffer *buffer)
}
/*
* Delete the range between two positions and copy the content to the
* clipboard.
* Delete the range between two positions and copy the content to the clipboard.
*/
void
@@ -930,7 +928,7 @@ gui_input_delete_range (struct t_gui_buffer *buffer,
}
/*
* Deletes previous word (default key: alt-backspace).
* Delete previous word (default key: alt-backspace).
*/
void
@@ -969,7 +967,7 @@ gui_input_delete_previous_word (struct t_gui_buffer *buffer)
}
/*
* Deletes previous word until whitespace (default key: ctrl-w).
* Delete previous word until whitespace (default key: ctrl-w).
*/
void
@@ -1008,7 +1006,7 @@ gui_input_delete_previous_word_whitespace (struct t_gui_buffer *buffer)
}
/*
* Deletes next word (default key: alt-d).
* Delete next word (default key: alt-d).
*/
void
@@ -1056,9 +1054,9 @@ gui_input_delete_next_word (struct t_gui_buffer *buffer)
}
/*
* Deletes all from cursor pos to beginning of line (default key: ctrl-u).
* Delete all from cursor pos to beginning of line (default key: ctrl-u).
*
* If cursor is at beginning of line, deletes to beginning of previous line.
* If cursor is at beginning of line, delete to beginning of previous line.
*/
void
@@ -1112,9 +1110,9 @@ gui_input_delete_beginning_of_line (struct t_gui_buffer *buffer)
}
/*
* Deletes all from cursor pos to end of line (default key: ctrl-k).
* Delete all from cursor pos to end of line (default key: ctrl-k).
*
* If cursor is at end of line, deletes to end of next line.
* If cursor is at end of line, delete to end of next line.
*/
void
@@ -1163,7 +1161,7 @@ gui_input_delete_end_of_line (struct t_gui_buffer *buffer)
}
/*
* Deletes all from cursor pos to beginning of input (default key: alt-ctrl-u).
* Delete all from cursor pos to beginning of input (default key: alt-ctrl-u).
*/
void
@@ -1199,7 +1197,7 @@ gui_input_delete_beginning_of_input (struct t_gui_buffer *buffer)
}
/*
* Deletes all from cursor pos to end of input (default key: alt-ctrl-k).
* Delete all from cursor pos to end of input (default key: alt-ctrl-k).
*/
void
@@ -1226,7 +1224,7 @@ gui_input_delete_end_of_input (struct t_gui_buffer *buffer)
}
/*
* Deletes current line (default key: alt-r).
* Delete current line (default key: alt-r).
*/
void
@@ -1271,7 +1269,7 @@ gui_input_delete_line (struct t_gui_buffer *buffer)
}
/*
* Deletes entire input (default key: alt-R).
* Delete entire input (default key: alt-R).
*/
void
@@ -1292,7 +1290,7 @@ gui_input_delete_input (struct t_gui_buffer *buffer)
}
/*
* Transposes chars at cursor pos (default key: ctrl-t).
* Transpose chars at cursor pos (default key: ctrl-t).
*/
void
@@ -1331,9 +1329,9 @@ gui_input_transpose_chars (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to beginning of line (default key: home).
* Move cursor to beginning of line (default key: home).
*
* If cursor is at beginning of line, moves to beginning of previous line.
* If cursor is at beginning of line, move to beginning of previous line.
*/
void
@@ -1366,9 +1364,9 @@ gui_input_move_beginning_of_line (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to end of line (default key: end).
* Move cursor to end of line (default key: end).
*
* If cursor is at end of line, moves to end of next line.
* If cursor is at end of line, move to end of next line.
*/
void
@@ -1401,7 +1399,7 @@ gui_input_move_end_of_line (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to beginning of input (default key: shift-home).
* Move cursor to beginning of input (default key: shift-home).
*/
void
@@ -1415,7 +1413,7 @@ gui_input_move_beginning_of_input (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to end of input (default key: shift-end).
* Move cursor to end of input (default key: shift-end).
*/
void
@@ -1432,7 +1430,7 @@ gui_input_move_end_of_input (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to previous char (default key: left).
* Move cursor to previous char (default key: left).
*/
void
@@ -1446,7 +1444,7 @@ gui_input_move_previous_char (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to next char (default key: right).
* Move cursor to next char (default key: right).
*/
void
@@ -1463,8 +1461,7 @@ gui_input_move_next_char (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to beginning of previous word (default key: alt-b or
* ctrl-left).
* Move cursor to beginning of previous word (default key: alt-b or ctrl-left).
*/
void
@@ -1503,8 +1500,7 @@ gui_input_move_previous_word (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to the beginning of next word (default key: alt-f or
* ctrl-right).
* Move cursor to the beginning of next word (default key: alt-f or ctrl-right).
*/
void
@@ -1546,7 +1542,7 @@ gui_input_move_next_word (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to previous line (default key: shift-up).
* Move cursor to previous line (default key: shift-up).
*/
void
@@ -1595,7 +1591,7 @@ gui_input_move_previous_line (struct t_gui_buffer *buffer)
}
/*
* Moves cursor to next line (default key: shift-down).
* Move cursor to next line (default key: shift-down).
*/
void
@@ -1643,7 +1639,7 @@ gui_input_move_next_line (struct t_gui_buffer *buffer)
}
/*
* Recalls previous command from local or global history.
* Recall previous command from local or global history.
*/
void
@@ -1700,7 +1696,7 @@ gui_input_history_previous (struct t_gui_window *window,
}
/*
* Recalls next command from local or global history.
* Recall next command from local or global history.
*/
void
@@ -1777,7 +1773,7 @@ gui_input_history_next (struct t_gui_window *window,
}
/*
* Recalls previous command from local history (default key: up).
* Recall previous command from local history (default key: up).
*/
void
@@ -1795,7 +1791,7 @@ gui_input_history_local_previous (struct t_gui_buffer *buffer)
}
/*
* Recalls next command from local history (default key: down).
* Recall next command from local history (default key: down).
*/
void
@@ -1813,7 +1809,7 @@ gui_input_history_local_next (struct t_gui_buffer *buffer)
}
/*
* Recalls previous command from global history (default key: ctrl-up).
* Recall previous command from global history (default key: ctrl-up).
*/
void
@@ -1831,7 +1827,7 @@ gui_input_history_global_previous (struct t_gui_buffer *buffer)
}
/*
* Recalls next command from global history (default key: ctrl-down).
* Recall next command from global history (default key: ctrl-down).
*/
void
@@ -1849,8 +1845,8 @@ gui_input_history_global_next (struct t_gui_buffer *buffer)
}
/*
* Sends the current history entry (found with search or recalled with
* "up" key) and inserts the next one in the command line without sending it
* Send the current history entry (found with search or recalled with
* "up" key) and insert the next one in the command line without sending it
* (default key: ctrl-o, in contexts "default" and "histsearch").
*/
@@ -1897,7 +1893,7 @@ gui_input_history_use_get_next (struct t_gui_buffer *buffer)
}
/*
* Initializes "grab key mode" (next key will be inserted into input buffer)
* Initialize "grab key mode" (next key will be inserted into input buffer)
* (default key: alt-k).
*/
@@ -1909,7 +1905,7 @@ gui_input_grab_key (struct t_gui_buffer *buffer, int command, const char *delay)
}
/*
* Initializes "grab mouse mode" (next mouse event will be inserted into input
* Initialize "grab mouse mode" (next mouse event will be inserted into input
* buffer) (default key: button2 of mouse in input bar).
*/
@@ -1921,7 +1917,7 @@ gui_input_grab_mouse (struct t_gui_buffer *buffer, int area)
}
/*
* Inserts a string in command line.
* Insert a string in command line.
*/
void
@@ -1942,7 +1938,7 @@ gui_input_insert (struct t_gui_buffer *buffer, const char *args)
}
/*
* Uses a undo: replace input with undo content.
* Use a undo: replace input with undo content.
*/
void
@@ -1959,7 +1955,7 @@ gui_input_undo_use (struct t_gui_buffer *buffer, struct t_gui_input_undo *undo)
}
/*
* Undoes last action on input buffer (default key: ctrl-_).
* Undo last action on input buffer (default key: ctrl-_).
*/
void
@@ -1990,7 +1986,7 @@ gui_input_undo (struct t_gui_buffer *buffer)
}
/*
* Redoes last action on input buffer (default key: alt-_).
* Redo last action on input buffer (default key: alt-_).
*/
void
src/gui/gui-key.c
+79 -79
View File
@@ -109,7 +109,7 @@ time_t gui_key_last_activity_time = 0; /* last activity time (key) */
/*
* Initializes keyboard.
* Initialize keyboard.
*/
void
@@ -142,9 +142,9 @@ gui_key_init (void)
}
/*
* Searches for a context by name.
* Search for a context by name.
*
* Returns index of context in enum t_gui_key_context, -1 if not found.
* Return index of context in enum t_gui_key_context, -1 if not found.
*/
int
@@ -166,7 +166,7 @@ gui_key_search_context (const char *context)
}
/*
* Gets current context.
* Get current context.
*/
int
@@ -187,7 +187,7 @@ gui_key_get_current_context (void)
}
/*
* Initializes "grab" mode.
* Initialize "grab" mode.
*/
void
@@ -215,7 +215,7 @@ gui_key_grab_init (int grab_command, const char *delay)
}
/*
* Inserts grabbed key in input buffer.
* Insert grabbed key in input buffer.
*/
int
@@ -303,7 +303,7 @@ gui_key_grab_end_timer_cb (const void *pointer, void *data, int remaining_calls)
}
/*
* Gets internal code from user key name.
* Get internal code from user key name.
*
* Note: this function works with legacy keys (WeeChat < 4.0.0) and should not
* be used anymore.
@@ -384,7 +384,7 @@ gui_key_legacy_internal_code (const char *key)
}
/*
* Expands raw key code to its name and name using aliases (human readable
* Expand raw key code to its name and name using aliases (human readable
* key name).
*
* Examples (return: rc, key name, key name with alias):
@@ -397,7 +397,7 @@ gui_key_legacy_internal_code (const char *key)
* "\001[[1;3D" => 1, "meta-[1;3D", "meta-left"
* "\001[w\001[[1;3A" => 1, "meta-w,meta-[1;3A", "meta-w,meta-up"
*
* Returns:
* Return:
* 1: OK
* 0: error: incomplete/invalid raw key
*
@@ -827,7 +827,7 @@ error:
}
/*
* Converts a legacy key to the new key name (using comma separator and alias).
* Convert a legacy key to the new key name (using comma separator and alias).
*
* Examples:
* "ctrl-" => NULL
@@ -875,7 +875,7 @@ gui_key_legacy_to_alias (const char *key)
}
/*
* Attempts to fix a key in mouse context (starting with "@area:"):
* Attempt to fix a key in mouse context (starting with "@area:"):
* - transform "ctrl-alt-" to "alt-ctrl-"
*
* Example:
@@ -916,7 +916,7 @@ gui_key_fix_mouse (const char *key)
}
/*
* Attempts to fix key:
* Attempt to fix key:
* - transform upper case ctrl keys to lower case ("ctrl-A" -> "ctrl-a")
* - replace " " by "space"
* - replace "meta2-" by "meta-["
@@ -993,7 +993,7 @@ gui_key_fix (const char *key)
}
/*
* Searches for position of a key (to keep keys sorted).
* Search for position of a key (to keep keys sorted).
*/
struct t_gui_key *
@@ -1014,7 +1014,7 @@ gui_key_find_pos (struct t_gui_key *keys, struct t_gui_key *key)
}
/*
* Inserts key into sorted list.
* Insert key into sorted list.
*/
void
@@ -1062,7 +1062,7 @@ gui_key_insert_sorted (struct t_gui_key **keys,
}
/*
* Sets area type and name.
* Set area type and name.
*
* For example: "bar(nicklist)" returns:
* type: 2 (bar)
@@ -1111,7 +1111,7 @@ gui_key_set_area_type_name (const char *area,
}
/*
* Sets areas types (any, chat, bar or item) and names for a key.
* Set areas types (any, chat, bar or item) and names for a key.
*/
void
@@ -1166,7 +1166,7 @@ gui_key_set_areas (struct t_gui_key *key)
}
/*
* Computes a score key for sorting keys and set it in key (high score == at the
* Compute a score key for sorting keys and set it in key (high score == at the
* end of list).
*/
@@ -1215,10 +1215,10 @@ gui_key_set_score (struct t_gui_key *key)
}
/*
* Checks if a key is safe or not: a safe key should begin with the "meta" or
* Check if a key is safe or not: a safe key should begin with the "meta" or
* "ctrl" code (there are exceptions).
*
* Returns:
* Return:
* 1: key is safe for the given context
* 0: key is NOT safe for the given context
*/
@@ -1270,7 +1270,7 @@ gui_key_is_safe (int context, const char *key)
}
/*
* Checks if the key chunk seems valid.
* Check if the key chunk seems valid.
*
* Example of valid key chunk:
* "meta-a"
@@ -1283,7 +1283,7 @@ gui_key_is_safe (int context, const char *key)
* "meta-[A" (raw code)
* "ctrl-cb" (invalid: missing comma)
*
* Returns:
* Return:
* 1: key chunk seems valid
* 0: key chunk seems either invalid or a raw code
*/
@@ -1335,7 +1335,7 @@ gui_key_chunk_seems_valid (const char *chunk)
}
/*
* Checks if the key seems valid: not a raw code, and no comma is missing.
* Check if the key seems valid: not a raw code, and no comma is missing.
*
* Example of valid keys:
* "meta-a"
@@ -1348,7 +1348,7 @@ gui_key_chunk_seems_valid (const char *chunk)
* "meta-[A" (raw code)
* "ctrl-cb" (invalid: missing comma)
*
* Returns:
* Return:
* 1: key seems valid
* 0: key seems either invalid or a raw code
*/
@@ -1416,9 +1416,9 @@ gui_key_option_change_cb (const void *pointer, void *data,
}
/*
* Creates a new key option.
* Create a new key option.
*
* Returns pointer to existing or new option.
* Return pointer to existing or new option.
*/
struct t_config_option *
@@ -1462,14 +1462,14 @@ gui_key_new_option (int context, const char *name, const char *value)
}
/*
* Adds a new key in keys list.
* Add a new key in keys list.
*
* If buffer is not null, then key is specific to buffer, otherwise it's general
* key (for most keys).
*
* If create_option == 1, a config option is created as well.
*
* Returns pointer to new key, NULL if error.
* Return pointer to new key, NULL if error.
*/
struct t_gui_key *
@@ -1571,9 +1571,9 @@ error:
}
/*
* Searches for a key.
* Search for a key.
*
* Returns pointer to key found, NULL if not found.
* Return pointer to key found, NULL if not found.
*/
struct t_gui_key *
@@ -1597,7 +1597,7 @@ gui_key_search (struct t_gui_key *keys, const char *key)
/*
* Compare chunks with key chunks.
*
* Returns:
* Return:
* 2: exact match
* 1: partial match (key_chunks starts with chunks but is longer)
* 0: no match
@@ -1621,14 +1621,14 @@ gui_key_compare_chunks (const char **chunks, int chunks_count,
}
/*
* Searches key chunks for context default, search or cursor (not for mouse).
* Search key chunks for context default, search or cursor (not for mouse).
* It can be part of key chunks or exact match.
*
* Parameter "chunks1" is the raw key split into chunks, and "chunks2" is the
* key with alias split into chunks (at least one of the chunks must be non
* NULL).
*
* Returns pointer to key found, NULL if not found.
* Return pointer to key found, NULL if not found.
* In case of exact match, *exact_match is set to 1, otherwise 0.
*/
@@ -1701,7 +1701,7 @@ gui_key_search_part (struct t_gui_buffer *buffer, int context,
}
/*
* Binds a key to a command.
* Bind a key to a command.
*
* If buffer is not null, then key is specific to buffer otherwise it's general
* key (for most keys).
@@ -1710,7 +1710,7 @@ gui_key_search_part (struct t_gui_buffer *buffer, int context,
*
* If key already exists, it is removed then added again with new value.
*
* Returns pointer to new key, NULL if error.
* Return pointer to new key, NULL if error.
*/
struct t_gui_key *
@@ -1756,7 +1756,7 @@ gui_key_bind (struct t_gui_buffer *buffer, int context, const char *key,
}
/*
* Binds keys in hashtable.
* Bind keys in hashtable.
*/
void
@@ -1800,12 +1800,12 @@ gui_key_bind_plugin_hashtable_map_cb (void *data,
}
/*
* Creates many keys using a hashtable (used by plugins only).
* Create many keys using a hashtable (used by plugins only).
*
* If key already exists, it is NOT changed (plugins should never overwrite user
* keys).
*
* Returns number of keys added.
* Return number of keys added.
*/
int
@@ -1831,9 +1831,9 @@ gui_key_bind_plugin (const char *context, struct t_hashtable *keys)
}
/*
* Removes one key binding.
* Remove one key binding.
*
* Returns:
* Return:
* 1: key removed
* 0: key not removed
*/
@@ -1883,9 +1883,9 @@ gui_key_unbind (struct t_gui_buffer *buffer, int context, const char *key)
}
/*
* Removes one or more key binding(s) (used by plugins only).
* Remove one or more key binding(s) (used by plugins only).
*
* Returns number of keys removed.
* Return number of keys removed.
*/
int
@@ -1947,9 +1947,9 @@ gui_key_unbind_plugin (const char *context, const char *key)
}
/*
* Checks if area in key is matching focus area on screen (cursor/mouse).
* Check if area in key is matching focus area on screen (cursor/mouse).
*
* Returns:
* Return:
* 1: area in key is matching focus area
* 0: area in key is not matching focus area
*/
@@ -2006,7 +2006,7 @@ gui_key_focus_matching (struct t_gui_key *key,
}
/*
* Displays focus hashtable (for debug).
* Display focus hashtable (for debug).
*/
void
@@ -2031,9 +2031,9 @@ gui_key_focus_display_hashtable (struct t_hashtable *hashtable)
}
/*
* Runs command according to focus.
* Run command according to focus.
*
* Returns:
* Return:
* 1: command was executed
* 0: command was not executed
*/
@@ -2183,10 +2183,10 @@ gui_key_focus_command (const char *key, int context,
}
/*
* Processes key pressed in cursor or mouse mode, looking for keys: "{area}key"
* Process key pressed in cursor or mouse mode, looking for keys: "{area}key"
* in context "cursor" or "mouse".
*
* Returns:
* Return:
* 1: command was executed
* 0: command was not executed
*/
@@ -2254,7 +2254,7 @@ end:
}
/*
* Prints a key in debug mode:
* Print a key in debug mode:
* - raw combo (eg: "^[[A")
* - for keyboard:
* - key name (eg: "meta-[A")
@@ -2333,9 +2333,9 @@ gui_key_debug_print_key (const char *combo, const char *key_name,
}
/*
* Processes a new key pressed.
* Process a new key pressed.
*
* Returns:
* Return:
* 1: key must be added to input buffer
* 0: key must not be added to input buffer
*/
@@ -2610,7 +2610,7 @@ end:
}
/*
* Deletes a key binding.
* Delete a key binding.
*
* If delete_option == 1, the config option is deleted.
*/
@@ -2661,7 +2661,7 @@ gui_key_free (int context,
}
/*
* Deletes all key bindings.
* Delete all key bindings.
*
* If delete_option == 1, the config options are deleted.
*/
@@ -2679,7 +2679,7 @@ gui_key_free_all (int context, struct t_gui_key **keys,
}
/*
* Optimizes keyboard buffer size.
* Optimize keyboard buffer size.
*/
void
@@ -2710,7 +2710,7 @@ gui_key_buffer_optimize (void)
}
/*
* Resets keyboard buffer (create empty if never created before).
* Reset keyboard buffer (create empty if never created before).
*/
void
@@ -2732,7 +2732,7 @@ gui_key_buffer_reset (void)
}
/*
* Adds a key to keyboard buffer.
* Add a key to keyboard buffer.
*/
void
@@ -2763,12 +2763,12 @@ gui_key_buffer_add (unsigned char key)
}
/*
* Searches for a string in gui_key_buffer (array of integers).
* Search for a string in gui_key_buffer (array of integers).
*
* Argument start_index must be >= 0.
* If max_index is negative, the search is until end of buffer.
*
* Returns index for string found in gui_key_buffer (not from "start_index" but
* Return index for string found in gui_key_buffer (not from "start_index" but
* from beginning of gui_key_buffer), or -1 if string is not found.
*/
@@ -2810,7 +2810,7 @@ gui_key_buffer_search (int start_index, int max_index, const char *string)
}
/*
* Removes some chars from gui_key_buffer.
* Remove some chars from gui_key_buffer.
*/
void
@@ -2826,7 +2826,7 @@ gui_key_buffer_remove (int index, int number)
}
/*
* Removes final newline at end of paste.
* Remove final newline at end of paste.
*/
void
@@ -2842,7 +2842,7 @@ gui_key_paste_remove_newline (void)
}
/*
* Replaces tabs by spaces in paste.
* Replace tabs by spaces in paste.
*/
void
@@ -2858,7 +2858,7 @@ gui_key_paste_replace_tabs (void)
}
/*
* Starts paste of text.
* Start paste of text.
*/
void
@@ -2869,7 +2869,7 @@ gui_key_paste_start (void)
}
/*
* Finishes paste of text. Does necessary modifications before flush of text.
* Finish paste of text, do necessary modifications before flush of text.
*/
void
@@ -2880,9 +2880,9 @@ gui_key_paste_finish (void)
}
/*
* Returns real number of lines in buffer.
* Return real number of lines in buffer.
*
* Returns number of lines (lines+1 if last key is not return).
* Return number of lines (lines+1 if last key is not return).
*/
int
@@ -2910,11 +2910,11 @@ gui_key_get_paste_lines (void)
}
/*
* Checks pasted lines: if more than N lines, then enables paste mode and ask
* Check pasted lines: if more than N lines, then enables paste mode and ask
* confirmation to user (ctrl-y=paste, ctrl-n=cancel) (N is option
* weechat.look.paste_max_lines).
*
* Returns:
* Return:
* 1: paste mode has been enabled
* 0: paste mode has not been enabled
*/
@@ -2967,7 +2967,7 @@ gui_key_paste_bracketed_timer_cb (const void *pointer, void *data,
}
/*
* Removes timer for bracketed paste.
* Remove timer for bracketed paste.
*/
void
@@ -2981,7 +2981,7 @@ gui_key_paste_bracketed_timer_remove (void)
}
/*
* Adds timer for bracketed paste.
* Add timer for bracketed paste.
*/
void
@@ -2996,7 +2996,7 @@ gui_key_paste_bracketed_timer_add (void)
}
/*
* Starts bracketed paste of text (ESC[200~ detected).
* Start bracketed paste of text (ESC[200~ detected).
*/
void
@@ -3007,7 +3007,7 @@ gui_key_paste_bracketed_start (void)
}
/*
* Stops bracketed paste of text (ESC[201~ detected or timeout while waiting for
* Stop bracketed paste of text (ESC[201~ detected or timeout while waiting for
* this code).
*/
@@ -3019,7 +3019,7 @@ gui_key_paste_bracketed_stop (void)
}
/*
* Accepts paste from user.
* Accept paste from user.
*/
void
@@ -3031,7 +3031,7 @@ gui_key_paste_accept (void)
}
/*
* Cancels paste from user (resets buffer).
* Cancel paste from user (resets buffer).
*/
void
@@ -3043,7 +3043,7 @@ gui_key_paste_cancel (void)
}
/*
* Ends keyboard (frees some data).
* End keyboard (frees some data).
*/
void
@@ -3072,7 +3072,7 @@ gui_key_end (void)
}
/*
* Returns hdata for key.
* Return hdata for key.
*/
struct t_hdata *
@@ -3131,9 +3131,9 @@ gui_key_hdata_key_cb (const void *pointer, void *data,
}
/*
* Adds a key in an infolist.
* Add a key in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -3171,7 +3171,7 @@ gui_key_add_to_infolist (struct t_infolist *infolist, struct t_gui_key *key)
}
/*
* Prints a key info in WeeChat log file (usually for crash dump).
* Print a key info in WeeChat log file (usually for crash dump).
*/
void
@@ -3197,7 +3197,7 @@ gui_key_print_log_key (struct t_gui_key *key, const char *prefix)
}
/*
* Prints key infos in WeeChat log file (usually for crash dump).
* Print key infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-layout.c
+48 -48
View File
@@ -48,9 +48,9 @@ struct t_gui_layout *gui_layout_current = NULL;
/*
* Searches a layout by name.
* Search a layout by name.
*
* Returns pointer to layout found, NULL if not found.
* Return pointer to layout found, NULL if not found.
*/
struct t_gui_layout *
@@ -73,12 +73,12 @@ gui_layout_search (const char *name)
}
/*
* Allocates a new layout.
* Allocate a new layout.
*
* Note: the layout is not added to the list (a call to gui_layout_add() will do
* that).
*
* Returns pointer to new layout, NULL if error.
* Return pointer to new layout, NULL if error.
*/
struct t_gui_layout *
@@ -107,9 +107,9 @@ gui_layout_alloc (const char *name)
}
/*
* Adds a layout in "gui_layouts".
* Add a layout in "gui_layouts".
*
* Returns:
* Return:
* 1: layout added
* 0: layout not added (another layout exists with same name)
*/
@@ -138,7 +138,7 @@ gui_layout_add (struct t_gui_layout *layout)
}
/*
* Renames a layout.
* Rename a layout.
*/
void
@@ -152,7 +152,7 @@ gui_layout_rename (struct t_gui_layout *layout, const char *new_name)
}
/*
* Removes a buffer layout from a layout.
* Remove a buffer layout from a layout.
*/
void
@@ -180,7 +180,7 @@ gui_layout_buffer_remove (struct t_gui_layout *layout,
}
/*
* Removes all buffer layouts from a layout.
* Remove all buffer layouts from a layout.
*/
void
@@ -196,7 +196,7 @@ gui_layout_buffer_remove_all (struct t_gui_layout *layout)
}
/*
* Resets layout_number in all buffers.
* Reset layout_number in all buffers.
*/
void
@@ -212,9 +212,9 @@ gui_layout_buffer_reset (void)
}
/*
* Adds a buffer layout in a layout.
* Add a buffer layout in a layout.
*
* Returns pointer to buffer layout, NULL if error.
* Return pointer to buffer layout, NULL if error.
*/
struct t_gui_layout_buffer *
@@ -249,7 +249,7 @@ gui_layout_buffer_add (struct t_gui_layout *layout,
}
/*
* Gets layout number for a plugin/buffer.
* Get layout number for a plugin/buffer.
*/
void
@@ -292,7 +292,7 @@ gui_layout_buffer_get_number (struct t_gui_layout *layout,
}
/*
* Gets layout numbers for all buffers.
* Get layout numbers for all buffers.
*/
void
@@ -312,7 +312,7 @@ gui_layout_buffer_get_number_all (struct t_gui_layout *layout)
}
/*
* Stores current layout for buffers in a layout.
* Store current layout for buffers in a layout.
*/
void
@@ -339,7 +339,7 @@ gui_layout_buffer_store (struct t_gui_layout *layout)
}
/*
* Applies a layout for buffers.
* Applie a layout for buffers.
*/
void
@@ -376,7 +376,7 @@ gui_layout_buffer_apply (struct t_gui_layout *layout)
}
/*
* Removes a window layout.
* Remove a window layout.
*/
void
@@ -399,7 +399,7 @@ gui_layout_window_remove (struct t_gui_layout_window *layout_window)
}
/*
* Removes all window layouts from a layout.
* Remove all window layouts from a layout.
*/
void
@@ -417,7 +417,7 @@ gui_layout_window_remove_all (struct t_gui_layout *layout)
/*
* Resets layout for windows.
* Reset layout for windows.
*/
void
@@ -441,9 +441,9 @@ gui_layout_window_reset (void)
}
/*
* Searches for a window layout by internal id.
* Searche for a window layout by internal id.
*
* Returns pointer to window layout found, NULL if not found.
* Return pointer to window layout found, NULL if not found.
*/
struct t_gui_layout_window *
@@ -476,9 +476,9 @@ gui_layout_window_search_by_id (struct t_gui_layout_window *layout_window,
}
/*
* Adds a window layout.
* Add a window layout.
*
* Returns pointer to new window layout, NULL if not found.
* Return pointer to new window layout, NULL if not found.
*/
struct t_gui_layout_window *
@@ -525,7 +525,7 @@ gui_layout_window_add (struct t_gui_layout_window **layout_window,
}
/*
* Stores tree of windows.
* Store tree of windows.
*/
void
@@ -575,9 +575,9 @@ gui_layout_window_store_tree (struct t_gui_layout *layout,
}
/*
* Stores current layout for windows in a layout.
* Store current layout for windows in a layout.
*
* Returns internal id of current window.
* Return internal id of current window.
*/
void
@@ -596,9 +596,9 @@ gui_layout_window_store (struct t_gui_layout *layout)
}
/*
* Checks whether a window has its layout buffer displayed or not.
* Check whether a window has its layout buffer displayed or not.
*
* Returns:
* Return:
* 1: the window has layout info and the proper buffer displayed
* 0: the window has layout info but NOT the proper buffer displayed
* -1: the window has no layout info
@@ -624,7 +624,7 @@ gui_layout_window_check_buffer (struct t_gui_window *window)
}
/*
* Assigns a buffer to windows.
* Assign a buffer to windows.
*/
void
@@ -649,8 +649,8 @@ gui_layout_window_assign_buffer (struct t_gui_buffer *buffer)
}
/*
* For each window, checks if another buffer should be assigned, and if yes,
* assigns it.
* For each window, check if another buffer should be assigned, and if yes,
* assign it.
*/
void
@@ -678,7 +678,7 @@ gui_layout_window_assign_all_buffers (void)
}
/*
* Applies tree windows (re-splits screen according to windows tree and assigns
* Apply tree windows (re-split screen according to windows tree and assign
* buffer to windows).
*/
@@ -736,7 +736,7 @@ gui_layout_window_apply_tree (struct t_gui_layout_window *layout_window,
}
/*
* Applies current layout for windows.
* Apply current layout for windows.
*/
void
@@ -766,7 +766,7 @@ gui_layout_window_apply (struct t_gui_layout *layout,
}
/*
* Stores layout according to option "store_layout_on_exit".
* Store layout according to option "store_layout_on_exit".
*/
void
@@ -813,7 +813,7 @@ gui_layout_store_on_exit (void)
}
/*
* Frees a layout.
* Free a layout.
*/
void
@@ -837,7 +837,7 @@ gui_layout_free (struct t_gui_layout *layout)
}
/*
* Removes a layout from hashtable "gui_layouts".
* Remove a layout from hashtable "gui_layouts".
*/
void
@@ -872,7 +872,7 @@ gui_layout_remove (struct t_gui_layout *layout)
}
/*
* Removes all layouts from "gui_layouts".
* Remove all layouts from "gui_layouts".
*/
void
@@ -885,7 +885,7 @@ gui_layout_remove_all (void)
}
/*
* Returns hdata for buffer layout.
* Return hdata for buffer layout.
*/
struct t_hdata *
@@ -912,7 +912,7 @@ gui_layout_hdata_layout_buffer_cb (const void *pointer, void *data,
}
/*
* Returns hdata for window layout.
* Return hdata for window layout.
*/
struct t_hdata *
@@ -941,7 +941,7 @@ gui_layout_hdata_layout_window_cb (const void *pointer, void *data,
}
/*
* Returns hdata for layout.
* Return hdata for layout.
*/
struct t_hdata *
@@ -974,9 +974,9 @@ gui_layout_hdata_layout_cb (const void *pointer, void *data,
}
/*
* Adds a buffer layout in an infolist.
* Add a buffer layout in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1005,9 +1005,9 @@ gui_layout_buffer_add_to_infolist (struct t_infolist *infolist,
}
/*
* Adds a window layout in an infolist.
* Add a window layout in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1050,9 +1050,9 @@ gui_layout_window_add_to_infolist (struct t_infolist *infolist,
}
/*
* Adds a layout in an infolist.
* Add a layout in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1084,7 +1084,7 @@ gui_layout_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints windows layout infos in WeeChat log file (usually for crash dump).
* Print windows layout infos in WeeChat log file (usually for crash dump).
*/
void
@@ -1114,7 +1114,7 @@ gui_layout_print_log_window (struct t_gui_layout_window *layout_window,
}
/*
* Prints layouts in WeeChat log file (usually for crash dump).
* Print layouts in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-line.c
+69 -69
View File
@@ -51,9 +51,9 @@
/*
* Allocates structure "t_gui_lines" and initializes it.
* Allocate structure "t_gui_lines" and initialize it.
*
* Returns pointer to new lines, NULL if error.
* Return pointer to new lines, NULL if error.
*/
struct t_gui_lines *
@@ -80,7 +80,7 @@ gui_line_lines_alloc (void)
}
/*
* Frees a "t_gui_lines" structure.
* Free a "t_gui_lines" structure.
*/
void
@@ -93,7 +93,7 @@ gui_line_lines_free (struct t_gui_lines *lines)
}
/*
* Allocates array with tags in a line_data.
* Allocate array with tags in a line_data.
*/
void
@@ -115,7 +115,7 @@ gui_line_tags_alloc (struct t_gui_line_data *line_data, const char *tags)
}
/*
* Frees array with tags in a line_data.
* Free array with tags in a line_data.
*/
void
@@ -133,11 +133,11 @@ gui_line_tags_free (struct t_gui_line_data *line_data)
}
/*
* Checks if prefix on line is a nick and is the same as nick on previous/next
* Check if prefix on line is a nick and is the same as nick on previous/next
* line (according to direction: if < 0, check if it's the same nick as
* previous line, otherwise next line).
*
* Returns:
* Return:
* 1: prefix is a nick and same as nick on previous/next line
* 0: prefix is not a nick, or different from nick on previous/next line
*/
@@ -191,11 +191,11 @@ gui_line_prefix_is_same_nick (struct t_gui_line *line, int direction)
}
/*
* Gets prefix and its length (for display only).
* Get prefix and its length (for display only).
*
* If the prefix can be hidden (same nick as previous message), and if the
* option is enabled (not empty string), then returns empty prefix or prefix
* from option.
* Return empty prefix or prefix from option if the prefix can be hidden
* (same nick as previous message), and if the option is enabled
* (not empty string).
*/
void
@@ -287,7 +287,7 @@ gui_line_get_prefix_for_display (struct t_gui_line *line,
}
/*
* Gets alignment for a line.
* Get alignment for a line.
*/
int
@@ -380,7 +380,7 @@ gui_line_get_align (struct t_gui_buffer *buffer, struct t_gui_line *line,
}
/*
* Builds a string with prefix and message.
* Build a string with prefix and message.
*
* Note: result must be freed after use.
*/
@@ -408,7 +408,7 @@ gui_line_build_string_prefix_message (const char *prefix, const char *message)
}
/*
* Builds a string with action message and nick with nick offline color.
* Build a string with action message and nick with nick offline color.
*
* Note: result must be freed after use.
*/
@@ -439,7 +439,7 @@ gui_line_build_string_message_nick_offline (const char *message)
}
/*
* Builds a string with message and tags.
* Build a string with message and tags.
*
* If colors == 1, keep colors in message and use color for delimiters around
* tags.
@@ -503,9 +503,9 @@ gui_line_build_string_message_tags (const char *message,
}
/*
* Checks if a line is displayed (no filter on line or filters disabled).
* Check if a line is displayed (no filter on line or filters disabled).
*
* Returns:
* Return:
* 1: line is displayed
* 0: line is hidden
*/
@@ -525,9 +525,9 @@ gui_line_is_displayed (struct t_gui_line *line)
}
/*
* Gets the first line displayed of a buffer.
* Get the first line displayed of a buffer.
*
* Returns pointer to first line displayed, NULL if not found.
* Return pointer to first line displayed, NULL if not found.
*/
struct t_gui_line *
@@ -545,9 +545,9 @@ gui_line_get_first_displayed (struct t_gui_buffer *buffer)
}
/*
* Gets the last line displayed of a buffer.
* Get the last line displayed of a buffer.
*
* Returns pointer to last line displayed, NULL if not found.
* Return pointer to last line displayed, NULL if not found.
*/
struct t_gui_line *
@@ -565,9 +565,9 @@ gui_line_get_last_displayed (struct t_gui_buffer *buffer)
}
/*
* Gets previous line displayed.
* Get previous line displayed.
*
* Returns pointer to previous line displayed, NULL if not found.
* Return pointer to previous line displayed, NULL if not found.
*/
struct t_gui_line *
@@ -585,9 +585,9 @@ gui_line_get_prev_displayed (struct t_gui_line *line)
}
/*
* Gets next line displayed.
* Get next line displayed.
*
* Returns pointer to next line displayed, NULL if not found.
* Return pointer to next line displayed, NULL if not found.
*/
struct t_gui_line *
@@ -605,9 +605,9 @@ gui_line_get_next_displayed (struct t_gui_line *line)
}
/*
* Searches a line by id.
* Search a line by id.
*
* Returns pointer to line found, NULL if not found.
* Return pointer to line found, NULL if not found.
*/
struct t_gui_line *
@@ -630,9 +630,9 @@ gui_line_search_by_id (struct t_gui_buffer *buffer, int id)
}
/*
* Searches for text in a line.
* Search for text in a line.
*
* Returns:
* Return:
* 1: text found in line
* 0: text not found in line
*/
@@ -721,9 +721,9 @@ gui_line_search_text (struct t_gui_buffer *buffer, struct t_gui_line *line)
}
/*
* Checks if a line matches regex.
* Check if a line matches regex.
*
* Returns:
* Return:
* 1: line matches regex
* 0: line does not match regex
*/
@@ -777,10 +777,10 @@ gui_line_match_regex (struct t_gui_line_data *line_data, regex_t *regex_prefix,
}
/*
* Checks if a line has tag "no_filter" (which means that line should never been
* Check if a line has tag "no_filter" (which means that line should never been
* filtered: it is always displayed).
*
* Returns:
* Return:
* 1: line has tag "no_filter"
* 0: line does not have tag "no_filter"
*/
@@ -804,9 +804,9 @@ gui_line_has_tag_no_filter (struct t_gui_line_data *line_data)
}
/*
* Checks if line matches tags.
* Check if line matches tags.
*
* Returns:
* Return:
* 1: line matches tags
* 0: line does not match tags
*/
@@ -869,7 +869,7 @@ gui_line_match_tags (struct t_gui_line_data *line_data,
}
/*
* Returns pointer on tag starting with "tag", NULL if such tag is not found.
* Return pointer on tag starting with "tag", NULL if such tag is not found.
*/
const char *
@@ -893,7 +893,7 @@ gui_line_search_tag_starting_with (struct t_gui_line *line, const char *tag)
}
/*
* Gets nick in tags: returns "xxx" if tag "nick_xxx" is found.
* Get nick in tags: return "xxx" if tag "nick_xxx" is found.
*/
const char *
@@ -912,10 +912,10 @@ gui_line_get_nick_tag (struct t_gui_line *line)
}
/*
* Checks if a line has highlight (with a string in global highlight or buffer
* Check if a line has highlight (with a string in global highlight or buffer
* highlight).
*
* Returns:
* Return:
* 1: line has highlight
* 0: line has no highlight
*/
@@ -1113,9 +1113,9 @@ end:
}
/*
* Checks if nick of line is offline (not in nicklist anymore).
* Check if nick of line is offline (not in nicklist anymore).
*
* Returns:
* Return:
* 1: nick is offline
* 0: nick is still there (in nicklist)
*/
@@ -1142,9 +1142,9 @@ gui_line_has_offline_nick (struct t_gui_line *line)
}
/*
* Checks if line is an action (eg: `/me` in irc plugin).
* Check if line is an action (eg: `/me` in irc plugin).
*
* Returns:
* Return:
* 1: line is an action
* 0: line is not an action
*/
@@ -1168,7 +1168,7 @@ gui_line_is_action (struct t_gui_line *line)
}
/*
* Computes "buffer_max_length" for a "t_gui_lines" structure.
* Compute "buffer_max_length" for a "t_gui_lines" structure.
*/
void
@@ -1195,7 +1195,7 @@ gui_line_compute_buffer_max_length (struct t_gui_buffer *buffer,
}
/*
* Computes "prefix_max_length" for a "t_gui_lines" structure.
* Compute "prefix_max_length" for a "t_gui_lines" structure.
*/
void
@@ -1224,7 +1224,7 @@ gui_line_compute_prefix_max_length (struct t_gui_lines *lines)
}
/*
* Adds a line to a "t_gui_lines" structure.
* Add a line to a "t_gui_lines" structure.
*/
void
@@ -1264,7 +1264,7 @@ gui_line_add_to_list (struct t_gui_lines *lines,
}
/*
* Frees data in a line.
* Free data in a line.
*/
void
@@ -1280,7 +1280,7 @@ gui_line_free_data (struct t_gui_line *line)
}
/*
* Removes a line from a "t_gui_lines" structure.
* Remove a line from a "t_gui_lines" structure.
*/
void
@@ -1363,7 +1363,7 @@ gui_line_remove_from_list (struct t_gui_buffer *buffer,
}
/*
* Adds line to mixed lines for a buffer.
* Add line to mixed lines for a buffer.
*/
void
@@ -1381,7 +1381,7 @@ gui_line_mixed_add (struct t_gui_lines *lines,
}
/*
* Frees all mixed lines matching a buffer.
* Free all mixed lines matching a buffer.
*/
void
@@ -1410,7 +1410,7 @@ gui_line_mixed_free_buffer (struct t_gui_buffer *buffer)
}
/*
* Frees all mixed lines in a buffer.
* Free all mixed lines in a buffer.
*/
void
@@ -1429,7 +1429,7 @@ gui_line_mixed_free_all (struct t_gui_buffer *buffer)
}
/*
* Deletes a line from a buffer.
* Delete a line from a buffer.
*/
void
@@ -1462,7 +1462,7 @@ gui_line_free (struct t_gui_buffer *buffer, struct t_gui_line *line)
}
/*
* Deletes all formatted lines from a buffer.
* Delete all formatted lines from a buffer.
*/
void
@@ -1493,9 +1493,9 @@ gui_line_free_all (struct t_gui_buffer *buffer)
}
/*
* Gets max notify level for a line, according to the nick.
* Get max notify level for a line, according to the nick.
*
* Returns max notify level, between -1 and GUI_HOTLIST_HIGHLIGHT.
* Return max notify level, between -1 and GUI_HOTLIST_HIGHLIGHT.
*/
int
@@ -1520,7 +1520,7 @@ gui_line_get_max_notify_level (struct t_gui_line *line)
}
/*
* Sets the notify level in a line:
* Set the notify level in a line:
* -1: no notify at all
* 0: low (GUI_HOTLIST_LOW)
* 1: message (GUI_HOTLIST_MESSAGE)
@@ -1552,7 +1552,7 @@ gui_line_set_notify_level (struct t_gui_line *line, int max_notify_level)
}
/*
* Sets highlight flag in a line:
* Set highlight flag in a line:
* 0: no highlight
* 1: highlight
*/
@@ -1570,7 +1570,7 @@ gui_line_set_highlight (struct t_gui_line *line, int max_notify_level)
}
/*
* Creates a new line for a buffer.
* Create a new line for a buffer.
*/
struct t_gui_line *
@@ -1663,7 +1663,7 @@ gui_line_new (struct t_gui_buffer *buffer, int y,
}
/*
* Updates data in a line via the hook_line.
* Update data in a line via the hook_line.
*/
void
@@ -1884,7 +1884,7 @@ gui_line_hook_update (struct t_gui_line *line,
}
/*
* Adds a new line in a buffer with formatted content.
* Add a new line in a buffer with formatted content.
*/
void
@@ -2005,7 +2005,7 @@ gui_line_add (struct t_gui_line *line)
}
/*
* Adds or updates a line in a buffer with free content.
* Add or updates a line in a buffer with free content.
*
* Ba careful: when replacing an existing line in the buffer, the "line"
* pointer received as parameter is freed and then becomes invalid.
@@ -2101,7 +2101,7 @@ gui_line_add_y (struct t_gui_line *line)
}
/*
* Clears prefix and message on a line (used on buffers with free content only).
* Clear prefix and message on a line (used on buffers with free content only).
*/
void
@@ -2130,7 +2130,7 @@ gui_line_clear (struct t_gui_line *line)
}
/*
* Mixes lines of a buffer (or group of buffers) with a new buffer.
* Mix lines of a buffer (or group of buffers) with a new buffer.
*/
void
@@ -2223,7 +2223,7 @@ gui_line_mix_buffers (struct t_gui_buffer *buffer)
}
/*
* Returns hdata for lines.
* Return hdata for lines.
*/
struct t_hdata *
@@ -2254,7 +2254,7 @@ gui_line_hdata_lines_cb (const void *pointer, void *data,
}
/*
* Returns hdata for line.
* Return hdata for line.
*/
struct t_hdata *
@@ -2410,7 +2410,7 @@ gui_line_hdata_line_data_update_cb (void *data,
}
/*
* Returns hdata for line data.
* Return hdata for line data.
*/
struct t_hdata *
@@ -2449,9 +2449,9 @@ gui_line_hdata_line_data_cb (const void *pointer, void *data,
}
/*
* Adds a line in an infolist.
* Add a line in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2534,7 +2534,7 @@ gui_line_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints lines structure infos in WeeChat log file (usually for crash dump).
* Print lines structure infos in WeeChat log file (usually for crash dump).
*/
void
src/gui/gui-mouse.c
+2 -2
View File
@@ -47,7 +47,7 @@ char gui_mouse_event_button = '#'; /* button pressed (or wheel) */
/*
* Sets debug for mouse events.
* Set debug for mouse events.
*/
void
@@ -65,7 +65,7 @@ gui_mouse_debug_set (int debug)
}
/*
* Resets event values.
* Reset event values.
*/
void
src/gui/gui-nick.c
+13 -13
View File
@@ -39,7 +39,7 @@
/*
* Hashes a string with a variant of djb2 hash, using 64-bit integer.
* Hash a string with a variant of djb2 hash, using 64-bit integer.
*
* Number pointed by *color_64 is updated by the function.
*/
@@ -56,7 +56,7 @@ gui_nick_hash_djb2_64 (const char *nickname, uint64_t *color_64)
}
/*
* Hashes a string with a variant of djb2 hash, using 32-bit integer.
* Hash a string with a variant of djb2 hash, using 32-bit integer.
*
* Number pointed by *color_32 is updated by the function.
*/
@@ -73,7 +73,7 @@ gui_nick_hash_djb2_32 (const char *nickname, uint32_t *color_32)
}
/*
* Hashes a string with sum of letters, using 64-bit integer.
* Hash a string with sum of letters, using 64-bit integer.
*
* Number pointed by *color_64 is updated by the function.
*/
@@ -89,7 +89,7 @@ gui_nick_hash_sum_64 (const char *nickname, uint64_t *color_64)
}
/*
* Hashes a string with sum of letters, using 32-bit integer.
* Hash a string with sum of letters, using 32-bit integer.
*
* Number pointed by *color_32 is updated by the function.
*/
@@ -105,9 +105,9 @@ gui_nick_hash_sum_32 (const char *nickname, uint32_t *color_32)
}
/*
* Hashes a nickname to find color.
* Hash a nickname to find color.
*
* Returns a number which is between 0 and num_colors - 1 (inclusive).
* Return a number which is between 0 and num_colors - 1 (inclusive).
*
* num_colors is commonly the number of colors in the option
* "weechat.color.chat_nick_colors".
@@ -165,9 +165,9 @@ gui_nick_hash_color (const char *nickname, int num_colors)
}
/*
* Gets forced color for a nick.
* Get forced color for a nick.
*
* Returns the name of color (for example: "green"), NULL if no color is forced
* Return the name of color (for example: "green"), NULL if no color is forced
* for nick.
*/
@@ -196,7 +196,7 @@ gui_nick_get_forced_color (const char *nickname)
}
/*
* Duplicates a nick and stops at first char in list (using option
* Duplicate a nick and stops at first char in list (using option
* weechat.look.nick_color_stop_chars).
*
* Note: result must be freed after use.
@@ -243,7 +243,7 @@ gui_nick_strdup_for_color (const char *nickname)
}
/*
* Finds a color name for a nick (according to nick letters).
* Find a color name for a nick (according to nick letters).
*
* If case_range < 0, nick is case-sensitive.
* If case_range == 0, nick is converted to lower case (with string_tolower).
@@ -258,7 +258,7 @@ gui_nick_strdup_for_color (const char *nickname)
* allowed with format "fg:bg", for example: "blue,yellow:red" for blue and
* yellow on red).
*
* Returns the name of a color (for example: "green").
* Return the name of a color (for example: "green").
*
* Note: result must be freed after use.
*/
@@ -333,7 +333,7 @@ end:
}
/*
* Finds a color code for a nick (according to nick letters).
* Find a color code for a nick (according to nick letters).
*
* If case_range < 0, nick is case-sensitive.
* If case_range == 0, nick is converted to lower case (with string_tolower).
@@ -348,7 +348,7 @@ end:
* allowed with format "fg:bg", for example: "blue,yellow:red" for blue and
* yellow on red).
*
* Returns a WeeChat color code (that can be used for display).
* Return a WeeChat color code (that can be used for display).
*
* Note: result must be freed after use.
*/
src/gui/gui-nicklist.c
+53 -53
View File
@@ -54,7 +54,7 @@ struct t_hashtable *gui_nicklist_hsignal = NULL;
/*
* Sends a signal when something has changed in nicklist.
* Send a signal when something has changed in nicklist.
*/
void
@@ -83,7 +83,7 @@ gui_nicklist_send_signal (const char *signal, struct t_gui_buffer *buffer,
}
/*
* Sends a hsignal when something will change or has changed in nicklist.
* Send a hsignal when something will change or has changed in nicklist.
*/
void
@@ -116,7 +116,7 @@ gui_nicklist_send_hsignal (const char *signal, struct t_gui_buffer *buffer,
}
/*
* Searches for position of a group (to keep nicklist sorted).
* Search for position of a group (to keep nicklist sorted).
*/
struct t_gui_nick_group *
@@ -136,7 +136,7 @@ gui_nicklist_find_pos_group (struct t_gui_nick_group *groups,
}
/*
* Inserts group into sorted list.
* Insert group into sorted list.
*/
void
@@ -180,10 +180,10 @@ gui_nicklist_insert_group_sorted (struct t_gui_nick_group **groups,
}
/*
* Searches for a group in nicklist by id (this function must not be called
* Search for a group in nicklist by id (this function must not be called
* directly).
*
* Returns pointer to group found, NULL if not found.
* Return pointer to group found, NULL if not found.
*/
struct t_gui_nick_group *
@@ -218,10 +218,10 @@ gui_nicklist_search_group_id (struct t_gui_buffer *buffer,
}
/*
* Searches for a group in nicklist by name (this function must not be called
* Search for a group in nicklist by name (this function must not be called
* directly).
*
* Returns pointer to group found, NULL if not found.
* Return pointer to group found, NULL if not found.
*/
struct t_gui_nick_group *
@@ -264,9 +264,9 @@ gui_nicklist_search_group_name (struct t_gui_buffer *buffer,
}
/*
* Searches for a group in nicklist.
* Search for a group in nicklist.
*
* Returns pointer to group found, NULL if not found.
* Return pointer to group found, NULL if not found.
*/
struct t_gui_nick_group *
@@ -298,7 +298,7 @@ gui_nicklist_search_group (struct t_gui_buffer *buffer,
}
/*
* Returns a new unique id for a group/nick.
* Return a new unique id for a group/nick.
*
* The id is the current time with microseconds precision.
* The same time (including microseconds) can be used only one time, so that
@@ -327,9 +327,9 @@ gui_nicklist_generate_id (struct t_gui_buffer *buffer)
}
/*
* Adds a group to nicklist with identifier (internal use).
* Add a group to nicklist with identifier (internal use).
*
* Returns pointer to new group, NULL if error.
* Return pointer to new group, NULL if error.
*/
struct t_gui_nick_group *
@@ -388,9 +388,9 @@ gui_nicklist_add_group_with_id (struct t_gui_buffer *buffer, long long id,
}
/*
* Adds a group to nicklist.
* Add a group to nicklist.
*
* Returns pointer to new group, NULL if error.
* Return pointer to new group, NULL if error.
*/
struct t_gui_nick_group *
@@ -411,7 +411,7 @@ gui_nicklist_add_group (struct t_gui_buffer *buffer,
}
/*
* Searches for position of a nick (to keep nicklist sorted).
* Search for position of a nick (to keep nicklist sorted).
*/
struct t_gui_nick *
@@ -434,7 +434,7 @@ gui_nicklist_find_pos_nick (struct t_gui_nick_group *group,
}
/*
* Inserts nick into sorted list.
* Insert nick into sorted list.
*/
void
@@ -477,10 +477,10 @@ gui_nicklist_insert_nick_sorted (struct t_gui_nick_group *group,
}
/*
* Searches for a nick in nicklist by id (this function must not be called
* Search for a nick in nicklist by id (this function must not be called
* directly).
*
* Returns pointer to nick found, NULL if not found.
* Return pointer to nick found, NULL if not found.
*/
struct t_gui_nick *
@@ -512,10 +512,10 @@ gui_nicklist_search_nick_id (struct t_gui_buffer *buffer,
}
/*
* Searches for a nick in nicklist by name (this function must not be called
* Search for a nick in nicklist by name (this function must not be called
* directly).
*
* Returns pointer to nick found, NULL if not found.
* Return pointer to nick found, NULL if not found.
*/
struct t_gui_nick *
@@ -559,9 +559,9 @@ gui_nicklist_search_nick_name (struct t_gui_buffer *buffer,
}
/*
* Searches for a nick in nicklist.
* Search for a nick in nicklist.
*
* Returns pointer to nick found, NULL if not found.
* Return pointer to nick found, NULL if not found.
*/
struct t_gui_nick *
@@ -590,9 +590,9 @@ gui_nicklist_search_nick (struct t_gui_buffer *buffer,
}
/*
* Adds a nick to nicklist with identifier (internal use).
* Add a nick to nicklist with identifier (internal use).
*
* Returns pointer to new nick, NULL if error.
* Return pointer to new nick, NULL if error.
*/
struct t_gui_nick *
@@ -642,9 +642,9 @@ gui_nicklist_add_nick_with_id (struct t_gui_buffer *buffer, long long id,
}
/*
* Adds a nick to nicklist.
* Add a nick to nicklist.
*
* Returns pointer to new nick, NULL if error.
* Return pointer to new nick, NULL if error.
*/
struct t_gui_nick *
@@ -669,7 +669,7 @@ gui_nicklist_add_nick (struct t_gui_buffer *buffer,
}
/*
* Removes a nick from a group.
* Remove a nick from a group.
*/
void
@@ -724,7 +724,7 @@ gui_nicklist_remove_nick (struct t_gui_buffer *buffer,
}
/*
* Removes a group from nicklist.
* Remove a group from nicklist.
*/
void
@@ -793,7 +793,7 @@ gui_nicklist_remove_group (struct t_gui_buffer *buffer,
}
/*
* Removes all nicks in nicklist.
* Remove all nicks in nicklist.
*/
void
@@ -816,7 +816,7 @@ gui_nicklist_remove_all (struct t_gui_buffer *buffer)
}
/*
* Gets next item (group or nick) of a group/nick.
* Get next item (group or nick) of a group/nick.
*/
void
@@ -896,10 +896,10 @@ gui_nicklist_get_next_item (struct t_gui_buffer *buffer,
}
/*
* Returns first char of a group that will be displayed on screen.
* Return first char of a group that will be displayed on screen.
*
* If name begins with some digits followed by '|', then start is after '|',
* otherwise it's beginning of name.
* If name begins with some digits followed by '|', start after '|',
* otherwise start at beginning of name.
*/
const char *
@@ -921,7 +921,7 @@ gui_nicklist_get_group_start (const char *name)
}
/*
* Computes visible_count variable for a nicklist.
* Compute visible_count variable for a nicklist.
*/
void
@@ -960,7 +960,7 @@ gui_nicklist_compute_visible_count (struct t_gui_buffer *buffer,
}
/*
* Gets a group property as integer.
* Get a group property as integer.
*/
int
@@ -983,7 +983,7 @@ gui_nicklist_group_get_integer (struct t_gui_buffer *buffer,
}
/*
* Gets a group property as string.
* Get a group property as string.
*/
const char *
@@ -1006,7 +1006,7 @@ gui_nicklist_group_get_string (struct t_gui_buffer *buffer,
}
/*
* Gets a group property as pointer.
* Get a group property as pointer.
*/
void *
@@ -1027,7 +1027,7 @@ gui_nicklist_group_get_pointer (struct t_gui_buffer *buffer,
}
/*
* Sets a group property (string).
* Set a group property (string).
*/
void
@@ -1080,7 +1080,7 @@ gui_nicklist_group_set (struct t_gui_buffer *buffer,
}
/*
* Gets a nick property as integer.
* Get a nick property as integer.
*/
int
@@ -1101,7 +1101,7 @@ gui_nicklist_nick_get_integer (struct t_gui_buffer *buffer,
}
/*
* Gets a nick property as string.
* Get a nick property as string.
*/
const char *
@@ -1128,7 +1128,7 @@ gui_nicklist_nick_get_string (struct t_gui_buffer *buffer,
}
/*
* Gets a nick property as pointer.
* Get a nick property as pointer.
*/
void *
@@ -1149,7 +1149,7 @@ gui_nicklist_nick_get_pointer (struct t_gui_buffer *buffer,
}
/*
* Sets a nick property (string).
* Set a nick property (string).
*/
void
@@ -1214,7 +1214,7 @@ gui_nicklist_nick_set (struct t_gui_buffer *buffer,
}
/*
* Returns hdata for nick_group.
* Return hdata for nick_group.
*/
struct t_hdata *
@@ -1248,7 +1248,7 @@ gui_nicklist_hdata_nick_group_cb (const void *pointer, void *data,
}
/*
* Returns hdata for nick.
* Return hdata for nick.
*/
struct t_hdata *
@@ -1279,9 +1279,9 @@ gui_nicklist_hdata_nick_cb (const void *pointer, void *data,
}
/*
* Adds a group in an infolist.
* Add a group in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1323,9 +1323,9 @@ gui_nicklist_add_group_to_infolist (struct t_infolist *infolist,
}
/*
* Adds a nick in an infolist.
* Add a nick in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1369,9 +1369,9 @@ gui_nicklist_add_nick_to_infolist (struct t_infolist *infolist,
}
/*
* Adds a nicklist in an infolist.
* Add a nicklist in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -1422,7 +1422,7 @@ gui_nicklist_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints nicklist infos in WeeChat log file (usually for crash dump).
* Print nicklist infos in WeeChat log file (usually for crash dump).
*/
void
@@ -1539,7 +1539,7 @@ gui_nicklist_print_log (struct t_gui_nick_group *group, int indent)
}
/*
* Frees all allocated data.
* Free all allocated data.
*/
void
src/gui/gui-window.c
+55 -56
View File
@@ -76,9 +76,9 @@ struct t_hook *gui_window_bare_display_timer = NULL;
/*
* Searches for a window by number.
* Search for a window by number.
*
* Returns pointer to window found, NULL if error.
* Return pointer to window found, NULL if error.
*/
struct t_gui_window *
@@ -97,7 +97,7 @@ gui_window_search_by_number (int number)
}
/*
* Gets pointer of window displayed at (x,y).
* Get pointer of window displayed at (x,y).
*
* Return pointer to window found, NULL if not found.
*/
@@ -123,7 +123,7 @@ gui_window_search_by_xy (int x, int y)
}
/*
* Returns following info:
* Return following info:
* - chat (0/1)
* - line
* - x in line
@@ -321,7 +321,7 @@ gui_window_get_context_at_xy (struct t_gui_window *window,
}
/*
* Sets flag "gui_window_refresh_needed".
* Set flag "gui_window_refresh_needed".
*/
void
@@ -332,9 +332,9 @@ gui_window_ask_refresh (int refresh)
}
/*
* Creates first entry in windows tree.
* Create first entry in windows tree.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -355,7 +355,7 @@ gui_window_tree_init (struct t_gui_window *window)
}
/*
* Converts a node to a leaf (free any leafs).
* Convert a node to a leaf (free any leafs).
*
* Called when 2 windows are merging into one.
*/
@@ -381,7 +381,7 @@ gui_window_tree_node_to_leaf (struct t_gui_window_tree *node,
}
/*
* Deletes entire windows tree.
* Delete entire windows tree.
*/
void
@@ -400,8 +400,7 @@ gui_window_tree_free (struct t_gui_window_tree **tree)
}
/*
* Searches a parent window which is split on the given direction
* ('h' or 'v').
* Search a parent window which is split on the given direction ('h' or 'v').
*/
struct t_gui_window_tree *
@@ -421,9 +420,9 @@ gui_window_tree_get_split (struct t_gui_window_tree *tree,
}
/*
* Searches for a scroll with buffer pointer.
* Search for a scroll with buffer pointer.
*
* Returns pointer to window scroll, NULL if not found.
* Return pointer to window scroll, NULL if not found.
*/
struct t_gui_window_scroll *
@@ -447,7 +446,7 @@ gui_window_scroll_search (struct t_gui_window *window,
}
/*
* Initializes a window scroll structure.
* Initialize a window scroll structure.
*/
void
@@ -467,7 +466,7 @@ gui_window_scroll_init (struct t_gui_window_scroll *window_scroll,
}
/*
* Frees a scroll structure in a window.
* Free a scroll structure in a window.
*/
void
@@ -488,7 +487,7 @@ gui_window_scroll_free (struct t_gui_window *window,
}
/*
* Frees all scroll structures in a window.
* Free all scroll structures in a window.
*/
void
@@ -501,7 +500,7 @@ gui_window_scroll_free_all (struct t_gui_window *window)
}
/*
* Removes all scroll structures which are empty (not scrolled).
* Remove all scroll structures which are empty (not scrolled).
*
* Note: the first scroll in list (current buffer) is NOT removed by this
* function.
@@ -536,7 +535,7 @@ gui_window_scroll_remove_not_scrolled (struct t_gui_window *window)
}
/*
* Switches scroll to a buffer.
* Switch scroll to a buffer.
*/
void
@@ -583,7 +582,7 @@ gui_window_scroll_switch (struct t_gui_window *window,
}
/*
* Removes buffer from scroll list in a window.
* Remove buffer from scroll list in a window.
*/
void
@@ -601,9 +600,9 @@ gui_window_scroll_remove_buffer (struct t_gui_window *window,
}
/*
* Creates a new window.
* Create a new window.
*
* Returns pointer to new window, NULL if error.
* Return pointer to new window, NULL if error.
*/
struct t_gui_window *
@@ -755,9 +754,9 @@ gui_window_new (struct t_gui_window *parent_window, struct t_gui_buffer *buffer,
}
/*
* Checks if a window pointer is valid.
* Check if a window pointer is valid.
*
* Returns:
* Return:
* 1: window exists
* 0: window does not exist
*/
@@ -782,9 +781,9 @@ gui_window_valid (struct t_gui_window *window)
}
/*
* Searches for window displaying a buffer.
* Search for window displaying a buffer.
*
* Returns NULL if no window is displaying given buffer.
* Return NULL if no window is displaying given buffer.
* If many windows are displaying this buffer, the first window in list is
* returned (or current window if it is displaying this buffer).
*/
@@ -812,7 +811,7 @@ gui_window_search_with_buffer (struct t_gui_buffer *buffer)
}
/*
* Gets a window property as integer.
* Get a window property as integer.
*/
int
@@ -854,7 +853,7 @@ gui_window_get_integer (struct t_gui_window *window, const char *property)
}
/*
* Gets a window property as string.
* Get a window property as string.
*/
const char *
@@ -867,7 +866,7 @@ gui_window_get_string (struct t_gui_window *window, const char *property)
}
/*
* Gets a window property as pointer.
* Get a window property as pointer.
*/
void *
@@ -889,7 +888,7 @@ gui_window_get_pointer (struct t_gui_window *window, const char *property)
}
/*
* Sets layout plugin name for window.
* Set layout plugin name for window.
*/
void
@@ -910,7 +909,7 @@ gui_window_set_layout_plugin_name (struct t_gui_window *window,
}
/*
* Sets layout buffer name for window.
* Set layout buffer name for window.
*/
void
@@ -931,7 +930,7 @@ gui_window_set_layout_buffer_name (struct t_gui_window *window,
}
/*
* Initializes a line in window coordinates.
* Initialize a line in window coordinates.
*/
void
@@ -954,7 +953,7 @@ gui_window_coords_init_line (struct t_gui_window *window, int line)
}
/*
* Removes a line from coordinates: each time the line is found in the array
* Remove a line from coordinates: each time the line is found in the array
* "coords", it is reinitialized.
*/
@@ -975,7 +974,7 @@ gui_window_coords_remove_line (struct t_gui_window *window,
}
/*
* Removes a line from coordinates: each time a line with data == line_data is
* Remove a line from coordinates: each time a line with data == line_data is
* found in the array "coords", it is reinitialized.
*/
@@ -999,7 +998,7 @@ gui_window_coords_remove_line_data (struct t_gui_window *window,
}
/*
* Allocates and initializes coordinates for window.
* Allocate and initializes coordinates for window.
*/
void
@@ -1028,7 +1027,7 @@ gui_window_coords_alloc (struct t_gui_window *window)
}
/*
* Deletes a window.
* Delete a window.
*/
void
@@ -1105,7 +1104,7 @@ gui_window_free (struct t_gui_window *window)
}
/*
* Switches to previous window.
* Switch to previous window.
*/
void
@@ -1119,7 +1118,7 @@ gui_window_switch_previous (struct t_gui_window *window)
}
/*
* Switches to next window.
* Switch to next window.
*/
void
@@ -1133,7 +1132,7 @@ gui_window_switch_next (struct t_gui_window *window)
}
/*
* Switches to window by number.
* Switch to window by number.
*/
void
@@ -1150,7 +1149,7 @@ gui_window_switch_by_number (int number)
}
/*
* Switches to next window displaying a buffer.
* Switch to next window displaying a buffer.
*/
void
@@ -1174,7 +1173,7 @@ gui_window_switch_by_buffer (struct t_gui_window *window, int buffer_number)
}
/*
* Scrolls window by a number of messages or time.
* Scroll window by a number of messages or time.
*/
void
@@ -1425,7 +1424,7 @@ gui_window_scroll (struct t_gui_window *window, char *scroll)
}
/*
* Horizontally scrolls window.
* Scroll window horizontally.
*/
void
@@ -1494,7 +1493,7 @@ gui_window_scroll_horiz (struct t_gui_window *window, char *scroll)
}
/*
* Scrolls to previous highlight.
* Scroll to previous highlight.
*/
void
@@ -1531,7 +1530,7 @@ gui_window_scroll_previous_highlight (struct t_gui_window *window)
}
/*
* Scrolls to next highlight.
* Scroll to next highlight.
*/
void
@@ -1568,7 +1567,7 @@ gui_window_scroll_next_highlight (struct t_gui_window *window)
}
/*
* Scrolls to first unread line of buffer.
* Scroll to first unread line of buffer.
*/
void
@@ -1601,9 +1600,9 @@ gui_window_scroll_unread (struct t_gui_window *window)
}
/*
* Searches for text in buffer lines or commands history.
* Search for text in buffer lines or commands history.
*
* Returns:
* Return:
* 1: successful search
* 0: no results found
*/
@@ -1680,7 +1679,7 @@ gui_window_search_text (struct t_gui_window *window)
}
/*
* Starts search in a buffer at a given position
* Start search in a buffer at a given position
* (or in whole buffer if text_search_start_line is NULL).
*/
@@ -1768,7 +1767,7 @@ gui_window_search_start (struct t_gui_window *window, int search,
}
/*
* Restarts search (after input changes or exact flag (un)set).
* Restart search (after input changes or exact flag (un)set).
*/
void
@@ -1828,7 +1827,7 @@ gui_window_search_restart (struct t_gui_window *window)
}
/*
* Stops search in a buffer, at current position if stop_here == 1 or reset
* Stop search in a buffer, at current position if stop_here == 1 or reset
* scroll to the initial value if stop_here == 0.
*/
@@ -1886,7 +1885,7 @@ gui_window_search_stop (struct t_gui_window *window, int stop_here)
}
/*
* Zooms window (maximize it or restore layout before previous zoom).
* Zoom window (maximize it or restore layout before previous zoom).
*/
void
@@ -1931,7 +1930,7 @@ gui_window_zoom (struct t_gui_window *window)
}
/*
* Returns hdata for window.
* Return hdata for window.
*/
struct t_hdata *
@@ -1981,7 +1980,7 @@ gui_window_hdata_window_cb (const void *pointer, void *data,
}
/*
* Returns hdata for window scroll.
* Return hdata for window scroll.
*/
struct t_hdata *
@@ -2013,7 +2012,7 @@ gui_window_hdata_window_scroll_cb (const void *pointer, void *data,
}
/*
* Returns hdata for window tree.
* Return hdata for window tree.
*/
struct t_hdata *
@@ -2041,9 +2040,9 @@ gui_window_hdata_window_tree_cb (const void *pointer, void *data,
}
/*
* Adds a window in an infolist.
* Add a window in an infolist.
*
* Returns:
* Return:
* 1: OK
* 0: error
*/
@@ -2100,7 +2099,7 @@ gui_window_add_to_infolist (struct t_infolist *infolist,
}
/*
* Prints window infos in WeeChat log file (usually for crash dump).
* Print window infos in WeeChat log file (usually for crash dump).
*/
void