1 /* gdb commands implemented in Python
3 Copyright (C) 2008-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
22 #include "arch-utils.h"
24 #include "exceptions.h"
25 #include "python-internal.h"
28 #include "cli/cli-decode.h"
29 #include "completer.h"
32 /* Struct representing built-in completion types. */
33 struct cmdpy_completer
35 /* Python symbol name. */
37 /* Completion function. */
38 completer_ftype *completer;
41 static struct cmdpy_completer completers[] =
43 { "COMPLETE_NONE", noop_completer },
44 { "COMPLETE_FILENAME", filename_completer },
45 { "COMPLETE_LOCATION", location_completer },
46 { "COMPLETE_COMMAND", command_completer },
47 { "COMPLETE_SYMBOL", make_symbol_completion_list_fn },
50 #define N_COMPLETERS (sizeof (completers) / sizeof (completers[0]))
52 /* A gdb command. For the time being only ordinary commands (not
53 set/show commands) are allowed. */
58 /* The corresponding gdb command object, or NULL if the command is
59 no longer installed. */
60 struct cmd_list_element *command;
62 /* A prefix command requires storage for a list of its sub-commands.
63 A pointer to this is passed to add_prefix_command, and to add_cmd
64 for sub-commands of that prefix. If this Command is not a prefix
65 command, then this field is unused. */
66 struct cmd_list_element *sub_list;
69 typedef struct cmdpy_object cmdpy_object;
71 static PyTypeObject cmdpy_object_type
72 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("cmdpy_object");
74 /* Constants used by this module. */
75 static PyObject *invoke_cst;
76 static PyObject *complete_cst;
80 /* Python function which wraps dont_repeat. */
82 cmdpy_dont_repeat (PyObject *self, PyObject *args)
90 /* Called if the gdb cmd_list_element is destroyed. */
93 cmdpy_destroyer (struct cmd_list_element *self, void *context)
96 struct cleanup *cleanup;
98 cleanup = ensure_python_env (get_current_arch (), current_language);
100 /* Release our hold on the command object. */
101 cmd = (cmdpy_object *) context;
105 /* We allocated the name, doc string, and perhaps the prefix
107 xfree ((char *) self->name);
109 xfree (self->prefixname);
111 do_cleanups (cleanup);
114 /* Called by gdb to invoke the command. */
117 cmdpy_function (struct cmd_list_element *command, char *args, int from_tty)
119 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
120 PyObject *argobj, *ttyobj, *result;
121 struct cleanup *cleanup;
123 cleanup = ensure_python_env (get_current_arch (), current_language);
126 error (_("Invalid invocation of Python command object."));
127 if (! PyObject_HasAttr ((PyObject *) obj, invoke_cst))
129 if (obj->command->prefixname)
131 /* A prefix command does not need an invoke method. */
132 do_cleanups (cleanup);
135 error (_("Python command object missing 'invoke' method."));
140 argobj = PyUnicode_Decode (args, strlen (args), host_charset (), NULL);
143 gdbpy_print_stack ();
144 error (_("Could not convert arguments to Python string."));
147 ttyobj = from_tty ? Py_True : Py_False;
149 result = PyObject_CallMethodObjArgs ((PyObject *) obj, invoke_cst, argobj,
156 PyObject *ptype, *pvalue, *ptraceback;
159 PyErr_Fetch (&ptype, &pvalue, &ptraceback);
161 /* Try to fetch an error message contained within ptype, pvalue.
162 When fetching the error message we need to make our own copy,
163 we no longer own ptype, pvalue after the call to PyErr_Restore. */
165 msg = gdbpy_exception_to_string (ptype, pvalue);
166 make_cleanup (xfree, msg);
170 /* An error occurred computing the string representation of the
171 error message. This is rare, but we should inform the user. */
172 printf_filtered (_("An error occurred in a Python command\n"
173 "and then another occurred computing the "
174 "error message.\n"));
175 gdbpy_print_stack ();
178 /* Don't print the stack for gdb.GdbError exceptions.
179 It is generally used to flag user errors.
181 We also don't want to print "Error occurred in Python command"
182 for user errors. However, a missing message for gdb.GdbError
183 exceptions is arguably a bug, so we flag it as such. */
185 if (! PyErr_GivenExceptionMatches (ptype, gdbpy_gdberror_exc)
186 || msg == NULL || *msg == '\0')
188 PyErr_Restore (ptype, pvalue, ptraceback);
189 gdbpy_print_stack ();
190 if (msg != NULL && *msg != '\0')
191 error (_("Error occurred in Python command: %s"), msg);
193 error (_("Error occurred in Python command."));
199 Py_XDECREF (ptraceback);
205 do_cleanups (cleanup);
208 /* Called by gdb for command completion. */
210 static VEC (char_ptr) *
211 cmdpy_completer (struct cmd_list_element *command,
212 const char *text, const char *word)
214 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
215 PyObject *textobj, *wordobj, *resultobj = NULL;
216 VEC (char_ptr) *result = NULL;
217 struct cleanup *cleanup;
219 cleanup = ensure_python_env (get_current_arch (), current_language);
222 error (_("Invalid invocation of Python command object."));
223 if (! PyObject_HasAttr ((PyObject *) obj, complete_cst))
225 /* If there is no complete method, don't error -- instead, just
226 say that there are no completions. */
230 textobj = PyUnicode_Decode (text, strlen (text), host_charset (), NULL);
232 error (_("Could not convert argument to Python string."));
233 wordobj = PyUnicode_Decode (word, strlen (word), host_charset (), NULL);
235 error (_("Could not convert argument to Python string."));
237 resultobj = PyObject_CallMethodObjArgs ((PyObject *) obj, complete_cst,
238 textobj, wordobj, NULL);
243 /* Just swallow errors here. */
247 make_cleanup_py_decref (resultobj);
250 if (PySequence_Check (resultobj))
252 Py_ssize_t i, len = PySequence_Size (resultobj);
258 for (i = out = 0; i < len; ++i)
260 PyObject *elt = PySequence_GetItem (resultobj, i);
263 if (elt == NULL || ! gdbpy_is_string (elt))
265 /* Skip problem elements. */
269 item = python_string_to_host_string (elt);
272 /* Skip problem elements. */
276 VEC_safe_push (char_ptr, result, item);
279 else if (PyInt_Check (resultobj))
281 /* User code may also return one of the completion constants,
282 thus requesting that sort of completion. */
285 if (! gdb_py_int_as_long (resultobj, &value))
290 else if (value >= 0 && value < (long) N_COMPLETERS)
291 result = completers[value].completer (command, text, word);
296 do_cleanups (cleanup);
301 /* Helper for cmdpy_init which locates the command list to use and
302 pulls out the command name.
304 NAME is the command name list. The final word in the list is the
305 name of the new command. All earlier words must be existing prefix
308 *BASE_LIST is set to the final prefix command's list of
311 START_LIST is the list in which the search starts.
313 This function returns the xmalloc()d name of the new command. On
314 error sets the Python error and returns NULL. */
317 gdbpy_parse_command_name (const char *name,
318 struct cmd_list_element ***base_list,
319 struct cmd_list_element **start_list)
321 struct cmd_list_element *elt;
322 int len = strlen (name);
325 const char *prefix_text2;
328 /* Skip trailing whitespace. */
329 for (i = len - 1; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i)
333 PyErr_SetString (PyExc_RuntimeError, _("No command name found."));
338 /* Find first character of the final word. */
339 for (; i > 0 && (isalnum (name[i - 1])
340 || name[i - 1] == '-'
341 || name[i - 1] == '_');
344 result = xmalloc (lastchar - i + 2);
345 memcpy (result, &name[i], lastchar - i + 1);
346 result[lastchar - i + 1] = '\0';
348 /* Skip whitespace again. */
349 for (--i; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i)
353 *base_list = start_list;
357 prefix_text = xmalloc (i + 2);
358 memcpy (prefix_text, name, i + 1);
359 prefix_text[i + 1] = '\0';
361 prefix_text2 = prefix_text;
362 elt = lookup_cmd_1 (&prefix_text2, *start_list, NULL, 1);
363 if (!elt || elt == (struct cmd_list_element *) -1)
365 PyErr_Format (PyExc_RuntimeError, _("Could not find command prefix %s."),
375 *base_list = elt->prefixlist;
379 PyErr_Format (PyExc_RuntimeError, _("'%s' is not a prefix command."),
386 /* Object initializer; sets up gdb-side structures for command.
388 Use: __init__(NAME, COMMAND_CLASS [, COMPLETER_CLASS][, PREFIX]]).
390 NAME is the name of the command. It may consist of multiple words,
391 in which case the final word is the name of the new command, and
392 earlier words must be prefix commands.
394 COMMAND_CLASS is the kind of command. It should be one of the COMMAND_*
395 constants defined in the gdb module.
397 COMPLETER_CLASS is the kind of completer. If not given, the
398 "complete" method will be used. Otherwise, it should be one of the
399 COMPLETE_* constants defined in the gdb module.
401 If PREFIX is True, then this command is a prefix command.
403 The documentation for the command is taken from the doc string for
407 cmdpy_init (PyObject *self, PyObject *args, PyObject *kw)
409 cmdpy_object *obj = (cmdpy_object *) self;
412 int completetype = -1;
413 char *docstring = NULL;
414 volatile struct gdb_exception except;
415 struct cmd_list_element **cmd_list;
416 char *cmd_name, *pfx_name;
417 static char *keywords[] = { "name", "command_class", "completer_class",
419 PyObject *is_prefix = NULL;
424 /* Note: this is apparently not documented in Python. We return
425 0 for success, -1 for failure. */
426 PyErr_Format (PyExc_RuntimeError,
427 _("Command object already initialized."));
431 if (! PyArg_ParseTupleAndKeywords (args, kw, "si|iO",
432 keywords, &name, &cmdtype,
433 &completetype, &is_prefix))
436 if (cmdtype != no_class && cmdtype != class_run
437 && cmdtype != class_vars && cmdtype != class_stack
438 && cmdtype != class_files && cmdtype != class_support
439 && cmdtype != class_info && cmdtype != class_breakpoint
440 && cmdtype != class_trace && cmdtype != class_obscure
441 && cmdtype != class_maintenance && cmdtype != class_user)
443 PyErr_Format (PyExc_RuntimeError, _("Invalid command class argument."));
447 if (completetype < -1 || completetype >= (int) N_COMPLETERS)
449 PyErr_Format (PyExc_RuntimeError,
450 _("Invalid completion type argument."));
454 cmd_name = gdbpy_parse_command_name (name, &cmd_list, &cmdlist);
459 if (is_prefix != NULL)
461 cmp = PyObject_IsTrue (is_prefix);
466 /* Make a normalized form of the command name. */
467 pfx_name = xmalloc (strlen (name) + 2);
473 /* Skip whitespace. */
474 while (name[i] == ' ' || name[i] == '\t')
476 /* Copy non-whitespace characters. */
477 while (name[i] && name[i] != ' ' && name[i] != '\t')
478 pfx_name[out++] = name[i++];
479 /* Add a single space after each word -- including the final
481 pfx_name[out++] = ' ';
483 pfx_name[out] = '\0';
491 if (PyObject_HasAttr (self, gdbpy_doc_cst))
493 PyObject *ds_obj = PyObject_GetAttr (self, gdbpy_doc_cst);
495 if (ds_obj && gdbpy_is_string (ds_obj))
497 docstring = python_string_to_host_string (ds_obj);
498 if (docstring == NULL)
507 docstring = xstrdup (_("This command is not documented."));
511 TRY_CATCH (except, RETURN_MASK_ALL)
513 struct cmd_list_element *cmd;
519 /* If we have our own "invoke" method, then allow unknown
521 allow_unknown = PyObject_HasAttr (self, invoke_cst);
522 cmd = add_prefix_cmd (cmd_name, (enum command_class) cmdtype,
523 NULL, docstring, &obj->sub_list,
524 pfx_name, allow_unknown, cmd_list);
527 cmd = add_cmd (cmd_name, (enum command_class) cmdtype, NULL,
528 docstring, cmd_list);
530 /* There appears to be no API to set this. */
531 cmd->func = cmdpy_function;
532 cmd->destroyer = cmdpy_destroyer;
535 set_cmd_context (cmd, self);
536 set_cmd_completer (cmd, ((completetype == -1) ? cmdpy_completer
537 : completers[completetype].completer));
539 if (except.reason < 0)
545 PyErr_Format (except.reason == RETURN_QUIT
546 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError,
547 "%s", except.message);
555 /* Initialize the 'commands' code. */
558 gdbpy_initialize_commands (void)
562 cmdpy_object_type.tp_new = PyType_GenericNew;
563 if (PyType_Ready (&cmdpy_object_type) < 0)
566 /* Note: alias and user are special; pseudo appears to be unused,
567 and there is no reason to expose tui or xdb, I think. */
568 if (PyModule_AddIntConstant (gdb_module, "COMMAND_NONE", no_class) < 0
569 || PyModule_AddIntConstant (gdb_module, "COMMAND_RUNNING", class_run) < 0
570 || PyModule_AddIntConstant (gdb_module, "COMMAND_DATA", class_vars) < 0
571 || PyModule_AddIntConstant (gdb_module, "COMMAND_STACK", class_stack) < 0
572 || PyModule_AddIntConstant (gdb_module, "COMMAND_FILES", class_files) < 0
573 || PyModule_AddIntConstant (gdb_module, "COMMAND_SUPPORT",
575 || PyModule_AddIntConstant (gdb_module, "COMMAND_STATUS", class_info) < 0
576 || PyModule_AddIntConstant (gdb_module, "COMMAND_BREAKPOINTS",
577 class_breakpoint) < 0
578 || PyModule_AddIntConstant (gdb_module, "COMMAND_TRACEPOINTS",
580 || PyModule_AddIntConstant (gdb_module, "COMMAND_OBSCURE",
582 || PyModule_AddIntConstant (gdb_module, "COMMAND_MAINTENANCE",
583 class_maintenance) < 0
584 || PyModule_AddIntConstant (gdb_module, "COMMAND_USER", class_user) < 0)
587 for (i = 0; i < N_COMPLETERS; ++i)
589 if (PyModule_AddIntConstant (gdb_module, completers[i].name, i) < 0)
593 Py_INCREF (&cmdpy_object_type);
594 PyModule_AddObject (gdb_module, "Command",
595 (PyObject *) &cmdpy_object_type);
597 invoke_cst = PyString_FromString ("invoke");
598 complete_cst = PyString_FromString ("complete");
603 static PyMethodDef cmdpy_object_methods[] =
605 { "dont_repeat", cmdpy_dont_repeat, METH_NOARGS,
606 "Prevent command repetition when user enters empty line." },
611 static PyTypeObject cmdpy_object_type =
613 PyVarObject_HEAD_INIT (NULL, 0)
614 "gdb.Command", /*tp_name*/
615 sizeof (cmdpy_object), /*tp_basicsize*/
624 0, /*tp_as_sequence*/
632 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
633 "GDB command object", /* tp_doc */
636 0, /* tp_richcompare */
637 0, /* tp_weaklistoffset */
640 cmdpy_object_methods, /* tp_methods */
645 0, /* tp_descr_get */
646 0, /* tp_descr_set */
647 0, /* tp_dictoffset */
648 cmdpy_init, /* tp_init */
654 /* Utility to build a buildargv-like result from ARGS.
655 This intentionally parses arguments the way libiberty/argv.c:buildargv
656 does. It splits up arguments in a reasonable way, and we want a standard
657 way of parsing arguments. Several gdb commands use buildargv to parse their
658 arguments. Plus we want to be able to write compatible python
659 implementations of gdb commands. */
662 gdbpy_string_to_argv (PyObject *self, PyObject *args)
667 if (!PyArg_ParseTuple (args, "s", &input))
670 py_argv = PyList_New (0);
672 /* buildargv uses NULL to represent an empty argument list, but we can't use
673 that in Python. Instead, if ARGS is "" then return an empty list.
674 This undoes the NULL -> "" conversion that cmdpy_function does. */
678 char **c_argv = gdb_buildargv (input);
681 for (i = 0; c_argv[i] != NULL; ++i)
683 PyObject *argp = PyString_FromString (c_argv[i]);
686 || PyList_Append (py_argv, argp) < 0)