/* vi:set ts=8 sts=4 sw=4 noet: * * VIM - Vi IMproved by Bram Moolenaar * * Do ":help uganda" in Vim to read copying and usage conditions. * Do ":help credits" in Vim to see a list of people who contributed. * See README.txt for an overview of the Vim source code. */ /* * clipboard.c: Functions to handle the clipboard */ #include "vim.h" #ifdef FEAT_CYGWIN_WIN32_CLIPBOARD # define WIN32_LEAN_AND_MEAN # include # include "winclip.pro" #endif // Functions for copying and pasting text between applications. // This is always included in a GUI version, but may also be included when the // clipboard and mouse is available to a terminal version such as xterm. // Note: there are some more functions in ops.c that handle selection stuff. // // Also note that the majority of functions here deal with the X 'primary' // (visible - for Visual mode use) selection, and only that. There are no // versions of these for the 'clipboard' selection, as Visual mode has no use // for them. #if defined(FEAT_CLIPBOARD) || defined(PROTO) #if defined(FEAT_WAYLAND_CLIPBOARD) # include "wayland.h" # ifdef FEAT_WAYLAND_CLIPBOARD_FS // Structures used for focus stealing typedef struct { struct wl_shm_pool *pool; int fd; struct wl_buffer *buffer; bool available; int width; int height; int stride; int size; } clip_wl_buffer_store_T; typedef struct { void *user_data; void (*on_focus)(void *data, uint32_t serial); struct wl_surface *surface; struct wl_keyboard *keyboard; struct { struct xdg_surface *surface; struct xdg_toplevel *toplevel; } shell; bool got_focus; } clip_wl_fs_surface_T; // fs = focus steal # endif // FEAT_WAYLAND_CLIPBOARD_FS // Represents either the regular or primary selection typedef struct { char_u *contents; // Non-null if we own selection, // contains the data to send to other // clients. vwl_data_source_T *source; // Non-NULL if we own the selection, // else NULL if we don't. vwl_data_offer_T *offer; // Current offer for the selection # ifdef FEAT_WAYLAND_CLIPBOARD_FS bool requires_focus; // If focus needs to be given to us to // work # endif bool own_success; // Used by clip_wl_own_selection() bool available; // If selection is ready to serve/use // These may point to the same proxy as the other selection vwl_data_device_manager_T *manager; vwl_data_device_T *device; } clip_wl_selection_T; // Represents the clipboard for the global Wayland connection, for the chosen // seat (using the 'wl_seat' option) typedef struct { vwl_seat_T *seat; #ifdef FEAT_WAYLAND_CLIPBOARD_FS clip_wl_buffer_store_T *fs_buffer; #endif clip_wl_selection_T regular; clip_wl_selection_T primary; // Array of file descriptors of clients we are sending data to. These should // be polled for POLLOUT and have the respective callback called for each. garray_T write_fds; } clip_wl_T; // Mime types we support sending and receiving // Mimes with a lower index in the array are prioritized first when we are // receiving data. static const char *supported_mimes[] = { VIMENC_ATOM_NAME, VIM_ATOM_NAME, "text/plain;charset=utf-8", "text/plain", "UTF8_STRING", "STRING", "TEXT" }; clip_wl_T clip_wl; static void clip_wl_receive_data(Clipboard_T *cbd, const char *mime_type, int fd); static void clip_wl_request_selection(Clipboard_T *cbd); static int clip_wl_own_selection(Clipboard_T *cbd); static void clip_wl_lose_selection(Clipboard_T *cbd); static void clip_wl_set_selection(Clipboard_T *cbd); # if defined(USE_SYSTEM) || defined(PROTO) static bool clip_wl_owner_exists(Clipboard_T *cbd); # endif #endif // FEAT_WAYLAND_CLIPBOARD /* * Selection stuff using Visual mode, for cutting and pasting text to other * windows. */ /* * Call this to initialise the clipboard. Pass it FALSE if the clipboard code * is included, but the clipboard can not be used, or TRUE if the clipboard can * be used. Eg unix may call this with FALSE, then call it again with TRUE if * the GUI starts. */ void clip_init(int can_use) { Clipboard_T *cb; cb = &clip_star; for (;;) { // No need to init again if cbd is already available if (can_use && cb->available) goto skip; cb->available = can_use; cb->owned = FALSE; cb->start.lnum = 0; cb->start.col = 0; cb->end.lnum = 0; cb->end.col = 0; cb->state = SELECT_CLEARED; skip: if (cb == &clip_plus) break; cb = &clip_plus; } } static void clip_init_single(Clipboard_T *cb, int can_use) { // No need to init again if cbd is already available if (can_use && cb->available) return; cb->available = can_use; cb->owned = FALSE; cb->start.lnum = 0; cb->start.col = 0; cb->end.lnum = 0; cb->end.col = 0; cb->state = SELECT_CLEARED; } /* * Check whether the VIsual area has changed, and if so try to become the owner * of the selection, and free any old converted selection we may still have * lying around. If the VIsual mode has ended, make a copy of what was * selected so we can still give it to others. Will probably have to make sure * this is called whenever VIsual mode is ended. */ void clip_update_selection(Clipboard_T *clip) { pos_T start, end; // If visual mode is only due to a redo command ("."), then ignore it if (!redo_VIsual_busy && VIsual_active && (State & MODE_NORMAL)) { if (LT_POS(VIsual, curwin->w_cursor)) { start = VIsual; end = curwin->w_cursor; if (has_mbyte) end.col += (*mb_ptr2len)(ml_get_cursor()) - 1; } else { start = curwin->w_cursor; end = VIsual; } if (!EQUAL_POS(clip->start, start) || !EQUAL_POS(clip->end, end) || clip->vmode != VIsual_mode) { clip_clear_selection(clip); clip->start = start; clip->end = end; clip->vmode = VIsual_mode; clip_free_selection(clip); clip_own_selection(clip); clip_gen_set_selection(clip); } } } static int clip_gen_own_selection(Clipboard_T *cbd UNUSED) { if (clipmethod == CLIPMETHOD_GUI) { #ifdef FEAT_GUI if (gui.in_use) return clip_mch_own_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_WAYLAND) { #ifdef FEAT_WAYLAND_CLIPBOARD return clip_wl_own_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_X11) { #ifdef FEAT_XCLIPBOARD return clip_xterm_own_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_OTHER) { #if !defined(FEAT_XCLIPBOARD) && !defined(FEAT_WAYLAND_CLIPBOARD) return clip_mch_own_selection(cbd); #endif } return FAIL; } void clip_own_selection(Clipboard_T *cbd) { /* * Also want to check somehow that we are reading from the keyboard rather * than a mapping etc. */ #if defined(FEAT_X11) || defined(FEAT_WAYLAND_CLIPBOARD) // Always own the selection, we might have lost it without being // notified, e.g. during a ":sh" command. if (cbd->available) { int was_owned = cbd->owned; cbd->owned = (clip_gen_own_selection(cbd) == OK); if (!was_owned && (cbd == &clip_star || cbd == &clip_plus)) { // May have to show a different kind of highlighting for the // selected area. There is no specific redraw command for this, // just redraw all windows on the current buffer. if (cbd->owned && (get_real_state() == MODE_VISUAL || get_real_state() == MODE_SELECT) && (cbd == &clip_star ? clip_isautosel_star() : clip_isautosel_plus()) && HL_ATTR(HLF_V) != HL_ATTR(HLF_VNC)) redraw_curbuf_later(UPD_INVERTED_ALL); } } #else // Only own the clipboard when we didn't own it yet. if (!cbd->owned && cbd->available) cbd->owned = (clip_gen_own_selection(cbd) == OK); #endif } static void clip_gen_lose_selection(Clipboard_T *cbd UNUSED) { if (clipmethod == CLIPMETHOD_GUI) { #ifdef FEAT_GUI if (gui.in_use) clip_mch_lose_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_WAYLAND) { #ifdef FEAT_WAYLAND_CLIPBOARD clip_wl_lose_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_X11) { #ifdef FEAT_XCLIPBOARD clip_xterm_lose_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_OTHER) { #if !defined(FEAT_XCLIPBOARD) && !defined(FEAT_WAYLAND_CLIPBOARD) clip_mch_lose_selection(cbd); #endif } } void clip_lose_selection(Clipboard_T *cbd) { #ifdef FEAT_X11 int was_owned = cbd->owned; #endif int visual_selection = FALSE; if (cbd == &clip_star || cbd == &clip_plus) visual_selection = TRUE; clip_free_selection(cbd); cbd->owned = FALSE; if (visual_selection) clip_clear_selection(cbd); clip_gen_lose_selection(cbd); #ifdef FEAT_X11 if (visual_selection) { // May have to show a different kind of highlighting for the selected // area. There is no specific redraw command for this, just redraw all // windows on the current buffer. if (was_owned && (get_real_state() == MODE_VISUAL || get_real_state() == MODE_SELECT) && (cbd == &clip_star ? clip_isautosel_star() : clip_isautosel_plus()) && HL_ATTR(HLF_V) != HL_ATTR(HLF_VNC) && !exiting) { update_curbuf(UPD_INVERTED_ALL); setcursor(); cursor_on(); out_flush_cursor(TRUE, FALSE); } } #endif } static void clip_copy_selection(Clipboard_T *clip) { if (VIsual_active && (State & MODE_NORMAL) && clip->available) { clip_update_selection(clip); clip_free_selection(clip); clip_own_selection(clip); if (clip->owned) clip_get_selection(clip); clip_gen_set_selection(clip); } } /* * Save and restore clip_unnamed before doing possibly many changes. This * prevents accessing the clipboard very often which might slow down Vim * considerably. */ static int global_change_count = 0; // if set, inside a start_global_changes static int clipboard_needs_update = FALSE; // clipboard needs to be updated static int clip_did_set_selection = TRUE; /* * Save clip_unnamed and reset it. */ void start_global_changes(void) { if (++global_change_count > 1) return; clip_unnamed_saved = clip_unnamed; clipboard_needs_update = FALSE; if (clip_did_set_selection) { clip_unnamed = 0; clip_did_set_selection = FALSE; } } /* * Return TRUE if setting the clipboard was postponed, it already contains the * right text. */ static int is_clipboard_needs_update(void) { return clipboard_needs_update; } /* * Restore clip_unnamed and set the selection when needed. */ void end_global_changes(void) { if (--global_change_count > 0) // recursive return; if (!clip_did_set_selection) { clip_did_set_selection = TRUE; clip_unnamed = clip_unnamed_saved; clip_unnamed_saved = 0; if (clipboard_needs_update) { // only store something in the clipboard, // if we have yanked anything to it if (clip_unnamed & CLIP_UNNAMED) { clip_own_selection(&clip_star); clip_gen_set_selection(&clip_star); } if (clip_unnamed & CLIP_UNNAMED_PLUS) { clip_own_selection(&clip_plus); clip_gen_set_selection(&clip_plus); } } } clipboard_needs_update = FALSE; } /* * Called when Visual mode is ended: update the selection. */ void clip_auto_select(void) { if (clip_isautosel_star()) clip_copy_selection(&clip_star); if (clip_isautosel_plus()) clip_copy_selection(&clip_plus); } /* * Return TRUE if automatic selection of Visual area is desired for the * * register. */ int clip_isautosel_star(void) { return ( #ifdef FEAT_GUI gui.in_use ? (vim_strchr(p_go, GO_ASEL) != NULL) : #endif clip_autoselect_star); } /* * Return TRUE if automatic selection of Visual area is desired for the + * register. */ int clip_isautosel_plus(void) { return ( #ifdef FEAT_GUI gui.in_use ? (vim_strchr(p_go, GO_ASELPLUS) != NULL) : #endif clip_autoselect_plus); } /* * Stuff for general mouse selection, without using Visual mode. */ /* * Compare two screen positions ala strcmp() */ static int clip_compare_pos( int row1, int col1, int row2, int col2) { if (row1 > row2) return(1); if (row1 < row2) return(-1); if (col1 > col2) return(1); if (col1 < col2) return(-1); return(0); } // "how" flags for clip_invert_area() #define CLIP_CLEAR 1 #define CLIP_SET 2 #define CLIP_TOGGLE 3 /* * Invert or un-invert a rectangle of the screen. * "invert" is true if the result is inverted. */ static void clip_invert_rectangle( Clipboard_T *cbd UNUSED, int row_arg, int col_arg, int height_arg, int width_arg, int invert) { int row = row_arg; int col = col_arg; int height = height_arg; int width = width_arg; #ifdef FEAT_PROP_POPUP // this goes on top of all popup windows screen_zindex = CLIP_ZINDEX; if (col < cbd->min_col) { width -= cbd->min_col - col; col = cbd->min_col; } if (width > cbd->max_col - col) width = cbd->max_col - col; if (row < cbd->min_row) { height -= cbd->min_row - row; row = cbd->min_row; } if (height > cbd->max_row - row + 1) height = cbd->max_row - row + 1; #endif #ifdef FEAT_GUI if (gui.in_use) gui_mch_invert_rectangle(row, col, height, width); else #endif screen_draw_rectangle(row, col, height, width, invert); #ifdef FEAT_PROP_POPUP screen_zindex = 0; #endif } /* * Invert a region of the display between a starting and ending row and column * Values for "how": * CLIP_CLEAR: undo inversion * CLIP_SET: set inversion * CLIP_TOGGLE: set inversion if pos1 < pos2, undo inversion otherwise. * 0: invert (GUI only). */ static void clip_invert_area( Clipboard_T *cbd, int row1, int col1, int row2, int col2, int how) { int invert = FALSE; int max_col; #ifdef FEAT_PROP_POPUP max_col = cbd->max_col - 1; #else max_col = Columns - 1; #endif if (how == CLIP_SET) invert = TRUE; // Swap the from and to positions so the from is always before if (clip_compare_pos(row1, col1, row2, col2) > 0) { int tmp_row, tmp_col; tmp_row = row1; tmp_col = col1; row1 = row2; col1 = col2; row2 = tmp_row; col2 = tmp_col; } else if (how == CLIP_TOGGLE) invert = TRUE; // If all on the same line, do it the easy way if (row1 == row2) { clip_invert_rectangle(cbd, row1, col1, 1, col2 - col1, invert); } else { // Handle a piece of the first line if (col1 > 0) { clip_invert_rectangle(cbd, row1, col1, 1, (int)Columns - col1, invert); row1++; } // Handle a piece of the last line if (col2 < max_col) { clip_invert_rectangle(cbd, row2, 0, 1, col2, invert); row2--; } // Handle the rectangle that's left if (row2 >= row1) clip_invert_rectangle(cbd, row1, 0, row2 - row1 + 1, (int)Columns, invert); } } /* * Start, continue or end a modeless selection. Used when editing the * command-line, in the cmdline window and when the mouse is in a popup window. */ void clip_modeless(int button, int is_click, int is_drag) { int repeat; repeat = ((clip_star.mode == SELECT_MODE_CHAR || clip_star.mode == SELECT_MODE_LINE) && (mod_mask & MOD_MASK_2CLICK)) || (clip_star.mode == SELECT_MODE_WORD && (mod_mask & MOD_MASK_3CLICK)); if (is_click && button == MOUSE_RIGHT) { // Right mouse button: If there was no selection, start one. // Otherwise extend the existing selection. if (clip_star.state == SELECT_CLEARED) clip_start_selection(mouse_col, mouse_row, FALSE); clip_process_selection(button, mouse_col, mouse_row, repeat); } else if (is_click) clip_start_selection(mouse_col, mouse_row, repeat); else if (is_drag) { // Don't try extending a selection if there isn't one. Happens when // button-down is in the cmdline and them moving mouse upwards. if (clip_star.state != SELECT_CLEARED) clip_process_selection(button, mouse_col, mouse_row, repeat); } else // release clip_process_selection(MOUSE_RELEASE, mouse_col, mouse_row, FALSE); } /* * Update the currently selected region by adding and/or subtracting from the * beginning or end and inverting the changed area(s). */ static void clip_update_modeless_selection( Clipboard_T *cb, int row1, int col1, int row2, int col2) { // See if we changed at the beginning of the selection if (row1 != cb->start.lnum || col1 != (int)cb->start.col) { clip_invert_area(cb, row1, col1, (int)cb->start.lnum, cb->start.col, CLIP_TOGGLE); cb->start.lnum = row1; cb->start.col = col1; } // See if we changed at the end of the selection if (row2 != cb->end.lnum || col2 != (int)cb->end.col) { clip_invert_area(cb, (int)cb->end.lnum, cb->end.col, row2, col2, CLIP_TOGGLE); cb->end.lnum = row2; cb->end.col = col2; } } /* * Find the starting and ending positions of the word at the given row and * column. Only white-separated words are recognized here. */ #define CHAR_CLASS(c) (c <= ' ' ? ' ' : vim_iswordc(c)) static void clip_get_word_boundaries(Clipboard_T *cb, int row, int col) { int start_class; int temp_col; char_u *p; int mboff; if (row >= screen_Rows || col >= screen_Columns || ScreenLines == NULL) return; p = ScreenLines + LineOffset[row]; // Correct for starting in the right half of a double-wide char if (enc_dbcs != 0) col -= dbcs_screen_head_off(p, p + col); else if (enc_utf8 && p[col] == 0) --col; start_class = CHAR_CLASS(p[col]); temp_col = col; for ( ; temp_col > 0; temp_col--) if (enc_dbcs != 0 && (mboff = dbcs_screen_head_off(p, p + temp_col - 1)) > 0) temp_col -= mboff; else if (CHAR_CLASS(p[temp_col - 1]) != start_class && !(enc_utf8 && p[temp_col - 1] == 0)) break; cb->word_start_col = temp_col; temp_col = col; for ( ; temp_col < screen_Columns; temp_col++) if (enc_dbcs != 0 && dbcs_ptr2cells(p + temp_col) == 2) ++temp_col; else if (CHAR_CLASS(p[temp_col]) != start_class && !(enc_utf8 && p[temp_col] == 0)) break; cb->word_end_col = temp_col; } /* * Find the column position for the last non-whitespace character on the given * line at or before start_col. */ static int clip_get_line_end(Clipboard_T *cbd UNUSED, int row) { int i; if (row >= screen_Rows || ScreenLines == NULL) return 0; for (i = #ifdef FEAT_PROP_POPUP cbd->max_col; #else screen_Columns; #endif i > 0; i--) if (ScreenLines[LineOffset[row] + i - 1] != ' ') break; return i; } /* * Start the selection */ void clip_start_selection(int col, int row, int repeated_click) { Clipboard_T *cb = &clip_star; #ifdef FEAT_PROP_POPUP win_T *wp; int row_cp = row; int col_cp = col; wp = mouse_find_win(&row_cp, &col_cp, FIND_POPUP); if (wp != NULL && WIN_IS_POPUP(wp) && popup_is_in_scrollbar(wp, row_cp, col_cp)) // click or double click in scrollbar does not start a selection return; #endif if (cb->state == SELECT_DONE) clip_clear_selection(cb); row = check_row(row); col = check_col(col); col = mb_fix_col(col, row); cb->start.lnum = row; cb->start.col = col; cb->end = cb->start; cb->origin_row = (short_u)cb->start.lnum; cb->state = SELECT_IN_PROGRESS; #ifdef FEAT_PROP_POPUP if (wp != NULL && WIN_IS_POPUP(wp)) { // Click in a popup window restricts selection to that window, // excluding the border. cb->min_col = wp->w_wincol + wp->w_popup_border[3]; cb->max_col = wp->w_wincol + popup_width(wp) - wp->w_popup_border[1] - wp->w_has_scrollbar; if (cb->max_col > screen_Columns) cb->max_col = screen_Columns; cb->min_row = wp->w_winrow + wp->w_popup_border[0]; cb->max_row = wp->w_winrow + popup_height(wp) - 1 - wp->w_popup_border[2]; } else { cb->min_col = 0; cb->max_col = screen_Columns; cb->min_row = 0; cb->max_row = screen_Rows; } #endif if (repeated_click) { if (++cb->mode > SELECT_MODE_LINE) cb->mode = SELECT_MODE_CHAR; } else cb->mode = SELECT_MODE_CHAR; #ifdef FEAT_GUI // clear the cursor until the selection is made if (gui.in_use) gui_undraw_cursor(); #endif switch (cb->mode) { case SELECT_MODE_CHAR: cb->origin_start_col = cb->start.col; cb->word_end_col = clip_get_line_end(cb, (int)cb->start.lnum); break; case SELECT_MODE_WORD: clip_get_word_boundaries(cb, (int)cb->start.lnum, cb->start.col); cb->origin_start_col = cb->word_start_col; cb->origin_end_col = cb->word_end_col; clip_invert_area(cb, (int)cb->start.lnum, cb->word_start_col, (int)cb->end.lnum, cb->word_end_col, CLIP_SET); cb->start.col = cb->word_start_col; cb->end.col = cb->word_end_col; break; case SELECT_MODE_LINE: clip_invert_area(cb, (int)cb->start.lnum, 0, (int)cb->start.lnum, (int)Columns, CLIP_SET); cb->start.col = 0; cb->end.col = Columns; break; } cb->prev = cb->start; #ifdef DEBUG_SELECTION printf("Selection started at (%ld,%d)\n", cb->start.lnum, cb->start.col); #endif } /* * Continue processing the selection */ void clip_process_selection( int button, int col, int row, int_u repeated_click) { Clipboard_T *cb = &clip_star; int diff; int slen = 1; // cursor shape width if (button == MOUSE_RELEASE) { if (cb->state != SELECT_IN_PROGRESS) return; // Check to make sure we have something selected if (cb->start.lnum == cb->end.lnum && cb->start.col == cb->end.col) { #ifdef FEAT_GUI if (gui.in_use) gui_update_cursor(FALSE, FALSE); #endif cb->state = SELECT_CLEARED; return; } #ifdef DEBUG_SELECTION printf("Selection ended: (%ld,%d) to (%ld,%d)\n", cb->start.lnum, cb->start.col, cb->end.lnum, cb->end.col); #endif if (clip_isautosel_star() || ( #ifdef FEAT_GUI gui.in_use ? (vim_strchr(p_go, GO_ASELML) != NULL) : #endif clip_autoselectml)) clip_copy_modeless_selection(FALSE); #ifdef FEAT_GUI if (gui.in_use) gui_update_cursor(FALSE, FALSE); #endif cb->state = SELECT_DONE; return; } row = check_row(row); col = check_col(col); col = mb_fix_col(col, row); if (col == (int)cb->prev.col && row == cb->prev.lnum && !repeated_click) return; /* * When extending the selection with the right mouse button, swap the * start and end if the position is before half the selection */ if (cb->state == SELECT_DONE && button == MOUSE_RIGHT) { /* * If the click is before the start, or the click is inside the * selection and the start is the closest side, set the origin to the * end of the selection. */ if (clip_compare_pos(row, col, (int)cb->start.lnum, cb->start.col) < 0 || (clip_compare_pos(row, col, (int)cb->end.lnum, cb->end.col) < 0 && (((cb->start.lnum == cb->end.lnum && cb->end.col - col > col - cb->start.col)) || ((diff = (cb->end.lnum - row) - (row - cb->start.lnum)) > 0 || (diff == 0 && col < (int)(cb->start.col + cb->end.col) / 2))))) { cb->origin_row = (short_u)cb->end.lnum; cb->origin_start_col = cb->end.col - 1; cb->origin_end_col = cb->end.col; } else { cb->origin_row = (short_u)cb->start.lnum; cb->origin_start_col = cb->start.col; cb->origin_end_col = cb->start.col; } if (cb->mode == SELECT_MODE_WORD && !repeated_click) cb->mode = SELECT_MODE_CHAR; } // set state, for when using the right mouse button cb->state = SELECT_IN_PROGRESS; #ifdef DEBUG_SELECTION printf("Selection extending to (%d,%d)\n", row, col); #endif if (repeated_click && ++cb->mode > SELECT_MODE_LINE) cb->mode = SELECT_MODE_CHAR; switch (cb->mode) { case SELECT_MODE_CHAR: // If we're on a different line, find where the line ends if (row != cb->prev.lnum) cb->word_end_col = clip_get_line_end(cb, row); // See if we are before or after the origin of the selection if (clip_compare_pos(row, col, cb->origin_row, cb->origin_start_col) >= 0) { if (col >= (int)cb->word_end_col) clip_update_modeless_selection(cb, cb->origin_row, cb->origin_start_col, row, (int)Columns); else { if (has_mbyte && mb_lefthalve(row, col)) slen = 2; clip_update_modeless_selection(cb, cb->origin_row, cb->origin_start_col, row, col + slen); } } else { if (has_mbyte && mb_lefthalve(cb->origin_row, cb->origin_start_col)) slen = 2; if (col >= (int)cb->word_end_col) clip_update_modeless_selection(cb, row, cb->word_end_col, cb->origin_row, cb->origin_start_col + slen); else clip_update_modeless_selection(cb, row, col, cb->origin_row, cb->origin_start_col + slen); } break; case SELECT_MODE_WORD: // If we are still within the same word, do nothing if (row == cb->prev.lnum && col >= (int)cb->word_start_col && col < (int)cb->word_end_col && !repeated_click) return; // Get new word boundaries clip_get_word_boundaries(cb, row, col); // Handle being after the origin point of selection if (clip_compare_pos(row, col, cb->origin_row, cb->origin_start_col) >= 0) clip_update_modeless_selection(cb, cb->origin_row, cb->origin_start_col, row, cb->word_end_col); else clip_update_modeless_selection(cb, row, cb->word_start_col, cb->origin_row, cb->origin_end_col); break; case SELECT_MODE_LINE: if (row == cb->prev.lnum && !repeated_click) return; if (clip_compare_pos(row, col, cb->origin_row, cb->origin_start_col) >= 0) clip_update_modeless_selection(cb, cb->origin_row, 0, row, (int)Columns); else clip_update_modeless_selection(cb, row, 0, cb->origin_row, (int)Columns); break; } cb->prev.lnum = row; cb->prev.col = col; #ifdef DEBUG_SELECTION printf("Selection is: (%ld,%d) to (%ld,%d)\n", cb->start.lnum, cb->start.col, cb->end.lnum, cb->end.col); #endif } # if defined(FEAT_GUI) || defined(PROTO) /* * Redraw part of the selection if character at "row,col" is inside of it. * Only used for the GUI. */ void clip_may_redraw_selection(int row, int col, int len) { int start = col; int end = col + len; if (clip_star.state != SELECT_CLEARED && row >= clip_star.start.lnum && row <= clip_star.end.lnum) { if (row == clip_star.start.lnum && start < (int)clip_star.start.col) start = clip_star.start.col; if (row == clip_star.end.lnum && end > (int)clip_star.end.col) end = clip_star.end.col; if (end > start) clip_invert_area(&clip_star, row, start, row, end, 0); } } # endif /* * Called from outside to clear selected region from the display */ void clip_clear_selection(Clipboard_T *cbd) { if (cbd->state == SELECT_CLEARED) return; clip_invert_area(cbd, (int)cbd->start.lnum, cbd->start.col, (int)cbd->end.lnum, cbd->end.col, CLIP_CLEAR); cbd->state = SELECT_CLEARED; } /* * Clear the selection if any lines from "row1" to "row2" are inside of it. */ void clip_may_clear_selection(int row1, int row2) { if (clip_star.state == SELECT_DONE && row2 >= clip_star.start.lnum && row1 <= clip_star.end.lnum) clip_clear_selection(&clip_star); } /* * Called before the screen is scrolled up or down. Adjusts the line numbers * of the selection. Call with big number when clearing the screen. */ void clip_scroll_selection( int rows) // negative for scroll down { int lnum; if (clip_star.state == SELECT_CLEARED) return; lnum = clip_star.start.lnum - rows; if (lnum <= 0) clip_star.start.lnum = 0; else if (lnum >= screen_Rows) // scrolled off of the screen clip_star.state = SELECT_CLEARED; else clip_star.start.lnum = lnum; lnum = clip_star.end.lnum - rows; if (lnum < 0) // scrolled off of the screen clip_star.state = SELECT_CLEARED; else if (lnum >= screen_Rows) clip_star.end.lnum = screen_Rows - 1; else clip_star.end.lnum = lnum; } /* * Copy the currently selected area into the '*' register so it will be * available for pasting. * When "both" is TRUE also copy to the '+' register. */ void clip_copy_modeless_selection(int both UNUSED) { char_u *buffer; char_u *bufp; int row; int start_col; int end_col; int line_end_col; int add_newline_flag = FALSE; int len; char_u *p; int row1 = clip_star.start.lnum; int col1 = clip_star.start.col; int row2 = clip_star.end.lnum; int col2 = clip_star.end.col; // Can't use ScreenLines unless initialized if (ScreenLines == NULL) return; /* * Make sure row1 <= row2, and if row1 == row2 that col1 <= col2. */ if (row1 > row2) { row = row1; row1 = row2; row2 = row; row = col1; col1 = col2; col2 = row; } else if (row1 == row2 && col1 > col2) { row = col1; col1 = col2; col2 = row; } #ifdef FEAT_PROP_POPUP if (col1 < clip_star.min_col) col1 = clip_star.min_col; if (col2 > clip_star.max_col) col2 = clip_star.max_col; if (row1 > clip_star.max_row || row2 < clip_star.min_row) return; if (row1 < clip_star.min_row) row1 = clip_star.min_row; if (row2 > clip_star.max_row) row2 = clip_star.max_row; #endif // correct starting point for being on right half of double-wide char p = ScreenLines + LineOffset[row1]; if (enc_dbcs != 0) col1 -= (*mb_head_off)(p, p + col1); else if (enc_utf8 && p[col1] == 0) --col1; // Create a temporary buffer for storing the text len = (row2 - row1 + 1) * Columns + 1; if (enc_dbcs != 0) len *= 2; // max. 2 bytes per display cell else if (enc_utf8) len *= MB_MAXBYTES; buffer = alloc(len); if (buffer == NULL) // out of memory return; // Process each row in the selection for (bufp = buffer, row = row1; row <= row2; row++) { if (row == row1) start_col = col1; else #ifdef FEAT_PROP_POPUP start_col = clip_star.min_col; #else start_col = 0; #endif if (row == row2) end_col = col2; else #ifdef FEAT_PROP_POPUP end_col = clip_star.max_col; #else end_col = Columns; #endif line_end_col = clip_get_line_end(&clip_star, row); // See if we need to nuke some trailing whitespace if (end_col >= #ifdef FEAT_PROP_POPUP clip_star.max_col #else Columns #endif && (row < row2 || end_col > line_end_col)) { // Get rid of trailing whitespace end_col = line_end_col; if (end_col < start_col) end_col = start_col; // If the last line extended to the end, add an extra newline if (row == row2) add_newline_flag = TRUE; } // If after the first row, we need to always add a newline if (row > row1 && !LineWraps[row - 1]) *bufp++ = NL; // Safetey check for in case resizing went wrong if (row < screen_Rows && end_col <= screen_Columns) { if (enc_dbcs != 0) { int i; p = ScreenLines + LineOffset[row]; for (i = start_col; i < end_col; ++i) if (enc_dbcs == DBCS_JPNU && p[i] == 0x8e) { // single-width double-byte char *bufp++ = 0x8e; *bufp++ = ScreenLines2[LineOffset[row] + i]; } else { *bufp++ = p[i]; if (MB_BYTE2LEN(p[i]) == 2) *bufp++ = p[++i]; } } else if (enc_utf8) { int off; int i; int ci; off = LineOffset[row]; for (i = start_col; i < end_col; ++i) { // The base character is either in ScreenLinesUC[] or // ScreenLines[]. if (ScreenLinesUC[off + i] == 0) *bufp++ = ScreenLines[off + i]; else { bufp += utf_char2bytes(ScreenLinesUC[off + i], bufp); for (ci = 0; ci < Screen_mco; ++ci) { // Add a composing character. if (ScreenLinesC[ci][off + i] == 0) break; bufp += utf_char2bytes(ScreenLinesC[ci][off + i], bufp); } } // Skip right half of double-wide character. if (ScreenLines[off + i + 1] == 0) ++i; } } else { STRNCPY(bufp, ScreenLines + LineOffset[row] + start_col, end_col - start_col); bufp += end_col - start_col; } } } // Add a newline at the end if the selection ended there if (add_newline_flag) *bufp++ = NL; // First cleanup any old selection and become the owner. clip_free_selection(&clip_star); clip_own_selection(&clip_star); // Yank the text into the '*' register. clip_yank_selection(MCHAR, buffer, (long)(bufp - buffer), &clip_star); // Make the register contents available to the outside world. clip_gen_set_selection(&clip_star); #ifdef FEAT_X11 if (both) { // Do the same for the '+' register. clip_free_selection(&clip_plus); clip_own_selection(&clip_plus); clip_yank_selection(MCHAR, buffer, (long)(bufp - buffer), &clip_plus); clip_gen_set_selection(&clip_plus); } #endif vim_free(buffer); } void clip_gen_set_selection(Clipboard_T *cbd) { if (!clip_did_set_selection) { // Updating postponed, so that accessing the system clipboard won't // hang Vim when accessing it many times (e.g. on a :g command). if ((cbd == &clip_plus && (clip_unnamed_saved & CLIP_UNNAMED_PLUS)) || (cbd == &clip_star && (clip_unnamed_saved & CLIP_UNNAMED))) { clipboard_needs_update = TRUE; return; } } if (clipmethod == CLIPMETHOD_GUI) { #ifdef FEAT_GUI if (gui.in_use) clip_mch_set_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_WAYLAND) { #ifdef FEAT_WAYLAND_CLIPBOARD clip_wl_set_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_X11) { #ifdef FEAT_XCLIPBOARD clip_xterm_set_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_OTHER) { #if !defined(FEAT_XCLIPBOARD) && !defined(FEAT_WAYLAND_CLIPBOARD) clip_mch_set_selection(cbd); #endif } } static void clip_gen_request_selection(Clipboard_T *cbd UNUSED) { if (clipmethod == CLIPMETHOD_GUI) { # ifdef FEAT_GUI if (gui.in_use) clip_mch_request_selection(cbd); # endif } else if (clipmethod == CLIPMETHOD_WAYLAND) { #ifdef FEAT_WAYLAND_CLIPBOARD clip_wl_request_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_X11) { #ifdef FEAT_XCLIPBOARD clip_xterm_request_selection(cbd); #endif } else if (clipmethod == CLIPMETHOD_OTHER) { #if !defined(FEAT_XCLIPBOARD) && !defined(FEAT_WAYLAND_CLIPBOARD) clip_mch_request_selection(cbd); #endif } } #if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD) && defined(USE_SYSTEM)) \ || defined(PROTO) static int clip_x11_owner_exists(Clipboard_T *cbd) { return XGetSelectionOwner(X_DISPLAY, cbd->sel_atom) != None; } #endif #if ((defined(FEAT_X11) || defined(FEAT_WAYLAND_CLIPBOARD)) \ && defined(USE_SYSTEM)) || defined(PROTO) int clip_gen_owner_exists(Clipboard_T *cbd UNUSED) { if (clipmethod == CLIPMETHOD_OTHER) { # ifdef FEAT_GUI_GTK if (gui.in_use) return clip_gtk_owner_exists(cbd); # endif } else if (clipmethod == CLIPMETHOD_WAYLAND) { # ifdef FEAT_WAYLAND_CLIPBOARD return clip_wl_owner_exists(cbd); # endif } else if (clipmethod == CLIPMETHOD_X11) { # ifdef FEAT_XCLIPBOARD return clip_x11_owner_exists(cbd); # endif } else return FALSE; return FALSE; } #endif /* * Extract the items in the 'clipboard' option and set global values. * Return an error message or NULL for success. */ char * did_set_clipboard(optset_T *args UNUSED) { int new_unnamed = 0; int new_autoselect_star = FALSE; int new_autoselect_plus = FALSE; int new_autoselectml = FALSE; int new_html = FALSE; regprog_T *new_exclude_prog = NULL; char *errmsg = NULL; char_u *p; for (p = p_cb; *p != NUL; ) { // Note: Keep this in sync with p_cb_values. if (STRNCMP(p, "unnamed", 7) == 0 && (p[7] == ',' || p[7] == NUL)) { new_unnamed |= CLIP_UNNAMED; p += 7; } else if (STRNCMP(p, "unnamedplus", 11) == 0 && (p[11] == ',' || p[11] == NUL)) { new_unnamed |= CLIP_UNNAMED_PLUS; p += 11; } else if (STRNCMP(p, "autoselect", 10) == 0 && (p[10] == ',' || p[10] == NUL)) { new_autoselect_star = TRUE; p += 10; } else if (STRNCMP(p, "autoselectplus", 14) == 0 && (p[14] == ',' || p[14] == NUL)) { new_autoselect_plus = TRUE; p += 14; } else if (STRNCMP(p, "autoselectml", 12) == 0 && (p[12] == ',' || p[12] == NUL)) { new_autoselectml = TRUE; p += 12; } else if (STRNCMP(p, "html", 4) == 0 && (p[4] == ',' || p[4] == NUL)) { new_html = TRUE; p += 4; } else if (STRNCMP(p, "exclude:", 8) == 0 && new_exclude_prog == NULL) { p += 8; new_exclude_prog = vim_regcomp(p, RE_MAGIC); if (new_exclude_prog == NULL) errmsg = e_invalid_argument; break; } else { errmsg = e_invalid_argument; break; } if (*p == ',') ++p; } if (errmsg == NULL) { if (global_busy) // clip_unnamed will be reset to clip_unnamed_saved // at end_global_changes clip_unnamed_saved = new_unnamed; else clip_unnamed = new_unnamed; clip_autoselect_star = new_autoselect_star; clip_autoselect_plus = new_autoselect_plus; clip_autoselectml = new_autoselectml; clip_html = new_html; vim_regfree(clip_exclude_prog); clip_exclude_prog = new_exclude_prog; #ifdef FEAT_GUI_GTK if (gui.in_use) { gui_gtk_set_selection_targets((GdkAtom)GDK_SELECTION_PRIMARY); gui_gtk_set_selection_targets((GdkAtom)clip_plus.gtk_sel_atom); gui_gtk_set_dnd_targets(); } #endif } else vim_regfree(new_exclude_prog); return errmsg; } /* * Stuff for the X clipboard. Shared between VMS and Unix. */ #if defined(FEAT_XCLIPBOARD) || defined(FEAT_GUI_X11) || defined(PROTO) # include # include /* * Open the application context (if it hasn't been opened yet). * Used for Motif GUI and the xterm clipboard. */ void open_app_context(void) { if (app_context == NULL) { XtToolkitInitialize(); app_context = XtCreateApplicationContext(); } } static Atom vim_atom; // Vim's own special selection format static Atom vimenc_atom; // Vim's extended selection format static Atom utf8_atom; static Atom compound_text_atom; static Atom text_atom; static Atom targets_atom; static Atom timestamp_atom; // Used to get a timestamp void x11_setup_atoms(Display *dpy) { vim_atom = XInternAtom(dpy, VIM_ATOM_NAME, False); vimenc_atom = XInternAtom(dpy, VIMENC_ATOM_NAME,False); utf8_atom = XInternAtom(dpy, "UTF8_STRING", False); compound_text_atom = XInternAtom(dpy, "COMPOUND_TEXT", False); text_atom = XInternAtom(dpy, "TEXT", False); targets_atom = XInternAtom(dpy, "TARGETS", False); clip_star.sel_atom = XA_PRIMARY; clip_plus.sel_atom = XInternAtom(dpy, "CLIPBOARD", False); timestamp_atom = XInternAtom(dpy, "TIMESTAMP", False); } /* * X Selection stuff, for cutting and pasting text to other windows. */ static Boolean clip_x11_convert_selection_cb( Widget w UNUSED, Atom *sel_atom, Atom *target, Atom *type, XtPointer *value, long_u *length, int *format) { static char_u *save_result = NULL; static long_u save_length = 0; char_u *string; int motion_type; Clipboard_T *cbd; int i; if (*sel_atom == clip_plus.sel_atom) cbd = &clip_plus; else cbd = &clip_star; if (!cbd->owned) return False; // Shouldn't ever happen // requestor wants to know what target types we support if (*target == targets_atom) { static Atom array[7]; *value = (XtPointer)array; i = 0; array[i++] = targets_atom; array[i++] = vimenc_atom; array[i++] = vim_atom; if (enc_utf8) array[i++] = utf8_atom; array[i++] = XA_STRING; array[i++] = text_atom; array[i++] = compound_text_atom; *type = XA_ATOM; // This used to be: *format = sizeof(Atom) * 8; but that caused // crashes on 64 bit machines. (Peter Derr) *format = 32; *length = i; return True; } if ( *target != XA_STRING && *target != vimenc_atom && (*target != utf8_atom || !enc_utf8) && *target != vim_atom && *target != text_atom && *target != compound_text_atom) return False; clip_get_selection(cbd); motion_type = clip_convert_selection(&string, length, cbd); if (motion_type < 0) return False; // For our own format, the first byte contains the motion type if (*target == vim_atom) (*length)++; // Our own format with encoding: motion 'encoding' NUL text if (*target == vimenc_atom) *length += STRLEN(p_enc) + 2; if (save_length < *length || save_length / 2 >= *length) *value = XtRealloc((char *)save_result, (Cardinal)*length + 1); else *value = save_result; if (*value == NULL) { vim_free(string); return False; } save_result = (char_u *)*value; save_length = *length; if (*target == XA_STRING || (*target == utf8_atom && enc_utf8)) { mch_memmove(save_result, string, (size_t)(*length)); *type = *target; } else if (*target == compound_text_atom || *target == text_atom) { XTextProperty text_prop; char *string_nt = (char *)save_result; int conv_result; // create NUL terminated string which XmbTextListToTextProperty wants mch_memmove(string_nt, string, (size_t)*length); string_nt[*length] = NUL; conv_result = XmbTextListToTextProperty(X_DISPLAY, &string_nt, 1, XCompoundTextStyle, &text_prop); if (conv_result != Success) { vim_free(string); return False; } *value = (XtPointer)(text_prop.value); // from plain text *length = text_prop.nitems; *type = compound_text_atom; XtFree((char *)save_result); save_result = (char_u *)*value; save_length = *length; } else if (*target == vimenc_atom) { int l = STRLEN(p_enc); save_result[0] = motion_type; STRCPY(save_result + 1, p_enc); mch_memmove(save_result + l + 2, string, (size_t)(*length - l - 2)); *type = vimenc_atom; } else { save_result[0] = motion_type; mch_memmove(save_result + 1, string, (size_t)(*length - 1)); *type = vim_atom; } *format = 8; // 8 bits per char vim_free(string); return True; } static void clip_x11_lose_ownership_cb(Widget w UNUSED, Atom *sel_atom) { if (*sel_atom == clip_plus.sel_atom) clip_lose_selection(&clip_plus); else clip_lose_selection(&clip_star); } static void clip_x11_notify_cb(Widget w UNUSED, Atom *sel_atom UNUSED, Atom *target UNUSED) { // To prevent automatically freeing the selection value. } /* * Property callback to get a timestamp for XtOwnSelection. */ # if (defined(FEAT_X11) && defined(FEAT_XCLIPBOARD)) || defined(PROTO) static void clip_x11_timestamp_cb( Widget w, XtPointer n UNUSED, XEvent *event, Boolean *cont UNUSED) { Atom actual_type; int format; unsigned long nitems, bytes_after; unsigned char *prop=NULL; XPropertyEvent *xproperty=&event->xproperty; // Must be a property notify, state can't be Delete (True), has to be // one of the supported selection types. if (event->type != PropertyNotify || xproperty->state || (xproperty->atom != clip_star.sel_atom && xproperty->atom != clip_plus.sel_atom)) return; if (XGetWindowProperty(xproperty->display, xproperty->window, xproperty->atom, 0, 0, False, timestamp_atom, &actual_type, &format, &nitems, &bytes_after, &prop)) return; if (prop) XFree(prop); // Make sure the property type is "TIMESTAMP" and it's 32 bits. if (actual_type != timestamp_atom || format != 32) return; // Get the selection, using the event timestamp. if (XtOwnSelection(w, xproperty->atom, xproperty->time, clip_x11_convert_selection_cb, clip_x11_lose_ownership_cb, clip_x11_notify_cb) == OK) { // Set the "owned" flag now, there may have been a call to // lose_ownership_cb in between. if (xproperty->atom == clip_plus.sel_atom) clip_plus.owned = TRUE; else clip_star.owned = TRUE; } } void x11_setup_selection(Widget w) { XtAddEventHandler(w, PropertyChangeMask, False, /*(XtEventHandler)*/clip_x11_timestamp_cb, (XtPointer)NULL); } # endif static void clip_x11_request_selection_cb( Widget w UNUSED, XtPointer success, Atom *sel_atom, Atom *type, XtPointer value, long_u *length, int *format) { int motion_type = MAUTO; long_u len; char_u *p; char **text_list = NULL; Clipboard_T *cbd; char_u *tmpbuf = NULL; if (*sel_atom == clip_plus.sel_atom) cbd = &clip_plus; else cbd = &clip_star; if (value == NULL || *length == 0) { clip_free_selection(cbd); // nothing received, clear register *(int *)success = FALSE; return; } p = (char_u *)value; len = *length; if (*type == vim_atom) { motion_type = *p++; len--; } else if (*type == vimenc_atom) { char_u *enc; vimconv_T conv; int convlen; motion_type = *p++; --len; enc = p; p += STRLEN(p) + 1; len -= p - enc; // If the encoding of the text is different from 'encoding', attempt // converting it. conv.vc_type = CONV_NONE; convert_setup(&conv, enc, p_enc); if (conv.vc_type != CONV_NONE) { convlen = len; // Need to use an int here. tmpbuf = string_convert(&conv, p, &convlen); len = convlen; if (tmpbuf != NULL) p = tmpbuf; convert_setup(&conv, NULL, NULL); } } else if (*type == compound_text_atom || *type == utf8_atom || (enc_dbcs != 0 && *type == text_atom)) { XTextProperty text_prop; int n_text = 0; int status; text_prop.value = (unsigned char *)value; text_prop.encoding = *type; text_prop.format = *format; text_prop.nitems = len; #if defined(X_HAVE_UTF8_STRING) if (*type == utf8_atom) status = Xutf8TextPropertyToTextList(X_DISPLAY, &text_prop, &text_list, &n_text); else #endif status = XmbTextPropertyToTextList(X_DISPLAY, &text_prop, &text_list, &n_text); if (status != Success || n_text < 1) { *(int *)success = FALSE; return; } p = (char_u *)text_list[0]; len = STRLEN(p); } clip_yank_selection(motion_type, p, (long)len, cbd); if (text_list != NULL) XFreeStringList(text_list); vim_free(tmpbuf); XtFree((char *)value); *(int *)success = TRUE; } void clip_x11_request_selection( Widget myShell, Display *dpy, Clipboard_T *cbd) { XEvent event; Atom type; static int success; int i; time_t start_time; int timed_out = FALSE; for (i = 0; i < 6; i++) { switch (i) { case 0: type = vimenc_atom; break; case 1: type = vim_atom; break; case 2: type = utf8_atom; break; case 3: type = compound_text_atom; break; case 4: type = text_atom; break; default: type = XA_STRING; } if (type == utf8_atom # if defined(X_HAVE_UTF8_STRING) && !enc_utf8 # endif ) // Only request utf-8 when 'encoding' is utf8 and // Xutf8TextPropertyToTextList is available. continue; success = MAYBE; XtGetSelectionValue(myShell, cbd->sel_atom, type, clip_x11_request_selection_cb, (XtPointer)&success, CurrentTime); // Make sure the request for the selection goes out before waiting for // a response. XFlush(dpy); /* * Wait for result of selection request, otherwise if we type more * characters, then they will appear before the one that requested the * paste! Don't worry, we will catch up with any other events later. */ start_time = time(NULL); while (success == MAYBE) { if (XCheckTypedEvent(dpy, PropertyNotify, &event) || XCheckTypedEvent(dpy, SelectionNotify, &event) || XCheckTypedEvent(dpy, SelectionRequest, &event)) { // This is where clip_x11_request_selection_cb() should be // called. It may actually happen a bit later, so we loop // until "success" changes. // We may get a SelectionRequest here and if we don't handle // it we hang. KDE klipper does this, for example. // We need to handle a PropertyNotify for large selections. XtDispatchEvent(&event); continue; } // Time out after 2 to 3 seconds to avoid that we hang when the // other process doesn't respond. Note that the SelectionNotify // event may still come later when the selection owner comes back // to life and the text gets inserted unexpectedly. Don't know // why that happens or how to avoid that :-(. if (time(NULL) > start_time + 2) { timed_out = TRUE; break; } // Do we need this? Probably not. XSync(dpy, False); // Wait for 1 msec to avoid that we eat up all CPU time. ui_delay(1L, TRUE); } if (success == TRUE) return; // don't do a retry with another type after timing out, otherwise we // hang for 15 seconds. if (timed_out) break; } // Final fallback position - use the X CUT_BUFFER0 store yank_cut_buffer0(dpy, cbd); } void clip_x11_lose_selection(Widget myShell, Clipboard_T *cbd) { XtDisownSelection(myShell, cbd->sel_atom, XtLastTimestampProcessed(XtDisplay(myShell))); } int clip_x11_own_selection(Widget myShell, Clipboard_T *cbd) { // When using the GUI we have proper timestamps, use the one of the last // event. When in the console we don't get events (the terminal gets // them), Get the time by a zero-length append, clip_x11_timestamp_cb will // be called with the current timestamp. #ifdef FEAT_GUI if (gui.in_use) { if (XtOwnSelection(myShell, cbd->sel_atom, XtLastTimestampProcessed(XtDisplay(myShell)), clip_x11_convert_selection_cb, clip_x11_lose_ownership_cb, clip_x11_notify_cb) == False) return FAIL; } else #endif { if (!XChangeProperty(XtDisplay(myShell), XtWindow(myShell), cbd->sel_atom, timestamp_atom, 32, PropModeAppend, NULL, 0)) return FAIL; } // Flush is required in a terminal as nothing else is doing it. XFlush(XtDisplay(myShell)); return OK; } /* * Send the current selection to the clipboard. Do nothing for X because we * will fill in the selection only when requested by another app. */ void clip_x11_set_selection(Clipboard_T *cbd UNUSED) { } #endif #if defined(FEAT_XCLIPBOARD) || defined(FEAT_GUI_X11) \ || defined(FEAT_GUI_GTK) || defined(PROTO) /* * Get the contents of the X CUT_BUFFER0 and put it in "cbd". */ void yank_cut_buffer0(Display *dpy, Clipboard_T *cbd) { int nbytes = 0; char_u *buffer = (char_u *)XFetchBuffer(dpy, &nbytes, 0); if (nbytes > 0) { int done = FALSE; // CUT_BUFFER0 is supposed to be always latin1. Convert to 'enc' when // using a multi-byte encoding. Conversion between two 8-bit // character sets usually fails and the text might actually be in // 'enc' anyway. if (has_mbyte) { char_u *conv_buf; vimconv_T vc; vc.vc_type = CONV_NONE; if (convert_setup(&vc, (char_u *)"latin1", p_enc) == OK) { conv_buf = string_convert(&vc, buffer, &nbytes); if (conv_buf != NULL) { clip_yank_selection(MCHAR, conv_buf, (long)nbytes, cbd); vim_free(conv_buf); done = TRUE; } convert_setup(&vc, NULL, NULL); } } if (!done) // use the text without conversion clip_yank_selection(MCHAR, buffer, (long)nbytes, cbd); XFree((void *)buffer); if (p_verbose > 0) { verbose_enter(); verb_msg(_("Used CUT_BUFFER0 instead of empty selection")); verbose_leave(); } } } #endif /* * SELECTION / PRIMARY ('*') * * Text selection stuff that uses the GUI selection register '*'. When using a * GUI this may be text from another window, otherwise it is the last text we * had highlighted with VIsual mode. With mouse support, clicking the middle * button performs the paste, otherwise you will need to do <"*p>. " * If not under X, it is synonymous with the clipboard register '+'. * * X CLIPBOARD ('+') * * Text selection stuff that uses the GUI clipboard register '+'. * Under X, this matches the standard cut/paste buffer CLIPBOARD selection. * It will be used for unnamed cut/pasting is 'clipboard' contains "unnamed", * otherwise you will need to do <"+p>. " * If not under X, it is synonymous with the selection register '*'. */ /* * Routine to export any final X selection we had to the environment * so that the text is still available after Vim has exited. X selections * only exist while the owning application exists, so we write to the * permanent (while X runs) store CUT_BUFFER0. * Dump the CLIPBOARD selection if we own it (it's logically the more * 'permanent' of the two), otherwise the PRIMARY one. * For now, use a hard-coded sanity limit of 1Mb of data. */ #if (defined(FEAT_X11) && defined(FEAT_CLIPBOARD)) || defined(PROTO) void x11_export_final_selection(void) { Display *dpy; char_u *str = NULL; long_u len = 0; int motion_type = -1; # ifdef FEAT_GUI if (gui.in_use) dpy = X_DISPLAY; else # endif # ifdef FEAT_XCLIPBOARD dpy = xterm_dpy; # else return; # endif // Get selection to export if (clip_plus.owned) motion_type = clip_convert_selection(&str, &len, &clip_plus); else if (clip_star.owned) motion_type = clip_convert_selection(&str, &len, &clip_star); // Check it's OK if (dpy != NULL && str != NULL && motion_type >= 0 && len < 1024*1024 && len > 0) { int ok = TRUE; // The CUT_BUFFER0 is supposed to always contain latin1. Convert from // 'enc' when it is a multi-byte encoding. When 'enc' is an 8-bit // encoding conversion usually doesn't work, so keep the text as-is. if (has_mbyte) { vimconv_T vc; vc.vc_type = CONV_NONE; if (convert_setup(&vc, p_enc, (char_u *)"latin1") == OK) { int intlen = len; char_u *conv_str; vc.vc_fail = TRUE; conv_str = string_convert(&vc, str, &intlen); len = intlen; if (conv_str != NULL) { vim_free(str); str = conv_str; } else { ok = FALSE; } convert_setup(&vc, NULL, NULL); } else { ok = FALSE; } } // Do not store the string if conversion failed. Better to use any // other selection than garbled text. if (ok) { XStoreBuffer(dpy, (char *)str, (int)len, 0); XFlush(dpy); } } vim_free(str); } #endif void clip_free_selection(Clipboard_T *cbd) { yankreg_T *y_ptr = get_y_current(); if (cbd == &clip_plus) set_y_current(get_y_register(PLUS_REGISTER)); else set_y_current(get_y_register(STAR_REGISTER)); free_yank_all(); get_y_current()->y_size = 0; set_y_current(y_ptr); } /* * Get the selected text and put it in register '*' or '+'. */ void clip_get_selection(Clipboard_T *cbd) { yankreg_T *old_y_previous, *old_y_current; pos_T old_cursor; pos_T old_visual; int old_visual_mode; colnr_T old_curswant; int old_set_curswant; pos_T old_op_start, old_op_end; oparg_T oa; cmdarg_T ca; if (cbd->owned) { if ((cbd == &clip_plus && get_y_register(PLUS_REGISTER)->y_array != NULL) || (cbd == &clip_star && get_y_register(STAR_REGISTER)->y_array != NULL)) return; // Avoid triggering autocmds such as TextYankPost. block_autocmds(); // Get the text between clip_star.start & clip_star.end old_y_previous = get_y_previous(); old_y_current = get_y_current(); old_cursor = curwin->w_cursor; old_curswant = curwin->w_curswant; old_set_curswant = curwin->w_set_curswant; old_op_start = curbuf->b_op_start; old_op_end = curbuf->b_op_end; old_visual = VIsual; old_visual_mode = VIsual_mode; clear_oparg(&oa); oa.regname = (cbd == &clip_plus ? '+' : '*'); oa.op_type = OP_YANK; CLEAR_FIELD(ca); ca.oap = &oa; ca.cmdchar = 'y'; ca.count1 = 1; ca.retval = CA_NO_ADJ_OP_END; do_pending_operator(&ca, 0, TRUE); // restore things set_y_previous(old_y_previous); set_y_current(old_y_current); curwin->w_cursor = old_cursor; changed_cline_bef_curs(); // need to update w_virtcol et al curwin->w_curswant = old_curswant; curwin->w_set_curswant = old_set_curswant; curbuf->b_op_start = old_op_start; curbuf->b_op_end = old_op_end; VIsual = old_visual; VIsual_mode = old_visual_mode; unblock_autocmds(); } else if (!is_clipboard_needs_update()) { clip_free_selection(cbd); // Try to get selected text from another window clip_gen_request_selection(cbd); } } /* * Convert from the GUI selection string into the '*'/'+' register. */ void clip_yank_selection( int type, char_u *str, long len, Clipboard_T *cbd) { yankreg_T *y_ptr; if (cbd == &clip_plus) y_ptr = get_y_register(PLUS_REGISTER); else y_ptr = get_y_register(STAR_REGISTER); clip_free_selection(cbd); str_to_reg(y_ptr, type, str, len, -1, FALSE); } static int clip_convert_selection_offset( char_u **str, long_u *len, int offset, // Extra space to add in *str and the offset to // place the actual string in *str. Clipboard_T *cbd) { char_u *p; int lnum; int i, j; int_u eolsize; yankreg_T *y_ptr; if (cbd == &clip_plus) y_ptr = get_y_register(PLUS_REGISTER); else y_ptr = get_y_register(STAR_REGISTER); # ifdef USE_CRNL eolsize = 2; # else eolsize = 1; # endif *str = NULL; *len = 0; if (y_ptr->y_array == NULL) return -1; for (i = 0; i < y_ptr->y_size; i++) *len += (long_u)y_ptr->y_array[i].length + eolsize; // Don't want newline character at end of last line if we're in MCHAR mode. if (y_ptr->y_type == MCHAR && *len >= eolsize) *len -= eolsize; *len += offset; p = *str = alloc(*len + 1); // add one to avoid zero if (p == NULL) return -1; p += offset; lnum = 0; for (i = 0, j = 0; i < (int)*len - offset; i++, j++) { if (y_ptr->y_array[lnum].string[j] == '\n') p[i] = NUL; else if (y_ptr->y_array[lnum].string[j] == NUL) { # ifdef USE_CRNL p[i++] = '\r'; # endif p[i] = '\n'; lnum++; j = -1; } else p[i] = y_ptr->y_array[lnum].string[j]; } return y_ptr->y_type; } /* * Convert the '*'/'+' register into a GUI selection string returned in *str * with length *len. * Returns the motion type, or -1 for failure. */ int clip_convert_selection(char_u **str, long_u *len, Clipboard_T *cbd) { return clip_convert_selection_offset(str, len, 0, cbd); } /* * When "regname" is a clipboard register, obtain the selection. If it's not * available return zero, otherwise return "regname". */ int may_get_selection(int regname) { if (regname == '*') { if (!clip_star.available) regname = 0; else clip_get_selection(&clip_star); } else if (regname == '+') { if (!clip_plus.available) regname = 0; else clip_get_selection(&clip_plus); } return regname; } /* * If we have written to a clipboard register, send the text to the clipboard. */ void may_set_selection(void) { if ((get_y_current() == get_y_register(STAR_REGISTER)) && clip_star.available) { clip_own_selection(&clip_star); clip_gen_set_selection(&clip_star); } else if ((get_y_current() == get_y_register(PLUS_REGISTER)) && clip_plus.available) { clip_own_selection(&clip_plus); clip_gen_set_selection(&clip_plus); } } /* * Adjust the register name pointed to with "rp" for the clipboard being * used always and the clipboard being available. */ void adjust_clip_reg(int *rp) { // If no reg. specified, and "unnamed" or "unnamedplus" is in 'clipboard', // use '*' or '+' reg, respectively. "unnamedplus" prevails. if (*rp == 0 && (clip_unnamed != 0 || clip_unnamed_saved != 0)) { if (clip_unnamed != 0) *rp = ((clip_unnamed & CLIP_UNNAMED_PLUS) && clip_plus.available) ? '+' : '*'; else *rp = ((clip_unnamed_saved & CLIP_UNNAMED_PLUS) && clip_plus.available) ? '+' : '*'; } if ((!clip_star.available && *rp == '*') || (!clip_plus.available && *rp == '+')) { msg_warn_missing_clipboard(!clip_plus.available, !clip_star.available); *rp = 0; } } #if defined(FEAT_WAYLAND_CLIPBOARD) static clip_wl_selection_T * clip_wl_get_selection(wayland_selection_T sel) { switch (sel) { case WAYLAND_SELECTION_REGULAR: return &clip_wl.regular; case WAYLAND_SELECTION_PRIMARY: return &clip_wl.primary; default: return NULL; } } static clip_wl_selection_T * clip_wl_get_selection_from_cbd(Clipboard_T *cbd) { if (cbd == &clip_plus) return &clip_wl.regular; else if (cbd == &clip_star) return &clip_wl.primary; else return NULL; } static Clipboard_T * clip_wl_get_cbd_from_selection(clip_wl_selection_T *sel) { if (sel == &clip_wl.regular) return &clip_plus; else if (sel == &clip_wl.primary) return &clip_star; else return NULL; } static wayland_selection_T clip_wl_get_selection_type(clip_wl_selection_T *sel) { if (sel == &clip_wl.regular) return WAYLAND_SELECTION_REGULAR; else if (sel == &clip_wl.primary) return WAYLAND_SELECTION_PRIMARY; else return WAYLAND_SELECTION_NONE; } #ifdef FEAT_WAYLAND_CLIPBOARD_FS /* * If globals required for focus stealing method are available. */ static bool clip_wl_focus_stealing_available(void) { return wayland_ct->gobjects.wl_compositor != NULL && wayland_ct->gobjects.wl_shm != NULL && wayland_ct->gobjects.xdg_wm_base != NULL; } /* * Called when compositor isn't using the buffer anymore, we can reuse it * again. */ static void wl_buffer_listener_release( void *data, struct wl_buffer *buffer UNUSED) { clip_wl_buffer_store_T *store = data; store->available = true; } static struct wl_buffer_listener wl_buffer_listener = { .release = wl_buffer_listener_release }; /* * Destroy a buffer store structure. */ static void clip_wl_destroy_buffer_store(clip_wl_buffer_store_T *store) { if (store == NULL) return; if (store->buffer != NULL) wl_buffer_destroy(store->buffer); if (store->pool != NULL) wl_shm_pool_destroy(store->pool); close(store->fd); vim_free(store); } /* * Initialize a buffer and its backing memory pool. */ static clip_wl_buffer_store_T * clip_wl_init_buffer_store(int width, int height) { int fd, r; clip_wl_buffer_store_T *store; store = alloc(sizeof(*store)); if (store == NULL) return NULL; store->available = false; store->width = width; store->height = height; store->stride = store->width * 4; store->size = store->stride * store->height; fd = mch_create_anon_file(); r = ftruncate(fd, store->size); if (r == -1) { if (fd >= 0) close(fd); return NULL; } store->pool = wl_shm_create_pool( wayland_ct->gobjects.wl_shm, fd, store->size); store->buffer = wl_shm_pool_create_buffer( store->pool, 0, store->width, store->height, store->stride, WL_SHM_FORMAT_ARGB8888); store->fd = fd; wl_buffer_add_listener(store->buffer, &wl_buffer_listener, store); if (vwl_connection_roundtrip(wayland_ct) == FAIL) { clip_wl_destroy_buffer_store(store); return NULL; } store->available = true; return store; } /* * Configure xdg_surface */ static void xdg_surface_listener_configure( void *data UNUSED, struct xdg_surface *surface, uint32_t serial) { xdg_surface_ack_configure(surface, serial); } static struct xdg_surface_listener xdg_surface_listener = { .configure = xdg_surface_listener_configure }; /* * Destroy a focus stealing structure. */ static void clip_wl_destroy_fs_surface(clip_wl_fs_surface_T *store) { if (store == NULL) return; if (store->shell.toplevel != NULL) xdg_toplevel_destroy(store->shell.toplevel); if (store->shell.surface != NULL) xdg_surface_destroy(store->shell.surface); if (store->surface != NULL) wl_surface_destroy(store->surface); if (store->keyboard != NULL) { if (wl_keyboard_get_version(store->keyboard) >= 3) wl_keyboard_release(store->keyboard); else wl_keyboard_destroy(store->keyboard); } vim_free(store); } VWL_FUNCS_DUMMY_KEYBOARD_EVENTS() /* * Called when the keyboard focus is on our surface */ static void clip_wl_fs_keyboard_listener_enter( void *data, struct wl_keyboard *keyboard UNUSED, uint32_t serial, struct wl_surface *surface UNUSED, struct wl_array *keys UNUSED) { clip_wl_fs_surface_T *store = data; store->got_focus = true; if (store->on_focus != NULL) store->on_focus(store->user_data, serial); } static struct wl_keyboard_listener vwl_fs_keyboard_listener = { .enter = clip_wl_fs_keyboard_listener_enter, .key = clip_wl_fs_keyboard_listener_key, .keymap = clip_wl_fs_keyboard_listener_keymap, .leave = clip_wl_fs_keyboard_listener_leave, .modifiers = clip_wl_fs_keyboard_listener_modifiers, .repeat_info = clip_wl_fs_keyboard_listener_repeat_info }; /* * Create an invisible surface in order to gain focus and call on_focus() with * serial that was given. */ static int clip_wl_init_fs_surface( vwl_seat_T *seat, clip_wl_buffer_store_T *buffer_store, void (*on_focus)(void *, uint32_t), void *user_data) { clip_wl_fs_surface_T *store; #ifdef ELAPSED_FUNC elapsed_T start_tv; #endif if (wayland_ct->gobjects.wl_compositor == NULL || wayland_ct->gobjects.xdg_wm_base == NULL || buffer_store == NULL || seat == NULL) return FAIL; store = ALLOC_CLEAR_ONE(clip_wl_fs_surface_T); if (store == NULL) return FAIL; // Get keyboard store->keyboard = vwl_seat_get_keyboard(seat); if (store->keyboard == NULL) goto fail; wl_keyboard_add_listener(store->keyboard, &vwl_fs_keyboard_listener, store); if (vwl_connection_dispatch(wayland_ct) < 0) goto fail; store->surface = wl_compositor_create_surface( wayland_ct->gobjects.wl_compositor); store->shell.surface = xdg_wm_base_get_xdg_surface( wayland_ct->gobjects.xdg_wm_base, store->surface); store->shell.toplevel = xdg_surface_get_toplevel(store->shell.surface); xdg_toplevel_set_title(store->shell.toplevel, "Vim clipboard"); xdg_surface_add_listener(store->shell.surface, &xdg_surface_listener, NULL); wl_surface_commit(store->surface); store->on_focus = on_focus; store->user_data = user_data; store->got_focus = FALSE; if (vwl_connection_roundtrip(wayland_ct) == FAIL) goto fail; // We may get the enter event early, if we do then we will set `got_focus` // to TRUE. if (store->got_focus) goto early_exit; // Buffer hasn't been released yet, abort. This shouldn't happen but still // check for it. if (!buffer_store->available) goto fail; buffer_store->available = false; wl_surface_attach(store->surface, buffer_store->buffer, 0, 0); wl_surface_damage(store->surface, 0, 0, buffer_store->width, buffer_store->height); wl_surface_commit(store->surface); // Dispatch events until we receive the enter event. Add a max delay of // 'p_wtm' when waiting for it (may be longer depending on how long we poll // when dispatching events) #ifdef ELAPSED_FUNC ELAPSED_INIT(start_tv); #endif while (vwl_connection_dispatch(wayland_ct) >= 0) { if (store->got_focus) break; #ifdef ELAPSED_FUNC if (ELAPSED_FUNC(start_tv) >= p_wtm) goto fail; #endif } early_exit: clip_wl_destroy_fs_surface(store); vwl_connection_flush(wayland_ct); return OK; fail: clip_wl_destroy_fs_surface(store); vwl_connection_flush(wayland_ct); return FAIL; } #endif // FEAT_WAYLAND_CLIPBOARD_FS static bool wl_data_offer_listener_event_offer( void *data UNUSED, vwl_data_offer_T *offer UNUSED, const char *mime_type ) { // Only accept mime type if we support it for (int i = 0; i < (int)ARRAY_LENGTH(supported_mimes); i++) if (STRCMP(mime_type, supported_mimes[i]) == 0) return true; return FALSE; } static const vwl_data_offer_listener_T vwl_data_offer_listener = { .offer = wl_data_offer_listener_event_offer }; static void vwl_data_device_listener_event_data_offer( void *data UNUSED, vwl_data_device_T *device UNUSED, vwl_data_offer_T *offer) { // Immediately start listening for offer events from the data offer vwl_data_offer_add_listener(offer, &vwl_data_offer_listener, NULL); } static void vwl_data_device_listener_event_selection( void *data UNUSED, vwl_data_device_T *device UNUSED, vwl_data_offer_T *offer, wayland_selection_T selection) { clip_wl_selection_T *sel = clip_wl_get_selection(selection); // Destroy previous offer if any, it is now invalid vwl_data_offer_destroy(sel->offer); // There are two cases when sel->offer is NULL // 1. No one owns the selection // 2. We own the selection (we'll just access the register directly) if (offer == NULL || offer->from_vim) { // Selection event is from us, so we are the source client. Therefore // ignore it. Or the selection is cleared, so set sel->offer to NULL vwl_data_offer_destroy(offer); sel->offer = NULL; return; } // Save offer. When we want to request data, then we'll actually call the // receive method. sel->offer = offer; } static void vwl_data_device_listener_event_finished( void *data UNUSED, vwl_data_device_T *device) { clip_wl_selection_T *sel; // Device finished, guessing this can happen is when the seat becomes // invalid? If so, let the user call :wlrestore! to reset. There wouldn't be // any point in trying to create another data device for the same seat, // since the seat is in an invalid state. if (device == clip_wl.regular.device) { sel = &clip_wl.regular; clip_wl.regular.device = NULL; } else if (device == clip_wl.primary.device) { sel = &clip_wl.primary; clip_wl.primary.device = NULL; } else // Shouldn't happen return; vim_free(sel->contents); vwl_data_source_destroy(sel->source); vwl_data_offer_destroy(sel->offer); sel->available = FALSE; vwl_data_device_destroy(device); } static const vwl_data_device_listener_T vwl_data_device_listener = { .data_offer = vwl_data_device_listener_event_data_offer, .selection = vwl_data_device_listener_event_selection, .finished = vwl_data_device_listener_event_finished }; /* * Initialize the clipboard for Wayland using the global Wayland connection. * Returns OK on success and FAIL on failure. */ int clip_init_wayland(void) { int_u supported = WAYLAND_SELECTION_NONE; if (wayland_ct == NULL) return FAIL; clip_wl.seat = vwl_connection_get_seat(wayland_ct, (char *)p_wse); if (clip_wl.seat == NULL) return FAIL; clip_wl.regular.manager = vwl_connection_get_data_device_manager( wayland_ct, WAYLAND_SELECTION_REGULAR, &supported); if (clip_wl.regular.manager != NULL) { clip_wl.regular.device = vwl_data_device_manager_get_data_device( clip_wl.regular.manager, clip_wl.seat); if (clip_wl.regular.device != NULL) clip_wl.regular.available = true; else { vwl_data_device_manager_discard(clip_wl.regular.manager); clip_wl.regular.manager = NULL; } } // If we still don't support the primary selection, find one for it // specifically. if (!(supported & WAYLAND_SELECTION_PRIMARY)) { clip_wl.primary.manager = vwl_connection_get_data_device_manager( wayland_ct, WAYLAND_SELECTION_PRIMARY, &supported); if (clip_wl.primary.manager != NULL) { clip_wl.primary.device = vwl_data_device_manager_get_data_device( clip_wl.primary.manager, clip_wl.seat); if (clip_wl.primary.device != NULL) clip_wl.primary.available = true; else { vwl_data_device_manager_discard(clip_wl.primary.manager); clip_wl.primary.manager = NULL; } } } else if (clip_wl.regular.available) { // The protocol supports both regular and primary selections, just use // one data device manager and one data device. clip_wl.primary.available = true; clip_wl.primary.manager = clip_wl.regular.manager; clip_wl.primary.device = clip_wl.regular.device; } #ifdef FEAT_WAYLAND_CLIPBOARD_FS if (clip_wl.regular.available && clip_wl.regular.manager->protocol == VWL_DATA_PROTOCOL_CORE && clip_wl_focus_stealing_available()) clip_wl.regular.requires_focus = true; if (clip_wl.primary.available && clip_wl.primary.manager->protocol == VWL_DATA_PROTOCOL_PRIMARY && clip_wl_focus_stealing_available()) clip_wl.primary.requires_focus = true; if (clip_wl.regular.requires_focus || clip_wl.primary.requires_focus) { // Initialize buffer to use for focus stealing clip_wl.fs_buffer = clip_wl_init_buffer_store(1, 1); } #endif if (!clip_wl.regular.available && !clip_wl.primary.available) return FAIL; // Start listening for selection updates if (clip_wl.regular.device != NULL) vwl_data_device_add_listener(clip_wl.regular.device, &vwl_data_device_listener, NULL); // Don't want to listen to the same data device twice if (clip_wl.primary.device != NULL && clip_wl.primary.device != clip_wl.regular.device) vwl_data_device_add_listener(clip_wl.primary.device, &vwl_data_device_listener, NULL); return OK; } void clip_uninit_wayland(void) { clip_wl_selection_T *sel; if (clipmethod == CLIPMETHOD_WAYLAND) { if (clip_star.owned) clip_lose_selection(&clip_star); if (clip_plus.owned) clip_lose_selection(&clip_plus); } #ifdef FEAT_WAYLAND_CLIPBOARD_FS clip_wl_destroy_buffer_store(clip_wl.fs_buffer); #endif // Don't want to double free if (clip_wl.regular.manager != clip_wl.primary.manager) vwl_data_device_manager_discard(clip_wl.primary.manager); vwl_data_device_manager_discard(clip_wl.regular.manager); if (clip_wl.regular.device != clip_wl.primary.device) vwl_data_device_destroy(clip_wl.primary.device); vwl_data_device_destroy(clip_wl.regular.device); sel = &clip_wl.regular; while (true) { vim_free(sel->contents); vwl_data_source_destroy(sel->source); vwl_data_offer_destroy(sel->offer); sel->available = false; if (sel == &clip_wl.primary) break; sel = &clip_wl.primary; } vim_memset(&clip_wl, 0, sizeof(clip_wl)); } int clip_reset_wayland(void) { wayland_uninit_connection(); if (wayland_init_connection(wayland_display_name) == FAIL || clip_init_wayland() == FAIL) return FAIL; choose_clipmethod(); return OK; } /* * Read data from a file descriptor and write it to the given clipboard. */ static void clip_wl_receive_data(Clipboard_T *cbd, const char *mime_type, int fd) { char_u *start, *final, *enc; garray_T buf; int motion_type = MAUTO; ssize_t r = 0; #ifndef HAVE_SELECT struct pollfd pfd; pfd.fd = fd; pfd.events = POLLIN; #else fd_set rfds; struct timeval tv; FD_ZERO(&rfds); FD_SET(fd, &rfds); #endif // Make pipe (read end) non-blocking if (fcntl(fd, F_SETFL, fcntl(fd, F_GETFL) | O_NONBLOCK) == -1) return; ga_init2(&buf, 1, 4096); // 4096 bytes seems reasonable for initial buffer size, memory is cheap // anyways. if (ga_grow(&buf, 4096) == FAIL) return; start = buf.ga_data; #ifndef HAVE_SELECT while (poll(&pfd, 1, p_wtm) > 0) #else while (tv.tv_sec = p_wtm / 1000, tv.tv_usec = (p_wtm % 1000) * 1000, select(fd + 1, &rfds, NULL, NULL, &tv) > 0) #endif { r = read(fd, start, buf.ga_maxlen - 1 - buf.ga_len); if (r == 0) break; else if (r < 0) { if (errno == EAGAIN || errno == EINTR) continue; break; } start += r; buf.ga_len += r; // Realloc if we are at the end of the buffer if (buf.ga_len >= buf.ga_maxlen - 1) { if (ga_grow(&buf, 8192) == FAIL) break; start = (char_u *)buf.ga_data + buf.ga_len; } } if (buf.ga_len == 0) { clip_free_selection(cbd); // Nothing received, clear register ga_clear(&buf); return; } final = buf.ga_data; if (STRCMP(mime_type, VIM_ATOM_NAME) == 0 && buf.ga_len >= 2) { motion_type = *final++;; buf.ga_len--; } else if (STRCMP(mime_type, VIMENC_ATOM_NAME) == 0 && buf.ga_len >= 3) { vimconv_T conv; int convlen; // first byte is motion type motion_type = *final++; buf.ga_len--; // Get encoding of selection enc = final; // Skip the encoding type including null terminator in final text final += STRLEN(final) + 1; // Subtract pointers to get length of encoding; buf.ga_len -= final - enc; conv.vc_type = CONV_NONE; convert_setup(&conv, enc, p_enc); if (conv.vc_type != CONV_NONE) { char_u *tmp; convlen = buf.ga_len; tmp = string_convert(&conv, final, &convlen); buf.ga_len = convlen; if (tmp != NULL) final = tmp; convert_setup(&conv, NULL, NULL); } } clip_yank_selection(motion_type, final, (long)buf.ga_len, cbd); ga_clear(&buf); } /* * Get the current selection and fill the respective register for cbd with the * data. */ static void clip_wl_request_selection(Clipboard_T *cbd) { clip_wl_selection_T *sel = clip_wl_get_selection_from_cbd(cbd); int fds[2]; int mime_types_len; const char **mime_types; const char *chosen_mime = NULL; if (!sel->available) goto clear; #ifdef FEAT_WAYLAND_CLIPBOARD_FS if (sel->requires_focus) { // We don't care about the on_focus callback since once we gain // focus the data offer events will come immediately. if (clip_wl_init_fs_surface(clip_wl.seat, clip_wl.fs_buffer, NULL, NULL) == FAIL) goto clear; } else #endif { // Dispatch any events that still queued up before checking for a data // offer. if (vwl_connection_roundtrip(wayland_ct) == FAIL) goto clear; } if (sel->offer == NULL) goto clear; mime_types_len = sel->offer->mime_types.ga_len; mime_types = sel->offer->mime_types.ga_data; // Choose mime type to receive from. Mime types with a lower index in the // "supported_mimes" array are prioritized over ones after it. for (int i = 0; i < (int)ARRAY_LENGTH(supported_mimes) && chosen_mime == NULL; i++) { for (int k = 0; k < mime_types_len && chosen_mime == NULL; k++) if (STRCMP(mime_types[k], supported_mimes[i]) == 0) chosen_mime = supported_mimes[i]; } if (chosen_mime == NULL || pipe(fds) == -1) goto clear; vwl_data_offer_receive(sel->offer, chosen_mime, fds[1]); close(fds[1]); // Close before we read data so that when the source client // closes their end we receive an EOF. if (vwl_connection_flush(wayland_ct) >= 0) clip_wl_receive_data(cbd, chosen_mime, fds[0]); close(fds[0]); return; clear: clip_free_selection(cbd); } static void vwl_data_source_listener_event_send( void *data, vwl_data_source_T *source UNUSED, const char *mime_type, int32_t fd ) { clip_wl_selection_T *sel = data; Clipboard_T *cbd = clip_wl_get_cbd_from_selection(sel); bool have_mime = false; int motion_type; long_u length; char_u *string; // Will be reallocated to a bigger size if // needed. int offset = 0; bool is_vim, is_vimenc; size_t total = 0; #ifndef HAVE_SELECT struct pollfd pfd; pfd.fd = fd; pfd.events = POLLOUT; #else fd_set wfds; struct timeval tv; FD_ZERO(&wfds); FD_SET(fd, &wfds); #endif // Check if we actually have mime type for (int i = 0; i < (int)ARRAY_LENGTH(supported_mimes); i++) if (STRCMP(supported_mimes[i], mime_type) == 0) { have_mime = true; break; } if (!have_mime) goto exit; // First byte sent is motion type for vim specific formats. For the vimenc // format, after the first byte is the encoding type, which is null // terminated. is_vimenc = STRCMP(mime_type, VIMENC_ATOM_NAME) == 0; is_vim = STRCMP(mime_type, VIM_ATOM_NAME) == 0; if (is_vimenc) offset += 2 + STRLEN(p_enc); else if (is_vim) offset += 1; clip_get_selection(cbd); motion_type = clip_convert_selection_offset(&string, &length, offset, cbd); if (motion_type < 0) goto exit; if (is_vimenc) { string[0] = (char_u)motion_type; // strcpy copies the NUL terminator too strcpy((char *)string + 1, (char *)p_enc); } else if (is_vim) string[0] = (char_u)motion_type; while (total < (size_t)length && #ifndef HAVE_SELECT poll(&pfd, 1, p_wtm) > 0) #else ((tv.tv_sec = p_wtm / 1000, tv.tv_usec = (p_wtm % 1000) * 1000), select(fd + 1, NULL, &wfds, NULL, &tv) > 0)) #endif { ssize_t w = write(fd, string + total, length - total); if (w == -1) break; total += w; } vim_free(string); exit: close(fd); } static void vwl_data_source_listener_event_cancelled( void *data, vwl_data_source_T *source UNUSED) { clip_wl_selection_T *sel = data; Clipboard_T *cbd = clip_wl_get_cbd_from_selection(sel); clip_lose_selection(cbd); } static const vwl_data_source_listener_T vwl_data_source_listener = { .send = vwl_data_source_listener_event_send, .cancelled = vwl_data_source_listener_event_cancelled }; static void clip_wl_do_set_selection(void *data, uint32_t serial) { clip_wl_selection_T *sel = data; wayland_selection_T sel_type = clip_wl_get_selection_type(sel); vwl_data_device_set_selection(sel->device, sel->source, serial, sel_type); sel->own_success = (vwl_connection_roundtrip(wayland_ct) == OK); } /* * Own the selection that cbd corresponds to. Start listening for requests from * other Wayland clients so they can receive data from us. Returns OK on success * and FAIL on failure. */ static int clip_wl_own_selection(Clipboard_T *cbd) { clip_wl_selection_T *sel = clip_wl_get_selection_from_cbd(cbd); wayland_selection_T sel_type = clip_wl_get_selection_type(sel); if (!sel->available || vwl_connection_roundtrip(wayland_ct) == FAIL) return FAIL; if (sel->source != NULL) { if (sel_type == WAYLAND_SELECTION_PRIMARY) // We already own the selection, ignore (only do this for primary // selection). We don't re set the selection because then we would // be setting the selection every time the user moves the visual // selection cursor, which is messy and inefficient. Some // applications like Google Chrome do it this way however. return OK; else if (sel_type == WAYLAND_SELECTION_REGULAR) { // Technically we don't need to do this as we already own the // selection, however if a user yanks text a second time, the // text yanked won't appear in their clipboard manager if they are // using one. // // This can be unexpected behaviour for the user so its probably // better to do it this way. Additionally other Wayland applications // seem to set the selection every time. vwl_data_source_destroy(sel->source); } else // Shouldn't happen return FAIL; } sel->source = vwl_data_device_manager_create_data_source(sel->manager); vwl_data_source_add_listener(sel->source, &vwl_data_source_listener, sel); // Advertise mime types vwl_data_source_offer(sel->source, wayland_vim_special_mime); for (int i = 0; i < (int)ARRAY_LENGTH(supported_mimes); i++) vwl_data_source_offer(sel->source, supported_mimes[i]); sel->own_success = false; #ifdef FEAT_WAYLAND_CLIPBOARD_FS if (sel->requires_focus) { if (clip_wl_init_fs_surface(clip_wl.seat, clip_wl.fs_buffer, clip_wl_do_set_selection, sel) == FAIL) goto fail; } else #endif clip_wl_do_set_selection(sel, 0); if (!sel->own_success) goto fail; return OK; fail: vwl_data_source_destroy(sel->source); sel->source = NULL; return FAIL; } /* * Disown the selection that cbd corresponds to. */ static void clip_wl_lose_selection(Clipboard_T *cbd) { clip_wl_selection_T *sel = clip_wl_get_selection_from_cbd(cbd); if (!sel->available) return; vwl_data_source_destroy(sel->source); sel->source = NULL; } /* * Send the current selection to the clipboard. Do nothing for Wayland because * we will fill in the selection only when requested by another client. */ static void clip_wl_set_selection(Clipboard_T *cbd UNUSED) { } #if defined(USE_SYSTEM) || defined(PROTO) /* * Return true if we own the selection corresponding to cbd or another client * does. */ static bool clip_wl_owner_exists(Clipboard_T *cbd) { clip_wl_selection_T *sel = clip_wl_get_selection_from_cbd(cbd); if (vwl_connection_roundtrip(wayland_ct) == FAIL) return false; return sel->available && (sel->source != NULL || sel->offer != NULL); } #endif #endif // FEAT_WAYLAND_CLIPBOARD /* * Returns the first method for accessing the clipboard that is available/works, * depending on the order of values in str. */ static clipmethod_T get_clipmethod(char_u *str, bool *regular, bool *primary) { int len = (int)STRLEN(str) + 1; char_u *buf = alloc(len); if (buf == NULL) return CLIPMETHOD_FAIL; clipmethod_T ret = CLIPMETHOD_FAIL; char_u *p = str; while (*p != NUL) { clipmethod_T method = CLIPMETHOD_NONE; (void)copy_option_part(&p, buf, len, ","); if (STRCMP(buf, "wayland") == 0) { #ifdef FEAT_GUI if (!gui.in_use) #endif { #ifdef FEAT_WAYLAND_CLIPBOARD if (clip_wl.regular.available || clip_wl.primary.available) { method = CLIPMETHOD_WAYLAND; *regular = clip_wl.regular.available; *primary = clip_wl.primary.available; } #endif } } else if (STRCMP(buf, "x11") == 0) { #ifdef FEAT_GUI if (!gui.in_use) #endif { #ifdef FEAT_XCLIPBOARD // x_IOerror_handler() in os_unix.c should set xterm_dpy to NULL // if we lost connection to the X server. if (xterm_dpy != NULL) { // If the X connection is lost then that handler will // longjmp somewhere else, in that case we will call // choose_clipmethod() again from there, and this if block // won't be executed since xterm_dpy will be set to NULL. xterm_update(); method = CLIPMETHOD_X11; *regular = *primary = true; } #endif } } else if (STRCMP(buf, "gui") == 0) { #ifdef FEAT_GUI if (gui.in_use) { method = CLIPMETHOD_GUI; *regular = *primary = true; } #endif } else if (STRCMP(buf, "other") == 0) { #if !defined(FEAT_XCLIPBOARD) && !defined(FEAT_WAYLAND_CLIPBOARD) method = CLIPMETHOD_OTHER; *regular = *primary = true; #endif } else { ret = CLIPMETHOD_FAIL; goto exit; } // Keep on going in order to catch errors if (method != CLIPMETHOD_NONE && ret == CLIPMETHOD_FAIL) ret = method; } // No match found, use "none". ret = (ret == CLIPMETHOD_FAIL) ? CLIPMETHOD_NONE : ret; exit: vim_free(buf); return ret; } /* * Returns name of clipmethod in a statically allocated string. */ static char_u * clipmethod_to_str(clipmethod_T method) { switch(method) { case CLIPMETHOD_WAYLAND: return (char_u *)"wayland"; case CLIPMETHOD_X11: return (char_u *)"x11"; case CLIPMETHOD_GUI: return (char_u *)"gui"; case CLIPMETHOD_OTHER: return (char_u *)"other"; default: return (char_u *)"none"; } } /* * Sets the current clipmethod to use given by `get_clipmethod()`. Returns an * error message on failure else NULL. */ char * choose_clipmethod(void) { bool regular = false, primary = false; clipmethod_T method = get_clipmethod(p_cpm, ®ular, &primary); if (method == CLIPMETHOD_FAIL) return e_invalid_argument; #if defined(FEAT_GUI) && defined(FEAT_WAYLAND) if (method == CLIPMETHOD_GUI) // We only interact with Wayland for the clipboard, we can just deinit // everything. wayland_uninit_connection(); #endif // Deinitialize clipboard if there is no way to access clipboard if (method == CLIPMETHOD_NONE) clip_init(FALSE); // If we have a clipmethod that works now, then initialize clipboard else if (clipmethod == CLIPMETHOD_NONE && method != CLIPMETHOD_NONE) { clip_init_single(&clip_plus, regular); clip_init_single(&clip_star, primary); clip_plus.did_warn = false; clip_star.did_warn = false; } // Disown clipboard if we are switching to a new method else if (clipmethod != CLIPMETHOD_NONE && method != clipmethod) { if (clip_star.owned) clip_lose_selection(&clip_star); if (clip_plus.owned) clip_lose_selection(&clip_plus); clip_init_single(&clip_plus, regular); clip_init_single(&clip_star, primary); } clipmethod = method; #ifdef FEAT_EVAL set_vim_var_string(VV_CLIPMETHOD, clipmethod_to_str(method), -1); #endif return NULL; } /* * Call choose_clipmethod(). */ void ex_clipreset(exarg_T *eap UNUSED) { clipmethod_T prev = clipmethod; choose_clipmethod(); if (clipmethod == CLIPMETHOD_NONE) smsg(_("Could not find a way to access the clipboard.")); else if (clipmethod != prev) smsg(_("Switched to clipboard method '%s'."), clipmethod_to_str(clipmethod)); } #endif // FEAT_CLIPBOARD