]> git.ipfire.org Git - thirdparty/bash.git/blob - lib/readline/complete.c
Bash-4.0 patchlevel 38
[thirdparty/bash.git] / lib / readline / complete.c
1 /* complete.c -- filename completion for readline. */
2
3 /* Copyright (C) 1987-2009 Free Software Foundation, Inc.
4
5 This file is part of the GNU Readline Library (Readline), a library
6 for reading lines of text with interactive input and history editing.
7
8 Readline is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 Readline is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with Readline. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #define READLINE_LIBRARY
23
24 #if defined (HAVE_CONFIG_H)
25 # include <config.h>
26 #endif
27
28 #include <sys/types.h>
29 #include <fcntl.h>
30 #if defined (HAVE_SYS_FILE_H)
31 # include <sys/file.h>
32 #endif
33
34 #if defined (HAVE_UNISTD_H)
35 # include <unistd.h>
36 #endif /* HAVE_UNISTD_H */
37
38 #if defined (HAVE_STDLIB_H)
39 # include <stdlib.h>
40 #else
41 # include "ansi_stdlib.h"
42 #endif /* HAVE_STDLIB_H */
43
44 #include <stdio.h>
45
46 #include <errno.h>
47 #if !defined (errno)
48 extern int errno;
49 #endif /* !errno */
50
51 #if defined (HAVE_PWD_H)
52 #include <pwd.h>
53 #endif
54
55 #include "posixdir.h"
56 #include "posixstat.h"
57
58 /* System-specific feature definitions and include files. */
59 #include "rldefs.h"
60 #include "rlmbutil.h"
61
62 /* Some standard library routines. */
63 #include "readline.h"
64 #include "xmalloc.h"
65 #include "rlprivate.h"
66
67 #ifdef __STDC__
68 typedef int QSFUNC (const void *, const void *);
69 #else
70 typedef int QSFUNC ();
71 #endif
72
73 #ifdef HAVE_LSTAT
74 # define LSTAT lstat
75 #else
76 # define LSTAT stat
77 #endif
78
79 /* Unix version of a hidden file. Could be different on other systems. */
80 #define HIDDEN_FILE(fname) ((fname)[0] == '.')
81
82 /* Most systems don't declare getpwent in <pwd.h> if _POSIX_SOURCE is
83 defined. */
84 #if defined (HAVE_GETPWENT) && (!defined (HAVE_GETPW_DECLS) || defined (_POSIX_SOURCE))
85 extern struct passwd *getpwent PARAMS((void));
86 #endif /* HAVE_GETPWENT && (!HAVE_GETPW_DECLS || _POSIX_SOURCE) */
87
88 /* If non-zero, then this is the address of a function to call when
89 completing a word would normally display the list of possible matches.
90 This function is called instead of actually doing the display.
91 It takes three arguments: (char **matches, int num_matches, int max_length)
92 where MATCHES is the array of strings that matched, NUM_MATCHES is the
93 number of strings in that array, and MAX_LENGTH is the length of the
94 longest string in that array. */
95 rl_compdisp_func_t *rl_completion_display_matches_hook = (rl_compdisp_func_t *)NULL;
96
97 #if defined (VISIBLE_STATS)
98 # if !defined (X_OK)
99 # define X_OK 1
100 # endif
101 static int stat_char PARAMS((char *));
102 #endif
103
104 static int path_isdir PARAMS((const char *));
105
106 static char *rl_quote_filename PARAMS((char *, int, char *));
107
108 static void set_completion_defaults PARAMS((int));
109 static int get_y_or_n PARAMS((int));
110 static int _rl_internal_pager PARAMS((int));
111 static char *printable_part PARAMS((char *));
112 static int fnwidth PARAMS((const char *));
113 static int fnprint PARAMS((const char *, int));
114 static int print_filename PARAMS((char *, char *, int));
115
116 static char **gen_completion_matches PARAMS((char *, int, int, rl_compentry_func_t *, int, int));
117
118 static char **remove_duplicate_matches PARAMS((char **));
119 static void insert_match PARAMS((char *, int, int, char *));
120 static int append_to_match PARAMS((char *, int, int, int));
121 static void insert_all_matches PARAMS((char **, int, char *));
122 static void display_matches PARAMS((char **));
123 static int compute_lcd_of_matches PARAMS((char **, int, const char *));
124 static int postprocess_matches PARAMS((char ***, int));
125
126 static char *make_quoted_replacement PARAMS((char *, int, char *));
127
128 /* **************************************************************** */
129 /* */
130 /* Completion matching, from readline's point of view. */
131 /* */
132 /* **************************************************************** */
133
134 /* Variables known only to the readline library. */
135
136 /* If non-zero, non-unique completions always show the list of matches. */
137 int _rl_complete_show_all = 0;
138
139 /* If non-zero, non-unique completions show the list of matches, unless it
140 is not possible to do partial completion and modify the line. */
141 int _rl_complete_show_unmodified = 0;
142
143 /* If non-zero, completed directory names have a slash appended. */
144 int _rl_complete_mark_directories = 1;
145
146 /* If non-zero, the symlinked directory completion behavior introduced in
147 readline-4.2a is disabled, and symlinks that point to directories have
148 a slash appended (subject to the value of _rl_complete_mark_directories).
149 This is user-settable via the mark-symlinked-directories variable. */
150 int _rl_complete_mark_symlink_dirs = 0;
151
152 /* If non-zero, completions are printed horizontally in alphabetical order,
153 like `ls -x'. */
154 int _rl_print_completions_horizontally;
155
156 /* Non-zero means that case is not significant in filename completion. */
157 #if defined (__MSDOS__) && !defined (__DJGPP__)
158 int _rl_completion_case_fold = 1;
159 #else
160 int _rl_completion_case_fold;
161 #endif
162
163 /* If non-zero, don't match hidden files (filenames beginning with a `.' on
164 Unix) when doing filename completion. */
165 int _rl_match_hidden_files = 1;
166
167 /* Length in characters of a common prefix replaced with an ellipsis (`...')
168 when displaying completion matches. Matches whose printable portion has
169 more than this number of displaying characters in common will have the common
170 display prefix replaced with an ellipsis. */
171 int _rl_completion_prefix_display_length = 0;
172
173 /* Global variables available to applications using readline. */
174
175 #if defined (VISIBLE_STATS)
176 /* Non-zero means add an additional character to each filename displayed
177 during listing completion iff rl_filename_completion_desired which helps
178 to indicate the type of file being listed. */
179 int rl_visible_stats = 0;
180 #endif /* VISIBLE_STATS */
181
182 /* If non-zero, then this is the address of a function to call when
183 completing on a directory name. The function is called with
184 the address of a string (the current directory name) as an arg. */
185 rl_icppfunc_t *rl_directory_completion_hook = (rl_icppfunc_t *)NULL;
186
187 rl_icppfunc_t *rl_directory_rewrite_hook = (rl_icppfunc_t *)NULL;
188
189 /* Non-zero means readline completion functions perform tilde expansion. */
190 int rl_complete_with_tilde_expansion = 0;
191
192 /* Pointer to the generator function for completion_matches ().
193 NULL means to use rl_filename_completion_function (), the default filename
194 completer. */
195 rl_compentry_func_t *rl_completion_entry_function = (rl_compentry_func_t *)NULL;
196
197 /* Pointer to generator function for rl_menu_complete (). NULL means to use
198 *rl_completion_entry_function (see above). */
199 rl_compentry_func_t *rl_menu_completion_entry_function = (rl_compentry_func_t *)NULL;
200
201 /* Pointer to alternative function to create matches.
202 Function is called with TEXT, START, and END.
203 START and END are indices in RL_LINE_BUFFER saying what the boundaries
204 of TEXT are.
205 If this function exists and returns NULL then call the value of
206 rl_completion_entry_function to try to match, otherwise use the
207 array of strings returned. */
208 rl_completion_func_t *rl_attempted_completion_function = (rl_completion_func_t *)NULL;
209
210 /* Non-zero means to suppress normal filename completion after the
211 user-specified completion function has been called. */
212 int rl_attempted_completion_over = 0;
213
214 /* Set to a character indicating the type of completion being performed
215 by rl_complete_internal, available for use by application completion
216 functions. */
217 int rl_completion_type = 0;
218
219 /* Up to this many items will be displayed in response to a
220 possible-completions call. After that, we ask the user if
221 she is sure she wants to see them all. A negative value means
222 don't ask. */
223 int rl_completion_query_items = 100;
224
225 int _rl_page_completions = 1;
226
227 /* The basic list of characters that signal a break between words for the
228 completer routine. The contents of this variable is what breaks words
229 in the shell, i.e. " \t\n\"\\'`@$><=" */
230 const char *rl_basic_word_break_characters = " \t\n\"\\'`@$><=;|&{("; /* }) */
231
232 /* List of basic quoting characters. */
233 const char *rl_basic_quote_characters = "\"'";
234
235 /* The list of characters that signal a break between words for
236 rl_complete_internal. The default list is the contents of
237 rl_basic_word_break_characters. */
238 /*const*/ char *rl_completer_word_break_characters = (/*const*/ char *)NULL;
239
240 /* Hook function to allow an application to set the completion word
241 break characters before readline breaks up the line. Allows
242 position-dependent word break characters. */
243 rl_cpvfunc_t *rl_completion_word_break_hook = (rl_cpvfunc_t *)NULL;
244
245 /* List of characters which can be used to quote a substring of the line.
246 Completion occurs on the entire substring, and within the substring
247 rl_completer_word_break_characters are treated as any other character,
248 unless they also appear within this list. */
249 const char *rl_completer_quote_characters = (const char *)NULL;
250
251 /* List of characters that should be quoted in filenames by the completer. */
252 const char *rl_filename_quote_characters = (const char *)NULL;
253
254 /* List of characters that are word break characters, but should be left
255 in TEXT when it is passed to the completion function. The shell uses
256 this to help determine what kind of completing to do. */
257 const char *rl_special_prefixes = (const char *)NULL;
258
259 /* If non-zero, then disallow duplicates in the matches. */
260 int rl_ignore_completion_duplicates = 1;
261
262 /* Non-zero means that the results of the matches are to be treated
263 as filenames. This is ALWAYS zero on entry, and can only be changed
264 within a completion entry finder function. */
265 int rl_filename_completion_desired = 0;
266
267 /* Non-zero means that the results of the matches are to be quoted using
268 double quotes (or an application-specific quoting mechanism) if the
269 filename contains any characters in rl_filename_quote_chars. This is
270 ALWAYS non-zero on entry, and can only be changed within a completion
271 entry finder function. */
272 int rl_filename_quoting_desired = 1;
273
274 /* This function, if defined, is called by the completer when real
275 filename completion is done, after all the matching names have been
276 generated. It is passed a (char**) known as matches in the code below.
277 It consists of a NULL-terminated array of pointers to potential
278 matching strings. The 1st element (matches[0]) is the maximal
279 substring that is common to all matches. This function can re-arrange
280 the list of matches as required, but all elements of the array must be
281 free()'d if they are deleted. The main intent of this function is
282 to implement FIGNORE a la SunOS csh. */
283 rl_compignore_func_t *rl_ignore_some_completions_function = (rl_compignore_func_t *)NULL;
284
285 /* Set to a function to quote a filename in an application-specific fashion.
286 Called with the text to quote, the type of match found (single or multiple)
287 and a pointer to the quoting character to be used, which the function can
288 reset if desired. */
289 rl_quote_func_t *rl_filename_quoting_function = rl_quote_filename;
290
291 /* Function to call to remove quoting characters from a filename. Called
292 before completion is attempted, so the embedded quotes do not interfere
293 with matching names in the file system. Readline doesn't do anything
294 with this; it's set only by applications. */
295 rl_dequote_func_t *rl_filename_dequoting_function = (rl_dequote_func_t *)NULL;
296
297 /* Function to call to decide whether or not a word break character is
298 quoted. If a character is quoted, it does not break words for the
299 completer. */
300 rl_linebuf_func_t *rl_char_is_quoted_p = (rl_linebuf_func_t *)NULL;
301
302 /* If non-zero, the completion functions don't append anything except a
303 possible closing quote. This is set to 0 by rl_complete_internal and
304 may be changed by an application-specific completion function. */
305 int rl_completion_suppress_append = 0;
306
307 /* Character appended to completed words when at the end of the line. The
308 default is a space. */
309 int rl_completion_append_character = ' ';
310
311 /* If non-zero, the completion functions don't append any closing quote.
312 This is set to 0 by rl_complete_internal and may be changed by an
313 application-specific completion function. */
314 int rl_completion_suppress_quote = 0;
315
316 /* Set to any quote character readline thinks it finds before any application
317 completion function is called. */
318 int rl_completion_quote_character;
319
320 /* Set to a non-zero value if readline found quoting anywhere in the word to
321 be completed; set before any application completion function is called. */
322 int rl_completion_found_quote;
323
324 /* If non-zero, a slash will be appended to completed filenames that are
325 symbolic links to directory names, subject to the value of the
326 mark-directories variable (which is user-settable). This exists so
327 that application completion functions can override the user's preference
328 (set via the mark-symlinked-directories variable) if appropriate.
329 It's set to the value of _rl_complete_mark_symlink_dirs in
330 rl_complete_internal before any application-specific completion
331 function is called, so without that function doing anything, the user's
332 preferences are honored. */
333 int rl_completion_mark_symlink_dirs;
334
335 /* If non-zero, inhibit completion (temporarily). */
336 int rl_inhibit_completion;
337
338 /* Set to the last key used to invoke one of the completion functions */
339 int rl_completion_invoking_key;
340
341 /* If non-zero, sort the completion matches. On by default. */
342 int rl_sort_completion_matches = 1;
343
344 /* Variables local to this file. */
345
346 /* Local variable states what happened during the last completion attempt. */
347 static int completion_changed_buffer;
348
349 /* The result of the query to the user about displaying completion matches */
350 static int completion_y_or_n;
351
352 /*************************************/
353 /* */
354 /* Bindable completion functions */
355 /* */
356 /*************************************/
357
358 /* Complete the word at or before point. You have supplied the function
359 that does the initial simple matching selection algorithm (see
360 rl_completion_matches ()). The default is to do filename completion. */
361 int
362 rl_complete (ignore, invoking_key)
363 int ignore, invoking_key;
364 {
365 rl_completion_invoking_key = invoking_key;
366
367 if (rl_inhibit_completion)
368 return (_rl_insert_char (ignore, invoking_key));
369 else if (rl_last_func == rl_complete && !completion_changed_buffer)
370 return (rl_complete_internal ('?'));
371 else if (_rl_complete_show_all)
372 return (rl_complete_internal ('!'));
373 else if (_rl_complete_show_unmodified)
374 return (rl_complete_internal ('@'));
375 else
376 return (rl_complete_internal (TAB));
377 }
378
379 /* List the possible completions. See description of rl_complete (). */
380 int
381 rl_possible_completions (ignore, invoking_key)
382 int ignore, invoking_key;
383 {
384 rl_completion_invoking_key = invoking_key;
385 return (rl_complete_internal ('?'));
386 }
387
388 int
389 rl_insert_completions (ignore, invoking_key)
390 int ignore, invoking_key;
391 {
392 rl_completion_invoking_key = invoking_key;
393 return (rl_complete_internal ('*'));
394 }
395
396 /* Return the correct value to pass to rl_complete_internal performing
397 the same tests as rl_complete. This allows consecutive calls to an
398 application's completion function to list possible completions and for
399 an application-specific completion function to honor the
400 show-all-if-ambiguous readline variable. */
401 int
402 rl_completion_mode (cfunc)
403 rl_command_func_t *cfunc;
404 {
405 if (rl_last_func == cfunc && !completion_changed_buffer)
406 return '?';
407 else if (_rl_complete_show_all)
408 return '!';
409 else if (_rl_complete_show_unmodified)
410 return '@';
411 else
412 return TAB;
413 }
414
415 /************************************/
416 /* */
417 /* Completion utility functions */
418 /* */
419 /************************************/
420
421 /* Reset readline state on a signal or other event. */
422 void
423 _rl_reset_completion_state ()
424 {
425 rl_completion_found_quote = 0;
426 rl_completion_quote_character = 0;
427 }
428
429 /* Set default values for readline word completion. These are the variables
430 that application completion functions can change or inspect. */
431 static void
432 set_completion_defaults (what_to_do)
433 int what_to_do;
434 {
435 /* Only the completion entry function can change these. */
436 rl_filename_completion_desired = 0;
437 rl_filename_quoting_desired = 1;
438 rl_completion_type = what_to_do;
439 rl_completion_suppress_append = rl_completion_suppress_quote = 0;
440 rl_completion_append_character = ' ';
441
442 /* The completion entry function may optionally change this. */
443 rl_completion_mark_symlink_dirs = _rl_complete_mark_symlink_dirs;
444 }
445
446 /* The user must press "y" or "n". Non-zero return means "y" pressed. */
447 static int
448 get_y_or_n (for_pager)
449 int for_pager;
450 {
451 int c;
452
453 for (;;)
454 {
455 RL_SETSTATE(RL_STATE_MOREINPUT);
456 c = rl_read_key ();
457 RL_UNSETSTATE(RL_STATE_MOREINPUT);
458
459 if (c == 'y' || c == 'Y' || c == ' ')
460 return (1);
461 if (c == 'n' || c == 'N' || c == RUBOUT)
462 return (0);
463 if (c == ABORT_CHAR || c < 0)
464 _rl_abort_internal ();
465 if (for_pager && (c == NEWLINE || c == RETURN))
466 return (2);
467 if (for_pager && (c == 'q' || c == 'Q'))
468 return (0);
469 rl_ding ();
470 }
471 }
472
473 static int
474 _rl_internal_pager (lines)
475 int lines;
476 {
477 int i;
478
479 fprintf (rl_outstream, "--More--");
480 fflush (rl_outstream);
481 i = get_y_or_n (1);
482 _rl_erase_entire_line ();
483 if (i == 0)
484 return -1;
485 else if (i == 2)
486 return (lines - 1);
487 else
488 return 0;
489 }
490
491 static int
492 path_isdir (filename)
493 const char *filename;
494 {
495 struct stat finfo;
496
497 return (stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode));
498 }
499
500 #if defined (VISIBLE_STATS)
501 /* Return the character which best describes FILENAME.
502 `@' for symbolic links
503 `/' for directories
504 `*' for executables
505 `=' for sockets
506 `|' for FIFOs
507 `%' for character special devices
508 `#' for block special devices */
509 static int
510 stat_char (filename)
511 char *filename;
512 {
513 struct stat finfo;
514 int character, r;
515
516 /* Short-circuit a //server on cygwin, since that will always behave as
517 a directory. */
518 #if __CYGWIN__
519 if (filename[0] == '/' && filename[1] == '/' && strchr (filename+2, '/') == 0)
520 return '/';
521 #endif
522
523 #if defined (HAVE_LSTAT) && defined (S_ISLNK)
524 r = lstat (filename, &finfo);
525 #else
526 r = stat (filename, &finfo);
527 #endif
528
529 if (r == -1)
530 return (0);
531
532 character = 0;
533 if (S_ISDIR (finfo.st_mode))
534 character = '/';
535 #if defined (S_ISCHR)
536 else if (S_ISCHR (finfo.st_mode))
537 character = '%';
538 #endif /* S_ISCHR */
539 #if defined (S_ISBLK)
540 else if (S_ISBLK (finfo.st_mode))
541 character = '#';
542 #endif /* S_ISBLK */
543 #if defined (S_ISLNK)
544 else if (S_ISLNK (finfo.st_mode))
545 character = '@';
546 #endif /* S_ISLNK */
547 #if defined (S_ISSOCK)
548 else if (S_ISSOCK (finfo.st_mode))
549 character = '=';
550 #endif /* S_ISSOCK */
551 #if defined (S_ISFIFO)
552 else if (S_ISFIFO (finfo.st_mode))
553 character = '|';
554 #endif
555 else if (S_ISREG (finfo.st_mode))
556 {
557 if (access (filename, X_OK) == 0)
558 character = '*';
559 }
560 return (character);
561 }
562 #endif /* VISIBLE_STATS */
563
564 /* Return the portion of PATHNAME that should be output when listing
565 possible completions. If we are hacking filename completion, we
566 are only interested in the basename, the portion following the
567 final slash. Otherwise, we return what we were passed. Since
568 printing empty strings is not very informative, if we're doing
569 filename completion, and the basename is the empty string, we look
570 for the previous slash and return the portion following that. If
571 there's no previous slash, we just return what we were passed. */
572 static char *
573 printable_part (pathname)
574 char *pathname;
575 {
576 char *temp, *x;
577
578 if (rl_filename_completion_desired == 0) /* don't need to do anything */
579 return (pathname);
580
581 temp = strrchr (pathname, '/');
582 #if defined (__MSDOS__)
583 if (temp == 0 && ISALPHA ((unsigned char)pathname[0]) && pathname[1] == ':')
584 temp = pathname + 1;
585 #endif
586
587 if (temp == 0 || *temp == '\0')
588 return (pathname);
589 /* If the basename is NULL, we might have a pathname like '/usr/src/'.
590 Look for a previous slash and, if one is found, return the portion
591 following that slash. If there's no previous slash, just return the
592 pathname we were passed. */
593 else if (temp[1] == '\0')
594 {
595 for (x = temp - 1; x > pathname; x--)
596 if (*x == '/')
597 break;
598 return ((*x == '/') ? x + 1 : pathname);
599 }
600 else
601 return ++temp;
602 }
603
604 /* Compute width of STRING when displayed on screen by print_filename */
605 static int
606 fnwidth (string)
607 const char *string;
608 {
609 int width, pos;
610 #if defined (HANDLE_MULTIBYTE)
611 mbstate_t ps;
612 int left, w;
613 size_t clen;
614 wchar_t wc;
615
616 left = strlen (string) + 1;
617 memset (&ps, 0, sizeof (mbstate_t));
618 #endif
619
620 width = pos = 0;
621 while (string[pos])
622 {
623 if (CTRL_CHAR (string[pos]) || string[pos] == RUBOUT)
624 {
625 width += 2;
626 pos++;
627 }
628 else
629 {
630 #if defined (HANDLE_MULTIBYTE)
631 clen = mbrtowc (&wc, string + pos, left - pos, &ps);
632 if (MB_INVALIDCH (clen))
633 {
634 width++;
635 pos++;
636 memset (&ps, 0, sizeof (mbstate_t));
637 }
638 else if (MB_NULLWCH (clen))
639 break;
640 else
641 {
642 pos += clen;
643 w = wcwidth (wc);
644 width += (w >= 0) ? w : 1;
645 }
646 #else
647 width++;
648 pos++;
649 #endif
650 }
651 }
652
653 return width;
654 }
655
656 #define ELLIPSIS_LEN 3
657
658 static int
659 fnprint (to_print, prefix_bytes)
660 const char *to_print;
661 int prefix_bytes;
662 {
663 int printed_len, w;
664 const char *s;
665 #if defined (HANDLE_MULTIBYTE)
666 mbstate_t ps;
667 const char *end;
668 size_t tlen;
669 int width;
670 wchar_t wc;
671
672 end = to_print + strlen (to_print) + 1;
673 memset (&ps, 0, sizeof (mbstate_t));
674 #endif
675
676 printed_len = 0;
677
678 /* Don't print only the ellipsis if the common prefix is one of the
679 possible completions */
680 if (to_print[prefix_bytes] == '\0')
681 prefix_bytes = 0;
682
683 if (prefix_bytes)
684 {
685 char ellipsis;
686
687 ellipsis = (to_print[prefix_bytes] == '.') ? '_' : '.';
688 for (w = 0; w < ELLIPSIS_LEN; w++)
689 putc (ellipsis, rl_outstream);
690 printed_len = ELLIPSIS_LEN;
691 }
692
693 s = to_print + prefix_bytes;
694 while (*s)
695 {
696 if (CTRL_CHAR (*s))
697 {
698 putc ('^', rl_outstream);
699 putc (UNCTRL (*s), rl_outstream);
700 printed_len += 2;
701 s++;
702 #if defined (HANDLE_MULTIBYTE)
703 memset (&ps, 0, sizeof (mbstate_t));
704 #endif
705 }
706 else if (*s == RUBOUT)
707 {
708 putc ('^', rl_outstream);
709 putc ('?', rl_outstream);
710 printed_len += 2;
711 s++;
712 #if defined (HANDLE_MULTIBYTE)
713 memset (&ps, 0, sizeof (mbstate_t));
714 #endif
715 }
716 else
717 {
718 #if defined (HANDLE_MULTIBYTE)
719 tlen = mbrtowc (&wc, s, end - s, &ps);
720 if (MB_INVALIDCH (tlen))
721 {
722 tlen = 1;
723 width = 1;
724 memset (&ps, 0, sizeof (mbstate_t));
725 }
726 else if (MB_NULLWCH (tlen))
727 break;
728 else
729 {
730 w = wcwidth (wc);
731 width = (w >= 0) ? w : 1;
732 }
733 fwrite (s, 1, tlen, rl_outstream);
734 s += tlen;
735 printed_len += width;
736 #else
737 putc (*s, rl_outstream);
738 s++;
739 printed_len++;
740 #endif
741 }
742 }
743
744 return printed_len;
745 }
746
747 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
748 are using it, check for and output a single character for `special'
749 filenames. Return the number of characters we output. */
750
751 static int
752 print_filename (to_print, full_pathname, prefix_bytes)
753 char *to_print, *full_pathname;
754 int prefix_bytes;
755 {
756 int printed_len, extension_char, slen, tlen;
757 char *s, c, *new_full_pathname, *dn;
758
759 extension_char = 0;
760 printed_len = fnprint (to_print, prefix_bytes);
761
762 #if defined (VISIBLE_STATS)
763 if (rl_filename_completion_desired && (rl_visible_stats || _rl_complete_mark_directories))
764 #else
765 if (rl_filename_completion_desired && _rl_complete_mark_directories)
766 #endif
767 {
768 /* If to_print != full_pathname, to_print is the basename of the
769 path passed. In this case, we try to expand the directory
770 name before checking for the stat character. */
771 if (to_print != full_pathname)
772 {
773 /* Terminate the directory name. */
774 c = to_print[-1];
775 to_print[-1] = '\0';
776
777 /* If setting the last slash in full_pathname to a NUL results in
778 full_pathname being the empty string, we are trying to complete
779 files in the root directory. If we pass a null string to the
780 bash directory completion hook, for example, it will expand it
781 to the current directory. We just want the `/'. */
782 if (full_pathname == 0 || *full_pathname == 0)
783 dn = "/";
784 else if (full_pathname[0] != '/')
785 dn = full_pathname;
786 else if (full_pathname[1] == 0)
787 dn = "//"; /* restore trailing slash to `//' */
788 else if (full_pathname[1] == '/' && full_pathname[2] == 0)
789 dn = "/"; /* don't turn /// into // */
790 else
791 dn = full_pathname;
792 s = tilde_expand (dn);
793 if (rl_directory_completion_hook)
794 (*rl_directory_completion_hook) (&s);
795
796 slen = strlen (s);
797 tlen = strlen (to_print);
798 new_full_pathname = (char *)xmalloc (slen + tlen + 2);
799 strcpy (new_full_pathname, s);
800 if (s[slen - 1] == '/')
801 slen--;
802 else
803 new_full_pathname[slen] = '/';
804 new_full_pathname[slen] = '/';
805 strcpy (new_full_pathname + slen + 1, to_print);
806
807 #if defined (VISIBLE_STATS)
808 if (rl_visible_stats)
809 extension_char = stat_char (new_full_pathname);
810 else
811 #endif
812 if (path_isdir (new_full_pathname))
813 extension_char = '/';
814
815 free (new_full_pathname);
816 to_print[-1] = c;
817 }
818 else
819 {
820 s = tilde_expand (full_pathname);
821 #if defined (VISIBLE_STATS)
822 if (rl_visible_stats)
823 extension_char = stat_char (s);
824 else
825 #endif
826 if (path_isdir (s))
827 extension_char = '/';
828 }
829
830 free (s);
831 if (extension_char)
832 {
833 putc (extension_char, rl_outstream);
834 printed_len++;
835 }
836 }
837
838 return printed_len;
839 }
840
841 static char *
842 rl_quote_filename (s, rtype, qcp)
843 char *s;
844 int rtype;
845 char *qcp;
846 {
847 char *r;
848
849 r = (char *)xmalloc (strlen (s) + 2);
850 *r = *rl_completer_quote_characters;
851 strcpy (r + 1, s);
852 if (qcp)
853 *qcp = *rl_completer_quote_characters;
854 return r;
855 }
856
857 /* Find the bounds of the current word for completion purposes, and leave
858 rl_point set to the end of the word. This function skips quoted
859 substrings (characters between matched pairs of characters in
860 rl_completer_quote_characters). First we try to find an unclosed
861 quoted substring on which to do matching. If one is not found, we use
862 the word break characters to find the boundaries of the current word.
863 We call an application-specific function to decide whether or not a
864 particular word break character is quoted; if that function returns a
865 non-zero result, the character does not break a word. This function
866 returns the opening quote character if we found an unclosed quoted
867 substring, '\0' otherwise. FP, if non-null, is set to a value saying
868 which (shell-like) quote characters we found (single quote, double
869 quote, or backslash) anywhere in the string. DP, if non-null, is set to
870 the value of the delimiter character that caused a word break. */
871
872 char
873 _rl_find_completion_word (fp, dp)
874 int *fp, *dp;
875 {
876 int scan, end, found_quote, delimiter, pass_next, isbrk;
877 char quote_char, *brkchars;
878
879 end = rl_point;
880 found_quote = delimiter = 0;
881 quote_char = '\0';
882
883 brkchars = 0;
884 if (rl_completion_word_break_hook)
885 brkchars = (*rl_completion_word_break_hook) ();
886 if (brkchars == 0)
887 brkchars = rl_completer_word_break_characters;
888
889 if (rl_completer_quote_characters)
890 {
891 /* We have a list of characters which can be used in pairs to
892 quote substrings for the completer. Try to find the start
893 of an unclosed quoted substring. */
894 /* FOUND_QUOTE is set so we know what kind of quotes we found. */
895 for (scan = pass_next = 0; scan < end; scan = MB_NEXTCHAR (rl_line_buffer, scan, 1, MB_FIND_ANY))
896 {
897 if (pass_next)
898 {
899 pass_next = 0;
900 continue;
901 }
902
903 /* Shell-like semantics for single quotes -- don't allow backslash
904 to quote anything in single quotes, especially not the closing
905 quote. If you don't like this, take out the check on the value
906 of quote_char. */
907 if (quote_char != '\'' && rl_line_buffer[scan] == '\\')
908 {
909 pass_next = 1;
910 found_quote |= RL_QF_BACKSLASH;
911 continue;
912 }
913
914 if (quote_char != '\0')
915 {
916 /* Ignore everything until the matching close quote char. */
917 if (rl_line_buffer[scan] == quote_char)
918 {
919 /* Found matching close. Abandon this substring. */
920 quote_char = '\0';
921 rl_point = end;
922 }
923 }
924 else if (strchr (rl_completer_quote_characters, rl_line_buffer[scan]))
925 {
926 /* Found start of a quoted substring. */
927 quote_char = rl_line_buffer[scan];
928 rl_point = scan + 1;
929 /* Shell-like quoting conventions. */
930 if (quote_char == '\'')
931 found_quote |= RL_QF_SINGLE_QUOTE;
932 else if (quote_char == '"')
933 found_quote |= RL_QF_DOUBLE_QUOTE;
934 else
935 found_quote |= RL_QF_OTHER_QUOTE;
936 }
937 }
938 }
939
940 if (rl_point == end && quote_char == '\0')
941 {
942 /* We didn't find an unclosed quoted substring upon which to do
943 completion, so use the word break characters to find the
944 substring on which to complete. */
945 while (rl_point = MB_PREVCHAR (rl_line_buffer, rl_point, MB_FIND_ANY))
946 {
947 scan = rl_line_buffer[rl_point];
948
949 if (strchr (brkchars, scan) == 0)
950 continue;
951
952 /* Call the application-specific function to tell us whether
953 this word break character is quoted and should be skipped. */
954 if (rl_char_is_quoted_p && found_quote &&
955 (*rl_char_is_quoted_p) (rl_line_buffer, rl_point))
956 continue;
957
958 /* Convoluted code, but it avoids an n^2 algorithm with calls
959 to char_is_quoted. */
960 break;
961 }
962 }
963
964 /* If we are at an unquoted word break, then advance past it. */
965 scan = rl_line_buffer[rl_point];
966
967 /* If there is an application-specific function to say whether or not
968 a character is quoted and we found a quote character, let that
969 function decide whether or not a character is a word break, even
970 if it is found in rl_completer_word_break_characters. Don't bother
971 if we're at the end of the line, though. */
972 if (scan)
973 {
974 if (rl_char_is_quoted_p)
975 isbrk = (found_quote == 0 ||
976 (*rl_char_is_quoted_p) (rl_line_buffer, rl_point) == 0) &&
977 strchr (brkchars, scan) != 0;
978 else
979 isbrk = strchr (brkchars, scan) != 0;
980
981 if (isbrk)
982 {
983 /* If the character that caused the word break was a quoting
984 character, then remember it as the delimiter. */
985 if (rl_basic_quote_characters &&
986 strchr (rl_basic_quote_characters, scan) &&
987 (end - rl_point) > 1)
988 delimiter = scan;
989
990 /* If the character isn't needed to determine something special
991 about what kind of completion to perform, then advance past it. */
992 if (rl_special_prefixes == 0 || strchr (rl_special_prefixes, scan) == 0)
993 rl_point++;
994 }
995 }
996
997 if (fp)
998 *fp = found_quote;
999 if (dp)
1000 *dp = delimiter;
1001
1002 return (quote_char);
1003 }
1004
1005 static char **
1006 gen_completion_matches (text, start, end, our_func, found_quote, quote_char)
1007 char *text;
1008 int start, end;
1009 rl_compentry_func_t *our_func;
1010 int found_quote, quote_char;
1011 {
1012 char **matches;
1013
1014 rl_completion_found_quote = found_quote;
1015 rl_completion_quote_character = quote_char;
1016
1017 /* If the user wants to TRY to complete, but then wants to give
1018 up and use the default completion function, they set the
1019 variable rl_attempted_completion_function. */
1020 if (rl_attempted_completion_function)
1021 {
1022 _rl_interrupt_immediately++;
1023 matches = (*rl_attempted_completion_function) (text, start, end);
1024 _rl_interrupt_immediately--;
1025
1026 if (matches || rl_attempted_completion_over)
1027 {
1028 rl_attempted_completion_over = 0;
1029 return (matches);
1030 }
1031 }
1032
1033 /* XXX -- filename dequoting moved into rl_filename_completion_function */
1034
1035 matches = rl_completion_matches (text, our_func);
1036 return matches;
1037 }
1038
1039 /* Filter out duplicates in MATCHES. This frees up the strings in
1040 MATCHES. */
1041 static char **
1042 remove_duplicate_matches (matches)
1043 char **matches;
1044 {
1045 char *lowest_common;
1046 int i, j, newlen;
1047 char dead_slot;
1048 char **temp_array;
1049
1050 /* Sort the items. */
1051 for (i = 0; matches[i]; i++)
1052 ;
1053
1054 /* Sort the array without matches[0], since we need it to
1055 stay in place no matter what. */
1056 if (i && rl_sort_completion_matches)
1057 qsort (matches+1, i-1, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
1058
1059 /* Remember the lowest common denominator for it may be unique. */
1060 lowest_common = savestring (matches[0]);
1061
1062 for (i = newlen = 0; matches[i + 1]; i++)
1063 {
1064 if (strcmp (matches[i], matches[i + 1]) == 0)
1065 {
1066 free (matches[i]);
1067 matches[i] = (char *)&dead_slot;
1068 }
1069 else
1070 newlen++;
1071 }
1072
1073 /* We have marked all the dead slots with (char *)&dead_slot.
1074 Copy all the non-dead entries into a new array. */
1075 temp_array = (char **)xmalloc ((3 + newlen) * sizeof (char *));
1076 for (i = j = 1; matches[i]; i++)
1077 {
1078 if (matches[i] != (char *)&dead_slot)
1079 temp_array[j++] = matches[i];
1080 }
1081 temp_array[j] = (char *)NULL;
1082
1083 if (matches[0] != (char *)&dead_slot)
1084 free (matches[0]);
1085
1086 /* Place the lowest common denominator back in [0]. */
1087 temp_array[0] = lowest_common;
1088
1089 /* If there is one string left, and it is identical to the
1090 lowest common denominator, then the LCD is the string to
1091 insert. */
1092 if (j == 2 && strcmp (temp_array[0], temp_array[1]) == 0)
1093 {
1094 free (temp_array[1]);
1095 temp_array[1] = (char *)NULL;
1096 }
1097 return (temp_array);
1098 }
1099
1100 /* Find the common prefix of the list of matches, and put it into
1101 matches[0]. */
1102 static int
1103 compute_lcd_of_matches (match_list, matches, text)
1104 char **match_list;
1105 int matches;
1106 const char *text;
1107 {
1108 register int i, c1, c2, si;
1109 int low; /* Count of max-matched characters. */
1110 char *dtext; /* dequoted TEXT, if needed */
1111 #if defined (HANDLE_MULTIBYTE)
1112 int v;
1113 mbstate_t ps1, ps2;
1114 wchar_t wc1, wc2;
1115 #endif
1116
1117 /* If only one match, just use that. Otherwise, compare each
1118 member of the list with the next, finding out where they
1119 stop matching. */
1120 if (matches == 1)
1121 {
1122 match_list[0] = match_list[1];
1123 match_list[1] = (char *)NULL;
1124 return 1;
1125 }
1126
1127 for (i = 1, low = 100000; i < matches; i++)
1128 {
1129 #if defined (HANDLE_MULTIBYTE)
1130 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1131 {
1132 memset (&ps1, 0, sizeof (mbstate_t));
1133 memset (&ps2, 0, sizeof (mbstate_t));
1134 }
1135 #endif
1136 if (_rl_completion_case_fold)
1137 {
1138 for (si = 0;
1139 (c1 = _rl_to_lower(match_list[i][si])) &&
1140 (c2 = _rl_to_lower(match_list[i + 1][si]));
1141 si++)
1142 #if defined (HANDLE_MULTIBYTE)
1143 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1144 {
1145 v = mbrtowc (&wc1, match_list[i]+si, strlen (match_list[i]+si), &ps1);
1146 mbrtowc (&wc2, match_list[i+1]+si, strlen (match_list[i+1]+si), &ps2);
1147 wc1 = towlower (wc1);
1148 wc2 = towlower (wc2);
1149 if (wc1 != wc2)
1150 break;
1151 else if (v > 1)
1152 si += v - 1;
1153 }
1154 else
1155 #endif
1156 if (c1 != c2)
1157 break;
1158 }
1159 else
1160 {
1161 for (si = 0;
1162 (c1 = match_list[i][si]) &&
1163 (c2 = match_list[i + 1][si]);
1164 si++)
1165 #if defined (HANDLE_MULTIBYTE)
1166 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1167 {
1168 mbstate_t ps_back;
1169 ps_back = ps1;
1170 if (!_rl_compare_chars (match_list[i], si, &ps1, match_list[i+1], si, &ps2))
1171 break;
1172 else if ((v = _rl_get_char_len (&match_list[i][si], &ps_back)) > 1)
1173 si += v - 1;
1174 }
1175 else
1176 #endif
1177 if (c1 != c2)
1178 break;
1179 }
1180
1181 if (low > si)
1182 low = si;
1183 }
1184
1185 /* If there were multiple matches, but none matched up to even the
1186 first character, and the user typed something, use that as the
1187 value of matches[0]. */
1188 if (low == 0 && text && *text)
1189 {
1190 match_list[0] = (char *)xmalloc (strlen (text) + 1);
1191 strcpy (match_list[0], text);
1192 }
1193 else
1194 {
1195 match_list[0] = (char *)xmalloc (low + 1);
1196
1197 /* XXX - this might need changes in the presence of multibyte chars */
1198
1199 /* If we are ignoring case, try to preserve the case of the string
1200 the user typed in the face of multiple matches differing in case. */
1201 if (_rl_completion_case_fold)
1202 {
1203 /* We're making an assumption here:
1204 IF we're completing filenames AND
1205 the application has defined a filename dequoting function AND
1206 we found a quote character AND
1207 the application has requested filename quoting
1208 THEN
1209 we assume that TEXT was dequoted before checking against
1210 the file system and needs to be dequoted here before we
1211 check against the list of matches
1212 FI */
1213 dtext = (char *)NULL;
1214 if (rl_filename_completion_desired &&
1215 rl_filename_dequoting_function &&
1216 rl_completion_found_quote &&
1217 rl_filename_quoting_desired)
1218 {
1219 dtext = (*rl_filename_dequoting_function) ((char *)text, rl_completion_quote_character);
1220 text = dtext;
1221 }
1222
1223 /* sort the list to get consistent answers. */
1224 qsort (match_list+1, matches, sizeof(char *), (QSFUNC *)_rl_qsort_string_compare);
1225
1226 si = strlen (text);
1227 if (si <= low)
1228 {
1229 for (i = 1; i <= matches; i++)
1230 if (strncmp (match_list[i], text, si) == 0)
1231 {
1232 strncpy (match_list[0], match_list[i], low);
1233 break;
1234 }
1235 /* no casematch, use first entry */
1236 if (i > matches)
1237 strncpy (match_list[0], match_list[1], low);
1238 }
1239 else
1240 /* otherwise, just use the text the user typed. */
1241 strncpy (match_list[0], text, low);
1242
1243 FREE (dtext);
1244 }
1245 else
1246 strncpy (match_list[0], match_list[1], low);
1247
1248 match_list[0][low] = '\0';
1249 }
1250
1251 return matches;
1252 }
1253
1254 static int
1255 postprocess_matches (matchesp, matching_filenames)
1256 char ***matchesp;
1257 int matching_filenames;
1258 {
1259 char *t, **matches, **temp_matches;
1260 int nmatch, i;
1261
1262 matches = *matchesp;
1263
1264 if (matches == 0)
1265 return 0;
1266
1267 /* It seems to me that in all the cases we handle we would like
1268 to ignore duplicate possiblilities. Scan for the text to
1269 insert being identical to the other completions. */
1270 if (rl_ignore_completion_duplicates)
1271 {
1272 temp_matches = remove_duplicate_matches (matches);
1273 free (matches);
1274 matches = temp_matches;
1275 }
1276
1277 /* If we are matching filenames, then here is our chance to
1278 do clever processing by re-examining the list. Call the
1279 ignore function with the array as a parameter. It can
1280 munge the array, deleting matches as it desires. */
1281 if (rl_ignore_some_completions_function && matching_filenames)
1282 {
1283 for (nmatch = 1; matches[nmatch]; nmatch++)
1284 ;
1285 (void)(*rl_ignore_some_completions_function) (matches);
1286 if (matches == 0 || matches[0] == 0)
1287 {
1288 FREE (matches);
1289 *matchesp = (char **)0;
1290 return 0;
1291 }
1292 else
1293 {
1294 /* If we removed some matches, recompute the common prefix. */
1295 for (i = 1; matches[i]; i++)
1296 ;
1297 if (i > 1 && i < nmatch)
1298 {
1299 t = matches[0];
1300 compute_lcd_of_matches (matches, i - 1, t);
1301 FREE (t);
1302 }
1303 }
1304 }
1305
1306 *matchesp = matches;
1307 return (1);
1308 }
1309
1310 /* A convenience function for displaying a list of strings in
1311 columnar format on readline's output stream. MATCHES is the list
1312 of strings, in argv format, LEN is the number of strings in MATCHES,
1313 and MAX is the length of the longest string in MATCHES. */
1314 void
1315 rl_display_match_list (matches, len, max)
1316 char **matches;
1317 int len, max;
1318 {
1319 int count, limit, printed_len, lines;
1320 int i, j, k, l, common_length, sind;
1321 char *temp, *t;
1322
1323 /* Find the length of the prefix common to all items: length as displayed
1324 characters (common_length) and as a byte index into the matches (sind) */
1325 common_length = sind = 0;
1326 if (_rl_completion_prefix_display_length > 0)
1327 {
1328 t = printable_part (matches[0]);
1329 temp = strrchr (t, '/');
1330 common_length = temp ? fnwidth (temp) : fnwidth (t);
1331 sind = temp ? strlen (temp) : strlen (t);
1332
1333 if (common_length > _rl_completion_prefix_display_length && common_length > ELLIPSIS_LEN)
1334 max -= common_length - ELLIPSIS_LEN;
1335 else
1336 common_length = sind = 0;
1337 }
1338
1339 /* How many items of MAX length can we fit in the screen window? */
1340 max += 2;
1341 limit = _rl_screenwidth / max;
1342 if (limit != 1 && (limit * max == _rl_screenwidth))
1343 limit--;
1344
1345 /* Avoid a possible floating exception. If max > _rl_screenwidth,
1346 limit will be 0 and a divide-by-zero fault will result. */
1347 if (limit == 0)
1348 limit = 1;
1349
1350 /* How many iterations of the printing loop? */
1351 count = (len + (limit - 1)) / limit;
1352
1353 /* Watch out for special case. If LEN is less than LIMIT, then
1354 just do the inner printing loop.
1355 0 < len <= limit implies count = 1. */
1356
1357 /* Sort the items if they are not already sorted. */
1358 if (rl_ignore_completion_duplicates == 0 && rl_sort_completion_matches)
1359 qsort (matches + 1, len, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
1360
1361 rl_crlf ();
1362
1363 lines = 0;
1364 if (_rl_print_completions_horizontally == 0)
1365 {
1366 /* Print the sorted items, up-and-down alphabetically, like ls. */
1367 for (i = 1; i <= count; i++)
1368 {
1369 for (j = 0, l = i; j < limit; j++)
1370 {
1371 if (l > len || matches[l] == 0)
1372 break;
1373 else
1374 {
1375 temp = printable_part (matches[l]);
1376 printed_len = print_filename (temp, matches[l], sind);
1377
1378 if (j + 1 < limit)
1379 for (k = 0; k < max - printed_len; k++)
1380 putc (' ', rl_outstream);
1381 }
1382 l += count;
1383 }
1384 rl_crlf ();
1385 lines++;
1386 if (_rl_page_completions && lines >= (_rl_screenheight - 1) && i < count)
1387 {
1388 lines = _rl_internal_pager (lines);
1389 if (lines < 0)
1390 return;
1391 }
1392 }
1393 }
1394 else
1395 {
1396 /* Print the sorted items, across alphabetically, like ls -x. */
1397 for (i = 1; matches[i]; i++)
1398 {
1399 temp = printable_part (matches[i]);
1400 printed_len = print_filename (temp, matches[i], sind);
1401 /* Have we reached the end of this line? */
1402 if (matches[i+1])
1403 {
1404 if (i && (limit > 1) && (i % limit) == 0)
1405 {
1406 rl_crlf ();
1407 lines++;
1408 if (_rl_page_completions && lines >= _rl_screenheight - 1)
1409 {
1410 lines = _rl_internal_pager (lines);
1411 if (lines < 0)
1412 return;
1413 }
1414 }
1415 else
1416 for (k = 0; k < max - printed_len; k++)
1417 putc (' ', rl_outstream);
1418 }
1419 }
1420 rl_crlf ();
1421 }
1422 }
1423
1424 /* Display MATCHES, a list of matching filenames in argv format. This
1425 handles the simple case -- a single match -- first. If there is more
1426 than one match, we compute the number of strings in the list and the
1427 length of the longest string, which will be needed by the display
1428 function. If the application wants to handle displaying the list of
1429 matches itself, it sets RL_COMPLETION_DISPLAY_MATCHES_HOOK to the
1430 address of a function, and we just call it. If we're handling the
1431 display ourselves, we just call rl_display_match_list. We also check
1432 that the list of matches doesn't exceed the user-settable threshold,
1433 and ask the user if he wants to see the list if there are more matches
1434 than RL_COMPLETION_QUERY_ITEMS. */
1435 static void
1436 display_matches (matches)
1437 char **matches;
1438 {
1439 int len, max, i;
1440 char *temp;
1441
1442 /* Move to the last visible line of a possibly-multiple-line command. */
1443 _rl_move_vert (_rl_vis_botlin);
1444
1445 /* Handle simple case first. What if there is only one answer? */
1446 if (matches[1] == 0)
1447 {
1448 temp = printable_part (matches[0]);
1449 rl_crlf ();
1450 print_filename (temp, matches[0], 0);
1451 rl_crlf ();
1452
1453 rl_forced_update_display ();
1454 rl_display_fixed = 1;
1455
1456 return;
1457 }
1458
1459 /* There is more than one answer. Find out how many there are,
1460 and find the maximum printed length of a single entry. */
1461 for (max = 0, i = 1; matches[i]; i++)
1462 {
1463 temp = printable_part (matches[i]);
1464 len = fnwidth (temp);
1465
1466 if (len > max)
1467 max = len;
1468 }
1469
1470 len = i - 1;
1471
1472 /* If the caller has defined a display hook, then call that now. */
1473 if (rl_completion_display_matches_hook)
1474 {
1475 (*rl_completion_display_matches_hook) (matches, len, max);
1476 return;
1477 }
1478
1479 /* If there are many items, then ask the user if she really wants to
1480 see them all. */
1481 if (rl_completion_query_items > 0 && len >= rl_completion_query_items)
1482 {
1483 rl_crlf ();
1484 fprintf (rl_outstream, "Display all %d possibilities? (y or n)", len);
1485 fflush (rl_outstream);
1486 if ((completion_y_or_n = get_y_or_n (0)) == 0)
1487 {
1488 rl_crlf ();
1489
1490 rl_forced_update_display ();
1491 rl_display_fixed = 1;
1492
1493 return;
1494 }
1495 }
1496
1497 rl_display_match_list (matches, len, max);
1498
1499 rl_forced_update_display ();
1500 rl_display_fixed = 1;
1501 }
1502
1503 static char *
1504 make_quoted_replacement (match, mtype, qc)
1505 char *match;
1506 int mtype;
1507 char *qc; /* Pointer to quoting character, if any */
1508 {
1509 int should_quote, do_replace;
1510 char *replacement;
1511
1512 /* If we are doing completion on quoted substrings, and any matches
1513 contain any of the completer_word_break_characters, then auto-
1514 matically prepend the substring with a quote character (just pick
1515 the first one from the list of such) if it does not already begin
1516 with a quote string. FIXME: Need to remove any such automatically
1517 inserted quote character when it no longer is necessary, such as
1518 if we change the string we are completing on and the new set of
1519 matches don't require a quoted substring. */
1520 replacement = match;
1521
1522 should_quote = match && rl_completer_quote_characters &&
1523 rl_filename_completion_desired &&
1524 rl_filename_quoting_desired;
1525
1526 if (should_quote)
1527 should_quote = should_quote && (!qc || !*qc ||
1528 (rl_completer_quote_characters && strchr (rl_completer_quote_characters, *qc)));
1529
1530 if (should_quote)
1531 {
1532 /* If there is a single match, see if we need to quote it.
1533 This also checks whether the common prefix of several
1534 matches needs to be quoted. */
1535 should_quote = rl_filename_quote_characters
1536 ? (_rl_strpbrk (match, rl_filename_quote_characters) != 0)
1537 : 0;
1538
1539 do_replace = should_quote ? mtype : NO_MATCH;
1540 /* Quote the replacement, since we found an embedded
1541 word break character in a potential match. */
1542 if (do_replace != NO_MATCH && rl_filename_quoting_function)
1543 replacement = (*rl_filename_quoting_function) (match, do_replace, qc);
1544 }
1545 return (replacement);
1546 }
1547
1548 static void
1549 insert_match (match, start, mtype, qc)
1550 char *match;
1551 int start, mtype;
1552 char *qc;
1553 {
1554 char *replacement;
1555 char oqc;
1556
1557 oqc = qc ? *qc : '\0';
1558 replacement = make_quoted_replacement (match, mtype, qc);
1559
1560 /* Now insert the match. */
1561 if (replacement)
1562 {
1563 /* Don't double an opening quote character. */
1564 if (qc && *qc && start && rl_line_buffer[start - 1] == *qc &&
1565 replacement[0] == *qc)
1566 start--;
1567 /* If make_quoted_replacement changed the quoting character, remove
1568 the opening quote and insert the (fully-quoted) replacement. */
1569 else if (qc && (*qc != oqc) && start && rl_line_buffer[start - 1] == oqc &&
1570 replacement[0] != oqc)
1571 start--;
1572 _rl_replace_text (replacement, start, rl_point - 1);
1573 if (replacement != match)
1574 free (replacement);
1575 }
1576 }
1577
1578 /* Append any necessary closing quote and a separator character to the
1579 just-inserted match. If the user has specified that directories
1580 should be marked by a trailing `/', append one of those instead. The
1581 default trailing character is a space. Returns the number of characters
1582 appended. If NONTRIVIAL_MATCH is set, we test for a symlink (if the OS
1583 has them) and don't add a suffix for a symlink to a directory. A
1584 nontrivial match is one that actually adds to the word being completed.
1585 The variable rl_completion_mark_symlink_dirs controls this behavior
1586 (it's initially set to the what the user has chosen, indicated by the
1587 value of _rl_complete_mark_symlink_dirs, but may be modified by an
1588 application's completion function). */
1589 static int
1590 append_to_match (text, delimiter, quote_char, nontrivial_match)
1591 char *text;
1592 int delimiter, quote_char, nontrivial_match;
1593 {
1594 char temp_string[4], *filename;
1595 int temp_string_index, s;
1596 struct stat finfo;
1597
1598 temp_string_index = 0;
1599 if (quote_char && rl_point && rl_completion_suppress_quote == 0 &&
1600 rl_line_buffer[rl_point - 1] != quote_char)
1601 temp_string[temp_string_index++] = quote_char;
1602
1603 if (delimiter)
1604 temp_string[temp_string_index++] = delimiter;
1605 else if (rl_completion_suppress_append == 0 && rl_completion_append_character)
1606 temp_string[temp_string_index++] = rl_completion_append_character;
1607
1608 temp_string[temp_string_index++] = '\0';
1609
1610 if (rl_filename_completion_desired)
1611 {
1612 filename = tilde_expand (text);
1613 s = (nontrivial_match && rl_completion_mark_symlink_dirs == 0)
1614 ? LSTAT (filename, &finfo)
1615 : stat (filename, &finfo);
1616 if (s == 0 && S_ISDIR (finfo.st_mode))
1617 {
1618 if (_rl_complete_mark_directories /* && rl_completion_suppress_append == 0 */)
1619 {
1620 /* This is clumsy. Avoid putting in a double slash if point
1621 is at the end of the line and the previous character is a
1622 slash. */
1623 if (rl_point && rl_line_buffer[rl_point] == '\0' && rl_line_buffer[rl_point - 1] == '/')
1624 ;
1625 else if (rl_line_buffer[rl_point] != '/')
1626 rl_insert_text ("/");
1627 }
1628 }
1629 #ifdef S_ISLNK
1630 /* Don't add anything if the filename is a symlink and resolves to a
1631 directory. */
1632 else if (s == 0 && S_ISLNK (finfo.st_mode) &&
1633 stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode))
1634 ;
1635 #endif
1636 else
1637 {
1638 if (rl_point == rl_end && temp_string_index)
1639 rl_insert_text (temp_string);
1640 }
1641 free (filename);
1642 }
1643 else
1644 {
1645 if (rl_point == rl_end && temp_string_index)
1646 rl_insert_text (temp_string);
1647 }
1648
1649 return (temp_string_index);
1650 }
1651
1652 static void
1653 insert_all_matches (matches, point, qc)
1654 char **matches;
1655 int point;
1656 char *qc;
1657 {
1658 int i;
1659 char *rp;
1660
1661 rl_begin_undo_group ();
1662 /* remove any opening quote character; make_quoted_replacement will add
1663 it back. */
1664 if (qc && *qc && point && rl_line_buffer[point - 1] == *qc)
1665 point--;
1666 rl_delete_text (point, rl_point);
1667 rl_point = point;
1668
1669 if (matches[1])
1670 {
1671 for (i = 1; matches[i]; i++)
1672 {
1673 rp = make_quoted_replacement (matches[i], SINGLE_MATCH, qc);
1674 rl_insert_text (rp);
1675 rl_insert_text (" ");
1676 if (rp != matches[i])
1677 free (rp);
1678 }
1679 }
1680 else
1681 {
1682 rp = make_quoted_replacement (matches[0], SINGLE_MATCH, qc);
1683 rl_insert_text (rp);
1684 rl_insert_text (" ");
1685 if (rp != matches[0])
1686 free (rp);
1687 }
1688 rl_end_undo_group ();
1689 }
1690
1691 void
1692 _rl_free_match_list (matches)
1693 char **matches;
1694 {
1695 register int i;
1696
1697 if (matches == 0)
1698 return;
1699
1700 for (i = 0; matches[i]; i++)
1701 free (matches[i]);
1702 free (matches);
1703 }
1704
1705 /* Complete the word at or before point.
1706 WHAT_TO_DO says what to do with the completion.
1707 `?' means list the possible completions.
1708 TAB means do standard completion.
1709 `*' means insert all of the possible completions.
1710 `!' means to do standard completion, and list all possible completions if
1711 there is more than one.
1712 `@' means to do standard completion, and list all possible completions if
1713 there is more than one and partial completion is not possible. */
1714 int
1715 rl_complete_internal (what_to_do)
1716 int what_to_do;
1717 {
1718 char **matches;
1719 rl_compentry_func_t *our_func;
1720 int start, end, delimiter, found_quote, i, nontrivial_lcd;
1721 char *text, *saved_line_buffer;
1722 char quote_char;
1723
1724 RL_SETSTATE(RL_STATE_COMPLETING);
1725
1726 set_completion_defaults (what_to_do);
1727
1728 saved_line_buffer = rl_line_buffer ? savestring (rl_line_buffer) : (char *)NULL;
1729 our_func = rl_completion_entry_function
1730 ? rl_completion_entry_function
1731 : rl_filename_completion_function;
1732 /* We now look backwards for the start of a filename/variable word. */
1733 end = rl_point;
1734 found_quote = delimiter = 0;
1735 quote_char = '\0';
1736
1737 if (rl_point)
1738 /* This (possibly) changes rl_point. If it returns a non-zero char,
1739 we know we have an open quote. */
1740 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
1741
1742 start = rl_point;
1743 rl_point = end;
1744
1745 text = rl_copy_text (start, end);
1746 matches = gen_completion_matches (text, start, end, our_func, found_quote, quote_char);
1747 /* nontrivial_lcd is set if the common prefix adds something to the word
1748 being completed. */
1749 nontrivial_lcd = matches && strcmp (text, matches[0]) != 0;
1750 free (text);
1751
1752 if (matches == 0)
1753 {
1754 rl_ding ();
1755 FREE (saved_line_buffer);
1756 completion_changed_buffer = 0;
1757 RL_UNSETSTATE(RL_STATE_COMPLETING);
1758 _rl_reset_completion_state ();
1759 return (0);
1760 }
1761
1762 /* If we are matching filenames, the attempted completion function will
1763 have set rl_filename_completion_desired to a non-zero value. The basic
1764 rl_filename_completion_function does this. */
1765 i = rl_filename_completion_desired;
1766
1767 if (postprocess_matches (&matches, i) == 0)
1768 {
1769 rl_ding ();
1770 FREE (saved_line_buffer);
1771 completion_changed_buffer = 0;
1772 RL_UNSETSTATE(RL_STATE_COMPLETING);
1773 _rl_reset_completion_state ();
1774 return (0);
1775 }
1776
1777 switch (what_to_do)
1778 {
1779 case TAB:
1780 case '!':
1781 case '@':
1782 /* Insert the first match with proper quoting. */
1783 if (*matches[0])
1784 insert_match (matches[0], start, matches[1] ? MULT_MATCH : SINGLE_MATCH, &quote_char);
1785
1786 /* If there are more matches, ring the bell to indicate.
1787 If we are in vi mode, Posix.2 says to not ring the bell.
1788 If the `show-all-if-ambiguous' variable is set, display
1789 all the matches immediately. Otherwise, if this was the
1790 only match, and we are hacking files, check the file to
1791 see if it was a directory. If so, and the `mark-directories'
1792 variable is set, add a '/' to the name. If not, and we
1793 are at the end of the line, then add a space. */
1794 if (matches[1])
1795 {
1796 if (what_to_do == '!')
1797 {
1798 display_matches (matches);
1799 break;
1800 }
1801 else if (what_to_do == '@')
1802 {
1803 if (nontrivial_lcd == 0)
1804 display_matches (matches);
1805 break;
1806 }
1807 else if (rl_editing_mode != vi_mode)
1808 rl_ding (); /* There are other matches remaining. */
1809 }
1810 else
1811 append_to_match (matches[0], delimiter, quote_char, nontrivial_lcd);
1812
1813 break;
1814
1815 case '*':
1816 insert_all_matches (matches, start, &quote_char);
1817 break;
1818
1819 case '?':
1820 display_matches (matches);
1821 break;
1822
1823 default:
1824 _rl_ttymsg ("bad value %d for what_to_do in rl_complete", what_to_do);
1825 rl_ding ();
1826 FREE (saved_line_buffer);
1827 RL_UNSETSTATE(RL_STATE_COMPLETING);
1828 _rl_reset_completion_state ();
1829 return 1;
1830 }
1831
1832 _rl_free_match_list (matches);
1833
1834 /* Check to see if the line has changed through all of this manipulation. */
1835 if (saved_line_buffer)
1836 {
1837 completion_changed_buffer = strcmp (rl_line_buffer, saved_line_buffer) != 0;
1838 free (saved_line_buffer);
1839 }
1840
1841 RL_UNSETSTATE(RL_STATE_COMPLETING);
1842 _rl_reset_completion_state ();
1843 return 0;
1844 }
1845
1846 /***************************************************************/
1847 /* */
1848 /* Application-callable completion match generator functions */
1849 /* */
1850 /***************************************************************/
1851
1852 /* Return an array of (char *) which is a list of completions for TEXT.
1853 If there are no completions, return a NULL pointer.
1854 The first entry in the returned array is the substitution for TEXT.
1855 The remaining entries are the possible completions.
1856 The array is terminated with a NULL pointer.
1857
1858 ENTRY_FUNCTION is a function of two args, and returns a (char *).
1859 The first argument is TEXT.
1860 The second is a state argument; it should be zero on the first call, and
1861 non-zero on subsequent calls. It returns a NULL pointer to the caller
1862 when there are no more matches.
1863 */
1864 char **
1865 rl_completion_matches (text, entry_function)
1866 const char *text;
1867 rl_compentry_func_t *entry_function;
1868 {
1869 /* Number of slots in match_list. */
1870 int match_list_size;
1871
1872 /* The list of matches. */
1873 char **match_list;
1874
1875 /* Number of matches actually found. */
1876 int matches;
1877
1878 /* Temporary string binder. */
1879 char *string;
1880
1881 matches = 0;
1882 match_list_size = 10;
1883 match_list = (char **)xmalloc ((match_list_size + 1) * sizeof (char *));
1884 match_list[1] = (char *)NULL;
1885
1886 _rl_interrupt_immediately++;
1887 while (string = (*entry_function) (text, matches))
1888 {
1889 if (matches + 1 == match_list_size)
1890 match_list = (char **)xrealloc
1891 (match_list, ((match_list_size += 10) + 1) * sizeof (char *));
1892
1893 match_list[++matches] = string;
1894 match_list[matches + 1] = (char *)NULL;
1895 }
1896 _rl_interrupt_immediately--;
1897
1898 /* If there were any matches, then look through them finding out the
1899 lowest common denominator. That then becomes match_list[0]. */
1900 if (matches)
1901 compute_lcd_of_matches (match_list, matches, text);
1902 else /* There were no matches. */
1903 {
1904 free (match_list);
1905 match_list = (char **)NULL;
1906 }
1907 return (match_list);
1908 }
1909
1910 /* A completion function for usernames.
1911 TEXT contains a partial username preceded by a random
1912 character (usually `~'). */
1913 char *
1914 rl_username_completion_function (text, state)
1915 const char *text;
1916 int state;
1917 {
1918 #if defined (__WIN32__) || defined (__OPENNT)
1919 return (char *)NULL;
1920 #else /* !__WIN32__ && !__OPENNT) */
1921 static char *username = (char *)NULL;
1922 static struct passwd *entry;
1923 static int namelen, first_char, first_char_loc;
1924 char *value;
1925
1926 if (state == 0)
1927 {
1928 FREE (username);
1929
1930 first_char = *text;
1931 first_char_loc = first_char == '~';
1932
1933 username = savestring (&text[first_char_loc]);
1934 namelen = strlen (username);
1935 setpwent ();
1936 }
1937
1938 #if defined (HAVE_GETPWENT)
1939 while (entry = getpwent ())
1940 {
1941 /* Null usernames should result in all users as possible completions. */
1942 if (namelen == 0 || (STREQN (username, entry->pw_name, namelen)))
1943 break;
1944 }
1945 #endif
1946
1947 if (entry == 0)
1948 {
1949 #if defined (HAVE_GETPWENT)
1950 endpwent ();
1951 #endif
1952 return ((char *)NULL);
1953 }
1954 else
1955 {
1956 value = (char *)xmalloc (2 + strlen (entry->pw_name));
1957
1958 *value = *text;
1959
1960 strcpy (value + first_char_loc, entry->pw_name);
1961
1962 if (first_char == '~')
1963 rl_filename_completion_desired = 1;
1964
1965 return (value);
1966 }
1967 #endif /* !__WIN32__ && !__OPENNT */
1968 }
1969
1970 /* Okay, now we write the entry_function for filename completion. In the
1971 general case. Note that completion in the shell is a little different
1972 because of all the pathnames that must be followed when looking up the
1973 completion for a command. */
1974 char *
1975 rl_filename_completion_function (text, state)
1976 const char *text;
1977 int state;
1978 {
1979 static DIR *directory = (DIR *)NULL;
1980 static char *filename = (char *)NULL;
1981 static char *dirname = (char *)NULL;
1982 static char *users_dirname = (char *)NULL;
1983 static int filename_len;
1984 char *temp;
1985 int dirlen;
1986 struct dirent *entry;
1987
1988 /* If we don't have any state, then do some initialization. */
1989 if (state == 0)
1990 {
1991 /* If we were interrupted before closing the directory or reading
1992 all of its contents, close it. */
1993 if (directory)
1994 {
1995 closedir (directory);
1996 directory = (DIR *)NULL;
1997 }
1998 FREE (dirname);
1999 FREE (filename);
2000 FREE (users_dirname);
2001
2002 filename = savestring (text);
2003 if (*text == 0)
2004 text = ".";
2005 dirname = savestring (text);
2006
2007 temp = strrchr (dirname, '/');
2008
2009 #if defined (__MSDOS__)
2010 /* special hack for //X/... */
2011 if (dirname[0] == '/' && dirname[1] == '/' && ISALPHA ((unsigned char)dirname[2]) && dirname[3] == '/')
2012 temp = strrchr (dirname + 3, '/');
2013 #endif
2014
2015 if (temp)
2016 {
2017 strcpy (filename, ++temp);
2018 *temp = '\0';
2019 }
2020 #if defined (__MSDOS__)
2021 /* searches from current directory on the drive */
2022 else if (ISALPHA ((unsigned char)dirname[0]) && dirname[1] == ':')
2023 {
2024 strcpy (filename, dirname + 2);
2025 dirname[2] = '\0';
2026 }
2027 #endif
2028 else
2029 {
2030 dirname[0] = '.';
2031 dirname[1] = '\0';
2032 }
2033
2034 /* We aren't done yet. We also support the "~user" syntax. */
2035
2036 /* Save the version of the directory that the user typed. */
2037 users_dirname = savestring (dirname);
2038
2039 if (*dirname == '~')
2040 {
2041 temp = tilde_expand (dirname);
2042 free (dirname);
2043 dirname = temp;
2044 }
2045
2046 if (rl_directory_rewrite_hook)
2047 (*rl_directory_rewrite_hook) (&dirname);
2048
2049 /* The directory completion hook should perform any necessary
2050 dequoting. */
2051 if (rl_directory_completion_hook && (*rl_directory_completion_hook) (&dirname))
2052 {
2053 free (users_dirname);
2054 users_dirname = savestring (dirname);
2055 }
2056 else if (rl_completion_found_quote && rl_filename_dequoting_function)
2057 {
2058 /* delete single and double quotes */
2059 temp = (*rl_filename_dequoting_function) (users_dirname, rl_completion_quote_character);
2060 free (users_dirname);
2061 users_dirname = temp;
2062 }
2063 directory = opendir (dirname);
2064
2065 /* Now dequote a non-null filename. */
2066 if (filename && *filename && rl_completion_found_quote && rl_filename_dequoting_function)
2067 {
2068 /* delete single and double quotes */
2069 temp = (*rl_filename_dequoting_function) (filename, rl_completion_quote_character);
2070 free (filename);
2071 filename = temp;
2072 }
2073 filename_len = strlen (filename);
2074
2075 rl_filename_completion_desired = 1;
2076 }
2077
2078 /* At this point we should entertain the possibility of hacking wildcarded
2079 filenames, like /usr/man/man<WILD>/te<TAB>. If the directory name
2080 contains globbing characters, then build an array of directories, and
2081 then map over that list while completing. */
2082 /* *** UNIMPLEMENTED *** */
2083
2084 /* Now that we have some state, we can read the directory. */
2085
2086 entry = (struct dirent *)NULL;
2087 while (directory && (entry = readdir (directory)))
2088 {
2089 /* Special case for no filename. If the user has disabled the
2090 `match-hidden-files' variable, skip filenames beginning with `.'.
2091 All other entries except "." and ".." match. */
2092 if (filename_len == 0)
2093 {
2094 if (_rl_match_hidden_files == 0 && HIDDEN_FILE (entry->d_name))
2095 continue;
2096
2097 if (entry->d_name[0] != '.' ||
2098 (entry->d_name[1] &&
2099 (entry->d_name[1] != '.' || entry->d_name[2])))
2100 break;
2101 }
2102 else
2103 {
2104 /* Otherwise, if these match up to the length of filename, then
2105 it is a match. */
2106 if (_rl_completion_case_fold)
2107 {
2108 if ((_rl_to_lower (entry->d_name[0]) == _rl_to_lower (filename[0])) &&
2109 (((int)D_NAMLEN (entry)) >= filename_len) &&
2110 (_rl_strnicmp (filename, entry->d_name, filename_len) == 0))
2111 break;
2112 }
2113 else
2114 {
2115 if ((entry->d_name[0] == filename[0]) &&
2116 (((int)D_NAMLEN (entry)) >= filename_len) &&
2117 (strncmp (filename, entry->d_name, filename_len) == 0))
2118 break;
2119 }
2120 }
2121 }
2122
2123 if (entry == 0)
2124 {
2125 if (directory)
2126 {
2127 closedir (directory);
2128 directory = (DIR *)NULL;
2129 }
2130 if (dirname)
2131 {
2132 free (dirname);
2133 dirname = (char *)NULL;
2134 }
2135 if (filename)
2136 {
2137 free (filename);
2138 filename = (char *)NULL;
2139 }
2140 if (users_dirname)
2141 {
2142 free (users_dirname);
2143 users_dirname = (char *)NULL;
2144 }
2145
2146 return (char *)NULL;
2147 }
2148 else
2149 {
2150 /* dirname && (strcmp (dirname, ".") != 0) */
2151 if (dirname && (dirname[0] != '.' || dirname[1]))
2152 {
2153 if (rl_complete_with_tilde_expansion && *users_dirname == '~')
2154 {
2155 dirlen = strlen (dirname);
2156 temp = (char *)xmalloc (2 + dirlen + D_NAMLEN (entry));
2157 strcpy (temp, dirname);
2158 /* Canonicalization cuts off any final slash present. We
2159 may need to add it back. */
2160 if (dirname[dirlen - 1] != '/')
2161 {
2162 temp[dirlen++] = '/';
2163 temp[dirlen] = '\0';
2164 }
2165 }
2166 else
2167 {
2168 dirlen = strlen (users_dirname);
2169 temp = (char *)xmalloc (2 + dirlen + D_NAMLEN (entry));
2170 strcpy (temp, users_dirname);
2171 /* Make sure that temp has a trailing slash here. */
2172 if (users_dirname[dirlen - 1] != '/')
2173 temp[dirlen++] = '/';
2174 }
2175
2176 strcpy (temp + dirlen, entry->d_name);
2177 }
2178 else
2179 temp = savestring (entry->d_name);
2180
2181 return (temp);
2182 }
2183 }
2184
2185 /* An initial implementation of a menu completion function a la tcsh. The
2186 first time (if the last readline command was not rl_menu_complete), we
2187 generate the list of matches. This code is very similar to the code in
2188 rl_complete_internal -- there should be a way to combine the two. Then,
2189 for each item in the list of matches, we insert the match in an undoable
2190 fashion, with the appropriate character appended (this happens on the
2191 second and subsequent consecutive calls to rl_menu_complete). When we
2192 hit the end of the match list, we restore the original unmatched text,
2193 ring the bell, and reset the counter to zero. */
2194 int
2195 rl_old_menu_complete (count, invoking_key)
2196 int count, invoking_key;
2197 {
2198 rl_compentry_func_t *our_func;
2199 int matching_filenames, found_quote;
2200
2201 static char *orig_text;
2202 static char **matches = (char **)0;
2203 static int match_list_index = 0;
2204 static int match_list_size = 0;
2205 static int orig_start, orig_end;
2206 static char quote_char;
2207 static int delimiter;
2208
2209 /* The first time through, we generate the list of matches and set things
2210 up to insert them. */
2211 if (rl_last_func != rl_old_menu_complete)
2212 {
2213 /* Clean up from previous call, if any. */
2214 FREE (orig_text);
2215 if (matches)
2216 _rl_free_match_list (matches);
2217
2218 match_list_index = match_list_size = 0;
2219 matches = (char **)NULL;
2220
2221 rl_completion_invoking_key = invoking_key;
2222
2223 RL_SETSTATE(RL_STATE_COMPLETING);
2224
2225 /* Only the completion entry function can change these. */
2226 set_completion_defaults ('%');
2227
2228 our_func = rl_menu_completion_entry_function;
2229 if (our_func == 0)
2230 our_func = rl_completion_entry_function
2231 ? rl_completion_entry_function
2232 : rl_filename_completion_function;
2233
2234 /* We now look backwards for the start of a filename/variable word. */
2235 orig_end = rl_point;
2236 found_quote = delimiter = 0;
2237 quote_char = '\0';
2238
2239 if (rl_point)
2240 /* This (possibly) changes rl_point. If it returns a non-zero char,
2241 we know we have an open quote. */
2242 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
2243
2244 orig_start = rl_point;
2245 rl_point = orig_end;
2246
2247 orig_text = rl_copy_text (orig_start, orig_end);
2248 matches = gen_completion_matches (orig_text, orig_start, orig_end,
2249 our_func, found_quote, quote_char);
2250
2251 /* If we are matching filenames, the attempted completion function will
2252 have set rl_filename_completion_desired to a non-zero value. The basic
2253 rl_filename_completion_function does this. */
2254 matching_filenames = rl_filename_completion_desired;
2255
2256 if (matches == 0 || postprocess_matches (&matches, matching_filenames) == 0)
2257 {
2258 rl_ding ();
2259 FREE (matches);
2260 matches = (char **)0;
2261 FREE (orig_text);
2262 orig_text = (char *)0;
2263 completion_changed_buffer = 0;
2264 RL_UNSETSTATE(RL_STATE_COMPLETING);
2265 return (0);
2266 }
2267
2268 RL_UNSETSTATE(RL_STATE_COMPLETING);
2269
2270 for (match_list_size = 0; matches[match_list_size]; match_list_size++)
2271 ;
2272 /* matches[0] is lcd if match_list_size > 1, but the circular buffer
2273 code below should take care of it. */
2274
2275 if (match_list_size > 1 && _rl_complete_show_all)
2276 display_matches (matches);
2277 }
2278
2279 /* Now we have the list of matches. Replace the text between
2280 rl_line_buffer[orig_start] and rl_line_buffer[rl_point] with
2281 matches[match_list_index], and add any necessary closing char. */
2282
2283 if (matches == 0 || match_list_size == 0)
2284 {
2285 rl_ding ();
2286 FREE (matches);
2287 matches = (char **)0;
2288 completion_changed_buffer = 0;
2289 return (0);
2290 }
2291
2292 match_list_index += count;
2293 if (match_list_index < 0)
2294 match_list_index += match_list_size;
2295 else
2296 match_list_index %= match_list_size;
2297
2298 if (match_list_index == 0 && match_list_size > 1)
2299 {
2300 rl_ding ();
2301 insert_match (orig_text, orig_start, MULT_MATCH, &quote_char);
2302 }
2303 else
2304 {
2305 insert_match (matches[match_list_index], orig_start, SINGLE_MATCH, &quote_char);
2306 append_to_match (matches[match_list_index], delimiter, quote_char,
2307 strcmp (orig_text, matches[match_list_index]));
2308 }
2309
2310 completion_changed_buffer = 1;
2311 return (0);
2312 }
2313
2314 int
2315 rl_menu_complete (count, ignore)
2316 int count, ignore;
2317 {
2318 rl_compentry_func_t *our_func;
2319 int matching_filenames, found_quote;
2320
2321 static char *orig_text;
2322 static char **matches = (char **)0;
2323 static int match_list_index = 0;
2324 static int match_list_size = 0;
2325 static int nontrivial_lcd = 0;
2326 static int full_completion = 0; /* set to 1 if menu completion should reinitialize on next call */
2327 static int orig_start, orig_end;
2328 static char quote_char;
2329 static int delimiter;
2330
2331 /* The first time through, we generate the list of matches and set things
2332 up to insert them. */
2333 if (rl_last_func != rl_menu_complete || full_completion)
2334 {
2335 /* Clean up from previous call, if any. */
2336 FREE (orig_text);
2337 if (matches)
2338 _rl_free_match_list (matches);
2339
2340 match_list_index = match_list_size = 0;
2341 matches = (char **)NULL;
2342
2343 full_completion = 0;
2344
2345 RL_SETSTATE(RL_STATE_COMPLETING);
2346
2347 /* Only the completion entry function can change these. */
2348 set_completion_defaults ('%');
2349
2350 our_func = rl_menu_completion_entry_function;
2351 if (our_func == 0)
2352 our_func = rl_completion_entry_function
2353 ? rl_completion_entry_function
2354 : rl_filename_completion_function;
2355
2356 /* We now look backwards for the start of a filename/variable word. */
2357 orig_end = rl_point;
2358 found_quote = delimiter = 0;
2359 quote_char = '\0';
2360
2361 if (rl_point)
2362 /* This (possibly) changes rl_point. If it returns a non-zero char,
2363 we know we have an open quote. */
2364 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
2365
2366 orig_start = rl_point;
2367 rl_point = orig_end;
2368
2369 orig_text = rl_copy_text (orig_start, orig_end);
2370 matches = gen_completion_matches (orig_text, orig_start, orig_end,
2371 our_func, found_quote, quote_char);
2372
2373 nontrivial_lcd = matches && strcmp (orig_text, matches[0]) != 0;
2374
2375 /* If we are matching filenames, the attempted completion function will
2376 have set rl_filename_completion_desired to a non-zero value. The basic
2377 rl_filename_completion_function does this. */
2378 matching_filenames = rl_filename_completion_desired;
2379
2380 if (matches == 0 || postprocess_matches (&matches, matching_filenames) == 0)
2381 {
2382 rl_ding ();
2383 FREE (matches);
2384 matches = (char **)0;
2385 FREE (orig_text);
2386 orig_text = (char *)0;
2387 completion_changed_buffer = 0;
2388 RL_UNSETSTATE(RL_STATE_COMPLETING);
2389 return (0);
2390 }
2391
2392 RL_UNSETSTATE(RL_STATE_COMPLETING);
2393
2394 for (match_list_size = 0; matches[match_list_size]; match_list_size++)
2395 ;
2396
2397 if (match_list_size == 0)
2398 {
2399 rl_ding ();
2400 FREE (matches);
2401 matches = (char **)0;
2402 match_list_index = 0;
2403 completion_changed_buffer = 0;
2404 return (0);
2405 }
2406
2407 /* matches[0] is lcd if match_list_size > 1, but the circular buffer
2408 code below should take care of it. */
2409 if (*matches[0])
2410 {
2411 insert_match (matches[0], orig_start, matches[1] ? MULT_MATCH : SINGLE_MATCH, &quote_char);
2412 orig_end = orig_start + strlen (matches[0]);
2413 completion_changed_buffer = STREQ (orig_text, matches[0]) == 0;
2414 }
2415
2416 if (match_list_size > 1 && _rl_complete_show_all)
2417 {
2418 display_matches (matches);
2419 /* If there are so many matches that the user has to be asked
2420 whether or not he wants to see the matches, menu completion
2421 is unwieldy. */
2422 if (rl_completion_query_items > 0 && match_list_size >= rl_completion_query_items)
2423 {
2424 rl_ding ();
2425 FREE (matches);
2426 matches = (char **)0;
2427 full_completion = 1;
2428 return (0);
2429 }
2430 }
2431 else if (match_list_size <= 1)
2432 {
2433 append_to_match (matches[0], delimiter, quote_char, nontrivial_lcd);
2434 full_completion = 1;
2435 return (0);
2436 }
2437 }
2438
2439 /* Now we have the list of matches. Replace the text between
2440 rl_line_buffer[orig_start] and rl_line_buffer[rl_point] with
2441 matches[match_list_index], and add any necessary closing char. */
2442
2443 if (matches == 0 || match_list_size == 0)
2444 {
2445 rl_ding ();
2446 FREE (matches);
2447 matches = (char **)0;
2448 completion_changed_buffer = 0;
2449 return (0);
2450 }
2451
2452 match_list_index += count;
2453 if (match_list_index < 0)
2454 match_list_index += match_list_size;
2455 else
2456 match_list_index %= match_list_size;
2457
2458 if (match_list_index == 0 && match_list_size > 1)
2459 {
2460 rl_ding ();
2461 insert_match (matches[0], orig_start, MULT_MATCH, &quote_char);
2462 }
2463 else
2464 {
2465 insert_match (matches[match_list_index], orig_start, SINGLE_MATCH, &quote_char);
2466 append_to_match (matches[match_list_index], delimiter, quote_char,
2467 strcmp (orig_text, matches[match_list_index]));
2468 }
2469
2470 completion_changed_buffer = 1;
2471 return (0);
2472 }