[deliverable/binutils-gdb.git] / gdb / utils.h

/* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
		      for now.  */
/* I/O, string, cleanup, and other random utilities for GDB.
   Copyright (C) 1986-2013 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef UTILS_H
#define UTILS_H

#include "cleanups.h"
#include "exceptions.h"

extern void initialize_utils (void);

/* String utilities.  */

extern int sevenbit_strings;

extern char *savestring (const char *, size_t);

extern int strcmp_iw (const char *, const char *);

extern int strcmp_iw_ordered (const char *, const char *);

extern int streq (const char *, const char *);

extern int subset_compare (char *, char *);

ULONGEST strtoulst (const char *num, const char **trailer, int base);

int compare_positive_ints (const void *ap, const void *bp);
int compare_strings (const void *ap, const void *bp);

/* This is defined in *-hdep.c, e.g., posix-hdep.c.  */
extern char *safe_strerror (int);

/* A wrapper for bfd_errmsg to produce a more helpful error message
   in the case of bfd_error_file_ambiguously recognized.
   MATCHING, if non-NULL, is the corresponding argument to
   bfd_check_format_matches, and will be freed.  */

extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);

/* Reset the prompt_for_continue clock.  */
void reset_prompt_for_continue_wait_time (void);
/* Return the time spent in prompt_for_continue.  */
struct timeval get_prompt_for_continue_wait_time (void);
\f
/* Parsing utilites.  */

extern int parse_pid_to_attach (char *args);

extern int parse_escape (struct gdbarch *, char **);

char **gdb_buildargv (const char *);
\f
/* Cleanup utilities.  */

extern struct cleanup *make_cleanup_freeargv (char **);

struct dyn_string;
extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);

struct ui_file;
extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);

struct ui_out;
extern struct cleanup *
  make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);

struct section_addr_info;
extern struct cleanup *(make_cleanup_free_section_addr_info 
                        (struct section_addr_info *));

extern struct cleanup *make_cleanup_close (int fd);

extern struct cleanup *make_cleanup_fclose (FILE *file);

extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);

struct obstack;
extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);

extern struct cleanup *make_cleanup_restore_integer (int *variable);
extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);

struct target_ops;
extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);

extern struct cleanup *
  make_cleanup_restore_ui_file (struct ui_file **variable);

extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
extern struct cleanup *make_cleanup_value_free (struct value *);

struct so_list;
extern struct cleanup *make_cleanup_free_so (struct so_list *so);

extern struct cleanup *make_cleanup_restore_current_language (void);

extern struct cleanup *make_cleanup_htab_delete (htab_t htab);

extern void free_current_contents (void *);

extern void init_page_info (void);

extern struct cleanup *make_cleanup_restore_page_info (void);
extern struct cleanup *
  set_batch_flag_and_make_cleanup_restore_page_info (void);

extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
\f
/* Path utilities.  */

extern char *gdb_realpath (const char *);

extern int gdb_filename_fnmatch (const char *pattern, const char *string,
				 int flags);

extern void substitute_path_component (char **stringp, const char *from,
				       const char *to);

char *ldirname (const char *filename);
\f
/* GDB output, ui_file utilities.  */

struct ui_file;

extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);

extern void begin_line (void);

extern void wrap_here (char *);

extern void reinitialize_more_filter (void);

extern int pagination_enabled;

/* Global ui_file streams.  These are all defined in main.c.  */
/* Normal results */
extern struct ui_file *gdb_stdout;
/* Input stream */
extern struct ui_file *gdb_stdin;
/* Serious error notifications */
extern struct ui_file *gdb_stderr;
/* Log/debug/trace messages that should bypass normal stdout/stderr
   filtering.  For moment, always call this stream using
   *_unfiltered.  In the very near future that restriction shall be
   removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
extern struct ui_file *gdb_stdlog;
/* Target output that should bypass normal stdout/stderr filtering.
   For moment, always call this stream using *_unfiltered.  In the
   very near future that restriction shall be removed - either call
   shall be unfiltered.  (cagney 1999-07-02).  */
extern struct ui_file *gdb_stdtarg;
extern struct ui_file *gdb_stdtargerr;
extern struct ui_file *gdb_stdtargin;

/* More generic printf like operations.  Filtered versions may return
   non-locally on error.  */

extern void fputs_filtered (const char *, struct ui_file *);

extern void fputs_unfiltered (const char *, struct ui_file *);

extern int fputc_filtered (int c, struct ui_file *);

extern int fputc_unfiltered (int c, struct ui_file *);

extern int putchar_filtered (int c);

