1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000, 2002-2003, 2007-2012 Free Software Foundation,
6 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* This is just a first cut at separating out the "interpreter"
24 functions of gdb into self-contained modules. There are a couple
25 of open areas that need to be sorted out:
27 1) The interpreter explicitly contains a UI_OUT, and can insert itself
28 into the event loop, but it doesn't explicitly contain hooks for readline.
29 I did this because it seems to me many interpreters won't want to use
30 the readline command interface, and it is probably simpler to just let
31 them take over the input in their resume proc. */
36 #include "event-loop.h"
37 #include "event-top.h"
39 #include "completer.h"
40 #include "gdb_string.h"
41 #include "gdb_assert.h"
42 #include "top.h" /* For command_loop. */
43 #include "exceptions.h"
44 #include "continuations.h"
46 /* True if the current interpreter in is async mode. See interps.h
47 for more details. This starts out disabled, until all the explicit
48 command line arguments (e.g., `gdb -ex "start" -ex "next"') are
50 int interpreter_async
= 0;
54 /* This is the name in "-i=" and set interpreter. */
57 /* Interpreters are stored in a linked list, this is the next
61 /* This is a cookie that an instance of the interpreter can use.
62 This is a bit confused right now as the exact initialization
63 sequence for it, and how it relates to the interpreter's uiout
64 object is a bit confused. */
67 /* Has the init_proc been run? */
70 const struct interp_procs
*procs
;
74 /* Functions local to this file. */
75 static void initialize_interps (void);
76 static char **interpreter_completer (struct cmd_list_element
*cmd
,
77 char *text
, char *word
);
79 /* The magic initialization routine for this module. */
81 void _initialize_interpreter (void);
83 /* Variables local to this file: */
85 static struct interp
*interp_list
= NULL
;
86 static struct interp
*current_interpreter
= NULL
;
87 static struct interp
*top_level_interpreter_ptr
= NULL
;
89 static int interpreter_initialized
= 0;
91 /* interp_new - This allocates space for a new interpreter,
92 fills the fields from the inputs, and returns a pointer to the
95 interp_new (const char *name
, const struct interp_procs
*procs
)
97 struct interp
*new_interp
;
99 new_interp
= XMALLOC (struct interp
);
101 new_interp
->name
= xstrdup (name
);
102 new_interp
->data
= NULL
;
103 new_interp
->quiet_p
= 0;
104 new_interp
->procs
= procs
;
105 new_interp
->inited
= 0;
110 /* Add interpreter INTERP to the gdb interpreter list. The
111 interpreter must not have previously been added. */
113 interp_add (struct interp
*interp
)
115 if (!interpreter_initialized
)
116 initialize_interps ();
118 gdb_assert (interp_lookup (interp
->name
) == NULL
);
120 interp
->next
= interp_list
;
121 interp_list
= interp
;
124 /* This sets the current interpreter to be INTERP. If INTERP has not
125 been initialized, then this will also run the init proc. If the
126 init proc is successful, return 1, if it fails, set the old
127 interpreter back in place and return 0. If we can't restore the
128 old interpreter, then raise an internal error, since we are in
129 pretty bad shape at this point.
131 The TOP_LEVEL parameter tells if this new interpreter is
132 the top-level one. The top-level is what is requested
133 on the command line, and is responsible for reporting general
134 notification about target state changes. For example, if
135 MI is the top-level interpreter, then it will always report
136 events such as target stops and new thread creation, even if they
137 are caused by CLI commands. */
139 interp_set (struct interp
*interp
, int top_level
)
141 struct interp
*old_interp
= current_interpreter
;
145 /* If we already have an interpreter, then trying to
146 set top level interpreter is kinda pointless. */
147 gdb_assert (!top_level
|| !current_interpreter
);
148 gdb_assert (!top_level
|| !top_level_interpreter_ptr
);
150 if (current_interpreter
!= NULL
)
152 ui_out_flush (current_uiout
);
153 if (current_interpreter
->procs
->suspend_proc
154 && !current_interpreter
->procs
->suspend_proc (current_interpreter
->
157 error (_("Could not suspend interpreter \"%s\"."),
158 current_interpreter
->name
);
166 current_interpreter
= interp
;
168 top_level_interpreter_ptr
= interp
;
170 /* We use interpreter_p for the "set interpreter" variable, so we need
171 to make sure we have a malloc'ed copy for the set command to free. */
172 if (interpreter_p
!= NULL
173 && strcmp (current_interpreter
->name
, interpreter_p
) != 0)
175 xfree (interpreter_p
);
177 interpreter_p
= xstrdup (current_interpreter
->name
);
180 /* Run the init proc. If it fails, try to restore the old interp. */
184 if (interp
->procs
->init_proc
!= NULL
)
186 interp
->data
= interp
->procs
->init_proc (interp
, top_level
);
191 /* Do this only after the interpreter is initialized. */
192 current_uiout
= interp
->procs
->ui_out_proc (interp
);
194 /* Clear out any installed interpreter hooks/event handlers. */
195 clear_interpreter_hooks ();
197 if (interp
->procs
->resume_proc
!= NULL
198 && (!interp
->procs
->resume_proc (interp
->data
)))
200 if (old_interp
== NULL
|| !interp_set (old_interp
, 0))
201 internal_error (__FILE__
, __LINE__
,
202 _("Failed to initialize new interp \"%s\" %s"),
203 interp
->name
, "and could not restore old interp!\n");
207 /* Finally, put up the new prompt to show that we are indeed here.
208 Also, display_gdb_prompt for the console does some readline magic
209 which is needed for the console interpreter, at least... */
213 if (!interp_quiet_p (interp
))
215 sprintf (buffer
, "Switching to interpreter \"%.24s\".\n",
217 ui_out_text (current_uiout
, buffer
);
219 display_gdb_prompt (NULL
);
225 /* interp_lookup - Looks up the interpreter for NAME. If no such
226 interpreter exists, return NULL, otherwise return a pointer to the
229 interp_lookup (const char *name
)
231 struct interp
*interp
;
233 if (name
== NULL
|| strlen (name
) == 0)
236 for (interp
= interp_list
; interp
!= NULL
; interp
= interp
->next
)
238 if (strcmp (interp
->name
, name
) == 0)
245 /* Returns the current interpreter. */
248 interp_ui_out (struct interp
*interp
)
251 return interp
->procs
->ui_out_proc (interp
);
253 return current_interpreter
->procs
->ui_out_proc (current_interpreter
);
256 /* Returns the interpreter's cookie. */
259 interp_data (struct interp
*interp
)
264 /* Returns the interpreter's name. */
267 interp_name (struct interp
*interp
)
272 /* Returns true if the current interp is the passed in name. */
274 current_interp_named_p (const char *interp_name
)
276 if (current_interpreter
)
277 return (strcmp (current_interpreter
->name
, interp_name
) == 0);
282 /* This is called in display_gdb_prompt. If the proc returns a zero
283 value, display_gdb_prompt will return without displaying the
286 current_interp_display_prompt_p (void)
288 if (current_interpreter
== NULL
289 || current_interpreter
->procs
->prompt_proc_p
== NULL
)
292 return current_interpreter
->procs
->prompt_proc_p (current_interpreter
->
296 /* Run the current command interpreter's main loop. */
298 current_interp_command_loop (void)
300 /* Somewhat messy. For the moment prop up all the old ways of
301 selecting the command loop. `deprecated_command_loop_hook'
302 should be deprecated. */
303 if (deprecated_command_loop_hook
!= NULL
)
304 deprecated_command_loop_hook ();
305 else if (current_interpreter
!= NULL
306 && current_interpreter
->procs
->command_loop_proc
!= NULL
)
307 current_interpreter
->procs
->command_loop_proc (current_interpreter
->data
);
313 interp_quiet_p (struct interp
*interp
)
316 return interp
->quiet_p
;
318 return current_interpreter
->quiet_p
;
322 interp_set_quiet (struct interp
*interp
, int quiet
)
324 int old_val
= interp
->quiet_p
;
326 interp
->quiet_p
= quiet
;
330 /* interp_exec - This executes COMMAND_STR in the current
333 interp_exec_p (struct interp
*interp
)
335 return interp
->procs
->exec_proc
!= NULL
;
339 interp_exec (struct interp
*interp
, const char *command_str
)
341 if (interp
->procs
->exec_proc
!= NULL
)
343 return interp
->procs
->exec_proc (interp
->data
, command_str
);
345 return exception_none
;
348 /* A convenience routine that nulls out all the common command hooks.
349 Use it when removing your interpreter in its suspend proc. */
351 clear_interpreter_hooks (void)
353 deprecated_init_ui_hook
= 0;
354 deprecated_print_frame_info_listing_hook
= 0;
355 /*print_frame_more_info_hook = 0; */
356 deprecated_query_hook
= 0;
357 deprecated_warning_hook
= 0;
358 deprecated_interactive_hook
= 0;
359 deprecated_readline_begin_hook
= 0;
360 deprecated_readline_hook
= 0;
361 deprecated_readline_end_hook
= 0;
362 deprecated_register_changed_hook
= 0;
363 deprecated_context_hook
= 0;
364 deprecated_target_wait_hook
= 0;
365 deprecated_call_command_hook
= 0;
366 deprecated_error_begin_hook
= 0;
367 deprecated_command_loop_hook
= 0;
370 /* This is a lazy init routine, called the first time the interpreter
371 module is used. I put it here just in case, but I haven't thought
372 of a use for it yet. I will probably bag it soon, since I don't
373 think it will be necessary. */
375 initialize_interps (void)
377 interpreter_initialized
= 1;
378 /* Don't know if anything needs to be done here... */
382 interpreter_exec_cmd (char *args
, int from_tty
)
384 struct interp
*old_interp
, *interp_to_use
;
385 char **prules
= NULL
;
389 int old_quiet
, use_quiet
;
392 error_no_arg (_("interpreter-exec command"));
394 prules
= gdb_buildargv (args
);
395 make_cleanup_freeargv (prules
);
398 for (trule
= prules
; *trule
!= NULL
; trule
++)
402 error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
404 old_interp
= current_interpreter
;
406 interp_to_use
= interp_lookup (prules
[0]);
407 if (interp_to_use
== NULL
)
408 error (_("Could not find interpreter \"%s\"."), prules
[0]);
410 /* Temporarily set interpreters quiet. */
411 old_quiet
= interp_set_quiet (old_interp
, 1);
412 use_quiet
= interp_set_quiet (interp_to_use
, 1);
414 if (!interp_set (interp_to_use
, 0))
415 error (_("Could not switch to interpreter \"%s\"."), prules
[0]);
417 for (i
= 1; i
< nrules
; i
++)
419 struct gdb_exception e
= interp_exec (interp_to_use
, prules
[i
]);
423 interp_set (old_interp
, 0);
424 interp_set_quiet (interp_to_use
, use_quiet
);
425 interp_set_quiet (old_interp
, old_quiet
);
426 error (_("error in command: \"%s\"."), prules
[i
]);
430 interp_set (old_interp
, 0);
431 interp_set_quiet (interp_to_use
, use_quiet
);
432 interp_set_quiet (old_interp
, old_quiet
);
435 /* List the possible interpreters which could complete the given text. */
437 interpreter_completer (struct cmd_list_element
*ignore
, char *text
, char *word
)
443 struct interp
*interp
;
445 /* We expect only a very limited number of interpreters, so just
446 allocate room for all of them plus one for the last that must be NULL
447 to correctly end the list. */
448 for (interp
= interp_list
; interp
!= NULL
; interp
= interp
->next
)
450 matches
= (char **) xcalloc (alloced
+ 1, sizeof (char *));
453 textlen
= strlen (text
);
454 for (interp
= interp_list
; interp
!= NULL
; interp
= interp
->next
)
456 if (strncmp (interp
->name
, text
, textlen
) == 0)
458 matches
[num_matches
] =
459 (char *) xmalloc (strlen (word
) + strlen (interp
->name
) + 1);
461 strcpy (matches
[num_matches
], interp
->name
);
462 else if (word
> text
)
464 /* Return some portion of interp->name. */
465 strcpy (matches
[num_matches
], interp
->name
+ (word
- text
));
469 /* Return some of text plus interp->name. */
470 strncpy (matches
[num_matches
], word
, text
- word
);
471 matches
[num_matches
][text
- word
] = '\0';
472 strcat (matches
[num_matches
], interp
->name
);
478 if (num_matches
== 0)
488 top_level_interpreter (void)
490 return top_level_interpreter_ptr
;
494 top_level_interpreter_data (void)
496 gdb_assert (top_level_interpreter_ptr
);
497 return top_level_interpreter_ptr
->data
;
500 /* This just adds the "interpreter-exec" command. */
502 _initialize_interpreter (void)
504 struct cmd_list_element
*c
;
506 c
= add_cmd ("interpreter-exec", class_support
,
507 interpreter_exec_cmd
, _("\
508 Execute a command in an interpreter. It takes two arguments:\n\
509 The first argument is the name of the interpreter to use.\n\
510 The second argument is the command to execute.\n"), &cmdlist
);
511 set_cmd_completer (c
, interpreter_completer
);