2 * Copyright (C) 2011-2013 Andre Noll <maan@systemlinux.org>
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>
20 #include "buffer_tree.h"
23 #include "interactive.h"
28 struct i9e_client_info
*ici
;
31 char empty_line
[1000];
33 struct btr_node
*stdout_btrn
;
34 bool last_write_was_status
;
35 bool line_handler_running
;
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 i9ep
->task
.error
;
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)
209 int n
= i9ep
->num_columns
;
212 * For reasons beyond my understanding, writing more than 68 characters
213 * here causes MacOS to mess up the terminal. Writing a line of spaces
214 * in smaller chunks works fine though. Weird.
216 fprintf(i9ep
->stderr_stream
, "\r");
218 if (n
>= sizeof(x
)) {
219 fprintf(i9ep
->stderr_stream
, "%s", x
);
224 fprintf(i9ep
->stderr_stream
, "%s", x
);
227 fprintf(i9ep
->stderr_stream
, "\r");
231 * Free all storage associated with a keymap.
233 * This function is not declared in the readline headers although the symbol is
234 * exported and the function is documented in the readline info file. So we
235 * have to declare it here.
237 * \param keymap The keymap to deallocate.
239 void rl_free_keymap(Keymap keymap
);
242 * Reset the terminal and save the in-memory command line history.
244 * This should be called before the caller exits.
248 char *hf
= i9ep
->ici
->history_file
;
250 rl_free_keymap(i9ep
->bare_km
);
251 rl_callback_handler_remove();
257 static void clear_bottom_line(void)
262 if (rl_point
== 0 && rl_end
== 0)
263 return wipe_bottom_line();
265 * We might have a multi-line input that needs to be wiped here, so the
266 * simple printf("\r<space>\r") is insufficient. To workaround this, we
267 * remove the whole line, redisplay and restore the killed text.
270 text
= rl_copy_text(0, rl_end
);
271 rl_kill_full_line(0, 0);
273 wipe_bottom_line(); /* wipe out the prompt */
274 rl_insert_text(text
);
279 static bool input_available(void)
282 struct timeval tv
= {0, 0};
286 FD_SET(i9ep
->ici
->fds
[0], &rfds
);
287 ret
= para_select(1, &rfds
, NULL
, &tv
);
291 static void i9e_line_handler(char *line
)
294 struct btr_node
*dummy
;
297 i9ep
->input_eof
= true;
303 dummy
= btr_new_node(&(struct btr_node_description
)
304 EMBRACE(.name
= "dummy line handler"));
305 i9e_attach_to_stdout(dummy
);
306 ret
= i9ep
->ici
->line_handler(line
);
308 PARA_WARNING_LOG("%s\n", para_strerror(-ret
));
310 btr_remove_node(&dummy
);
315 static int i9e_post_select(__a_unused
struct sched
*s
, __a_unused
struct task
*t
)
318 struct i9e_client_info
*ici
= i9ep
->ici
;
320 size_t sz
, consumed
= 0;
325 ret
= -E_I9E_TERM_RQ
;
326 if (i9ep
->caught_sigterm
)
329 if (i9ep
->caught_sigint
)
331 while (input_available())
332 rl_callback_read_char();
333 if (!i9ep
->stdout_btrn
)
335 ret
= btr_node_status(i9ep
->stdout_btrn
, 0, BTR_NT_LEAF
);
343 sz
= btr_next_buffer(i9ep
->stdout_btrn
, &buf
);
346 if (i9ep
->last_write_was_status
)
347 fprintf(i9ep
->stderr_stream
, "\n");
348 i9ep
->last_write_was_status
= false;
349 ret
= xwrite(ici
->fds
[1], buf
, sz
);
352 btr_consume(i9ep
->stdout_btrn
, ret
);
354 if (ret
== sz
&& consumed
< 10000)
358 if (i9ep
->stdout_btrn
) {
360 btr_remove_node(&i9ep
->stdout_btrn
);
361 rl_set_keymap(i9ep
->standard_km
);
362 rl_set_prompt(i9ep
->ici
->prompt
);
368 i9ep
->caught_sigint
= false;
372 static void i9e_pre_select(struct sched
*s
, __a_unused
struct task
*t
)
376 if (i9ep
->input_eof
|| i9ep
->caught_sigint
|| i9ep
->caught_sigterm
) {
380 if (i9ep
->stdout_btrn
) {
381 ret
= btr_node_status(i9ep
->stdout_btrn
, 0, BTR_NT_LEAF
);
387 para_fd_set(i9ep
->ici
->fds
[1], &s
->wfds
, &s
->max_fileno
);
390 * fd[0] might have been reset to blocking mode if our job was moved to
391 * the background due to CTRL-Z or SIGSTOP, so set the fd back to
394 ret
= mark_fd_nonblocking(i9ep
->ici
->fds
[0]);
396 PARA_WARNING_LOG("set to nonblock failed: (fd0 %d, %s)\n",
397 i9ep
->ici
->fds
[0], para_strerror(-ret
));
398 para_fd_set(i9ep
->ici
->fds
[0], &s
->rfds
, &s
->max_fileno
);
401 static void update_winsize(void)
404 int ret
= ioctl(i9ep
->ici
->fds
[2], TIOCGWINSZ
, (char *)&w
);
407 assert(w
.ws_col
< sizeof(i9ep
->empty_line
));
408 i9ep
->num_columns
= w
.ws_col
;
410 i9ep
->num_columns
= 80;
412 memset(i9ep
->empty_line
, ' ', i9ep
->num_columns
);
413 i9ep
->empty_line
[i9ep
->num_columns
] = '\0';
417 * Defined key sequences are mapped to keys starting with this offset. I.e.
418 * pressing the first defined key sequence yields the key number \p KEY_OFFSET.
420 #define KEY_OFFSET 64
422 static int dispatch_key(__a_unused
int count
, int key
)
426 assert(key
>= KEY_OFFSET
);
427 ret
= i9ep
->ici
->key_handler(key
- KEY_OFFSET
);
428 return ret
< 0? ret
: 0;
432 * Register the i9e task and initialize readline.
434 * \param ici The i9e configuration parameters set by the caller.
435 * \param s The scheduler instance to add the i9e task to.
437 * The caller must allocate and initialize the structure \a ici points to.
440 * \sa \ref register_task().
442 int i9e_open(struct i9e_client_info
*ici
, struct sched
*s
)
446 if (!isatty(ici
->fds
[0]))
447 return -E_I9E_SETUPTERM
;
448 ret
= mark_fd_nonblocking(ici
->fds
[0]);
451 ret
= mark_fd_nonblocking(ici
->fds
[1]);
454 i9ep
->task
.pre_select
= i9e_pre_select
;
455 i9ep
->task
.post_select
= i9e_post_select
;
456 sprintf(i9ep
->task
.status
, "i9e");
457 register_task(s
, &i9ep
->task
);
458 rl_readline_name
= "para_i9e";
459 rl_basic_word_break_characters
= " ";
460 rl_attempted_completion_function
= i9e_completer
;
462 i9ep
->stderr_stream
= fdopen(ici
->fds
[2], "w");
463 setvbuf(i9ep
->stderr_stream
, NULL
, _IONBF
, 0);
465 i9ep
->standard_km
= rl_get_keymap();
466 i9ep
->bare_km
= rl_make_bare_keymap();
467 if (ici
->bound_keyseqs
) {
470 /* FIXME: This is an arbitrary constant. */
471 for (i
= 0; i
< 32 && (seq
= ici
->bound_keyseqs
[i
]); i
++) {
472 char buf
[2] = {KEY_OFFSET
+ i
, '\0'};
473 /* readline needs an allocated buffer for the macro */
474 rl_generic_bind(ISMACR
, seq
, para_strdup(buf
), i9ep
->bare_km
);
475 rl_bind_key_in_map(KEY_OFFSET
+ i
, dispatch_key
, i9ep
->bare_km
);
478 if (ici
->history_file
)
479 read_history(ici
->history_file
);
482 rl_callback_handler_install("", i9e_line_handler
);
483 i9e_attach_to_stdout(ici
->producer
);
484 rl_set_keymap(i9ep
->bare_km
);
486 rl_callback_handler_install(i9ep
->ici
->prompt
, i9e_line_handler
);
490 static void reset_line_state(void)
492 if (i9ep
->stdout_btrn
)
495 rl_reset_line_state();
496 rl_forced_update_display();
500 * The log function of the i9e subsystem.
502 * \param ll Severity log level.
503 * \param fmt Printf-like format string.
505 * This clears the bottom line of the terminal if necessary and writes the
506 * string given by \a fmt to fd[2], where fd[] is the array provided earlier in
509 __printf_2_3
void i9e_log(int ll
, const char* fmt
,...)
513 if (ll
< i9ep
->ici
->loglevel
)
517 vfprintf(i9ep
->stderr_stream
, fmt
, argp
);
520 i9ep
->last_write_was_status
= false;
524 * Print the current status to stderr.
526 * \param buf The text to print.
527 * \param len The number of bytes in \a buf.
529 * This clears the bottom line, moves to the beginning of the line and prints
530 * the given text. If the length of this text exceeds the width of the
531 * terminal, the text is shortened by leaving out a part in the middle.
533 void ie9_print_status_bar(char *buf
, unsigned len
)
535 size_t x
= i9ep
->num_columns
, y
= (x
- 4) / 2;
540 fprintf(i9ep
->stderr_stream
, "\r%s", buf
);
541 fprintf(i9ep
->stderr_stream
, " .. ");
542 fprintf(i9ep
->stderr_stream
, "%s", buf
+ len
- y
);
548 strcpy(scratch
+ 1, buf
);
549 memset(scratch
+ 1 + len
, ' ', y
);
550 scratch
[1 + len
+ y
] = '\r';
551 scratch
[2 + len
+ y
] = '\0';
552 fprintf(i9ep
->stderr_stream
, "\r%s", scratch
);
554 i9ep
->last_write_was_status
= true;
558 * Tell i9e that the caller received a signal.
560 * \param sig_num The number of the signal received.
562 * Currently the function only cares about \p SIGINT, but this may change.
564 void i9e_signal_dispatch(int sig_num
)
566 if (sig_num
== SIGWINCH
)
567 return update_winsize();
568 if (sig_num
== SIGINT
) {
569 fprintf(i9ep
->stderr_stream
, "\n");
570 rl_replace_line ("", false /* clear_undo */);
572 i9ep
->caught_sigint
= true;
574 if (sig_num
== SIGTERM
)
575 i9ep
->caught_sigterm
= true;
579 * Wrapper for select(2) which does not restart on interrupts.
581 * \param n \sa \ref para_select().
582 * \param readfds \sa \ref para_select().
583 * \param writefds \sa \ref para_select().
584 * \param timeout_tv \sa \ref para_select().
586 * \return \sa \ref para_select().
588 * The only difference between this function and \ref para_select() is that
589 * \ref i9e_select() returns zero if the select call returned \p EINTR.
591 int i9e_select(int n
, fd_set
*readfds
, fd_set
*writefds
,
592 struct timeval
*timeout_tv
)
594 int ret
= select(n
, readfds
, writefds
, NULL
, timeout_tv
);
600 ret
= -ERRNO_TO_PARA_ERROR(errno
);
606 * Return the possible completions for a given word.
608 * \param word The word to complete.
609 * \param string_list All possible words in this context.
610 * \param result String list is returned here.
612 * This function never fails. If no completion was found, a string list of
613 * length zero is returned. In any case, the result must be freed by the caller
614 * using \ref free_argv().
616 * This function is independent of readline and may be called before
619 * \return The number of possible completions.
621 int i9e_extract_completions(const char *word
, char **string_list
,
624 char **matches
= para_malloc(sizeof(char *));
625 int match_count
= 0, matches_len
= 1;
627 int len
= strlen(word
);
629 for (p
= string_list
; *p
; p
++) {
630 if (!is_prefix(word
, *p
, len
))
633 if (match_count
>= matches_len
) {
635 matches
= para_realloc(matches
,
636 matches_len
* sizeof(char *));
638 matches
[match_count
- 1] = para_strdup(*p
);
640 matches
[match_count
] = NULL
;
646 * Return the list of partially matching words.
648 * \param word The command to complete.
649 * \param completers The array containing all command names.
651 * This is similar to \ref i9e_extract_completions(), but completes on the
652 * command names in \a completers.
654 * \return See \ref i9e_extract_completions().
656 char **i9e_complete_commands(const char *word
, struct i9e_completer
*completers
)
660 int i
, match_count
, len
= strlen(word
);
663 * In contrast to completing against an arbitrary string list, here we
664 * know all possible completions and expect that there will not be many
665 * of them. So it should be OK to iterate twice over all commands which
666 * simplifies the code a bit.
668 for (i
= 0, match_count
= 0; (cmd
= completers
[i
].name
); i
++) {
669 if (is_prefix(word
, cmd
, len
))
672 matches
= para_malloc((match_count
+ 1) * sizeof(*matches
));
673 for (i
= 0, match_count
= 0; (cmd
= completers
[i
].name
); i
++)
674 if (is_prefix(word
, cmd
, len
))
675 matches
[match_count
++] = para_strdup(cmd
);
676 matches
[match_count
] = NULL
;
681 * Complete according to the given options.
683 * \param opts All available options.
684 * \param ci Information which was passed to the completer.
685 * \param cr Result pointer.
687 * This convenience helper can be used to complete an option. The array of all
688 * possible options is passed as the first argument. Flags, i.e. options
689 * without an argument, are expected to be listed as strings of type "-X" in \a
690 * opts while options which require an argument should be passed with a
691 * trailing "=" character like "-X=".
693 * If the word can be uniquely completed to a flag option, an additional space
694 * character is appended to the output. For non-flag options no space character
697 void i9e_complete_option(char **opts
, struct i9e_completion_info
*ci
,
698 struct i9e_completion_result
*cr
)
702 num_matches
= i9e_extract_completions(ci
->word
, opts
, &cr
->matches
);
703 if (num_matches
== 1) {
704 char *opt
= cr
->matches
[0];
705 char c
= opt
[strlen(opt
) - 1];
707 cr
->dont_append_space
= true;
712 * Print possible completions to stdout.
714 * \param completers The array of completion functions.
716 * At the end of the output a line starting with "-o=", followed by the
717 * (possibly empty) list of completion options is printed. Currently, the only
718 * two completion options are "nospace" and "filenames". The former indicates
719 * that no space should be appended even for a unique match while the latter
720 * indicates that usual filename completion should be performed in addition to
721 * the previously printed options.
725 int i9e_print_completions(struct i9e_completer
*completers
)
727 struct i9e_completion_result cr
;
728 struct i9e_completion_info ci
;
733 reset_completion_result(&cr
);
734 buf
= getenv("COMP_POINT");
735 ci
.point
= buf
? atoi(buf
) : 0;
736 ci
.buffer
= para_strdup(getenv("COMP_LINE"));
738 ci
.argc
= create_argv(ci
.buffer
, " ", &ci
.argv
);
739 ci
.word_num
= compute_word_num(ci
.buffer
, " ", ci
.point
);
741 end
= ci
.buffer
+ ci
.point
;
742 for (p
= end
; p
> ci
.buffer
&& *p
!= ' '; p
--)
748 ci
.word
= para_malloc(n
+ 1);
749 strncpy(ci
.word
, p
, n
);
752 PARA_DEBUG_LOG("line: %s, point: %d (%c), wordnum: %d, word: %s\n",
753 ci
.buffer
, ci
.point
, ci
.buffer
[ci
.point
], ci
.word_num
, ci
.word
);
754 if (ci
.word_num
== 0)
755 cr
.matches
= i9e_complete_commands(ci
.word
, completers
);
757 create_matches(&ci
, completers
, &cr
);
759 if (cr
.matches
&& cr
.matches
[0]) {
760 for (i
= 0; cr
.matches
[i
]; i
++)
761 printf("%s\n", cr
.matches
[i
]);
765 if (cr
.dont_append_space
)
767 if (cr
.filename_completion_desired
)
768 printf(",filenames");
770 free_argv(cr
.matches
);