extern int putchar_unfiltered (int c);

extern void puts_filtered (const char *);

extern void puts_unfiltered (const char *);

extern void puts_filtered_tabular (char *string, int width, int right);

extern void puts_debug (char *prefix, char *string, char *suffix);

extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);

extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
  ATTRIBUTE_PRINTF (2, 0);

extern void fprintf_filtered (struct ui_file *, const char *, ...)
  ATTRIBUTE_PRINTF (2, 3);

extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
  ATTRIBUTE_PRINTF (3, 4);

extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);

extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);

extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);

extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
  ATTRIBUTE_PRINTF (2, 0);

extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
  ATTRIBUTE_PRINTF (2, 3);

extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);

extern void print_spaces (int, struct ui_file *);

extern void print_spaces_filtered (int, struct ui_file *);

extern char *n_spaces (int);

extern void fputstr_filtered (const char *str, int quotr,
			      struct ui_file * stream);

extern void fputstr_unfiltered (const char *str, int quotr,
				struct ui_file * stream);

extern void fputstrn_filtered (const char *str, int n, int quotr,
			       struct ui_file * stream);

extern void fputstrn_unfiltered (const char *str, int n, int quotr,
				 struct ui_file * stream);

/* Display the host ADDR on STREAM formatted as ``0x%x''.  */
extern void gdb_print_host_address (const void *addr, struct ui_file *stream);

extern const char *host_address_to_string (const void *addr);

/* Convert CORE_ADDR to string in platform-specific manner.
   This is usually formatted similar to 0x%lx.  */
extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);

/* Return a string representation in hexadecimal notation of ADDRESS,
   which is suitable for printing.  */

extern const char *print_core_address (struct gdbarch *gdbarch,
				       CORE_ADDR address);

/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
extern hashval_t core_addr_hash (const void *ap);
extern int core_addr_eq (const void *ap, const void *bp);

/* %d for LONGEST */
extern char *plongest (LONGEST l);
/* %u for ULONGEST */
extern char *pulongest (ULONGEST l);

extern char *phex (ULONGEST l, int sizeof_l);
extern char *phex_nz (ULONGEST l, int sizeof_l);
extern char *int_string (LONGEST, int, int, int, int);

/* Convert a CORE_ADDR into a HEX string with leading zeros.
   The output from core_addr_to_string() can be passed direct to
   string_to_core_addr().  */
extern const char *core_addr_to_string (const CORE_ADDR addr);
extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
extern CORE_ADDR string_to_core_addr (const char *my_string);

/* Return a string that contains a number formatted as a hex
   string.  */
extern char *hex_string (LONGEST);
extern char *hex_string_custom (LONGEST, int);

extern void fprintf_symbol_filtered (struct ui_file *, const char *,
				     enum language, int);

extern void throw_perror_with_name (enum errors errcode, const char *string)
  ATTRIBUTE_NORETURN;
extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;

extern void print_sys_errmsg (const char *, int);
\f
/* Warnings and error messages.  */

extern void (*deprecated_error_begin_hook) (void);

/* Message to be printed before the warning message, when a warning occurs.  */

extern char *warning_pre_print;

extern void verror (const char *fmt, va_list ap)
     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);

extern void error (const char *fmt, ...)
     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);

extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;

extern void vfatal (const char *fmt, va_list ap)
     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);

extern void fatal (const char *fmt, ...)
     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);

extern void internal_verror (const char *file, int line, const char *,
			     va_list ap)
     ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);

extern void internal_vwarning (const char *file, int line,
			       const char *, va_list ap)
     ATTRIBUTE_PRINTF (3, 0);

extern void internal_warning (const char *file, int line,
			      const char *, ...) ATTRIBUTE_PRINTF (3, 4);

extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);

extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
\f
/* Misc. utilities.  */

/* Allocation and deallocation functions for the libiberty hash table
   which use obstacks.  */
void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
void dummy_obstack_deallocate (void *object, void *data);

#ifdef HAVE_WAITPID
extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
#endif

extern int producer_is_gcc_ge_4 (const char *producer);

extern int myread (int, char *, int);

/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
   power of 2).  Round up/down when necessary.  Examples of correct
   use include:

   addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
   write_memory (addr, value, len);
   addr += len;

   and:

   sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
   write_memory (sp, value, len);

   Note that uses such as:

   write_memory (addr, value, len);
   addr += align_up (len, 8);

   and:

   sp -= align_up (len, 8);
   write_memory (sp, value, len);

   are typically not correct as they don't ensure that the address (SP
   or ADDR) is correctly aligned (relying on previous alignment to
   keep things right).  This is also why the methods are called
   "align_..." instead of "round_..." as the latter reads better with
   this incorrect coding style.  */

