1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
|
/*
* BRLTTY - A background process providing access to the console screen (when in
* text mode) for a blind person using a refreshable braille display.
*
* Copyright (C) 1995-2025 by The BRLTTY Developers.
*
* BRLTTY comes with ABSOLUTELY NO WARRANTY.
*
* This is free software, placed under the terms of the
* GNU Lesser General Public License, as published by the Free Software
* Foundation; either version 2.1 of the License, or (at your option) any
* later version. Please see the file LICENSE-LGPL for details.
*
* Web Page: http://brltty.app/
*
* This software is maintained by Dave Mielke <dave@mielke.cc>.
*/
/* Tmux screen driver
* This driver interfaces with a running tmux session using tmux control mode
* to provide braille access to tmux panes.
*
* Tmux Control Mode Protocol Documentation:
* https://github.com/tmux/tmux/wiki/Control-Mode
*
* Protocol Overview:
* - Commands produce output wrapped in %begin/%end guard lines
* - Format: %begin [timestamp] [command-number] [flags]
* - Each command generates one output block
* - Asynchronous notifications prefixed with % (e.g., %output, %layout-change)
* - Use -C flag for control mode (single -C for testing, -CC for applications)
*/
#include "prologue.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <sys/wait.h>
#include <wchar.h>
#include <locale.h>
#include "log.h"
#include "color.h"
#include "parse.h"
#include "async_handle.h"
#include "async_io.h"
#include "embed.h"
/* From scr_main.h */
extern void mainScreenUpdated(void);
typedef enum {
PARM_SESSION,
PARM_SOCKET,
} ScreenParameters;
#define SCRPARMS "session", "socket"
#include "scr_driver.h"
/* Parameters */
static char *sessionParameter = NULL;
static char *socketParameter = NULL;
/* Tmux control mode state */
static pid_t tmuxPid = -1;
static int tmuxStdout = -1;
static int tmuxStdin = -1;
static AsyncHandle tmuxMonitorHandle = NULL;
/* Buffering for reading from tmux */
static char tmuxReadBuffer[4096];
static size_t tmuxReadBufferUsed = 0;
/* Screen state */
static int screenRows = 24;
static int screenCols = 80;
static int cursorRow = 0;
static int cursorCol = 0;
static wchar_t *screenContent = NULL;
static ScreenColor *screenColors = NULL;
static int screenAllocated = 0;
static int currentPaneNumber = 0;
/* Pane switching state */
static int pendingPaneSwitchDirection = 0; /* 0=none, 1=next, -1=previous */
/* Expected response types */
typedef enum {
RESPONSE_NONE, /* Not expecting anything */
RESPONSE_IGNORE, /* Ignore this response (e.g., send-keys) */
RESPONSE_DIMENSIONS, /* list-panes - expecting 1 line */
RESPONSE_CONTENT, /* capture-pane - expecting screenRows lines */
RESPONSE_PANE_LIST, /* list-panes -a - list of all panes for navigation */
} ResponseType;
/* Response queue entry */
typedef struct {
ResponseType type;
int repeatCount; /* How many consecutive responses of this type */
} ResponseQueueEntry;
/* Response queue - static circular buffer */
#define RESPONSE_QUEUE_SIZE 8
static ResponseQueueEntry responseQueue[RESPONSE_QUEUE_SIZE];
static int responseQueueHead = 0;
static int responseQueueTail = 0;
/* Current response being processed */
static int insideBeginEnd = -1; /* Sequence number of current %begin/%end block, -1 if not inside */
static ResponseType currentResponseType = RESPONSE_NONE;
static char **responseLines = NULL;
static int responseLineCount = 0;
static int responseLineCapacity = 0;
/* Screen update tracking */
static int screenNeedsUpdate = 0;
static int updateInProgress = 0; /* Flag to prevent duplicate update sequences */
/* Tmux commands */
static const char *TMUX_CMD_ENABLE_NOTIFICATIONS =
"refresh-client -A pane:window-pane-changed,session:session-window-changed";
static const char *TMUX_CMD_LIST_PANES =
"list-panes -f '#{pane_active}' -F '#{pane_width} #{pane_height} #{cursor_x} #{cursor_y} #{pane_id}'";
static const char *TMUX_CMD_LIST_ALL_PANES =
"list-panes -a -F '#{window_index} #{pane_index} #{pane_id}'";
static const char *TMUX_CMD_CAPTURE_PANE =
"capture-pane -e -p";
/* Forward declarations */
static int startTmuxControlMode(void);
static void stopTmuxControlMode(void);
static int updateScreenFromTmux(void);
static void enqueueExpectedResponse(ResponseType type);
static void clearResponseQueue(void);
static int sendTmuxCommand(const char *command, ResponseType expectedResponse);
static int parseTmuxOutput(const char *line);
static void clearResponseLines(void);
static int addResponseLine(const char *line);
static void processScreenContent(void);
static void processPaneList(void);
static int parsePaneId(const char *paneIdStr);
static void updateScreenColor(int code, ScreenColor *color);
static int parseAnsiSequence(const char **ptr, ScreenColor *color);
/* Async callback */
static ASYNC_MONITOR_CALLBACK(tmuxMonitorCallback);
static ScreenCharacter defaultCharacter;
static void
updateScreenColor(int code, ScreenColor *color) {
/* Process a single ANSI SGR (Select Graphic Rendition) parameter */
if (code == 0) {
/* Reset the screen color */
*color = defaultCharacter.color;
return;
}
if (code == 1) {
/* Bold on */
color->isBold = 1;
return;
}
if (code == 4) {
/* Underline on */
color->hasUnderline = 1;
return;
}
if (code == 5 || code == 6) {
/* Blink (slow or fast) on */
color->isBlinking = 1;
return;
}
if (code == 9) {
/* Strike Through on */
color->hasStrikeThrough = 1;
return;
}
if (code == 22) {
/* Normal intensity */
color->isBold = 0;
return;
}
if (code == 25) {
/* Blink off */
color->isBlinking = 0;
return;
}
if (code == 29) {
/* Strike Through off */
color->hasStrikeThrough = 0;
return;
}
if ((code >= 30) && (code <= 37)) {
/* Standard foreground colors */
color->foreground = ansiToRgb(code - 30);
return;
}
if (code == 39) {
/* Default foreground color */
color->foreground = ansiToRgb(7);
return;
}
if ((code >= 40) && (code <= 47)) {
/* Standard background colors */
color->background = ansiToRgb(code - 40);
return;
}
if (code == 49) {
/* Default background color */
color->background = ansiToRgb(0);
return;
}
if ((code >= 90) && (code <= 97)) {
/* Bright foreground colors */
color->foreground = ansiToRgb(code - 90 + 8);
return;
}
if ((code >= 100) && (code <= 107)) {
/* Bright background colors */
color->background = ansiToRgb(code - 100 + 8);
return;
}
}
static int
parseAnsiSequence(const char **ptr, ScreenColor *color) {
/* Parse an ANSI escape sequence: ESC[...m
* Returns 1 if a sequence was parsed, 0 otherwise
* Updates *ptr to point past the sequence
* Updates *attr with new VGA attributes */
const char *p = *ptr;
if (p[0] != '\033' || p[1] != '[') {
return 0;
}
p += 2; /* Skip ESC[ */
/* Parse semicolon-separated numeric parameters */
int params[16];
int paramCount = 0;
while (*p && *p != 'm' && paramCount < 16) {
if (*p >= '0' && *p <= '9') {
int value = 0;
while (*p >= '0' && *p <= '9') {
value = value * 10 + (*p - '0');
p++;
}
params[paramCount++] = value;
} else if (*p == ';') {
p++;
/* Handle empty parameter (default to 0) */
if (*p == ';' || *p == 'm') {
params[paramCount++] = 0;
}
} else {
/* Invalid character, abort */
return 0;
}
}
if (*p != 'm') {
/* Not an SGR sequence, ignore */
return 0;
}
p++; /* Skip 'm' */
/* If no parameters, default to 0 (reset) */
if (paramCount == 0) {
params[0] = 0;
paramCount = 1;
}
/* Apply all parameters */
for (int i = 0; i < paramCount; i++) {
/* Handle 256-color and RGB sequences */
int code = params[i];
if (code == 38 && i + 2 < paramCount && params[i + 1] == 5) {
/* 256-color foreground: ESC[38;5;Nm */
color->foreground = ansiToRgb(params[i + 2]);
i += 2;
continue;
}
if (code == 48 && i + 2 < paramCount && params[i + 1] == 5) {
/* 256-color background: ESC[48;5;Nm */
color->background = ansiToRgb(params[i + 2]);
i += 2;
continue;
}
if (code == 38 && i + 4 < paramCount && params[i + 1] == 2) {
/* foreground RGB color: ESC[38;2;R;G;Bm or ESC[48;2;R;G;Bm */
color->foreground.r = params[i + 2];
color->foreground.g = params[i + 3];
color->foreground.b = params[i + 4];
i += 4;
continue;
}
if (code == 48 && i + 4 < paramCount && params[i + 1] == 2) {
/* background RGB color: ESC[38;2;R;G;Bm or ESC[48;2;R;G;Bm */
color->background.r = params[i + 2];
color->background.g = params[i + 3];
color->background.b = params[i + 4];
i += 4;
continue;
}
/* Standard SGR parameter */
updateScreenColor(code, color);
}
*ptr = p;
return 1;
}
static void
setParameter(char **variable, char **parameters, ScreenParameters parameter) {
char *value = parameters[parameter];
if (value && !*value) value = NULL;
*variable = value;
}
static int
processParameters_TmuxScreen(char **parameters) {
setParameter(&sessionParameter, parameters, PARM_SESSION);
setParameter(&socketParameter, parameters, PARM_SOCKET);
return 1;
}
static void
releaseParameters_TmuxScreen(void) {
/* Parameters are managed by BRLTTY */
}
static int
allocateScreenBuffer(void) {
size_t size = screenRows * screenCols;
if (screenAllocated) {
wchar_t *newContent = realloc(screenContent, size * sizeof(wchar_t));
ScreenColor *newColors = realloc(screenColors, size * sizeof(ScreenColor));
if (!newContent || !newColors) {
logMessage(LOG_ERR, "Failed to reallocate screen buffer");
return 0;
}
screenContent = newContent;
screenColors = newColors;
} else {
screenContent = malloc(size * sizeof(wchar_t));
screenColors = malloc(size * sizeof(ScreenColor));
if (!screenContent || !screenColors) {
logMessage(LOG_ERR, "Failed to allocate screen buffer");
if (screenContent) free(screenContent);
if (screenColors) free(screenColors);
return 0;
}
screenAllocated = 1;
}
/* Clear the buffer */
for (size_t i = 0; i < size; i++) {
screenContent[i] = defaultCharacter.text;
screenColors[i] = defaultCharacter.color;
}
return 1;
}
static void
freeScreenBuffer(void) {
if (screenAllocated) {
free(screenContent);
free(screenColors);
screenContent = NULL;
screenColors = NULL;
screenAllocated = 0;
}
}
static int
construct_TmuxScreen(void) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Constructing Tmux screen driver");
defaultCharacter = defaultScreenCharacter;
toRGBScreenColor(&defaultCharacter.color);
/* Set locale for wide character support */
setlocale(LC_ALL, "");
if (!allocateScreenBuffer()) {
return 0;
}
if (!startTmuxControlMode()) {
freeScreenBuffer();
return 0;
}
/* Tmux sends a dummy %begin/%end block on startup - queue an IGNORE response for it */
enqueueExpectedResponse(RESPONSE_IGNORE);
/* Enable pane change notifications */
sendTmuxCommand(TMUX_CMD_ENABLE_NOTIFICATIONS, RESPONSE_IGNORE);
screenNeedsUpdate = 1;
updateInProgress = 0;
/* Register async monitor for tmux output */
if (!asyncMonitorFileInput(&tmuxMonitorHandle, tmuxStdout, tmuxMonitorCallback, NULL)) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Failed to register async monitor for tmux output");
stopTmuxControlMode();
freeScreenBuffer();
return 0;
}
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Tmux async monitor registered");
return 1;
}
static void
destruct_TmuxScreen(void) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Destructing Tmux screen driver");
/* Unregister async monitor */
if (tmuxMonitorHandle) {
asyncCancelRequest(tmuxMonitorHandle);
tmuxMonitorHandle = NULL;
}
stopTmuxControlMode();
freeScreenBuffer();
/* Free response queue */
clearResponseQueue();
/* Free response lines */
clearResponseLines();
if (responseLines) {
free(responseLines);
responseLines = NULL;
responseLineCapacity = 0;
}
}
static int
startTmuxControlMode(void) {
int pipeStdout[2];
int pipeStdin[2];
if (pipe(pipeStdout) < 0 || pipe(pipeStdin) < 0) {
logMessage(LOG_ERR, "Failed to create pipes: %s", strerror(errno));
return 0;
}
tmuxPid = fork();
if (tmuxPid < 0) {
logMessage(LOG_ERR, "Failed to fork: %s", strerror(errno));
close(pipeStdout[0]);
close(pipeStdout[1]);
close(pipeStdin[0]);
close(pipeStdin[1]);
return 0;
}
if (tmuxPid == 0) {
/* Child process - exec tmux */
close(pipeStdout[0]); /* Close read end */
close(pipeStdin[1]); /* Close write end */
dup2(pipeStdin[0], STDIN_FILENO);
dup2(pipeStdout[1], STDOUT_FILENO);
dup2(pipeStdout[1], STDERR_FILENO);
close(pipeStdin[0]);
close(pipeStdout[1]);
#ifndef O_CLOEXEC
/* Close all other file descriptors inherited from BRLTTY
* (braille devices, log files, sockets, etc.).
* This is only needed if O_CLOEXEC is not available. */
long maxfd = sysconf(_SC_OPEN_MAX);
if (maxfd < 0) maxfd = 1024; /* Fallback if sysconf fails */
for (int fd = 3; fd < maxfd; fd++) {
close(fd); /* close() is async-signal-safe and ignores EBADF */
}
#endif
/* Build tmux command */
if (sessionParameter) {
if (socketParameter) {
execlp("tmux", "tmux", "-C", "-S", socketParameter, "attach-session", "-t", sessionParameter, NULL);
} else {
execlp("tmux", "tmux", "-C", "attach-session", "-t", sessionParameter, NULL);
}
} else {
if (socketParameter) {
execlp("tmux", "tmux", "-C", "-S", socketParameter, "attach-session", NULL);
} else {
execlp("tmux", "tmux", "-C", "attach-session", NULL);
}
}
logMessage(LOG_ERR, "Failed to exec tmux: %s", strerror(errno));
_exit(1);
}
/* Parent process */
close(pipeStdout[1]); /* Close write end */
close(pipeStdin[0]); /* Close read end */
tmuxStdout = pipeStdout[0];
tmuxStdin = pipeStdin[1];
/* Make stdout non-blocking */
int flags = fcntl(tmuxStdout, F_GETFL, 0);
fcntl(tmuxStdout, F_SETFL, flags | O_NONBLOCK);
/* Initialize input buffer */
tmuxReadBufferUsed = 0;
brlttyEnableInterrupt();
logMessage(LOG_DEBUG, "Tmux control mode started");
return 1;
}
static void
stopTmuxControlMode(void) {
brlttyDisableInterrupt();
if (tmuxPid > 0) {
kill(tmuxPid, SIGTERM);
waitpid(tmuxPid, NULL, 0);
tmuxPid = -1;
}
if (tmuxStdout >= 0) {
close(tmuxStdout);
tmuxStdout = -1;
}
if (tmuxStdin >= 0) {
close(tmuxStdin);
tmuxStdin = -1;
}
}
static int
sendTmuxCommand(const char *command, ResponseType expectedResponse) {
if (tmuxStdin < 0) {
return 0;
}
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Sending tmux command: [%s]", command);
size_t len = strlen(command);
ssize_t written = write(tmuxStdin, command, len);
if (written < 0 || (size_t)written != len) {
logMessage(LOG_ERR, "Failed to write to tmux: %s", strerror(errno));
return 0;
}
/* Write newline */
if (write(tmuxStdin, "\n", 1) != 1) {
logMessage(LOG_ERR, "Failed to write newline to tmux: %s", strerror(errno));
return 0;
}
/* Enqueue the expected response type */
enqueueExpectedResponse(expectedResponse);
return 1;
}
static void
enqueueExpectedResponse(ResponseType type) {
/* Check if queue is empty */
if (responseQueueHead == responseQueueTail) {
/* Empty queue - add first entry */
responseQueue[responseQueueTail].type = type;
responseQueue[responseQueueTail].repeatCount = 1;
responseQueueTail = (responseQueueTail + 1) % RESPONSE_QUEUE_SIZE;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Enqueued response type %d", type);
return;
}
/* Get the index of the last entry */
int lastIndex = (responseQueueTail - 1 + RESPONSE_QUEUE_SIZE) % RESPONSE_QUEUE_SIZE;
if (responseQueue[lastIndex].type == type) {
/* Same type as last entry - increment repeat count */
responseQueue[lastIndex].repeatCount++;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Incremented repeat count for type %d to %d", type, responseQueue[lastIndex].repeatCount);
return;
}
/* Check if queue is full */
int nextTail = (responseQueueTail + 1) % RESPONSE_QUEUE_SIZE;
if (nextTail == responseQueueHead) {
logMessage(LOG_ERR, "Response queue full, cannot enqueue type %d", type);
return;
}
/* Add new entry */
responseQueue[responseQueueTail].type = type;
responseQueue[responseQueueTail].repeatCount = 1;
responseQueueTail = nextTail;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Enqueued response type %d", type);
}
static ResponseType
dequeueExpectedResponse(void) {
/* Check if queue is empty */
if (responseQueueHead == responseQueueTail) {
return RESPONSE_NONE;
}
/* Get the entry at head */
ResponseType type = responseQueue[responseQueueHead].type;
if (responseQueue[responseQueueHead].repeatCount > 1) {
/* Decrement repeat count instead of removing entry */
responseQueue[responseQueueHead].repeatCount--;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Decremented repeat count for type %d to %d", type, responseQueue[responseQueueHead].repeatCount);
return type;
}
/* Remove entry from queue by advancing head */
responseQueueHead = (responseQueueHead + 1) % RESPONSE_QUEUE_SIZE;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Dequeued response type %d", type);
return type;
}
static void
clearResponseQueue(void) {
responseQueueHead = 0;
responseQueueTail = 0;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Response queue cleared");
}
static void
clearResponseLines(void) {
for (int i = 0; i < responseLineCount; i++) {
free(responseLines[i]);
}
responseLineCount = 0;
}
static int
addResponseLine(const char *line) {
if (responseLineCount >= responseLineCapacity) {
int newCapacity = responseLineCapacity == 0 ? 32 : responseLineCapacity * 2;
char **newLines = realloc(responseLines, newCapacity * sizeof(char *));
if (!newLines) {
logMessage(LOG_ERR, "Failed to allocate memory for response lines");
return 0;
}
responseLines = newLines;
responseLineCapacity = newCapacity;
}
responseLines[responseLineCount] = strdup(line);
if (!responseLines[responseLineCount]) {
logMessage(LOG_ERR, "Failed to duplicate line");
return 0;
}
responseLineCount++;
return 1;
}
static void
processScreenContent(void) {
/* Process response pane content and fill screen buffer */
int row = 0;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Processing %d response lines for %dx%d screen",
responseLineCount, screenCols, screenRows);
for (int i = 0; i < responseLineCount && row < screenRows; i++) {
const char *line = responseLines[i];
int col = 0;
ScreenColor currentColor = defaultCharacter.color;
/* Convert line to wide characters and fill buffer, parsing ANSI sequences */
for (const char *p = line; *p && col < screenCols; ) {
/* Check for ANSI escape sequence */
if (parseAnsiSequence(&p, ¤tColor)) {
/* Sequence parsed, currentColor updated, continue */
continue;
}
/* Regular character - convert to wide char */
wchar_t wc;
int bytes = mbtowc(&wc, p, MB_CUR_MAX);
if (bytes <= 0) {
/* Invalid character, skip it */
p++;
continue;
}
int index = row * screenCols + col;
screenContent[index] = wc;
screenColors[index] = currentColor;
p += bytes;
col++;
}
/* Fill remaining columns with spaces */
for (; col < screenCols; col++) {
int index = row * screenCols + col;
screenContent[index] = defaultCharacter.text;
screenColors[index] = defaultCharacter.color;
}
row++;
}
/* Fill remaining rows with spaces */
for (; row < screenRows; row++) {
for (int col = 0; col < screenCols; col++) {
int index = row * screenCols + col;
screenContent[index] = defaultCharacter.text;
screenColors[index] = defaultCharacter.color;
}
}
mainScreenUpdated();
}
static int
parsePaneId(const char *paneIdStr) {
/* Parse pane ID string (format: %N) and return the numeric part
* Returns -1 if parsing fails
*/
if (!paneIdStr || paneIdStr[0] != '%') {
return -1;
}
return atoi(paneIdStr + 1);
}
static void
processPaneList(void) {
/* Process list of all panes and switch to next/previous pane */
if (responseLineCount == 0 || pendingPaneSwitchDirection == 0) {
return;
}
int currentIndex = -1;
int targetIndex = -1;
/* Find current pane in the list */
for (int i = 0; i < responseLineCount; i++) {
char paneId[32];
int windowIdx, paneIdx;
if (sscanf(responseLines[i], "%d %d %31s", &windowIdx, &paneIdx, paneId) == 3) {
int paneNum = parsePaneId(paneId);
if (paneNum == currentPaneNumber) {
currentIndex = i;
break;
}
}
}
/* Calculate target index with wraparound */
if (currentIndex >= 0) {
if (pendingPaneSwitchDirection > 0) {
targetIndex = (currentIndex + 1) % responseLineCount;
} else {
targetIndex = (currentIndex - 1 + responseLineCount) % responseLineCount;
}
/* Parse target pane info and switch to it */
char paneId[32];
int windowIdx, paneIdx;
if (sscanf(responseLines[targetIndex], "%d %d %31s", &windowIdx, &paneIdx, paneId) == 3) {
char selectWindowCmd[64];
char selectPaneCmd[64];
snprintf(selectWindowCmd, sizeof(selectWindowCmd), "select-window -t :%d", windowIdx);
snprintf(selectPaneCmd, sizeof(selectPaneCmd), "select-pane -t :%d.%d", windowIdx, paneIdx);
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Switching to window %d pane %d (%s)",
windowIdx, paneIdx, paneId);
sendTmuxCommand(selectWindowCmd, RESPONSE_IGNORE);
sendTmuxCommand(selectPaneCmd, RESPONSE_IGNORE);
}
}
pendingPaneSwitchDirection = 0;
}
static int
parseTmuxOutput(const char *line) {
/* Parse tmux control mode output
* In control mode, output is either:
* - Control messages starting with % (like %begin, %end, %output, etc.)
* - Regular output lines (including pane IDs like %0, %1)
*/
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"parsing tmux line \"%s\" (currentType %d)", line, currentResponseType);
if (insideBeginEnd >= 0 &&
currentResponseType == RESPONSE_CONTENT &&
responseLineCount < screenRows) {
/*
* The capture command returns the screen content which may contain
* the equivalent of control messages such as "%end". Don't consider
* any additional parsing until we've gathered at least the expected
* number of lines.
*/
addResponseLine(line);
return 1;
}
/* Check for control messages */
if (line[0] == '%') {
/* Check if it's a known control message */
if (strncmp(line, "%begin ", 7) == 0) {
/* Start of command output
* Format: %begin timestamp command-number flags */
int timestamp, cmdNumber, flags;
int parsed = sscanf(line, "%%begin %d %d %d", ×tamp, &cmdNumber, &flags);
/* Track the sequence number of this block */
if (parsed >= 2) {
insideBeginEnd = cmdNumber;
/* Dequeue the next expected response type */
currentResponseType = dequeueExpectedResponse();
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Tmux begin: cmd=%d, dequeued type=%d",
cmdNumber, currentResponseType);
} else {
insideBeginEnd = -1;
currentResponseType = RESPONSE_NONE;
}
} else if (strncmp(line, "%end ", 5) == 0 || strncmp(line, "%error ", 7) == 0) {
/* End of command output - process captured data
* Format: %end timestamp command-number flags
* Or: %error timestamp command-number flags */
int isError = (strncmp(line, "%error ", 7) == 0);
int timestamp, cmdNumber, flags;
int parsed = sscanf(line + (isError ? 7 : 5), "%d %d %d", ×tamp, &cmdNumber, &flags);
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Tmux %s: cmd=%d currentType=%d lines=%d",
isError ? "error" : "end", cmdNumber, currentResponseType, responseLineCount);
/* Check if this matches our begin sequence */
int isMatchingEnd = (parsed >= 2 && cmdNumber == insideBeginEnd);
if (!isMatchingEnd) {
logMessage(LOG_ERR, "Sequence mismatch: %%begin had %d, %s has %d",
insideBeginEnd, isError ? "%error" : "%end", cmdNumber);
}
insideBeginEnd = -1;
if (isError) {
/* Log the error message */
logMessage(LOG_ERR, "Tmux command %d failed:", cmdNumber);
for (int i = 0; i < responseLineCount; i++) {
logMessage(LOG_ERR, " %s", responseLines[i]);
}
currentResponseType = RESPONSE_NONE;
} else if (isMatchingEnd) {
if (currentResponseType == RESPONSE_IGNORE) {
/* Command response we don't care about (e.g., send-keys) */
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Ignoring response");
} else if (currentResponseType == RESPONSE_DIMENSIONS) {
/* Dimensions received from list-panes - parse first line */
if (responseLineCount == 1) {
const char *line = responseLines[0];
char paneId[32];
int parsed = sscanf(line, "%d %d %d %d %31s",
&screenCols, &screenRows, &cursorCol, &cursorRow, paneId);
if (parsed == 5) {
/* pane_id format is %<number> - extract the numeric part */
currentPaneNumber = parsePaneId(paneId);
if (currentPaneNumber < 0) {
currentPaneNumber = 0;
}
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"list-panes: %dx%d, cursor: (%d,%d), pane: %s (number: %d)",
screenCols, screenRows, cursorCol, cursorRow, paneId, currentPaneNumber);
allocateScreenBuffer();
} else {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Failed to parse list-panes response: %s", line);
}
}
} else if (currentResponseType == RESPONSE_CONTENT) {
/* Content received from capture-pane - process it */
if (responseLineCount > 0) {
processScreenContent();
}
/* Update sequence complete */
updateInProgress = 0;
} else if (currentResponseType == RESPONSE_PANE_LIST) {
/* Received list of all panes - process and switch */
processPaneList();
}
currentResponseType = RESPONSE_NONE;
}
/* We're done with this response */
clearResponseLines();
} else if (strncmp(line, "%output ", 8) == 0) {
/* Pane output notification - screen has changed!
* Format: %output %pane_id data...
* Only update if it's for the current pane
*/
int paneNum = parsePaneId(line + 8);
if (paneNum == currentPaneNumber) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Tmux output notification for current pane %d", paneNum);
screenNeedsUpdate = 1;
} else {
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG,
"Tmux output notification for other pane %d (current: %d)", paneNum, currentPaneNumber);
}
} else if (strncmp(line, "%layout-change", 14) == 0) {
/* Layout changed - screen dimensions may have changed */
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Tmux layout change: %s", line);
screenNeedsUpdate = 1;
} else if (strncmp(line, "%window-pane-changed", 20) == 0) {
/* Active pane changed */
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Tmux pane change: %s", line);
screenNeedsUpdate = 1;
} else if (strncmp(line, "%session-window-changed", 23) == 0) {
/* Active window changed */
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Tmux window change: %s", line);
screenNeedsUpdate = 1;
} else if (strncmp(line, "%session-changed", 16) == 0) {
/* Session changed notification */
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Tmux session change: %s", line);
screenNeedsUpdate = 1;
} else if (strncmp(line, "%sessions-changed", 17) == 0) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Tmux sessions change: %s", line);
screenNeedsUpdate = 1;
} else if (strncmp(line, "%exit", 5) == 0) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Tmux exit: %s", line);
brlttyInterrupt(WAIT_STOP);
} else {
/* Starts with % but not a known control message */
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Line starts with %% but not a control message: %s", line);
}
} else if (insideBeginEnd >= 0) {
addResponseLine(line);
} else {
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "unexpected data from tmux: %s", line);
}
return 1;
}
ASYNC_MONITOR_CALLBACK(tmuxMonitorCallback) {
/* Called by BRLTTY's event loop when data is available on tmux stdout */
ssize_t bytesRead;
char *lineStart = tmuxReadBuffer;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "Async callback called");
if (tmuxStdout < 0) return 0;
/* Read all available data without blocking */
do {
bytesRead = read(tmuxStdout, tmuxReadBuffer + tmuxReadBufferUsed,
sizeof(tmuxReadBuffer) - tmuxReadBufferUsed);
/* Check for errors */
if (bytesRead < 0) {
if (errno == EAGAIN || errno == EWOULDBLOCK) {
/* No more data available - this is normal for non-blocking I/O */
bytesRead = 0;
} else {
logMessage(LOG_ERR, "Error reading from tmux: %s", strerror(errno));
brlttyInterrupt(WAIT_STOP);
return 0;
}
}
/* Look for line termination */
for (ssize_t i = tmuxReadBufferUsed; i < tmuxReadBufferUsed + bytesRead; i++) {
if (tmuxReadBuffer[i] != '\n') continue;
/* End of line - null terminate and process */
tmuxReadBuffer[i] = '\0';
parseTmuxOutput(lineStart);
lineStart = tmuxReadBuffer + i + 1;
}
/* Compute size of incomplete line data */
tmuxReadBufferUsed = tmuxReadBuffer + tmuxReadBufferUsed + bytesRead - lineStart;
if (tmuxReadBufferUsed >= sizeof(tmuxReadBuffer)) {
logMessage(LOG_ERR, "Error reading from tmux: line exceeds %zu bytes",
sizeof(tmuxReadBuffer));
return 0;
}
/* Move incomplete line data to the beginning */
if (tmuxReadBufferUsed)
memmove(tmuxReadBuffer, lineStart, tmuxReadBufferUsed);
lineStart = tmuxReadBuffer;
} while (bytesRead > 0);
if (screenNeedsUpdate)
if (updateScreenFromTmux())
screenNeedsUpdate = 0;
return 1;
}
static int
updateScreenFromTmux(void) {
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "updateScreenFromTmux called (updateInProgress=%d)", updateInProgress);
if (updateInProgress) {
/* An update sequence is already queued */
return 1;
}
/* Send both commands back-to-back - responses will arrive asynchronously
* and be processed by tmuxMonitorCallback in the right order.
*
* First: list-panes (without -a) to get dimensions and cursor of active pane only
* Second: capture-pane to get the content
*/
if (sendTmuxCommand(TMUX_CMD_LIST_PANES, RESPONSE_DIMENSIONS) &&
sendTmuxCommand(TMUX_CMD_CAPTURE_PANE, RESPONSE_CONTENT)) {
updateInProgress = 1;
return 1;
}
return 0;
}
static void
describe_TmuxScreen(ScreenDescription *description) {
description->cols = screenCols;
description->rows = screenRows;
description->posx = cursorCol;
description->posy = cursorRow;
description->number = currentPaneNumber;
description->hasCursor = 1;
description->hasSelection = 0;
description->unreadable = NULL;
description->quality = SCQ_GOOD;
logMessage(LOG_CATEGORY(SCREEN_DRIVER) | LOG_DEBUG, "describe: %dx%d, cursor: (%d,%d), pane: %d",
screenCols, screenRows, cursorCol, cursorRow, currentPaneNumber);
}
static int
readCharacters_TmuxScreen(const ScreenBox *box, ScreenCharacter *buffer) {
if (!validateScreenBox(box, screenCols, screenRows)) {
logMessage(LOG_ERR, "Invalid screen box");
return 0;
}
for (int row = 0; row < box->height; row++) {
int screenRow = box->top + row;
if (screenRow >= screenRows) break;
for (int col = 0; col < box->width; col++) {
int screenCol = box->left + col;
if (screenCol >= screenCols) break;
int screenIndex = screenRow * screenCols + screenCol;
int bufferIndex = row * box->width + col;
buffer[bufferIndex].text = screenContent[screenIndex];
buffer[bufferIndex].color = screenColors[screenIndex];
}
}
return 1;
}
static int
insertKey_TmuxScreen(ScreenKey key) {
char command[256];
/* Map ScreenKey to tmux key names */
if (key == SCR_KEY_CURSOR_UP) {
snprintf(command, sizeof(command), "send-keys Up");
} else if (key == SCR_KEY_CURSOR_DOWN) {
snprintf(command, sizeof(command), "send-keys Down");
} else if (key == SCR_KEY_CURSOR_LEFT) {
snprintf(command, sizeof(command), "send-keys Left");
} else if (key == SCR_KEY_CURSOR_RIGHT) {
snprintf(command, sizeof(command), "send-keys Right");
} else if (key == SCR_KEY_HOME) {
snprintf(command, sizeof(command), "send-keys Home");
} else if (key == SCR_KEY_END) {
snprintf(command, sizeof(command), "send-keys End");
} else if (key == SCR_KEY_PAGE_UP) {
snprintf(command, sizeof(command), "send-keys PageUp");
} else if (key == SCR_KEY_PAGE_DOWN) {
snprintf(command, sizeof(command), "send-keys PageDown");
} else if (key == SCR_KEY_ENTER) {
snprintf(command, sizeof(command), "send-keys Enter");
} else if (key == SCR_KEY_TAB) {
snprintf(command, sizeof(command), "send-keys Tab");
} else if (key == SCR_KEY_BACKSPACE) {
snprintf(command, sizeof(command), "send-keys BSpace");
} else if (key == SCR_KEY_DELETE) {
snprintf(command, sizeof(command), "send-keys DC");
} else if (key == SCR_KEY_ESCAPE) {
snprintf(command, sizeof(command), "send-keys Escape");
} else if (key >= SCR_KEY_F1 && key <= SCR_KEY_F12) {
int fnum = key - SCR_KEY_F1 + 1;
snprintf(command, sizeof(command), "send-keys F%d", fnum);
} else {
/* Regular character */
wchar_t ch = key & SCR_KEY_CHAR_MASK;
if (ch < 0x80) {
/* ASCII character */
if (key & SCR_KEY_CONTROL) {
snprintf(command, sizeof(command), "send-keys C-%c", (char)ch);
} else if (key & (SCR_KEY_ALT_LEFT | SCR_KEY_ALT_RIGHT)) {
snprintf(command, sizeof(command), "send-keys M-%c", (char)ch);
} else {
snprintf(command, sizeof(command), "send-keys '%c'", (char)ch);
}
} else {
/* Unicode character - just send as literal */
char utf8[8];
snprintf(utf8, sizeof(utf8), "%lc", (wint_t)ch);
snprintf(command, sizeof(command), "send-keys '%s'", utf8);
}
}
return sendTmuxCommand(command, RESPONSE_IGNORE);
}
static int
poll_TmuxScreen(void) {
/* With async I/O, BRLTTY's event loop handles monitoring the tmux FD.
* We don't need to poll - return 0 to indicate no polling needed. */
return 0;
}
static int
refresh_TmuxScreen(void) {
/* All the refreshing is done through the async I/O callback. */
return 1;
}
static ScreenPasteMode
getPasteMode_TmuxScreen(void) {
/* Tmux always accepts bracketed paste input */
return SPM_BRACKETED;
}
static int
currentVirtualTerminal_TmuxScreen(void) {
/* Return the current pane number (extracted from pane_id) */
return currentPaneNumber;
}
static int
switchVirtualTerminal_TmuxScreen(int vt) {
/* Switch to a different pane by cycling through all panes
* vt parameter indicates target pane number
* We need to query list-panes -a to find next/previous pane
*/
if (vt > currentPaneNumber) {
pendingPaneSwitchDirection = 1; /* Next */
} else if (vt < currentPaneNumber) {
pendingPaneSwitchDirection = -1; /* Previous */
} else {
/* Already on this pane */
return 1;
}
logMessage(LOG_CATEGORY(SCREEN_DRIVER), "Querying pane list for switch (direction: %d)",
pendingPaneSwitchDirection);
return sendTmuxCommand(TMUX_CMD_LIST_ALL_PANES, RESPONSE_PANE_LIST);
}
static void
scr_initialize(MainScreen *main) {
initializeRealScreen(main);
main->base.poll = poll_TmuxScreen;
main->base.refresh = refresh_TmuxScreen;
main->base.describe = describe_TmuxScreen;
main->base.readCharacters = readCharacters_TmuxScreen;
main->base.insertKey = insertKey_TmuxScreen;
main->base.getPasteMode = getPasteMode_TmuxScreen;
main->base.currentVirtualTerminal = currentVirtualTerminal_TmuxScreen;
main->base.switchVirtualTerminal = switchVirtualTerminal_TmuxScreen;
main->processParameters = processParameters_TmuxScreen;
main->releaseParameters = releaseParameters_TmuxScreen;
main->construct = construct_TmuxScreen;
main->destruct = destruct_TmuxScreen;
}
|