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