extern ULONGEST align_up (ULONGEST v, int n);
extern ULONGEST align_down (ULONGEST v, int n);

/* Sign extend VALUE.  BIT is the (1-based) index of the bit in VALUE
   to sign-extend.  */

extern LONGEST gdb_sign_extend (LONGEST value, int bit);

#endif /* UTILS_H */
Commit	Line	Data
48faced0 DE	1	/* INDENT-OFF / / ATTRIBUTE_PRINTF confuses indent, avoid running it
	2	for now. */
	3	/* I/O, string, cleanup, and other random utilities for GDB.
8acc9f48	4	Copyright (C) 1986-2013 Free Software Foundation, Inc.
48faced0 DE	5
	6	This file is part of GDB.
	7
	8	This program 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	This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
	20
	21	#ifndef UTILS_H
	22	#define UTILS_H
	23
	24	#include "cleanups.h"
af880d85	25	#include "exceptions.h"
48faced0 DE	26
	27	extern void initialize_utils (void);
	28
	29	/* String utilities. */
	30
	31	extern int sevenbit_strings;
	32
	33	extern char savestring (const char , size_t);
	34
	35	extern int strcmp_iw (const char , const char );
	36
	37	extern int strcmp_iw_ordered (const char , const char );
	38
	39	extern int streq (const char , const char );
	40
	41	extern int subset_compare (char , char );
	42
	43	ULONGEST strtoulst (const char num, const char *trailer, int base);
	44
	45	int compare_positive_ints (const void ap, const void bp);
	46	int compare_strings (const void ap, const void bp);
	47
	48	/* This is defined in -hdep.c, e.g., posix-hdep.c. /
	49	extern char *safe_strerror (int);
	50
	51	/* A wrapper for bfd_errmsg to produce a more helpful error message
	52	in the case of bfd_error_file_ambiguously recognized.
	53	MATCHING, if non-NULL, is the corresponding argument to
	54	bfd_check_format_matches, and will be freed. */
	55
	56	extern const char gdb_bfd_errmsg (bfd_error_type error_tag, char *matching);
bd712aed DE	57
	58	/* Reset the prompt_for_continue clock. */
	59	void reset_prompt_for_continue_wait_time (void);
	60	/* Return the time spent in prompt_for_continue. */
	61	struct timeval get_prompt_for_continue_wait_time (void);
48faced0 DE	62	\f
	63	/* Parsing utilites. */
	64
	65	extern int parse_pid_to_attach (char *args);
	66
	67	extern int parse_escape (struct gdbarch , char *);
	68
	69	char *gdb_buildargv (const char );
	70	\f
	71	/* Cleanup utilities. */
	72
	73	extern struct cleanup make_cleanup_freeargv (char *);
	74
	75	struct dyn_string;
	76	extern struct cleanup make_cleanup_dyn_string_delete (struct dyn_string );
	77
	78	struct ui_file;
	79	extern struct cleanup make_cleanup_ui_file_delete (struct ui_file );
	80
	81	struct ui_out;
	82	extern struct cleanup *
	83	make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
	84
	85	struct section_addr_info;
	86	extern struct cleanup *(make_cleanup_free_section_addr_info
	87	(struct section_addr_info *));
	88
	89	extern struct cleanup *make_cleanup_close (int fd);
	90
	91	extern struct cleanup make_cleanup_fclose (FILE file);
	92
	93	extern struct cleanup make_cleanup_bfd_unref (bfd abfd);
	94
	95	struct obstack;
	96	extern struct cleanup make_cleanup_obstack_free (struct obstack obstack);
	97
	98	extern struct cleanup make_cleanup_restore_integer (int variable);
	99	extern struct cleanup make_cleanup_restore_uinteger (unsigned int variable);
	100
	101	struct target_ops;
	102	extern struct cleanup make_cleanup_unpush_target (struct target_ops ops);
	103
	104	extern struct cleanup *
	105	make_cleanup_restore_ui_file (struct ui_file **variable);
	106
	107	extern struct cleanup make_cleanup_value_free_to_mark (struct value );
	108	extern struct cleanup make_cleanup_value_free (struct value );
	109
	110	struct so_list;
	111	extern struct cleanup make_cleanup_free_so (struct so_list so);
	112
5b12a61c JK	113	extern struct cleanup *make_cleanup_restore_current_language (void);
5b12a61c JK	114
48faced0 DE	115	extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
	116
	117	extern void free_current_contents (void *);
	118
