1 /* pcomplete.h - structure definitions and other stuff for programmable
4 /* Copyright (C) 1999-2009 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash 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 Bash 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 Bash. If not, see <http://www.gnu.org/licenses/>.
22 #if !defined (_PCOMPLETE_H_)
23 # define _PCOMPLETE_H_
28 typedef struct compspec
{
30 unsigned long actions
;
31 unsigned long options
;
42 /* Values for COMPSPEC actions. These are things the shell knows how to
44 #define CA_ALIAS (1<<0)
45 #define CA_ARRAYVAR (1<<1)
46 #define CA_BINDING (1<<2)
47 #define CA_BUILTIN (1<<3)
48 #define CA_COMMAND (1<<4)
49 #define CA_DIRECTORY (1<<5)
50 #define CA_DISABLED (1<<6)
51 #define CA_ENABLED (1<<7)
52 #define CA_EXPORT (1<<8)
53 #define CA_FILE (1<<9)
54 #define CA_FUNCTION (1<<10)
55 #define CA_GROUP (1<<11)
56 #define CA_HELPTOPIC (1<<12)
57 #define CA_HOSTNAME (1<<13)
58 #define CA_JOB (1<<14)
59 #define CA_KEYWORD (1<<15)
60 #define CA_RUNNING (1<<16)
61 #define CA_SERVICE (1<<17)
62 #define CA_SETOPT (1<<18)
63 #define CA_SHOPT (1<<19)
64 #define CA_SIGNAL (1<<20)
65 #define CA_STOPPED (1<<21)
66 #define CA_USER (1<<22)
67 #define CA_VARIABLE (1<<23)
69 /* Values for COMPSPEC options field. */
70 #define COPT_RESERVED (1<<0) /* reserved for other use */
71 #define COPT_DEFAULT (1<<1)
72 #define COPT_FILENAMES (1<<2)
73 #define COPT_DIRNAMES (1<<3)
74 #define COPT_NOQUOTE (1<<4)
75 #define COPT_NOSPACE (1<<5)
76 #define COPT_BASHDEFAULT (1<<6)
77 #define COPT_PLUSDIRS (1<<7)
79 /* List of items is used by the code that implements the programmable
81 typedef struct _list_of_items
{
83 int (*list_getter
) __P((struct _list_of_items
*)); /* function to call to get the list */
87 /* These may or may not be used. */
88 STRINGLIST
*genlist
; /* for handing to the completion code one item at a time */
89 int genindex
; /* index of item last handed to completion code */
93 /* Values for ITEMLIST -> flags */
94 #define LIST_DYNAMIC 0x001
95 #define LIST_DIRTY 0x002
96 #define LIST_INITIALIZED 0x004
97 #define LIST_MUSTSORT 0x008
98 #define LIST_DONTFREE 0x010
99 #define LIST_DONTFREEMEMBERS 0x020
101 #define EMPTYCMD "_EmptycmD_"
102 #define DEFAULTCMD "_DefaultCmD_"
104 extern HASH_TABLE
*prog_completes
;
105 extern int prog_completion_enabled
;
107 /* Not all of these are used yet. */
108 extern ITEMLIST it_aliases
;
109 extern ITEMLIST it_arrayvars
;
110 extern ITEMLIST it_bindings
;
111 extern ITEMLIST it_builtins
;
112 extern ITEMLIST it_commands
;
113 extern ITEMLIST it_directories
;
114 extern ITEMLIST it_disabled
;
115 extern ITEMLIST it_enabled
;
116 extern ITEMLIST it_exports
;
117 extern ITEMLIST it_files
;
118 extern ITEMLIST it_functions
;
119 extern ITEMLIST it_groups
;
120 extern ITEMLIST it_helptopics
;
121 extern ITEMLIST it_hostnames
;
122 extern ITEMLIST it_jobs
;
123 extern ITEMLIST it_keywords
;
124 extern ITEMLIST it_running
;
125 extern ITEMLIST it_services
;
126 extern ITEMLIST it_setopts
;
127 extern ITEMLIST it_shopts
;
128 extern ITEMLIST it_signals
;
129 extern ITEMLIST it_stopped
;
130 extern ITEMLIST it_users
;
131 extern ITEMLIST it_variables
;
133 extern COMPSPEC
*pcomp_curcs
;
134 extern const char *pcomp_curcmd
;
136 /* Functions from pcomplib.c */
137 extern COMPSPEC
*compspec_create
__P((void));
138 extern void compspec_dispose
__P((COMPSPEC
*));
139 extern COMPSPEC
*compspec_copy
__P((COMPSPEC
*));
141 extern void progcomp_create
__P((void));
142 extern void progcomp_flush
__P((void));
143 extern void progcomp_dispose
__P((void));
145 extern int progcomp_size
__P((void));
147 extern int progcomp_insert
__P((char *, COMPSPEC
*));
148 extern int progcomp_remove
__P((char *));
150 extern COMPSPEC
*progcomp_search
__P((const char *));
152 extern void progcomp_walk
__P((hash_wfunc
*));
154 /* Functions from pcomplete.c */
155 extern void set_itemlist_dirty
__P((ITEMLIST
*));
157 extern STRINGLIST
*completions_to_stringlist
__P((char **));
159 extern STRINGLIST
*gen_compspec_completions
__P((COMPSPEC
*, const char *, const char *, int, int, int *));
160 extern char **programmable_completions
__P((const char *, const char *, int, int, int *));
162 extern void pcomp_set_readline_variables
__P((int, int));
163 extern void pcomp_set_compspec_options
__P((COMPSPEC
*, int, int));
164 #endif /* _PCOMPLETE_H_ */