1 /* complete.c -- filename completion for readline. */
3 /* Copyright (C) 1987-2011 Free Software Foundation, Inc.
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.
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.
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.
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/>.
22 #define READLINE_LIBRARY
24 #if defined (HAVE_CONFIG_H)
28 #include <sys/types.h>
30 #if defined (HAVE_SYS_FILE_H)
31 # include <sys/file.h>
34 #if defined (HAVE_UNISTD_H)
36 #endif /* HAVE_UNISTD_H */
38 #if defined (HAVE_STDLIB_H)
41 # include "ansi_stdlib.h"
42 #endif /* HAVE_STDLIB_H */
51 #if defined (HAVE_PWD_H)
56 #include "posixstat.h"
58 /* System-specific feature definitions and include files. */
62 /* Some standard library routines. */
65 #include "rlprivate.h"
68 typedef int QSFUNC (const void *, const void *);
70 typedef int QSFUNC ();
79 /* Unix version of a hidden file. Could be different on other systems. */
80 #define HIDDEN_FILE(fname) ((fname)[0] == '.')
82 /* Most systems don't declare getpwent in <pwd.h> if _POSIX_SOURCE is
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) */
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;
97 #if defined (VISIBLE_STATS)
101 static int stat_char PARAMS((char *));
104 static int path_isdir PARAMS((const char *));
106 static char *rl_quote_filename PARAMS((char *, int, char *));
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));
116 static char **gen_completion_matches PARAMS((char *, int, int, rl_compentry_func_t *, int, int));
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 int complete_fncmp PARAMS((const char *, int, const char *, int));
123 static void display_matches PARAMS((char **));
124 static int compute_lcd_of_matches PARAMS((char **, int, const char *));
125 static int postprocess_matches PARAMS((char ***, int));
126 static int complete_get_screenwidth PARAMS((void));
128 static char *make_quoted_replacement PARAMS((char *, int, char *));
130 /* **************************************************************** */
132 /* Completion matching, from readline's point of view. */
134 /* **************************************************************** */
136 /* Variables known only to the readline library. */
138 /* If non-zero, non-unique completions always show the list of matches. */
139 int _rl_complete_show_all = 0;
141 /* If non-zero, non-unique completions show the list of matches, unless it
142 is not possible to do partial completion and modify the line. */
143 int _rl_complete_show_unmodified = 0;
145 /* If non-zero, completed directory names have a slash appended. */
146 int _rl_complete_mark_directories = 1;
148 /* If non-zero, the symlinked directory completion behavior introduced in
149 readline-4.2a is disabled, and symlinks that point to directories have
150 a slash appended (subject to the value of _rl_complete_mark_directories).
151 This is user-settable via the mark-symlinked-directories variable. */
152 int _rl_complete_mark_symlink_dirs = 0;
154 /* If non-zero, completions are printed horizontally in alphabetical order,
156 int _rl_print_completions_horizontally;
158 /* Non-zero means that case is not significant in filename completion. */
159 #if defined (__MSDOS__) && !defined (__DJGPP__)
160 int _rl_completion_case_fold = 1;
162 int _rl_completion_case_fold = 0;
165 /* Non-zero means that `-' and `_' are equivalent when comparing filenames
167 int _rl_completion_case_map = 0;
169 /* If zero, don't match hidden files (filenames beginning with a `.' on
170 Unix) when doing filename completion. */
171 int _rl_match_hidden_files = 1;
173 /* Length in characters of a common prefix replaced with an ellipsis (`...')
174 when displaying completion matches. Matches whose printable portion has
175 more than this number of displaying characters in common will have the common
176 display prefix replaced with an ellipsis. */
177 int _rl_completion_prefix_display_length = 0;
179 /* The readline-private number of screen columns to use when displaying
180 matches. If < 0 or > _rl_screenwidth, it is ignored. */
181 int _rl_completion_columns = -1;
183 /* Global variables available to applications using readline. */
185 #if defined (VISIBLE_STATS)
186 /* Non-zero means add an additional character to each filename displayed
187 during listing completion iff rl_filename_completion_desired which helps
188 to indicate the type of file being listed. */
189 int rl_visible_stats = 0;
190 #endif /* VISIBLE_STATS */
192 /* If non-zero, when completing in the middle of a word, don't insert
193 characters from the match that match characters following point in
194 the word. This means, for instance, completing when the cursor is
195 after the `e' in `Makefile' won't result in `Makefilefile'. */
196 int _rl_skip_completed_text = 0;
198 /* If non-zero, menu completion displays the common prefix first in the
199 cycle of possible completions instead of the last. */
200 int _rl_menu_complete_prefix_first = 0;
202 /* If non-zero, then this is the address of a function to call when
203 completing on a directory name. The function is called with
204 the address of a string (the current directory name) as an arg. */
205 rl_icppfunc_t *rl_directory_completion_hook = (rl_icppfunc_t *)NULL;
207 rl_icppfunc_t *rl_directory_rewrite_hook = (rl_icppfunc_t *)NULL;
209 /* If non-zero, this is the address of a function to call when reading
210 directory entries from the filesystem for completion and comparing
211 them to the partial word to be completed. The function should
212 either return its first argument (if no conversion takes place) or
213 newly-allocated memory. This can, for instance, convert filenames
214 between character sets for comparison against what's typed at the
215 keyboard. The returned value is what is added to the list of
216 matches. The second argument is the length of the filename to be
218 rl_dequote_func_t *rl_filename_rewrite_hook = (rl_dequote_func_t *)NULL;
220 /* Non-zero means readline completion functions perform tilde expansion. */
221 int rl_complete_with_tilde_expansion = 0;
223 /* Pointer to the generator function for completion_matches ().
224 NULL means to use rl_filename_completion_function (), the default filename
226 rl_compentry_func_t *rl_completion_entry_function = (rl_compentry_func_t *)NULL;
228 /* Pointer to generator function for rl_menu_complete (). NULL means to use
229 *rl_completion_entry_function (see above). */
230 rl_compentry_func_t *rl_menu_completion_entry_function = (rl_compentry_func_t *)NULL;
232 /* Pointer to alternative function to create matches.
233 Function is called with TEXT, START, and END.
234 START and END are indices in RL_LINE_BUFFER saying what the boundaries
236 If this function exists and returns NULL then call the value of
237 rl_completion_entry_function to try to match, otherwise use the
238 array of strings returned. */
239 rl_completion_func_t *rl_attempted_completion_function = (rl_completion_func_t *)NULL;
241 /* Non-zero means to suppress normal filename completion after the
242 user-specified completion function has been called. */
243 int rl_attempted_completion_over = 0;
245 /* Set to a character indicating the type of completion being performed
246 by rl_complete_internal, available for use by application completion
248 int rl_completion_type = 0;
250 /* Up to this many items will be displayed in response to a
251 possible-completions call. After that, we ask the user if
252 she is sure she wants to see them all. A negative value means
254 int rl_completion_query_items = 100;
256 int _rl_page_completions = 1;
258 /* The basic list of characters that signal a break between words for the
259 completer routine. The contents of this variable is what breaks words
260 in the shell, i.e. " \t\n\"\\'`@$><=" */
261 const char *rl_basic_word_break_characters = " \t\n\"\\'`@$><=;|&{("; /* }) */
263 /* List of basic quoting characters. */
264 const char *rl_basic_quote_characters = "\"'";
266 /* The list of characters that signal a break between words for
267 rl_complete_internal. The default list is the contents of
268 rl_basic_word_break_characters. */
269 /*const*/ char *rl_completer_word_break_characters = (/*const*/ char *)NULL;
271 /* Hook function to allow an application to set the completion word
272 break characters before readline breaks up the line. Allows
273 position-dependent word break characters. */
274 rl_cpvfunc_t *rl_completion_word_break_hook = (rl_cpvfunc_t *)NULL;
276 /* List of characters which can be used to quote a substring of the line.
277 Completion occurs on the entire substring, and within the substring
278 rl_completer_word_break_characters are treated as any other character,
279 unless they also appear within this list. */
280 const char *rl_completer_quote_characters = (const char *)NULL;
282 /* List of characters that should be quoted in filenames by the completer. */
283 const char *rl_filename_quote_characters = (const char *)NULL;
285 /* List of characters that are word break characters, but should be left
286 in TEXT when it is passed to the completion function. The shell uses
287 this to help determine what kind of completing to do. */
288 const char *rl_special_prefixes = (const char *)NULL;
290 /* If non-zero, then disallow duplicates in the matches. */
291 int rl_ignore_completion_duplicates = 1;
293 /* Non-zero means that the results of the matches are to be treated
294 as filenames. This is ALWAYS zero on entry, and can only be changed
295 within a completion entry finder function. */
296 int rl_filename_completion_desired = 0;
298 /* Non-zero means that the results of the matches are to be quoted using
299 double quotes (or an application-specific quoting mechanism) if the
300 filename contains any characters in rl_filename_quote_chars. This is
301 ALWAYS non-zero on entry, and can only be changed within a completion
302 entry finder function. */
303 int rl_filename_quoting_desired = 1;
305 /* This function, if defined, is called by the completer when real
306 filename completion is done, after all the matching names have been
307 generated. It is passed a (char**) known as matches in the code below.
308 It consists of a NULL-terminated array of pointers to potential
309 matching strings. The 1st element (matches[0]) is the maximal
310 substring that is common to all matches. This function can re-arrange
311 the list of matches as required, but all elements of the array must be
312 free()'d if they are deleted. The main intent of this function is
313 to implement FIGNORE a la SunOS csh. */
314 rl_compignore_func_t *rl_ignore_some_completions_function = (rl_compignore_func_t *)NULL;
316 /* Set to a function to quote a filename in an application-specific fashion.
317 Called with the text to quote, the type of match found (single or multiple)
318 and a pointer to the quoting character to be used, which the function can
320 rl_quote_func_t *rl_filename_quoting_function = rl_quote_filename;
322 /* Function to call to remove quoting characters from a filename. Called
323 before completion is attempted, so the embedded quotes do not interfere
324 with matching names in the file system. Readline doesn't do anything
325 with this; it's set only by applications. */
326 rl_dequote_func_t *rl_filename_dequoting_function = (rl_dequote_func_t *)NULL;
328 /* Function to call to decide whether or not a word break character is
329 quoted. If a character is quoted, it does not break words for the
331 rl_linebuf_func_t *rl_char_is_quoted_p = (rl_linebuf_func_t *)NULL;
333 /* If non-zero, the completion functions don't append anything except a
334 possible closing quote. This is set to 0 by rl_complete_internal and
335 may be changed by an application-specific completion function. */
336 int rl_completion_suppress_append = 0;
338 /* Character appended to completed words when at the end of the line. The
339 default is a space. */
340 int rl_completion_append_character = ' ';
342 /* If non-zero, the completion functions don't append any closing quote.
343 This is set to 0 by rl_complete_internal and may be changed by an
344 application-specific completion function. */
345 int rl_completion_suppress_quote = 0;
347 /* Set to any quote character readline thinks it finds before any application
348 completion function is called. */
349 int rl_completion_quote_character;
351 /* Set to a non-zero value if readline found quoting anywhere in the word to
352 be completed; set before any application completion function is called. */
353 int rl_completion_found_quote;
355 /* If non-zero, a slash will be appended to completed filenames that are
356 symbolic links to directory names, subject to the value of the
357 mark-directories variable (which is user-settable). This exists so
358 that application completion functions can override the user's preference
359 (set via the mark-symlinked-directories variable) if appropriate.
360 It's set to the value of _rl_complete_mark_symlink_dirs in
361 rl_complete_internal before any application-specific completion
362 function is called, so without that function doing anything, the user's
363 preferences are honored. */
364 int rl_completion_mark_symlink_dirs;
366 /* If non-zero, inhibit completion (temporarily). */
367 int rl_inhibit_completion;
369 /* Set to the last key used to invoke one of the completion functions */
370 int rl_completion_invoking_key;
372 /* If non-zero, sort the completion matches. On by default. */
373 int rl_sort_completion_matches = 1;
375 /* Variables local to this file. */
377 /* Local variable states what happened during the last completion attempt. */
378 static int completion_changed_buffer;
380 /* The result of the query to the user about displaying completion matches */
381 static int completion_y_or_n;
383 /*************************************/
385 /* Bindable completion functions */
387 /*************************************/
389 /* Complete the word at or before point. You have supplied the function
390 that does the initial simple matching selection algorithm (see
391 rl_completion_matches ()). The default is to do filename completion. */
393 rl_complete (ignore, invoking_key)
394 int ignore, invoking_key;
396 rl_completion_invoking_key = invoking_key;
398 if (rl_inhibit_completion)
399 return (_rl_insert_char (ignore, invoking_key));
400 else if (rl_last_func == rl_complete && !completion_changed_buffer)
401 return (rl_complete_internal ('?'));
402 else if (_rl_complete_show_all)
403 return (rl_complete_internal ('!'));
404 else if (_rl_complete_show_unmodified)
405 return (rl_complete_internal ('@'));
407 return (rl_complete_internal (TAB));
410 /* List the possible completions. See description of rl_complete (). */
412 rl_possible_completions (ignore, invoking_key)
413 int ignore, invoking_key;
415 rl_completion_invoking_key = invoking_key;
416 return (rl_complete_internal ('?'));
420 rl_insert_completions (ignore, invoking_key)
421 int ignore, invoking_key;
423 rl_completion_invoking_key = invoking_key;
424 return (rl_complete_internal ('*'));
427 /* Return the correct value to pass to rl_complete_internal performing
428 the same tests as rl_complete. This allows consecutive calls to an
429 application's completion function to list possible completions and for
430 an application-specific completion function to honor the
431 show-all-if-ambiguous readline variable. */
433 rl_completion_mode (cfunc)
434 rl_command_func_t *cfunc;
436 if (rl_last_func == cfunc && !completion_changed_buffer)
438 else if (_rl_complete_show_all)
440 else if (_rl_complete_show_unmodified)
446 /************************************/
448 /* Completion utility functions */
450 /************************************/
452 /* Reset readline state on a signal or other event. */
454 _rl_reset_completion_state ()
456 rl_completion_found_quote = 0;
457 rl_completion_quote_character = 0;
460 /* Set default values for readline word completion. These are the variables
461 that application completion functions can change or inspect. */
463 set_completion_defaults (what_to_do)
466 /* Only the completion entry function can change these. */
467 rl_filename_completion_desired = 0;
468 rl_filename_quoting_desired = 1;
469 rl_completion_type = what_to_do;
470 rl_completion_suppress_append = rl_completion_suppress_quote = 0;
471 rl_completion_append_character = ' ';
473 /* The completion entry function may optionally change this. */
474 rl_completion_mark_symlink_dirs = _rl_complete_mark_symlink_dirs;
477 /* The user must press "y" or "n". Non-zero return means "y" pressed. */
479 get_y_or_n (for_pager)
484 /* Disabled for GDB due to the gdb.base/readline-ask.exp regression.
485 [patch] testsuite: Test readline-6.2 "ask" regression
486 http://sourceware.org/ml/gdb-patches/2011-05/msg00002.html */
488 /* For now, disable pager in callback mode, until we later convert to state
489 driven functions. Have to wait until next major version to add new
490 state definition, since it will change value of RL_STATE_DONE. */
491 #if defined (READLINE_CALLBACKS)
492 if (RL_ISSTATE (RL_STATE_CALLBACK))
499 RL_SETSTATE(RL_STATE_MOREINPUT);
501 RL_UNSETSTATE(RL_STATE_MOREINPUT);
503 if (c == 'y' || c == 'Y' || c == ' ')
505 if (c == 'n' || c == 'N' || c == RUBOUT)
507 if (c == ABORT_CHAR || c < 0)
508 _rl_abort_internal ();
509 if (for_pager && (c == NEWLINE || c == RETURN))
511 if (for_pager && (c == 'q' || c == 'Q'))
518 _rl_internal_pager (lines)
523 fprintf (rl_outstream, "--More--");
524 fflush (rl_outstream);
526 _rl_erase_entire_line ();
536 path_isdir (filename)
537 const char *filename;
541 return (stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode));
544 #if defined (VISIBLE_STATS)
545 /* Return the character which best describes FILENAME.
546 `@' for symbolic links
551 `%' for character special devices
552 `#' for block special devices */
560 /* Short-circuit a //server on cygwin, since that will always behave as
563 if (filename[0] == '/' && filename[1] == '/' && strchr (filename+2, '/') == 0)
567 #if defined (HAVE_LSTAT) && defined (S_ISLNK)
568 r = lstat (filename, &finfo);
570 r = stat (filename, &finfo);
577 if (S_ISDIR (finfo.st_mode))
579 #if defined (S_ISCHR)
580 else if (S_ISCHR (finfo.st_mode))
583 #if defined (S_ISBLK)
584 else if (S_ISBLK (finfo.st_mode))
587 #if defined (S_ISLNK)
588 else if (S_ISLNK (finfo.st_mode))
591 #if defined (S_ISSOCK)
592 else if (S_ISSOCK (finfo.st_mode))
594 #endif /* S_ISSOCK */
595 #if defined (S_ISFIFO)
596 else if (S_ISFIFO (finfo.st_mode))
599 else if (S_ISREG (finfo.st_mode))
601 #if defined (_WIN32) && !defined (__CYGWIN__)
602 /* Windows 'access' doesn't support X_OK and on latest Windows
603 versions even invokes an invalid parameter exception. */
604 char *ext = strrchr (filename, '.');
607 && (_rl_stricmp (ext, ".exe") == 0
608 || _rl_stricmp (ext, ".cmd") == 0
609 || _rl_stricmp (ext, ".bat") == 0
610 || _rl_stricmp (ext, ".com") == 0))
613 if (access (filename, X_OK) == 0)
619 #endif /* VISIBLE_STATS */
621 /* Return the portion of PATHNAME that should be output when listing
622 possible completions. If we are hacking filename completion, we
623 are only interested in the basename, the portion following the
624 final slash. Otherwise, we return what we were passed. Since
625 printing empty strings is not very informative, if we're doing
626 filename completion, and the basename is the empty string, we look
627 for the previous slash and return the portion following that. If
628 there's no previous slash, we just return what we were passed. */
630 printable_part (pathname)
635 if (rl_filename_completion_desired == 0) /* don't need to do anything */
638 temp = strrchr (pathname, '/');
639 #if defined (__MSDOS__)
640 if (temp == 0 && ISALPHA ((unsigned char)pathname[0]) && pathname[1] == ':')
644 if (temp == 0 || *temp == '\0')
646 /* If the basename is NULL, we might have a pathname like '/usr/src/'.
647 Look for a previous slash and, if one is found, return the portion
648 following that slash. If there's no previous slash, just return the
649 pathname we were passed. */
650 else if (temp[1] == '\0')
652 for (x = temp - 1; x > pathname; x--)
655 return ((*x == '/') ? x + 1 : pathname);
661 /* Compute width of STRING when displayed on screen by print_filename */
667 #if defined (HANDLE_MULTIBYTE)
673 left = strlen (string) + 1;
674 memset (&ps, 0, sizeof (mbstate_t));
680 if (CTRL_CHAR (string[pos]) || string[pos] == RUBOUT)
687 #if defined (HANDLE_MULTIBYTE)
688 clen = mbrtowc (&wc, string + pos, left - pos, &ps);
689 if (MB_INVALIDCH (clen))
693 memset (&ps, 0, sizeof (mbstate_t));
695 else if (MB_NULLWCH (clen))
701 width += (w >= 0) ? w : 1;
713 #define ELLIPSIS_LEN 3
716 fnprint (to_print, prefix_bytes)
717 const char *to_print;
722 #if defined (HANDLE_MULTIBYTE)
729 end = to_print + strlen (to_print) + 1;
730 memset (&ps, 0, sizeof (mbstate_t));
735 /* Don't print only the ellipsis if the common prefix is one of the
736 possible completions */
737 if (to_print[prefix_bytes] == '\0')
744 ellipsis = (to_print[prefix_bytes] == '.') ? '_' : '.';
745 for (w = 0; w < ELLIPSIS_LEN; w++)
746 putc (ellipsis, rl_outstream);
747 printed_len = ELLIPSIS_LEN;
750 s = to_print + prefix_bytes;
755 putc ('^', rl_outstream);
756 putc (UNCTRL (*s), rl_outstream);
759 #if defined (HANDLE_MULTIBYTE)
760 memset (&ps, 0, sizeof (mbstate_t));
763 else if (*s == RUBOUT)
765 putc ('^', rl_outstream);
766 putc ('?', rl_outstream);
769 #if defined (HANDLE_MULTIBYTE)
770 memset (&ps, 0, sizeof (mbstate_t));
775 #if defined (HANDLE_MULTIBYTE)
776 tlen = mbrtowc (&wc, s, end - s, &ps);
777 if (MB_INVALIDCH (tlen))
781 memset (&ps, 0, sizeof (mbstate_t));
783 else if (MB_NULLWCH (tlen))
788 width = (w >= 0) ? w : 1;
790 fwrite (s, 1, tlen, rl_outstream);
792 printed_len += width;
794 putc (*s, rl_outstream);
804 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
805 are using it, check for and output a single character for `special'
806 filenames. Return the number of characters we output. */
809 print_filename (to_print, full_pathname, prefix_bytes)
810 char *to_print, *full_pathname;
813 int printed_len, extension_char, slen, tlen;
814 char *s, c, *new_full_pathname, *dn;
817 printed_len = fnprint (to_print, prefix_bytes);
819 #if defined (VISIBLE_STATS)
820 if (rl_filename_completion_desired && (rl_visible_stats || _rl_complete_mark_directories))
822 if (rl_filename_completion_desired && _rl_complete_mark_directories)
825 /* If to_print != full_pathname, to_print is the basename of the
826 path passed. In this case, we try to expand the directory
827 name before checking for the stat character. */
828 if (to_print != full_pathname)
830 /* Terminate the directory name. */
834 /* If setting the last slash in full_pathname to a NUL results in
835 full_pathname being the empty string, we are trying to complete
836 files in the root directory. If we pass a null string to the
837 bash directory completion hook, for example, it will expand it
838 to the current directory. We just want the `/'. */
839 if (full_pathname == 0 || *full_pathname == 0)
841 else if (full_pathname[0] != '/')
843 else if (full_pathname[1] == 0)
844 dn = "//"; /* restore trailing slash to `//' */
845 else if (full_pathname[1] == '/' && full_pathname[2] == 0)
846 dn = "/"; /* don't turn /// into // */
849 s = tilde_expand (dn);
850 if (rl_directory_completion_hook)
851 (*rl_directory_completion_hook) (&s);
854 tlen = strlen (to_print);
855 new_full_pathname = (char *)xmalloc (slen + tlen + 2);
856 strcpy (new_full_pathname, s);
857 if (s[slen - 1] == '/')
860 new_full_pathname[slen] = '/';
861 new_full_pathname[slen] = '/';
862 strcpy (new_full_pathname + slen + 1, to_print);
864 #if defined (VISIBLE_STATS)
865 if (rl_visible_stats)
866 extension_char = stat_char (new_full_pathname);
869 if (path_isdir (new_full_pathname))
870 extension_char = '/';
872 xfree (new_full_pathname);
877 s = tilde_expand (full_pathname);
878 #if defined (VISIBLE_STATS)
879 if (rl_visible_stats)
880 extension_char = stat_char (s);
884 extension_char = '/';
890 putc (extension_char, rl_outstream);
899 rl_quote_filename (s, rtype, qcp)
906 r = (char *)xmalloc (strlen (s) + 2);
907 *r = *rl_completer_quote_characters;
910 *qcp = *rl_completer_quote_characters;
914 /* Find the bounds of the current word for completion purposes, and leave
915 rl_point set to the end of the word. This function skips quoted
916 substrings (characters between matched pairs of characters in
917 rl_completer_quote_characters). First we try to find an unclosed
918 quoted substring on which to do matching. If one is not found, we use
919 the word break characters to find the boundaries of the current word.
920 We call an application-specific function to decide whether or not a
921 particular word break character is quoted; if that function returns a
922 non-zero result, the character does not break a word. This function
923 returns the opening quote character if we found an unclosed quoted
924 substring, '\0' otherwise. FP, if non-null, is set to a value saying
925 which (shell-like) quote characters we found (single quote, double
926 quote, or backslash) anywhere in the string. DP, if non-null, is set to
927 the value of the delimiter character that caused a word break. */
930 _rl_find_completion_word (fp, dp)
933 int scan, end, found_quote, delimiter, pass_next, isbrk;
934 char quote_char, *brkchars;
937 found_quote = delimiter = 0;
941 if (rl_completion_word_break_hook)
942 brkchars = (*rl_completion_word_break_hook) ();
944 brkchars = rl_completer_word_break_characters;
946 if (rl_completer_quote_characters)
948 /* We have a list of characters which can be used in pairs to
949 quote substrings for the completer. Try to find the start
950 of an unclosed quoted substring. */
951 /* FOUND_QUOTE is set so we know what kind of quotes we found. */
952 for (scan = pass_next = 0; scan < end; scan = MB_NEXTCHAR (rl_line_buffer, scan, 1, MB_FIND_ANY))
960 /* Shell-like semantics for single quotes -- don't allow backslash
961 to quote anything in single quotes, especially not the closing
962 quote. If you don't like this, take out the check on the value
964 if (quote_char != '\'' && rl_line_buffer[scan] == '\\')
967 found_quote |= RL_QF_BACKSLASH;
971 if (quote_char != '\0')
973 /* Ignore everything until the matching close quote char. */
974 if (rl_line_buffer[scan] == quote_char)
976 /* Found matching close. Abandon this substring. */
981 else if (strchr (rl_completer_quote_characters, rl_line_buffer[scan]))
983 /* Found start of a quoted substring. */
984 quote_char = rl_line_buffer[scan];
986 /* Shell-like quoting conventions. */
987 if (quote_char == '\'')
988 found_quote |= RL_QF_SINGLE_QUOTE;
989 else if (quote_char == '"')
990 found_quote |= RL_QF_DOUBLE_QUOTE;
992 found_quote |= RL_QF_OTHER_QUOTE;
997 if (rl_point == end && quote_char == '\0')
999 /* We didn't find an unclosed quoted substring upon which to do
1000 completion, so use the word break characters to find the
1001 substring on which to complete. */
1002 while (rl_point = MB_PREVCHAR (rl_line_buffer, rl_point, MB_FIND_ANY))
1004 scan = rl_line_buffer[rl_point];
1006 if (strchr (brkchars, scan) == 0)
1009 /* Call the application-specific function to tell us whether
1010 this word break character is quoted and should be skipped. */
1011 if (rl_char_is_quoted_p && found_quote &&
1012 (*rl_char_is_quoted_p) (rl_line_buffer, rl_point))
1015 /* Convoluted code, but it avoids an n^2 algorithm with calls
1016 to char_is_quoted. */
1021 /* If we are at an unquoted word break, then advance past it. */
1022 scan = rl_line_buffer[rl_point];
1024 /* If there is an application-specific function to say whether or not
1025 a character is quoted and we found a quote character, let that
1026 function decide whether or not a character is a word break, even
1027 if it is found in rl_completer_word_break_characters. Don't bother
1028 if we're at the end of the line, though. */
1031 if (rl_char_is_quoted_p)
1032 isbrk = (found_quote == 0 ||
1033 (*rl_char_is_quoted_p) (rl_line_buffer, rl_point) == 0) &&
1034 strchr (brkchars, scan) != 0;
1036 isbrk = strchr (brkchars, scan) != 0;
1040 /* If the character that caused the word break was a quoting
1041 character, then remember it as the delimiter. */
1042 if (rl_basic_quote_characters &&
1043 strchr (rl_basic_quote_characters, scan) &&
1044 (end - rl_point) > 1)
1047 /* If the character isn't needed to determine something special
1048 about what kind of completion to perform, then advance past it. */
1049 if (rl_special_prefixes == 0 || strchr (rl_special_prefixes, scan) == 0)
1059 return (quote_char);
1063 gen_completion_matches (text, start, end, our_func, found_quote, quote_char)
1066 rl_compentry_func_t *our_func;
1067 int found_quote, quote_char;
1071 rl_completion_found_quote = found_quote;
1072 rl_completion_quote_character = quote_char;
1074 /* If the user wants to TRY to complete, but then wants to give
1075 up and use the default completion function, they set the
1076 variable rl_attempted_completion_function. */
1077 if (rl_attempted_completion_function)
1079 _rl_interrupt_immediately++;
1080 matches = (*rl_attempted_completion_function) (text, start, end);
1081 if (_rl_interrupt_immediately > 0)
1082 _rl_interrupt_immediately--;
1084 if (matches || rl_attempted_completion_over)
1086 rl_attempted_completion_over = 0;
1091 /* XXX -- filename dequoting moved into rl_filename_completion_function */
1093 matches = rl_completion_matches (text, our_func);
1097 /* Filter out duplicates in MATCHES. This frees up the strings in
1100 remove_duplicate_matches (matches)
1103 char *lowest_common;
1108 /* Sort the items. */
1109 for (i = 0; matches[i]; i++)
1112 /* Sort the array without matches[0], since we need it to
1113 stay in place no matter what. */
1114 if (i && rl_sort_completion_matches)
1115 qsort (matches+1, i-1, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
1117 /* Remember the lowest common denominator for it may be unique. */
1118 lowest_common = savestring (matches[0]);
1120 for (i = newlen = 0; matches[i + 1]; i++)
1122 if (strcmp (matches[i], matches[i + 1]) == 0)
1125 matches[i] = (char *)&dead_slot;
1131 /* We have marked all the dead slots with (char *)&dead_slot.
1132 Copy all the non-dead entries into a new array. */
1133 temp_array = (char **)xmalloc ((3 + newlen) * sizeof (char *));
1134 for (i = j = 1; matches[i]; i++)
1136 if (matches[i] != (char *)&dead_slot)
1137 temp_array[j++] = matches[i];
1139 temp_array[j] = (char *)NULL;
1141 if (matches[0] != (char *)&dead_slot)
1144 /* Place the lowest common denominator back in [0]. */
1145 temp_array[0] = lowest_common;
1147 /* If there is one string left, and it is identical to the
1148 lowest common denominator, then the LCD is the string to
1150 if (j == 2 && strcmp (temp_array[0], temp_array[1]) == 0)
1152 xfree (temp_array[1]);
1153 temp_array[1] = (char *)NULL;
1155 return (temp_array);
1158 /* Find the common prefix of the list of matches, and put it into
1161 compute_lcd_of_matches (match_list, matches, text)
1166 register int i, c1, c2, si;
1167 int low; /* Count of max-matched characters. */
1168 char *dtext; /* dequoted TEXT, if needed */
1169 #if defined (HANDLE_MULTIBYTE)
1175 /* If only one match, just use that. Otherwise, compare each
1176 member of the list with the next, finding out where they
1180 match_list[0] = match_list[1];
1181 match_list[1] = (char *)NULL;
1185 for (i = 1, low = 100000; i < matches; i++)
1187 #if defined (HANDLE_MULTIBYTE)
1188 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1190 memset (&ps1, 0, sizeof (mbstate_t));
1191 memset (&ps2, 0, sizeof (mbstate_t));
1194 if (_rl_completion_case_fold)
1197 (c1 = _rl_to_lower(match_list[i][si])) &&
1198 (c2 = _rl_to_lower(match_list[i + 1][si]));
1200 #if defined (HANDLE_MULTIBYTE)
1201 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1203 v = mbrtowc (&wc1, match_list[i]+si, strlen (match_list[i]+si), &ps1);
1204 mbrtowc (&wc2, match_list[i+1]+si, strlen (match_list[i+1]+si), &ps2);
1205 wc1 = towlower (wc1);
1206 wc2 = towlower (wc2);
1220 (c1 = match_list[i][si]) &&
1221 (c2 = match_list[i + 1][si]);
1223 #if defined (HANDLE_MULTIBYTE)
1224 if (MB_CUR_MAX > 1 && rl_byte_oriented == 0)
1228 if (!_rl_compare_chars (match_list[i], si, &ps1, match_list[i+1], si, &ps2))
1230 else if ((v = _rl_get_char_len (&match_list[i][si], &ps_back)) > 1)
1243 /* If there were multiple matches, but none matched up to even the
1244 first character, and the user typed something, use that as the
1245 value of matches[0]. */
1246 if (low == 0 && text && *text)
1248 match_list[0] = (char *)xmalloc (strlen (text) + 1);
1249 strcpy (match_list[0], text);
1253 match_list[0] = (char *)xmalloc (low + 1);
1255 /* XXX - this might need changes in the presence of multibyte chars */
1257 /* If we are ignoring case, try to preserve the case of the string
1258 the user typed in the face of multiple matches differing in case. */
1259 if (_rl_completion_case_fold)
1261 /* We're making an assumption here:
1262 IF we're completing filenames AND
1263 the application has defined a filename dequoting function AND
1264 we found a quote character AND
1265 the application has requested filename quoting
1267 we assume that TEXT was dequoted before checking against
1268 the file system and needs to be dequoted here before we
1269 check against the list of matches
1271 dtext = (char *)NULL;
1272 if (rl_filename_completion_desired &&
1273 rl_filename_dequoting_function &&
1274 rl_completion_found_quote &&
1275 rl_filename_quoting_desired)
1277 dtext = (*rl_filename_dequoting_function) ((char *)text, rl_completion_quote_character);
1281 /* sort the list to get consistent answers. */
1282 qsort (match_list+1, matches, sizeof(char *), (QSFUNC *)_rl_qsort_string_compare);
1287 for (i = 1; i <= matches; i++)
1288 if (strncmp (match_list[i], text, si) == 0)
1290 strncpy (match_list[0], match_list[i], low);
1293 /* no casematch, use first entry */
1295 strncpy (match_list[0], match_list[1], low);
1298 /* otherwise, just use the text the user typed. */
1299 strncpy (match_list[0], text, low);
1304 strncpy (match_list[0], match_list[1], low);
1306 match_list[0][low] = '\0';
1313 postprocess_matches (matchesp, matching_filenames)
1315 int matching_filenames;
1317 char *t, **matches, **temp_matches;
1320 matches = *matchesp;
1325 /* It seems to me that in all the cases we handle we would like
1326 to ignore duplicate possiblilities. Scan for the text to
1327 insert being identical to the other completions. */
1328 if (rl_ignore_completion_duplicates)
1330 temp_matches = remove_duplicate_matches (matches);
1332 matches = temp_matches;
1335 /* If we are matching filenames, then here is our chance to
1336 do clever processing by re-examining the list. Call the
1337 ignore function with the array as a parameter. It can
1338 munge the array, deleting matches as it desires. */
1339 if (rl_ignore_some_completions_function && matching_filenames)
1341 for (nmatch = 1; matches[nmatch]; nmatch++)
1343 (void)(*rl_ignore_some_completions_function) (matches);
1344 if (matches == 0 || matches[0] == 0)
1347 *matchesp = (char **)0;
1352 /* If we removed some matches, recompute the common prefix. */
1353 for (i = 1; matches[i]; i++)
1355 if (i > 1 && i < nmatch)
1358 compute_lcd_of_matches (matches, i - 1, t);
1364 *matchesp = matches;
1369 complete_get_screenwidth ()
1374 cols = _rl_completion_columns;
1375 if (cols >= 0 && cols <= _rl_screenwidth)
1377 envcols = getenv ("COLUMNS");
1378 if (envcols && *envcols)
1379 cols = atoi (envcols);
1380 if (cols >= 0 && cols <= _rl_screenwidth)
1382 return _rl_screenwidth;
1385 /* A convenience function for displaying a list of strings in
1386 columnar format on readline's output stream. MATCHES is the list
1387 of strings, in argv format, LEN is the number of strings in MATCHES,
1388 and MAX is the length of the longest string in MATCHES. */
1390 rl_display_match_list (matches, len, max)
1394 int count, limit, printed_len, lines, cols;
1395 int i, j, k, l, common_length, sind;
1398 /* Find the length of the prefix common to all items: length as displayed
1399 characters (common_length) and as a byte index into the matches (sind) */
1400 common_length = sind = 0;
1401 if (_rl_completion_prefix_display_length > 0)
1403 t = printable_part (matches[0]);
1404 temp = strrchr (t, '/');
1405 common_length = temp ? fnwidth (temp) : fnwidth (t);
1406 sind = temp ? strlen (temp) : strlen (t);
1408 if (common_length > _rl_completion_prefix_display_length && common_length > ELLIPSIS_LEN)
1409 max -= common_length - ELLIPSIS_LEN;
1411 common_length = sind = 0;
1414 /* How many items of MAX length can we fit in the screen window? */
1415 cols = complete_get_screenwidth ();
1418 if (limit != 1 && (limit * max == cols))
1421 /* If cols == 0, limit will end up -1 */
1422 if (cols < _rl_screenwidth && limit < 0)
1425 /* Avoid a possible floating exception. If max > cols,
1426 limit will be 0 and a divide-by-zero fault will result. */
1430 /* How many iterations of the printing loop? */
1431 count = (len + (limit - 1)) / limit;
1433 /* Watch out for special case. If LEN is less than LIMIT, then
1434 just do the inner printing loop.
1435 0 < len <= limit implies count = 1. */
1437 /* Sort the items if they are not already sorted. */
1438 if (rl_ignore_completion_duplicates == 0 && rl_sort_completion_matches)
1439 qsort (matches + 1, len, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
1444 if (_rl_print_completions_horizontally == 0)
1446 /* Print the sorted items, up-and-down alphabetically, like ls. */
1447 for (i = 1; i <= count; i++)
1449 for (j = 0, l = i; j < limit; j++)
1451 if (l > len || matches[l] == 0)
1455 temp = printable_part (matches[l]);
1456 printed_len = print_filename (temp, matches[l], sind);
1459 for (k = 0; k < max - printed_len; k++)
1460 putc (' ', rl_outstream);
1466 if (_rl_page_completions && lines >= (_rl_screenheight - 1) && i < count)
1468 lines = _rl_internal_pager (lines);
1476 /* Print the sorted items, across alphabetically, like ls -x. */
1477 for (i = 1; matches[i]; i++)
1479 temp = printable_part (matches[i]);
1480 printed_len = print_filename (temp, matches[i], sind);
1481 /* Have we reached the end of this line? */
1484 if (i && (limit > 1) && (i % limit) == 0)
1488 if (_rl_page_completions && lines >= _rl_screenheight - 1)
1490 lines = _rl_internal_pager (lines);
1496 for (k = 0; k < max - printed_len; k++)
1497 putc (' ', rl_outstream);
1504 /* Display MATCHES, a list of matching filenames in argv format. This
1505 handles the simple case -- a single match -- first. If there is more
1506 than one match, we compute the number of strings in the list and the
1507 length of the longest string, which will be needed by the display
1508 function. If the application wants to handle displaying the list of
1509 matches itself, it sets RL_COMPLETION_DISPLAY_MATCHES_HOOK to the
1510 address of a function, and we just call it. If we're handling the
1511 display ourselves, we just call rl_display_match_list. We also check
1512 that the list of matches doesn't exceed the user-settable threshold,
1513 and ask the user if he wants to see the list if there are more matches
1514 than RL_COMPLETION_QUERY_ITEMS. */
1516 display_matches (matches)
1522 /* Move to the last visible line of a possibly-multiple-line command. */
1523 _rl_move_vert (_rl_vis_botlin);
1525 /* Handle simple case first. What if there is only one answer? */
1526 if (matches[1] == 0)
1528 temp = printable_part (matches[0]);
1530 print_filename (temp, matches[0], 0);
1533 rl_forced_update_display ();
1534 rl_display_fixed = 1;
1539 /* There is more than one answer. Find out how many there are,
1540 and find the maximum printed length of a single entry. */
1541 for (max = 0, i = 1; matches[i]; i++)
1543 temp = printable_part (matches[i]);
1544 len = fnwidth (temp);
1552 /* If the caller has defined a display hook, then call that now. */
1553 if (rl_completion_display_matches_hook)
1555 (*rl_completion_display_matches_hook) (matches, len, max);
1559 /* If there are many items, then ask the user if she really wants to
1561 if (rl_completion_query_items > 0 && len >= rl_completion_query_items)
1564 fprintf (rl_outstream, "Display all %d possibilities? (y or n)", len);
1565 fflush (rl_outstream);
1566 if ((completion_y_or_n = get_y_or_n (0)) == 0)
1570 rl_forced_update_display ();
1571 rl_display_fixed = 1;
1577 rl_display_match_list (matches, len, max);
1579 rl_forced_update_display ();
1580 rl_display_fixed = 1;
1584 make_quoted_replacement (match, mtype, qc)
1587 char *qc; /* Pointer to quoting character, if any */
1589 int should_quote, do_replace;
1592 /* If we are doing completion on quoted substrings, and any matches
1593 contain any of the completer_word_break_characters, then auto-
1594 matically prepend the substring with a quote character (just pick
1595 the first one from the list of such) if it does not already begin
1596 with a quote string. FIXME: Need to remove any such automatically
1597 inserted quote character when it no longer is necessary, such as
1598 if we change the string we are completing on and the new set of
1599 matches don't require a quoted substring. */
1600 replacement = match;
1602 should_quote = match && rl_completer_quote_characters &&
1603 rl_filename_completion_desired &&
1604 rl_filename_quoting_desired;
1607 should_quote = should_quote && (!qc || !*qc ||
1608 (rl_completer_quote_characters && strchr (rl_completer_quote_characters, *qc)));
1612 /* If there is a single match, see if we need to quote it.
1613 This also checks whether the common prefix of several
1614 matches needs to be quoted. */
1615 should_quote = rl_filename_quote_characters
1616 ? (_rl_strpbrk (match, rl_filename_quote_characters) != 0)
1619 do_replace = should_quote ? mtype : NO_MATCH;
1620 /* Quote the replacement, since we found an embedded
1621 word break character in a potential match. */
1622 if (do_replace != NO_MATCH && rl_filename_quoting_function)
1623 replacement = (*rl_filename_quoting_function) (match, do_replace, qc);
1625 return (replacement);
1629 insert_match (match, start, mtype, qc)
1634 char *replacement, *r;
1638 oqc = qc ? *qc : '\0';
1639 replacement = make_quoted_replacement (match, mtype, qc);
1641 /* Now insert the match. */
1644 rlen = strlen (replacement);
1645 /* Don't double an opening quote character. */
1646 if (qc && *qc && start && rl_line_buffer[start - 1] == *qc &&
1647 replacement[0] == *qc)
1649 /* If make_quoted_replacement changed the quoting character, remove
1650 the opening quote and insert the (fully-quoted) replacement. */
1651 else if (qc && (*qc != oqc) && start && rl_line_buffer[start - 1] == oqc &&
1652 replacement[0] != oqc)
1655 /* Don't double a closing quote character */
1656 if (qc && *qc && end && rl_line_buffer[rl_point] == *qc && replacement[rlen - 1] == *qc)
1658 if (_rl_skip_completed_text)
1661 while (start < rl_end && *r && rl_line_buffer[start] == *r)
1666 if (start <= end || *r)
1667 _rl_replace_text (r, start, end);
1668 rl_point = start + strlen (r);
1671 _rl_replace_text (replacement, start, end);
1672 if (replacement != match)
1673 xfree (replacement);
1677 /* Append any necessary closing quote and a separator character to the
1678 just-inserted match. If the user has specified that directories
1679 should be marked by a trailing `/', append one of those instead. The
1680 default trailing character is a space. Returns the number of characters
1681 appended. If NONTRIVIAL_MATCH is set, we test for a symlink (if the OS
1682 has them) and don't add a suffix for a symlink to a directory. A
1683 nontrivial match is one that actually adds to the word being completed.
1684 The variable rl_completion_mark_symlink_dirs controls this behavior
1685 (it's initially set to the what the user has chosen, indicated by the
1686 value of _rl_complete_mark_symlink_dirs, but may be modified by an
1687 application's completion function). */
1689 append_to_match (text, delimiter, quote_char, nontrivial_match)
1691 int delimiter, quote_char, nontrivial_match;
1693 char temp_string[4], *filename;
1694 int temp_string_index, s;
1697 temp_string_index = 0;
1698 if (quote_char && rl_point && rl_completion_suppress_quote == 0 &&
1699 rl_line_buffer[rl_point - 1] != quote_char)
1700 temp_string[temp_string_index++] = quote_char;
1703 temp_string[temp_string_index++] = delimiter;
1704 else if (rl_completion_suppress_append == 0 && rl_completion_append_character)
1705 temp_string[temp_string_index++] = rl_completion_append_character;
1707 temp_string[temp_string_index++] = '\0';
1709 if (rl_filename_completion_desired)
1711 filename = tilde_expand (text);
1712 s = (nontrivial_match && rl_completion_mark_symlink_dirs == 0)
1713 ? LSTAT (filename, &finfo)
1714 : stat (filename, &finfo);
1715 if (s == 0 && S_ISDIR (finfo.st_mode))
1717 if (_rl_complete_mark_directories /* && rl_completion_suppress_append == 0 */)
1719 /* This is clumsy. Avoid putting in a double slash if point
1720 is at the end of the line and the previous character is a
1722 if (rl_point && rl_line_buffer[rl_point] == '\0' && rl_line_buffer[rl_point - 1] == '/')
1724 else if (rl_line_buffer[rl_point] != '/')
1725 rl_insert_text ("/");
1729 /* Don't add anything if the filename is a symlink and resolves to a
1731 else if (s == 0 && S_ISLNK (finfo.st_mode) &&
1732 stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode))
1737 if (rl_point == rl_end && temp_string_index)
1738 rl_insert_text (temp_string);
1744 if (rl_point == rl_end && temp_string_index)
1745 rl_insert_text (temp_string);
1748 return (temp_string_index);
1752 insert_all_matches (matches, point, qc)
1760 rl_begin_undo_group ();
1761 /* remove any opening quote character; make_quoted_replacement will add
1763 if (qc && *qc && point && rl_line_buffer[point - 1] == *qc)
1765 rl_delete_text (point, rl_point);
1770 for (i = 1; matches[i]; i++)
1772 rp = make_quoted_replacement (matches[i], SINGLE_MATCH, qc);
1773 rl_insert_text (rp);
1774 rl_insert_text (" ");
1775 if (rp != matches[i])
1781 rp = make_quoted_replacement (matches[0], SINGLE_MATCH, qc);
1782 rl_insert_text (rp);
1783 rl_insert_text (" ");
1784 if (rp != matches[0])
1787 rl_end_undo_group ();
1791 _rl_free_match_list (matches)
1799 for (i = 0; matches[i]; i++)
1804 /* Complete the word at or before point.
1805 WHAT_TO_DO says what to do with the completion.
1806 `?' means list the possible completions.
1807 TAB means do standard completion.
1808 `*' means insert all of the possible completions.
1809 `!' means to do standard completion, and list all possible completions if
1810 there is more than one.
1811 `@' means to do standard completion, and list all possible completions if
1812 there is more than one and partial completion is not possible. */
1814 rl_complete_internal (what_to_do)
1818 rl_compentry_func_t *our_func;
1819 int start, end, delimiter, found_quote, i, nontrivial_lcd;
1820 char *text, *saved_line_buffer;
1826 RL_SETSTATE(RL_STATE_COMPLETING);
1828 set_completion_defaults (what_to_do);
1830 saved_line_buffer = rl_line_buffer ? savestring (rl_line_buffer) : (char *)NULL;
1831 our_func = rl_completion_entry_function
1832 ? rl_completion_entry_function
1833 : rl_filename_completion_function;
1834 /* We now look backwards for the start of a filename/variable word. */
1836 found_quote = delimiter = 0;
1840 /* This (possibly) changes rl_point. If it returns a non-zero char,
1841 we know we have an open quote. */
1842 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
1847 text = rl_copy_text (start, end);
1848 matches = gen_completion_matches (text, start, end, our_func, found_quote, quote_char);
1849 /* nontrivial_lcd is set if the common prefix adds something to the word
1851 nontrivial_lcd = matches && strcmp (text, matches[0]) != 0;
1853 if (what_to_do == '!' || what_to_do == '@')
1854 tlen = strlen (text);
1861 FREE (saved_line_buffer);
1862 completion_changed_buffer = 0;
1863 RL_UNSETSTATE(RL_STATE_COMPLETING);
1864 _rl_reset_completion_state ();
1868 /* If we are matching filenames, the attempted completion function will
1869 have set rl_filename_completion_desired to a non-zero value. The basic
1870 rl_filename_completion_function does this. */
1871 i = rl_filename_completion_desired;
1873 if (postprocess_matches (&matches, i) == 0)
1876 FREE (saved_line_buffer);
1877 completion_changed_buffer = 0;
1878 RL_UNSETSTATE(RL_STATE_COMPLETING);
1879 _rl_reset_completion_state ();
1888 /* Insert the first match with proper quoting. */
1891 insert_match (matches[0], start, matches[1] ? MULT_MATCH : SINGLE_MATCH, "e_char);
1893 if (what_to_do == TAB)
1896 insert_match (matches[0], start, matches[1] ? MULT_MATCH : SINGLE_MATCH, "e_char);
1898 else if (*matches[0] && matches[1] == 0)
1899 /* should we perform the check only if there are multiple matches? */
1900 insert_match (matches[0], start, matches[1] ? MULT_MATCH : SINGLE_MATCH, "e_char);
1901 else if (*matches[0]) /* what_to_do != TAB && multiple matches */
1903 mlen = *matches[0] ? strlen (matches[0]) : 0;
1905 insert_match (matches[0], start, matches[1] ? MULT_MATCH : SINGLE_MATCH, "e_char);
1909 /* If there are more matches, ring the bell to indicate.
1910 If we are in vi mode, Posix.2 says to not ring the bell.
1911 If the `show-all-if-ambiguous' variable is set, display
1912 all the matches immediately. Otherwise, if this was the
1913 only match, and we are hacking files, check the file to
1914 see if it was a directory. If so, and the `mark-directories'
1915 variable is set, add a '/' to the name. If not, and we
1916 are at the end of the line, then add a space. */
1919 if (what_to_do == '!')
1921 display_matches (matches);
1924 else if (what_to_do == '@')
1926 if (nontrivial_lcd == 0)
1927 display_matches (matches);
1930 else if (rl_editing_mode != vi_mode)
1931 rl_ding (); /* There are other matches remaining. */
1934 append_to_match (matches[0], delimiter, quote_char, nontrivial_lcd);
1939 insert_all_matches (matches, start, "e_char);
1943 display_matches (matches);
1947 _rl_ttymsg ("bad value %d for what_to_do in rl_complete", what_to_do);
1949 FREE (saved_line_buffer);
1950 RL_UNSETSTATE(RL_STATE_COMPLETING);
1951 _rl_reset_completion_state ();
1955 _rl_free_match_list (matches);
1957 /* Check to see if the line has changed through all of this manipulation. */
1958 if (saved_line_buffer)
1960 completion_changed_buffer = strcmp (rl_line_buffer, saved_line_buffer) != 0;
1961 xfree (saved_line_buffer);
1964 RL_UNSETSTATE(RL_STATE_COMPLETING);
1965 _rl_reset_completion_state ();
1969 /***************************************************************/
1971 /* Application-callable completion match generator functions */
1973 /***************************************************************/
1975 /* Return an array of (char *) which is a list of completions for TEXT.
1976 If there are no completions, return a NULL pointer.
1977 The first entry in the returned array is the substitution for TEXT.
1978 The remaining entries are the possible completions.
1979 The array is terminated with a NULL pointer.
1981 ENTRY_FUNCTION is a function of two args, and returns a (char *).
1982 The first argument is TEXT.
1983 The second is a state argument; it should be zero on the first call, and
1984 non-zero on subsequent calls. It returns a NULL pointer to the caller
1985 when there are no more matches.
1988 rl_completion_matches (text, entry_function)
1990 rl_compentry_func_t *entry_function;
1992 /* Number of slots in match_list. */
1993 int match_list_size;
1995 /* The list of matches. */
1998 /* Number of matches actually found. */
2001 /* Temporary string binder. */
2005 match_list_size = 10;
2006 match_list = (char **)xmalloc ((match_list_size + 1) * sizeof (char *));
2007 match_list[1] = (char *)NULL;
2009 _rl_interrupt_immediately++;
2010 while (string = (*entry_function) (text, matches))
2012 if (matches + 1 == match_list_size)
2013 match_list = (char **)xrealloc
2014 (match_list, ((match_list_size += 10) + 1) * sizeof (char *));
2016 match_list[++matches] = string;
2017 match_list[matches + 1] = (char *)NULL;
2019 if (_rl_interrupt_immediately > 0)
2020 _rl_interrupt_immediately--;
2022 /* If there were any matches, then look through them finding out the
2023 lowest common denominator. That then becomes match_list[0]. */
2025 compute_lcd_of_matches (match_list, matches, text);
2026 else /* There were no matches. */
2029 match_list = (char **)NULL;
2031 return (match_list);
2034 /* A completion function for usernames.
2035 TEXT contains a partial username preceded by a random
2036 character (usually `~'). */
2038 rl_username_completion_function (text, state)
2042 #if defined (__WIN32__) || defined (__OPENNT)
2043 return (char *)NULL;
2044 #else /* !__WIN32__ && !__OPENNT) */
2045 static char *username = (char *)NULL;
2046 static struct passwd *entry;
2047 static int namelen, first_char, first_char_loc;
2055 first_char_loc = first_char == '~';
2057 username = savestring (&text[first_char_loc]);
2058 namelen = strlen (username);
2062 #if defined (HAVE_GETPWENT)
2063 while (entry = getpwent ())
2065 /* Null usernames should result in all users as possible completions. */
2066 if (namelen == 0 || (STREQN (username, entry->pw_name, namelen)))
2073 #if defined (HAVE_GETPWENT)
2076 return ((char *)NULL);
2080 value = (char *)xmalloc (2 + strlen (entry->pw_name));
2084 strcpy (value + first_char_loc, entry->pw_name);
2086 if (first_char == '~')
2087 rl_filename_completion_desired = 1;
2091 #endif /* !__WIN32__ && !__OPENNT */
2094 /* Return non-zero if CONVFN matches FILENAME up to the length of FILENAME
2095 (FILENAME_LEN). If _rl_completion_case_fold is set, compare without
2096 regard to the alphabetic case of characters. CONVFN is the possibly-
2097 converted directory entry; FILENAME is what the user typed. */
2099 complete_fncmp (convfn, convlen, filename, filename_len)
2102 const char *filename;
2105 register char *s1, *s2;
2108 /* Otherwise, if these match up to the length of filename, then
2110 if (_rl_completion_case_fold && _rl_completion_case_map)
2112 /* Case-insensitive comparison treating _ and - as equivalent */
2113 if (filename_len == 0)
2115 if (convlen < filename_len)
2117 s1 = (char *)convfn;
2118 s2 = (char *)filename;
2122 d = _rl_to_lower (*s1) - _rl_to_lower (*s2);
2123 /* *s1 == [-_] && *s2 == [-_] */
2124 if ((*s1 == '-' || *s1 == '_') && (*s2 == '-' || *s2 == '_'))
2128 s1++; s2++; /* already checked convlen >= filename_len */
2133 else if (_rl_completion_case_fold)
2135 if ((_rl_to_lower (convfn[0]) == _rl_to_lower (filename[0])) &&
2136 (convlen >= filename_len) &&
2137 (_rl_strnicmp (filename, convfn, filename_len) == 0))
2142 if ((convfn[0] == filename[0]) &&
2143 (convlen >= filename_len) &&
2144 (strncmp (filename, convfn, filename_len) == 0))
2150 /* Okay, now we write the entry_function for filename completion. In the
2151 general case. Note that completion in the shell is a little different
2152 because of all the pathnames that must be followed when looking up the
2153 completion for a command. */
2155 rl_filename_completion_function (text, state)
2159 static DIR *directory = (DIR *)NULL;
2160 static char *filename = (char *)NULL;
2161 static char *dirname = (char *)NULL;
2162 static char *users_dirname = (char *)NULL;
2163 static int filename_len;
2164 char *temp, *dentry, *convfn;
2165 int dirlen, dentlen, convlen;
2166 struct dirent *entry;
2168 /* If we don't have any state, then do some initialization. */
2171 /* If we were interrupted before closing the directory or reading
2172 all of its contents, close it. */
2175 closedir (directory);
2176 directory = (DIR *)NULL;
2180 FREE (users_dirname);
2182 filename = savestring (text);
2185 dirname = savestring (text);
2187 temp = strrchr (dirname, '/');
2189 #if defined (__MSDOS__)
2190 /* special hack for //X/... */
2191 if (dirname[0] == '/' && dirname[1] == '/' && ISALPHA ((unsigned char)dirname[2]) && dirname[3] == '/')
2192 temp = strrchr (dirname + 3, '/');
2197 strcpy (filename, ++temp);
2200 #if defined (__MSDOS__)
2201 /* searches from current directory on the drive */
2202 else if (ISALPHA ((unsigned char)dirname[0]) && dirname[1] == ':')
2204 strcpy (filename, dirname + 2);
2214 /* We aren't done yet. We also support the "~user" syntax. */
2216 /* Save the version of the directory that the user typed, dequoting
2218 if (rl_completion_found_quote && rl_filename_dequoting_function)
2219 users_dirname = (*rl_filename_dequoting_function) (dirname, rl_completion_quote_character);
2221 users_dirname = savestring (dirname);
2223 if (*dirname == '~')
2225 temp = tilde_expand (dirname);
2230 /* We have saved the possibly-dequoted version of the directory name
2231 the user typed. Now transform the directory name we're going to
2232 pass to opendir(2). The directory rewrite hook modifies only the
2233 directory name; the directory completion hook modifies both the
2234 directory name passed to opendir(2) and the version the user
2235 typed. Both the directory completion and rewrite hooks should perform
2236 any necessary dequoting. The hook functions return 1 if they modify
2237 the directory name argument. If either hook returns 0, it should
2238 not modify the directory name pointer passed as an argument. */
2239 if (rl_directory_rewrite_hook)
2240 (*rl_directory_rewrite_hook) (&dirname);
2241 else if (rl_directory_completion_hook && (*rl_directory_completion_hook) (&dirname))
2243 xfree (users_dirname);
2244 users_dirname = savestring (dirname);
2246 else if (rl_completion_found_quote && rl_filename_dequoting_function)
2248 /* delete single and double quotes */
2250 dirname = savestring (users_dirname);
2252 directory = opendir (dirname);
2254 /* Now dequote a non-null filename. */
2255 if (filename && *filename && rl_completion_found_quote && rl_filename_dequoting_function)
2257 /* delete single and double quotes */
2258 temp = (*rl_filename_dequoting_function) (filename, rl_completion_quote_character);
2262 filename_len = strlen (filename);
2264 rl_filename_completion_desired = 1;
2267 /* At this point we should entertain the possibility of hacking wildcarded
2268 filenames, like /usr/man/man<WILD>/te<TAB>. If the directory name
2269 contains globbing characters, then build an array of directories, and
2270 then map over that list while completing. */
2271 /* *** UNIMPLEMENTED *** */
2273 /* Now that we have some state, we can read the directory. */
2275 entry = (struct dirent *)NULL;
2276 while (directory && (entry = readdir (directory)))
2278 convfn = dentry = entry->d_name;
2279 convlen = dentlen = D_NAMLEN (entry);
2281 if (rl_filename_rewrite_hook)
2283 convfn = (*rl_filename_rewrite_hook) (dentry, dentlen);
2284 convlen = (convfn == dentry) ? dentlen : strlen (convfn);
2287 /* Special case for no filename. If the user has disabled the
2288 `match-hidden-files' variable, skip filenames beginning with `.'.
2289 All other entries except "." and ".." match. */
2290 if (filename_len == 0)
2292 if (_rl_match_hidden_files == 0 && HIDDEN_FILE (convfn))
2295 if (convfn[0] != '.' ||
2296 (convfn[1] && (convfn[1] != '.' || convfn[2])))
2301 if (complete_fncmp (convfn, convlen, filename, filename_len))
2310 closedir (directory);
2311 directory = (DIR *)NULL;
2316 dirname = (char *)NULL;
2321 filename = (char *)NULL;
2325 xfree (users_dirname);
2326 users_dirname = (char *)NULL;
2329 return (char *)NULL;
2333 /* dirname && (strcmp (dirname, ".") != 0) */
2334 if (dirname && (dirname[0] != '.' || dirname[1]))
2336 if (rl_complete_with_tilde_expansion && *users_dirname == '~')
2338 dirlen = strlen (dirname);
2339 temp = (char *)xmalloc (2 + dirlen + D_NAMLEN (entry));
2340 strcpy (temp, dirname);
2341 /* Canonicalization cuts off any final slash present. We
2342 may need to add it back. */
2343 if (dirname[dirlen - 1] != '/')
2345 temp[dirlen++] = '/';
2346 temp[dirlen] = '\0';
2351 dirlen = strlen (users_dirname);
2352 temp = (char *)xmalloc (2 + dirlen + D_NAMLEN (entry));
2353 strcpy (temp, users_dirname);
2354 /* Make sure that temp has a trailing slash here. */
2355 if (users_dirname[dirlen - 1] != '/')
2356 temp[dirlen++] = '/';
2359 strcpy (temp + dirlen, convfn);
2362 temp = savestring (convfn);
2364 if (convfn != dentry)
2371 /* An initial implementation of a menu completion function a la tcsh. The
2372 first time (if the last readline command was not rl_old_menu_complete), we
2373 generate the list of matches. This code is very similar to the code in
2374 rl_complete_internal -- there should be a way to combine the two. Then,
2375 for each item in the list of matches, we insert the match in an undoable
2376 fashion, with the appropriate character appended (this happens on the
2377 second and subsequent consecutive calls to rl_old_menu_complete). When we
2378 hit the end of the match list, we restore the original unmatched text,
2379 ring the bell, and reset the counter to zero. */
2381 rl_old_menu_complete (count, invoking_key)
2382 int count, invoking_key;
2384 rl_compentry_func_t *our_func;
2385 int matching_filenames, found_quote;
2387 static char *orig_text;
2388 static char **matches = (char **)0;
2389 static int match_list_index = 0;
2390 static int match_list_size = 0;
2391 static int orig_start, orig_end;
2392 static char quote_char;
2393 static int delimiter;
2395 /* The first time through, we generate the list of matches and set things
2396 up to insert them. */
2397 if (rl_last_func != rl_old_menu_complete)
2399 /* Clean up from previous call, if any. */
2402 _rl_free_match_list (matches);
2404 match_list_index = match_list_size = 0;
2405 matches = (char **)NULL;
2407 rl_completion_invoking_key = invoking_key;
2409 RL_SETSTATE(RL_STATE_COMPLETING);
2411 /* Only the completion entry function can change these. */
2412 set_completion_defaults ('%');
2414 our_func = rl_menu_completion_entry_function;
2416 our_func = rl_completion_entry_function
2417 ? rl_completion_entry_function
2418 : rl_filename_completion_function;
2420 /* We now look backwards for the start of a filename/variable word. */
2421 orig_end = rl_point;
2422 found_quote = delimiter = 0;
2426 /* This (possibly) changes rl_point. If it returns a non-zero char,
2427 we know we have an open quote. */
2428 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
2430 orig_start = rl_point;
2431 rl_point = orig_end;
2433 orig_text = rl_copy_text (orig_start, orig_end);
2434 matches = gen_completion_matches (orig_text, orig_start, orig_end,
2435 our_func, found_quote, quote_char);
2437 /* If we are matching filenames, the attempted completion function will
2438 have set rl_filename_completion_desired to a non-zero value. The basic
2439 rl_filename_completion_function does this. */
2440 matching_filenames = rl_filename_completion_desired;
2442 if (matches == 0 || postprocess_matches (&matches, matching_filenames) == 0)
2446 matches = (char **)0;
2448 orig_text = (char *)0;
2449 completion_changed_buffer = 0;
2450 RL_UNSETSTATE(RL_STATE_COMPLETING);
2454 RL_UNSETSTATE(RL_STATE_COMPLETING);
2456 for (match_list_size = 0; matches[match_list_size]; match_list_size++)
2458 /* matches[0] is lcd if match_list_size > 1, but the circular buffer
2459 code below should take care of it. */
2461 if (match_list_size > 1 && _rl_complete_show_all)
2462 display_matches (matches);
2465 /* Now we have the list of matches. Replace the text between
2466 rl_line_buffer[orig_start] and rl_line_buffer[rl_point] with
2467 matches[match_list_index], and add any necessary closing char. */
2469 if (matches == 0 || match_list_size == 0)
2473 matches = (char **)0;
2474 completion_changed_buffer = 0;
2478 match_list_index += count;
2479 if (match_list_index < 0)
2481 while (match_list_index < 0)
2482 match_list_index += match_list_size;
2485 match_list_index %= match_list_size;
2487 if (match_list_index == 0 && match_list_size > 1)
2490 insert_match (orig_text, orig_start, MULT_MATCH, "e_char);
2494 insert_match (matches[match_list_index], orig_start, SINGLE_MATCH, "e_char);
2495 append_to_match (matches[match_list_index], delimiter, quote_char,
2496 strcmp (orig_text, matches[match_list_index]));
2499 completion_changed_buffer = 1;
2504 rl_menu_complete (count, ignore)
2507 rl_compentry_func_t *our_func;
2508 int matching_filenames, found_quote;
2510 static char *orig_text;
2511 static char **matches = (char **)0;
2512 static int match_list_index = 0;
2513 static int match_list_size = 0;
2514 static int nontrivial_lcd = 0;
2515 static int full_completion = 0; /* set to 1 if menu completion should reinitialize on next call */
2516 static int orig_start, orig_end;
2517 static char quote_char;
2518 static int delimiter, cstate;
2520 /* The first time through, we generate the list of matches and set things
2521 up to insert them. */
2522 if ((rl_last_func != rl_menu_complete && rl_last_func != rl_backward_menu_complete) || full_completion)
2524 /* Clean up from previous call, if any. */
2527 _rl_free_match_list (matches);
2529 match_list_index = match_list_size = 0;
2530 matches = (char **)NULL;
2532 full_completion = 0;
2534 RL_SETSTATE(RL_STATE_COMPLETING);
2536 /* Only the completion entry function can change these. */
2537 set_completion_defaults ('%');
2539 our_func = rl_menu_completion_entry_function;
2541 our_func = rl_completion_entry_function
2542 ? rl_completion_entry_function
2543 : rl_filename_completion_function;
2545 /* We now look backwards for the start of a filename/variable word. */
2546 orig_end = rl_point;
2547 found_quote = delimiter = 0;
2551 /* This (possibly) changes rl_point. If it returns a non-zero char,
2552 we know we have an open quote. */
2553 quote_char = _rl_find_completion_word (&found_quote, &delimiter);
2555 orig_start = rl_point;
2556 rl_point = orig_end;
2558 orig_text = rl_copy_text (orig_start, orig_end);
2559 matches = gen_completion_matches (orig_text, orig_start, orig_end,
2560 our_func, found_quote, quote_char);
2562 nontrivial_lcd = matches && strcmp (orig_text, matches[0]) != 0;
2564 /* If we are matching filenames, the attempted completion function will
2565 have set rl_filename_completion_desired to a non-zero value. The basic
2566 rl_filename_completion_function does this. */
2567 matching_filenames = rl_filename_completion_desired;
2569 if (matches == 0 || postprocess_matches (&matches, matching_filenames) == 0)
2573 matches = (char **)0;
2575 orig_text = (char *)0;
2576 completion_changed_buffer = 0;
2577 RL_UNSETSTATE(RL_STATE_COMPLETING);
2581 RL_UNSETSTATE(RL_STATE_COMPLETING);
2583 for (match_list_size = 0; matches[match_list_size]; match_list_size++)
2586 if (match_list_size == 0)
2590 matches = (char **)0;
2591 match_list_index = 0;
2592 completion_changed_buffer = 0;
2596 /* matches[0] is lcd if match_list_size > 1, but the circular buffer
2597 code below should take care of it. */
2600 insert_match (matches[0], orig_start, matches[1] ? MULT_MATCH : SINGLE_MATCH, "e_char);
2601 orig_end = orig_start + strlen (matches[0]);
2602 completion_changed_buffer = STREQ (orig_text, matches[0]) == 0;
2605 if (match_list_size > 1 && _rl_complete_show_all)
2607 display_matches (matches);
2608 /* If there are so many matches that the user has to be asked
2609 whether or not he wants to see the matches, menu completion
2611 if (rl_completion_query_items > 0 && match_list_size >= rl_completion_query_items)
2615 matches = (char **)0;
2616 full_completion = 1;
2620 else if (match_list_size <= 1)
2622 append_to_match (matches[0], delimiter, quote_char, nontrivial_lcd);
2623 full_completion = 1;
2626 else if (_rl_menu_complete_prefix_first && match_list_size > 1)
2633 /* Now we have the list of matches. Replace the text between
2634 rl_line_buffer[orig_start] and rl_line_buffer[rl_point] with
2635 matches[match_list_index], and add any necessary closing char. */
2637 if (matches == 0 || match_list_size == 0)
2641 matches = (char **)0;
2642 completion_changed_buffer = 0;
2646 match_list_index += count;
2647 if (match_list_index < 0)
2649 while (match_list_index < 0)
2650 match_list_index += match_list_size;
2653 match_list_index %= match_list_size;
2655 if (match_list_index == 0 && match_list_size > 1)
2658 insert_match (matches[0], orig_start, MULT_MATCH, "e_char);
2662 insert_match (matches[match_list_index], orig_start, SINGLE_MATCH, "e_char);
2663 append_to_match (matches[match_list_index], delimiter, quote_char,
2664 strcmp (orig_text, matches[match_list_index]));
2667 completion_changed_buffer = 1;
2672 rl_backward_menu_complete (count, key)
2675 /* Positive arguments to backward-menu-complete translate into negative
2676 arguments for menu-complete, and vice versa. */
2677 return (rl_menu_complete (-count, key));