gdb/macroscope.h

   1 /* Interface to functions for deciding which macros are currently in scope.
   2    Copyright (C) 2002-2020 Free Software Foundation, Inc.
   3    Contributed by Red Hat, 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 MACROSCOPE_H
  21 #define MACROSCOPE_H
  22
  23 #include "macrotab.h"
  24 #include "symtab.h"
  25
  26
  27 /* The table of macros defined by the user.  */
  28 extern struct macro_table *macro_user_macros;
  29
  30 /* All the information we need to decide which macro definitions are
  31    in scope: a source file (either a main source file or an
  32    #inclusion), and a line number in that file.  */
  33 struct macro_scope {
  34   struct macro_source_file *file;
  35   int line;
  36 };
  37
  38
  39 /* Return a `struct macro_scope' object corresponding to the symtab
  40    and line given in SAL.  If we have no macro information for that
  41    location, or if SAL's pc is zero, return zero.  */
  42 gdb::unique_xmalloc_ptr<struct macro_scope> sal_macro_scope
  43     (struct symtab_and_line sal);
  44
  45
  46 /* Return a `struct macro_scope' object representing just the
  47    user-defined macros.  */
  48 gdb::unique_xmalloc_ptr<struct macro_scope> user_macro_scope (void);
  49
  50 /* Return a `struct macro_scope' object describing the scope the `macro
  51    expand' and `macro expand-once' commands should use for looking up
  52    macros.  If we have a selected frame, this is the source location of
  53    its PC; otherwise, this is the last listing position.
  54
  55    If we have no macro information for the current location, return
  56    the user macro scope.  */
  57 gdb::unique_xmalloc_ptr<struct macro_scope> default_macro_scope (void);
  58
  59
  60 /* Look up the definition of the macro named NAME in scope at the source
  61    location given by BATON, which must be a pointer to a `struct
  62    macro_scope' structure.  This function is suitable for use as
  63    a macro_lookup_ftype function.  */
  64 struct macro_definition *standard_macro_lookup (const char *name, void *baton);
  65
  66
  67 #endif /* MACROSCOPE_H */