gdb/cp-abi.c

   1 /* Generic code for supporting multiple C++ ABI's
   2
   3    Copyright (C) 2001, 2002, 2003, 2005, 2006 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 2 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, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #include "defs.h"
  23 #include "value.h"
  24 #include "cp-abi.h"
  25 #include "command.h"
  26 #include "gdbcmd.h"
  27 #include "ui-out.h"
  28
  29 #include "gdb_string.h"
  30
  31 static struct cp_abi_ops *find_cp_abi (const char *short_name);
  32
  33 static struct cp_abi_ops current_cp_abi = { "", NULL };
  34 static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
  35
  36 #define CP_ABI_MAX 8
  37 static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
  38 static int num_cp_abis = 0;
  39
  40 enum ctor_kinds
  41 is_constructor_name (const char *name)
  42 {
  43   if ((current_cp_abi.is_constructor_name) == NULL)
  44     error (_("ABI doesn't define required function is_constructor_name"));
  45   return (*current_cp_abi.is_constructor_name) (name);
  46 }
  47
  48 enum dtor_kinds
  49 is_destructor_name (const char *name)
  50 {
  51   if ((current_cp_abi.is_destructor_name) == NULL)
  52     error (_("ABI doesn't define required function is_destructor_name"));
  53   return (*current_cp_abi.is_destructor_name) (name);
  54 }
  55
  56 int
  57 is_vtable_name (const char *name)
  58 {
  59   if ((current_cp_abi.is_vtable_name) == NULL)
  60     error (_("ABI doesn't define required function is_vtable_name"));
  61   return (*current_cp_abi.is_vtable_name) (name);
  62 }
  63
  64 int
  65 is_operator_name (const char *name)
  66 {
  67   if ((current_cp_abi.is_operator_name) == NULL)
  68     error (_("ABI doesn't define required function is_operator_name"));
  69   return (*current_cp_abi.is_operator_name) (name);
  70 }
  71
  72 int
  73 baseclass_offset (struct type *type, int index, const bfd_byte *valaddr,
  74                   CORE_ADDR address)
  75 {
  76   if (current_cp_abi.baseclass_offset == NULL)
  77     error (_("ABI doesn't define required function baseclass_offset"));
  78   return (*current_cp_abi.baseclass_offset) (type, index, valaddr, address);
  79 }
  80
  81 struct value *
  82 value_virtual_fn_field (struct value **arg1p, struct fn_field *f, int j,
  83                         struct type *type, int offset)
  84 {
  85   if ((current_cp_abi.virtual_fn_field) == NULL)
  86     return NULL;
  87   return (*current_cp_abi.virtual_fn_field) (arg1p, f, j, type, offset);
  88 }
  89
  90 struct type *
  91 value_rtti_type (struct value *v, int *full, int *top, int *using_enc)
  92 {
  93   if ((current_cp_abi.rtti_type) == NULL)
  94     return NULL;
  95   return (*current_cp_abi.rtti_type) (v, full, top, using_enc);
  96 }
  97
  98 void
  99 cplus_print_method_ptr (const gdb_byte *contents, struct type *type,
 100                         struct ui_file *stream)
 101 {
 102   if (current_cp_abi.print_method_ptr == NULL)
 103     error (_("GDB does not support pointers to methods on this target"));
 104   (*current_cp_abi.print_method_ptr) (contents, type, stream);
 105 }
 106
 107 int
 108 cplus_method_ptr_size (void)
 109 {
 110   if (current_cp_abi.method_ptr_size == NULL)
 111     error (_("GDB does not support pointers to methods on this target"));
 112   return (*current_cp_abi.method_ptr_size) ();
 113 }
 114
 115 void
 116 cplus_make_method_ptr (gdb_byte *contents, CORE_ADDR value, int is_virtual)
 117 {
 118   if (current_cp_abi.make_method_ptr == NULL)
 119     error (_("GDB does not support pointers to methods on this target"));
 120   (*current_cp_abi.make_method_ptr) (contents, value, is_virtual);
 121 }
 122
 123 struct value *
 124 cplus_method_ptr_to_value (struct value **this_p, struct value *method_ptr)
 125 {
 126   if (current_cp_abi.method_ptr_to_value == NULL)
 127     error (_("GDB does not support pointers to methods on this target"));
 128   return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
 129 }
 130
 131 /* Set the current C++ ABI to SHORT_NAME.  */
 132
 133 static int
 134 switch_to_cp_abi (const char *short_name)
 135 {
 136   struct cp_abi_ops *abi;
 137
 138   abi = find_cp_abi (short_name);
 139   if (abi == NULL)
 140     return 0;
 141
 142   current_cp_abi = *abi;
 143   return 1;
 144 }
 145
 146 /* Add ABI to the list of supported C++ ABI's.  */
 147
 148 int
 149 register_cp_abi (struct cp_abi_ops *abi)
 150 {
 151   if (num_cp_abis == CP_ABI_MAX)
 152     internal_error (__FILE__, __LINE__,
 153                     _("Too many C++ ABIs, please increase CP_ABI_MAX in cp-abi.c"));
 154
 155   cp_abis[num_cp_abis++] = abi;
 156
 157   return 1;
 158 }
 159
 160 /* Set the ABI to use in "auto" mode to SHORT_NAME.  */
 161
 162 void
 163 set_cp_abi_as_auto_default (const char *short_name)
 164 {
 165   char *new_longname, *new_doc;
 166   struct cp_abi_ops *abi = find_cp_abi (short_name);
 167
 168   if (abi == NULL)
 169     internal_error (__FILE__, __LINE__,
 170                     _("Cannot find C++ ABI \"%s\" to set it as auto default."),
 171                     short_name);
 172
 173   if (auto_cp_abi.longname != NULL)
 174     xfree ((char *) auto_cp_abi.longname);
 175   if (auto_cp_abi.doc != NULL)
 176     xfree ((char *) auto_cp_abi.doc);
 177
 178   auto_cp_abi = *abi;
 179
 180   auto_cp_abi.shortname = "auto";
 181   xasprintf (&new_longname, "currently \"%s\"", abi->shortname);
 182   auto_cp_abi.longname = new_longname;
 183
 184   xasprintf (&new_doc, "Automatically selected; currently \"%s\"",
 185              abi->shortname);
 186   auto_cp_abi.doc = new_doc;
 187
 188   /* Since we copy the current ABI into current_cp_abi instead of
 189      using a pointer, if auto is currently the default, we need to
 190      reset it.  */
 191   if (strcmp (current_cp_abi.shortname, "auto") == 0)
 192     switch_to_cp_abi ("auto");
 193 }
 194
 195 /* Return the ABI operations associated with SHORT_NAME.  */
 196
 197 static struct cp_abi_ops *
 198 find_cp_abi (const char *short_name)
 199 {
 200   int i;
 201
 202   for (i = 0; i < num_cp_abis; i++)
 203     if (strcmp (cp_abis[i]->shortname, short_name) == 0)
 204       return cp_abis[i];
 205
 206   return NULL;
 207 }
 208
 209 /* Display the list of registered C++ ABIs.  */
 210
 211 static void
 212 list_cp_abis (int from_tty)
 213 {
 214   struct cleanup *cleanup_chain;
 215   int i;
 216   ui_out_text (uiout, "The available C++ ABIs are:\n");
 217
 218   cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "cp-abi-list");
 219   for (i = 0; i < num_cp_abis; i++)
 220     {
 221       char pad[14];
 222       int padcount;
 223
 224       ui_out_text (uiout, "  ");
 225       ui_out_field_string (uiout, "cp-abi", cp_abis[i]->shortname);
 226
 227       padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
 228       pad[padcount] = 0;
 229       while (padcount > 0)
 230         pad[--padcount] = ' ';
 231       ui_out_text (uiout, pad);
 232
 233       ui_out_field_string (uiout, "doc", cp_abis[i]->doc);
 234       ui_out_text (uiout, "\n");
 235     }
 236   do_cleanups (cleanup_chain);
 237 }
 238
 239 /* Set the current C++ ABI, or display the list of options if no
 240    argument is given.  */
 241
 242 static void
 243 set_cp_abi_cmd (char *args, int from_tty)
 244 {
 245   if (args == NULL)
 246     {
 247       list_cp_abis (from_tty);
 248       return;
 249     }
 250
 251   if (!switch_to_cp_abi (args))
 252     error (_("Could not find \"%s\" in ABI list"), args);
 253 }
 254
 255 /* Show the currently selected C++ ABI.  */
 256
 257 static void
 258 show_cp_abi_cmd (char *args, int from_tty)
 259 {
 260   ui_out_text (uiout, "The currently selected C++ ABI is \"");
 261
 262   ui_out_field_string (uiout, "cp-abi", current_cp_abi.shortname);
 263   ui_out_text (uiout, "\" (");
 264   ui_out_field_string (uiout, "longname", current_cp_abi.longname);
 265   ui_out_text (uiout, ").\n");
 266 }
 267
 268 extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */
 269
 270 void
 271 _initialize_cp_abi (void)
 272 {
 273   register_cp_abi (&auto_cp_abi);
 274   switch_to_cp_abi ("auto");
 275
 276   add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
 277 Set the ABI used for inspecting C++ objects.\n\
 278 \"set cp-abi\" with no arguments will list the available ABIs."),
 279            &setlist);
 280
 281   add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
 282            _("Show the ABI used for inspecting C++ objects."), &showlist);
 283 }