/* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
for now. */
/* I/O, string, cleanup, and other random utilities for GDB.
- Copyright (C) 1986-2017 Free Software Foundation, Inc.
+ Copyright (C) 1986-2020 Free Software Foundation, Inc.
This file is part of GDB.
#define UTILS_H
#include "exceptions.h"
-#include "common/scoped_restore.h"
+#include "gdbsupport/scoped_restore.h"
#include <chrono>
-extern void initialize_utils (void);
+#ifdef HAVE_LIBXXHASH
+#include <xxhash.h>
+#endif
+
+struct completion_match_for_lcd;
+class compiled_regex;
/* String utilities. */
-extern int sevenbit_strings;
+extern bool sevenbit_strings;
/* Modes of operation for strncmp_iw_with_mode. */
/* 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. */
-extern int strncmp_iw_with_mode (const char *string1,
- const char *string2,
- size_t string2_len,
- strncmp_iw_mode mode,
- enum language language);
+ 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.
extern int strcmp_iw_ordered (const char *, const char *);
-extern int streq (const char *, const char *);
+/* Return true if the strings are equal. */
-extern int subset_compare (const char *, const char *);
+extern bool streq (const char *, const char *);
+
+/* A variant of streq that is suitable for use as an htab
+ callback. */
-int compare_positive_ints (const void *ap, const void *bp);
-int compare_strings (const void *ap, const void *bp);
+extern int streq_hash (const void *, const void *);
+
+extern int subset_compare (const char *, const char *);
/* Compare C strings for std::sort. */
MATCHING, if non-NULL, is the corresponding argument to
bfd_check_format_matches, and will be freed. */
-extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
+extern std::string gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
/* Reset the prompt_for_continue clock. */
void reset_prompt_for_continue_wait_time (void);
/* Return the time spent in prompt_for_continue. */
std::chrono::steady_clock::duration get_prompt_for_continue_wait_time ();
\f
-/* Parsing utilites. */
+/* Parsing utilities. */
extern int parse_pid_to_attach (const char *args);
}
/* 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. */
+ which case this object is initialized with a NULL array. */
explicit gdb_argv (const char *str)
: m_argv (NULL)
/* Return the underlying array, transferring ownership to the
caller. */
- char **release ()
+ ATTRIBUTE_UNUSED_RESULT char **release ()
{
char **result = m_argv;
m_argv = NULL;
\f
/* Cleanup utilities. */
-struct section_addr_info;
-extern struct cleanup *make_cleanup_free_section_addr_info
- (struct section_addr_info *);
-
-/* For make_cleanup_close see common/filestuff.h. */
-
-struct target_ops;
-extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
-
-extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
-
/* A deleter for a hash table. */
struct htab_deleter
{
/* 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);
/* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
int m_save_batch_flag;
};
-extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
\f
/* Path utilities. */
-extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *);
-
-extern gdb::unique_xmalloc_ptr<char> gdb_realpath_keepfile (const char *);
-
-extern gdb::unique_xmalloc_ptr<char> gdb_abspath (const char *);
-
extern int gdb_filename_fnmatch (const char *pattern, const char *string,
int flags);
extern void reinitialize_more_filter (void);
-extern int pagination_enabled;
+extern bool 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);
+/* Flush STREAM. This is a wrapper for ui_file_flush that also
+ flushes any output pending from uses of the *_filtered output
+ functions; that output is kept in a special buffer so that
+ pagination and styling are handled properly. */
+extern void gdb_flush (struct ui_file *);
+
/* The current top level's ui_file streams. */
/* Normal results */
extern void set_screen_width_and_height (int width, int height);
/* More generic printf like operations. Filtered versions may return
- non-locally on error. */
+ non-locally on error. As an extension over plain printf, these
+ support some GDB-specific format specifiers. Particularly useful
+ here are the styling formatters: '%p[', '%p]' and '%ps'. See
+ ui_out::message for details. */
extern void fputs_filtered (const char *, struct ui_file *);
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);
+/* Like fprintf_filtered, but styles the output according to STYLE,
+ when appropriate. */
+
+extern void fprintf_styled (struct ui_file *stream,
+ const ui_file_style &style,
+ const char *fmt,
+ ...)
+ ATTRIBUTE_PRINTF (3, 4);
+
+extern void vfprintf_styled (struct ui_file *stream,
+ const ui_file_style &style,
+ const char *fmt,
+ va_list args)
+ ATTRIBUTE_PRINTF (3, 0);
+
+/* Like vfprintf_styled, but do not process gdb-specific format
+ specifiers. */
+extern void vfprintf_styled_no_gdbfmt (struct ui_file *stream,
+ const ui_file_style &style,
+ bool filter,
+ const char *fmt, va_list args)
+ ATTRIBUTE_PRINTF (4, 0);
+
+/* Like fputs_filtered, but styles the output according to STYLE, when
+ appropriate. */
+
+extern void fputs_styled (const char *linebuffer,
+ const ui_file_style &style,
+ struct ui_file *stream);
+
+/* Unfiltered variant of fputs_styled. */
+
+extern void fputs_styled_unfiltered (const char *linebuffer,
+ const ui_file_style &style,
+ struct ui_file *stream);
+
+/* Like fputs_styled, but uses highlight_style to highlight the
+ parts of STR that match HIGHLIGHT. */
+
+extern void fputs_highlighted (const char *str, const compiled_regex &highlight,
+ struct ui_file *stream);
+
+/* Reset the terminal style to the default, if needed. */
+
+extern void reset_terminal_style (struct ui_file *stream);
+
/* Display the host ADDR on STREAM formatted as ``0x%x''. */
extern void gdb_print_host_address_1 (const void *addr, struct ui_file *stream);
#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 const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
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:
-
- sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
- write_memory (sp, value, len);
-
- Note that uses such as:
-
- write_memory (addr, value, len);
- addr += align_up (len, 8);
-
- and:
-
- sp -= align_up (len, 8);
- write_memory (sp, value, len);
-
- 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. */
-
-extern ULONGEST align_up (ULONGEST v, int n);
-extern ULONGEST align_down (ULONGEST v, int n);
-
/* Resource limits used by getrlimit and setrlimit. */
enum resource_limit_kind
extern void dump_core (void);
-/* Return the hex string form of LENGTH bytes of DATA.
- Space for the result is malloc'd, caller must free. */
+/* Copy NBITS bits from SOURCE to DEST starting at the given bit
+ offsets. Use the bit order as specified by BITS_BIG_ENDIAN.
+ Source and destination buffers must not overlap. */
-extern char *make_hex_string (const gdb_byte *data, size_t length);
+extern void copy_bitwise (gdb_byte *dest, ULONGEST dest_offset,
+ const gdb_byte *source, ULONGEST source_offset,
+ ULONGEST nbits, int bits_big_endian);
+
+/* A fast hashing function. This can be used to hash data in a fast way
+ when the length is known. If no fast hashing library is available, falls
+ back to iterative_hash from libiberty. START_VALUE can be set to
+ continue hashing from a previous value. */
+
+static inline unsigned int
+fast_hash (const void *ptr, size_t len, unsigned int start_value = 0)
+{
+#ifdef HAVE_LIBXXHASH
+ return XXH64 (ptr, len, start_value);
+#else
+ return iterative_hash (ptr, len, start_value);
+#endif
+}
#endif /* UTILS_H */
projects / deliverable / binutils-gdb.git / blobdiff