/* C preprocessor macro expansion commands for GDB.
|
/* C preprocessor macro expansion commands for GDB.
|
Copyright (C) 2002, 2007, 2008 Free Software Foundation, Inc.
|
Copyright (C) 2002, 2007, 2008 Free Software Foundation, Inc.
|
Contributed by Red Hat, Inc.
|
Contributed by Red Hat, Inc.
|
|
|
This file is part of GDB.
|
This file is part of GDB.
|
|
|
This program is free software; you can redistribute it and/or modify
|
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
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
|
#include "defs.h"
|
#include "defs.h"
|
#include "macrotab.h"
|
#include "macrotab.h"
|
#include "macroexp.h"
|
#include "macroexp.h"
|
#include "macroscope.h"
|
#include "macroscope.h"
|
#include "command.h"
|
#include "command.h"
|
#include "gdbcmd.h"
|
#include "gdbcmd.h"
|
|
|
|
|
/* The `macro' prefix command. */
|
/* The `macro' prefix command. */
|
|
|
static struct cmd_list_element *macrolist;
|
static struct cmd_list_element *macrolist;
|
|
|
static void
|
static void
|
macro_command (char *arg, int from_tty)
|
macro_command (char *arg, int from_tty)
|
{
|
{
|
printf_unfiltered
|
printf_unfiltered
|
("\"macro\" must be followed by the name of a macro command.\n");
|
("\"macro\" must be followed by the name of a macro command.\n");
|
help_list (macrolist, "macro ", -1, gdb_stdout);
|
help_list (macrolist, "macro ", -1, gdb_stdout);
|
}
|
}
|
|
|
|
|
|
|
/* Macro expansion commands. */
|
/* Macro expansion commands. */
|
|
|
|
|
static void
|
static void
|
macro_expand_command (char *exp, int from_tty)
|
macro_expand_command (char *exp, int from_tty)
|
{
|
{
|
struct macro_scope *ms = NULL;
|
struct macro_scope *ms = NULL;
|
char *expanded = NULL;
|
char *expanded = NULL;
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
make_cleanup (free_current_contents, &expanded);
|
make_cleanup (free_current_contents, &expanded);
|
|
|
/* You know, when the user doesn't specify any expression, it would be
|
/* You know, when the user doesn't specify any expression, it would be
|
really cool if this defaulted to the last expression evaluated.
|
really cool if this defaulted to the last expression evaluated.
|
Then it would be easy to ask, "Hey, what did I just evaluate?" But
|
Then it would be easy to ask, "Hey, what did I just evaluate?" But
|
at the moment, the `print' commands don't save the last expression
|
at the moment, the `print' commands don't save the last expression
|
evaluated, just its value. */
|
evaluated, just its value. */
|
if (! exp || ! *exp)
|
if (! exp || ! *exp)
|
error (_("You must follow the `macro expand' command with the"
|
error (_("You must follow the `macro expand' command with the"
|
" expression you\n"
|
" expression you\n"
|
"want to expand."));
|
"want to expand."));
|
|
|
ms = default_macro_scope ();
|
ms = default_macro_scope ();
|
if (ms)
|
if (ms)
|
{
|
{
|
expanded = macro_expand (exp, standard_macro_lookup, ms);
|
expanded = macro_expand (exp, standard_macro_lookup, ms);
|
fputs_filtered ("expands to: ", gdb_stdout);
|
fputs_filtered ("expands to: ", gdb_stdout);
|
fputs_filtered (expanded, gdb_stdout);
|
fputs_filtered (expanded, gdb_stdout);
|
fputs_filtered ("\n", gdb_stdout);
|
fputs_filtered ("\n", gdb_stdout);
|
}
|
}
|
else
|
else
|
fputs_filtered ("GDB has no preprocessor macro information for "
|
fputs_filtered ("GDB has no preprocessor macro information for "
|
"that code.\n",
|
"that code.\n",
|
gdb_stdout);
|
gdb_stdout);
|
|
|
do_cleanups (cleanup_chain);
|
do_cleanups (cleanup_chain);
|
return;
|
return;
|
}
|
}
|
|
|
|
|
static void
|
static void
|
macro_expand_once_command (char *exp, int from_tty)
|
macro_expand_once_command (char *exp, int from_tty)
|
{
|
{
|
struct macro_scope *ms = NULL;
|
struct macro_scope *ms = NULL;
|
char *expanded = NULL;
|
char *expanded = NULL;
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
make_cleanup (free_current_contents, &expanded);
|
make_cleanup (free_current_contents, &expanded);
|
|
|
/* You know, when the user doesn't specify any expression, it would be
|
/* You know, when the user doesn't specify any expression, it would be
|
really cool if this defaulted to the last expression evaluated.
|
really cool if this defaulted to the last expression evaluated.
|
And it should set the once-expanded text as the new `last
|
And it should set the once-expanded text as the new `last
|
expression'. That way, you could just hit return over and over and
|
expression'. That way, you could just hit return over and over and
|
see the expression expanded one level at a time. */
|
see the expression expanded one level at a time. */
|
if (! exp || ! *exp)
|
if (! exp || ! *exp)
|
error (_("You must follow the `macro expand-once' command with"
|
error (_("You must follow the `macro expand-once' command with"
|
" the expression\n"
|
" the expression\n"
|
"you want to expand."));
|
"you want to expand."));
|
|
|
ms = default_macro_scope ();
|
ms = default_macro_scope ();
|
if (ms)
|
if (ms)
|
{
|
{
|
expanded = macro_expand_once (exp, standard_macro_lookup, ms);
|
expanded = macro_expand_once (exp, standard_macro_lookup, ms);
|
fputs_filtered ("expands to: ", gdb_stdout);
|
fputs_filtered ("expands to: ", gdb_stdout);
|
fputs_filtered (expanded, gdb_stdout);
|
fputs_filtered (expanded, gdb_stdout);
|
fputs_filtered ("\n", gdb_stdout);
|
fputs_filtered ("\n", gdb_stdout);
|
}
|
}
|
else
|
else
|
fputs_filtered ("GDB has no preprocessor macro information for "
|
fputs_filtered ("GDB has no preprocessor macro information for "
|
"that code.\n",
|
"that code.\n",
|
gdb_stdout);
|
gdb_stdout);
|
|
|
do_cleanups (cleanup_chain);
|
do_cleanups (cleanup_chain);
|
return;
|
return;
|
}
|
}
|
|
|
|
|
static void
|
static void
|
show_pp_source_pos (struct ui_file *stream,
|
show_pp_source_pos (struct ui_file *stream,
|
struct macro_source_file *file,
|
struct macro_source_file *file,
|
int line)
|
int line)
|
{
|
{
|
fprintf_filtered (stream, "%s:%d\n", file->filename, line);
|
fprintf_filtered (stream, "%s:%d\n", file->filename, line);
|
|
|
while (file->included_by)
|
while (file->included_by)
|
{
|
{
|
fprintf_filtered (gdb_stdout, " included at %s:%d\n",
|
fprintf_filtered (gdb_stdout, " included at %s:%d\n",
|
file->included_by->filename,
|
file->included_by->filename,
|
file->included_at_line);
|
file->included_at_line);
|
file = file->included_by;
|
file = file->included_by;
|
}
|
}
|
}
|
}
|
|
|
|
|
static void
|
static void
|
info_macro_command (char *name, int from_tty)
|
info_macro_command (char *name, int from_tty)
|
{
|
{
|
struct macro_scope *ms = NULL;
|
struct macro_scope *ms = NULL;
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
|
struct macro_definition *d;
|
struct macro_definition *d;
|
|
|
if (! name || ! *name)
|
if (! name || ! *name)
|
error (_("You must follow the `info macro' command with the name"
|
error (_("You must follow the `info macro' command with the name"
|
" of the macro\n"
|
" of the macro\n"
|
"whose definition you want to see."));
|
"whose definition you want to see."));
|
|
|
ms = default_macro_scope ();
|
ms = default_macro_scope ();
|
if (! ms)
|
if (! ms)
|
error (_("GDB has no preprocessor macro information for that code."));
|
error (_("GDB has no preprocessor macro information for that code."));
|
|
|
d = macro_lookup_definition (ms->file, ms->line, name);
|
d = macro_lookup_definition (ms->file, ms->line, name);
|
if (d)
|
if (d)
|
{
|
{
|
int line;
|
int line;
|
struct macro_source_file *file
|
struct macro_source_file *file
|
= macro_definition_location (ms->file, ms->line, name, &line);
|
= macro_definition_location (ms->file, ms->line, name, &line);
|
|
|
fprintf_filtered (gdb_stdout, "Defined at ");
|
fprintf_filtered (gdb_stdout, "Defined at ");
|
show_pp_source_pos (gdb_stdout, file, line);
|
show_pp_source_pos (gdb_stdout, file, line);
|
fprintf_filtered (gdb_stdout, "#define %s", name);
|
fprintf_filtered (gdb_stdout, "#define %s", name);
|
if (d->kind == macro_function_like)
|
if (d->kind == macro_function_like)
|
{
|
{
|
int i;
|
int i;
|
|
|
fputs_filtered ("(", gdb_stdout);
|
fputs_filtered ("(", gdb_stdout);
|
for (i = 0; i < d->argc; i++)
|
for (i = 0; i < d->argc; i++)
|
{
|
{
|
fputs_filtered (d->argv[i], gdb_stdout);
|
fputs_filtered (d->argv[i], gdb_stdout);
|
if (i + 1 < d->argc)
|
if (i + 1 < d->argc)
|
fputs_filtered (", ", gdb_stdout);
|
fputs_filtered (", ", gdb_stdout);
|
}
|
}
|
fputs_filtered (")", gdb_stdout);
|
fputs_filtered (")", gdb_stdout);
|
}
|
}
|
fprintf_filtered (gdb_stdout, " %s\n", d->replacement);
|
fprintf_filtered (gdb_stdout, " %s\n", d->replacement);
|
}
|
}
|
else
|
else
|
{
|
{
|
fprintf_filtered (gdb_stdout,
|
fprintf_filtered (gdb_stdout,
|
"The symbol `%s' has no definition as a C/C++"
|
"The symbol `%s' has no definition as a C/C++"
|
" preprocessor macro\n"
|
" preprocessor macro\n"
|
"at ", name);
|
"at ", name);
|
show_pp_source_pos (gdb_stdout, ms->file, ms->line);
|
show_pp_source_pos (gdb_stdout, ms->file, ms->line);
|
}
|
}
|
|
|
do_cleanups (cleanup_chain);
|
do_cleanups (cleanup_chain);
|
}
|
}
|
|
|
|
|
|
|
/* User-defined macros. */
|
/* User-defined macros. */
|
|
|
/* A table of user-defined macros. Unlike the macro tables used for
|
/* A table of user-defined macros. Unlike the macro tables used for
|
symtabs, this one uses xmalloc for all its allocation, not an
|
symtabs, this one uses xmalloc for all its allocation, not an
|
obstack, and it doesn't bcache anything; it just xmallocs things. So
|
obstack, and it doesn't bcache anything; it just xmallocs things. So
|
it's perfectly possible to remove things from this, or redefine
|
it's perfectly possible to remove things from this, or redefine
|
things. */
|
things. */
|
static struct macro_table *user_macros;
|
static struct macro_table *user_macros;
|
|
|
static void
|
static void
|
macro_define_command (char *exp, int from_tty)
|
macro_define_command (char *exp, int from_tty)
|
{
|
{
|
error (_("Command not implemented yet."));
|
error (_("Command not implemented yet."));
|
}
|
}
|
|
|
|
|
static void
|
static void
|
macro_undef_command (char *exp, int from_tty)
|
macro_undef_command (char *exp, int from_tty)
|
{
|
{
|
error (_("Command not implemented yet."));
|
error (_("Command not implemented yet."));
|
}
|
}
|
|
|
|
|
static void
|
static void
|
macro_list_command (char *exp, int from_tty)
|
macro_list_command (char *exp, int from_tty)
|
{
|
{
|
error (_("Command not implemented yet."));
|
error (_("Command not implemented yet."));
|
}
|
}
|
|
|
|
|
|
|
/* Initializing the `macrocmd' module. */
|
/* Initializing the `macrocmd' module. */
|
|
|
extern initialize_file_ftype _initialize_macrocmd; /* -Wmissing-prototypes */
|
extern initialize_file_ftype _initialize_macrocmd; /* -Wmissing-prototypes */
|
|
|
void
|
void
|
_initialize_macrocmd (void)
|
_initialize_macrocmd (void)
|
{
|
{
|
struct cmd_list_element *c;
|
struct cmd_list_element *c;
|
|
|
/* We introduce a new command prefix, `macro', under which we'll put
|
/* We introduce a new command prefix, `macro', under which we'll put
|
the various commands for working with preprocessor macros. */
|
the various commands for working with preprocessor macros. */
|
add_prefix_cmd ("macro", class_info, macro_command,
|
add_prefix_cmd ("macro", class_info, macro_command,
|
_("Prefix for commands dealing with C preprocessor macros."),
|
_("Prefix for commands dealing with C preprocessor macros."),
|
¯olist, "macro ", 0, &cmdlist);
|
¯olist, "macro ", 0, &cmdlist);
|
|
|
add_cmd ("expand", no_class, macro_expand_command, _("\
|
add_cmd ("expand", no_class, macro_expand_command, _("\
|
Fully expand any C/C++ preprocessor macro invocations in EXPRESSION.\n\
|
Fully expand any C/C++ preprocessor macro invocations in EXPRESSION.\n\
|
Show the expanded expression."),
|
Show the expanded expression."),
|
¯olist);
|
¯olist);
|
add_alias_cmd ("exp", "expand", no_class, 1, ¯olist);
|
add_alias_cmd ("exp", "expand", no_class, 1, ¯olist);
|
add_cmd ("expand-once", no_class, macro_expand_once_command, _("\
|
add_cmd ("expand-once", no_class, macro_expand_once_command, _("\
|
Expand C/C++ preprocessor macro invocations appearing directly in EXPRESSION.\n\
|
Expand C/C++ preprocessor macro invocations appearing directly in EXPRESSION.\n\
|
Show the expanded expression.\n\
|
Show the expanded expression.\n\
|
\n\
|
\n\
|
This command differs from `macro expand' in that it only expands macro\n\
|
This command differs from `macro expand' in that it only expands macro\n\
|
invocations that appear directly in EXPRESSION; if expanding a macro\n\
|
invocations that appear directly in EXPRESSION; if expanding a macro\n\
|
introduces further macro invocations, those are left unexpanded.\n\
|
introduces further macro invocations, those are left unexpanded.\n\
|
\n\
|
\n\
|
`macro expand-once' helps you see how a particular macro expands,\n\
|
`macro expand-once' helps you see how a particular macro expands,\n\
|
whereas `macro expand' shows you how all the macros involved in an\n\
|
whereas `macro expand' shows you how all the macros involved in an\n\
|
expression work together to yield a pre-processed expression."),
|
expression work together to yield a pre-processed expression."),
|
¯olist);
|
¯olist);
|
add_alias_cmd ("exp1", "expand-once", no_class, 1, ¯olist);
|
add_alias_cmd ("exp1", "expand-once", no_class, 1, ¯olist);
|
|
|
add_cmd ("macro", no_class, info_macro_command,
|
add_cmd ("macro", no_class, info_macro_command,
|
_("Show the definition of MACRO, and its source location."),
|
_("Show the definition of MACRO, and its source location."),
|
&infolist);
|
&infolist);
|
|
|
add_cmd ("define", no_class, macro_define_command, _("\
|
add_cmd ("define", no_class, macro_define_command, _("\
|
Define a new C/C++ preprocessor macro.\n\
|
Define a new C/C++ preprocessor macro.\n\
|
The GDB command `macro define DEFINITION' is equivalent to placing a\n\
|
The GDB command `macro define DEFINITION' is equivalent to placing a\n\
|
preprocessor directive of the form `#define DEFINITION' such that the\n\
|
preprocessor directive of the form `#define DEFINITION' such that the\n\
|
definition is visible in all the inferior's source files.\n\
|
definition is visible in all the inferior's source files.\n\
|
For example:\n\
|
For example:\n\
|
(gdb) macro define PI (3.1415926)\n\
|
(gdb) macro define PI (3.1415926)\n\
|
(gdb) macro define MIN(x,y) ((x) < (y) ? (x) : (y))"),
|
(gdb) macro define MIN(x,y) ((x) < (y) ? (x) : (y))"),
|
¯olist);
|
¯olist);
|
|
|
add_cmd ("undef", no_class, macro_undef_command, _("\
|
add_cmd ("undef", no_class, macro_undef_command, _("\
|
Remove the definition of the C/C++ preprocessor macro with the given name."),
|
Remove the definition of the C/C++ preprocessor macro with the given name."),
|
¯olist);
|
¯olist);
|
|
|
add_cmd ("list", no_class, macro_list_command,
|
add_cmd ("list", no_class, macro_list_command,
|
_("List all the macros defined using the `macro define' command."),
|
_("List all the macros defined using the `macro define' command."),
|
¯olist);
|
¯olist);
|
|
|
user_macros = new_macro_table (0, 0);
|
user_macros = new_macro_table (0, 0);
|
}
|
}
|
|
|
