]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libedit/filecomplete.c
Bring LLVM libunwind snapshot into contrib/llvm/projects
[FreeBSD/FreeBSD.git] / lib / libedit / filecomplete.c
1 /*      $NetBSD: filecomplete.c,v 1.34 2014/10/18 15:07:02 riz Exp $    */
2
3 /*-
4  * Copyright (c) 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jaromir Dolecek.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #if !defined(lint) && !defined(SCCSID)
34 __RCSID("$NetBSD: filecomplete.c,v 1.34 2014/10/18 15:07:02 riz Exp $");
35 #endif /* not lint && not SCCSID */
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38
39 #include <sys/types.h>
40 #include <sys/stat.h>
41 #include <stdio.h>
42 #include <dirent.h>
43 #include <string.h>
44 #include <pwd.h>
45 #include <ctype.h>
46 #include <stdlib.h>
47 #include <unistd.h>
48 #include <limits.h>
49 #include <errno.h>
50 #include <fcntl.h>
51
52 #include "el.h"
53 #include "fcns.h"               /* for EL_NUM_FCNS */
54 #include "histedit.h"
55 #include "filecomplete.h"
56
57 static const Char break_chars[] = { ' ', '\t', '\n', '"', '\\', '\'', '`', '@',
58     '$', '>', '<', '=', ';', '|', '&', '{', '(', '\0' };
59 /* Tilde is deliberately omitted here, we treat it specially. */
60 static const Char extra_quote_chars[] = { ')', '}', '*', '?', '[', '$', '\0' };
61
62
63 /********************************/
64 /* completion functions */
65
66 /*
67  * does tilde expansion of strings of type ``~user/foo''
68  * if ``user'' isn't valid user name or ``txt'' doesn't start
69  * w/ '~', returns pointer to strdup()ed copy of ``txt''
70  *
71  * it's the caller's responsibility to free() the returned string
72  */
73 char *
74 fn_tilde_expand(const char *txt)
75 {
76 #if defined(HAVE_GETPW_R_POSIX) || defined(HAVE_GETPW_R_DRAFT)
77         struct passwd pwres;
78         char pwbuf[1024];
79 #endif
80         struct passwd *pass;
81         char *temp;
82         size_t len = 0;
83
84         if (txt[0] != '~')
85                 return strdup(txt);
86
87         temp = strchr(txt + 1, '/');
88         if (temp == NULL) {
89                 temp = strdup(txt + 1);
90                 if (temp == NULL)
91                         return NULL;
92         } else {
93                 /* text until string after slash */
94                 len = (size_t)(temp - txt + 1);
95                 temp = el_malloc(len * sizeof(*temp));
96                 if (temp == NULL)
97                         return NULL;
98                 (void)strncpy(temp, txt + 1, len - 2);
99                 temp[len - 2] = '\0';
100         }
101         if (temp[0] == 0) {
102 #ifdef HAVE_GETPW_R_POSIX
103                 if (getpwuid_r(getuid(), &pwres, pwbuf, sizeof(pwbuf),
104                     &pass) != 0)
105                         pass = NULL;
106 #elif HAVE_GETPW_R_DRAFT
107                 pass = getpwuid_r(getuid(), &pwres, pwbuf, sizeof(pwbuf));
108 #else
109                 pass = getpwuid(getuid());
110 #endif
111         } else {
112 #ifdef HAVE_GETPW_R_POSIX
113                 if (getpwnam_r(temp, &pwres, pwbuf, sizeof(pwbuf), &pass) != 0)
114                         pass = NULL;
115 #elif HAVE_GETPW_R_DRAFT
116                 pass = getpwnam_r(temp, &pwres, pwbuf, sizeof(pwbuf));
117 #else
118                 pass = getpwnam(temp);
119 #endif
120         }
121         el_free(temp);          /* value no more needed */
122         if (pass == NULL)
123                 return strdup(txt);
124
125         /* update pointer txt to point at string immedially following */
126         /* first slash */
127         txt += len;
128
129         len = strlen(pass->pw_dir) + 1 + strlen(txt) + 1;
130         temp = el_malloc(len * sizeof(*temp));
131         if (temp == NULL)
132                 return NULL;
133         (void)snprintf(temp, len, "%s/%s", pass->pw_dir, txt);
134
135         return temp;
136 }
137
138
139 /*
140  * return first found file name starting by the ``text'' or NULL if no
141  * such file can be found
142  * value of ``state'' is ignored
143  *
144  * it's the caller's responsibility to free the returned string
145  */
146 char *
147 fn_filename_completion_function(const char *text, int state)
148 {
149         static DIR *dir = NULL;
150         static char *filename = NULL, *dirname = NULL, *dirpath = NULL;
151         static size_t filename_len = 0;
152         struct dirent *entry;
153         char *temp;
154         size_t len;
155
156         if (state == 0 || dir == NULL) {
157                 temp = strrchr(text, '/');
158                 if (temp) {
159                         char *nptr;
160                         temp++;
161                         nptr = el_realloc(filename, (strlen(temp) + 1) *
162                             sizeof(*nptr));
163                         if (nptr == NULL) {
164                                 el_free(filename);
165                                 filename = NULL;
166                                 return NULL;
167                         }
168                         filename = nptr;
169                         (void)strcpy(filename, temp);
170                         len = (size_t)(temp - text);    /* including last slash */
171
172                         nptr = el_realloc(dirname, (len + 1) *
173                             sizeof(*nptr));
174                         if (nptr == NULL) {
175                                 el_free(dirname);
176                                 dirname = NULL;
177                                 return NULL;
178                         }
179                         dirname = nptr;
180                         (void)strncpy(dirname, text, len);
181                         dirname[len] = '\0';
182                 } else {
183                         el_free(filename);
184                         if (*text == 0)
185                                 filename = NULL;
186                         else {
187                                 filename = strdup(text);
188                                 if (filename == NULL)
189                                         return NULL;
190                         }
191                         el_free(dirname);
192                         dirname = NULL;
193                 }
194
195                 if (dir != NULL) {
196                         (void)closedir(dir);
197                         dir = NULL;
198                 }
199
200                 /* support for ``~user'' syntax */
201
202                 el_free(dirpath);
203                 dirpath = NULL;
204                 if (dirname == NULL) {
205                         if ((dirname = strdup("")) == NULL)
206                                 return NULL;
207                         dirpath = strdup("./");
208                 } else if (*dirname == '~')
209                         dirpath = fn_tilde_expand(dirname);
210                 else
211                         dirpath = strdup(dirname);
212
213                 if (dirpath == NULL)
214                         return NULL;
215
216                 dir = opendir(dirpath);
217                 if (!dir)
218                         return NULL;    /* cannot open the directory */
219
220                 /* will be used in cycle */
221                 filename_len = filename ? strlen(filename) : 0;
222         }
223
224         /* find the match */
225         while ((entry = readdir(dir)) != NULL) {
226                 /* skip . and .. */
227                 if (entry->d_name[0] == '.' && (!entry->d_name[1]
228                     || (entry->d_name[1] == '.' && !entry->d_name[2])))
229                         continue;
230                 if (filename_len == 0)
231                         break;
232                 /* otherwise, get first entry where first */
233                 /* filename_len characters are equal      */
234                 if (entry->d_name[0] == filename[0]
235 #if HAVE_STRUCT_DIRENT_D_NAMLEN
236                     && entry->d_namlen >= filename_len
237 #else
238                     && strlen(entry->d_name) >= filename_len
239 #endif
240                     && strncmp(entry->d_name, filename,
241                         filename_len) == 0)
242                         break;
243         }
244
245         if (entry) {            /* match found */
246
247 #if HAVE_STRUCT_DIRENT_D_NAMLEN
248                 len = entry->d_namlen;
249 #else
250                 len = strlen(entry->d_name);
251 #endif
252
253                 len = strlen(dirname) + len + 1;
254                 temp = el_malloc(len * sizeof(*temp));
255                 if (temp == NULL)
256                         return NULL;
257                 (void)snprintf(temp, len, "%s%s", dirname, entry->d_name);
258         } else {
259                 (void)closedir(dir);
260                 dir = NULL;
261                 temp = NULL;
262         }
263
264         return temp;
265 }
266
267
268 static const char *
269 append_char_function(const char *name)
270 {
271         struct stat stbuf;
272         char *expname = *name == '~' ? fn_tilde_expand(name) : NULL;
273         const char *rs = " ";
274
275         if (stat(expname ? expname : name, &stbuf) == -1)
276                 goto out;
277         if (S_ISDIR(stbuf.st_mode))
278                 rs = "/";
279 out:
280         if (expname)
281                 el_free(expname);
282         return rs;
283 }
284 /*
285  * returns list of completions for text given
286  * non-static for readline.
287  */
288 char ** completion_matches(const char *, char *(*)(const char *, int));
289 char **
290 completion_matches(const char *text, char *(*genfunc)(const char *, int))
291 {
292         char **match_list = NULL, *retstr, *prevstr;
293         size_t match_list_len, max_equal, which, i;
294         size_t matches;
295
296         matches = 0;
297         match_list_len = 1;
298         while ((retstr = (*genfunc) (text, (int)matches)) != NULL) {
299                 /* allow for list terminator here */
300                 if (matches + 3 >= match_list_len) {
301                         char **nmatch_list;
302                         while (matches + 3 >= match_list_len)
303                                 match_list_len <<= 1;
304                         nmatch_list = el_realloc(match_list,
305                             match_list_len * sizeof(*nmatch_list));
306                         if (nmatch_list == NULL) {
307                                 el_free(match_list);
308                                 return NULL;
309                         }
310                         match_list = nmatch_list;
311
312                 }
313                 match_list[++matches] = retstr;
314         }
315
316         if (!match_list)
317                 return NULL;    /* nothing found */
318
319         /* find least denominator and insert it to match_list[0] */
320         which = 2;
321         prevstr = match_list[1];
322         max_equal = strlen(prevstr);
323         for (; which <= matches; which++) {
324                 for (i = 0; i < max_equal &&
325                     prevstr[i] == match_list[which][i]; i++)
326                         continue;
327                 max_equal = i;
328         }
329
330         retstr = el_malloc((max_equal + 1) * sizeof(*retstr));
331         if (retstr == NULL) {
332                 el_free(match_list);
333                 return NULL;
334         }
335         (void)strncpy(retstr, match_list[1], max_equal);
336         retstr[max_equal] = '\0';
337         match_list[0] = retstr;
338
339         /* add NULL as last pointer to the array */
340         match_list[matches + 1] = NULL;
341
342         return match_list;
343 }
344
345 /*
346  * Sort function for qsort(). Just wrapper around strcasecmp().
347  */
348 static int
349 _fn_qsort_string_compare(const void *i1, const void *i2)
350 {
351         const char *s1 = ((const char * const *)i1)[0];
352         const char *s2 = ((const char * const *)i2)[0];
353
354         return strcasecmp(s1, s2);
355 }
356
357 /*
358  * Display list of strings in columnar format on readline's output stream.
359  * 'matches' is list of strings, 'num' is number of strings in 'matches',
360  * 'width' is maximum length of string in 'matches'.
361  *
362  * matches[0] is not one of the match strings, but it is counted in
363  * num, so the strings are matches[1] *through* matches[num-1].
364  */
365 void
366 fn_display_match_list (EditLine *el, char **matches, size_t num, size_t width)
367 {
368         size_t line, lines, col, cols, thisguy;
369         int screenwidth = el->el_terminal.t_size.h;
370
371         /* Ignore matches[0]. Avoid 1-based array logic below. */
372         matches++;
373         num--;
374
375         /*
376          * Find out how many entries can be put on one line; count
377          * with one space between strings the same way it's printed.
378          */
379         cols = (size_t)screenwidth / (width + 1);
380         if (cols == 0)
381                 cols = 1;
382
383         /* how many lines of output, rounded up */
384         lines = (num + cols - 1) / cols;
385
386         /* Sort the items. */
387         qsort(matches, num, sizeof(char *), _fn_qsort_string_compare);
388
389         /*
390          * On the ith line print elements i, i+lines, i+lines*2, etc.
391          */
392         for (line = 0; line < lines; line++) {
393                 for (col = 0; col < cols; col++) {
394                         thisguy = line + col * lines;
395                         if (thisguy >= num)
396                                 break;
397                         (void)fprintf(el->el_outfile, "%s%-*s",
398                             col == 0 ? "" : " ", (int)width, matches[thisguy]);
399                 }
400                 (void)fprintf(el->el_outfile, "\n");
401         }
402 }
403
404 /*
405  * Complete the word at or before point,
406  * 'what_to_do' says what to do with the completion.
407  * \t   means do standard completion.
408  * `?' means list the possible completions.
409  * `*' means insert all of the possible completions.
410  * `!' means to do standard completion, and list all possible completions if
411  * there is more than one.
412  *
413  * Note: '*' support is not implemented
414  *       '!' could never be invoked
415  */
416 int
417 fn_complete(EditLine *el,
418         char *(*complet_func)(const char *, int),
419         char **(*attempted_completion_function)(const char *, int, int),
420         const Char *word_break, const Char *special_prefixes,
421         const char *(*app_func)(const char *), size_t query_items,
422         int *completion_type, int *over, int *point, int *end,
423         const Char *(*find_word_start_func)(const Char *, const Char *),
424         Char *(*dequoting_func)(const Char *),
425         char *(*quoting_func)(const char *))
426 {
427         const TYPE(LineInfo) *li;
428         Char *temp;
429         Char *dequoted_temp;
430         char **matches;
431         const Char *ctemp;
432         size_t len;
433         int what_to_do = '\t';
434         int retval = CC_NORM;
435
436         if (el->el_state.lastcmd == el->el_state.thiscmd)
437                 what_to_do = '?';
438
439         /* readline's rl_complete() has to be told what we did... */
440         if (completion_type != NULL)
441                 *completion_type = what_to_do;
442
443         if (!complet_func)
444                 complet_func = fn_filename_completion_function;
445         if (!app_func)
446                 app_func = append_char_function;
447
448         /* We now look backwards for the start of a filename/variable word */
449         li = FUN(el,line)(el);
450         if (find_word_start_func)
451                 ctemp = find_word_start_func(li->buffer, li->cursor);
452         else {
453                 ctemp = li->cursor;
454                 while (ctemp > li->buffer
455                     && !Strchr(word_break, ctemp[-1])
456                     && (!special_prefixes || !Strchr(special_prefixes, ctemp[-1]) ) )
457                         ctemp--;
458         }
459
460         len = (size_t)(li->cursor - ctemp);
461         temp = el_malloc((len + 1) * sizeof(*temp));
462         (void)Strncpy(temp, ctemp, len);
463         temp[len] = '\0';
464
465         if (dequoting_func) {
466                 dequoted_temp = dequoting_func(temp);
467                 if (dequoted_temp == NULL)
468                         return retval;
469         } else
470                 dequoted_temp = NULL;
471
472         /* these can be used by function called in completion_matches() */
473         /* or (*attempted_completion_function)() */
474         if (point != 0)
475                 *point = (int)(li->cursor - li->buffer);
476         if (end != NULL)
477                 *end = (int)(li->lastchar - li->buffer);
478
479         if (attempted_completion_function) {
480                 int cur_off = (int)(li->cursor - li->buffer);
481                 matches = (*attempted_completion_function)(
482                     ct_encode_string(dequoted_temp ? dequoted_temp : temp,
483                         &el->el_scratch),
484                     cur_off - (int)len, cur_off);
485         } else
486                 matches = 0;
487         if (!attempted_completion_function || 
488             (over != NULL && !*over && !matches))
489                 matches = completion_matches(
490                     ct_encode_string(dequoted_temp ? dequoted_temp : temp,
491                         &el->el_scratch), complet_func);
492
493         if (over != NULL)
494                 *over = 0;
495
496         if (matches) {
497                 int i;
498                 size_t matches_num, maxlen, match_len, match_display=1;
499
500                 retval = CC_REFRESH;
501                 /*
502                  * Only replace the completed string with common part of
503                  * possible matches if there is possible completion.
504                  */
505                 if (matches[0][0] != '\0') {
506                         char *quoted_match;
507                         if (quoting_func) {
508                                 quoted_match = quoting_func(matches[0]);
509                                 if (quoted_match == NULL)
510                                         goto free_matches;
511                         } else
512                                 quoted_match = NULL;
513                         el_deletestr(el, (int) len);
514                         FUN(el,insertstr)(el,
515                             ct_decode_string(quoted_match ? quoted_match :
516                                 matches[0] , &el->el_scratch));
517                 }
518
519                 if (what_to_do == '?')
520                         goto display_matches;
521
522                 if (matches[2] == NULL &&
523                     (matches[1] == NULL || strcmp(matches[0], matches[1]) == 0)) {
524                         /*
525                          * We found exact match. Add a space after
526                          * it, unless we do filename completion and the
527                          * object is a directory.
528                          */
529                         FUN(el,insertstr)(el,
530                             ct_decode_string((*app_func)(matches[0]),
531                             &el->el_scratch));
532                 } else if (what_to_do == '!') {
533     display_matches:
534                         /*
535                          * More than one match and requested to list possible
536                          * matches.
537                          */
538
539                         for(i = 1, maxlen = 0; matches[i]; i++) {
540                                 match_len = strlen(matches[i]);
541                                 if (match_len > maxlen)
542                                         maxlen = match_len;
543                         }
544                         /* matches[1] through matches[i-1] are available */
545                         matches_num = (size_t)(i - 1);
546                                 
547                         /* newline to get on next line from command line */
548                         (void)fprintf(el->el_outfile, "\n");
549
550                         /*
551                          * If there are too many items, ask user for display
552                          * confirmation.
553                          */
554                         if (matches_num > query_items) {
555                                 (void)fprintf(el->el_outfile,
556                                     "Display all %zu possibilities? (y or n) ",
557                                     matches_num);
558                                 (void)fflush(el->el_outfile);
559                                 if (getc(stdin) != 'y')
560                                         match_display = 0;
561                                 (void)fprintf(el->el_outfile, "\n");
562                         }
563
564                         if (match_display) {
565                                 /*
566                                  * Interface of this function requires the
567                                  * strings be matches[1..num-1] for compat.
568                                  * We have matches_num strings not counting
569                                  * the prefix in matches[0], so we need to
570                                  * add 1 to matches_num for the call.
571                                  */
572                                 fn_display_match_list(el, matches,
573                                     matches_num+1, maxlen);
574                         }
575                         retval = CC_REDISPLAY;
576                 } else if (matches[0][0]) {
577                         /*
578                          * There was some common match, but the name was
579                          * not complete enough. Next tab will print possible
580                          * completions.
581                          */
582                         el_beep(el);
583                 } else {
584                         /* lcd is not a valid object - further specification */
585                         /* is needed */
586                         el_beep(el);
587                         retval = CC_NORM;
588                 }
589
590 free_matches:
591                 /* free elements of array and the array itself */
592                 for (i = 0; matches[i]; i++)
593                         el_free(matches[i]);
594                 el_free(matches);
595                 matches = NULL;
596         }
597         free(dequoted_temp);
598         el_free(temp);
599         return retval;
600 }
601
602 /*
603  * el-compatible wrapper around rl_complete; needed for key binding
604  */
605 /* ARGSUSED */
606 unsigned char
607 _el_fn_complete(EditLine *el, int ch __attribute__((__unused__)))
608 {
609         return (unsigned char)fn_complete(el, NULL, NULL,
610             break_chars, NULL, NULL, (size_t)100,
611             NULL, NULL, NULL, NULL,
612             NULL, NULL, NULL);
613 }
614
615 static const Char *
616 sh_find_word_start(const Char *buffer, const Char *cursor)
617 {
618         const Char *word_start = buffer;
619
620         while (buffer < cursor) {
621                 if (*buffer == '\\')
622                         buffer++;
623                 else if (Strchr(break_chars, *buffer))
624                         word_start = buffer + 1;
625                 buffer++;
626         }
627         return word_start;
628 }
629
630 static char *
631 sh_quote(const char *str)
632 {
633         const char *src;
634         int extra_len = 0;
635         char *quoted_str, *dst;
636
637          for (src = str; *src != '\0'; src++)
638                 if (Strchr(break_chars, *src) ||
639                     Strchr(extra_quote_chars, *src))
640                         extra_len++;
641
642         quoted_str = malloc(sizeof(*quoted_str) *
643              (strlen(str) + extra_len + 1));
644         if (quoted_str == NULL)
645                 return NULL;
646
647         dst = quoted_str;
648         for (src = str; *src != '\0'; src++) {
649                 if (Strchr(break_chars, *src) ||
650                     Strchr(extra_quote_chars, *src))
651                         *dst++ = '\\';
652                 *dst++ = *src;
653         }
654         *dst = '\0';
655
656         return quoted_str;
657 }
658
659 static Char *
660 sh_dequote(const Char *str)
661 {
662         Char *dequoted_str, *dst;
663
664         /* save extra space to replace \~ with ./~ */
665         dequoted_str = malloc(sizeof(*dequoted_str) * (Strlen(str) + 1 + 1));
666         if (dequoted_str == NULL)
667                 return NULL;
668
669         dst = dequoted_str;
670
671         /* dequote \~ at start as ./~ */
672         if (*str == '\\' && str[1] == '~') {
673                 str++;
674                 *dst++ = '.';
675                 *dst++ = '/';
676         }
677
678         while (*str) {
679                 if (*str == '\\')
680                         str++;
681                 if (*str)
682                         *dst++ = *str++;
683         }
684         *dst = '\0';
685
686         return dequoted_str;
687 }
688
689 /*
690  * completion function using sh quoting rules; for key binding
691  */
692 /* ARGSUSED */
693 unsigned char
694 _el_fn_sh_complete(EditLine *el, int ch __attribute__((__unused__)))
695 {
696         return (unsigned char)fn_complete(el, NULL, NULL,
697             break_chars, NULL, NULL, 100,
698             NULL, NULL, NULL, NULL,
699             sh_find_word_start, sh_dequote, sh_quote);
700 }