Use target_xfer_partial_ftype for rs6000_xfer_shared_libraries
[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"
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
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
245/* Display the host ADDR on STREAM formatted as ``0x%x''. */
246extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
247
248extern const char *host_address_to_string (const void *addr);
249
250/* Convert CORE_ADDR to string in platform-specific manner.
251 This is usually formatted similar to 0x%lx. */
252extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
253
254/* Return a string representation in hexadecimal notation of ADDRESS,
255 which is suitable for printing. */
256
257extern const char *print_core_address (struct gdbarch *gdbarch,
258 CORE_ADDR address);
259
260/* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex. */
261extern hashval_t core_addr_hash (const void *ap);
262extern int core_addr_eq (const void *ap, const void *bp);
263
264/* %d for LONGEST */
265extern char *plongest (LONGEST l);
266/* %u for ULONGEST */
267extern char *pulongest (ULONGEST l);
268
269extern char *phex (ULONGEST l, int sizeof_l);
270extern char *phex_nz (ULONGEST l, int sizeof_l);
271extern char *int_string (LONGEST, int, int, int, int);
272
273/* Convert a CORE_ADDR into a HEX string with leading zeros.
274 The output from core_addr_to_string() can be passed direct to
275 string_to_core_addr(). */
276extern const char *core_addr_to_string (const CORE_ADDR addr);
277extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
278extern CORE_ADDR string_to_core_addr (const char *my_string);
279
280/* Return a string that contains a number formatted as a hex
281 string. */
282extern char *hex_string (LONGEST);
283extern char *hex_string_custom (LONGEST, int);
284
285extern void fprintf_symbol_filtered (struct ui_file *, const char *,
286 enum language, int);
287
598d3636
JK
288extern void throw_perror_with_name (enum errors errcode, const char *string)
289 ATTRIBUTE_NORETURN;
48faced0
DE
290extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
291
7c647d61
JB
292extern void perror_warning_with_name (const char *string);
293
48faced0
DE
294extern void print_sys_errmsg (const char *, int);
295\f
296/* Warnings and error messages. */
297
298extern void (*deprecated_error_begin_hook) (void);
299
48faced0
DE
300/* Message to be printed before the warning message, when a warning occurs. */
301
302extern char *warning_pre_print;
303
304extern void verror (const char *fmt, va_list ap)
305 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
306
307extern void error (const char *fmt, ...)
308 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
309
310extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
311
312extern void vfatal (const char *fmt, va_list ap)
313 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
314
315extern void fatal (const char *fmt, ...)
316 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
317
318extern void internal_verror (const char *file, int line, const char *,
319 va_list ap)
320 ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
321
322extern void internal_vwarning (const char *file, int line,
323 const char *, va_list ap)
324 ATTRIBUTE_PRINTF (3, 0);
325
326extern void internal_warning (const char *file, int line,
327 const char *, ...) ATTRIBUTE_PRINTF (3, 4);
328
329extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
330
331extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
332\f
333/* Misc. utilities. */
334
335/* Allocation and deallocation functions for the libiberty hash table
336 which use obstacks. */
337void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
338void dummy_obstack_deallocate (void *object, void *data);
339
340#ifdef HAVE_WAITPID
341extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
342#endif
343
344extern int producer_is_gcc_ge_4 (const char *producer);
345
48faced0
DE
346extern int myread (int, char *, int);
347
348/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
349 power of 2). Round up/down when necessary. Examples of correct
350 use include:
351
352 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
353 write_memory (addr, value, len);
354 addr += len;
355
356 and:
357
358 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
359 write_memory (sp, value, len);
360
361 Note that uses such as:
362
363 write_memory (addr, value, len);
364 addr += align_up (len, 8);
365
366 and:
367
368 sp -= align_up (len, 8);
369 write_memory (sp, value, len);
370
371 are typically not correct as they don't ensure that the address (SP
372 or ADDR) is correctly aligned (relying on previous alignment to
373 keep things right). This is also why the methods are called
374 "align_..." instead of "round_..." as the latter reads better with
375 this incorrect coding style. */
376
377extern ULONGEST align_up (ULONGEST v, int n);
378extern ULONGEST align_down (ULONGEST v, int n);
379
5bd1ef56
TT
380/* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
381 to sign-extend. */
382
383extern LONGEST gdb_sign_extend (LONGEST value, int bit);
384
48faced0 385#endif /* UTILS_H */
This page took 0.207054 seconds and 4 git commands to generate.