gui: Recognize "home" and "end" keys.
[paraslash.git] / gui.c
1 /*
2 * Copyright (C) 1998-2011 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file gui.c Curses-based interface for paraslash. */
8
9 #include <regex.h>
10 #include <signal.h>
11 #include <sys/types.h>
12 #include <dirent.h>
13 #include <curses.h>
14
15 #include "gui.cmdline.h"
16 #include "para.h"
17 #include "gui.h"
18 #include "string.h"
19 #include "ringbuffer.h"
20 #include "fd.h"
21 #include "error.h"
22 #include "list.h"
23 #include "sched.h"
24 #include "signal.h"
25
26 /** define the array of error lists needed by para_gui */
27 INIT_GUI_ERRLISTS;
28 static char *stat_content[NUM_STAT_ITEMS];
29
30 #define STANDARD_STATUS_BAR "para_gui " PACKAGE_VERSION " (hit ? for help)"
31
32 static int signal_pipe;
33
34 static struct win_data {
35 WINDOW *win;
36 NCURSES_SIZE_T begx;
37 NCURSES_SIZE_T begy;
38 NCURSES_SIZE_T cols;
39 NCURSES_SIZE_T lines;
40 } top, bot, sb, in, sep;
41
42 #define RINGBUFFER_SIZE 512
43 struct rb_entry {
44 char *msg;
45 size_t len;
46 int color;
47 };
48 static struct ringbuffer *bot_win_rb;
49 #define NUM_LINES(len) (1 + (len) / bot.cols)
50
51 static unsigned scroll_position;
52
53 static int cmd_died, curses_active;
54 static pid_t cmd_pid;
55
56 static int command_pipe = -1;
57 static int stat_pipe = -1;
58 static struct gui_args_info conf;
59
60 enum {GETCH_MODE, COMMAND_MODE, EXTERNAL_MODE};
61
62
63 #define COLOR_STATUSBAR 52
64 #define COLOR_COMMAND 53
65 #define COLOR_OUTPUT 54
66 #define COLOR_MSG 55
67 #define COLOR_ERRMSG 56
68 #define COLOR_WELCOME 57
69 #define COLOR_SEPARATOR 58
70 #define COLOR_TOP 59
71 #define COLOR_BOT 60
72
73 struct gui_command {
74 const char *key;
75 const char *name;
76 const char *description;
77 void (*handler)(void);
78 };
79
80 struct stat_item {
81 char name[MAXLINE];
82 char prefix[MAXLINE];
83 char postfix[MAXLINE];
84 unsigned y;
85 unsigned x;
86 unsigned len;
87 int fg, bg;
88 int align;
89 char content[MAXLINE];
90 };
91
92 static struct gui_theme theme;
93
94 static int _argc;
95 static char **_argv;
96
97 static void com_help(void);
98 static void com_reread_conf(void);
99 static void com_enlarge_top_win(void);
100 static void com_shrink_top_win(void);
101 static void com_version(void);
102 static void com_quit(void);
103 static void com_refresh(void);
104 static void com_ll_incr(void);
105 static void com_ll_decr(void);
106 static void com_prev_theme(void);
107 static void com_next_theme(void);
108 static void com_scroll_up(void);
109 static void com_scroll_down(void);
110 static void com_page_up(void);
111 static void com_page_down(void);
112 static void com_cancel_scrolling(void);
113 static void com_scroll_top(void);
114
115 static struct gui_command command_list[] = {
116 {
117 .key = "?",
118 .name = "help",
119 .description = "print help",
120 .handler = com_help
121 }, {
122 .key = "+",
123 .name = "enlarge_win",
124 .description = "enlarge the top window",
125 .handler = com_enlarge_top_win
126 }, {
127 .key = "-",
128 .name = "shrink_win",
129 .description = "shrink the top window",
130 .handler = com_shrink_top_win
131 }, {
132 .key = "r",
133 .name = "reread_conf",
134 .description = "reread configuration file",
135 .handler = com_reread_conf
136 }, {
137 .key = "q",
138 .name = "quit",
139 .description = "exit para_gui",
140 .handler = com_quit
141 }, {
142 .key = "^L",
143 .name = "refresh",
144 .description = "redraw the screen",
145 .handler = com_refresh
146 }, {
147 .key = ".",
148 .name = "next_theme",
149 .description = "switch to next theme",
150 .handler = com_next_theme
151 }, {
152 .key = ",",
153 .name = "prev_theme",
154 .description = "switch to previous stream",
155 .handler = com_prev_theme
156 }, {
157 .key = ">",
158 .name = "ll_incr",
159 .description = "increase loglevel (decreases verbosity)",
160 .handler = com_ll_incr
161 }, {
162 .key = "<",
163 .name = "ll_decr",
164 .description = "decrease loglevel (increases verbosity)",
165 .handler = com_ll_decr
166 }, {
167 .key = "V",
168 .name = "version",
169 .description = "show the para_gui version",
170 .handler = com_version
171 }, {
172 .key = "<up>",
173 .name = "scroll_up",
174 .description = "scroll up one line",
175 .handler = com_scroll_up
176 }, {
177 .key = "<down>",
178 .name = "scroll_down",
179 .description = "scroll down one line",
180 .handler = com_scroll_down
181 }, {
182 .key = "<ppage>",
183 .name = "page_up",
184 .description = "scroll up one page",
185 .handler = com_page_up
186 }, {
187 .key = "<npage>",
188 .name = "page_down",
189 .description = "scroll down one page",
190 .handler = com_page_down
191 }, {
192 .key = "<home>",
193 .name = "scroll_top",
194 .description = "scroll to top of buffer",
195 .handler = com_scroll_top
196 }, {
197 .key = "<end>",
198 .name = "cancel_scroll",
199 .description = "deactivate scroll mode",
200 .handler = com_cancel_scrolling
201 }, {
202 .handler = NULL
203 }
204 };
205
206 static int find_cmd_byname(char *name)
207 {
208 int i;
209
210 for (i = 0; command_list[i].handler; i++)
211 if (!strcmp(command_list[i].name, name))
212 return i;
213 return -1;
214 }
215
216 /* taken from mutt */
217 static char *km_keyname(int c)
218 {
219 static char buf[10];
220
221 if (c == KEY_UP) {
222 sprintf(buf, "<up>");
223 return buf;
224 }
225 if (c == KEY_DOWN) {
226 sprintf(buf, "<down>");
227 return buf;
228 }
229 if (c == KEY_LEFT) {
230 sprintf(buf, "<left>");
231 return buf;
232 }
233 if (c == KEY_RIGHT) {
234 sprintf(buf, "<right>");
235 return buf;
236 }
237 if (c == KEY_NPAGE) {
238 sprintf(buf, "<npage>");
239 return buf;
240 }
241 if (c == KEY_PPAGE) {
242 sprintf(buf, "<ppage>");
243 return buf;
244 }
245 if (c == KEY_HOME) {
246 sprintf(buf, "<home>");
247 return buf;
248 }
249 if (c == KEY_END) {
250 sprintf(buf, "<end>");
251 return buf;
252 }
253 if (c < 256 && c > -128 && iscntrl((unsigned char) c)) {
254 if (c < 0)
255 c += 256;
256 if (c < 128) {
257 buf[0] = '^';
258 buf[1] = (c + '@') & 0x7f;
259 buf[2] = 0;
260 } else
261 snprintf(buf, sizeof(buf), "\\%d%d%d", c >> 6,
262 (c >> 3) & 7, c & 7);
263 } else if (c >= KEY_F0 && c < KEY_F(256))
264 sprintf(buf, "<F%d>", c - KEY_F0);
265 else if (isprint(c))
266 snprintf(buf, sizeof(buf), "%c", (unsigned char) c);
267 else
268 snprintf(buf, sizeof(buf), "\\x%hx", (unsigned short) c);
269 return buf;
270 }
271
272 static char *configfile_exists(void)
273 {
274 static char *config_file;
275 char *tmp;
276
277 if (!conf.config_file_given) {
278 if (!config_file) {
279 char *home = para_homedir();
280 config_file = make_message("%s/.paraslash/gui.conf",
281 home);
282 free(home);
283 }
284 tmp = config_file;
285 } else
286 tmp = conf.config_file_arg;
287 return file_exists(tmp)? tmp: NULL;
288 }
289
290 /*
291 * print num spaces to curses window
292 */
293 static void add_spaces(WINDOW* win, unsigned int num)
294 {
295 while (num > 0) {
296 num--;
297 waddstr(win, " ");
298 }
299 }
300
301 /*
302 * print aligned string to curses window. This function always prints
303 * exactly len chars.
304 */
305 static int align_str(WINDOW* win, char *str, unsigned int len,
306 unsigned int align)
307 {
308 int i, num; /* of spaces */
309
310 if (!win || !str)
311 return -1;
312 num = len - strlen(str);
313 if (num < 0) {
314 str[len] = '\0';
315 num = 0;
316 }
317 /* replace control characters by spaces */
318 for (i = 0; i < len && str[i]; i++) {
319 if (str[i] == '\n' || str[i] == '\r' || str[i] == '\f')
320 str[i] = ' ';
321 }
322 if (align == LEFT) {
323 waddstr(win, str);
324 add_spaces(win, num);
325 } else if (align == RIGHT) {
326 add_spaces(win, num);
327 waddstr(win, str);
328 } else {
329 add_spaces(win, num / 2);
330 waddstr(win, str[0]? str: "");
331 add_spaces(win, num - num / 2);
332 }
333 return 1;
334 }
335
336 __printf_2_3 static void print_in_bar(int color, const char *fmt,...)
337 {
338 char *msg;
339
340 if (!curses_active)
341 return;
342 wattron(in.win, COLOR_PAIR(color));
343 PARA_VSPRINTF(fmt, msg);
344 wmove(in.win, 0, 0);
345 align_str(in.win, msg, sb.cols, LEFT);
346 free(msg);
347 wrefresh(in.win);
348 }
349
350 /*
351 * update the status bar
352 */
353 static void print_status_bar(void)
354 {
355 char *tmp;
356
357 if (!curses_active)
358 return;
359 tmp = para_strdup(STANDARD_STATUS_BAR);
360 wmove(sb.win, 0, 0);
361 align_str(sb.win, tmp, sb.cols, CENTER);
362 free(tmp);
363 wrefresh(sb.win);
364 }
365
366 /*
367 * get the number of the oldest rbe that is (partially) visible. On return,
368 * lines contains the sum of the number of lines of all visable entries. If the
369 * first one is only partially visible, lines is greater than bot.lines.
370 */
371 static int first_visible_rbe(unsigned *lines)
372 {
373 int i;
374 *lines = 0;
375 for (i = scroll_position; i < RINGBUFFER_SIZE; i++) {
376 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
377 int rbe_lines;
378 if (!rbe)
379 return i - 1;
380 // fprintf(stderr, "found: %s\n", rbe->msg);
381 rbe_lines = NUM_LINES(rbe->len);
382 if (rbe_lines > bot.lines)
383 return -1;
384 *lines += rbe_lines;
385 if (*lines >= bot.lines)
386 return i;
387 }
388 return RINGBUFFER_SIZE - 1;
389 }
390
391 static int draw_top_rbe(unsigned *lines)
392 {
393 unsigned len;
394 int offset, fvr = first_visible_rbe(lines);
395 struct rb_entry *rbe;
396
397 if (fvr < 0)
398 return -1;
399 wmove(bot.win, 0, 0);
400 rbe = ringbuffer_get(bot_win_rb, fvr);
401 if (!rbe)
402 return -1;
403 /* first rbe might be only partially visible */
404 offset = (*lines - bot.lines) * bot.cols;
405 len = strlen(rbe->msg);
406 if (offset < 0 || len < offset)
407 return -1;
408 wattron(bot.win, COLOR_PAIR(rbe->color));
409 waddstr(bot.win, rbe->msg + offset);
410 *lines = NUM_LINES(len - offset);
411 return fvr;
412 }
413
414 static void redraw_bot_win(void)
415 {
416 unsigned lines;
417 int i;
418
419 wmove(bot.win, 0, 0);
420 wclear(bot.win);
421 i = draw_top_rbe(&lines);
422 if (i <= 0)
423 goto out;
424 while (i > 0 && lines < bot.lines) {
425 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, --i);
426 if (!rbe) {
427 lines++;
428 waddstr(bot.win, "\n");
429 continue;
430 }
431 lines += NUM_LINES(rbe->len);
432 wattron(bot.win, COLOR_PAIR(rbe->color));
433 waddstr(bot.win, "\n");
434 waddstr(bot.win, rbe->msg);
435 }
436 out:
437 wrefresh(bot.win);
438 }
439
440 static void rb_add_entry(int color, char *msg)
441 {
442 struct rb_entry *old, *new = para_malloc(sizeof(struct rb_entry));
443 int x, y;
444 new->color = color;
445 new->len = strlen(msg);
446 new->msg = msg;
447 old = ringbuffer_add(bot_win_rb, new);
448 // fprintf(stderr, "added: %s\n", new->msg);
449 if (old) {
450 free(old->msg);
451 free(old);
452 }
453 if (scroll_position) {
454 /* discard current scrolling, like xterm does */
455 scroll_position = 0;
456 redraw_bot_win();
457 return;
458 }
459 wattron(bot.win, COLOR_PAIR(color));
460 getyx(bot.win, y, x);
461 if (y || x)
462 waddstr(bot.win, "\n");
463 waddstr(bot.win, msg);
464 }
465
466 /*
467 * print formated output to bot win and refresh
468 */
469 __printf_2_3 static void outputf(int color, const char* fmt,...)
470 {
471 char *msg;
472
473 if (!curses_active)
474 return;
475 PARA_VSPRINTF(fmt, msg);
476 rb_add_entry(color, msg);
477 wrefresh(bot.win);
478 }
479
480 static int add_output_line(char *line, __a_unused void *data)
481 {
482 if (!curses_active)
483 return 1;
484 rb_add_entry(COLOR_OUTPUT, para_strdup(line));
485 return 1;
486 }
487
488 static int loglevel;
489
490 __printf_2_3 void para_log(int ll, const char *fmt,...)
491 {
492 int color;
493 char *msg;
494
495 if (ll < loglevel || !curses_active)
496 return;
497 switch (ll) {
498 case LL_DEBUG:
499 case LL_INFO:
500 case LL_NOTICE:
501 color = COLOR_MSG;
502 break;
503 default:
504 color = COLOR_ERRMSG;
505 }
506 PARA_VSPRINTF(fmt, msg);
507 chop(msg);
508 rb_add_entry(color, msg);
509 wrefresh(bot.win);
510 }
511
512 static void setup_signal_handling(void)
513 {
514 signal_pipe = para_signal_init();
515 para_install_sighandler(SIGINT);
516 para_install_sighandler(SIGTERM);
517 para_install_sighandler(SIGCHLD);
518 para_install_sighandler(SIGWINCH);
519 para_install_sighandler(SIGUSR1);
520 para_sigaction(SIGHUP, SIG_IGN);
521 }
522
523 __noreturn static void do_exit(int ret)
524 {
525 para_sigaction(SIGTERM, SIG_IGN);
526 kill(0, SIGTERM);
527 exit(ret);
528 }
529
530 static void shutdown_curses(void)
531 {
532 if (!curses_active)
533 return;
534 def_prog_mode();
535 curses_active = 0;
536 endwin();
537 }
538
539 __noreturn static void finish(int ret)
540 {
541 shutdown_curses();
542 do_exit(ret);
543 }
544
545 /*
546 * exit curses and print given message to stdout/stderr
547 */
548 __noreturn __printf_2_3 static void msg_n_exit(int ret, const char* fmt, ...)
549 {
550 va_list argp;
551 FILE *outfd = ret? stderr: stdout;
552
553 shutdown_curses();
554 va_start(argp, fmt);
555 vfprintf(outfd, fmt, argp);
556 va_end(argp);
557 do_exit(ret);
558 }
559
560 static void print_welcome(void)
561 {
562 if (loglevel > LL_NOTICE)
563 return;
564 outputf(COLOR_WELCOME, "Welcome to para_gui " PACKAGE_VERSION
565 " \"" CODENAME "\". Theme: %s", theme.name);
566 wclrtoeol(bot.win);
567 }
568
569 /*
570 * init all windows
571 */
572 static void init_wins(int top_lines)
573 {
574 int i;
575
576 top.lines = top_lines;
577 top.cols = COLS;
578 top.begy = 0;
579 top.begx = 0;
580
581 bot.lines = LINES - top.lines - 3;
582 bot.cols = COLS;
583 bot.begy = top.lines + 1;
584 bot.begx = 0;
585
586 sb.lines = 1;
587 sb.cols = COLS;
588 sb.begy = LINES - 2;
589 sb.begx = 0;
590
591 in.lines = 1;
592 in.cols = COLS;
593 in.begy = LINES - 1;
594 in.begx = 0;
595
596 sep.lines = 1;
597 sep.cols = COLS;
598 sep.begy = top.lines;
599 sep.begx = 0;
600
601 assume_default_colors(theme.default_fg, theme.default_bg);
602 if (top.win) {
603 mvwin(top.win, top.begy, top.begx);
604 wresize(top.win, top.lines, top.cols);
605
606 mvwin(sb.win, sb.begy, sb.begx);
607 wresize(sb.win, sb.lines, sb.cols);
608
609 mvwin(sep.win, sep.begy, sep.begx);
610 wresize(sep.win, sep.lines, sep.cols);
611
612 mvwin(bot.win, bot.begy, bot.begx);
613 wresize(bot.win, bot.lines, bot.cols);
614
615 mvwin(in.win, in.begy, in.begx);
616 wresize(in.win, in.lines, in.cols);
617 } else {
618 sep.win = newwin(sep.lines, sep.cols, sep.begy, sep.begx);
619 top.win = newwin(top.lines, top.cols, top.begy, top.begx);
620 bot.win = newwin(bot.lines, bot.cols, bot.begy, bot.begx);
621 sb.win = newwin(sb.lines, sb.cols, sb.begy, sb.begx);
622 in.win = newwin(in.lines, in.cols, in.begy, in.begx);
623 if (!top.win || !bot.win || !sb.win || !in.win || !sep.win)
624 msg_n_exit(1, "Error: Cannot create curses windows\n");
625 wclear(bot.win);
626 wclear(sb.win);
627 wclear(in.win);
628 scrollok(bot.win, 1);
629 wattron(sb.win, COLOR_PAIR(COLOR_STATUSBAR));
630 wattron(sep.win, COLOR_PAIR(COLOR_SEPARATOR));
631 wattron(bot.win, COLOR_PAIR(COLOR_BOT));
632 wattron(top.win, COLOR_PAIR(COLOR_TOP));
633 nodelay(top.win, 1);
634 nodelay(bot.win, 1);
635 nodelay(sb.win, 1);
636 nodelay(in.win, 0);
637
638 keypad(top.win, 1);
639 keypad(bot.win, 1);
640 keypad(sb.win, 1);
641 keypad(in.win, 1);
642 print_status_bar();
643 }
644 wmove(sep.win, 0, 0);
645 for (i = 1; i <= COLS; i++)
646 waddstr(sep.win, theme.sep_str);
647 wclear(top.win);
648 //wclear(bot.win);
649 wnoutrefresh(top.win);
650 wnoutrefresh(bot.win);
651 //wnoutrefresh(sb.win);
652 print_status_bar();
653 wnoutrefresh(in.win);
654 wnoutrefresh(sep.win);
655 doupdate();
656 }
657
658 static void check_geometry(void)
659 {
660 if (LINES < theme.lines_min || COLS < theme.cols_min)
661 msg_n_exit(EXIT_FAILURE, "Error: Terminal (%dx%d) too small"
662 " (need at least %dx%d)\n", COLS, LINES,
663 theme.cols_min, theme.lines_min);
664 }
665
666 /*
667 * Print stat item #i to curses window
668 */
669 static void print_stat_item(int i)
670 {
671 char *tmp;
672 struct stat_item_data d = theme.data[i];
673 char *c = stat_content[i];
674
675 if (!curses_active || !d.len || !c)
676 return;
677 tmp = make_message("%s%s%s", d.prefix, c, d.postfix);
678 wmove(top.win, d.y * top.lines / 100, d.x * COLS / 100);
679 wrefresh(top.win);
680 wattron(top.win, COLOR_PAIR(i + 1));
681 align_str(top.win, tmp, d.len * COLS / 100, d.align);
682 free(tmp);
683 wrefresh(top.win);
684 }
685
686 static int update_item(int item_num, char *buf)
687 {
688 char **c = stat_content + item_num;
689
690 free(*c);
691 if (buf && buf[0])
692 goto dup;
693 switch (item_num) {
694 case SI_ARTIST:
695 *c = para_strdup("(artist tag not set)");
696 goto print;
697 case SI_TITLE:
698 *c = para_strdup("(title tag not set)");
699 goto print;
700 case SI_YEAR:
701 *c = para_strdup("????");
702 goto print;
703 case SI_ALBUM:
704 *c = para_strdup("(album tag not set)");
705 goto print;
706 case SI_COMMENT:
707 *c = para_strdup("(comment tag not set)");
708 goto print;
709 }
710 dup:
711 *c = para_strdup(buf);
712 print:
713 print_stat_item(item_num);
714 return 1;
715 }
716
717 static int read_stat_pipe(fd_set *rfds)
718 {
719 static char *buf;
720 static int bufsize, loaded;
721 int ret, ret2;
722 size_t sz;
723
724 if (stat_pipe < 0)
725 return 0;
726 if (loaded >= bufsize) {
727 if (bufsize > 1000 * 1000) {
728 loaded = 0;
729 return 0;
730 }
731 bufsize += bufsize + 1000;
732 buf = para_realloc(buf, bufsize);
733 }
734 assert(loaded < bufsize);
735 ret = read_nonblock(stat_pipe, buf + loaded, bufsize - loaded,
736 rfds, &sz);
737 loaded += sz;
738 ret2 = for_each_stat_item(buf, loaded, update_item);
739 if (ret < 0 || ret2 < 0) {
740 loaded = 0;
741 return ret2 < 0? ret2 : ret;
742 }
743 sz = ret2; /* what is left */
744 if (sz > 0 && sz < loaded)
745 memmove(buf, buf + loaded - sz, sz);
746 loaded = sz;
747 return 1;
748 }
749
750 static void print_all_items(void)
751 {
752 int i;
753
754 if (!curses_active)
755 return;
756 FOR_EACH_STATUS_ITEM(i)
757 print_stat_item(i);
758 }
759
760 static void clear_all_items(void)
761 {
762 int i;
763
764 FOR_EACH_STATUS_ITEM(i) {
765 free(stat_content[i]);
766 stat_content[i] = para_strdup("");
767 }
768 }
769
770 static void init_colors(void)
771 {
772 int i;
773
774 if (!has_colors())
775 msg_n_exit(EXIT_FAILURE, "Error: No color term\n");
776 start_color();
777 FOR_EACH_STATUS_ITEM(i)
778 if (theme.data[i].len)
779 init_pair(i + 1, theme.data[i].fg, theme.data[i].bg);
780 init_pair(COLOR_STATUSBAR, theme.sb_fg, theme.sb_bg);
781 init_pair(COLOR_COMMAND, theme.cmd_fg, theme.cmd_bg);
782 init_pair(COLOR_OUTPUT, theme.output_fg, theme.output_bg);
783 init_pair(COLOR_MSG, theme.msg_fg, theme.msg_bg);
784 init_pair(COLOR_ERRMSG, theme.err_msg_fg, theme.err_msg_bg);
785 init_pair(COLOR_WELCOME, theme.welcome_fg, theme.welcome_bg);
786 init_pair(COLOR_SEPARATOR, theme.sep_fg, theme.sep_bg);
787 init_pair(COLOR_TOP, theme.default_fg, theme.default_bg);
788 init_pair(COLOR_BOT, theme.default_fg, theme.default_bg);
789 }
790
791 /*
792 * (re-)initialize the curses library FIXME: Error checking
793 */
794 static void init_curses(void)
795 {
796 curses_active = 1;
797 if (top.win && refresh() == ERR) { /* refesh is really needed */
798 msg_n_exit(EXIT_FAILURE, "refresh() failed\n");
799 }
800 check_geometry();
801 curs_set(0); /* make cursor invisible, ignore errors */
802 // if (noraw() == ERR);
803 // msg_n_exit(EXIT_FAILURE, "can not place terminal out of "
804 // "raw mode\n");
805 nonl(); /* tell curses not to do NL->CR/NL on output */
806 noecho(); /* don't echo input */
807 cbreak(); /* take input chars one at a time, no wait for \n */
808 //reset_prog_mode();
809 init_colors();
810 clear();
811 init_wins(theme.top_lines_default);
812 print_all_items();
813 noecho(); /* don't echo input */
814 }
815
816
817 static void check_sigchld(void)
818 {
819 int ret;
820 pid_t pid;
821 reap_next_child:
822 ret = para_reap_child(&pid);
823 if (ret <= 0)
824 return;
825 if (pid == cmd_pid) {
826 cmd_pid = 0;
827 cmd_died = 1;
828 }
829 goto reap_next_child;
830 }
831
832 /*
833 * This sucker modifies its first argument. *handler and *arg are
834 * pointers to 0-terminated strings (inside line). Crap.
835 */
836 static int split_key_map(char *line, char **handler, char **arg)
837 {
838 if (!(*handler = strchr(line + 1, ':')))
839 goto err_out;
840 **handler = '\0';
841 (*handler)++;
842 if (!(*arg = strchr(*handler, ':')))
843 goto err_out;
844 **arg = '\0';
845 (*arg)++;
846 return 1;
847 err_out:
848 return 0;
849 }
850
851 static int check_key_map_args(void)
852 {
853 char *s;
854 int i, ret = -1;
855 char *tmp = NULL, *handler, *arg;
856
857 for (i = 0; i < conf.key_map_given; ++i) {
858 s = conf.key_map_arg[i];
859 if (!(*s))
860 goto err_out;
861 free(tmp);
862 tmp = para_strdup(s);
863 if (!split_key_map(tmp, &handler, &arg))
864 goto err_out;
865 if (strlen(handler) != 1)
866 goto err_out;
867 if (*handler != 'x'
868 && *handler != 'd'
869 && *handler != 'i'
870 && *handler != 'p')
871 goto err_out;
872 if (*handler != 'i')
873 continue;
874 if (find_cmd_byname(arg) < 0)
875 goto err_out;
876 }
877 ret = 0;
878 err_out:
879 free(tmp);
880 return ret;
881 }
882
883 /*
884 * React to various signal-related events
885 */
886 static void handle_signal(int sig)
887 {
888 switch (sig) {
889 case SIGTERM:
890 msg_n_exit(EXIT_FAILURE,
891 "only the good die young (caught SIGTERM))\n");
892 return;
893 case SIGWINCH:
894 if (curses_active) {
895 shutdown_curses();
896 init_curses();
897 redraw_bot_win();
898 }
899 return;
900 case SIGINT:
901 PARA_WARNING_LOG("caught SIGINT, reset");
902 /* Nothing to do. SIGINT killed our child which gets noticed
903 * by do_select and resets everything.
904 */
905 return;
906 case SIGUSR1:
907 PARA_NOTICE_LOG("got SIGUSR1, rereading configuration");
908 com_reread_conf();
909 return;
910 case SIGCHLD:
911 check_sigchld();
912 return;
913 }
914 }
915
916 static int open_stat_pipe(void)
917 {
918 static int init = 1;
919 int ret, fds[3] = {0, 1, 0};
920 pid_t pid;
921
922 if (init)
923 init = 0;
924 else
925 /*
926 * Sleep a bit to avoid a busy loop. As the call to sleep() may
927 * be interrupted by SIGCHLD, we simply wait until the call
928 * succeeds.
929 */
930 while (sleep(2))
931 ; /* nothing */
932 ret = para_exec_cmdline_pid(&pid, conf.stat_cmd_arg, fds);
933 if (ret < 0)
934 return ret;
935 ret = mark_fd_nonblocking(fds[1]);
936 if (ret >= 0)
937 return fds[1];
938 close(fds[1]);
939 return ret;
940 }
941
942 /*
943 * This is the core select loop. Besides the (internal) signal
944 * pipe, the following other fds are checked according to the mode:
945 *
946 * GETCH_MODE: check stdin, return when key is pressed
947 *
948 * COMMAND_MODE: check command_pipe and stdin. Return when a screen full
949 * of output has been read or when other end has closed command pipe or
950 * when any key is pressed.
951 *
952 * EXTERNAL_MODE: Check only signal pipe. Used when an external command
953 * is running. During that time curses is disabled. Returns when
954 * cmd_pid == 0.
955 */
956 static int do_select(int mode)
957 {
958 fd_set rfds;
959 int ret;
960 int max_fileno;
961 char command_buf[4096] = "";
962 int cbo = 0; /* command buf offset */
963 struct timeval tv;
964 repeat:
965 tv.tv_sec = conf.timeout_arg / 1000;
966 tv.tv_usec = (conf.timeout_arg % 1000) * 1000;
967 // ret = refresh_status();
968 FD_ZERO(&rfds);
969 max_fileno = 0;
970 if (stat_pipe < 0)
971 stat_pipe = open_stat_pipe();
972 if (stat_pipe >= 0)
973 para_fd_set(stat_pipe, &rfds, &max_fileno);
974 /* signal pipe */
975 para_fd_set(signal_pipe, &rfds, &max_fileno);
976 /* command pipe only for COMMAND_MODE */
977 if (command_pipe >= 0 && mode == COMMAND_MODE)
978 para_fd_set(command_pipe, &rfds, &max_fileno);
979 ret = para_select(max_fileno + 1, &rfds, NULL, &tv);
980 if (ret <= 0)
981 goto check_return; /* skip fd checks */
982 /* signals */
983 ret = para_next_signal(&rfds);
984 if (ret > 0)
985 handle_signal(ret);
986 /* read command pipe if ready */
987 if (command_pipe >= 0 && mode == COMMAND_MODE) {
988 size_t sz;
989 ret = read_nonblock(command_pipe, command_buf + cbo,
990 sizeof(command_buf) - 1 - cbo, &rfds, &sz);
991 cbo += sz;
992 sz = cbo;
993 cbo = for_each_line(command_buf, cbo, &add_output_line, NULL);
994 if (sz != cbo)
995 wrefresh(bot.win);
996 if (ret < 0) {
997 PARA_NOTICE_LOG("closing command pipe: %s",
998 para_strerror(-ret));
999 close(command_pipe);
1000 command_pipe = -1;
1001 return 0;
1002 }
1003 }
1004 ret = read_stat_pipe(&rfds);
1005 if (ret < 0) {
1006 PARA_NOTICE_LOG("closing stat pipe: %s\n", para_strerror(-ret));
1007 close(stat_pipe);
1008 stat_pipe = -1;
1009 clear_all_items();
1010 free(stat_content[SI_BASENAME]);
1011 stat_content[SI_BASENAME] =
1012 para_strdup("stat command terminated!?");
1013 print_all_items();
1014 }
1015 check_return:
1016 switch (mode) {
1017 case COMMAND_MODE:
1018 ret = wgetch(top.win);
1019 if (ret != ERR && ret != KEY_RESIZE) {
1020 if (command_pipe) {
1021 close(command_pipe);
1022 command_pipe = -1;
1023 }
1024 if (cmd_pid)
1025 kill(cmd_pid, SIGTERM);
1026 return -1;
1027 }
1028 break;
1029 case GETCH_MODE:
1030 ret = wgetch(top.win);
1031 if (ret != ERR && ret != KEY_RESIZE)
1032 return ret;
1033 break;
1034 case EXTERNAL_MODE:
1035 if (cmd_died) {
1036 cmd_died = 0;
1037 return 0;
1038 }
1039 }
1040 goto repeat;
1041 }
1042
1043 /*
1044 * read from command pipe and print data to bot window
1045 */
1046 static int send_output(void)
1047 {
1048 int ret;
1049
1050 if (command_pipe < 0)
1051 return 0;
1052 ret = mark_fd_nonblocking(command_pipe);
1053 if (ret < 0) {
1054 close(command_pipe);
1055 return ret;
1056 }
1057 if (do_select(COMMAND_MODE) >= 0)
1058 PARA_INFO_LOG("command complete");
1059 else
1060 PARA_NOTICE_LOG("command aborted");
1061 print_in_bar(COLOR_MSG, " ");
1062 return 1;
1063 }
1064
1065 static int client_cmd_cmdline(char *cmd)
1066 {
1067 int ret, fds[3] = {0, 1, 0};
1068 char *c = make_message(BINDIR "/para_client -- %s", cmd);
1069
1070 outputf(COLOR_COMMAND, "%s", c);
1071 print_in_bar(COLOR_MSG, "executing client command, hit any key to abort\n");
1072 ret = para_exec_cmdline_pid(&cmd_pid, c, fds);
1073 free(c);
1074 if (ret < 0)
1075 return -1;
1076 command_pipe = fds[1];
1077 return send_output();
1078 }
1079
1080 /*
1081 * exec command and print output to bot win
1082 */
1083 static int display_cmd(char *cmd)
1084 {
1085 int fds[3] = {0, 1, 0};
1086
1087 print_in_bar(COLOR_MSG, "executing display command, hit any key to abort");
1088 outputf(COLOR_COMMAND, "%s", cmd);
1089 if (para_exec_cmdline_pid(&cmd_pid, cmd, fds) < 0)
1090 return -1;
1091 command_pipe = fds[1];
1092 return send_output();
1093 }
1094
1095 /*
1096 * shutdown curses and stat pipe before executing external commands
1097 */
1098 static int external_cmd(char *cmd)
1099 {
1100 int fds[3] = {-1, -1, -1};
1101
1102 if (cmd_pid)
1103 return -1;
1104 shutdown_curses();
1105 para_exec_cmdline_pid(&cmd_pid, cmd, fds);
1106 cmd_died = 0;
1107 do_select(EXTERNAL_MODE);
1108 init_curses();
1109 return 0;
1110 }
1111
1112 static void print_scroll_msg(void)
1113 {
1114 unsigned lines_total, filled = ringbuffer_filled(bot_win_rb);
1115 int first_rbe = first_visible_rbe(&lines_total);
1116 print_in_bar(COLOR_MSG, "scrolled view: %d-%d/%d\n", filled - first_rbe,
1117 filled - scroll_position, ringbuffer_filled(bot_win_rb));
1118 }
1119
1120 static void com_scroll_top(void)
1121 {
1122 int i = RINGBUFFER_SIZE - 1;
1123 unsigned lines = 0;
1124
1125 while (i > 0 && !ringbuffer_get(bot_win_rb, i))
1126 i--;
1127 /* i is oldest entry */
1128 for (; lines < bot.lines && i >= 0; i--) {
1129 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
1130 if (!rbe)
1131 break;
1132 lines += NUM_LINES(strlen(rbe->msg));
1133 }
1134 i++;
1135 if (lines > 0 && scroll_position != i) {
1136 scroll_position = i;
1137 redraw_bot_win();
1138 print_scroll_msg();
1139 return;
1140 }
1141 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1142 }
1143
1144 static void com_cancel_scrolling(void)
1145 {
1146
1147 if (scroll_position == 0) {
1148 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1149 return;
1150 }
1151 scroll_position = 0;
1152 redraw_bot_win();
1153 }
1154
1155 static void com_page_down(void)
1156 {
1157 unsigned lines = 0;
1158 int i = scroll_position;
1159 while (lines < bot.lines && --i > 0) {
1160 struct rb_entry *rbe = ringbuffer_get(bot_win_rb, i);
1161 if (!rbe)
1162 break;
1163 lines += NUM_LINES(strlen(rbe->msg));
1164 }
1165 if (lines) {
1166 scroll_position = i;
1167 redraw_bot_win();
1168 print_scroll_msg();
1169 return;
1170 }
1171 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1172 }
1173
1174 static void com_page_up(void)
1175 {
1176 unsigned lines;
1177 int fvr = first_visible_rbe(&lines);
1178
1179 if (fvr < 0 || fvr + 1 >= ringbuffer_filled(bot_win_rb)) {
1180 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1181 return;
1182 }
1183 scroll_position = fvr + 1;
1184 for (; scroll_position > 0; scroll_position--) {
1185 first_visible_rbe(&lines);
1186 if (lines == bot.lines)
1187 break;
1188 }
1189 redraw_bot_win();
1190 print_scroll_msg();
1191 }
1192
1193 static void com_scroll_down(void)
1194 {
1195 struct rb_entry *rbe;
1196 int rbe_lines;
1197
1198 if (!scroll_position) {
1199 print_in_bar(COLOR_ERRMSG, "bottom of buffer is shown\n");
1200 return;
1201 }
1202 scroll_position--;
1203 rbe = ringbuffer_get(bot_win_rb, scroll_position);
1204 rbe_lines = NUM_LINES(rbe->len);
1205 wscrl(bot.win, rbe_lines);
1206 wmove(bot.win, bot.lines - rbe_lines, 0);
1207 wattron(bot.win, COLOR_PAIR(rbe->color));
1208 waddstr(bot.win, rbe->msg);
1209 wrefresh(bot.win);
1210 print_scroll_msg();
1211 }
1212
1213 static void com_scroll_up(void)
1214 {
1215 struct rb_entry *rbe = NULL;
1216 unsigned lines;
1217 int i, first_rbe, num_scroll;
1218
1219 /* the entry that is going to vanish */
1220 rbe = ringbuffer_get(bot_win_rb, scroll_position);
1221 if (!rbe)
1222 goto err_out;
1223 num_scroll = NUM_LINES(rbe->len);
1224 first_rbe = first_visible_rbe(&lines);
1225 if (first_rbe < 0 || (first_rbe == ringbuffer_filled(bot_win_rb) - 1))
1226 goto err_out;
1227 scroll_position++;
1228 wscrl(bot.win, -num_scroll);
1229 i = draw_top_rbe(&lines);
1230 if (i < 0)
1231 goto err_out;
1232 while (i > 0 && lines < num_scroll) {
1233 int rbe_lines;
1234 rbe = ringbuffer_get(bot_win_rb, --i);
1235 if (!rbe)
1236 break;
1237 rbe_lines = NUM_LINES(rbe->len);
1238 lines += rbe_lines;
1239 // fprintf(stderr, "msg: %s\n", rbe->msg);
1240 wattron(bot.win, COLOR_PAIR(rbe->color));
1241 waddstr(bot.win, "\n");
1242 waddstr(bot.win, rbe->msg);
1243 if (!i)
1244 break;
1245 i--;
1246 }
1247 wrefresh(bot.win);
1248 print_scroll_msg();
1249 return;
1250 err_out:
1251 print_in_bar(COLOR_ERRMSG, "top of buffer is shown\n");
1252 }
1253
1254 static void com_ll_decr(void)
1255 {
1256 if (loglevel <= LL_DEBUG) {
1257 print_in_bar(COLOR_ERRMSG,
1258 "loglevel already at maximal verbosity\n");
1259 return;
1260 }
1261 loglevel--;
1262 print_in_bar(COLOR_MSG, "loglevel set to %d\n", loglevel);
1263 }
1264
1265 static void com_ll_incr(void)
1266 {
1267 if (loglevel >= LL_EMERG) {
1268 print_in_bar(COLOR_ERRMSG,
1269 "loglevel already at minimal verbosity\n");
1270 return;
1271 }
1272 loglevel++;
1273 print_in_bar(COLOR_MSG, "loglevel set to %d\n", loglevel);
1274 }
1275
1276 /*
1277 * reread configuration, terminate on errors
1278 */
1279 static void com_reread_conf(void)
1280 {
1281 char *cf =configfile_exists();
1282 struct gui_cmdline_parser_params params = {
1283 .override = 1,
1284 .initialize = 1,
1285 .check_required = 0,
1286 .check_ambiguity = 0,
1287 .print_errors = 0,
1288 };
1289
1290 if (!cf) {
1291 PARA_WARNING_LOG("there is no configuration to read");
1292 return;
1293 }
1294 PARA_INFO_LOG("rereading command line options and config file");
1295 gui_cmdline_parser_ext(_argc, _argv, &conf, &params);
1296 if (gui_cmdline_parser_config_file(cf, &conf, &params) != 0) {
1297 PARA_EMERG_LOG("errors in config file");
1298 finish(EXIT_FAILURE);
1299 }
1300 PARA_NOTICE_LOG("config file reloaded");
1301 if (check_key_map_args() < 0)
1302 finish(EXIT_FAILURE);
1303 }
1304
1305 static void com_help(void)
1306 {
1307 int i;
1308
1309 for (i = 0; i < conf.key_map_given; ++i) {
1310 char *handler, *arg, *tmp = para_strdup(conf.key_map_arg[i]);
1311 const char *handler_text = "???", *desc = NULL;
1312
1313 if (!split_key_map(tmp, &handler, &arg)) {
1314 free(tmp);
1315 return;
1316 }
1317 switch (*handler) {
1318 case 'i':
1319 handler_text = "internal";
1320 desc = command_list[find_cmd_byname(arg)].description;
1321 break;
1322 case 'x': handler_text = "external"; break;
1323 case 'd': handler_text = "display "; break;
1324 case 'p': handler_text = "para "; break;
1325 }
1326 outputf(COLOR_MSG, "%s\t%s\t%s%s\t%s", tmp, handler_text, arg,
1327 strlen(arg) < 8? "\t" : "",
1328 desc? desc : "");
1329 free(tmp);
1330 }
1331 for (i = 0; command_list[i].handler; i++) {
1332 struct gui_command gc = command_list[i];
1333
1334 outputf(COLOR_MSG, "%s\tinternal\t%s\t%s%s", gc.key, gc.name,
1335 strlen(gc.name) < 8? "\t" : "",
1336 gc.description);
1337 }
1338 print_in_bar(COLOR_MSG, "try \"para_gui -h\" or \"para_client help\" "
1339 "for more info");
1340 }
1341
1342 static void com_shrink_top_win(void)
1343 {
1344 if (top.lines <= theme.top_lines_min) {
1345 PARA_WARNING_LOG("can not decrease top window");
1346 return;
1347 }
1348 init_wins(top.lines - 1);
1349 wclear(top.win);
1350 print_all_items();
1351 print_in_bar(COLOR_MSG, "%s", "decreased top window");
1352 }
1353
1354 static void com_enlarge_top_win(void)
1355 {
1356 if (bot.lines < 3) {
1357 PARA_WARNING_LOG("can not increase top window");
1358 return;
1359 }
1360 init_wins(top.lines + 1);
1361 wclear(top.win);
1362 print_all_items();
1363 print_in_bar(COLOR_MSG, "increased top window");
1364 }
1365
1366 static void com_version(void)
1367 {
1368 print_in_bar(COLOR_MSG, "para_gui " PACKAGE_VERSION " \""
1369 CODENAME "\"");
1370 }
1371
1372 __noreturn static void com_quit(void)
1373 {
1374 finish(0);
1375 }
1376
1377 static void com_refresh(void)
1378 {
1379 shutdown_curses();
1380 init_curses();
1381 }
1382
1383 static void change_theme(int next)
1384 {
1385 if (next)
1386 next_theme(&theme);
1387 else
1388 prev_theme(&theme);
1389 /* This seems to be needed twice, why? */
1390 com_refresh();
1391 com_refresh();
1392 PARA_NOTICE_LOG("new theme: %s", theme.name);
1393 }
1394
1395 static void com_next_theme(void)
1396 {
1397 change_theme(1);
1398 }
1399
1400 static void com_prev_theme(void)
1401 {
1402 change_theme(0);
1403 }
1404
1405
1406 static void handle_command(int c)
1407 {
1408 int i;
1409
1410 /* first check user's key bindings */
1411 for (i = 0; i < conf.key_map_given; ++i) {
1412 char *tmp, *handler, *arg;
1413
1414 tmp = para_strdup(conf.key_map_arg[i]);
1415 if (!split_key_map(tmp, &handler, &arg)) {
1416 free(tmp);
1417 return;
1418 }
1419 if (strcmp(tmp, km_keyname(c))) {
1420 free(tmp);
1421 continue;
1422 }
1423 if (*handler == 'd')
1424 display_cmd(arg);
1425 else if (*handler == 'x')
1426 external_cmd(arg);
1427 else if (*handler == 'p')
1428 client_cmd_cmdline(arg);
1429 else if (*handler == 'i') {
1430 int num = find_cmd_byname(arg);
1431 if (num >= 0)
1432 command_list[num].handler();
1433 }
1434 free(tmp);
1435 return;
1436 }
1437 /* not found, check internal key bindings */
1438 for (i = 0; command_list[i].handler; i++) {
1439 if (!strcmp(km_keyname(c), command_list[i].key)) {
1440 command_list[i].handler();
1441 return;
1442 }
1443 }
1444 print_in_bar(COLOR_ERRMSG, "key '%s' is not bound, press ? for help",
1445 km_keyname(c));
1446 }
1447
1448 int main(int argc, char *argv[])
1449 {
1450 int ret;
1451 char *cf;
1452
1453 _argc = argc;
1454 _argv = argv;
1455
1456 if (gui_cmdline_parser(argc, argv, &conf) != 0)
1457 exit(EXIT_FAILURE);
1458 HANDLE_VERSION_FLAG("gui", conf);
1459 cf = configfile_exists();
1460 if (!cf && conf.config_file_given) {
1461 fprintf(stderr, "can not read config file %s\n",
1462 conf.config_file_arg);
1463 exit(EXIT_FAILURE);
1464 }
1465 if (cf) {
1466 struct gui_cmdline_parser_params params = {
1467 .override = 0,
1468 .initialize = 0,
1469 .check_required = 0,
1470 .check_ambiguity = 0,
1471 .print_errors = 1,
1472 };
1473 if (gui_cmdline_parser_config_file(cf, &conf, &params) != 0)
1474 exit(EXIT_FAILURE);
1475 }
1476 loglevel = get_loglevel_by_name(conf.loglevel_arg);
1477 if (check_key_map_args() < 0) {
1478 fprintf(stderr, "invalid key map\n");
1479 exit(EXIT_FAILURE);
1480 }
1481 init_theme_or_die(conf.theme_arg, &theme);
1482 top.lines = theme.top_lines_default;
1483 setup_signal_handling();
1484 bot_win_rb = ringbuffer_new(RINGBUFFER_SIZE);
1485 initscr(); /* needed only once, always successful */
1486 init_curses();
1487 print_welcome();
1488 for (;;) {
1489 print_status_bar();
1490 ret = do_select(GETCH_MODE);
1491 if (!ret)
1492 continue;
1493 print_in_bar(COLOR_MSG, " ");
1494 handle_command(ret);
1495 }
1496 }