arc: Fix ARI warning for printf(%p)
[deliverable/binutils-gdb.git] / gdb / utils.h
CommitLineData
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.
618f726f 4 Copyright (C) 1986-2016 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
af880d85 24#include "exceptions.h"
48faced0
DE
25
26extern void initialize_utils (void);
27
28/* String utilities. */
29
30extern int sevenbit_strings;
31
48faced0
DE
32extern int strcmp_iw (const char *, const char *);
33
34extern int strcmp_iw_ordered (const char *, const char *);
35
36extern int streq (const char *, const char *);
37
38extern int subset_compare (char *, char *);
39
48faced0
DE
40int compare_positive_ints (const void *ap, const void *bp);
41int compare_strings (const void *ap, const void *bp);
42
48faced0
DE
43/* A wrapper for bfd_errmsg to produce a more helpful error message
44 in the case of bfd_error_file_ambiguously recognized.
45 MATCHING, if non-NULL, is the corresponding argument to
46 bfd_check_format_matches, and will be freed. */
47
48extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
bd712aed
DE
49
50/* Reset the prompt_for_continue clock. */
51void reset_prompt_for_continue_wait_time (void);
52/* Return the time spent in prompt_for_continue. */
53struct timeval get_prompt_for_continue_wait_time (void);
48faced0
DE
54\f
55/* Parsing utilites. */
56
c0939df1 57extern int parse_pid_to_attach (const char *args);
48faced0 58
d7561cbb 59extern int parse_escape (struct gdbarch *, const char **);
48faced0
DE
60
61char **gdb_buildargv (const char *);
62\f
63/* Cleanup utilities. */
64
65extern struct cleanup *make_cleanup_freeargv (char **);
66
67struct dyn_string;
68extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
69
70struct ui_file;
71extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
72
73struct ui_out;
74extern struct cleanup *
75 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
76
77struct section_addr_info;
78extern struct cleanup *(make_cleanup_free_section_addr_info
79 (struct section_addr_info *));
80
ca095836 81/* For make_cleanup_close see common/filestuff.h. */
48faced0
DE
82
83extern struct cleanup *make_cleanup_fclose (FILE *file);
84
85extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
86
87struct obstack;
88extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
89
90extern struct cleanup *make_cleanup_restore_integer (int *variable);
91extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
92
93struct target_ops;
94extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
95
96extern struct cleanup *
97 make_cleanup_restore_ui_file (struct ui_file **variable);
98
99extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
100extern struct cleanup *make_cleanup_value_free (struct value *);
101
102struct so_list;
103extern struct cleanup *make_cleanup_free_so (struct so_list *so);
104
5b12a61c
JK
105extern struct cleanup *make_cleanup_restore_current_language (void);
106
48faced0
DE
107extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
108
410a0ff2
SDJ
109struct parser_state;
110extern struct cleanup *make_cleanup_clear_parser_state
111 (struct parser_state **p);
112
48faced0
DE
113extern void free_current_contents (void *);
114
48faced0
DE
115extern void init_page_info (void);
116
117extern struct cleanup *make_cleanup_restore_page_info (void);
118extern struct cleanup *
119 set_batch_flag_and_make_cleanup_restore_page_info (void);
120
121extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
122\f
123/* Path utilities. */
124
125extern char *gdb_realpath (const char *);
126
4856b6bc
JK
127extern char *gdb_realpath_keepfile (const char *);
128
04affae3
JK
129extern char *gdb_abspath (const char *);
130
48faced0
DE
131extern int gdb_filename_fnmatch (const char *pattern, const char *string,
132 int flags);
133
134extern void substitute_path_component (char **stringp, const char *from,
135 const char *to);
136
137char *ldirname (const char *filename);
cce0e923
DE
138
139extern int count_path_elements (const char *path);
140
141extern const char *strip_leading_path_elements (const char *path, int n);
48faced0
DE
142\f
143/* GDB output, ui_file utilities. */
144
145struct ui_file;
146
48faced0
DE
147extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
148extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
149extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
150
151extern void begin_line (void);
152
153extern void wrap_here (char *);
154
155extern void reinitialize_more_filter (void);
156
74da6f00
PA
157extern int pagination_enabled;
158
79aa2fe8
PA
159extern struct ui_file **current_ui_gdb_stdout_ptr (void);
160extern struct ui_file **current_ui_gdb_stdin_ptr (void);
161extern struct ui_file **current_ui_gdb_stderr_ptr (void);
162extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
163
164/* The current top level's ui_file streams. */
165
48faced0 166/* Normal results */
79aa2fe8 167#define gdb_stdout (*current_ui_gdb_stdout_ptr ())
48faced0 168/* Input stream */
79aa2fe8 169#define gdb_stdin (*current_ui_gdb_stdin_ptr ())
48faced0 170/* Serious error notifications */
79aa2fe8 171#define gdb_stderr (*current_ui_gdb_stderr_ptr ())
48faced0
DE
172/* Log/debug/trace messages that should bypass normal stdout/stderr
173 filtering. For moment, always call this stream using
174 *_unfiltered. In the very near future that restriction shall be
175 removed - either call shall be unfiltered. (cagney 1999-06-13). */
79aa2fe8
PA
176#define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
177
178/* Truly global ui_file streams. These are all defined in main.c. */
179
48faced0
DE
180/* Target output that should bypass normal stdout/stderr filtering.
181 For moment, always call this stream using *_unfiltered. In the
182 very near future that restriction shall be removed - either call
183 shall be unfiltered. (cagney 1999-07-02). */
184extern struct ui_file *gdb_stdtarg;
185extern struct ui_file *gdb_stdtargerr;
186extern struct ui_file *gdb_stdtargin;
187
d6e5e7f7
PP
188/* Set the screen dimensions to WIDTH and HEIGHT. */
189
190extern void set_screen_width_and_height (int width, int height);
191
48faced0
DE
192/* More generic printf like operations. Filtered versions may return
193 non-locally on error. */
194
195extern void fputs_filtered (const char *, struct ui_file *);
196
197extern void fputs_unfiltered (const char *, struct ui_file *);
198
199extern int fputc_filtered (int c, struct ui_file *);
200
201extern int fputc_unfiltered (int c, struct ui_file *);
202
203extern int putchar_filtered (int c);
204
205extern int putchar_unfiltered (int c);
206
207extern void puts_filtered (const char *);
208
209extern void puts_unfiltered (const char *);
210
211extern void puts_filtered_tabular (char *string, int width, int right);
212
213extern void puts_debug (char *prefix, char *string, char *suffix);
214
215extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
216
217extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
218 ATTRIBUTE_PRINTF (2, 0);
219
220extern void fprintf_filtered (struct ui_file *, const char *, ...)
221 ATTRIBUTE_PRINTF (2, 3);
222
223extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
224 ATTRIBUTE_PRINTF (3, 4);
225
226extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
227
228extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
229
230extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
231
232extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
233 ATTRIBUTE_PRINTF (2, 0);
234
235extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
236 ATTRIBUTE_PRINTF (2, 3);
237
238extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
239
240extern void print_spaces (int, struct ui_file *);
241
242extern void print_spaces_filtered (int, struct ui_file *);
243
244extern char *n_spaces (int);
245
246extern void fputstr_filtered (const char *str, int quotr,
247 struct ui_file * stream);
248
249extern void fputstr_unfiltered (const char *str, int quotr,
250 struct ui_file * stream);
251
252extern void fputstrn_filtered (const char *str, int n, int quotr,
253 struct ui_file * stream);
254
255extern void fputstrn_unfiltered (const char *str, int n, int quotr,
256 struct ui_file * stream);
257
2437fd32
GB
258/* Return nonzero if filtered printing is initialized. */
259extern int filtered_printing_initialized (void);
260
48faced0 261/* Display the host ADDR on STREAM formatted as ``0x%x''. */
b80c3053
PA
262extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
263
264/* Wrapper that avoids adding a pointless cast to all callers. */
265#define gdb_print_host_address(ADDR, STREAM) \
266 gdb_print_host_address_1 ((const void *) ADDR, STREAM)
48faced0 267
48faced0
DE
268/* Convert CORE_ADDR to string in platform-specific manner.
269 This is usually formatted similar to 0x%lx. */
270extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
271
272/* Return a string representation in hexadecimal notation of ADDRESS,
273 which is suitable for printing. */
274
275extern const char *print_core_address (struct gdbarch *gdbarch,
276 CORE_ADDR address);
277
278/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
279extern hashval_t core_addr_hash (const void *ap);
280extern int core_addr_eq (const void *ap, const void *bp);
281
48faced0
DE
282extern CORE_ADDR string_to_core_addr (const char *my_string);
283
48faced0
DE
284extern void fprintf_symbol_filtered (struct ui_file *, const char *,
285 enum language, int);
286
598d3636
JK
287extern void throw_perror_with_name (enum errors errcode, const char *string)
288 ATTRIBUTE_NORETURN;
48faced0 289
7c647d61
JB
290extern void perror_warning_with_name (const char *string);
291
48faced0
DE
292extern void print_sys_errmsg (const char *, int);
293\f
294/* Warnings and error messages. */
295
296extern void (*deprecated_error_begin_hook) (void);
297
48faced0
DE
298/* Message to be printed before the warning message, when a warning occurs. */
299
300extern char *warning_pre_print;
301
48faced0
DE
302extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
303
57fcfb1b
GB
304extern void demangler_vwarning (const char *file, int line,
305 const char *, va_list ap)
306 ATTRIBUTE_PRINTF (3, 0);
307
308extern void demangler_warning (const char *file, int line,
309 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
310
48faced0
DE
311\f
312/* Misc. utilities. */
313
314/* Allocation and deallocation functions for the libiberty hash table
315 which use obstacks. */
316void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
317void dummy_obstack_deallocate (void *object, void *data);
318
319#ifdef HAVE_WAITPID
320extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
321#endif
322
323extern int producer_is_gcc_ge_4 (const char *producer);
cc7039d3 324extern int producer_is_gcc (const char *producer, int *major, int *minor);
48faced0 325
48faced0
DE
326extern int myread (int, char *, int);
327
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
330 use include:
331
332 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
333 write_memory (addr, value, len);
334 addr += len;
335
336 and:
337
338 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
339 write_memory (sp, value, len);
340
341 Note that uses such as:
342
343 write_memory (addr, value, len);
344 addr += align_up (len, 8);
345
346 and:
347
348 sp -= align_up (len, 8);
349 write_memory (sp, value, len);
350
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. */
356
357extern ULONGEST align_up (ULONGEST v, int n);
358extern ULONGEST align_down (ULONGEST v, int n);
359
eae7090b
GB
360/* Resource limits used by getrlimit and setrlimit. */
361
362enum resource_limit_kind
363 {
364 LIMIT_CUR,
365 LIMIT_MAX
366 };
367
368/* Check whether GDB will be able to dump core using the dump_core
369 function. Returns zero if GDB cannot or should not dump core.
370 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
371 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
372
373extern int can_dump_core (enum resource_limit_kind limit_kind);
374
375/* Print a warning that we cannot dump core. */
376
377extern void warn_cant_dump_core (const char *reason);
378
379/* Dump core trying to increase the core soft limit to hard limit
380 first. */
381
382extern void dump_core (void);
383
7c50a931
DE
384/* Return the hex string form of LENGTH bytes of DATA.
385 Space for the result is malloc'd, caller must free. */
386
387extern char *make_hex_string (const gdb_byte *data, size_t length);
388
48faced0 389#endif /* UTILS_H */
This page took 0.512419 seconds and 4 git commands to generate.