interactive.c

   1 /*
   2  * Copyright (C) 2011 Andre Noll <maan@tuebingen.mpg.de>
   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 "para.h"
  10
  11 #include <regex.h>
  12 #include <readline/readline.h>
  13 #include <readline/history.h>
  14 #include <sys/ioctl.h>
  15 #include <signal.h>
  16
  17 #include "fd.h"
  18 #include "buffer_tree.h"
  19 #include "list.h"
  20 #include "sched.h"
  21 #include "interactive.h"
  22 #include "string.h"
  23 #include "error.h"
  24
  25 struct i9e_private {
  26         struct i9e_client_info *ici;
  27         FILE *stderr_stream;
  28         int num_columns;
  29         int num_key_bindings;
  30         char empty_line[1000];
  31         struct task *task;
  32         struct btr_node *stdout_btrn;
  33         bool last_write_was_status;
  34         bool input_eof;
  35         bool caught_sigint;
  36         bool caught_sigterm;
  37         Keymap standard_km;
  38         Keymap bare_km;
  39 };
  40 static struct i9e_private i9e_private, *i9ep = &i9e_private;
  41
  42 /**
  43  * Return the error state of the i9e task.
  44  *
  45  * This is mainly useful for other tasks to tell whether the i9e task is still
  46  * running.
  47  *
  48  * \return A negative return value of zero means the i9e task terminated. Only
  49  * in this case it is safe to call ie9_close().
  50  */
  51 int i9e_get_error(void)
  52 {
  53         return task_status(i9ep->task);
  54 }
  55
  56 static bool is_prefix(const char *partial, const char *full, size_t len)
  57 {
  58         if (len == 0)
  59                 len = strlen(partial);
  60         return !strncmp(partial, full, len);
  61 }
  62
  63 /*
  64  * Generator function for command completion. STATE lets us know whether
  65  * to start from scratch; without any state (i.e. STATE == 0), then we
  66  * start at the top of the list.
  67  */
  68 static char *command_generator(const char *text, int state)
  69 {
  70         static int list_index, len;
  71         const char *name;
  72         struct i9e_client_info *ici = i9ep->ici;
  73
  74         rl_attempted_completion_over = 1; /* disable filename completion */
  75         /*
  76          * If this is a new word to complete, initialize now. This includes
  77          * saving the length of TEXT for efficiency, and initializing the index
  78          * variable to 0.
  79          */
  80         if (state == 0) {
  81                 list_index = 0;
  82                 len = strlen(text);
  83         }
  84         /* Return the next name which partially matches from the command list. */
  85         while ((name = ici->completers[list_index].name)) {
  86                 list_index++;
  87                 if (is_prefix(text, name, len))
  88                         return para_strdup(name);
  89         }
  90         return NULL; /* no names matched */
  91 }
  92
  93 static void reset_completion_result(struct i9e_completion_result *cr)
  94 {
  95         cr->dont_append_space = false;
  96         cr->filename_completion_desired = false;
  97         cr->matches = NULL;
  98 }
  99
 100 static void create_matches(struct i9e_completion_info *ci,
 101                 struct i9e_completer *completers,
 102                 struct i9e_completion_result *cr)
 103 {
 104         int i, ret;
 105
 106         reset_completion_result(cr);
 107
 108         ret = create_argv(ci->buffer, " ", &ci->argv);
 109         if (ret < 0 || !ci->argv[0])
 110                 return;
 111
 112         ci->argc = ret;
 113         ci->word_num = compute_word_num(ci->buffer, " ", ci->point);
 114         for (i = 0; completers[i].name; i++) {
 115                 if (strcmp(completers[i].name, ci->argv[0]) != 0)
 116                         continue;
 117                 completers[i].completer(ci, cr);
 118                 break;
 119         }
 120         PARA_DEBUG_LOG("current word: %d (%s)\n", ci->word_num,
 121                 ci->argv[ci->word_num]);
 122         if (cr->matches)
 123                 for (i = 0; cr->matches[i]; i++)
 124                         PARA_DEBUG_LOG("match %d: %s\n", i, cr->matches[i]);
 125 }
 126
 127 static char *completion_generator(const char *word, int state)
 128 {
 129         static int list_index;
 130         static char **argv, **matches;
 131         struct i9e_completer *completers = i9ep->ici->completers;
 132         struct i9e_completion_info ci = {
 133                 .word = (char *)word,
 134                 .point = rl_point,
 135                 .buffer = rl_line_buffer,
 136         };
 137         struct i9e_completion_result cr = {.matches = NULL};
 138
 139         if (state != 0)
 140                 goto out;
 141         /* clean up previous matches and set defaults */
 142         free(matches);
 143         matches = NULL;
 144         free_argv(argv);
 145         argv = NULL;
 146         list_index = 0;
 147         rl_completion_append_character = ' ';
 148         rl_completion_suppress_append = false;
 149         rl_attempted_completion_over = true;
 150
 151         create_matches(&ci, completers, &cr);
 152
 153         matches = cr.matches;
 154         argv = ci.argv;
 155         rl_completion_suppress_append = cr.dont_append_space;
 156         rl_attempted_completion_over = !cr.filename_completion_desired;
 157 out:
 158         if (!matches)
 159                 return NULL;
 160         return matches[list_index++];
 161 }
 162
 163 /*
 164  * Attempt to complete on the contents of TEXT. START and END bound the
 165  * region of rl_line_buffer that contains the word to complete.  TEXT is
 166  * the word to complete.  We can use the entire contents of rl_line_buffer
 167  * in case we want to do some simple parsing. Return the array of matches,
 168  * or NULL if there aren't any.
 169  */
 170 static char **i9e_completer(const char *text, int start, __a_unused int end)
 171 {
 172         struct i9e_client_info *ici = i9ep->ici;
 173
 174         if (!ici->completers)
 175                 return NULL;
 176         /* Complete on command names if this is the first word in the line. */
 177         if (start == 0)
 178                 return rl_completion_matches(text, command_generator);
 179         return rl_completion_matches(text, completion_generator);
 180 }
 181
 182 /**
 183  * Prepare writing to stdout.
 184  *
 185  * \param producer The buffer tree node which produces output.
 186  *
 187  * The i9e subsystem maintains a buffer tree node which may be attached to
 188  * another node which generates output (a "producer"). When attached, the i9e
 189  * buffer tree node copies the buffers generated by the producer to stdout.
 190  *
 191  * This function attaches the i9e input queue to an output queue of \a
 192  * producer.
 193  *
 194  * \return Standard.
 195  */
 196 void i9e_attach_to_stdout(struct btr_node *producer)
 197 {
 198         btr_remove_node(&i9ep->stdout_btrn);
 199         i9ep->stdout_btrn = btr_new_node(&(struct btr_node_description)
 200                 EMBRACE(.name = "interactive_stdout", .parent = producer));
 201         rl_set_keymap(i9ep->bare_km);
 202 }
 203
 204 static void wipe_bottom_line(void)
 205 {
 206         char x[] = "          ";
 207         int n = i9ep->num_columns;
 208
 209         /*
 210          * For reasons beyond my understanding, writing more than 68 characters
 211          * here causes MacOS to mess up the terminal. Writing a line of spaces
 212          * in smaller chunks works fine though. Weird.
 213          */
 214         fprintf(i9ep->stderr_stream, "\r");
 215         while (n > 0) {
 216                 if (n >= sizeof(x)) {
 217                         fprintf(i9ep->stderr_stream, "%s", x);
 218                         n -= sizeof(x);
 219                         continue;
 220                 }
 221                 x[n] = '\0';
 222                 fprintf(i9ep->stderr_stream, "%s", x);
 223                 break;
 224         }
 225         fprintf(i9ep->stderr_stream, "\r");
 226 }
 227
 228 #ifndef RL_FREE_KEYMAP_DECLARED
 229 /**
 230  * Free all storage associated with a keymap.
 231  *
 232  * This function is not declared in the readline headers although the symbol is
 233  * exported and the function is documented in the readline info file. So we
 234  * have to declare it here.
 235  *
 236  * \param keymap The keymap to deallocate.
 237  */
 238 void rl_free_keymap(Keymap keymap);
 239 #endif
 240
 241 /**
 242  * Reset the terminal and save the in-memory command line history.
 243  *
 244  * This should be called before the caller exits.
 245  */
 246 void i9e_close(void)
 247 {
 248         char *hf = i9ep->ici->history_file;
 249
 250         rl_free_keymap(i9ep->bare_km);
 251         rl_callback_handler_remove();
 252         if (hf)
 253                 write_history(hf);
 254         wipe_bottom_line();
 255 }
 256
 257 static void clear_bottom_line(void)
 258 {
 259         int point;
 260         char *text;
 261
 262         if (rl_point == 0 && rl_end == 0)
 263                 return wipe_bottom_line();
 264         /*
 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.
 268          */
 269         point = rl_point;
 270         text = rl_copy_text(0, rl_end);
 271         rl_kill_full_line(0, 0);
 272         rl_redisplay();
 273         wipe_bottom_line(); /* wipe out the prompt */
 274         rl_insert_text(text);
 275         free(text);
 276         rl_point = point;
 277 }
 278
 279 static bool input_available(void)
 280 {
 281         fd_set rfds;
 282         struct timeval tv = {0, 0};
 283         int ret;
 284
 285         FD_ZERO(&rfds);
 286         FD_SET(i9ep->ici->fds[0], &rfds);
 287         ret = para_select(1, &rfds, NULL, &tv);
 288         return ret > 0;
 289 }
 290
 291 static void i9e_line_handler(char *line)
 292 {
 293         int ret;
 294         struct btr_node *dummy;
 295
 296         if (!line) {
 297                 i9ep->input_eof = true;
 298                 return;
 299         }
 300         if (!*line)
 301                 goto free_line;
 302         rl_set_prompt("");
 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);
 307         if (ret < 0)
 308                 PARA_WARNING_LOG("%s\n", para_strerror(-ret));
 309         add_history(line);
 310         btr_remove_node(&dummy);
 311 free_line:
 312         free(line);
 313 }
 314
 315 static int i9e_post_select(__a_unused struct sched *s, __a_unused void *context)
 316 {
 317         int ret;
 318         struct i9e_client_info *ici = i9ep->ici;
 319         char *buf;
 320         size_t sz, consumed = 0;
 321
 322         ret = -E_I9E_EOF;
 323         if (i9ep->input_eof)
 324                 goto rm_btrn;
 325         ret = -E_I9E_TERM_RQ;
 326         if (i9ep->caught_sigterm)
 327                 goto rm_btrn;
 328         ret = 0;
 329         if (i9ep->caught_sigint)
 330                 goto rm_btrn;
 331         while (input_available())
 332                 rl_callback_read_char();
 333         if (!i9ep->stdout_btrn)
 334                 goto out;
 335         ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
 336         if (ret < 0) {
 337                 ret = 0;
 338                 goto rm_btrn;
 339         }
 340         if (ret == 0)
 341                 goto out;
 342 again:
 343         sz = btr_next_buffer(i9ep->stdout_btrn, &buf);
 344         if (sz == 0)
 345                 goto out;
 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);
 350         if (ret < 0)
 351                 goto rm_btrn;
 352         btr_consume(i9ep->stdout_btrn, ret);
 353         consumed += ret;
 354         if (ret == sz && consumed < 10000)
 355                 goto again;
 356         goto out;
 357 rm_btrn:
 358         if (i9ep->stdout_btrn) {
 359                 wipe_bottom_line();
 360                 btr_remove_node(&i9ep->stdout_btrn);
 361                 rl_set_keymap(i9ep->standard_km);
 362                 rl_set_prompt(i9ep->ici->prompt);
 363                 rl_redisplay();
 364         }
 365         if (ret < 0)
 366                 wipe_bottom_line();
 367 out:
 368         i9ep->caught_sigint = false;
 369         return ret;
 370 }
 371
 372 static void i9e_pre_select(struct sched *s, __a_unused void *context)
 373 {
 374         int ret;
 375
 376         if (i9ep->input_eof || i9ep->caught_sigint || i9ep->caught_sigterm) {
 377                 sched_min_delay(s);
 378                 return;
 379         }
 380         if (i9ep->stdout_btrn) {
 381                 ret = btr_node_status(i9ep->stdout_btrn, 0, BTR_NT_LEAF);
 382                 if (ret < 0) {
 383                         sched_min_delay(s);
 384                         return;
 385                 }
 386                 if (ret > 0)
 387                         para_fd_set(i9ep->ici->fds[1], &s->wfds, &s->max_fileno);
 388         }
 389         /*
 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
 392          * nonblocking mode.
 393          */
 394         ret = mark_fd_nonblocking(i9ep->ici->fds[0]);
 395         if (ret < 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);
 399 }
 400
 401 static void update_winsize(void)
 402 {
 403         struct winsize w;
 404         int ret = ioctl(i9ep->ici->fds[2], TIOCGWINSZ, (char *)&w);
 405
 406         if (ret >= 0) {
 407                 assert(w.ws_col < sizeof(i9ep->empty_line));
 408                 i9ep->num_columns = w.ws_col;
 409         } else
 410                 i9ep->num_columns = 80;
 411
 412         memset(i9ep->empty_line, ' ', i9ep->num_columns);
 413         i9ep->empty_line[i9ep->num_columns] = '\0';
 414 }
 415
 416 static int dispatch_key(__a_unused int count, __a_unused int key)
 417 {
 418         int i, ret;
 419
 420         for (i = i9ep->num_key_bindings - 1; i >= 0; i--) {
 421                 if (strcmp(rl_executing_keyseq, i9ep->ici->bound_keyseqs[i]))
 422                         continue;
 423                 ret = i9ep->ici->key_handler(i);
 424                 return ret < 0? ret : 0;
 425         }
 426         assert(0);
 427 }
 428
 429 /**
 430  * Register the i9e task and initialize readline.
 431  *
 432  * \param ici The i9e configuration parameters set by the caller.
 433  * \param s The scheduler instance to add the i9e task to.
 434  *
 435  * The caller must allocate and initialize the structure \a ici points to.
 436  *
 437  * \return Standard.
 438  */
 439 int i9e_open(struct i9e_client_info *ici, struct sched *s)
 440 {
 441         int ret;
 442
 443         if (!isatty(ici->fds[0]))
 444                 return -E_I9E_SETUPTERM;
 445         ret = mark_fd_nonblocking(ici->fds[0]);
 446         if (ret < 0)
 447                 return ret;
 448         ret = mark_fd_nonblocking(ici->fds[1]);
 449         if (ret < 0)
 450                 return ret;
 451         i9ep->task = task_register(&(struct task_info) {
 452                 .name = "i9e",
 453                 .pre_select = i9e_pre_select,
 454                 .post_select = i9e_post_select,
 455                 .context = i9ep,
 456         }, s);
 457
 458         rl_readline_name = "para_i9e";
 459         rl_basic_word_break_characters = " ";
 460         rl_attempted_completion_function = i9e_completer;
 461         i9ep->ici = ici;
 462         i9ep->stderr_stream = fdopen(ici->fds[2], "w");
 463         setvbuf(i9ep->stderr_stream, NULL, _IONBF, 0);
 464
 465         i9ep->standard_km = rl_get_keymap();
 466         i9ep->bare_km = rl_make_bare_keymap();
 467         if (ici->bound_keyseqs) {
 468                 char *seq;
 469                 int i;
 470                 /* bind each key sequence to the our dispatcher */
 471                 for (i = 0; (seq = ici->bound_keyseqs[i]); i++)
 472                         rl_generic_bind(ISFUNC, seq, (char *)dispatch_key,
 473                                 i9ep->bare_km);
 474                 i9ep->num_key_bindings = i;
 475         }
 476         if (ici->history_file)
 477                 read_history(ici->history_file);
 478         update_winsize();
 479         if (ici->producer) {
 480                 rl_callback_handler_install("", i9e_line_handler);
 481                 i9e_attach_to_stdout(ici->producer);
 482         } else
 483                 rl_callback_handler_install(i9ep->ici->prompt, i9e_line_handler);
 484         return 1;
 485 }
 486
 487 static void reset_line_state(void)
 488 {
 489         if (i9ep->stdout_btrn)
 490                 return;
 491         rl_on_new_line();
 492         rl_reset_line_state();
 493         rl_forced_update_display();
 494 }
 495
 496 /**
 497  * The log function of the i9e subsystem.
 498  *
 499  * \param ll Severity log level.
 500  * \param fmt Printf-like format string.
 501  *
 502  * This clears the bottom line of the terminal if necessary and writes the
 503  * string given by \a fmt to fd[2], where fd[] is the array provided earlier in
 504  * \ref i9e_open().
 505  */
 506 __printf_2_3 void i9e_log(int ll, const char* fmt,...)
 507 {
 508         va_list argp;
 509
 510         if (ll < i9ep->ici->loglevel)
 511                 return;
 512         clear_bottom_line();
 513         va_start(argp, fmt);
 514         vfprintf(i9ep->stderr_stream, fmt, argp);
 515         va_end(argp);
 516         reset_line_state();
 517         i9ep->last_write_was_status = false;
 518 }
 519
 520 /**
 521  * Print the current status to stderr.
 522  *
 523  * \param buf The text to print.
 524  * \param len The number of bytes in \a buf.
 525  *
 526  * This clears the bottom line, moves to the beginning of the line and prints
 527  * the given text. If the length of this text exceeds the width of the
 528  * terminal, the text is shortened by leaving out a part in the middle.
 529  */
 530 void ie9_print_status_bar(char *buf, unsigned len)
 531 {
 532         size_t x = i9ep->num_columns, y = (x - 4) / 2;
 533
 534         assert(x >= 6);
 535         if (len > x) {
 536                 buf[y] = '\0';
 537                 fprintf(i9ep->stderr_stream, "\r%s", buf);
 538                 fprintf(i9ep->stderr_stream, " .. ");
 539                 fprintf(i9ep->stderr_stream, "%s", buf + len - y);
 540         } else {
 541                 char scratch[1000];
 542
 543                 y = x - len;
 544                 scratch[0] = '\r';
 545                 strcpy(scratch + 1, buf);
 546                 memset(scratch + 1 + len, ' ', y);
 547                 scratch[1 + len + y] = '\r';
 548                 scratch[2 + len + y] = '\0';
 549                 fprintf(i9ep->stderr_stream, "\r%s", scratch);
 550         }
 551         i9ep->last_write_was_status = true;
 552 }
 553
 554 /**
 555  * Tell i9e that the caller received a signal.
 556  *
 557  * \param sig_num The number of the signal received.
 558  */
 559 void i9e_signal_dispatch(int sig_num)
 560 {
 561         if (sig_num == SIGWINCH)
 562                 return update_winsize();
 563         if (sig_num == SIGINT) {
 564                 fprintf(i9ep->stderr_stream, "\n");
 565                 rl_replace_line ("", false /* clear_undo */);
 566                 reset_line_state();
 567                 i9ep->caught_sigint = true;
 568         }
 569         if (sig_num == SIGTERM)
 570                 i9ep->caught_sigterm = true;
 571 }
 572
 573 /**
 574  * Wrapper for select(2) which does not restart on interrupts.
 575  *
 576  * \param n \sa \ref para_select().
 577  * \param readfds \sa \ref para_select().
 578  * \param writefds \sa \ref para_select().
 579  * \param timeout_tv \sa \ref para_select().
 580  *
 581  * \return \sa \ref para_select().
 582  *
 583  * The only difference between this function and \ref para_select() is that
 584  * \ref i9e_select() returns zero if the select call returned \p EINTR.
 585  */
 586 int i9e_select(int n, fd_set *readfds, fd_set *writefds,
 587                 struct timeval *timeout_tv)
 588 {
 589         int ret = select(n, readfds, writefds, NULL, timeout_tv);
 590
 591         if (ret < 0) {
 592                 if (errno == EINTR)
 593                         ret = 0;
 594                 else
 595                         ret = -ERRNO_TO_PARA_ERROR(errno);
 596         }
 597         return ret;
 598 }
 599
 600 /**
 601  * Return the possible completions for a given word.
 602  *
 603  * \param word The word to complete.
 604  * \param string_list All possible words in this context.
 605  * \param result String list is returned here.
 606  *
 607  * This function never fails. If no completion was found, a string list of
 608  * length zero is returned. In any case, the result must be freed by the caller
 609  * using \ref free_argv().
 610  *
 611  * This function is independent of readline and may be called before
 612  * i9e_open().
 613  *
 614  * \return The number of possible completions.
 615  */
 616 int i9e_extract_completions(const char *word, char **string_list,
 617                 char ***result)
 618 {
 619         char **matches = para_malloc(sizeof(char *));
 620         int match_count = 0, matches_len = 1;
 621         char **p;
 622         int len = strlen(word);
 623
 624         for (p = string_list; *p; p++) {
 625                 if (!is_prefix(word, *p, len))
 626                         continue;
 627                 match_count++;
 628                 if (match_count >= matches_len) {
 629                         matches_len *= 2;
 630                         matches = para_realloc(matches,
 631                                 matches_len * sizeof(char *));
 632                 }
 633                 matches[match_count - 1] = para_strdup(*p);
 634         }
 635         matches[match_count] = NULL;
 636         *result = matches;
 637         return match_count;
 638 }
 639
 640 /**
 641  * Return the list of partially matching words.
 642  *
 643  * \param word The command to complete.
 644  * \param completers The array containing all command names.
 645  *
 646  * This is similar to \ref i9e_extract_completions(), but completes on the
 647  * command names in \a completers.
 648  *
 649  * \return See \ref i9e_extract_completions().
 650  */
 651 char **i9e_complete_commands(const char *word, struct i9e_completer *completers)
 652 {
 653         char **matches;
 654         const char *cmd;
 655         int i, match_count, len = strlen(word);
 656
 657         /*
 658          * In contrast to completing against an arbitrary string list, here we
 659          * know all possible completions and expect that there will not be many
 660          * of them. So it should be OK to iterate twice over all commands which
 661          * simplifies the code a bit.
 662          */
 663         for (i = 0, match_count = 0; (cmd = completers[i].name); i++) {
 664                 if (is_prefix(word, cmd, len))
 665                         match_count++;
 666         }
 667         matches = para_malloc((match_count + 1) * sizeof(*matches));
 668         for (i = 0, match_count = 0; (cmd = completers[i].name); i++)
 669                 if (is_prefix(word, cmd, len))
 670                         matches[match_count++] = para_strdup(cmd);
 671         matches[match_count] = NULL;
 672         return matches;
 673 }
 674
 675 /**
 676  * Complete according to the given options.
 677  *
 678  * \param opts All available options.
 679  * \param ci Information which was passed to the completer.
 680  * \param cr Result pointer.
 681  *
 682  * This convenience helper can be used to complete an option. The array of all
 683  * possible options is passed as the first argument. Flags, i.e. options
 684  * without an argument, are expected to be listed as strings of type "-X" in \a
 685  * opts while options which require an argument should be passed with a
 686  * trailing "=" character like "-X=".
 687  *
 688  * If the word can be uniquely completed to a flag option, an additional space
 689  * character is appended to the output. For non-flag options no space character
 690  * is appended.
 691  */
 692 void i9e_complete_option(char **opts, struct i9e_completion_info *ci,
 693                 struct i9e_completion_result *cr)
 694 {
 695         int num_matches;
 696
 697         num_matches = i9e_extract_completions(ci->word, opts, &cr->matches);
 698         if (num_matches == 1) {
 699                 char *opt = cr->matches[0];
 700                 char c = opt[strlen(opt) - 1];
 701                 if (c == '=')
 702                         cr->dont_append_space = true;
 703         }
 704 }
 705
 706 /**
 707  * Print possible completions to stdout.
 708  *
 709  * \param completers The array of completion functions.
 710  *
 711  * At the end of the output a line starting with "-o=", followed by the
 712  * (possibly empty) list of completion options is printed. Currently, the only
 713  * two completion options are "nospace" and "filenames". The former indicates
 714  * that no space should be appended even for a unique match while the latter
 715  * indicates that usual filename completion should be performed in addition to
 716  * the previously printed options.
 717  *
 718  * \return Standard.
 719  */
 720 int i9e_print_completions(struct i9e_completer *completers)
 721 {
 722         struct i9e_completion_result cr;
 723         struct i9e_completion_info ci;
 724         char *buf;
 725         const char *end, *p;
 726         int i, n, ret;
 727
 728         reset_completion_result(&cr);
 729         buf = getenv("COMP_POINT");
 730         ci.point = buf? atoi(buf) : 0;
 731         ci.buffer = para_strdup(getenv("COMP_LINE"));
 732
 733         ci.argc = create_argv(ci.buffer, " ", &ci.argv);
 734         ci.word_num = compute_word_num(ci.buffer, " ", ci.point);
 735
 736         end = ci.buffer + ci.point;
 737         for (p = end; p > ci.buffer && *p != ' '; p--)
 738                 ; /* nothing */
 739         if (*p == ' ')
 740                 p++;
 741
 742         n = end - p + 1;
 743         ci.word = para_malloc(n + 1);
 744         strncpy(ci.word, p, n);
 745         ci.word[n] = '\0';
 746
 747         PARA_DEBUG_LOG("line: %s, point: %d (%c), wordnum: %d, word: %s\n",
 748                 ci.buffer, ci.point, ci.buffer[ci.point], ci.word_num, ci.word);
 749         if (ci.word_num == 0)
 750                 cr.matches = i9e_complete_commands(ci.word, completers);
 751         else
 752                 create_matches(&ci, completers, &cr);
 753         ret = 0;
 754         if (cr.matches && cr.matches[0]) {
 755                 for (i = 0; cr.matches[i]; i++)
 756                         printf("%s\n", cr.matches[i]);
 757                 ret = 1;
 758         }
 759         printf("-o=");
 760         if (cr.dont_append_space)
 761                 printf("nospace");
 762         if (cr.filename_completion_desired)
 763                 printf(",filenames");
 764         printf("\n");
 765         free_argv(cr.matches);
 766         free_argv(ci.argv);
 767         free(ci.buffer);
 768         free(ci.word);
 769         return ret;
 770 }