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