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