gdb/rust-lang.h

   1 /* Rust language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2016-2021 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef RUST_LANG_H
  21 #define RUST_LANG_H
  22
  23 #include "demangle.h"
  24 #include "language.h"
  25 #include "value.h"
  26 #include "c-lang.h"
  27
  28 struct parser_state;
  29 struct type;
  30
  31 /* Return true if TYPE is a tuple type; otherwise false.  */
  32 extern bool rust_tuple_type_p (struct type *type);
  33
  34 /* Return true if TYPE is a tuple struct type; otherwise false.  */
  35 extern bool rust_tuple_struct_type_p (struct type *type);
  36
  37 /* Given a block, find the name of the block's crate. Returns an empty
  38    stringif no crate name can be found.  */
  39 extern std::string rust_crate_for_block (const struct block *block);
  40
  41 /* Returns the last segment of a Rust path like foo::bar::baz.  Will
  42    not handle cases where the last segment contains generics.  */
  43
  44 extern const char *rust_last_path_segment (const char *path);
  45
  46 /* Create a new slice type.  NAME is the name of the type.  ELT_TYPE
  47    is the type of the elements of the slice.  USIZE_TYPE is the Rust
  48    "usize" type to use.  The new type is allocated whereever ELT_TYPE
  49    is allocated.  */
  50 extern struct type *rust_slice_type (const char *name, struct type *elt_type,
  51                                      struct type *usize_type);
  52
  53 /* Class representing the Rust language.  */
  54
  55 class rust_language : public language_defn
  56 {
  57 public:
  58   rust_language ()
  59     : language_defn (language_rust)
  60   { /* Nothing.  */ }
  61
  62   /* See language.h.  */
  63
  64   const char *name () const override
  65   { return "rust"; }
  66
  67   /* See language.h.  */
  68
  69   const char *natural_name () const override
  70   { return "Rust"; }
  71
  72   /* See language.h.  */
  73
  74   const std::vector<const char *> &filename_extensions () const override
  75   {
  76     static const std::vector<const char *> extensions = { ".rs" };
  77     return extensions;
  78   }
  79
  80   /* See language.h.  */
  81
  82   void language_arch_info (struct gdbarch *gdbarch,
  83                            struct language_arch_info *lai) const override;
  84
  85   /* See language.h.  */
  86
  87   bool sniff_from_mangled_name
  88        (const char *mangled, gdb::unique_xmalloc_ptr<char> *demangled)
  89        const override
  90   {
  91     *demangled = gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
  92     return *demangled != NULL;
  93   }
  94
  95   /* See language.h.  */
  96
  97   gdb::unique_xmalloc_ptr<char> demangle_symbol (const char *mangled,
  98                                                  int options) const override
  99   {
 100     return gdb_demangle (mangled, options);
 101   }
 102
 103   /* See language.h.  */
 104
 105   void print_type (struct type *type, const char *varstring,
 106                    struct ui_file *stream, int show, int level,
 107                    const struct type_print_options *flags) const override;
 108
 109   /* See language.h.  */
 110
 111   gdb::unique_xmalloc_ptr<char> watch_location_expression
 112         (struct type *type, CORE_ADDR addr) const override
 113   {
 114     type = check_typedef (TYPE_TARGET_TYPE (check_typedef (type)));
 115     std::string name = type_to_string (type);
 116     return gdb::unique_xmalloc_ptr<char>
 117       (xstrprintf ("*(%s as *mut %s)", core_addr_to_string (addr),
 118                    name.c_str ()));
 119   }
 120
 121   /* See language.h.  */
 122
 123   void value_print_inner
 124         (struct value *val, struct ui_file *stream, int recurse,
 125          const struct value_print_options *options) const override;
 126
 127   /* See language.h.  */
 128
 129   struct block_symbol lookup_symbol_nonlocal
 130         (const char *name, const struct block *block,
 131          const domain_enum domain) const override
 132   {
 133     struct block_symbol result = {};
 134
 135     if (symbol_lookup_debug)
 136       {
 137         fprintf_unfiltered (gdb_stdlog,
 138                             "rust_lookup_symbol_non_local"
 139                             " (%s, %s (scope %s), %s)\n",
 140                             name, host_address_to_string (block),
 141                             block_scope (block), domain_name (domain));
 142       }
 143
 144     /* Look up bare names in the block's scope.  */
 145     std::string scopedname;
 146     if (name[cp_find_first_component (name)] == '\0')
 147       {
 148         const char *scope = block_scope (block);
 149
 150         if (scope[0] != '\0')
 151           {
 152             scopedname = std::string (scope) + "::" + name;
 153             name = scopedname.c_str ();
 154           }
 155         else
 156           name = NULL;
 157       }
 158
 159     if (name != NULL)
 160       {
 161         result = lookup_symbol_in_static_block (name, block, domain);
 162         if (result.symbol == NULL)
 163           result = lookup_global_symbol (name, block, domain);
 164       }
 165     return result;
 166   }
 167
 168   /* See language.h.  */
 169
 170   int parser (struct parser_state *ps) const override;
 171
 172   /* See language.h.  */
 173
 174   void emitchar (int ch, struct type *chtype,
 175                  struct ui_file *stream, int quoter) const override;
 176
 177   /* See language.h.  */
 178
 179   void printchar (int ch, struct type *chtype,
 180                   struct ui_file *stream) const override
 181   {
 182     fputs_filtered ("'", stream);
 183     emitchar (ch, chtype, stream, '\'');
 184     fputs_filtered ("'", stream);
 185   }
 186
 187   /* See language.h.  */
 188
 189   void printstr (struct ui_file *stream, struct type *elttype,
 190                  const gdb_byte *string, unsigned int length,
 191                  const char *encoding, int force_ellipses,
 192                  const struct value_print_options *options) const override;
 193
 194   /* See language.h.  */
 195
 196   void print_typedef (struct type *type, struct symbol *new_symbol,
 197                       struct ui_file *stream) const override
 198   {
 199     type = check_typedef (type);
 200     fprintf_filtered (stream, "type %s = ", new_symbol->print_name ());
 201     type_print (type, "", stream, 0);
 202     fprintf_filtered (stream, ";");
 203   }
 204
 205   /* See language.h.  */
 206
 207   bool is_string_type_p (struct type *type) const override;
 208
 209   /* See language.h.  */
 210
 211   bool range_checking_on_by_default () const override
 212   { return true; }
 213
 214 private:
 215
 216   /* Helper for value_print_inner, arguments are as for that function.
 217      Prints structs and untagged unions.  */
 218
 219   void val_print_struct (struct value *val, struct ui_file *stream,
 220                          int recurse,
 221                          const struct value_print_options *options) const;
 222
 223   /* Helper for value_print_inner, arguments are as for that function.
 224      Prints discriminated unions (Rust enums).  */
 225
 226   void print_enum (struct value *val, struct ui_file *stream, int recurse,
 227                    const struct value_print_options *options) const;
 228 };
 229
 230 #endif /* RUST_LANG_H */