Copy over fix for fetching dynamic type of a reference from python side.
[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.
ecd75fc8 4 Copyright (C) 1986-2014 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
24#include "cleanups.h"
af880d85 25#include "exceptions.h"
01fd3ea5 26#include "print-utils.h"
48faced0
DE
27
28extern void initialize_utils (void);
29
30/* String utilities. */
31
32extern int sevenbit_strings;
33
34extern char *savestring (const char *, size_t);
35
36extern int strcmp_iw (const char *, const char *);
37
38extern int strcmp_iw_ordered (const char *, const char *);
39
40extern int streq (const char *, const char *);
41
42extern int subset_compare (char *, char *);
43
44ULONGEST strtoulst (const char *num, const char **trailer, int base);
45
46int compare_positive_ints (const void *ap, const void *bp);
47int compare_strings (const void *ap, const void *bp);
48
49/* This is defined in *-hdep.c, e.g., posix-hdep.c. */
50extern char *safe_strerror (int);
51
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. */
56
57extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
bd712aed
DE
58
59/* Reset the prompt_for_continue clock. */
60void reset_prompt_for_continue_wait_time (void);
61/* Return the time spent in prompt_for_continue. */
62struct timeval get_prompt_for_continue_wait_time (void);
48faced0
DE
63\f
64/* Parsing utilites. */
65
66extern int parse_pid_to_attach (char *args);
67
d7561cbb 68extern int parse_escape (struct gdbarch *, const char **);
48faced0
DE
69
70char **gdb_buildargv (const char *);
71\f
72/* Cleanup utilities. */
73
74extern struct cleanup *make_cleanup_freeargv (char **);
75
76struct dyn_string;
77extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
78
79struct ui_file;
80extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
81
82struct ui_out;
83extern struct cleanup *
84 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
85
86struct section_addr_info;
87extern struct cleanup *(make_cleanup_free_section_addr_info
88 (struct section_addr_info *));
89
90extern struct cleanup *make_cleanup_close (int fd);
91
92extern struct cleanup *make_cleanup_fclose (FILE *file);
93
94extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
95
96struct obstack;
97extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
98
99extern struct cleanup *make_cleanup_restore_integer (int *variable);
100extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
101
102struct target_ops;
103extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
104
105extern struct cleanup *
106 make_cleanup_restore_ui_file (struct ui_file **variable);
107
108extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
109extern struct cleanup *make_cleanup_value_free (struct value *);
110
111struct so_list;
112extern struct cleanup *make_cleanup_free_so (struct so_list *so);
113
5b12a61c
JK
114extern struct cleanup *make_cleanup_restore_current_language (void);
115
48faced0
DE
116extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
117
410a0ff2
SDJ
118struct parser_state;
119extern struct cleanup *make_cleanup_clear_parser_state
120 (struct parser_state **p);
121
48faced0
DE
122extern void free_current_contents (void *);
123
48faced0
DE
124extern void init_page_info (void);
125
126extern struct cleanup *make_cleanup_restore_page_info (void);
127extern struct cleanup *
128 set_batch_flag_and_make_cleanup_restore_page_info (void);
129
130extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
131\f
132/* Path utilities. */
133
134extern char *gdb_realpath (const char *);
135
4856b6bc
JK
136extern char *gdb_realpath_keepfile (const char *);
137
04affae3
JK
138extern char *gdb_abspath (const char *);
139
48faced0
DE
140extern int gdb_filename_fnmatch (const char *pattern, const char *string,
141 int flags);
142
143extern void substitute_path_component (char **stringp, const char *from,
144 const char *to);
145
146char *ldirname (const char *filename);
147\f
148/* GDB output, ui_file utilities. */
149
150struct ui_file;
151
48faced0
DE
152extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
153extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
154extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
155
156extern void begin_line (void);
157
158extern void wrap_here (char *);
159
160extern void reinitialize_more_filter (void);
161
74da6f00
PA
162extern int pagination_enabled;
163
48faced0
DE
164/* Global ui_file streams. These are all defined in main.c. */
165/* Normal results */
166extern struct ui_file *gdb_stdout;
167/* Input stream */
168extern struct ui_file *gdb_stdin;
169/* Serious error notifications */
170extern struct ui_file *gdb_stderr;
171/* Log/debug/trace messages that should bypass normal stdout/stderr
172 filtering. For moment, always call this stream using
173 *_unfiltered. In the very near future that restriction shall be
174 removed - either call shall be unfiltered. (cagney 1999-06-13). */
175extern struct ui_file *gdb_stdlog;
176/* Target output that should bypass normal stdout/stderr filtering.
177 For moment, always call this stream using *_unfiltered. In the
178 very near future that restriction shall be removed - either call
179 shall be unfiltered. (cagney 1999-07-02). */
180extern struct ui_file *gdb_stdtarg;
181extern struct ui_file *gdb_stdtargerr;
182extern struct ui_file *gdb_stdtargin;
183
184/* More generic printf like operations. Filtered versions may return
185 non-locally on error. */
186
187extern void fputs_filtered (const char *, struct ui_file *);
188
189extern void fputs_unfiltered (const char *, struct ui_file *);
190
191extern int fputc_filtered (int c, struct ui_file *);
192
193extern int fputc_unfiltered (int c, struct ui_file *);
194
195extern int putchar_filtered (int c);
196
197extern int putchar_unfiltered (int c);
198
199extern void puts_filtered (const char *);
200
201extern void puts_unfiltered (const char *);
202
203extern void puts_filtered_tabular (char *string, int width, int right);
204
205extern void puts_debug (char *prefix, char *string, char *suffix);
206
207extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
208
209extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
210 ATTRIBUTE_PRINTF (2, 0);
211
212extern void fprintf_filtered (struct ui_file *, const char *, ...)
213 ATTRIBUTE_PRINTF (2, 3);
214
215extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
216 ATTRIBUTE_PRINTF (3, 4);
217
218extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
219
220extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
221
222extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
223
224extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
225 ATTRIBUTE_PRINTF (2, 0);
226
227extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
228 ATTRIBUTE_PRINTF (2, 3);
229
230extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
231
232extern void print_spaces (int, struct ui_file *);
233
234extern void print_spaces_filtered (int, struct ui_file *);
235
236extern char *n_spaces (int);
237
238extern void fputstr_filtered (const char *str, int quotr,
239 struct ui_file * stream);
240
241extern void fputstr_unfiltered (const char *str, int quotr,
242 struct ui_file * stream);
243
244extern void fputstrn_filtered (const char *str, int n, int quotr,
245 struct ui_file * stream);
246
247extern void fputstrn_unfiltered (const char *str, int n, int quotr,
248 struct ui_file * stream);
249
250/* Display the host ADDR on STREAM formatted as ``0x%x''. */
251extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
252
48faced0
DE
253/* Convert CORE_ADDR to string in platform-specific manner.
254 This is usually formatted similar to 0x%lx. */
255extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
256
257/* Return a string representation in hexadecimal notation of ADDRESS,
258 which is suitable for printing. */
259
260extern const char *print_core_address (struct gdbarch *gdbarch,
261 CORE_ADDR address);
262
263/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
264extern hashval_t core_addr_hash (const void *ap);
265extern int core_addr_eq (const void *ap, const void *bp);
266
48faced0
DE
267extern CORE_ADDR string_to_core_addr (const char *my_string);
268
48faced0
DE
269extern void fprintf_symbol_filtered (struct ui_file *, const char *,
270 enum language, int);
271
598d3636
JK
272extern void throw_perror_with_name (enum errors errcode, const char *string)
273 ATTRIBUTE_NORETURN;
48faced0
DE
274extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
275
7c647d61
JB
276extern void perror_warning_with_name (const char *string);
277
48faced0
DE
278extern void print_sys_errmsg (const char *, int);
279\f
280/* Warnings and error messages. */
281
282extern void (*deprecated_error_begin_hook) (void);
283
48faced0
DE
284/* Message to be printed before the warning message, when a warning occurs. */
285
286extern char *warning_pre_print;
287
288extern void verror (const char *fmt, va_list ap)
289 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
290
291extern void error (const char *fmt, ...)
292 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
293
294extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
295
296extern void vfatal (const char *fmt, va_list ap)
297 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
298
299extern void fatal (const char *fmt, ...)
300 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
301
302extern void internal_verror (const char *file, int line, const char *,
303 va_list ap)
304 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
305
306extern void internal_vwarning (const char *file, int line,
307 const char *, va_list ap)
308 ATTRIBUTE_PRINTF (3, 0);
309
310extern void internal_warning (const char *file, int line,
311 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
312
313extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
314
315extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
316\f
317/* Misc. utilities. */
318
319/* Allocation and deallocation functions for the libiberty hash table
320 which use obstacks. */
321void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
322void dummy_obstack_deallocate (void *object, void *data);
323
324#ifdef HAVE_WAITPID
325extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
326#endif
327
328extern int producer_is_gcc_ge_4 (const char *producer);
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
5bd1ef56
TT
364/* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
365 to sign-extend. */
366
367extern LONGEST gdb_sign_extend (LONGEST value, int bit);
368
48faced0 369#endif /* UTILS_H */
This page took 0.484516 seconds and 4 git commands to generate.