1 /* $OpenBSD: grid.c,v 1.123 2022/03/30 07:05:26 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2008 Nicholas Marriott <nicholas.marriott@gmail.com> 5 * 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. 9 * 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. 17 */ 18 19 #include <sys/types.h> 20 21 #include <stdlib.h> 22 #include <string.h> 23 24 #include "tmux.h" 25 26 /* 27 * Grid data. This is the basic data structure that represents what is shown on 28 * screen. 29 * 30 * A grid is a grid of cells (struct grid_cell). Lines are not allocated until 31 * cells in that line are written to. The grid is split into history and 32 * viewable data with the history starting at row (line) 0 and extending to 33 * (hsize - 1); from hsize to hsize + (sy - 1) is the viewable data. All 34 * functions in this file work on absolute coordinates, grid-view.c has 35 * functions which work on the screen data. 36 */ 37 38 /* Default grid cell data. */ 39 const struct grid_cell grid_default_cell = { 40 { { ' ' }, 0, 1, 1 }, 0, 0, 8, 8, 0 41 }; 42 43 /* 44 * Padding grid cell data. Padding cells are the only zero width cell that 45 * appears in the grid - because of this, they are always extended cells. 46 */ 47 static const struct grid_cell grid_padding_cell = { 48 { { '!' }, 0, 0, 0 }, 0, GRID_FLAG_PADDING, 8, 8, 0 49 }; 50 51 /* Cleared grid cell data. */ 52 static const struct grid_cell grid_cleared_cell = { 53 { { ' ' }, 0, 1, 1 }, 0, GRID_FLAG_CLEARED, 8, 8, 0 54 }; 55 static const struct grid_cell_entry grid_cleared_entry = { 56 GRID_FLAG_CLEARED, { .data = { 0, 8, 8, ' ' } } 57 }; 58 59 /* Store cell in entry. */ 60 static void 61 grid_store_cell(struct grid_cell_entry *gce, const struct grid_cell *gc, 62 u_char c) 63 { 64 gce->flags = (gc->flags & ~GRID_FLAG_CLEARED); 65 66 gce->data.fg = gc->fg & 0xff; 67 if (gc->fg & COLOUR_FLAG_256) 68 gce->flags |= GRID_FLAG_FG256; 69 70 gce->data.bg = gc->bg & 0xff; 71 if (gc->bg & COLOUR_FLAG_256) 72 gce->flags |= GRID_FLAG_BG256; 73 74 gce->data.attr = gc->attr; 75 gce->data.data = c; 76 } 77 78 /* Check if a cell should be an extended cell. */ 79 static int 80 grid_need_extended_cell(const struct grid_cell_entry *gce, 81 const struct grid_cell *gc) 82 { 83 if (gce->flags & GRID_FLAG_EXTENDED) 84 return (1); 85 if (gc->attr > 0xff) 86 return (1); 87 if (gc->data.size != 1 || gc->data.width != 1) 88 return (1); 89 if ((gc->fg & COLOUR_FLAG_RGB) || (gc->bg & COLOUR_FLAG_RGB)) 90 return (1); 91 if (gc->us != 0) /* only supports 256 or RGB */ 92 return (1); 93 return (0); 94 } 95 96 /* Get an extended cell. */ 97 static void 98 grid_get_extended_cell(struct grid_line *gl, struct grid_cell_entry *gce, 99 int flags) 100 { 101 u_int at = gl->extdsize + 1; 102 103 gl->extddata = xreallocarray(gl->extddata, at, sizeof *gl->extddata); 104 gl->extdsize = at; 105 106 gce->offset = at - 1; 107 gce->flags = (flags | GRID_FLAG_EXTENDED); 108 } 109 110 /* Set cell as extended. */ 111 static struct grid_extd_entry * 112 grid_extended_cell(struct grid_line *gl, struct grid_cell_entry *gce, 113 const struct grid_cell *gc) 114 { 115 struct grid_extd_entry *gee; 116 int flags = (gc->flags & ~GRID_FLAG_CLEARED); 117 utf8_char uc; 118 119 if (~gce->flags & GRID_FLAG_EXTENDED) 120 grid_get_extended_cell(gl, gce, flags); 121 else if (gce->offset >= gl->extdsize) 122 fatalx("offset too big"); 123 gl->flags |= GRID_LINE_EXTENDED; 124 125 utf8_from_data(&gc->data, &uc); 126 127 gee = &gl->extddata[gce->offset]; 128 gee->data = uc; 129 gee->attr = gc->attr; 130 gee->flags = flags; 131 gee->fg = gc->fg; 132 gee->bg = gc->bg; 133 gee->us = gc->us; 134 return (gee); 135 } 136 137 /* Free up unused extended cells. */ 138 static void 139 grid_compact_line(struct grid_line *gl) 140 { 141 int new_extdsize = 0; 142 struct grid_extd_entry *new_extddata; 143 struct grid_cell_entry *gce; 144 struct grid_extd_entry *gee; 145 u_int px, idx; 146 147 if (gl->extdsize == 0) 148 return; 149 150 for (px = 0; px < gl->cellsize; px++) { 151 gce = &gl->celldata[px]; 152 if (gce->flags & GRID_FLAG_EXTENDED) 153 new_extdsize++; 154 } 155 156 if (new_extdsize == 0) { 157 free(gl->extddata); 158 gl->extddata = NULL; 159 gl->extdsize = 0; 160 return; 161 } 162 new_extddata = xreallocarray(NULL, new_extdsize, sizeof *gl->extddata); 163 164 idx = 0; 165 for (px = 0; px < gl->cellsize; px++) { 166 gce = &gl->celldata[px]; 167 if (gce->flags & GRID_FLAG_EXTENDED) { 168 gee = &gl->extddata[gce->offset]; 169 memcpy(&new_extddata[idx], gee, sizeof *gee); 170 gce->offset = idx++; 171 } 172 } 173 174 free(gl->extddata); 175 gl->extddata = new_extddata; 176 gl->extdsize = new_extdsize; 177 } 178 179 /* Get line data. */ 180 struct grid_line * 181 grid_get_line(struct grid *gd, u_int line) 182 { 183 return (&gd->linedata[line]); 184 } 185 186 /* Adjust number of lines. */ 187 void 188 grid_adjust_lines(struct grid *gd, u_int lines) 189 { 190 gd->linedata = xreallocarray(gd->linedata, lines, sizeof *gd->linedata); 191 } 192 193 /* Copy default into a cell. */ 194 static void 195 grid_clear_cell(struct grid *gd, u_int px, u_int py, u_int bg) 196 { 197 struct grid_line *gl = &gd->linedata[py]; 198 struct grid_cell_entry *gce = &gl->celldata[px]; 199 struct grid_extd_entry *gee; 200 201 memcpy(gce, &grid_cleared_entry, sizeof *gce); 202 if (bg != 8) { 203 if (bg & COLOUR_FLAG_RGB) { 204 grid_get_extended_cell(gl, gce, gce->flags); 205 gee = grid_extended_cell(gl, gce, &grid_cleared_cell); 206 gee->bg = bg; 207 } else { 208 if (bg & COLOUR_FLAG_256) 209 gce->flags |= GRID_FLAG_BG256; 210 gce->data.bg = bg; 211 } 212 } 213 } 214 215 /* Check grid y position. */ 216 static int 217 grid_check_y(struct grid *gd, const char *from, u_int py) 218 { 219 if (py >= gd->hsize + gd->sy) { 220 log_debug("%s: y out of range: %u", from, py); 221 return (-1); 222 } 223 return (0); 224 } 225 226 /* Check if two styles are (visibly) the same. */ 227 int 228 grid_cells_look_equal(const struct grid_cell *gc1, const struct grid_cell *gc2) 229 { 230 if (gc1->fg != gc2->fg || gc1->bg != gc2->bg) 231 return (0); 232 if (gc1->attr != gc2->attr || gc1->flags != gc2->flags) 233 return (0); 234 return (1); 235 } 236 237 /* Compare grid cells. Return 1 if equal, 0 if not. */ 238 int 239 grid_cells_equal(const struct grid_cell *gc1, const struct grid_cell *gc2) 240 { 241 if (!grid_cells_look_equal(gc1, gc2)) 242 return (0); 243 if (gc1->data.width != gc2->data.width) 244 return (0); 245 if (gc1->data.size != gc2->data.size) 246 return (0); 247 return (memcmp(gc1->data.data, gc2->data.data, gc1->data.size) == 0); 248 } 249 250 /* Free one line. */ 251 static void 252 grid_free_line(struct grid *gd, u_int py) 253 { 254 free(gd->linedata[py].celldata); 255 gd->linedata[py].celldata = NULL; 256 free(gd->linedata[py].extddata); 257 gd->linedata[py].extddata = NULL; 258 } 259 260 /* Free several lines. */ 261 static void 262 grid_free_lines(struct grid *gd, u_int py, u_int ny) 263 { 264 u_int yy; 265 266 for (yy = py; yy < py + ny; yy++) 267 grid_free_line(gd, yy); 268 } 269 270 /* Create a new grid. */ 271 struct grid * 272 grid_create(u_int sx, u_int sy, u_int hlimit) 273 { 274 struct grid *gd; 275 276 gd = xmalloc(sizeof *gd); 277 gd->sx = sx; 278 gd->sy = sy; 279 280 if (hlimit != 0) 281 gd->flags = GRID_HISTORY; 282 else 283 gd->flags = 0; 284 285 gd->hscrolled = 0; 286 gd->hsize = 0; 287 gd->hlimit = hlimit; 288 289 if (gd->sy != 0) 290 gd->linedata = xcalloc(gd->sy, sizeof *gd->linedata); 291 else 292 gd->linedata = NULL; 293 294 return (gd); 295 } 296 297 /* Destroy grid. */ 298 void 299 grid_destroy(struct grid *gd) 300 { 301 grid_free_lines(gd, 0, gd->hsize + gd->sy); 302 303 free(gd->linedata); 304 305 free(gd); 306 } 307 308 /* Compare grids. */ 309 int 310 grid_compare(struct grid *ga, struct grid *gb) 311 { 312 struct grid_line *gla, *glb; 313 struct grid_cell gca, gcb; 314 u_int xx, yy; 315 316 if (ga->sx != gb->sx || ga->sy != gb->sy) 317 return (1); 318 319 for (yy = 0; yy < ga->sy; yy++) { 320 gla = &ga->linedata[yy]; 321 glb = &gb->linedata[yy]; 322 if (gla->cellsize != glb->cellsize) 323 return (1); 324 for (xx = 0; xx < gla->cellsize; xx++) { 325 grid_get_cell(ga, xx, yy, &gca); 326 grid_get_cell(gb, xx, yy, &gcb); 327 if (!grid_cells_equal(&gca, &gcb)) 328 return (1); 329 } 330 } 331 332 return (0); 333 } 334 335 /* Trim lines from the history. */ 336 static void 337 grid_trim_history(struct grid *gd, u_int ny) 338 { 339 grid_free_lines(gd, 0, ny); 340 memmove(&gd->linedata[0], &gd->linedata[ny], 341 (gd->hsize + gd->sy - ny) * (sizeof *gd->linedata)); 342 } 343 344 /* 345 * Collect lines from the history if at the limit. Free the top (oldest) 10% 346 * and shift up. 347 */ 348 void 349 grid_collect_history(struct grid *gd) 350 { 351 u_int ny; 352 353 if (gd->hsize == 0 || gd->hsize < gd->hlimit) 354 return; 355 356 ny = gd->hlimit / 10; 357 if (ny < 1) 358 ny = 1; 359 if (ny > gd->hsize) 360 ny = gd->hsize; 361 362 /* 363 * Free the lines from 0 to ny then move the remaining lines over 364 * them. 365 */ 366 grid_trim_history(gd, ny); 367 368 gd->hsize -= ny; 369 if (gd->hscrolled > gd->hsize) 370 gd->hscrolled = gd->hsize; 371 } 372 373 /* Remove lines from the bottom of the history. */ 374 void 375 grid_remove_history(struct grid *gd, u_int ny) 376 { 377 u_int yy; 378 379 if (ny > gd->hsize) 380 return; 381 for (yy = 0; yy < ny; yy++) 382 grid_free_line(gd, gd->hsize + gd->sy - 1 - yy); 383 gd->hsize -= ny; 384 } 385 386 /* 387 * Scroll the entire visible screen, moving one line into the history. Just 388 * allocate a new line at the bottom and move the history size indicator. 389 */ 390 void 391 grid_scroll_history(struct grid *gd, u_int bg) 392 { 393 u_int yy; 394 395 yy = gd->hsize + gd->sy; 396 gd->linedata = xreallocarray(gd->linedata, yy + 1, 397 sizeof *gd->linedata); 398 grid_empty_line(gd, yy, bg); 399 400 gd->hscrolled++; 401 grid_compact_line(&gd->linedata[gd->hsize]); 402 gd->hsize++; 403 } 404 405 /* Clear the history. */ 406 void 407 grid_clear_history(struct grid *gd) 408 { 409 grid_trim_history(gd, gd->hsize); 410 411 gd->hscrolled = 0; 412 gd->hsize = 0; 413 414 gd->linedata = xreallocarray(gd->linedata, gd->sy, 415 sizeof *gd->linedata); 416 } 417 418 /* Scroll a region up, moving the top line into the history. */ 419 void 420 grid_scroll_history_region(struct grid *gd, u_int upper, u_int lower, u_int bg) 421 { 422 struct grid_line *gl_history, *gl_upper; 423 u_int yy; 424 425 /* Create a space for a new line. */ 426 yy = gd->hsize + gd->sy; 427 gd->linedata = xreallocarray(gd->linedata, yy + 1, 428 sizeof *gd->linedata); 429 430 /* Move the entire screen down to free a space for this line. */ 431 gl_history = &gd->linedata[gd->hsize]; 432 memmove(gl_history + 1, gl_history, gd->sy * sizeof *gl_history); 433 434 /* Adjust the region and find its start and end. */ 435 upper++; 436 gl_upper = &gd->linedata[upper]; 437 lower++; 438 439 /* Move the line into the history. */ 440 memcpy(gl_history, gl_upper, sizeof *gl_history); 441 442 /* Then move the region up and clear the bottom line. */ 443 memmove(gl_upper, gl_upper + 1, (lower - upper) * sizeof *gl_upper); 444 grid_empty_line(gd, lower, bg); 445 446 /* Move the history offset down over the line. */ 447 gd->hscrolled++; 448 gd->hsize++; 449 } 450 451 /* Expand line to fit to cell. */ 452 static void 453 grid_expand_line(struct grid *gd, u_int py, u_int sx, u_int bg) 454 { 455 struct grid_line *gl; 456 u_int xx; 457 458 gl = &gd->linedata[py]; 459 if (sx <= gl->cellsize) 460 return; 461 462 if (sx < gd->sx / 4) 463 sx = gd->sx / 4; 464 else if (sx < gd->sx / 2) 465 sx = gd->sx / 2; 466 else if (gd->sx > sx) 467 sx = gd->sx; 468 469 gl->celldata = xreallocarray(gl->celldata, sx, sizeof *gl->celldata); 470 for (xx = gl->cellsize; xx < sx; xx++) 471 grid_clear_cell(gd, xx, py, bg); 472 gl->cellsize = sx; 473 } 474 475 /* Empty a line and set background colour if needed. */ 476 void 477 grid_empty_line(struct grid *gd, u_int py, u_int bg) 478 { 479 memset(&gd->linedata[py], 0, sizeof gd->linedata[py]); 480 if (!COLOUR_DEFAULT(bg)) 481 grid_expand_line(gd, py, gd->sx, bg); 482 } 483 484 /* Peek at grid line. */ 485 const struct grid_line * 486 grid_peek_line(struct grid *gd, u_int py) 487 { 488 if (grid_check_y(gd, __func__, py) != 0) 489 return (NULL); 490 return (&gd->linedata[py]); 491 } 492 493 /* Get cell from line. */ 494 static void 495 grid_get_cell1(struct grid_line *gl, u_int px, struct grid_cell *gc) 496 { 497 struct grid_cell_entry *gce = &gl->celldata[px]; 498 struct grid_extd_entry *gee; 499 500 if (gce->flags & GRID_FLAG_EXTENDED) { 501 if (gce->offset >= gl->extdsize) 502 memcpy(gc, &grid_default_cell, sizeof *gc); 503 else { 504 gee = &gl->extddata[gce->offset]; 505 gc->flags = gee->flags; 506 gc->attr = gee->attr; 507 gc->fg = gee->fg; 508 gc->bg = gee->bg; 509 gc->us = gee->us; 510 utf8_to_data(gee->data, &gc->data); 511 } 512 return; 513 } 514 515 gc->flags = gce->flags & ~(GRID_FLAG_FG256|GRID_FLAG_BG256); 516 gc->attr = gce->data.attr; 517 gc->fg = gce->data.fg; 518 if (gce->flags & GRID_FLAG_FG256) 519 gc->fg |= COLOUR_FLAG_256; 520 gc->bg = gce->data.bg; 521 if (gce->flags & GRID_FLAG_BG256) 522 gc->bg |= COLOUR_FLAG_256; 523 gc->us = 0; 524 utf8_set(&gc->data, gce->data.data); 525 } 526 527 /* Get cell for reading. */ 528 void 529 grid_get_cell(struct grid *gd, u_int px, u_int py, struct grid_cell *gc) 530 { 531 if (grid_check_y(gd, __func__, py) != 0 || 532 px >= gd->linedata[py].cellsize) 533 memcpy(gc, &grid_default_cell, sizeof *gc); 534 else 535 grid_get_cell1(&gd->linedata[py], px, gc); 536 } 537 538 /* Set cell at position. */ 539 void 540 grid_set_cell(struct grid *gd, u_int px, u_int py, const struct grid_cell *gc) 541 { 542 struct grid_line *gl; 543 struct grid_cell_entry *gce; 544 545 if (grid_check_y(gd, __func__, py) != 0) 546 return; 547 548 grid_expand_line(gd, py, px + 1, 8); 549 550 gl = &gd->linedata[py]; 551 if (px + 1 > gl->cellused) 552 gl->cellused = px + 1; 553 554 gce = &gl->celldata[px]; 555 if (grid_need_extended_cell(gce, gc)) 556 grid_extended_cell(gl, gce, gc); 557 else 558 grid_store_cell(gce, gc, gc->data.data[0]); 559 } 560 561 /* Set padding at position. */ 562 void 563 grid_set_padding(struct grid *gd, u_int px, u_int py) 564 { 565 grid_set_cell(gd, px, py, &grid_padding_cell); 566 } 567 568 /* Set cells at position. */ 569 void 570 grid_set_cells(struct grid *gd, u_int px, u_int py, const struct grid_cell *gc, 571 const char *s, size_t slen) 572 { 573 struct grid_line *gl; 574 struct grid_cell_entry *gce; 575 struct grid_extd_entry *gee; 576 u_int i; 577 578 if (grid_check_y(gd, __func__, py) != 0) 579 return; 580 581 grid_expand_line(gd, py, px + slen, 8); 582 583 gl = &gd->linedata[py]; 584 if (px + slen > gl->cellused) 585 gl->cellused = px + slen; 586 587 for (i = 0; i < slen; i++) { 588 gce = &gl->celldata[px + i]; 589 if (grid_need_extended_cell(gce, gc)) { 590 gee = grid_extended_cell(gl, gce, gc); 591 gee->data = utf8_build_one(s[i]); 592 } else 593 grid_store_cell(gce, gc, s[i]); 594 } 595 } 596 597 /* Clear area. */ 598 void 599 grid_clear(struct grid *gd, u_int px, u_int py, u_int nx, u_int ny, u_int bg) 600 { 601 struct grid_line *gl; 602 u_int xx, yy, ox, sx; 603 604 if (nx == 0 || ny == 0) 605 return; 606 607 if (px == 0 && nx == gd->sx) { 608 grid_clear_lines(gd, py, ny, bg); 609 return; 610 } 611 612 if (grid_check_y(gd, __func__, py) != 0) 613 return; 614 if (grid_check_y(gd, __func__, py + ny - 1) != 0) 615 return; 616 617 for (yy = py; yy < py + ny; yy++) { 618 gl = &gd->linedata[yy]; 619 620 sx = gd->sx; 621 if (sx > gl->cellsize) 622 sx = gl->cellsize; 623 ox = nx; 624 if (COLOUR_DEFAULT(bg)) { 625 if (px > sx) 626 continue; 627 if (px + nx > sx) 628 ox = sx - px; 629 } 630 631 grid_expand_line(gd, yy, px + ox, 8); /* default bg first */ 632 for (xx = px; xx < px + ox; xx++) 633 grid_clear_cell(gd, xx, yy, bg); 634 } 635 } 636 637 /* Clear lines. This just frees and truncates the lines. */ 638 void 639 grid_clear_lines(struct grid *gd, u_int py, u_int ny, u_int bg) 640 { 641 u_int yy; 642 643 if (ny == 0) 644 return; 645 646 if (grid_check_y(gd, __func__, py) != 0) 647 return; 648 if (grid_check_y(gd, __func__, py + ny - 1) != 0) 649 return; 650 651 for (yy = py; yy < py + ny; yy++) { 652 grid_free_line(gd, yy); 653 grid_empty_line(gd, yy, bg); 654 } 655 if (py != 0) 656 gd->linedata[py - 1].flags &= ~GRID_LINE_WRAPPED; 657 } 658 659 /* Move a group of lines. */ 660 void 661 grid_move_lines(struct grid *gd, u_int dy, u_int py, u_int ny, u_int bg) 662 { 663 u_int yy; 664 665 if (ny == 0 || py == dy) 666 return; 667 668 if (grid_check_y(gd, __func__, py) != 0) 669 return; 670 if (grid_check_y(gd, __func__, py + ny - 1) != 0) 671 return; 672 if (grid_check_y(gd, __func__, dy) != 0) 673 return; 674 if (grid_check_y(gd, __func__, dy + ny - 1) != 0) 675 return; 676 677 /* Free any lines which are being replaced. */ 678 for (yy = dy; yy < dy + ny; yy++) { 679 if (yy >= py && yy < py + ny) 680 continue; 681 grid_free_line(gd, yy); 682 } 683 if (dy != 0) 684 gd->linedata[dy - 1].flags &= ~GRID_LINE_WRAPPED; 685 686 memmove(&gd->linedata[dy], &gd->linedata[py], 687 ny * (sizeof *gd->linedata)); 688 689 /* 690 * Wipe any lines that have been moved (without freeing them - they are 691 * still present). 692 */ 693 for (yy = py; yy < py + ny; yy++) { 694 if (yy < dy || yy >= dy + ny) 695 grid_empty_line(gd, yy, bg); 696 } 697 if (py != 0 && (py < dy || py >= dy + ny)) 698 gd->linedata[py - 1].flags &= ~GRID_LINE_WRAPPED; 699 } 700 701 /* Move a group of cells. */ 702 void 703 grid_move_cells(struct grid *gd, u_int dx, u_int px, u_int py, u_int nx, 704 u_int bg) 705 { 706 struct grid_line *gl; 707 u_int xx; 708 709 if (nx == 0 || px == dx) 710 return; 711 712 if (grid_check_y(gd, __func__, py) != 0) 713 return; 714 gl = &gd->linedata[py]; 715 716 grid_expand_line(gd, py, px + nx, 8); 717 grid_expand_line(gd, py, dx + nx, 8); 718 memmove(&gl->celldata[dx], &gl->celldata[px], 719 nx * sizeof *gl->celldata); 720 if (dx + nx > gl->cellused) 721 gl->cellused = dx + nx; 722 723 /* Wipe any cells that have been moved. */ 724 for (xx = px; xx < px + nx; xx++) { 725 if (xx >= dx && xx < dx + nx) 726 continue; 727 grid_clear_cell(gd, xx, py, bg); 728 } 729 } 730 731 /* Get ANSI foreground sequence. */ 732 static size_t 733 grid_string_cells_fg(const struct grid_cell *gc, int *values) 734 { 735 size_t n; 736 u_char r, g, b; 737 738 n = 0; 739 if (gc->fg & COLOUR_FLAG_256) { 740 values[n++] = 38; 741 values[n++] = 5; 742 values[n++] = gc->fg & 0xff; 743 } else if (gc->fg & COLOUR_FLAG_RGB) { 744 values[n++] = 38; 745 values[n++] = 2; 746 colour_split_rgb(gc->fg, &r, &g, &b); 747 values[n++] = r; 748 values[n++] = g; 749 values[n++] = b; 750 } else { 751 switch (gc->fg) { 752 case 0: 753 case 1: 754 case 2: 755 case 3: 756 case 4: 757 case 5: 758 case 6: 759 case 7: 760 values[n++] = gc->fg + 30; 761 break; 762 case 8: 763 values[n++] = 39; 764 break; 765 case 90: 766 case 91: 767 case 92: 768 case 93: 769 case 94: 770 case 95: 771 case 96: 772 case 97: 773 values[n++] = gc->fg; 774 break; 775 } 776 } 777 return (n); 778 } 779 780 /* Get ANSI background sequence. */ 781 static size_t 782 grid_string_cells_bg(const struct grid_cell *gc, int *values) 783 { 784 size_t n; 785 u_char r, g, b; 786 787 n = 0; 788 if (gc->bg & COLOUR_FLAG_256) { 789 values[n++] = 48; 790 values[n++] = 5; 791 values[n++] = gc->bg & 0xff; 792 } else if (gc->bg & COLOUR_FLAG_RGB) { 793 values[n++] = 48; 794 values[n++] = 2; 795 colour_split_rgb(gc->bg, &r, &g, &b); 796 values[n++] = r; 797 values[n++] = g; 798 values[n++] = b; 799 } else { 800 switch (gc->bg) { 801 case 0: 802 case 1: 803 case 2: 804 case 3: 805 case 4: 806 case 5: 807 case 6: 808 case 7: 809 values[n++] = gc->bg + 40; 810 break; 811 case 8: 812 values[n++] = 49; 813 break; 814 case 90: 815 case 91: 816 case 92: 817 case 93: 818 case 94: 819 case 95: 820 case 96: 821 case 97: 822 values[n++] = gc->bg + 10; 823 break; 824 } 825 } 826 return (n); 827 } 828 829 /* Get underscore colour sequence. */ 830 static size_t 831 grid_string_cells_us(const struct grid_cell *gc, int *values) 832 { 833 size_t n; 834 u_char r, g, b; 835 836 n = 0; 837 if (gc->us & COLOUR_FLAG_256) { 838 values[n++] = 58; 839 values[n++] = 5; 840 values[n++] = gc->us & 0xff; 841 } else if (gc->us & COLOUR_FLAG_RGB) { 842 values[n++] = 58; 843 values[n++] = 2; 844 colour_split_rgb(gc->us, &r, &g, &b); 845 values[n++] = r; 846 values[n++] = g; 847 values[n++] = b; 848 } 849 return (n); 850 } 851 852 /* Add on SGR code. */ 853 static void 854 grid_string_cells_add_code(char *buf, size_t len, u_int n, int *s, int *newc, 855 int *oldc, size_t nnewc, size_t noldc, int escape_c0) 856 { 857 u_int i; 858 char tmp[64]; 859 860 if (nnewc != 0 && 861 (nnewc != noldc || 862 memcmp(newc, oldc, nnewc * sizeof newc[0]) != 0 || 863 (n != 0 && s[0] == 0))) { 864 if (escape_c0) 865 strlcat(buf, "\\033[", len); 866 else 867 strlcat(buf, "\033[", len); 868 for (i = 0; i < nnewc; i++) { 869 if (i + 1 < nnewc) 870 xsnprintf(tmp, sizeof tmp, "%d;", newc[i]); 871 else 872 xsnprintf(tmp, sizeof tmp, "%d", newc[i]); 873 strlcat(buf, tmp, len); 874 } 875 strlcat(buf, "m", len); 876 } 877 } 878 879 /* 880 * Returns ANSI code to set particular attributes (colour, bold and so on) 881 * given a current state. 882 */ 883 static void 884 grid_string_cells_code(const struct grid_cell *lastgc, 885 const struct grid_cell *gc, char *buf, size_t len, int escape_c0) 886 { 887 int oldc[64], newc[64], s[128]; 888 size_t noldc, nnewc, n, i; 889 u_int attr = gc->attr, lastattr = lastgc->attr; 890 char tmp[64]; 891 892 struct { 893 u_int mask; 894 u_int code; 895 } attrs[] = { 896 { GRID_ATTR_BRIGHT, 1 }, 897 { GRID_ATTR_DIM, 2 }, 898 { GRID_ATTR_ITALICS, 3 }, 899 { GRID_ATTR_UNDERSCORE, 4 }, 900 { GRID_ATTR_BLINK, 5 }, 901 { GRID_ATTR_REVERSE, 7 }, 902 { GRID_ATTR_HIDDEN, 8 }, 903 { GRID_ATTR_STRIKETHROUGH, 9 }, 904 { GRID_ATTR_UNDERSCORE_2, 42 }, 905 { GRID_ATTR_UNDERSCORE_3, 43 }, 906 { GRID_ATTR_UNDERSCORE_4, 44 }, 907 { GRID_ATTR_UNDERSCORE_5, 45 }, 908 { GRID_ATTR_OVERLINE, 53 }, 909 }; 910 n = 0; 911 912 /* If any attribute is removed, begin with 0. */ 913 for (i = 0; i < nitems(attrs); i++) { 914 if (((~attr & attrs[i].mask) && 915 (lastattr & attrs[i].mask)) || 916 (lastgc->us != 0 && gc->us == 0)) { 917 s[n++] = 0; 918 lastattr &= GRID_ATTR_CHARSET; 919 break; 920 } 921 } 922 /* For each attribute that is newly set, add its code. */ 923 for (i = 0; i < nitems(attrs); i++) { 924 if ((attr & attrs[i].mask) && !(lastattr & attrs[i].mask)) 925 s[n++] = attrs[i].code; 926 } 927 928 /* Write the attributes. */ 929 *buf = '\0'; 930 if (n > 0) { 931 if (escape_c0) 932 strlcat(buf, "\\033[", len); 933 else 934 strlcat(buf, "\033[", len); 935 for (i = 0; i < n; i++) { 936 if (s[i] < 10) 937 xsnprintf(tmp, sizeof tmp, "%d", s[i]); 938 else { 939 xsnprintf(tmp, sizeof tmp, "%d:%d", s[i] / 10, 940 s[i] % 10); 941 } 942 strlcat(buf, tmp, len); 943 if (i + 1 < n) 944 strlcat(buf, ";", len); 945 } 946 strlcat(buf, "m", len); 947 } 948 949 /* If the foreground colour changed, write its parameters. */ 950 nnewc = grid_string_cells_fg(gc, newc); 951 noldc = grid_string_cells_fg(lastgc, oldc); 952 grid_string_cells_add_code(buf, len, n, s, newc, oldc, nnewc, noldc, 953 escape_c0); 954 955 /* If the background colour changed, append its parameters. */ 956 nnewc = grid_string_cells_bg(gc, newc); 957 noldc = grid_string_cells_bg(lastgc, oldc); 958 grid_string_cells_add_code(buf, len, n, s, newc, oldc, nnewc, noldc, 959 escape_c0); 960 961 /* If the underscore colour changed, append its parameters. */ 962 nnewc = grid_string_cells_us(gc, newc); 963 noldc = grid_string_cells_us(lastgc, oldc); 964 grid_string_cells_add_code(buf, len, n, s, newc, oldc, nnewc, noldc, 965 escape_c0); 966 967 /* Append shift in/shift out if needed. */ 968 if ((attr & GRID_ATTR_CHARSET) && !(lastattr & GRID_ATTR_CHARSET)) { 969 if (escape_c0) 970 strlcat(buf, "\\016", len); /* SO */ 971 else 972 strlcat(buf, "\016", len); /* SO */ 973 } 974 if (!(attr & GRID_ATTR_CHARSET) && (lastattr & GRID_ATTR_CHARSET)) { 975 if (escape_c0) 976 strlcat(buf, "\\017", len); /* SI */ 977 else 978 strlcat(buf, "\017", len); /* SI */ 979 } 980 } 981 982 /* Convert cells into a string. */ 983 char * 984 grid_string_cells(struct grid *gd, u_int px, u_int py, u_int nx, 985 struct grid_cell **lastgc, int with_codes, int escape_c0, int trim) 986 { 987 struct grid_cell gc; 988 static struct grid_cell lastgc1; 989 const char *data; 990 char *buf, code[128]; 991 size_t len, off, size, codelen; 992 u_int xx; 993 const struct grid_line *gl; 994 995 if (lastgc != NULL && *lastgc == NULL) { 996 memcpy(&lastgc1, &grid_default_cell, sizeof lastgc1); 997 *lastgc = &lastgc1; 998 } 999 1000 len = 128; 1001 buf = xmalloc(len); 1002 off = 0; 1003 1004 gl = grid_peek_line(gd, py); 1005 for (xx = px; xx < px + nx; xx++) { 1006 if (gl == NULL || xx >= gl->cellused) 1007 break; 1008 grid_get_cell(gd, xx, py, &gc); 1009 if (gc.flags & GRID_FLAG_PADDING) 1010 continue; 1011 1012 if (with_codes) { 1013 grid_string_cells_code(*lastgc, &gc, code, sizeof code, 1014 escape_c0); 1015 codelen = strlen(code); 1016 memcpy(*lastgc, &gc, sizeof **lastgc); 1017 } else 1018 codelen = 0; 1019 1020 data = gc.data.data; 1021 size = gc.data.size; 1022 if (escape_c0 && size == 1 && *data == '\\') { 1023 data = "\\\\"; 1024 size = 2; 1025 } 1026 1027 while (len < off + size + codelen + 1) { 1028 buf = xreallocarray(buf, 2, len); 1029 len *= 2; 1030 } 1031 1032 if (codelen != 0) { 1033 memcpy(buf + off, code, codelen); 1034 off += codelen; 1035 } 1036 memcpy(buf + off, data, size); 1037 off += size; 1038 } 1039 1040 if (trim) { 1041 while (off > 0 && buf[off - 1] == ' ') 1042 off--; 1043 } 1044 buf[off] = '\0'; 1045 1046 return (buf); 1047 } 1048 1049 /* 1050 * Duplicate a set of lines between two grids. Both source and destination 1051 * should be big enough. 1052 */ 1053 void 1054 grid_duplicate_lines(struct grid *dst, u_int dy, struct grid *src, u_int sy, 1055 u_int ny) 1056 { 1057 struct grid_line *dstl, *srcl; 1058 u_int yy; 1059 1060 if (dy + ny > dst->hsize + dst->sy) 1061 ny = dst->hsize + dst->sy - dy; 1062 if (sy + ny > src->hsize + src->sy) 1063 ny = src->hsize + src->sy - sy; 1064 grid_free_lines(dst, dy, ny); 1065 1066 for (yy = 0; yy < ny; yy++) { 1067 srcl = &src->linedata[sy]; 1068 dstl = &dst->linedata[dy]; 1069 1070 memcpy(dstl, srcl, sizeof *dstl); 1071 if (srcl->cellsize != 0) { 1072 dstl->celldata = xreallocarray(NULL, 1073 srcl->cellsize, sizeof *dstl->celldata); 1074 memcpy(dstl->celldata, srcl->celldata, 1075 srcl->cellsize * sizeof *dstl->celldata); 1076 } else 1077 dstl->celldata = NULL; 1078 if (srcl->extdsize != 0) { 1079 dstl->extdsize = srcl->extdsize; 1080 dstl->extddata = xreallocarray(NULL, dstl->extdsize, 1081 sizeof *dstl->extddata); 1082 memcpy(dstl->extddata, srcl->extddata, dstl->extdsize * 1083 sizeof *dstl->extddata); 1084 } else 1085 dstl->extddata = NULL; 1086 1087 sy++; 1088 dy++; 1089 } 1090 } 1091 1092 /* Mark line as dead. */ 1093 static void 1094 grid_reflow_dead(struct grid_line *gl) 1095 { 1096 memset(gl, 0, sizeof *gl); 1097 gl->flags = GRID_LINE_DEAD; 1098 } 1099 1100 /* Add lines, return the first new one. */ 1101 static struct grid_line * 1102 grid_reflow_add(struct grid *gd, u_int n) 1103 { 1104 struct grid_line *gl; 1105 u_int sy = gd->sy + n; 1106 1107 gd->linedata = xreallocarray(gd->linedata, sy, sizeof *gd->linedata); 1108 gl = &gd->linedata[gd->sy]; 1109 memset(gl, 0, n * (sizeof *gl)); 1110 gd->sy = sy; 1111 return (gl); 1112 } 1113 1114 /* Move a line across. */ 1115 static struct grid_line * 1116 grid_reflow_move(struct grid *gd, struct grid_line *from) 1117 { 1118 struct grid_line *to; 1119 1120 to = grid_reflow_add(gd, 1); 1121 memcpy(to, from, sizeof *to); 1122 grid_reflow_dead(from); 1123 return (to); 1124 } 1125 1126 /* Join line below onto this one. */ 1127 static void 1128 grid_reflow_join(struct grid *target, struct grid *gd, u_int sx, u_int yy, 1129 u_int width, int already) 1130 { 1131 struct grid_line *gl, *from = NULL; 1132 struct grid_cell gc; 1133 u_int lines, left, i, to, line, want = 0; 1134 u_int at; 1135 int wrapped = 1; 1136 1137 /* 1138 * Add a new target line. 1139 */ 1140 if (!already) { 1141 to = target->sy; 1142 gl = grid_reflow_move(target, &gd->linedata[yy]); 1143 } else { 1144 to = target->sy - 1; 1145 gl = &target->linedata[to]; 1146 } 1147 at = gl->cellused; 1148 1149 /* 1150 * Loop until no more to consume or the target line is full. 1151 */ 1152 lines = 0; 1153 for (;;) { 1154 /* 1155 * If this is now the last line, there is nothing more to be 1156 * done. 1157 */ 1158 if (yy + 1 + lines == gd->hsize + gd->sy) 1159 break; 1160 line = yy + 1 + lines; 1161 1162 /* If the next line is empty, skip it. */ 1163 if (~gd->linedata[line].flags & GRID_LINE_WRAPPED) 1164 wrapped = 0; 1165 if (gd->linedata[line].cellused == 0) { 1166 if (!wrapped) 1167 break; 1168 lines++; 1169 continue; 1170 } 1171 1172 /* 1173 * Is the destination line now full? Copy the first character 1174 * separately because we need to leave "from" set to the last 1175 * line if this line is full. 1176 */ 1177 grid_get_cell1(&gd->linedata[line], 0, &gc); 1178 if (width + gc.data.width > sx) 1179 break; 1180 width += gc.data.width; 1181 grid_set_cell(target, at, to, &gc); 1182 at++; 1183 1184 /* Join as much more as possible onto the current line. */ 1185 from = &gd->linedata[line]; 1186 for (want = 1; want < from->cellused; want++) { 1187 grid_get_cell1(from, want, &gc); 1188 if (width + gc.data.width > sx) 1189 break; 1190 width += gc.data.width; 1191 1192 grid_set_cell(target, at, to, &gc); 1193 at++; 1194 } 1195 lines++; 1196 1197 /* 1198 * If this line wasn't wrapped or we didn't consume the entire 1199 * line, don't try to join any further lines. 1200 */ 1201 if (!wrapped || want != from->cellused || width == sx) 1202 break; 1203 } 1204 if (lines == 0) 1205 return; 1206 1207 /* 1208 * If we didn't consume the entire final line, then remove what we did 1209 * consume. If we consumed the entire line and it wasn't wrapped, 1210 * remove the wrap flag from this line. 1211 */ 1212 left = from->cellused - want; 1213 if (left != 0) { 1214 grid_move_cells(gd, 0, want, yy + lines, left, 8); 1215 from->cellsize = from->cellused = left; 1216 lines--; 1217 } else if (!wrapped) 1218 gl->flags &= ~GRID_LINE_WRAPPED; 1219 1220 /* Remove the lines that were completely consumed. */ 1221 for (i = yy + 1; i < yy + 1 + lines; i++) { 1222 free(gd->linedata[i].celldata); 1223 free(gd->linedata[i].extddata); 1224 grid_reflow_dead(&gd->linedata[i]); 1225 } 1226 1227 /* Adjust scroll position. */ 1228 if (gd->hscrolled > to + lines) 1229 gd->hscrolled -= lines; 1230 else if (gd->hscrolled > to) 1231 gd->hscrolled = to; 1232 } 1233 1234 /* Split this line into several new ones */ 1235 static void 1236 grid_reflow_split(struct grid *target, struct grid *gd, u_int sx, u_int yy, 1237 u_int at) 1238 { 1239 struct grid_line *gl = &gd->linedata[yy], *first; 1240 struct grid_cell gc; 1241 u_int line, lines, width, i, xx; 1242 u_int used = gl->cellused; 1243 int flags = gl->flags; 1244 1245 /* How many lines do we need to insert? We know we need at least two. */ 1246 if (~gl->flags & GRID_LINE_EXTENDED) 1247 lines = 1 + (gl->cellused - 1) / sx; 1248 else { 1249 lines = 2; 1250 width = 0; 1251 for (i = at; i < used; i++) { 1252 grid_get_cell1(gl, i, &gc); 1253 if (width + gc.data.width > sx) { 1254 lines++; 1255 width = 0; 1256 } 1257 width += gc.data.width; 1258 } 1259 } 1260 1261 /* Insert new lines. */ 1262 line = target->sy + 1; 1263 first = grid_reflow_add(target, lines); 1264 1265 /* Copy sections from the original line. */ 1266 width = 0; 1267 xx = 0; 1268 for (i = at; i < used; i++) { 1269 grid_get_cell1(gl, i, &gc); 1270 if (width + gc.data.width > sx) { 1271 target->linedata[line].flags |= GRID_LINE_WRAPPED; 1272 1273 line++; 1274 width = 0; 1275 xx = 0; 1276 } 1277 width += gc.data.width; 1278 grid_set_cell(target, xx, line, &gc); 1279 xx++; 1280 } 1281 if (flags & GRID_LINE_WRAPPED) 1282 target->linedata[line].flags |= GRID_LINE_WRAPPED; 1283 1284 /* Move the remainder of the original line. */ 1285 gl->cellsize = gl->cellused = at; 1286 gl->flags |= GRID_LINE_WRAPPED; 1287 memcpy(first, gl, sizeof *first); 1288 grid_reflow_dead(gl); 1289 1290 /* Adjust the scroll position. */ 1291 if (yy <= gd->hscrolled) 1292 gd->hscrolled += lines - 1; 1293 1294 /* 1295 * If the original line had the wrapped flag and there is still space 1296 * in the last new line, try to join with the next lines. 1297 */ 1298 if (width < sx && (flags & GRID_LINE_WRAPPED)) 1299 grid_reflow_join(target, gd, sx, yy, width, 1); 1300 } 1301 1302 /* Reflow lines on grid to new width. */ 1303 void 1304 grid_reflow(struct grid *gd, u_int sx) 1305 { 1306 struct grid *target; 1307 struct grid_line *gl; 1308 struct grid_cell gc; 1309 u_int yy, width, i, at; 1310 1311 /* 1312 * Create a destination grid. This is just used as a container for the 1313 * line data and may not be fully valid. 1314 */ 1315 target = grid_create(gd->sx, 0, 0); 1316 1317 /* 1318 * Loop over each source line. 1319 */ 1320 for (yy = 0; yy < gd->hsize + gd->sy; yy++) { 1321 gl = &gd->linedata[yy]; 1322 if (gl->flags & GRID_LINE_DEAD) 1323 continue; 1324 1325 /* 1326 * Work out the width of this line. at is the point at which 1327 * the available width is hit, and width is the full line 1328 * width. 1329 */ 1330 at = width = 0; 1331 if (~gl->flags & GRID_LINE_EXTENDED) { 1332 width = gl->cellused; 1333 if (width > sx) 1334 at = sx; 1335 else 1336 at = width; 1337 } else { 1338 for (i = 0; i < gl->cellused; i++) { 1339 grid_get_cell1(gl, i, &gc); 1340 if (at == 0 && width + gc.data.width > sx) 1341 at = i; 1342 width += gc.data.width; 1343 } 1344 } 1345 1346 /* 1347 * If the line is exactly right, just move it across 1348 * unchanged. 1349 */ 1350 if (width == sx) { 1351 grid_reflow_move(target, gl); 1352 continue; 1353 } 1354 1355 /* 1356 * If the line is too big, it needs to be split, whether or not 1357 * it was previously wrapped. 1358 */ 1359 if (width > sx) { 1360 grid_reflow_split(target, gd, sx, yy, at); 1361 continue; 1362 } 1363 1364 /* 1365 * If the line was previously wrapped, join as much as possible 1366 * of the next line. 1367 */ 1368 if (gl->flags & GRID_LINE_WRAPPED) 1369 grid_reflow_join(target, gd, sx, yy, width, 0); 1370 else 1371 grid_reflow_move(target, gl); 1372 } 1373 1374 /* 1375 * Replace the old grid with the new. 1376 */ 1377 if (target->sy < gd->sy) 1378 grid_reflow_add(target, gd->sy - target->sy); 1379 gd->hsize = target->sy - gd->sy; 1380 if (gd->hscrolled > gd->hsize) 1381 gd->hscrolled = gd->hsize; 1382 free(gd->linedata); 1383 gd->linedata = target->linedata; 1384 free(target); 1385 } 1386 1387 /* Convert to position based on wrapped lines. */ 1388 void 1389 grid_wrap_position(struct grid *gd, u_int px, u_int py, u_int *wx, u_int *wy) 1390 { 1391 u_int ax = 0, ay = 0, yy; 1392 1393 for (yy = 0; yy < py; yy++) { 1394 if (gd->linedata[yy].flags & GRID_LINE_WRAPPED) 1395 ax += gd->linedata[yy].cellused; 1396 else { 1397 ax = 0; 1398 ay++; 1399 } 1400 } 1401 if (px >= gd->linedata[yy].cellused) 1402 ax = UINT_MAX; 1403 else 1404 ax += px; 1405 *wx = ax; 1406 *wy = ay; 1407 } 1408 1409 /* Convert position based on wrapped lines back. */ 1410 void 1411 grid_unwrap_position(struct grid *gd, u_int *px, u_int *py, u_int wx, u_int wy) 1412 { 1413 u_int yy, ay = 0; 1414 1415 for (yy = 0; yy < gd->hsize + gd->sy - 1; yy++) { 1416 if (ay == wy) 1417 break; 1418 if (~gd->linedata[yy].flags & GRID_LINE_WRAPPED) 1419 ay++; 1420 } 1421 1422 /* 1423 * yy is now 0 on the unwrapped line which contains wx. Walk forwards 1424 * until we find the end or the line now containing wx. 1425 */ 1426 if (wx == UINT_MAX) { 1427 while (gd->linedata[yy].flags & GRID_LINE_WRAPPED) 1428 yy++; 1429 wx = gd->linedata[yy].cellused; 1430 } else { 1431 while (gd->linedata[yy].flags & GRID_LINE_WRAPPED) { 1432 if (wx < gd->linedata[yy].cellused) 1433 break; 1434 wx -= gd->linedata[yy].cellused; 1435 yy++; 1436 } 1437 } 1438 *px = wx; 1439 *py = yy; 1440 } 1441 1442 /* Get length of line. */ 1443 u_int 1444 grid_line_length(struct grid *gd, u_int py) 1445 { 1446 struct grid_cell gc; 1447 u_int px; 1448 1449 px = grid_get_line(gd, py)->cellsize; 1450 if (px > gd->sx) 1451 px = gd->sx; 1452 while (px > 0) { 1453 grid_get_cell(gd, px - 1, py, &gc); 1454 if ((gc.flags & GRID_FLAG_PADDING) || 1455 gc.data.size != 1 || 1456 *gc.data.data != ' ') 1457 break; 1458 px--; 1459 } 1460 return (px); 1461 } 1462