/* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
for now. */
/* I/O, string, cleanup, and other random utilities for GDB.
- Copyright (C) 1986-2013 Free Software Foundation, Inc.
+ Copyright (C) 1986-2018 Free Software Foundation, Inc.
This file is part of GDB.
#ifndef UTILS_H
#define UTILS_H
-#include "cleanups.h"
#include "exceptions.h"
+#include "common/scoped_restore.h"
+#include <chrono>
extern void initialize_utils (void);
extern int sevenbit_strings;
-extern char *savestring (const char *, size_t);
-
-extern int strcmp_iw (const char *, const char *);
+/* Modes of operation for strncmp_iw_with_mode. */
+
+enum class strncmp_iw_mode
+{
+/* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
+ differences in whitespace. Returns 0 if they match, non-zero if
+ they don't (slightly different than strcmp()'s range of return
+ values). */
+ NORMAL,
+
+ /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
+ string1=="FOO(PARAMS)" matches string2=="FOO". */
+ MATCH_PARAMS,
+};
+
+/* Helper for strcmp_iw and strncmp_iw. Exported so that languages
+ can implement both NORMAL and MATCH_PARAMS variants in a single
+ function and defer part of the work to strncmp_iw_with_mode.
+
+ LANGUAGE is used to implement some context-sensitive
+ language-specific comparisons. For example, for C++,
+ "string1=operator()" should not match "string2=operator" even in
+ MATCH_PARAMS mode.
+
+ MATCH_FOR_LCD is passed down so that the function can mark parts of
+ the symbol name as ignored for completion matching purposes (e.g.,
+ to handle abi tags). */
+extern int strncmp_iw_with_mode
+ (const char *string1, const char *string2, size_t string2_len,
+ strncmp_iw_mode mode, enum language language,
+ completion_match_for_lcd *match_for_lcd = NULL);
+
+/* Do a strncmp() type operation on STRING1 and STRING2, ignoring any
+ differences in whitespace. STRING2_LEN is STRING2's length.
+ Returns 0 if STRING1 matches STRING2_LEN characters of STRING2,
+ non-zero otherwise (slightly different than strncmp()'s range of
+ return values). Note: passes language_minimal to
+ strncmp_iw_with_mode, and should therefore be avoided if a more
+ suitable language is available. */
+extern int strncmp_iw (const char *string1, const char *string2,
+ size_t string2_len);
+
+/* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
+ differences in whitespace. Returns 0 if they match, non-zero if
+ they don't (slightly different than strcmp()'s range of return
+ values).
+
+ As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
+ This "feature" is useful when searching for matching C++ function
+ names (such as if the user types 'break FOO', where FOO is a
+ mangled C++ function).
+
+ Note: passes language_minimal to strncmp_iw_with_mode, and should
+ therefore be avoided if a more suitable language is available. */
+extern int strcmp_iw (const char *string1, const char *string2);
extern int strcmp_iw_ordered (const char *, const char *);
-extern int streq (const char *, const char *);
+/* Return true if the strings are equal. */
+
+extern bool streq (const char *, const char *);
+
+/* A variant of streq that is suitable for use as an htab
+ callback. */
-extern int subset_compare (char *, char *);
+extern int streq_hash (const void *, const void *);
-ULONGEST strtoulst (const char *num, const char **trailer, int base);
+extern int subset_compare (const char *, const char *);
int compare_positive_ints (const void *ap, const void *bp);
-int compare_strings (const void *ap, const void *bp);
-/* This is defined in *-hdep.c, e.g., posix-hdep.c. */
-extern char *safe_strerror (int);
+/* Compare C strings for std::sort. */
+
+static inline bool
+compare_cstrings (const char *str1, const char *str2)
+{
+ return strcmp (str1, str2) < 0;
+}
/* A wrapper for bfd_errmsg to produce a more helpful error message
in the case of bfd_error_file_ambiguously recognized.
/* Reset the prompt_for_continue clock. */
void reset_prompt_for_continue_wait_time (void);
/* Return the time spent in prompt_for_continue. */
-struct timeval get_prompt_for_continue_wait_time (void);
+std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
\f
/* Parsing utilites. */
-extern int parse_pid_to_attach (char *args);
+extern int parse_pid_to_attach (const char *args);
-extern int parse_escape (struct gdbarch *, char **);
+extern int parse_escape (struct gdbarch *, const char **);
-char **gdb_buildargv (const char *);
-\f
-/* Cleanup utilities. */
+/* A wrapper for an array of char* that was allocated in the way that
+ 'buildargv' does, and should be freed with 'freeargv'. */
-extern struct cleanup *make_cleanup_freeargv (char **);
+class gdb_argv
+{
+public:
-struct dyn_string;
-extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
+ /* A constructor that initializes to NULL. */
-struct ui_file;
-extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
+ gdb_argv ()
+ : m_argv (NULL)
+ {
+ }
-struct ui_out;
-extern struct cleanup *
- make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
+ /* A constructor that calls buildargv on STR. STR may be NULL, in
+ which case this object is initialized with a NULL array. If
+ buildargv fails due to out-of-memory, call malloc_failure.
+ Therefore, the value is guaranteed to be non-NULL, unless the
+ parameter itself is NULL. */
-struct section_addr_info;
-extern struct cleanup *(make_cleanup_free_section_addr_info
- (struct section_addr_info *));
+ explicit gdb_argv (const char *str)
+ : m_argv (NULL)
+ {
+ reset (str);
+ }
-extern struct cleanup *make_cleanup_close (int fd);
+ /* A constructor that takes ownership of an existing array. */
-extern struct cleanup *make_cleanup_fclose (FILE *file);
+ explicit gdb_argv (char **array)
+ : m_argv (array)
+ {
+ }
-extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
+ gdb_argv (const gdb_argv &) = delete;
+ gdb_argv &operator= (const gdb_argv &) = delete;
-struct obstack;
-extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
+ ~gdb_argv ()
+ {
+ freeargv (m_argv);
+ }
-extern struct cleanup *make_cleanup_restore_integer (int *variable);
-extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
+ /* Call buildargv on STR, storing the result in this object. Any
+ previous state is freed. STR may be NULL, in which case this
+ object is reset with a NULL array. If buildargv fails due to
+ out-of-memory, call malloc_failure. Therefore, the value is
+ guaranteed to be non-NULL, unless the parameter itself is
+ NULL. */
-struct target_ops;
-extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
+ void reset (const char *str);
-extern struct cleanup *
- make_cleanup_restore_ui_file (struct ui_file **variable);
+ /* Return the underlying array. */
-extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
-extern struct cleanup *make_cleanup_value_free (struct value *);
+ char **get ()
+ {
+ return m_argv;
+ }
+
+ /* Return the underlying array, transferring ownership to the
+ caller. */
+
+ char **release ()
+ {
+ char **result = m_argv;
+ m_argv = NULL;
+ return result;
+ }
+
+ /* Return the number of items in the array. */
+
+ int count () const
+ {
+ return countargv (m_argv);
+ }
+
+ /* Index into the array. */
+
+ char *operator[] (int arg)
+ {
+ gdb_assert (m_argv != NULL);
+ return m_argv[arg];
+ }
+
+ /* The iterator type. */
+
+ typedef char **iterator;
+
+ /* Return an iterator pointing to the start of the array. */
-struct so_list;
-extern struct cleanup *make_cleanup_free_so (struct so_list *so);
+ iterator begin ()
+ {
+ return m_argv;
+ }
-extern struct cleanup *make_cleanup_restore_current_language (void);
+ /* Return an iterator pointing to the end of the array. */
-extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
+ iterator end ()
+ {
+ return m_argv + count ();
+ }
+
+ bool operator!= (std::nullptr_t)
+ {
+ return m_argv != NULL;
+ }
+
+ bool operator== (std::nullptr_t)
+ {
+ return m_argv == NULL;
+ }
+
+private:
+
+ /* The wrapped array. */
+
+ char **m_argv;
+};
+
+\f
+/* Cleanup utilities. */
+
+/* For make_cleanup_close see common/filestuff.h. */
+
+extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
+
+/* A deleter for a hash table. */
+struct htab_deleter
+{
+ void operator() (htab *ptr) const
+ {
+ htab_delete (ptr);
+ }
+};
+
+/* A unique_ptr wrapper for htab_t. */
+typedef std::unique_ptr<htab, htab_deleter> htab_up;
extern void free_current_contents (void *);
extern void init_page_info (void);
-extern struct cleanup *make_cleanup_restore_page_info (void);
-extern struct cleanup *
- set_batch_flag_and_make_cleanup_restore_page_info (void);
+/* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
+ Restore when destroyed. */
+
+struct set_batch_flag_and_restore_page_info
+{
+public:
+
+ set_batch_flag_and_restore_page_info ();
+ ~set_batch_flag_and_restore_page_info ();
+
+ DISABLE_COPY_AND_ASSIGN (set_batch_flag_and_restore_page_info);
+
+private:
+
+ /* Note that this doesn't use scoped_restore, because it's important
+ to control the ordering of operations in the destruction, and it
+ was simpler to avoid introducing a new ad hoc class. */
+ unsigned m_save_lines_per_page;
+ unsigned m_save_chars_per_line;
+ int m_save_batch_flag;
+};
extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
\f
/* Path utilities. */
-extern char *gdb_realpath (const char *);
-
extern int gdb_filename_fnmatch (const char *pattern, const char *string,
int flags);
extern void substitute_path_component (char **stringp, const char *from,
const char *to);
-char *ldirname (const char *filename);
+std::string ldirname (const char *filename);
+
+extern int count_path_elements (const char *path);
+
+extern const char *strip_leading_path_elements (const char *path, int n);
\f
/* GDB output, ui_file utilities. */
extern void begin_line (void);
-extern void wrap_here (char *);
+extern void wrap_here (const char *);
extern void reinitialize_more_filter (void);
-/* Global ui_file streams. These are all defined in main.c. */
+extern int pagination_enabled;
+
+extern struct ui_file **current_ui_gdb_stdout_ptr (void);
+extern struct ui_file **current_ui_gdb_stdin_ptr (void);
+extern struct ui_file **current_ui_gdb_stderr_ptr (void);
+extern struct ui_file **current_ui_gdb_stdlog_ptr (void);
+
+/* The current top level's ui_file streams. */
+
/* Normal results */
-extern struct ui_file *gdb_stdout;
+#define gdb_stdout (*current_ui_gdb_stdout_ptr ())
/* Input stream */
-extern struct ui_file *gdb_stdin;
+#define gdb_stdin (*current_ui_gdb_stdin_ptr ())
/* Serious error notifications */
-extern struct ui_file *gdb_stderr;
+#define gdb_stderr (*current_ui_gdb_stderr_ptr ())
/* Log/debug/trace messages that should bypass normal stdout/stderr
filtering. For moment, always call this stream using
*_unfiltered. In the very near future that restriction shall be
removed - either call shall be unfiltered. (cagney 1999-06-13). */
-extern struct ui_file *gdb_stdlog;
+#define gdb_stdlog (*current_ui_gdb_stdlog_ptr ())
+
+/* Truly global ui_file streams. These are all defined in main.c. */
+
/* Target output that should bypass normal stdout/stderr filtering.
For moment, always call this stream using *_unfiltered. In the
very near future that restriction shall be removed - either call
extern struct ui_file *gdb_stdtargerr;
extern struct ui_file *gdb_stdtargin;
+/* Set the screen dimensions to WIDTH and HEIGHT. */
+
+extern void set_screen_width_and_height (int width, int height);
+
/* More generic printf like operations. Filtered versions may return
non-locally on error. */
extern void fputstrn_filtered (const char *str, int n, int quotr,
struct ui_file * stream);
+typedef int (*do_fputc_ftype) (int c, ui_file *stream);
+
extern void fputstrn_unfiltered (const char *str, int n, int quotr,
+ do_fputc_ftype do_fputc,
struct ui_file * stream);
+/* Return nonzero if filtered printing is initialized. */
+extern int filtered_printing_initialized (void);
+
/* Display the host ADDR on STREAM formatted as ``0x%x''. */
-extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
+extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
-extern const char *host_address_to_string (const void *addr);
+/* Wrapper that avoids adding a pointless cast to all callers. */
+#define gdb_print_host_address(ADDR, STREAM) \
+ gdb_print_host_address_1 ((const void *) ADDR, STREAM)
+
+/* Return the address only having significant bits. */
+extern CORE_ADDR address_significant (gdbarch *gdbarch, CORE_ADDR addr);
/* Convert CORE_ADDR to string in platform-specific manner.
This is usually formatted similar to 0x%lx. */
extern hashval_t core_addr_hash (const void *ap);
extern int core_addr_eq (const void *ap, const void *bp);
-/* %d for LONGEST */
-extern char *plongest (LONGEST l);
-/* %u for ULONGEST */
-extern char *pulongest (ULONGEST l);
-
-extern char *phex (ULONGEST l, int sizeof_l);
-extern char *phex_nz (ULONGEST l, int sizeof_l);
-extern char *int_string (LONGEST, int, int, int, int);
-
-/* Convert a CORE_ADDR into a HEX string with leading zeros.
- The output from core_addr_to_string() can be passed direct to
- string_to_core_addr(). */
-extern const char *core_addr_to_string (const CORE_ADDR addr);
-extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
extern CORE_ADDR string_to_core_addr (const char *my_string);
-/* Return a string that contains a number formatted as a hex
- string. */
-extern char *hex_string (LONGEST);
-extern char *hex_string_custom (LONGEST, int);
-
extern void fprintf_symbol_filtered (struct ui_file *, const char *,
enum language, int);
extern void throw_perror_with_name (enum errors errcode, const char *string)
ATTRIBUTE_NORETURN;
-extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
+
+extern void perror_warning_with_name (const char *string);
extern void print_sys_errmsg (const char *, int);
\f
extern void (*deprecated_error_begin_hook) (void);
-/* Message to be printed before the error message, when an error occurs. */
-
-extern char *error_pre_print;
-
-/* Message to be printed before the error message, when an error occurs. */
-
-extern char *quit_pre_print;
-
/* Message to be printed before the warning message, when a warning occurs. */
-extern char *warning_pre_print;
-
-extern void verror (const char *fmt, va_list ap)
- ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
+extern const char *warning_pre_print;
-extern void error (const char *fmt, ...)
- ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
+extern void error_stream (const string_file &) ATTRIBUTE_NORETURN;
-extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
-
-extern void vfatal (const char *fmt, va_list ap)
- ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
-
-extern void fatal (const char *fmt, ...)
- ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
-
-extern void internal_verror (const char *file, int line, const char *,
- va_list ap)
- ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
-
-extern void internal_vwarning (const char *file, int line,
+extern void demangler_vwarning (const char *file, int line,
const char *, va_list ap)
ATTRIBUTE_PRINTF (3, 0);
-extern void internal_warning (const char *file, int line,
+extern void demangler_warning (const char *file, int line,
const char *, ...) ATTRIBUTE_PRINTF (3, 4);
-extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
-
-extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
\f
/* Misc. utilities. */
extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
#endif
-extern int producer_is_gcc_ge_4 (const char *producer);
-
extern int myread (int, char *, int);
-/* Ensure that V is aligned to an N byte boundary (B's assumed to be a
- power of 2). Round up/down when necessary. Examples of correct
- use include:
-
- addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
- write_memory (addr, value, len);
- addr += len;
-
- and:
+/* Resource limits used by getrlimit and setrlimit. */
- sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
- write_memory (sp, value, len);
+enum resource_limit_kind
+ {
+ LIMIT_CUR,
+ LIMIT_MAX
+ };
- Note that uses such as:
+/* Check whether GDB will be able to dump core using the dump_core
+ function. Returns zero if GDB cannot or should not dump core.
+ If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
+ If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
- write_memory (addr, value, len);
- addr += align_up (len, 8);
+extern int can_dump_core (enum resource_limit_kind limit_kind);
- and:
+/* Print a warning that we cannot dump core. */
- sp -= align_up (len, 8);
- write_memory (sp, value, len);
+extern void warn_cant_dump_core (const char *reason);
- are typically not correct as they don't ensure that the address (SP
- or ADDR) is correctly aligned (relying on previous alignment to
- keep things right). This is also why the methods are called
- "align_..." instead of "round_..." as the latter reads better with
- this incorrect coding style. */
+/* Dump core trying to increase the core soft limit to hard limit
+ first. */
-extern ULONGEST align_up (ULONGEST v, int n);
-extern ULONGEST align_down (ULONGEST v, int n);
+extern void dump_core (void);
-/* Sign extend VALUE. BIT is the (1-based) index of the bit in VALUE
- to sign-extend. */
+/* Return the hex string form of LENGTH bytes of DATA.
+ Space for the result is malloc'd, caller must free. */
-extern LONGEST gdb_sign_extend (LONGEST value, int bit);
+extern char *make_hex_string (const gdb_byte *data, size_t length);
#endif /* UTILS_H */
projects / thirdparty / binutils-gdb.git / blobdiff