1 /* Copyright (C) 2011 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file interactive.c Readline abstraction for interactive sessions. */
8 #include <readline/readline.h>
9 #include <readline/history.h>
10 #include <sys/ioctl.h>
14 #include "buffer_tree.h"
17 #include "interactive.h"
22 struct i9e_client_info
*ici
;
26 char empty_line
[1000];
27 char key_sequence
[32];
28 unsigned key_sequence_length
;
30 struct btr_node
*stdout_btrn
;
31 bool last_write_was_status
;
39 static struct i9e_private i9e_private
, *i9ep
= &i9e_private
;
42 * Return the error state of the i9e task.
44 * This is mainly useful for other tasks to tell whether the i9e task is still
47 * \return A negative return value of zero means the i9e task terminated. Only
48 * in this case it is safe to call ie9_close().
50 int i9e_get_error(void)
52 return task_status(i9ep
->task
);
55 static bool is_prefix(const char *partial
, const char *full
, size_t len
)
58 len
= strlen(partial
);
59 return !strncmp(partial
, full
, len
);
63 * Generator function for command completion. STATE lets us know whether
64 * to start from scratch; without any state (i.e. STATE == 0), then we
65 * start at the top of the list.
67 static char *command_generator(const char *text
, int state
)
69 static int list_index
, len
;
71 struct i9e_client_info
*ici
= i9ep
->ici
;
73 rl_attempted_completion_over
= 1; /* disable filename completion */
75 * If this is a new word to complete, initialize now. This includes
76 * saving the length of TEXT for efficiency, and initializing the index
83 /* Return the next name which partially matches from the command list. */
84 while ((name
= ici
->completers
[list_index
].name
)) {
86 if (is_prefix(text
, name
, len
))
87 return para_strdup(name
);
89 return NULL
; /* no names matched */
92 static void reset_completion_result(struct i9e_completion_result
*cr
)
94 cr
->dont_append_space
= false;
95 cr
->filename_completion_desired
= false;
99 static void create_matches(struct i9e_completion_info
*ci
,
100 struct i9e_completer
*completers
,
101 struct i9e_completion_result
*cr
)
105 reset_completion_result(cr
);
107 ret
= create_argv(ci
->buffer
, " ", &ci
->argv
);
108 if (ret
< 0 || !ci
->argv
[0])
112 ci
->word_num
= compute_word_num(ci
->buffer
, " ", ci
->point
);
113 for (i
= 0; completers
[i
].name
; i
++) {
114 if (strcmp(completers
[i
].name
, ci
->argv
[0]) != 0)
116 completers
[i
].completer(ci
, cr
);
119 PARA_DEBUG_LOG("current word: %d (%s)\n", ci
->word_num
,
120 ci
->argv
[ci
->word_num
]);
122 for (i
= 0; cr
->matches
[i
]; i
++)
123 PARA_DEBUG_LOG("match %d: %s\n", i
, cr
->matches
[i
]);
126 static char *completion_generator(const char *word
, int state
)
128 static int list_index
;
129 static char **argv
, **matches
;
130 struct i9e_completer
*completers
= i9ep
->ici
->completers
;
131 struct i9e_completion_info ci
= {
132 .word
= (char *)word
,
134 .buffer
= rl_line_buffer
,
136 struct i9e_completion_result cr
= {.matches
= NULL
};
140 /* clean up previous matches and set defaults */
146 rl_completion_append_character
= ' ';
147 rl_completion_suppress_append
= false;
148 rl_attempted_completion_over
= true;
150 create_matches(&ci
, completers
, &cr
);
152 matches
= cr
.matches
;
154 rl_completion_suppress_append
= cr
.dont_append_space
;
155 rl_attempted_completion_over
= !cr
.filename_completion_desired
;
159 return matches
[list_index
++];
163 * Attempt to complete on the contents of TEXT. START and END bound the
164 * region of rl_line_buffer that contains the word to complete. TEXT is
165 * the word to complete. We can use the entire contents of rl_line_buffer
166 * in case we want to do some simple parsing. Return the array of matches,
167 * or NULL if there aren't any.
169 static char **i9e_completer(const char *text
, int start
, __a_unused
int end
)
171 struct i9e_client_info
*ici
= i9ep
->ici
;
173 if (!ici
->completers
)
175 /* Complete on command names if this is the first word in the line. */
177 return rl_completion_matches(text
, command_generator
);
178 return rl_completion_matches(text
, completion_generator
);
182 * Prepare writing to stdout.
184 * \param producer The buffer tree node which produces output.
186 * The i9e subsystem maintains a buffer tree node which may be attached to
187 * another node which generates output (a "producer"). When attached, the i9e
188 * buffer tree node copies the buffers generated by the producer to stdout.
190 * This function attaches the i9e input queue to an output queue of \a
195 void i9e_attach_to_stdout(struct btr_node
*producer
)
197 btr_remove_node(&i9ep
->stdout_btrn
);
198 i9ep
->stdout_btrn
= btr_new_node(&(struct btr_node_description
)
199 EMBRACE(.name
= "interactive_stdout", .parent
= producer
));
200 rl_set_keymap(i9ep
->bare_km
);
203 static void wipe_bottom_line(void)
205 fprintf(i9ep
->stderr_stream
, "\r%s\r", i9ep
->empty_line
);
208 #ifndef RL_FREE_KEYMAP_DECLARED
210 * Free all storage associated with a keymap.
212 * This function is not declared in the readline headers although the symbol is
213 * exported and the function is documented in the readline info file. So we
214 * have to declare it here.
216 * \param keymap The keymap to deallocate.
218 void rl_free_keymap(Keymap keymap
);
222 * Reset the terminal and save the in-memory command line history.
224 * This should be called before the caller exits.
228 char *hf
= i9ep
->ici
->history_file
;
230 rl_free_keymap(i9ep
->bare_km
);
231 rl_callback_handler_remove();
235 fcntl(i9ep
->ici
->fds
[0], F_SETFL
, i9ep
->fd_flags
[0]);
236 fcntl(i9ep
->ici
->fds
[1], F_SETFL
, i9ep
->fd_flags
[1]);
239 static void clear_bottom_line(void)
244 if (rl_point
== 0 && rl_end
== 0)
245 return wipe_bottom_line();
247 * We might have a multi-line input that needs to be wiped here, so the
248 * simple printf("\r<space>\r") is insufficient. To workaround this, we
249 * remove the whole line, redisplay and restore the killed text.
252 text
= rl_copy_text(0, rl_end
);
253 rl_kill_full_line(0, 0);
255 wipe_bottom_line(); /* wipe out the prompt */
256 rl_insert_text(text
);
261 static bool input_available(void)
264 struct timeval tv
= {0, 0};
268 FD_SET(i9ep
->ici
->fds
[0], &rfds
);
269 ret
= para_select(1, &rfds
, NULL
, &tv
);
273 static void i9e_line_handler(char *line
)
276 struct btr_node
*dummy
;
279 i9ep
->input_eof
= true;
285 dummy
= btr_new_node(&(struct btr_node_description
)
286 EMBRACE(.name
= "dummy line handler"));
287 i9e_attach_to_stdout(dummy
);
288 ret
= i9ep
->ici
->line_handler(line
);
290 PARA_WARNING_LOG("%s\n", para_strerror(-ret
));
292 btr_remove_node(&dummy
);
297 static int i9e_post_select(__a_unused
struct sched
*s
, __a_unused
void *context
)
300 struct i9e_client_info
*ici
= i9ep
->ici
;
302 size_t sz
, consumed
= 0;
307 ret
= -E_I9E_TERM_RQ
;
308 if (i9ep
->caught_sigterm
)
311 if (i9ep
->caught_sigint
)
313 while (input_available()) {
314 if (i9ep
->stdout_btrn
) {
315 unsigned len
= i9ep
->key_sequence_length
;
316 assert(len
< sizeof(i9ep
->key_sequence
) - 1);
317 buf
= i9ep
->key_sequence
+ len
;
318 ret
= read(i9ep
->ici
->fds
[0], buf
, 1);
320 ret
= -ERRNO_TO_PARA_ERROR(errno
);
327 i9ep
->key_sequence_length
++;
328 rl_stuff_char((int)(unsigned char)*buf
);
330 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
void *context
)
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';
416 static int dispatch_key(__a_unused
int count
, __a_unused
int key
)
421 if (i9ep
->key_sequence_length
== 0)
423 for (i
= i9ep
->num_key_bindings
- 1; i
>= 0; i
--) {
424 if (strcmp(i9ep
->key_sequence
, i9ep
->ici
->bound_keyseqs
[i
]))
426 i9ep
->key_sequence
[0] = '\0';
427 i9ep
->key_sequence_length
= 0;
428 ret
= i9ep
->ici
->key_handler(i
);
429 return ret
< 0? ret
: 0;
431 PARA_WARNING_LOG("ignoring key %d\n", i9ep
->key_sequence
[0]);
433 * We received an undefined key sequence. Throw away the first byte,
434 * and try to parse the remainder.
436 memmove(i9ep
->key_sequence
, i9ep
->key_sequence
+ 1,
437 i9ep
->key_sequence_length
); /* move also terminating zero byte */
438 i9ep
->key_sequence_length
--;
443 * Register the i9e task and initialize readline.
445 * \param ici The i9e configuration parameters set by the caller.
446 * \param s The scheduler instance to add the i9e task to.
448 * The caller must allocate and initialize the structure \a ici points to.
452 int i9e_open(struct i9e_client_info
*ici
, struct sched
*s
)
456 memset(i9ep
, 0, sizeof(struct i9e_private
));
457 if (!isatty(ici
->fds
[0]))
458 return -E_I9E_SETUPTERM
;
459 ret
= fcntl(ici
->fds
[0], F_GETFL
);
461 return -E_I9E_SETUPTERM
;
462 i9ep
->fd_flags
[0] = ret
;
463 ret
= fcntl(ici
->fds
[1], F_GETFL
);
465 return -E_I9E_SETUPTERM
;
466 i9ep
->fd_flags
[1] = ret
;
467 ret
= mark_fd_nonblocking(ici
->fds
[0]);
470 ret
= mark_fd_nonblocking(ici
->fds
[1]);
473 i9ep
->task
= task_register(&(struct task_info
) {
475 .pre_select
= i9e_pre_select
,
476 .post_select
= i9e_post_select
,
480 rl_readline_name
= "para_i9e";
481 rl_basic_word_break_characters
= " ";
482 rl_attempted_completion_function
= i9e_completer
;
484 i9ep
->stderr_stream
= fdopen(ici
->fds
[2], "w");
485 setvbuf(i9ep
->stderr_stream
, NULL
, _IONBF
, 0);
487 i9ep
->standard_km
= rl_get_keymap();
488 i9ep
->bare_km
= rl_make_bare_keymap();
489 if (ici
->bound_keyseqs
) {
492 /* bind each key sequence to our dispatcher */
493 for (i
= 0; (seq
= ici
->bound_keyseqs
[i
]); i
++) {
494 if (strlen(seq
) >= sizeof(i9ep
->key_sequence
) - 1) {
495 PARA_WARNING_LOG("ignoring overlong key %s\n",
499 if (rl_bind_keyseq_in_map(seq
,
500 dispatch_key
, i9ep
->bare_km
) != 0)
501 PARA_WARNING_LOG("could not bind #%d: %s\n", i
, seq
);
503 i9ep
->num_key_bindings
= i
;
505 if (ici
->history_file
)
506 read_history(ici
->history_file
);
509 rl_callback_handler_install("", i9e_line_handler
);
510 i9e_attach_to_stdout(ici
->producer
);
512 rl_callback_handler_install(i9ep
->ici
->prompt
, i9e_line_handler
);
516 static void reset_line_state(void)
518 if (i9ep
->stdout_btrn
)
521 rl_reset_line_state();
522 rl_forced_update_display();
526 * The log function of the i9e subsystem.
528 * \param ll Severity log level.
529 * \param fmt Printf-like format string.
531 * This clears the bottom line of the terminal if necessary and writes the
532 * string given by \a fmt to fd[2], where fd[] is the array provided earlier in
535 __printf_2_3
void i9e_log(int ll
, const char* fmt
,...)
539 if (ll
< i9ep
->ici
->loglevel
)
543 vfprintf(i9ep
->stderr_stream
, fmt
, argp
);
546 i9ep
->last_write_was_status
= false;
550 * Print the current status to stderr.
552 * \param buf The text to print.
553 * \param len The number of bytes in \a buf.
555 * This clears the bottom line, moves to the beginning of the line and prints
556 * the given text. If the length of this text exceeds the width of the
557 * terminal, the text is shortened by leaving out a part in the middle.
559 void ie9_print_status_bar(char *buf
, unsigned len
)
561 size_t x
= i9ep
->num_columns
, y
= (x
- 4) / 2;
566 fprintf(i9ep
->stderr_stream
, "\r%s", buf
);
567 fprintf(i9ep
->stderr_stream
, " .. ");
568 fprintf(i9ep
->stderr_stream
, "%s", buf
+ len
- y
);
574 strcpy(scratch
+ 1, buf
);
575 memset(scratch
+ 1 + len
, ' ', y
);
576 scratch
[1 + len
+ y
] = '\r';
577 scratch
[2 + len
+ y
] = '\0';
578 fprintf(i9ep
->stderr_stream
, "\r%s", scratch
);
580 i9ep
->last_write_was_status
= true;
584 * Tell i9e that the caller received a signal.
586 * \param sig_num The number of the signal received.
588 void i9e_signal_dispatch(int sig_num
)
590 if (sig_num
== SIGWINCH
)
591 return update_winsize();
592 if (sig_num
== SIGINT
) {
593 fprintf(i9ep
->stderr_stream
, "\n");
594 rl_replace_line ("", false /* clear_undo */);
596 i9ep
->caught_sigint
= true;
598 if (sig_num
== SIGTERM
)
599 i9ep
->caught_sigterm
= true;
603 * Wrapper for select(2) which does not restart on interrupts.
605 * \param n \sa \ref para_select().
606 * \param readfds \sa \ref para_select().
607 * \param writefds \sa \ref para_select().
608 * \param timeout_tv \sa \ref para_select().
610 * \return \sa \ref para_select().
612 * The only difference between this function and \ref para_select() is that
613 * \ref i9e_select() returns zero if the select call returned \p EINTR.
615 int i9e_select(int n
, fd_set
*readfds
, fd_set
*writefds
,
616 struct timeval
*timeout_tv
)
618 int ret
= select(n
, readfds
, writefds
, NULL
, timeout_tv
);
624 ret
= -ERRNO_TO_PARA_ERROR(errno
);
630 * Return the possible completions for a given word.
632 * \param word The word to complete.
633 * \param string_list All possible words in this context.
634 * \param result String list is returned here.
636 * This function never fails. If no completion was found, a string list of
637 * length zero is returned. In any case, the result must be freed by the caller
638 * using \ref free_argv().
640 * This function is independent of readline and may be called before
643 * \return The number of possible completions.
645 int i9e_extract_completions(const char *word
, char **string_list
,
648 char **matches
= para_malloc(sizeof(char *));
649 int match_count
= 0, matches_len
= 1;
651 int len
= strlen(word
);
653 for (p
= string_list
; *p
; p
++) {
654 if (!is_prefix(word
, *p
, len
))
657 if (match_count
>= matches_len
) {
659 matches
= para_realloc(matches
,
660 matches_len
* sizeof(char *));
662 matches
[match_count
- 1] = para_strdup(*p
);
664 matches
[match_count
] = NULL
;
670 * Return the list of partially matching words.
672 * \param word The command to complete.
673 * \param completers The array containing all command names.
675 * This is similar to \ref i9e_extract_completions(), but completes on the
676 * command names in \a completers.
678 * \return See \ref i9e_extract_completions().
680 char **i9e_complete_commands(const char *word
, struct i9e_completer
*completers
)
684 int i
, match_count
, len
= strlen(word
);
687 * In contrast to completing against an arbitrary string list, here we
688 * know all possible completions and expect that there will not be many
689 * of them. So it should be OK to iterate twice over all commands which
690 * simplifies the code a bit.
692 for (i
= 0, match_count
= 0; (cmd
= completers
[i
].name
); i
++) {
693 if (is_prefix(word
, cmd
, len
))
696 matches
= para_malloc((match_count
+ 1) * sizeof(*matches
));
697 for (i
= 0, match_count
= 0; (cmd
= completers
[i
].name
); i
++)
698 if (is_prefix(word
, cmd
, len
))
699 matches
[match_count
++] = para_strdup(cmd
);
700 matches
[match_count
] = NULL
;
705 * Complete according to the given options.
707 * \param opts All available options.
708 * \param ci Information which was passed to the completer.
709 * \param cr Result pointer.
711 * This convenience helper can be used to complete an option. The array of all
712 * possible options is passed as the first argument. Flags, i.e. options
713 * without an argument, are expected to be listed as strings of type "-X" in \a
714 * opts while options which require an argument should be passed with a
715 * trailing "=" character like "-X=".
717 * If the word can be uniquely completed to a flag option, an additional space
718 * character is appended to the output. For non-flag options no space character
721 void i9e_complete_option(char **opts
, struct i9e_completion_info
*ci
,
722 struct i9e_completion_result
*cr
)
726 num_matches
= i9e_extract_completions(ci
->word
, opts
, &cr
->matches
);
727 if (num_matches
== 1) {
728 char *opt
= cr
->matches
[0];
729 char c
= opt
[strlen(opt
) - 1];
731 cr
->dont_append_space
= true;
736 * Print possible completions to stdout.
738 * \param completers The array of completion functions.
740 * At the end of the output a line starting with "-o=", followed by the
741 * (possibly empty) list of completion options is printed. Currently, the only
742 * two completion options are "nospace" and "filenames". The former indicates
743 * that no space should be appended even for a unique match while the latter
744 * indicates that usual filename completion should be performed in addition to
745 * the previously printed options.
749 int i9e_print_completions(struct i9e_completer
*completers
)
751 struct i9e_completion_result cr
;
752 struct i9e_completion_info ci
;
757 reset_completion_result(&cr
);
758 buf
= getenv("COMP_POINT");
759 ci
.point
= buf
? atoi(buf
) : 0;
760 ci
.buffer
= para_strdup(getenv("COMP_LINE"));
762 ci
.argc
= create_argv(ci
.buffer
, " ", &ci
.argv
);
763 ci
.word_num
= compute_word_num(ci
.buffer
, " ", ci
.point
);
765 /* determine the current word to complete */
766 end
= ci
.buffer
+ ci
.point
;
769 if (ci
.point
== 0 || ci
.buffer
[ci
.point
- 1] == ' ') {
770 ci
.word
= para_strdup(NULL
);
772 } else /* The cursor is positioned right after a word */
775 for (p
= end
; p
> ci
.buffer
&& *p
!= ' '; p
--)
780 ci
.word
= para_malloc(n
+ 1);
781 strncpy(ci
.word
, p
, n
);
784 PARA_DEBUG_LOG("line: %s, point: %d (%c), wordnum: %d, word: %s\n",
785 ci
.buffer
, ci
.point
, ci
.buffer
[ci
.point
], ci
.word_num
, ci
.word
);
786 if (ci
.word_num
== 0)
787 cr
.matches
= i9e_complete_commands(ci
.word
, completers
);
789 create_matches(&ci
, completers
, &cr
);
791 if (cr
.matches
&& cr
.matches
[0]) {
792 for (i
= 0; cr
.matches
[i
]; i
++)
793 printf("%s\n", cr
.matches
[i
]);
797 if (cr
.dont_append_space
)
799 if (cr
.filename_completion_desired
)
800 printf(",filenames");
802 free_argv(cr
.matches
);