48faced0 DE	119	extern void init_page_info (void);
	120
	121	extern struct cleanup *make_cleanup_restore_page_info (void);
	122	extern struct cleanup *
	123	set_batch_flag_and_make_cleanup_restore_page_info (void);
	124
	125	extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
	126	\f
	127	/* Path utilities. */
	128
	129	extern char gdb_realpath (const char );
	130
48faced0 DE	131	extern int gdb_filename_fnmatch (const char pattern, const char string,
	132	int flags);
	133
	134	extern void substitute_path_component (char *stringp, const char from,
	135	const char *to);
	136
	137	char ldirname (const char filename);
	138	\f
	139	/* GDB output, ui_file utilities. */
	140
	141	struct ui_file;
	142
48faced0 DE	143	extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
	144	extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
	145	extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
	146
	147	extern void begin_line (void);
	148
	149	extern void wrap_here (char *);
	150
	151	extern void reinitialize_more_filter (void);
	152
74da6f00 PA	153	extern int pagination_enabled;
74da6f00 PA	154
48faced0 DE	155	/* Global ui_file streams. These are all defined in main.c. */
	156	/* Normal results */
	157	extern struct ui_file *gdb_stdout;
	158	/* Input stream */
	159	extern struct ui_file *gdb_stdin;
	160	/* Serious error notifications */
	161	extern struct ui_file *gdb_stderr;
	162	/* Log/debug/trace messages that should bypass normal stdout/stderr
	163	filtering. For moment, always call this stream using
	164	*_unfiltered. In the very near future that restriction shall be
	165	removed - either call shall be unfiltered. (cagney 1999-06-13). */
	166	extern struct ui_file *gdb_stdlog;
	167	/* Target output that should bypass normal stdout/stderr filtering.
	168	For moment, always call this stream using *_unfiltered. In the
	169	very near future that restriction shall be removed - either call
	170	shall be unfiltered. (cagney 1999-07-02). */
	171	extern struct ui_file *gdb_stdtarg;
	172	extern struct ui_file *gdb_stdtargerr;
	173	extern struct ui_file *gdb_stdtargin;
	174
	175	/* More generic printf like operations. Filtered versions may return
	176	non-locally on error. */
	177
	178	extern void fputs_filtered (const char , struct ui_file );
	179
	180	extern void fputs_unfiltered (const char , struct ui_file );
	181
	182	extern int fputc_filtered (int c, struct ui_file *);
	183
	184	extern int fputc_unfiltered (int c, struct ui_file *);
	185
	186	extern int putchar_filtered (int c);
	187
	188	extern int putchar_unfiltered (int c);
	189
	190	extern void puts_filtered (const char *);
	191
	192	extern void puts_unfiltered (const char *);
	193
	194	extern void puts_filtered_tabular (char *string, int width, int right);
	195
	196	extern void puts_debug (char prefix, char string, char *suffix);
	197
	198	extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
	199
	200	extern void vfprintf_filtered (struct ui_file , const char , va_list)
	201	ATTRIBUTE_PRINTF (2, 0);
	202
	203	extern void fprintf_filtered (struct ui_file , const char , ...)
	204	ATTRIBUTE_PRINTF (2, 3);
	205
	206	extern void fprintfi_filtered (int, struct ui_file , const char , ...)
	207	ATTRIBUTE_PRINTF (3, 4);
	208
	209	extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
	210
	211	extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
	212
	213	extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
	214
	215	extern void vfprintf_unfiltered (struct ui_file , const char , va_list)
	216	ATTRIBUTE_PRINTF (2, 0);
	217
	218	extern void fprintf_unfiltered (struct ui_file , const char , ...)
