Remove ensure_python_env
[deliverable/binutils-gdb.git] / gdb / python / py-cmd.c
CommitLineData
d8906c6f
TJB
1/* gdb commands implemented in Python
2
61baf725 3 Copyright (C) 2008-2017 Free Software Foundation, Inc.
d8906c6f
TJB
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"
d452c4bc 22#include "arch-utils.h"
d8906c6f 23#include "value.h"
d8906c6f
TJB
24#include "python-internal.h"
25#include "charset.h"
26#include "gdbcmd.h"
27#include "cli/cli-decode.h"
28#include "completer.h"
d452c4bc 29#include "language.h"
d1b3de2e 30#include "py-ref.h"
d8906c6f
TJB
31
32/* Struct representing built-in completion types. */
33struct cmdpy_completer
34{
75ddda77
DE
35 /* Python symbol name.
36 This isn't a const char * for Python 2.4's sake.
37 PyModule_AddIntConstant only takes a char *, sigh. */
d8906c6f
TJB
38 char *name;
39 /* Completion function. */
625e8578 40 completer_ftype *completer;
d8906c6f
TJB
41};
42
75ddda77 43static const struct cmdpy_completer completers[] =
d8906c6f
TJB
44{
45 { "COMPLETE_NONE", noop_completer },
46 { "COMPLETE_FILENAME", filename_completer },
47 { "COMPLETE_LOCATION", location_completer },
48 { "COMPLETE_COMMAND", command_completer },
49 { "COMPLETE_SYMBOL", make_symbol_completion_list_fn },
92e32e33 50 { "COMPLETE_EXPRESSION", expression_completer },
d8906c6f
TJB
51};
52
53#define N_COMPLETERS (sizeof (completers) / sizeof (completers[0]))
54
55/* A gdb command. For the time being only ordinary commands (not
56 set/show commands) are allowed. */
57struct cmdpy_object
58{
59 PyObject_HEAD
60
61 /* The corresponding gdb command object, or NULL if the command is
62 no longer installed. */
63 struct cmd_list_element *command;
64
65 /* A prefix command requires storage for a list of its sub-commands.
66 A pointer to this is passed to add_prefix_command, and to add_cmd
67 for sub-commands of that prefix. If this Command is not a prefix
68 command, then this field is unused. */
69 struct cmd_list_element *sub_list;
70};
71
72typedef struct cmdpy_object cmdpy_object;
73
e36122e9 74extern PyTypeObject cmdpy_object_type
62eec1a5 75 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("cmdpy_object");
d8906c6f 76
d8906c6f
TJB
77/* Constants used by this module. */
78static PyObject *invoke_cst;
79static PyObject *complete_cst;
80
81\f
82
83/* Python function which wraps dont_repeat. */
84static PyObject *
85cmdpy_dont_repeat (PyObject *self, PyObject *args)
86{
87 dont_repeat ();
88 Py_RETURN_NONE;
89}
90
91\f
92
93/* Called if the gdb cmd_list_element is destroyed. */
07ca107c 94
d8906c6f
TJB
95static void
96cmdpy_destroyer (struct cmd_list_element *self, void *context)
97{
98 cmdpy_object *cmd;
d8906c6f 99
6ba0cd40 100 gdbpy_enter enter_py (get_current_arch (), current_language);
d8906c6f
TJB
101
102 /* Release our hold on the command object. */
103 cmd = (cmdpy_object *) context;
104 cmd->command = NULL;
105 Py_DECREF (cmd);
106
107 /* We allocated the name, doc string, and perhaps the prefix
108 name. */
6f937416 109 xfree ((char *) self->name);
1947513d 110 xfree ((char *) self->doc);
64e61d29 111 xfree ((char *) self->prefixname);
d8906c6f
TJB
112}
113
114/* Called by gdb to invoke the command. */
07ca107c 115
d8906c6f
TJB
116static void
117cmdpy_function (struct cmd_list_element *command, char *args, int from_tty)
118{
119 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
d8906c6f 120
12a5cedd 121 gdbpy_enter enter_py (get_current_arch (), current_language);
d8906c6f
TJB
122
123 if (! obj)
124 error (_("Invalid invocation of Python command object."));
125 if (! PyObject_HasAttr ((PyObject *) obj, invoke_cst))
126 {
127 if (obj->command->prefixname)
128 {
129 /* A prefix command does not need an invoke method. */
d8906c6f
TJB
130 return;
131 }
132 error (_("Python command object missing 'invoke' method."));
133 }
134
135 if (! args)
136 args = "";
12a5cedd
TT
137 gdbpy_ref argobj (PyUnicode_Decode (args, strlen (args), host_charset (),
138 NULL));
139 if (argobj == NULL)
8dc78533
JK
140 {
141 gdbpy_print_stack ();
142 error (_("Could not convert arguments to Python string."));
143 }
d8906c6f 144
12a5cedd
TT
145 gdbpy_ref ttyobj (from_tty ? Py_True : Py_False);
146 Py_INCREF (ttyobj.get ());
147 gdbpy_ref result (PyObject_CallMethodObjArgs ((PyObject *) obj, invoke_cst,
148 argobj.get (), ttyobj.get (),
149 NULL));
07ca107c 150
12a5cedd 151 if (result == NULL)
d8906c6f
TJB
152 {
153 PyObject *ptype, *pvalue, *ptraceback;
d8906c6f
TJB
154
155 PyErr_Fetch (&ptype, &pvalue, &ptraceback);
156
07ca107c
DE
157 /* Try to fetch an error message contained within ptype, pvalue.
158 When fetching the error message we need to make our own copy,
159 we no longer own ptype, pvalue after the call to PyErr_Restore. */
d8906c6f 160
9b972014
TT
161 gdb::unique_xmalloc_ptr<char>
162 msg (gdbpy_exception_to_string (ptype, pvalue));
07ca107c
DE
163
164 if (msg == NULL)
165 {
166 /* An error occurred computing the string representation of the
167 error message. This is rare, but we should inform the user. */
168 printf_filtered (_("An error occurred in a Python command\n"
9a2b4c1b
MS
169 "and then another occurred computing the "
170 "error message.\n"));
d8906c6f 171 gdbpy_print_stack ();
d8906c6f 172 }
07ca107c
DE
173
174 /* Don't print the stack for gdb.GdbError exceptions.
175 It is generally used to flag user errors.
176
177 We also don't want to print "Error occurred in Python command"
178 for user errors. However, a missing message for gdb.GdbError
179 exceptions is arguably a bug, so we flag it as such. */
180
181 if (! PyErr_GivenExceptionMatches (ptype, gdbpy_gdberror_exc)
182 || msg == NULL || *msg == '\0')
d8906c6f
TJB
183 {
184 PyErr_Restore (ptype, pvalue, ptraceback);
185 gdbpy_print_stack ();
07ca107c 186 if (msg != NULL && *msg != '\0')
9b972014 187 error (_("Error occurred in Python command: %s"), msg.get ());
07ca107c
DE
188 else
189 error (_("Error occurred in Python command."));
d8906c6f 190 }
07ca107c 191 else
cca56ac7
TT
192 {
193 Py_XDECREF (ptype);
194 Py_XDECREF (pvalue);
195 Py_XDECREF (ptraceback);
9b972014 196 error ("%s", msg.get ());
cca56ac7 197 }
d8906c6f 198 }
d8906c6f
TJB
199}
200
7d793aa9
SDJ
201/* Helper function for the Python command completers (both "pure"
202 completer and brkchar handler). This function takes COMMAND, TEXT
203 and WORD and tries to call the Python method for completion with
6d62641c
SDJ
204 these arguments.
205
206 This function is usually called twice: once when we are figuring out
207 the break characters to be used, and another to perform the real
208 completion itself. The reason for this two step dance is that we
209 need to know the set of "brkchars" to use early on, before we
210 actually try to perform the completion. But if a Python command
211 supplies a "complete" method then we have to call that method
212 first: it may return as its result the kind of completion to
213 perform and that will in turn specify which brkchars to use. IOW,
214 we need the result of the "complete" method before we actually
215 perform the completion. The only situation when this function is
216 not called twice is when the user uses the "complete" command: in
217 this scenario, there is no call to determine the "brkchars".
218
219 Ideally, it would be nice to cache the result of the first call (to
220 determine the "brkchars") and return this value directly in the
221 second call (to perform the actual completion). However, due to
222 the peculiarity of the "complete" command mentioned above, it is
223 possible to put GDB in a bad state if you perform a TAB-completion
224 and then a "complete"-completion sequentially. Therefore, we just
225 recalculate everything twice for TAB-completions.
7d793aa9
SDJ
226
227 This function returns the PyObject representing the Python method
228 call. */
229
230static PyObject *
231cmdpy_completer_helper (struct cmd_list_element *command,
6d62641c 232 const char *text, const char *word)
7d793aa9
SDJ
233{
234 cmdpy_object *obj = (cmdpy_object *) get_cmd_context (command);
235 PyObject *textobj, *wordobj;
6d62641c 236 PyObject *resultobj;
7d793aa9 237
6d62641c
SDJ
238 if (obj == NULL)
239 error (_("Invalid invocation of Python command object."));
240 if (!PyObject_HasAttr ((PyObject *) obj, complete_cst))
7d793aa9 241 {
6d62641c
SDJ
242 /* If there is no complete method, don't error. */
243 return NULL;
244 }
7d793aa9 245
6d62641c
SDJ
246 textobj = PyUnicode_Decode (text, strlen (text), host_charset (), NULL);
247 if (textobj == NULL)
248 error (_("Could not convert argument to Python string."));
249 wordobj = PyUnicode_Decode (word, strlen (word), host_charset (), NULL);
250 if (wordobj == NULL)
251 {
7d793aa9 252 Py_DECREF (textobj);
6d62641c
SDJ
253 error (_("Could not convert argument to Python string."));
254 }
7d793aa9 255
6d62641c
SDJ
256 resultobj = PyObject_CallMethodObjArgs ((PyObject *) obj, complete_cst,
257 textobj, wordobj, NULL);
258 Py_DECREF (textobj);
259 Py_DECREF (wordobj);
260 if (!resultobj)
261 {
262 /* Just swallow errors here. */
263 PyErr_Clear ();
7d793aa9
SDJ
264 }
265
6d62641c
SDJ
266 Py_XINCREF (resultobj);
267
7d793aa9
SDJ
268 return resultobj;
269}
270
271/* Python function called to determine the break characters of a
272 certain completer. We are only interested in knowing if the
273 completer registered by the user will return one of the integer
274 codes (see COMPLETER_* symbols). */
275
276static void
277cmdpy_completer_handle_brkchars (struct cmd_list_element *command,
278 const char *text, const char *word)
279{
280 PyObject *resultobj = NULL;
7d793aa9 281
6ba0cd40 282 gdbpy_enter enter_py (get_current_arch (), current_language);
7d793aa9
SDJ
283
284 /* Calling our helper to obtain the PyObject of the Python
285 function. */
6d62641c 286 resultobj = cmdpy_completer_helper (command, text, word);
7d793aa9
SDJ
287
288 /* Check if there was an error. */
289 if (resultobj == NULL)
290 goto done;
291
292 if (PyInt_Check (resultobj))
293 {
294 /* User code may also return one of the completion constants,
295 thus requesting that sort of completion. We are only
296 interested in this kind of return. */
297 long value;
298
299 if (!gdb_py_int_as_long (resultobj, &value))
300 {
301 /* Ignore. */
302 PyErr_Clear ();
303 }
304 else if (value >= 0 && value < (long) N_COMPLETERS)
305 {
306 /* This is the core of this function. Depending on which
307 completer type the Python function returns, we have to
308 adjust the break characters accordingly. */
309 set_gdb_completion_word_break_characters
310 (completers[value].completer);
311 }
312 }
313
314 done:
315
6d62641c 316 Py_XDECREF (resultobj);
7d793aa9
SDJ
317}
318
d8906c6f 319/* Called by gdb for command completion. */
63d97a20 320
49c4e619 321static VEC (char_ptr) *
6f937416
PA
322cmdpy_completer (struct cmd_list_element *command,
323 const char *text, const char *word)
d8906c6f 324{
7d793aa9 325 PyObject *resultobj = NULL;
49c4e619 326 VEC (char_ptr) *result = NULL;
d8906c6f 327
6ba0cd40 328 gdbpy_enter enter_py (get_current_arch (), current_language);
d8906c6f 329
7d793aa9
SDJ
330 /* Calling our helper to obtain the PyObject of the Python
331 function. */
6d62641c 332 resultobj = cmdpy_completer_helper (command, text, word);
d8906c6f 333
7d793aa9
SDJ
334 /* If the result object of calling the Python function is NULL, it
335 means that there was an error. In this case, just give up and
336 return NULL. */
337 if (resultobj == NULL)
338 goto done;
d8906c6f
TJB
339
340 result = NULL;
ba327838 341 if (PyInt_Check (resultobj))
d8906c6f 342 {
ba327838
TT
343 /* User code may also return one of the completion constants,
344 thus requesting that sort of completion. */
345 long value;
346
347 if (! gdb_py_int_as_long (resultobj, &value))
348 {
349 /* Ignore. */
350 PyErr_Clear ();
351 }
352 else if (value >= 0 && value < (long) N_COMPLETERS)
353 result = completers[value].completer (command, text, word);
354 }
355 else
356 {
357 PyObject *iter = PyObject_GetIter (resultobj);
358 PyObject *elt;
d59b6f6c 359
ba327838 360 if (iter == NULL)
d8906c6f
TJB
361 goto done;
362
ba327838 363 while ((elt = PyIter_Next (iter)) != NULL)
d8906c6f 364 {
d59b6f6c 365
ba327838 366 if (! gdbpy_is_string (elt))
d8906c6f
TJB
367 {
368 /* Skip problem elements. */
ba327838 369 Py_DECREF (elt);
d8906c6f
TJB
370 continue;
371 }
9b972014
TT
372 gdb::unique_xmalloc_ptr<char>
373 item (python_string_to_host_string (elt));
ba327838 374 Py_DECREF (elt);
49c4e619 375 if (item == NULL)
8dc78533
JK
376 {
377 /* Skip problem elements. */
378 PyErr_Clear ();
379 continue;
380 }
9b972014 381 VEC_safe_push (char_ptr, result, item.release ());
d8906c6f 382 }
d59b6f6c 383
ba327838
TT
384 Py_DECREF (iter);
385
386 /* If we got some results, ignore problems. Otherwise, report
387 the problem. */
388 if (result != NULL && PyErr_Occurred ())
389 PyErr_Clear ();
d8906c6f
TJB
390 }
391
392 done:
393
6d62641c 394 Py_XDECREF (resultobj);
d8906c6f
TJB
395
396 return result;
397}
398
399/* Helper for cmdpy_init which locates the command list to use and
400 pulls out the command name.
256458bc 401
63d97a20 402 NAME is the command name list. The final word in the list is the
d8906c6f
TJB
403 name of the new command. All earlier words must be existing prefix
404 commands.
405
406 *BASE_LIST is set to the final prefix command's list of
407 *sub-commands.
256458bc 408
d7b32ed3
PM
409 START_LIST is the list in which the search starts.
410
d8906c6f
TJB
411 This function returns the xmalloc()d name of the new command. On
412 error sets the Python error and returns NULL. */
63d97a20 413
d7b32ed3 414char *
63d97a20 415gdbpy_parse_command_name (const char *name,
d7b32ed3
PM
416 struct cmd_list_element ***base_list,
417 struct cmd_list_element **start_list)
d8906c6f
TJB
418{
419 struct cmd_list_element *elt;
63d97a20 420 int len = strlen (name);
d8906c6f 421 int i, lastchar;
6f937416
PA
422 char *prefix_text;
423 const char *prefix_text2;
d8906c6f
TJB
424 char *result;
425
426 /* Skip trailing whitespace. */
63d97a20 427 for (i = len - 1; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i)
d8906c6f
TJB
428 ;
429 if (i < 0)
430 {
044c0f87 431 PyErr_SetString (PyExc_RuntimeError, _("No command name found."));
d8906c6f
TJB
432 return NULL;
433 }
434 lastchar = i;
435
436 /* Find first character of the final word. */
63d97a20
DE
437 for (; i > 0 && (isalnum (name[i - 1])
438 || name[i - 1] == '-'
439 || name[i - 1] == '_');
d8906c6f
TJB
440 --i)
441 ;
224c3ddb 442 result = (char *) xmalloc (lastchar - i + 2);
63d97a20 443 memcpy (result, &name[i], lastchar - i + 1);
d8906c6f
TJB
444 result[lastchar - i + 1] = '\0';
445
446 /* Skip whitespace again. */
63d97a20 447 for (--i; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i)
d8906c6f
TJB
448 ;
449 if (i < 0)
450 {
d7b32ed3 451 *base_list = start_list;
d8906c6f
TJB
452 return result;
453 }
454
224c3ddb 455 prefix_text = (char *) xmalloc (i + 2);
63d97a20 456 memcpy (prefix_text, name, i + 1);
d8906c6f
TJB
457 prefix_text[i + 1] = '\0';
458
63d97a20
DE
459 prefix_text2 = prefix_text;
460 elt = lookup_cmd_1 (&prefix_text2, *start_list, NULL, 1);
d81412aa 461 if (elt == NULL || elt == CMD_LIST_AMBIGUOUS)
d8906c6f 462 {
044c0f87 463 PyErr_Format (PyExc_RuntimeError, _("Could not find command prefix %s."),
d8906c6f
TJB
464 prefix_text);
465 xfree (prefix_text);
466 xfree (result);
467 return NULL;
468 }
469
470 if (elt->prefixlist)
471 {
472 xfree (prefix_text);
473 *base_list = elt->prefixlist;
474 return result;
475 }
476
044c0f87 477 PyErr_Format (PyExc_RuntimeError, _("'%s' is not a prefix command."),
d8906c6f
TJB
478 prefix_text);
479 xfree (prefix_text);
480 xfree (result);
481 return NULL;
482}
483
484/* Object initializer; sets up gdb-side structures for command.
485
cc924cad 486 Use: __init__(NAME, COMMAND_CLASS [, COMPLETER_CLASS][, PREFIX]]).
d8906c6f
TJB
487
488 NAME is the name of the command. It may consist of multiple words,
489 in which case the final word is the name of the new command, and
490 earlier words must be prefix commands.
491
cc924cad 492 COMMAND_CLASS is the kind of command. It should be one of the COMMAND_*
d8906c6f
TJB
493 constants defined in the gdb module.
494
cc924cad 495 COMPLETER_CLASS is the kind of completer. If not given, the
d8906c6f
TJB
496 "complete" method will be used. Otherwise, it should be one of the
497 COMPLETE_* constants defined in the gdb module.
498
499 If PREFIX is True, then this command is a prefix command.
500
501 The documentation for the command is taken from the doc string for
63d97a20
DE
502 the python class. */
503
d8906c6f 504static int
cc924cad 505cmdpy_init (PyObject *self, PyObject *args, PyObject *kw)
d8906c6f
TJB
506{
507 cmdpy_object *obj = (cmdpy_object *) self;
ddd49eee 508 const char *name;
d8906c6f
TJB
509 int cmdtype;
510 int completetype = -1;
511 char *docstring = NULL;
d8906c6f
TJB
512 struct cmd_list_element **cmd_list;
513 char *cmd_name, *pfx_name;
cc924cad
TJB
514 static char *keywords[] = { "name", "command_class", "completer_class",
515 "prefix", NULL };
d8906c6f
TJB
516 PyObject *is_prefix = NULL;
517 int cmp;
518
519 if (obj->command)
520 {
521 /* Note: this is apparently not documented in Python. We return
522 0 for success, -1 for failure. */
523 PyErr_Format (PyExc_RuntimeError,
044c0f87 524 _("Command object already initialized."));
d8906c6f
TJB
525 return -1;
526 }
527
9a2b4c1b
MS
528 if (! PyArg_ParseTupleAndKeywords (args, kw, "si|iO",
529 keywords, &name, &cmdtype,
d8906c6f
TJB
530 &completetype, &is_prefix))
531 return -1;
532
533 if (cmdtype != no_class && cmdtype != class_run
534 && cmdtype != class_vars && cmdtype != class_stack
535 && cmdtype != class_files && cmdtype != class_support
536 && cmdtype != class_info && cmdtype != class_breakpoint
537 && cmdtype != class_trace && cmdtype != class_obscure
7d74f244 538 && cmdtype != class_maintenance && cmdtype != class_user)
d8906c6f 539 {
044c0f87 540 PyErr_Format (PyExc_RuntimeError, _("Invalid command class argument."));
d8906c6f
TJB
541 return -1;
542 }
543
544 if (completetype < -1 || completetype >= (int) N_COMPLETERS)
545 {
9a2b4c1b
MS
546 PyErr_Format (PyExc_RuntimeError,
547 _("Invalid completion type argument."));
d8906c6f
TJB
548 return -1;
549 }
550
63d97a20 551 cmd_name = gdbpy_parse_command_name (name, &cmd_list, &cmdlist);
d8906c6f
TJB
552 if (! cmd_name)
553 return -1;
554
555 pfx_name = NULL;
256458bc 556 if (is_prefix != NULL)
d8906c6f
TJB
557 {
558 cmp = PyObject_IsTrue (is_prefix);
559 if (cmp == 1)
560 {
561 int i, out;
256458bc 562
d8906c6f 563 /* Make a normalized form of the command name. */
224c3ddb 564 pfx_name = (char *) xmalloc (strlen (name) + 2);
256458bc 565
d8906c6f
TJB
566 i = 0;
567 out = 0;
568 while (name[i])
569 {
570 /* Skip whitespace. */
571 while (name[i] == ' ' || name[i] == '\t')
572 ++i;
573 /* Copy non-whitespace characters. */
574 while (name[i] && name[i] != ' ' && name[i] != '\t')
575 pfx_name[out++] = name[i++];
576 /* Add a single space after each word -- including the final
577 word. */
578 pfx_name[out++] = ' ';
579 }
580 pfx_name[out] = '\0';
581 }
582 else if (cmp < 0)
e463f587
MS
583 {
584 xfree (cmd_name);
d8906c6f 585 return -1;
e463f587 586 }
d8906c6f
TJB
587 }
588 if (PyObject_HasAttr (self, gdbpy_doc_cst))
589 {
590 PyObject *ds_obj = PyObject_GetAttr (self, gdbpy_doc_cst);
d59b6f6c 591
d8906c6f 592 if (ds_obj && gdbpy_is_string (ds_obj))
8dc78533 593 {
9b972014 594 docstring = python_string_to_host_string (ds_obj).release ();
8dc78533
JK
595 if (docstring == NULL)
596 {
597 xfree (cmd_name);
598 xfree (pfx_name);
d8191432 599 Py_DECREF (ds_obj);
8dc78533
JK
600 return -1;
601 }
602 }
d8191432
TT
603
604 Py_XDECREF (ds_obj);
d8906c6f
TJB
605 }
606 if (! docstring)
607 docstring = xstrdup (_("This command is not documented."));
608
609 Py_INCREF (self);
610
492d29ea 611 TRY
d8906c6f
TJB
612 {
613 struct cmd_list_element *cmd;
614
615 if (pfx_name)
616 {
617 int allow_unknown;
618
619 /* If we have our own "invoke" method, then allow unknown
620 sub-commands. */
621 allow_unknown = PyObject_HasAttr (self, invoke_cst);
622 cmd = add_prefix_cmd (cmd_name, (enum command_class) cmdtype,
623 NULL, docstring, &obj->sub_list,
624 pfx_name, allow_unknown, cmd_list);
625 }
626 else
627 cmd = add_cmd (cmd_name, (enum command_class) cmdtype, NULL,
628 docstring, cmd_list);
629
630 /* There appears to be no API to set this. */
631 cmd->func = cmdpy_function;
632 cmd->destroyer = cmdpy_destroyer;
633
634 obj->command = cmd;
635 set_cmd_context (cmd, self);
636 set_cmd_completer (cmd, ((completetype == -1) ? cmdpy_completer
637 : completers[completetype].completer));
7d793aa9
SDJ
638 if (completetype == -1)
639 set_cmd_completer_handle_brkchars (cmd,
640 cmdpy_completer_handle_brkchars);
d8906c6f 641 }
492d29ea 642 CATCH (except, RETURN_MASK_ALL)
d8906c6f
TJB
643 {
644 xfree (cmd_name);
645 xfree (docstring);
646 xfree (pfx_name);
647 Py_DECREF (self);
648 PyErr_Format (except.reason == RETURN_QUIT
649 ? PyExc_KeyboardInterrupt : PyExc_RuntimeError,
650 "%s", except.message);
651 return -1;
652 }
492d29ea
PA
653 END_CATCH
654
d8906c6f
TJB
655 return 0;
656}
657
658\f
659
660/* Initialize the 'commands' code. */
63d97a20 661
999633ed 662int
d8906c6f
TJB
663gdbpy_initialize_commands (void)
664{
665 int i;
666
6a1b1664 667 cmdpy_object_type.tp_new = PyType_GenericNew;
d8906c6f 668 if (PyType_Ready (&cmdpy_object_type) < 0)
999633ed 669 return -1;
d8906c6f
TJB
670
671 /* Note: alias and user are special; pseudo appears to be unused,
4f45d445 672 and there is no reason to expose tui, I think. */
d8906c6f
TJB
673 if (PyModule_AddIntConstant (gdb_module, "COMMAND_NONE", no_class) < 0
674 || PyModule_AddIntConstant (gdb_module, "COMMAND_RUNNING", class_run) < 0
675 || PyModule_AddIntConstant (gdb_module, "COMMAND_DATA", class_vars) < 0
676 || PyModule_AddIntConstant (gdb_module, "COMMAND_STACK", class_stack) < 0
677 || PyModule_AddIntConstant (gdb_module, "COMMAND_FILES", class_files) < 0
678 || PyModule_AddIntConstant (gdb_module, "COMMAND_SUPPORT",
679 class_support) < 0
680 || PyModule_AddIntConstant (gdb_module, "COMMAND_STATUS", class_info) < 0
681 || PyModule_AddIntConstant (gdb_module, "COMMAND_BREAKPOINTS",
682 class_breakpoint) < 0
683 || PyModule_AddIntConstant (gdb_module, "COMMAND_TRACEPOINTS",
684 class_trace) < 0
685 || PyModule_AddIntConstant (gdb_module, "COMMAND_OBSCURE",
686 class_obscure) < 0
687 || PyModule_AddIntConstant (gdb_module, "COMMAND_MAINTENANCE",
7d74f244
DE
688 class_maintenance) < 0
689 || PyModule_AddIntConstant (gdb_module, "COMMAND_USER", class_user) < 0)
999633ed 690 return -1;
d8906c6f
TJB
691
692 for (i = 0; i < N_COMPLETERS; ++i)
693 {
694 if (PyModule_AddIntConstant (gdb_module, completers[i].name, i) < 0)
999633ed 695 return -1;
d8906c6f
TJB
696 }
697
aa36459a
TT
698 if (gdb_pymodule_addobject (gdb_module, "Command",
699 (PyObject *) &cmdpy_object_type) < 0)
999633ed 700 return -1;
d8906c6f
TJB
701
702 invoke_cst = PyString_FromString ("invoke");
999633ed
TT
703 if (invoke_cst == NULL)
704 return -1;
d8906c6f 705 complete_cst = PyString_FromString ("complete");
999633ed
TT
706 if (complete_cst == NULL)
707 return -1;
708
709 return 0;
d8906c6f
TJB
710}
711
712\f
713
714static PyMethodDef cmdpy_object_methods[] =
715{
716 { "dont_repeat", cmdpy_dont_repeat, METH_NOARGS,
717 "Prevent command repetition when user enters empty line." },
718
719 { 0 }
720};
721
e36122e9 722PyTypeObject cmdpy_object_type =
d8906c6f 723{
9a27f2c6 724 PyVarObject_HEAD_INIT (NULL, 0)
d8906c6f
TJB
725 "gdb.Command", /*tp_name*/
726 sizeof (cmdpy_object), /*tp_basicsize*/
727 0, /*tp_itemsize*/
728 0, /*tp_dealloc*/
729 0, /*tp_print*/
730 0, /*tp_getattr*/
731 0, /*tp_setattr*/
732 0, /*tp_compare*/
733 0, /*tp_repr*/
734 0, /*tp_as_number*/
735 0, /*tp_as_sequence*/
736 0, /*tp_as_mapping*/
737 0, /*tp_hash */
738 0, /*tp_call*/
739 0, /*tp_str*/
740 0, /*tp_getattro*/
741 0, /*tp_setattro*/
742 0, /*tp_as_buffer*/
743 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
744 "GDB command object", /* tp_doc */
745 0, /* tp_traverse */
746 0, /* tp_clear */
747 0, /* tp_richcompare */
748 0, /* tp_weaklistoffset */
749 0, /* tp_iter */
750 0, /* tp_iternext */
751 cmdpy_object_methods, /* tp_methods */
752 0, /* tp_members */
753 0, /* tp_getset */
754 0, /* tp_base */
755 0, /* tp_dict */
756 0, /* tp_descr_get */
757 0, /* tp_descr_set */
758 0, /* tp_dictoffset */
759 cmdpy_init, /* tp_init */
760 0, /* tp_alloc */
d8906c6f 761};
07ca107c
DE
762
763\f
764
765/* Utility to build a buildargv-like result from ARGS.
766 This intentionally parses arguments the way libiberty/argv.c:buildargv
767 does. It splits up arguments in a reasonable way, and we want a standard
768 way of parsing arguments. Several gdb commands use buildargv to parse their
769 arguments. Plus we want to be able to write compatible python
770 implementations of gdb commands. */
771
772PyObject *
773gdbpy_string_to_argv (PyObject *self, PyObject *args)
774{
ddd49eee 775 const char *input;
07ca107c
DE
776
777 if (!PyArg_ParseTuple (args, "s", &input))
778 return NULL;
779
d1b3de2e 780 gdbpy_ref py_argv (PyList_New (0));
3919fd96
TT
781 if (py_argv == NULL)
782 return NULL;
07ca107c
DE
783
784 /* buildargv uses NULL to represent an empty argument list, but we can't use
785 that in Python. Instead, if ARGS is "" then return an empty list.
786 This undoes the NULL -> "" conversion that cmdpy_function does. */
787
788 if (*input != '\0')
789 {
790 char **c_argv = gdb_buildargv (input);
791 int i;
792
793 for (i = 0; c_argv[i] != NULL; ++i)
794 {
d1b3de2e 795 gdbpy_ref argp (PyString_FromString (c_argv[i]));
07ca107c
DE
796
797 if (argp == NULL
d1b3de2e 798 || PyList_Append (py_argv.get (), argp.get ()) < 0)
07ca107c 799 {
07ca107c
DE
800 freeargv (c_argv);
801 return NULL;
802 }
803 }
804
805 freeargv (c_argv);
806 }
807
d1b3de2e 808 return py_argv.release ();
07ca107c 809}
This page took 0.807301 seconds and 4 git commands to generate.