btr: Remove btr_free_node().
[paraslash.git] / interactive.c
1 /*
2 * Copyright (C) 2011-2012 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file interactive.c Readline abstraction for interactive sessions. */
8
9 #include <regex.h>
10 #include <stdbool.h>
11 #include <curses.h>
12 #include <readline/readline.h>
13 #include <readline/history.h>
14 #include <sys/ioctl.h>
15 #include <assert.h>
16 #include <signal.h>
17
18 #include "para.h"
19 #include "fd.h"
20 #include "buffer_tree.h"
21 #include "list.h"
22 #include "sched.h"
23 #include "interactive.h"
24 #include "string.h"
25 #include "error.h"
26
27 struct i9e_private {
28 struct i9e_client_info *ici;
29 FILE *stderr_stream;
30 char empty_line[1000];
31 struct task task;
32 struct btr_node *stdout_btrn;
33 bool line_handler_running;
34 bool input_eof;
35 bool caught_sigint;
36 };
37 static struct i9e_private i9e_private, *i9ep = &i9e_private;
38
39 static bool is_prefix(const char *partial, const char *full, size_t len)
40 {
41 if (len == 0)
42 len = strlen(partial);
43 return !strncmp(partial, full, len);
44 }
45
46 /*
47 * Generator function for command completion. STATE lets us know whether
48 * to start from scratch; without any state (i.e. STATE == 0), then we
49 * start at the top of the list.
50 */
51 static char *command_generator(const char *text, int state)
52 {
53 static int list_index, len;
54 const char *name;
55 struct i9e_client_info *ici = i9ep->ici;
56
57 rl_attempted_completion_over = 1; /* disable filename completion */
58 /*
59 * If this is a new word to complete, initialize now. This includes
60 * saving the length of TEXT for efficiency, and initializing the index
61 * variable to 0.
62 */
63 if (state == 0) {
64 list_index = 0;
65 len = strlen(text);
66 }
67 /* Return the next name which partially matches from the command list. */
68 while ((name = ici->completers[list_index].name)) {
69 list_index++;
70 if (is_prefix(text, name, len))
71 return para_strdup(name);
72 }
73 return NULL; /* no names matched */
74 }
75
76 static void reset_completion_result(struct i9e_completion_result *cr)
77 {
78 cr->dont_append_space = false;
79 cr->filename_completion_desired = false;
80 cr->matches = NULL;
81 }
82
83 static void create_matches(struct i9e_completion_info *ci,
84 struct i9e_completer *completers,
85 struct i9e_completion_result *cr)
86 {
87 int i, ret;
88
89 reset_completion_result(cr);
90
91 ret = create_argv(ci->buffer, " ", &ci->argv);
92 if (ret < 0 || !ci->argv[0])
93 return;
94
95 ci->argc = ret;
96 ci->word_num = compute_word_num(ci->buffer, " ", ci->point);
97 for (i = 0; completers[i].name; i++) {
98 if (strcmp(completers[i].name, ci->argv[0]) != 0)
99 continue;
100 completers[i].completer(ci, cr);
101 break;
102 }
103 PARA_DEBUG_LOG("current word: %d (%s)\n", ci->word_num,
104 ci->argv[ci->word_num]);
105 if (cr->matches)
106 for (i = 0; cr->matches[i]; i++)
107 PARA_DEBUG_LOG("match %d: %s\n", i, cr->matches[i]);
108 }
109
110 static char *completion_generator(const char *word, int state)
111 {
112 static int list_index;
113 static char **argv, **matches;
114 struct i9e_completer *completers = i9ep->ici->completers;
115 struct i9e_completion_info ci = {
116 .word = (char *)word,
117 .point = rl_point,
118 .buffer = rl_line_buffer,
119 };
120 struct i9e_completion_result cr = {.matches = NULL};
121
122 if (state != 0)
123 goto out;
124 /* clean up previous matches and set defaults */
125 free(matches);
126 matches = NULL;
127 free_argv(argv);
128 argv = NULL;
129 list_index = 0;
130 rl_completion_append_character = ' ';
131 rl_completion_suppress_append = false;
132 rl_attempted_completion_over = true;
133
134 create_matches(&ci, completers, &cr);
135
136 matches = cr.matches;
137 argv = ci.argv;
138 rl_completion_suppress_append = cr.dont_append_space;
139 rl_attempted_completion_over = !cr.filename_completion_desired;
140 out:
141 if (!matches)
142 return NULL;
143 return matches[list_index++];
144 }
145
146 /*
147 * Attempt to complete on the contents of TEXT. START and END bound the
148 * region of rl_line_buffer that contains the word to complete. TEXT is
149 * the word to complete. We can use the entire contents of rl_line_buffer
150 * in case we want to do some simple parsing. Return the array of matches,
151 * or NULL if there aren't any.
152 */
153 static char **i9e_completer(const char *text, int start, __a_unused int end)
154 {
155 struct i9e_client_info *ici = i9ep->ici;
156
157 if (!ici->completers)
158 return NULL;
159 /* Complete on command names if this is the first word in the line. */
160 if (start == 0)
161 return rl_completion_matches(text, command_generator);
162 return rl_completion_matches(text, completion_generator);
163 }
164
165 /**
166 * Prepare writing to stdout.
167 *
168 * \param producer The buffer tree node which produces output.
169 *
170 * The i9e subsystem maintains a buffer tree node which may be attached to
171 * another node which generates output (a "producer"). When attached, the i9e
172 * buffer tree node copies the buffers generated by the producer to stdout.
173 *
174 * This function attaches the i9e input queue to an output queue of \a
175 * producer.
176 *
177 * \return Standard.
178 */
179 void i9e_attach_to_stdout(struct btr_node *producer)
180 {
181 assert(!i9ep->stdout_btrn);
182 i9ep->stdout_btrn = btr_new_node(&(struct btr_node_description)
183 EMBRACE(.name = "interactive_stdout", .parent = producer));
184 }
185
186 /**
187 * Reset the terminal and save the in-memory command line history.
188 *
189 * This should be called before the caller exits.
190 */
191 void i9e_close(void)
192 {
193 char *hf = i9ep->ici->history_file;
194
195 rl_deprep_terminal();
196 fprintf(i9ep->stderr_stream, "\n");
197 if (hf)
198 write_history(hf);
199 fclose(i9ep->stderr_stream);
200 }
201
202 static void wipe_bottom_line(void)
203 {
204 fprintf(i9ep->stderr_stream, "\r%s\r", i9ep->empty_line);
205 }
206
207 static void clear_bottom_line(void)
208 {
209 int point;
210 char *text;
211
212 if (rl_point == 0 && rl_end == 0)
213 return wipe_bottom_line();
214 /*
215 * We might have a multi-line input that needs to be wiped here, so the
216 * simple printf("\r<space>\r") is insufficient. To workaround this, we
217 * remove the whole line, redisplay and restore the killed text.
218 */
219 point = rl_point;
220 text = rl_copy_text(0, rl_end);
221 rl_kill_full_line(0, 0);
222 rl_redisplay();
223 wipe_bottom_line(); /* wipe out the prompt */
224 rl_insert_text(text);
225 rl_point = point;
226 }
227
228 static bool input_available(void)
229 {
230 fd_set rfds;
231 struct timeval tv = {0, 0};
232 int ret;
233
234 FD_ZERO(&rfds);
235 FD_SET(i9ep->ici->fds[0], &rfds);
236 ret = para_select(1, &rfds, NULL, &tv);
237 return ret > 0;
238 }
239
240 static void i9e_line_handler(char *line)
241 {
242 int ret;
243
244 i9ep->line_handler_running = true;
245 ret = i9ep->ici->line_handler(line);
246 i9ep->line_handler_running = false;
247 if (ret < 0)
248 PARA_WARNING_LOG("%s\n", para_strerror(-ret));
249 rl_set_prompt("");
250 if (line) {
251 if (!*line)
252 rl_set_prompt(i9ep->ici->prompt);
253 else
254 add_history(line);
255 free(line);
256 } else {
257 rl_set_prompt("");
258 i9ep->input_eof = true;
259 }
260 }
261
262 static void i9e_input(void)
263 {
264 do {
265 rl_callback_read_char();
266 } while (input_available());
267 }
268
269 static void i9e_post_select(struct sched *s, struct task *t)
270 {
271 int ret;
272 struct btr_node *btrn = i9ep->stdout_btrn;
273 struct i9e_client_info *ici = i9ep->ici;
274 char *buf;
275 size_t sz;
276
277 if (i9ep->input_eof) {
278 t->error = -E_I9E_EOF;
279 return;
280 }
281 if (!btrn) {
282 i9ep->caught_sigint = false;
283 if (FD_ISSET(ici->fds[0], &s->rfds))
284 i9e_input();
285 return;
286 }
287 if (i9ep->caught_sigint)
288 goto rm_btrn;
289 ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
290 if (ret < 0)
291 goto rm_btrn;
292 sz = btr_next_buffer(btrn, &buf);
293 if (sz == 0)
294 goto out;
295 ret = xwrite(ici->fds[1], buf, sz);
296 if (ret < 0)
297 goto rm_btrn;
298 btr_consume(btrn, ret);
299 goto out;
300 rm_btrn:
301 btr_remove_node(&i9ep->stdout_btrn);
302 rl_set_prompt(i9ep->ici->prompt);
303 rl_forced_update_display();
304 out:
305 t->error = 0;
306 }
307
308 static void i9e_pre_select(struct sched *s, __a_unused struct task *t)
309 {
310 int ret;
311
312 if (i9ep->input_eof || i9ep->caught_sigint) {
313 sched_min_delay(s);
314 return;
315 }
316 if (i9ep->stdout_btrn) {
317 ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
318 if (ret < 0) {
319 sched_min_delay(s);
320 return;
321 }
322 if (ret > 0)
323 para_fd_set(i9ep->ici->fds[1], &s->wfds, &s->max_fileno);
324 }
325 /*
326 * fd[0] might have been reset to blocking mode if our job was moved to
327 * the background due to CTRL-Z or SIGSTOP, so set the fd back to
328 * nonblocking mode.
329 */
330 ret = mark_fd_nonblocking(i9ep->ici->fds[0]);
331 if (ret < 0)
332 PARA_WARNING_LOG("set to nonblock failed: (fd0 %d, %s)\n",
333 i9ep->ici->fds[0], para_strerror(-ret));
334 para_fd_set(i9ep->ici->fds[0], &s->rfds, &s->max_fileno);
335 }
336
337 static void update_winsize(void)
338 {
339 struct winsize w;
340 int ret = ioctl(i9ep->ici->fds[2], TIOCGWINSZ, (char *)&w);
341 int num_columns = 80;
342
343 if (ret >= 0) {
344 assert(w.ws_col < sizeof(i9ep->empty_line));
345 num_columns = w.ws_col;
346 }
347 memset(i9ep->empty_line, ' ', num_columns);
348 i9ep->empty_line[num_columns] = '\0';
349 }
350
351 /**
352 * Register the i9e task and initialize readline.
353 *
354 * \param ici The i9e configuration parameters set by the caller.
355 * \param s The scheduler instance to add the i9e task to.
356 *
357 * The caller must allocate and initialize the structure \a ici points to.
358 *
359 * \return Standard.
360 * \sa \ref register_task().
361 */
362 int i9e_open(struct i9e_client_info *ici, struct sched *s)
363 {
364 int ret;
365
366 if (!isatty(ici->fds[0]))
367 return -E_I9E_SETUPTERM;
368 ret = mark_fd_nonblocking(ici->fds[0]);
369 if (ret < 0)
370 return ret;
371 ret = mark_fd_nonblocking(ici->fds[1]);
372 if (ret < 0)
373 return ret;
374 i9ep->task.pre_select = i9e_pre_select;
375 i9ep->task.post_select = i9e_post_select;
376 sprintf(i9ep->task.status, "i9e");
377 register_task(s, &i9ep->task);
378 rl_readline_name = "para_i9e";
379 rl_basic_word_break_characters = " ";
380 rl_attempted_completion_function = i9e_completer;
381 i9ep->ici = ici;
382 i9ep->stderr_stream = fdopen(ici->fds[2], "w");
383 setvbuf(i9ep->stderr_stream, NULL, _IONBF, 0);
384
385 if (ici->history_file)
386 read_history(ici->history_file);
387 update_winsize();
388 rl_callback_handler_install(i9ep->ici->prompt, i9e_line_handler);
389 return 1;
390 }
391
392 static void reset_line_state(void)
393 {
394 if (i9ep->line_handler_running)
395 return;
396 rl_on_new_line();
397 rl_reset_line_state();
398 rl_forced_update_display();
399 }
400
401 /**
402 * The log function of the i9e subsystem.
403 *
404 * \param ll Severity log level.
405 * \param fmt Printf-like format string.
406 *
407 * This clears the bottom line of the terminal if necessary and writes the
408 * string given by \a fmt to fd[2], where fd[] is the array provided earlier in
409 * \ref i9e_open().
410 */
411 __printf_2_3 void i9e_log(int ll, const char* fmt,...)
412 {
413 va_list argp;
414
415 if (ll < i9ep->ici->loglevel)
416 return;
417 if (i9ep->line_handler_running == false)
418 clear_bottom_line();
419 va_start(argp, fmt);
420 vfprintf(i9ep->stderr_stream, fmt, argp);
421 va_end(argp);
422 reset_line_state();
423 }
424
425 /**
426 * Tell i9e that the caller received a signal.
427 *
428 * \param sig_num The number of the signal received.
429 *
430 * Currently the function only cares about \p SIGINT, but this may change.
431 */
432 void i9e_signal_dispatch(int sig_num)
433 {
434 if (sig_num == SIGINT) {
435 fprintf(i9ep->stderr_stream, "\n");
436 rl_replace_line ("", false /* clear_undo */);
437 reset_line_state();
438 i9ep->caught_sigint = true;
439 }
440 }
441
442 /**
443 * Wrapper for select(2) which does not restart on interrupts.
444 *
445 * \param n \sa \ref para_select().
446 * \param readfds \sa \ref para_select().
447 * \param writefds \sa \ref para_select().
448 * \param timeout_tv \sa \ref para_select().
449 *
450 * \return \sa \ref para_select().
451 *
452 * The only difference between this function and \ref para_select() is that
453 * \ref i9e_select() returns zero if the select call returned \p EINTR.
454 */
455 int i9e_select(int n, fd_set *readfds, fd_set *writefds,
456 struct timeval *timeout_tv)
457 {
458 int ret = select(n, readfds, writefds, NULL, timeout_tv);
459
460 if (ret < 0) {
461 if (errno == EINTR)
462 ret = 0;
463 else
464 ret = -ERRNO_TO_PARA_ERROR(errno);
465 }
466 return ret;
467 }
468
469 /**
470 * Return the possible completions for a given word.
471 *
472 * \param word The word to complete.
473 * \param string_list All possible words in this context.
474 * \param result String list is returned here.
475 *
476 * This function never fails. If no completion was found, a string list of
477 * length zero is returned. In any case, the result must be freed by the caller
478 * using \ref free_argv().
479 *
480 * This function is independent of readline and may be called before
481 * i9e_open().
482 *
483 * \return The number of possible completions.
484 */
485 int i9e_extract_completions(const char *word, char **string_list,
486 char ***result)
487 {
488 char **matches = para_malloc(sizeof(char *));
489 int match_count = 0, matches_len = 1;
490 char **p;
491 int len = strlen(word);
492
493 for (p = string_list; *p; p++) {
494 if (!is_prefix(word, *p, len))
495 continue;
496 match_count++;
497 if (match_count >= matches_len) {
498 matches_len *= 2;
499 matches = para_realloc(matches,
500 matches_len * sizeof(char *));
501 }
502 matches[match_count - 1] = para_strdup(*p);
503 }
504 matches[match_count] = NULL;
505 *result = matches;
506 return match_count;
507 }
508
509 /**
510 * Return the list of partially matching words.
511 *
512 * \param word The command to complete.
513 * \param completers The array containing all command names.
514 *
515 * This is similar to \ref i9e_extract_completions(), but completes on the
516 * command names in \a completers.
517 *
518 * \return See \ref i9e_extract_completions().
519 */
520 char **i9e_complete_commands(const char *word, struct i9e_completer *completers)
521 {
522 char **matches;
523 const char *cmd;
524 int i, match_count, len = strlen(word);
525
526 /*
527 * In contrast to completing against an arbitrary string list, here we
528 * know all possible completions and expect that there will not be many
529 * of them. So it should be OK to iterate twice over all commands which
530 * simplifies the code a bit.
531 */
532 for (i = 0, match_count = 0; (cmd = completers[i].name); i++) {
533 if (is_prefix(word, cmd, len))
534 match_count++;
535 }
536 matches = para_malloc((match_count + 1) * sizeof(*matches));
537 for (i = 0, match_count = 0; (cmd = completers[i].name); i++)
538 if (is_prefix(word, cmd, len))
539 matches[match_count++] = para_strdup(cmd);
540 matches[match_count] = NULL;
541 return matches;
542 }
543
544 /**
545 * Complete according to the given options.
546 *
547 * \param opts All available options.
548 * \param ci Information which was passed to the completer.
549 * \param cr Result pointer.
550 *
551 * This convenience helper can be used to complete an option. The array of all
552 * possible options is passed as the first argument. Flags, i.e. options
553 * without an argument, are expected to be listed as strings of type "-X" in \a
554 * opts while options which require an argument should be passed with a
555 * trailing "=" character like "-X=".
556 *
557 * If the word can be uniquely completed to a flag option, an additional space
558 * character is appended to the output. For non-flag options no space character
559 * is appended.
560 */
561 void i9e_complete_option(char **opts, struct i9e_completion_info *ci,
562 struct i9e_completion_result *cr)
563 {
564 int num_matches;
565
566 num_matches = i9e_extract_completions(ci->word, opts, &cr->matches);
567 if (num_matches == 1) {
568 char *opt = cr->matches[0];
569 char c = opt[strlen(opt) - 1];
570 if (c == '=')
571 cr->dont_append_space = true;
572 }
573 }
574
575 /**
576 * Print possible completions to stdout.
577 *
578 * \param completers The array of completion functions.
579 *
580 * At the end of the output a line starting with "-o=", followed by the
581 * (possibly empty) list of completion options is printed. Currently, the only
582 * two completion options are "nospace" and "filenames". The former indicates
583 * that no space should be appended even for a unique match while the latter
584 * indicates that usual filename completion should be performed in addition to
585 * the previously printed options.
586 *
587 * \return Standard.
588 */
589 int i9e_print_completions(struct i9e_completer *completers)
590 {
591 struct i9e_completion_result cr;
592 struct i9e_completion_info ci;
593 char *buf;
594 const char *end, *p;
595 int i, n, ret;
596
597 reset_completion_result(&cr);
598 buf = getenv("COMP_POINT");
599 ci.point = buf? atoi(buf) : 0;
600 ci.buffer = para_strdup(getenv("COMP_LINE"));
601
602 ci.argc = create_argv(ci.buffer, " ", &ci.argv);
603 ci.word_num = compute_word_num(ci.buffer, " ", ci.point);
604
605 end = ci.buffer + ci.point;
606 for (p = end; p > ci.buffer && *p != ' '; p--)
607 ; /* nothing */
608 if (*p == ' ')
609 p++;
610
611 n = end - p + 1;
612 ci.word = para_malloc(n + 1);
613 strncpy(ci.word, p, n);
614 ci.word[n] = '\0';
615
616 PARA_DEBUG_LOG("line: %s, point: %d (%c), wordnum: %d, word: %s\n",
617 ci.buffer, ci.point, ci.buffer[ci.point], ci.word_num, ci.word);
618 if (ci.word_num == 0)
619 cr.matches = i9e_complete_commands(ci.word, completers);
620 else
621 create_matches(&ci, completers, &cr);
622 ret = 0;
623 if (cr.matches && cr.matches[0]) {
624 for (i = 0; cr.matches[i]; i++)
625 printf("%s\n", cr.matches[i]);
626 ret = 1;
627 }
628 printf("-o=");
629 if (cr.dont_append_space)
630 printf("nospace");
631 if (cr.filename_completion_desired)
632 printf(",filenames");
633 printf("\n");
634 free_argv(cr.matches);
635 free_argv(ci.argv);
636 free(ci.buffer);
637 free(ci.word);
638 return ret;
639 }