Per-language symbol name hashing algorithm

[deliverable/binutils-gdb.git] / gdb / language.h

diff --git a/gdb/language.h b/gdb/language.h
index 5e4fe4c6e03b109dee3698c1e170bc3783d801be..64ccfccdab64f2a61c8b0b930ad014e2e8f1661a 100644 (file)
--- a/gdb/language.h
+++ b/gdb/language.h
@@ -1,6 +1,6 @@
 /* Source-language-related definitions for GDB.
 
 /* Source-language-related definitions for GDB.
 

-   Copyright (C) 1991-2016 Free Software Foundation, Inc.
+   Copyright (C) 1991-2017 Free Software Foundation, Inc.

 
    Contributed by the Department of Computer Science at the State University
    of New York at Buffalo.
 
    Contributed by the Department of Computer Science at the State University
    of New York at Buffalo.


@@ -24,6 +24,7 @@
 #define LANGUAGE_H 1
 
 #include "symtab.h"
 #define LANGUAGE_H 1
 
 #include "symtab.h"

+#include "common/function-view.h"

 
 /* Forward decls for prototypes.  */
 struct value;
 
 /* Forward decls for prototypes.  */
 struct value;


@@ -133,7 +134,7 @@ struct language_arch_info
    transformed for lookup.  */
 
 typedef int (*symbol_name_cmp_ftype) (const char *symbol_search_name,
    transformed for lookup.  */
 
 typedef int (*symbol_name_cmp_ftype) (const char *symbol_search_name,

-                                         const char *lookup_name);
+                                     const char *lookup_name);

 
 /* Structure tying together assorted information about a language.  */
 
 
 /* Structure tying together assorted information about a language.  */
 


@@ -182,7 +183,7 @@ struct language_defn
 
     /* Parser error function.  */
 
 
     /* Parser error function.  */
 

-    void (*la_error) (char *);
+    void (*la_error) (const char *);

 
     /* Given an expression *EXPP created by prefixifying the result of
        la_parser, perform any remaining processing necessary to complete
 
     /* Given an expression *EXPP created by prefixifying the result of
        la_parser, perform any remaining processing necessary to complete


@@ -270,7 +271,7 @@ struct language_defn
     /* If this is non-NULL, specifies the name that of the implicit
        local variable that refers to the current object instance.  */
 
     /* If this is non-NULL, specifies the name that of the implicit
        local variable that refers to the current object instance.  */
 

-    char *la_name_of_this;
+    const char *la_name_of_this;

 
     /* This is a function that lookup_symbol will call when it gets to
        the part of symbol lookup where C looks up static and global
 
     /* This is a function that lookup_symbol will call when it gets to
        the part of symbol lookup where C looks up static and global


@@ -320,16 +321,19 @@ struct language_defn
     char string_lower_bound;
 
     /* The list of characters forming word boundaries.  */
     char string_lower_bound;
 
     /* The list of characters forming word boundaries.  */

-    char *(*la_word_break_characters) (void);
+    const char *(*la_word_break_characters) (void);

 
 

-    /* Should return a vector of all symbols which are possible
+    /* Add to the completion tracker all symbols which are possible

        completions for TEXT.  WORD is the entire command on which the
        completion is being made.  If CODE is TYPE_CODE_UNDEF, then all
        symbols should be examined; otherwise, only STRUCT_DOMAIN
        symbols whose type has a code of CODE should be matched.  */
        completions for TEXT.  WORD is the entire command on which the
        completion is being made.  If CODE is TYPE_CODE_UNDEF, then all
        symbols should be examined; otherwise, only STRUCT_DOMAIN
        symbols whose type has a code of CODE should be matched.  */

