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