externs.h

   1 /* externs.h -- extern function declarations which do not appear in their
   2    own header file. */
   3
   4 /* Copyright (C) 1993-2009 Free Software Foundation, Inc.
   5
   6    This file is part of GNU Bash, the Bourne Again SHell.
   7
   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.
  12
  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.
  17
  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/>.
  20 */
  21
  22 /* Make sure that this is included *after* config.h! */
  23
  24 #if !defined (_EXTERNS_H_)
  25 #  define _EXTERNS_H_
  26
  27 #include "stdc.h"
  28
  29 /* Functions from expr.c. */
  30 extern intmax_t evalexp __P((char *, int *));
  31
  32 /* Functions from print_cmd.c. */
  33 #define FUNC_MULTILINE  0x01
  34 #define FUNC_EXTERNAL   0x02
  35
  36 extern char *make_command_string __P((COMMAND *));
  37 extern char *named_function_string __P((char *, COMMAND *, int));
  38
  39 extern void print_command __P((COMMAND *));
  40 extern void print_simple_command __P((SIMPLE_COM *));
  41 extern void print_word_list __P((WORD_LIST *, char *));
  42
  43 /* debugger support */
  44 extern void print_for_command_head __P((FOR_COM *));
  45 #if defined (SELECT_COMMAND)
  46 extern void print_select_command_head __P((SELECT_COM *));
  47 #endif
  48 extern void print_case_command_head __P((CASE_COM *));
  49 #if defined (DPAREN_ARITHMETIC)
  50 extern void print_arith_command __P((WORD_LIST *));
  51 #endif
  52 #if defined (COND_COMMAND)
  53 extern void print_cond_command __P((COND_COM *));
  54 #endif
  55
  56 /* set -x support */
  57 extern void xtrace_init __P((void));
  58 #ifdef NEED_XTRACE_SET_DECL
  59 extern void xtrace_set __P((int, FILE *));
  60 #endif
  61 extern void xtrace_fdchk __P((int));
  62 extern void xtrace_reset __P((void));
  63 extern char *indirection_level_string __P((void));
  64 extern void xtrace_print_assignment __P((char *, char *, int, int));
  65 extern void xtrace_print_word_list __P((WORD_LIST *, int));
  66 extern void xtrace_print_for_command_head __P((FOR_COM *));
  67 #if defined (SELECT_COMMAND)
  68 extern void xtrace_print_select_command_head __P((SELECT_COM *));
  69 #endif
  70 extern void xtrace_print_case_command_head __P((CASE_COM *));
  71 #if defined (DPAREN_ARITHMETIC)
  72 extern void xtrace_print_arith_cmd __P((WORD_LIST *));
  73 #endif
  74 #if defined (COND_COMMAND)
  75 extern void xtrace_print_cond_term __P((int, int, WORD_DESC *, char *, char *));
  76 #endif
  77
  78 /* Functions from shell.c. */
  79 extern void exit_shell __P((int)) __attribute__((__noreturn__));
  80 extern void sh_exit __P((int)) __attribute__((__noreturn__));
  81 extern void disable_priv_mode __P((void));
  82 extern void unbind_args __P((void));
  83
  84 #if defined (RESTRICTED_SHELL)
  85 extern int shell_is_restricted __P((char *));
  86 extern int maybe_make_restricted __P((char *));
  87 #endif
  88
  89 extern void unset_bash_input __P((int));
  90 extern void get_current_user_info __P((void));
  91
  92 /* Functions from eval.c. */
  93 extern int reader_loop __P((void));
  94 extern int parse_command __P((void));
  95 extern int read_command __P((void));
  96
  97 /* Functions from braces.c. */
  98 #if defined (BRACE_EXPANSION)
  99 extern char **brace_expand __P((char *));
 100 #endif
 101
 102 /* Miscellaneous functions from parse.y */
 103 extern int yyparse __P((void));
 104 extern int return_EOF __P((void));
 105 extern char *xparse_dolparen __P((char *, char *, int *, int));
 106 extern void reset_parser __P((void));
 107 extern WORD_LIST *parse_string_to_word_list __P((char *, int, const char *));
 108
 109 extern void free_pushed_string_input __P((void));
 110
 111 extern char *decode_prompt_string __P((char *));
 112
 113 extern int get_current_prompt_level __P((void));
 114 extern void set_current_prompt_level __P((int));
 115
 116 #if defined (HISTORY)
 117 extern char *history_delimiting_chars __P((void));
 118 #endif
 119
 120 /* Declarations for functions defined in locale.c */
 121 extern void set_default_locale __P((void));
 122 extern void set_default_locale_vars __P((void));
 123 extern int set_locale_var __P((char *, char *));
 124 extern int set_lang __P((char *, char *));
 125 extern void set_default_lang __P((void));
 126 extern char *get_locale_var __P((char *));
 127 extern char *localetrans __P((char *, int, int *));
 128 extern char *mk_msgstr __P((char *, int *));
 129 extern char *localeexpand __P((char *, int, int, int, int *));
 130
 131 /* Declarations for functions defined in list.c. */
 132 extern void list_walk __P((GENERIC_LIST *, sh_glist_func_t *));
 133 extern void wlist_walk __P((WORD_LIST *, sh_icpfunc_t *));
 134 extern GENERIC_LIST *list_reverse ();
 135 extern int list_length ();
 136 extern GENERIC_LIST *list_append ();
 137 extern GENERIC_LIST *list_remove ();
 138
 139 /* Declarations for functions defined in stringlib.c */
 140 extern int find_string_in_alist __P((char *, STRING_INT_ALIST *, int));
 141 extern char *find_token_in_alist __P((int, STRING_INT_ALIST *, int));
 142 extern int find_index_in_alist __P((char *, STRING_INT_ALIST *, int));
 143
 144 extern char *substring __P((const char *, int, int));
 145 extern char *strsub __P((char *, char *, char *, int));
 146 extern char *strcreplace __P((char *, int, char *, int));
 147 extern void strip_leading __P((char *));
 148 extern void strip_trailing __P((char *, int, int));
 149 extern void xbcopy __P((char *, char *, int));
 150
 151 /* Functions from version.c. */
 152 extern char *shell_version_string __P((void));
 153 extern void show_shell_version __P((int));
 154
 155 /* Functions from the bash library, lib/sh/libsh.a.  These should really
 156    go into a separate include file. */
 157
 158 /* declarations for functions defined in lib/sh/casemod.c */
 159 extern char *sh_modcase __P((const char *, char *, int));
 160
 161 /* Defines for flags argument to sh_modcase.  These need to agree with what's
 162    in lib/sh/casemode.c */
 163 #define CASE_LOWER      0x0001
 164 #define CASE_UPPER      0x0002
 165 #define CASE_CAPITALIZE 0x0004
 166 #define CASE_UNCAP      0x0008
 167 #define CASE_TOGGLE     0x0010
 168 #define CASE_TOGGLEALL  0x0020
 169 #define CASE_UPFIRST    0x0040
 170 #define CASE_LOWFIRST   0x0080
 171
 172 #define CASE_USEWORDS   0x1000
 173
 174 /* declarations for functions defined in lib/sh/clktck.c */
 175 extern long get_clk_tck __P((void));
 176
 177 /* declarations for functions defined in lib/sh/clock.c */
 178 extern void clock_t_to_secs ();
 179 extern void print_clock_t ();
 180
 181 /* Declarations for functions defined in lib/sh/fdprintf.c */
 182 extern void fdprintf __P((int, const char *, ...))  __attribute__((__format__ (printf, 2, 3)));
 183
 184 /* Declarations for functions defined in lib/sh/fmtulong.c */
 185 #define FL_PREFIX     0x01    /* add 0x, 0X, or 0 prefix as appropriate */
 186 #define FL_ADDBASE    0x02    /* add base# prefix to converted value */
 187 #define FL_HEXUPPER   0x04    /* use uppercase when converting to hex */
 188 #define FL_UNSIGNED   0x08    /* don't add any sign */
 189
 190 extern char *fmtulong __P((unsigned long int, int, char *, size_t, int));
 191
 192 /* Declarations for functions defined in lib/sh/fmtulong.c */
 193 #if defined (HAVE_LONG_LONG)
 194 extern char *fmtullong __P((unsigned long long int, int, char *, size_t, int));
 195 #endif
 196
 197 /* Declarations for functions defined in lib/sh/fmtumax.c */
 198 extern char *fmtumax __P((uintmax_t, int, char *, size_t, int));
 199
 200 /* Declarations for functions defined in lib/sh/fnxform.c */
 201 extern char *fnx_fromfs __P((char *, size_t));
 202 extern char *fnx_tofs __P((char *, size_t));
 203
 204 /* Declarations for functions defined in lib/sh/fpurge.c */
 205
 206 #if defined NEED_FPURGE_DECL
 207 #if !HAVE_DECL_FPURGE
 208
 209 #if HAVE_FPURGE
 210 #  define fpurge _bash_fpurge
 211 #endif
 212 extern int fpurge __P((FILE *stream));
 213
 214 #endif /* HAVE_DECL_FPURGE */
 215 #endif /* NEED_FPURGE_DECL */
 216
 217 /* Declarations for functions defined in lib/sh/getcwd.c */
 218 #if !defined (HAVE_GETCWD)
 219 extern char *getcwd __P((char *, size_t));
 220 #endif
 221
 222 /* Declarations for functions defined in lib/sh/input_avail.c */
 223 extern int input_avail __P((int));
 224
 225 /* Declarations for functions defined in lib/sh/itos.c */
 226 extern char *inttostr __P((intmax_t, char *, size_t));
 227 extern char *itos __P((intmax_t));
 228 extern char *uinttostr __P((uintmax_t, char *, size_t));
 229 extern char *uitos __P((uintmax_t));
 230
 231 /* declarations for functions defined in lib/sh/makepath.c */
 232 #define MP_DOTILDE      0x01
 233 #define MP_DOCWD        0x02
 234 #define MP_RMDOT        0x04
 235 #define MP_IGNDOT       0x08
 236
 237 extern char *sh_makepath __P((const char *, const char *, int));
 238
 239 /* declarations for functions defined in lib/sh/mbscasecmp.c */
 240 #if !defined (HAVE_MBSCASECMP)
 241 extern char *mbscasecmp __P((const char *, const char *));
 242 #endif
 243
 244 /* declarations for functions defined in lib/sh/mbschr.c */
 245 #if !defined (HAVE_MBSCHR)
 246 extern char *mbschr __P((const char *, int));
 247 #endif
 248
 249 /* declarations for functions defined in lib/sh/mbscmp.c */
 250 #if !defined (HAVE_MBSCMP)
 251 extern char *mbscmp __P((const char *, const char *));
 252 #endif
 253
 254 /* declarations for functions defined in lib/sh/netconn.c */
 255 extern int isnetconn __P((int));
 256
 257 /* declarations for functions defined in lib/sh/netopen.c */
 258 extern int netopen __P((char *));
 259
 260 /* Declarations for  functions defined in lib/sh/oslib.c */
 261
 262 #if !defined (HAVE_DUP2) || defined (DUP2_BROKEN)
 263 extern int dup2 __P((int, int));
 264 #endif
 265
 266 #if !defined (HAVE_GETDTABLESIZE)
 267 extern int getdtablesize __P((void));
 268 #endif /* !HAVE_GETDTABLESIZE */
 269
 270 #if !defined (HAVE_GETHOSTNAME)
 271 extern int gethostname __P((char *, int));
 272 #endif /* !HAVE_GETHOSTNAME */
 273
 274 extern int getmaxgroups __P((void));
 275 extern long getmaxchild __P((void));
 276
 277 /* declarations for functions defined in lib/sh/pathcanon.c */
 278 #define PATH_CHECKDOTDOT        0x0001
 279 #define PATH_CHECKEXISTS        0x0002
 280 #define PATH_HARDPATH           0x0004
 281 #define PATH_NOALLOC            0x0008
 282
 283 extern char *sh_canonpath __P((char *, int));
 284
 285 /* declarations for functions defined in lib/sh/pathphys.c */
 286 extern char *sh_physpath __P((char *, int));
 287 extern char *sh_realpath __P((const char *, char *));
 288
 289 /* declarations for functions defined in lib/sh/setlinebuf.c */
 290 #ifdef NEED_SH_SETLINEBUF_DECL
 291 extern int sh_setlinebuf __P((FILE *));
 292 #endif
 293
 294 /* declarations for functions defined in lib/sh/shaccess.c */
 295 extern int sh_eaccess __P((char *, int));
 296
 297 /* declarations for functions defined in lib/sh/shmatch.c */
 298 extern int sh_regmatch __P((const char *, const char *, int));
 299
 300 /* defines for flags argument to sh_regmatch. */
 301 #define SHMAT_SUBEXP            0x001   /* save subexpressions in SH_REMATCH */
 302 #define SHMAT_PWARN             0x002   /* print a warning message on invalid regexp */
 303
 304 /* declarations for functions defined in lib/sh/shquote.c */
 305 extern char *sh_single_quote __P((char *));
 306 extern char *sh_double_quote __P((char *));
 307 extern char *sh_mkdoublequoted __P((const char *, int, int));
 308 extern char *sh_un_double_quote __P((char *));
 309 extern char *sh_backslash_quote __P((char *));
 310 extern char *sh_backslash_quote_for_double_quotes __P((char *));
 311 extern int sh_contains_shell_metas __P((char *));
 312
 313 /* declarations for functions defined in lib/sh/spell.c */
 314 extern int spname __P((char *, char *));
 315 extern char *dirspell __P((char *));
 316
 317 /* declarations for functions defined in lib/sh/strcasecmp.c */
 318 #if !defined (HAVE_STRCASECMP)
 319 extern int strncasecmp __P((const char *, const char *, int));
 320 extern int strcasecmp __P((const char *, const char *));
 321 #endif /* HAVE_STRCASECMP */
 322
 323 /* declarations for functions defined in lib/sh/strcasestr.c */
 324 #if ! HAVE_STRCASESTR
 325 extern char *strcasestr __P((const char *, const char *));
 326 #endif
 327
 328 /* declarations for functions defined in lib/sh/strerror.c */
 329 #if !defined (HAVE_STRERROR) && !defined (strerror)
 330 extern char *strerror __P((int));
 331 #endif
 332
 333 /* declarations for functions defined in lib/sh/strftime.c */
 334 #if !defined (HAVE_STRFTIME) && defined (NEED_STRFTIME_DECL)
 335 extern size_t strftime __P((char *, size_t, const char *, const struct tm *));
 336 #endif
 337
 338 /* declarations for functions and structures defined in lib/sh/stringlist.c */
 339
 340 /* This is a general-purpose argv-style array struct. */
 341 typedef struct _list_of_strings {
 342   char **list;
 343   int list_size;
 344   int list_len;
 345 } STRINGLIST;
 346
 347 typedef int sh_strlist_map_func_t __P((char *));
 348
 349 extern STRINGLIST *strlist_create __P((int));
 350 extern STRINGLIST *strlist_resize __P((STRINGLIST *, int));
 351 extern void strlist_flush __P((STRINGLIST *));
 352 extern void strlist_dispose __P((STRINGLIST *));
 353 extern int strlist_remove __P((STRINGLIST *, char *));
 354 extern STRINGLIST *strlist_copy __P((STRINGLIST *));
 355 extern STRINGLIST *strlist_merge __P((STRINGLIST *, STRINGLIST *));
 356 extern STRINGLIST *strlist_append __P((STRINGLIST *, STRINGLIST *));
 357 extern STRINGLIST *strlist_prefix_suffix __P((STRINGLIST *, char *, char *));
 358 extern void strlist_print __P((STRINGLIST *, char *));
 359 extern void strlist_walk __P((STRINGLIST *, sh_strlist_map_func_t *));
 360 extern void strlist_sort __P((STRINGLIST *));
 361
 362 /* declarations for functions defined in lib/sh/stringvec.c */
 363
 364 extern char **strvec_create __P((int));
 365 extern char **strvec_resize __P((char **, int));
 366 extern void strvec_flush __P((char **));
 367 extern void strvec_dispose __P((char **));
 368 extern int strvec_remove __P((char **, char *));
 369 extern int strvec_len __P((char **));
 370 extern int strvec_search __P((char **, char *));
 371 extern char **strvec_copy __P((char **));
 372 extern int strvec_strcmp __P((char **, char **));
 373 extern void strvec_sort __P((char **));
 374
 375 extern char **strvec_from_word_list __P((WORD_LIST *, int, int, int *));
 376 extern WORD_LIST *strvec_to_word_list __P((char **, int, int));
 377
 378 /* declarations for functions defined in lib/sh/strnlen.c */
 379 #if !defined (HAVE_STRNLEN)
 380 extern size_t strnlen __P((const char *, size_t));
 381 #endif
 382
 383 /* declarations for functions defined in lib/sh/strpbrk.c */
 384 #if !defined (HAVE_STRPBRK)
 385 extern char *strpbrk __P((const char *, const char *));
 386 #endif
 387
 388 /* declarations for functions defined in lib/sh/strtod.c */
 389 #if !defined (HAVE_STRTOD)
 390 extern double strtod __P((const char *, char **));
 391 #endif
 392
 393 /* declarations for functions defined in lib/sh/strtol.c */
 394 #if !HAVE_DECL_STRTOL
 395 extern long strtol __P((const char *, char **, int));
 396 #endif
 397
 398 /* declarations for functions defined in lib/sh/strtoll.c */
 399 #if defined (HAVE_LONG_LONG) && !HAVE_DECL_STRTOLL
 400 extern long long strtoll __P((const char *, char **, int));
 401 #endif
 402
 403 /* declarations for functions defined in lib/sh/strtoul.c */
 404 #if !HAVE_DECL_STRTOUL
 405 extern unsigned long strtoul __P((const char *, char **, int));
 406 #endif
 407
 408 /* declarations for functions defined in lib/sh/strtoull.c */
 409 #if defined (HAVE_LONG_LONG) && !HAVE_DECL_STRTOULL
 410 extern unsigned long long strtoull __P((const char *, char **, int));
 411 #endif
 412
 413 /* declarations for functions defined in lib/sh/strimax.c */
 414 #if !HAVE_DECL_STRTOIMAX
 415 extern intmax_t strtoimax __P((const char *, char **, int));
 416 #endif
 417
 418 /* declarations for functions defined in lib/sh/strumax.c */
 419 #if !HAVE_DECL_STRTOUMAX
 420 extern uintmax_t strtoumax __P((const char *, char **, int));
 421 #endif
 422
 423 /* declarations for functions defined in lib/sh/strtrans.c */
 424 extern char *ansicstr __P((char *, int, int, int *, int *));
 425 extern char *ansic_quote __P((char *, int, int *));
 426 extern int ansic_shouldquote __P((const char *));
 427 extern char *ansiexpand __P((char *, int, int, int *));
 428
 429 /* declarations for functions defined in lib/sh/timeval.c.  No prototypes
 430    so we don't have to count on having a definition of struct timeval in
 431    scope when this file is included. */
 432 extern void timeval_to_secs ();
 433 extern void print_timeval ();
 434
 435 /* declarations for functions defined in lib/sh/tmpfile.c */
 436 #define MT_USETMPDIR            0x0001
 437 #define MT_READWRITE            0x0002
 438 #define MT_USERANDOM            0x0004
 439
 440 extern char *sh_mktmpname __P((char *, int));
 441 extern int sh_mktmpfd __P((char *, int, char **));
 442 /* extern FILE *sh_mktmpfp __P((char *, int, char **)); */
 443
 444 /* declarations for functions defined in lib/sh/uconvert.c */
 445 extern int uconvert __P((char *, long *, long *));
 446
 447 /* declarations for functions defined in lib/sh/ufuncs.c */
 448 extern unsigned int falarm __P((unsigned int, unsigned int));
 449 extern unsigned int fsleep __P((unsigned int, unsigned int));
 450
 451 /* declarations for functions defined in lib/sh/winsize.c */
 452 extern void get_new_window_size __P((int, int *, int *));
 453
 454 /* declarations for functions defined in lib/sh/zcatfd.c */
 455 extern int zcatfd __P((int, int, char *));
 456
 457 /* declarations for functions defined in lib/sh/zgetline.c */
 458 extern ssize_t zgetline __P((int, char **, size_t *, int));
 459
 460 /* declarations for functions defined in lib/sh/zmapfd.c */
 461 extern int zmapfd __P((int, char **, char *));
 462
 463 /* declarations for functions defined in lib/sh/zread.c */
 464 extern ssize_t zread __P((int, char *, size_t));
 465 extern ssize_t zreadretry __P((int, char *, size_t));
 466 extern ssize_t zreadintr __P((int, char *, size_t));
 467 extern ssize_t zreadc __P((int, char *));
 468 extern ssize_t zreadcintr __P((int, char *));
 469 extern void zreset __P((void));
 470 extern void zsyncfd __P((int));
 471
 472 /* declarations for functions defined in lib/sh/zwrite.c */
 473 extern int zwrite __P((int, char *, size_t));
 474
 475 #endif /* _EXTERNS_H_ */