-    VEC (char_ptr) *(*la_make_symbol_completion_list) (const char *text,
-                                                      const char *word,
-                                                      enum type_code code);
+    void (*la_collect_symbol_completion_matches)
+      (completion_tracker &tracker,
+       complete_symbol_mode mode,
+       const char *text,
+       const char *word,
+       enum type_code code);

 
     /* The per-architecture (OS/ABI) language information.  */
     void (*la_language_arch_info) (struct gdbarch *,
 
     /* The per-architecture (OS/ABI) language information.  */
     void (*la_language_arch_info) (struct gdbarch *,


@@ -357,6 +361,12 @@ struct language_defn
     void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length,
                           struct type **chartype, const char **charset);
 
     void (*la_get_string) (struct value *value, gdb_byte **buffer, int *length,
                           struct type **chartype, const char **charset);
 

+    /* Return an expression that can be used for a location
+       watchpoint.  TYPE is a pointer type that points to the memory
+       to watch, and ADDR is the address of the watched memory.  */
+    gdb::unique_xmalloc_ptr<char> (*la_watch_location_expression)
+         (struct type *type, CORE_ADDR addr);
+

     /* Return a pointer to the function that should be used to match
        a symbol name against LOOKUP_NAME. This is mostly for languages
        such as Ada where the matching algorithm depends on LOOKUP_NAME.
     /* Return a pointer to the function that should be used to match
        a symbol name against LOOKUP_NAME. This is mostly for languages
        such as Ada where the matching algorithm depends on LOOKUP_NAME.


@@ -372,18 +382,20 @@ struct language_defn
        The caller is responsible for iterating up through superblocks
        if desired.
 
        The caller is responsible for iterating up through superblocks
        if desired.
 

-       For each one, call CALLBACK with the symbol and the DATA
-       argument.  If CALLBACK returns zero, the iteration ends at that
-       point.
+       For each one, call CALLBACK with the symbol.  If CALLBACK
+       returns false, the iteration ends at that point.

 
        This field may not be NULL.  If the language does not need any
        special processing here, 'iterate_over_symbols' should be
        used as the definition.  */
 
        This field may not be NULL.  If the language does not need any
        special processing here, 'iterate_over_symbols' should be
        used as the definition.  */

-    void (*la_iterate_over_symbols) (const struct block *block,
-                                    const char *name,
-                                    domain_enum domain,
-                                    symbol_found_callback_ftype *callback,
-                                    void *data);
+    void (*la_iterate_over_symbols)
+      (const struct block *block, const char *name, domain_enum domain,
+       gdb::function_view<symbol_found_callback_ftype> callback);
+
+    /* Hash the given symbol search name.  Use
+       default_search_name_hash if no special treatment is
+       required.  */
+    unsigned int (*la_search_name_hash) (const char *name);

 
     /* Various operations on varobj.  */
     const struct lang_varobj_ops *la_varobj_ops;
 
     /* Various operations on varobj.  */
     const struct lang_varobj_ops *la_varobj_ops;


@@ -527,9 +539,8 @@ extern enum language set_language (enum language);
 #define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \
   (current_language->la_print_array_index(index_value, stream, options))
 
 #define LA_PRINT_ARRAY_INDEX(index_value, stream, options) \
   (current_language->la_print_array_index(index_value, stream, options))
 

-#define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK, DATA) \
-  (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK, \
-                                             DATA))
+#define LA_ITERATE_OVER_SYMBOLS(BLOCK, NAME, DOMAIN, CALLBACK) \
+  (current_language->la_iterate_over_symbols (BLOCK, NAME, DOMAIN, CALLBACK))

 
 /* Test a character to decide whether it can be printed in literal form
    or needs to be printed in another representation.  For example,
 
 /* Test a character to decide whether it can be printed in literal form
    or needs to be printed in another representation.  For example,


@@ -556,16 +567,12 @@ extern int value_true (struct value *);
 
 /* Misc:  The string representing a particular enum language.  */
 
 
 /* Misc:  The string representing a particular enum language.  */
 

-extern enum language language_enum (char *str);
+extern enum language language_enum (const char *str);

 
 extern const struct language_defn *language_def (enum language);
 
 extern const char *language_str (enum language);
 
 
 extern const struct language_defn *language_def (enum language);
 
 extern const char *language_str (enum language);
 

-/* Add a language to the set known by GDB (at initialization time).  */
-
-extern void add_language (const struct language_defn *);
-

 /* Check for a language-specific trampoline.  */
 
 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);
 /* Check for a language-specific trampoline.  */
 
 extern CORE_ADDR skip_language_trampoline (struct frame_info *, CORE_ADDR pc);


@@ -586,7 +593,7 @@ extern char *language_class_name_from_physname (const struct language_defn *,
                                                const char *physname);
 
 /* Splitting strings into words.  */
                                                const char *physname);
 
 /* Splitting strings into words.  */

-extern char *default_word_break_characters (void);
+extern const char *default_word_break_characters (void);

 
 /* Print the index of an array element using the C99 syntax.  */
 extern void default_print_array_index (struct value *index_value,
 
 /* Print the index of an array element using the C99 syntax.  */
 extern void default_print_array_index (struct value *index_value,


@@ -609,7 +616,60 @@ void default_print_typedef (struct type *type, struct symbol *new_symbol,
 void default_get_string (struct value *value, gdb_byte **buffer, int *length,
                         struct type **char_type, const char **charset);
 
 void default_get_string (struct value *value, gdb_byte **buffer, int *length,
                         struct type **char_type, const char **charset);
 

+/* Default name hashing function.  */
+
+/* Produce an unsigned hash value from SEARCH_NAME that is consistent
+   with strcmp_iw, strcmp, and, at least on Ada symbols, wild_match.
+   That is, two identifiers equivalent according to any of those three
+   comparison operators hash to the same value.  */
+extern unsigned int default_search_name_hash (const char *search_name);
+

 void c_get_string (struct value *value, gdb_byte **buffer, int *length,
                   struct type **char_type, const char **charset);
 
 void c_get_string (struct value *value, gdb_byte **buffer, int *length,
                   struct type **char_type, const char **charset);
 

+/* The languages supported by GDB.  */
+
+extern const struct language_defn auto_language_defn;
+extern const struct language_defn unknown_language_defn;
+extern const struct language_defn minimal_language_defn;
+
+extern const struct language_defn ada_language_defn;
+extern const struct language_defn asm_language_defn;
+extern const struct language_defn c_language_defn;
+extern const struct language_defn cplus_language_defn;
+extern const struct language_defn d_language_defn;
+extern const struct language_defn f_language_defn;
+extern const struct language_defn go_language_defn;
+extern const struct language_defn m2_language_defn;
+extern const struct language_defn objc_language_defn;
+extern const struct language_defn opencl_language_defn;
+extern const struct language_defn pascal_language_defn;
+extern const struct language_defn rust_language_defn;
+
+/* Save the current language and restore it upon destruction.  */
+
+class scoped_restore_current_language
+{
+public:
+
+  explicit scoped_restore_current_language ()
+    : m_lang (current_language->la_language)
+  {
+  }
+
+  ~scoped_restore_current_language ()
+  {
+    set_language (m_lang);
+  }
+
+  scoped_restore_current_language (const scoped_restore_current_language &)
+      = delete;
+  scoped_restore_current_language &operator=
+      (const scoped_restore_current_language &) = delete;
+
+private:
+
+  enum language m_lang;
+};
+

 #endif /* defined (LANGUAGE_H) */
 #endif /* defined (LANGUAGE_H) */