Change producer_is_gcc function return type to bool.
[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.
32d0add0 4 Copyright (C) 1986-2015 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
b1ffba5a
MW
24#include <stdbool.h>
25
af880d85 26#include "exceptions.h"
48faced0
DE
27
28extern void initialize_utils (void);
29
30/* String utilities. */
31
32extern int sevenbit_strings;
33
48faced0
DE
34extern int strcmp_iw (const char *, const char *);
35
36extern int strcmp_iw_ordered (const char *, const char *);
37
38extern int streq (const char *, const char *);
39
40extern int subset_compare (char *, char *);
41
42ULONGEST strtoulst (const char *num, const char **trailer, int base);
43
44int compare_positive_ints (const void *ap, const void *bp);
45int compare_strings (const void *ap, const void *bp);
46
48faced0
DE
47/* A wrapper for bfd_errmsg to produce a more helpful error message
48 in the case of bfd_error_file_ambiguously recognized.
49 MATCHING, if non-NULL, is the corresponding argument to
50 bfd_check_format_matches, and will be freed. */
51
52extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
bd712aed
DE
53
54/* Reset the prompt_for_continue clock. */
55void reset_prompt_for_continue_wait_time (void);
56/* Return the time spent in prompt_for_continue. */
57struct timeval get_prompt_for_continue_wait_time (void);
48faced0
DE
58\f
59/* Parsing utilites. */
60
c0939df1 61extern int parse_pid_to_attach (const char *args);
48faced0 62
d7561cbb 63extern int parse_escape (struct gdbarch *, const char **);
48faced0
DE
64
65char **gdb_buildargv (const char *);
66\f
67/* Cleanup utilities. */
68
69extern struct cleanup *make_cleanup_freeargv (char **);
70
71struct dyn_string;
72extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
73
74struct ui_file;
75extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
76
77struct ui_out;
78extern struct cleanup *
79 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
80
81struct section_addr_info;
82extern struct cleanup *(make_cleanup_free_section_addr_info
83 (struct section_addr_info *));
84
85extern struct cleanup *make_cleanup_close (int fd);
86
87extern struct cleanup *make_cleanup_fclose (FILE *file);
88
89extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
90
91struct obstack;
92extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
93
94extern struct cleanup *make_cleanup_restore_integer (int *variable);
95extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
96
97struct target_ops;
98extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
99
100extern struct cleanup *
101 make_cleanup_restore_ui_file (struct ui_file **variable);
102
103extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
104extern struct cleanup *make_cleanup_value_free (struct value *);
105
106struct so_list;
107extern struct cleanup *make_cleanup_free_so (struct so_list *so);
108
5b12a61c
JK
109extern struct cleanup *make_cleanup_restore_current_language (void);
110
48faced0
DE
111extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
112
410a0ff2
SDJ
113struct parser_state;
114extern struct cleanup *make_cleanup_clear_parser_state
115 (struct parser_state **p);
116
48faced0
DE
117extern void free_current_contents (void *);
118
48faced0
DE
119extern void init_page_info (void);
120
121extern struct cleanup *make_cleanup_restore_page_info (void);
122extern struct cleanup *
123 set_batch_flag_and_make_cleanup_restore_page_info (void);
124
125extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
126\f
127/* Path utilities. */
128
129extern char *gdb_realpath (const char *);
130
4856b6bc
JK
131extern char *gdb_realpath_keepfile (const char *);
132
04affae3
JK
133extern char *gdb_abspath (const char *);
134
48faced0
DE
135extern int gdb_filename_fnmatch (const char *pattern, const char *string,
136 int flags);
137
138extern void substitute_path_component (char **stringp, const char *from,
139 const char *to);
140
141char *ldirname (const char *filename);
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
48faced0
DE
159/* Global ui_file streams. These are all defined in main.c. */
160/* Normal results */
161extern struct ui_file *gdb_stdout;
162/* Input stream */
163extern struct ui_file *gdb_stdin;
164/* Serious error notifications */
165extern 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). */
170extern 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). */
175extern struct ui_file *gdb_stdtarg;
176extern struct ui_file *gdb_stdtargerr;
177extern struct ui_file *gdb_stdtargin;
178
179/* More generic printf like operations. Filtered versions may return
180 non-locally on error. */
181
182extern void fputs_filtered (const char *, struct ui_file *);
183
184extern void fputs_unfiltered (const char *, struct ui_file *);
185
186extern int fputc_filtered (int c, struct ui_file *);
187
188extern int fputc_unfiltered (int c, struct ui_file *);
189
190extern int putchar_filtered (int c);
191
192extern int putchar_unfiltered (int c);
193
194extern void puts_filtered (const char *);
195
196extern void puts_unfiltered (const char *);
197
198extern void puts_filtered_tabular (char *string, int width, int right);
199
200extern void puts_debug (char *prefix, char *string, char *suffix);
201
202extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
203
204extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
205 ATTRIBUTE_PRINTF (2, 0);
206
207extern void fprintf_filtered (struct ui_file *, const char *, ...)
208 ATTRIBUTE_PRINTF (2, 3);
209
210extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
211 ATTRIBUTE_PRINTF (3, 4);
212
213extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
214
215extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
216
217extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
218
219extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
220 ATTRIBUTE_PRINTF (2, 0);
221
222extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
223 ATTRIBUTE_PRINTF (2, 3);
224
225extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
226
227extern void print_spaces (int, struct ui_file *);
228
229extern void print_spaces_filtered (int, struct ui_file *);
230
231extern char *n_spaces (int);
232
233extern void fputstr_filtered (const char *str, int quotr,
234 struct ui_file * stream);
235
236extern void fputstr_unfiltered (const char *str, int quotr,
237 struct ui_file * stream);
238
239extern void fputstrn_filtered (const char *str, int n, int quotr,
240 struct ui_file * stream);
241
242extern void fputstrn_unfiltered (const char *str, int n, int quotr,
243 struct ui_file * stream);
244
2437fd32
GB
245/* Return nonzero if filtered printing is initialized. */
246extern int filtered_printing_initialized (void);
247
48faced0
DE
248/* Display the host ADDR on STREAM formatted as ``0x%x''. */
249extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
250
48faced0
DE
251/* Convert CORE_ADDR to string in platform-specific manner.
252 This is usually formatted similar to 0x%lx. */
253extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
254
255/* Return a string representation in hexadecimal notation of ADDRESS,
256 which is suitable for printing. */
257
258extern const char *print_core_address (struct gdbarch *gdbarch,
259 CORE_ADDR address);
260
261/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
262extern hashval_t core_addr_hash (const void *ap);
263extern int core_addr_eq (const void *ap, const void *bp);
264
48faced0
DE
265extern CORE_ADDR string_to_core_addr (const char *my_string);
266
48faced0
DE
267extern void fprintf_symbol_filtered (struct ui_file *, const char *,
268 enum language, int);
269
598d3636
JK
270extern void throw_perror_with_name (enum errors errcode, const char *string)
271 ATTRIBUTE_NORETURN;
48faced0 272
7c647d61
JB
273extern void perror_warning_with_name (const char *string);
274
48faced0
DE
275extern void print_sys_errmsg (const char *, int);
276\f
277/* Warnings and error messages. */
278
279extern void (*deprecated_error_begin_hook) (void);
280
48faced0
DE
281/* Message to be printed before the warning message, when a warning occurs. */
282
283extern char *warning_pre_print;
284
48faced0
DE
285extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
286
57fcfb1b
GB
287extern void demangler_vwarning (const char *file, int line,
288 const char *, va_list ap)
289 ATTRIBUTE_PRINTF (3, 0);
290
291extern void demangler_warning (const char *file, int line,
292 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
293
48faced0
DE
294\f
295/* Misc. utilities. */
296
297/* Allocation and deallocation functions for the libiberty hash table
298 which use obstacks. */
299void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
300void dummy_obstack_deallocate (void *object, void *data);
301
302#ifdef HAVE_WAITPID
303extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
304#endif
305
306extern int producer_is_gcc_ge_4 (const char *producer);
b1ffba5a 307extern bool producer_is_gcc (const char *producer, int *major, int *minor);
48faced0 308
48faced0
DE
309extern int myread (int, char *, int);
310
311/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
312 power of 2). Round up/down when necessary. Examples of correct
313 use include:
314
315 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
316 write_memory (addr, value, len);
317 addr += len;
318
319 and:
320
321 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
322 write_memory (sp, value, len);
323
324 Note that uses such as:
325
326 write_memory (addr, value, len);
327 addr += align_up (len, 8);
328
329 and:
330
331 sp -= align_up (len, 8);
332 write_memory (sp, value, len);
333
334 are typically not correct as they don't ensure that the address (SP
335 or ADDR) is correctly aligned (relying on previous alignment to
336 keep things right). This is also why the methods are called
337 "align_..." instead of "round_..." as the latter reads better with
338 this incorrect coding style. */
339
340extern ULONGEST align_up (ULONGEST v, int n);
341extern ULONGEST align_down (ULONGEST v, int n);
342
eae7090b
GB
343/* Resource limits used by getrlimit and setrlimit. */
344
345enum resource_limit_kind
346 {
347 LIMIT_CUR,
348 LIMIT_MAX
349 };
350
351/* Check whether GDB will be able to dump core using the dump_core
352 function. Returns zero if GDB cannot or should not dump core.
353 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
354 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
355
356extern int can_dump_core (enum resource_limit_kind limit_kind);
357
358/* Print a warning that we cannot dump core. */
359
360extern void warn_cant_dump_core (const char *reason);
361
362/* Dump core trying to increase the core soft limit to hard limit
363 first. */
364
365extern void dump_core (void);
366
7c50a931
DE
367/* Return the hex string form of LENGTH bytes of DATA.
368 Space for the result is malloc'd, caller must free. */
369
370extern char *make_hex_string (const gdb_byte *data, size_t length);
371
48faced0 372#endif /* UTILS_H */
This page took 0.394873 seconds and 4 git commands to generate.