Makefiles: Flatten and sort file lists
[deliverable/binutils-gdb.git] / gdb / guile / guile.c
1 /* General GDB/Guile code.
2
3 Copyright (C) 2014-2016 Free Software Foundation, Inc.
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 /* See README file in this directory for implementation notes, coding
21 conventions, et.al. */
22
23 #include "defs.h"
24 #include "breakpoint.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-utils.h"
28 #include "command.h"
29 #include "gdbcmd.h"
30 #include "top.h"
31 #include "extension-priv.h"
32 #include "utils.h"
33 #include "version.h"
34 #ifdef HAVE_GUILE
35 #include "guile.h"
36 #include "guile-internal.h"
37 #endif
38 #include <signal.h>
39
40 /* The Guile version we're using.
41 We *could* use the macros in libguile/version.h but that would preclude
42 handling the user switching in a different version with, e.g.,
43 LD_LIBRARY_PATH (using a different version than what gdb was compiled with
44 is not something to be done lightly, but can be useful). */
45 int gdbscm_guile_major_version;
46 int gdbscm_guile_minor_version;
47 int gdbscm_guile_micro_version;
48
49 /* The guile subdirectory within gdb's data-directory. */
50 static const char *guile_datadir;
51
52 /* Declared constants and enum for guile exception printing. */
53 const char gdbscm_print_excp_none[] = "none";
54 const char gdbscm_print_excp_full[] = "full";
55 const char gdbscm_print_excp_message[] = "message";
56
57 /* "set guile print-stack" choices. */
58 static const char *const guile_print_excp_enums[] =
59 {
60 gdbscm_print_excp_none,
61 gdbscm_print_excp_full,
62 gdbscm_print_excp_message,
63 NULL
64 };
65
66 /* The exception printing variable. 'full' if we want to print the
67 error message and stack, 'none' if we want to print nothing, and
68 'message' if we only want to print the error message. 'message' is
69 the default. */
70 const char *gdbscm_print_excp = gdbscm_print_excp_message;
71
72 #ifdef HAVE_GUILE
73 /* Forward decls, these are defined later. */
74 extern const struct extension_language_script_ops guile_extension_script_ops;
75 extern const struct extension_language_ops guile_extension_ops;
76 #endif
77
78 /* The main struct describing GDB's interface to the Guile
79 extension language. */
80 extern const struct extension_language_defn extension_language_guile =
81 {
82 EXT_LANG_GUILE,
83 "guile",
84 "Guile",
85
86 ".scm",
87 "-gdb.scm",
88
89 guile_control,
90
91 #ifdef HAVE_GUILE
92 &guile_extension_script_ops,
93 &guile_extension_ops
94 #else
95 NULL,
96 NULL
97 #endif
98 };
99 \f
100 #ifdef HAVE_GUILE
101
102 static void gdbscm_finish_initialization
103 (const struct extension_language_defn *);
104 static int gdbscm_initialized (const struct extension_language_defn *);
105 static void gdbscm_eval_from_control_command
106 (const struct extension_language_defn *, struct command_line *);
107 static script_sourcer_func gdbscm_source_script;
108
109 int gdb_scheme_initialized;
110
111 /* Symbol for setting documentation strings. */
112 SCM gdbscm_documentation_symbol;
113
114 /* Keywords used by various functions. */
115 static SCM from_tty_keyword;
116 static SCM to_string_keyword;
117
118 /* The name of the various modules (without the surrounding parens). */
119 const char gdbscm_module_name[] = "gdb";
120 const char gdbscm_init_module_name[] = "gdb";
121
122 /* The name of the bootstrap file. */
123 static const char boot_scm_filename[] = "boot.scm";
124
125 /* The interface between gdb proper and loading of python scripts. */
126
127 const struct extension_language_script_ops guile_extension_script_ops =
128 {
129 gdbscm_source_script,
130 gdbscm_source_objfile_script,
131 gdbscm_execute_objfile_script,
132 gdbscm_auto_load_enabled
133 };
134
135 /* The interface between gdb proper and guile scripting. */
136
137 const struct extension_language_ops guile_extension_ops =
138 {
139 gdbscm_finish_initialization,
140 gdbscm_initialized,
141
142 gdbscm_eval_from_control_command,
143
144 NULL, /* gdbscm_start_type_printers, */
145 NULL, /* gdbscm_apply_type_printers, */
146 NULL, /* gdbscm_free_type_printers, */
147
148 gdbscm_apply_val_pretty_printer,
149
150 NULL, /* gdbscm_apply_frame_filter, */
151
152 gdbscm_preserve_values,
153
154 gdbscm_breakpoint_has_cond,
155 gdbscm_breakpoint_cond_says_stop,
156
157 NULL, /* gdbscm_check_quit_flag, */
158 NULL, /* gdbscm_set_quit_flag, */
159 };
160
161 /* Implementation of the gdb "guile-repl" command. */
162
163 static void
164 guile_repl_command (char *arg, int from_tty)
165 {
166 struct cleanup *cleanup;
167
168 cleanup = make_cleanup_restore_integer (&current_ui->async);
169 current_ui->async = 0;
170
171 arg = skip_spaces (arg);
172
173 /* This explicitly rejects any arguments for now.
174 "It is easier to relax a restriction than impose one after the fact."
175 We would *like* to be able to pass arguments to the interactive shell
176 but that's not what python-interactive does. Until there is time to
177 sort it out, we forbid arguments. */
178
179 if (arg && *arg)
180 error (_("guile-repl currently does not take any arguments."));
181 else
182 {
183 dont_repeat ();
184 gdbscm_enter_repl ();
185 }
186
187 do_cleanups (cleanup);
188 }
189
190 /* Implementation of the gdb "guile" command.
191 Note: Contrary to the Python version this displays the result.
192 Have to see which is better.
193
194 TODO: Add the result to Guile's history? */
195
196 static void
197 guile_command (char *arg, int from_tty)
198 {
199 struct cleanup *cleanup;
200
201 cleanup = make_cleanup_restore_integer (&current_ui->async);
202 current_ui->async = 0;
203
204 arg = skip_spaces (arg);
205
206 if (arg && *arg)
207 {
208 char *msg = gdbscm_safe_eval_string (arg, 1);
209
210 if (msg != NULL)
211 {
212 make_cleanup (xfree, msg);
213 error ("%s", msg);
214 }
215 }
216 else
217 {
218 struct command_line *l = get_command_line (guile_control, "");
219
220 make_cleanup_free_command_lines (&l);
221 execute_control_command_untraced (l);
222 }
223
224 do_cleanups (cleanup);
225 }
226
227 /* Given a command_line, return a command string suitable for passing
228 to Guile. Lines in the string are separated by newlines. The return
229 value is allocated using xmalloc and the caller is responsible for
230 freeing it. */
231
232 static char *
233 compute_scheme_string (struct command_line *l)
234 {
235 struct command_line *iter;
236 char *script = NULL;
237 int size = 0;
238 int here;
239
240 for (iter = l; iter; iter = iter->next)
241 size += strlen (iter->line) + 1;
242
243 script = (char *) xmalloc (size + 1);
244 here = 0;
245 for (iter = l; iter; iter = iter->next)
246 {
247 int len = strlen (iter->line);
248
249 strcpy (&script[here], iter->line);
250 here += len;
251 script[here++] = '\n';
252 }
253 script[here] = '\0';
254 return script;
255 }
256
257 /* Take a command line structure representing a "guile" command, and
258 evaluate its body using the Guile interpreter.
259 This is the extension_language_ops.eval_from_control_command "method". */
260
261 static void
262 gdbscm_eval_from_control_command
263 (const struct extension_language_defn *extlang, struct command_line *cmd)
264 {
265 char *script, *msg;
266 struct cleanup *cleanup;
267
268 if (cmd->body_count != 1)
269 error (_("Invalid \"guile\" block structure."));
270
271 cleanup = make_cleanup (null_cleanup, NULL);
272
273 script = compute_scheme_string (cmd->body_list[0]);
274 msg = gdbscm_safe_eval_string (script, 0);
275 xfree (script);
276 if (msg != NULL)
277 {
278 make_cleanup (xfree, msg);
279 error ("%s", msg);
280 }
281
282 do_cleanups (cleanup);
283 }
284
285 /* Read a file as Scheme code.
286 This is the extension_language_script_ops.script_sourcer "method".
287 FILE is the file to run. FILENAME is name of the file FILE.
288 This does not throw any errors. If an exception occurs an error message
289 is printed. */
290
291 static void
292 gdbscm_source_script (const struct extension_language_defn *extlang,
293 FILE *file, const char *filename)
294 {
295 char *msg = gdbscm_safe_source_script (filename);
296
297 if (msg != NULL)
298 {
299 fprintf_filtered (gdb_stderr, "%s\n", msg);
300 xfree (msg);
301 }
302 }
303 \f
304 /* (execute string [#:from-tty boolean] [#:to-string boolean])
305 A Scheme function which evaluates a string using the gdb CLI. */
306
307 static SCM
308 gdbscm_execute_gdb_command (SCM command_scm, SCM rest)
309 {
310 int from_tty_arg_pos = -1, to_string_arg_pos = -1;
311 int from_tty = 0, to_string = 0;
312 const SCM keywords[] = { from_tty_keyword, to_string_keyword, SCM_BOOL_F };
313 char *command;
314 struct cleanup *cleanups;
315 struct gdb_exception except = exception_none;
316
317 gdbscm_parse_function_args (FUNC_NAME, SCM_ARG1, keywords, "s#tt",
318 command_scm, &command, rest,
319 &from_tty_arg_pos, &from_tty,
320 &to_string_arg_pos, &to_string);
321
322 /* Note: The contents of "command" may get modified while it is
323 executed. */
324 cleanups = make_cleanup (xfree, command);
325
326 std::string to_string_res;
327
328 TRY
329 {
330 struct cleanup *inner_cleanups;
331
332 inner_cleanups = make_cleanup_restore_integer (&current_ui->async);
333 current_ui->async = 0;
334
335 prevent_dont_repeat ();
336 if (to_string)
337 to_string_res = execute_command_to_string (command, from_tty);
338 else
339 execute_command (command, from_tty);
340
341 /* Do any commands attached to breakpoint we stopped at. */
342 bpstat_do_actions ();
343
344 do_cleanups (inner_cleanups);
345 }
346 CATCH (ex, RETURN_MASK_ALL)
347 {
348 except = ex;
349 }
350 END_CATCH
351
352 do_cleanups (cleanups);
353 GDBSCM_HANDLE_GDB_EXCEPTION (except);
354
355 if (to_string)
356 return gdbscm_scm_from_c_string (to_string_res.c_str ());
357 return SCM_UNSPECIFIED;
358 }
359
360 /* (data-directory) -> string */
361
362 static SCM
363 gdbscm_data_directory (void)
364 {
365 return gdbscm_scm_from_c_string (gdb_datadir);
366 }
367
368 /* (guile-data-directory) -> string */
369
370 static SCM
371 gdbscm_guile_data_directory (void)
372 {
373 return gdbscm_scm_from_c_string (guile_datadir);
374 }
375
376 /* (gdb-version) -> string */
377
378 static SCM
379 gdbscm_gdb_version (void)
380 {
381 return gdbscm_scm_from_c_string (version);
382 }
383
384 /* (host-config) -> string */
385
386 static SCM
387 gdbscm_host_config (void)
388 {
389 return gdbscm_scm_from_c_string (host_name);
390 }
391
392 /* (target-config) -> string */
393
394 static SCM
395 gdbscm_target_config (void)
396 {
397 return gdbscm_scm_from_c_string (target_name);
398 }
399
400 #else /* ! HAVE_GUILE */
401
402 /* Dummy implementation of the gdb "guile-repl" and "guile"
403 commands. */
404
405 static void
406 guile_repl_command (char *arg, int from_tty)
407 {
408 arg = skip_spaces (arg);
409 if (arg && *arg)
410 error (_("guile-repl currently does not take any arguments."));
411 error (_("Guile scripting is not supported in this copy of GDB."));
412 }
413
414 static void
415 guile_command (char *arg, int from_tty)
416 {
417 arg = skip_spaces (arg);
418 if (arg && *arg)
419 error (_("Guile scripting is not supported in this copy of GDB."));
420 else
421 {
422 /* Even if Guile isn't enabled, we still have to slurp the
423 command list to the corresponding "end". */
424 struct command_line *l = get_command_line (guile_control, "");
425 struct cleanup *cleanups = make_cleanup_free_command_lines (&l);
426
427 execute_control_command_untraced (l);
428 do_cleanups (cleanups);
429 }
430 }
431
432 #endif /* ! HAVE_GUILE */
433 \f
434 /* Lists for 'set,show,info guile' commands. */
435
436 static struct cmd_list_element *set_guile_list;
437 static struct cmd_list_element *show_guile_list;
438 static struct cmd_list_element *info_guile_list;
439
440 /* Function for use by 'set guile' prefix command. */
441
442 static void
443 set_guile_command (char *args, int from_tty)
444 {
445 help_list (set_guile_list, "set guile ", all_commands, gdb_stdout);
446 }
447
448 /* Function for use by 'show guile' prefix command. */
449
450 static void
451 show_guile_command (char *args, int from_tty)
452 {
453 cmd_show_list (show_guile_list, from_tty, "");
454 }
455
456 /* The "info scheme" command is defined as a prefix, with
457 allow_unknown 0. Therefore, its own definition is called only for
458 "info scheme" with no args. */
459
460 static void
461 info_guile_command (char *args, int from_tty)
462 {
463 printf_unfiltered (_("\"info guile\" must be followed"
464 " by the name of an info command.\n"));
465 help_list (info_guile_list, "info guile ", all_commands, gdb_stdout);
466 }
467 \f
468 /* Initialization. */
469
470 #ifdef HAVE_GUILE
471
472 static const scheme_function misc_guile_functions[] =
473 {
474 { "execute", 1, 0, 1, as_a_scm_t_subr (gdbscm_execute_gdb_command),
475 "\
476 Execute the given GDB command.\n\
477 \n\
478 Arguments: string [#:to-string boolean] [#:from-tty boolean]\n\
479 If #:from-tty is true then the command executes as if entered\n\
480 from the keyboard. The default is false (#f).\n\
481 If #:to-string is true then the result is returned as a string.\n\
482 Otherwise output is sent to the current output port,\n\
483 which is the default.\n\
484 Returns: The result of the command if #:to-string is true.\n\
485 Otherwise returns unspecified." },
486
487 { "data-directory", 0, 0, 0, as_a_scm_t_subr (gdbscm_data_directory),
488 "\
489 Return the name of GDB's data directory." },
490
491 { "guile-data-directory", 0, 0, 0,
492 as_a_scm_t_subr (gdbscm_guile_data_directory),
493 "\
494 Return the name of the Guile directory within GDB's data directory." },
495
496 { "gdb-version", 0, 0, 0, as_a_scm_t_subr (gdbscm_gdb_version),
497 "\
498 Return GDB's version string." },
499
500 { "host-config", 0, 0, 0, as_a_scm_t_subr (gdbscm_host_config),
501 "\
502 Return the name of the host configuration." },
503
504 { "target-config", 0, 0, 0, as_a_scm_t_subr (gdbscm_target_config),
505 "\
506 Return the name of the target configuration." },
507
508 END_FUNCTIONS
509 };
510
511 /* Load BOOT_SCM_FILE, the first Scheme file that gets loaded. */
512
513 static SCM
514 boot_guile_support (void *boot_scm_file)
515 {
516 /* Load boot.scm without compiling it (there's no need to compile it).
517 The other files should have been compiled already, and boot.scm is
518 expected to adjust '%load-compiled-path' accordingly. If they haven't
519 been compiled, Guile will auto-compile them. The important thing to keep
520 in mind is that there's a >= 100x speed difference between compiled and
521 non-compiled files. */
522 return scm_c_primitive_load ((const char *) boot_scm_file);
523 }
524
525 /* Return non-zero if ARGS has the "standard" format for throw args.
526 The standard format is:
527 (function format-string (format-string-args-list) ...).
528 FUNCTION is #f if no function was recorded. */
529
530 static int
531 standard_throw_args_p (SCM args)
532 {
533 if (gdbscm_is_true (scm_list_p (args))
534 && scm_ilength (args) >= 3)
535 {
536 /* The function in which the error occurred. */
537 SCM arg0 = scm_list_ref (args, scm_from_int (0));
538 /* The format string. */
539 SCM arg1 = scm_list_ref (args, scm_from_int (1));
540 /* The arguments of the format string. */
541 SCM arg2 = scm_list_ref (args, scm_from_int (2));
542
543 if ((scm_is_string (arg0) || gdbscm_is_false (arg0))
544 && scm_is_string (arg1)
545 && gdbscm_is_true (scm_list_p (arg2)))
546 return 1;
547 }
548
549 return 0;
550 }
551
552 /* Print the error recorded in a "standard" throw args. */
553
554 static void
555 print_standard_throw_error (SCM args)
556 {
557 /* The function in which the error occurred. */
558 SCM arg0 = scm_list_ref (args, scm_from_int (0));
559 /* The format string. */
560 SCM arg1 = scm_list_ref (args, scm_from_int (1));
561 /* The arguments of the format string. */
562 SCM arg2 = scm_list_ref (args, scm_from_int (2));
563
564 /* ARG0 is #f if no function was recorded. */
565 if (gdbscm_is_true (arg0))
566 {
567 scm_simple_format (scm_current_error_port (),
568 scm_from_latin1_string (_("Error in function ~s:~%")),
569 scm_list_1 (arg0));
570 }
571 scm_simple_format (scm_current_error_port (), arg1, arg2);
572 }
573
574 /* Print the error message recorded in KEY, ARGS, the arguments to throw.
575 Normally we let Scheme print the error message.
576 This function is used when Scheme initialization fails.
577 We can still use the Scheme C API though. */
578
579 static void
580 print_throw_error (SCM key, SCM args)
581 {
582 /* IWBN to call gdbscm_print_exception_with_stack here, but Guile didn't
583 boot successfully so play it safe and avoid it. The "format string" and
584 its args are embedded in ARGS, but the content of ARGS depends on KEY.
585 Make sure ARGS has the expected canonical content before trying to use
586 it. */
587 if (standard_throw_args_p (args))
588 print_standard_throw_error (args);
589 else
590 {
591 scm_simple_format (scm_current_error_port (),
592 scm_from_latin1_string (_("Throw to key `~a' with args `~s'.~%")),
593 scm_list_2 (key, args));
594 }
595 }
596
597 /* Handle an exception thrown while loading BOOT_SCM_FILE. */
598
599 static SCM
600 handle_boot_error (void *boot_scm_file, SCM key, SCM args)
601 {
602 fprintf_unfiltered (gdb_stderr, ("Exception caught while booting Guile.\n"));
603
604 print_throw_error (key, args);
605
606 fprintf_unfiltered (gdb_stderr, "\n");
607 warning (_("Could not complete Guile gdb module initialization from:\n"
608 "%s.\n"
609 "Limited Guile support is available.\n"
610 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
611 (const char *) boot_scm_file);
612
613 return SCM_UNSPECIFIED;
614 }
615
616 /* Load gdb/boot.scm, the Scheme side of GDB/Guile support.
617 Note: This function assumes it's called within the gdb module. */
618
619 static void
620 initialize_scheme_side (void)
621 {
622 char *boot_scm_path;
623 char *msg;
624
625 guile_datadir = concat (gdb_datadir, SLASH_STRING, "guile", (char *) NULL);
626 boot_scm_path = concat (guile_datadir, SLASH_STRING, "gdb",
627 SLASH_STRING, boot_scm_filename, (char *) NULL);
628
629 scm_c_catch (SCM_BOOL_T, boot_guile_support, boot_scm_path,
630 handle_boot_error, boot_scm_path, NULL, NULL);
631
632 xfree (boot_scm_path);
633 }
634
635 /* Install the gdb scheme module.
636 The result is a boolean indicating success.
637 If initializing the gdb module fails an error message is printed.
638 Note: This function runs in the context of the gdb module. */
639
640 static void
641 initialize_gdb_module (void *data)
642 {
643 /* Computing these is a pain, so only do it once.
644 Also, do it here and save the result so that obtaining the values
645 is thread-safe. */
646 gdbscm_guile_major_version = gdbscm_scm_string_to_int (scm_major_version ());
647 gdbscm_guile_minor_version = gdbscm_scm_string_to_int (scm_minor_version ());
648 gdbscm_guile_micro_version = gdbscm_scm_string_to_int (scm_micro_version ());
649
650 /* The documentation symbol needs to be defined before any calls to
651 gdbscm_define_{variables,functions}. */
652 gdbscm_documentation_symbol = scm_from_latin1_symbol ("documentation");
653
654 /* The smob and exception support must be initialized early. */
655 gdbscm_initialize_smobs ();
656 gdbscm_initialize_exceptions ();
657
658 /* The rest are initialized in alphabetical order. */
659 gdbscm_initialize_arches ();
660 gdbscm_initialize_auto_load ();
661 gdbscm_initialize_blocks ();
662 gdbscm_initialize_breakpoints ();
663 gdbscm_initialize_commands ();
664 gdbscm_initialize_disasm ();
665 gdbscm_initialize_frames ();
666 gdbscm_initialize_iterators ();
667 gdbscm_initialize_lazy_strings ();
668 gdbscm_initialize_math ();
669 gdbscm_initialize_objfiles ();
670 gdbscm_initialize_parameters ();
671 gdbscm_initialize_ports ();
672 gdbscm_initialize_pretty_printers ();
673 gdbscm_initialize_pspaces ();
674 gdbscm_initialize_strings ();
675 gdbscm_initialize_symbols ();
676 gdbscm_initialize_symtabs ();
677 gdbscm_initialize_types ();
678 gdbscm_initialize_values ();
679
680 gdbscm_define_functions (misc_guile_functions, 1);
681
682 from_tty_keyword = scm_from_latin1_keyword ("from-tty");
683 to_string_keyword = scm_from_latin1_keyword ("to-string");
684
685 initialize_scheme_side ();
686
687 gdb_scheme_initialized = 1;
688 }
689
690 /* Utility to call scm_c_define_module+initialize_gdb_module from
691 within scm_with_guile. */
692
693 static void *
694 call_initialize_gdb_module (void *data)
695 {
696 /* Most of the initialization is done by initialize_gdb_module.
697 It is called via scm_c_define_module so that the initialization is
698 performed within the desired module. */
699 scm_c_define_module (gdbscm_module_name, initialize_gdb_module, NULL);
700
701 #if HAVE_GUILE_MANUAL_FINALIZATION
702 scm_run_finalizers ();
703 #endif
704
705 return NULL;
706 }
707
708 /* A callback to finish Guile initialization after gdb has finished all its
709 initialization.
710 This is the extension_language_ops.finish_initialization "method". */
711
712 static void
713 gdbscm_finish_initialization (const struct extension_language_defn *extlang)
714 {
715 /* Restore the environment to the user interaction one. */
716 scm_set_current_module (scm_interaction_environment ());
717 }
718
719 /* The extension_language_ops.initialized "method". */
720
721 static int
722 gdbscm_initialized (const struct extension_language_defn *extlang)
723 {
724 return gdb_scheme_initialized;
725 }
726
727 /* Enable or disable Guile backtraces. */
728
729 static void
730 gdbscm_set_backtrace (int enable)
731 {
732 static const char disable_bt[] = "(debug-disable 'backtrace)";
733 static const char enable_bt[] = "(debug-enable 'backtrace)";
734
735 if (enable)
736 gdbscm_safe_eval_string (enable_bt, 0);
737 else
738 gdbscm_safe_eval_string (disable_bt, 0);
739 }
740
741 #endif /* HAVE_GUILE */
742
743 /* Install the various gdb commands used by Guile. */
744
745 static void
746 install_gdb_commands (void)
747 {
748 add_com ("guile-repl", class_obscure,
749 guile_repl_command,
750 #ifdef HAVE_GUILE
751 _("\
752 Start an interactive Guile prompt.\n\
753 \n\
754 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
755 prompt) or ,quit.")
756 #else /* HAVE_GUILE */
757 _("\
758 Start a Guile interactive prompt.\n\
759 \n\
760 Guile scripting is not supported in this copy of GDB.\n\
761 This command is only a placeholder.")
762 #endif /* HAVE_GUILE */
763 );
764 add_com_alias ("gr", "guile-repl", class_obscure, 1);
765
766 /* Since "help guile" is easy to type, and intuitive, we add general help
767 in using GDB+Guile to this command. */
768 add_com ("guile", class_obscure, guile_command,
769 #ifdef HAVE_GUILE
770 _("\
771 Evaluate one or more Guile expressions.\n\
772 \n\
773 The expression(s) can be given as an argument, for instance:\n\
774 \n\
775 guile (display 23)\n\
776 \n\
777 The result of evaluating the last expression is printed.\n\
778 \n\
779 If no argument is given, the following lines are read and passed\n\
780 to Guile for evaluation. Type a line containing \"end\" to indicate\n\
781 the end of the set of expressions.\n\
782 \n\
783 The Guile GDB module must first be imported before it can be used.\n\
784 Do this with:\n\
785 (gdb) guile (use-modules (gdb))\n\
786 or if you want to import the (gdb) module with a prefix, use:\n\
787 (gdb) guile (use-modules ((gdb) #:renamer (symbol-prefix-proc 'gdb:)))\n\
788 \n\
789 The Guile interactive session, started with the \"guile-repl\"\n\
790 command, provides extensive help and apropos capabilities.\n\
791 Type \",help\" once in a Guile interactive session.")
792 #else /* HAVE_GUILE */
793 _("\
794 Evaluate a Guile expression.\n\
795 \n\
796 Guile scripting is not supported in this copy of GDB.\n\
797 This command is only a placeholder.")
798 #endif /* HAVE_GUILE */
799 );
800 add_com_alias ("gu", "guile", class_obscure, 1);
801
802 add_prefix_cmd ("guile", class_obscure, set_guile_command,
803 _("Prefix command for Guile preference settings."),
804 &set_guile_list, "set guile ", 0,
805 &setlist);
806 add_alias_cmd ("gu", "guile", class_obscure, 1, &setlist);
807
808 add_prefix_cmd ("guile", class_obscure, show_guile_command,
809 _("Prefix command for Guile preference settings."),
810 &show_guile_list, "show guile ", 0,
811 &showlist);
812 add_alias_cmd ("gu", "guile", class_obscure, 1, &showlist);
813
814 add_prefix_cmd ("guile", class_obscure, info_guile_command,
815 _("Prefix command for Guile info displays."),
816 &info_guile_list, "info guile ", 0,
817 &infolist);
818 add_info_alias ("gu", "guile", 1);
819
820 /* The name "print-stack" is carried over from Python.
821 A better name is "print-exception". */
822 add_setshow_enum_cmd ("print-stack", no_class, guile_print_excp_enums,
823 &gdbscm_print_excp, _("\
824 Set mode for Guile exception printing on error."), _("\
825 Show the mode of Guile exception printing on error."), _("\
826 none == no stack or message will be printed.\n\
827 full == a message and a stack will be printed.\n\
828 message == an error message without a stack will be printed."),
829 NULL, NULL,
830 &set_guile_list, &show_guile_list);
831 }
832
833 /* Provide a prototype to silence -Wmissing-prototypes. */
834 extern initialize_file_ftype _initialize_guile;
835
836 void
837 _initialize_guile (void)
838 {
839 install_gdb_commands ();
840
841 #if HAVE_GUILE
842 {
843 #ifdef HAVE_SIGPROCMASK
844 sigset_t sigchld_mask, prev_mask;
845 #endif
846
847 /* The Python support puts the C side in module "_gdb", leaving the Python
848 side to define module "gdb" which imports "_gdb". There is evidently no
849 similar convention in Guile so we skip this. */
850
851 #if HAVE_GUILE_MANUAL_FINALIZATION
852 /* Our SMOB free functions are not thread-safe, as GDB itself is not
853 intended to be thread-safe. Disable automatic finalization so that
854 finalizers aren't run in other threads. */
855 scm_set_automatic_finalization_enabled (0);
856 #endif
857
858 #ifdef HAVE_SIGPROCMASK
859 /* Before we initialize Guile, block SIGCHLD.
860 This is done so that all threads created during Guile initialization
861 have SIGCHLD blocked. PR 17247.
862 Really libgc and Guile should do this, but we need to work with
863 libgc 7.4.x. */
864 sigemptyset (&sigchld_mask);
865 sigaddset (&sigchld_mask, SIGCHLD);
866 sigprocmask (SIG_BLOCK, &sigchld_mask, &prev_mask);
867 #endif
868
869 /* scm_with_guile is the most portable way to initialize Guile.
870 Plus we need to initialize the Guile support while in Guile mode
871 (e.g., called from within a call to scm_with_guile). */
872 scm_with_guile (call_initialize_gdb_module, NULL);
873
874 #ifdef HAVE_SIGPROCMASK
875 sigprocmask (SIG_SETMASK, &prev_mask, NULL);
876 #endif
877
878 /* Set Guile's backtrace to match the "set guile print-stack" default.
879 [N.B. The two settings are still separate.]
880 But only do this after we've initialized Guile, it's nice to see a
881 backtrace if there's an error during initialization.
882 OTOH, if the error is that gdb/init.scm wasn't found because gdb is
883 being run from the build tree, the backtrace is more noise than signal.
884 Sigh. */
885 gdbscm_set_backtrace (0);
886 }
887 #endif
888 }
This page took 0.048979 seconds and 4 git commands to generate.