/* C preprocessor macro expansion commands for GDB.
- Copyright 2002 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2007, 2008, 2009, 2010, 2011
+ 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 2 of the License, or
+ 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,
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, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "macroscope.h"
#include "command.h"
#include "gdbcmd.h"
+#include "gdb_string.h"
\f
/* The `macro' prefix command. */
struct macro_scope *ms = NULL;
char *expanded = NULL;
struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &ms);
+
make_cleanup (free_current_contents, &expanded);
/* You know, when the user doesn't specify any expression, it would be
at the moment, the `print' commands don't save the last expression
evaluated, just its value. */
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"
- "want to expand.");
+ "want to expand."));
ms = default_macro_scope ();
if (ms)
expression'. That way, you could just hit return over and over and
see the expression expanded one level at a time. */
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"
- "you want to expand.");
+ "you want to expand."));
ms = default_macro_scope ();
if (ms)
struct macro_definition *d;
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"
- "whose definition you want to see.");
+ "whose definition you want to see."));
ms = default_macro_scope ();
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);
if (d)
fprintf_filtered (gdb_stdout, "Defined at ");
show_pp_source_pos (gdb_stdout, file, line);
- fprintf_filtered (gdb_stdout, "#define %s", name);
+ if (line != 0)
+ fprintf_filtered (gdb_stdout, "#define %s", name);
+ else
+ fprintf_filtered (gdb_stdout, "-D%s", name);
if (d->kind == macro_function_like)
{
int i;
}
fputs_filtered (")", gdb_stdout);
}
- fprintf_filtered (gdb_stdout, " %s\n", d->replacement);
+ if (line != 0)
+ fprintf_filtered (gdb_stdout, " %s\n", d->replacement);
+ else
+ fprintf_filtered (gdb_stdout, "=%s\n", d->replacement);
}
else
{
\f
/* User-defined macros. */
-/* A table of user-defined macros. Unlike the macro tables used for
- symtabs, this one uses xmalloc for all its allocation, not an
- obstack, and it doesn't bcache anything; it just xmallocs things. So
- it's perfectly possible to remove things from this, or redefine
- things. */
-static struct macro_table *user_macros;
+static void
+skip_ws (char **expp)
+{
+ while (macro_is_whitespace (**expp))
+ ++*expp;
+}
+
+/* Try to find the bounds of an identifier. If an identifier is
+ found, returns a newly allocated string; otherwise returns NULL.
+ EXPP is a pointer to an input string; it is updated to point to the
+ text following the identifier. If IS_PARAMETER is true, this
+ function will also allow "..." forms as used in varargs macro
+ parameters. */
+
+static char *
+extract_identifier (char **expp, int is_parameter)
+{
+ char *result;
+ char *p = *expp;
+ unsigned int len;
+
+ if (is_parameter && !strncmp (p, "...", 3))
+ {
+ /* Ok. */
+ }
+ else
+ {
+ if (! *p || ! macro_is_identifier_nondigit (*p))
+ return NULL;
+ for (++p;
+ *p && (macro_is_identifier_nondigit (*p) || macro_is_digit (*p));
+ ++p)
+ ;
+ }
+
+ if (is_parameter && !strncmp (p, "...", 3))
+ p += 3;
+
+ len = p - *expp;
+ result = (char *) xmalloc (len + 1);
+ memcpy (result, *expp, len);
+ result[len] = '\0';
+ *expp += len;
+ return result;
+}
+
+/* Helper function to clean up a temporarily-constructed macro object.
+ This assumes that the contents were all allocated with xmalloc. */
+static void
+free_macro_definition_ptr (void *ptr)
+{
+ int i;
+ struct macro_definition *loc = (struct macro_definition *) ptr;
+
+ for (i = 0; i < loc->argc; ++i)
+ xfree ((char *) loc->argv[i]);
+ xfree ((char *) loc->argv);
+ /* Note that the 'replacement' field is not allocated. */
+}
static void
macro_define_command (char *exp, int from_tty)
{
- error ("Command not implemented yet.");
+ struct macro_definition new_macro;
+ char *name = NULL;
+ struct cleanup *cleanup_chain;
+
+ if (!exp)
+ error (_("usage: macro define NAME[(ARGUMENT-LIST)] [REPLACEMENT-LIST]"));
+
+ cleanup_chain = make_cleanup (free_macro_definition_ptr, &new_macro);
+ make_cleanup (free_current_contents, &name);
+
+ memset (&new_macro, 0, sizeof (struct macro_definition));
+
+ skip_ws (&exp);
+ name = extract_identifier (&exp, 0);
+ if (! name)
+ error (_("Invalid macro name."));
+ if (*exp == '(')
+ {
+ /* Function-like macro. */
+ int alloced = 5;
+ char **argv = (char **) xmalloc (alloced * sizeof (char *));
+
+ new_macro.kind = macro_function_like;
+ new_macro.argc = 0;
+ new_macro.argv = (const char * const *) argv;
+
+ /* Skip the '(' and whitespace. */
+ ++exp;
+ skip_ws (&exp);
+
+ while (*exp != ')')
+ {
+ int i;
+
+ if (new_macro.argc == alloced)
+ {
+ alloced *= 2;
+ argv = (char **) xrealloc (argv, alloced * sizeof (char *));
+ /* Must update new_macro as well... */
+ new_macro.argv = (const char * const *) argv;
+ }
+ argv[new_macro.argc] = extract_identifier (&exp, 1);
+ if (! argv[new_macro.argc])
+ error (_("Macro is missing an argument."));
+ ++new_macro.argc;
+
+ for (i = new_macro.argc - 2; i >= 0; --i)
+ {
+ if (! strcmp (argv[i], argv[new_macro.argc - 1]))
+ error (_("Two macro arguments with identical names."));
+ }
+
+ skip_ws (&exp);
+ if (*exp == ',')
+ {
+ ++exp;
+ skip_ws (&exp);
+ }
+ else if (*exp != ')')
+ error (_("',' or ')' expected at end of macro arguments."));
+ }
+ /* Skip the closing paren. */
+ ++exp;
+ skip_ws (&exp);
+
+ macro_define_function (macro_main (macro_user_macros), -1, name,
+ new_macro.argc, (const char **) new_macro.argv,
+ exp);
+ }
+ else
+ {
+ skip_ws (&exp);
+ macro_define_object (macro_main (macro_user_macros), -1, name, exp);
+ }
+
+ do_cleanups (cleanup_chain);
}
static void
macro_undef_command (char *exp, int from_tty)
{
- error ("Command not implemented yet.");
+ char *name;
+
+ if (!exp)
+ error (_("usage: macro undef NAME"));
+
+ skip_ws (&exp);
+ name = extract_identifier (&exp, 0);
+ if (! name)
+ error (_("Invalid macro name."));
+ macro_undef (macro_main (macro_user_macros), -1, name);
+ xfree (name);
+}
+
+
+static void
+print_one_macro (const char *name, const struct macro_definition *macro,
+ void *ignore)
+{
+ fprintf_filtered (gdb_stdout, "macro define %s", name);
+ if (macro->kind == macro_function_like)
+ {
+ int i;
+
+ fprintf_filtered (gdb_stdout, "(");
+ for (i = 0; i < macro->argc; ++i)
+ fprintf_filtered (gdb_stdout, "%s%s", (i > 0) ? ", " : "",
+ macro->argv[i]);
+ fprintf_filtered (gdb_stdout, ")");
+ }
+ fprintf_filtered (gdb_stdout, " %s\n", macro->replacement);
}
static void
macro_list_command (char *exp, int from_tty)
{
- error ("Command not implemented yet.");
+ macro_for_each (macro_user_macros, print_one_macro, NULL);
}
void
_initialize_macrocmd (void)
{
- struct cmd_list_element *c;
-
/* We introduce a new command prefix, `macro', under which we'll put
the various commands for working with preprocessor macros. */
- add_prefix_cmd
- ("macro", class_info, macro_command,
- "Prefix for commands dealing with C preprocessor macros.",
- ¯olist, "macro ", 0, &cmdlist);
-
- add_cmd
- ("expand", no_class, macro_expand_command,
- "Fully expand any C/C++ preprocessor macro invocations in EXPRESSION.\n"
- "Show the expanded expression.",
- ¯olist);
+ add_prefix_cmd ("macro", class_info, macro_command,
+ _("Prefix for commands dealing with C preprocessor macros."),
+ ¯olist, "macro ", 0, &cmdlist);
+
+ add_cmd ("expand", no_class, macro_expand_command, _("\
+Fully expand any C/C++ preprocessor macro invocations in EXPRESSION.\n\
+Show the expanded expression."),
+ ¯olist);
add_alias_cmd ("exp", "expand", no_class, 1, ¯olist);
- add_cmd
- ("expand-once", no_class, macro_expand_once_command,
- "Expand C/C++ preprocessor macro invocations appearing directly in"
- " EXPRESSION.\n"
- "Show the expanded expression.\n"
- "\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"
- "introduces further macro invocations, those are left unexpanded.\n"
- "\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"
- "expression work together to yield a pre-processed expression.",
- ¯olist);
+ add_cmd ("expand-once", no_class, macro_expand_once_command, _("\
+Expand C/C++ preprocessor macro invocations appearing directly in EXPRESSION.\n\
+Show the expanded expression.\n\
+\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\
+introduces further macro invocations, those are left unexpanded.\n\
+\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\
+expression work together to yield a pre-processed expression."),
+ ¯olist);
add_alias_cmd ("exp1", "expand-once", no_class, 1, ¯olist);
- add_cmd
- ("macro", no_class, info_macro_command,
- "Show the definition of MACRO, and its source location.",
- &infolist);
-
- add_cmd
- ("define", no_class, macro_define_command,
- "Define a new C/C++ preprocessor macro.\n"
- "The GDB command `macro define DEFINITION' is equivalent to placing a\n"
- "preprocessor directive of the form `#define DEFINITION' such that the\n"
- "definition is visible in all the inferior's source files.\n"
- "For example:\n"
- " (gdb) macro define PI (3.1415926)\n"
- " (gdb) macro define MIN(x,y) ((x) < (y) ? (x) : (y))",
- ¯olist);
-
- add_cmd
- ("undef", no_class, macro_undef_command,
- "Remove the definition of the C/C++ preprocessor macro with the"
- " given name.",
- ¯olist);
-
- add_cmd
- ("list", no_class, macro_list_command,
- "List all the macros defined using the `macro define' command.",
- ¯olist);
-
- user_macros = new_macro_table (0, 0);
+ add_cmd ("macro", no_class, info_macro_command,
+ _("Show the definition of MACRO, and its source location."),
+ &infolist);
+
+ add_cmd ("define", no_class, macro_define_command, _("\
+Define a new C/C++ preprocessor macro.\n\
+The GDB command `macro define DEFINITION' is equivalent to placing a\n\
+preprocessor directive of the form `#define DEFINITION' such that the\n\
+definition is visible in all the inferior's source files.\n\
+For example:\n\
+ (gdb) macro define PI (3.1415926)\n\
+ (gdb) macro define MIN(x,y) ((x) < (y) ? (x) : (y))"),
+ ¯olist);
+
+ add_cmd ("undef", no_class, macro_undef_command, _("\
+Remove the definition of the C/C++ preprocessor macro with the given name."),
+ ¯olist);
+
+ add_cmd ("list", no_class, macro_list_command,
+ _("List all the macros defined using the `macro define' command."),
+ ¯olist);
}