gdb/utils.h

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