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/>. */
26 extern void initialize_utils (void);
28 /* String utilities. */
30 extern int sevenbit_strings;
32 extern char *savestring (const char *, size_t);
34 extern int strcmp_iw (const char *, const char *);
36 extern int strcmp_iw_ordered (const char *, const char *);
38 extern int streq (const char *, const char *);
40 extern int subset_compare (char *, char *);
42 ULONGEST strtoulst (const char *num, const char **trailer, int base);
44 int compare_positive_ints (const void *ap, const void *bp);
45 int compare_strings (const void *ap, const void *bp);
47 /* This is defined in *-hdep.c, e.g., posix-hdep.c. */
48 extern char *safe_strerror (int);
50 /* A wrapper for bfd_errmsg to produce a more helpful error message
51 in the case of bfd_error_file_ambiguously recognized.
52 MATCHING, if non-NULL, is the corresponding argument to
53 bfd_check_format_matches, and will be freed. */
55 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
57 /* Reset the prompt_for_continue clock. */
58 void reset_prompt_for_continue_wait_time (void);
59 /* Return the time spent in prompt_for_continue. */
60 struct timeval get_prompt_for_continue_wait_time (void);
62 /* Parsing utilites. */
64 extern int parse_pid_to_attach (char *args);
66 extern int parse_escape (struct gdbarch *, char **);
68 char **gdb_buildargv (const char *);
70 /* Cleanup utilities. */
72 extern struct cleanup *make_cleanup_freeargv (char **);
75 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
78 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
81 extern struct cleanup *
82 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
84 struct section_addr_info;
85 extern struct cleanup *(make_cleanup_free_section_addr_info
86 (struct section_addr_info *));
88 extern struct cleanup *make_cleanup_close (int fd);
90 extern struct cleanup *make_cleanup_fclose (FILE *file);
92 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
95 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
97 extern struct cleanup *make_cleanup_restore_integer (int *variable);
98 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
101 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
103 extern struct cleanup *
104 make_cleanup_restore_ui_file (struct ui_file **variable);
106 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
107 extern struct cleanup *make_cleanup_value_free (struct value *);
110 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
112 extern struct cleanup *make_cleanup_restore_current_language (void);
114 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
116 extern void free_current_contents (void *);
118 extern void init_page_info (void);
120 extern struct cleanup *make_cleanup_restore_page_info (void);
121 extern struct cleanup *
122 set_batch_flag_and_make_cleanup_restore_page_info (void);
124 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
126 /* Path utilities. */
128 extern char *gdb_realpath (const char *);
130 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
133 extern void substitute_path_component (char **stringp, const char *from,
136 char *ldirname (const char *filename);
138 /* GDB output, ui_file utilities. */
142 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
143 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
144 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
146 extern void begin_line (void);
148 extern void wrap_here (char *);
150 extern void reinitialize_more_filter (void);
152 /* Global ui_file streams. These are all defined in main.c. */
154 extern struct ui_file *gdb_stdout;
156 extern struct ui_file *gdb_stdin;
157 /* Serious error notifications */
158 extern struct ui_file *gdb_stderr;
159 /* Log/debug/trace messages that should bypass normal stdout/stderr
160 filtering. For moment, always call this stream using
161 *_unfiltered. In the very near future that restriction shall be
162 removed - either call shall be unfiltered. (cagney 1999-06-13). */
163 extern struct ui_file *gdb_stdlog;
164 /* Target output that should bypass normal stdout/stderr filtering.
165 For moment, always call this stream using *_unfiltered. In the
166 very near future that restriction shall be removed - either call
167 shall be unfiltered. (cagney 1999-07-02). */
168 extern struct ui_file *gdb_stdtarg;
169 extern struct ui_file *gdb_stdtargerr;
170 extern struct ui_file *gdb_stdtargin;
172 /* More generic printf like operations. Filtered versions may return
173 non-locally on error. */
175 extern void fputs_filtered (const char *, struct ui_file *);
177 extern void fputs_unfiltered (const char *, struct ui_file *);
179 extern int fputc_filtered (int c, struct ui_file *);
181 extern int fputc_unfiltered (int c, struct ui_file *);
183 extern int putchar_filtered (int c);
185 extern int putchar_unfiltered (int c);
187 extern void puts_filtered (const char *);
189 extern void puts_unfiltered (const char *);
191 extern void puts_filtered_tabular (char *string, int width, int right);
193 extern void puts_debug (char *prefix, char *string, char *suffix);
195 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
197 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
198 ATTRIBUTE_PRINTF (2, 0);
200 extern void fprintf_filtered (struct ui_file *, const char *, ...)
201 ATTRIBUTE_PRINTF (2, 3);
203 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
204 ATTRIBUTE_PRINTF (3, 4);
206 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
208 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
210 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
212 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
213 ATTRIBUTE_PRINTF (2, 0);
215 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
216 ATTRIBUTE_PRINTF (2, 3);
218 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
220 extern void print_spaces (int, struct ui_file *);
222 extern void print_spaces_filtered (int, struct ui_file *);
224 extern char *n_spaces (int);
226 extern void fputstr_filtered (const char *str, int quotr,
227 struct ui_file * stream);
229 extern void fputstr_unfiltered (const char *str, int quotr,
230 struct ui_file * stream);
232 extern void fputstrn_filtered (const char *str, int n, int quotr,
233 struct ui_file * stream);
235 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
236 struct ui_file * stream);
238 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
239 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
241 extern const char *host_address_to_string (const void *addr);
243 /* Convert CORE_ADDR to string in platform-specific manner.
244 This is usually formatted similar to 0x%lx. */
245 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
247 /* Return a string representation in hexadecimal notation of ADDRESS,
248 which is suitable for printing. */
250 extern const char *print_core_address (struct gdbarch *gdbarch,
253 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
254 extern hashval_t core_addr_hash (const void *ap);
255 extern int core_addr_eq (const void *ap, const void *bp);
258 extern char *plongest (LONGEST l);
259 /* %u for ULONGEST */
260 extern char *pulongest (ULONGEST l);
262 extern char *phex (ULONGEST l, int sizeof_l);
263 extern char *phex_nz (ULONGEST l, int sizeof_l);
264 extern char *int_string (LONGEST, int, int, int, int);
266 /* Convert a CORE_ADDR into a HEX string with leading zeros.
267 The output from core_addr_to_string() can be passed direct to
268 string_to_core_addr(). */
269 extern const char *core_addr_to_string (const CORE_ADDR addr);
270 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
271 extern CORE_ADDR string_to_core_addr (const char *my_string);
273 /* Return a string that contains a number formatted as a hex
275 extern char *hex_string (LONGEST);
276 extern char *hex_string_custom (LONGEST, int);
278 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
281 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
283 extern void print_sys_errmsg (const char *, int);
285 /* Warnings and error messages. */
287 extern void (*deprecated_error_begin_hook) (void);
289 /* Message to be printed before the error message, when an error occurs. */
291 extern char *error_pre_print;
293 /* Message to be printed before the error message, when an error occurs. */
295 extern char *quit_pre_print;
297 /* Message to be printed before the warning message, when a warning occurs. */
299 extern char *warning_pre_print;
301 extern void verror (const char *fmt, va_list ap)
302 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
304 extern void error (const char *fmt, ...)
305 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
307 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
309 extern void vfatal (const char *fmt, va_list ap)
310 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
312 extern void fatal (const char *fmt, ...)
313 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
315 extern void internal_verror (const char *file, int line, const char *,
317 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
319 extern void internal_vwarning (const char *file, int line,
320 const char *, va_list ap)
321 ATTRIBUTE_PRINTF (3, 0);
323 extern void internal_warning (const char *file, int line,
324 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
326 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
328 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
330 /* Misc. utilities. */
332 /* Allocation and deallocation functions for the libiberty hash table
333 which use obstacks. */
334 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
335 void dummy_obstack_deallocate (void *object, void *data);
338 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
341 extern int producer_is_gcc_ge_4 (const char *producer);
343 extern int myread (int, char *, int);
345 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
346 power of 2). Round up/down when necessary. Examples of correct
349 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
350 write_memory (addr, value, len);
355 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
356 write_memory (sp, value, len);
358 Note that uses such as:
360 write_memory (addr, value, len);
361 addr += align_up (len, 8);
365 sp -= align_up (len, 8);
366 write_memory (sp, value, len);
368 are typically not correct as they don't ensure that the address (SP
369 or ADDR) is correctly aligned (relying on previous alignment to
370 keep things right). This is also why the methods are called
371 "align_..." instead of "round_..." as the latter reads better with
372 this incorrect coding style. */
374 extern ULONGEST align_up (ULONGEST v, int n);
375 extern ULONGEST align_down (ULONGEST v, int n);