2 * Copyright (C) 2011 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file interactive.c Readline abstraction for interactive sessions. */
12 #include <readline/readline.h>
13 #include <readline/history.h>
14 #include <sys/ioctl.h>
18 #include "buffer_tree.h"
21 #include "interactive.h"
26 struct i9e_client_info *ici;
30 char empty_line[1000];
31 char key_sequence[32];
32 unsigned key_sequence_length;
34 struct btr_node *stdout_btrn;
35 bool last_write_was_status;
42 static struct i9e_private i9e_private, *i9ep = &i9e_private;
45 * Return the error state of the i9e task.
47 * This is mainly useful for other tasks to tell whether the i9e task is still
50 * \return A negative return value of zero means the i9e task terminated. Only
51 * in this case it is safe to call ie9_close().
53 int i9e_get_error(void)
55 return task_status(i9ep->task);
58 static bool is_prefix(const char *partial, const char *full, size_t len)
61 len = strlen(partial);
62 return !strncmp(partial, full, len);
66 * Generator function for command completion. STATE lets us know whether
67 * to start from scratch; without any state (i.e. STATE == 0), then we
68 * start at the top of the list.
70 static char *command_generator(const char *text, int state)
72 static int list_index, len;
74 struct i9e_client_info *ici = i9ep->ici;
76 rl_attempted_completion_over = 1; /* disable filename completion */
78 * If this is a new word to complete, initialize now. This includes
79 * saving the length of TEXT for efficiency, and initializing the index
86 /* Return the next name which partially matches from the command list. */
87 while ((name = ici->completers[list_index].name)) {
89 if (is_prefix(text, name, len))
90 return para_strdup(name);
92 return NULL; /* no names matched */
95 static void reset_completion_result(struct i9e_completion_result *cr)
97 cr->dont_append_space = false;
98 cr->filename_completion_desired = false;
102 static void create_matches(struct i9e_completion_info *ci,
103 struct i9e_completer *completers,
104 struct i9e_completion_result *cr)
108 reset_completion_result(cr);
110 ret = create_argv(ci->buffer, " ", &ci->argv);
111 if (ret < 0 || !ci->argv[0])
115 ci->word_num = compute_word_num(ci->buffer, " ", ci->point);
116 for (i = 0; completers[i].name; i++) {
117 if (strcmp(completers[i].name, ci->argv[0]) != 0)
119 completers[i].completer(ci, cr);
122 PARA_DEBUG_LOG("current word: %d (%s)\n", ci->word_num,
123 ci->argv[ci->word_num]);
125 for (i = 0; cr->matches[i]; i++)
126 PARA_DEBUG_LOG("match %d: %s\n", i, cr->matches[i]);
129 static char *completion_generator(const char *word, int state)
131 static int list_index;
132 static char **argv, **matches;
133 struct i9e_completer *completers = i9ep->ici->completers;
134 struct i9e_completion_info ci = {
135 .word = (char *)word,
137 .buffer = rl_line_buffer,
139 struct i9e_completion_result cr = {.matches = NULL};
143 /* clean up previous matches and set defaults */
149 rl_completion_append_character = ' ';
150 rl_completion_suppress_append = false;
151 rl_attempted_completion_over = true;
153 create_matches(&ci, completers, &cr);
155 matches = cr.matches;
157 rl_completion_suppress_append = cr.dont_append_space;
158 rl_attempted_completion_over = !cr.filename_completion_desired;
162 return matches[list_index++];
166 * Attempt to complete on the contents of TEXT. START and END bound the
167 * region of rl_line_buffer that contains the word to complete. TEXT is
168 * the word to complete. We can use the entire contents of rl_line_buffer
169 * in case we want to do some simple parsing. Return the array of matches,
170 * or NULL if there aren't any.
172 static char **i9e_completer(const char *text, int start, __a_unused int end)
174 struct i9e_client_info *ici = i9ep->ici;
176 if (!ici->completers)
178 /* Complete on command names if this is the first word in the line. */
180 return rl_completion_matches(text, command_generator);
181 return rl_completion_matches(text, completion_generator);
185 * Prepare writing to stdout.
187 * \param producer The buffer tree node which produces output.
189 * The i9e subsystem maintains a buffer tree node which may be attached to
190 * another node which generates output (a "producer"). When attached, the i9e
191 * buffer tree node copies the buffers generated by the producer to stdout.
193 * This function attaches the i9e input queue to an output queue of \a
198 void i9e_attach_to_stdout(struct btr_node *producer)
200 btr_remove_node(&i9ep->stdout_btrn);
201 i9ep->stdout_btrn = btr_new_node(&(struct btr_node_description)
202 EMBRACE(.name = "interactive_stdout", .parent = producer));
203 rl_set_keymap(i9ep->bare_km);
206 static void wipe_bottom_line(void)
208 fprintf(i9ep->stderr_stream, "\r%s\r", i9ep->empty_line);
211 #ifndef RL_FREE_KEYMAP_DECLARED
213 * Free all storage associated with a keymap.
215 * This function is not declared in the readline headers although the symbol is
216 * exported and the function is documented in the readline info file. So we
217 * have to declare it here.
219 * \param keymap The keymap to deallocate.
221 void rl_free_keymap(Keymap keymap);
225 * Reset the terminal and save the in-memory command line history.
227 * This should be called before the caller exits.
231 char *hf = i9ep->ici->history_file;
233 rl_free_keymap(i9ep->bare_km);
234 rl_callback_handler_remove();
240 static void clear_bottom_line(void)
245 if (rl_point == 0 && rl_end == 0)
246 return wipe_bottom_line();
248 * We might have a multi-line input that needs to be wiped here, so the
249 * simple printf("\r<space>\r") is insufficient. To workaround this, we
250 * remove the whole line, redisplay and restore the killed text.
253 text = rl_copy_text(0, rl_end);
254 rl_kill_full_line(0, 0);
256 wipe_bottom_line(); /* wipe out the prompt */
257 rl_insert_text(text);
262 static bool input_available(void)
265 struct timeval tv = {0, 0};
269 FD_SET(i9ep->ici->fds[0], &rfds);
270 ret = para_select(1, &rfds, NULL, &tv);
274 static void i9e_line_handler(char *line)
277 struct btr_node *dummy;
280 i9ep->input_eof = true;
286 dummy = btr_new_node(&(struct btr_node_description)
287 EMBRACE(.name = "dummy line handler"));
288 i9e_attach_to_stdout(dummy);
289 ret = i9ep->ici->line_handler(line);
291 PARA_WARNING_LOG("%s\n", para_strerror(-ret));
293 btr_remove_node(&dummy);
298 static int i9e_post_select(__a_unused struct sched *s, __a_unused void *context)
301 struct i9e_client_info *ici = i9ep->ici;
303 size_t sz, consumed = 0;
308 ret = -E_I9E_TERM_RQ;
309 if (i9ep->caught_sigterm)
312 if (i9ep->caught_sigint)
314 while (input_available()) {
315 if (i9ep->stdout_btrn) {
316 unsigned len = i9ep->key_sequence_length;
317 assert(len < sizeof(i9ep->key_sequence) - 1);
318 buf = i9ep->key_sequence + len;
319 ret = read(i9ep->ici->fds[0], buf, 1);
321 ret = -ERRNO_TO_PARA_ERROR(errno);
328 i9ep->key_sequence_length++;
329 rl_stuff_char((int)(unsigned char)*buf);
331 rl_callback_read_char();
334 if (!i9ep->stdout_btrn)
336 ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
344 sz = btr_next_buffer(i9ep->stdout_btrn, &buf);
347 if (i9ep->last_write_was_status)
348 fprintf(i9ep->stderr_stream, "\n");
349 i9ep->last_write_was_status = false;
350 ret = xwrite(ici->fds[1], buf, sz);
353 btr_consume(i9ep->stdout_btrn, ret);
355 if (ret == sz && consumed < 10000)
359 if (i9ep->stdout_btrn) {
361 btr_remove_node(&i9ep->stdout_btrn);
362 rl_set_keymap(i9ep->standard_km);
363 rl_set_prompt(i9ep->ici->prompt);
369 i9ep->caught_sigint = false;
373 static void i9e_pre_select(struct sched *s, __a_unused void *context)
377 if (i9ep->input_eof || i9ep->caught_sigint || i9ep->caught_sigterm) {
381 if (i9ep->stdout_btrn) {
382 ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
388 para_fd_set(i9ep->ici->fds[1], &s->wfds, &s->max_fileno);
391 * fd[0] might have been reset to blocking mode if our job was moved to
392 * the background due to CTRL-Z or SIGSTOP, so set the fd back to
395 ret = mark_fd_nonblocking(i9ep->ici->fds[0]);
397 PARA_WARNING_LOG("set to nonblock failed: (fd0 %d, %s)\n",
398 i9ep->ici->fds[0], para_strerror(-ret));
399 para_fd_set(i9ep->ici->fds[0], &s->rfds, &s->max_fileno);
402 static void update_winsize(void)
405 int ret = ioctl(i9ep->ici->fds[2], TIOCGWINSZ, (char *)&w);
408 assert(w.ws_col < sizeof(i9ep->empty_line));
409 i9ep->num_columns = w.ws_col;
411 i9ep->num_columns = 80;
413 memset(i9ep->empty_line, ' ', i9ep->num_columns);
414 i9ep->empty_line[i9ep->num_columns] = '\0';
417 static int dispatch_key(__a_unused int count, __a_unused int key)
422 if (i9ep->key_sequence_length == 0)
424 for (i = i9ep->num_key_bindings - 1; i >= 0; i--) {
425 if (strcmp(i9ep->key_sequence, i9ep->ici->bound_keyseqs[i]))
427 i9ep->key_sequence[0] = '\0';
428 i9ep->key_sequence_length = 0;
429 ret = i9ep->ici->key_handler(i);
430 return ret < 0? ret : 0;
432 PARA_WARNING_LOG("ignoring key %d\n", i9ep->key_sequence[0]);
434 * We received an undefined key sequence. Throw away the first byte,
435 * and try to parse the remainder.
437 memmove(i9ep->key_sequence, i9ep->key_sequence + 1,
438 i9ep->key_sequence_length); /* move also terminating zero byte */
439 i9ep->key_sequence_length--;
444 * Register the i9e task and initialize readline.
446 * \param ici The i9e configuration parameters set by the caller.
447 * \param s The scheduler instance to add the i9e task to.
449 * The caller must allocate and initialize the structure \a ici points to.
453 int i9e_open(struct i9e_client_info *ici, struct sched *s)
457 memset(i9ep, 0, sizeof(struct i9e_private));
458 if (!isatty(ici->fds[0]))
459 return -E_I9E_SETUPTERM;
460 ret = mark_fd_nonblocking(ici->fds[0]);
463 ret = mark_fd_nonblocking(ici->fds[1]);
466 i9ep->task = task_register(&(struct task_info) {
468 .pre_select = i9e_pre_select,
469 .post_select = i9e_post_select,
473 rl_readline_name = "para_i9e";
474 rl_basic_word_break_characters = " ";
475 rl_attempted_completion_function = i9e_completer;
477 i9ep->stderr_stream = fdopen(ici->fds[2], "w");
478 setvbuf(i9ep->stderr_stream, NULL, _IONBF, 0);
480 i9ep->standard_km = rl_get_keymap();
481 i9ep->bare_km = rl_make_bare_keymap();
482 if (ici->bound_keyseqs) {
485 /* bind each key sequence to our dispatcher */
486 for (i = 0; (seq = ici->bound_keyseqs[i]); i++) {
487 if (strlen(seq) >= sizeof(i9ep->key_sequence) - 1) {
488 PARA_WARNING_LOG("ignoring overlong key %s\n",
492 if (rl_bind_keyseq_in_map(seq,
493 dispatch_key, i9ep->bare_km) != 0)
494 PARA_WARNING_LOG("could not bind #%d: %s\n", i, seq);
496 i9ep->num_key_bindings = i;
498 if (ici->history_file)
499 read_history(ici->history_file);
502 rl_callback_handler_install("", i9e_line_handler);
503 i9e_attach_to_stdout(ici->producer);
505 rl_callback_handler_install(i9ep->ici->prompt, i9e_line_handler);
509 static void reset_line_state(void)
511 if (i9ep->stdout_btrn)
514 rl_reset_line_state();
515 rl_forced_update_display();
519 * The log function of the i9e subsystem.
521 * \param ll Severity log level.
522 * \param fmt Printf-like format string.
524 * This clears the bottom line of the terminal if necessary and writes the
525 * string given by \a fmt to fd[2], where fd[] is the array provided earlier in
528 __printf_2_3 void i9e_log(int ll, const char* fmt,...)
532 if (ll < i9ep->ici->loglevel)
536 vfprintf(i9ep->stderr_stream, fmt, argp);
539 i9ep->last_write_was_status = false;
543 * Print the current status to stderr.
545 * \param buf The text to print.
546 * \param len The number of bytes in \a buf.
548 * This clears the bottom line, moves to the beginning of the line and prints
549 * the given text. If the length of this text exceeds the width of the
550 * terminal, the text is shortened by leaving out a part in the middle.
552 void ie9_print_status_bar(char *buf, unsigned len)
554 size_t x = i9ep->num_columns, y = (x - 4) / 2;
559 fprintf(i9ep->stderr_stream, "\r%s", buf);
560 fprintf(i9ep->stderr_stream, " .. ");
561 fprintf(i9ep->stderr_stream, "%s", buf + len - y);
567 strcpy(scratch + 1, buf);
568 memset(scratch + 1 + len, ' ', y);
569 scratch[1 + len + y] = '\r';
570 scratch[2 + len + y] = '\0';
571 fprintf(i9ep->stderr_stream, "\r%s", scratch);
573 i9ep->last_write_was_status = true;
577 * Tell i9e that the caller received a signal.
579 * \param sig_num The number of the signal received.
581 void i9e_signal_dispatch(int sig_num)
583 if (sig_num == SIGWINCH)
584 return update_winsize();
585 if (sig_num == SIGINT) {
586 fprintf(i9ep->stderr_stream, "\n");
587 rl_replace_line ("", false /* clear_undo */);
589 i9ep->caught_sigint = true;
591 if (sig_num == SIGTERM)
592 i9ep->caught_sigterm = true;
596 * Wrapper for select(2) which does not restart on interrupts.
598 * \param n \sa \ref para_select().
599 * \param readfds \sa \ref para_select().
600 * \param writefds \sa \ref para_select().
601 * \param timeout_tv \sa \ref para_select().
603 * \return \sa \ref para_select().
605 * The only difference between this function and \ref para_select() is that
606 * \ref i9e_select() returns zero if the select call returned \p EINTR.
608 int i9e_select(int n, fd_set *readfds, fd_set *writefds,
609 struct timeval *timeout_tv)
611 int ret = select(n, readfds, writefds, NULL, timeout_tv);
617 ret = -ERRNO_TO_PARA_ERROR(errno);
623 * Return the possible completions for a given word.
625 * \param word The word to complete.
626 * \param string_list All possible words in this context.
627 * \param result String list is returned here.
629 * This function never fails. If no completion was found, a string list of
630 * length zero is returned. In any case, the result must be freed by the caller
631 * using \ref free_argv().
633 * This function is independent of readline and may be called before
636 * \return The number of possible completions.
638 int i9e_extract_completions(const char *word, char **string_list,
641 char **matches = para_malloc(sizeof(char *));
642 int match_count = 0, matches_len = 1;
644 int len = strlen(word);
646 for (p = string_list; *p; p++) {
647 if (!is_prefix(word, *p, len))
650 if (match_count >= matches_len) {
652 matches = para_realloc(matches,
653 matches_len * sizeof(char *));
655 matches[match_count - 1] = para_strdup(*p);
657 matches[match_count] = NULL;
663 * Return the list of partially matching words.
665 * \param word The command to complete.
666 * \param completers The array containing all command names.
668 * This is similar to \ref i9e_extract_completions(), but completes on the
669 * command names in \a completers.
671 * \return See \ref i9e_extract_completions().
673 char **i9e_complete_commands(const char *word, struct i9e_completer *completers)
677 int i, match_count, len = strlen(word);
680 * In contrast to completing against an arbitrary string list, here we
681 * know all possible completions and expect that there will not be many
682 * of them. So it should be OK to iterate twice over all commands which
683 * simplifies the code a bit.
685 for (i = 0, match_count = 0; (cmd = completers[i].name); i++) {
686 if (is_prefix(word, cmd, len))
689 matches = para_malloc((match_count + 1) * sizeof(*matches));
690 for (i = 0, match_count = 0; (cmd = completers[i].name); i++)
691 if (is_prefix(word, cmd, len))
692 matches[match_count++] = para_strdup(cmd);
693 matches[match_count] = NULL;
698 * Complete according to the given options.
700 * \param opts All available options.
701 * \param ci Information which was passed to the completer.
702 * \param cr Result pointer.
704 * This convenience helper can be used to complete an option. The array of all
705 * possible options is passed as the first argument. Flags, i.e. options
706 * without an argument, are expected to be listed as strings of type "-X" in \a
707 * opts while options which require an argument should be passed with a
708 * trailing "=" character like "-X=".
710 * If the word can be uniquely completed to a flag option, an additional space
711 * character is appended to the output. For non-flag options no space character
714 void i9e_complete_option(char **opts, struct i9e_completion_info *ci,
715 struct i9e_completion_result *cr)
719 num_matches = i9e_extract_completions(ci->word, opts, &cr->matches);
720 if (num_matches == 1) {
721 char *opt = cr->matches[0];
722 char c = opt[strlen(opt) - 1];
724 cr->dont_append_space = true;
729 * Print possible completions to stdout.
731 * \param completers The array of completion functions.
733 * At the end of the output a line starting with "-o=", followed by the
734 * (possibly empty) list of completion options is printed. Currently, the only
735 * two completion options are "nospace" and "filenames". The former indicates
736 * that no space should be appended even for a unique match while the latter
737 * indicates that usual filename completion should be performed in addition to
738 * the previously printed options.
742 int i9e_print_completions(struct i9e_completer *completers)
744 struct i9e_completion_result cr;
745 struct i9e_completion_info ci;
750 reset_completion_result(&cr);
751 buf = getenv("COMP_POINT");
752 ci.point = buf? atoi(buf) : 0;
753 ci.buffer = para_strdup(getenv("COMP_LINE"));
755 ci.argc = create_argv(ci.buffer, " ", &ci.argv);
756 ci.word_num = compute_word_num(ci.buffer, " ", ci.point);
758 end = ci.buffer + ci.point;
759 for (p = end; p > ci.buffer && *p != ' '; p--)
765 ci.word = para_malloc(n + 1);
766 strncpy(ci.word, p, n);
769 PARA_DEBUG_LOG("line: %s, point: %d (%c), wordnum: %d, word: %s\n",
770 ci.buffer, ci.point, ci.buffer[ci.point], ci.word_num, ci.word);
771 if (ci.word_num == 0)
772 cr.matches = i9e_complete_commands(ci.word, completers);
774 create_matches(&ci, completers, &cr);
776 if (cr.matches && cr.matches[0]) {
777 for (i = 0; cr.matches[i]; i++)
778 printf("%s\n", cr.matches[i]);
782 if (cr.dont_append_space)
784 if (cr.filename_completion_desired)
785 printf(",filenames");
787 free_argv(cr.matches);