externs.h

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