Don't let two frames with the same id end up in the frame chain.
[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.
8acc9f48 4 Copyright (C) 1986-2013 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"
48faced0
DE
26
27extern void initialize_utils (void);
28
29/* String utilities. */
30
31extern int sevenbit_strings;
32
33extern char *savestring (const char *, size_t);
34
35extern int strcmp_iw (const char *, const char *);
36
37extern int strcmp_iw_ordered (const char *, const char *);
38
39extern int streq (const char *, const char *);
40
41extern int subset_compare (char *, char *);
42
43ULONGEST strtoulst (const char *num, const char **trailer, int base);
44
45int compare_positive_ints (const void *ap, const void *bp);
46int compare_strings (const void *ap, const void *bp);
47
48/* This is defined in *-hdep.c, e.g., posix-hdep.c. */
49extern char *safe_strerror (int);
50
51/* A wrapper for bfd_errmsg to produce a more helpful error message
52 in the case of bfd_error_file_ambiguously recognized.
53 MATCHING, if non-NULL, is the corresponding argument to
54 bfd_check_format_matches, and will be freed. */
55
56extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
bd712aed
DE
57
58/* Reset the prompt_for_continue clock. */
59void reset_prompt_for_continue_wait_time (void);
60/* Return the time spent in prompt_for_continue. */
61struct timeval get_prompt_for_continue_wait_time (void);
48faced0
DE
62\f
63/* Parsing utilites. */
64
65extern int parse_pid_to_attach (char *args);
66
d7561cbb 67extern int parse_escape (struct gdbarch *, const char **);
48faced0
DE
68
69char **gdb_buildargv (const char *);
70\f
71/* Cleanup utilities. */
72
73extern struct cleanup *make_cleanup_freeargv (char **);
74
75struct dyn_string;
76extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
77
78struct ui_file;
79extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
80
81struct ui_out;
82extern struct cleanup *
83 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
84
85struct section_addr_info;
86extern struct cleanup *(make_cleanup_free_section_addr_info
87 (struct section_addr_info *));
88
89extern struct cleanup *make_cleanup_close (int fd);
90
91extern struct cleanup *make_cleanup_fclose (FILE *file);
92
93extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
94
95struct obstack;
96extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
97
98extern struct cleanup *make_cleanup_restore_integer (int *variable);
99extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
100
101struct target_ops;
102extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
103
104extern struct cleanup *
105 make_cleanup_restore_ui_file (struct ui_file **variable);
106
107extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
108extern struct cleanup *make_cleanup_value_free (struct value *);
109
110struct so_list;
111extern struct cleanup *make_cleanup_free_so (struct so_list *so);
112
5b12a61c
JK
113extern struct cleanup *make_cleanup_restore_current_language (void);
114
48faced0
DE
115extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
116
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
48faced0
DE
133extern int gdb_filename_fnmatch (const char *pattern, const char *string,
134 int flags);
135
136extern void substitute_path_component (char **stringp, const char *from,
137 const char *to);
138
139char *ldirname (const char *filename);
140\f
141/* GDB output, ui_file utilities. */
142
143struct ui_file;
144
48faced0
DE
145extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
146extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
147extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
148
149extern void begin_line (void);
150
151extern void wrap_here (char *);
152
153extern void reinitialize_more_filter (void);
154
74da6f00
PA
155extern int pagination_enabled;
156
48faced0
DE
157/* Global ui_file streams. These are all defined in main.c. */
158/* Normal results */
159extern struct ui_file *gdb_stdout;
160/* Input stream */
161extern struct ui_file *gdb_stdin;
162/* Serious error notifications */
163extern struct ui_file *gdb_stderr;
164/* Log/debug/trace messages that should bypass normal stdout/stderr
165 filtering. For moment, always call this stream using
166 *_unfiltered. In the very near future that restriction shall be
167 removed - either call shall be unfiltered. (cagney 1999-06-13). */
168extern struct ui_file *gdb_stdlog;
169/* Target output that should bypass normal stdout/stderr filtering.
170 For moment, always call this stream using *_unfiltered. In the
171 very near future that restriction shall be removed - either call
172 shall be unfiltered. (cagney 1999-07-02). */
173extern struct ui_file *gdb_stdtarg;
174extern struct ui_file *gdb_stdtargerr;
175extern struct ui_file *gdb_stdtargin;
176
177/* More generic printf like operations. Filtered versions may return
178 non-locally on error. */
179
180extern void fputs_filtered (const char *, struct ui_file *);
181
182extern void fputs_unfiltered (const char *, struct ui_file *);
183
184extern int fputc_filtered (int c, struct ui_file *);
185
186extern int fputc_unfiltered (int c, struct ui_file *);
187
188extern int putchar_filtered (int c);
189
190extern int putchar_unfiltered (int c);
191
192extern void puts_filtered (const char *);
193
194extern void puts_unfiltered (const char *);
195
196extern void puts_filtered_tabular (char *string, int width, int right);
197
198extern void puts_debug (char *prefix, char *string, char *suffix);
199
200extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
201
202extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
203 ATTRIBUTE_PRINTF (2, 0);
204
205extern void fprintf_filtered (struct ui_file *, const char *, ...)
206 ATTRIBUTE_PRINTF (2, 3);
207
208extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
209 ATTRIBUTE_PRINTF (3, 4);
210
211extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
212
213extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
214
215extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
216
217extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
218 ATTRIBUTE_PRINTF (2, 0);
219
220extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
221 ATTRIBUTE_PRINTF (2, 3);
222
223extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
224
225extern void print_spaces (int, struct ui_file *);
226
227extern void print_spaces_filtered (int, struct ui_file *);
228
229extern char *n_spaces (int);
230
231extern void fputstr_filtered (const char *str, int quotr,
232 struct ui_file * stream);
233
234extern void fputstr_unfiltered (const char *str, int quotr,
235 struct ui_file * stream);
236
237extern void fputstrn_filtered (const char *str, int n, int quotr,
238 struct ui_file * stream);
239
240extern void fputstrn_unfiltered (const char *str, int n, int quotr,
241 struct ui_file * stream);
242
243/* Display the host ADDR on STREAM formatted as ``0x%x''. */
244extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
245
246extern const char *host_address_to_string (const void *addr);
247
248/* Convert CORE_ADDR to string in platform-specific manner.
249 This is usually formatted similar to 0x%lx. */
250extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
251
252/* Return a string representation in hexadecimal notation of ADDRESS,
253 which is suitable for printing. */
254
255extern const char *print_core_address (struct gdbarch *gdbarch,
256 CORE_ADDR address);
257
258/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
259extern hashval_t core_addr_hash (const void *ap);
260extern int core_addr_eq (const void *ap, const void *bp);
261
262/* %d for LONGEST */
263extern char *plongest (LONGEST l);
264/* %u for ULONGEST */
265extern char *pulongest (ULONGEST l);
266
267extern char *phex (ULONGEST l, int sizeof_l);
268extern char *phex_nz (ULONGEST l, int sizeof_l);
269extern char *int_string (LONGEST, int, int, int, int);
270
271/* Convert a CORE_ADDR into a HEX string with leading zeros.
272 The output from core_addr_to_string() can be passed direct to
273 string_to_core_addr(). */
274extern const char *core_addr_to_string (const CORE_ADDR addr);
275extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
276extern CORE_ADDR string_to_core_addr (const char *my_string);
277
278/* Return a string that contains a number formatted as a hex
279 string. */
280extern char *hex_string (LONGEST);
281extern char *hex_string_custom (LONGEST, int);
282
283extern void fprintf_symbol_filtered (struct ui_file *, const char *,
284 enum language, int);
285
598d3636
JK
286extern void throw_perror_with_name (enum errors errcode, const char *string)
287 ATTRIBUTE_NORETURN;
48faced0
DE
288extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
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
302extern void verror (const char *fmt, va_list ap)
303 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
304
305extern void error (const char *fmt, ...)
306 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
307
308extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
309
310extern void vfatal (const char *fmt, va_list ap)
311 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
312
313extern void fatal (const char *fmt, ...)
314 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
315
316extern void internal_verror (const char *file, int line, const char *,
317 va_list ap)
318 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
319
320extern void internal_vwarning (const char *file, int line,
321 const char *, va_list ap)
322 ATTRIBUTE_PRINTF (3, 0);
323
324extern void internal_warning (const char *file, int line,
325 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
326
327extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
328
329extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
330\f
331/* Misc. utilities. */
332
333/* Allocation and deallocation functions for the libiberty hash table
334 which use obstacks. */
335void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
336void dummy_obstack_deallocate (void *object, void *data);
337
338#ifdef HAVE_WAITPID
339extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
340#endif
341
342extern int producer_is_gcc_ge_4 (const char *producer);
343
48faced0
DE
344extern int myread (int, char *, int);
345
346/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
347 power of 2). Round up/down when necessary. Examples of correct
348 use include:
349
350 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
351 write_memory (addr, value, len);
352 addr += len;
353
354 and:
355
356 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
357 write_memory (sp, value, len);
358
359 Note that uses such as:
360
361 write_memory (addr, value, len);
362 addr += align_up (len, 8);
363
364 and:
365
366 sp -= align_up (len, 8);
367 write_memory (sp, value, len);
368
369 are typically not correct as they don't ensure that the address (SP
370 or ADDR) is correctly aligned (relying on previous alignment to
371 keep things right). This is also why the methods are called
372 "align_..." instead of "round_..." as the latter reads better with
373 this incorrect coding style. */
374
375extern ULONGEST align_up (ULONGEST v, int n);
376extern ULONGEST align_down (ULONGEST v, int n);
377
5bd1ef56
TT
378/* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
379 to sign-extend. */
380
381extern LONGEST gdb_sign_extend (LONGEST value, int bit);
382
48faced0 383#endif /* UTILS_H */
This page took 0.223207 seconds and 4 git commands to generate.