Merge branch 'vendor/TCSH'
[dragonfly.git] / contrib / tcsh-6 / sh.decls.h
1 /* $Header: /p/tcsh/cvsroot/tcsh/sh.decls.h,v 3.62 2011/02/25 23:58:34 christos Exp $ */
2 /*
3  * sh.decls.h    External declarations from sh*.c
4  */
5 /*-
6  * Copyright (c) 1980, 1991 The Regents of the University of California.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
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.
20  *
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
31  * SUCH DAMAGE.
32  */
33 #ifndef _h_sh_decls
34 #define _h_sh_decls
35
36 /*
37  * sh.c
38  */
39 extern  Char             *gethdir       (const Char *);
40 extern  void              dosource      (Char **, struct command *);
41 extern  void              exitstat      (void);
42 extern  void              goodbye       (Char **, struct command *);
43 extern  void              importpath    (Char *);
44 extern  void              initdesc      (void);
45 extern  void              pintr         (void);
46 extern  void              pintr1        (int);
47 extern  void              phup          (void);
48 extern  void              process       (int);
49 extern  void              untty         (void);
50 #ifdef PROF
51 extern  void              done          (int) __attribute__((__noreturn__));
52 #else
53 extern  void              xexit         (int) __attribute__((__noreturn__));
54 #endif
55 extern  int               grabpgrp      (int, pid_t);
56
57 /*
58  * sh.dir.c
59  */
60 extern  void              dinit         (Char *);
61 extern  void              dodirs        (Char **, struct command *);
62 extern  Char             *dcanon        (Char *, Char *);
63 extern  void              dtildepr      (Char *);
64 extern  void              dtilde        (void);
65 extern  void              dochngd       (Char **, struct command *);
66 extern  Char             *dnormalize    (const Char *, int);
67 extern  void              dopushd       (Char **, struct command *);
68 extern  void              dopopd        (Char **, struct command *);
69 extern  void              dfree         (struct directory *);
70 extern  void              dsetstack     (void);
71 extern  const Char       *getstakd      (int);
72 extern  void              recdirs       (Char *, int);
73 extern  void              loaddirs      (Char *);
74
75 /*
76  * sh.dol.c
77  */
78 extern  void              Dfix          (struct command *);
79 extern  Char             *Dfix1         (Char *);
80 extern  void              heredoc       (Char *);
81
82 /*
83  * sh.err.c
84  */
85 extern  void              reset         (void) __attribute__((__noreturn__));
86 extern  void              cleanup_push_internal(void *, void (*fn) (void *)
87 #ifdef CLEANUP_DEBUG
88                                                 , const char *, size_t
89 #define cleanup_push(v, f) cleanup_push_internal(v, f, __FILE__, __LINE__)
90 #else
91 #define cleanup_push(v, f) cleanup_push_internal(v, f)
92 #endif
93 );
94 extern  int               cleanup_reset(void);
95 extern  void              cleanup_ignore(void *);
96 extern  void              cleanup_until(void *);
97 extern  void              cleanup_until_mark(void);
98 extern  size_t            cleanup_push_mark(void);
99 extern  void              cleanup_pop_mark(size_t);
100 extern  void              open_cleanup(void *);
101 extern  void              opendir_cleanup(void *);
102 extern  void              sigint_cleanup(void *);
103 extern  void              sigprocmask_cleanup(void *);
104 extern  void              xfree_indirect(void *);
105 extern  void              errinit       (void);
106 extern  void              seterror      (unsigned int, ...);
107 extern  void              fixerror      (void);
108 extern  void              stderror      (unsigned int, ...)
109     __attribute__((__noreturn__));
110
111 /*
112  * sh.exec.c
113  */
114 extern  void              doexec        (struct command *, int);
115 extern  void              dohash        (Char **, struct command *);
116 extern  void              dounhash      (Char **, struct command *);
117 extern  void              execash       (Char **, struct command *);
118 extern  void              hashstat      (Char **, struct command *);
119 extern  void              xechoit       (Char **);
120 extern  int               executable    (const Char *, const Char *, int);
121 extern  int               tellmewhat    (struct wordent *, Char **);
122 extern  void              dowhere       (Char **, struct command *);
123 extern  int               find_cmd      (Char *, int);
124
125 /*
126  * sh.exp.c
127  */
128 extern  Char             *filetest      (Char *, Char ***, int);
129 extern  tcsh_number_t     expr          (Char ***);
130 extern  tcsh_number_t     exp0          (Char ***, int);
131
132 /*
133  * sh.file.c
134  */
135 #if defined(FILEC) && defined(TIOCSTI)
136 extern  size_t            tenex         (Char *, size_t);
137 #endif
138
139 /*
140  * sh.func.c
141  */
142 extern  void              tsetenv       (const Char *, const Char *);
143 extern  void              Unsetenv      (Char *);
144 extern  void              doalias       (Char **, struct command *);
145 extern  void              dobreak       (Char **, struct command *);
146 extern  void              docontin      (Char **, struct command *);
147 extern  void              doecho        (Char **, struct command *);
148 extern  void              doelse        (Char **, struct command *);
149 extern  void              doend         (Char **, struct command *);
150 extern  void              doeval        (Char **, struct command *);
151 extern  void              doexit        (Char **, struct command *);
152 extern  void              doforeach     (Char **, struct command *);
153 extern  void              doglob        (Char **, struct command *);
154 extern  void              dogoto        (Char **, struct command *);
155 extern  void              doif          (Char **, struct command *);
156 extern  void              dolimit       (Char **, struct command *);
157 extern  void              dologin       (Char **, struct command *);
158 extern  void              dologout      (Char **, struct command *);
159 #ifdef NEWGRP
160 extern  void              donewgrp      (Char **, struct command *);
161 #endif
162 extern  void              donohup       (Char **, struct command *);
163 extern  void              dohup         (Char **, struct command *);
164 extern  void              doonintr      (Char **, struct command *);
165 extern  void              doprintenv    (Char **, struct command *);
166 extern  void              dorepeat      (Char **, struct command *);
167 extern  void              dofiletest    (Char **, struct command *);
168 extern  void              dosetenv      (Char **, struct command *);
169 extern  void              dosuspend     (Char **, struct command *);
170 extern  void              doswbrk       (Char **, struct command *);
171 extern  void              doswitch      (Char **, struct command *);
172 extern  void              doumask       (Char **, struct command *);
173 extern  void              dounlimit     (Char **, struct command *);
174 extern  void              dounsetenv    (Char **, struct command *);
175 extern  void              dowhile       (Char **, struct command *);
176 extern  void              dozip         (Char **, struct command *);
177 extern  void              func          (struct command *,
178                                          const struct biltins *);
179 extern  void              gotolab       (Char *);
180 extern const struct biltins *isbfunc    (struct command *);
181 extern  void              prvars        (void);
182 extern  int               srchx         (Char *);
183 extern  void              unalias       (Char **, struct command *);
184 extern  void              wfree         (void);
185 extern  void              dobuiltins    (Char **, struct command *);
186 extern  void              reexecute     (struct command *);
187
188 /*
189  * sh.glob.c
190  */
191 extern  Char             *globequal     (Char *);
192 extern  Char            **dobackp       (Char *, int);
193 extern  Char             *globone       (Char *, int);
194 extern  int               Gmatch        (const Char *, const Char *);
195 extern  int               Gnmatch       (const Char *, const Char *,
196                                          const Char **);
197 extern  Char            **globall       (Char **, int);
198 extern  Char            **glob_all_or_error(Char **);
199 extern  void              rscan         (Char **, void (*)(Char));
200 extern  int               tglob         (Char **);
201 extern  void              trim          (Char **);
202
203 #if !defined(WINNT_NATIVE) && defined(NLS_CATALOGS)
204 extern  char             *xcatgets      (nl_catd, int, int, const char *);
205 #if defined(HAVE_ICONV) && defined(HAVE_NL_LANGINFO)
206 extern  char             *iconv_catgets (nl_catd, int, int, const char *);
207 #endif
208 #endif
209 extern  void              nlsinit       (void);
210 extern  void              nlsclose      (void);
211 extern  int               t_pmatch      (const Char *, const Char *,
212                                          const Char **, int);
213
214 /*
215  * sh.hist.c
216  */
217 extern  void              dohist        (Char **, struct command *);
218 extern  struct Hist      *enthist       (int, struct wordent *, int, int, int);
219 extern  void              savehist      (struct wordent *, int);
220 extern  char             *fmthist       (int, ptr_t);
221 extern  void              rechist       (Char *, int);
222 extern  void              loadhist      (Char *, int);
223 extern  void              displayHistStats(const char *);
224
225 /*
226  * sh.init.c
227  */
228 extern  void              mesginit      (void);
229
230 /*
231  * sh.lex.c
232  */
233 extern  void              addla         (Char *);
234 extern  void              bseek         (struct Ain *);
235 extern  void              btell         (struct Ain *);
236 extern  void              btoeof        (void);
237 extern  void              copylex       (struct wordent *, struct wordent *);
238 extern  Char             *domod         (Char *, Char);
239 extern  void              freelex       (struct wordent *);
240 extern  int               lex           (struct wordent *);
241 extern  void              lex_cleanup   (void *);
242 extern  void              prlex         (struct wordent *);
243 extern  eChar             readc         (int);
244 extern  void              settell       (void);
245 extern  void              unreadc       (Char);
246
247
248 /*
249  * sh.misc.c
250  */
251 extern  int               any           (const char *, Char);
252 extern  Char            **blkcpy        (Char **, Char **);
253 extern  void              blkfree       (Char **);
254 extern  void              blk_cleanup   (void *);
255 extern  void              blk_indirect_cleanup(void *);
256 extern  int               blklen        (Char **);
257 extern  void              blkpr         (Char *const *);
258 extern  Char             *blkexpand     (Char *const *);
259 extern  Char            **blkspl        (Char **, Char **);
260 extern  void              closem        (void);
261 #ifndef CLOSE_ON_EXEC
262 extern  void              closech       (void);
263 #endif /* !CLOSE_ON_EXEC */
264 extern  Char            **copyblk       (Char **);
265 extern  int               dcopy         (int, int);
266 extern  int               dmove         (int, int);
267 extern  void              donefds       (void);
268 extern  Char              lastchr       (Char *);
269 extern  void              lshift        (Char **, int);
270 extern  int               number        (Char *);
271 extern  int               prefix        (const Char *, const Char *);
272 extern  Char            **saveblk       (Char **);
273 extern  void              setzero       (void *, size_t);
274 extern  Char             *strip         (Char *);
275 extern  Char             *quote         (Char *);
276 extern  const Char       *quote_meta    (struct Strbuf *, const Char *);
277 #ifndef SHORT_STRINGS
278 extern  char             *strnsave      (const char *, size_t);
279 #endif
280 extern  char             *strsave       (const char *);
281 extern  void              udvar         (Char *) __attribute__((__noreturn__));
282 #ifndef POSIX
283 extern  char             *strstr        (const char *, const char *);
284 #endif /* !POSIX */
285 extern  char             *strspl        (const char *, const char *);
286 extern  char             *strend        (const char *);
287 extern  char             *areadlink     (const char *);
288 extern  void              xclose        (int);
289 extern  void              xclosedir     (DIR *);
290 extern  int               xcreat        (const char *, mode_t);
291 extern  struct group     *xgetgrgid     (gid_t);
292 extern  struct passwd    *xgetpwnam     (const char *);
293 extern  struct passwd    *xgetpwuid     (uid_t);
294 extern  int               xopen         (const char *, int, ...);
295 extern  ssize_t           xread         (int, void *, size_t);
296 extern  int               xtcsetattr    (int, int, const struct termios *);
297 extern  ssize_t           xwrite        (int, const void *, size_t);
298
299 /*
300  * sh.parse.c
301  */
302 extern  void              alias         (struct wordent *);
303 extern  void              freesyn       (struct command *);
304 extern struct command    *syntax        (const struct wordent *,
305                                          const struct wordent *, int);
306 extern  void              syntax_cleanup(void *);
307
308 /*
309  * sh.print.c
310  */
311 extern  void              drainoline    (void);
312 extern  void              flush         (void);
313 #ifdef BSDTIMES
314 extern  void              pcsecs        (unsigned long);
315 #else /* !BSDTIMES */
316 # ifdef POSIX
317 extern  void              pcsecs        (clock_t);
318 # else /* !POSIX */
319 extern  void              pcsecs        (time_t);
320 # endif /* !POSIX */
321 #endif /* BSDTIMES */
322 #ifdef BSDLIMIT
323 extern  void              psecs         (unsigned long);
324 #endif /* BSDLIMIT */
325 extern  int               putpure       (int);
326 extern  int               putraw        (int);
327 extern  void              xputchar      (int);
328 #ifdef WIDE_STRINGS
329 extern  void              putwraw       (Char);
330 extern  void              xputwchar     (Char);
331 #else
332 # define putwraw(C) putraw(C)
333 # define xputwchar(C) xputchar(C)
334 #endif
335 extern  void              output_raw_restore(void *);
336
337
338 /*
339  * sh.proc.c
340  */
341 extern  void              dobg          (Char **, struct command *);
342 extern  void              dobg1         (Char **, struct command *);
343 extern  void              dofg          (Char **, struct command *);
344 extern  void              dofg1         (Char **, struct command *);
345 extern  void              dojobs        (Char **, struct command *);
346 extern  void              dokill        (Char **, struct command *);
347 extern  void              donotify      (Char **, struct command *);
348 extern  void              dostop        (Char **, struct command *);
349 extern  void              dowait        (Char **, struct command *);
350 extern  void              palloc        (pid_t, struct command *);
351 extern  void              panystop      (int);
352 extern  void              pchild        (void);
353 extern  void              pendjob       (void);
354 extern  pid_t             pfork         (struct command *, int);
355 extern  void              pgetty        (int, pid_t);
356 extern  void              pjwait        (struct process *);
357 extern  void              pnote         (void);
358 extern  void              psavejob      (void);
359 extern  void              psavejob_cleanup(void *);
360 extern  int               pstart        (struct process *, int);
361 extern  void              pwait         (void);
362 extern  struct process   *pfind         (Char *);
363
364 /*
365  * sh.sem.c
366  */
367 extern  void              execute       (struct command *, volatile int, int *,
368                                          int *, int);
369 extern  void              mypipe        (int *);
370
371 /*
372  * sh.set.c
373  */
374 extern  struct varent    *adrof1        (const Char *, struct varent *);
375 extern  void              doset         (Char **, struct command *);
376 extern  void              dolet         (Char **, struct command *);
377 extern  Char             *putn          (tcsh_number_t);
378 extern  tcsh_number_t     getn          (const Char *);
379 extern  Char             *value1        (Char *, struct varent *);
380 extern  void              setcopy       (const Char *, const Char *, int);
381 extern  void              setv          (const Char *, Char *, int);
382 extern  void              set1          (const Char *, Char **,
383                                          struct varent *, int);
384 extern  void              setq          (const Char *, Char **,
385                                          struct varent *, int);
386 extern  void              unset         (Char **, struct command *);
387 extern  void              unset1        (Char *[], struct varent *);
388 extern  void              unsetv        (Char *);
389 extern  void              setNS         (const Char *);
390 extern  void              shift         (Char **, struct command *);
391 extern  void              plist         (struct varent *, int);
392 extern  Char             *unparse       (struct command *);
393 #if defined(DSPMBYTE)
394 extern  void              update_dspmbyte_vars  (void);
395 extern  void              autoset_dspmbyte      (const Char *);
396 #endif
397 #if defined(AUTOSET_KANJI)
398 extern  void              autoset_kanji (void);
399 #endif
400 extern  void              exportpath    (Char **);
401
402 /*
403  * sh.time.c
404  */
405 extern  void              donice        (Char **, struct command *);
406 extern  void              dotime        (Char **, struct command *);
407 #ifdef BSDTIMES
408 extern  void              prusage       (struct sysrusage *,
409                                          struct sysrusage *, 
410                                          timeval_t *, timeval_t *);
411 extern  void              ruadd         (struct sysrusage *,
412                                          struct sysrusage *);
413 #else /* BSDTIMES */
414 # ifdef _SEQUENT_
415 extern  void              prusage       (struct process_stats *,
416                                          struct process_stats *, 
417                                          timeval_t *, timeval_t *);
418 extern  void              ruadd         (struct process_stats *,
419                                          struct process_stats *);
420 # else /* !_SEQUENT_ */
421 #  ifdef POSIX
422 extern  void              prusage       (struct tms *, struct tms *, 
423                                          clock_t, clock_t);
424 #  else /* !POSIX */
425 extern  void              prusage       (struct tms *, struct tms *, 
426                                          time_t, time_t);
427 #  endif /* !POSIX */
428 # endif /* !_SEQUENT_ */
429 #endif /* BSDTIMES */
430 extern  void              settimes      (void);
431 #if defined(BSDTIMES) || defined(_SEQUENT_)
432 extern  void              tvsub         (struct timeval *, 
433                                          struct timeval *, 
434                                          struct timeval *);
435 #endif /* BSDTIMES || _SEQUENT_ */
436
437 /*
438  * tw.parse.c
439  */
440 extern   void             copyn                 (Char *, const Char *, size_t);
441 extern   void             catn                  (Char *, const Char *, int);
442
443 #endif /* _h_sh_decls */