1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000-2017 Free Software Foundation, Inc.
5 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 /* This is just a first cut at separating out the "interpreter"
23 functions of gdb into self-contained modules. There are a couple
24 of open areas that need to be sorted out:
26 1) The interpreter explicitly contains a UI_OUT, and can insert itself
27 into the event loop, but it doesn't explicitly contain hooks for readline.
28 I did this because it seems to me many interpreters won't want to use
29 the readline command interface, and it is probably simpler to just let
30 them take over the input in their resume proc. */
35 #include "event-loop.h"
36 #include "event-top.h"
38 #include "completer.h"
39 #include "top.h" /* For command_loop. */
40 #include "continuations.h"
42 /* Each UI has its own independent set of interpreters. */
46 /* Each top level has its own independent set of interpreters. */
47 struct interp
*interp_list
;
48 struct interp
*current_interpreter
;
49 struct interp
*top_level_interpreter
;
51 /* The interpreter that is active while `interp_exec' is active, NULL
52 at all other times. */
53 struct interp
*command_interpreter
;
56 /* Get UI's ui_interp_info object. Never returns NULL. */
58 static struct ui_interp_info
*
59 get_interp_info (struct ui
*ui
)
61 if (ui
->interp_info
== NULL
)
62 ui
->interp_info
= XCNEW (struct ui_interp_info
);
63 return ui
->interp_info
;
66 /* Get the current UI's ui_interp_info object. Never returns
69 static struct ui_interp_info
*
70 get_current_interp_info (void)
72 return get_interp_info (current_ui
);
75 /* The magic initialization routine for this module. */
77 void _initialize_interpreter (void);
79 static struct interp
*interp_lookup_existing (struct ui
*ui
,
82 interp::interp (const char *name
)
84 this->name
= xstrdup (name
);
85 this->quiet_p
= false;
92 /* An interpreter factory. Maps an interpreter name to the factory
93 function that instantiates an interpreter by that name. */
97 /* This is the name in "-i=INTERP" and "interpreter-exec INTERP". */
100 /* The function that creates the interpreter. */
101 interp_factory_func func
;
104 typedef struct interp_factory
*interp_factory_p
;
105 DEF_VEC_P(interp_factory_p
);
107 /* The registered interpreter factories. */
108 static VEC(interp_factory_p
) *interpreter_factories
= NULL
;
113 interp_factory_register (const char *name
, interp_factory_func func
)
115 struct interp_factory
*f
;
118 /* Assert that no factory for NAME is already registered. */
120 VEC_iterate (interp_factory_p
, interpreter_factories
, ix
, f
);
122 if (strcmp (f
->name
, name
) == 0)
124 internal_error (__FILE__
, __LINE__
,
125 _("interpreter factory already registered: \"%s\"\n"),
129 f
= XNEW (struct interp_factory
);
132 VEC_safe_push (interp_factory_p
, interpreter_factories
, f
);
135 /* Add interpreter INTERP to the gdb interpreter list. The
136 interpreter must not have previously been added. */
138 interp_add (struct ui
*ui
, struct interp
*interp
)
140 struct ui_interp_info
*ui_interp
= get_interp_info (ui
);
142 gdb_assert (interp_lookup_existing (ui
, interp
->name
) == NULL
);
144 interp
->next
= ui_interp
->interp_list
;
145 ui_interp
->interp_list
= interp
;
148 /* This sets the current interpreter to be INTERP. If INTERP has not
149 been initialized, then this will also run the init method.
151 The TOP_LEVEL parameter tells if this new interpreter is
152 the top-level one. The top-level is what is requested
153 on the command line, and is responsible for reporting general
154 notification about target state changes. For example, if
155 MI is the top-level interpreter, then it will always report
156 events such as target stops and new thread creation, even if they
157 are caused by CLI commands. */
160 interp_set (struct interp
*interp
, bool top_level
)
162 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
163 struct interp
*old_interp
= ui_interp
->current_interpreter
;
167 /* If we already have an interpreter, then trying to
168 set top level interpreter is kinda pointless. */
169 gdb_assert (!top_level
|| !ui_interp
->current_interpreter
);
170 gdb_assert (!top_level
|| !ui_interp
->top_level_interpreter
);
172 if (old_interp
!= NULL
)
174 current_uiout
->flush ();
175 old_interp
->suspend ();
182 ui_interp
->current_interpreter
= interp
;
184 ui_interp
->top_level_interpreter
= interp
;
186 /* We use interpreter_p for the "set interpreter" variable, so we need
187 to make sure we have a malloc'ed copy for the set command to free. */
188 if (interpreter_p
!= NULL
189 && strcmp (interp
->name
, interpreter_p
) != 0)
191 xfree (interpreter_p
);
193 interpreter_p
= xstrdup (interp
->name
);
196 /* Run the init proc. */
199 interp
->init (top_level
);
200 interp
->inited
= true;
203 /* Do this only after the interpreter is initialized. */
204 current_uiout
= interp
->interp_ui_out ();
206 /* Clear out any installed interpreter hooks/event handlers. */
207 clear_interpreter_hooks ();
211 if (!first_time
&& !interp_quiet_p (interp
))
213 xsnprintf (buffer
, sizeof (buffer
),
214 "Switching to interpreter \"%.24s\".\n", interp
->name
);
215 current_uiout
->text (buffer
);
219 /* Look up the interpreter for NAME. If no such interpreter exists,
220 return NULL, otherwise return a pointer to the interpreter. */
222 static struct interp
*
223 interp_lookup_existing (struct ui
*ui
, const char *name
)
225 struct ui_interp_info
*ui_interp
= get_interp_info (ui
);
226 struct interp
*interp
;
228 for (interp
= ui_interp
->interp_list
;
230 interp
= interp
->next
)
232 if (strcmp (interp
->name
, name
) == 0)
242 interp_lookup (struct ui
*ui
, const char *name
)
244 struct interp_factory
*factory
;
245 struct interp
*interp
;
248 if (name
== NULL
|| strlen (name
) == 0)
251 /* Only create each interpreter once per top level. */
252 interp
= interp_lookup_existing (ui
, name
);
257 VEC_iterate (interp_factory_p
, interpreter_factories
, ix
, factory
);
259 if (strcmp (factory
->name
, name
) == 0)
261 interp
= factory
->func (name
);
262 interp_add (ui
, interp
);
272 set_top_level_interpreter (const char *name
)
275 struct interp
*interp
= interp_lookup (current_ui
, name
);
278 error (_("Interpreter `%s' unrecognized"), name
);
280 interp_set (interp
, true);
283 /* Returns the current interpreter. */
286 interp_ui_out (struct interp
*interp
)
288 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
291 interp
= ui_interp
->current_interpreter
;
292 return interp
->interp_ui_out ();
296 current_interp_set_logging (ui_file_up logfile
,
297 bool logging_redirect
)
299 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
300 struct interp
*interp
= ui_interp
->current_interpreter
;
302 return interp
->set_logging (std::move (logfile
), logging_redirect
);
305 /* Temporarily overrides the current interpreter. */
307 interp_set_temp (const char *name
)
309 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
310 struct interp
*interp
= interp_lookup (current_ui
, name
);
311 struct interp
*old_interp
= ui_interp
->current_interpreter
;
314 ui_interp
->current_interpreter
= interp
;
318 /* Returns the interpreter's name. */
321 interp_name (struct interp
*interp
)
326 /* Returns true if the current interp is the passed in name. */
328 current_interp_named_p (const char *interp_name
)
330 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
331 struct interp
*interp
= ui_interp
->current_interpreter
;
334 return (strcmp (interp
->name
, interp_name
) == 0);
339 /* The interpreter that was active when a command was executed.
340 Normally that'd always be CURRENT_INTERPRETER, except that MI's
341 -interpreter-exec command doesn't actually flip the current
342 interpreter when running its sub-command. The
343 `command_interpreter' global tracks when interp_exec is called
344 (IOW, when -interpreter-exec is called). If that is set, it is
345 INTERP in '-interpreter-exec INTERP "CMD"' or in 'interpreter-exec
346 INTERP "CMD". Otherwise, interp_exec isn't active, and so the
347 interpreter running the command is the current interpreter. */
350 command_interp (void)
352 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
354 if (ui_interp
->command_interpreter
!= NULL
)
355 return ui_interp
->command_interpreter
;
357 return ui_interp
->current_interpreter
;
363 interp_pre_command_loop (struct interp
*interp
)
365 gdb_assert (interp
!= NULL
);
367 interp
->pre_command_loop ();
373 interp_supports_command_editing (struct interp
*interp
)
375 return interp
->supports_command_editing ();
379 interp_quiet_p (struct interp
*interp
)
381 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
384 return interp
->quiet_p
;
386 return ui_interp
->current_interpreter
->quiet_p
;
390 interp_set_quiet (struct interp
*interp
, int quiet
)
392 int old_val
= interp
->quiet_p
;
394 interp
->quiet_p
= quiet
;
398 /* interp_exec - This executes COMMAND_STR in the current
402 interp_exec (struct interp
*interp
, const char *command_str
)
404 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
406 struct gdb_exception ex
;
407 struct interp
*save_command_interp
;
409 /* See `command_interp' for why we do this. */
410 save_command_interp
= ui_interp
->command_interpreter
;
411 ui_interp
->command_interpreter
= interp
;
413 ex
= interp
->exec (command_str
);
415 ui_interp
->command_interpreter
= save_command_interp
;
420 /* A convenience routine that nulls out all the common command hooks.
421 Use it when removing your interpreter in its suspend proc. */
423 clear_interpreter_hooks (void)
425 deprecated_print_frame_info_listing_hook
= 0;
426 /*print_frame_more_info_hook = 0; */
427 deprecated_query_hook
= 0;
428 deprecated_warning_hook
= 0;
429 deprecated_interactive_hook
= 0;
430 deprecated_readline_begin_hook
= 0;
431 deprecated_readline_hook
= 0;
432 deprecated_readline_end_hook
= 0;
433 deprecated_context_hook
= 0;
434 deprecated_target_wait_hook
= 0;
435 deprecated_call_command_hook
= 0;
436 deprecated_error_begin_hook
= 0;
440 interpreter_exec_cmd (char *args
, int from_tty
)
442 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
443 struct interp
*old_interp
, *interp_to_use
;
444 char **prules
= NULL
;
448 int old_quiet
, use_quiet
;
449 struct cleanup
*cleanup
;
452 error_no_arg (_("interpreter-exec command"));
454 prules
= gdb_buildargv (args
);
455 cleanup
= make_cleanup_freeargv (prules
);
458 for (trule
= prules
; *trule
!= NULL
; trule
++)
462 error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
464 old_interp
= ui_interp
->current_interpreter
;
466 interp_to_use
= interp_lookup (current_ui
, prules
[0]);
467 if (interp_to_use
== NULL
)
468 error (_("Could not find interpreter \"%s\"."), prules
[0]);
470 /* Temporarily set interpreters quiet. */
471 old_quiet
= interp_set_quiet (old_interp
, 1);
472 use_quiet
= interp_set_quiet (interp_to_use
, 1);
474 interp_set (interp_to_use
, false);
476 for (i
= 1; i
< nrules
; i
++)
478 struct gdb_exception e
= interp_exec (interp_to_use
, prules
[i
]);
482 interp_set (old_interp
, 0);
483 interp_set_quiet (interp_to_use
, use_quiet
);
484 interp_set_quiet (old_interp
, old_quiet
);
485 error (_("error in command: \"%s\"."), prules
[i
]);
489 interp_set (old_interp
, 0);
490 interp_set_quiet (interp_to_use
, use_quiet
);
491 interp_set_quiet (old_interp
, old_quiet
);
493 do_cleanups (cleanup
);
499 interpreter_completer (struct cmd_list_element
*ignore
,
500 const char *text
, const char *word
)
502 struct interp_factory
*interp
;
504 VEC (char_ptr
) *matches
= NULL
;
507 textlen
= strlen (text
);
509 VEC_iterate (interp_factory_p
, interpreter_factories
, ix
, interp
);
512 if (strncmp (interp
->name
, text
, textlen
) == 0)
516 match
= (char *) xmalloc (strlen (word
) + strlen (interp
->name
) + 1);
518 strcpy (match
, interp
->name
);
519 else if (word
> text
)
521 /* Return some portion of interp->name. */
522 strcpy (match
, interp
->name
+ (word
- text
));
526 /* Return some of text plus interp->name. */
527 strncpy (match
, word
, text
- word
);
528 match
[text
- word
] = '\0';
529 strcat (match
, interp
->name
);
531 VEC_safe_push (char_ptr
, matches
, match
);
539 top_level_interpreter (void)
541 struct ui_interp_info
*ui_interp
= get_current_interp_info ();
543 return ui_interp
->top_level_interpreter
;
549 current_interpreter (void)
551 struct ui_interp_info
*ui_interp
= get_interp_info (current_ui
);
553 return ui_interp
->current_interpreter
;
556 /* This just adds the "interpreter-exec" command. */
558 _initialize_interpreter (void)
560 struct cmd_list_element
*c
;
562 c
= add_cmd ("interpreter-exec", class_support
,
563 interpreter_exec_cmd
, _("\
564 Execute a command in an interpreter. It takes two arguments:\n\
565 The first argument is the name of the interpreter to use.\n\
566 The second argument is the command to execute.\n"), &cmdlist
);
567 set_cmd_completer (c
, interpreter_completer
);