1 /* $Header: /p/tcsh/cvsroot/tcsh/tw.init.c,v 3.42 2011/04/17 14:49:30 christos Exp $ */
3 * tw.init.c: Handle lists of things to complete
6 * Copyright (c) 1980, 1991 The Regents of the University of California.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 RCSID("$tcsh: tw.init.c,v 3.42 2011/04/17 14:49:30 christos Exp $")
45 Char **list, /* List of command names */
46 *buff; /* Space holding command names */
47 size_t nlist, /* Number of items */
48 nbuff, /* Current space in name buf */
49 tlist, /* Total space in list */
50 tbuff; /* Total space in name buf */
54 static struct varent *tw_vptr = NULL; /* Current shell variable */
55 static Char **tw_env = NULL; /* Current environment variable */
56 static const Char *tw_word; /* Current word pointer */
57 static struct KeyFuncs *tw_bind = NULL; /* List of the bindings */
59 static struct limits *tw_limit = NULL; /* List of the resource limits */
60 #endif /* HAVENOLIMIT */
61 static int tw_index = 0; /* signal and job index */
62 static DIR *tw_dir_fd = NULL; /* Current directory descriptor */
63 static int tw_cmd_got = 0; /* What we need to do */
64 static stringlist_t tw_cmd = { NULL, NULL, 0, 0, 0, 0 };
65 static stringlist_t tw_item = { NULL, NULL, 0, 0, 0, 0 };
66 #define TW_FL_CMD 0x01
67 #define TW_FL_ALIAS 0x02
68 #define TW_FL_BUILTIN 0x04
69 #define TW_FL_SORT 0x08
70 #define TW_FL_REL 0x10
72 static struct { /* Current element pointer */
73 size_t cur; /* Current element number */
74 Char **pathv; /* Current element in path */
75 DIR *dfd; /* Current directory descriptor */
82 if (tw_dir_fd != NULL) \
83 rewinddir(tw_dir_fd); \
91 disabled_cleanup(&pintr_disabled); \
94 static Char *tw_str_add (stringlist_t *, size_t);
95 static void tw_str_free (stringlist_t *);
96 static int tw_dir_next (struct Strbuf *, DIR *);
97 static void tw_cmd_add (const Char *name);
98 static void tw_cmd_cmd (void);
99 static void tw_cmd_builtin (void);
100 static void tw_cmd_alias (void);
101 static void tw_cmd_sort (void);
102 static void tw_vptr_start (struct varent *);
106 * Add an item to the string list
109 tw_str_add(stringlist_t *sl, size_t len)
113 if (sl->tlist <= sl->nlist) {
115 sl->tlist += TW_INCR;
116 sl->list = xrealloc(sl->list, sl->tlist * sizeof(Char *));
117 disabled_cleanup(&pintr_disabled);
119 if (sl->tbuff <= sl->nbuff + len) {
124 sl->tbuff += TW_INCR + len;
125 sl->buff = xrealloc(sl->buff, sl->tbuff * sizeof(Char));
126 /* Re-thread the new pointer list, if changed */
127 if (ptr != NULL && ptr != sl->buff) {
128 intptr_t offs = sl->buff - ptr;
129 for (i = 0; i < sl->nlist; i++)
132 disabled_cleanup(&pintr_disabled);
134 ptr = sl->list[sl->nlist++] = &sl->buff[sl->nbuff];
144 tw_str_free(stringlist_t *sl)
150 sl->tlist = sl->nlist = 0;
155 sl->tbuff = sl->nbuff = 0;
157 disabled_cleanup(&pintr_disabled);
158 } /* end tw_str_free */
162 tw_dir_next(struct Strbuf *res, DIR *dfd)
169 if ((dirp = readdir(dfd)) != NULL) {
170 Strbuf_append(res, str2short(dirp->d_name));
174 } /* end tw_dir_next */
178 * Add the name to the command list
181 tw_cmd_add(const Char *name)
185 len = Strlen(name) + 2;
186 (void) Strcpy(tw_str_add(&tw_cmd, len), name);
187 } /* end tw_cmd_add */
191 * Free the command list
197 tw_str_free(&tw_cmd);
199 } /* end tw_cmd_free */
202 * Add system commands to the command list
209 Char *dir = NULL, *name;
211 struct varent *v = adrof(STRpath);
212 struct varent *recexec = adrof(STRrecognize_only_executables);
216 if (v == NULL || v->vec == NULL) /* if no path */
219 for (pv = v->vec; *pv; pv++) {
220 if (pv[0][0] != '/') {
221 tw_cmd_got |= TW_FL_REL;
225 if ((dirp = opendir(short2str(*pv))) == NULL)
228 cleanup_push(dirp, opendir_cleanup);
230 dir = Strspl(*pv, STRslash);
231 cleanup_push(dir, xfree);
233 while ((dp = readdir(dirp)) != NULL) {
234 #if defined(_UWIN) || defined(__CYGWIN__)
235 /* Turn foo.{exe,com,bat} into foo since UWIN's readdir returns
236 * the file with the .exe, .com, .bat extension
238 * Same for Cygwin, but only for .exe and .com extension.
240 len = strlen(dp->d_name);
241 if (len > 4 && (strcmp(&dp->d_name[len - 4], ".exe") == 0 ||
243 strcmp(&dp->d_name[len - 4], ".bat") == 0 ||
244 #endif /* !__CYGWIN__ */
245 strcmp(&dp->d_name[len - 4], ".com") == 0))
246 dp->d_name[len - 4] = '\0';
247 #endif /* _UWIN || __CYGWIN__ */
248 /* the call to executable() may make this a bit slow */
249 name = str2short(dp->d_name);
250 if (dp->d_ino == 0 || (recexec && !executable(dir, name, 0)))
253 if (name[0] == '#' || /* emacs temp files */
254 name[0] == '.' || /* .files */
255 name[len - 1] == '~' || /* emacs backups */
256 name[len - 1] == '%') /* textedit backups */
257 continue; /* Ignore! */
262 } /* end tw_cmd_cmd */
266 * Add builtins to the command list
271 const struct biltins *bptr;
273 for (bptr = bfunc; bptr < &bfunc[nbfunc]; bptr++)
275 tw_cmd_add(str2short(bptr->bname));
277 for (bptr = nt_bfunc; bptr < &nt_bfunc[nt_nbfunc]; bptr++)
279 tw_cmd_add(str2short(bptr->bname));
280 #endif /* WINNT_NATIVE*/
281 } /* end tw_cmd_builtin */
285 * Add aliases to the command list
298 if (p->v_parent == 0) /* is it the header? */
301 tw_cmd_add(p->v_name);
309 } while (p->v_right == c);
312 } /* end tw_cmd_alias */
316 * Sort the command list removing duplicate elements
325 qsort(tw_cmd.list, tw_cmd.nlist, sizeof(Char *), fcompare);
327 /* get rid of multiple entries */
328 for (i = 0, fwd = 0; i + 1 < tw_cmd.nlist; i++) {
329 if (Strcmp(tw_cmd.list[i], tw_cmd.list[i + 1]) == 0) /* garbage */
330 fwd++; /* increase the forward ref. count */
332 tw_cmd.list[i - fwd] = tw_cmd.list[i];
334 /* Fix fencepost error -- Theodore Ts'o <tytso@athena.mit.edu> */
336 tw_cmd.list[i - fwd] = tw_cmd.list[i];
338 disabled_cleanup(&pintr_disabled);
339 } /* end tw_cmd_sort */
343 * Get the command list and sort it, if not done yet.
344 * Reset the current pointer to the beginning of the command list
348 tw_cmd_start(DIR *dfd, const Char *pat)
350 static Char *defpath[] = { STRNULL, 0 };
353 if ((tw_cmd_got & TW_FL_CMD) == 0) {
356 tw_cmd_got |= TW_FL_CMD;
358 if ((tw_cmd_got & TW_FL_ALIAS) == 0) {
360 tw_cmd_got &= ~TW_FL_SORT;
361 tw_cmd_got |= TW_FL_ALIAS;
363 if ((tw_cmd_got & TW_FL_BUILTIN) == 0) {
365 tw_cmd_got &= ~TW_FL_SORT;
366 tw_cmd_got |= TW_FL_BUILTIN;
368 if ((tw_cmd_got & TW_FL_SORT) == 0) {
370 tw_cmd_got |= TW_FL_SORT;
373 tw_cmd_state.cur = 0;
374 CLRDIR(tw_cmd_state.dfd)
375 if (tw_cmd_got & TW_FL_REL) {
376 struct varent *vp = adrof(STRpath);
378 tw_cmd_state.pathv = vp->vec;
380 tw_cmd_state.pathv = defpath;
383 tw_cmd_state.pathv = defpath;
388 * Return the next element in the command list or
389 * Look for commands in the relative path components
392 tw_cmd_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
397 if (tw_cmd_state.cur < tw_cmd.nlist) {
399 Strbuf_append(res, tw_cmd.list[tw_cmd_state.cur++]);
404 * We need to process relatives in the path.
406 while ((tw_cmd_state.dfd == NULL ||
407 (res->len = 0, ret = tw_dir_next(res, tw_cmd_state.dfd)) == 0) &&
408 *tw_cmd_state.pathv != NULL) {
410 CLRDIR(tw_cmd_state.dfd)
412 while (*tw_cmd_state.pathv && tw_cmd_state.pathv[0][0] == '/')
413 tw_cmd_state.pathv++;
414 if ((ptr = *tw_cmd_state.pathv) != 0) {
416 Strbuf_append(res, ptr);
419 * We complete directories only on '.' should that
423 if (ptr[0] == '\0' || (ptr[0] == '.' && ptr[1] == '\0')) {
424 tw_cmd_state.dfd = opendir(".");
425 *flags = TW_DIR_OK | TW_EXEC_CHK;
428 Strbuf_append(dir, *tw_cmd_state.pathv);
429 Strbuf_append1(dir, '/');
430 tw_cmd_state.dfd = opendir(short2str(*tw_cmd_state.pathv));
431 *flags = TW_EXEC_CHK;
433 Strbuf_terminate(dir);
434 tw_cmd_state.pathv++;
438 } /* end tw_cmd_next */
442 * Find the first variable in the variable list
445 tw_vptr_start(struct varent *c)
447 tw_vptr = c; /* start at beginning of variable list */
450 while (tw_vptr->v_left)
451 tw_vptr = tw_vptr->v_left;
453 if (tw_vptr->v_parent == 0) { /* is it the header? */
458 return; /* found first one */
459 if (tw_vptr->v_right) {
460 tw_vptr = tw_vptr->v_right;
465 tw_vptr = tw_vptr->v_parent;
466 } while (tw_vptr->v_right == c);
469 } /* end tw_shvar_start */
473 * Return the next shell variable
477 tw_shvar_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
484 if ((p = tw_vptr) == NULL)
485 return 0; /* just in case */
487 Strbuf_append(res, p->v_name); /* we know that this name is here now */
489 /* now find the next one */
491 if (p->v_right) { /* if we can go right */
496 else { /* else go up */
500 } while (p->v_right == c);
502 if (p->v_parent == 0) { /* is it the header? */
507 tw_vptr = p; /* save state for the next call */
511 } /* end tw_shvar_next */
515 * Return the next environment variable
519 tw_envvar_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
525 if (tw_env == NULL || *tw_env == NULL)
527 for (ps = *tw_env; *ps && *ps != '='; ps++)
529 Strbuf_appendn(res, *tw_env, ps - *tw_env);
532 } /* end tw_envvar_next */
536 * Begin the list of the shell and environment variables
540 tw_var_start(DIR *dfd, const Char *pat)
544 tw_vptr_start(&shvhed);
545 tw_env = STR_environ;
546 } /* end tw_var_start */
550 * Begin the list of the shell aliases
554 tw_alias_start(DIR *dfd, const Char *pat)
558 tw_vptr_start(&aliases);
560 } /* tw_alias_start */
563 /* tw_complete_start():
564 * Begin the list of completions
568 tw_complete_start(DIR *dfd, const Char *pat)
572 tw_vptr_start(&completions);
574 } /* end tw_complete_start */
578 * Return the next shell or environment variable
581 tw_var_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
586 ret = tw_shvar_next(res, dir, flags);
587 if (ret == 0 && tw_env)
588 ret = tw_envvar_next(res, dir, flags);
590 } /* end tw_var_next */
593 /* tw_logname_start():
594 * Initialize lognames to the beginning of the list
598 tw_logname_start(DIR *dfd, const Char *pat)
603 (void) setpwent(); /* Open passwd file */
605 } /* end tw_logname_start */
608 /* tw_logname_next():
609 * Return the next entry from the passwd file
613 tw_logname_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
618 * We don't want to get interrupted inside getpwent()
619 * because the yellow pages code is not interruptible,
620 * and if we call endpwent() immediatetely after
621 * (in pintr()) we may be freeing an invalid pointer
631 disabled_cleanup(&pintr_disabled);
639 Strbuf_append(res, str2short(pw->pw_name));
641 } /* end tw_logname_next */
645 * Close the passwd file to finish the logname list
656 } /* end tw_logname_end */
659 /* tw_grpname_start():
660 * Initialize grpnames to the beginning of the list
664 tw_grpname_start(DIR *dfd, const Char *pat)
668 #if !defined(_VMS_POSIX) && !defined(_OSD_POSIX) && !defined(WINNT_NATIVE) && !defined (__ANDROID__)
669 (void) setgrent(); /* Open group file */
670 #endif /* !_VMS_POSIX && !_OSD_POSIX && !WINNT_NATIVE */
671 } /* end tw_grpname_start */
674 /* tw_grpname_next():
675 * Return the next entry from the group file
679 tw_grpname_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
684 * We don't want to get interrupted inside getgrent()
685 * because the yellow pages code is not interruptible,
686 * and if we call endgrent() immediatetely after
687 * (in pintr()) we may be freeing an invalid pointer
692 #if !defined(_VMS_POSIX) && !defined(_OSD_POSIX) && !defined(WINNT_NATIVE) && !defined(__ANDROID__)
694 while ((gr = getgrent()) == NULL && errno == EINTR) {
695 handle_pending_signals();
698 #else /* _VMS_POSIX || _OSD_POSIX || WINNT_NATIVE */
700 #endif /* !_VMS_POSIX && !_OSD_POSIX && !WINNT_NATIVE */
701 disabled_cleanup(&pintr_disabled);
709 Strbuf_append(res, str2short(gr->gr_name));
711 } /* end tw_grpname_next */
715 * Close the group file to finish the groupname list
723 #if !defined(_VMS_POSIX) && !defined(_OSD_POSIX) && !defined(WINNT_NATIVE) && !defined (__ANDROID__)
725 #endif /* !_VMS_POSIX && !_OSD_POSIX && !WINNT_NATIVE */
726 } /* end tw_grpname_end */
729 * Initialize the directory for the file list
733 tw_file_start(DIR *dfd, const Char *pat)
738 if ((vp = adrof(STRcdpath)) != NULL)
740 } /* end tw_file_start */
744 * Return the next file in the directory
747 tw_file_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
749 int ret = tw_dir_next(res, tw_dir_fd);
750 if (ret == 0 && (*flags & TW_DIR_OK) != 0) {
752 while (tw_env && *tw_env)
753 if ((tw_dir_fd = opendir(short2str(*tw_env))) != NULL)
760 Strbuf_append(dir, *tw_env++);
761 Strbuf_append1(dir, '/');
762 Strbuf_terminate(dir);
763 ret = tw_dir_next(res, tw_dir_fd);
767 } /* end tw_file_next */
771 * Clear directory related lists
777 CLRDIR(tw_cmd_state.dfd)
778 } /* end tw_dir_end */
787 tw_str_free(&tw_item);
788 } /* end tw_item_free */
792 * Return the list of items
798 } /* end tw_item_get */
802 * Return a new item for a Strbuf_terminate()'d s
805 tw_item_add(const struct Strbuf *s)
809 p = tw_str_add(&tw_item, s->len + 1);
815 * Find the string if it exists in the item list
819 tw_item_find(Char *str)
823 if (tw_item.list == NULL || str == NULL)
826 for (i = 0; i < tw_item.nlist; i++)
827 if (tw_item.list[i] != NULL && Strcmp(tw_item.list[i], str) == 0)
828 return tw_item.list[i];
830 } /* end tw_item_find */
834 * Initialize a variable list
837 tw_vl_start(DIR *dfd, const Char *pat)
840 if ((tw_vptr = adrof(pat)) != NULL) {
841 tw_env = tw_vptr->vec;
846 } /* end tw_vl_start */
850 * Initialize a word list
853 tw_wl_start(DIR *dfd, const Char *pat)
857 } /* end tw_wl_start */
861 * Return the next word from the word list
865 tw_wl_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
871 if (tw_word == NULL || tw_word[0] == '\0')
874 while (*tw_word && Isspace(*tw_word)) tw_word++;
876 for (p = tw_word; *tw_word && !Isspace(*tw_word); tw_word++)
880 Strbuf_appendn(res, p, tw_word - p);
884 } /* end tw_wl_next */
888 * Begin the list of the shell bindings
892 tw_bind_start(DIR *dfd, const Char *pat)
897 } /* end tw_bind_start */
901 * Begin the list of the shell bindings
905 tw_bind_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
909 if (tw_bind && tw_bind->name) {
912 for (ptr = tw_bind->name; *ptr != '\0'; ptr++)
913 Strbuf_append1(res, *ptr);
918 } /* end tw_bind_next */
922 * Begin the list of the shell limitings
926 tw_limit_start(DIR *dfd, const Char *pat)
932 #endif /* ! HAVENOLIMIT */
933 } /* end tw_limit_start */
937 * Begin the list of the shell limitings
941 tw_limit_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
946 if (tw_limit && tw_limit->limname) {
949 for (ptr = tw_limit->limname; *ptr != '\0'; ptr++)
950 Strbuf_append1(res, *ptr);
954 #endif /* ! HAVENOLIMIT */
956 } /* end tw_limit_next */
960 * Begin the list of the shell sigings
964 tw_sig_start(DIR *dfd, const Char *pat)
969 } /* end tw_sig_start */
973 * Begin the list of the shell sigings
977 tw_sig_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
981 for (;tw_index < nsig; tw_index++) {
984 if (mesg[tw_index].iname == NULL)
987 for (ptr = mesg[tw_index].iname; *ptr != '\0'; ptr++)
988 Strbuf_append1(res, *ptr);
993 } /* end tw_sig_next */
997 * Begin the list of the shell jobings
1001 tw_job_start(DIR *dfd, const Char *pat)
1006 } /* end tw_job_start */
1010 * Begin the list of the shell jobings
1014 tw_job_next(struct Strbuf *res, struct Strbuf *dir, int *flags)
1020 for (;tw_index <= pmaxindex; tw_index++) {
1021 for (j = proclist.p_next; j != NULL; j = j->p_next)
1022 if (j->p_index == tw_index && j->p_procid == j->p_jobid)
1026 Strbuf_append(res, j->p_command);
1031 } /* end tw_job_next */