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