2 * Copyright (c) 2009, 2013 The FreeBSD Foundation
5 * This software was developed by Ed Schouten under sponsorship from the
8 * Portions of this software were developed by Oleksandr Rybalko
9 * under sponsorship from the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
41 #include <sys/systm.h>
43 #include <dev/vt/vt.h>
45 static MALLOC_DEFINE(M_VTBUF, "vtbuf", "vt buffer");
47 #define VTBUF_LOCK(vb) mtx_lock_spin(&(vb)->vb_lock)
48 #define VTBUF_UNLOCK(vb) mtx_unlock_spin(&(vb)->vb_lock)
50 #define POS_INDEX(c, r) (((r) << 12) + (c))
51 #define POS_COPY(d, s) do { \
52 (d).tp_col = (s).tp_col; \
53 (d).tp_row = (s).tp_row; \
59 * line5 <--- curroffset (terminal output to that line)
61 * line1 <--- roffset (history display from that point)
66 vthistory_seek(struct vt_buf *vb, int offset, int whence)
68 int diff, top, bottom, roffset;
70 /* No scrolling if not enabled. */
71 if ((vb->vb_flags & VBF_SCROLL) == 0) {
72 if (vb->vb_roffset != vb->vb_curroffset) {
73 vb->vb_roffset = vb->vb_curroffset;
76 return (0); /* No changes */
78 top = (vb->vb_flags & VBF_HISTORY_FULL)?
79 (vb->vb_curroffset + vb->vb_scr_size.tp_row):vb->vb_history_size;
80 bottom = vb->vb_curroffset + vb->vb_history_size;
83 * Operate on copy of offset value, since it temporary can be bigger
84 * than amount of rows in buffer.
86 roffset = vb->vb_roffset + vb->vb_history_size;
89 roffset = offset + vb->vb_history_size;
95 /* Go to current offset. */
96 roffset = vb->vb_curroffset + vb->vb_history_size;
100 roffset = (roffset < top)?top:roffset;
101 roffset = (roffset > bottom)?bottom:roffset;
103 roffset %= vb->vb_history_size;
105 if (vb->vb_roffset != roffset) {
106 diff = vb->vb_roffset - roffset;
107 vb->vb_roffset = roffset;
109 * Offset changed, please update Nth lines on sceen.
110 * +N - Nth lines at top;
111 * -N - Nth lines at bottom.
115 return (0); /* No changes */
119 vthistory_addlines(struct vt_buf *vb, int offset)
122 vb->vb_curroffset += offset;
123 if (vb->vb_curroffset < 0)
124 vb->vb_curroffset = 0;
125 vb->vb_curroffset %= vb->vb_history_size;
126 if ((vb->vb_flags & VBF_SCROLL) == 0) {
127 vb->vb_roffset = vb->vb_curroffset;
132 vthistory_getpos(const struct vt_buf *vb, unsigned int *offset)
135 *offset = vb->vb_roffset;
138 /* Translate current view row number to history row. */
140 vtbuf_wth(struct vt_buf *vb, int row)
143 return ((vb->vb_roffset + row) % vb->vb_history_size);
146 /* Translate history row to current view row number. */
148 vtbuf_htw(struct vt_buf *vb, int row)
153 * History offset roffset winrow
154 * 205 200 ((205 - 200 + 1000) % 1000) = 5
155 * 90 990 ((90 - 990 + 1000) % 1000) = 100
157 return ((row - vb->vb_roffset + vb->vb_history_size) %
158 vb->vb_history_size);
162 vtbuf_iscursor(struct vt_buf *vb, int row, int col)
164 int sc, sr, ec, er, tmp;
166 if ((vb->vb_flags & (VBF_CURSOR|VBF_SCROLL)) == VBF_CURSOR &&
167 (vb->vb_cursor.tp_row == row) && (vb->vb_cursor.tp_col == col))
170 /* Mark cut/paste region. */
173 * Luckily screen view is not like circular buffer, so we will
174 * calculate in screen coordinates. Translate first.
176 sc = vb->vb_mark_start.tp_col;
177 sr = vtbuf_htw(vb, vb->vb_mark_start.tp_row);
178 ec = vb->vb_mark_end.tp_col;
179 er = vtbuf_htw(vb, vb->vb_mark_end.tp_row);
182 /* Swap start and end if start > end. */
183 if (POS_INDEX(sc, sr) > POS_INDEX(ec, er)) {
184 tmp = sc; sc = ec; ec = tmp;
185 tmp = sr; sr = er; er = tmp;
188 if ((POS_INDEX(sc, sr) <= POS_INDEX(col, row)) &&
189 (POS_INDEX(col, row) < POS_INDEX(ec, er)))
195 static inline uint64_t
196 vtbuf_dirty_axis(unsigned int begin, unsigned int end)
198 uint64_t left, right, mask;
201 * Mark all bits between begin % 64 and end % 64 dirty.
202 * This code is functionally equivalent to:
204 * for (i = begin; i < end; i++)
205 * mask |= (uint64_t)1 << (i % 64);
208 /* Obvious case. Mark everything dirty. */
209 if (end - begin >= 64)
212 /* 1....0; used bits on the left. */
213 left = VBM_DIRTY << begin % 64;
214 /* 0....1; used bits on the right. */
215 right = VBM_DIRTY >> -end % 64;
218 * Only take the intersection. If the result of that is 0, it
219 * means that the selection crossed a 64 bit boundary along the
220 * way, which means we have to take the complement.
229 vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area)
233 if (vb->vb_dirtyrect.tr_begin.tp_row > area->tr_begin.tp_row)
234 vb->vb_dirtyrect.tr_begin.tp_row = area->tr_begin.tp_row;
235 if (vb->vb_dirtyrect.tr_begin.tp_col > area->tr_begin.tp_col)
236 vb->vb_dirtyrect.tr_begin.tp_col = area->tr_begin.tp_col;
237 if (vb->vb_dirtyrect.tr_end.tp_row < area->tr_end.tp_row)
238 vb->vb_dirtyrect.tr_end.tp_row = area->tr_end.tp_row;
239 if (vb->vb_dirtyrect.tr_end.tp_col < area->tr_end.tp_col)
240 vb->vb_dirtyrect.tr_end.tp_col = area->tr_end.tp_col;
241 vb->vb_dirtymask.vbm_row |=
242 vtbuf_dirty_axis(area->tr_begin.tp_row, area->tr_end.tp_row);
243 vb->vb_dirtymask.vbm_col |=
244 vtbuf_dirty_axis(area->tr_begin.tp_col, area->tr_end.tp_col);
249 vtbuf_dirty_cell(struct vt_buf *vb, const term_pos_t *p)
254 area.tr_end.tp_row = p->tp_row + 1;
255 area.tr_end.tp_col = p->tp_col + 1;
256 vtbuf_dirty(vb, &area);
260 vtbuf_make_undirty(struct vt_buf *vb)
263 vb->vb_dirtyrect.tr_begin = vb->vb_scr_size;
264 vb->vb_dirtyrect.tr_end.tp_row = vb->vb_dirtyrect.tr_end.tp_col = 0;
265 vb->vb_dirtymask.vbm_row = vb->vb_dirtymask.vbm_col = 0;
269 vtbuf_undirty(struct vt_buf *vb, term_rect_t *r, struct vt_bufmask *m)
273 *r = vb->vb_dirtyrect;
274 *m = vb->vb_dirtymask;
275 vtbuf_make_undirty(vb);
280 vtbuf_copy(struct vt_buf *vb, const term_rect_t *r, const term_pos_t *p2)
282 const term_pos_t *p1 = &r->tr_begin;
284 unsigned int rows, cols;
287 KASSERT(r->tr_begin.tp_row < vb->vb_scr_size.tp_row,
288 ("vtbuf_copy begin.tp_row %d must be less than screen width %d",
289 r->tr_begin.tp_row, vb->vb_scr_size.tp_row));
290 KASSERT(r->tr_begin.tp_col < vb->vb_scr_size.tp_col,
291 ("vtbuf_copy begin.tp_col %d must be less than screen height %d",
292 r->tr_begin.tp_col, vb->vb_scr_size.tp_col));
294 KASSERT(r->tr_end.tp_row <= vb->vb_scr_size.tp_row,
295 ("vtbuf_copy end.tp_row %d must be less than screen width %d",
296 r->tr_end.tp_row, vb->vb_scr_size.tp_row));
297 KASSERT(r->tr_end.tp_col <= vb->vb_scr_size.tp_col,
298 ("vtbuf_copy end.tp_col %d must be less than screen height %d",
299 r->tr_end.tp_col, vb->vb_scr_size.tp_col));
301 KASSERT(p2->tp_row < vb->vb_scr_size.tp_row,
302 ("vtbuf_copy tp_row %d must be less than screen width %d",
303 p2->tp_row, vb->vb_scr_size.tp_row));
304 KASSERT(p2->tp_col < vb->vb_scr_size.tp_col,
305 ("vtbuf_copy tp_col %d must be less than screen height %d",
306 p2->tp_col, vb->vb_scr_size.tp_col));
308 rows = r->tr_end.tp_row - r->tr_begin.tp_row;
309 rdiff = r->tr_begin.tp_row - p2->tp_row;
310 cols = r->tr_end.tp_col - r->tr_begin.tp_col;
311 if (r->tr_begin.tp_row > p2->tp_row && r->tr_begin.tp_col == 0 &&
312 r->tr_end.tp_col == vb->vb_scr_size.tp_col && /* Full row. */
313 (rows + rdiff) == vb->vb_scr_size.tp_row && /* Whole screen. */
314 rdiff > 0) { /* Only forward dirrection. Do not eat history. */
315 vthistory_addlines(vb, rdiff);
316 } else if (p2->tp_row < p1->tp_row) {
317 /* Handle overlapping copies of line segments. */
319 for (pr = 0; pr < rows; pr++)
321 &VTBUF_FIELD(vb, p2->tp_row + pr, p2->tp_col),
322 &VTBUF_FIELD(vb, p1->tp_row + pr, p1->tp_col),
323 cols * sizeof(term_char_t));
325 /* Move data down. */
326 for (pr = rows - 1; pr >= 0; pr--)
328 &VTBUF_FIELD(vb, p2->tp_row + pr, p2->tp_col),
329 &VTBUF_FIELD(vb, p1->tp_row + pr, p1->tp_col),
330 cols * sizeof(term_char_t));
334 area.tr_end.tp_row = MIN(p2->tp_row + rows, vb->vb_scr_size.tp_row);
335 area.tr_end.tp_col = MIN(p2->tp_col + cols, vb->vb_scr_size.tp_col);
336 vtbuf_dirty(vb, &area);
340 vtbuf_fill(struct vt_buf *vb, const term_rect_t *r, term_char_t c)
345 for (pr = r->tr_begin.tp_row; pr < r->tr_end.tp_row; pr++) {
346 row = vb->vb_rows[(vb->vb_curroffset + pr) %
347 VTBUF_MAX_HEIGHT(vb)];
348 for (pc = r->tr_begin.tp_col; pc < r->tr_end.tp_col; pc++) {
355 vtbuf_fill_locked(struct vt_buf *vb, const term_rect_t *r, term_char_t c)
357 KASSERT(r->tr_begin.tp_row < vb->vb_scr_size.tp_row,
358 ("vtbuf_fill_locked begin.tp_row %d must be < screen width %d",
359 r->tr_begin.tp_row, vb->vb_scr_size.tp_row));
360 KASSERT(r->tr_begin.tp_col < vb->vb_scr_size.tp_col,
361 ("vtbuf_fill_locked begin.tp_col %d must be < screen height %d",
362 r->tr_begin.tp_col, vb->vb_scr_size.tp_col));
364 KASSERT(r->tr_end.tp_row <= vb->vb_scr_size.tp_row,
365 ("vtbuf_fill_locked end.tp_row %d must be <= screen width %d",
366 r->tr_end.tp_row, vb->vb_scr_size.tp_row));
367 KASSERT(r->tr_end.tp_col <= vb->vb_scr_size.tp_col,
368 ("vtbuf_fill_locked end.tp_col %d must be <= screen height %d",
369 r->tr_end.tp_col, vb->vb_scr_size.tp_col));
372 vtbuf_fill(vb, r, c);
379 vtbuf_init_rows(struct vt_buf *vb)
383 vb->vb_history_size = MAX(vb->vb_history_size, vb->vb_scr_size.tp_row);
385 for (r = 0; r < vb->vb_history_size; r++)
386 vb->vb_rows[r] = &vb->vb_buffer[r *
387 vb->vb_scr_size.tp_col];
391 vtbuf_init_early(struct vt_buf *vb)
394 vb->vb_flags |= VBF_CURSOR;
396 vb->vb_curroffset = 0;
397 vb->vb_mark_start.tp_row = 0;
398 vb->vb_mark_start.tp_col = 0;
399 vb->vb_mark_end.tp_row = 0;
400 vb->vb_mark_end.tp_col = 0;
403 vtbuf_make_undirty(vb);
404 if ((vb->vb_flags & VBF_MTX_INIT) == 0) {
405 mtx_init(&vb->vb_lock, "vtbuf", NULL, MTX_SPIN);
406 vb->vb_flags |= VBF_MTX_INIT;
411 vtbuf_init(struct vt_buf *vb, const term_pos_t *p)
415 vb->vb_scr_size = *p;
416 vb->vb_history_size = VBF_DEFAULT_HISTORY_SIZE;
418 if ((vb->vb_flags & VBF_STATIC) == 0) {
419 sz = vb->vb_history_size * p->tp_col * sizeof(term_char_t);
420 vb->vb_buffer = malloc(sz, M_VTBUF, M_WAITOK | M_ZERO);
422 sz = vb->vb_history_size * sizeof(term_char_t *);
423 vb->vb_rows = malloc(sz, M_VTBUF, M_WAITOK | M_ZERO);
426 vtbuf_init_early(vb);
430 vtbuf_sethistory_size(struct vt_buf *vb, int size)
435 p.tp_row = vb->vb_scr_size.tp_row;
436 p.tp_col = vb->vb_scr_size.tp_col;
437 vtbuf_grow(vb, &p, size);
441 vtbuf_grow(struct vt_buf *vb, const term_pos_t *p, int history_size)
443 term_char_t *old, *new, **rows, **oldrows, **copyrows, *row;
444 int bufsize, rowssize, w, h, c, r;
447 history_size = MAX(history_size, p->tp_row);
449 if (history_size > vb->vb_history_size || p->tp_col >
450 vb->vb_scr_size.tp_col) {
451 /* Allocate new buffer. */
452 bufsize = history_size * p->tp_col * sizeof(term_char_t);
453 new = malloc(bufsize, M_VTBUF, M_WAITOK | M_ZERO);
454 rowssize = history_size * sizeof(term_pos_t *);
455 rows = malloc(rowssize, M_VTBUF, M_WAITOK | M_ZERO);
459 old = vb->vb_flags & VBF_STATIC ? NULL : vb->vb_buffer;
460 oldrows = vb->vb_flags & VBF_STATIC ? NULL : vb->vb_rows;
461 copyrows = vb->vb_rows;
462 w = vb->vb_scr_size.tp_col;
463 h = vb->vb_history_size;
465 vb->vb_history_size = history_size;
468 vb->vb_flags &= ~VBF_STATIC;
469 vb->vb_scr_size = *p;
472 /* Copy history and fill extra space. */
473 for (r = 0; r < history_size; r ++) {
475 if (r < h) { /* Copy. */
476 memmove(rows[r], copyrows[r],
477 MIN(p->tp_col, w) * sizeof(term_char_t));
478 for (c = MIN(p->tp_col, w); c < p->tp_col;
480 row[c] = VTBUF_SPACE_CHAR;
482 } else { /* Just fill. */
483 rect.tr_begin.tp_col = 0;
484 rect.tr_begin.tp_row = r;
485 rect.tr_end.tp_col = p->tp_col;
486 rect.tr_end.tp_row = p->tp_row;
487 vtbuf_fill(vb, &rect, VTBUF_SPACE_CHAR);
491 vtbuf_make_undirty(vb);
493 /* Deallocate old buffer. */
495 free(oldrows, M_VTBUF);
500 vtbuf_putchar(struct vt_buf *vb, const term_pos_t *p, term_char_t c)
504 KASSERT(p->tp_row < vb->vb_scr_size.tp_row,
505 ("vtbuf_putchar tp_row %d must be less than screen width %d",
506 p->tp_row, vb->vb_scr_size.tp_row));
507 KASSERT(p->tp_col < vb->vb_scr_size.tp_col,
508 ("vtbuf_putchar tp_col %d must be less than screen height %d",
509 p->tp_col, vb->vb_scr_size.tp_col));
511 row = vb->vb_rows[(vb->vb_curroffset + p->tp_row) %
512 VTBUF_MAX_HEIGHT(vb)];
513 if (row[p->tp_col] != c) {
517 vtbuf_dirty_cell(vb, p);
522 vtbuf_cursor_position(struct vt_buf *vb, const term_pos_t *p)
525 if (vb->vb_flags & VBF_CURSOR) {
526 vtbuf_dirty_cell(vb, &vb->vb_cursor);
528 vtbuf_dirty_cell(vb, &vb->vb_cursor);
535 vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row)
539 area.tr_begin.tp_row = MAX(row - 1, 0);
540 area.tr_begin.tp_col = MAX(col - 1, 0);
541 area.tr_end.tp_row = MIN(row + 2, vb->vb_scr_size.tp_row);
542 area.tr_end.tp_col = MIN(col + 2, vb->vb_scr_size.tp_col);
543 vtbuf_dirty(vb, &area);
547 vtbuf_flush_mark(struct vt_buf *vb)
552 /* Notify renderer to update marked region. */
553 if (vb->vb_mark_start.tp_col || vb->vb_mark_end.tp_col ||
554 vb->vb_mark_start.tp_row || vb->vb_mark_end.tp_row) {
556 s = vtbuf_htw(vb, vb->vb_mark_start.tp_row);
557 e = vtbuf_htw(vb, vb->vb_mark_end.tp_row);
559 area.tr_begin.tp_col = 0;
560 area.tr_begin.tp_row = MIN(s, e);
562 area.tr_end.tp_col = vb->vb_scr_size.tp_col;
563 area.tr_end.tp_row = MAX(s, e) + 1;
565 vtbuf_dirty(vb, &area);
570 vtbuf_get_marked_len(struct vt_buf *vb)
575 /* Swap according to window coordinates. */
576 if (POS_INDEX(vtbuf_htw(vb, vb->vb_mark_start.tp_row), vb->vb_mark_start.tp_col) >
577 POS_INDEX(vtbuf_htw(vb, vb->vb_mark_end.tp_row), vb->vb_mark_end.tp_col)) {
578 POS_COPY(e, vb->vb_mark_start);
579 POS_COPY(s, vb->vb_mark_end);
581 POS_COPY(s, vb->vb_mark_start);
582 POS_COPY(e, vb->vb_mark_end);
585 si = s.tp_row * vb->vb_scr_size.tp_col + s.tp_col;
586 ei = e.tp_row * vb->vb_scr_size.tp_col + e.tp_col;
588 /* Number symbols and number of rows to inject \n */
589 sz = ei - si + ((e.tp_row - s.tp_row) * 2) + 1;
591 return (sz * sizeof(term_char_t));
595 vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz)
600 /* Swap according to window coordinates. */
601 if (POS_INDEX(vtbuf_htw(vb, vb->vb_mark_start.tp_row), vb->vb_mark_start.tp_col) >
602 POS_INDEX(vtbuf_htw(vb, vb->vb_mark_end.tp_row), vb->vb_mark_end.tp_col)) {
603 POS_COPY(e, vb->vb_mark_start);
604 POS_COPY(s, vb->vb_mark_end);
606 POS_COPY(s, vb->vb_mark_start);
607 POS_COPY(e, vb->vb_mark_end);
611 for (r = s.tp_row; r <= e.tp_row; r ++) {
612 cs = (r == s.tp_row)?s.tp_col:0;
613 ce = (r == e.tp_row)?e.tp_col:vb->vb_scr_size.tp_col;
614 for (c = cs; c < ce; c ++) {
615 buf[i++] = vb->vb_rows[r][c];
617 /* Add new line for all rows, but not for last one. */
626 vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row)
630 case VTB_MARK_END: /* B1 UP */
631 if (vb->vb_mark_last != VTB_MARK_MOVE)
635 case VTB_MARK_EXTEND:
636 vtbuf_flush_mark(vb); /* Clean old mark. */
637 vb->vb_mark_end.tp_col = col;
638 vb->vb_mark_end.tp_row = vtbuf_wth(vb, row);
641 vtbuf_flush_mark(vb); /* Clean old mark. */
642 vb->vb_mark_start.tp_col = col;
643 vb->vb_mark_start.tp_row = vtbuf_wth(vb, row);
644 /* Start again, so clear end point. */
645 vb->vb_mark_end.tp_col = col;
646 vb->vb_mark_end.tp_row = vtbuf_wth(vb, row);
649 vtbuf_flush_mark(vb); /* Clean old mark. */
650 vb->vb_mark_start.tp_col = 0; /* XXX */
651 vb->vb_mark_end.tp_col = 10; /* XXX */
652 vb->vb_mark_start.tp_row = vb->vb_mark_end.tp_row =
656 vtbuf_flush_mark(vb); /* Clean old mark. */
657 vb->vb_mark_start.tp_col = 0;
658 vb->vb_mark_end.tp_col = vb->vb_scr_size.tp_col;
659 vb->vb_mark_start.tp_row = vb->vb_mark_end.tp_row =
663 vb->vb_mark_last = type;
670 vb->vb_mark_last = type;
671 /* Draw new marked region. */
672 vtbuf_flush_mark(vb);
677 vtbuf_cursor_visibility(struct vt_buf *vb, int yes)
682 oflags = vb->vb_flags;
684 vb->vb_flags |= VBF_CURSOR;
686 vb->vb_flags &= ~VBF_CURSOR;
687 nflags = vb->vb_flags;
690 if (oflags != nflags)
691 vtbuf_dirty_cell(vb, &vb->vb_cursor);
695 vtbuf_scroll_mode(struct vt_buf *vb, int yes)
700 oflags = vb->vb_flags;
702 vb->vb_flags |= VBF_SCROLL;
704 vb->vb_flags &= ~VBF_SCROLL;
705 nflags = vb->vb_flags;
708 if (oflags != nflags)
709 vtbuf_dirty_cell(vb, &vb->vb_cursor);