1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
3 /* I/O, string, cleanup, and other random utilities for GDB.
4 Copyright (C) 1986-2013 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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/>. */
25 #include "exceptions.h"
27 extern void initialize_utils (void);
29 /* String utilities. */
31 extern int sevenbit_strings;
33 extern char *savestring (const char *, size_t);
35 extern int strcmp_iw (const char *, const char *);
37 extern int strcmp_iw_ordered (const char *, const char *);
39 extern int streq (const char *, const char *);
41 extern int subset_compare (char *, char *);
43 ULONGEST strtoulst (const char *num, const char **trailer, int base);
45 int compare_positive_ints (const void *ap, const void *bp);
46 int compare_strings (const void *ap, const void *bp);
48 /* This is defined in *-hdep.c, e.g., posix-hdep.c. */
49 extern char *safe_strerror (int);
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. */
56 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
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);
63 /* Parsing utilites. */
65 extern int parse_pid_to_attach (char *args);
67 extern int parse_escape (struct gdbarch *, const char **);
69 char **gdb_buildargv (const char *);
71 /* Cleanup utilities. */
73 extern struct cleanup *make_cleanup_freeargv (char **);
76 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
79 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
82 extern struct cleanup *
83 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
85 struct section_addr_info;
86 extern struct cleanup *(make_cleanup_free_section_addr_info
87 (struct section_addr_info *));
89 extern struct cleanup *make_cleanup_close (int fd);
91 extern struct cleanup *make_cleanup_fclose (FILE *file);
93 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
96 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
98 extern struct cleanup *make_cleanup_restore_integer (int *variable);
99 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
102 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
104 extern struct cleanup *
105 make_cleanup_restore_ui_file (struct ui_file **variable);
107 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
108 extern struct cleanup *make_cleanup_value_free (struct value *);
111 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
113 extern struct cleanup *make_cleanup_restore_current_language (void);
115 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
117 extern void free_current_contents (void *);
119 extern void init_page_info (void);
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);
125 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
127 /* Path utilities. */
129 extern char *gdb_realpath (const char *);
131 extern char *gdb_realpath_keepfile (const char *);
133 extern char *gdb_abspath (const char *);
135 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
138 extern void substitute_path_component (char **stringp, const char *from,
141 char *ldirname (const char *filename);
143 /* GDB output, ui_file utilities. */
147 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
148 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
149 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
151 extern void begin_line (void);
153 extern void wrap_here (char *);
155 extern void reinitialize_more_filter (void);
157 extern int pagination_enabled;
159 /* Global ui_file streams. These are all defined in main.c. */
161 extern struct ui_file *gdb_stdout;
163 extern struct ui_file *gdb_stdin;
164 /* Serious error notifications */
165 extern struct ui_file *gdb_stderr;
166 /* Log/debug/trace messages that should bypass normal stdout/stderr
167 filtering. For moment, always call this stream using
168 *_unfiltered. In the very near future that restriction shall be
169 removed - either call shall be unfiltered. (cagney 1999-06-13). */
170 extern struct ui_file *gdb_stdlog;
171 /* Target output that should bypass normal stdout/stderr filtering.
172 For moment, always call this stream using *_unfiltered. In the
173 very near future that restriction shall be removed - either call
174 shall be unfiltered. (cagney 1999-07-02). */
175 extern struct ui_file *gdb_stdtarg;
176 extern struct ui_file *gdb_stdtargerr;
177 extern struct ui_file *gdb_stdtargin;
179 /* More generic printf like operations. Filtered versions may return
180 non-locally on error. */
182 extern void fputs_filtered (const char *, struct ui_file *);
184 extern void fputs_unfiltered (const char *, struct ui_file *);
186 extern int fputc_filtered (int c, struct ui_file *);
188 extern int fputc_unfiltered (int c, struct ui_file *);
190 extern int putchar_filtered (int c);
192 extern int putchar_unfiltered (int c);
194 extern void puts_filtered (const char *);
196 extern void puts_unfiltered (const char *);
198 extern void puts_filtered_tabular (char *string, int width, int right);
200 extern void puts_debug (char *prefix, char *string, char *suffix);
202 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
204 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
205 ATTRIBUTE_PRINTF (2, 0);
207 extern void fprintf_filtered (struct ui_file *, const char *, ...)
208 ATTRIBUTE_PRINTF (2, 3);
210 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
211 ATTRIBUTE_PRINTF (3, 4);
213 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
215 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
217 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
219 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
220 ATTRIBUTE_PRINTF (2, 0);
222 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
223 ATTRIBUTE_PRINTF (2, 3);
225 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
227 extern void print_spaces (int, struct ui_file *);
229 extern void print_spaces_filtered (int, struct ui_file *);
231 extern char *n_spaces (int);
233 extern void fputstr_filtered (const char *str, int quotr,
234 struct ui_file * stream);
236 extern void fputstr_unfiltered (const char *str, int quotr,
237 struct ui_file * stream);
239 extern void fputstrn_filtered (const char *str, int n, int quotr,
240 struct ui_file * stream);
242 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
243 struct ui_file * stream);
245 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
246 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
248 extern const char *host_address_to_string (const void *addr);
250 /* Convert CORE_ADDR to string in platform-specific manner.
251 This is usually formatted similar to 0x%lx. */
252 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
254 /* Return a string representation in hexadecimal notation of ADDRESS,
255 which is suitable for printing. */
257 extern const char *print_core_address (struct gdbarch *gdbarch,
260 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
261 extern hashval_t core_addr_hash (const void *ap);
262 extern int core_addr_eq (const void *ap, const void *bp);
265 extern char *plongest (LONGEST l);
266 /* %u for ULONGEST */
267 extern char *pulongest (ULONGEST l);
269 extern char *phex (ULONGEST l, int sizeof_l);
270 extern char *phex_nz (ULONGEST l, int sizeof_l);
271 extern char *int_string (LONGEST, int, int, int, int);
273 /* Convert a CORE_ADDR into a HEX string with leading zeros.
274 The output from core_addr_to_string() can be passed direct to
275 string_to_core_addr(). */
276 extern const char *core_addr_to_string (const CORE_ADDR addr);
277 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
278 extern CORE_ADDR string_to_core_addr (const char *my_string);
280 /* Return a string that contains a number formatted as a hex
282 extern char *hex_string (LONGEST);
283 extern char *hex_string_custom (LONGEST, int);
285 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
288 extern void throw_perror_with_name (enum errors errcode, const char *string)
290 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
292 extern void perror_warning_with_name (const char *string);
294 extern void print_sys_errmsg (const char *, int);
296 /* Warnings and error messages. */
298 extern void (*deprecated_error_begin_hook) (void);
300 /* Message to be printed before the warning message, when a warning occurs. */
302 extern char *warning_pre_print;
304 extern void verror (const char *fmt, va_list ap)
305 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
307 extern void error (const char *fmt, ...)
308 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
310 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
312 extern void vfatal (const char *fmt, va_list ap)
313 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
315 extern void fatal (const char *fmt, ...)
316 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
318 extern void internal_verror (const char *file, int line, const char *,
320 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
322 extern void internal_vwarning (const char *file, int line,
323 const char *, va_list ap)
324 ATTRIBUTE_PRINTF (3, 0);
326 extern void internal_warning (const char *file, int line,
327 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
329 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
331 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
333 /* Misc. utilities. */
335 /* Allocation and deallocation functions for the libiberty hash table
336 which use obstacks. */
337 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
338 void dummy_obstack_deallocate (void *object, void *data);
341 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
344 extern int producer_is_gcc_ge_4 (const char *producer);
346 extern int myread (int, char *, int);
348 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
349 power of 2). Round up/down when necessary. Examples of correct
352 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
353 write_memory (addr, value, len);
358 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
359 write_memory (sp, value, len);
361 Note that uses such as:
363 write_memory (addr, value, len);
364 addr += align_up (len, 8);
368 sp -= align_up (len, 8);
369 write_memory (sp, value, len);
371 are typically not correct as they don't ensure that the address (SP
372 or ADDR) is correctly aligned (relying on previous alignment to
373 keep things right). This is also why the methods are called
374 "align_..." instead of "round_..." as the latter reads better with
375 this incorrect coding style. */
377 extern ULONGEST align_up (ULONGEST v, int n);
378 extern ULONGEST align_down (ULONGEST v, int n);
380 /* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
383 extern LONGEST gdb_sign_extend (LONGEST value, int bit);