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