1 /* complete.c -- filename completion for readline. */
3 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library, a library for
6 reading lines of text with interactive input and history editing.
8 The GNU Readline Library is free software; you can redistribute it
9 and/or modify it under the terms of the GNU General Public License
10 as published by the Free Software Foundation; either version 2, or
11 (at your option) any later version.
13 The GNU Readline Library is distributed in the hope that it will be
14 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 The GNU General Public License is often shipped with GNU software, and
19 is generally kept in a file called COPYING or LICENSE. If you do not
20 have a copy of the license, write to the Free Software Foundation,
21 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
22 #define READLINE_LIBRARY
24 #if defined (HAVE_CONFIG_H)
28 #include <sys/types.h>
30 #if defined (HAVE_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 */
54 #include "posixstat.h"
56 /* System-specific feature definitions and include files. */
59 /* Some standard library routines. */
62 #include "rlprivate.h"
65 typedef int QSFUNC (const void *, const void *);
67 typedef int QSFUNC ();
70 /* Most systems don't declare getpwent in <pwd.h> if _POSIX_SOURCE is
72 #if !defined (HAVE_GETPW_DECLS) || defined (_POSIX_SOURCE)
73 extern struct passwd
*getpwent
__P((void));
74 #endif /* !HAVE_GETPW_DECLS || _POSIX_SOURCE */
76 /* If non-zero, then this is the address of a function to call when
77 completing a word would normally display the list of possible matches.
78 This function is called instead of actually doing the display.
79 It takes three arguments: (char **matches, int num_matches, int max_length)
80 where MATCHES is the array of strings that matched, NUM_MATCHES is the
81 number of strings in that array, and MAX_LENGTH is the length of the
82 longest string in that array. */
83 rl_compdisp_func_t
*rl_completion_display_matches_hook
= (rl_compdisp_func_t
*)NULL
;
85 #if defined (VISIBLE_STATS)
89 static int stat_char
__P((char *));
92 static char *rl_quote_filename
__P((char *, int, char *));
94 static char **remove_duplicate_matches
__P((char **));
95 static void insert_match
__P((char *, int, int, char *));
96 static int append_to_match
__P((char *, int, int));
97 static void insert_all_matches
__P((char **, int, char *));
98 static void display_matches
__P((char **));
99 static int compute_lcd_of_matches
__P((char **, int, const char *));
101 /* **************************************************************** */
103 /* Completion matching, from readline's point of view. */
105 /* **************************************************************** */
107 /* Variables known only to the readline library. */
109 /* If non-zero, non-unique completions always show the list of matches. */
110 int _rl_complete_show_all
= 0;
112 /* If non-zero, completed directory names have a slash appended. */
113 int _rl_complete_mark_directories
= 1;
115 /* If non-zero, completions are printed horizontally in alphabetical order,
117 int _rl_print_completions_horizontally
;
119 /* Non-zero means that case is not significant in filename completion. */
120 #if defined (__MSDOS__) && !defined (__DJGPP__)
121 int _rl_completion_case_fold
= 1;
123 int _rl_completion_case_fold
;
126 /* Global variables available to applications using readline. */
128 #if defined (VISIBLE_STATS)
129 /* Non-zero means add an additional character to each filename displayed
130 during listing completion iff rl_filename_completion_desired which helps
131 to indicate the type of file being listed. */
132 int rl_visible_stats
= 0;
133 #endif /* VISIBLE_STATS */
135 /* If non-zero, then this is the address of a function to call when
136 completing on a directory name. The function is called with
137 the address of a string (the current directory name) as an arg. */
138 rl_icppfunc_t
*rl_directory_completion_hook
= (rl_icppfunc_t
*)NULL
;
140 rl_icppfunc_t
*rl_directory_rewrite_hook
= (rl_icppfunc_t
*)NULL
;
142 /* Non-zero means readline completion functions perform tilde expansion. */
143 int rl_complete_with_tilde_expansion
= 0;
145 /* Pointer to the generator function for completion_matches ().
146 NULL means to use rl_filename_completion_function (), the default filename
148 rl_compentry_func_t
*rl_completion_entry_function
= (rl_compentry_func_t
*)NULL
;
150 /* Pointer to alternative function to create matches.
151 Function is called with TEXT, START, and END.
152 START and END are indices in RL_LINE_BUFFER saying what the boundaries
154 If this function exists and returns NULL then call the value of
155 rl_completion_entry_function to try to match, otherwise use the
156 array of strings returned. */
157 rl_completion_func_t
*rl_attempted_completion_function
= (rl_completion_func_t
*)NULL
;
159 /* Non-zero means to suppress normal filename completion after the
160 user-specified completion function has been called. */
161 int rl_attempted_completion_over
= 0;
163 /* Set to a character indicating the type of completion being performed
164 by rl_complete_internal, available for use by application completion
166 int rl_completion_type
= 0;
168 /* Up to this many items will be displayed in response to a
169 possible-completions call. After that, we ask the user if
170 she is sure she wants to see them all. */
171 int rl_completion_query_items
= 100;
173 /* The basic list of characters that signal a break between words for the
174 completer routine. The contents of this variable is what breaks words
175 in the shell, i.e. " \t\n\"\\'`@$><=" */
176 const char *rl_basic_word_break_characters
= " \t\n\"\\'`@$><=;|&{(";
178 /* List of basic quoting characters. */
179 const char *rl_basic_quote_characters
= "\"'";
181 /* The list of characters that signal a break between words for
182 rl_complete_internal. The default list is the contents of
183 rl_basic_word_break_characters. */
184 const char *rl_completer_word_break_characters
= (const char *)NULL
;
186 /* List of characters which can be used to quote a substring of the line.
187 Completion occurs on the entire substring, and within the substring
188 rl_completer_word_break_characters are treated as any other character,
189 unless they also appear within this list. */
190 const char *rl_completer_quote_characters
= (const char *)NULL
;
192 /* List of characters that should be quoted in filenames by the completer. */
193 const char *rl_filename_quote_characters
= (const char *)NULL
;
195 /* List of characters that are word break characters, but should be left
196 in TEXT when it is passed to the completion function. The shell uses
197 this to help determine what kind of completing to do. */
198 const char *rl_special_prefixes
= (const char *)NULL
;
200 /* If non-zero, then disallow duplicates in the matches. */
201 int rl_ignore_completion_duplicates
= 1;
203 /* Non-zero means that the results of the matches are to be treated
204 as filenames. This is ALWAYS zero on entry, and can only be changed
205 within a completion entry finder function. */
206 int rl_filename_completion_desired
= 0;
208 /* Non-zero means that the results of the matches are to be quoted using
209 double quotes (or an application-specific quoting mechanism) if the
210 filename contains any characters in rl_filename_quote_chars. This is
211 ALWAYS non-zero on entry, and can only be changed within a completion
212 entry finder function. */
213 int rl_filename_quoting_desired
= 1;
215 /* This function, if defined, is called by the completer when real
216 filename completion is done, after all the matching names have been
217 generated. It is passed a (char**) known as matches in the code below.
218 It consists of a NULL-terminated array of pointers to potential
219 matching strings. The 1st element (matches[0]) is the maximal
220 substring that is common to all matches. This function can re-arrange
221 the list of matches as required, but all elements of the array must be
222 free()'d if they are deleted. The main intent of this function is
223 to implement FIGNORE a la SunOS csh. */
224 rl_compignore_func_t
*rl_ignore_some_completions_function
= (rl_compignore_func_t
*)NULL
;
226 /* Set to a function to quote a filename in an application-specific fashion.
227 Called with the text to quote, the type of match found (single or multiple)
228 and a pointer to the quoting character to be used, which the function can
230 rl_quote_func_t
*rl_filename_quoting_function
= rl_quote_filename
;
232 /* Function to call to remove quoting characters from a filename. Called
233 before completion is attempted, so the embedded quotes do not interfere
234 with matching names in the file system. Readline doesn't do anything
235 with this; it's set only by applications. */
236 rl_dequote_func_t
*rl_filename_dequoting_function
= (rl_dequote_func_t
*)NULL
;
238 /* Function to call to decide whether or not a word break character is
239 quoted. If a character is quoted, it does not break words for the
241 rl_linebuf_func_t
*rl_char_is_quoted_p
= (rl_linebuf_func_t
*)NULL
;
243 /* Character appended to completed words when at the end of the line. The
244 default is a space. */
245 int rl_completion_append_character
= ' ';
247 /* If non-zero, inhibit completion (temporarily). */
248 int rl_inhibit_completion
;
250 /* Variables local to this file. */
252 /* Local variable states what happened during the last completion attempt. */
253 static int completion_changed_buffer
;
255 /*************************************/
257 /* Bindable completion functions */
259 /*************************************/
261 /* Complete the word at or before point. You have supplied the function
262 that does the initial simple matching selection algorithm (see
263 rl_completion_matches ()). The default is to do filename completion. */
265 rl_complete (ignore
, invoking_key
)
266 int ignore
, invoking_key
;
268 if (rl_inhibit_completion
)
269 return (rl_insert (ignore
, invoking_key
));
270 else if (rl_last_func
== rl_complete
&& !completion_changed_buffer
)
271 return (rl_complete_internal ('?'));
272 else if (_rl_complete_show_all
)
273 return (rl_complete_internal ('!'));
275 return (rl_complete_internal (TAB
));
278 /* List the possible completions. See description of rl_complete (). */
280 rl_possible_completions (ignore
, invoking_key
)
281 int ignore
, invoking_key
;
283 return (rl_complete_internal ('?'));
287 rl_insert_completions (ignore
, invoking_key
)
288 int ignore
, invoking_key
;
290 return (rl_complete_internal ('*'));
293 /************************************/
295 /* Completion utility functions */
297 /************************************/
299 /* The user must press "y" or "n". Non-zero return means "y" pressed. */
307 RL_SETSTATE(RL_STATE_MOREINPUT
);
309 RL_UNSETSTATE(RL_STATE_MOREINPUT
);
311 if (c
== 'y' || c
== 'Y' || c
== ' ')
313 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
316 _rl_abort_internal ();
321 #if defined (VISIBLE_STATS)
322 /* Return the character which best describes FILENAME.
323 `@' for symbolic links
328 `%' for character special devices
329 `#' for block special devices */
337 #if defined (HAVE_LSTAT) && defined (S_ISLNK)
338 r
= lstat (filename
, &finfo
);
340 r
= stat (filename
, &finfo
);
347 if (S_ISDIR (finfo
.st_mode
))
349 #if defined (S_ISCHR)
350 else if (S_ISCHR (finfo
.st_mode
))
353 #if defined (S_ISBLK)
354 else if (S_ISBLK (finfo
.st_mode
))
357 #if defined (S_ISLNK)
358 else if (S_ISLNK (finfo
.st_mode
))
361 #if defined (S_ISSOCK)
362 else if (S_ISSOCK (finfo
.st_mode
))
364 #endif /* S_ISSOCK */
365 #if defined (S_ISFIFO)
366 else if (S_ISFIFO (finfo
.st_mode
))
369 else if (S_ISREG (finfo
.st_mode
))
371 if (access (filename
, X_OK
) == 0)
376 #endif /* VISIBLE_STATS */
378 /* Return the portion of PATHNAME that should be output when listing
379 possible completions. If we are hacking filename completion, we
380 are only interested in the basename, the portion following the
381 final slash. Otherwise, we return what we were passed. */
383 printable_part (pathname
)
388 temp
= rl_filename_completion_desired
? strrchr (pathname
, '/') : (char *)NULL
;
389 #if defined (__MSDOS__)
390 if (rl_filename_completion_desired
&& temp
== 0 && isalpha (pathname
[0]) && pathname
[1] == ':')
393 return (temp
? ++temp
: pathname
);
396 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
397 are using it, check for and output a single character for `special'
398 filenames. Return the number of characters we output. */
404 putc ('^', rl_outstream); \
405 putc (UNCTRL (c), rl_outstream); \
408 else if (c == RUBOUT) \
410 putc ('^', rl_outstream); \
411 putc ('?', rl_outstream); \
416 putc (c, rl_outstream); \
422 print_filename (to_print
, full_pathname
)
423 char *to_print
, *full_pathname
;
426 #if !defined (VISIBLE_STATS)
429 for (s
= to_print
; *s
; s
++)
434 char *s
, c
, *new_full_pathname
;
435 int extension_char
, slen
, tlen
;
437 for (s
= to_print
; *s
; s
++)
442 if (rl_filename_completion_desired
&& rl_visible_stats
)
444 /* If to_print != full_pathname, to_print is the basename of the
445 path passed. In this case, we try to expand the directory
446 name before checking for the stat character. */
447 if (to_print
!= full_pathname
)
449 /* Terminate the directory name. */
453 /* If setting the last slash in full_pathname to a NUL results in
454 full_pathname being the empty string, we are trying to complete
455 files in the root directory. If we pass a null string to the
456 bash directory completion hook, for example, it will expand it
457 to the current directory. We just want the `/'. */
458 s
= tilde_expand (full_pathname
&& *full_pathname
? full_pathname
: "/");
459 if (rl_directory_completion_hook
)
460 (*rl_directory_completion_hook
) (&s
);
463 tlen
= strlen (to_print
);
464 new_full_pathname
= xmalloc (slen
+ tlen
+ 2);
465 strcpy (new_full_pathname
, s
);
466 new_full_pathname
[slen
] = '/';
467 strcpy (new_full_pathname
+ slen
+ 1, to_print
);
469 extension_char
= stat_char (new_full_pathname
);
471 free (new_full_pathname
);
476 s
= tilde_expand (full_pathname
);
477 extension_char
= stat_char (s
);
483 putc (extension_char
, rl_outstream
);
487 #endif /* VISIBLE_STATS */
492 rl_quote_filename (s
, rtype
, qcp
)
499 r
= xmalloc (strlen (s
) + 2);
500 *r
= *rl_completer_quote_characters
;
503 *qcp
= *rl_completer_quote_characters
;
507 /* Find the bounds of the current word for completion purposes, and leave
508 rl_point set to the end of the word. This function skips quoted
509 substrings (characters between matched pairs of characters in
510 rl_completer_quote_characters. First we try to find an unclosed
511 quoted substring on which to do matching. If one is not found, we use
512 the word break characters to find the boundaries of the current word.
513 We call an application-specific function to decide whether or not a
514 particular word break character is quoted; if that function returns a
515 non-zero result, the character does not break a word. This function
516 returns the opening quote character if we found an unclosed quoted
517 substring, '\0' otherwise. FP, if non-null, is set to a value saying
518 which (shell-like) quote characters we found (single quote, double
519 quote, or backslash) anywhere in the string. DP, if non-null, is set to
520 the value of the delimiter character that caused a word break. */
523 find_completion_word (fp
, dp
)
526 int scan
, end
, found_quote
, delimiter
, pass_next
, isbrk
;
530 found_quote
= delimiter
= 0;
533 if (rl_completer_quote_characters
)
535 /* We have a list of characters which can be used in pairs to
536 quote substrings for the completer. Try to find the start
537 of an unclosed quoted substring. */
538 /* FOUND_QUOTE is set so we know what kind of quotes we found. */
539 for (scan
= pass_next
= 0; scan
< end
; scan
++)
547 /* Shell-like semantics for single quotes -- don't allow backslash
548 to quote anything in single quotes, especially not the closing
549 quote. If you don't like this, take out the check on the value
551 if (quote_char
!= '\'' && rl_line_buffer
[scan
] == '\\')
554 found_quote
|= RL_QF_BACKSLASH
;
558 if (quote_char
!= '\0')
560 /* Ignore everything until the matching close quote char. */
561 if (rl_line_buffer
[scan
] == quote_char
)
563 /* Found matching close. Abandon this substring. */
568 else if (strchr (rl_completer_quote_characters
, rl_line_buffer
[scan
]))
570 /* Found start of a quoted substring. */
571 quote_char
= rl_line_buffer
[scan
];
573 /* Shell-like quoting conventions. */
574 if (quote_char
== '\'')
575 found_quote
|= RL_QF_SINGLE_QUOTE
;
576 else if (quote_char
== '"')
577 found_quote
|= RL_QF_DOUBLE_QUOTE
;
582 if (rl_point
== end
&& quote_char
== '\0')
584 /* We didn't find an unclosed quoted substring upon which to do
585 completion, so use the word break characters to find the
586 substring on which to complete. */
589 scan
= rl_line_buffer
[rl_point
];
591 if (strchr (rl_completer_word_break_characters
, scan
) == 0)
594 /* Call the application-specific function to tell us whether
595 this word break character is quoted and should be skipped. */
596 if (rl_char_is_quoted_p
&& found_quote
&&
597 (*rl_char_is_quoted_p
) (rl_line_buffer
, rl_point
))
600 /* Convoluted code, but it avoids an n^2 algorithm with calls
601 to char_is_quoted. */
606 /* If we are at an unquoted word break, then advance past it. */
607 scan
= rl_line_buffer
[rl_point
];
609 /* If there is an application-specific function to say whether or not
610 a character is quoted and we found a quote character, let that
611 function decide whether or not a character is a word break, even
612 if it is found in rl_completer_word_break_characters. Don't bother
613 if we're at the end of the line, though. */
616 if (rl_char_is_quoted_p
)
617 isbrk
= (found_quote
== 0 ||
618 (*rl_char_is_quoted_p
) (rl_line_buffer
, rl_point
) == 0) &&
619 strchr (rl_completer_word_break_characters
, scan
) != 0;
621 isbrk
= strchr (rl_completer_word_break_characters
, scan
) != 0;
625 /* If the character that caused the word break was a quoting
626 character, then remember it as the delimiter. */
627 if (rl_basic_quote_characters
&&
628 strchr (rl_basic_quote_characters
, scan
) &&
629 (end
- rl_point
) > 1)
632 /* If the character isn't needed to determine something special
633 about what kind of completion to perform, then advance past it. */
634 if (rl_special_prefixes
== 0 || strchr (rl_special_prefixes
, scan
) == 0)
648 gen_completion_matches (text
, start
, end
, our_func
, found_quote
, quote_char
)
651 rl_compentry_func_t
*our_func
;
652 int found_quote
, quote_char
;
654 char **matches
, *temp
;
656 /* If the user wants to TRY to complete, but then wants to give
657 up and use the default completion function, they set the
658 variable rl_attempted_completion_function. */
659 if (rl_attempted_completion_function
)
661 matches
= (*rl_attempted_completion_function
) (text
, start
, end
);
663 if (matches
|| rl_attempted_completion_over
)
665 rl_attempted_completion_over
= 0;
670 /* Beware -- we're stripping the quotes here. Do this only if we know
671 we are doing filename completion and the application has defined a
672 filename dequoting function. */
675 if (found_quote
&& our_func
== rl_filename_completion_function
&&
676 rl_filename_dequoting_function
)
678 /* delete single and double quotes */
679 temp
= (*rl_filename_dequoting_function
) (text
, quote_char
);
680 text
= temp
; /* not freeing text is not a memory leak */
683 matches
= rl_completion_matches (text
, our_func
);
688 /* Filter out duplicates in MATCHES. This frees up the strings in
691 remove_duplicate_matches (matches
)
699 /* Sort the items. */
700 for (i
= 0; matches
[i
]; i
++)
703 /* Sort the array without matches[0], since we need it to
704 stay in place no matter what. */
706 qsort (matches
+1, i
-1, sizeof (char *), (QSFUNC
*)_rl_qsort_string_compare
);
708 /* Remember the lowest common denominator for it may be unique. */
709 lowest_common
= savestring (matches
[0]);
711 for (i
= newlen
= 0; matches
[i
+ 1]; i
++)
713 if (strcmp (matches
[i
], matches
[i
+ 1]) == 0)
716 matches
[i
] = (char *)&dead_slot
;
722 /* We have marked all the dead slots with (char *)&dead_slot.
723 Copy all the non-dead entries into a new array. */
724 temp_array
= (char **)xmalloc ((3 + newlen
) * sizeof (char *));
725 for (i
= j
= 1; matches
[i
]; i
++)
727 if (matches
[i
] != (char *)&dead_slot
)
728 temp_array
[j
++] = matches
[i
];
730 temp_array
[j
] = (char *)NULL
;
732 if (matches
[0] != (char *)&dead_slot
)
735 /* Place the lowest common denominator back in [0]. */
736 temp_array
[0] = lowest_common
;
738 /* If there is one string left, and it is identical to the
739 lowest common denominator, then the LCD is the string to
741 if (j
== 2 && strcmp (temp_array
[0], temp_array
[1]) == 0)
743 free (temp_array
[1]);
744 temp_array
[1] = (char *)NULL
;
749 /* Find the common prefix of the list of matches, and put it into
752 compute_lcd_of_matches (match_list
, matches
, text
)
757 register int i
, c1
, c2
, si
;
758 int low
; /* Count of max-matched characters. */
760 /* If only one match, just use that. Otherwise, compare each
761 member of the list with the next, finding out where they
765 match_list
[0] = match_list
[1];
766 match_list
[1] = (char *)NULL
;
770 for (i
= 1, low
= 100000; i
< matches
; i
++)
772 if (_rl_completion_case_fold
)
775 (c1
= _rl_to_lower(match_list
[i
][si
])) &&
776 (c2
= _rl_to_lower(match_list
[i
+ 1][si
]));
784 (c1
= match_list
[i
][si
]) &&
785 (c2
= match_list
[i
+ 1][si
]);
795 /* If there were multiple matches, but none matched up to even the
796 first character, and the user typed something, use that as the
797 value of matches[0]. */
798 if (low
== 0 && text
&& *text
)
800 match_list
[0] = xmalloc (strlen (text
) + 1);
801 strcpy (match_list
[0], text
);
805 match_list
[0] = xmalloc (low
+ 1);
806 strncpy (match_list
[0], match_list
[1], low
);
807 match_list
[0][low
] = '\0';
814 postprocess_matches (matchesp
, matching_filenames
)
816 int matching_filenames
;
818 char *t
, **matches
, **temp_matches
;
823 /* It seems to me that in all the cases we handle we would like
824 to ignore duplicate possiblilities. Scan for the text to
825 insert being identical to the other completions. */
826 if (rl_ignore_completion_duplicates
)
828 temp_matches
= remove_duplicate_matches (matches
);
830 matches
= temp_matches
;
833 /* If we are matching filenames, then here is our chance to
834 do clever processing by re-examining the list. Call the
835 ignore function with the array as a parameter. It can
836 munge the array, deleting matches as it desires. */
837 if (rl_ignore_some_completions_function
&& matching_filenames
)
839 for (nmatch
= 1; matches
[nmatch
]; nmatch
++)
841 (void)(*rl_ignore_some_completions_function
) (matches
);
842 if (matches
== 0 || matches
[0] == 0)
845 *matchesp
= (char **)0;
850 /* If we removed some matches, recompute the common prefix. */
851 for (i
= 1; matches
[i
]; i
++)
853 if (i
> 1 && i
< nmatch
)
856 compute_lcd_of_matches (matches
, i
- 1, t
);
866 /* A convenience function for displaying a list of strings in
867 columnar format on readline's output stream. MATCHES is the list
868 of strings, in argv format, LEN is the number of strings in MATCHES,
869 and MAX is the length of the longest string in MATCHES. */
871 rl_display_match_list (matches
, len
, max
)
875 int count
, limit
, printed_len
;
879 /* How many items of MAX length can we fit in the screen window? */
881 limit
= _rl_screenwidth
/ max
;
882 if (limit
!= 1 && (limit
* max
== _rl_screenwidth
))
885 /* Avoid a possible floating exception. If max > _rl_screenwidth,
886 limit will be 0 and a divide-by-zero fault will result. */
890 /* How many iterations of the printing loop? */
891 count
= (len
+ (limit
- 1)) / limit
;
893 /* Watch out for special case. If LEN is less than LIMIT, then
894 just do the inner printing loop.
895 0 < len <= limit implies count = 1. */
897 /* Sort the items if they are not already sorted. */
898 if (rl_ignore_completion_duplicates
== 0)
899 qsort (matches
+ 1, len
, sizeof (char *), (QSFUNC
*)_rl_qsort_string_compare
);
903 if (_rl_print_completions_horizontally
== 0)
905 /* Print the sorted items, up-and-down alphabetically, like ls. */
906 for (i
= 1; i
<= count
; i
++)
908 for (j
= 0, l
= i
; j
< limit
; j
++)
910 if (l
> len
|| matches
[l
] == 0)
914 temp
= printable_part (matches
[l
]);
915 printed_len
= print_filename (temp
, matches
[l
]);
918 for (k
= 0; k
< max
- printed_len
; k
++)
919 putc (' ', rl_outstream
);
928 /* Print the sorted items, across alphabetically, like ls -x. */
929 for (i
= 1; matches
[i
]; i
++)
931 temp
= printable_part (matches
[i
]);
932 printed_len
= print_filename (temp
, matches
[i
]);
933 /* Have we reached the end of this line? */
936 if (i
&& (limit
> 1) && (i
% limit
) == 0)
939 for (k
= 0; k
< max
- printed_len
; k
++)
940 putc (' ', rl_outstream
);
947 /* Display MATCHES, a list of matching filenames in argv format. This
948 handles the simple case -- a single match -- first. If there is more
949 than one match, we compute the number of strings in the list and the
950 length of the longest string, which will be needed by the display
951 function. If the application wants to handle displaying the list of
952 matches itself, it sets RL_COMPLETION_DISPLAY_MATCHES_HOOK to the
953 address of a function, and we just call it. If we're handling the
954 display ourselves, we just call rl_display_match_list. We also check
955 that the list of matches doesn't exceed the user-settable threshold,
956 and ask the user if he wants to see the list if there are more matches
957 than RL_COMPLETION_QUERY_ITEMS. */
959 display_matches (matches
)
965 /* Move to the last visible line of a possibly-multiple-line command. */
966 _rl_move_vert (_rl_vis_botlin
);
968 /* Handle simple case first. What if there is only one answer? */
971 temp
= printable_part (matches
[0]);
973 print_filename (temp
, matches
[0]);
976 rl_forced_update_display ();
977 rl_display_fixed
= 1;
982 /* There is more than one answer. Find out how many there are,
983 and find the maximum printed length of a single entry. */
984 for (max
= 0, i
= 1; matches
[i
]; i
++)
986 temp
= printable_part (matches
[i
]);
995 /* If the caller has defined a display hook, then call that now. */
996 if (rl_completion_display_matches_hook
)
998 (*rl_completion_display_matches_hook
) (matches
, len
, max
);
1002 /* If there are many items, then ask the user if she really wants to
1004 if (len
>= rl_completion_query_items
)
1007 fprintf (rl_outstream
, "Display all %d possibilities? (y or n)", len
);
1008 fflush (rl_outstream
);
1009 if (get_y_or_n () == 0)
1013 rl_forced_update_display ();
1014 rl_display_fixed
= 1;
1020 rl_display_match_list (matches
, len
, max
);
1022 rl_forced_update_display ();
1023 rl_display_fixed
= 1;
1027 make_quoted_replacement (match
, mtype
, qc
)
1030 char *qc
; /* Pointer to quoting character, if any */
1032 int should_quote
, do_replace
;
1035 /* If we are doing completion on quoted substrings, and any matches
1036 contain any of the completer_word_break_characters, then auto-
1037 matically prepend the substring with a quote character (just pick
1038 the first one from the list of such) if it does not already begin
1039 with a quote string. FIXME: Need to remove any such automatically
1040 inserted quote character when it no longer is necessary, such as
1041 if we change the string we are completing on and the new set of
1042 matches don't require a quoted substring. */
1043 replacement
= match
;
1045 should_quote
= match
&& rl_completer_quote_characters
&&
1046 rl_filename_completion_desired
&&
1047 rl_filename_quoting_desired
;
1050 should_quote
= should_quote
&& (!qc
|| !*qc
||
1051 (rl_completer_quote_characters
&& strchr (rl_completer_quote_characters
, *qc
)));
1055 /* If there is a single match, see if we need to quote it.
1056 This also checks whether the common prefix of several
1057 matches needs to be quoted. */
1058 should_quote
= rl_filename_quote_characters
1059 ? (_rl_strpbrk (match
, rl_filename_quote_characters
) != 0)
1062 do_replace
= should_quote
? mtype
: NO_MATCH
;
1063 /* Quote the replacement, since we found an embedded
1064 word break character in a potential match. */
1065 if (do_replace
!= NO_MATCH
&& rl_filename_quoting_function
)
1066 replacement
= (*rl_filename_quoting_function
) (match
, do_replace
, qc
);
1068 return (replacement
);
1072 insert_match (match
, start
, mtype
, qc
)
1080 oqc
= qc
? *qc
: '\0';
1081 replacement
= make_quoted_replacement (match
, mtype
, qc
);
1083 /* Now insert the match. */
1086 /* Don't double an opening quote character. */
1087 if (qc
&& *qc
&& start
&& rl_line_buffer
[start
- 1] == *qc
&&
1088 replacement
[0] == *qc
)
1090 /* If make_quoted_replacement changed the quoting character, remove
1091 the opening quote and insert the (fully-quoted) replacement. */
1092 else if (qc
&& (*qc
!= oqc
) && start
&& rl_line_buffer
[start
- 1] == oqc
&&
1093 replacement
[0] != oqc
)
1095 _rl_replace_text (replacement
, start
, rl_point
- 1);
1096 if (replacement
!= match
)
1101 /* Append any necessary closing quote and a separator character to the
1102 just-inserted match. If the user has specified that directories
1103 should be marked by a trailing `/', append one of those instead. The
1104 default trailing character is a space. Returns the number of characters
1107 append_to_match (text
, delimiter
, quote_char
)
1109 int delimiter
, quote_char
;
1111 char temp_string
[4], *filename
;
1112 int temp_string_index
;
1115 temp_string_index
= 0;
1116 if (quote_char
&& rl_point
&& rl_line_buffer
[rl_point
- 1] != quote_char
)
1117 temp_string
[temp_string_index
++] = quote_char
;
1120 temp_string
[temp_string_index
++] = delimiter
;
1121 else if (rl_completion_append_character
)
1122 temp_string
[temp_string_index
++] = rl_completion_append_character
;
1124 temp_string
[temp_string_index
++] = '\0';
1126 if (rl_filename_completion_desired
)
1128 filename
= tilde_expand (text
);
1129 if (stat (filename
, &finfo
) == 0 && S_ISDIR (finfo
.st_mode
))
1131 if (_rl_complete_mark_directories
&& rl_line_buffer
[rl_point
] != '/')
1132 rl_insert_text ("/");
1136 if (rl_point
== rl_end
)
1137 rl_insert_text (temp_string
);
1143 if (rl_point
== rl_end
)
1144 rl_insert_text (temp_string
);
1147 return (temp_string_index
);
1151 insert_all_matches (matches
, point
, qc
)
1159 rl_begin_undo_group ();
1160 /* remove any opening quote character; make_quoted_replacement will add
1162 if (qc
&& *qc
&& point
&& rl_line_buffer
[point
- 1] == *qc
)
1164 rl_delete_text (point
, rl_point
);
1169 for (i
= 1; matches
[i
]; i
++)
1171 rp
= make_quoted_replacement (matches
[i
], SINGLE_MATCH
, qc
);
1172 rl_insert_text (rp
);
1173 rl_insert_text (" ");
1174 if (rp
!= matches
[i
])
1180 rp
= make_quoted_replacement (matches
[0], SINGLE_MATCH
, qc
);
1181 rl_insert_text (rp
);
1182 rl_insert_text (" ");
1183 if (rp
!= matches
[0])
1186 rl_end_undo_group ();
1190 free_match_list (matches
)
1195 for (i
= 0; matches
[i
]; i
++)
1200 /* Complete the word at or before point.
1201 WHAT_TO_DO says what to do with the completion.
1202 `?' means list the possible completions.
1203 TAB means do standard completion.
1204 `*' means insert all of the possible completions.
1205 `!' means to do standard completion, and list all possible completions if
1206 there is more than one. */
1208 rl_complete_internal (what_to_do
)
1212 rl_compentry_func_t
*our_func
;
1213 int start
, end
, delimiter
, found_quote
, i
;
1214 char *text
, *saved_line_buffer
;
1217 RL_SETSTATE(RL_STATE_COMPLETING
);
1218 /* Only the completion entry function can change these. */
1219 rl_filename_completion_desired
= 0;
1220 rl_filename_quoting_desired
= 1;
1221 rl_completion_type
= what_to_do
;
1223 saved_line_buffer
= rl_line_buffer
? savestring (rl_line_buffer
) : (char *)NULL
;
1224 our_func
= rl_completion_entry_function
1225 ? rl_completion_entry_function
1226 : rl_filename_completion_function
;
1228 /* We now look backwards for the start of a filename/variable word. */
1230 found_quote
= delimiter
= 0;
1234 /* This (possibly) changes rl_point. If it returns a non-zero char,
1235 we know we have an open quote. */
1236 quote_char
= find_completion_word (&found_quote
, &delimiter
);
1241 text
= rl_copy_text (start
, end
);
1242 matches
= gen_completion_matches (text
, start
, end
, our_func
, found_quote
, quote_char
);
1248 FREE (saved_line_buffer
);
1249 RL_UNSETSTATE(RL_STATE_COMPLETING
);
1253 /* If we are matching filenames, the attempted completion function will
1254 have set rl_filename_completion_desired to a non-zero value. The basic
1255 rl_filename_completion_function does this. */
1256 i
= rl_filename_completion_desired
;
1258 if (postprocess_matches (&matches
, i
) == 0)
1261 FREE (saved_line_buffer
);
1262 completion_changed_buffer
= 0;
1263 RL_UNSETSTATE(RL_STATE_COMPLETING
);
1271 /* Insert the first match with proper quoting. */
1273 insert_match (matches
[0], start
, matches
[1] ? MULT_MATCH
: SINGLE_MATCH
, "e_char
);
1275 /* If there are more matches, ring the bell to indicate.
1276 If we are in vi mode, Posix.2 says to not ring the bell.
1277 If the `show-all-if-ambiguous' variable is set, display
1278 all the matches immediately. Otherwise, if this was the
1279 only match, and we are hacking files, check the file to
1280 see if it was a directory. If so, and the `mark-directories'
1281 variable is set, add a '/' to the name. If not, and we
1282 are at the end of the line, then add a space. */
1285 if (what_to_do
== '!')
1287 display_matches (matches
);
1290 else if (rl_editing_mode
!= vi_mode
)
1291 rl_ding (); /* There are other matches remaining. */
1294 append_to_match (matches
[0], delimiter
, quote_char
);
1299 insert_all_matches (matches
, start
, "e_char
);
1303 display_matches (matches
);
1307 fprintf (stderr
, "\r\nreadline: bad value %d for what_to_do in rl_complete\n", what_to_do
);
1309 FREE (saved_line_buffer
);
1310 RL_UNSETSTATE(RL_STATE_COMPLETING
);
1314 free_match_list (matches
);
1316 /* Check to see if the line has changed through all of this manipulation. */
1317 if (saved_line_buffer
)
1319 completion_changed_buffer
= strcmp (rl_line_buffer
, saved_line_buffer
) != 0;
1320 free (saved_line_buffer
);
1323 RL_UNSETSTATE(RL_STATE_COMPLETING
);
1327 /***************************************************************/
1329 /* Application-callable completion match generator functions */
1331 /***************************************************************/
1333 /* Return an array of (char *) which is a list of completions for TEXT.
1334 If there are no completions, return a NULL pointer.
1335 The first entry in the returned array is the substitution for TEXT.
1336 The remaining entries are the possible completions.
1337 The array is terminated with a NULL pointer.
1339 ENTRY_FUNCTION is a function of two args, and returns a (char *).
1340 The first argument is TEXT.
1341 The second is a state argument; it should be zero on the first call, and
1342 non-zero on subsequent calls. It returns a NULL pointer to the caller
1343 when there are no more matches.
1346 rl_completion_matches (text
, entry_function
)
1348 rl_compentry_func_t
*entry_function
;
1350 /* Number of slots in match_list. */
1351 int match_list_size
;
1353 /* The list of matches. */
1356 /* Number of matches actually found. */
1359 /* Temporary string binder. */
1363 match_list_size
= 10;
1364 match_list
= (char **)xmalloc ((match_list_size
+ 1) * sizeof (char *));
1365 match_list
[1] = (char *)NULL
;
1367 while (string
= (*entry_function
) (text
, matches
))
1369 if (matches
+ 1 == match_list_size
)
1370 match_list
= (char **)xrealloc
1371 (match_list
, ((match_list_size
+= 10) + 1) * sizeof (char *));
1373 match_list
[++matches
] = string
;
1374 match_list
[matches
+ 1] = (char *)NULL
;
1377 /* If there were any matches, then look through them finding out the
1378 lowest common denominator. That then becomes match_list[0]. */
1380 compute_lcd_of_matches (match_list
, matches
, text
);
1381 else /* There were no matches. */
1384 match_list
= (char **)NULL
;
1386 return (match_list
);
1389 /* A completion function for usernames.
1390 TEXT contains a partial username preceded by a random
1391 character (usually `~'). */
1393 rl_username_completion_function (text
, state
)
1397 #if defined (__WIN32__) || defined (__OPENNT)
1398 return (char *)NULL
;
1399 #else /* !__WIN32__ && !__OPENNT) */
1400 static char *username
= (char *)NULL
;
1401 static struct passwd
*entry
;
1402 static int namelen
, first_char
, first_char_loc
;
1410 first_char_loc
= first_char
== '~';
1412 username
= savestring (&text
[first_char_loc
]);
1413 namelen
= strlen (username
);
1417 while (entry
= getpwent ())
1419 /* Null usernames should result in all users as possible completions. */
1420 if (namelen
== 0 || (STREQN (username
, entry
->pw_name
, namelen
)))
1427 return ((char *)NULL
);
1431 value
= xmalloc (2 + strlen (entry
->pw_name
));
1435 strcpy (value
+ first_char_loc
, entry
->pw_name
);
1437 if (first_char
== '~')
1438 rl_filename_completion_desired
= 1;
1442 #endif /* !__WIN32__ && !__OPENNT */
1445 /* Okay, now we write the entry_function for filename completion. In the
1446 general case. Note that completion in the shell is a little different
1447 because of all the pathnames that must be followed when looking up the
1448 completion for a command. */
1450 rl_filename_completion_function (text
, state
)
1454 static DIR *directory
= (DIR *)NULL
;
1455 static char *filename
= (char *)NULL
;
1456 static char *dirname
= (char *)NULL
;
1457 static char *users_dirname
= (char *)NULL
;
1458 static int filename_len
;
1461 struct dirent
*entry
;
1463 /* If we don't have any state, then do some initialization. */
1466 /* If we were interrupted before closing the directory or reading
1467 all of its contents, close it. */
1470 closedir (directory
);
1471 directory
= (DIR *)NULL
;
1475 FREE (users_dirname
);
1477 filename
= savestring (text
);
1480 dirname
= savestring (text
);
1482 temp
= strrchr (dirname
, '/');
1484 #if defined (__MSDOS__)
1485 /* special hack for //X/... */
1486 if (dirname
[0] == '/' && dirname
[1] == '/' && isalpha (dirname
[2]) && dirname
[3] == '/')
1487 temp
= strrchr (dirname
+ 3, '/');
1492 strcpy (filename
, ++temp
);
1495 #if defined (__MSDOS__)
1496 /* searches from current directory on the drive */
1497 else if (isalpha (dirname
[0]) && dirname
[1] == ':')
1499 strcpy (filename
, dirname
+ 2);
1509 /* We aren't done yet. We also support the "~user" syntax. */
1511 /* Save the version of the directory that the user typed. */
1512 users_dirname
= savestring (dirname
);
1514 if (*dirname
== '~')
1516 temp
= tilde_expand (dirname
);
1521 if (rl_directory_rewrite_hook
)
1522 (*rl_directory_rewrite_hook
) (&dirname
);
1524 if (rl_directory_completion_hook
&& (*rl_directory_completion_hook
) (&dirname
))
1526 free (users_dirname
);
1527 users_dirname
= savestring (dirname
);
1530 directory
= opendir (dirname
);
1531 filename_len
= strlen (filename
);
1533 rl_filename_completion_desired
= 1;
1536 /* At this point we should entertain the possibility of hacking wildcarded
1537 filenames, like /usr/man/man<WILD>/te<TAB>. If the directory name
1538 contains globbing characters, then build an array of directories, and
1539 then map over that list while completing. */
1540 /* *** UNIMPLEMENTED *** */
1542 /* Now that we have some state, we can read the directory. */
1544 entry
= (struct dirent
*)NULL
;
1545 while (directory
&& (entry
= readdir (directory
)))
1547 /* Special case for no filename.
1548 All entries except "." and ".." match. */
1549 if (filename_len
== 0)
1551 if (entry
->d_name
[0] != '.' ||
1552 (entry
->d_name
[1] &&
1553 (entry
->d_name
[1] != '.' || entry
->d_name
[2])))
1558 /* Otherwise, if these match up to the length of filename, then
1560 if (_rl_completion_case_fold
)
1562 if ((_rl_to_lower (entry
->d_name
[0]) == _rl_to_lower (filename
[0])) &&
1563 (((int)D_NAMLEN (entry
)) >= filename_len
) &&
1564 (_rl_strnicmp (filename
, entry
->d_name
, filename_len
) == 0))
1569 if ((entry
->d_name
[0] == filename
[0]) &&
1570 (((int)D_NAMLEN (entry
)) >= filename_len
) &&
1571 (strncmp (filename
, entry
->d_name
, filename_len
) == 0))
1581 closedir (directory
);
1582 directory
= (DIR *)NULL
;
1587 dirname
= (char *)NULL
;
1592 filename
= (char *)NULL
;
1596 free (users_dirname
);
1597 users_dirname
= (char *)NULL
;
1600 return (char *)NULL
;
1604 /* dirname && (strcmp (dirname, ".") != 0) */
1605 if (dirname
&& (dirname
[0] != '.' || dirname
[1]))
1607 if (rl_complete_with_tilde_expansion
&& *users_dirname
== '~')
1609 dirlen
= strlen (dirname
);
1610 temp
= xmalloc (2 + dirlen
+ D_NAMLEN (entry
));
1611 strcpy (temp
, dirname
);
1612 /* Canonicalization cuts off any final slash present. We
1613 may need to add it back. */
1614 if (dirname
[dirlen
- 1] != '/')
1616 temp
[dirlen
++] = '/';
1617 temp
[dirlen
] = '\0';
1622 dirlen
= strlen (users_dirname
);
1623 temp
= xmalloc (2 + dirlen
+ D_NAMLEN (entry
));
1624 strcpy (temp
, users_dirname
);
1625 /* Make sure that temp has a trailing slash here. */
1626 if (users_dirname
[dirlen
- 1] != '/')
1627 temp
[dirlen
++] = '/';
1630 strcpy (temp
+ dirlen
, entry
->d_name
);
1633 temp
= savestring (entry
->d_name
);
1639 /* An initial implementation of a menu completion function a la tcsh. The
1640 first time (if the last readline command was not rl_menu_complete), we
1641 generate the list of matches. This code is very similar to the code in
1642 rl_complete_internal -- there should be a way to combine the two. Then,
1643 for each item in the list of matches, we insert the match in an undoable
1644 fashion, with the appropriate character appended (this happens on the
1645 second and subsequent consecutive calls to rl_menu_complete). When we
1646 hit the end of the match list, we restore the original unmatched text,
1647 ring the bell, and reset the counter to zero. */
1649 rl_menu_complete (count
, ignore
)
1652 rl_compentry_func_t
*our_func
;
1653 int matching_filenames
, found_quote
;
1655 static char *orig_text
;
1656 static char **matches
= (char **)0;
1657 static int match_list_index
= 0;
1658 static int match_list_size
= 0;
1659 static int orig_start
, orig_end
;
1660 static char quote_char
;
1661 static int delimiter
;
1663 /* The first time through, we generate the list of matches and set things
1664 up to insert them. */
1665 if (rl_last_func
!= rl_menu_complete
)
1667 /* Clean up from previous call, if any. */
1670 free_match_list (matches
);
1672 match_list_index
= match_list_size
= 0;
1673 matches
= (char **)NULL
;
1675 /* Only the completion entry function can change these. */
1676 rl_filename_completion_desired
= 0;
1677 rl_filename_quoting_desired
= 1;
1678 rl_completion_type
= '%';
1680 our_func
= rl_completion_entry_function
1681 ? rl_completion_entry_function
1682 : rl_filename_completion_function
;
1684 /* We now look backwards for the start of a filename/variable word. */
1685 orig_end
= rl_point
;
1686 found_quote
= delimiter
= 0;
1690 /* This (possibly) changes rl_point. If it returns a non-zero char,
1691 we know we have an open quote. */
1692 quote_char
= find_completion_word (&found_quote
, &delimiter
);
1694 orig_start
= rl_point
;
1695 rl_point
= orig_end
;
1697 orig_text
= rl_copy_text (orig_start
, orig_end
);
1698 matches
= gen_completion_matches (orig_text
, orig_start
, orig_end
,
1699 our_func
, found_quote
, quote_char
);
1701 /* If we are matching filenames, the attempted completion function will
1702 have set rl_filename_completion_desired to a non-zero value. The basic
1703 rl_filename_completion_function does this. */
1704 matching_filenames
= rl_filename_completion_desired
;
1706 if (matches
== 0 || postprocess_matches (&matches
, matching_filenames
) == 0)
1710 matches
= (char **)0;
1712 orig_text
= (char *)0;
1713 completion_changed_buffer
= 0;
1717 for (match_list_size
= 0; matches
[match_list_size
]; match_list_size
++)
1719 /* matches[0] is lcd if match_list_size > 1, but the circular buffer
1720 code below should take care of it. */
1723 /* Now we have the list of matches. Replace the text between
1724 rl_line_buffer[orig_start] and rl_line_buffer[rl_point] with
1725 matches[match_list_index], and add any necessary closing char. */
1727 if (matches
== 0 || match_list_size
== 0)
1731 matches
= (char **)0;
1732 completion_changed_buffer
= 0;
1736 match_list_index
= (match_list_index
+ count
) % match_list_size
;
1737 if (match_list_index
< 0)
1738 match_list_index
+= match_list_size
;
1740 if (match_list_index
== 0 && match_list_size
> 1)
1743 insert_match (orig_text
, orig_start
, MULT_MATCH
, "e_char
);
1747 insert_match (matches
[match_list_index
], orig_start
, SINGLE_MATCH
, "e_char
);
1748 append_to_match (matches
[match_list_index
], delimiter
, quote_char
);
1751 completion_changed_buffer
= 1;