2
0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2024-12-27 04:52:05 +08:00
binutils-gdb/gdb/macroexp.h

100 lines
4.0 KiB
C
Raw Normal View History

/* Interface to C preprocessor macro expansion for GDB.
Copyright (C) 2002-2017 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 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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, see <http://www.gnu.org/licenses/>. */
#ifndef MACROEXP_H
#define MACROEXP_H
/* A function for looking up preprocessor macro definitions. Return
the preprocessor definition of NAME in scope according to BATON, or
zero if NAME is not defined as a preprocessor macro.
The caller must not free or modify the definition returned. It is
probably unwise for the caller to hold pointers to it for very
long; it probably lives in some objfile's obstacks. */
typedef struct macro_definition *(macro_lookup_ftype) (const char *name,
void *baton);
/* Expand any preprocessor macros in SOURCE, and return the expanded
text. Use LOOKUP_FUNC and LOOKUP_FUNC_BATON to find identifiers'
preprocessor definitions. SOURCE is a null-terminated string. The
result is a null-terminated string, allocated using xmalloc; it is
the caller's responsibility to free it. */
char *macro_expand (const char *source,
macro_lookup_ftype *lookup_func,
void *lookup_func_baton);
/* Expand all preprocessor macro references that appear explicitly in
SOURCE, but do not expand any new macro references introduced by
that first level of expansion. Use LOOKUP_FUNC and
LOOKUP_FUNC_BATON to find identifiers' preprocessor definitions.
SOURCE is a null-terminated string. The result is a
null-terminated string, allocated using xmalloc; it is the caller's
responsibility to free it. */
char *macro_expand_once (const char *source,
macro_lookup_ftype *lookup_func,
void *lookup_func_baton);
/* If the null-terminated string pointed to by *LEXPTR begins with a
macro invocation, return the result of expanding that invocation as
a null-terminated string, and set *LEXPTR to the next character
after the invocation. The result is completely expanded; it
contains no further macro invocations.
Otherwise, if *LEXPTR does not start with a macro invocation,
return zero, and leave *LEXPTR unchanged.
Use LOOKUP_FUNC and LOOKUP_BATON to find macro definitions.
If this function returns a string, the caller is responsible for
freeing it, using xfree.
We need this expand-one-token-at-a-time interface in order to
accomodate GDB's C expression parser, which may not consume the
entire string. When the user enters a command like
(gdb) break *func+20 if x == 5
the parser is expected to consume `func+20', and then stop when it
sees the "if". But of course, "if" appearing in a character string
or as part of a larger identifier doesn't count. So you pretty
much have to do tokenization to find the end of the string that
needs to be macro-expanded. Our C/C++ tokenizer isn't really
designed to be called by anything but the yacc parser engine. */
char *macro_expand_next (const char **lexptr,
macro_lookup_ftype *lookup_func,
void *lookup_baton);
gdb PR gdb/855: * NEWS: Add entry for macro commands. * Makefile.in (macrocmd.o): Add gdb_string.h. * macroscope.h (user_macro_scope): Declare. (default_macro_scope): Update documentation. (macro_user_macros): Declare. * c-lang.c (c_preprocess_and_parse): Always attempt macro lookup. Use user_macro_scope. (null_macro_lookup): Remove. * macrotab.h (macro_callback_fn): Declare. (macro_for_each): Likewise. (macro_allow_redefinitions): Likewise. * macrotab.c (foreach_macro): New function (macro_for_each): Likewise. (struct macro_table) <redef_ok>: New field. (macro_allow_redefinitions): New function. (new_macro_table): Update. (macro_define_function): Likewise. (macro_define_object): Likewise. * macroscope.c (user_macro_scope): New function. (default_macro_scope): Use it. (macro_user_macros): New global. (standard_macro_lookup): Look in macro_user_macros. (_initialize_macroscope): New function. * macroexp.h (macro_is_whitespace, macro_is_digit, macro_is_identifier_nondigit): Declare. * macroexp.c (macro_is_whitespace): Rename. No longer static. (macro_is_digit): Likewise. (macro_is_identifier_nondigit): Likewise. (get_identifier): Update. (get_pp_number): Likewise. (get_token): Likewise. * macrocmd.c (skip_ws): New function. (extract_identifier): Likewise. (free_macro_definition_ptr): Likewise. (user_macros): Remove. (macro_define_command): Implement. (_initialize_macrocmd): Update. (macro_undef_command): Implement. (print_one_macro): New function. (macro_list_command): Implement. gdb/doc * gdb.texinfo (Macros): Update. Use @code rather than @command. gdb/testsuite * gdb.base/macscp.exp: Add macro tests.
2008-07-19 04:55:33 +08:00
/* Functions to classify characters according to cpp rules. */
int macro_is_whitespace (int c);
int macro_is_identifier_nondigit (int c);
int macro_is_digit (int c);
/* Stringify STR according to C rules and return an xmalloc'd pointer
to the result. */
char *macro_stringify (const char *str);
#endif /* MACROEXP_H */