gdb/rust-lang.h

   1 /* Rust language support definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2016-2023 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 char *get_digit_separator () const override
  75   { return "_"; }
  76
  77   /* See language.h.  */
  78
  79   const std::vector<const char *> &filename_extensions () const override
  80   {
  81     static const std::vector<const char *> extensions = { ".rs" };
  82     return extensions;
  83   }
  84
  85   /* See language.h.  */
  86
  87   void language_arch_info (struct gdbarch *gdbarch,
  88                            struct language_arch_info *lai) const override;
  89
  90   /* See language.h.  */
  91
  92   bool sniff_from_mangled_name
  93        (const char *mangled, gdb::unique_xmalloc_ptr<char> *demangled)
  94        const override
  95   {
  96     demangled->reset (rust_demangle (mangled, 0));
  97     return *demangled != NULL;
  98   }
  99
 100   /* See language.h.  */
 101
 102   gdb::unique_xmalloc_ptr<char> demangle_symbol (const char *mangled,
 103                                                  int options) const override
 104   {
 105     return gdb::unique_xmalloc_ptr<char> (rust_demangle (mangled, options));
 106   }
 107
 108   /* See language.h.  */
 109
 110   bool can_print_type_offsets () const override
 111   {
 112     return true;
 113   }
 114
 115   /* See language.h.  */
 116
 117   void print_type (struct type *type, const char *varstring,
 118                    struct ui_file *stream, int show, int level,
 119                    const struct type_print_options *flags) const override;
 120
 121   /* See language.h.  */
 122
 123   gdb::unique_xmalloc_ptr<char> watch_location_expression
 124         (struct type *type, CORE_ADDR addr) const override
 125   {
 126     type = check_typedef (check_typedef (type)->target_type ());
 127     std::string name = type_to_string (type);
 128     return xstrprintf ("*(%s as *mut %s)", core_addr_to_string (addr),
 129                        name.c_str ());
 130   }
 131
 132   /* See language.h.  */
 133
 134   void value_print_inner
 135         (struct value *val, struct ui_file *stream, int recurse,
 136          const struct value_print_options *options) const override;
 137
 138   /* See language.h.  */
 139
 140   void value_print (struct value *val, struct ui_file *stream,
 141                     const struct value_print_options *options) const override;
 142
 143   /* See language.h.  */
 144
 145   struct block_symbol lookup_symbol_nonlocal
 146         (const char *name, const struct block *block,
 147          const domain_enum domain) const override;
 148
 149   /* See language.h.  */
 150
 151   int parser (struct parser_state *ps) const override;
 152
 153   /* See language.h.  */
 154
 155   void emitchar (int ch, struct type *chtype,
 156                  struct ui_file *stream, int quoter) const override;
 157
 158   /* See language.h.  */
 159
 160   void printchar (int ch, struct type *chtype,
 161                   struct ui_file *stream) const override
 162   {
 163     gdb_puts ("'", stream);
 164     emitchar (ch, chtype, stream, '\'');
 165     gdb_puts ("'", stream);
 166   }
 167
 168   /* See language.h.  */
 169
 170   void printstr (struct ui_file *stream, struct type *elttype,
 171                  const gdb_byte *string, unsigned int length,
 172                  const char *encoding, int force_ellipses,
 173                  const struct value_print_options *options) const override;
 174
 175   /* See language.h.  */
 176
 177   void print_typedef (struct type *type, struct symbol *new_symbol,
 178                       struct ui_file *stream) const override
 179   {
 180     type = check_typedef (type);
 181     gdb_printf (stream, "type %s = ", new_symbol->print_name ());
 182     type_print (type, "", stream, 0);
 183     gdb_printf (stream, ";");
 184   }
 185
 186   /* See language.h.  */
 187
 188   bool is_string_type_p (struct type *type) const override;
 189
 190   /* See language.h.  */
 191
 192   bool range_checking_on_by_default () const override
 193   { return true; }
 194
 195 private:
 196
 197   /* Helper for value_print_inner, arguments are as for that function.
 198      Prints structs and untagged unions.  */
 199
 200   void val_print_struct (struct value *val, struct ui_file *stream,
 201                          int recurse,
 202                          const struct value_print_options *options) const;
 203
 204   /* Helper for value_print_inner, arguments are as for that function.
 205      Prints discriminated unions (Rust enums).  */
 206
 207   void print_enum (struct value *val, struct ui_file *stream, int recurse,
 208                    const struct value_print_options *options) const;
 209 };
 210
 211 #endif /* RUST_LANG_H */