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