mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-02-04 04:06:06 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
foot/selection.c

2464 lines
70 KiB
C
Raw Normal View History

selection: add a selection API
2019-07-11 09:51:51 +02:00
#include "selection.h"
selection: implement double-click-to-select-word
2019-07-17 21:30:57 +02:00
#include <ctype.h>
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
#include <string.h>
#include <unistd.h>
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
#include <fcntl.h>
selection: handle partial writes and EINTR when writing to clipboard
2019-07-11 16:26:25 +02:00
#include <errno.h>
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
#include <sys/epoll.h>
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
#include <sys/timerfd.h>
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
selection: add a selection API
2019-07-11 09:51:51 +02:00
#define LOG_MODULE "selection"
selection: disable debug logging
2019-07-11 10:01:46 +02:00
#define LOG_ENABLE_DBG 0
selection: add a selection API
2019-07-11 09:51:51 +02:00
#include "log.h"
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
#include "async.h"
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
#include "char32.h"
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
#include "commands.h"
config: add ‘[default].word-delimiters’ This option lets the user configure which characters act as word delimiters when selecting text. This affects both “double clicking”, and ‘ctrl-w’ in scrollback search mode. Closes #156
2020-10-09 19:44:23 +02:00
#include "config.h"
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
#include "extract.h"
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
#include "grid.h"
selection: break out isword() to a new file
2019-12-03 19:16:05 +01:00
#include "misc.h"
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
#include "render.h"
search: reset match state when selection is cancelled While we’re in scrollback search mode, the selection may be cancelled (for example, if the application is scrolling out the selected text). Trying to e.g. extend the search selection after this has happened triggered a crash. This fixes it by simply resetting the search match state when the selection is cancelled. Closes #644
2021-07-22 17:53:29 +02:00
#include "search.h"
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
#include "uri.h"
util.h: new header file defining commonly used macros
2020-05-01 11:46:24 +02:00
#include "util.h"
Use vt_to_slave() instead of calling write(term->ptmx, ...) everywhere
2019-07-15 15:42:21 +02:00
#include "vt.h"
Convert most dynamic allocations to use functions from xmalloc.h
2020-08-08 20:34:30 +01:00
#include "xmalloc.h"
selection: add a selection API
2019-07-11 09:51:51 +02:00
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
static const char *const mime_type_map[] = {
[DATA_OFFER_MIME_UNSET] = NULL,
[DATA_OFFER_MIME_TEXT_PLAIN] = "text/plain",
[DATA_OFFER_MIME_TEXT_UTF8] = "text/plain;charset=utf-8",
[DATA_OFFER_MIME_URI_LIST] = "text/uri-list",
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
[DATA_OFFER_MIME_TEXT_TEXT] = "TEXT",
[DATA_OFFER_MIME_TEXT_STRING] = "STRING",
[DATA_OFFER_MIME_TEXT_UTF8_STRING] = "UTF8_STRING",
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
};
term: cancel selection when scrolling wraps If we scroll enough, we'll eventually end up wrapping around the entire scrollback buffer. At this point, a selection is no longer valid, so cancel it. Note: this was very obvious when scrolling in the alt screen, since its scrollback buffer is what you see on the screen (i.e. it has no scrollback).
2019-08-05 20:16:17 +02:00
bool
term: scrolling: hopefully fix all selection/scrolling related crashes When scrolling, there are a couple of cases where an existing selection must be canceled because we cannot meaningfully represent it after scrolling. These are when the selection is (partly) inside: * The top scrolling region * The bottom scrolling region * The new lines scrolled in. I.e. re-used lines For the scrolling regions, the real problem is when the selection crosses the scrolling region boundary; a selection that is completely inside a scrolling regions _might_ be possible to keep, but we would need to translate the selection coordinates to the new scrolling region lines. For simplicity, we cancel the selection if it touches the scrolling region. Period. The last item, newly scrolled in lines is when the selection covers very old lines and we're now wrapping around the scrollback history. Then there's a fourth problem case: when the user has started a selection, but hasn't yet moved the cursor. In this case, we have no end point. What's more problematic is that when the user (after scrolling) moves the cursor, we try to create a huge selection that covers mostly empty (NULL) rows, causing us to crash. This can happen e.g. when reverse scrolling in such a way that we wrap around the scrollback history. The actual viewport in this case is something like `-n - m`. But the selection we'll end up trying to create will be `m - (rows - n)`. This range may very well contain NULL rows. To deal with this, we simply cancel the selection.
2020-05-17 15:34:49 +02:00
selection_on_rows(const struct terminal *term, int row_start, int row_end)
term: cancel selection when scrolling wraps If we scroll enough, we'll eventually end up wrapping around the entire scrollback buffer. At this point, a selection is no longer valid, so cancel it. Note: this was very obvious when scrolling in the alt screen, since its scrollback buffer is what you see on the screen (i.e. it has no scrollback).
2019-08-05 20:16:17 +02:00
{
term: scrolling: hopefully fix all selection/scrolling related crashes When scrolling, there are a couple of cases where an existing selection must be canceled because we cannot meaningfully represent it after scrolling. These are when the selection is (partly) inside: * The top scrolling region * The bottom scrolling region * The new lines scrolled in. I.e. re-used lines For the scrolling regions, the real problem is when the selection crosses the scrolling region boundary; a selection that is completely inside a scrolling regions _might_ be possible to keep, but we would need to translate the selection coordinates to the new scrolling region lines. For simplicity, we cancel the selection if it touches the scrolling region. Period. The last item, newly scrolled in lines is when the selection covers very old lines and we're now wrapping around the scrollback history. Then there's a fourth problem case: when the user has started a selection, but hasn't yet moved the cursor. In this case, we have no end point. What's more problematic is that when the user (after scrolling) moves the cursor, we try to create a huge selection that covers mostly empty (NULL) rows, causing us to crash. This can happen e.g. when reverse scrolling in such a way that we wrap around the scrollback history. The actual viewport in this case is something like `-n - m`. But the selection we'll end up trying to create will be `m - (rows - n)`. This range may very well contain NULL rows. To deal with this, we simply cancel the selection.
2020-05-17 15:34:49 +02:00
LOG_DBG("on rows: %d-%d, range: %d-%d (offset=%d)",
search: fix next/prev not updating selection correctly when matches overlap When the new match overlapped with the old match, the selection wasn’t updated correctly.
2022-04-17 19:16:47 +02:00
term->selection.coords.start.row, term->selection.coords.end.row,
term: scrolling: hopefully fix all selection/scrolling related crashes When scrolling, there are a couple of cases where an existing selection must be canceled because we cannot meaningfully represent it after scrolling. These are when the selection is (partly) inside: * The top scrolling region * The bottom scrolling region * The new lines scrolled in. I.e. re-used lines For the scrolling regions, the real problem is when the selection crosses the scrolling region boundary; a selection that is completely inside a scrolling regions _might_ be possible to keep, but we would need to translate the selection coordinates to the new scrolling region lines. For simplicity, we cancel the selection if it touches the scrolling region. Period. The last item, newly scrolled in lines is when the selection covers very old lines and we're now wrapping around the scrollback history. Then there's a fourth problem case: when the user has started a selection, but hasn't yet moved the cursor. In this case, we have no end point. What's more problematic is that when the user (after scrolling) moves the cursor, we try to create a huge selection that covers mostly empty (NULL) rows, causing us to crash. This can happen e.g. when reverse scrolling in such a way that we wrap around the scrollback history. The actual viewport in this case is something like `-n - m`. But the selection we'll end up trying to create will be `m - (rows - n)`. This range may very well contain NULL rows. To deal with this, we simply cancel the selection.
2020-05-17 15:34:49 +02:00
row_start, row_end, term->grid->offset);
selection: on_row_in_view() -> on_rows_in_view(), and now takes a range This allows us to check the selection once when scrolling, instead of once for each scrolled in line.
2020-05-16 16:28:32 +02:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.end.row < 0)
term: cancel selection when scrolling wraps If we scroll enough, we'll eventually end up wrapping around the entire scrollback buffer. At this point, a selection is no longer valid, so cancel it. Note: this was very obvious when scrolling in the alt screen, since its scrollback buffer is what you see on the screen (i.e. it has no scrollback).
2019-08-05 20:16:17 +02:00
return false;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
xassert(term->selection.coords.start.row != -1);
term: scrolling: hopefully fix all selection/scrolling related crashes When scrolling, there are a couple of cases where an existing selection must be canceled because we cannot meaningfully represent it after scrolling. These are when the selection is (partly) inside: * The top scrolling region * The bottom scrolling region * The new lines scrolled in. I.e. re-used lines For the scrolling regions, the real problem is when the selection crosses the scrolling region boundary; a selection that is completely inside a scrolling regions _might_ be possible to keep, but we would need to translate the selection coordinates to the new scrolling region lines. For simplicity, we cancel the selection if it touches the scrolling region. Period. The last item, newly scrolled in lines is when the selection covers very old lines and we're now wrapping around the scrollback history. Then there's a fourth problem case: when the user has started a selection, but hasn't yet moved the cursor. In this case, we have no end point. What's more problematic is that when the user (after scrolling) moves the cursor, we try to create a huge selection that covers mostly empty (NULL) rows, causing us to crash. This can happen e.g. when reverse scrolling in such a way that we wrap around the scrollback history. The actual viewport in this case is something like `-n - m`. But the selection we'll end up trying to create will be `m - (rows - n)`. This range may very well contain NULL rows. To deal with this, we simply cancel the selection.
2020-05-17 15:34:49 +02:00
row_start += term->grid->offset;
row_end += term->grid->offset;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
const struct coord *start = &term->selection.coords.start;
const struct coord *end = &term->selection.coords.end;
term: cancel selection when scrolling wraps If we scroll enough, we'll eventually end up wrapping around the entire scrollback buffer. At this point, a selection is no longer valid, so cancel it. Note: this was very obvious when scrolling in the alt screen, since its scrollback buffer is what you see on the screen (i.e. it has no scrollback).
2019-08-05 20:16:17 +02:00
term: scrolling: hopefully fix all selection/scrolling related crashes When scrolling, there are a couple of cases where an existing selection must be canceled because we cannot meaningfully represent it after scrolling. These are when the selection is (partly) inside: * The top scrolling region * The bottom scrolling region * The new lines scrolled in. I.e. re-used lines For the scrolling regions, the real problem is when the selection crosses the scrolling region boundary; a selection that is completely inside a scrolling regions _might_ be possible to keep, but we would need to translate the selection coordinates to the new scrolling region lines. For simplicity, we cancel the selection if it touches the scrolling region. Period. The last item, newly scrolled in lines is when the selection covers very old lines and we're now wrapping around the scrollback history. Then there's a fourth problem case: when the user has started a selection, but hasn't yet moved the cursor. In this case, we have no end point. What's more problematic is that when the user (after scrolling) moves the cursor, we try to create a huge selection that covers mostly empty (NULL) rows, causing us to crash. This can happen e.g. when reverse scrolling in such a way that we wrap around the scrollback history. The actual viewport in this case is something like `-n - m`. But the selection we'll end up trying to create will be `m - (rows - n)`. This range may very well contain NULL rows. To deal with this, we simply cancel the selection.
2020-05-17 15:34:49 +02:00
if ((row_start <= start->row && row_end >= start->row) ||
(row_start <= end->row && row_end >= end->row))
{
/* The range crosses one of the selection boundaries */
return true;
}
/* For the last check we must ensure start <= end */
selection: on_row_in_view() -> on_rows_in_view(), and now takes a range This allows us to check the selection once when scrolling, instead of once for each scrolled in line.
2020-05-16 16:28:32 +02:00
if (start->row > end->row) {
const struct coord *tmp = start;
start = end;
end = tmp;
}
csi: erase scrollback: cancel selection if it touches the scrollback This breaks out the scrollback erasing logic for \E[3J from csi.c, and moves it to the new function term_erase_scrollback(), and changes the logic to calculate the start and end row (absolute) numbers of the scrollback, and only iterate those, instead of iterating *all* rows, filtering out those that are on-screen. It also adds an intersection range check of the selection range, and cancels the selection if it touches any of the deleted scrollback rows. This fixes a crash when trying to render the next frame, since the selection now references rows that have been freed. Closes #633
2021-07-16 16:45:36 +02:00
if (row_start >= start->row && row_end <= end->row)
selection: on_row_in_view() -> on_rows_in_view(), and now takes a range This allows us to check the selection once when scrolling, instead of once for each scrolled in line.
2020-05-16 16:28:32 +02:00
return true;
selection: on_rows_in_view: fix range check
2020-05-17 12:01:24 +02:00
return false;
term: cancel selection when scrolling wraps If we scroll enough, we'll eventually end up wrapping around the entire scrollback buffer. At this point, a selection is no longer valid, so cancel it. Note: this was very obvious when scrolling in the alt screen, since its scrollback buffer is what you see on the screen (i.e. it has no scrollback).
2019-08-05 20:16:17 +02:00
}
selection: handle viewport wrap around correctly When the viewport wraps around, the selection points may be "incorrect".
2020-05-19 18:49:42 +02:00
void
selection_view_up(struct terminal *term, int new_view)
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (likely(term->selection.coords.start.row < 0))
selection: handle viewport wrap around correctly When the viewport wraps around, the selection points may be "incorrect".
2020-05-19 18:49:42 +02:00
return;
if (likely(new_view < term->grid->view))
return;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start.row += term->grid->num_rows;
if (term->selection.coords.end.row >= 0)
term->selection.coords.end.row += term->grid->num_rows;
selection: handle viewport wrap around correctly When the viewport wraps around, the selection points may be "incorrect".
2020-05-19 18:49:42 +02:00
}
void
selection_view_down(struct terminal *term, int new_view)
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (likely(term->selection.coords.start.row < 0))
selection: handle viewport wrap around correctly When the viewport wraps around, the selection points may be "incorrect".
2020-05-19 18:49:42 +02:00
return;
if (likely(new_view > term->grid->view))
return;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start.row &= term->grid->num_rows - 1;
if (term->selection.coords.end.row >= 0)
term->selection.coords.end.row &= term->grid->num_rows - 1;
selection: handle viewport wrap around correctly When the viewport wraps around, the selection points may be "incorrect".
2020-05-19 18:49:42 +02:00
}
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
static void
foreach_selected_normal(
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
struct terminal *term, struct coord _start, struct coord _end,
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
bool (*cb)(struct terminal *term, struct row *row, struct cell *cell,
int row_no, int col, void *data),
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
void *data)
{
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
const struct coord *start = &_start;
const struct coord *end = &_end;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
const int scrollback_start = term->grid->offset + term->rows;
const int grid_rows = term->grid->num_rows;
/* Start/end rows, relative to the scrollback start */
const int rel_start_row =
(start->row - scrollback_start + grid_rows) & (grid_rows - 1);
const int rel_end_row =
(end->row - scrollback_start + grid_rows) & (grid_rows - 1);
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
int start_row, end_row;
int start_col, end_col;
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
if (rel_start_row < rel_end_row) {
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
start_row = start->row;
start_col = start->col;
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
end_row = end->row;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
end_col = end->col;
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
} else if (rel_start_row > rel_end_row) {
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
start_row = end->row;
start_col = end->col;
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
end_row = start->row;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
end_col = start->col;
} else {
start_row = end_row = start->row;
start_col = min(start->col, end->col);
end_col = max(start->col, end->col);
}
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
start_row &= (grid_rows - 1);
end_row &= (grid_rows - 1);
for (int r = start_row; r != end_row; r = (r + 1) & (grid_rows - 1)) {
struct row *row = term->grid->rows[r];
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(row != NULL);
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
for (int c = start_col; c <= term->cols - 1; c++) {
if (!cb(term, row, &row->cells[c], r, c, data))
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
start_col = 0;
}
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
/* Last, partial row */
struct row *row = term->grid->rows[end_row];
xassert(row != NULL);
for (int c = start_col; c <= end_col; c++) {
if (!cb(term, row, &row->cells[c], end_row, c, data))
return;
}
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
static void
foreach_selected_block(
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
struct terminal *term, struct coord _start, struct coord _end,
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
bool (*cb)(struct terminal *term, struct row *row, struct cell *cell,
int row_no, int col, void *data),
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
void *data)
{
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
const struct coord *start = &_start;
const struct coord *end = &_end;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
const int scrollback_start = term->grid->offset + term->rows;
const int grid_rows = term->grid->num_rows;
/* Start/end rows, relative to the scrollback start */
const int rel_start_row =
(start->row - scrollback_start + grid_rows) & (grid_rows - 1);
const int rel_end_row =
(end->row - scrollback_start + grid_rows) & (grid_rows - 1);
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
struct coord top_left = {
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
.row = (rel_start_row < rel_end_row
? start->row : end->row) & (grid_rows - 1),
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
.col = min(start->col, end->col),
};
struct coord bottom_right = {
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
.row = (rel_start_row > rel_end_row
? start->row : end->row) & (grid_rows - 1),
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
.col = max(start->col, end->col),
};
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
int r = top_left.row;
while (true) {
struct row *row = term->grid->rows[r];
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(row != NULL);
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: foreach: don't call callback for trailing multi-character cells
2020-07-14 12:59:36 +02:00
for (int c = top_left.col; c <= bottom_right.col; c++) {
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
if (!cb(term, row, &row->cells[c], r, c, data))
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return;
selection: foreach: don't call callback for trailing multi-character cells
2020-07-14 12:59:36 +02:00
}
selection: foreach: sort start/end based on their scrollback-start relative values When iterating the characters in a selection, we want to go from the “start” to the “end”, where start is the upper left-most character, and “end” is the lower right-most character. There are two things to consider: * The ‘start’ coordinate may actually sort after the ‘end’ coordinate (user selected from bottom of the window and upward) * The scrollback wraparound. What we do is calculate both the star and end coordinates’ scrollback-start relative row numbers. That is, the number of rows from the beginning of the scrollback. So if the very first row (i.e. the oldest) in the scrollback is selected, that has the scrollback-start relative number “0”. Then we loop from whichever (start or end coordinate) is highest up in the scrollback, to the “other” coordinate.
2022-02-07 14:13:38 +01:00
if (r == bottom_right.row)
break;
r++;
r &= grid_rows - 1;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
}
static void
foreach_selected(
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
struct terminal *term, struct coord start, struct coord end,
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
bool (*cb)(struct terminal *term, struct row *row, struct cell *cell, int row_no, int col, void *data),
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
void *data)
{
switch (term->selection.kind) {
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_CHAR_WISE:
case SELECTION_WORD_WISE:
case SELECTION_LINE_WISE:
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
foreach_selected_normal(term, start, end, cb, data);
return;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
case SELECTION_BLOCK:
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
foreach_selected_block(term, start, end, cb, data);
return;
selection: selection_cancel() now sets 'kind' to SELECTION_NONE
2020-01-04 12:09:09 +01:00
case SELECTION_NONE:
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
break;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
BUG("Invalid selection kind");
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
selection: provide a const-wrapper for extract_one() extract_one() takes const pointers, while the callback argument to foreach() expects non-const.
2020-07-15 11:31:57 +02:00
static bool
extract_one_const_wrapper(struct terminal *term,
struct row *row, struct cell *cell,
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
int row_no, int col, void *data)
selection: provide a const-wrapper for extract_one() extract_one() takes const pointers, while the callback argument to foreach() expects non-const.
2020-07-15 11:31:57 +02:00
{
return extract_one(term, row, cell, col, data);
}
config: add 'pipe-selected' key binding This works just like pipe-visible and pipe-scrollback, but pipes the user-selected text, if any, to the external tool. Closes #51
2020-07-31 17:02:53 +02:00
char *
selection_to_text(const struct terminal *term)
selection: extract_selection now uses foreach_selected() This "automagically" adds support for block selections, since foreach_selected already handles block selections.
2020-01-04 12:59:29 +01:00
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.end.row == -1)
config: add 'pipe-selected' key binding This works just like pipe-visible and pipe-scrollback, but pipes the user-selected text, if any, to the external tool. Closes #51
2020-07-31 17:02:53 +02:00
return NULL;
extract: move ‘strip_trailing_empty’ parameter from extra_finish() to extract_begin()
2021-03-30 14:40:21 +02:00
struct extraction_context *ctx = extract_begin(term->selection.kind, true);
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
if (ctx == NULL)
return NULL;
selection: extract_selection now uses foreach_selected() This "automagically" adds support for block selections, since foreach_selected already handles block selections.
2020-01-04 12:59:29 +01:00
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
foreach_selected(
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
(struct terminal *)term, term->selection.coords.start, term->selection.coords.end,
selection: provide a const-wrapper for extract_one() extract_one() takes const pointers, while the callback argument to foreach() expects non-const.
2020-07-15 11:31:57 +02:00
&extract_one_const_wrapper, ctx);
selection: insert newlines only when last column is empty
2019-08-04 13:07:54 +02:00
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
char *text;
extract: move ‘strip_trailing_empty’ parameter from extra_finish() to extract_begin()
2021-03-30 14:40:21 +02:00
return extract_finish(ctx, &text, NULL) ? text : NULL;
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
selection: expose find_word_boundary_{left,right}()
2021-03-28 21:03:53 +02:00
void
selection_find_word_boundary_left(struct terminal *term, struct coord *pos,
bool spaces_only)
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
{
selection: find_word_boundary: assert ‘pos’ is valid
2022-04-23 12:23:27 +02:00
xassert(pos->row >= 0);
xassert(pos->row < term->rows);
xassert(pos->col >= 0);
xassert(pos->col < term->cols);
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
const struct row *r = grid_row_in_view(term->grid, pos->row);
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
char32_t c = r->cells[pos->col].wc;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
while (c >= CELL_SPACER) {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(pos->col > 0);
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
if (pos->col == 0)
return;
pos->col--;
c = r->cells[pos->col].wc;
}
composed: store compose chains in a binary search tree The previous implementation stored compose chains in a dynamically allocated array. Adding a chain was easy: resize the array and append the new chain at the end. Looking up a compose chain given a compose chain key/index was also easy: just index into the array. However, searching for a pre-existing chain given a codepoint sequence was very slow. Since the array wasn’t sorted, we typically had to scan through the entire array, just to realize that there is no pre-existing chain, and that we need to add a new one. Since this happens for *each* codepoint in a grapheme cluster, things quickly became really slow. Things were ok:ish as long as the compose chain struct was small, as that made it possible to hold all the chains in the cache. Once the number of chains reached a certain point, or when we were forced to bump maximum number of allowed codepoints in a chain, we started thrashing the cache and things got much much worse. So what can we do? We can’t sort the array, because a) that would invalidate all existing chain keys in the grid (and iterating the entire scrollback and updating compose keys is *not* an option). b) inserting a chain becomes slow as we need to first find _where_ to insert it, and then memmove() the rest of the array. This patch uses a binary search tree to store the chains instead of a simple array. The tree is sorted on a “key”, which is the XOR of all codepoints, truncated to the CELL_COMB_CHARS_HI-CELL_COMB_CHARS_LO range. The grid now stores CELL_COMB_CHARS_LO+key, instead of CELL_COMB_CHARS_LO+index. Since the key is truncated, collisions may occur. This is handled by incrementing the key by 1. Lookup is of course slower than before, O(log n) instead of O(1). Insertion is slightly slower as well: technically it’s O(log n) instead of O(1). However, we also need to take into account the re-allocating the array will occasionally force a full copy of the array when it cannot simply be growed. But finding a pre-existing chain is now *much* faster: O(log n) instead of O(n). In most cases, the first lookup will either succeed (return a true match), or fail (return NULL). However, since key collisions are possible, it may also return false matches. This means we need to verify the contents of the chain before deciding to use it instead of inserting a new chain. But remember that this comparison was being done for each and every chain in the previous implementation. With lookups being much faster, and in particular, no longer requiring us to check the chain contents for every singlec chain, we can now use a dynamically allocated ‘chars’ array in the chain. This was previously a hardcoded array of 10 chars. Using a dynamic allocated array means looking in the array is slower, since we now need two loads: one to load the pointer, and a second to load _from_ the pointer. As a result, the base size of a compose chain (i.e. an “empty” chain) has now been reduced from 48 bytes to 32. A chain with two codepoints is 40 bytes. This means we have up to 4 codepoints while still using less, or the same amount, of memory as before. Furthermore, the Unicode random test (i.e. write random “unicode” chars) is now **faster** than current master (i.e. before text-shaping support was added), **with** test-shaping enabled. With text-shaping disabled, we’re _even_ faster.
2021-06-24 13:17:07 +02:00
if (c >= CELL_COMB_CHARS_LO && c <= CELL_COMB_CHARS_HI)
c = composed_lookup(term->composed, c - CELL_COMB_CHARS_LO)->chars[0];
selection: find_word_boundary{left,right}: handle composed characters
2021-01-03 13:09:24 +01:00
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
bool initial_is_space = c == 0 || isc32space(c);
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
bool initial_is_delim =
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
!initial_is_space && !isword(c, spaces_only, term->conf->word_delimiters);
bool initial_is_word =
c != 0 && isword(c, spaces_only, term->conf->word_delimiters);
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
while (true) {
int next_col = pos->col - 1;
int next_row = pos->row;
selection: pay attention to hard linebreaks when search for word boundaries Double-clicking on a word in the left or right margin, would line-wrap the selection if there was a non-empty cell in the corresponding right/left margin on the prev/next line. Regardless of whether there was a hard linebreak or not. Script to reprouce: !/bin/bash cols=$(tput cols) printf "%*coo\nbar\n" $((${cols} - 2)) f Run, then double click either “foo” or “bar”. Neither should select the other part. Closes #565
2021-05-31 17:12:38 +02:00
const struct row *row = grid_row_in_view(term->grid, next_row);
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
/* Linewrap */
if (next_col < 0) {
next_col = term->cols - 1;
if (--next_row < 0)
break;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
selection: pay attention to hard linebreaks when search for word boundaries Double-clicking on a word in the left or right margin, would line-wrap the selection if there was a non-empty cell in the corresponding right/left margin on the prev/next line. Regardless of whether there was a hard linebreak or not. Script to reprouce: !/bin/bash cols=$(tput cols) printf "%*coo\nbar\n" $((${cols} - 2)) f Run, then double click either “foo” or “bar”. Neither should select the other part. Closes #565
2021-05-31 17:12:38 +02:00
row = grid_row_in_view(term->grid, next_row);
if (row->linebreak) {
/* Hard linebreak, treat as space. I.e. break selection */
break;
}
}
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
c = row->cells[next_col].wc;
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
while (c >= CELL_SPACER) {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(next_col > 0);
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
if (--next_col < 0)
return;
c = row->cells[next_col].wc;
}
composed: store compose chains in a binary search tree The previous implementation stored compose chains in a dynamically allocated array. Adding a chain was easy: resize the array and append the new chain at the end. Looking up a compose chain given a compose chain key/index was also easy: just index into the array. However, searching for a pre-existing chain given a codepoint sequence was very slow. Since the array wasn’t sorted, we typically had to scan through the entire array, just to realize that there is no pre-existing chain, and that we need to add a new one. Since this happens for *each* codepoint in a grapheme cluster, things quickly became really slow. Things were ok:ish as long as the compose chain struct was small, as that made it possible to hold all the chains in the cache. Once the number of chains reached a certain point, or when we were forced to bump maximum number of allowed codepoints in a chain, we started thrashing the cache and things got much much worse. So what can we do? We can’t sort the array, because a) that would invalidate all existing chain keys in the grid (and iterating the entire scrollback and updating compose keys is *not* an option). b) inserting a chain becomes slow as we need to first find _where_ to insert it, and then memmove() the rest of the array. This patch uses a binary search tree to store the chains instead of a simple array. The tree is sorted on a “key”, which is the XOR of all codepoints, truncated to the CELL_COMB_CHARS_HI-CELL_COMB_CHARS_LO range. The grid now stores CELL_COMB_CHARS_LO+key, instead of CELL_COMB_CHARS_LO+index. Since the key is truncated, collisions may occur. This is handled by incrementing the key by 1. Lookup is of course slower than before, O(log n) instead of O(1). Insertion is slightly slower as well: technically it’s O(log n) instead of O(1). However, we also need to take into account the re-allocating the array will occasionally force a full copy of the array when it cannot simply be growed. But finding a pre-existing chain is now *much* faster: O(log n) instead of O(n). In most cases, the first lookup will either succeed (return a true match), or fail (return NULL). However, since key collisions are possible, it may also return false matches. This means we need to verify the contents of the chain before deciding to use it instead of inserting a new chain. But remember that this comparison was being done for each and every chain in the previous implementation. With lookups being much faster, and in particular, no longer requiring us to check the chain contents for every singlec chain, we can now use a dynamically allocated ‘chars’ array in the chain. This was previously a hardcoded array of 10 chars. Using a dynamic allocated array means looking in the array is slower, since we now need two loads: one to load the pointer, and a second to load _from_ the pointer. As a result, the base size of a compose chain (i.e. an “empty” chain) has now been reduced from 48 bytes to 32. A chain with two codepoints is 40 bytes. This means we have up to 4 codepoints while still using less, or the same amount, of memory as before. Furthermore, the Unicode random test (i.e. write random “unicode” chars) is now **faster** than current master (i.e. before text-shaping support was added), **with** test-shaping enabled. With text-shaping disabled, we’re _even_ faster.
2021-06-24 13:17:07 +02:00
if (c >= CELL_COMB_CHARS_LO && c <= CELL_COMB_CHARS_HI)
c = composed_lookup(term->composed, c - CELL_COMB_CHARS_LO)->chars[0];
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
bool is_space = c == 0 || isc32space(c);
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
bool is_delim =
!is_space && !isword(c, spaces_only, term->conf->word_delimiters);
bool is_word =
c != 0 && isword(c, spaces_only, term->conf->word_delimiters);
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
if (initial_is_space && !is_space)
break;
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
if (initial_is_delim && !is_delim)
break;
if (initial_is_word && !is_word)
break;
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
pos->col = next_col;
pos->row = next_row;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
}
}
selection: expose find_word_boundary_{left,right}()
2021-03-28 21:03:53 +02:00
void
selection_find_word_boundary_right(struct terminal *term, struct coord *pos,
bool spaces_only)
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
{
selection: find_word_boundary: assert ‘pos’ is valid
2022-04-23 12:23:27 +02:00
xassert(pos->row >= 0);
xassert(pos->row < term->rows);
xassert(pos->col >= 0);
xassert(pos->col < term->cols);
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
const struct row *r = grid_row_in_view(term->grid, pos->row);
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
char32_t c = r->cells[pos->col].wc;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
while (c >= CELL_SPACER) {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(pos->col > 0);
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
if (pos->col == 0)
return;
pos->col--;
c = r->cells[pos->col].wc;
}
composed: store compose chains in a binary search tree The previous implementation stored compose chains in a dynamically allocated array. Adding a chain was easy: resize the array and append the new chain at the end. Looking up a compose chain given a compose chain key/index was also easy: just index into the array. However, searching for a pre-existing chain given a codepoint sequence was very slow. Since the array wasn’t sorted, we typically had to scan through the entire array, just to realize that there is no pre-existing chain, and that we need to add a new one. Since this happens for *each* codepoint in a grapheme cluster, things quickly became really slow. Things were ok:ish as long as the compose chain struct was small, as that made it possible to hold all the chains in the cache. Once the number of chains reached a certain point, or when we were forced to bump maximum number of allowed codepoints in a chain, we started thrashing the cache and things got much much worse. So what can we do? We can’t sort the array, because a) that would invalidate all existing chain keys in the grid (and iterating the entire scrollback and updating compose keys is *not* an option). b) inserting a chain becomes slow as we need to first find _where_ to insert it, and then memmove() the rest of the array. This patch uses a binary search tree to store the chains instead of a simple array. The tree is sorted on a “key”, which is the XOR of all codepoints, truncated to the CELL_COMB_CHARS_HI-CELL_COMB_CHARS_LO range. The grid now stores CELL_COMB_CHARS_LO+key, instead of CELL_COMB_CHARS_LO+index. Since the key is truncated, collisions may occur. This is handled by incrementing the key by 1. Lookup is of course slower than before, O(log n) instead of O(1). Insertion is slightly slower as well: technically it’s O(log n) instead of O(1). However, we also need to take into account the re-allocating the array will occasionally force a full copy of the array when it cannot simply be growed. But finding a pre-existing chain is now *much* faster: O(log n) instead of O(n). In most cases, the first lookup will either succeed (return a true match), or fail (return NULL). However, since key collisions are possible, it may also return false matches. This means we need to verify the contents of the chain before deciding to use it instead of inserting a new chain. But remember that this comparison was being done for each and every chain in the previous implementation. With lookups being much faster, and in particular, no longer requiring us to check the chain contents for every singlec chain, we can now use a dynamically allocated ‘chars’ array in the chain. This was previously a hardcoded array of 10 chars. Using a dynamic allocated array means looking in the array is slower, since we now need two loads: one to load the pointer, and a second to load _from_ the pointer. As a result, the base size of a compose chain (i.e. an “empty” chain) has now been reduced from 48 bytes to 32. A chain with two codepoints is 40 bytes. This means we have up to 4 codepoints while still using less, or the same amount, of memory as before. Furthermore, the Unicode random test (i.e. write random “unicode” chars) is now **faster** than current master (i.e. before text-shaping support was added), **with** test-shaping enabled. With text-shaping disabled, we’re _even_ faster.
2021-06-24 13:17:07 +02:00
if (c >= CELL_COMB_CHARS_LO && c <= CELL_COMB_CHARS_HI)
c = composed_lookup(term->composed, c - CELL_COMB_CHARS_LO)->chars[0];
selection: find_word_boundary{left,right}: handle composed characters
2021-01-03 13:09:24 +01:00
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
bool initial_is_space = c == 0 || isc32space(c);
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
bool initial_is_delim =
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
!initial_is_space && !isword(c, spaces_only, term->conf->word_delimiters);
bool initial_is_word =
c != 0 && isword(c, spaces_only, term->conf->word_delimiters);
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
while (true) {
int next_col = pos->col + 1;
int next_row = pos->row;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
selection: pay attention to hard linebreaks when search for word boundaries Double-clicking on a word in the left or right margin, would line-wrap the selection if there was a non-empty cell in the corresponding right/left margin on the prev/next line. Regardless of whether there was a hard linebreak or not. Script to reprouce: !/bin/bash cols=$(tput cols) printf "%*coo\nbar\n" $((${cols} - 2)) f Run, then double click either “foo” or “bar”. Neither should select the other part. Closes #565
2021-05-31 17:12:38 +02:00
const struct row *row = grid_row_in_view(term->grid, next_row);
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
/* Linewrap */
if (next_col >= term->cols) {
selection: pay attention to hard linebreaks when search for word boundaries Double-clicking on a word in the left or right margin, would line-wrap the selection if there was a non-empty cell in the corresponding right/left margin on the prev/next line. Regardless of whether there was a hard linebreak or not. Script to reprouce: !/bin/bash cols=$(tput cols) printf "%*coo\nbar\n" $((${cols} - 2)) f Run, then double click either “foo” or “bar”. Neither should select the other part. Closes #565
2021-05-31 17:12:38 +02:00
if (row->linebreak) {
/* Hard linebreak, treat as space. I.e. break selection */
break;
}
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
next_col = 0;
if (++next_row >= term->rows)
break;
selection: pay attention to hard linebreaks when search for word boundaries Double-clicking on a word in the left or right margin, would line-wrap the selection if there was a non-empty cell in the corresponding right/left margin on the prev/next line. Regardless of whether there was a hard linebreak or not. Script to reprouce: !/bin/bash cols=$(tput cols) printf "%*coo\nbar\n" $((${cols} - 2)) f Run, then double click either “foo” or “bar”. Neither should select the other part. Closes #565
2021-05-31 17:12:38 +02:00
row = grid_row_in_view(term->grid, next_row);
}
selection: find_word_boundary{left,right}: handle composed characters
2021-01-03 13:09:24 +01:00
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
c = row->cells[next_col].wc;
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
while (c >= CELL_SPACER) {
selection: find_word_boundary_{left,right}: handle multi-column characters
2021-01-03 14:07:40 +01:00
if (++next_col >= term->cols) {
next_col = 0;
if (++next_row >= term->rows)
return;
}
c = row->cells[next_col].wc;
}
composed: store compose chains in a binary search tree The previous implementation stored compose chains in a dynamically allocated array. Adding a chain was easy: resize the array and append the new chain at the end. Looking up a compose chain given a compose chain key/index was also easy: just index into the array. However, searching for a pre-existing chain given a codepoint sequence was very slow. Since the array wasn’t sorted, we typically had to scan through the entire array, just to realize that there is no pre-existing chain, and that we need to add a new one. Since this happens for *each* codepoint in a grapheme cluster, things quickly became really slow. Things were ok:ish as long as the compose chain struct was small, as that made it possible to hold all the chains in the cache. Once the number of chains reached a certain point, or when we were forced to bump maximum number of allowed codepoints in a chain, we started thrashing the cache and things got much much worse. So what can we do? We can’t sort the array, because a) that would invalidate all existing chain keys in the grid (and iterating the entire scrollback and updating compose keys is *not* an option). b) inserting a chain becomes slow as we need to first find _where_ to insert it, and then memmove() the rest of the array. This patch uses a binary search tree to store the chains instead of a simple array. The tree is sorted on a “key”, which is the XOR of all codepoints, truncated to the CELL_COMB_CHARS_HI-CELL_COMB_CHARS_LO range. The grid now stores CELL_COMB_CHARS_LO+key, instead of CELL_COMB_CHARS_LO+index. Since the key is truncated, collisions may occur. This is handled by incrementing the key by 1. Lookup is of course slower than before, O(log n) instead of O(1). Insertion is slightly slower as well: technically it’s O(log n) instead of O(1). However, we also need to take into account the re-allocating the array will occasionally force a full copy of the array when it cannot simply be growed. But finding a pre-existing chain is now *much* faster: O(log n) instead of O(n). In most cases, the first lookup will either succeed (return a true match), or fail (return NULL). However, since key collisions are possible, it may also return false matches. This means we need to verify the contents of the chain before deciding to use it instead of inserting a new chain. But remember that this comparison was being done for each and every chain in the previous implementation. With lookups being much faster, and in particular, no longer requiring us to check the chain contents for every singlec chain, we can now use a dynamically allocated ‘chars’ array in the chain. This was previously a hardcoded array of 10 chars. Using a dynamic allocated array means looking in the array is slower, since we now need two loads: one to load the pointer, and a second to load _from_ the pointer. As a result, the base size of a compose chain (i.e. an “empty” chain) has now been reduced from 48 bytes to 32. A chain with two codepoints is 40 bytes. This means we have up to 4 codepoints while still using less, or the same amount, of memory as before. Furthermore, the Unicode random test (i.e. write random “unicode” chars) is now **faster** than current master (i.e. before text-shaping support was added), **with** test-shaping enabled. With text-shaping disabled, we’re _even_ faster.
2021-06-24 13:17:07 +02:00
if (c >= CELL_COMB_CHARS_LO && c <= CELL_COMB_CHARS_HI)
c = composed_lookup(term->composed, c - CELL_COMB_CHARS_LO)->chars[0];
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
bool is_space = c == 0 || isc32space(c);
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
bool is_delim =
!is_space && !isword(c, spaces_only, term->conf->word_delimiters);
bool is_word =
c != 0 && isword(c, spaces_only, term->conf->word_delimiters);
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
if (initial_is_space && !is_space)
break;
selection: find_word_boundary_{left,right}: try to make the code more readable
2021-01-03 14:33:35 +01:00
if (initial_is_delim && !is_delim)
break;
if (initial_is_word && !is_word)
break;
selection: find_word_boundary{left,right}: what we match depends on initial character If the initial character is a space, find the next non-space character. If the initial character is a delimiter, find the next non-delimiter character (space, or word character). If the initial character is neither (i.e, it is a word character), find the next non-word character.
2021-01-03 13:54:41 +01:00
pos->col = next_col;
pos->row = next_row;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
}
}
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
void
selection_find_line_boundary_left(struct terminal *term, struct coord *pos,
bool spaces_only)
{
int next_row = pos->row;
pos->col = 0;
while (true) {
if (--next_row < 0)
return;
const struct row *row = grid_row_in_view(term->grid, next_row);
assert(row != NULL);
if (row->linebreak)
return;
pos->col = 0;
pos->row = next_row;
}
}
void
selection_find_line_boundary_right(struct terminal *term, struct coord *pos,
bool spaces_only)
{
int next_row = pos->row;
pos->col = term->cols - 1;
while (true) {
const struct row *row = grid_row_in_view(term->grid, next_row);
assert(row != NULL);
if (row->linebreak)
return;
if (++next_row >= term->rows)
return;
pos->col = term->cols - 1;
pos->row = next_row;
}
}
selection: add a selection API
2019-07-11 09:51:51 +02:00
void
selection: track selection type; normal or block selection
2020-01-03 23:29:45 +01:00
selection_start(struct terminal *term, int col, int row,
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
enum selection_kind kind,
bool spaces_only)
selection: add a selection API
2019-07-11 09:51:51 +02:00
{
selection_cancel(term);
selection: track selection type; normal or block selection
2020-01-03 23:29:45 +01:00
LOG_DBG("%s selection started at %d,%d",
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
kind == SELECTION_CHAR_WISE ? "character-wise" :
kind == SELECTION_WORD_WISE ? "word-wise" :
kind == SELECTION_LINE_WISE ? "line-wise" :
selection: track selection type; normal or block selection
2020-01-03 23:29:45 +01:00
kind == SELECTION_BLOCK ? "block" : "<unknown>",
row, col);
selection: don't allow only half of double-width characters to be selected
2020-06-02 18:21:39 +02:00
selection: track selection type; normal or block selection
2020-01-03 23:29:45 +01:00
term->selection.kind = kind;
config: add mouse specific bind actions This extends the "normal" bind action enum with mouse specific actions. When parsing key bindings, we only check up to the last valid keyboard binding, while mouse bindings support *both* key actions and mouse actions. The new actions are: * select-begin: starts an interactive selection * select-extend: interactively extend an existing selection * select-word: select word under cursor * select-word-whitespace: select word under cursor, where the only word separating characters are whitespace characters. The old hard-coded selection "bindings" have been converted to instead use these actions, via default bindings added to the configuration.
2020-08-11 09:55:33 +02:00
term->selection.ongoing = true;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
term->selection.spaces_only = spaces_only;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
switch (kind) {
case SELECTION_CHAR_WISE:
case SELECTION_BLOCK:
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start = (struct coord){col, term->grid->view + row};
term->selection.coords.end = (struct coord){-1, -1};
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.pivot.start = term->selection.coords.start;
term->selection.pivot.end = term->selection.coords.end;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
break;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_WORD_WISE: {
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
struct coord start = {col, row}, end = {col, row};
selection: expose find_word_boundary_{left,right}()
2021-03-28 21:03:53 +02:00
selection_find_word_boundary_left(term, &start, spaces_only);
selection_find_word_boundary_right(term, &end, spaces_only);
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start = (struct coord){
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
start.col, term->grid->view + start.row};
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.pivot.start = term->selection.coords.start;
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
term->selection.pivot.end = (struct coord){end.col, term->grid->view + end.row};
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
selection_update(term, end.col, end.row);
break;
}
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
case SELECTION_LINE_WISE: {
struct coord start = {0, row}, end = {term->cols - 1, row};
selection_find_line_boundary_left(term, &start, spaces_only);
selection_find_line_boundary_right(term, &end, spaces_only);
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start = (struct coord){
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
start.col, term->grid->view + start.row};
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.pivot.start = term->selection.coords.start;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
term->selection.pivot.end = (struct coord){end.col, term->grid->view + end.row};
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
selection_update(term, end.col, end.row);
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
break;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
}
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_NONE:
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
BUG("Invalid selection kind");
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
break;
selection: use selection_start() to initialize word/row-based selection This removes the selection_mark_word() and selection_mark_row() functions. To start a word/row-based selection, use selection_start() with SELECTION_SEMANTIC_{WORD,ROW}
2021-01-02 23:00:54 +01:00
}
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
selection: add a selection API
2019-07-11 09:51:51 +02:00
}
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
/* Context used while (un)marking selected cells, to be able to
* exclude empty cells */
struct mark_context {
const struct row *last_row;
int empty_count;
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
uint8_t **keep_selection;
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
};
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
static bool
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
unmark_selected(struct terminal *term, struct row *row, struct cell *cell,
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
int row_no, int col, void *data)
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
{
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
if (!cell->attrs.selected)
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return true;
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
struct mark_context *ctx = data;
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
const uint8_t *keep_selection =
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
ctx->keep_selection != NULL ? ctx->keep_selection[row_no] : NULL;
if (keep_selection != NULL) {
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
unsigned idx = (unsigned)col / 8;
unsigned ofs = (unsigned)col % 8;
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
if (keep_selection[idx] & (1 << ofs)) {
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
/* We’re updating the selection, and this cell is still
* going to be selected */
return true;
}
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
}
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: row->dirty is a boolean
2020-07-15 09:21:39 +02:00
row->dirty = true;
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
cell->attrs.selected = false;
cell->attrs.clean = false;
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return true;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
static bool
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
premark_selected(struct terminal *term, struct row *row, struct cell *cell,
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
int row_no, int col, void *data)
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
{
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
struct mark_context *ctx = data;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(ctx != NULL);
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
if (ctx->last_row != row) {
ctx->last_row = row;
ctx->empty_count = 0;
}
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
if (cell->wc == 0 && term->selection.kind != SELECTION_BLOCK) {
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
ctx->empty_count++;
return true;
}
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
uint8_t *keep_selection = ctx->keep_selection[row_no];
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
if (keep_selection == NULL) {
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
keep_selection = xcalloc((term->grid->num_cols + 7) / 8, sizeof(keep_selection[0]));
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
ctx->keep_selection[row_no] = keep_selection;
}
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
/* Tell unmark to leave this be */
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
for (int i = 0; i < ctx->empty_count + 1; i++) {
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
unsigned idx = (unsigned)(col - i) / 8;
unsigned ofs = (unsigned)(col - i) % 8;
keep_selection[idx] |= 1 << ofs;
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
}
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
selection: reset ‘empty_count’ after we’ve emitted the empty cells When marking and unmarking cells, we don’t highlight trailing empty cells. We do however highlight empty cells if they are followed by non-empty cells. I think this was an intentional choice. If one row ended with trailing empty cells, but *no* hard linebreak, then we’d continue on the next row, and emit all the empty cells once we hit a non-emtpy cell on the second row. But this is something that shouldn’t happen in any real-world use cases.
2021-06-05 13:41:17 +02:00
ctx->empty_count = 0;
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return true;
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
}
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
static bool
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
mark_selected(struct terminal *term, struct row *row, struct cell *cell,
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
int row_no, int col, void *data)
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
{
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
struct mark_context *ctx = data;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(ctx != NULL);
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
if (ctx->last_row != row) {
ctx->last_row = row;
ctx->empty_count = 0;
}
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
if (cell->wc == 0 && term->selection.kind != SELECTION_BLOCK) {
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
ctx->empty_count++;
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return true;
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
}
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
for (int i = 0; i < ctx->empty_count + 1; i++) {
struct cell *c = &row->cells[col - i];
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
if (!c->attrs.selected) {
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
row->dirty = true;
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
c->attrs.selected = true;
c->attrs.clean = false;
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
}
}
selection: reset ‘empty_count’ after we’ve emitted the empty cells When marking and unmarking cells, we don’t highlight trailing empty cells. We do however highlight empty cells if they are followed by non-empty cells. I think this was an intentional choice. If one row ended with trailing empty cells, but *no* hard linebreak, then we’d continue on the next row, and emit all the empty cells once we hit a non-emtpy cell on the second row. But this is something that shouldn’t happen in any real-world use cases.
2021-06-05 13:41:17 +02:00
ctx->empty_count = 0;
selection: refactor: break out text extraction to a separate file
2020-07-15 11:19:18 +02:00
return true;
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
}
selection: modify: replace reset_context() macro with a function
2021-08-14 09:56:14 +02:00
static void
reset_modify_context(struct mark_context *ctx)
{
ctx->last_row = NULL;
ctx->empty_count = 0;
}
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
static void
selection_modify(struct terminal *term, struct coord start, struct coord end)
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
xassert(term->selection.coords.start.row != -1);
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(start.row != -1 && start.col != -1);
xassert(end.row != -1 && end.col != -1);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
selection: modify: convert ‘keep_selection’ bitmask from uint64_t to uint8_t
2021-08-14 09:58:50 +02:00
uint8_t **keep_selection =
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
xcalloc(term->grid->num_rows, sizeof(keep_selection[0]));
struct mark_context ctx = {.keep_selection = keep_selection};
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
/* Premark all cells that *will* be selected */
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
foreach_selected(term, start, end, &premark_selected, &ctx);
selection: modify: replace reset_context() macro with a function
2021-08-14 09:56:14 +02:00
reset_modify_context(&ctx);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.end.row >= 0) {
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
/* Unmark previous selection, ignoring cells that are part of
* the new selection */
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
foreach_selected(term, term->selection.coords.start, term->selection.coords.end,
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
&unmark_selected, &ctx);
selection: modify: replace reset_context() macro with a function
2021-08-14 09:56:14 +02:00
reset_modify_context(&ctx);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start = start;
term->selection.coords.end = end;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
/* Mark new selection */
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
foreach_selected(term, start, end, &mark_selected, &ctx);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
render_refresh(term);
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
selection: modify: no need to check for NULL before calling free()
2021-08-14 10:50:49 +02:00
for (size_t i = 0; i < term->grid->num_rows; i++)
selection: don’t require two cell attr bits for selection updating When updating the selection (i.e when changing it - adding or removing cells to the selection), we need to do two things: * Unset the ‘selected’ bit on all cells that are no longer selected. * Set the ‘selected’ bit on all cells that *are* selected. Since it’s quite tricky to calculate the difference between the “old” and “new” selection, this is done by first un-selecting the old selection, and then selecting the new, updated selection. I.e. first we clear the ‘selected’ bit from *all* cells, and then we re-set it on those cells that are still selected. This process also dirties the cells, to make sure they are re-rendered (needed to reflect their new selected/un-selected status). To avoid dirtying *all* previously selected, and newly selected cells, we have used an algorithm that first runs a “pre-pass”, marking all cells that *will* be selected as such. The un-select pass would then skip (no dirty) cells that have been marked by the pre-pass. Finally, the select pass would only dirty cells that have *not* been marked by the pre-pass. In short, we only dirty cells whose selection state have *changed*. To do this, we used a second ‘selected’ bit in the cell attribute struct. Those bits are *scarce*. This patch implements an alternative algorithm, that frees up one of the two ‘selected’ bits. This is done by lazy allocating a bitmask for the entire grid. The pre-pass sets bits in the bitmask. Thus, after the pre-pass, the bitmask has set bits for all cells that *will* be selected. The un-select pass simply skips cells with a one-bit in the bitmask. Cells without a one-bit in the bitmask are dirtied, and their ‘selected’ bit is cleared. The select-pass doesn’t even have to look at the bitmask - if the cell already has its ‘selected’ bit set, it does nothing. Otherwise it sets it and dirties the cell. The bitmask is implemented as an array of arrays of 64-bit integers. Each outer element represents one row. These pointers are calloc():ed before starting the pre-pass. The pre-pass allocates the inner arrays on demand. The unselect pass is designed to handle both the complete absence of a bitmask, as well as row entries being NULL (both means the cell is *not* pre-marked, and will thus be dirtied).
2021-08-13 17:45:09 +02:00
free(keep_selection[i]);
free(keep_selection);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
static void
set_pivot_point_for_block_and_char_wise(struct terminal *term,
struct coord start,
enum selection_direction new_direction)
{
struct coord *pivot_start = &term->selection.pivot.start;
struct coord *pivot_end = &term->selection.pivot.end;
*pivot_start = start;
/* First, make sure ‘start’ isn’t in the middle of a
* multi-column character */
while (true) {
const struct row *row = term->grid->rows[pivot_start->row & (term->grid->num_rows - 1)];
const struct cell *cell = &row->cells[pivot_start->col];
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
if (cell->wc < CELL_SPACER)
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
break;
/* Multi-column chars don’t cross rows */
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(pivot_start->col > 0);
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (pivot_start->col == 0)
break;
pivot_start->col--;
}
/*
* Setup pivot end to be one character *before* start
* Which one we move, the end or start point, depends
* on the initial selection direction.
*/
*pivot_end = *pivot_start;
if (new_direction == SELECTION_RIGHT) {
bool keep_going = true;
while (keep_going) {
const struct row *row = term->grid->rows[pivot_end->row & (term->grid->num_rows - 1)];
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
const char32_t wc = row->cells[pivot_end->col].wc;
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
keep_going = wc >= CELL_SPACER;
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (pivot_end->col == 0) {
if (pivot_end->row - term->grid->view <= 0)
break;
pivot_end->col = term->cols - 1;
pivot_end->row--;
} else
pivot_end->col--;
}
} else {
bool keep_going = true;
while (keep_going) {
const struct row *row = term->grid->rows[pivot_start->row & (term->grid->num_rows - 1)];
fcft: adapt to API changes in fcft-3.x Fcft no longer uses wchar_t, but plain uint32_t to represent codepoints. Since we do a fair amount of string operations in foot, it still makes sense to use something that actually _is_ a string (or character), rather than an array of uint32_t. For this reason, we switch out all wchar_t usage in foot to char32_t. We also verify, at compile-time, that char32_t used UTF-32 (which is what fcft expects). Unfortunately, there are no string functions for char32_t. To avoid having to re-implement all wcs*() functions, we add a small wrapper layer of c32*() functions. These wrapper functions take char32_t arguments, but then simply call the corresponding wcs*() function. For this to work, wcs*() must _also_ be UTF-32 compatible. We can check for the presence of the __STDC_ISO_10646__ macro. If set, wchar_t is at least 4 bytes and its internal representation is UTF-32. FreeBSD does *not* define this macro, because its internal wchar_t representation depends on the current locale. It _does_ use UTF-32 _if_ the current locale is UTF-8. Since foot enforces UTF-8, we simply need to check if __FreeBSD__ is defined. Other fcft API changes: * fcft_glyph_rasterize() -> fcft_codepoint_rasterize() * font.space_advance has been removed * ‘tags’ have been removed from fcft_grapheme_rasterize() * ‘fcft_log_init()’ removed * ‘fcft_init()’ and ‘fcft_fini()’ must be explicitly called
2021-08-21 14:50:42 +02:00
const char32_t wc = pivot_start->col < term->cols - 1
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
? row->cells[pivot_start->col + 1].wc : 0;
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
keep_going = wc >= CELL_SPACER;
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (pivot_start->col >= term->cols - 1) {
if (pivot_start->row - term->grid->view >= term->rows - 1)
break;
pivot_start->col = 0;
pivot_start->row++;
} else
pivot_start->col++;
}
}
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(term->grid->rows[pivot_start->row & (term->grid->num_rows - 1)]->
selection: fix bad assertion When there are multiple multi-column characters back-to-back, the cell before the pivot end point may in fact be a SPACER+1 cell.
2021-06-02 19:29:06 +02:00
cells[pivot_start->col].wc <= CELL_SPACER);
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(term->grid->rows[pivot_end->row & (term->grid->num_rows - 1)]->
selection: fix bad assertion When there are multiple multi-column characters back-to-back, the cell before the pivot end point may in fact be a SPACER+1 cell.
2021-06-02 19:29:06 +02:00
cells[pivot_end->col].wc <= CELL_SPACER + 1);
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
}
selection: add a selection API
2019-07-11 09:51:51 +02:00
void
selection_update(struct terminal *term, int col, int row)
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row < 0)
selection: disable selection when client has enabled mouse tracking
2019-07-11 09:57:04 +02:00
return;
selection: update: don't update if there's no ongoing selection
2020-08-11 10:14:38 +02:00
if (!term->selection.ongoing)
return;
selection: add a selection API
2019-07-11 09:51:51 +02:00
LOG_DBG("selection updated: start = %d,%d, end = %d,%d -> %d, %d",
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start.row, term->selection.coords.start.col,
term->selection.coords.end.row, term->selection.coords.end.col,
selection: add a selection API
2019-07-11 09:51:51 +02:00
row, col);
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(term->grid->view + row != -1);
selection: invalidate *all* affected lines when updating selection
2019-07-11 11:10:12 +02:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
struct coord new_start = term->selection.coords.start;
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
struct coord new_end = {col, term->grid->view + row};
selection: don't allow only half of double-width characters to be selected
2020-06-02 18:21:39 +02:00
selection: adjust start point when the selection changes direction Without this, the initial cell will always be selected, regardless of how the selection is moved to the left or right. With this patch, the initial cell will only be selected while the selection is being made in the original direction. Changing direction of the selection moves the start point to next/previous character.
2020-08-12 18:50:49 +02:00
/* Adjust start point if the selection has changed 'direction' */
if (!(new_end.row == new_start.row && new_end.col == new_start.col)) {
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
enum selection_direction new_direction = term->selection.direction;
struct coord *pivot_start = &term->selection.pivot.start;
struct coord *pivot_end = &term->selection.pivot.end;
selection: adjust start point when the selection changes direction Without this, the initial cell will always be selected, regardless of how the selection is moved to the left or right. With this patch, the initial cell will only be selected while the selection is being made in the original direction. Changing direction of the selection moves the start point to next/previous character.
2020-08-12 18:50:49 +02:00
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (term->selection.kind == SELECTION_BLOCK) {
if (new_end.col > pivot_start->col)
new_direction = SELECTION_RIGHT;
else
new_direction = SELECTION_LEFT;
selection: adjust start point when the selection changes direction Without this, the initial cell will always be selected, regardless of how the selection is moved to the left or right. With this patch, the initial cell will only be selected while the selection is being made in the original direction. Changing direction of the selection moves the start point to next/previous character.
2020-08-12 18:50:49 +02:00
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (term->selection.direction == SELECTION_UNDIR)
set_pivot_point_for_block_and_char_wise(term, *pivot_start, new_direction);
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (new_direction == SELECTION_LEFT)
new_start = *pivot_end;
else
new_start = *pivot_start;
term->selection.direction = new_direction;
} else {
if (new_end.row < pivot_start->row ||
(new_end.row == pivot_start->row &&
new_end.col < pivot_start->col))
{
/* New end point is before the start point */
new_direction = SELECTION_LEFT;
} else {
/* The new end point is after the start point */
new_direction = SELECTION_RIGHT;
}
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (term->selection.direction != new_direction) {
if (term->selection.direction == SELECTION_UNDIR &&
pivot_end->row < 0)
{
set_pivot_point_for_block_and_char_wise(
term, *pivot_start, new_direction);
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
}
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
if (new_direction == SELECTION_LEFT) {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(pivot_end->row >= 0);
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
new_start = *pivot_end;
} else
new_start = *pivot_start;
selection: allow selections to pivot around a range instead of a point Extend selection pivoting to allow selections to pivot around a range. Use this in word- and row-based selections to pivot around the initial word/row that was selected. This mimics the behavior of at least urxvt and xterm.
2021-01-03 13:11:46 +01:00
selection: break out pivot point adjustment for character-wise selections
2021-01-06 10:54:53 +01:00
term->selection.direction = new_direction;
selection: adjust start point when the selection changes direction Without this, the initial cell will always be selected, regardless of how the selection is moved to the left or right. With this patch, the initial cell will only be selected while the selection is being made in the original direction. Changing direction of the selection moves the start point to next/previous character.
2020-08-12 18:50:49 +02:00
}
}
}
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
switch (term->selection.kind) {
case SELECTION_CHAR_WISE:
case SELECTION_BLOCK:
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
break;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_WORD_WISE:
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
switch (term->selection.direction) {
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
case SELECTION_LEFT: {
struct coord end = {col, row};
selection: expose find_word_boundary_{left,right}()
2021-03-28 21:03:53 +02:00
selection_find_word_boundary_left(
term, &end, term->selection.spaces_only);
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
new_end = (struct coord){end.col, term->grid->view + end.row};
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
break;
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
}
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
case SELECTION_RIGHT: {
struct coord end = {col, row};
selection: expose find_word_boundary_{left,right}()
2021-03-28 21:03:53 +02:00
selection_find_word_boundary_right(
term, &end, term->selection.spaces_only);
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
new_end = (struct coord){end.col, term->grid->view + end.row};
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
break;
selection: update: find_word_boundary_{left,right}: coordinates are screen local
2021-01-03 15:15:34 +01:00
}
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
case SELECTION_UNDIR:
break;
}
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
break;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_LINE_WISE:
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
switch (term->selection.direction) {
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
case SELECTION_LEFT: {
struct coord end = {0, row};
selection_find_line_boundary_left(
term, &end, term->selection.spaces_only);
new_end = (struct coord){end.col, term->grid->view + end.row};
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
break;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
}
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
case SELECTION_RIGHT: {
struct coord end = {col, row};
selection_find_line_boundary_right(
term, &end, term->selection.spaces_only);
new_end = (struct coord){end.col, term->grid->view + end.row};
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
break;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
}
selection: wip: update selection row-wise when initial selection was by row
2021-01-02 21:26:28 +01:00
case SELECTION_UNDIR:
break;
}
break;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_NONE:
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
BUG("Invalid selection kind");
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
break;
selection: wip: update selection word-wise when initial selection was by word
2021-01-02 21:20:41 +01:00
}
selection: update: get start-row pointer *after* modifying the start row index
2021-01-03 16:01:05 +01:00
size_t start_row_idx = new_start.row & (term->grid->num_rows - 1);
size_t end_row_idx = new_end.row & (term->grid->num_rows - 1);
const struct row *row_start = term->grid->rows[start_row_idx];
const struct row *row_end = term->grid->rows[end_row_idx];
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
/* If an end point is in the middle of a multi-column character,
* expand the selection to cover the entire character */
selection: don't allow only half of double-width characters to be selected
2020-06-02 18:21:39 +02:00
if (new_start.row < new_end.row ||
(new_start.row == new_end.row && new_start.col <= new_end.col))
{
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
while (new_start.col >= 1 &&
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
row_start->cells[new_start.col].wc >= CELL_SPACER)
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
new_start.col--;
while (new_end.col < term->cols - 1 &&
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
row_end->cells[new_end.col + 1].wc >= CELL_SPACER)
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
new_end.col++;
selection: don't allow only half of double-width characters to be selected
2020-06-02 18:21:39 +02:00
} else {
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
while (new_end.col >= 1 &&
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
row_end->cells[new_end.col].wc >= CELL_SPACER)
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
new_end.col--;
while (new_start.col < term->cols - 1 &&
term: rename CELL_MULT_COL_SPACER -> CELL_SPACER, and change its definition Instead of using CELL_SPACER for *all* cells that previously used CELL_MULT_COL_SPACER, include the remaining number of spacers following, and including, itself. This is encoded by adding to the CELL_SPACER value. So, a double width character will now store the character itself in the first cell (just like before), and CELL_SPACER+1 in the second cell. A three-cell character would store the character itself, then CELL_SPACER+2, and finally CELL_SPACER+1. In other words, the last spacer is always CELL_SPACER+1. CELL_SPACER+0 is used when padding at the right margin. I.e. when writing e.g. a double width character in the last column, we insert a CELL_SPACER+0 pad character, and then write the double width character in the first column on the next row.
2021-05-14 14:41:02 +02:00
row_start->cells[new_start.col + 1].wc >= CELL_SPACER)
selection: improve handling of multi-column characters * Don't assume multi-column characters are exactly *two* columns * Check for CELL_MULT_COL_SPACER values instead of using wcwidth()
2020-08-13 18:33:22 +02:00
new_start.col++;
selection: don't allow only half of double-width characters to be selected
2020-06-02 18:21:39 +02:00
}
selection_modify(term, new_start, new_end);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
selection: invalidate *all* affected lines when updating selection
2019-07-11 11:10:12 +02:00
selection/render: sync cells' 'selected' bit before rendering For performance reasons, we track whether a cell is selected or not using a bit in a cell's attributes. This makes it easy for the renderer to determine if the cells should be rendered as selected or not - it just have to look at the 'selected' bit instead of doing a complex range check against the current selection. This works nicely in most cases. But, if the cell is updated, the 'selected' bit is cleared. This results in the renderer rendering the cell normally, i.e. _not_ selected. Checking for this, and re-setting the 'selected' bit when the cell is updated (printed to) is way too expensive as it is in the hot path. Instead, sync the 'selected' bits just before rendering. This isn't so bad as it may sound; if there is no selection this is a no-op. Even if there is a selection, only those cells whose 'selected' bit have been cleared are dirtied (and thus re-rendered) - these cells would have been re-rendered anyway.
2020-05-16 21:36:08 +02:00
void
selection_dirty_cells(struct terminal *term)
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row < 0 || term->selection.coords.end.row < 0)
selection/render: sync cells' 'selected' bit before rendering For performance reasons, we track whether a cell is selected or not using a bit in a cell's attributes. This makes it easy for the renderer to determine if the cells should be rendered as selected or not - it just have to look at the 'selected' bit instead of doing a complex range check against the current selection. This works nicely in most cases. But, if the cell is updated, the 'selected' bit is cleared. This results in the renderer rendering the cell normally, i.e. _not_ selected. Checking for this, and re-setting the 'selected' bit when the cell is updated (printed to) is way too expensive as it is in the hot path. Instead, sync the 'selected' bits just before rendering. This isn't so bad as it may sound; if there is no selection this is a no-op. Even if there is a selection, only those cells whose 'selected' bit have been cleared are dirtied (and thus re-rendered) - these cells would have been re-rendered anyway.
2020-05-16 21:36:08 +02:00
return;
foreach_selected(
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term, term->selection.coords.start, term->selection.coords.end, &mark_selected,
don't use empty struct initializers
2020-08-23 07:42:20 +02:00
&(struct mark_context){0});
selection/render: sync cells' 'selected' bit before rendering For performance reasons, we track whether a cell is selected or not using a bit in a cell's attributes. This makes it easy for the renderer to determine if the cells should be rendered as selected or not - it just have to look at the 'selected' bit instead of doing a complex range check against the current selection. This works nicely in most cases. But, if the cell is updated, the 'selected' bit is cleared. This results in the renderer rendering the cell normally, i.e. _not_ selected. Checking for this, and re-setting the 'selected' bit when the cell is updated (printed to) is way too expensive as it is in the hot path. Instead, sync the 'selected' bits just before rendering. This isn't so bad as it may sound; if there is no selection this is a no-op. Even if there is a selection, only those cells whose 'selected' bit have been cleared are dirtied (and thus re-rendered) - these cells would have been re-rendered anyway.
2020-05-16 21:36:08 +02:00
}
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
static void
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
selection_extend_normal(struct terminal *term, int col, int row,
enum selection_kind new_kind)
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
const struct coord *start = &term->selection.coords.start;
const struct coord *end = &term->selection.coords.end;
selection: add a selection API
2019-07-11 09:51:51 +02:00
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
if (start->row > end->row ||
(start->row == end->row && start->col > end->col))
{
const struct coord *tmp = start;
start = end;
end = tmp;
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
}
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(start->row < end->row || start->col < end->col);
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
struct coord new_start, new_end;
selection: fix enum type enum selection_scroll_direction is used when extending a selection by auto-scrolling the terminal content while the mouse is outside the grid. What we want is enum selection_direction.
2020-11-06 20:12:15 +01:00
enum selection_direction direction;
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
if (row < start->row || (row == start->row && col < start->col)) {
/* Extend selection to start *before* current start */
selection: extending a selection is now interactive That is, a selection extension can be resized just like an ordinary extension.
2020-07-27 16:44:41 +02:00
new_start = *end;
new_end = (struct coord){col, row};
selection: explicitly set direction when right-click extending Fixes an issue where right-click-and-dragging to extend a selection caused one cell being removed from the selection. Closes #180
2020-11-04 19:01:59 +01:00
direction = SELECTION_LEFT;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
else if (row > end->row || (row == end->row && col > end->col)) {
/* Extend selection to end *after* current end */
new_start = *start;
new_end = (struct coord){col, row};
selection: explicitly set direction when right-click extending Fixes an issue where right-click-and-dragging to extend a selection caused one cell being removed from the selection. Closes #180
2020-11-04 19:01:59 +01:00
direction = SELECTION_RIGHT;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
else {
/* Shrink selection from start or end, depending on which one is closest */
const int linear = row * term->cols + col;
if (abs(linear - (start->row * term->cols + start->col)) <
abs(linear - (end->row * term->cols + end->col)))
{
/* Move start point */
selection: extending a selection is now interactive That is, a selection extension can be resized just like an ordinary extension.
2020-07-27 16:44:41 +02:00
new_start = *end;
new_end = (struct coord){col, row};
selection: explicitly set direction when right-click extending Fixes an issue where right-click-and-dragging to extend a selection caused one cell being removed from the selection. Closes #180
2020-11-04 19:01:59 +01:00
direction = SELECTION_LEFT;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
else {
/* Move end point */
new_start = *start;
new_end = (struct coord){col, row};
selection: explicitly set direction when right-click extending Fixes an issue where right-click-and-dragging to extend a selection caused one cell being removed from the selection. Closes #180
2020-11-04 19:01:59 +01:00
direction = SELECTION_RIGHT;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
}
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
const bool spaces_only = term->selection.spaces_only;
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
switch (term->selection.kind) {
case SELECTION_CHAR_WISE:
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(new_kind == SELECTION_CHAR_WISE);
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
set_pivot_point_for_block_and_char_wise(term, new_start, direction);
break;
case SELECTION_WORD_WISE: {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(new_kind == SELECTION_CHAR_WISE ||
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
new_kind == SELECTION_WORD_WISE);
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
struct coord pivot_start = {new_start.col, new_start.row - term->grid->view};
struct coord pivot_end = pivot_start;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
selection_find_word_boundary_left(term, &pivot_start, spaces_only);
selection_find_word_boundary_right(term, &pivot_end, spaces_only);
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
term->selection.pivot.start =
(struct coord){pivot_start.col, term->grid->view + pivot_start.row};
term->selection.pivot.end =
(struct coord){pivot_end.col, term->grid->view + pivot_end.row};
break;
}
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
case SELECTION_LINE_WISE: {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(new_kind == SELECTION_CHAR_WISE ||
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
new_kind == SELECTION_LINE_WISE);
struct coord pivot_start = {new_start.col, new_start.row - term->grid->view};
struct coord pivot_end = pivot_start;
selection_find_line_boundary_left(term, &pivot_start, spaces_only);
selection_find_line_boundary_right(term, &pivot_end, spaces_only);
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
term->selection.pivot.start =
(struct coord){pivot_start.col, term->grid->view + pivot_start.row};
term->selection.pivot.end =
(struct coord){pivot_end.col, term->grid->view + pivot_end.row};
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
break;
selection: line-wise selection now handles soft line-wrapping Previously, soft-wrapped lines were not selected correctly, as the selection logic was hardcoded to simply select everything between the first and last column on the current terminal row. Now, we scan backward and forward, looking for hard-wrapped lines. This is similar to how word-based selection works. Closes #726
2021-09-30 13:39:23 +02:00
}
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
case SELECTION_BLOCK:
case SELECTION_NONE:
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
BUG("Invalid selection kind in this context");
selection: extend: re-calculate pivot point
2021-01-06 11:07:19 +01:00
break;
}
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
term->selection.kind = new_kind;
selection: explicitly set direction when right-click extending Fixes an issue where right-click-and-dragging to extend a selection caused one cell being removed from the selection. Closes #180
2020-11-04 19:01:59 +01:00
term->selection.direction = direction;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
selection_modify(term, new_start, new_end);
}
static void
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
selection_extend_block(struct terminal *term, int col, int row)
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
const struct coord *start = &term->selection.coords.start;
const struct coord *end = &term->selection.coords.end;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
struct coord top_left = {
.row = min(start->row, end->row),
.col = min(start->col, end->col),
};
struct coord top_right = {
.row = min(start->row, end->row),
.col = max(start->col, end->col),
};
struct coord bottom_left = {
.row = max(start->row, end->row),
.col = min(start->col, end->col),
};
struct coord bottom_right = {
.row = max(start->row, end->row),
.col = max(start->col, end->col),
};
struct coord new_start;
struct coord new_end;
selection: extend-block: update pivot point and selection direction
2021-01-06 11:14:11 +01:00
enum selection_direction direction = SELECTION_UNDIR;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
if (row <= top_left.row ||
abs(row - top_left.row) < abs(row - bottom_left.row))
{
/* Move one of the top corners */
if (abs(col - top_left.col) < abs(col - top_right.col)) {
selection: extending a selection is now interactive That is, a selection extension can be resized just like an ordinary extension.
2020-07-27 16:44:41 +02:00
new_start = bottom_right;
new_end = (struct coord){col, row};
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
else {
selection: extending a selection is now interactive That is, a selection extension can be resized just like an ordinary extension.
2020-07-27 16:44:41 +02:00
new_start = bottom_left;
new_end = (struct coord){col, row};
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
}
}
else {
/* Move one of the bottom corners */
if (abs(col - bottom_left.col) < abs(col - bottom_right.col)) {
new_start = top_right;
new_end = (struct coord){col, row};
}
else {
new_start = top_left;
new_end = (struct coord){col, row};
}
}
selection: extend-block: update pivot point and selection direction
2021-01-06 11:14:11 +01:00
direction = col > new_start.col ? SELECTION_RIGHT : SELECTION_LEFT;
set_pivot_point_for_block_and_char_wise(term, new_start, direction);
term->selection.direction = direction;
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
selection_modify(term, new_start, new_end);
}
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_extend(struct seat *seat, struct terminal *term,
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
int col, int row, enum selection_kind new_kind)
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row < 0 || term->selection.coords.end.row < 0) {
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
/* No existing selection */
return;
}
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
if (term->selection.kind == SELECTION_BLOCK && new_kind != SELECTION_BLOCK)
return;
selection: extend: set ongoing to true
2020-08-11 10:16:52 +02:00
term->selection.ongoing = true;
selection: extend: new row must be offsetted with the current view offset
2020-04-04 12:05:40 +02:00
row += term->grid->view;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if ((row == term->selection.coords.start.row && col == term->selection.coords.start.col) ||
(row == term->selection.coords.end.row && col == term->selection.coords.end.col))
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
{
/* Extension point *is* one of the current end points */
return;
}
switch (term->selection.kind) {
case SELECTION_NONE:
Convert all but 2 remaining uses of xassert(false) to BUG("...")
2021-02-10 09:01:51 +00:00
BUG("Invalid selection kind");
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
return;
selection: combine enum selection_kind with selection_semantic
2021-01-06 10:53:27 +01:00
case SELECTION_CHAR_WISE:
case SELECTION_WORD_WISE:
case SELECTION_LINE_WISE:
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
selection_extend_normal(term, col, row, new_kind);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
break;
case SELECTION_BLOCK:
config: add ‘select-extend-character-wise’ bind action This forces the (new) selection mode to be character-wise when extending a word- or line-wise selection. Default key binding is ctrl+RMB.
2021-01-06 11:11:46 +01:00
selection_extend_block(term, col, row);
selection: add selection_extend() This function extends an existing selection in the following way: If the extension point is *before* the upper boundary of the current selection, extend the selection upwards. If the extension point is *after* the bottom boundary of the current selection, extend the selection downwards. If the extension point is *inside* the current selection, shrink the selection such that the new size is maximized. This means we move the *closest* start/end point from in the current selection.
2020-04-04 11:59:15 +02:00
break;
}
selection: add a selection API
2019-07-11 09:51:51 +02:00
}
wip: multi-seat support Compiles and runs, but mouse, clipboard and other things have been disabled.
2020-07-08 16:45:26 +02:00
//static const struct zwp_primary_selection_source_v1_listener primary_selection_source_listener;
selection: implement copy *to* primary
2019-07-11 17:34:52 +02:00
selection: add a selection API
2019-07-11 09:51:51 +02:00
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_finalize(struct seat *seat, struct terminal *term, uint32_t serial)
selection: add a selection API
2019-07-11 09:51:51 +02:00
{
config: add mouse specific bind actions This extends the "normal" bind action enum with mouse specific actions. When parsing key bindings, we only check up to the last valid keyboard binding, while mouse bindings support *both* key actions and mouse actions. The new actions are: * select-begin: starts an interactive selection * select-extend: interactively extend an existing selection * select-word: select word under cursor * select-word-whitespace: select word under cursor, where the only word separating characters are whitespace characters. The old hard-coded selection "bindings" have been converted to instead use these actions, via default bindings added to the configuration.
2020-08-11 09:55:33 +02:00
if (!term->selection.ongoing)
return;
input: rework mouse button/motion handling Store a list of currently pressed buttons, and which surface they belong to (i.e. which surface that received the press). Then, in motion events (with a button pressed, aka drag operations), send the event to the “original” surface (that received the press). Also send release events to the originating surface. This means a surface receiving a press will always receive a corresponding release. And no one will receive a release event without a corresponding press event. Motion events with a button pressed will *always* use the *first* button that was pressed. I.e. if you press a button, start dragging, and then press another button, we keep generating motion events for the *first* button.
2020-12-12 19:05:24 +01:00
LOG_DBG("selection finalize");
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
selection_stop_scroll_timer(term);
config: add mouse specific bind actions This extends the "normal" bind action enum with mouse specific actions. When parsing key bindings, we only check up to the last valid keyboard binding, while mouse bindings support *both* key actions and mouse actions. The new actions are: * select-begin: starts an interactive selection * select-extend: interactively extend an existing selection * select-word: select word under cursor * select-word-whitespace: select word under cursor, where the only word separating characters are whitespace characters. The old hard-coded selection "bindings" have been converted to instead use these actions, via default bindings added to the configuration.
2020-08-11 09:55:33 +02:00
term->selection.ongoing = false;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row < 0 || term->selection.coords.end.row < 0)
selection: finalize: clear ongoing selection Check for ongoing selection, and *clear* it before bailing out due to the selection not having an end-point. This fixes an issue where a selection was kept as ongoing, even though the button had been released. Typically triggered by clicking without moving the mouse; this started a new selection, then (tried to) finalize it, but failed since the selection didn't have an end-point.
2020-08-11 10:15:01 +02:00
return;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
xassert(term->selection.coords.start.row != -1);
xassert(term->selection.coords.end.row != -1);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start.row &= (term->grid->num_rows - 1);
term->selection.coords.end.row &= (term->grid->num_rows - 1);
selection: copy selected text to the target configured by ‘selection-target’ Closes #288
2021-01-16 11:26:45 +01:00
switch (term->conf->selection_target) {
config: add ‘none’ as a possible value for ‘selection-target’ When ‘selection-target’ is set to ‘none’, selecting text does not copy the text to _any_ clipboard. This patch also refactors the value parsing to be data driven.
2021-01-16 15:39:44 +01:00
case SELECTION_TARGET_NONE:
break;
selection: copy selected text to the target configured by ‘selection-target’ Closes #288
2021-01-16 11:26:45 +01:00
case SELECTION_TARGET_PRIMARY:
selection_to_primary(seat, term, serial);
break;
case SELECTION_TARGET_CLIPBOARD:
selection_to_clipboard(seat, term, serial);
break;
case SELECTION_TARGET_BOTH:
selection_to_primary(seat, term, serial);
selection_to_clipboard(seat, term, serial);
break;
}
selection: add a selection API
2019-07-11 09:51:51 +02:00
}
void
selection_cancel(struct terminal *term)
{
LOG_DBG("selection cancelled: start = %d,%d end = %d,%d",
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start.row, term->selection.coords.start.col,
term->selection.coords.end.row, term->selection.coords.end.col);
selection: add a selection API
2019-07-11 09:51:51 +02:00
selection: cancel: call selection_stop_scroll_timer() Instead of re-implementing the same logic, simply call selection_stop_scroll_timer().
2020-10-11 18:24:47 +02:00
selection_stop_scroll_timer(term);
selection: don't highlight trailing empty cells in a selection This makes it clear which cells contain spaces (that will be copied) or are empty (will *not* be copied).
2020-08-12 18:54:51 +02:00
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row >= 0 && term->selection.coords.end.row >= 0) {
selection: update: don't dirty cells that don't change state Previously when updating a selection, we would unmark *all* cells in the old selection, and then mark all cells in the new selection. This caused *all* cells to be dirtied and thus re-rendered. Avoid this, by adding a temporary state to the cells' selected state. Before unmarking the old selection, pre-mark the new selection using a temporary state. When unmarking the old selection, ignore cells in this temporary state. When marking the new selection, ignore cells in this temporary state (except clearing the temporary state).
2020-01-06 11:56:18 +01:00
foreach_selected(
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term, term->selection.coords.start, term->selection.coords.end,
don't use empty struct initializers
2020-08-23 07:42:20 +02:00
&unmark_selected, &(struct mark_context){0});
selection: store cell 'selected' state in the cells' attributes Instead of having the renderer calculate, for each cell, whether that cell is currently selected or not, make selection_update() mark/unmark the selected cells. The renderer now only has to look at the cells' 'selected' attribute. This makes the renderer both smaller and faster.
2020-01-04 12:03:04 +01:00
render_refresh(term);
}
selection: add a selection API
2019-07-11 09:51:51 +02:00
selection: selection_cancel() now sets 'kind' to SELECTION_NONE
2020-01-04 12:09:09 +01:00
term->selection.kind = SELECTION_NONE;
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
term->selection.coords.start = (struct coord){-1, -1};
term->selection.coords.end = (struct coord){-1, -1};
selection: cancel: reset pivot coordinates
2021-01-03 15:25:43 +01:00
term->selection.pivot.start = (struct coord){-1, -1};
term->selection.pivot.end = (struct coord){-1, -1};
selection: adjust start point when the selection changes direction Without this, the initial cell will always be selected, regardless of how the selection is moved to the left or right. With this patch, the initial cell will only be selected while the selection is being made in the original direction. Changing direction of the selection moves the start point to next/previous character.
2020-08-12 18:50:49 +02:00
term->selection.direction = SELECTION_UNDIR;
config: add mouse specific bind actions This extends the "normal" bind action enum with mouse specific actions. When parsing key bindings, we only check up to the last valid keyboard binding, while mouse bindings support *both* key actions and mouse actions. The new actions are: * select-begin: starts an interactive selection * select-extend: interactively extend an existing selection * select-word: select word under cursor * select-word-whitespace: select word under cursor, where the only word separating characters are whitespace characters. The old hard-coded selection "bindings" have been converted to instead use these actions, via default bindings added to the configuration.
2020-08-11 09:55:33 +02:00
term->selection.ongoing = false;
search: reset match state when selection is cancelled While we’re in scrollback search mode, the selection may be cancelled (for example, if the application is scrolling out the selected text). Trying to e.g. extend the search selection after this has happened triggered a crash. This fixes it by simply resetting the search match state when the selection is cancelled. Closes #644
2021-07-22 17:53:29 +02:00
search_selection_cancelled(term);
selection: add a selection API
2019-07-11 09:51:51 +02:00
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
selection: add selection_<type>_has_data() Returns true when there is data available for paste in the clipboard/primary selection.
2020-09-09 18:45:10 +02:00
bool
selection_clipboard_has_data(const struct seat *seat)
{
return seat->clipboard.data_offer != NULL;
}
bool
selection_primary_has_data(const struct seat *seat)
{
return seat->primary.data_offer != NULL;
}
selection: add selection_<type>_unset() These functions clear the current selection.
2020-09-09 18:44:49 +02:00
void
selection_clipboard_unset(struct seat *seat)
{
struct wl_clipboard *clipboard = &seat->clipboard;
if (clipboard->data_source == NULL)
return;
/* Kill previous data source */
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(clipboard->serial != 0);
selection: add selection_<type>_unset() These functions clear the current selection.
2020-09-09 18:44:49 +02:00
wl_data_device_set_selection(seat->data_device, NULL, clipboard->serial);
wl_data_source_destroy(clipboard->data_source);
clipboard->data_source = NULL;
clipboard->serial = 0;
free(clipboard->text);
clipboard->text = NULL;
}
void
selection_primary_unset(struct seat *seat)
{
struct wl_primary *primary = &seat->primary;
if (primary->data_source == NULL)
return;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(primary->serial != 0);
selection: add selection_<type>_unset() These functions clear the current selection.
2020-09-09 18:44:49 +02:00
zwp_primary_selection_device_v1_set_selection(
seat->primary_selection_device, NULL, primary->serial);
zwp_primary_selection_source_v1_destroy(primary->data_source);
primary->data_source = NULL;
primary->serial = 0;
free(primary->text);
primary->text = NULL;
}
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
static bool
fdm_scroll_timer(struct fdm *fdm, int fd, int events, void *data)
{
if (events & EPOLLHUP)
return false;
struct terminal *term = data;
uint64_t expiration_count;
ssize_t ret = read(
term->selection.auto_scroll.fd,
&expiration_count, sizeof(expiration_count));
if (ret < 0) {
if (errno == EAGAIN)
return true;
LOG_ERRNO("failed to read selection scroll timer");
return false;
}
switch (term->selection.auto_scroll.direction) {
selection: auto-scroll: add SELECTION_SCROLL_NOT as a scroll ‘direction’
2020-10-11 18:18:18 +02:00
case SELECTION_SCROLL_NOT:
return true;
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
case SELECTION_SCROLL_UP:
selection: auto-scroll: call cmd_scrollback_{up,down}() with number of rows No need to loop and call cmd_scrollback_{up,down}() with ‘1’ each loop iteration; just call it with the total number of lines to scroll.
2020-10-11 18:26:24 +02:00
cmd_scrollback_up(term, expiration_count);
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
selection_update(term, term->selection.auto_scroll.col, 0);
break;
case SELECTION_SCROLL_DOWN:
selection: auto-scroll: call cmd_scrollback_{up,down}() with number of rows No need to loop and call cmd_scrollback_{up,down}() with ‘1’ each loop iteration; just call it with the total number of lines to scroll.
2020-10-11 18:26:24 +02:00
cmd_scrollback_down(term, expiration_count);
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
selection_update(term, term->selection.auto_scroll.col, term->rows - 1);
break;
}
return true;
}
void
selection_start_scroll_timer(struct terminal *term, int interval_ns,
enum selection_scroll_direction direction, int col)
{
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(direction != SELECTION_SCROLL_NOT);
selection: auto-scroll: add SELECTION_SCROLL_NOT as a scroll ‘direction’
2020-10-11 18:18:18 +02:00
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
if (!term->selection.ongoing)
return;
if (term->selection.auto_scroll.fd < 0) {
int fd = timerfd_create(CLOCK_MONOTONIC, TFD_CLOEXEC | TFD_NONBLOCK);
if (fd < 0) {
LOG_ERRNO("failed to create selection scroll timer");
goto err;
}
if (!fdm_add(term->fdm, fd, EPOLLIN, &fdm_scroll_timer, term)) {
close(fd);
return;
}
term->selection.auto_scroll.fd = fd;
}
struct itimerspec timer;
if (timerfd_gettime(term->selection.auto_scroll.fd, &timer) < 0) {
LOG_ERRNO("failed to get current selection scroll timer value");
goto err;
}
if (timer.it_value.tv_sec == 0 && timer.it_value.tv_nsec == 0)
timer.it_value.tv_nsec = 1;
timer.it_interval.tv_sec = interval_ns / 1000000000;
timer.it_interval.tv_nsec = interval_ns % 1000000000;
if (timerfd_settime(term->selection.auto_scroll.fd, 0, &timer, NULL) < 0) {
LOG_ERRNO("failed to set new selection scroll timer value");
goto err;
}
term->selection.auto_scroll.direction = direction;
term->selection.auto_scroll.col = col;
return;
err:
selection_stop_scroll_timer(term);
return;
}
void
selection_stop_scroll_timer(struct terminal *term)
{
selection: auto-scroll: add SELECTION_SCROLL_NOT as a scroll ‘direction’
2020-10-11 18:18:18 +02:00
if (term->selection.auto_scroll.fd < 0) {
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(term->selection.auto_scroll.direction == SELECTION_SCROLL_NOT);
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
return;
selection: auto-scroll: add SELECTION_SCROLL_NOT as a scroll ‘direction’
2020-10-11 18:18:18 +02:00
}
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
fdm_del(term->fdm, term->selection.auto_scroll.fd);
term->selection.auto_scroll.fd = -1;
selection: auto-scroll: add SELECTION_SCROLL_NOT as a scroll ‘direction’
2020-10-11 18:18:18 +02:00
term->selection.auto_scroll.direction = SELECTION_SCROLL_NOT;
selection: auto-scroll: selection keeps scrolling while mouse is outside grid Moving the mouse outside the grid while we have an on-going selection now starts a timer. The interval of this timer depends on the mouse’s distance from the grid - the further away the mouse is, the shorter interval. On each timer timeout, we scroll one line, and update the selection. Thus, the shorter the interval, the faster we scroll. The timer is canceled as soon as the mouse enters the grid again, or the selection is either canceled or finalized. The timer FD is created and destroyed on-demand. Most of the logic is now in selection.c. The exception is the calculation of the timer interval, which depends on the mouse’s position. Thus, this is done in input.c. The scroll+selection update logic needs to know a) which direction we’re scrolling in, and b) which *column* the selection should be updated with. If the mouse is outside the grid’s left or right margins, the stored mouse column will be -1. I.e. we don’t know whether the mouse is on the left or right side of the grid. This is why the caller, that starts the timer, must provide this value. The same applies to top and bottom margins, but since we already have the scroll *direction*, which row value to use can be derived from this.
2020-10-11 15:44:20 +02:00
}
wip: multi-seat support Compiles and runs, but mouse, clipboard and other things have been disabled.
2020-07-08 16:45:26 +02:00
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
target(void *data, struct wl_data_source *wl_data_source, const char *mime_type)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
LOG_DBG("TARGET: mime-type=%s", mime_type);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
struct clipboard_send {
char *data;
size_t len;
size_t idx;
};
static bool
fdm_send(struct fdm *fdm, int fd, int events, void *data)
{
selection: initialize 'ctx' before jumping into its scope
2019-11-05 08:51:10 +01:00
struct clipboard_send *ctx = data;
selection: async send: handle POLLHUP
2019-11-05 08:40:39 +01:00
if (events & EPOLLHUP)
goto done;
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
switch (async_write(fd, ctx->data, ctx->len, &ctx->idx)) {
case ASYNC_WRITE_REMAIN:
return true;
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
case ASYNC_WRITE_DONE:
break;
case ASYNC_WRITE_ERR:
LOG_ERRNO(
"failed to asynchronously write %zu of selection data to FD=%d",
ctx->len - ctx->idx, fd);
break;
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
}
selection: async send: handle POLLHUP
2019-11-05 08:40:39 +01:00
done:
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
fdm_del(fdm, fd);
free(ctx->data);
free(ctx);
return true;
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
send_clipboard_or_primary(struct seat *seat, int fd, const char *selection,
const char *source_name)
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
{
selection: free strdup:ed clipboard data on fdm failure
2019-11-05 08:40:24 +01:00
/* Make it NONBLOCK:ing right away - we don't want to block if the
* initial attempt to send the data synchronously fails */
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
int flags;
if ((flags = fcntl(fd, F_GETFL)) < 0 ||
fcntl(fd, F_SETFL, flags | O_NONBLOCK) < 0)
{
LOG_ERRNO("failed to set O_NONBLOCK");
return;
selection: handle partial writes and EINTR when writing to clipboard
2019-07-11 16:26:25 +02:00
}
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
size_t len = strlen(selection);
async: first synchronous write may succeed partially When trying to write (to e.g. the slave, or to a clipboard receiver), we first try to send the data synchronously, and only if that fails do we switch to asynchronous mode. However, the first synchronous may (in fact, is likely to) succeed partially.
2019-11-28 19:20:25 +01:00
size_t async_idx = 0;
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
async: first synchronous write may succeed partially When trying to write (to e.g. the slave, or to a clipboard receiver), we first try to send the data synchronously, and only if that fails do we switch to asynchronous mode. However, the first synchronous may (in fact, is likely to) succeed partially.
2019-11-28 19:20:25 +01:00
switch (async_write(fd, selection, len, &async_idx)) {
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
case ASYNC_WRITE_REMAIN: {
Convert most dynamic allocations to use functions from xmalloc.h
2020-08-08 20:34:30 +01:00
struct clipboard_send *ctx = xmalloc(sizeof(*ctx));
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
*ctx = (struct clipboard_send) {
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
.data = xstrdup(&selection[async_idx]),
.len = len - async_idx,
.idx = 0,
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
};
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
if (fdm_add(seat->wayl->fdm, fd, EPOLLOUT, &fdm_send, ctx))
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
return;
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
selection: free strdup:ed clipboard data on fdm failure
2019-11-05 08:40:24 +01:00
free(ctx->data);
selection: send primary/clipboard data asynchronously TODO: try writing synchronously first
2019-11-04 13:11:15 +01:00
free(ctx);
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
break;
}
case ASYNC_WRITE_DONE:
break;
case ASYNC_WRITE_ERR:
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
LOG_ERRNO("failed write %zu bytes of %s selection data to FD=%d",
len, source_name, fd);
selection: try to write selection data synchronously first Only if we fail to write everything do we switch to asynchronous mode.
2019-11-04 14:00:51 +01:00
break;
}
close(fd);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
static void
send(void *data, struct wl_data_source *wl_data_source, const char *mime_type,
int32_t fd)
{
struct seat *seat = data;
const struct wl_clipboard *clipboard = &seat->clipboard;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(clipboard->text != NULL);
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
send_clipboard_or_primary(seat, fd, clipboard->text, "clipboard");
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
cancelled(void *data, struct wl_data_source *wl_data_source)
{
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat = data;
struct wl_clipboard *clipboard = &seat->clipboard;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(clipboard->data_source == wl_data_source);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
wl_data_source_destroy(clipboard->data_source);
clipboard->data_source = NULL;
clipboard->serial = 0;
free(clipboard->text);
clipboard->text = NULL;
}
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
/* We don’t support dragging *from* */
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
dnd_drop_performed(void *data, struct wl_data_source *wl_data_source)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
//LOG_DBG("DnD drop performed");
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
dnd_finished(void *data, struct wl_data_source *wl_data_source)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
//LOG_DBG("DnD finished");
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
action(void *data, struct wl_data_source *wl_data_source, uint32_t dnd_action)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
//LOG_DBG("DnD action: %u", dnd_action);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static const struct wl_data_source_listener data_source_listener = {
.target = &target,
.send = &send,
.cancelled = &cancelled,
.dnd_drop_performed = &dnd_drop_performed,
.dnd_finished = &dnd_finished,
.action = &action,
};
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: implement copy *to* primary
2019-07-11 17:34:52 +02:00
static void
primary_send(void *data,
struct zwp_primary_selection_source_v1 *zwp_primary_selection_source_v1,
const char *mime_type, int32_t fd)
{
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat = data;
const struct wl_primary *primary = &seat->primary;
selection: implement copy *to* primary
2019-07-11 17:34:52 +02:00
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(primary->text != NULL);
selection: re-factor: break out code shared between clipboard/primary send The send functions are called by the compositor when another application wants to paste data *from* foot.
2020-10-13 18:38:49 +02:00
send_clipboard_or_primary(seat, fd, primary->text, "primary");
selection: implement copy *to* primary
2019-07-11 17:34:52 +02:00
}
static void
primary_cancelled(void *data,
struct zwp_primary_selection_source_v1 *zwp_primary_selection_source_v1)
{
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat = data;
struct wl_primary *primary = &seat->primary;
selection: implement copy *to* primary
2019-07-11 17:34:52 +02:00
zwp_primary_selection_source_v1_destroy(primary->data_source);
primary->data_source = NULL;
primary->serial = 0;
free(primary->text);
primary->text = NULL;
}
static const struct zwp_primary_selection_source_v1_listener primary_selection_source_listener = {
.send = &primary_send,
.cancelled = &primary_cancelled,
};
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
bool
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
text_to_clipboard(struct seat *seat, struct terminal *term, char *text, uint32_t serial)
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
{
selection: assert serial is non-zero before copying data to the clipboard
2022-04-23 15:49:25 +02:00
xassert(serial != 0);
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct wl_clipboard *clipboard = &seat->clipboard;
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
selection: we already have a direct pointer to the clipboard struct
2019-11-22 21:51:53 +01:00
if (clipboard->data_source != NULL) {
wayland: move clipboard/primary structs into the wayland struct These are application global and very wayland specific
2019-10-27 16:15:32 +01:00
/* Kill previous data source */
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(clipboard->serial != 0);
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
wl_data_device_set_selection(seat->data_device, NULL, clipboard->serial);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
wl_data_source_destroy(clipboard->data_source);
free(clipboard->text);
clipboard->data_source = NULL;
clipboard->serial = 0;
selection: reset clipboard/primary->text after free:ing it
2020-09-17 20:05:22 +02:00
clipboard->text = NULL;
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
clipboard->data_source
term: wayland struct is now not a part of the terminal struct We do however need access to it, so provide a pointer. The difference is that now we can have a *single* wayland instance, but multiple terminal instances.
2019-10-27 18:51:14 +01:00
= wl_data_device_manager_create_data_source(term->wl->data_device_manager);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
selection: cleanup
2019-07-11 16:37:45 +02:00
if (clipboard->data_source == NULL) {
LOG_ERR("failed to create clipboard data source");
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
return false;
selection: cleanup
2019-07-11 16:37:45 +02:00
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
clipboard->text = text;
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Configure source */
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
wl_data_source_offer(clipboard->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_UTF8]);
selection: offer clipboard content in more mime types
2020-11-30 20:02:47 +01:00
wl_data_source_offer(clipboard->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_PLAIN]);
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
wl_data_source_offer(clipboard->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_TEXT]);;
wl_data_source_offer(clipboard->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_STRING]);
wl_data_source_offer(clipboard->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_UTF8_STRING]);
selection: offer clipboard content in more mime types
2020-11-30 20:02:47 +01:00
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
wl_data_source_add_listener(clipboard->data_source, &data_source_listener, seat);
wl_data_device_set_selection(seat->data_device, clipboard->data_source, serial);
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Needed when sending the selection to other client */
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
clipboard->serial = serial;
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
return true;
}
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_to_clipboard(struct seat *seat, struct terminal *term, uint32_t serial)
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
{
refactor: add a ‘range’ struct, grouping a start and end coord together
2022-04-09 15:09:02 +02:00
if (term->selection.coords.start.row < 0 || term->selection.coords.end.row < 0)
selection: selection_to_clipboard: exit early on no-selection When there's no selection, exit early to avoid trying to get grid data from row -1.
2019-11-22 21:52:12 +01:00
return;
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
/* Get selection as a string */
config: add 'pipe-selected' key binding This works just like pipe-visible and pipe-scrollback, but pipes the user-selected text, if any, to the external tool. Closes #51
2020-07-31 17:02:53 +02:00
char *text = selection_to_text(term);
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
if (!text_to_clipboard(seat, term, text, serial))
selection: add text_to_clipboard() This function takes a string and makes it available to the clipboard.
2019-07-19 11:12:14 +02:00
free(text);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
struct clipboard_receive {
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
int read_fd;
int timeout_fd;
struct itimerspec timeout;
selection: don’t replace \r\n and \n with \r in bracketed paste mode
2021-01-27 10:44:28 +01:00
bool bracketed;
selection: don’t quote file URIs on the alt screen Closes #379
2022-02-02 21:17:01 +01:00
bool quote_paths;
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
void (*decoder)(struct clipboard_receive *ctx, char *data, size_t size);
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
void (*finish)(struct clipboard_receive *ctx);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
/* URI state */
bool add_space;
struct {
char *data;
size_t sz;
size_t idx;
} buf;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
/* Callback data */
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
void (*cb)(char *data, size_t size, void *user);
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
void (*done)(void *user);
void *user;
};
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
static void
clipboard_receive_done(struct fdm *fdm, struct clipboard_receive *ctx)
{
fdm_del(fdm, ctx->timeout_fd);
fdm_del(fdm, ctx->read_fd);
ctx->done(ctx->user);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
free(ctx->buf.data);
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
free(ctx);
}
static bool
fdm_receive_timeout(struct fdm *fdm, int fd, int events, void *data)
{
struct clipboard_receive *ctx = data;
if (events & EPOLLHUP)
return false;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(events & EPOLLIN);
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
uint64_t expire_count;
ssize_t ret = read(fd, &expire_count, sizeof(expire_count));
if (ret < 0) {
if (errno == EAGAIN)
return true;
LOG_ERRNO("failed to read clipboard timeout timer");
return false;
}
LOG_WARN("no data received from clipboard in %llu seconds, aborting",
(unsigned long long)ctx->timeout.it_value.tv_sec);
clipboard_receive_done(fdm, ctx);
return true;
}
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
static void
fdm_receive_decoder_plain(struct clipboard_receive *ctx, char *data, size_t size)
{
ctx->cb(data, size, ctx->user);
}
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
static void
fdm_receive_finish_plain(struct clipboard_receive *ctx)
{
}
selection: URI decoder: break out decoding of a single URI
2021-01-12 14:45:04 +01:00
static bool
decode_one_uri(struct clipboard_receive *ctx, char *uri, size_t len)
{
LOG_DBG("URI: \"%.*s\"", (int)len, uri);
selection: uri decode: move zero-length check into decode_one_uri()
2021-01-12 14:56:47 +01:00
if (len == 0)
return false;
selection: URI decoder: break out decoding of a single URI
2021-01-12 14:45:04 +01:00
char *scheme, *host, *path;
if (!uri_parse(uri, len, &scheme, NULL, NULL, &host, NULL, &path, NULL, NULL)) {
LOG_ERR("drag-and-drop: invalid URI: %.*s", (int)len, uri);
return false;
}
if (ctx->add_space)
ctx->cb(" ", 1, ctx->user);
ctx->add_space = true;
if (strcmp(scheme, "file") == 0 && hostname_is_localhost(host)) {
selection: don’t quote file URIs on the alt screen Closes #379
2022-02-02 21:17:01 +01:00
if (ctx->quote_paths)
ctx->cb("'", 1, ctx->user);
selection: URI decoder: break out decoding of a single URI
2021-01-12 14:45:04 +01:00
ctx->cb(path, strlen(path), ctx->user);
selection: don’t quote file URIs on the alt screen Closes #379
2022-02-02 21:17:01 +01:00
if (ctx->quote_paths)
ctx->cb("'", 1, ctx->user);
selection: URI decoder: break out decoding of a single URI
2021-01-12 14:45:04 +01:00
} else
ctx->cb(uri, len, ctx->user);
free(scheme);
free(host);
free(path);
return true;
}
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
static void
fdm_receive_decoder_uri(struct clipboard_receive *ctx, char *data, size_t size)
{
while (ctx->buf.idx + size > ctx->buf.sz) {
size_t new_sz = ctx->buf.sz == 0 ? size : 2 * ctx->buf.sz;
ctx->buf.data = xrealloc(ctx->buf.data, new_sz);
ctx->buf.sz = new_sz;
}
memcpy(&ctx->buf.data[ctx->buf.idx], data, size);
ctx->buf.idx += size;
char *start = ctx->buf.data;
char *end = NULL;
selection: don’t replace \r\n and \n with \r in bracketed paste mode
2021-01-27 10:44:28 +01:00
while (true) {
for (end = start; end < &ctx->buf.data[ctx->buf.idx]; end++) {
if (*end == '\r' || *end == '\n')
break;
}
if (end >= &ctx->buf.data[ctx->buf.idx])
break;
selection: URI decoder: break out decoding of a single URI
2021-01-12 14:45:04 +01:00
decode_one_uri(ctx, start, end - start);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
start = end + 1;
}
const size_t ofs = start - ctx->buf.data;
const size_t left = ctx->buf.idx - ofs;
memmove(&ctx->buf.data[0], &ctx->buf.data[ofs], left);
ctx->buf.idx = left;
}
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
static void
fdm_receive_finish_uri(struct clipboard_receive *ctx)
{
LOG_DBG("finish: %.*s", (int)ctx->buf.idx, ctx->buf.data);
selection: uri decode: move zero-length check into decode_one_uri()
2021-01-12 14:56:47 +01:00
decode_one_uri(ctx, ctx->buf.data, ctx->buf.idx);
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
}
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
static bool
fdm_receive(struct fdm *fdm, int fd, int events, void *data)
{
struct clipboard_receive *ctx = data;
if ((events & EPOLLHUP) && !(events & EPOLLIN))
goto done;
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
/* Reset timeout timer */
if (timerfd_settime(ctx->timeout_fd, 0, &ctx->timeout, NULL) < 0) {
LOG_ERRNO("failed to re-arm clipboard timeout timer");
return false;
}
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
/* Read until EOF */
while (true) {
char text[256];
ssize_t count = read(fd, text, sizeof(text));
if (count == -1) {
if (errno == EAGAIN || errno == EWOULDBLOCK)
return true;
LOG_ERRNO("failed to read clipboard data");
break;
}
if (count == 0)
break;
selection: replace \r\n and \n with \r, and strip \e from pasted text Closes #305 Closes #306
2021-01-20 19:20:03 +01:00
/*
* Call cb while at same time replace:
selection: don’t translate \r to \n when pasting In non-bracketed paste mode, we translate \n to \r, and \r\n to \r. The latter matches XTerm, urxvt, alacritty and kitty. The former matches alacritty and kitty (xterm and urxvt just blindly replaces all \n occurrences with \r, meaning \r\n is translated to \r\r. For some reason, we then unconditionally translated all \r back to \n, regardless of whether bracketed paste was enabled or not. Unsure why/where this comes from, but it doesn't match any of the other terminal emulators I tested. One example where this caused issues is in older versions of nano (at least up to 2.9). Closes #980
2022-03-16 20:17:02 +01:00
* - \r\n -> \r (non-bracketed paste)
* - \n -> \r (non-bracketed paste)
selection: codespell: stript -> strip
2021-01-23 11:28:41 +01:00
* - C0 -> <nothing> (strip non-formatting C0 characters)
selection: replace \r\n and \n with \r, and strip \e from pasted text Closes #305 Closes #306
2021-01-20 19:20:03 +01:00
* - \e -> <nothing> (i.e. strip ESC)
*/
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
char *p = text;
selection: optimize \r\n -> \n when receiving clipboard data Instead of first memmoving, possibly lots of data lots of times, the received buffer, and _then_ calling the callback, simply call the callback multiple times, and just skip the \r character(s).
2019-12-15 12:11:12 +01:00
size_t left = count;
selection: don’t strip formatting C0 control characters in bracketed paste mode It’s ok to let the receiving end handle formatting C0 control characters in bracketed paste mode. In fact, we *must* let them through. Otherwise it is impossible to paste e.g. tabs into editors and similar applications.
2021-02-12 10:03:01 +01:00
#define skip_one() \
do { \
ctx->decoder(ctx, p, i); \
xassert(i + 1 <= left); \
p += i + 1; \
left -= i + 1; \
} while (0)
selection: optimize \r\n -> \n when receiving clipboard data Instead of first memmoving, possibly lots of data lots of times, the received buffer, and _then_ calling the callback, simply call the callback multiple times, and just skip the \r character(s).
2019-12-15 12:11:12 +01:00
again:
selection: replace \r\n and \n with \r, and strip \e from pasted text Closes #305 Closes #306
2021-01-20 19:20:03 +01:00
for (size_t i = 0; i < left; i++) {
switch (p[i]) {
default:
break;
case '\n':
selection: don’t replace \r\n and \n with \r in bracketed paste mode
2021-01-27 10:44:28 +01:00
if (!ctx->bracketed)
p[i] = '\r';
selection: replace \r\n and \n with \r, and strip \e from pasted text Closes #305 Closes #306
2021-01-20 19:20:03 +01:00
break;
case '\r':
selection: strip non-formatting C0, BS, HT and DEL from pasted text
2021-01-23 11:22:22 +01:00
/* Convert \r\n -> \r */
selection: don’t replace \r\n and \n with \r in bracketed paste mode
2021-01-27 10:44:28 +01:00
if (!ctx->bracketed && i + 1 < left && p[i + 1] == '\n') {
selection: don’t strip formatting C0 control characters in bracketed paste mode It’s ok to let the receiving end handle formatting C0 control characters in bracketed paste mode. In fact, we *must* let them through. Otherwise it is impossible to paste e.g. tabs into editors and similar applications.
2021-02-12 10:03:01 +01:00
i++;
skip_one();
selection: replace \r\n and \n with \r, and strip \e from pasted text Closes #305 Closes #306
2021-01-20 19:20:03 +01:00
goto again;
}
break;
selection: strip non-formatting C0, BS, HT and DEL from pasted text
2021-01-23 11:22:22 +01:00
/* C0 non-formatting control characters (\b \t \n \r excluded) */
case '\x01': case '\x02': case '\x03': case '\x04': case '\x05':
selection: don’t strip formatting C0 control characters in bracketed paste mode It’s ok to let the receiving end handle formatting C0 control characters in bracketed paste mode. In fact, we *must* let them through. Otherwise it is impossible to paste e.g. tabs into editors and similar applications.
2021-02-12 10:03:01 +01:00
case '\x06': case '\x07': case '\x0e': case '\x0f': case '\x10':
case '\x11': case '\x12': case '\x13': case '\x14': case '\x15':
case '\x16': case '\x17': case '\x18': case '\x19': case '\x1a':
case '\x1b': case '\x1c': case '\x1d': case '\x1e': case '\x1f':
skip_one();
goto again;
selection: strip non-formatting C0, BS, HT and DEL from pasted text
2021-01-23 11:22:22 +01:00
/* Additional control characters stripped by default (but
* configurable) in XTerm: BS, HT, DEL */
selection: don’t strip formatting C0 control characters in bracketed paste mode It’s ok to let the receiving end handle formatting C0 control characters in bracketed paste mode. In fact, we *must* let them through. Otherwise it is impossible to paste e.g. tabs into editors and similar applications.
2021-02-12 10:03:01 +01:00
case '\b': case '\t': case '\v': case '\f': case '\x7f':
if (!ctx->bracketed) {
skip_one();
goto again;
}
break;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
}
}
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
ctx->decoder(ctx, p, left);
selection: optimize \r\n -> \n when receiving clipboard data Instead of first memmoving, possibly lots of data lots of times, the received buffer, and _then_ calling the callback, simply call the callback multiple times, and just skip the \r character(s).
2019-12-15 12:11:12 +01:00
left = 0;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
}
selection: don’t strip formatting C0 control characters in bracketed paste mode It’s ok to let the receiving end handle formatting C0 control characters in bracketed paste mode. In fact, we *must* let them through. Otherwise it is impossible to paste e.g. tabs into editors and similar applications.
2021-02-12 10:03:01 +01:00
#undef skip_one
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
done:
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
ctx->finish(ctx);
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
clipboard_receive_done(fdm, ctx);
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
return true;
}
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
static void
begin_receive_clipboard(struct terminal *term, int read_fd,
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
enum data_offer_mime_type mime_type,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
void (*cb)(char *data, size_t size, void *user),
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
void (*done)(void *user), void *user)
{
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
int timeout_fd = -1;
struct clipboard_receive *ctx = NULL;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
int flags;
if ((flags = fcntl(read_fd, F_GETFL)) < 0 ||
fcntl(read_fd, F_SETFL, flags | O_NONBLOCK) < 0)
{
LOG_ERRNO("failed to set O_NONBLOCK");
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
goto err;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
}
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
timeout_fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK | TFD_CLOEXEC);
if (timeout_fd < 0) {
LOG_ERRNO("failed to create clipboard timeout timer FD");
goto err;
}
const struct itimerspec timeout = {.it_value = {.tv_sec = 2}};
if (timerfd_settime(timeout_fd, 0, &timeout, NULL) < 0) {
codespell: selection: faild -> failed
2020-08-27 19:55:27 +02:00
LOG_ERRNO("failed to arm clipboard timeout timer");
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
goto err;
}
ctx = xmalloc(sizeof(*ctx));
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
*ctx = (struct clipboard_receive) {
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
.read_fd = read_fd,
.timeout_fd = timeout_fd,
.timeout = timeout,
selection: don’t replace \r\n and \n with \r in bracketed paste mode
2021-01-27 10:44:28 +01:00
.bracketed = term->bracketed_paste,
selection: don’t quote file URIs on the alt screen Closes #379
2022-02-02 21:17:01 +01:00
.quote_paths = term->grid == &term->normal,
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
.decoder = (mime_type == DATA_OFFER_MIME_URI_LIST
? &fdm_receive_decoder_uri
: &fdm_receive_decoder_plain),
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
.finish = (mime_type == DATA_OFFER_MIME_URI_LIST
? &fdm_receive_finish_uri
: &fdm_receive_finish_plain),
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
.cb = cb,
.done = done,
.user = user,
};
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
if (!fdm_add(term->fdm, read_fd, EPOLLIN, &fdm_receive, ctx) ||
!fdm_add(term->fdm, timeout_fd, EPOLLIN, &fdm_receive_timeout, ctx))
{
goto err;
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
}
selection: add a 2 second timeout when receiving clipboard data When reading clipboard data, a malicious clipboard provider could stall us forever, by not sending any data, and not closing the pipe. This commit adds a timer_fd based timeout of 2 seconds. If the timer triggers, we abort the clipboard receive.
2020-08-22 08:29:35 +02:00
return;
err:
free(ctx);
fdm_del(term->fdm, timeout_fd);
fdm_del(term->fdm, read_fd);
done(user);
selection: make text_from_{clipboard,primary} async
2019-11-05 09:09:51 +01:00
}
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
void
seat: use separate 'enter' serials for keyboard and mouse
2020-07-09 11:20:46 +02:00
text_from_clipboard(struct seat *seat, struct terminal *term,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
void (*cb)(char *data, size_t size, void *user),
selection: text_from_{clipboard,primary}: add 'done' callback This callback is *always* called, including when there has been an error. This is in preparation for making text_from_{clipboard,primary} asynchronous.
2019-11-05 08:49:32 +01:00
void (*done)(void *user), void *user)
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
{
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct wl_clipboard *clipboard = &seat->clipboard;
selection: do not try to paste un-handled mime types Closes #230
2020-11-30 20:04:17 +01:00
if (clipboard->data_offer == NULL ||
clipboard->mime_type == DATA_OFFER_MIME_UNSET)
{
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
done(user);
return;
}
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Prepare a pipe the other client can write its selection to us */
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
int fds[2];
if (pipe2(fds, O_CLOEXEC) == -1) {
LOG_ERRNO("failed to create pipe");
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
done(user);
return;
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
}
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
LOG_DBG("receive from clipboard: mime-type=%s",
mime_type_map[clipboard->mime_type]);
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
int read_fd = fds[0];
int write_fd = fds[1];
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Give write-end of pipe to other client */
selection: read until EOF when reading from clipboard
2019-07-11 16:27:12 +02:00
wl_data_offer_receive(
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
clipboard->data_offer, mime_type_map[clipboard->mime_type], write_fd);
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Don't keep our copy of the write-end open (or we'll never get EOF) */
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
close(write_fd);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
begin_receive_clipboard(term, read_fd, clipboard->mime_type, cb, done, user);
selection: add text_from_clipboard() This function reads data from the clipboard, and calls a user-provided callback for each chunk of clipboard data.
2019-07-19 14:20:00 +02:00
}
static void
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
receive_offer(char *data, size_t size, void *user)
selection: add text_from_clipboard() This function reads data from the clipboard, and calls a user-provided callback for each chunk of clipboard data.
2019-07-19 14:20:00 +02:00
{
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
struct terminal *term = user;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(term->is_sending_paste_data);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
term_paste_data_to_slave(term, data, size);
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
}
selection: don’t quote file URIs on the alt screen Closes #379
2022-02-02 21:17:01 +01:00
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
static void
receive_offer_done(void *user)
{
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
struct terminal *term = user;
selection: text_from_{clipboard,primary}: add 'done' callback This callback is *always* called, including when there has been an error. This is in preparation for making text_from_{clipboard,primary} asynchronous.
2019-11-05 08:49:32 +01:00
if (term->bracketed_paste)
selection: block non-paste data from being sent to client while pasting While pasting data from the clipboard, block *all* other data from being sent to the client. This includes keyboard and mouse events, but also replies for VT queries. This is particularly important when bracketed paste has been enabled, since then the client will interpret *everything* between the bracketed paste start and end as paste data.
2020-08-22 09:14:18 +02:00
term_paste_data_to_slave(term, "\033[201~", 6);
term->is_sending_paste_data = false;
/* Make sure we send any queued up non-paste data */
if (tll_length(term->ptmx_buffers) > 0)
fdm_event_add(term->fdm, term->ptmx, EPOLLOUT);
selection: text_from_{clipboard,primary}: add 'done' callback This callback is *always* called, including when there has been an error. This is in preparation for making text_from_{clipboard,primary} asynchronous.
2019-11-05 08:49:32 +01:00
}
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection: add text_from_clipboard() This function reads data from the clipboard, and calls a user-provided callback for each chunk of clipboard data.
2019-07-19 14:20:00 +02:00
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_from_clipboard(struct seat *seat, struct terminal *term, uint32_t serial)
selection: add text_from_clipboard() This function reads data from the clipboard, and calls a user-provided callback for each chunk of clipboard data.
2019-07-19 14:20:00 +02:00
{
selection: don't initiate a paste when we're already pasting
2020-08-22 16:30:52 +02:00
if (term->is_sending_paste_data) {
/* We're already pasting... */
return;
}
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct wl_clipboard *clipboard = &seat->clipboard;
selection: add text_from_clipboard() This function reads data from the clipboard, and calls a user-provided callback for each chunk of clipboard data.
2019-07-19 14:20:00 +02:00
if (clipboard->data_offer == NULL)
return;
selection: block non-paste data from being sent to client while pasting While pasting data from the clipboard, block *all* other data from being sent to the client. This includes keyboard and mouse events, but also replies for VT queries. This is particularly important when bracketed paste has been enabled, since then the client will interpret *everything* between the bracketed paste start and end as paste data.
2020-08-22 09:14:18 +02:00
term->is_sending_paste_data = true;
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
if (term->bracketed_paste)
selection: must use term_paste_data_to_slave() for paste data
2020-08-22 16:20:49 +02:00
term_paste_data_to_slave(term, "\033[200~", 6);
selection: read until EOF when reading from clipboard
2019-07-11 16:27:12 +02:00
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
text_from_clipboard(seat, term, &receive_offer, &receive_offer_done, term);
selection: add support for pasting from clipboard
2019-07-11 12:33:31 +02:00
}
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
bool
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
text_to_primary(struct seat *seat, struct terminal *term, char *text, uint32_t serial)
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
{
term: wayland struct is now not a part of the terminal struct We do however need access to it, so provide a pointer. The difference is that now we can have a *single* wayland instance, but multiple terminal instances.
2019-10-27 18:51:14 +01:00
if (term->wl->primary_selection_device_manager == NULL)
selection: primary: don't require compositor to implement it
2019-09-25 19:26:55 +02:00
return false;
selection: assert serial is non-zero before copying data to the clipboard
2022-04-23 15:49:25 +02:00
xassert(serial != 0);
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct wl_primary *primary = &seat->primary;
wayland: move clipboard/primary structs into the wayland struct These are application global and very wayland specific
2019-10-27 16:15:32 +01:00
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
/* TODO: somehow share code with the clipboard equivalent */
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
if (seat->primary.data_source != NULL) {
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
/* Kill previous data source */
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(primary->serial != 0);
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
zwp_primary_selection_device_v1_set_selection(
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
seat->primary_selection_device, NULL, primary->serial);
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
zwp_primary_selection_source_v1_destroy(primary->data_source);
free(primary->text);
primary->data_source = NULL;
primary->serial = 0;
selection: reset clipboard/primary->text after free:ing it
2020-09-17 20:05:22 +02:00
primary->text = NULL;
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
}
primary->data_source
= zwp_primary_selection_device_manager_v1_create_source(
term: wayland struct is now not a part of the terminal struct We do however need access to it, so provide a pointer. The difference is that now we can have a *single* wayland instance, but multiple terminal instances.
2019-10-27 18:51:14 +01:00
term->wl->primary_selection_device_manager);
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
if (primary->data_source == NULL) {
LOG_ERR("failed to create clipboard data source");
return false;
}
/* Get selection as a string */
primary->text = text;
/* Configure source */
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
zwp_primary_selection_source_v1_offer(primary->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_UTF8]);
selection: offer clipboard content in more mime types
2020-11-30 20:02:47 +01:00
zwp_primary_selection_source_v1_offer(primary->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_PLAIN]);
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
zwp_primary_selection_source_v1_offer(primary->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_TEXT]);
zwp_primary_selection_source_v1_offer(primary->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_STRING]);
zwp_primary_selection_source_v1_offer(primary->data_source, mime_type_map[DATA_OFFER_MIME_TEXT_UTF8_STRING]);
selection: offer clipboard content in more mime types
2020-11-30 20:02:47 +01:00
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
zwp_primary_selection_source_v1_add_listener(primary->data_source, &primary_selection_source_listener, seat);
zwp_primary_selection_device_v1_set_selection(seat->primary_selection_device, primary->data_source, serial);
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
/* Needed when sending the selection to other client */
primary->serial = serial;
return true;
}
selection: add selection_from_primary() API (stub for now)
2019-07-11 16:42:59 +02:00
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_to_primary(struct seat *seat, struct terminal *term, uint32_t serial)
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
{
term: wayland struct is now not a part of the terminal struct We do however need access to it, so provide a pointer. The difference is that now we can have a *single* wayland instance, but multiple terminal instances.
2019-10-27 18:51:14 +01:00
if (term->wl->primary_selection_device_manager == NULL)
selection: primary: don't require compositor to implement it
2019-09-25 19:26:55 +02:00
return;
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
/* Get selection as a string */
config: add 'pipe-selected' key binding This works just like pipe-visible and pipe-scrollback, but pipes the user-selected text, if any, to the external tool. Closes #51
2020-07-31 17:02:53 +02:00
char *text = selection_to_text(term);
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
if (!text_to_primary(seat, term, text, serial))
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
free(text);
}
void
text_from_primary(
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat, struct terminal *term,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
void (*cb)(char *data, size_t size, void *user),
selection: text_from_{clipboard,primary}: add 'done' callback This callback is *always* called, including when there has been an error. This is in preparation for making text_from_{clipboard,primary} asynchronous.
2019-11-05 08:49:32 +01:00
void (*done)(void *user), void *user)
selection: add selection_from_primary() API (stub for now)
2019-07-11 16:42:59 +02:00
{
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
if (term->wl->primary_selection_device_manager == NULL) {
done(user);
return;
}
selection: primary: don't require compositor to implement it
2019-09-25 19:26:55 +02:00
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct wl_primary *primary = &seat->primary;
selection: do not try to paste un-handled mime types Closes #230
2020-11-30 20:04:17 +01:00
if (primary->data_offer == NULL ||
primary->mime_type == DATA_OFFER_MIME_UNSET)
{
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
done(user);
return;
}
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
/* Prepare a pipe the other client can write its selection to us */
int fds[2];
if (pipe2(fds, O_CLOEXEC) == -1) {
LOG_ERRNO("failed to create pipe");
selection: don't do "return function_returning_void()" in functions returning void
2020-08-23 09:39:49 +02:00
done(user);
return;
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
}
selection: add a ‘finish’ function, called at the end of receiving clipboard data This is necessary to decode the final URI in a text/uri-list offer if it hasn’t been newline terminated.
2021-01-12 14:45:41 +01:00
LOG_DBG("receive from primary: mime-type=%s",
mime_type_map[primary->mime_type]);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
int read_fd = fds[0];
int write_fd = fds[1];
/* Give write-end of pipe to other client */
zwp_primary_selection_offer_v1_receive(
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
primary->data_offer, mime_type_map[primary->mime_type], write_fd);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
/* Don't keep our copy of the write-end open (or we'll never get EOF) */
close(write_fd);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
begin_receive_clipboard(term, read_fd, primary->mime_type, cb, done, user);
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
}
void
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
selection_from_primary(struct seat *seat, struct terminal *term)
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
{
term: wayland struct is now not a part of the terminal struct We do however need access to it, so provide a pointer. The difference is that now we can have a *single* wayland instance, but multiple terminal instances.
2019-10-27 18:51:14 +01:00
if (term->wl->primary_selection_device_manager == NULL)
selection: primary: don't require compositor to implement it
2019-09-25 19:26:55 +02:00
return;
selection: don't initiate a paste when we're already pasting
2020-08-22 16:30:52 +02:00
if (term->is_sending_paste_data) {
/* We're already pasting... */
return;
}
selection: use appropriate check for PRIMARY paste Assume it could be a copy-paste typo. We should check PRIMARY, not CLIPBOARD. Without this fix, we can't use PRIMARY until we copy anything to CLIPBOARD.
2020-10-10 21:13:08 +03:00
struct wl_primary *primary = &seat->primary;
if (primary->data_offer == NULL)
osc: implement copy/paste to/from primary
2019-08-09 21:27:51 +02:00
return;
selection: block non-paste data from being sent to client while pasting While pasting data from the clipboard, block *all* other data from being sent to the client. This includes keyboard and mouse events, but also replies for VT queries. This is particularly important when bracketed paste has been enabled, since then the client will interpret *everything* between the bracketed paste start and end as paste data.
2020-08-22 09:14:18 +02:00
term->is_sending_paste_data = true;
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
if (term->bracketed_paste)
selection: block non-paste data from being sent to client while pasting While pasting data from the clipboard, block *all* other data from being sent to the client. This includes keyboard and mouse events, but also replies for VT queries. This is particularly important when bracketed paste has been enabled, since then the client will interpret *everything* between the bracketed paste start and end as paste data.
2020-08-22 09:14:18 +02:00
term_paste_data_to_slave(term, "\033[200~", 6);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
text_from_primary(seat, term, &receive_offer, &receive_offer_done, term);
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
}
static void
select_mime_type_for_offer(const char *_mime_type,
enum data_offer_mime_type *type)
{
enum data_offer_mime_type mime_type = DATA_OFFER_MIME_UNSET;
/* Translate offered mime type to our mime type enum */
for (size_t i = 0; i < ALEN(mime_type_map); i++) {
if (mime_type_map[i] == NULL)
continue;
if (strcmp(_mime_type, mime_type_map[i]) == 0) {
mime_type = i;
break;
}
}
LOG_DBG("mime-type: %s -> %s (offered type was %s)",
mime_type_map[*type], mime_type_map[mime_type], _mime_type);
/* Mime-type transition; if the new mime-type is "better" than
* previously offered types, use the new type */
switch (mime_type) {
case DATA_OFFER_MIME_TEXT_PLAIN:
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
case DATA_OFFER_MIME_TEXT_TEXT:
case DATA_OFFER_MIME_TEXT_STRING:
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
/* text/plain is our least preferred type. Only use if current
* type is unset */
switch (*type) {
case DATA_OFFER_MIME_UNSET:
*type = mime_type;
break;
default:
break;
}
break;
case DATA_OFFER_MIME_TEXT_UTF8:
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
case DATA_OFFER_MIME_TEXT_UTF8_STRING:
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
/* text/plain;charset=utf-8 is preferred over text/plain */
switch (*type) {
case DATA_OFFER_MIME_UNSET:
case DATA_OFFER_MIME_TEXT_PLAIN:
selection: add support for TEXT/STRING/UTF8_STRING mime-types in incoming offers We were already offering these mime types for our own clipboard data, but ignored them in incoming offers. Fixes paste issues from Geany. Closes #583
2021-06-09 09:51:07 +02:00
case DATA_OFFER_MIME_TEXT_TEXT:
case DATA_OFFER_MIME_TEXT_STRING:
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
*type = mime_type;
break;
default:
break;
}
break;
case DATA_OFFER_MIME_URI_LIST:
/* text/uri-list is always used when offered */
*type = mime_type;
break;
case DATA_OFFER_MIME_UNSET:
break;
}
}
static void
data_offer_reset(struct wl_clipboard *clipboard)
{
if (clipboard->data_offer != NULL) {
wl_data_offer_destroy(clipboard->data_offer);
clipboard->data_offer = NULL;
}
clipboard->window = NULL;
clipboard->mime_type = DATA_OFFER_MIME_UNSET;
selection: add selection_from_primary() API (stub for now)
2019-07-11 16:42:59 +02:00
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
offer(void *data, struct wl_data_offer *wl_data_offer, const char *mime_type)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct seat *seat = data;
select_mime_type_for_offer(mime_type, &seat->clipboard.mime_type);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
source_actions(void *data, struct wl_data_offer *wl_data_offer,
uint32_t source_actions)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
#if defined(_DEBUG) && LOG_ENABLE_DBG
char actions_as_string[1024];
size_t idx = 0;
actions_as_string[0] = '\0';
actions_as_string[sizeof(actions_as_string) - 1] = '\0';
for (size_t i = 0; i < 31; i++) {
if (((source_actions >> i) & 1) == 0)
continue;
enum wl_data_device_manager_dnd_action action = 1 << i;
const char *s = NULL;
switch (action) {
case WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE: s = NULL; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY: s = "copy"; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE: s = "move"; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_ASK: s = "ask"; break;
}
if (s == NULL)
continue;
strncat(actions_as_string, s, sizeof(actions_as_string) - idx - 1);
idx += strlen(s);
strncat(actions_as_string, ", ", sizeof(actions_as_string) - idx - 1);
idx += 2;
}
/* Strip trailing ", " */
if (strlen(actions_as_string) > 2)
actions_as_string[strlen(actions_as_string) - 2] = '\0';
LOG_DBG("DnD actions: %s (0x%08x)", actions_as_string, source_actions);
#endif
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
offer_action(void *data, struct wl_data_offer *wl_data_offer, uint32_t dnd_action)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
#if defined(_DEBUG) && LOG_ENABLE_DBG
const char *s = NULL;
switch (dnd_action) {
case WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE: s = "<none>"; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY: s = "copy"; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE: s = "move"; break;
case WL_DATA_DEVICE_MANAGER_DND_ACTION_ASK: s = "ask"; break;
}
LOG_DBG("DnD offer action: %s (0x%08x)", s, dnd_action);
#endif
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static const struct wl_data_offer_listener data_offer_listener = {
.offer = &offer,
.source_actions = &source_actions,
.action = &offer_action,
};
static void
data_offer(void *data, struct wl_data_device *wl_data_device,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct wl_data_offer *offer)
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct seat *seat = data;
data_offer_reset(&seat->clipboard);
seat->clipboard.data_offer = offer;
wl_data_offer_add_listener(offer, &data_offer_listener, seat);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
enter(void *data, struct wl_data_device *wl_data_device, uint32_t serial,
struct wl_surface *surface, wl_fixed_t x, wl_fixed_t y,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct wl_data_offer *offer)
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
struct seat *seat = data;
struct wayland *wayl = seat->wayl;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(offer == seat->clipboard.data_offer);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
codespell: fix misspelled words
2020-10-28 19:34:49 +01:00
/* Remember _which_ terminal the current DnD offer is targeting */
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(seat->clipboard.window == NULL);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
tll_foreach(wayl->terms, it) {
if (term_surface_kind(it->item, surface) == TERM_SURF_GRID &&
!it->item->is_sending_paste_data)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
wl_data_offer_accept(
offer, serial, mime_type_map[seat->clipboard.mime_type]);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
wl_data_offer_set_actions(
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
offer,
WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY,
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY);
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
seat->clipboard.window = it->item->window;
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
return;
}
}
codespell: fix misspelled words
2020-10-28 19:34:49 +01:00
/* Either terminal is already busy sending paste data, or mouse
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
* pointer isn’t over the grid */
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
seat->clipboard.window = NULL;
wl_data_offer_set_actions(offer, 0, 0);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
leave(void *data, struct wl_data_device *wl_data_device)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
struct seat *seat = data;
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
seat->clipboard.window = NULL;
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
motion(void *data, struct wl_data_device *wl_data_device, uint32_t time,
wl_fixed_t x, wl_fixed_t y)
{
}
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
struct dnd_context {
struct terminal *term;
struct wl_data_offer *data_offer;
};
static void
receive_dnd(char *data, size_t size, void *user)
{
struct dnd_context *ctx = user;
receive_offer(data, size, ctx->term);
}
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
static void
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
receive_dnd_done(void *user)
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
{
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
struct dnd_context *ctx = user;
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
wl_data_offer_finish(ctx->data_offer);
selection: dnd: fix wl_data_offer_destroy() race At the end of a drag-and-drop operation, we need to call `wl_data_offer_finish()`. We *must* ensure the data offer hasn’t been destroyed before that. This could previously happen if the compositor decided to send a regular clipboard offer *after* we had started a drop operation, but *before* it had finished. The dnd offer was then destroyed when the clipboard offer was received, causing us to crash in `wl_data_offer_finish()`. To handle this, let the receive_offer_context take over ownership of the data_offer pointer, and “manually” destroy it *after* calling `wl_data_offer_finish()` in `receive_dnd_done()`. Note: we should not, and can not, do the same thing for regular clipboard and primary selection offers; such offers can be used multiple times and should *not* be destroyed after a single copy operation.
2020-10-31 10:36:11 +01:00
wl_data_offer_destroy(ctx->data_offer);
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
receive_offer_done(ctx->term);
free(ctx);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
}
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
static void
drop(void *data, struct wl_data_device *wl_data_device)
{
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
struct seat *seat = data;
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(seat->clipboard.window != NULL);
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct terminal *term = seat->clipboard.window->term;
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct wl_clipboard *clipboard = &seat->clipboard;
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
struct dnd_context *ctx = xmalloc(sizeof(*ctx));
*ctx = (struct dnd_context){
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
.term = term,
.data_offer = clipboard->data_offer,
};
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
/* Prepare a pipe the other client can write its selection to us */
int fds[2];
if (pipe2(fds, O_CLOEXEC) == -1) {
LOG_ERRNO("failed to create pipe");
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
free(ctx);
return;
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
}
int read_fd = fds[0];
int write_fd = fds[1];
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
LOG_DBG("DnD drop: mime-type=%s", mime_type_map[clipboard->mime_type]);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
/* Give write-end of pipe to other client */
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
wl_data_offer_receive(
clipboard->data_offer, mime_type_map[clipboard->mime_type], write_fd);
selection: implement support for drag-and-drop We accept COPY and MOVE actions, for text/plain;charset=utf-8 mime-types. To implement DnD, we need to track the current DnD data offer *and* the terminal instance it is (currently) targeting. To do this, a seat has a new member, ‘dnd_term’. On a DnD enter event, we lookup the corresponding terminal instance and point ‘dnd_term’ to it. On a DnD leave event, ‘dnd_term’ is reset. The DnD data offer is tracked in the terminal’s wayland window instance. It is reset, along with the seat’s ‘dnd_term’ on a DnD leave event. On a drop event, we immediately clear the seat’s ‘dnd_term’, to ensure we don’t reset it, or destroy the offer before the drop has been completed. The drop’s ‘done()’ callback takes care of destroying and resetting the DnD offer in the terminal’s wayland window instance. Closes #175
2020-10-26 21:02:53 +01:00
/* Don't keep our copy of the write-end open (or we'll never get EOF) */
close(write_fd);
term->is_sending_paste_data = true;
if (term->bracketed_paste)
term_paste_data_to_slave(term, "\033[200~", 6);
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
begin_receive_clipboard(
selection: do mime-type based decoding before passing data to callback The intention here is to make *all* text_from_clipboard() and text_from_primary() callers benefit from mime-type base decoding (e.g. URI list decoding). Previously, the decoding was done *in* the callback, which meant only the “default” clipboard/primary selection paste functions, and DnD, recognized URI lists.
2020-11-01 11:52:11 +01:00
term, read_fd, clipboard->mime_type,
&receive_dnd, &receive_dnd_done, ctx);
selection: dnd: fix wl_data_offer_destroy() race At the end of a drag-and-drop operation, we need to call `wl_data_offer_finish()`. We *must* ensure the data offer hasn’t been destroyed before that. This could previously happen if the compositor decided to send a regular clipboard offer *after* we had started a drop operation, but *before* it had finished. The dnd offer was then destroyed when the clipboard offer was received, causing us to crash in `wl_data_offer_finish()`. To handle this, let the receive_offer_context take over ownership of the data_offer pointer, and “manually” destroy it *after* calling `wl_data_offer_finish()` in `receive_dnd_done()`. Note: we should not, and can not, do the same thing for regular clipboard and primary selection offers; such offers can be used multiple times and should *not* be destroyed after a single copy operation.
2020-10-31 10:36:11 +01:00
/* data offer is now “owned” by the receive context */
clipboard->data_offer = NULL;
clipboard->mime_type = DATA_OFFER_MIME_UNSET;
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
static void
selection(void *data, struct wl_data_device *wl_data_device,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct wl_data_offer *offer)
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
{
selection: cleanup
2019-07-11 16:37:45 +02:00
/* Selection offer from other client */
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat = data;
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
if (offer == NULL)
data_offer_reset(&seat->clipboard);
else
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(offer == seat->clipboard.data_offer);
selection: initial copy-to-clipboard functionality
2019-07-11 12:16:50 +02:00
}
const struct wl_data_device_listener data_device_listener = {
.data_offer = &data_offer,
.enter = &enter,
.leave = &leave,
.motion = &motion,
.drop = &drop,
.selection = &selection,
};
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
static void
primary_offer(void *data,
struct zwp_primary_selection_offer_v1 *zwp_primary_selection_offer,
const char *mime_type)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
LOG_DBG("primary offer: %s", mime_type);
struct seat *seat = data;
select_mime_type_for_offer(mime_type, &seat->primary.mime_type);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
}
static const struct zwp_primary_selection_offer_v1_listener primary_selection_offer_listener = {
.offer = &primary_offer,
};
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
static void
primary_offer_reset(struct wl_primary *primary)
{
if (primary->data_offer != NULL) {
zwp_primary_selection_offer_v1_destroy(primary->data_offer);
primary->data_offer = NULL;
}
primary->mime_type = DATA_OFFER_MIME_UNSET;
}
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
static void
primary_data_offer(void *data,
struct zwp_primary_selection_device_v1 *zwp_primary_selection_device,
struct zwp_primary_selection_offer_v1 *offer)
{
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct seat *seat = data;
primary_offer_reset(&seat->primary);
seat->primary.data_offer = offer;
zwp_primary_selection_offer_v1_add_listener(
offer, &primary_selection_offer_listener, seat);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
}
static void
primary_selection(void *data,
struct zwp_primary_selection_device_v1 *zwp_primary_selection_device,
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
struct zwp_primary_selection_offer_v1 *offer)
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
{
/* Selection offer from other client, for primary */
multi-seat: re-enable selection support (excluding OSC 52)
2020-07-08 18:41:09 +02:00
struct seat *seat = data;
selection: add support for different mime-types Add support for `text/plain`, `text/plain;charset=utf-8` and `text/uri-list` to regular copy operations (both from clipboard and primary selection) and drag-and-drop operations.
2020-10-28 19:16:04 +01:00
if (offer == NULL)
primary_offer_reset(&seat->primary);
else
debug: rename assert() to xassert(), to avoid clashing with <assert.h>
2021-01-16 20:16:00 +00:00
xassert(seat->primary.data_offer == offer);
selection: add support for pasting *from* primary
2019-07-11 17:02:21 +02:00
}
const struct zwp_primary_selection_device_v1_listener primary_selection_device_listener = {
.data_offer = &primary_data_offer,
.selection = &primary_selection,
};
Reference in a new issue Copy permalink