Add an option to set the character used for unused areas of the
[tmux-openbsd.git] / screen-write.c
blob0d70f66873a584a3d40ecbfd8dee42520905ac6a
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/types.h>
21 #include <stdlib.h>
22 #include <string.h>
24 #include "tmux.h"
26 static struct screen_write_citem *screen_write_collect_trim(
27 struct screen_write_ctx *, u_int, u_int, u_int, int *);
28 static void screen_write_collect_clear(struct screen_write_ctx *, u_int,
29 u_int);
30 static void screen_write_collect_scroll(struct screen_write_ctx *, u_int);
31 static void screen_write_collect_flush(struct screen_write_ctx *, int,
32 const char *);
34 static int screen_write_overwrite(struct screen_write_ctx *,
35 struct grid_cell *, u_int);
36 static const struct grid_cell *screen_write_combine(struct screen_write_ctx *,
37 const struct utf8_data *, u_int *);
39 struct screen_write_citem {
40 u_int x;
41 int wrapped;
43 enum { TEXT, CLEAR } type;
44 u_int used;
45 u_int bg;
47 struct grid_cell gc;
49 TAILQ_ENTRY(screen_write_citem) entry;
51 struct screen_write_cline {
52 char *data;
53 TAILQ_HEAD(, screen_write_citem) items;
55 TAILQ_HEAD(, screen_write_citem) screen_write_citem_freelist =
56 TAILQ_HEAD_INITIALIZER(screen_write_citem_freelist);
58 static struct screen_write_citem *
59 screen_write_get_citem(void)
61 struct screen_write_citem *ci;
63 ci = TAILQ_FIRST(&screen_write_citem_freelist);
64 if (ci != NULL) {
65 TAILQ_REMOVE(&screen_write_citem_freelist, ci, entry);
66 memset(ci, 0, sizeof *ci);
67 return (ci);
69 return (xcalloc(1, sizeof *ci));
72 static void
73 screen_write_free_citem(struct screen_write_citem *ci)
75 TAILQ_INSERT_TAIL(&screen_write_citem_freelist, ci, entry);
78 static void
79 screen_write_offset_timer(__unused int fd, __unused short events, void *data)
81 struct window *w = data;
83 tty_update_window_offset(w);
86 /* Set cursor position. */
87 static void
88 screen_write_set_cursor(struct screen_write_ctx *ctx, int cx, int cy)
90 struct window_pane *wp = ctx->wp;
91 struct window *w;
92 struct screen *s = ctx->s;
93 struct timeval tv = { .tv_usec = 10000 };
95 if (cx != -1 && (u_int)cx == s->cx && cy != -1 && (u_int)cy == s->cy)
96 return;
98 if (cx != -1) {
99 if ((u_int)cx > screen_size_x(s)) /* allow last column */
100 cx = screen_size_x(s) - 1;
101 s->cx = cx;
103 if (cy != -1) {
104 if ((u_int)cy > screen_size_y(s) - 1)
105 cy = screen_size_y(s) - 1;
106 s->cy = cy;
109 if (wp == NULL)
110 return;
111 w = wp->window;
113 if (!event_initialized(&w->offset_timer))
114 evtimer_set(&w->offset_timer, screen_write_offset_timer, w);
115 if (!evtimer_pending(&w->offset_timer, NULL))
116 evtimer_add(&w->offset_timer, &tv);
119 /* Do a full redraw. */
120 static void
121 screen_write_redraw_cb(const struct tty_ctx *ttyctx)
123 struct window_pane *wp = ttyctx->arg;
125 if (wp != NULL)
126 wp->flags |= PANE_REDRAW;
129 /* Update context for client. */
130 static int
131 screen_write_set_client_cb(struct tty_ctx *ttyctx, struct client *c)
133 struct window_pane *wp = ttyctx->arg;
135 if (c->session->curw->window != wp->window)
136 return (0);
137 if (wp->layout_cell == NULL)
138 return (0);
140 if (wp->flags & (PANE_REDRAW|PANE_DROP))
141 return (-1);
142 if (c->flags & CLIENT_REDRAWPANES) {
144 * Redraw is already deferred to redraw another pane - redraw
145 * this one also when that happens.
147 log_debug("%s: adding %%%u to deferred redraw", __func__,
148 wp->id);
149 wp->flags |= PANE_REDRAW;
150 return (-1);
153 ttyctx->bigger = tty_window_offset(&c->tty, &ttyctx->wox, &ttyctx->woy,
154 &ttyctx->wsx, &ttyctx->wsy);
156 ttyctx->xoff = ttyctx->rxoff = wp->xoff;
157 ttyctx->yoff = ttyctx->ryoff = wp->yoff;
159 if (status_at_line(c) == 0)
160 ttyctx->yoff += status_line_size(c);
162 return (1);
165 /* Set up context for TTY command. */
166 static void
167 screen_write_initctx(struct screen_write_ctx *ctx, struct tty_ctx *ttyctx,
168 int sync)
170 struct screen *s = ctx->s;
172 memset(ttyctx, 0, sizeof *ttyctx);
174 ttyctx->s = s;
175 ttyctx->sx = screen_size_x(s);
176 ttyctx->sy = screen_size_y(s);
178 ttyctx->ocx = s->cx;
179 ttyctx->ocy = s->cy;
180 ttyctx->orlower = s->rlower;
181 ttyctx->orupper = s->rupper;
183 memcpy(&ttyctx->defaults, &grid_default_cell, sizeof ttyctx->defaults);
184 if (ctx->init_ctx_cb != NULL) {
185 ctx->init_ctx_cb(ctx, ttyctx);
186 if (ttyctx->palette != NULL) {
187 if (ttyctx->defaults.fg == 8)
188 ttyctx->defaults.fg = ttyctx->palette->fg;
189 if (ttyctx->defaults.bg == 8)
190 ttyctx->defaults.bg = ttyctx->palette->bg;
192 } else {
193 ttyctx->redraw_cb = screen_write_redraw_cb;
194 if (ctx->wp != NULL) {
195 tty_default_colours(&ttyctx->defaults, ctx->wp);
196 ttyctx->palette = &ctx->wp->palette;
197 ttyctx->set_client_cb = screen_write_set_client_cb;
198 ttyctx->arg = ctx->wp;
202 if (~ctx->flags & SCREEN_WRITE_SYNC) {
204 * For the active pane or for an overlay (no pane), we want to
205 * only use synchronized updates if requested (commands that
206 * move the cursor); for other panes, always use it, since the
207 * cursor will have to move.
209 if (ctx->wp != NULL) {
210 if (ctx->wp != ctx->wp->window->active)
211 ttyctx->num = 1;
212 else
213 ttyctx->num = sync;
214 } else
215 ttyctx->num = 0x10|sync;
216 tty_write(tty_cmd_syncstart, ttyctx);
217 ctx->flags |= SCREEN_WRITE_SYNC;
221 /* Make write list. */
222 void
223 screen_write_make_list(struct screen *s)
225 u_int y;
227 s->write_list = xcalloc(screen_size_y(s), sizeof *s->write_list);
228 for (y = 0; y < screen_size_y(s); y++)
229 TAILQ_INIT(&s->write_list[y].items);
232 /* Free write list. */
233 void
234 screen_write_free_list(struct screen *s)
236 u_int y;
238 for (y = 0; y < screen_size_y(s); y++)
239 free(s->write_list[y].data);
240 free(s->write_list);
243 /* Set up for writing. */
244 static void
245 screen_write_init(struct screen_write_ctx *ctx, struct screen *s)
247 memset(ctx, 0, sizeof *ctx);
249 ctx->s = s;
251 if (ctx->s->write_list == NULL)
252 screen_write_make_list(ctx->s);
253 ctx->item = screen_write_get_citem();
255 ctx->scrolled = 0;
256 ctx->bg = 8;
259 /* Initialize writing with a pane. */
260 void
261 screen_write_start_pane(struct screen_write_ctx *ctx, struct window_pane *wp,
262 struct screen *s)
264 if (s == NULL)
265 s = wp->screen;
266 screen_write_init(ctx, s);
267 ctx->wp = wp;
269 if (log_get_level() != 0) {
270 log_debug("%s: size %ux%u, pane %%%u (at %u,%u)",
271 __func__, screen_size_x(ctx->s), screen_size_y(ctx->s),
272 wp->id, wp->xoff, wp->yoff);
276 /* Initialize writing with a callback. */
277 void
278 screen_write_start_callback(struct screen_write_ctx *ctx, struct screen *s,
279 screen_write_init_ctx_cb cb, void *arg)
281 screen_write_init(ctx, s);
283 ctx->init_ctx_cb = cb;
284 ctx->arg = arg;
286 if (log_get_level() != 0) {
287 log_debug("%s: size %ux%u, with callback", __func__,
288 screen_size_x(ctx->s), screen_size_y(ctx->s));
292 /* Initialize writing. */
293 void
294 screen_write_start(struct screen_write_ctx *ctx, struct screen *s)
296 screen_write_init(ctx, s);
298 if (log_get_level() != 0) {
299 log_debug("%s: size %ux%u, no pane", __func__,
300 screen_size_x(ctx->s), screen_size_y(ctx->s));
304 /* Finish writing. */
305 void
306 screen_write_stop(struct screen_write_ctx *ctx)
308 screen_write_collect_end(ctx);
309 screen_write_collect_flush(ctx, 0, __func__);
311 screen_write_free_citem(ctx->item);
314 /* Reset screen state. */
315 void
316 screen_write_reset(struct screen_write_ctx *ctx)
318 struct screen *s = ctx->s;
320 screen_reset_tabs(s);
321 screen_write_scrollregion(ctx, 0, screen_size_y(s) - 1);
323 s->mode = MODE_CURSOR | MODE_WRAP;
325 screen_write_clearscreen(ctx, 8);
326 screen_write_set_cursor(ctx, 0, 0);
329 /* Write character. */
330 void
331 screen_write_putc(struct screen_write_ctx *ctx, const struct grid_cell *gcp,
332 u_char ch)
334 struct grid_cell gc;
336 memcpy(&gc, gcp, sizeof gc);
338 utf8_set(&gc.data, ch);
339 screen_write_cell(ctx, &gc);
342 /* Calculate string length. */
343 size_t
344 screen_write_strlen(const char *fmt, ...)
346 va_list ap;
347 char *msg;
348 struct utf8_data ud;
349 u_char *ptr;
350 size_t left, size = 0;
351 enum utf8_state more;
353 va_start(ap, fmt);
354 xvasprintf(&msg, fmt, ap);
355 va_end(ap);
357 ptr = msg;
358 while (*ptr != '\0') {
359 if (*ptr > 0x7f && utf8_open(&ud, *ptr) == UTF8_MORE) {
360 ptr++;
362 left = strlen(ptr);
363 if (left < (size_t)ud.size - 1)
364 break;
365 while ((more = utf8_append(&ud, *ptr)) == UTF8_MORE)
366 ptr++;
367 ptr++;
369 if (more == UTF8_DONE)
370 size += ud.width;
371 } else {
372 if (*ptr > 0x1f && *ptr < 0x7f)
373 size++;
374 ptr++;
378 free(msg);
379 return (size);
382 /* Write string wrapped over lines. */
384 screen_write_text(struct screen_write_ctx *ctx, u_int cx, u_int width,
385 u_int lines, int more, const struct grid_cell *gcp, const char *fmt, ...)
387 struct screen *s = ctx->s;
388 va_list ap;
389 char *tmp;
390 u_int cy = s->cy, i, end, next, idx = 0, at, left;
391 struct utf8_data *text;
392 struct grid_cell gc;
394 memcpy(&gc, gcp, sizeof gc);
396 va_start(ap, fmt);
397 xvasprintf(&tmp, fmt, ap);
398 va_end(ap);
400 text = utf8_fromcstr(tmp);
401 free(tmp);
403 left = (cx + width) - s->cx;
404 for (;;) {
405 /* Find the end of what can fit on the line. */
406 at = 0;
407 for (end = idx; text[end].size != 0; end++) {
408 if (text[end].size == 1 && text[end].data[0] == '\n')
409 break;
410 if (at + text[end].width > left)
411 break;
412 at += text[end].width;
416 * If we're on a space, that's the end. If not, walk back to
417 * try and find one.
419 if (text[end].size == 0)
420 next = end;
421 else if (text[end].size == 1 && text[end].data[0] == '\n')
422 next = end + 1;
423 else if (text[end].size == 1 && text[end].data[0] == ' ')
424 next = end + 1;
425 else {
426 for (i = end; i > idx; i--) {
427 if (text[i].size == 1 && text[i].data[0] == ' ')
428 break;
430 if (i != idx) {
431 next = i + 1;
432 end = i;
433 } else
434 next = end;
437 /* Print the line. */
438 for (i = idx; i < end; i++) {
439 utf8_copy(&gc.data, &text[i]);
440 screen_write_cell(ctx, &gc);
443 /* If at the bottom, stop. */
444 idx = next;
445 if (s->cy == cy + lines - 1 || text[idx].size == 0)
446 break;
448 screen_write_cursormove(ctx, cx, s->cy + 1, 0);
449 left = width;
453 * Fail if on the last line and there is more to come or at the end, or
454 * if the text was not entirely consumed.
456 if ((s->cy == cy + lines - 1 && (!more || s->cx == cx + width)) ||
457 text[idx].size != 0) {
458 free(text);
459 return (0);
461 free(text);
464 * If no more to come, move to the next line. Otherwise, leave on
465 * the same line (except if at the end).
467 if (!more || s->cx == cx + width)
468 screen_write_cursormove(ctx, cx, s->cy + 1, 0);
469 return (1);
472 /* Write simple string (no maximum length). */
473 void
474 screen_write_puts(struct screen_write_ctx *ctx, const struct grid_cell *gcp,
475 const char *fmt, ...)
477 va_list ap;
479 va_start(ap, fmt);
480 screen_write_vnputs(ctx, -1, gcp, fmt, ap);
481 va_end(ap);
484 /* Write string with length limit (-1 for unlimited). */
485 void
486 screen_write_nputs(struct screen_write_ctx *ctx, ssize_t maxlen,
487 const struct grid_cell *gcp, const char *fmt, ...)
489 va_list ap;
491 va_start(ap, fmt);
492 screen_write_vnputs(ctx, maxlen, gcp, fmt, ap);
493 va_end(ap);
496 void
497 screen_write_vnputs(struct screen_write_ctx *ctx, ssize_t maxlen,
498 const struct grid_cell *gcp, const char *fmt, va_list ap)
500 struct grid_cell gc;
501 struct utf8_data *ud = &gc.data;
502 char *msg;
503 u_char *ptr;
504 size_t left, size = 0;
505 enum utf8_state more;
507 memcpy(&gc, gcp, sizeof gc);
508 xvasprintf(&msg, fmt, ap);
510 ptr = msg;
511 while (*ptr != '\0') {
512 if (*ptr > 0x7f && utf8_open(ud, *ptr) == UTF8_MORE) {
513 ptr++;
515 left = strlen(ptr);
516 if (left < (size_t)ud->size - 1)
517 break;
518 while ((more = utf8_append(ud, *ptr)) == UTF8_MORE)
519 ptr++;
520 ptr++;
522 if (more != UTF8_DONE)
523 continue;
524 if (maxlen > 0 && size + ud->width > (size_t)maxlen) {
525 while (size < (size_t)maxlen) {
526 screen_write_putc(ctx, &gc, ' ');
527 size++;
529 break;
531 size += ud->width;
532 screen_write_cell(ctx, &gc);
533 } else {
534 if (maxlen > 0 && size + 1 > (size_t)maxlen)
535 break;
537 if (*ptr == '\001')
538 gc.attr ^= GRID_ATTR_CHARSET;
539 else if (*ptr == '\n') {
540 screen_write_linefeed(ctx, 0, 8);
541 screen_write_carriagereturn(ctx);
542 } else if (*ptr > 0x1f && *ptr < 0x7f) {
543 size++;
544 screen_write_putc(ctx, &gc, *ptr);
546 ptr++;
550 free(msg);
554 * Copy from another screen but without the selection stuff. Assumes the target
555 * region is already big enough.
557 void
558 screen_write_fast_copy(struct screen_write_ctx *ctx, struct screen *src,
559 u_int px, u_int py, u_int nx, u_int ny)
561 struct screen *s = ctx->s;
562 struct grid *gd = src->grid;
563 struct grid_cell gc;
564 u_int xx, yy, cx, cy;
566 if (nx == 0 || ny == 0)
567 return;
569 cy = s->cy;
570 for (yy = py; yy < py + ny; yy++) {
571 if (yy >= gd->hsize + gd->sy)
572 break;
573 cx = s->cx;
574 for (xx = px; xx < px + nx; xx++) {
575 if (xx >= grid_get_line(gd, yy)->cellsize)
576 break;
577 grid_get_cell(gd, xx, yy, &gc);
578 if (xx + gc.data.width > px + nx)
579 break;
580 grid_view_set_cell(ctx->s->grid, cx, cy, &gc);
581 cx++;
583 cy++;
587 /* Draw a horizontal line on screen. */
588 void
589 screen_write_hline(struct screen_write_ctx *ctx, u_int nx, int left, int right)
591 struct screen *s = ctx->s;
592 struct grid_cell gc;
593 u_int cx, cy, i;
595 cx = s->cx;
596 cy = s->cy;
598 memcpy(&gc, &grid_default_cell, sizeof gc);
599 gc.attr |= GRID_ATTR_CHARSET;
601 screen_write_putc(ctx, &gc, left ? 't' : 'q');
602 for (i = 1; i < nx - 1; i++)
603 screen_write_putc(ctx, &gc, 'q');
604 screen_write_putc(ctx, &gc, right ? 'u' : 'q');
606 screen_write_set_cursor(ctx, cx, cy);
609 /* Draw a vertical line on screen. */
610 void
611 screen_write_vline(struct screen_write_ctx *ctx, u_int ny, int top, int bottom)
613 struct screen *s = ctx->s;
614 struct grid_cell gc;
615 u_int cx, cy, i;
617 cx = s->cx;
618 cy = s->cy;
620 memcpy(&gc, &grid_default_cell, sizeof gc);
621 gc.attr |= GRID_ATTR_CHARSET;
623 screen_write_putc(ctx, &gc, top ? 'w' : 'x');
624 for (i = 1; i < ny - 1; i++) {
625 screen_write_set_cursor(ctx, cx, cy + i);
626 screen_write_putc(ctx, &gc, 'x');
628 screen_write_set_cursor(ctx, cx, cy + ny - 1);
629 screen_write_putc(ctx, &gc, bottom ? 'v' : 'x');
631 screen_write_set_cursor(ctx, cx, cy);
634 /* Draw a menu on screen. */
635 void
636 screen_write_menu(struct screen_write_ctx *ctx, struct menu *menu,
637 int choice, const struct grid_cell *choice_gc)
639 struct screen *s = ctx->s;
640 struct grid_cell default_gc;
641 const struct grid_cell *gc = &default_gc;
642 u_int cx, cy, i, j;
643 const char *name;
645 cx = s->cx;
646 cy = s->cy;
648 memcpy(&default_gc, &grid_default_cell, sizeof default_gc);
650 screen_write_box(ctx, menu->width + 4, menu->count + 2,
651 BOX_LINES_DEFAULT, &default_gc, menu->title);
653 for (i = 0; i < menu->count; i++) {
654 name = menu->items[i].name;
655 if (name == NULL) {
656 screen_write_cursormove(ctx, cx, cy + 1 + i, 0);
657 screen_write_hline(ctx, menu->width + 4, 1, 1);
658 } else {
659 if (choice >= 0 && i == (u_int)choice && *name != '-')
660 gc = choice_gc;
661 screen_write_cursormove(ctx, cx + 2, cy + 1 + i, 0);
662 for (j = 0; j < menu->width; j++)
663 screen_write_putc(ctx, gc, ' ');
664 screen_write_cursormove(ctx, cx + 2, cy + 1 + i, 0);
665 if (*name == '-') {
666 name++;
667 default_gc.attr |= GRID_ATTR_DIM;
668 format_draw(ctx, gc, menu->width, name, NULL,
670 default_gc.attr &= ~GRID_ATTR_DIM;
671 } else
672 format_draw(ctx, gc, menu->width, name, NULL,
673 gc == choice_gc);
674 gc = &default_gc;
678 screen_write_set_cursor(ctx, cx, cy);
681 static void
682 screen_write_box_border_set(enum box_lines box_lines, int cell_type,
683 struct grid_cell *gc)
685 switch (box_lines) {
686 case BOX_LINES_NONE:
687 break;
688 case BOX_LINES_DOUBLE:
689 gc->attr &= ~GRID_ATTR_CHARSET;
690 utf8_copy(&gc->data, tty_acs_double_borders(cell_type));
691 break;
692 case BOX_LINES_HEAVY:
693 gc->attr &= ~GRID_ATTR_CHARSET;
694 utf8_copy(&gc->data, tty_acs_heavy_borders(cell_type));
695 break;
696 case BOX_LINES_ROUNDED:
697 gc->attr &= ~GRID_ATTR_CHARSET;
698 utf8_copy(&gc->data, tty_acs_rounded_borders(cell_type));
699 break;
700 case BOX_LINES_SIMPLE:
701 gc->attr &= ~GRID_ATTR_CHARSET;
702 utf8_set(&gc->data, SIMPLE_BORDERS[cell_type]);
703 break;
704 case BOX_LINES_PADDED:
705 gc->attr &= ~GRID_ATTR_CHARSET;
706 utf8_set(&gc->data, PADDED_BORDERS[cell_type]);
707 break;
708 case BOX_LINES_SINGLE:
709 case BOX_LINES_DEFAULT:
710 gc->attr |= GRID_ATTR_CHARSET;
711 utf8_set(&gc->data, CELL_BORDERS[cell_type]);
712 break;
716 /* Draw a box on screen. */
717 void
718 screen_write_box(struct screen_write_ctx *ctx, u_int nx, u_int ny,
719 enum box_lines lines, const struct grid_cell *gcp, const char *title)
721 struct screen *s = ctx->s;
722 struct grid_cell gc;
723 u_int cx, cy, i;
725 cx = s->cx;
726 cy = s->cy;
728 if (gcp != NULL)
729 memcpy(&gc, gcp, sizeof gc);
730 else
731 memcpy(&gc, &grid_default_cell, sizeof gc);
733 gc.attr |= GRID_ATTR_CHARSET;
734 gc.flags |= GRID_FLAG_NOPALETTE;
736 /* Draw top border */
737 screen_write_box_border_set(lines, CELL_TOPLEFT, &gc);
738 screen_write_cell(ctx, &gc);
739 screen_write_box_border_set(lines, CELL_LEFTRIGHT, &gc);
740 for (i = 1; i < nx - 1; i++)
741 screen_write_cell(ctx, &gc);
742 screen_write_box_border_set(lines, CELL_TOPRIGHT, &gc);
743 screen_write_cell(ctx, &gc);
745 /* Draw bottom border */
746 screen_write_set_cursor(ctx, cx, cy + ny - 1);
747 screen_write_box_border_set(lines, CELL_BOTTOMLEFT, &gc);
748 screen_write_cell(ctx, &gc);
749 screen_write_box_border_set(lines, CELL_LEFTRIGHT, &gc);
750 for (i = 1; i < nx - 1; i++)
751 screen_write_cell(ctx, &gc);
752 screen_write_box_border_set(lines, CELL_BOTTOMRIGHT, &gc);
753 screen_write_cell(ctx, &gc);
755 /* Draw sides */
756 screen_write_box_border_set(lines, CELL_TOPBOTTOM, &gc);
757 for (i = 1; i < ny - 1; i++) {
758 /* left side */
759 screen_write_set_cursor(ctx, cx, cy + i);
760 screen_write_cell(ctx, &gc);
761 /* right side */
762 screen_write_set_cursor(ctx, cx + nx - 1, cy + i);
763 screen_write_cell(ctx, &gc);
766 if (title != NULL) {
767 gc.attr &= ~GRID_ATTR_CHARSET;
768 screen_write_cursormove(ctx, cx + 2, cy, 0);
769 format_draw(ctx, &gc, nx - 4, title, NULL, 0);
772 screen_write_set_cursor(ctx, cx, cy);
776 * Write a preview version of a window. Assumes target area is big enough and
777 * already cleared.
779 void
780 screen_write_preview(struct screen_write_ctx *ctx, struct screen *src, u_int nx,
781 u_int ny)
783 struct screen *s = ctx->s;
784 struct grid_cell gc;
785 u_int cx, cy, px, py;
787 cx = s->cx;
788 cy = s->cy;
791 * If the cursor is on, pick the area around the cursor, otherwise use
792 * the top left.
794 if (src->mode & MODE_CURSOR) {
795 px = src->cx;
796 if (px < nx / 3)
797 px = 0;
798 else
799 px = px - nx / 3;
800 if (px + nx > screen_size_x(src)) {
801 if (nx > screen_size_x(src))
802 px = 0;
803 else
804 px = screen_size_x(src) - nx;
806 py = src->cy;
807 if (py < ny / 3)
808 py = 0;
809 else
810 py = py - ny / 3;
811 if (py + ny > screen_size_y(src)) {
812 if (ny > screen_size_y(src))
813 py = 0;
814 else
815 py = screen_size_y(src) - ny;
817 } else {
818 px = 0;
819 py = 0;
822 screen_write_fast_copy(ctx, src, px, src->grid->hsize + py, nx, ny);
824 if (src->mode & MODE_CURSOR) {
825 grid_view_get_cell(src->grid, src->cx, src->cy, &gc);
826 gc.attr |= GRID_ATTR_REVERSE;
827 screen_write_set_cursor(ctx, cx + (src->cx - px),
828 cy + (src->cy - py));
829 screen_write_cell(ctx, &gc);
833 /* Set a mode. */
834 void
835 screen_write_mode_set(struct screen_write_ctx *ctx, int mode)
837 struct screen *s = ctx->s;
839 s->mode |= mode;
841 if (log_get_level() != 0)
842 log_debug("%s: %s", __func__, screen_mode_to_string(mode));
845 /* Clear a mode. */
846 void
847 screen_write_mode_clear(struct screen_write_ctx *ctx, int mode)
849 struct screen *s = ctx->s;
851 s->mode &= ~mode;
853 if (log_get_level() != 0)
854 log_debug("%s: %s", __func__, screen_mode_to_string(mode));
857 /* Cursor up by ny. */
858 void
859 screen_write_cursorup(struct screen_write_ctx *ctx, u_int ny)
861 struct screen *s = ctx->s;
862 u_int cx = s->cx, cy = s->cy;
864 if (ny == 0)
865 ny = 1;
867 if (cy < s->rupper) {
868 /* Above region. */
869 if (ny > cy)
870 ny = cy;
871 } else {
872 /* Below region. */
873 if (ny > cy - s->rupper)
874 ny = cy - s->rupper;
876 if (cx == screen_size_x(s))
877 cx--;
879 cy -= ny;
881 screen_write_set_cursor(ctx, cx, cy);
884 /* Cursor down by ny. */
885 void
886 screen_write_cursordown(struct screen_write_ctx *ctx, u_int ny)
888 struct screen *s = ctx->s;
889 u_int cx = s->cx, cy = s->cy;
891 if (ny == 0)
892 ny = 1;
894 if (cy > s->rlower) {
895 /* Below region. */
896 if (ny > screen_size_y(s) - 1 - cy)
897 ny = screen_size_y(s) - 1 - cy;
898 } else {
899 /* Above region. */
900 if (ny > s->rlower - cy)
901 ny = s->rlower - cy;
903 if (cx == screen_size_x(s))
904 cx--;
905 else if (ny == 0)
906 return;
908 cy += ny;
910 screen_write_set_cursor(ctx, cx, cy);
913 /* Cursor right by nx. */
914 void
915 screen_write_cursorright(struct screen_write_ctx *ctx, u_int nx)
917 struct screen *s = ctx->s;
918 u_int cx = s->cx, cy = s->cy;
920 if (nx == 0)
921 nx = 1;
923 if (nx > screen_size_x(s) - 1 - cx)
924 nx = screen_size_x(s) - 1 - cx;
925 if (nx == 0)
926 return;
928 cx += nx;
930 screen_write_set_cursor(ctx, cx, cy);
933 /* Cursor left by nx. */
934 void
935 screen_write_cursorleft(struct screen_write_ctx *ctx, u_int nx)
937 struct screen *s = ctx->s;
938 u_int cx = s->cx, cy = s->cy;
940 if (nx == 0)
941 nx = 1;
943 if (nx > cx)
944 nx = cx;
945 if (nx == 0)
946 return;
948 cx -= nx;
950 screen_write_set_cursor(ctx, cx, cy);
953 /* Backspace; cursor left unless at start of wrapped line when can move up. */
954 void
955 screen_write_backspace(struct screen_write_ctx *ctx)
957 struct screen *s = ctx->s;
958 struct grid_line *gl;
959 u_int cx = s->cx, cy = s->cy;
961 if (cx == 0) {
962 if (cy == 0)
963 return;
964 gl = grid_get_line(s->grid, s->grid->hsize + cy - 1);
965 if (gl->flags & GRID_LINE_WRAPPED) {
966 cy--;
967 cx = screen_size_x(s) - 1;
969 } else
970 cx--;
972 screen_write_set_cursor(ctx, cx, cy);
975 /* VT100 alignment test. */
976 void
977 screen_write_alignmenttest(struct screen_write_ctx *ctx)
979 struct screen *s = ctx->s;
980 struct tty_ctx ttyctx;
981 struct grid_cell gc;
982 u_int xx, yy;
984 memcpy(&gc, &grid_default_cell, sizeof gc);
985 utf8_set(&gc.data, 'E');
987 for (yy = 0; yy < screen_size_y(s); yy++) {
988 for (xx = 0; xx < screen_size_x(s); xx++)
989 grid_view_set_cell(s->grid, xx, yy, &gc);
992 screen_write_set_cursor(ctx, 0, 0);
994 s->rupper = 0;
995 s->rlower = screen_size_y(s) - 1;
997 screen_write_initctx(ctx, &ttyctx, 1);
999 screen_write_collect_clear(ctx, 0, screen_size_y(s) - 1);
1000 tty_write(tty_cmd_alignmenttest, &ttyctx);
1003 /* Insert nx characters. */
1004 void
1005 screen_write_insertcharacter(struct screen_write_ctx *ctx, u_int nx, u_int bg)
1007 struct screen *s = ctx->s;
1008 struct tty_ctx ttyctx;
1010 if (nx == 0)
1011 nx = 1;
1013 if (nx > screen_size_x(s) - s->cx)
1014 nx = screen_size_x(s) - s->cx;
1015 if (nx == 0)
1016 return;
1018 if (s->cx > screen_size_x(s) - 1)
1019 return;
1021 screen_write_initctx(ctx, &ttyctx, 0);
1022 ttyctx.bg = bg;
1024 grid_view_insert_cells(s->grid, s->cx, s->cy, nx, bg);
1026 screen_write_collect_flush(ctx, 0, __func__);
1027 ttyctx.num = nx;
1028 tty_write(tty_cmd_insertcharacter, &ttyctx);
1031 /* Delete nx characters. */
1032 void
1033 screen_write_deletecharacter(struct screen_write_ctx *ctx, u_int nx, u_int bg)
1035 struct screen *s = ctx->s;
1036 struct tty_ctx ttyctx;
1038 if (nx == 0)
1039 nx = 1;
1041 if (nx > screen_size_x(s) - s->cx)
1042 nx = screen_size_x(s) - s->cx;
1043 if (nx == 0)
1044 return;
1046 if (s->cx > screen_size_x(s) - 1)
1047 return;
1049 screen_write_initctx(ctx, &ttyctx, 0);
1050 ttyctx.bg = bg;
1052 grid_view_delete_cells(s->grid, s->cx, s->cy, nx, bg);
1054 screen_write_collect_flush(ctx, 0, __func__);
1055 ttyctx.num = nx;
1056 tty_write(tty_cmd_deletecharacter, &ttyctx);
1059 /* Clear nx characters. */
1060 void
1061 screen_write_clearcharacter(struct screen_write_ctx *ctx, u_int nx, u_int bg)
1063 struct screen *s = ctx->s;
1064 struct tty_ctx ttyctx;
1066 if (nx == 0)
1067 nx = 1;
1069 if (nx > screen_size_x(s) - s->cx)
1070 nx = screen_size_x(s) - s->cx;
1071 if (nx == 0)
1072 return;
1074 if (s->cx > screen_size_x(s) - 1)
1075 return;
1077 screen_write_initctx(ctx, &ttyctx, 0);
1078 ttyctx.bg = bg;
1080 grid_view_clear(s->grid, s->cx, s->cy, nx, 1, bg);
1082 screen_write_collect_flush(ctx, 0, __func__);
1083 ttyctx.num = nx;
1084 tty_write(tty_cmd_clearcharacter, &ttyctx);
1087 /* Insert ny lines. */
1088 void
1089 screen_write_insertline(struct screen_write_ctx *ctx, u_int ny, u_int bg)
1091 struct screen *s = ctx->s;
1092 struct grid *gd = s->grid;
1093 struct tty_ctx ttyctx;
1095 if (ny == 0)
1096 ny = 1;
1098 if (s->cy < s->rupper || s->cy > s->rlower) {
1099 if (ny > screen_size_y(s) - s->cy)
1100 ny = screen_size_y(s) - s->cy;
1101 if (ny == 0)
1102 return;
1104 screen_write_initctx(ctx, &ttyctx, 1);
1105 ttyctx.bg = bg;
1107 grid_view_insert_lines(gd, s->cy, ny, bg);
1109 screen_write_collect_flush(ctx, 0, __func__);
1110 ttyctx.num = ny;
1111 tty_write(tty_cmd_insertline, &ttyctx);
1112 return;
1115 if (ny > s->rlower + 1 - s->cy)
1116 ny = s->rlower + 1 - s->cy;
1117 if (ny == 0)
1118 return;
1120 screen_write_initctx(ctx, &ttyctx, 1);
1121 ttyctx.bg = bg;
1123 if (s->cy < s->rupper || s->cy > s->rlower)
1124 grid_view_insert_lines(gd, s->cy, ny, bg);
1125 else
1126 grid_view_insert_lines_region(gd, s->rlower, s->cy, ny, bg);
1128 screen_write_collect_flush(ctx, 0, __func__);
1130 ttyctx.num = ny;
1131 tty_write(tty_cmd_insertline, &ttyctx);
1134 /* Delete ny lines. */
1135 void
1136 screen_write_deleteline(struct screen_write_ctx *ctx, u_int ny, u_int bg)
1138 struct screen *s = ctx->s;
1139 struct grid *gd = s->grid;
1140 struct tty_ctx ttyctx;
1142 if (ny == 0)
1143 ny = 1;
1145 if (s->cy < s->rupper || s->cy > s->rlower) {
1146 if (ny > screen_size_y(s) - s->cy)
1147 ny = screen_size_y(s) - s->cy;
1148 if (ny == 0)
1149 return;
1151 screen_write_initctx(ctx, &ttyctx, 1);
1152 ttyctx.bg = bg;
1154 grid_view_delete_lines(gd, s->cy, ny, bg);
1156 screen_write_collect_flush(ctx, 0, __func__);
1157 ttyctx.num = ny;
1158 tty_write(tty_cmd_deleteline, &ttyctx);
1159 return;
1162 if (ny > s->rlower + 1 - s->cy)
1163 ny = s->rlower + 1 - s->cy;
1164 if (ny == 0)
1165 return;
1167 screen_write_initctx(ctx, &ttyctx, 1);
1168 ttyctx.bg = bg;
1170 if (s->cy < s->rupper || s->cy > s->rlower)
1171 grid_view_delete_lines(gd, s->cy, ny, bg);
1172 else
1173 grid_view_delete_lines_region(gd, s->rlower, s->cy, ny, bg);
1175 screen_write_collect_flush(ctx, 0, __func__);
1176 ttyctx.num = ny;
1177 tty_write(tty_cmd_deleteline, &ttyctx);
1180 /* Clear line at cursor. */
1181 void
1182 screen_write_clearline(struct screen_write_ctx *ctx, u_int bg)
1184 struct screen *s = ctx->s;
1185 struct grid_line *gl;
1186 u_int sx = screen_size_x(s);
1187 struct screen_write_citem *ci = ctx->item;
1189 gl = grid_get_line(s->grid, s->grid->hsize + s->cy);
1190 if (gl->cellsize == 0 && COLOUR_DEFAULT(bg))
1191 return;
1193 grid_view_clear(s->grid, 0, s->cy, sx, 1, bg);
1195 screen_write_collect_clear(ctx, s->cy, 1);
1196 ci->x = 0;
1197 ci->used = sx;
1198 ci->type = CLEAR;
1199 ci->bg = bg;
1200 TAILQ_INSERT_TAIL(&ctx->s->write_list[s->cy].items, ci, entry);
1201 ctx->item = screen_write_get_citem();
1204 /* Clear to end of line from cursor. */
1205 void
1206 screen_write_clearendofline(struct screen_write_ctx *ctx, u_int bg)
1208 struct screen *s = ctx->s;
1209 struct grid_line *gl;
1210 u_int sx = screen_size_x(s);
1211 struct screen_write_citem *ci = ctx->item, *before;
1213 if (s->cx == 0) {
1214 screen_write_clearline(ctx, bg);
1215 return;
1218 gl = grid_get_line(s->grid, s->grid->hsize + s->cy);
1219 if (s->cx > sx - 1 || (s->cx >= gl->cellsize && COLOUR_DEFAULT(bg)))
1220 return;
1222 grid_view_clear(s->grid, s->cx, s->cy, sx - s->cx, 1, bg);
1224 before = screen_write_collect_trim(ctx, s->cy, s->cx, sx - s->cx, NULL);
1225 ci->x = s->cx;
1226 ci->used = sx - s->cx;
1227 ci->type = CLEAR;
1228 ci->bg = bg;
1229 if (before == NULL)
1230 TAILQ_INSERT_TAIL(&ctx->s->write_list[s->cy].items, ci, entry);
1231 else
1232 TAILQ_INSERT_BEFORE(before, ci, entry);
1233 ctx->item = screen_write_get_citem();
1236 /* Clear to start of line from cursor. */
1237 void
1238 screen_write_clearstartofline(struct screen_write_ctx *ctx, u_int bg)
1240 struct screen *s = ctx->s;
1241 u_int sx = screen_size_x(s);
1242 struct screen_write_citem *ci = ctx->item, *before;
1244 if (s->cx >= sx - 1) {
1245 screen_write_clearline(ctx, bg);
1246 return;
1249 if (s->cx > sx - 1)
1250 grid_view_clear(s->grid, 0, s->cy, sx, 1, bg);
1251 else
1252 grid_view_clear(s->grid, 0, s->cy, s->cx + 1, 1, bg);
1254 before = screen_write_collect_trim(ctx, s->cy, 0, s->cx + 1, NULL);
1255 ci->x = 0;
1256 ci->used = s->cx + 1;
1257 ci->type = CLEAR;
1258 ci->bg = bg;
1259 if (before == NULL)
1260 TAILQ_INSERT_TAIL(&ctx->s->write_list[s->cy].items, ci, entry);
1261 else
1262 TAILQ_INSERT_BEFORE(before, ci, entry);
1263 ctx->item = screen_write_get_citem();
1266 /* Move cursor to px,py. */
1267 void
1268 screen_write_cursormove(struct screen_write_ctx *ctx, int px, int py,
1269 int origin)
1271 struct screen *s = ctx->s;
1273 if (origin && py != -1 && (s->mode & MODE_ORIGIN)) {
1274 if ((u_int)py > s->rlower - s->rupper)
1275 py = s->rlower;
1276 else
1277 py += s->rupper;
1280 if (px != -1 && (u_int)px > screen_size_x(s) - 1)
1281 px = screen_size_x(s) - 1;
1282 if (py != -1 && (u_int)py > screen_size_y(s) - 1)
1283 py = screen_size_y(s) - 1;
1285 log_debug("%s: from %u,%u to %u,%u", __func__, s->cx, s->cy, px, py);
1286 screen_write_set_cursor(ctx, px, py);
1289 /* Reverse index (up with scroll). */
1290 void
1291 screen_write_reverseindex(struct screen_write_ctx *ctx, u_int bg)
1293 struct screen *s = ctx->s;
1294 struct tty_ctx ttyctx;
1296 if (s->cy == s->rupper) {
1297 grid_view_scroll_region_down(s->grid, s->rupper, s->rlower, bg);
1298 screen_write_collect_flush(ctx, 0, __func__);
1300 screen_write_initctx(ctx, &ttyctx, 1);
1301 ttyctx.bg = bg;
1303 tty_write(tty_cmd_reverseindex, &ttyctx);
1304 } else if (s->cy > 0)
1305 screen_write_set_cursor(ctx, -1, s->cy - 1);
1309 /* Set scroll region. */
1310 void
1311 screen_write_scrollregion(struct screen_write_ctx *ctx, u_int rupper,
1312 u_int rlower)
1314 struct screen *s = ctx->s;
1316 if (rupper > screen_size_y(s) - 1)
1317 rupper = screen_size_y(s) - 1;
1318 if (rlower > screen_size_y(s) - 1)
1319 rlower = screen_size_y(s) - 1;
1320 if (rupper >= rlower) /* cannot be one line */
1321 return;
1323 screen_write_collect_flush(ctx, 0, __func__);
1325 /* Cursor moves to top-left. */
1326 screen_write_set_cursor(ctx, 0, 0);
1328 s->rupper = rupper;
1329 s->rlower = rlower;
1332 /* Line feed. */
1333 void
1334 screen_write_linefeed(struct screen_write_ctx *ctx, int wrapped, u_int bg)
1336 struct screen *s = ctx->s;
1337 struct grid *gd = s->grid;
1338 struct grid_line *gl;
1340 gl = grid_get_line(gd, gd->hsize + s->cy);
1341 if (wrapped)
1342 gl->flags |= GRID_LINE_WRAPPED;
1344 log_debug("%s: at %u,%u (region %u-%u)", __func__, s->cx, s->cy,
1345 s->rupper, s->rlower);
1347 if (bg != ctx->bg) {
1348 screen_write_collect_flush(ctx, 1, __func__);
1349 ctx->bg = bg;
1352 if (s->cy == s->rlower) {
1353 grid_view_scroll_region_up(gd, s->rupper, s->rlower, bg);
1354 screen_write_collect_scroll(ctx, bg);
1355 ctx->scrolled++;
1356 } else if (s->cy < screen_size_y(s) - 1)
1357 screen_write_set_cursor(ctx, -1, s->cy + 1);
1360 /* Scroll up. */
1361 void
1362 screen_write_scrollup(struct screen_write_ctx *ctx, u_int lines, u_int bg)
1364 struct screen *s = ctx->s;
1365 struct grid *gd = s->grid;
1366 u_int i;
1368 if (lines == 0)
1369 lines = 1;
1370 else if (lines > s->rlower - s->rupper + 1)
1371 lines = s->rlower - s->rupper + 1;
1373 if (bg != ctx->bg) {
1374 screen_write_collect_flush(ctx, 1, __func__);
1375 ctx->bg = bg;
1378 for (i = 0; i < lines; i++) {
1379 grid_view_scroll_region_up(gd, s->rupper, s->rlower, bg);
1380 screen_write_collect_scroll(ctx, bg);
1382 ctx->scrolled += lines;
1385 /* Scroll down. */
1386 void
1387 screen_write_scrolldown(struct screen_write_ctx *ctx, u_int lines, u_int bg)
1389 struct screen *s = ctx->s;
1390 struct grid *gd = s->grid;
1391 struct tty_ctx ttyctx;
1392 u_int i;
1394 screen_write_initctx(ctx, &ttyctx, 1);
1395 ttyctx.bg = bg;
1397 if (lines == 0)
1398 lines = 1;
1399 else if (lines > s->rlower - s->rupper + 1)
1400 lines = s->rlower - s->rupper + 1;
1402 for (i = 0; i < lines; i++)
1403 grid_view_scroll_region_down(gd, s->rupper, s->rlower, bg);
1405 screen_write_collect_flush(ctx, 0, __func__);
1406 ttyctx.num = lines;
1407 tty_write(tty_cmd_scrolldown, &ttyctx);
1410 /* Carriage return (cursor to start of line). */
1411 void
1412 screen_write_carriagereturn(struct screen_write_ctx *ctx)
1414 screen_write_set_cursor(ctx, 0, -1);
1417 /* Clear to end of screen from cursor. */
1418 void
1419 screen_write_clearendofscreen(struct screen_write_ctx *ctx, u_int bg)
1421 struct screen *s = ctx->s;
1422 struct grid *gd = s->grid;
1423 struct tty_ctx ttyctx;
1424 u_int sx = screen_size_x(s), sy = screen_size_y(s);
1426 screen_write_initctx(ctx, &ttyctx, 1);
1427 ttyctx.bg = bg;
1429 /* Scroll into history if it is enabled and clearing entire screen. */
1430 if (s->cx == 0 && s->cy == 0 && (gd->flags & GRID_HISTORY))
1431 grid_view_clear_history(gd, bg);
1432 else {
1433 if (s->cx <= sx - 1)
1434 grid_view_clear(gd, s->cx, s->cy, sx - s->cx, 1, bg);
1435 grid_view_clear(gd, 0, s->cy + 1, sx, sy - (s->cy + 1), bg);
1438 screen_write_collect_clear(ctx, s->cy + 1, sy - (s->cy + 1));
1439 screen_write_collect_flush(ctx, 0, __func__);
1440 tty_write(tty_cmd_clearendofscreen, &ttyctx);
1443 /* Clear to start of screen. */
1444 void
1445 screen_write_clearstartofscreen(struct screen_write_ctx *ctx, u_int bg)
1447 struct screen *s = ctx->s;
1448 struct tty_ctx ttyctx;
1449 u_int sx = screen_size_x(s);
1451 screen_write_initctx(ctx, &ttyctx, 1);
1452 ttyctx.bg = bg;
1454 if (s->cy > 0)
1455 grid_view_clear(s->grid, 0, 0, sx, s->cy, bg);
1456 if (s->cx > sx - 1)
1457 grid_view_clear(s->grid, 0, s->cy, sx, 1, bg);
1458 else
1459 grid_view_clear(s->grid, 0, s->cy, s->cx + 1, 1, bg);
1461 screen_write_collect_clear(ctx, 0, s->cy);
1462 screen_write_collect_flush(ctx, 0, __func__);
1463 tty_write(tty_cmd_clearstartofscreen, &ttyctx);
1466 /* Clear entire screen. */
1467 void
1468 screen_write_clearscreen(struct screen_write_ctx *ctx, u_int bg)
1470 struct screen *s = ctx->s;
1471 struct tty_ctx ttyctx;
1472 u_int sx = screen_size_x(s), sy = screen_size_y(s);
1474 screen_write_initctx(ctx, &ttyctx, 1);
1475 ttyctx.bg = bg;
1477 /* Scroll into history if it is enabled. */
1478 if (s->grid->flags & GRID_HISTORY)
1479 grid_view_clear_history(s->grid, bg);
1480 else
1481 grid_view_clear(s->grid, 0, 0, sx, sy, bg);
1483 screen_write_collect_clear(ctx, 0, sy);
1484 tty_write(tty_cmd_clearscreen, &ttyctx);
1487 /* Clear entire history. */
1488 void
1489 screen_write_clearhistory(struct screen_write_ctx *ctx)
1491 grid_clear_history(ctx->s->grid);
1494 /* Force a full redraw. */
1495 void
1496 screen_write_fullredraw(struct screen_write_ctx *ctx)
1498 struct tty_ctx ttyctx;
1500 screen_write_collect_flush(ctx, 0, __func__);
1502 screen_write_initctx(ctx, &ttyctx, 1);
1503 ttyctx.redraw_cb(&ttyctx);
1506 /* Trim collected items. */
1507 static struct screen_write_citem *
1508 screen_write_collect_trim(struct screen_write_ctx *ctx, u_int y, u_int x,
1509 u_int used, int *wrapped)
1511 struct screen_write_cline *cl = &ctx->s->write_list[y];
1512 struct screen_write_citem *ci, *ci2, *tmp, *before = NULL;
1513 u_int sx = x, ex = x + used - 1;
1514 u_int csx, cex;
1516 if (TAILQ_EMPTY(&cl->items))
1517 return (NULL);
1518 TAILQ_FOREACH_SAFE(ci, &cl->items, entry, tmp) {
1519 csx = ci->x;
1520 cex = ci->x + ci->used - 1;
1522 /* Item is entirely before. */
1523 if (cex < sx) {
1524 log_debug("%s: %p %u-%u before %u-%u", __func__, ci,
1525 csx, cex, sx, ex);
1526 continue;
1529 /* Item is entirely after. */
1530 if (csx > ex) {
1531 log_debug("%s: %p %u-%u after %u-%u", __func__, ci,
1532 csx, cex, sx, ex);
1533 before = ci;
1534 break;
1537 /* Item is entirely inside. */
1538 if (csx >= sx && cex <= ex) {
1539 log_debug("%s: %p %u-%u inside %u-%u", __func__, ci,
1540 csx, cex, sx, ex);
1541 TAILQ_REMOVE(&cl->items, ci, entry);
1542 screen_write_free_citem(ci);
1543 if (csx == 0 && ci->wrapped && wrapped != NULL)
1544 *wrapped = 1;
1545 continue;
1548 /* Item under the start. */
1549 if (csx < sx && cex >= sx && cex <= ex) {
1550 log_debug("%s: %p %u-%u start %u-%u", __func__, ci,
1551 csx, cex, sx, ex);
1552 ci->used = sx - csx;
1553 log_debug("%s: %p now %u-%u", __func__, ci, ci->x,
1554 ci->x + ci->used + 1);
1555 continue;
1558 /* Item covers the end. */
1559 if (cex > ex && csx >= sx && csx <= ex) {
1560 log_debug("%s: %p %u-%u end %u-%u", __func__, ci,
1561 csx, cex, sx, ex);
1562 ci->x = ex + 1;
1563 ci->used = cex - ex;
1564 log_debug("%s: %p now %u-%u", __func__, ci, ci->x,
1565 ci->x + ci->used + 1);
1566 before = ci;
1567 break;
1570 /* Item must cover both sides. */
1571 log_debug("%s: %p %u-%u under %u-%u", __func__, ci,
1572 csx, cex, sx, ex);
1573 ci2 = screen_write_get_citem();
1574 ci2->type = ci->type;
1575 ci2->bg = ci->bg;
1576 memcpy(&ci2->gc, &ci->gc, sizeof ci2->gc);
1577 TAILQ_INSERT_AFTER(&cl->items, ci, ci2, entry);
1579 ci->used = sx - csx;
1580 ci2->x = ex + 1;
1581 ci2->used = cex - ex;
1583 log_debug("%s: %p now %u-%u (%p) and %u-%u (%p)", __func__, ci,
1584 ci->x, ci->x + ci->used - 1, ci, ci2->x,
1585 ci2->x + ci2->used - 1, ci2);
1586 before = ci2;
1587 break;
1589 return (before);
1592 /* Clear collected lines. */
1593 static void
1594 screen_write_collect_clear(struct screen_write_ctx *ctx, u_int y, u_int n)
1596 struct screen_write_cline *cl;
1597 u_int i;
1599 for (i = y; i < y + n; i++) {
1600 cl = &ctx->s->write_list[i];
1601 TAILQ_CONCAT(&screen_write_citem_freelist, &cl->items, entry);
1605 /* Scroll collected lines up. */
1606 static void
1607 screen_write_collect_scroll(struct screen_write_ctx *ctx, u_int bg)
1609 struct screen *s = ctx->s;
1610 struct screen_write_cline *cl;
1611 u_int y;
1612 char *saved;
1613 struct screen_write_citem *ci;
1615 log_debug("%s: at %u,%u (region %u-%u)", __func__, s->cx, s->cy,
1616 s->rupper, s->rlower);
1618 screen_write_collect_clear(ctx, s->rupper, 1);
1619 saved = ctx->s->write_list[s->rupper].data;
1620 for (y = s->rupper; y < s->rlower; y++) {
1621 cl = &ctx->s->write_list[y + 1];
1622 TAILQ_CONCAT(&ctx->s->write_list[y].items, &cl->items, entry);
1623 ctx->s->write_list[y].data = cl->data;
1625 ctx->s->write_list[s->rlower].data = saved;
1627 ci = screen_write_get_citem();
1628 ci->x = 0;
1629 ci->used = screen_size_x(s);
1630 ci->type = CLEAR;
1631 ci->bg = bg;
1632 TAILQ_INSERT_TAIL(&ctx->s->write_list[s->rlower].items, ci, entry);
1635 /* Flush collected lines. */
1636 static void
1637 screen_write_collect_flush(struct screen_write_ctx *ctx, int scroll_only,
1638 const char *from)
1640 struct screen *s = ctx->s;
1641 struct screen_write_citem *ci, *tmp;
1642 struct screen_write_cline *cl;
1643 u_int y, cx, cy, last, items = 0;
1644 struct tty_ctx ttyctx;
1646 if (ctx->scrolled != 0) {
1647 log_debug("%s: scrolled %u (region %u-%u)", __func__,
1648 ctx->scrolled, s->rupper, s->rlower);
1649 if (ctx->scrolled > s->rlower - s->rupper + 1)
1650 ctx->scrolled = s->rlower - s->rupper + 1;
1652 screen_write_initctx(ctx, &ttyctx, 1);
1653 ttyctx.num = ctx->scrolled;
1654 ttyctx.bg = ctx->bg;
1655 tty_write(tty_cmd_scrollup, &ttyctx);
1657 ctx->scrolled = 0;
1658 ctx->bg = 8;
1660 if (scroll_only)
1661 return;
1663 cx = s->cx; cy = s->cy;
1664 for (y = 0; y < screen_size_y(s); y++) {
1665 cl = &ctx->s->write_list[y];
1666 last = UINT_MAX;
1667 TAILQ_FOREACH_SAFE(ci, &cl->items, entry, tmp) {
1668 if (last != UINT_MAX && ci->x <= last) {
1669 fatalx("collect list not in order: %u <= %u",
1670 ci->x, last);
1672 screen_write_set_cursor(ctx, ci->x, y);
1673 if (ci->type == CLEAR) {
1674 screen_write_initctx(ctx, &ttyctx, 1);
1675 ttyctx.bg = ci->bg;
1676 ttyctx.num = ci->used;
1677 tty_write(tty_cmd_clearcharacter, &ttyctx);
1678 } else {
1679 screen_write_initctx(ctx, &ttyctx, 0);
1680 ttyctx.cell = &ci->gc;
1681 ttyctx.wrapped = ci->wrapped;
1682 ttyctx.ptr = cl->data + ci->x;
1683 ttyctx.num = ci->used;
1684 tty_write(tty_cmd_cells, &ttyctx);
1686 items++;
1688 TAILQ_REMOVE(&cl->items, ci, entry);
1689 screen_write_free_citem(ci);
1690 last = ci->x;
1693 s->cx = cx; s->cy = cy;
1695 log_debug("%s: flushed %u items (%s)", __func__, items, from);
1698 /* Finish and store collected cells. */
1699 void
1700 screen_write_collect_end(struct screen_write_ctx *ctx)
1702 struct screen *s = ctx->s;
1703 struct screen_write_citem *ci = ctx->item, *before;
1704 struct screen_write_cline *cl = &s->write_list[s->cy];
1705 struct grid_cell gc;
1706 u_int xx;
1707 int wrapped = ci->wrapped;
1709 if (ci->used == 0)
1710 return;
1712 before = screen_write_collect_trim(ctx, s->cy, s->cx, ci->used,
1713 &wrapped);
1714 ci->x = s->cx;
1715 ci->wrapped = wrapped;
1716 if (before == NULL)
1717 TAILQ_INSERT_TAIL(&cl->items, ci, entry);
1718 else
1719 TAILQ_INSERT_BEFORE(before, ci, entry);
1720 ctx->item = screen_write_get_citem();
1722 log_debug("%s: %u %.*s (at %u,%u)", __func__, ci->used,
1723 (int)ci->used, cl->data + ci->x, s->cx, s->cy);
1725 if (s->cx != 0) {
1726 for (xx = s->cx; xx > 0; xx--) {
1727 grid_view_get_cell(s->grid, xx, s->cy, &gc);
1728 if (~gc.flags & GRID_FLAG_PADDING)
1729 break;
1730 grid_view_set_cell(s->grid, xx, s->cy,
1731 &grid_default_cell);
1733 if (gc.data.width > 1) {
1734 grid_view_set_cell(s->grid, xx, s->cy,
1735 &grid_default_cell);
1739 grid_view_set_cells(s->grid, s->cx, s->cy, &ci->gc, cl->data + ci->x,
1740 ci->used);
1741 screen_write_set_cursor(ctx, s->cx + ci->used, -1);
1743 for (xx = s->cx; xx < screen_size_x(s); xx++) {
1744 grid_view_get_cell(s->grid, xx, s->cy, &gc);
1745 if (~gc.flags & GRID_FLAG_PADDING)
1746 break;
1747 grid_view_set_cell(s->grid, xx, s->cy, &grid_default_cell);
1751 /* Write cell data, collecting if necessary. */
1752 void
1753 screen_write_collect_add(struct screen_write_ctx *ctx,
1754 const struct grid_cell *gc)
1756 struct screen *s = ctx->s;
1757 struct screen_write_citem *ci;
1758 u_int sx = screen_size_x(s);
1759 int collect;
1762 * Don't need to check that the attributes and whatnot are still the
1763 * same - input_parse will end the collection when anything that isn't
1764 * a plain character is encountered.
1767 collect = 1;
1768 if (gc->data.width != 1 || gc->data.size != 1 || *gc->data.data >= 0x7f)
1769 collect = 0;
1770 else if (gc->attr & GRID_ATTR_CHARSET)
1771 collect = 0;
1772 else if (~s->mode & MODE_WRAP)
1773 collect = 0;
1774 else if (s->mode & MODE_INSERT)
1775 collect = 0;
1776 else if (s->sel != NULL)
1777 collect = 0;
1778 if (!collect) {
1779 screen_write_collect_end(ctx);
1780 screen_write_collect_flush(ctx, 0, __func__);
1781 screen_write_cell(ctx, gc);
1782 return;
1785 if (s->cx > sx - 1 || ctx->item->used > sx - 1 - s->cx)
1786 screen_write_collect_end(ctx);
1787 ci = ctx->item; /* may have changed */
1789 if (s->cx > sx - 1) {
1790 log_debug("%s: wrapped at %u,%u", __func__, s->cx, s->cy);
1791 ci->wrapped = 1;
1792 screen_write_linefeed(ctx, 1, 8);
1793 screen_write_set_cursor(ctx, 0, -1);
1796 if (ci->used == 0)
1797 memcpy(&ci->gc, gc, sizeof ci->gc);
1798 if (ctx->s->write_list[s->cy].data == NULL)
1799 ctx->s->write_list[s->cy].data = xmalloc(screen_size_x(ctx->s));
1800 ctx->s->write_list[s->cy].data[s->cx + ci->used++] = gc->data.data[0];
1803 /* Write cell data. */
1804 void
1805 screen_write_cell(struct screen_write_ctx *ctx, const struct grid_cell *gc)
1807 struct screen *s = ctx->s;
1808 struct grid *gd = s->grid;
1809 const struct utf8_data *ud = &gc->data;
1810 const struct utf8_data zwj = { "\342\200\215", 0, 3, 0 };
1811 struct grid_line *gl;
1812 struct grid_cell_entry *gce;
1813 struct grid_cell tmp_gc, now_gc;
1814 struct tty_ctx ttyctx;
1815 u_int sx = screen_size_x(s), sy = screen_size_y(s);
1816 u_int width = gc->data.width, xx, last, cx, cy;
1817 int selected, skip = 1;
1819 /* Ignore padding cells. */
1820 if (gc->flags & GRID_FLAG_PADDING)
1821 return;
1824 * If this is a zero width joiner, set the flag so the next character
1825 * will be treated as zero width and appended. Note that we assume a
1826 * ZWJ will not change the width - the width of the first character is
1827 * used.
1829 if (ud->size == 3 && memcmp(ud->data, "\342\200\215", 3) == 0) {
1830 log_debug("zero width joiner at %u,%u", s->cx, s->cy);
1831 ctx->flags |= SCREEN_WRITE_ZWJ;
1832 return;
1836 * If the width is zero, combine onto the previous character. We always
1837 * combine with the cell to the left of the cursor position. In theory,
1838 * the application could have moved the cursor somewhere else, but if
1839 * they are silly enough to do that, who cares?
1841 if (ctx->flags & SCREEN_WRITE_ZWJ) {
1842 screen_write_collect_flush(ctx, 0, __func__);
1843 screen_write_combine(ctx, &zwj, &xx);
1845 if (width == 0 || (ctx->flags & SCREEN_WRITE_ZWJ)) {
1846 ctx->flags &= ~SCREEN_WRITE_ZWJ;
1847 screen_write_collect_flush(ctx, 0, __func__);
1848 if ((gc = screen_write_combine(ctx, ud, &xx)) != NULL) {
1849 cx = s->cx; cy = s->cy;
1850 screen_write_set_cursor(ctx, xx, s->cy);
1851 screen_write_initctx(ctx, &ttyctx, 0);
1852 ttyctx.cell = gc;
1853 tty_write(tty_cmd_cell, &ttyctx);
1854 s->cx = cx; s->cy = cy;
1856 return;
1859 /* Flush any existing scrolling. */
1860 screen_write_collect_flush(ctx, 1, __func__);
1862 /* If this character doesn't fit, ignore it. */
1863 if ((~s->mode & MODE_WRAP) &&
1864 width > 1 &&
1865 (width > sx || (s->cx != sx && s->cx > sx - width)))
1866 return;
1868 /* If in insert mode, make space for the cells. */
1869 if (s->mode & MODE_INSERT) {
1870 grid_view_insert_cells(s->grid, s->cx, s->cy, width, 8);
1871 skip = 0;
1874 /* Check this will fit on the current line and wrap if not. */
1875 if ((s->mode & MODE_WRAP) && s->cx > sx - width) {
1876 log_debug("%s: wrapped at %u,%u", __func__, s->cx, s->cy);
1877 screen_write_linefeed(ctx, 1, 8);
1878 screen_write_set_cursor(ctx, 0, -1);
1879 screen_write_collect_flush(ctx, 1, __func__);
1882 /* Sanity check cursor position. */
1883 if (s->cx > sx - width || s->cy > sy - 1)
1884 return;
1885 screen_write_initctx(ctx, &ttyctx, 0);
1887 /* Handle overwriting of UTF-8 characters. */
1888 gl = grid_get_line(s->grid, s->grid->hsize + s->cy);
1889 if (gl->flags & GRID_LINE_EXTENDED) {
1890 grid_view_get_cell(gd, s->cx, s->cy, &now_gc);
1891 if (screen_write_overwrite(ctx, &now_gc, width))
1892 skip = 0;
1896 * If the new character is UTF-8 wide, fill in padding cells. Have
1897 * already ensured there is enough room.
1899 for (xx = s->cx + 1; xx < s->cx + width; xx++) {
1900 log_debug("%s: new padding at %u,%u", __func__, xx, s->cy);
1901 grid_view_set_padding(gd, xx, s->cy);
1902 skip = 0;
1905 /* If no change, do not draw. */
1906 if (skip) {
1907 if (s->cx >= gl->cellsize)
1908 skip = grid_cells_equal(gc, &grid_default_cell);
1909 else {
1910 gce = &gl->celldata[s->cx];
1911 if (gce->flags & GRID_FLAG_EXTENDED)
1912 skip = 0;
1913 else if (gc->flags != gce->flags)
1914 skip = 0;
1915 else if (gc->attr != gce->data.attr)
1916 skip = 0;
1917 else if (gc->fg != gce->data.fg)
1918 skip = 0;
1919 else if (gc->bg != gce->data.bg)
1920 skip = 0;
1921 else if (gc->data.width != 1)
1922 skip = 0;
1923 else if (gc->data.size != 1)
1924 skip = 0;
1925 else if (gce->data.data != gc->data.data[0])
1926 skip = 0;
1930 /* Update the selected flag and set the cell. */
1931 selected = screen_check_selection(s, s->cx, s->cy);
1932 if (selected && (~gc->flags & GRID_FLAG_SELECTED)) {
1933 memcpy(&tmp_gc, gc, sizeof tmp_gc);
1934 tmp_gc.flags |= GRID_FLAG_SELECTED;
1935 grid_view_set_cell(gd, s->cx, s->cy, &tmp_gc);
1936 } else if (!selected && (gc->flags & GRID_FLAG_SELECTED)) {
1937 memcpy(&tmp_gc, gc, sizeof tmp_gc);
1938 tmp_gc.flags &= ~GRID_FLAG_SELECTED;
1939 grid_view_set_cell(gd, s->cx, s->cy, &tmp_gc);
1940 } else if (!skip)
1941 grid_view_set_cell(gd, s->cx, s->cy, gc);
1942 if (selected)
1943 skip = 0;
1946 * Move the cursor. If not wrapping, stick at the last character and
1947 * replace it.
1949 last = !(s->mode & MODE_WRAP);
1950 if (s->cx <= sx - last - width)
1951 screen_write_set_cursor(ctx, s->cx + width, -1);
1952 else
1953 screen_write_set_cursor(ctx, sx - last, -1);
1955 /* Create space for character in insert mode. */
1956 if (s->mode & MODE_INSERT) {
1957 screen_write_collect_flush(ctx, 0, __func__);
1958 ttyctx.num = width;
1959 tty_write(tty_cmd_insertcharacter, &ttyctx);
1962 /* Write to the screen. */
1963 if (!skip) {
1964 if (selected) {
1965 screen_select_cell(s, &tmp_gc, gc);
1966 ttyctx.cell = &tmp_gc;
1967 } else
1968 ttyctx.cell = gc;
1969 tty_write(tty_cmd_cell, &ttyctx);
1973 /* Combine a UTF-8 zero-width character onto the previous. */
1974 static const struct grid_cell *
1975 screen_write_combine(struct screen_write_ctx *ctx, const struct utf8_data *ud,
1976 u_int *xx)
1978 struct screen *s = ctx->s;
1979 struct grid *gd = s->grid;
1980 static struct grid_cell gc;
1981 u_int n;
1983 /* Can't combine if at 0. */
1984 if (s->cx == 0)
1985 return (NULL);
1987 /* Empty data is out. */
1988 if (ud->size == 0)
1989 fatalx("UTF-8 data empty");
1991 /* Retrieve the previous cell. */
1992 for (n = 1; n <= s->cx; n++) {
1993 grid_view_get_cell(gd, s->cx - n, s->cy, &gc);
1994 if (~gc.flags & GRID_FLAG_PADDING)
1995 break;
1997 if (n > s->cx)
1998 return (NULL);
1999 *xx = s->cx - n;
2001 /* Check there is enough space. */
2002 if (gc.data.size + ud->size > sizeof gc.data.data)
2003 return (NULL);
2005 log_debug("%s: %.*s onto %.*s at %u,%u", __func__, (int)ud->size,
2006 ud->data, (int)gc.data.size, gc.data.data, *xx, s->cy);
2008 /* Append the data. */
2009 memcpy(gc.data.data + gc.data.size, ud->data, ud->size);
2010 gc.data.size += ud->size;
2012 /* Set the new cell. */
2013 grid_view_set_cell(gd, *xx, s->cy, &gc);
2015 return (&gc);
2019 * UTF-8 wide characters are a bit of an annoyance. They take up more than one
2020 * cell on the screen, so following cells must not be drawn by marking them as
2021 * padding.
2023 * So far, so good. The problem is, when overwriting a padding cell, or a UTF-8
2024 * character, it is necessary to also overwrite any other cells which covered
2025 * by the same character.
2027 static int
2028 screen_write_overwrite(struct screen_write_ctx *ctx, struct grid_cell *gc,
2029 u_int width)
2031 struct screen *s = ctx->s;
2032 struct grid *gd = s->grid;
2033 struct grid_cell tmp_gc;
2034 u_int xx;
2035 int done = 0;
2037 if (gc->flags & GRID_FLAG_PADDING) {
2039 * A padding cell, so clear any following and leading padding
2040 * cells back to the character. Don't overwrite the current
2041 * cell as that happens later anyway.
2043 xx = s->cx + 1;
2044 while (--xx > 0) {
2045 grid_view_get_cell(gd, xx, s->cy, &tmp_gc);
2046 if (~tmp_gc.flags & GRID_FLAG_PADDING)
2047 break;
2048 log_debug("%s: padding at %u,%u", __func__, xx, s->cy);
2049 grid_view_set_cell(gd, xx, s->cy, &grid_default_cell);
2052 /* Overwrite the character at the start of this padding. */
2053 log_debug("%s: character at %u,%u", __func__, xx, s->cy);
2054 grid_view_set_cell(gd, xx, s->cy, &grid_default_cell);
2055 done = 1;
2059 * Overwrite any padding cells that belong to any UTF-8 characters
2060 * we'll be overwriting with the current character.
2062 if (width != 1 ||
2063 gc->data.width != 1 ||
2064 gc->flags & GRID_FLAG_PADDING) {
2065 xx = s->cx + width - 1;
2066 while (++xx < screen_size_x(s)) {
2067 grid_view_get_cell(gd, xx, s->cy, &tmp_gc);
2068 if (~tmp_gc.flags & GRID_FLAG_PADDING)
2069 break;
2070 log_debug("%s: overwrite at %u,%u", __func__, xx,
2071 s->cy);
2072 grid_view_set_cell(gd, xx, s->cy, &grid_default_cell);
2073 done = 1;
2077 return (done);
2080 /* Set external clipboard. */
2081 void
2082 screen_write_setselection(struct screen_write_ctx *ctx, u_char *str, u_int len)
2084 struct tty_ctx ttyctx;
2086 screen_write_initctx(ctx, &ttyctx, 0);
2087 ttyctx.ptr = str;
2088 ttyctx.num = len;
2090 tty_write(tty_cmd_setselection, &ttyctx);
2093 /* Write unmodified string. */
2094 void
2095 screen_write_rawstring(struct screen_write_ctx *ctx, u_char *str, u_int len)
2097 struct tty_ctx ttyctx;
2099 screen_write_initctx(ctx, &ttyctx, 0);
2100 ttyctx.ptr = str;
2101 ttyctx.num = len;
2103 tty_write(tty_cmd_rawstring, &ttyctx);
2106 /* Turn alternate screen on. */
2107 void
2108 screen_write_alternateon(struct screen_write_ctx *ctx, struct grid_cell *gc,
2109 int cursor)
2111 struct tty_ctx ttyctx;
2112 struct window_pane *wp = ctx->wp;
2114 if (wp != NULL && !options_get_number(wp->options, "alternate-screen"))
2115 return;
2117 screen_write_collect_flush(ctx, 0, __func__);
2118 screen_alternate_on(ctx->s, gc, cursor);
2120 screen_write_initctx(ctx, &ttyctx, 1);
2121 ttyctx.redraw_cb(&ttyctx);
2124 /* Turn alternate screen off. */
2125 void
2126 screen_write_alternateoff(struct screen_write_ctx *ctx, struct grid_cell *gc,
2127 int cursor)
2129 struct tty_ctx ttyctx;
2130 struct window_pane *wp = ctx->wp;
2132 if (wp != NULL && !options_get_number(wp->options, "alternate-screen"))
2133 return;
2135 screen_write_collect_flush(ctx, 0, __func__);
2136 screen_alternate_off(ctx->s, gc, cursor);
2138 screen_write_initctx(ctx, &ttyctx, 1);
2139 ttyctx.redraw_cb(&ttyctx);