Fix crash when creating index from index
[binutils-gdb.git] / gdb / macroscope.c
index 08ff6ebff58d14c5bae88cc4b6617bbad435322f..93f561acccd8b7a5e97afc3b555b44f93edbb03b 100644 (file)
@@ -1,12 +1,12 @@
 /* Functions for deciding which macros are currently in scope.
-   Copyright 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002-2022 Free Software Foundation, Inc.
    Contributed by Red Hat, Inc.
 
    This file is part of GDB.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 
 #include "macroscope.h"
 #include "symtab.h"
+#include "source.h"
 #include "target.h"
 #include "frame.h"
 #include "inferior.h"
+#include "complaints.h"
 
+/* A table of user-defined macros.  Unlike the macro tables used for
+   symtabs, this one uses xmalloc for all its allocation, not an
+   obstack, and it doesn't bcache anything; it just xmallocs things.  So
+   it's perfectly possible to remove things from this, or redefine
+   things.  */
+struct macro_table *macro_user_macros;
 
-struct macro_scope *
+
+gdb::unique_xmalloc_ptr<struct macro_scope>
 sal_macro_scope (struct symtab_and_line sal)
 {
-  struct macro_source_file *main;
-  struct macro_scope *ms;
+  struct macro_source_file *main_file, *inclusion;
+  struct compunit_symtab *cust;
 
-  if (! sal.symtab
-      || ! sal.symtab->macro_table)
-    return 0;
+  if (sal.symtab == NULL)
+    return NULL;
 
-  ms = (struct macro_scope *) xmalloc (sizeof (*ms));
+  cust = sal.symtab->compunit ();
+  if (cust->macro_table () == NULL)
+    return NULL;
 
-  main = macro_main (sal.symtab->macro_table);
-  ms->file = macro_lookup_inclusion (main, sal.symtab->filename);
+  gdb::unique_xmalloc_ptr<struct macro_scope> ms (XNEW (struct macro_scope));
 
-  if (! ms->file)
-    internal_error
-      (__FILE__, __LINE__,
-       "\n"
-       "the symtab `%s' refers to a preprocessor macro table which doesn't\n"
-       "have any record of processing a file by that name.\n",
-       sal.symtab->filename);
+  main_file = macro_main (cust->macro_table ());
+  inclusion = macro_lookup_inclusion (main_file, sal.symtab->filename);
 
-  ms->line = sal.line;
+  if (inclusion)
+    {
+      ms->file = inclusion;
+      ms->line = sal.line;
+    }
+  else
+    {
+      /* There are, unfortunately, cases where a compilation unit can
+        have a symtab for a source file that doesn't appear in the
+        macro table.  For example, at the moment, Dwarf doesn't have
+        any way in the .debug_macinfo section to describe the effect
+        of #line directives, so if you debug a YACC parser you'll get
+        a macro table which only mentions the .c files generated by
+        YACC, but symtabs that mention the .y files consumed by YACC.
+
+        In the long run, we should extend the Dwarf macro info
+        representation to handle #line directives, and get GCC to
+        emit it.
+
+        For the time being, though, we'll just treat these as
+        occurring at the end of the main source file.  */
+      ms->file = main_file;
+      ms->line = -1;
+
+      complaint (_("symtab found for `%s', but that file\n"
+                "is not covered in the compilation unit's macro information"),
+                symtab_to_filename_for_display (sal.symtab));
+    }
 
   return ms;
 }
 
 
-struct macro_scope *
+gdb::unique_xmalloc_ptr<struct macro_scope>
+user_macro_scope (void)
+{
+  gdb::unique_xmalloc_ptr<struct macro_scope> ms (XNEW (struct macro_scope));
+  ms->file = macro_main (macro_user_macros);
+  ms->line = -1;
+  return ms;
+}
+
+gdb::unique_xmalloc_ptr<struct macro_scope>
 default_macro_scope (void)
 {
   struct symtab_and_line sal;
-  struct macro_source_file *main;
-  struct macro_scope *ms;
-
-  /* If there's a selected frame, use its PC.  */ 
-  if (selected_frame)
-    sal = find_pc_line (selected_frame->pc, 0);
-  
-  /* If the target has any registers at all, then use its PC.  Why we
-     would have registers but no stack, I'm not sure.  */
-  else if (target_has_registers)
-    sal = find_pc_line (read_pc (), 0);
-
-  /* If all else fails, fall back to the current listing position.  */
+  gdb::unique_xmalloc_ptr<struct macro_scope> ms;
+  struct frame_info *frame;
+  CORE_ADDR pc;
+
+  /* If there's a selected frame, use its PC.  */
+  frame = deprecated_safe_get_selected_frame ();
+  if (frame && get_frame_pc_if_available (frame, &pc))
+    sal = find_pc_line (pc, 0);
+
+  /* Fall back to the current listing position.  */
   else
     {
       /* Don't call select_source_symtab here.  That can raise an
-         error if symbols aren't loaded, but GDB calls the expression
-         evaluator in all sorts of contexts.
-
-         For example, commands like `set width' call the expression
-         evaluator to evaluate their numeric arguments.  If the
-         current language is C, then that may call this function to
-         choose a scope for macro expansion.  If you don't have any
-         symbol files loaded, then select_source_symtab will raise an
-         error.  But `set width' shouldn't raise an error just because
-         it can't decide which scope to macro-expand its argument in.  */
-      sal.symtab = current_source_symtab;
-      sal.line = current_source_line;
+        error if symbols aren't loaded, but GDB calls the expression
+        evaluator in all sorts of contexts.
+
+        For example, commands like `set width' call the expression
+        evaluator to evaluate their numeric arguments.  If the
+        current language is C, then that may call this function to
+        choose a scope for macro expansion.  If you don't have any
+        symbol files loaded, then get_current_or_default would raise an
+        error.  But `set width' shouldn't raise an error just because
+        it can't decide which scope to macro-expand its argument in.  */
+      struct symtab_and_line cursal
+       = get_current_source_symtab_and_line ();
+      
+      sal.symtab = cursal.symtab;
+      sal.line = cursal.line;
     }
 
-  return sal_macro_scope (sal);
+  ms = sal_macro_scope (sal);
+  if (! ms)
+    ms = user_macro_scope ();
+
+  return ms;
 }
 
 
@@ -99,9 +141,23 @@ default_macro_scope (void)
    location given by BATON, which must be a pointer to a `struct
    macro_scope' structure.  */
 struct macro_definition *
-standard_macro_lookup (const char *name, void *baton)
+standard_macro_lookup (const char *name, const macro_scope &ms)
 {
-  struct macro_scope *ms = (struct macro_scope *) baton;
+  /* Give user-defined macros priority over all others.  */
+  macro_definition *result
+    = macro_lookup_definition (macro_main (macro_user_macros), -1, name);
 
-  return macro_lookup_definition (ms->file, ms->line, name);
+  if (result == nullptr)
+    result = macro_lookup_definition (ms.file, ms.line, name);
+
+  return result;
+}
+
+void _initialize_macroscope ();
+void
+_initialize_macroscope ()
+{
+  macro_user_macros = new_macro_table (NULL, NULL, NULL);
+  macro_set_main (macro_user_macros, "<user-defined>");
+  macro_allow_redefinitions (macro_user_macros);
 }