Commit | Line | Data |
---|---|---|
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. */ | |
33 | struct 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 | 43 | static 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. */ | |
57 | struct 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 | ||
72 | typedef struct cmdpy_object cmdpy_object; | |
73 | ||
e36122e9 | 74 | extern PyTypeObject cmdpy_object_type |
62eec1a5 | 75 | CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("cmdpy_object"); |
d8906c6f | 76 | |
d8906c6f TJB |
77 | /* Constants used by this module. */ |
78 | static PyObject *invoke_cst; | |
79 | static PyObject *complete_cst; | |
80 | ||
81 | \f | |
82 | ||
83 | /* Python function which wraps dont_repeat. */ | |
84 | static PyObject * | |
85 | cmdpy_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 |
95 | static void |
96 | cmdpy_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 |
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); | |
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 | ||
230 | static PyObject * | |
231 | cmdpy_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); | |
7d793aa9 | 235 | |
6d62641c SDJ |
236 | if (obj == NULL) |
237 | error (_("Invalid invocation of Python command object.")); | |
238 | if (!PyObject_HasAttr ((PyObject *) obj, complete_cst)) | |
7d793aa9 | 239 | { |
6d62641c SDJ |
240 | /* If there is no complete method, don't error. */ |
241 | return NULL; | |
242 | } | |
7d793aa9 | 243 | |
905f2cca TT |
244 | gdbpy_ref textobj (PyUnicode_Decode (text, strlen (text), host_charset (), |
245 | NULL)); | |
6d62641c SDJ |
246 | if (textobj == NULL) |
247 | error (_("Could not convert argument to Python string.")); | |
905f2cca TT |
248 | gdbpy_ref wordobj (PyUnicode_Decode (word, strlen (word), host_charset (), |
249 | NULL)); | |
6d62641c | 250 | if (wordobj == NULL) |
905f2cca | 251 | error (_("Could not convert argument to Python string.")); |
7d793aa9 | 252 | |
905f2cca TT |
253 | gdbpy_ref resultobj (PyObject_CallMethodObjArgs ((PyObject *) obj, |
254 | complete_cst, | |
255 | textobj.get (), | |
256 | wordobj.get (), NULL)); | |
257 | if (resultobj == NULL) | |
6d62641c SDJ |
258 | { |
259 | /* Just swallow errors here. */ | |
260 | PyErr_Clear (); | |
7d793aa9 SDJ |
261 | } |
262 | ||
905f2cca | 263 | return resultobj.release (); |
7d793aa9 SDJ |
264 | } |
265 | ||
266 | /* Python function called to determine the break characters of a | |
267 | certain completer. We are only interested in knowing if the | |
268 | completer registered by the user will return one of the integer | |
269 | codes (see COMPLETER_* symbols). */ | |
270 | ||
271 | static void | |
272 | cmdpy_completer_handle_brkchars (struct cmd_list_element *command, | |
273 | const char *text, const char *word) | |
274 | { | |
6ba0cd40 | 275 | gdbpy_enter enter_py (get_current_arch (), current_language); |
7d793aa9 SDJ |
276 | |
277 | /* Calling our helper to obtain the PyObject of the Python | |
278 | function. */ | |
905f2cca | 279 | gdbpy_ref resultobj (cmdpy_completer_helper (command, text, word)); |
7d793aa9 SDJ |
280 | |
281 | /* Check if there was an error. */ | |
282 | if (resultobj == NULL) | |
905f2cca | 283 | return; |
7d793aa9 | 284 | |
905f2cca | 285 | if (PyInt_Check (resultobj.get ())) |
7d793aa9 SDJ |
286 | { |
287 | /* User code may also return one of the completion constants, | |
288 | thus requesting that sort of completion. We are only | |
289 | interested in this kind of return. */ | |
290 | long value; | |
291 | ||
905f2cca | 292 | if (!gdb_py_int_as_long (resultobj.get (), &value)) |
7d793aa9 SDJ |
293 | { |
294 | /* Ignore. */ | |
295 | PyErr_Clear (); | |
296 | } | |
297 | else if (value >= 0 && value < (long) N_COMPLETERS) | |
298 | { | |
299 | /* This is the core of this function. Depending on which | |
300 | completer type the Python function returns, we have to | |
301 | adjust the break characters accordingly. */ | |
302 | set_gdb_completion_word_break_characters | |
303 | (completers[value].completer); | |
304 | } | |
305 | } | |
7d793aa9 SDJ |
306 | } |
307 | ||
d8906c6f | 308 | /* Called by gdb for command completion. */ |
63d97a20 | 309 | |
49c4e619 | 310 | static VEC (char_ptr) * |
6f937416 PA |
311 | cmdpy_completer (struct cmd_list_element *command, |
312 | const char *text, const char *word) | |
d8906c6f | 313 | { |
49c4e619 | 314 | VEC (char_ptr) *result = NULL; |
d8906c6f | 315 | |
6ba0cd40 | 316 | gdbpy_enter enter_py (get_current_arch (), current_language); |
d8906c6f | 317 | |
7d793aa9 SDJ |
318 | /* Calling our helper to obtain the PyObject of the Python |
319 | function. */ | |
905f2cca | 320 | gdbpy_ref resultobj (cmdpy_completer_helper (command, text, word)); |
d8906c6f | 321 | |
7d793aa9 SDJ |
322 | /* If the result object of calling the Python function is NULL, it |
323 | means that there was an error. In this case, just give up and | |
324 | return NULL. */ | |
325 | if (resultobj == NULL) | |
905f2cca | 326 | return NULL; |
d8906c6f TJB |
327 | |
328 | result = NULL; | |
905f2cca | 329 | if (PyInt_Check (resultobj.get ())) |
d8906c6f | 330 | { |
ba327838 TT |
331 | /* User code may also return one of the completion constants, |
332 | thus requesting that sort of completion. */ | |
333 | long value; | |
334 | ||
905f2cca | 335 | if (! gdb_py_int_as_long (resultobj.get (), &value)) |
ba327838 TT |
336 | { |
337 | /* Ignore. */ | |
338 | PyErr_Clear (); | |
339 | } | |
340 | else if (value >= 0 && value < (long) N_COMPLETERS) | |
341 | result = completers[value].completer (command, text, word); | |
342 | } | |
343 | else | |
344 | { | |
905f2cca | 345 | gdbpy_ref iter (PyObject_GetIter (resultobj.get ())); |
d59b6f6c | 346 | |
ba327838 | 347 | if (iter == NULL) |
905f2cca | 348 | return NULL; |
d8906c6f | 349 | |
905f2cca | 350 | while (true) |
d8906c6f | 351 | { |
905f2cca TT |
352 | gdbpy_ref elt (PyIter_Next (iter.get ())); |
353 | if (elt == NULL) | |
354 | break; | |
d59b6f6c | 355 | |
905f2cca | 356 | if (! gdbpy_is_string (elt.get ())) |
d8906c6f TJB |
357 | { |
358 | /* Skip problem elements. */ | |
d8906c6f TJB |
359 | continue; |
360 | } | |
9b972014 | 361 | gdb::unique_xmalloc_ptr<char> |
905f2cca | 362 | item (python_string_to_host_string (elt.get ())); |
49c4e619 | 363 | if (item == NULL) |
8dc78533 JK |
364 | { |
365 | /* Skip problem elements. */ | |
366 | PyErr_Clear (); | |
367 | continue; | |
368 | } | |
9b972014 | 369 | VEC_safe_push (char_ptr, result, item.release ()); |
d8906c6f | 370 | } |
d59b6f6c | 371 | |
ba327838 TT |
372 | /* If we got some results, ignore problems. Otherwise, report |
373 | the problem. */ | |
374 | if (result != NULL && PyErr_Occurred ()) | |
375 | PyErr_Clear (); | |
d8906c6f TJB |
376 | } |
377 | ||
d8906c6f TJB |
378 | return result; |
379 | } | |
380 | ||
381 | /* Helper for cmdpy_init which locates the command list to use and | |
382 | pulls out the command name. | |
256458bc | 383 | |
63d97a20 | 384 | NAME is the command name list. The final word in the list is the |
d8906c6f TJB |
385 | name of the new command. All earlier words must be existing prefix |
386 | commands. | |
387 | ||
388 | *BASE_LIST is set to the final prefix command's list of | |
389 | *sub-commands. | |
256458bc | 390 | |
d7b32ed3 PM |
391 | START_LIST is the list in which the search starts. |
392 | ||
d8906c6f TJB |
393 | This function returns the xmalloc()d name of the new command. On |
394 | error sets the Python error and returns NULL. */ | |
63d97a20 | 395 | |
d7b32ed3 | 396 | char * |
63d97a20 | 397 | gdbpy_parse_command_name (const char *name, |
d7b32ed3 PM |
398 | struct cmd_list_element ***base_list, |
399 | struct cmd_list_element **start_list) | |
d8906c6f TJB |
400 | { |
401 | struct cmd_list_element *elt; | |
63d97a20 | 402 | int len = strlen (name); |
d8906c6f | 403 | int i, lastchar; |
6f937416 PA |
404 | char *prefix_text; |
405 | const char *prefix_text2; | |
d8906c6f TJB |
406 | char *result; |
407 | ||
408 | /* Skip trailing whitespace. */ | |
63d97a20 | 409 | for (i = len - 1; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i) |
d8906c6f TJB |
410 | ; |
411 | if (i < 0) | |
412 | { | |
044c0f87 | 413 | PyErr_SetString (PyExc_RuntimeError, _("No command name found.")); |
d8906c6f TJB |
414 | return NULL; |
415 | } | |
416 | lastchar = i; | |
417 | ||
418 | /* Find first character of the final word. */ | |
63d97a20 DE |
419 | for (; i > 0 && (isalnum (name[i - 1]) |
420 | || name[i - 1] == '-' | |
421 | || name[i - 1] == '_'); | |
d8906c6f TJB |
422 | --i) |
423 | ; | |
224c3ddb | 424 | result = (char *) xmalloc (lastchar - i + 2); |
63d97a20 | 425 | memcpy (result, &name[i], lastchar - i + 1); |
d8906c6f TJB |
426 | result[lastchar - i + 1] = '\0'; |
427 | ||
428 | /* Skip whitespace again. */ | |
63d97a20 | 429 | for (--i; i >= 0 && (name[i] == ' ' || name[i] == '\t'); --i) |
d8906c6f TJB |
430 | ; |
431 | if (i < 0) | |
432 | { | |
d7b32ed3 | 433 | *base_list = start_list; |
d8906c6f TJB |
434 | return result; |
435 | } | |
436 | ||
224c3ddb | 437 | prefix_text = (char *) xmalloc (i + 2); |
63d97a20 | 438 | memcpy (prefix_text, name, i + 1); |
d8906c6f TJB |
439 | prefix_text[i + 1] = '\0'; |
440 | ||
63d97a20 DE |
441 | prefix_text2 = prefix_text; |
442 | elt = lookup_cmd_1 (&prefix_text2, *start_list, NULL, 1); | |
d81412aa | 443 | if (elt == NULL || elt == CMD_LIST_AMBIGUOUS) |
d8906c6f | 444 | { |
044c0f87 | 445 | PyErr_Format (PyExc_RuntimeError, _("Could not find command prefix %s."), |
d8906c6f TJB |
446 | prefix_text); |
447 | xfree (prefix_text); | |
448 | xfree (result); | |
449 | return NULL; | |
450 | } | |
451 | ||
452 | if (elt->prefixlist) | |
453 | { | |
454 | xfree (prefix_text); | |
455 | *base_list = elt->prefixlist; | |
456 | return result; | |
457 | } | |
458 | ||
044c0f87 | 459 | PyErr_Format (PyExc_RuntimeError, _("'%s' is not a prefix command."), |
d8906c6f TJB |
460 | prefix_text); |
461 | xfree (prefix_text); | |
462 | xfree (result); | |
463 | return NULL; | |
464 | } | |
465 | ||
466 | /* Object initializer; sets up gdb-side structures for command. | |
467 | ||
cc924cad | 468 | Use: __init__(NAME, COMMAND_CLASS [, COMPLETER_CLASS][, PREFIX]]). |
d8906c6f TJB |
469 | |
470 | NAME is the name of the command. It may consist of multiple words, | |
471 | in which case the final word is the name of the new command, and | |
472 | earlier words must be prefix commands. | |
473 | ||
cc924cad | 474 | COMMAND_CLASS is the kind of command. It should be one of the COMMAND_* |
d8906c6f TJB |
475 | constants defined in the gdb module. |
476 | ||
cc924cad | 477 | COMPLETER_CLASS is the kind of completer. If not given, the |
d8906c6f TJB |
478 | "complete" method will be used. Otherwise, it should be one of the |
479 | COMPLETE_* constants defined in the gdb module. | |
480 | ||
481 | If PREFIX is True, then this command is a prefix command. | |
482 | ||
483 | The documentation for the command is taken from the doc string for | |
63d97a20 DE |
484 | the python class. */ |
485 | ||
d8906c6f | 486 | static int |
cc924cad | 487 | cmdpy_init (PyObject *self, PyObject *args, PyObject *kw) |
d8906c6f TJB |
488 | { |
489 | cmdpy_object *obj = (cmdpy_object *) self; | |
ddd49eee | 490 | const char *name; |
d8906c6f TJB |
491 | int cmdtype; |
492 | int completetype = -1; | |
493 | char *docstring = NULL; | |
d8906c6f TJB |
494 | struct cmd_list_element **cmd_list; |
495 | char *cmd_name, *pfx_name; | |
cc924cad TJB |
496 | static char *keywords[] = { "name", "command_class", "completer_class", |
497 | "prefix", NULL }; | |
d8906c6f TJB |
498 | PyObject *is_prefix = NULL; |
499 | int cmp; | |
500 | ||
501 | if (obj->command) | |
502 | { | |
503 | /* Note: this is apparently not documented in Python. We return | |
504 | 0 for success, -1 for failure. */ | |
505 | PyErr_Format (PyExc_RuntimeError, | |
044c0f87 | 506 | _("Command object already initialized.")); |
d8906c6f TJB |
507 | return -1; |
508 | } | |
509 | ||
9a2b4c1b MS |
510 | if (! PyArg_ParseTupleAndKeywords (args, kw, "si|iO", |
511 | keywords, &name, &cmdtype, | |
d8906c6f TJB |
512 | &completetype, &is_prefix)) |
513 | return -1; | |
514 | ||
515 | if (cmdtype != no_class && cmdtype != class_run | |
516 | && cmdtype != class_vars && cmdtype != class_stack | |
517 | && cmdtype != class_files && cmdtype != class_support | |
518 | && cmdtype != class_info && cmdtype != class_breakpoint | |
519 | && cmdtype != class_trace && cmdtype != class_obscure | |
7d74f244 | 520 | && cmdtype != class_maintenance && cmdtype != class_user) |
d8906c6f | 521 | { |
044c0f87 | 522 | PyErr_Format (PyExc_RuntimeError, _("Invalid command class argument.")); |
d8906c6f TJB |
523 | return -1; |
524 | } | |
525 | ||
526 | if (completetype < -1 || completetype >= (int) N_COMPLETERS) | |
527 | { | |
9a2b4c1b MS |
528 | PyErr_Format (PyExc_RuntimeError, |
529 | _("Invalid completion type argument.")); | |
d8906c6f TJB |
530 | return -1; |
531 | } | |
532 | ||
63d97a20 | 533 | cmd_name = gdbpy_parse_command_name (name, &cmd_list, &cmdlist); |
d8906c6f TJB |
534 | if (! cmd_name) |
535 | return -1; | |
536 | ||
537 | pfx_name = NULL; | |
256458bc | 538 | if (is_prefix != NULL) |
d8906c6f TJB |
539 | { |
540 | cmp = PyObject_IsTrue (is_prefix); | |
541 | if (cmp == 1) | |
542 | { | |
543 | int i, out; | |
256458bc | 544 | |
d8906c6f | 545 | /* Make a normalized form of the command name. */ |
224c3ddb | 546 | pfx_name = (char *) xmalloc (strlen (name) + 2); |
256458bc | 547 | |
d8906c6f TJB |
548 | i = 0; |
549 | out = 0; | |
550 | while (name[i]) | |
551 | { | |
552 | /* Skip whitespace. */ | |
553 | while (name[i] == ' ' || name[i] == '\t') | |
554 | ++i; | |
555 | /* Copy non-whitespace characters. */ | |
556 | while (name[i] && name[i] != ' ' && name[i] != '\t') | |
557 | pfx_name[out++] = name[i++]; | |
558 | /* Add a single space after each word -- including the final | |
559 | word. */ | |
560 | pfx_name[out++] = ' '; | |
561 | } | |
562 | pfx_name[out] = '\0'; | |
563 | } | |
564 | else if (cmp < 0) | |
e463f587 MS |
565 | { |
566 | xfree (cmd_name); | |
d8906c6f | 567 | return -1; |
e463f587 | 568 | } |
d8906c6f TJB |
569 | } |
570 | if (PyObject_HasAttr (self, gdbpy_doc_cst)) | |
571 | { | |
905f2cca | 572 | gdbpy_ref ds_obj (PyObject_GetAttr (self, gdbpy_doc_cst)); |
d59b6f6c | 573 | |
905f2cca | 574 | if (ds_obj != NULL && gdbpy_is_string (ds_obj.get ())) |
8dc78533 | 575 | { |
905f2cca | 576 | docstring = python_string_to_host_string (ds_obj.get ()).release (); |
8dc78533 JK |
577 | if (docstring == NULL) |
578 | { | |
579 | xfree (cmd_name); | |
580 | xfree (pfx_name); | |
581 | return -1; | |
582 | } | |
583 | } | |
d8906c6f TJB |
584 | } |
585 | if (! docstring) | |
586 | docstring = xstrdup (_("This command is not documented.")); | |
587 | ||
588 | Py_INCREF (self); | |
589 | ||
492d29ea | 590 | TRY |
d8906c6f TJB |
591 | { |
592 | struct cmd_list_element *cmd; | |
593 | ||
594 | if (pfx_name) | |
595 | { | |
596 | int allow_unknown; | |
597 | ||
598 | /* If we have our own "invoke" method, then allow unknown | |
599 | sub-commands. */ | |
600 | allow_unknown = PyObject_HasAttr (self, invoke_cst); | |
601 | cmd = add_prefix_cmd (cmd_name, (enum command_class) cmdtype, | |
602 | NULL, docstring, &obj->sub_list, | |
603 | pfx_name, allow_unknown, cmd_list); | |
604 | } | |
605 | else | |
606 | cmd = add_cmd (cmd_name, (enum command_class) cmdtype, NULL, | |
607 | docstring, cmd_list); | |
608 | ||
609 | /* There appears to be no API to set this. */ | |
610 | cmd->func = cmdpy_function; | |
611 | cmd->destroyer = cmdpy_destroyer; | |
612 | ||
613 | obj->command = cmd; | |
614 | set_cmd_context (cmd, self); | |
615 | set_cmd_completer (cmd, ((completetype == -1) ? cmdpy_completer | |
616 | : completers[completetype].completer)); | |
7d793aa9 SDJ |
617 | if (completetype == -1) |
618 | set_cmd_completer_handle_brkchars (cmd, | |
619 | cmdpy_completer_handle_brkchars); | |
d8906c6f | 620 | } |
492d29ea | 621 | CATCH (except, RETURN_MASK_ALL) |
d8906c6f TJB |
622 | { |
623 | xfree (cmd_name); | |
624 | xfree (docstring); | |
625 | xfree (pfx_name); | |
626 | Py_DECREF (self); | |
627 | PyErr_Format (except.reason == RETURN_QUIT | |
628 | ? PyExc_KeyboardInterrupt : PyExc_RuntimeError, | |
629 | "%s", except.message); | |
630 | return -1; | |
631 | } | |
492d29ea PA |
632 | END_CATCH |
633 | ||
d8906c6f TJB |
634 | return 0; |
635 | } | |
636 | ||
637 | \f | |
638 | ||
639 | /* Initialize the 'commands' code. */ | |
63d97a20 | 640 | |
999633ed | 641 | int |
d8906c6f TJB |
642 | gdbpy_initialize_commands (void) |
643 | { | |
644 | int i; | |
645 | ||
6a1b1664 | 646 | cmdpy_object_type.tp_new = PyType_GenericNew; |
d8906c6f | 647 | if (PyType_Ready (&cmdpy_object_type) < 0) |
999633ed | 648 | return -1; |
d8906c6f TJB |
649 | |
650 | /* Note: alias and user are special; pseudo appears to be unused, | |
4f45d445 | 651 | and there is no reason to expose tui, I think. */ |
d8906c6f TJB |
652 | if (PyModule_AddIntConstant (gdb_module, "COMMAND_NONE", no_class) < 0 |
653 | || PyModule_AddIntConstant (gdb_module, "COMMAND_RUNNING", class_run) < 0 | |
654 | || PyModule_AddIntConstant (gdb_module, "COMMAND_DATA", class_vars) < 0 | |
655 | || PyModule_AddIntConstant (gdb_module, "COMMAND_STACK", class_stack) < 0 | |
656 | || PyModule_AddIntConstant (gdb_module, "COMMAND_FILES", class_files) < 0 | |
657 | || PyModule_AddIntConstant (gdb_module, "COMMAND_SUPPORT", | |
658 | class_support) < 0 | |
659 | || PyModule_AddIntConstant (gdb_module, "COMMAND_STATUS", class_info) < 0 | |
660 | || PyModule_AddIntConstant (gdb_module, "COMMAND_BREAKPOINTS", | |
661 | class_breakpoint) < 0 | |
662 | || PyModule_AddIntConstant (gdb_module, "COMMAND_TRACEPOINTS", | |
663 | class_trace) < 0 | |
664 | || PyModule_AddIntConstant (gdb_module, "COMMAND_OBSCURE", | |
665 | class_obscure) < 0 | |
666 | || PyModule_AddIntConstant (gdb_module, "COMMAND_MAINTENANCE", | |
7d74f244 DE |
667 | class_maintenance) < 0 |
668 | || PyModule_AddIntConstant (gdb_module, "COMMAND_USER", class_user) < 0) | |
999633ed | 669 | return -1; |
d8906c6f TJB |
670 | |
671 | for (i = 0; i < N_COMPLETERS; ++i) | |
672 | { | |
673 | if (PyModule_AddIntConstant (gdb_module, completers[i].name, i) < 0) | |
999633ed | 674 | return -1; |
d8906c6f TJB |
675 | } |
676 | ||
aa36459a TT |
677 | if (gdb_pymodule_addobject (gdb_module, "Command", |
678 | (PyObject *) &cmdpy_object_type) < 0) | |
999633ed | 679 | return -1; |
d8906c6f TJB |
680 | |
681 | invoke_cst = PyString_FromString ("invoke"); | |
999633ed TT |
682 | if (invoke_cst == NULL) |
683 | return -1; | |
d8906c6f | 684 | complete_cst = PyString_FromString ("complete"); |
999633ed TT |
685 | if (complete_cst == NULL) |
686 | return -1; | |
687 | ||
688 | return 0; | |
d8906c6f TJB |
689 | } |
690 | ||
691 | \f | |
692 | ||
693 | static PyMethodDef cmdpy_object_methods[] = | |
694 | { | |
695 | { "dont_repeat", cmdpy_dont_repeat, METH_NOARGS, | |
696 | "Prevent command repetition when user enters empty line." }, | |
697 | ||
698 | { 0 } | |
699 | }; | |
700 | ||
e36122e9 | 701 | PyTypeObject cmdpy_object_type = |
d8906c6f | 702 | { |
9a27f2c6 | 703 | PyVarObject_HEAD_INIT (NULL, 0) |
d8906c6f TJB |
704 | "gdb.Command", /*tp_name*/ |
705 | sizeof (cmdpy_object), /*tp_basicsize*/ | |
706 | 0, /*tp_itemsize*/ | |
707 | 0, /*tp_dealloc*/ | |
708 | 0, /*tp_print*/ | |
709 | 0, /*tp_getattr*/ | |
710 | 0, /*tp_setattr*/ | |
711 | 0, /*tp_compare*/ | |
712 | 0, /*tp_repr*/ | |
713 | 0, /*tp_as_number*/ | |
714 | 0, /*tp_as_sequence*/ | |
715 | 0, /*tp_as_mapping*/ | |
716 | 0, /*tp_hash */ | |
717 | 0, /*tp_call*/ | |
718 | 0, /*tp_str*/ | |
719 | 0, /*tp_getattro*/ | |
720 | 0, /*tp_setattro*/ | |
721 | 0, /*tp_as_buffer*/ | |
722 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ | |
723 | "GDB command object", /* tp_doc */ | |
724 | 0, /* tp_traverse */ | |
725 | 0, /* tp_clear */ | |
726 | 0, /* tp_richcompare */ | |
727 | 0, /* tp_weaklistoffset */ | |
728 | 0, /* tp_iter */ | |
729 | 0, /* tp_iternext */ | |
730 | cmdpy_object_methods, /* tp_methods */ | |
731 | 0, /* tp_members */ | |
732 | 0, /* tp_getset */ | |
733 | 0, /* tp_base */ | |
734 | 0, /* tp_dict */ | |
735 | 0, /* tp_descr_get */ | |
736 | 0, /* tp_descr_set */ | |
737 | 0, /* tp_dictoffset */ | |
738 | cmdpy_init, /* tp_init */ | |
739 | 0, /* tp_alloc */ | |
d8906c6f | 740 | }; |
07ca107c DE |
741 | |
742 | \f | |
743 | ||
744 | /* Utility to build a buildargv-like result from ARGS. | |
745 | This intentionally parses arguments the way libiberty/argv.c:buildargv | |
746 | does. It splits up arguments in a reasonable way, and we want a standard | |
747 | way of parsing arguments. Several gdb commands use buildargv to parse their | |
748 | arguments. Plus we want to be able to write compatible python | |
749 | implementations of gdb commands. */ | |
750 | ||
751 | PyObject * | |
752 | gdbpy_string_to_argv (PyObject *self, PyObject *args) | |
753 | { | |
ddd49eee | 754 | const char *input; |
07ca107c DE |
755 | |
756 | if (!PyArg_ParseTuple (args, "s", &input)) | |
757 | return NULL; | |
758 | ||
d1b3de2e | 759 | gdbpy_ref py_argv (PyList_New (0)); |
3919fd96 TT |
760 | if (py_argv == NULL) |
761 | return NULL; | |
07ca107c DE |
762 | |
763 | /* buildargv uses NULL to represent an empty argument list, but we can't use | |
764 | that in Python. Instead, if ARGS is "" then return an empty list. | |
765 | This undoes the NULL -> "" conversion that cmdpy_function does. */ | |
766 | ||
767 | if (*input != '\0') | |
768 | { | |
769 | char **c_argv = gdb_buildargv (input); | |
770 | int i; | |
771 | ||
772 | for (i = 0; c_argv[i] != NULL; ++i) | |
773 | { | |
d1b3de2e | 774 | gdbpy_ref argp (PyString_FromString (c_argv[i])); |
07ca107c DE |
775 | |
776 | if (argp == NULL | |
d1b3de2e | 777 | || PyList_Append (py_argv.get (), argp.get ()) < 0) |
07ca107c | 778 | { |
07ca107c DE |
779 | freeargv (c_argv); |
780 | return NULL; | |
781 | } | |
782 | } | |
783 | ||
784 | freeargv (c_argv); | |
785 | } | |
786 | ||
d1b3de2e | 787 | return py_argv.release (); |
07ca107c | 788 | } |