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-2014 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"
26 #include "print-utils.h"
28 extern void initialize_utils (void);
30 /* String utilities. */
32 extern int sevenbit_strings
;
34 extern char *savestring (const char *, size_t);
36 extern int strcmp_iw (const char *, const char *);
38 extern int strcmp_iw_ordered (const char *, const char *);
40 extern int streq (const char *, const char *);
42 extern int subset_compare (char *, char *);
44 ULONGEST
strtoulst (const char *num
, const char **trailer
, int base
);
46 int compare_positive_ints (const void *ap
, const void *bp
);
47 int compare_strings (const void *ap
, const void *bp
);
49 /* This is defined in *-hdep.c, e.g., posix-hdep.c. */
50 extern char *safe_strerror (int);
52 /* A wrapper for bfd_errmsg to produce a more helpful error message
53 in the case of bfd_error_file_ambiguously recognized.
54 MATCHING, if non-NULL, is the corresponding argument to
55 bfd_check_format_matches, and will be freed. */
57 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
);
59 /* Reset the prompt_for_continue clock. */
60 void reset_prompt_for_continue_wait_time (void);
61 /* Return the time spent in prompt_for_continue. */
62 struct timeval
get_prompt_for_continue_wait_time (void);
64 /* Parsing utilites. */
66 extern int parse_pid_to_attach (char *args
);
68 extern int parse_escape (struct gdbarch
*, const char **);
70 char **gdb_buildargv (const char *);
72 /* Cleanup utilities. */
74 extern struct cleanup
*make_cleanup_freeargv (char **);
77 extern struct cleanup
*make_cleanup_dyn_string_delete (struct dyn_string
*);
80 extern struct cleanup
*make_cleanup_ui_file_delete (struct ui_file
*);
83 extern struct cleanup
*
84 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
);
86 struct section_addr_info
;
87 extern struct cleanup
*(make_cleanup_free_section_addr_info
88 (struct section_addr_info
*));
90 extern struct cleanup
*make_cleanup_close (int fd
);
92 extern struct cleanup
*make_cleanup_fclose (FILE *file
);
94 extern struct cleanup
*make_cleanup_bfd_unref (bfd
*abfd
);
97 extern struct cleanup
*make_cleanup_obstack_free (struct obstack
*obstack
);
99 extern struct cleanup
*make_cleanup_restore_integer (int *variable
);
100 extern struct cleanup
*make_cleanup_restore_uinteger (unsigned int *variable
);
103 extern struct cleanup
*make_cleanup_unpush_target (struct target_ops
*ops
);
105 extern struct cleanup
*
106 make_cleanup_restore_ui_file (struct ui_file
**variable
);
108 extern struct cleanup
*make_cleanup_value_free_to_mark (struct value
*);
109 extern struct cleanup
*make_cleanup_value_free (struct value
*);
112 extern struct cleanup
*make_cleanup_free_so (struct so_list
*so
);
114 extern struct cleanup
*make_cleanup_restore_current_language (void);
116 extern struct cleanup
*make_cleanup_htab_delete (htab_t htab
);
118 extern void free_current_contents (void *);
120 extern void init_page_info (void);
122 extern struct cleanup
*make_cleanup_restore_page_info (void);
123 extern struct cleanup
*
124 set_batch_flag_and_make_cleanup_restore_page_info (void);
126 extern struct cleanup
*make_bpstat_clear_actions_cleanup (void);
128 /* Path utilities. */
130 extern char *gdb_realpath (const char *);
132 extern char *gdb_realpath_keepfile (const char *);
134 extern char *gdb_abspath (const char *);
136 extern int gdb_filename_fnmatch (const char *pattern
, const char *string
,
139 extern void substitute_path_component (char **stringp
, const char *from
,
142 char *ldirname (const char *filename
);
144 /* GDB output, ui_file utilities. */
148 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
149 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
150 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
152 extern void begin_line (void);
154 extern void wrap_here (char *);
156 extern void reinitialize_more_filter (void);
158 extern int pagination_enabled
;
160 /* Global ui_file streams. These are all defined in main.c. */
162 extern struct ui_file
*gdb_stdout
;
164 extern struct ui_file
*gdb_stdin
;
165 /* Serious error notifications */
166 extern struct ui_file
*gdb_stderr
;
167 /* Log/debug/trace messages that should bypass normal stdout/stderr
168 filtering. For moment, always call this stream using
169 *_unfiltered. In the very near future that restriction shall be
170 removed - either call shall be unfiltered. (cagney 1999-06-13). */
171 extern struct ui_file
*gdb_stdlog
;
172 /* Target output that should bypass normal stdout/stderr filtering.
173 For moment, always call this stream using *_unfiltered. In the
174 very near future that restriction shall be removed - either call
175 shall be unfiltered. (cagney 1999-07-02). */
176 extern struct ui_file
*gdb_stdtarg
;
177 extern struct ui_file
*gdb_stdtargerr
;
178 extern struct ui_file
*gdb_stdtargin
;
180 /* More generic printf like operations. Filtered versions may return
181 non-locally on error. */
183 extern void fputs_filtered (const char *, struct ui_file
*);
185 extern void fputs_unfiltered (const char *, struct ui_file
*);
187 extern int fputc_filtered (int c
, struct ui_file
*);
189 extern int fputc_unfiltered (int c
, struct ui_file
*);
191 extern int putchar_filtered (int c
);
193 extern int putchar_unfiltered (int c
);
195 extern void puts_filtered (const char *);
197 extern void puts_unfiltered (const char *);
199 extern void puts_filtered_tabular (char *string
, int width
, int right
);
201 extern void puts_debug (char *prefix
, char *string
, char *suffix
);
203 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
205 extern void vfprintf_filtered (struct ui_file
*, const char *, va_list)
206 ATTRIBUTE_PRINTF (2, 0);
208 extern void fprintf_filtered (struct ui_file
*, const char *, ...)
209 ATTRIBUTE_PRINTF (2, 3);
211 extern void fprintfi_filtered (int, struct ui_file
*, const char *, ...)
212 ATTRIBUTE_PRINTF (3, 4);
214 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
216 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
218 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
220 extern void vfprintf_unfiltered (struct ui_file
*, const char *, va_list)
221 ATTRIBUTE_PRINTF (2, 0);
223 extern void fprintf_unfiltered (struct ui_file
*, const char *, ...)
224 ATTRIBUTE_PRINTF (2, 3);
226 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
228 extern void print_spaces (int, struct ui_file
*);
230 extern void print_spaces_filtered (int, struct ui_file
*);
232 extern char *n_spaces (int);
234 extern void fputstr_filtered (const char *str
, int quotr
,
235 struct ui_file
* stream
);
237 extern void fputstr_unfiltered (const char *str
, int quotr
,
238 struct ui_file
* stream
);
240 extern void fputstrn_filtered (const char *str
, int n
, int quotr
,
241 struct ui_file
* stream
);
243 extern void fputstrn_unfiltered (const char *str
, int n
, int quotr
,
244 struct ui_file
* stream
);
246 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
247 extern void gdb_print_host_address (const void *addr
, struct ui_file
*stream
);
249 /* Convert CORE_ADDR to string in platform-specific manner.
250 This is usually formatted similar to 0x%lx. */
251 extern const char *paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
253 /* Return a string representation in hexadecimal notation of ADDRESS,
254 which is suitable for printing. */
256 extern const char *print_core_address (struct gdbarch
*gdbarch
,
259 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
260 extern hashval_t
core_addr_hash (const void *ap
);
261 extern int core_addr_eq (const void *ap
, const void *bp
);
263 extern CORE_ADDR
string_to_core_addr (const char *my_string
);
265 extern void fprintf_symbol_filtered (struct ui_file
*, const char *,
268 extern void throw_perror_with_name (enum errors errcode
, const char *string
)
270 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN
;
272 extern void perror_warning_with_name (const char *string
);
274 extern void print_sys_errmsg (const char *, int);
276 /* Warnings and error messages. */
278 extern void (*deprecated_error_begin_hook
) (void);
280 /* Message to be printed before the warning message, when a warning occurs. */
282 extern char *warning_pre_print
;
284 extern void verror (const char *fmt
, va_list ap
)
285 ATTRIBUTE_NORETURN
ATTRIBUTE_PRINTF (1, 0);
287 extern void error (const char *fmt
, ...)
288 ATTRIBUTE_NORETURN
ATTRIBUTE_PRINTF (1, 2);
290 extern void error_stream (struct ui_file
*) ATTRIBUTE_NORETURN
;
292 extern void vfatal (const char *fmt
, va_list ap
)
293 ATTRIBUTE_NORETURN
ATTRIBUTE_PRINTF (1, 0);
295 extern void fatal (const char *fmt
, ...)
296 ATTRIBUTE_NORETURN
ATTRIBUTE_PRINTF (1, 2);
298 extern void internal_verror (const char *file
, int line
, const char *,
300 ATTRIBUTE_NORETURN
ATTRIBUTE_PRINTF (3, 0);
302 extern void internal_vwarning (const char *file
, int line
,
303 const char *, va_list ap
)
304 ATTRIBUTE_PRINTF (3, 0);
306 extern void internal_warning (const char *file
, int line
,
307 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
309 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
311 extern void vwarning (const char *, va_list args
) ATTRIBUTE_PRINTF (1, 0);
313 /* Misc. utilities. */
315 /* Allocation and deallocation functions for the libiberty hash table
316 which use obstacks. */
317 void *hashtab_obstack_allocate (void *data
, size_t size
, size_t count
);
318 void dummy_obstack_deallocate (void *object
, void *data
);
321 extern pid_t
wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
);
324 extern int producer_is_gcc_ge_4 (const char *producer
);
326 extern int myread (int, char *, int);
328 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
329 power of 2). Round up/down when necessary. Examples of correct
332 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
333 write_memory (addr, value, len);
338 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
339 write_memory (sp, value, len);
341 Note that uses such as:
343 write_memory (addr, value, len);
344 addr += align_up (len, 8);
348 sp -= align_up (len, 8);
349 write_memory (sp, value, len);
351 are typically not correct as they don't ensure that the address (SP
352 or ADDR) is correctly aligned (relying on previous alignment to
353 keep things right). This is also why the methods are called
354 "align_..." instead of "round_..." as the latter reads better with
355 this incorrect coding style. */
357 extern ULONGEST
align_up (ULONGEST v
, int n
);
358 extern ULONGEST
align_down (ULONGEST v
, int n
);
360 /* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
363 extern LONGEST
gdb_sign_extend (LONGEST value
, int bit
);