219	ATTRIBUTE_PRINTF (2, 3);
220
221	extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
222
223	extern void print_spaces (int, struct ui_file *);
224
225	extern void print_spaces_filtered (int, struct ui_file *);
226
227	extern char *n_spaces (int);
228
229	extern void fputstr_filtered (const char *str, int quotr,
230	struct ui_file * stream);
231
232	extern void fputstr_unfiltered (const char *str, int quotr,
233	struct ui_file * stream);
234
235	extern void fputstrn_filtered (const char *str, int n, int quotr,
236	struct ui_file * stream);
237
238	extern void fputstrn_unfiltered (const char *str, int n, int quotr,
239	struct ui_file * stream);
240
241	/* Display the host ADDR on STREAM formatted as ``0x%x''. */
242	extern void gdb_print_host_address (const void addr, struct ui_file stream);
243
244	extern const char host_address_to_string (const void addr);
245
246	/* Convert CORE_ADDR to string in platform-specific manner.
247	This is usually formatted similar to 0x%lx. */
248	extern const char paddress (struct gdbarch gdbarch, CORE_ADDR addr);
249
250	/* Return a string representation in hexadecimal notation of ADDRESS,
251	which is suitable for printing. */
252
253	extern const char print_core_address (struct gdbarch gdbarch,
254	CORE_ADDR address);
255
256	/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
257	extern hashval_t core_addr_hash (const void *ap);
258	extern int core_addr_eq (const void ap, const void bp);
259
260	/* %d for LONGEST */
261	extern char *plongest (LONGEST l);
262	/* %u for ULONGEST */
263	extern char *pulongest (ULONGEST l);
264
265	extern char *phex (ULONGEST l, int sizeof_l);
266	extern char *phex_nz (ULONGEST l, int sizeof_l);
267	extern char *int_string (LONGEST, int, int, int, int);
268
269	/* Convert a CORE_ADDR into a HEX string with leading zeros.
270	The output from core_addr_to_string() can be passed direct to
271	string_to_core_addr(). */
272	extern const char *core_addr_to_string (const CORE_ADDR addr);
273	extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
274	extern CORE_ADDR string_to_core_addr (const char *my_string);
275
276	/* Return a string that contains a number formatted as a hex
277	string. */
278	extern char *hex_string (LONGEST);
279	extern char *hex_string_custom (LONGEST, int);
280
281	extern void fprintf_symbol_filtered (struct ui_file , const char ,
282	enum language, int);
283
598d3636 JK	284	extern void throw_perror_with_name (enum errors errcode, const char *string)
598d3636 JK	285	ATTRIBUTE_NORETURN;
48faced0 DE	286	extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
	287
	288	extern void print_sys_errmsg (const char *, int);
	289	\f
	290	/* Warnings and error messages. */
	291
	292	extern void (*deprecated_error_begin_hook) (void);
	293
48faced0 DE	294	/* Message to be printed before the warning message, when a warning occurs. */
	295
	296	extern char *warning_pre_print;
	297
	298	extern void verror (const char *fmt, va_list ap)
	299	ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
	300
	301	extern void error (const char *fmt, ...)
	302	ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
	303
	304	extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
	305
	306	extern void vfatal (const char *fmt, va_list ap)
	307	ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
	308
	309	extern void fatal (const char *fmt, ...)
	310	ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
	311
	312	extern void internal_verror (const char file, int line, const char ,
	313	va_list ap)
	314	ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
	315
	316	extern void internal_vwarning (const char *file, int line,
	317	const char *, va_list ap)
	318	ATTRIBUTE_PRINTF (3, 0);
	319
	320	extern void internal_warning (const char *file, int line,
	321	const char *, ...) ATTRIBUTE_PRINTF (3, 4);
	322
	323	extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
	324
	325	extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
	326	\f
	327	/* Misc. utilities. */
	328
	329	/* Allocation and deallocation functions for the libiberty hash table
	330	which use obstacks. */
	331	void hashtab_obstack_allocate (void data, size_t size, size_t count);
	332	void dummy_obstack_deallocate (void object, void data);
	333
	334	#ifdef HAVE_WAITPID
	335	extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
	336	#endif
	337
	338	extern int producer_is_gcc_ge_4 (const char *producer);
	339
48faced0 DE	340	extern int myread (int, char *, int);
	341
	342	/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
	343	power of 2). Round up/down when necessary. Examples of correct
	344	use include:
	345
	346	addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
	347	write_memory (addr, value, len);
	348	addr += len;
	349
	350	and:
	351
	352	sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
	353	write_memory (sp, value, len);
	354
	355	Note that uses such as:
	356
	357	write_memory (addr, value, len);
	358	addr += align_up (len, 8);
	359
	360	and:
	361
	362	sp -= align_up (len, 8);
	363	write_memory (sp, value, len);
	364
	365	are typically not correct as they don't ensure that the address (SP
	366	or ADDR) is correctly aligned (relying on previous alignment to
	367	keep things right). This is also why the methods are called
	368	"align_..." instead of "round_..." as the latter reads better with
	369	this incorrect coding style. */
	370
	371	extern ULONGEST align_up (ULONGEST v, int n);
	372	extern ULONGEST align_down (ULONGEST v, int n);
	373
5bd1ef56 TT	374	/* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
	375	to sign-extend. */
	376
	377	extern LONGEST gdb_sign_extend (LONGEST value, int bit);
	378
48faced0	379	#endif /* UTILS_H */