2 * Copyright (C) 1998 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file gui.c Curses-based interface for paraslash. */
11 #include <sys/types.h>
21 #include "ringbuffer.h"
29 /** Array of error strings. */
32 static struct lls_parse_result *cmdline_lpr, *lpr;
34 #define CMD_PTR (lls_cmd(0, gui_suite))
35 #define OPT_RESULT(_name) (lls_opt_result(LSG_GUI_PARA_GUI_OPT_ ## _name, lpr))
36 #define OPT_GIVEN(_name) (lls_opt_given(OPT_RESULT(_name)))
37 #define OPT_STRING_VAL(_name) (lls_string_val(0, OPT_RESULT(_name)))
38 #define OPT_UINT32_VAL(_name) (lls_uint32_val(0, OPT_RESULT(_name)))
39 #define FOR_EACH_KEY_MAP(_i) for (_i = 0; _i < OPT_GIVEN(KEY_MAP); _i++)
41 static char *stat_content[NUM_STAT_ITEMS];
43 static struct gui_window {
46 } top, bot, sb, in, sep;
48 /** How many lines of output to remember. */
49 #define RINGBUFFER_SIZE 512
56 static struct ringbuffer *bot_win_rb;
58 static unsigned scroll_position;
59 static pid_t exec_pid;
60 static int exec_fds[2] = {-1, -1};
63 /** Type of the process currently being executed. */
65 EXEC_IDLE, /**< No process running. */
66 EXEC_DCMD, /**< para or display process running. */
67 EXEC_XCMD, /**< External process running. */
71 * Codes for various colors.
73 * Each status item has its own color pair. The ones defined here start at a
74 * higher number so that they do not overlap with these.
77 COLOR_STATUSBAR = NUM_STAT_ITEMS + 1,
90 const char *description;
91 void (*handler)(void);
94 static struct gui_theme theme;
96 #define GUI_COMMANDS \
97 GUI_COMMAND(help, "?", "print help") \
98 GUI_COMMAND(enlarge_top_win, "+", "enlarge the top window") \
99 GUI_COMMAND(shrink_top_win, "-", "shrink the top window") \
100 GUI_COMMAND(reread_conf, "r", "reread configuration file") \
101 GUI_COMMAND(quit, "q", "exit para_gui") \
102 GUI_COMMAND(refresh, "^L", "redraw the screen") \
103 GUI_COMMAND(next_theme, ".", "switch to next theme") \
104 GUI_COMMAND(prev_theme, ",", "switch to previous theme") \
105 GUI_COMMAND(ll_incr, ">", "increase loglevel (decreases verbosity)") \
106 GUI_COMMAND(ll_decr, "<", "decrease loglevel (increases verbosity)") \
107 GUI_COMMAND(version, "V", "show the para_gui version") \
108 GUI_COMMAND(scroll_up, "<up>", "scroll up one line") \
109 GUI_COMMAND(scroll_down, "<down>", "scroll_down") \
110 GUI_COMMAND(page_up, "<ppage>", "scroll up one page") \
111 GUI_COMMAND(page_down, "<npage>", "scroll down one page") \
112 GUI_COMMAND(scroll_top, "<home>", "scroll to top of buffer") \
113 GUI_COMMAND(cancel_scroll, "<end>", "deactivate scroll mode") \
115 /* declare command handlers */
116 #define GUI_COMMAND(_c, _k, _d) \
117 static void com_ ## _c(void);
122 /* define command array */
123 #define GUI_COMMAND(_c, _k, _d) \
128 .handler = com_ ## _c \
131 static struct gui_command command_list[] = {GUI_COMMANDS {.name = NULL}};
142 struct timeval next_exec;
146 /** Stdout/stderr of the executing process is read in chunks of this size. */
147 #define COMMAND_BUF_SIZE 32768
151 char command_buf[2][COMMAND_BUF_SIZE]; /* stdout/stderr of command */
152 int cbo[2]; /* command buf offsets */
153 unsigned flags[2]; /* passed to for_each_line() */
156 static int find_cmd_byname(const char *name)
160 for (i = 0; command_list[i].handler; i++)
161 if (!strcmp(command_list[i].name, name))
167 * Even though ncurses provides getmaxx and getmaxy, these functions/macros are
168 * not described in the XSI Curses standard.
170 static int get_num_lines(struct gui_window *w)
173 __a_unused int cols; /* avoid "set but not used" warnings */
175 getmaxyx(w->win, lines, cols);
179 static int get_num_cols(struct gui_window *w)
181 __a_unused int lines; /* avoid "set but not used" warnings */
184 getmaxyx(w->win, lines, cols);
188 /** Number of lines of the window are occupied by an output line. */
189 #define NUM_LINES(len) (1 + (len) / get_num_cols(&bot))
191 /* isendwin() returns false before initscr() was called */
192 static bool curses_active(void)
194 return top.win && !isendwin();
197 /* taken from mutt */
198 static char *km_keyname(int c)
203 sprintf(buf, "<up>");
207 sprintf(buf, "<down>");
211 sprintf(buf, "<left>");
214 if (c == KEY_RIGHT) {
215 sprintf(buf, "<right>");
218 if (c == KEY_NPAGE) {
219 sprintf(buf, "<npage>");
222 if (c == KEY_PPAGE) {
223 sprintf(buf, "<ppage>");
227 sprintf(buf, "<home>");
231 sprintf(buf, "<end>");
234 if (c < 256 && c > -128 && iscntrl((unsigned char) c)) {
239 buf[1] = (c + '@') & 0x7f;
242 snprintf(buf, sizeof(buf), "\\%d%d%d", c >> 6,
243 (c >> 3) & 7, c & 7);
244 } else if (c >= KEY_F0 && c < KEY_F(256))
245 sprintf(buf, "<F%d>", c - KEY_F0);
247 snprintf(buf, sizeof(buf), "%c", (unsigned char) c);
249 snprintf(buf, sizeof(buf), "\\x%hx", (unsigned short) c);
253 /* Print given number of spaces to curses window. */
254 static void add_spaces(WINDOW *win, unsigned int num)
256 const char space[] = " ";
257 const unsigned sz = sizeof(space) - 1; /* number of spaces */
265 waddstr(win, space + sz - num);
270 * Print aligned string to curses window. This function always prints
273 static int align_str(WINDOW *win, const char *str, unsigned int len,
276 int ret, num; /* of spaces */
278 char *sstr; /* sanitized string */
282 ret = sanitize_str(str, len, &sstr, &width);
284 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
286 sstr = para_strdup(NULL);
288 assert(width <= len);
292 add_spaces(win, num);
293 } else if (align == RIGHT) {
294 add_spaces(win, num);
297 add_spaces(win, num / 2);
299 add_spaces(win, num - num / 2);
305 static void refresh_window(struct gui_window *gw)
307 gw->needs_update = true;
310 static bool window_update_needed(void)
312 return top.needs_update || bot.needs_update || sb.needs_update ||
313 in.needs_update || sep.needs_update;
316 __printf_2_3 static void print_in_bar(int color, const char *fmt,...)
321 if (!curses_active())
323 wattron(in.win, COLOR_PAIR(color));
325 xvasprintf(&msg, fmt, ap);
328 align_str(in.win, msg, get_num_cols(&in), LEFT);
333 static void print_status_bar(void)
337 tmp = para_strdup("para_gui " PACKAGE_VERSION " (hit ? for help)");
339 align_str(sb.win, tmp, get_num_cols(&sb), CENTER);
344 * get the number of the oldest rbe that is (partially) visible. On return,
345 * lines contains the sum of the number of lines of all visible entries. If the
346 * first one is only partially visible, lines is greater than bot.lines.
348 static int first_visible_rbe(unsigned *lines)
350 int i, bot_lines = get_num_lines(&bot);
353 for (i = scroll_position; i < RINGBUFFER_SIZE; i++) {
354 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
358 rbe_lines = NUM_LINES(rbe->len);
359 if (rbe_lines > bot_lines)
362 if (*lines >= bot_lines)
365 return RINGBUFFER_SIZE - 1;
369 returns number of first visible rbe, *lines is the number of lines drawn.
371 static int draw_top_rbe(unsigned *lines)
373 int bot_cols, bot_lines, ret, fvr = first_visible_rbe(lines);
374 struct rb_entry *rbe;
375 size_t bytes_to_skip, cells_to_skip, width;
379 wmove(bot.win, 0, 0);
380 rbe = ringbuffer_get(bot_win_rb, fvr);
383 getmaxyx(bot.win, bot_lines, bot_cols);
384 if (*lines > bot_lines) {
385 /* rbe is partially visible multi-line */
386 cells_to_skip = (*lines - bot_lines) * bot_cols;
387 ret = skip_cells(rbe->msg, cells_to_skip, &bytes_to_skip);
390 ret = strwidth(rbe->msg + bytes_to_skip, &width);
397 wattron(bot.win, COLOR_PAIR(rbe->color));
398 waddstr(bot.win, rbe->msg + bytes_to_skip);
399 *lines = NUM_LINES(width);
403 static void redraw_bot_win(void)
406 int i, bot_lines = get_num_lines(&bot);
408 wmove(bot.win, 0, 0);
410 i = draw_top_rbe(&lines);
413 while (i > 0 && lines < bot_lines) {
414 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, --i);
417 waddstr(bot.win, "\n");
420 lines += NUM_LINES(rbe->len);
421 wattron(bot.win, COLOR_PAIR(rbe->color));
422 waddstr(bot.win, "\n");
423 waddstr(bot.win, rbe->msg);
426 refresh_window(&bot);
429 static void rb_add_entry(int color, char *msg)
431 struct rb_entry *old, *new;
435 if (strwidth(msg, &len) < 0)
437 new = para_malloc(sizeof(struct rb_entry));
441 old = ringbuffer_add(bot_win_rb, new);
446 if (scroll_position) {
447 /* discard current scrolling, like xterm does */
452 wattron(bot.win, COLOR_PAIR(color));
453 getyx(bot.win, y, x);
455 waddstr(bot.win, "\n");
456 waddstr(bot.win, msg);
459 /* Print formatted output to bot win and refresh. */
460 __printf_2_3 static void outputf(int color, const char *fmt,...)
465 if (!curses_active())
468 xvasprintf(&msg, fmt, ap);
470 rb_add_entry(color, msg);
471 refresh_window(&bot);
474 static int add_output_line(char *line, void *data)
476 int color = *(int *)data? COLOR_ERRMSG : COLOR_OUTPUT;
478 if (!curses_active())
480 rb_add_entry(color, para_strdup(line));
484 static __printf_2_3 void curses_log(int ll, const char *fmt,...)
491 if (curses_active()) {
492 int color = ll <= LL_NOTICE? COLOR_MSG : COLOR_ERRMSG;
494 unsigned bytes = xvasprintf(&msg, fmt, ap);
495 if (bytes > 0 && msg[bytes - 1] == '\n')
496 msg[bytes - 1] = '\0'; /* cut trailing newline */
497 rb_add_entry(color, msg);
498 refresh_window(&bot);
499 } else if (exec_pid <= 0) /* no external command running */
500 vfprintf(stderr, fmt, ap);
504 /** The log function of para_gui, always set to curses_log(). */
505 __printf_2_3 void (*para_log)(int, const char *, ...) = curses_log;
507 /* Call endwin() to reset the terminal into non-visual mode. */
508 static void shutdown_curses(void)
511 * If para_gui received a terminating signal in external mode, the
512 * terminal can be in an unusable state at this point because the child
513 * process might not have caught the signal. In this case endwin() has
514 * already been called and must not be called again. So we first return
515 * to program mode, then call endwin().
517 if (!curses_active())
522 /* Disable curses, print a message, kill running processes and exit. */
523 __noreturn __printf_2_3 static void die(int exit_code, const char *fmt, ...)
527 /* Kill every process in our process group. */
528 para_sigaction(SIGTERM, SIG_IGN);
530 /* Wait up to two seconds for child processes to die. */
532 while (waitpid(0, NULL, 0) >= 0)
535 /* mousemask() exists only in ncurses */
536 #ifdef NCURSES_MOUSE_VERSION
537 mousemask(~(mmask_t)0, NULL); /* Avoid bad terminal state with xterm. */
541 vfprintf(stderr, fmt, argp);
546 /* Print stat item #i to curses window. */
547 static void print_stat_item(int i)
550 struct stat_item_data d = theme.data[i];
551 char *c = stat_content[i];
552 int top_lines = get_num_lines(&top);
554 if (!curses_active() || !d.len || !c)
556 tmp = make_message("%s%s%s", d.prefix, c, d.postfix);
557 wmove(top.win, d.y * top_lines / 100, d.x * COLS / 100);
558 wattron(top.win, COLOR_PAIR(i + 1));
559 align_str(top.win, tmp, d.len * COLS / 100, d.align);
561 refresh_window(&top);
564 static int update_item(int item_num, char *buf)
566 char **c = stat_content + item_num;
573 *c = para_strdup("(artist tag not set)");
576 *c = para_strdup("(title tag not set)");
579 *c = para_strdup("????");
582 *c = para_strdup("(album tag not set)");
585 *c = para_strdup("(comment tag not set)");
589 *c = para_strdup(buf);
591 print_stat_item(item_num);
595 static void print_all_items(void)
599 if (!curses_active())
601 FOR_EACH_STATUS_ITEM(i)
605 static void clear_all_items(void)
609 FOR_EACH_STATUS_ITEM(i) {
610 free(stat_content[i]);
611 stat_content[i] = para_strdup("");
615 static void status_pre_select(struct sched *s, void *context)
617 struct status_task *st = context;
620 para_fd_set(st->fd, &s->rfds, &s->max_fileno);
621 if (task_get_notification(st->task) < 0)
622 return sched_min_delay(s);
624 sched_request_barrier_or_min_delay(&st->next_exec, s);
627 static int status_post_select(struct sched *s, void *context)
629 struct status_task *st = context;
633 ret = task_get_notification(st->task);
634 if (ret == -E_GUI_SIGCHLD && st->pid > 0) {
636 if (waitpid(st->pid, &exit_status, WNOHANG) == st->pid) {
638 PARA_ERROR_LOG("stat command exit status: %d",
643 int fds[3] = {0, 1, 0};
646 /* Avoid busy loop */
647 if (tv_diff(&st->next_exec, now, NULL) > 0)
649 st->next_exec.tv_sec = now->tv_sec + 2;
650 ret = para_exec_cmdline_pid(&st->pid,
651 OPT_STRING_VAL(STAT_CMD), fds);
654 ret = mark_fd_nonblocking(fds[1]);
663 if (st->loaded >= st->bufsize) {
664 if (st->bufsize > 1000 * 1000) {
668 st->bufsize += st->bufsize + 1000;
669 st->buf = para_realloc(st->buf, st->bufsize);
671 assert(st->loaded < st->bufsize);
672 ret = read_nonblock(st->fd, st->buf + st->loaded,
673 st->bufsize - st->loaded, &s->rfds, &sz);
675 ret2 = for_each_stat_item(st->buf, st->loaded, update_item);
676 if (ret < 0 || ret2 < 0) {
678 PARA_NOTICE_LOG("closing stat pipe: %s\n",
679 para_strerror(ret < 0? -ret : -ret2));
683 free(stat_content[SI_BASENAME]);
684 stat_content[SI_BASENAME] =
685 para_strdup("stat command terminated!?");
689 sz = ret2; /* what is left */
690 if (sz > 0 && sz < st->loaded)
691 memmove(st->buf, st->buf + st->loaded - sz, sz);
696 /* Initialize all windows. */
697 static void init_wins(int top_lines)
699 int top_y = 0, bot_y = top_lines + 1, sb_y = LINES - 2,
700 in_y = LINES - 1, sep_y = top_lines;
701 int bot_lines = LINES - top_lines - 3, sb_lines = 1, in_lines = 1,
704 assume_default_colors(theme.dflt.fg, theme.dflt.bg);
706 wresize(top.win, top_lines, COLS);
707 mvwin(top.win, top_y, 0);
709 wresize(sb.win, sb_lines, COLS);
710 mvwin(sb.win, sb_y, 0);
712 wresize(sep.win, sep_lines, COLS);
713 mvwin(sep.win, sep_y, 0);
715 wresize(bot.win, bot_lines, COLS);
716 mvwin(bot.win, bot_y, 0);
718 wresize(in.win, in_lines, COLS);
719 mvwin(in.win, in_y, 0);
721 sep.win = newwin(sep_lines, COLS, sep_y, 0);
722 top.win = newwin(top_lines, COLS, top_y, 0);
723 bot.win = newwin(bot_lines, COLS, bot_y, 0);
724 sb.win = newwin(sb_lines, COLS, sb_y, 0);
725 in.win = newwin(in_lines, COLS, in_y, 0);
726 if (!top.win || !bot.win || !sb.win || !in.win || !sep.win)
727 die(EXIT_FAILURE, "Error: Cannot create curses windows\n");
731 scrollok(bot.win, 1);
732 wattron(sb.win, COLOR_PAIR(COLOR_STATUSBAR));
733 wattron(sep.win, COLOR_PAIR(COLOR_SEPARATOR));
734 wattron(bot.win, COLOR_PAIR(COLOR_BOT));
735 wattron(top.win, COLOR_PAIR(COLOR_TOP));
746 wmove(sep.win, 0, 0);
747 whline(sep.win, theme.sep_char, COLS);
751 wnoutrefresh(top.win);
752 wnoutrefresh(bot.win);
754 wnoutrefresh(sb.win);
755 wnoutrefresh(in.win);
756 wnoutrefresh(sep.win);
760 static void init_pair_or_die(short pair, short f, short b)
762 if (init_pair(pair, f, b) == ERR)
763 die(EXIT_FAILURE, "fatal: init_pair() failed\n");
766 static void init_colors_or_die(void)
771 die(EXIT_FAILURE, "fatal: No color term\n");
772 if (start_color() == ERR)
773 die(EXIT_FAILURE, "fatal: failed to start colors\n");
774 FOR_EACH_STATUS_ITEM(i)
775 if (theme.data[i].len)
776 init_pair_or_die(i + 1, theme.data[i].color.fg,
777 theme.data[i].color.bg);
778 init_pair_or_die(COLOR_STATUSBAR, theme.sb.fg, theme.sb.bg);
779 init_pair_or_die(COLOR_COMMAND, theme.cmd.fg, theme.cmd.bg);
780 init_pair_or_die(COLOR_OUTPUT, theme.output.fg, theme.output.bg);
781 init_pair_or_die(COLOR_MSG, theme.msg.fg, theme.msg.bg);
782 init_pair_or_die(COLOR_ERRMSG, theme.err_msg.fg, theme.err_msg.bg);
783 init_pair_or_die(COLOR_SEPARATOR, theme.sep.fg, theme.sep.bg);
784 init_pair_or_die(COLOR_TOP, theme.dflt.fg, theme.dflt.bg);
785 init_pair_or_die(COLOR_BOT, theme.dflt.fg, theme.dflt.bg);
788 /* (Re-)initialize the curses library. */
789 static void init_curses(void)
793 if (refresh() == ERR) /* refresh is really needed */
794 die(EXIT_FAILURE, "refresh() failed\n");
795 if (LINES < theme.lines_min || COLS < theme.cols_min)
796 die(EXIT_FAILURE, "Terminal (%dx%d) too small"
797 " (need at least %dx%d)\n", COLS, LINES,
798 theme.cols_min, theme.lines_min);
799 curs_set(0); /* make cursor invisible, ignore errors */
800 nonl(); /* do not NL->CR/NL on output, always returns OK */
801 /* don't echo input */
803 die(EXIT_FAILURE, "fatal: noecho() failed\n");
804 /* take input chars one at a time, no wait for \n */
806 die(EXIT_FAILURE, "fatal: cbreak() failed\n");
807 init_colors_or_die();
808 clear(); /* ignore non-fatal errors */
809 init_wins(theme.top_lines_default);
810 // noecho(); /* don't echo input */
814 * This sucker modifies its first argument. *handler and *arg are
815 * pointers to 0-terminated strings (inside line). Crap.
817 static int split_key_map(char *line, char **handler, char **arg)
819 if (!(*handler = strchr(line + 1, ':')))
823 if (!(*arg = strchr(*handler, ':')))
832 static void check_key_map_args_or_die(void)
836 const struct lls_opt_result *lor = OPT_RESULT(KEY_MAP);
838 FOR_EACH_KEY_MAP(i) {
842 tmp = para_strdup(lls_string_val(i, lor));
843 if (!split_key_map(tmp, &handler, &arg))
845 if (strlen(handler) != 1)
847 if (*handler != 'x' && *handler != 'd' && *handler != 'i'
852 if (find_cmd_byname(arg) < 0)
855 if (i != OPT_GIVEN(KEY_MAP))
856 die(EXIT_FAILURE, "invalid key map: %s\n",
857 lls_string_val(i, lor));
861 static void parse_config_file_or_die(bool reload)
864 char *cf = NULL, *errctx = NULL;
869 struct lls_parse_result *cf_lpr, *merged_lpr;
871 if (OPT_GIVEN(CONFIG_FILE))
872 cf = para_strdup(OPT_STRING_VAL(CONFIG_FILE));
874 char *home = para_homedir();
875 cf = make_message("%s/.paraslash/gui.conf", home);
878 ret = mmap_full_file(cf, O_RDONLY, &map, &sz, NULL);
880 if (ret != -E_EMPTY && ret != -ERRNO_TO_PARA_ERROR(ENOENT))
882 if (ret == -ERRNO_TO_PARA_ERROR(ENOENT) && OPT_GIVEN(CONFIG_FILE))
888 ret = lls(lls_convert_config(map, sz, NULL, &cf_argv, &errctx));
889 para_munmap(map, sz);
893 ret = lls(lls_parse(cf_argc, cf_argv, CMD_PTR, &cf_lpr, &errctx));
894 lls_free_argv(cf_argv);
897 if (reload) /* config file overrides command line */
898 ret = lls(lls_merge(cf_lpr, cmdline_lpr, CMD_PTR, &merged_lpr,
900 else /* command line options override config file options */
901 ret = lls(lls_merge(cmdline_lpr, cf_lpr, CMD_PTR, &merged_lpr,
903 lls_free_parse_result(cf_lpr, CMD_PTR);
906 if (lpr != cmdline_lpr)
907 lls_free_parse_result(lpr, CMD_PTR);
910 loglevel = OPT_UINT32_VAL(LOGLEVEL);
911 check_key_map_args_or_die();
912 theme_init(OPT_STRING_VAL(THEME), &theme);
917 PARA_ERROR_LOG("%s\n", errctx);
919 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
924 /* Reread configuration, terminate on errors. */
925 static void reread_conf(void)
928 * If the reload of the config file fails, we are about to exit. In
929 * this case we print the error message to stderr rather than to the
930 * curses window. So we have to shutdown curses first.
933 parse_config_file_or_die(true);
935 print_in_bar(COLOR_MSG, "config file reloaded\n");
938 /* React to various signal-related events. */
939 static int signal_post_select(struct sched *s, __a_unused void *context)
941 int ret = para_next_signal(&s->rfds);
947 die(EXIT_FAILURE, "only the good die young (caught SIGTERM)\n");
951 PARA_NOTICE_LOG("got SIGUSR1, rereading configuration\n");
955 task_notify_all(s, E_GUI_SIGCHLD);
961 static enum exec_status exec_status(void)
963 if (exec_fds[0] >= 0 || exec_fds[1] >= 0)
970 static void exec_pre_select(struct sched *s, void *context)
972 struct exec_task *et = context;
973 if (exec_fds[0] >= 0)
974 para_fd_set(exec_fds[0], &s->rfds, &s->max_fileno);
975 if (exec_fds[1] >= 0)
976 para_fd_set(exec_fds[1], &s->rfds, &s->max_fileno);
977 if (task_get_notification(et->task) < 0)
981 static int exec_post_select(struct sched *s, void *context)
983 struct exec_task *ct = context;
986 ret = task_get_notification(ct->task);
987 if (ret == -E_GUI_SIGCHLD && exec_pid > 0) {
989 if (waitpid(exec_pid, &exit_status, WNOHANG) == exec_pid) {
992 PARA_INFO_LOG("command exit status: %d", exit_status);
993 print_in_bar(COLOR_MSG, " ");
996 for (i = 0; i < 2; i++) {
1000 ret = read_nonblock(exec_fds[i],
1001 ct->command_buf[i] + ct->cbo[i],
1002 COMMAND_BUF_SIZE - 1 - ct->cbo[i], &s->rfds, &sz);
1005 ct->cbo[i] = for_each_line(ct->flags[i], ct->command_buf[i],
1006 ct->cbo[i], add_output_line, &i);
1007 if (sz != ct->cbo[i]) { /* at least one line found */
1008 refresh_window(&bot);
1011 if (ret < 0 || exec_pid == 0) {
1013 PARA_NOTICE_LOG("closing command fd %d: %s",
1014 i, para_strerror(-ret));
1019 if (exec_fds[!i] < 0) /* both fds closed */
1022 if (ct->cbo[i] == COMMAND_BUF_SIZE - 1) {
1023 PARA_NOTICE_LOG("discarding overlong line");
1025 ct->flags[i] = FELF_DISCARD_FIRST;
1031 static void input_pre_select(struct sched *s, __a_unused void *context)
1033 if (exec_status() != EXEC_XCMD)
1034 para_fd_set(STDIN_FILENO, &s->rfds, &s->max_fileno);
1035 if (window_update_needed())
1039 /* Read from command pipe and print data to bot window. */
1040 static void exec_and_display(const char *file_and_args)
1042 int ret, fds[3] = {0, 1, 1};
1044 outputf(COLOR_COMMAND, "%s", file_and_args);
1045 ret = para_exec_cmdline_pid(&exec_pid, file_and_args, fds);
1048 ret = mark_fd_nonblocking(fds[1]);
1051 ret = mark_fd_nonblocking(fds[2]);
1054 exec_fds[0] = fds[1];
1055 exec_fds[1] = fds[2];
1056 print_in_bar(COLOR_MSG, "hit any key to abort\n");
1059 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
1064 static void exec_para(const char *args)
1066 char *file_and_args;
1068 file_and_args = make_message(BINDIR "/para_client -- %s", args);
1069 exec_and_display(file_and_args);
1070 free(file_and_args);
1073 /* Shutdown curses and stat pipe before executing external commands. */
1074 static void exec_external(char *file_and_args)
1076 int fds[3] = {-1, -1, -1};
1081 para_exec_cmdline_pid(&exec_pid, file_and_args, fds);
1084 static void handle_command(int c)
1087 const struct lls_opt_result *lor = OPT_RESULT(KEY_MAP);
1089 /* first check user-defined key bindings */
1090 FOR_EACH_KEY_MAP(i) {
1091 char *tmp, *handler, *arg;
1093 tmp = para_strdup(lls_string_val(i, lor));
1094 if (!split_key_map(tmp, &handler, &arg)) {
1098 if (strcmp(tmp, km_keyname(c))) {
1102 if (*handler == 'd')
1103 exec_and_display(arg);
1104 else if (*handler == 'x')
1106 else if (*handler == 'p')
1108 else if (*handler == 'i') {
1109 int num = find_cmd_byname(arg);
1111 command_list[num].handler();
1116 /* not found, check internal key bindings */
1117 for (i = 0; command_list[i].handler; i++) {
1118 if (!strcmp(km_keyname(c), command_list[i].key)) {
1119 command_list[i].handler();
1123 print_in_bar(COLOR_ERRMSG, "key '%s' is not bound, press ? for help",
1127 static int input_post_select(__a_unused struct sched *s,
1128 __a_unused void *context)
1131 enum exec_status exs = exec_status();
1133 if (exs == EXEC_XCMD)
1135 if (window_update_needed()) {
1136 if (top.needs_update)
1137 assert(wnoutrefresh(top.win) == OK);
1138 if (bot.needs_update)
1139 assert(wnoutrefresh(bot.win) == OK);
1140 if (sep.needs_update)
1141 assert(wnoutrefresh(sep.win) == OK);
1142 if (sb.needs_update)
1143 assert(wnoutrefresh(sb.win) == OK);
1144 if (in.needs_update)
1145 assert(wnoutrefresh(in.win) == OK);
1147 top.needs_update = bot.needs_update = sb.needs_update =
1148 in.needs_update = sep.needs_update = false;
1150 ret = wgetch(top.win);
1153 if (ret == KEY_RESIZE) {
1154 if (curses_active()) {
1161 if (exs == EXEC_IDLE)
1162 handle_command(ret);
1163 else if (exec_pid > 0)
1164 kill(exec_pid, SIGTERM);
1168 static void print_scroll_msg(void)
1170 unsigned lines_total, filled = ringbuffer_filled(bot_win_rb);
1171 int first_rbe = first_visible_rbe(&lines_total);
1173 print_in_bar(COLOR_MSG, "scrolled view: %u-%u/%u\n", filled - first_rbe,
1174 filled - scroll_position, ringbuffer_filled(bot_win_rb));
1177 static void com_scroll_top(void)
1179 int i = RINGBUFFER_SIZE - 1, bot_lines = get_num_lines(&bot);
1182 while (i > 0 && !ringbuffer_get(bot_win_rb, i))
1184 /* i is oldest entry */
1185 for (; lines < bot_lines && i >= 0; i--) {
1186 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
1189 lines += NUM_LINES(rbe->len);
1192 if (lines > 0 && scroll_position != i) {
1193 scroll_position = i;
1198 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1201 static void com_cancel_scroll(void)
1204 if (scroll_position == 0) {
1205 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1208 scroll_position = 0;
1212 static void com_page_down(void)
1215 int i = scroll_position, bot_lines = get_num_lines(&bot);
1217 while (lines < bot_lines && --i > 0) {
1218 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
1221 lines += NUM_LINES(rbe->len);
1224 scroll_position = i;
1229 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1232 static void com_page_up(void)
1235 int fvr = first_visible_rbe(&lines), bot_lines = get_num_lines(&bot);
1237 if (fvr < 0 || fvr + 1 >= ringbuffer_filled(bot_win_rb)) {
1238 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1241 scroll_position = fvr + 1;
1242 for (; scroll_position > 0; scroll_position--) {
1243 first_visible_rbe(&lines);
1244 if (lines == bot_lines)
1251 static void com_scroll_down(void)
1253 struct rb_entry *rbe;
1254 int rbe_lines, bot_lines = get_num_lines(&bot);
1256 if (!scroll_position) {
1257 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1261 rbe = ringbuffer_get(bot_win_rb, scroll_position);
1262 rbe_lines = NUM_LINES(rbe->len);
1263 wscrl(bot.win, rbe_lines);
1264 wmove(bot.win, bot_lines - rbe_lines, 0);
1265 wattron(bot.win, COLOR_PAIR(rbe->color));
1266 waddstr(bot.win, rbe->msg);
1267 refresh_window(&bot);
1271 static void com_scroll_up(void)
1273 struct rb_entry *rbe = NULL;
1275 int i, first_rbe, num_scroll;
1277 /* the entry that is going to vanish */
1278 rbe = ringbuffer_get(bot_win_rb, scroll_position);
1281 num_scroll = NUM_LINES(rbe->len);
1282 first_rbe = first_visible_rbe(&lines);
1283 if (first_rbe < 0 || (first_rbe == ringbuffer_filled(bot_win_rb) - 1))
1286 wscrl(bot.win, -num_scroll);
1287 i = draw_top_rbe(&lines);
1290 while (i > 0 && lines < num_scroll) {
1292 rbe = ringbuffer_get(bot_win_rb, --i);
1295 rbe_lines = NUM_LINES(rbe->len);
1297 wattron(bot.win, COLOR_PAIR(rbe->color));
1298 waddstr(bot.win, "\n");
1299 waddstr(bot.win, rbe->msg);
1304 refresh_window(&bot);
1308 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1311 static void com_ll_decr(void)
1313 if (loglevel <= LL_DEBUG) {
1314 print_in_bar(COLOR_ERRMSG,
1315 "loglevel already at maximal verbosity\n");
1319 print_in_bar(COLOR_MSG, "loglevel set to %d\n", loglevel);
1322 static void com_ll_incr(void)
1324 if (loglevel >= LL_EMERG) {
1325 print_in_bar(COLOR_ERRMSG,
1326 "loglevel already at minimal verbosity\n");
1330 print_in_bar(COLOR_MSG, "loglevel set to %d\n", loglevel);
1333 static void com_reread_conf(void)
1338 static void com_help(void)
1341 const struct lls_opt_result *lor = OPT_RESULT(KEY_MAP);
1343 FOR_EACH_KEY_MAP(i) {
1344 char *handler, *arg, *tmp = para_strdup(lls_string_val(i, lor));
1345 const char *handler_text = "???", *desc = NULL;
1347 if (!split_key_map(tmp, &handler, &arg)) {
1353 handler_text = "internal";
1354 desc = command_list[find_cmd_byname(arg)].description;
1356 case 'x': handler_text = "external"; break;
1357 case 'd': handler_text = "display "; break;
1358 case 'p': handler_text = "para "; break;
1360 outputf(COLOR_MSG, "%s\t%s\t%s%s\t%s", tmp, handler_text, arg,
1361 strlen(arg) < 8? "\t" : "",
1365 for (i = 0; command_list[i].handler; i++) {
1366 struct gui_command gc = command_list[i];
1368 outputf(COLOR_MSG, "%s\tinternal\t%s\t%s%s", gc.key, gc.name,
1369 strlen(gc.name) < 8? "\t" : "",
1372 print_in_bar(COLOR_MSG, "try \"para_gui -h\" or \"para_client help\" "
1376 static void com_shrink_top_win(void)
1378 int top_lines = get_num_lines(&top);
1380 if (top_lines <= theme.top_lines_min) {
1381 PARA_WARNING_LOG("can not decrease top window\n");
1384 init_wins(top_lines - 1);
1385 print_in_bar(COLOR_MSG, "%s", "decreased top window");
1388 static void com_enlarge_top_win(void)
1390 int top_lines = get_num_lines(&top), bot_lines = get_num_lines(&bot);
1392 if (bot_lines < 3) {
1393 PARA_WARNING_LOG("can not increase top window\n");
1396 init_wins(top_lines + 1);
1397 print_in_bar(COLOR_MSG, "increased top window");
1400 static void com_version(void)
1402 print_in_bar(COLOR_MSG, "%s", version_single_line("gui"));
1405 __noreturn static void com_quit(void)
1407 die(EXIT_SUCCESS, "%s", "");
1410 static void com_refresh(void)
1416 static void com_next_theme(void)
1422 static void com_prev_theme(void)
1428 static int setup_tasks_and_schedule(void)
1431 struct exec_task exec_task = {.task = NULL};
1432 struct status_task status_task = {.fd = -1};
1433 struct input_task input_task = {.task = NULL};
1434 struct signal_task *signal_task;
1435 struct sched sched = {.default_timeout = {.tv_sec = 1}};
1437 exec_task.task = task_register(&(struct task_info) {
1439 .pre_select = exec_pre_select,
1440 .post_select = exec_post_select,
1441 .context = &exec_task,
1444 status_task.task = task_register(&(struct task_info) {
1446 .pre_select = status_pre_select,
1447 .post_select = status_post_select,
1448 .context = &status_task,
1451 input_task.task = task_register(&(struct task_info) {
1453 .pre_select = input_pre_select,
1454 .post_select = input_post_select,
1455 .context = &input_task,
1458 signal_task = signal_init_or_die();
1459 para_install_sighandler(SIGINT);
1460 para_install_sighandler(SIGTERM);
1461 para_install_sighandler(SIGCHLD);
1462 para_install_sighandler(SIGUSR1);
1463 signal_task->task = task_register(&(struct task_info) {
1465 .pre_select = signal_pre_select,
1466 .post_select = signal_post_select,
1467 .context = signal_task,
1469 ret = schedule(&sched);
1470 sched_shutdown(&sched);
1471 signal_shutdown(signal_task);
1475 static void handle_help_flags(void)
1479 if (OPT_GIVEN(DETAILED_HELP))
1480 help = lls_long_help(CMD_PTR);
1481 else if (OPT_GIVEN(HELP))
1482 help = lls_short_help(CMD_PTR);
1485 printf("%s\n", help);
1491 * The main function of para_gui.
1493 * \param argc Usual argument count.
1494 * \param argv Usual argument vector.
1496 * After initialization para_gui registers the following tasks to the paraslash
1497 * scheduler: status, exec, signal, input.
1499 * The status task executes the para_audioc stat command to obtain the status
1500 * of para_server and para_audiod, and displays this information in the top
1501 * window of para_gui.
1503 * The exec task is responsible for printing the output of the currently
1504 * running executable to the bottom window.
1506 * The signal task performs various actions according to signals received. For
1507 * example, it reloads the configuration file on SIGUSR1, and it shuts down the
1508 * curses system on SIGTERM to restore the terminal settings before exit.
1510 * The input task reads single key strokes from stdin. For each key pressed, it
1511 * executes the command handler associated with this key.
1513 * \return \p EXIT_SUCCESS or \p EXIT_FAILURE.
1515 int main(int argc, char *argv[])
1520 ret = lls(lls_parse(argc, argv, CMD_PTR, &cmdline_lpr, &errctx));
1524 loglevel = OPT_UINT32_VAL(LOGLEVEL);
1525 version_handle_flag("gui", OPT_GIVEN(VERSION));
1526 handle_help_flags();
1527 parse_config_file_or_die(false);
1528 bot_win_rb = ringbuffer_new(RINGBUFFER_SIZE);
1529 setlocale(LC_CTYPE, "");
1530 initscr(); /* needed only once, always successful */
1532 ret = setup_tasks_and_schedule();
1534 lls_free_parse_result(lpr, CMD_PTR);
1535 if (lpr != cmdline_lpr)
1536 lls_free_parse_result(cmdline_lpr, CMD_PTR);
1539 PARA_ERROR_LOG("%s\n", errctx);
1541 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
1543 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;