1 /* GDB commands implemented in Scheme.
3 Copyright (C) 2008-2021 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 /* See README file in this directory for implementation notes, coding
21 conventions, et.al. */
27 #include "cli/cli-decode.h"
28 #include "completer.h"
29 #include "guile-internal.h"
31 /* The <gdb:command> smob.
33 Note: Commands are added to gdb using a two step process:
34 1) Call make-command to create a <gdb:command> object.
35 2) Call register-command! to add the command to gdb.
36 It is done this way so that the constructor, make-command, doesn't have
37 any side-effects. This means that the smob needs to store everything
38 that was passed to make-command. */
42 /* This always appears first. */
45 /* The name of the command, as passed to make-command. */
48 /* The last word of the command.
49 This is needed because add_cmd requires us to allocate space
53 /* Non-zero if this is a prefix command. */
56 /* One of the COMMAND_* constants. */
57 enum command_class cmd_class
;
59 /* The documentation for the command. */
62 /* The corresponding gdb command object.
63 This is NULL if the command has not been registered yet, or
64 is no longer registered. */
65 struct cmd_list_element
*command
;
67 /* A prefix command requires storage for a list of its sub-commands.
68 A pointer to this is passed to add_prefix_command, and to add_cmd
69 for sub-commands of that prefix.
70 This is NULL if the command has not been registered yet, or
71 is no longer registered. If this command is not a prefix
72 command, then this field is unused. */
73 struct cmd_list_element
*sub_list
;
75 /* The procedure to call to invoke the command.
76 (lambda (self arg from-tty) ...).
77 Its result is unspecified. */
80 /* Either #f, one of the COMPLETE_* constants, or a procedure to call to
81 perform command completion. Called as (lambda (self text word) ...). */
84 /* The <gdb:command> object we are contained in, needed to protect/unprotect
85 the object since a reference to it comes from non-gc-managed space
86 (the command context pointer). */
90 static const char command_smob_name
[] = "gdb:command";
92 /* The tag Guile knows the objfile smob by. */
93 static scm_t_bits command_smob_tag
;
95 /* Keywords used by make-command. */
96 static SCM invoke_keyword
;
97 static SCM command_class_keyword
;
98 static SCM completer_class_keyword
;
99 static SCM prefix_p_keyword
;
100 static SCM doc_keyword
;
102 /* Struct representing built-in completion types. */
103 struct cmdscm_completer
105 /* Scheme symbol name. */
107 /* Completion function. */
108 completer_ftype
*completer
;
111 static const struct cmdscm_completer cmdscm_completers
[] =
113 { "COMPLETE_NONE", noop_completer
},
114 { "COMPLETE_FILENAME", filename_completer
},
115 { "COMPLETE_LOCATION", location_completer
},
116 { "COMPLETE_COMMAND", command_completer
},
117 { "COMPLETE_SYMBOL", symbol_completer
},
118 { "COMPLETE_EXPRESSION", expression_completer
},
121 #define N_COMPLETERS (sizeof (cmdscm_completers) \
122 / sizeof (cmdscm_completers[0]))
124 static int cmdscm_is_valid (command_smob
*);
126 /* Administrivia for command smobs. */
128 /* The smob "print" function for <gdb:command>. */
131 cmdscm_print_command_smob (SCM self
, SCM port
, scm_print_state
*pstate
)
133 command_smob
*c_smob
= (command_smob
*) SCM_SMOB_DATA (self
);
135 gdbscm_printf (port
, "#<%s", command_smob_name
);
137 gdbscm_printf (port
, " %s",
138 c_smob
->name
!= NULL
? c_smob
->name
: "{unnamed}");
140 if (! cmdscm_is_valid (c_smob
))
141 scm_puts (" {invalid}", port
);
143 scm_puts (">", port
);
145 scm_remember_upto_here_1 (self
);
147 /* Non-zero means success. */
151 /* Low level routine to create a <gdb:command> object.
152 It's empty in the sense that a command still needs to be associated
156 cmdscm_make_command_smob (void)
158 command_smob
*c_smob
= (command_smob
*)
159 scm_gc_malloc (sizeof (command_smob
), command_smob_name
);
162 memset (c_smob
, 0, sizeof (*c_smob
));
163 c_smob
->cmd_class
= no_class
;
164 c_smob
->invoke
= SCM_BOOL_F
;
165 c_smob
->complete
= SCM_BOOL_F
;
166 c_scm
= scm_new_smob (command_smob_tag
, (scm_t_bits
) c_smob
);
167 c_smob
->containing_scm
= c_scm
;
168 gdbscm_init_gsmob (&c_smob
->base
);
173 /* Clear the COMMAND pointer in C_SMOB and unprotect the object from GC. */
176 cmdscm_release_command (command_smob
*c_smob
)
178 c_smob
->command
= NULL
;
179 scm_gc_unprotect_object (c_smob
->containing_scm
);
182 /* Return non-zero if SCM is a command smob. */
185 cmdscm_is_command (SCM scm
)
187 return SCM_SMOB_PREDICATE (command_smob_tag
, scm
);
190 /* (command? scm) -> boolean */
193 gdbscm_command_p (SCM scm
)
195 return scm_from_bool (cmdscm_is_command (scm
));
198 /* Returns the <gdb:command> object in SELF.
199 Throws an exception if SELF is not a <gdb:command> object. */
202 cmdscm_get_command_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
204 SCM_ASSERT_TYPE (cmdscm_is_command (self
), self
, arg_pos
, func_name
,
210 /* Returns a pointer to the command smob of SELF.
211 Throws an exception if SELF is not a <gdb:command> object. */
213 static command_smob
*
214 cmdscm_get_command_smob_arg_unsafe (SCM self
, int arg_pos
,
215 const char *func_name
)
217 SCM c_scm
= cmdscm_get_command_arg_unsafe (self
, arg_pos
, func_name
);
218 command_smob
*c_smob
= (command_smob
*) SCM_SMOB_DATA (c_scm
);
223 /* Return non-zero if command C_SMOB is valid. */
226 cmdscm_is_valid (command_smob
*c_smob
)
228 return c_smob
->command
!= NULL
;
231 /* Returns a pointer to the command smob of SELF.
232 Throws an exception if SELF is not a valid <gdb:command> object. */
234 static command_smob
*
235 cmdscm_get_valid_command_smob_arg_unsafe (SCM self
, int arg_pos
,
236 const char *func_name
)
239 = cmdscm_get_command_smob_arg_unsafe (self
, arg_pos
, func_name
);
241 if (!cmdscm_is_valid (c_smob
))
243 gdbscm_invalid_object_error (func_name
, arg_pos
, self
,
250 /* Scheme functions for GDB commands. */
252 /* (command-valid? <gdb:command>) -> boolean
253 Returns #t if SELF is still valid. */
256 gdbscm_command_valid_p (SCM self
)
259 = cmdscm_get_command_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
261 return scm_from_bool (cmdscm_is_valid (c_smob
));
264 /* (dont-repeat cmd) -> unspecified
265 Scheme function which wraps dont_repeat. */
268 gdbscm_dont_repeat (SCM self
)
270 /* We currently don't need anything from SELF, but still verify it.
271 Call for side effects. */
272 cmdscm_get_valid_command_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
276 return SCM_UNSPECIFIED
;
279 /* The make-command function. */
281 /* Called if the gdb cmd_list_element is destroyed. */
284 cmdscm_destroyer (struct cmd_list_element
*self
, void *context
)
286 command_smob
*c_smob
= (command_smob
*) context
;
288 cmdscm_release_command (c_smob
);
291 /* Called by gdb to invoke the command. */
294 cmdscm_function (const char *args
, int from_tty
, cmd_list_element
*command
)
296 command_smob
*c_smob
/*obj*/ = (command_smob
*) command
->context ();
297 SCM arg_scm
, tty_scm
, result
;
299 gdb_assert (c_smob
!= NULL
);
303 arg_scm
= gdbscm_scm_from_string (args
, strlen (args
), host_charset (), 1);
304 if (gdbscm_is_exception (arg_scm
))
305 error (_("Could not convert arguments to Scheme string."));
307 tty_scm
= scm_from_bool (from_tty
);
309 result
= gdbscm_safe_call_3 (c_smob
->invoke
, c_smob
->containing_scm
,
310 arg_scm
, tty_scm
, gdbscm_user_error_p
);
312 if (gdbscm_is_exception (result
))
314 /* Don't print the stack if this was an error signalled by the command
316 if (gdbscm_user_error_p (gdbscm_exception_key (result
)))
318 gdb::unique_xmalloc_ptr
<char> msg
319 = gdbscm_exception_message_to_string (result
);
321 error ("%s", msg
.get ());
325 gdbscm_print_gdb_exception (SCM_BOOL_F
, result
);
326 error (_("Error occurred in Scheme-implemented GDB command."));
331 /* Subroutine of cmdscm_completer to simplify it.
332 Print an error message indicating that COMPLETION is a bad completion
336 cmdscm_bad_completion_result (const char *msg
, SCM completion
)
338 SCM port
= scm_current_error_port ();
340 scm_puts (msg
, port
);
341 scm_display (completion
, port
);
345 /* Subroutine of cmdscm_completer to simplify it.
346 Validate COMPLETION and add to RESULT.
347 If an error occurs print an error message.
348 The result is a boolean indicating success. */
351 cmdscm_add_completion (SCM completion
, completion_tracker
&tracker
)
355 if (!scm_is_string (completion
))
357 /* Inform the user, but otherwise ignore the entire result. */
358 cmdscm_bad_completion_result (_("Bad text from completer: "),
363 gdb::unique_xmalloc_ptr
<char> item
364 = gdbscm_scm_to_string (completion
, NULL
, host_charset (), 1,
368 /* Inform the user, but otherwise ignore the entire result. */
369 gdbscm_print_gdb_exception (SCM_BOOL_F
, except_scm
);
373 tracker
.add_completion (std::move (item
));
378 /* Called by gdb for command completion. */
381 cmdscm_completer (struct cmd_list_element
*command
,
382 completion_tracker
&tracker
,
383 const char *text
, const char *word
)
385 command_smob
*c_smob
/*obj*/ = (command_smob
*) command
->context ();
386 SCM completer_result_scm
;
387 SCM text_scm
, word_scm
;
389 gdb_assert (c_smob
!= NULL
);
390 gdb_assert (gdbscm_is_procedure (c_smob
->complete
));
392 text_scm
= gdbscm_scm_from_string (text
, strlen (text
), host_charset (),
394 if (gdbscm_is_exception (text_scm
))
395 error (_("Could not convert \"text\" argument to Scheme string."));
396 word_scm
= gdbscm_scm_from_string (word
, strlen (word
), host_charset (),
398 if (gdbscm_is_exception (word_scm
))
399 error (_("Could not convert \"word\" argument to Scheme string."));
402 = gdbscm_safe_call_3 (c_smob
->complete
, c_smob
->containing_scm
,
403 text_scm
, word_scm
, NULL
);
405 if (gdbscm_is_exception (completer_result_scm
))
407 /* Inform the user, but otherwise ignore. */
408 gdbscm_print_gdb_exception (SCM_BOOL_F
, completer_result_scm
);
412 if (gdbscm_is_true (scm_list_p (completer_result_scm
)))
414 SCM list
= completer_result_scm
;
416 while (!scm_is_eq (list
, SCM_EOL
))
418 SCM next
= scm_car (list
);
420 if (!cmdscm_add_completion (next
, tracker
))
423 list
= scm_cdr (list
);
426 else if (itscm_is_iterator (completer_result_scm
))
428 SCM iter
= completer_result_scm
;
429 SCM next
= itscm_safe_call_next_x (iter
, NULL
);
431 while (gdbscm_is_true (next
))
433 if (gdbscm_is_exception (next
))
435 /* Inform the user. */
436 gdbscm_print_gdb_exception (SCM_BOOL_F
, completer_result_scm
);
440 if (cmdscm_add_completion (next
, tracker
))
443 next
= itscm_safe_call_next_x (iter
, NULL
);
448 /* Inform the user, but otherwise ignore. */
449 cmdscm_bad_completion_result (_("Bad completer result: "),
450 completer_result_scm
);
454 /* Helper for gdbscm_make_command which locates the command list to use and
455 pulls out the command name.
457 NAME is the command name list. The final word in the list is the
458 name of the new command. All earlier words must be existing prefix
461 *BASE_LIST is set to the final prefix command's list of
464 START_LIST is the list in which the search starts.
466 This function returns the xmalloc()d name of the new command.
467 On error a Scheme exception is thrown. */
470 gdbscm_parse_command_name (const char *name
,
471 const char *func_name
, int arg_pos
,
472 struct cmd_list_element
***base_list
,
473 struct cmd_list_element
**start_list
)
475 struct cmd_list_element
*elt
;
476 int len
= strlen (name
);
479 const char *prefix_text2
;
482 /* Skip trailing whitespace. */
483 for (i
= len
- 1; i
>= 0 && (name
[i
] == ' ' || name
[i
] == '\t'); --i
)
487 gdbscm_out_of_range_error (func_name
, arg_pos
,
488 gdbscm_scm_from_c_string (name
),
489 _("no command name found"));
493 /* Find first character of the final word. */
494 for (; i
> 0 && valid_cmd_char_p (name
[i
- 1]); --i
)
496 result
= (char *) xmalloc (lastchar
- i
+ 2);
497 memcpy (result
, &name
[i
], lastchar
- i
+ 1);
498 result
[lastchar
- i
+ 1] = '\0';
500 /* Skip whitespace again. */
501 for (--i
; i
>= 0 && (name
[i
] == ' ' || name
[i
] == '\t'); --i
)
505 *base_list
= start_list
;
509 prefix_text
= (char *) xmalloc (i
+ 2);
510 memcpy (prefix_text
, name
, i
+ 1);
511 prefix_text
[i
+ 1] = '\0';
513 prefix_text2
= prefix_text
;
514 elt
= lookup_cmd_1 (&prefix_text2
, *start_list
, NULL
, NULL
, 1);
515 if (elt
== NULL
|| elt
== CMD_LIST_AMBIGUOUS
)
517 msg
= xstrprintf (_("could not find command prefix '%s'"), prefix_text
);
520 scm_dynwind_begin ((scm_t_dynwind_flags
) 0);
521 gdbscm_dynwind_xfree (msg
);
522 gdbscm_out_of_range_error (func_name
, arg_pos
,
523 gdbscm_scm_from_c_string (name
), msg
);
526 if (elt
->is_prefix ())
529 *base_list
= elt
->subcommands
;
533 msg
= xstrprintf (_("'%s' is not a prefix command"), prefix_text
);
536 scm_dynwind_begin ((scm_t_dynwind_flags
) 0);
537 gdbscm_dynwind_xfree (msg
);
538 gdbscm_out_of_range_error (func_name
, arg_pos
,
539 gdbscm_scm_from_c_string (name
), msg
);
543 static const scheme_integer_constant command_classes
[] =
545 /* Note: alias and user are special; pseudo appears to be unused,
546 and there is no reason to expose tui, I think. */
547 { "COMMAND_NONE", no_class
},
548 { "COMMAND_RUNNING", class_run
},
549 { "COMMAND_DATA", class_vars
},
550 { "COMMAND_STACK", class_stack
},
551 { "COMMAND_FILES", class_files
},
552 { "COMMAND_SUPPORT", class_support
},
553 { "COMMAND_STATUS", class_info
},
554 { "COMMAND_BREAKPOINTS", class_breakpoint
},
555 { "COMMAND_TRACEPOINTS", class_trace
},
556 { "COMMAND_OBSCURE", class_obscure
},
557 { "COMMAND_MAINTENANCE", class_maintenance
},
558 { "COMMAND_USER", class_user
},
560 END_INTEGER_CONSTANTS
563 /* Return non-zero if command_class is a valid command class. */
566 gdbscm_valid_command_class_p (int command_class
)
570 for (i
= 0; command_classes
[i
].name
!= NULL
; ++i
)
572 if (command_classes
[i
].value
== command_class
)
579 /* Return a normalized form of command NAME.
580 That is tabs are replaced with spaces and multiple spaces are replaced
582 If WANT_TRAILING_SPACE is non-zero, add one space at the end. This is for
584 but that is the caller's responsibility.
585 Space for the result is allocated on the GC heap. */
588 gdbscm_canonicalize_command_name (const char *name
, int want_trailing_space
)
590 int i
, out
, seen_word
;
592 = (char *) scm_gc_malloc_pointerless (strlen (name
) + 2, FUNC_NAME
);
594 i
= out
= seen_word
= 0;
597 /* Skip whitespace. */
598 while (name
[i
] == ' ' || name
[i
] == '\t')
600 /* Copy non-whitespace characters. */
605 while (name
[i
] && name
[i
] != ' ' && name
[i
] != '\t')
606 result
[out
++] = name
[i
++];
610 if (want_trailing_space
)
617 /* (make-command name [#:invoke lambda]
618 [#:command-class class] [#:completer-class completer]
619 [#:prefix? <bool>] [#:doc <string>]) -> <gdb:command>
621 NAME is the name of the command. It may consist of multiple words,
622 in which case the final word is the name of the new command, and
623 earlier words must be prefix commands.
625 INVOKE is a procedure of three arguments that performs the command when
626 invoked: (lambda (self arg from-tty) ...).
627 Its result is unspecified.
629 CLASS is the kind of command. It must be one of the COMMAND_*
630 constants defined in the gdb module. If not specified, "no_class" is used.
632 COMPLETER is the kind of completer. It must be either:
633 #f - completion is not supported for this command.
634 One of the COMPLETE_* constants defined in the gdb module.
635 A procedure of three arguments: (lambda (self text word) ...).
636 Its result is one of:
638 A <gdb:iterator> object that returns the set of possible completions,
640 TODO(dje): Once PR 16699 is fixed, add support for returning
641 a COMPLETE_* constant.
642 If not specified, then completion is not supported for this command.
644 If PREFIX is #t, then this command is a prefix command.
646 DOC is the doc string for the command.
648 The result is the <gdb:command> Scheme object.
649 The command is not available to be used yet, however.
650 It must still be added to gdb with register-command!. */
653 gdbscm_make_command (SCM name_scm
, SCM rest
)
655 const SCM keywords
[] = {
656 invoke_keyword
, command_class_keyword
, completer_class_keyword
,
657 prefix_p_keyword
, doc_keyword
, SCM_BOOL_F
659 int invoke_arg_pos
= -1, command_class_arg_pos
= 1;
660 int completer_class_arg_pos
= -1, is_prefix_arg_pos
= -1;
661 int doc_arg_pos
= -1;
664 enum command_class command_class
= no_class
;
665 SCM completer_class
= SCM_BOOL_F
;
668 SCM invoke
= SCM_BOOL_F
;
670 command_smob
*c_smob
;
672 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG1
, keywords
, "s#OiOts",
673 name_scm
, &name
, rest
,
674 &invoke_arg_pos
, &invoke
,
675 &command_class_arg_pos
, &command_class
,
676 &completer_class_arg_pos
, &completer_class
,
677 &is_prefix_arg_pos
, &is_prefix
,
681 doc
= xstrdup (_("This command is not documented."));
684 name
= gdbscm_canonicalize_command_name (s
, is_prefix
);
687 doc
= gdbscm_gc_xstrdup (s
);
694 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG1
, name_scm
,
695 _("no command name found"));
698 if (gdbscm_is_true (invoke
))
700 SCM_ASSERT_TYPE (gdbscm_is_procedure (invoke
), invoke
,
701 invoke_arg_pos
, FUNC_NAME
, _("procedure"));
704 if (!gdbscm_valid_command_class_p (command_class
))
706 gdbscm_out_of_range_error (FUNC_NAME
, command_class_arg_pos
,
707 scm_from_int (command_class
),
708 _("invalid command class argument"));
711 SCM_ASSERT_TYPE (gdbscm_is_false (completer_class
)
712 || scm_is_integer (completer_class
)
713 || gdbscm_is_procedure (completer_class
),
714 completer_class
, completer_class_arg_pos
, FUNC_NAME
,
715 _("integer or procedure"));
716 if (scm_is_integer (completer_class
)
717 && !scm_is_signed_integer (completer_class
, 0, N_COMPLETERS
- 1))
719 gdbscm_out_of_range_error (FUNC_NAME
, completer_class_arg_pos
,
721 _("invalid completion type argument"));
724 c_scm
= cmdscm_make_command_smob ();
725 c_smob
= (command_smob
*) SCM_SMOB_DATA (c_scm
);
727 c_smob
->is_prefix
= is_prefix
;
728 c_smob
->cmd_class
= command_class
;
730 c_smob
->invoke
= invoke
;
731 c_smob
->complete
= completer_class
;
736 /* (register-command! <gdb:command>) -> unspecified
738 It is an error to register a command more than once. */
741 gdbscm_register_command_x (SCM self
)
744 = cmdscm_get_command_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
746 struct cmd_list_element
**cmd_list
;
747 struct cmd_list_element
*cmd
= NULL
;
749 if (cmdscm_is_valid (c_smob
))
750 scm_misc_error (FUNC_NAME
, _("command is already registered"), SCM_EOL
);
752 cmd_name
= gdbscm_parse_command_name (c_smob
->name
, FUNC_NAME
, SCM_ARG1
,
753 &cmd_list
, &cmdlist
);
754 c_smob
->cmd_name
= gdbscm_gc_xstrdup (cmd_name
);
757 gdbscm_gdb_exception exc
{};
760 if (c_smob
->is_prefix
)
762 /* If we have our own "invoke" method, then allow unknown
764 int allow_unknown
= gdbscm_is_true (c_smob
->invoke
);
766 cmd
= add_prefix_cmd (c_smob
->cmd_name
, c_smob
->cmd_class
,
767 NULL
, c_smob
->doc
, &c_smob
->sub_list
,
768 allow_unknown
, cmd_list
);
772 cmd
= add_cmd (c_smob
->cmd_name
, c_smob
->cmd_class
,
773 c_smob
->doc
, cmd_list
);
776 catch (const gdb_exception
&except
)
778 exc
= unpack (except
);
780 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
782 /* Note: At this point the command exists in gdb.
783 So no more errors after this point. */
785 /* There appears to be no API to set this. */
786 cmd
->func
= cmdscm_function
;
787 cmd
->destroyer
= cmdscm_destroyer
;
789 c_smob
->command
= cmd
;
790 cmd
->set_context (c_smob
);
792 if (gdbscm_is_true (c_smob
->complete
))
794 set_cmd_completer (cmd
,
795 scm_is_integer (c_smob
->complete
)
796 ? cmdscm_completers
[scm_to_int (c_smob
->complete
)].completer
800 /* The owner of this command is not in GC-controlled memory, so we need
801 to protect it from GC until the command is deleted. */
802 scm_gc_protect_object (c_smob
->containing_scm
);
804 return SCM_UNSPECIFIED
;
807 /* Initialize the Scheme command support. */
809 static const scheme_function command_functions
[] =
811 { "make-command", 1, 0, 1, as_a_scm_t_subr (gdbscm_make_command
),
813 Make a GDB command object.\n\
815 Arguments: name [#:invoke lambda]\n\
816 [#:command-class <class>] [#:completer-class <completer>]\n\
817 [#:prefix? <bool>] [#:doc string]\n\
818 name: The name of the command. It may consist of multiple words,\n\
819 in which case the final word is the name of the new command, and\n\
820 earlier words must be prefix commands.\n\
821 invoke: A procedure of three arguments to perform the command.\n\
822 (lambda (self arg from-tty) ...)\n\
823 Its result is unspecified.\n\
824 class: The class of the command, one of COMMAND_*.\n\
825 The default is COMMAND_NONE.\n\
826 completer: The kind of completer, #f, one of COMPLETE_*, or a procedure\n\
827 to perform the completion: (lambda (self text word) ...).\n\
828 prefix?: If true then the command is a prefix command.\n\
829 doc: The \"doc string\" of the command.\n\
830 Returns: <gdb:command> object" },
832 { "register-command!", 1, 0, 0, as_a_scm_t_subr (gdbscm_register_command_x
),
834 Register a <gdb:command> object with GDB." },
836 { "command?", 1, 0, 0, as_a_scm_t_subr (gdbscm_command_p
),
838 Return #t if the object is a <gdb:command> object." },
840 { "command-valid?", 1, 0, 0, as_a_scm_t_subr (gdbscm_command_valid_p
),
842 Return #t if the <gdb:command> object is valid." },
844 { "dont-repeat", 1, 0, 0, as_a_scm_t_subr (gdbscm_dont_repeat
),
846 Prevent command repetition when user enters an empty line.\n\
848 Arguments: <gdb:command>\n\
849 Returns: unspecified" },
854 /* Initialize the 'commands' code. */
857 gdbscm_initialize_commands (void)
862 = gdbscm_make_smob_type (command_smob_name
, sizeof (command_smob
));
863 scm_set_smob_print (command_smob_tag
, cmdscm_print_command_smob
);
865 gdbscm_define_integer_constants (command_classes
, 1);
866 gdbscm_define_functions (command_functions
, 1);
868 for (i
= 0; i
< N_COMPLETERS
; ++i
)
870 scm_c_define (cmdscm_completers
[i
].name
, scm_from_int (i
));
871 scm_c_export (cmdscm_completers
[i
].name
, NULL
);
874 invoke_keyword
= scm_from_latin1_keyword ("invoke");
875 command_class_keyword
= scm_from_latin1_keyword ("command-class");
876 completer_class_keyword
= scm_from_latin1_keyword ("completer-class");
877 prefix_p_keyword
= scm_from_latin1_keyword ("prefix?");
878 doc_keyword
= scm_from_latin1_keyword ("doc");