9ff8eaaddf98a8b5b2b751fdb377aec89a962138
[deliverable/binutils-gdb.git] / gdb / python / py-cmd.c
1 /* gdb commands implemented in Python
2
3 Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, 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 3 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, see <http://www.gnu.org/licenses/>. */
19
20
21 #include "defs.h"
22 #include "arch-utils.h"
23 #include "value.h"
24 #include "exceptions.h"
25 #include "python-internal.h"
26 #include "charset.h"
27 #include "gdbcmd.h"
28 #include "cli/cli-decode.h"
29 #include "completer.h"
30 #include "language.h"
31
32 /* Struct representing built-in completion types. */
33 struct cmdpy_completer
34 {
35 /* Python symbol name. */
36 char *name;
37 /* Completion function. */
38 char **(*completer) (struct cmd_list_element *, char *, char *);
39 };
40
41 static struct cmdpy_completer completers[] =
42 {
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 },
48 };
49
50 #define N_COMPLETERS (sizeof (completers) / sizeof (completers[0]))
51
52 /* A gdb command. For the time being only ordinary commands (not
53 set/show commands) are allowed. */
54 struct cmdpy_object
55 {
56 PyObject_HEAD
57
58 /* The corresponding gdb command object, or NULL if the command is
59 no longer installed. */
60 struct cmd_list_element *command;
61
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;
67 };
68
69 typedef struct cmdpy_object cmdpy_object;
70
71 static PyTypeObject cmdpy_object_type;
72
73
74 /* Constants used by this module. */
75 static PyObject *invoke_cst;
76 static PyObject *complete_cst;
77
78 \f
79
80 /* Python function which wraps dont_repeat. */
81 static PyObject *
82 cmdpy_dont_repeat (PyObject *self, PyObject *args)
83 {
84 dont_repeat ();
85 Py_RETURN_NONE;
86 }
87
88 \f
89
90 /* Called if the gdb cmd_list_element is destroyed. */
91
92 static void
93 cmdpy_destroyer (struct cmd_list_element *self, void *context)
94 {
95 cmdpy_object *cmd;
96 struct cleanup *cleanup;
97
98 cleanup = ensure_python_env (get_current_arch (), current_language);
99
100 /* Release our hold on the command object. */
101 cmd = (cmdpy_object *) context;
102 cmd->command = NULL;
103 Py_DECREF (cmd);
104
105 /* We allocated the name, doc string, and perhaps the prefix
106 name. */
107 xfree (self->name);
108 xfree (self->doc);
109 xfree (self->prefixname);
110
111 do_cleanups (cleanup);
112 }
113
114 /* Called by gdb to invoke the command. */
115
116 static void
117 cmdpy_function (struct cmd_list_element *command, char *args, int from_tty)
118 {
119 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
120 PyObject *argobj, *ttyobj, *result;
121 struct cleanup *cleanup;
122
123 cleanup = ensure_python_env (get_current_arch (), current_language);
124
125 if (! obj)
126 error (_("Invalid invocation of Python command object."));
127 if (! PyObject_HasAttr ((PyObject *) obj, invoke_cst))
128 {
129 if (obj->command->prefixname)
130 {
131 /* A prefix command does not need an invoke method. */
132 do_cleanups (cleanup);
133 return;
134 }
135 error (_("Python command object missing 'invoke' method."));
136 }
137
138 if (! args)
139 args = "";
140 argobj = PyUnicode_Decode (args, strlen (args), host_charset (), NULL);
141 if (! argobj)
142 {
143 gdbpy_print_stack ();
144 error (_("Could not convert arguments to Python string."));
145 }
146
147 ttyobj = from_tty ? Py_True : Py_False;
148 Py_INCREF (ttyobj);
149 result = PyObject_CallMethodObjArgs ((PyObject *) obj, invoke_cst, argobj,
150 ttyobj, NULL);
151 Py_DECREF (argobj);
152 Py_DECREF (ttyobj);
153
154 if (! result)
155 {
156 PyObject *ptype, *pvalue, *ptraceback;
157 char *msg;
158
159 PyErr_Fetch (&ptype, &pvalue, &ptraceback);
160
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. */
164
165 msg = gdbpy_exception_to_string (ptype, pvalue);
166 make_cleanup (xfree, msg);
167
168 if (msg == NULL)
169 {
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 ();
176 }
177
178 /* Don't print the stack for gdb.GdbError exceptions.
179 It is generally used to flag user errors.
180
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. */
184
185 if (! PyErr_GivenExceptionMatches (ptype, gdbpy_gdberror_exc)
186 || msg == NULL || *msg == '\0')
187 {
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);
192 else
193 error (_("Error occurred in Python command."));
194 }
195 else
196 {
197 Py_XDECREF (ptype);
198 Py_XDECREF (pvalue);
199 Py_XDECREF (ptraceback);
200 error ("%s", msg);
201 }
202 }
203
204 Py_DECREF (result);
205 do_cleanups (cleanup);
206 }
207
208 /* Called by gdb for command completion. */
209 static char **
210 cmdpy_completer (struct cmd_list_element *command, char *text, char *word)
211 {
212 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
213 PyObject *textobj, *wordobj, *resultobj = NULL;
214 char **result = NULL;
215 struct cleanup *cleanup;
216
217 cleanup = ensure_python_env (get_current_arch (), current_language);
218
219 if (! obj)
220 error (_("Invalid invocation of Python command object."));
221 if (! PyObject_HasAttr ((PyObject *) obj, complete_cst))
222 {
223 /* If there is no complete method, don't error -- instead, just
224 say that there are no completions. */
225 goto done;
226 }
227
228 textobj = PyUnicode_Decode (text, strlen (text), host_charset (), NULL);
229 if (! textobj)
230 error (_("Could not convert argument to Python string."));
231 wordobj = PyUnicode_Decode (word, strlen (word), host_charset (), NULL);
232 if (! wordobj)
233 error (_("Could not convert argument to Python string."));
234
235 resultobj = PyObject_CallMethodObjArgs ((PyObject *) obj, complete_cst,
236 textobj, wordobj, NULL);
237 Py_DECREF (textobj);
238 Py_DECREF (wordobj);
239 if (! resultobj)
240 {
241 /* Just swallow errors here. */
242 PyErr_Clear ();
243 goto done;
244 }
245 make_cleanup_py_decref (resultobj);
246
247 result = NULL;
248 if (PySequence_Check (resultobj))
249 {
250 Py_ssize_t i, len = PySequence_Size (resultobj);
251 Py_ssize_t out;
252
253 if (len < 0)
254 goto done;
255
256 result = (char **) xmalloc ((len + 1) * sizeof (char *));
257 for (i = out = 0; i < len; ++i)
258 {
259 PyObject *elt = PySequence_GetItem (resultobj, i);
260
261 if (elt == NULL || ! gdbpy_is_string (elt))
262 {
263 /* Skip problem elements. */
264 PyErr_Clear ();
265 continue;
266 }
267 result[out] = python_string_to_host_string (elt);
268 if (result[out] == NULL)
269 {
270 /* Skip problem elements. */
271 PyErr_Clear ();
272 continue;
273 }
274 ++out;
275 }
276 result[out] = NULL;
277 }
278 else if (PyInt_Check (resultobj))
279 {
280 /* User code may also return one of the completion constants,
281 thus requesting that sort of completion. */
282 long value;
283
284 if (! gdb_py_int_as_long (resultobj, &value))
285 {
286 /* Ignore. */
287 PyErr_Clear ();
288 }
289 else if (value >= 0 && value < (long) N_COMPLETERS)
290 result = completers[value].completer (command, text, word);
291 }
292
293 done:
294
295 do_cleanups (cleanup);
296
297 return result;
298 }
299
300 /* Helper for cmdpy_init which locates the command list to use and
301 pulls out the command name.
302
303 TEXT is the command name list. The final word in the list is the
304 name of the new command. All earlier words must be existing prefix
305 commands.
306
307 *BASE_LIST is set to the final prefix command's list of
308 *sub-commands.
309
310 START_LIST is the list in which the search starts.
311
312 This function returns the xmalloc()d name of the new command. On
313 error sets the Python error and returns NULL. */
314 char *
315 gdbpy_parse_command_name (char *text,
316 struct cmd_list_element ***base_list,
317 struct cmd_list_element **start_list)
318 {
319 struct cmd_list_element *elt;
320 int len = strlen (text);
321 int i, lastchar;
322 char *prefix_text;
323 char *result;
324
325 /* Skip trailing whitespace. */
326 for (i = len - 1; i >= 0 && (text[i] == ' ' || text[i] == '\t'); --i)
327 ;
328 if (i < 0)
329 {
330 PyErr_SetString (PyExc_RuntimeError, _("No command name found."));
331 return NULL;
332 }
333 lastchar = i;
334
335 /* Find first character of the final word. */
336 for (; i > 0 && (isalnum (text[i - 1])
337 || text[i - 1] == '-'
338 || text[i - 1] == '_');
339 --i)
340 ;
341 result = xmalloc (lastchar - i + 2);
342 memcpy (result, &text[i], lastchar - i + 1);
343 result[lastchar - i + 1] = '\0';
344
345 /* Skip whitespace again. */
346 for (--i; i >= 0 && (text[i] == ' ' || text[i] == '\t'); --i)
347 ;
348 if (i < 0)
349 {
350 *base_list = start_list;
351 return result;
352 }
353
354 prefix_text = xmalloc (i + 2);
355 memcpy (prefix_text, text, i + 1);
356 prefix_text[i + 1] = '\0';
357
358 text = prefix_text;
359 elt = lookup_cmd_1 (&text, *start_list, NULL, 1);
360 if (!elt || elt == (struct cmd_list_element *) -1)
361 {
362 PyErr_Format (PyExc_RuntimeError, _("Could not find command prefix %s."),
363 prefix_text);
364 xfree (prefix_text);
365 xfree (result);
366 return NULL;
367 }
368
369 if (elt->prefixlist)
370 {
371 xfree (prefix_text);
372 *base_list = elt->prefixlist;
373 return result;
374 }
375
376 PyErr_Format (PyExc_RuntimeError, _("'%s' is not a prefix command."),
377 prefix_text);
378 xfree (prefix_text);
379 xfree (result);
380 return NULL;
381 }
382
383 /* Object initializer; sets up gdb-side structures for command.
384
385 Use: __init__(NAME, COMMAND_CLASS [, COMPLETER_CLASS][, PREFIX]]).
386
387 NAME is the name of the command. It may consist of multiple words,
388 in which case the final word is the name of the new command, and
389 earlier words must be prefix commands.
390
391 COMMAND_CLASS is the kind of command. It should be one of the COMMAND_*
392 constants defined in the gdb module.
393
394 COMPLETER_CLASS is the kind of completer. If not given, the
395 "complete" method will be used. Otherwise, it should be one of the
396 COMPLETE_* constants defined in the gdb module.
397
398 If PREFIX is True, then this command is a prefix command.
399
400 The documentation for the command is taken from the doc string for
401 the python class.
402
403 */
404 static int
405 cmdpy_init (PyObject *self, PyObject *args, PyObject *kw)
406 {
407 cmdpy_object *obj = (cmdpy_object *) self;
408 const char *name;
409 char *copy;
410 int cmdtype;
411 int completetype = -1;
412 char *docstring = NULL;
413 volatile struct gdb_exception except;
414 struct cmd_list_element **cmd_list;
415 char *cmd_name, *pfx_name;
416 static char *keywords[] = { "name", "command_class", "completer_class",
417 "prefix", NULL };
418 PyObject *is_prefix = NULL;
419 int cmp;
420
421 if (obj->command)
422 {
423 /* Note: this is apparently not documented in Python. We return
424 0 for success, -1 for failure. */
425 PyErr_Format (PyExc_RuntimeError,
426 _("Command object already initialized."));
427 return -1;
428 }
429
430 if (! PyArg_ParseTupleAndKeywords (args, kw, "si|iO",
431 keywords, &name, &cmdtype,
432 &completetype, &is_prefix))
433 return -1;
434
435 if (cmdtype != no_class && cmdtype != class_run
436 && cmdtype != class_vars && cmdtype != class_stack
437 && cmdtype != class_files && cmdtype != class_support
438 && cmdtype != class_info && cmdtype != class_breakpoint
439 && cmdtype != class_trace && cmdtype != class_obscure
440 && cmdtype != class_maintenance)
441 {
442 PyErr_Format (PyExc_RuntimeError, _("Invalid command class argument."));
443 return -1;
444 }
445
446 if (completetype < -1 || completetype >= (int) N_COMPLETERS)
447 {
448 PyErr_Format (PyExc_RuntimeError,
449 _("Invalid completion type argument."));
450 return -1;
451 }
452
453 copy = xstrdup (name);
454 cmd_name = gdbpy_parse_command_name (copy, &cmd_list, &cmdlist);
455 xfree (copy);
456 if (! cmd_name)
457 return -1;
458
459 pfx_name = NULL;
460 if (is_prefix != NULL)
461 {
462 cmp = PyObject_IsTrue (is_prefix);
463 if (cmp == 1)
464 {
465 int i, out;
466
467 /* Make a normalized form of the command name. */
468 pfx_name = xmalloc (strlen (name) + 2);
469
470 i = 0;
471 out = 0;
472 while (name[i])
473 {
474 /* Skip whitespace. */
475 while (name[i] == ' ' || name[i] == '\t')
476 ++i;
477 /* Copy non-whitespace characters. */
478 while (name[i] && name[i] != ' ' && name[i] != '\t')
479 pfx_name[out++] = name[i++];
480 /* Add a single space after each word -- including the final
481 word. */
482 pfx_name[out++] = ' ';
483 }
484 pfx_name[out] = '\0';
485 }
486 else if (cmp < 0)
487 {
488 xfree (cmd_name);
489 return -1;
490 }
491 }
492 if (PyObject_HasAttr (self, gdbpy_doc_cst))
493 {
494 PyObject *ds_obj = PyObject_GetAttr (self, gdbpy_doc_cst);
495
496 if (ds_obj && gdbpy_is_string (ds_obj))
497 {
498 docstring = python_string_to_host_string (ds_obj);
499 if (docstring == NULL)
500 {
501 xfree (cmd_name);
502 xfree (pfx_name);
503 return -1;
504 }
505 }
506 }
507 if (! docstring)
508 docstring = xstrdup (_("This command is not documented."));
509
510 Py_INCREF (self);
511
512 TRY_CATCH (except, RETURN_MASK_ALL)
513 {
514 struct cmd_list_element *cmd;
515
516 if (pfx_name)
517 {
518 int allow_unknown;
519
520 /* If we have our own "invoke" method, then allow unknown
521 sub-commands. */
522 allow_unknown = PyObject_HasAttr (self, invoke_cst);
523 cmd = add_prefix_cmd (cmd_name, (enum command_class) cmdtype,
524 NULL, docstring, &obj->sub_list,
525 pfx_name, allow_unknown, cmd_list);
526 }
527 else
528 cmd = add_cmd (cmd_name, (enum command_class) cmdtype, NULL,
529 docstring, cmd_list);
530
531 /* There appears to be no API to set this. */
532 cmd->func = cmdpy_function;
533 cmd->destroyer = cmdpy_destroyer;
534
535 obj->command = cmd;
536 set_cmd_context (cmd, self);
537 set_cmd_completer (cmd, ((completetype == -1) ? cmdpy_completer
538 : completers[completetype].completer));
539 }
540 if (except.reason < 0)
541 {
542 xfree (cmd_name);
543 xfree (docstring);
544 xfree (pfx_name);
545 Py_DECREF (self);
546 PyErr_Format (except.reason == RETURN_QUIT
547 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError,
548 "%s", except.message);
549 return -1;
550 }
551 return 0;
552 }
553
554 \f
555
556 /* Initialize the 'commands' code. */
557 void
558 gdbpy_initialize_commands (void)
559 {
560 int i;
561
562 cmdpy_object_type.tp_new = PyType_GenericNew;
563 if (PyType_Ready (&cmdpy_object_type) < 0)
564 return;
565
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",
574 class_support) < 0
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",
579 class_trace) < 0
580 || PyModule_AddIntConstant (gdb_module, "COMMAND_OBSCURE",
581 class_obscure) < 0
582 || PyModule_AddIntConstant (gdb_module, "COMMAND_MAINTENANCE",
583 class_maintenance) < 0)
584 return;
585
586 for (i = 0; i < N_COMPLETERS; ++i)
587 {
588 if (PyModule_AddIntConstant (gdb_module, completers[i].name, i) < 0)
589 return;
590 }
591
592 Py_INCREF (&cmdpy_object_type);
593 PyModule_AddObject (gdb_module, "Command",
594 (PyObject *) &cmdpy_object_type);
595
596 invoke_cst = PyString_FromString ("invoke");
597 complete_cst = PyString_FromString ("complete");
598 }
599
600 \f
601
602 static PyMethodDef cmdpy_object_methods[] =
603 {
604 { "dont_repeat", cmdpy_dont_repeat, METH_NOARGS,
605 "Prevent command repetition when user enters empty line." },
606
607 { 0 }
608 };
609
610 static PyTypeObject cmdpy_object_type =
611 {
612 PyObject_HEAD_INIT (NULL)
613 0, /*ob_size*/
614 "gdb.Command", /*tp_name*/
615 sizeof (cmdpy_object), /*tp_basicsize*/
616 0, /*tp_itemsize*/
617 0, /*tp_dealloc*/
618 0, /*tp_print*/
619 0, /*tp_getattr*/
620 0, /*tp_setattr*/
621 0, /*tp_compare*/
622 0, /*tp_repr*/
623 0, /*tp_as_number*/
624 0, /*tp_as_sequence*/
625 0, /*tp_as_mapping*/
626 0, /*tp_hash */
627 0, /*tp_call*/
628 0, /*tp_str*/
629 0, /*tp_getattro*/
630 0, /*tp_setattro*/
631 0, /*tp_as_buffer*/
632 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
633 "GDB command object", /* tp_doc */
634 0, /* tp_traverse */
635 0, /* tp_clear */
636 0, /* tp_richcompare */
637 0, /* tp_weaklistoffset */
638 0, /* tp_iter */
639 0, /* tp_iternext */
640 cmdpy_object_methods, /* tp_methods */
641 0, /* tp_members */
642 0, /* tp_getset */
643 0, /* tp_base */
644 0, /* tp_dict */
645 0, /* tp_descr_get */
646 0, /* tp_descr_set */
647 0, /* tp_dictoffset */
648 cmdpy_init, /* tp_init */
649 0, /* tp_alloc */
650 };
651
652 \f
653
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. */
660
661 PyObject *
662 gdbpy_string_to_argv (PyObject *self, PyObject *args)
663 {
664 PyObject *py_argv;
665 const char *input;
666
667 if (!PyArg_ParseTuple (args, "s", &input))
668 return NULL;
669
670 py_argv = PyList_New (0);
671
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. */
675
676 if (*input != '\0')
677 {
678 char **c_argv = gdb_buildargv (input);
679 int i;
680
681 for (i = 0; c_argv[i] != NULL; ++i)
682 {
683 PyObject *argp = PyString_FromString (c_argv[i]);
684
685 if (argp == NULL
686 || PyList_Append (py_argv, argp) < 0)
687 {
688 if (argp != NULL)
689 {
690 Py_DECREF (argp);
691 }
692 Py_DECREF (py_argv);
693 freeargv (c_argv);
694 return NULL;
695 }
696 }
697
698 freeargv (c_argv);
699 }
700
701 return py_argv;
702 }
This page took 0.066394 seconds and 4 git commands to generate.