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