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-2014 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 #include "print-utils.h"
  27
  28 extern void initialize_utils (void);
  29
  30 /* String utilities.  */
  31
  32 extern int sevenbit_strings;
  33
  34 extern char *savestring (const char *, size_t);
  35
  36 extern int strcmp_iw (const char *, const char *);
  37
  38 extern int strcmp_iw_ordered (const char *, const char *);
  39
  40 extern int streq (const char *, const char *);
  41
  42 extern int subset_compare (char *, char *);
  43
  44 ULONGEST strtoulst (const char *num, const char **trailer, int base);
  45
  46 int compare_positive_ints (const void *ap, const void *bp);
  47 int compare_strings (const void *ap, const void *bp);
  48
  49 /* This is defined in *-hdep.c, e.g., posix-hdep.c.  */
  50 extern 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
  57 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
  58
  59 /* Reset the prompt_for_continue clock.  */
  60 void reset_prompt_for_continue_wait_time (void);
  61 /* Return the time spent in prompt_for_continue.  */
  62 struct timeval get_prompt_for_continue_wait_time (void);
  63 \f
  64 /* Parsing utilites.  */
  65
  66 extern int parse_pid_to_attach (char *args);
  67
  68 extern int parse_escape (struct gdbarch *, const char **);
  69
  70 char **gdb_buildargv (const char *);
  71 \f
  72 /* Cleanup utilities.  */
  73
  74 extern struct cleanup *make_cleanup_freeargv (char **);
  75
  76 struct dyn_string;
  77 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
  78
  79 struct ui_file;
  80 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
  81
  82 struct ui_out;
  83 extern struct cleanup *
  84   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
  85
  86 struct section_addr_info;
  87 extern struct cleanup *(make_cleanup_free_section_addr_info
  88                         (struct section_addr_info *));
  89
  90 extern struct cleanup *make_cleanup_close (int fd);
  91
  92 extern struct cleanup *make_cleanup_fclose (FILE *file);
  93
  94 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
  95
  96 struct obstack;
  97 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
  98
  99 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 100 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 101
 102 struct target_ops;
 103 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 104
 105 extern struct cleanup *
 106   make_cleanup_restore_ui_file (struct ui_file **variable);
 107
 108 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 109 extern struct cleanup *make_cleanup_value_free (struct value *);
 110
 111 struct so_list;
 112 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
 113
 114 extern struct cleanup *make_cleanup_restore_current_language (void);
 115
 116 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
 117
 118 struct parser_state;
 119 extern struct cleanup *make_cleanup_clear_parser_state
 120   (struct parser_state **p);
 121
 122 extern void free_current_contents (void *);
 123
 124 extern void init_page_info (void);
 125
 126 extern struct cleanup *make_cleanup_restore_page_info (void);
 127 extern struct cleanup *
 128   set_batch_flag_and_make_cleanup_restore_page_info (void);
 129
 130 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 131 \f
 132 /* Path utilities.  */
 133
 134 extern char *gdb_realpath (const char *);
 135
 136 extern char *gdb_realpath_keepfile (const char *);
 137
 138 extern char *gdb_abspath (const char *);
 139
 140 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 141                                  int flags);
 142
 143 extern void substitute_path_component (char **stringp, const char *from,
 144                                        const char *to);
 145
 146 char *ldirname (const char *filename);
 147 \f
 148 /* GDB output, ui_file utilities.  */
 149
 150 struct ui_file;
 151
 152 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 153 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 154 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 155
 156 extern void begin_line (void);
 157
 158 extern void wrap_here (char *);
 159
 160 extern void reinitialize_more_filter (void);
 161
 162 extern int pagination_enabled;
 163
 164 /* Global ui_file streams.  These are all defined in main.c.  */
 165 /* Normal results */
 166 extern struct ui_file *gdb_stdout;
 167 /* Input stream */
 168 extern struct ui_file *gdb_stdin;
 169 /* Serious error notifications */
 170 extern 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).  */
 175 extern 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).  */
 180 extern struct ui_file *gdb_stdtarg;
 181 extern struct ui_file *gdb_stdtargerr;
 182 extern struct ui_file *gdb_stdtargin;
 183
 184 /* More generic printf like operations.  Filtered versions may return
 185    non-locally on error.  */
 186
 187 extern void fputs_filtered (const char *, struct ui_file *);
 188
 189 extern void fputs_unfiltered (const char *, struct ui_file *);
 190
 191 extern int fputc_filtered (int c, struct ui_file *);
 192
 193 extern int fputc_unfiltered (int c, struct ui_file *);
 194
 195 extern int putchar_filtered (int c);
 196
 197 extern int putchar_unfiltered (int c);
 198
 199 extern void puts_filtered (const char *);
 200
 201 extern void puts_unfiltered (const char *);
 202
 203 extern void puts_filtered_tabular (char *string, int width, int right);
 204
 205 extern void puts_debug (char *prefix, char *string, char *suffix);
 206
 207 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 208
 209 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 210   ATTRIBUTE_PRINTF (2, 0);
 211
 212 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 213   ATTRIBUTE_PRINTF (2, 3);
 214
 215 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 216   ATTRIBUTE_PRINTF (3, 4);
 217
 218 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 219
 220 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 221
 222 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 223
 224 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 225   ATTRIBUTE_PRINTF (2, 0);
 226
 227 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 228   ATTRIBUTE_PRINTF (2, 3);
 229
 230 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 231
 232 extern void print_spaces (int, struct ui_file *);
 233
 234 extern void print_spaces_filtered (int, struct ui_file *);
 235
 236 extern char *n_spaces (int);
 237
 238 extern void fputstr_filtered (const char *str, int quotr,
 239                               struct ui_file * stream);
 240
 241 extern void fputstr_unfiltered (const char *str, int quotr,
 242                                 struct ui_file * stream);
 243
 244 extern void fputstrn_filtered (const char *str, int n, int quotr,
 245                                struct ui_file * stream);
 246
 247 extern 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''.  */
 251 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 252
 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
 267 extern CORE_ADDR string_to_core_addr (const char *my_string);
 268
 269 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 270                                      enum language, int);
 271
 272 extern void throw_perror_with_name (enum errors errcode, const char *string)
 273   ATTRIBUTE_NORETURN;
 274 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
 275
 276 extern void perror_warning_with_name (const char *string);
 277
 278 extern void print_sys_errmsg (const char *, int);
 279 \f
 280 /* Warnings and error messages.  */
 281
 282 extern void (*deprecated_error_begin_hook) (void);
 283
 284 /* Message to be printed before the warning message, when a warning occurs.  */
 285
 286 extern char *warning_pre_print;
 287
 288 extern void verror (const char *fmt, va_list ap)
 289      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 290
 291 extern void error (const char *fmt, ...)
 292      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 293
 294 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 295
 296 extern void vfatal (const char *fmt, va_list ap)
 297      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 298
 299 extern void fatal (const char *fmt, ...)
 300      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 301
 302 extern void internal_verror (const char *file, int line, const char *,
 303                              va_list ap)
 304      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
 305
 306 extern void internal_vwarning (const char *file, int line,
 307                                const char *, va_list ap)
 308      ATTRIBUTE_PRINTF (3, 0);
 309
 310 extern void internal_warning (const char *file, int line,
 311                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 312
 313 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 314
 315 extern 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.  */
 321 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
 322 void dummy_obstack_deallocate (void *object, void *data);
 323
 324 #ifdef HAVE_WAITPID
 325 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 326 #endif
 327
 328 extern int producer_is_gcc_ge_4 (const char *producer);
 329
 330 extern 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
 361 extern ULONGEST align_up (ULONGEST v, int n);
 362 extern ULONGEST align_down (ULONGEST v, int n);
 363
 364 /* Sign extend VALUE.  BIT is the (1-based) index of the bit in VALUE
 365    to sign-extend.  */
 366
 367 extern LONGEST gdb_sign_extend (LONGEST value, int bit);
 368
 369 #endif /* UTILS_H */