1/* Interface to functions for deciding which macros are currently in scope. 2 Copyright (C) 2002, 2007 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/* All the information we need to decide which macro definitions are 28 in scope: a source file (either a main source file or an 29 #inclusion), and a line number in that file. */ 30struct macro_scope { 31 struct macro_source_file *file; 32 int line; 33}; 34 35 36/* Return a `struct macro_scope' object corresponding to the symtab 37 and line given in SAL. If we have no macro information for that 38 location, or if SAL's pc is zero, return zero. */ 39struct macro_scope *sal_macro_scope (struct symtab_and_line sal); 40 41 42/* Return a `struct macro_scope' object describing the scope the `macro 43 expand' and `macro expand-once' commands should use for looking up 44 macros. If we have a selected frame, this is the source location of 45 its PC; otherwise, this is the last listing position. 46 47 If we have no macro information for the current location, return zero. 48 49 The object returned is allocated using xmalloc; the caller is 50 responsible for freeing it. */ 51struct macro_scope *default_macro_scope (void); 52 53 54/* Look up the definition of the macro named NAME in scope at the source 55 location given by BATON, which must be a pointer to a `struct 56 macro_scope' structure. This function is suitable for use as 57 a macro_lookup_ftype function. */ 58struct macro_definition *standard_macro_lookup (const char *name, void *baton); 59 60 61#endif /* MACROSCOPE_H */ 62