1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986-2000 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
23 #include "call-cmds.h"
28 #include "breakpoint.h"
30 #include "expression.h"
33 #include "terminal.h" /* For job_control. */
38 /* readline include files */
39 #include <readline/readline.h>
40 #include <readline/history.h>
42 /* readline defines this. */
45 #include <sys/types.h>
49 #include "event-top.h"
50 #include "gdb_string.h"
58 /* Prototypes for local functions */
60 static void dont_repeat_command (char *, int);
62 static void source_cleanup_lines (PTR
);
64 static void user_defined_command (char *, int);
66 static void init_signals (void);
69 static void stop_sig (int);
72 static char *line_completion_function (char *, int, char *, int);
74 static char *readline_line_completion_function (char *, int);
76 static void while_command (char *, int);
78 static void if_command (char *, int);
80 static struct command_line
*build_command_line (enum command_control_type
,
83 static struct command_line
*get_command_line (enum command_control_type
,
86 static void realloc_body_list (struct command_line
*, int);
88 static enum misc_command_type
read_next_line (struct command_line
**);
90 static enum command_control_type
91 recurse_read_control_structure (struct command_line
*);
93 static struct cleanup
*setup_user_args (char *);
95 static char *locate_arg (char *);
97 static char *insert_args (char *);
99 static void arg_cleanup (void *);
101 static void init_main (void);
103 static void init_cmd_lists (void);
105 static void float_handler (int);
107 static void init_signals (void);
109 static void set_verbose (char *, int, struct cmd_list_element
*);
111 static void show_history (char *, int);
113 static void set_history (char *, int);
115 static void set_history_size_command (char *, int, struct cmd_list_element
*);
117 static void show_commands (char *, int);
119 static void echo_command (char *, int);
121 static void pwd_command (char *, int);
123 static void show_version (char *, int);
125 static void document_command (char *, int);
127 static void define_command (char *, int);
129 static void validate_comname (char *);
131 static void help_command (char *, int);
133 static void show_command (char *, int);
135 static void info_command (char *, int);
137 static void complete_command (char *, int);
139 static void do_nothing (int);
141 static void show_debug (char *, int);
143 static void set_debug (char *, int);
146 /* NOTE 1999-04-29: This function will be static again, once we modify
147 gdb to use the event loop as the default command loop and we merge
148 event-top.c into this file, top.c */
149 /* static */ int quit_cover (PTR
);
151 static void disconnect (int);
154 static void do_restore_instream_cleanup (void *stream
);
156 static struct cleanup
*make_cleanup_free_command_lines (struct command_line
**);
158 /* Default command line prompt. This is overriden in some configs. */
160 #ifndef DEFAULT_PROMPT
161 #define DEFAULT_PROMPT "(gdb) "
164 /* Initialization file name for gdb. This is overridden in some configs. */
166 #ifndef GDBINIT_FILENAME
167 #define GDBINIT_FILENAME ".gdbinit"
169 char gdbinit
[] = GDBINIT_FILENAME
;
171 int inhibit_gdbinit
= 0;
173 /* If nonzero, and GDB has been configured to be able to use windows,
174 attempt to open them upon startup. */
178 extern char lang_frame_mismatch_warn
[]; /* language.c */
180 /* Flag for whether we want all the "from_tty" gubbish printed. */
182 int caution
= 1; /* Default is yes, sigh. */
184 /* Define all cmd_list_elements. */
186 /* Chain containing all defined commands. */
188 struct cmd_list_element
*cmdlist
;
190 /* Chain containing all defined info subcommands. */
192 struct cmd_list_element
*infolist
;
194 /* Chain containing all defined enable subcommands. */
196 struct cmd_list_element
*enablelist
;
198 /* Chain containing all defined disable subcommands. */
200 struct cmd_list_element
*disablelist
;
202 /* Chain containing all defined toggle subcommands. */
204 struct cmd_list_element
*togglelist
;
206 /* Chain containing all defined stop subcommands. */
208 struct cmd_list_element
*stoplist
;
210 /* Chain containing all defined delete subcommands. */
212 struct cmd_list_element
*deletelist
;
214 /* Chain containing all defined "enable breakpoint" subcommands. */
216 struct cmd_list_element
*enablebreaklist
;
218 /* Chain containing all defined set subcommands */
220 struct cmd_list_element
*setlist
;
222 /* Chain containing all defined unset subcommands */
224 struct cmd_list_element
*unsetlist
;
226 /* Chain containing all defined show subcommands. */
228 struct cmd_list_element
*showlist
;
230 /* Chain containing all defined \"set history\". */
232 struct cmd_list_element
*sethistlist
;
234 /* Chain containing all defined \"show history\". */
236 struct cmd_list_element
*showhistlist
;
238 /* Chain containing all defined \"unset history\". */
240 struct cmd_list_element
*unsethistlist
;
242 /* Chain containing all defined maintenance subcommands. */
244 struct cmd_list_element
*maintenancelist
;
246 /* Chain containing all defined "maintenance info" subcommands. */
248 struct cmd_list_element
*maintenanceinfolist
;
250 /* Chain containing all defined "maintenance print" subcommands. */
252 struct cmd_list_element
*maintenanceprintlist
;
254 struct cmd_list_element
*setprintlist
;
256 struct cmd_list_element
*showprintlist
;
258 struct cmd_list_element
*setdebuglist
;
260 struct cmd_list_element
*showdebuglist
;
262 struct cmd_list_element
*setchecklist
;
264 struct cmd_list_element
*showchecklist
;
266 /* stdio stream that command input is being read from. Set to stdin normally.
267 Set by source_command to the file we are sourcing. Set to NULL if we are
268 executing a user-defined command or interacting via a GUI. */
272 /* Current working directory. */
274 char *current_directory
;
276 /* The directory name is actually stored here (usually). */
277 char gdb_dirbuf
[1024];
279 /* Function to call before reading a command, if nonzero.
280 The function receives two args: an input stream,
281 and a prompt string. */
283 void (*window_hook
) (FILE *, char *);
288 /* gdb prints this when reading a command interactively */
289 static char *gdb_prompt_string
; /* the global prompt string */
290 extern char *get_prompt (void); /* access function for prompt string */
292 /* Buffer used for reading command lines, and the size
293 allocated for it so far. */
298 /* Nonzero if the current command is modified by "server ". This
299 affects things like recording into the command history, commands
300 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
301 whatever) can issue its own commands and also send along commands
302 from the user, and have the user not notice that the user interface
303 is issuing commands too. */
306 /* Baud rate specified for talking to serial target systems. Default
307 is left as -1, so targets can choose their own defaults. */
308 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
309 or (unsigned int)-1. This is a Bad User Interface. */
313 /* Timeout limit for response from target. */
315 /* The default value has been changed many times over the years. It
316 was originally 5 seconds. But that was thought to be a long time
317 to sit and wait, so it was changed to 2 seconds. That was thought
318 to be plenty unless the connection was going through some terminal
319 server or multiplexer or other form of hairy serial connection.
321 In mid-1996, remote_timeout was moved from remote.c to top.c and
322 it began being used in other remote-* targets. It appears that the
323 default was changed to 20 seconds at that time, perhaps because the
324 Hitachi E7000 ICE didn't always respond in a timely manner.
326 But if 5 seconds is a long time to sit and wait for retransmissions,
327 20 seconds is far worse. This demonstrates the difficulty of using
328 a single variable for all protocol timeouts.
330 As remote.c is used much more than remote-e7000.c, it was changed
331 back to 2 seconds in 1999. */
333 int remote_timeout
= 2;
335 /* Non-zero tells remote* modules to output debugging info. */
337 int remote_debug
= 0;
339 /* Non-zero means the target is running. Note: this is different from
340 saying that there is an active target and we are stopped at a
341 breakpoint, for instance. This is a real indicator whether the
342 target is off and running, which gdb is doing something else. */
343 int target_executing
= 0;
345 /* Level of control structure. */
346 static int control_level
;
348 /* Structure for arguments to user defined functions. */
349 #define MAXUSERARGS 10
352 struct user_args
*next
;
363 /* Signal to catch ^Z typed while reading a command: SIGTSTP or SIGCONT. */
367 #define STOP_SIGNAL SIGTSTP
368 static void stop_sig (int);
372 /* Some System V have job control but not sigsetmask(). */
373 #if !defined (HAVE_SIGSETMASK)
375 #define HAVE_SIGSETMASK 1
377 #define HAVE_SIGSETMASK 0
381 #if 0 == (HAVE_SIGSETMASK)
382 #define sigsetmask(n)
385 /* Hooks for alternate command interfaces. */
387 /* Called after most modules have been initialized, but before taking users
390 void (*init_ui_hook
) (char *argv0
);
392 /* This hook is called from within gdb's many mini-event loops which could
393 steal control from a real user interface's event loop. It returns
394 non-zero if the user is requesting a detach, zero otherwise. */
396 int (*ui_loop_hook
) (int);
398 /* Called instead of command_loop at top level. Can be invoked via
399 return_to_top_level. */
401 void (*command_loop_hook
) (void);
404 /* Called from print_frame_info to list the line we stopped in. */
406 void (*print_frame_info_listing_hook
) (struct symtab
* s
, int line
,
407 int stopline
, int noerror
);
408 /* Replaces most of query. */
410 int (*query_hook
) (const char *, va_list);
412 /* Replaces most of warning. */
414 void (*warning_hook
) (const char *, va_list);
416 /* These three functions support getting lines of text from the user. They
417 are used in sequence. First readline_begin_hook is called with a text
418 string that might be (for example) a message for the user to type in a
419 sequence of commands to be executed at a breakpoint. If this function
420 calls back to a GUI, it might take this opportunity to pop up a text
421 interaction window with this message. Next, readline_hook is called
422 with a prompt that is emitted prior to collecting the user input.
423 It can be called multiple times. Finally, readline_end_hook is called
424 to notify the GUI that we are done with the interaction window and it
427 void (*readline_begin_hook
) (char *, ...);
428 char *(*readline_hook
) (char *);
429 void (*readline_end_hook
) (void);
431 /* Called as appropriate to notify the interface of the specified breakpoint
434 void (*create_breakpoint_hook
) (struct breakpoint
* bpt
);
435 void (*delete_breakpoint_hook
) (struct breakpoint
* bpt
);
436 void (*modify_breakpoint_hook
) (struct breakpoint
* bpt
);
438 /* Called as appropriate to notify the interface that we have attached
439 to or detached from an already running process. */
441 void (*attach_hook
) (void);
442 void (*detach_hook
) (void);
444 /* Called during long calculations to allow GUI to repair window damage, and to
445 check for stop buttons, etc... */
447 void (*interactive_hook
) (void);
449 /* Called when the registers have changed, as a hint to a GUI
450 to minimize window update. */
452 void (*registers_changed_hook
) (void);
454 /* Tell the GUI someone changed the register REGNO. -1 means
455 that the caller does not know which register changed or
456 that several registers have changed (see value_assign). */
457 void (*register_changed_hook
) (int regno
);
459 /* Tell the GUI someone changed LEN bytes of memory at ADDR */
460 void (*memory_changed_hook
) (CORE_ADDR addr
, int len
);
462 /* Called when going to wait for the target. Usually allows the GUI to run
463 while waiting for target events. */
465 int (*target_wait_hook
) (int pid
, struct target_waitstatus
* status
);
467 /* Used by UI as a wrapper around command execution. May do various things
468 like enabling/disabling buttons, etc... */
470 void (*call_command_hook
) (struct cmd_list_element
* c
, char *cmd
,
473 /* Called after a `set' command has finished. Is only run if the
474 `set' command succeeded. */
476 void (*set_hook
) (struct cmd_list_element
* c
);
478 /* Called when the current thread changes. Argument is thread id. */
480 void (*context_hook
) (int id
);
482 /* Takes control from error (). Typically used to prevent longjmps out of the
483 middle of the GUI. Usually used in conjunction with a catch routine. */
485 NORETURN
void (*error_hook
) (void) ATTR_NORETURN
;
488 /* One should use catch_errors rather than manipulating these
490 #if defined(HAVE_SIGSETJMP)
491 #define SIGJMP_BUF sigjmp_buf
492 #define SIGSETJMP(buf) sigsetjmp(buf, 1)
493 #define SIGLONGJMP(buf,val) siglongjmp(buf,val)
495 #define SIGJMP_BUF jmp_buf
496 #define SIGSETJMP(buf) setjmp(buf)
497 #define SIGLONGJMP(buf,val) longjmp(buf,val)
500 /* Where to go for return_to_top_level. */
501 static SIGJMP_BUF
*catch_return
;
503 /* Return for reason REASON to the nearest containing catch_errors(). */
506 return_to_top_level (enum return_reason reason
)
511 /* Perhaps it would be cleaner to do this via the cleanup chain (not sure
512 I can think of a reason why that is vital, though). */
513 bpstat_clear_actions (stop_bpstat
); /* Clear queued breakpoint commands */
515 disable_current_display ();
516 do_cleanups (ALL_CLEANUPS
);
517 if (event_loop_p
&& target_can_async_p () && !target_executing
)
518 do_exec_cleanups (ALL_CLEANUPS
);
519 if (event_loop_p
&& sync_execution
)
520 do_exec_error_cleanups (ALL_CLEANUPS
);
522 if (annotation_level
> 1)
533 /* Jump to the containing catch_errors() call, communicating REASON
534 to that call via setjmp's return value. Note that REASON can't
535 be zero, by definition in defs.h. */
537 (NORETURN
void) SIGLONGJMP (*catch_return
, (int) reason
);
540 /* Call FUNC with arg ARGS, catching any errors. If there is no
541 error, return the value returned by FUNC. If there is an error,
542 print ERRSTRING, print the specific error message, then return
545 Must not be called with immediate_quit in effect (bad things might
546 happen, say we got a signal in the middle of a memcpy to quit_return).
547 This is an OK restriction; with very few exceptions immediate_quit can
548 be replaced by judicious use of QUIT.
550 MASK specifies what to catch; it is normally set to
551 RETURN_MASK_ALL, if for no other reason than that the code which
552 calls catch_errors might not be set up to deal with a quit which
553 isn't caught. But if the code can deal with it, it generally
554 should be RETURN_MASK_ERROR, unless for some reason it is more
555 useful to abort only the portion of the operation inside the
556 catch_errors. Note that quit should return to the command line
557 fairly quickly, even if some further processing is being done. */
559 /* MAYBE: cagney/1999-11-05: catch_errors() in conjunction with
560 error() et.al. could maintain a set of flags that indicate the the
561 current state of each of the longjmp buffers. This would give the
562 longjmp code the chance to detect a longjmp botch (before it gets
563 to longjmperror()). Prior to 1999-11-05 this wasn't possible as
564 code also randomly used a SET_TOP_LEVEL macro that directly
565 initialize the longjmp buffers. */
567 /* MAYBE: cagney/1999-11-05: Should the catch_errors and cleanups code
568 be consolidated into a single file instead of being distributed
569 between utils.c and top.c? */
572 catch_errors (catch_errors_ftype
*func
, PTR args
, char *errstring
,
575 SIGJMP_BUF
*saved_catch
;
578 struct cleanup
*saved_cleanup_chain
;
579 char *saved_error_pre_print
;
580 char *saved_quit_pre_print
;
582 /* Return value from SIGSETJMP(): enum return_reason if error or
583 quit caught, 0 otherwise. */
586 /* Override error/quit messages during FUNC. */
588 saved_error_pre_print
= error_pre_print
;
589 saved_quit_pre_print
= quit_pre_print
;
591 if (mask
& RETURN_MASK_ERROR
)
592 error_pre_print
= errstring
;
593 if (mask
& RETURN_MASK_QUIT
)
594 quit_pre_print
= errstring
;
596 /* Prevent error/quit during FUNC from calling cleanups established
599 saved_cleanup_chain
= save_cleanups ();
601 /* Call FUNC, catching error/quit events. */
603 saved_catch
= catch_return
;
604 catch_return
= &catch;
605 caught
= SIGSETJMP (catch);
607 val
= (*func
) (args
);
608 catch_return
= saved_catch
;
610 /* FIXME: cagney/1999-11-05: A correct FUNC implementation will
611 clean things up (restoring the cleanup chain) to the state they
612 were just prior to the call. Unfortunately, many FUNC's are not
613 that well behaved. This could be fixed by adding either a
614 do_cleanups call (to cover the problem) or an assertion check to
615 detect bad FUNCs code. */
617 /* Restore the cleanup chain and error/quit messages to their
620 restore_cleanups (saved_cleanup_chain
);
622 if (mask
& RETURN_MASK_QUIT
)
623 quit_pre_print
= saved_quit_pre_print
;
624 if (mask
& RETURN_MASK_ERROR
)
625 error_pre_print
= saved_error_pre_print
;
627 /* Return normally if no error/quit event occurred. */
632 /* If the caller didn't request that the event be caught, relay the
633 event to the next containing catch_errors(). */
635 if (!(mask
& RETURN_MASK (caught
)))
636 return_to_top_level (caught
);
638 /* Tell the caller that an event was caught.
640 FIXME: nsd/2000-02-22: When MASK is RETURN_MASK_ALL, the caller
641 can't tell what type of event occurred.
643 A possible fix is to add a new interface, catch_event(), that
644 returns enum return_reason after catching an error or a quit.
646 When returning normally, i.e. without catching an error or a
647 quit, catch_event() could return RETURN_NORMAL, which would be
648 added to enum return_reason. FUNC would return information
649 exclusively via ARGS.
651 Alternatively, normal catch_event() could return FUNC's return
652 value. The caller would need to be aware of potential overlap
653 with enum return_reason, which could be publicly restricted to
654 negative values to simplify return value processing in FUNC and
660 struct captured_command_args
662 catch_command_errors_ftype
*command
;
668 do_captured_command (void *data
)
670 struct captured_command_args
*context
= data
;
671 context
->command (context
->arg
, context
->from_tty
);
672 /* FIXME: cagney/1999-11-07: Technically this do_cleanups() call
673 isn't needed. Instead an assertion check could be made that
674 simply confirmed that the called function correctly cleaned up
675 after itself. Unfortunately, old code (prior to 1999-11-04) in
676 main.c was calling SET_TOP_LEVEL(), calling the command function,
677 and then *always* calling do_cleanups(). For the moment we
678 remain ``bug compatible'' with that old code.. */
679 do_cleanups (ALL_CLEANUPS
);
684 catch_command_errors (catch_command_errors_ftype
* command
,
685 char *arg
, int from_tty
, return_mask mask
)
687 struct captured_command_args args
;
688 args
.command
= command
;
690 args
.from_tty
= from_tty
;
691 return catch_errors (do_captured_command
, &args
, "", mask
);
695 /* Handler for SIGHUP. */
699 disconnect (int signo
)
701 catch_errors (quit_cover
, NULL
,
702 "Could not kill the program being debugged", RETURN_MASK_ALL
);
703 signal (SIGHUP
, SIG_DFL
);
704 kill (getpid (), SIGHUP
);
707 /* Just a little helper function for disconnect(). */
709 /* NOTE 1999-04-29: This function will be static again, once we modify
710 gdb to use the event loop as the default command loop and we merge
711 event-top.c into this file, top.c */
715 caution
= 0; /* Throw caution to the wind -- we're exiting.
716 This prevents asking the user dumb questions. */
717 quit_command ((char *) 0, 0);
720 #endif /* defined SIGHUP */
722 /* Line number we are currently in in a file which is being sourced. */
723 /* NOTE 1999-04-29: This variable will be static again, once we modify
724 gdb to use the event loop as the default command loop and we merge
725 event-top.c into this file, top.c */
726 /* static */ int source_line_number
;
728 /* Name of the file we are sourcing. */
729 /* NOTE 1999-04-29: This variable will be static again, once we modify
730 gdb to use the event loop as the default command loop and we merge
731 event-top.c into this file, top.c */
732 /* static */ char *source_file_name
;
734 /* Buffer containing the error_pre_print used by the source stuff.
736 /* NOTE 1999-04-29: This variable will be static again, once we modify
737 gdb to use the event loop as the default command loop and we merge
738 event-top.c into this file, top.c */
739 /* static */ char *source_error
;
740 static int source_error_allocated
;
742 /* Something to glom on to the start of error_pre_print if source_file_name
744 /* NOTE 1999-04-29: This variable will be static again, once we modify
745 gdb to use the event loop as the default command loop and we merge
746 event-top.c into this file, top.c */
747 /* static */ char *source_pre_error
;
749 /* Clean up on error during a "source" command (or execution of a
750 user-defined command). */
753 do_restore_instream_cleanup (void *stream
)
755 /* Restore the previous input stream. */
759 /* Read commands from STREAM. */
761 read_command_file (FILE *stream
)
763 struct cleanup
*cleanups
;
765 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
768 do_cleanups (cleanups
);
771 extern void init_proc (void);
773 void (*pre_init_ui_hook
) (void);
777 do_chdir_cleanup (void *old_dir
)
785 gdb_init (char *argv0
)
787 if (pre_init_ui_hook
)
790 /* Run the init function of each source file */
792 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
793 current_directory
= gdb_dirbuf
;
796 /* Make sure we return to the original directory upon exit, come
797 what may, since the OS doesn't do that for us. */
798 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
801 init_cmd_lists (); /* This needs to be done first */
802 initialize_targets (); /* Setup target_terminal macros for utils.c */
803 initialize_utils (); /* Make errors and warnings possible */
804 initialize_all_files ();
805 initialize_current_architecture ();
806 init_main (); /* But that omits this file! Do it now */
808 /* The signal handling mechanism is different depending whether or
809 not the async version is run. NOTE: in the future we plan to make
810 the event loop be the default engine of gdb, and this difference
813 async_init_signals ();
817 /* We need a default language for parsing expressions, so simple things like
818 "set width 0" won't fail if no language is explicitly set in a config file
819 or implicitly set by reading an executable during startup. */
820 set_language (language_c
);
821 expected_language
= current_language
; /* don't warn about the change. */
824 /* Install the default UI */
825 uiout
= cli_out_new (gdb_stdout
);
829 /* All the interpreters should have had a look at things by now.
830 Initialize the selected interpreter. */
831 if (interpreter_p
&& !init_ui_hook
)
833 fprintf_unfiltered (gdb_stderr
, "Interpreter `%s' unrecognized.\n",
840 init_ui_hook (argv0
);
843 /* Allocate, initialize a new command line structure for one of the
844 control commands (if/while). */
846 static struct command_line
*
847 build_command_line (enum command_control_type type
, char *args
)
849 struct command_line
*cmd
;
852 error ("if/while commands require arguments.\n");
854 cmd
= (struct command_line
*) xmalloc (sizeof (struct command_line
));
856 cmd
->control_type
= type
;
860 = (struct command_line
**) xmalloc (sizeof (struct command_line
*)
862 memset (cmd
->body_list
, 0, sizeof (struct command_line
*) * cmd
->body_count
);
863 cmd
->line
= savestring (args
, strlen (args
));
867 /* Build and return a new command structure for the control commands
868 such as "if" and "while". */
870 static struct command_line
*
871 get_command_line (enum command_control_type type
, char *arg
)
873 struct command_line
*cmd
;
874 struct cleanup
*old_chain
= NULL
;
876 /* Allocate and build a new command line structure. */
877 cmd
= build_command_line (type
, arg
);
879 old_chain
= make_cleanup_free_command_lines (&cmd
);
881 /* Read in the body of this command. */
882 if (recurse_read_control_structure (cmd
) == invalid_control
)
884 warning ("error reading in control structure\n");
885 do_cleanups (old_chain
);
889 discard_cleanups (old_chain
);
893 /* Recursively print a command (including full control structures). */
896 print_command_lines (struct ui_out
*uiout
, struct command_line
*cmd
,
899 struct command_line
*list
;
906 ui_out_spaces (uiout
, 2 * depth
);
908 /* A simple command, print it and continue. */
909 if (list
->control_type
== simple_control
)
911 ui_out_field_string (uiout
, NULL
, list
->line
);
912 ui_out_text (uiout
, "\n");
917 /* loop_continue to jump to the start of a while loop, print it
919 if (list
->control_type
== continue_control
)
921 ui_out_field_string (uiout
, NULL
, "loop_continue");
922 ui_out_text (uiout
, "\n");
927 /* loop_break to break out of a while loop, print it and continue. */
928 if (list
->control_type
== break_control
)
930 ui_out_field_string (uiout
, NULL
, "loop_break");
931 ui_out_text (uiout
, "\n");
936 /* A while command. Recursively print its subcommands and continue. */
937 if (list
->control_type
== while_control
)
939 ui_out_text (uiout
, "while ");
940 ui_out_field_fmt (uiout
, NULL
, "while %s", list
->line
);
941 ui_out_text (uiout
, "\n");
942 print_command_lines (uiout
, *list
->body_list
, depth
+ 1);
943 ui_out_field_string (uiout
, NULL
, "end");
945 ui_out_spaces (uiout
, 2 * depth
);
946 ui_out_text (uiout
, "end\n");
951 /* An if command. Recursively print both arms before continueing. */
952 if (list
->control_type
== if_control
)
954 ui_out_text (uiout
, "if ");
955 ui_out_field_fmt (uiout
, NULL
, "if %s", list
->line
);
956 ui_out_text (uiout
, "\n");
958 print_command_lines (uiout
, list
->body_list
[0], depth
+ 1);
960 /* Show the false arm if it exists. */
961 if (list
->body_count
== 2)
964 ui_out_spaces (uiout
, 2 * depth
);
965 ui_out_field_string (uiout
, NULL
, "else");
966 ui_out_text (uiout
, "else\n");
967 print_command_lines (uiout
, list
->body_list
[1], depth
+ 1);
970 ui_out_field_string (uiout
, NULL
, "end");
972 ui_out_spaces (uiout
, 2 * depth
);
973 ui_out_text (uiout
, "end\n");
978 /* ignore illegal command type and try next */
984 print_command_line (struct command_line
*cmd
, unsigned int depth
,
985 struct ui_file
*stream
)
991 for (i
= 0; i
< depth
; i
++)
992 fputs_filtered (" ", stream
);
995 /* A simple command, print it and return. */
996 if (cmd
->control_type
== simple_control
)
998 fputs_filtered (cmd
->line
, stream
);
999 fputs_filtered ("\n", stream
);
1003 /* loop_continue to jump to the start of a while loop, print it
1005 if (cmd
->control_type
== continue_control
)
1007 fputs_filtered ("loop_continue\n", stream
);
1011 /* loop_break to break out of a while loop, print it and return. */
1012 if (cmd
->control_type
== break_control
)
1014 fputs_filtered ("loop_break\n", stream
);
1018 /* A while command. Recursively print its subcommands before returning. */
1019 if (cmd
->control_type
== while_control
)
1021 struct command_line
*list
;
1022 fputs_filtered ("while ", stream
);
1023 fputs_filtered (cmd
->line
, stream
);
1024 fputs_filtered ("\n", stream
);
1025 list
= *cmd
->body_list
;
1028 print_command_line (list
, depth
+ 1, stream
);
1033 /* An if command. Recursively print both arms before returning. */
1034 if (cmd
->control_type
== if_control
)
1036 fputs_filtered ("if ", stream
);
1037 fputs_filtered (cmd
->line
, stream
);
1038 fputs_filtered ("\n", stream
);
1040 print_command_line (cmd
->body_list
[0], depth
+ 1, stream
);
1042 /* Show the false arm if it exists. */
1043 if (cmd
->body_count
== 2)
1047 for (i
= 0; i
< depth
; i
++)
1048 fputs_filtered (" ", stream
);
1050 fputs_filtered ("else\n", stream
);
1051 print_command_line (cmd
->body_list
[1], depth
+ 1, stream
);
1055 for (i
= 0; i
< depth
; i
++)
1056 fputs_filtered (" ", stream
);
1058 fputs_filtered ("end\n", stream
);
1063 /* Execute the command in CMD. */
1065 enum command_control_type
1066 execute_control_command (struct command_line
*cmd
)
1068 struct expression
*expr
;
1069 struct command_line
*current
;
1070 struct cleanup
*old_chain
= 0;
1074 enum command_control_type ret
;
1077 switch (cmd
->control_type
)
1079 case simple_control
:
1080 /* A simple command, execute it and return. */
1081 new_line
= insert_args (cmd
->line
);
1083 return invalid_control
;
1084 old_chain
= make_cleanup (free_current_contents
, &new_line
);
1085 execute_command (new_line
, 0);
1086 ret
= cmd
->control_type
;
1089 case continue_control
:
1091 /* Return for "continue", and "break" so we can either
1092 continue the loop at the top, or break out. */
1093 ret
= cmd
->control_type
;
1098 /* Parse the loop control expression for the while statement. */
1099 new_line
= insert_args (cmd
->line
);
1101 return invalid_control
;
1102 old_chain
= make_cleanup (free_current_contents
, &new_line
);
1103 expr
= parse_expression (new_line
);
1104 make_cleanup (free_current_contents
, &expr
);
1106 ret
= simple_control
;
1109 /* Keep iterating so long as the expression is true. */
1116 /* Evaluate the expression. */
1117 val_mark
= value_mark ();
1118 val
= evaluate_expression (expr
);
1119 cond_result
= value_true (val
);
1120 value_free_to_mark (val_mark
);
1122 /* If the value is false, then break out of the loop. */
1126 /* Execute the body of the while statement. */
1127 current
= *cmd
->body_list
;
1130 ret
= execute_control_command (current
);
1132 /* If we got an error, or a "break" command, then stop
1134 if (ret
== invalid_control
|| ret
== break_control
)
1140 /* If we got a "continue" command, then restart the loop
1142 if (ret
== continue_control
)
1145 /* Get the next statement. */
1146 current
= current
->next
;
1150 /* Reset RET so that we don't recurse the break all the way down. */
1151 if (ret
== break_control
)
1152 ret
= simple_control
;
1159 new_line
= insert_args (cmd
->line
);
1161 return invalid_control
;
1162 old_chain
= make_cleanup (free_current_contents
, &new_line
);
1163 /* Parse the conditional for the if statement. */
1164 expr
= parse_expression (new_line
);
1165 make_cleanup (free_current_contents
, &expr
);
1168 ret
= simple_control
;
1170 /* Evaluate the conditional. */
1171 val_mark
= value_mark ();
1172 val
= evaluate_expression (expr
);
1174 /* Choose which arm to take commands from based on the value of the
1175 conditional expression. */
1176 if (value_true (val
))
1177 current
= *cmd
->body_list
;
1178 else if (cmd
->body_count
== 2)
1179 current
= *(cmd
->body_list
+ 1);
1180 value_free_to_mark (val_mark
);
1182 /* Execute commands in the given arm. */
1185 ret
= execute_control_command (current
);
1187 /* If we got an error, get out. */
1188 if (ret
!= simple_control
)
1191 /* Get the next statement in the body. */
1192 current
= current
->next
;
1199 warning ("Invalid control type in command structure.");
1200 return invalid_control
;
1204 do_cleanups (old_chain
);
1209 /* "while" command support. Executes a body of statements while the
1210 loop condition is nonzero. */
1213 while_command (char *arg
, int from_tty
)
1215 struct command_line
*command
= NULL
;
1218 command
= get_command_line (while_control
, arg
);
1220 if (command
== NULL
)
1223 execute_control_command (command
);
1224 free_command_lines (&command
);
1227 /* "if" command support. Execute either the true or false arm depending
1228 on the value of the if conditional. */
1231 if_command (char *arg
, int from_tty
)
1233 struct command_line
*command
= NULL
;
1236 command
= get_command_line (if_control
, arg
);
1238 if (command
== NULL
)
1241 execute_control_command (command
);
1242 free_command_lines (&command
);
1247 arg_cleanup (void *ignore
)
1249 struct user_args
*oargs
= user_args
;
1251 internal_error ("Internal error, arg_cleanup called with no user args.\n");
1253 user_args
= user_args
->next
;
1257 /* Bind the incomming arguments for a user defined command to
1258 $arg0, $arg1 ... $argMAXUSERARGS. */
1260 static struct cleanup
*
1261 setup_user_args (char *p
)
1263 struct user_args
*args
;
1264 struct cleanup
*old_chain
;
1265 unsigned int arg_count
= 0;
1267 args
= (struct user_args
*) xmalloc (sizeof (struct user_args
));
1268 memset (args
, 0, sizeof (struct user_args
));
1270 args
->next
= user_args
;
1273 old_chain
= make_cleanup (arg_cleanup
, 0/*ignored*/);
1285 if (arg_count
>= MAXUSERARGS
)
1287 error ("user defined function may only have %d arguments.\n",
1292 /* Strip whitespace. */
1293 while (*p
== ' ' || *p
== '\t')
1296 /* P now points to an argument. */
1298 user_args
->a
[arg_count
].arg
= p
;
1300 /* Get to the end of this argument. */
1303 if (((*p
== ' ' || *p
== '\t')) && !squote
&& !dquote
&& !bsquote
)
1309 else if (*p
== '\\')
1332 user_args
->a
[arg_count
].len
= p
- start_arg
;
1339 /* Given character string P, return a point to the first argument ($arg),
1340 or NULL if P contains no arguments. */
1343 locate_arg (char *p
)
1345 while ((p
= strchr (p
, '$')))
1347 if (strncmp (p
, "$arg", 4) == 0 && isdigit (p
[4]))
1354 /* Insert the user defined arguments stored in user_arg into the $arg
1355 arguments found in line, with the updated copy being placed into nline. */
1358 insert_args (char *line
)
1360 char *p
, *save_line
, *new_line
;
1363 /* First we need to know how much memory to allocate for the new line. */
1366 while ((p
= locate_arg (line
)))
1371 if (i
>= user_args
->count
)
1373 error ("Missing argument %d in user function.\n", i
);
1376 len
+= user_args
->a
[i
].len
;
1380 /* Don't forget the tail. */
1381 len
+= strlen (line
);
1383 /* Allocate space for the new line and fill it in. */
1384 new_line
= (char *) xmalloc (len
+ 1);
1385 if (new_line
== NULL
)
1388 /* Restore pointer to beginning of old line. */
1391 /* Save pointer to beginning of new line. */
1392 save_line
= new_line
;
1394 while ((p
= locate_arg (line
)))
1398 memcpy (new_line
, line
, p
- line
);
1399 new_line
+= p
- line
;
1402 len
= user_args
->a
[i
].len
;
1405 memcpy (new_line
, user_args
->a
[i
].arg
, len
);
1410 /* Don't forget the tail. */
1411 strcpy (new_line
, line
);
1413 /* Return a pointer to the beginning of the new line. */
1418 execute_user_command (struct cmd_list_element
*c
, char *args
)
1420 register struct command_line
*cmdlines
;
1421 struct cleanup
*old_chain
;
1422 enum command_control_type ret
;
1424 old_chain
= setup_user_args (args
);
1426 cmdlines
= c
->user_commands
;
1431 /* Set the instream to 0, indicating execution of a
1432 user-defined function. */
1433 old_chain
= make_cleanup (do_restore_instream_cleanup
, instream
);
1434 instream
= (FILE *) 0;
1437 ret
= execute_control_command (cmdlines
);
1438 if (ret
!= simple_control
&& ret
!= break_control
)
1440 warning ("Error in control structure.\n");
1443 cmdlines
= cmdlines
->next
;
1445 do_cleanups (old_chain
);
1448 /* Execute the line P as a command.
1449 Pass FROM_TTY as second argument to the defining function. */
1452 execute_command (char *p
, int from_tty
)
1454 register struct cmd_list_element
*c
;
1455 register enum language flang
;
1456 static int warned
= 0;
1458 /* FIXME: These should really be in an appropriate header file */
1459 extern void serial_log_command (const char *);
1463 /* Force cleanup of any alloca areas if using C alloca instead of
1464 a builtin alloca. */
1467 /* This can happen when command_line_input hits end of file. */
1471 serial_log_command (p
);
1473 while (*p
== ' ' || *p
== '\t')
1480 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
1482 /* If the target is running, we allow only a limited set of
1484 if (event_loop_p
&& target_can_async_p () && target_executing
)
1485 if (!strcmp (c
->name
, "help")
1486 && !strcmp (c
->name
, "pwd")
1487 && !strcmp (c
->name
, "show")
1488 && !strcmp (c
->name
, "stop"))
1489 error ("Cannot execute this command while the target is running.");
1491 /* Pass null arg rather than an empty one. */
1494 /* Clear off trailing whitespace, except for set and complete command. */
1495 if (arg
&& c
->type
!= set_cmd
&& c
->function
.cfunc
!= complete_command
)
1497 p
= arg
+ strlen (arg
) - 1;
1498 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
1503 /* If this command has been pre-hooked, run the hook first. */
1504 if ((c
->hook_pre
) && (!c
->hook_in
))
1506 c
->hook_in
= 1; /* Prevent recursive hooking */
1507 execute_user_command (c
->hook_pre
, (char *) 0);
1508 c
->hook_in
= 0; /* Allow hook to work again once it is complete */
1511 if (c
->flags
& DEPRECATED_WARN_USER
)
1512 deprecated_cmd_warning (&line
);
1514 if (c
->class == class_user
)
1515 execute_user_command (c
, arg
);
1516 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
1517 do_setshow_command (arg
, from_tty
& caution
, c
);
1518 else if (c
->function
.cfunc
== NO_FUNCTION
)
1519 error ("That is not a command, just a help topic.");
1520 else if (call_command_hook
)
1521 call_command_hook (c
, arg
, from_tty
& caution
);
1523 (*c
->function
.cfunc
) (arg
, from_tty
& caution
);
1525 /* If this command has been post-hooked, run the hook last. */
1526 if ((c
->hook_post
) && (!c
->hook_in
))
1528 c
->hook_in
= 1; /* Prevent recursive hooking */
1529 execute_user_command (c
->hook_post
, (char *) 0);
1530 c
->hook_in
= 0; /* allow hook to work again once it is complete */
1535 /* Tell the user if the language has changed (except first time). */
1536 if (current_language
!= expected_language
)
1538 if (language_mode
== language_mode_auto
)
1540 language_info (1); /* Print what changed. */
1545 /* Warn the user if the working language does not match the
1546 language of the current frame. Only warn the user if we are
1547 actually running the program, i.e. there is a stack. */
1548 /* FIXME: This should be cacheing the frame and only running when
1549 the frame changes. */
1551 if (target_has_stack
)
1553 flang
= get_frame_language ();
1555 && flang
!= language_unknown
1556 && flang
!= current_language
->la_language
)
1558 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
1564 /* Read commands from `instream' and execute them
1565 until end of file or error reading instream. */
1570 struct cleanup
*old_chain
;
1572 int stdin_is_tty
= ISATTY (stdin
);
1573 long time_at_cmd_start
;
1575 long space_at_cmd_start
= 0;
1577 extern int display_time
;
1578 extern int display_space
;
1580 while (instream
&& !feof (instream
))
1583 extern int insert_mode
;
1585 if (window_hook
&& instream
== stdin
)
1586 (*window_hook
) (instream
, get_prompt ());
1589 if (instream
== stdin
&& stdin_is_tty
)
1590 reinitialize_more_filter ();
1591 old_chain
= make_cleanup (null_cleanup
, 0);
1594 /* A bit of paranoia: I want to make sure the "insert_mode" global
1595 * is clear except when it is being used for command-line editing
1596 * (see tuiIO.c, utils.c); otherwise normal output will
1597 * get messed up in the TUI. So clear it before/after
1598 * the command-line-input call. - RT
1602 /* Get a command-line. This calls the readline package. */
1603 command
= command_line_input (instream
== stdin
?
1604 get_prompt () : (char *) NULL
,
1605 instream
== stdin
, "prompt");
1612 time_at_cmd_start
= get_run_time ();
1617 extern char **environ
;
1618 char *lim
= (char *) sbrk (0);
1620 space_at_cmd_start
= (long) (lim
- (char *) &environ
);
1624 execute_command (command
, instream
== stdin
);
1625 /* Do any commands attached to breakpoint we stopped at. */
1626 bpstat_do_actions (&stop_bpstat
);
1627 do_cleanups (old_chain
);
1631 long cmd_time
= get_run_time () - time_at_cmd_start
;
1633 printf_unfiltered ("Command execution time: %ld.%06ld\n",
1634 cmd_time
/ 1000000, cmd_time
% 1000000);
1640 extern char **environ
;
1641 char *lim
= (char *) sbrk (0);
1642 long space_now
= lim
- (char *) &environ
;
1643 long space_diff
= space_now
- space_at_cmd_start
;
1645 printf_unfiltered ("Space used: %ld (%c%ld for this command)\n",
1647 (space_diff
>= 0 ? '+' : '-'),
1654 /* Read commands from `instream' and execute them until end of file or
1655 error reading instream. This command loop doesnt care about any
1656 such things as displaying time and space usage. If the user asks
1657 for those, they won't work. */
1659 simplified_command_loop (char *(*read_input_func
) (char *),
1660 void (*execute_command_func
) (char *, int))
1662 struct cleanup
*old_chain
;
1664 int stdin_is_tty
= ISATTY (stdin
);
1666 while (instream
&& !feof (instream
))
1669 if (instream
== stdin
&& stdin_is_tty
)
1670 reinitialize_more_filter ();
1671 old_chain
= make_cleanup (null_cleanup
, 0);
1673 /* Get a command-line. */
1674 command
= (*read_input_func
) (instream
== stdin
?
1675 get_prompt () : (char *) NULL
);
1680 (*execute_command_func
) (command
, instream
== stdin
);
1682 /* Do any commands attached to breakpoint we stopped at. */
1683 bpstat_do_actions (&stop_bpstat
);
1685 do_cleanups (old_chain
);
1689 /* Commands call this if they do not want to be repeated by null lines. */
1697 /* If we aren't reading from standard input, we are saving the last
1698 thing read from stdin in line and don't want to delete it. Null lines
1699 won't repeat here in any case. */
1700 if (instream
== stdin
)
1704 /* Read a line from the stream "instream" without command line editing.
1706 It prints PROMPT_ARG once at the start.
1707 Action is compatible with "readline", e.g. space for the result is
1708 malloc'd and should be freed by the caller.
1710 A NULL return means end of file. */
1712 gdb_readline (char *prompt_arg
)
1716 int input_index
= 0;
1717 int result_size
= 80;
1721 /* Don't use a _filtered function here. It causes the assumed
1722 character position to be off, since the newline we read from
1723 the user is not accounted for. */
1724 fputs_unfiltered (prompt_arg
, gdb_stdout
);
1726 /* Move to a new line so the entered line doesn't have a prompt
1727 on the front of it. */
1728 fputs_unfiltered ("\n", gdb_stdout
);
1730 gdb_flush (gdb_stdout
);
1733 result
= (char *) xmalloc (result_size
);
1737 /* Read from stdin if we are executing a user defined command.
1738 This is the right thing for prompt_for_continue, at least. */
1739 c
= fgetc (instream
? instream
: stdin
);
1743 if (input_index
> 0)
1744 /* The last line does not end with a newline. Return it, and
1745 if we are called again fgetc will still return EOF and
1746 we'll return NULL then. */
1753 #ifndef CRLF_SOURCE_FILES
1757 if (input_index
> 0 && result
[input_index
- 1] == '\r')
1763 result
[input_index
++] = c
;
1764 while (input_index
>= result_size
)
1767 result
= (char *) xrealloc (result
, result_size
);
1771 result
[input_index
++] = '\0';
1775 /* Variables which control command line editing and history
1776 substitution. These variables are given default values at the end
1778 static int command_editing_p
;
1779 /* NOTE 1999-04-29: This variable will be static again, once we modify
1780 gdb to use the event loop as the default command loop and we merge
1781 event-top.c into this file, top.c */
1782 /* static */ int history_expansion_p
;
1783 static int write_history_p
;
1784 static int history_size
;
1785 static char *history_filename
;
1787 /* readline uses the word breaks for two things:
1788 (1) In figuring out where to point the TEXT parameter to the
1789 rl_completion_entry_function. Since we don't use TEXT for much,
1790 it doesn't matter a lot what the word breaks are for this purpose, but
1791 it does affect how much stuff M-? lists.
1792 (2) If one of the matches contains a word break character, readline
1793 will quote it. That's why we switch between
1794 gdb_completer_word_break_characters and
1795 gdb_completer_command_word_break_characters. I'm not sure when
1796 we need this behavior (perhaps for funky characters in C++ symbols?). */
1798 /* Variables which are necessary for fancy command line editing. */
1799 char *gdb_completer_word_break_characters
=
1800 " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,-";
1802 /* When completing on command names, we remove '-' from the list of
1803 word break characters, since we use it in command names. If the
1804 readline library sees one in any of the current completion strings,
1805 it thinks that the string needs to be quoted and automatically supplies
1807 char *gdb_completer_command_word_break_characters
=
1808 " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,";
1810 /* When completing on file names, we remove from the list of word
1811 break characters any characters that are commonly used in file
1812 names, such as '-', '+', '~', etc. Otherwise, readline displays
1813 incorrect completion candidates. */
1814 char *gdb_completer_file_name_break_characters
= " \t\n*|\"';:?/><";
1816 /* Characters that can be used to quote completion strings. Note that we
1817 can't include '"' because the gdb C parser treats such quoted sequences
1819 char *gdb_completer_quote_characters
=
1822 /* Functions that are used as part of the fancy command line editing. */
1824 /* This can be used for functions which don't want to complete on symbols
1825 but don't want to complete on anything else either. */
1828 noop_completer (char *text
, char *prefix
)
1833 /* Complete on filenames. */
1835 filename_completer (char *text
, char *word
)
1837 /* From readline. */
1838 extern char *filename_completion_function (char *, int);
1839 int subsequent_name
;
1841 int return_val_used
;
1842 int return_val_alloced
;
1844 return_val_used
= 0;
1845 /* Small for testing. */
1846 return_val_alloced
= 1;
1847 return_val
= (char **) xmalloc (return_val_alloced
* sizeof (char *));
1849 subsequent_name
= 0;
1853 p
= filename_completion_function (text
, subsequent_name
);
1854 if (return_val_used
>= return_val_alloced
)
1856 return_val_alloced
*= 2;
1858 (char **) xrealloc (return_val
,
1859 return_val_alloced
* sizeof (char *));
1863 return_val
[return_val_used
++] = p
;
1866 /* We need to set subsequent_name to a non-zero value before the
1867 continue line below, because otherwise, if the first file seen
1868 by GDB is a backup file whose name ends in a `~', we will loop
1870 subsequent_name
= 1;
1871 /* Like emacs, don't complete on old versions. Especially useful
1872 in the "source" command. */
1873 if (p
[strlen (p
) - 1] == '~')
1879 /* Return exactly p. */
1880 return_val
[return_val_used
++] = p
;
1881 else if (word
> text
)
1883 /* Return some portion of p. */
1884 q
= xmalloc (strlen (p
) + 5);
1885 strcpy (q
, p
+ (word
- text
));
1886 return_val
[return_val_used
++] = q
;
1891 /* Return some of TEXT plus p. */
1892 q
= xmalloc (strlen (p
) + (text
- word
) + 5);
1893 strncpy (q
, word
, text
- word
);
1894 q
[text
- word
] = '\0';
1896 return_val
[return_val_used
++] = q
;
1902 /* There is no way to do this just long enough to affect quote inserting
1903 without also affecting the next completion. This should be fixed in
1905 /* Insure that readline does the right thing
1906 with respect to inserting quotes. */
1907 rl_completer_word_break_characters
= "";
1912 /* Here are some useful test cases for completion. FIXME: These should
1913 be put in the test suite. They should be tested with both M-? and TAB.
1915 "show output-" "radix"
1916 "show output" "-radix"
1917 "p" ambiguous (commands starting with p--path, print, printf, etc.)
1918 "p " ambiguous (all symbols)
1919 "info t foo" no completions
1920 "info t " no completions
1921 "info t" ambiguous ("info target", "info terminal", etc.)
1922 "info ajksdlfk" no completions
1923 "info ajksdlfk " no completions
1925 "info " ambiguous (all info commands)
1926 "p \"a" no completions (string constant)
1927 "p 'a" ambiguous (all symbols starting with a)
1928 "p b-a" ambiguous (all symbols starting with a)
1929 "p b-" ambiguous (all symbols)
1930 "file Make" "file" (word break hard to screw up here)
1931 "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
1934 /* Generate completions one by one for the completer. Each time we are
1935 called return another potential completion to the caller.
1936 line_completion just completes on commands or passes the buck to the
1937 command's completer function, the stuff specific to symbol completion
1938 is in make_symbol_completion_list.
1940 TEXT is the caller's idea of the "word" we are looking at.
1942 MATCHES is the number of matches that have currently been collected from
1943 calling this completion function. When zero, then we need to initialize,
1944 otherwise the initialization has already taken place and we can just
1945 return the next potential completion string.
1947 LINE_BUFFER is available to be looked at; it contains the entire text
1948 of the line. POINT is the offset in that line of the cursor. You
1949 should pretend that the line ends at POINT.
1951 Returns NULL if there are no more completions, else a pointer to a string
1952 which is a possible completion, it is the caller's responsibility to
1956 line_completion_function (char *text
, int matches
, char *line_buffer
, int point
)
1958 static char **list
= (char **) NULL
; /* Cache of completions */
1959 static int index
; /* Next cached completion */
1960 char *output
= NULL
;
1961 char *tmp_command
, *p
;
1962 /* Pointer within tmp_command which corresponds to text. */
1964 struct cmd_list_element
*c
, *result_list
;
1968 /* The caller is beginning to accumulate a new set of completions, so
1969 we need to find all of them now, and cache them for returning one at
1970 a time on future calls. */
1974 /* Free the storage used by LIST, but not by the strings inside.
1975 This is because rl_complete_internal () frees the strings. */
1981 /* Choose the default set of word break characters to break completions.
1982 If we later find out that we are doing completions on command strings
1983 (as opposed to strings supplied by the individual command completer
1984 functions, which can be any string) then we will switch to the
1985 special word break set for command strings, which leaves out the
1986 '-' character used in some commands. */
1988 rl_completer_word_break_characters
=
1989 gdb_completer_word_break_characters
;
1991 /* Decide whether to complete on a list of gdb commands or on symbols. */
1992 tmp_command
= (char *) alloca (point
+ 1);
1995 strncpy (tmp_command
, line_buffer
, point
);
1996 tmp_command
[point
] = '\0';
1997 /* Since text always contains some number of characters leading up
1998 to point, we can find the equivalent position in tmp_command
1999 by subtracting that many characters from the end of tmp_command. */
2000 word
= tmp_command
+ point
- strlen (text
);
2004 /* An empty line we want to consider ambiguous; that is, it
2005 could be any command. */
2006 c
= (struct cmd_list_element
*) -1;
2011 c
= lookup_cmd_1 (&p
, cmdlist
, &result_list
, 1);
2014 /* Move p up to the next interesting thing. */
2015 while (*p
== ' ' || *p
== '\t')
2022 /* It is an unrecognized command. So there are no
2023 possible completions. */
2026 else if (c
== (struct cmd_list_element
*) -1)
2030 /* lookup_cmd_1 advances p up to the first ambiguous thing, but
2031 doesn't advance over that thing itself. Do so now. */
2033 while (*q
&& (isalnum (*q
) || *q
== '-' || *q
== '_'))
2035 if (q
!= tmp_command
+ point
)
2037 /* There is something beyond the ambiguous
2038 command, so there are no possible completions. For
2039 example, "info t " or "info t foo" does not complete
2040 to anything, because "info t" can be "info target" or
2046 /* We're trying to complete on the command which was ambiguous.
2047 This we can deal with. */
2050 list
= complete_on_cmdlist (*result_list
->prefixlist
, p
,
2055 list
= complete_on_cmdlist (cmdlist
, p
, word
);
2057 /* Insure that readline does the right thing with respect to
2058 inserting quotes. */
2059 rl_completer_word_break_characters
=
2060 gdb_completer_command_word_break_characters
;
2065 /* We've recognized a full command. */
2067 if (p
== tmp_command
+ point
)
2069 /* There is no non-whitespace in the line beyond the command. */
2071 if (p
[-1] == ' ' || p
[-1] == '\t')
2073 /* The command is followed by whitespace; we need to complete
2074 on whatever comes after command. */
2077 /* It is a prefix command; what comes after it is
2078 a subcommand (e.g. "info "). */
2079 list
= complete_on_cmdlist (*c
->prefixlist
, p
, word
);
2081 /* Insure that readline does the right thing
2082 with respect to inserting quotes. */
2083 rl_completer_word_break_characters
=
2084 gdb_completer_command_word_break_characters
;
2088 list
= complete_on_enum (c
->enums
, p
, word
);
2089 rl_completer_word_break_characters
=
2090 gdb_completer_command_word_break_characters
;
2094 /* It is a normal command; what comes after it is
2095 completed by the command's completer function. */
2096 list
= (*c
->completer
) (p
, word
);
2097 if (c
->completer
== filename_completer
)
2098 rl_completer_word_break_characters
=
2099 gdb_completer_file_name_break_characters
;
2104 /* The command is not followed by whitespace; we need to
2105 complete on the command itself. e.g. "p" which is a
2106 command itself but also can complete to "print", "ptype"
2110 /* Find the command we are completing on. */
2112 while (q
> tmp_command
)
2114 if (isalnum (q
[-1]) || q
[-1] == '-' || q
[-1] == '_')
2120 list
= complete_on_cmdlist (result_list
, q
, word
);
2122 /* Insure that readline does the right thing
2123 with respect to inserting quotes. */
2124 rl_completer_word_break_characters
=
2125 gdb_completer_command_word_break_characters
;
2130 /* There is non-whitespace beyond the command. */
2132 if (c
->prefixlist
&& !c
->allow_unknown
)
2134 /* It is an unrecognized subcommand of a prefix command,
2135 e.g. "info adsfkdj". */
2140 list
= complete_on_enum (c
->enums
, p
, word
);
2144 /* It is a normal command. */
2145 list
= (*c
->completer
) (p
, word
);
2146 if (c
->completer
== filename_completer
)
2147 rl_completer_word_break_characters
=
2148 gdb_completer_file_name_break_characters
;
2154 /* If we found a list of potential completions during initialization then
2155 dole them out one at a time. The vector of completions is NULL
2156 terminated, so after returning the last one, return NULL (and continue
2157 to do so) each time we are called after that, until a new list is
2162 output
= list
[index
];
2170 /* Can't do this because readline hasn't yet checked the word breaks
2171 for figuring out whether to insert a quote. */
2173 /* Make sure the word break characters are set back to normal for the
2174 next time that readline tries to complete something. */
2175 rl_completer_word_break_characters
=
2176 gdb_completer_word_break_characters
;
2182 /* Line completion interface function for readline. */
2185 readline_line_completion_function (char *text
, int matches
)
2187 return line_completion_function (text
, matches
, rl_line_buffer
, rl_point
);
2190 /* Skip over a possibly quoted word (as defined by the quote characters
2191 and word break characters the completer uses). Returns pointer to the
2192 location after the "word". */
2195 skip_quoted (char *str
)
2197 char quote_char
= '\0';
2200 for (scan
= str
; *scan
!= '\0'; scan
++)
2202 if (quote_char
!= '\0')
2204 /* Ignore everything until the matching close quote char */
2205 if (*scan
== quote_char
)
2207 /* Found matching close quote. */
2212 else if (strchr (gdb_completer_quote_characters
, *scan
))
2214 /* Found start of a quoted string. */
2217 else if (strchr (gdb_completer_word_break_characters
, *scan
))
2228 stop_sig (int signo
)
2230 #if STOP_SIGNAL == SIGTSTP
2231 signal (SIGTSTP
, SIG_DFL
);
2233 kill (getpid (), SIGTSTP
);
2234 signal (SIGTSTP
, stop_sig
);
2236 signal (STOP_SIGNAL
, stop_sig
);
2238 printf_unfiltered ("%s", get_prompt ());
2239 gdb_flush (gdb_stdout
);
2241 /* Forget about any previous command -- null line now will do nothing. */
2244 #endif /* STOP_SIGNAL */
2246 /* Initialize signal handlers. */
2248 do_nothing (int signo
)
2250 /* Under System V the default disposition of a signal is reinstated after
2251 the signal is caught and delivered to an application process. On such
2252 systems one must restore the replacement signal handler if one wishes
2253 to continue handling the signal in one's program. On BSD systems this
2254 is not needed but it is harmless, and it simplifies the code to just do
2255 it unconditionally. */
2256 signal (signo
, do_nothing
);
2262 signal (SIGINT
, request_quit
);
2264 /* If SIGTRAP was set to SIG_IGN, then the SIG_IGN will get passed
2265 to the inferior and breakpoints will be ignored. */
2267 signal (SIGTRAP
, SIG_DFL
);
2270 /* If we initialize SIGQUIT to SIG_IGN, then the SIG_IGN will get
2271 passed to the inferior, which we don't want. It would be
2272 possible to do a "signal (SIGQUIT, SIG_DFL)" after we fork, but
2273 on BSD4.3 systems using vfork, that can affect the
2274 GDB process as well as the inferior (the signal handling tables
2275 might be in memory, shared between the two). Since we establish
2276 a handler for SIGQUIT, when we call exec it will set the signal
2277 to SIG_DFL for us. */
2278 signal (SIGQUIT
, do_nothing
);
2280 if (signal (SIGHUP
, do_nothing
) != SIG_IGN
)
2281 signal (SIGHUP
, disconnect
);
2283 signal (SIGFPE
, float_handler
);
2285 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
2286 signal (SIGWINCH
, SIGWINCH_HANDLER
);
2290 /* Read one line from the command input stream `instream'
2291 into the local static buffer `linebuffer' (whose current length
2293 The buffer is made bigger as necessary.
2294 Returns the address of the start of the line.
2296 NULL is returned for end of file.
2298 *If* the instream == stdin & stdin is a terminal, the line read
2299 is copied into the file line saver (global var char *line,
2300 length linesize) so that it can be duplicated.
2302 This routine either uses fancy command line editing or
2303 simple input as the user has requested. */
2306 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
2308 static char *linebuffer
= 0;
2309 static unsigned linelength
= 0;
2313 char *local_prompt
= prompt_arg
;
2317 /* The annotation suffix must be non-NULL. */
2318 if (annotation_suffix
== NULL
)
2319 annotation_suffix
= "";
2321 if (annotation_level
> 1 && instream
== stdin
)
2323 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
2324 + strlen (annotation_suffix
) + 40);
2325 if (prompt_arg
== NULL
)
2326 local_prompt
[0] = '\0';
2328 strcpy (local_prompt
, prompt_arg
);
2329 strcat (local_prompt
, "\n\032\032");
2330 strcat (local_prompt
, annotation_suffix
);
2331 strcat (local_prompt
, "\n");
2334 if (linebuffer
== 0)
2337 linebuffer
= (char *) xmalloc (linelength
);
2342 /* Control-C quits instantly if typed while in this loop
2343 since it should not wait until the user types a newline. */
2349 signal (STOP_SIGNAL
, handle_stop_sig
);
2351 signal (STOP_SIGNAL
, stop_sig
);
2357 /* Make sure that all output has been output. Some machines may let
2358 you get away with leaving out some of the gdb_flush, but not all. */
2360 gdb_flush (gdb_stdout
);
2361 gdb_flush (gdb_stderr
);
2363 if (source_file_name
!= NULL
)
2365 ++source_line_number
;
2366 sprintf (source_error
,
2367 "%s%s:%d: Error in sourced command file:\n",
2370 source_line_number
);
2371 error_pre_print
= source_error
;
2374 if (annotation_level
> 1 && instream
== stdin
)
2376 printf_unfiltered ("\n\032\032pre-");
2377 printf_unfiltered (annotation_suffix
);
2378 printf_unfiltered ("\n");
2381 /* Don't use fancy stuff if not talking to stdin. */
2382 if (readline_hook
&& instream
== NULL
)
2384 rl
= (*readline_hook
) (local_prompt
);
2386 else if (command_editing_p
&& instream
== stdin
&& ISATTY (instream
))
2388 rl
= readline (local_prompt
);
2392 rl
= gdb_readline (local_prompt
);
2395 if (annotation_level
> 1 && instream
== stdin
)
2397 printf_unfiltered ("\n\032\032post-");
2398 printf_unfiltered (annotation_suffix
);
2399 printf_unfiltered ("\n");
2402 if (!rl
|| rl
== (char *) EOF
)
2407 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
2409 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
2410 nline
= (char *) xrealloc (linebuffer
, linelength
);
2411 p
+= nline
- linebuffer
;
2415 /* Copy line. Don't copy null at end. (Leaves line alone
2416 if this was just a newline) */
2420 free (rl
); /* Allocated in readline. */
2422 if (p
== linebuffer
|| *(p
- 1) != '\\')
2425 p
--; /* Put on top of '\'. */
2426 local_prompt
= (char *) 0;
2431 signal (STOP_SIGNAL
, SIG_DFL
);
2438 #define SERVER_COMMAND_LENGTH 7
2440 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
2441 && STREQN (linebuffer
, "server ", SERVER_COMMAND_LENGTH
);
2444 /* Note that we don't set `line'. Between this and the check in
2445 dont_repeat, this insures that repeating will still do the
2448 return linebuffer
+ SERVER_COMMAND_LENGTH
;
2451 /* Do history expansion if that is wished. */
2452 if (history_expansion_p
&& instream
== stdin
2453 && ISATTY (instream
))
2455 char *history_value
;
2458 *p
= '\0'; /* Insert null now. */
2459 expanded
= history_expand (linebuffer
, &history_value
);
2462 /* Print the changes. */
2463 printf_unfiltered ("%s\n", history_value
);
2465 /* If there was an error, call this function again. */
2468 free (history_value
);
2469 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
2471 if (strlen (history_value
) > linelength
)
2473 linelength
= strlen (history_value
) + 1;
2474 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
2476 strcpy (linebuffer
, history_value
);
2477 p
= linebuffer
+ strlen (linebuffer
);
2478 free (history_value
);
2482 /* If we just got an empty line, and that is supposed
2483 to repeat the previous command, return the value in the
2485 if (repeat
&& p
== linebuffer
)
2487 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
2493 /* Add line to history if appropriate. */
2494 if (instream
== stdin
2495 && ISATTY (stdin
) && *linebuffer
)
2496 add_history (linebuffer
);
2498 /* Note: lines consisting solely of comments are added to the command
2499 history. This is useful when you type a command, and then
2500 realize you don't want to execute it quite yet. You can comment
2501 out the command and then later fetch it from the value history
2502 and remove the '#'. The kill ring is probably better, but some
2503 people are in the habit of commenting things out. */
2505 *p1
= '\0'; /* Found a comment. */
2507 /* Save into global buffer if appropriate. */
2510 if (linelength
> linesize
)
2512 line
= xrealloc (line
, linelength
);
2513 linesize
= linelength
;
2515 strcpy (line
, linebuffer
);
2523 /* Expand the body_list of COMMAND so that it can hold NEW_LENGTH
2524 code bodies. This is typically used when we encounter an "else"
2525 clause for an "if" command. */
2528 realloc_body_list (struct command_line
*command
, int new_length
)
2531 struct command_line
**body_list
;
2533 n
= command
->body_count
;
2535 /* Nothing to do? */
2536 if (new_length
<= n
)
2539 body_list
= (struct command_line
**)
2540 xmalloc (sizeof (struct command_line
*) * new_length
);
2542 memcpy (body_list
, command
->body_list
, sizeof (struct command_line
*) * n
);
2544 free (command
->body_list
);
2545 command
->body_list
= body_list
;
2546 command
->body_count
= new_length
;
2549 /* Read one line from the input stream. If the command is an "else" or
2550 "end", return such an indication to the caller. */
2552 static enum misc_command_type
2553 read_next_line (struct command_line
**command
)
2555 char *p
, *p1
, *prompt_ptr
, control_prompt
[256];
2558 if (control_level
>= 254)
2559 error ("Control nesting too deep!\n");
2561 /* Set a prompt based on the nesting of the control commands. */
2562 if (instream
== stdin
|| (instream
== 0 && readline_hook
!= NULL
))
2564 for (i
= 0; i
< control_level
; i
++)
2565 control_prompt
[i
] = ' ';
2566 control_prompt
[i
] = '>';
2567 control_prompt
[i
+ 1] = '\0';
2568 prompt_ptr
= (char *) &control_prompt
[0];
2573 p
= command_line_input (prompt_ptr
, instream
== stdin
, "commands");
2575 /* Not sure what to do here. */
2579 /* Strip leading and trailing whitespace. */
2580 while (*p
== ' ' || *p
== '\t')
2583 p1
= p
+ strlen (p
);
2584 while (p1
!= p
&& (p1
[-1] == ' ' || p1
[-1] == '\t'))
2587 /* Blanks and comments don't really do anything, but we need to
2588 distinguish them from else, end and other commands which can be
2590 if (p1
== p
|| p
[0] == '#')
2593 /* Is this the end of a simple, while, or if control structure? */
2594 if (p1
- p
== 3 && !strncmp (p
, "end", 3))
2597 /* Is the else clause of an if control structure? */
2598 if (p1
- p
== 4 && !strncmp (p
, "else", 4))
2599 return else_command
;
2601 /* Check for while, if, break, continue, etc and build a new command
2602 line structure for them. */
2603 if (p1
- p
> 5 && !strncmp (p
, "while", 5))
2604 *command
= build_command_line (while_control
, p
+ 6);
2605 else if (p1
- p
> 2 && !strncmp (p
, "if", 2))
2606 *command
= build_command_line (if_control
, p
+ 3);
2607 else if (p1
- p
== 10 && !strncmp (p
, "loop_break", 10))
2609 *command
= (struct command_line
*)
2610 xmalloc (sizeof (struct command_line
));
2611 (*command
)->next
= NULL
;
2612 (*command
)->line
= NULL
;
2613 (*command
)->control_type
= break_control
;
2614 (*command
)->body_count
= 0;
2615 (*command
)->body_list
= NULL
;
2617 else if (p1
- p
== 13 && !strncmp (p
, "loop_continue", 13))
2619 *command
= (struct command_line
*)
2620 xmalloc (sizeof (struct command_line
));
2621 (*command
)->next
= NULL
;
2622 (*command
)->line
= NULL
;
2623 (*command
)->control_type
= continue_control
;
2624 (*command
)->body_count
= 0;
2625 (*command
)->body_list
= NULL
;
2629 /* A normal command. */
2630 *command
= (struct command_line
*)
2631 xmalloc (sizeof (struct command_line
));
2632 (*command
)->next
= NULL
;
2633 (*command
)->line
= savestring (p
, p1
- p
);
2634 (*command
)->control_type
= simple_control
;
2635 (*command
)->body_count
= 0;
2636 (*command
)->body_list
= NULL
;
2639 /* Nothing special. */
2643 /* Recursively read in the control structures and create a command_line
2644 structure from them.
2646 The parent_control parameter is the control structure in which the
2647 following commands are nested. */
2649 static enum command_control_type
2650 recurse_read_control_structure (struct command_line
*current_cmd
)
2652 int current_body
, i
;
2653 enum misc_command_type val
;
2654 enum command_control_type ret
;
2655 struct command_line
**body_ptr
, *child_tail
, *next
;
2660 /* Sanity checks. */
2661 if (current_cmd
->control_type
== simple_control
)
2663 error ("Recursed on a simple control type\n");
2664 return invalid_control
;
2667 if (current_body
> current_cmd
->body_count
)
2669 error ("Allocated body is smaller than this command type needs\n");
2670 return invalid_control
;
2673 /* Read lines from the input stream and build control structures. */
2679 val
= read_next_line (&next
);
2681 /* Just skip blanks and comments. */
2682 if (val
== nop_command
)
2685 if (val
== end_command
)
2687 if (current_cmd
->control_type
== while_control
2688 || current_cmd
->control_type
== if_control
)
2690 /* Success reading an entire control structure. */
2691 ret
= simple_control
;
2696 ret
= invalid_control
;
2701 /* Not the end of a control structure. */
2702 if (val
== else_command
)
2704 if (current_cmd
->control_type
== if_control
2705 && current_body
== 1)
2707 realloc_body_list (current_cmd
, 2);
2714 ret
= invalid_control
;
2721 child_tail
->next
= next
;
2725 body_ptr
= current_cmd
->body_list
;
2726 for (i
= 1; i
< current_body
; i
++)
2735 /* If the latest line is another control structure, then recurse
2737 if (next
->control_type
== while_control
2738 || next
->control_type
== if_control
)
2741 ret
= recurse_read_control_structure (next
);
2744 if (ret
!= simple_control
)
2754 /* Read lines from the input stream and accumulate them in a chain of
2755 struct command_line's, which is then returned. For input from a
2756 terminal, the special command "end" is used to mark the end of the
2757 input, and is not included in the returned chain of commands. */
2759 #define END_MESSAGE "End with a line saying just \"end\"."
2761 struct command_line
*
2762 read_command_lines (char *prompt_arg
, int from_tty
)
2764 struct command_line
*head
, *tail
, *next
;
2765 struct cleanup
*old_chain
;
2766 enum command_control_type ret
;
2767 enum misc_command_type val
;
2770 if (readline_begin_hook
)
2772 /* Note - intentional to merge messages with no newline */
2773 (*readline_begin_hook
) ("%s %s\n", prompt_arg
, END_MESSAGE
);
2775 else if (from_tty
&& input_from_terminal_p ())
2777 printf_unfiltered ("%s\n%s\n", prompt_arg
, END_MESSAGE
);
2778 gdb_flush (gdb_stdout
);
2786 val
= read_next_line (&next
);
2788 /* Ignore blank lines or comments. */
2789 if (val
== nop_command
)
2792 if (val
== end_command
)
2794 ret
= simple_control
;
2798 if (val
!= ok_command
)
2800 ret
= invalid_control
;
2804 if (next
->control_type
== while_control
2805 || next
->control_type
== if_control
)
2808 ret
= recurse_read_control_structure (next
);
2811 if (ret
== invalid_control
)
2822 old_chain
= make_cleanup_free_command_lines (&head
);
2831 if (ret
!= invalid_control
)
2833 discard_cleanups (old_chain
);
2836 do_cleanups (old_chain
);
2839 if (readline_end_hook
)
2841 (*readline_end_hook
) ();
2846 /* Free a chain of struct command_line's. */
2849 free_command_lines (struct command_line
**lptr
)
2851 register struct command_line
*l
= *lptr
;
2852 register struct command_line
*next
;
2853 struct command_line
**blist
;
2858 if (l
->body_count
> 0)
2860 blist
= l
->body_list
;
2861 for (i
= 0; i
< l
->body_count
; i
++, blist
++)
2862 free_command_lines (blist
);
2872 do_free_command_lines_cleanup (void *arg
)
2874 free_command_lines (arg
);
2877 static struct cleanup
*
2878 make_cleanup_free_command_lines (struct command_line
**arg
)
2880 return make_cleanup (do_free_command_lines_cleanup
, arg
);
2883 /* Add an element to the list of info subcommands. */
2885 struct cmd_list_element
*
2886 add_info (char *name
, void (*fun
) (char *, int), char *doc
)
2888 return add_cmd (name
, no_class
, fun
, doc
, &infolist
);
2891 /* Add an alias to the list of info subcommands. */
2893 struct cmd_list_element
*
2894 add_info_alias (char *name
, char *oldname
, int abbrev_flag
)
2896 return add_alias_cmd (name
, oldname
, 0, abbrev_flag
, &infolist
);
2899 /* The "info" command is defined as a prefix, with allow_unknown = 0.
2900 Therefore, its own definition is called only for "info" with no args. */
2904 info_command (char *arg
, int from_tty
)
2906 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
2907 help_list (infolist
, "info ", -1, gdb_stdout
);
2910 /* The "complete" command is used by Emacs to implement completion. */
2914 complete_command (char *arg
, int from_tty
)
2924 argpoint
= strlen (arg
);
2926 for (completion
= line_completion_function (arg
, i
= 0, arg
, argpoint
);
2928 completion
= line_completion_function (arg
, ++i
, arg
, argpoint
))
2930 printf_unfiltered ("%s\n", completion
);
2935 /* The "show" command with no arguments shows all the settings. */
2939 show_command (char *arg
, int from_tty
)
2941 cmd_show_list (showlist
, from_tty
, "");
2944 /* Add an element to the list of commands. */
2946 struct cmd_list_element
*
2947 add_com (char *name
, enum command_class
class, void (*fun
) (char *, int),
2950 return add_cmd (name
, class, fun
, doc
, &cmdlist
);
2953 /* Add an alias or abbreviation command to the list of commands. */
2955 struct cmd_list_element
*
2956 add_com_alias (char *name
, char *oldname
, enum command_class
class,
2959 return add_alias_cmd (name
, oldname
, class, abbrev_flag
, &cmdlist
);
2963 error_no_arg (char *why
)
2965 error ("Argument required (%s).", why
);
2968 /* Provide documentation on command or list given by COMMAND. FROM_TTY
2973 help_command (char *command
, int from_tty
)
2975 help_cmd (command
, gdb_stdout
);
2979 validate_comname (char *comname
)
2984 error_no_arg ("name of command to define");
2989 if (!isalnum (*p
) && *p
!= '-' && *p
!= '_')
2990 error ("Junk in argument list: \"%s\"", p
);
2995 /* This is just a placeholder in the command data structures. */
2997 user_defined_command (char *ignore
, int from_tty
)
3002 define_command (char *comname
, int from_tty
)
3004 #define MAX_TMPBUF 128
3011 register struct command_line
*cmds
;
3012 register struct cmd_list_element
*c
, *newc
, *oldc
, *hookc
= 0;
3013 char *tem
= comname
;
3015 char tmpbuf
[MAX_TMPBUF
];
3016 int hook_type
= CMD_NO_HOOK
;
3017 int hook_name_size
= 0;
3019 #define HOOK_STRING "hook-"
3021 #define HOOK_POST_STRING "hookpost-"
3022 #define HOOK_POST_LEN 9
3024 validate_comname (comname
);
3026 /* Look it up, and verify that we got an exact match. */
3027 c
= lookup_cmd (&tem
, cmdlist
, "", -1, 1);
3028 if (c
&& !STREQ (comname
, c
->name
))
3033 if (c
->class == class_user
|| c
->class == class_alias
)
3034 tem
= "Redefine command \"%s\"? ";
3036 tem
= "Really redefine built-in command \"%s\"? ";
3037 if (!query (tem
, c
->name
))
3038 error ("Command \"%s\" not redefined.", c
->name
);
3041 /* If this new command is a hook, then mark the command which it
3042 is hooking. Note that we allow hooking `help' commands, so that
3043 we can hook the `stop' pseudo-command. */
3045 if (!strncmp (comname
, HOOK_STRING
, HOOK_LEN
))
3047 hook_type
= CMD_PRE_HOOK
;
3048 hook_name_size
= HOOK_LEN
;
3050 else if (!strncmp (comname
, HOOK_POST_STRING
, HOOK_POST_LEN
))
3052 hook_type
= CMD_POST_HOOK
;
3053 hook_name_size
= HOOK_POST_LEN
;
3056 if (hook_type
!= CMD_NO_HOOK
)
3058 /* Look up cmd it hooks, and verify that we got an exact match. */
3059 tem
= comname
+ hook_name_size
;
3060 hookc
= lookup_cmd (&tem
, cmdlist
, "", -1, 0);
3061 if (hookc
&& !STREQ (comname
+ hook_name_size
, hookc
->name
))
3065 warning ("Your new `%s' command does not hook any existing command.",
3067 if (!query ("Proceed? "))
3068 error ("Not confirmed.");
3072 comname
= savestring (comname
, strlen (comname
));
3074 /* If the rest of the commands will be case insensitive, this one
3075 should behave in the same manner. */
3076 for (tem
= comname
; *tem
; tem
++)
3078 *tem
= tolower (*tem
);
3080 sprintf (tmpbuf
, "Type commands for definition of \"%s\".", comname
);
3081 cmds
= read_command_lines (tmpbuf
, from_tty
);
3083 if (c
&& c
->class == class_user
)
3084 free_command_lines (&c
->user_commands
);
3086 newc
= add_cmd (comname
, class_user
, user_defined_command
,
3087 (c
&& c
->class == class_user
)
3088 ? c
->doc
: savestring ("User-defined.", 13), &cmdlist
);
3089 newc
->user_commands
= cmds
;
3091 /* If this new command is a hook, then mark both commands as being
3098 hookc
->hook_pre
= newc
; /* Target gets hooked. */
3099 newc
->hookee_pre
= hookc
; /* We are marked as hooking target cmd. */
3102 hookc
->hook_pre
= newc
; /* Target gets hooked. */
3103 newc
->hookee_pre
= hookc
; /* We are marked as hooking target cmd. */
3106 /* Should never come here as hookc would be 0. */
3112 document_command (char *comname
, int from_tty
)
3114 struct command_line
*doclines
;
3115 register struct cmd_list_element
*c
;
3116 char *tem
= comname
;
3119 validate_comname (comname
);
3121 c
= lookup_cmd (&tem
, cmdlist
, "", 0, 1);
3123 if (c
->class != class_user
)
3124 error ("Command \"%s\" is built-in.", comname
);
3126 sprintf (tmpbuf
, "Type documentation for \"%s\".", comname
);
3127 doclines
= read_command_lines (tmpbuf
, from_tty
);
3133 register struct command_line
*cl1
;
3134 register int len
= 0;
3136 for (cl1
= doclines
; cl1
; cl1
= cl1
->next
)
3137 len
+= strlen (cl1
->line
) + 1;
3139 c
->doc
= (char *) xmalloc (len
+ 1);
3142 for (cl1
= doclines
; cl1
; cl1
= cl1
->next
)
3144 strcat (c
->doc
, cl1
->line
);
3146 strcat (c
->doc
, "\n");
3150 free_command_lines (&doclines
);
3153 /* Print the GDB banner. */
3155 print_gdb_version (struct ui_file
*stream
)
3157 /* From GNU coding standards, first line is meant to be easy for a
3158 program to parse, and is just canonical program name and version
3159 number, which starts after last space. */
3162 /* Print it console style until a format is defined */
3163 fprintf_filtered (stream
, "GNU gdb %s (UI_OUT)\n", version
);
3165 fprintf_filtered (stream
, "GNU gdb %s\n", version
);
3168 /* Second line is a copyright notice. */
3170 fprintf_filtered (stream
, "Copyright 2000 Free Software Foundation, Inc.\n");
3172 /* Following the copyright is a brief statement that the program is
3173 free software, that users are free to copy and change it on
3174 certain conditions, that it is covered by the GNU GPL, and that
3175 there is no warranty. */
3177 fprintf_filtered (stream
, "\
3178 GDB is free software, covered by the GNU General Public License, and you are\n\
3179 welcome to change it and/or distribute copies of it under certain conditions.\n\
3180 Type \"show copying\" to see the conditions.\n\
3181 There is absolutely no warranty for GDB. Type \"show warranty\" for details.\n");
3183 /* After the required info we print the configuration information. */
3185 fprintf_filtered (stream
, "This GDB was configured as \"");
3186 if (!STREQ (host_name
, target_name
))
3188 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
3192 fprintf_filtered (stream
, "%s", host_name
);
3194 fprintf_filtered (stream
, "\".");
3199 show_version (char *args
, int from_tty
)
3202 print_gdb_version (gdb_stdout
);
3203 printf_filtered ("\n");
3207 /* get_prompt: access method for the GDB prompt string. */
3209 #define MAX_PROMPT_SIZE 256
3212 * int get_prompt_1 (char * buf);
3214 * Work-horse for get_prompt (called via catch_errors).
3215 * Argument is buffer to hold the formatted prompt.
3217 * Returns: 1 for success (use formatted prompt)
3218 * 0 for failure (use gdb_prompt_string).
3221 static int gdb_prompt_escape
;
3224 get_prompt_1 (void *data
)
3226 char *formatted_prompt
= data
;
3230 local_prompt
= PROMPT (0);
3232 local_prompt
= gdb_prompt_string
;
3235 if (gdb_prompt_escape
== 0)
3237 return 0; /* do no formatting */
3240 /* formatted prompt */
3242 char fmt
[40], *promptp
, *outp
, *tmp
;
3249 struct type
*arg_type
, *elt_type
;
3251 promptp
= local_prompt
;
3252 outp
= formatted_prompt
;
3254 while (*promptp
!= '\0')
3256 int available
= MAX_PROMPT_SIZE
- (outp
- formatted_prompt
) - 1;
3258 if (*promptp
!= gdb_prompt_escape
)
3260 if (available
>= 1) /* overflow protect */
3261 *outp
++ = *promptp
++;
3265 /* GDB prompt string contains escape char. Parse for arg.
3266 Two consecutive escape chars followed by arg followed by
3267 a comma means to insert the arg using a default format.
3268 Otherwise a printf format string may be included between
3269 the two escape chars. eg:
3270 %%foo, insert foo using default format
3271 %2.2f%foo, insert foo using "%2.2f" format
3272 A mismatch between the format string and the data type
3273 of "foo" is an error (which we don't know how to protect
3276 fmt
[0] = '\0'; /* assume null format string */
3277 if (promptp
[1] == gdb_prompt_escape
) /* double esc char */
3279 promptp
+= 2; /* skip past two escape chars. */
3283 /* extract format string from between two esc chars */
3287 fmt
[i
++] = *promptp
++; /* copy format string */
3289 while (i
< sizeof (fmt
) - 1 &&
3290 *promptp
!= gdb_prompt_escape
&&
3293 if (*promptp
!= gdb_prompt_escape
)
3294 error ("Syntax error at prompt position %d",
3295 promptp
- local_prompt
);
3298 promptp
++; /* skip second escape char */
3299 fmt
[i
++] = '\0'; /* terminate the format string */
3303 arg_val
= parse_to_comma_and_eval (&promptp
);
3304 if (*promptp
== ',')
3305 promptp
++; /* skip past the comma */
3306 arg_type
= check_typedef (VALUE_TYPE (arg_val
));
3307 switch (TYPE_CODE (arg_type
))
3309 case TYPE_CODE_ARRAY
:
3310 elt_type
= check_typedef (TYPE_TARGET_TYPE (arg_type
));
3311 if (TYPE_LENGTH (arg_type
) > 0 &&
3312 TYPE_LENGTH (elt_type
) == 1 &&
3313 TYPE_CODE (elt_type
) == TYPE_CODE_INT
)
3315 int len
= TYPE_LENGTH (arg_type
);
3317 if (VALUE_LAZY (arg_val
))
3318 value_fetch_lazy (arg_val
);
3319 tmp
= VALUE_CONTENTS (arg_val
);
3321 if (len
> available
)
3322 len
= available
; /* overflow protect */
3324 /* FIXME: how to protect GDB from crashing
3325 from bad user-supplied format string? */
3327 sprintf (outp
, fmt
, tmp
);
3329 strncpy (outp
, tmp
, len
);
3334 elt_type
= check_typedef (TYPE_TARGET_TYPE (arg_type
));
3335 addrval
= value_as_pointer (arg_val
);
3337 if (TYPE_LENGTH (elt_type
) == 1 &&
3338 TYPE_CODE (elt_type
) == TYPE_CODE_INT
&&
3341 /* display it as a string */
3342 char *default_fmt
= "%s";
3346 /* Limiting the number of bytes that the following call
3347 will read protects us from sprintf overflow later. */
3348 i
= target_read_string (addrval
, /* src */
3350 available
, /* len */
3352 if (err
) /* read failed */
3353 error ("%s on target_read", safe_strerror (err
));
3355 tmp
[i
] = '\0'; /* force-terminate string */
3356 /* FIXME: how to protect GDB from crashing
3357 from bad user-supplied format string? */
3358 sprintf (outp
, fmt
[0] == 0 ? default_fmt
: fmt
,
3364 /* display it as a pointer */
3365 char *default_fmt
= "0x%x";
3367 /* FIXME: how to protect GDB from crashing
3368 from bad user-supplied format string? */
3369 if (available
>= 16 /*? */ ) /* overflow protect */
3370 sprintf (outp
, fmt
[0] == 0 ? default_fmt
: fmt
,
3376 char *default_fmt
= "%g";
3378 doubleval
= value_as_double (arg_val
);
3379 /* FIXME: how to protect GDB from crashing
3380 from bad user-supplied format string? */
3381 if (available
>= 16 /*? */ ) /* overflow protect */
3382 sprintf (outp
, fmt
[0] == 0 ? default_fmt
: fmt
,
3383 (double) doubleval
);
3388 char *default_fmt
= "%d";
3390 longval
= value_as_long (arg_val
);
3391 /* FIXME: how to protect GDB from crashing
3392 from bad user-supplied format string? */
3393 if (available
>= 16 /*? */ ) /* overflow protect */
3394 sprintf (outp
, fmt
[0] == 0 ? default_fmt
: fmt
,
3398 case TYPE_CODE_BOOL
:
3400 /* no default format for bool */
3401 longval
= value_as_long (arg_val
);
3402 if (available
>= 8 /*? */ ) /* overflow protect */
3405 strcpy (outp
, "<true>");
3407 strcpy (outp
, "<false>");
3411 case TYPE_CODE_ENUM
:
3413 /* no default format for enum */
3414 longval
= value_as_long (arg_val
);
3415 len
= TYPE_NFIELDS (arg_type
);
3416 /* find enum name if possible */
3417 for (i
= 0; i
< len
; i
++)
3418 if (TYPE_FIELD_BITPOS (arg_type
, i
) == longval
)
3419 break; /* match -- end loop */
3421 if (i
< len
) /* enum name found */
3423 char *name
= TYPE_FIELD_NAME (arg_type
, i
);
3425 strncpy (outp
, name
, available
);
3426 /* in casel available < strlen (name), */
3427 outp
[available
] = '\0';
3431 if (available
>= 16 /*? */ ) /* overflow protect */
3432 sprintf (outp
, "%ld", (long) longval
);
3436 case TYPE_CODE_VOID
:
3438 break; /* void type -- no output */
3440 error ("bad data type at prompt position %d",
3441 promptp
- local_prompt
);
3444 outp
+= strlen (outp
);
3447 *outp
++ = '\0'; /* terminate prompt string */
3455 static char buf
[MAX_PROMPT_SIZE
];
3457 if (catch_errors (get_prompt_1
, buf
, "bad formatted prompt: ",
3460 return &buf
[0]; /* successful formatted prompt */
3464 /* Prompt could not be formatted. */
3468 return gdb_prompt_string
;
3473 set_prompt (char *s
)
3475 /* ??rehrauer: I don't know why this fails, since it looks as though
3476 assignments to prompt are wrapped in calls to savestring...
3481 PROMPT (0) = savestring (s
, strlen (s
));
3483 gdb_prompt_string
= savestring (s
, strlen (s
));
3487 /* If necessary, make the user confirm that we should quit. Return
3488 non-zero if we should quit, zero if we shouldn't. */
3493 if (inferior_pid
!= 0 && target_has_execution
)
3497 /* This is something of a hack. But there's no reliable way to
3498 see if a GUI is running. The `use_windows' variable doesn't
3501 s
= "A debugging session is active.\nDo you still want to close the debugger?";
3502 else if (attach_flag
)
3503 s
= "The program is running. Quit anyway (and detach it)? ";
3505 s
= "The program is running. Exit anyway? ";
3514 /* Quit without asking for confirmation. */
3517 quit_force (char *args
, int from_tty
)
3521 /* An optional expression may be used to cause gdb to terminate with the
3522 value of that expression. */
3525 value_ptr val
= parse_and_eval (args
);
3527 exit_code
= (int) value_as_long (val
);
3530 if (inferior_pid
!= 0 && target_has_execution
)
3533 target_detach (args
, from_tty
);
3538 /* UDI wants this, to kill the TIP. */
3541 /* Save the history information if it is appropriate to do so. */
3542 if (write_history_p
&& history_filename
)
3543 write_history (history_filename
);
3545 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
3548 /* tuiDo((TuiOpaqueFuncPtr)tuiCleanUp); */
3549 /* The above does not need to be inside a tuiDo(), since
3550 * it is not manipulating the curses screen, but rather,
3551 * it is tearing it down.
3560 /* Handle the quit command. */
3563 quit_command (char *args
, int from_tty
)
3565 if (!quit_confirm ())
3566 error ("Not confirmed.");
3567 quit_force (args
, from_tty
);
3570 /* Returns whether GDB is running on a terminal and whether the user
3571 desires that questions be asked of them on that terminal. */
3574 input_from_terminal_p (void)
3576 return gdb_has_a_terminal () && (instream
== stdin
) & caution
;
3581 pwd_command (char *args
, int from_tty
)
3584 error ("The \"pwd\" command does not take an argument: %s", args
);
3585 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
3587 if (!STREQ (gdb_dirbuf
, current_directory
))
3588 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
3589 current_directory
, gdb_dirbuf
);
3591 printf_unfiltered ("Working directory %s.\n", current_directory
);
3595 cd_command (char *dir
, int from_tty
)
3598 /* Found something other than leading repetitions of "/..". */
3599 int found_real_path
;
3602 /* If the new directory is absolute, repeat is a no-op; if relative,
3603 repeat might be useful but is more likely to be a mistake. */
3607 error_no_arg ("new working directory");
3609 dir
= tilde_expand (dir
);
3610 make_cleanup (free
, dir
);
3612 if (chdir (dir
) < 0)
3613 perror_with_name (dir
);
3615 #if defined(_WIN32) || defined(__MSDOS__)
3616 /* There's too much mess with DOSish names like "d:", "d:.",
3617 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
3618 simply get the canonicalized name of the current directory. */
3619 dir
= getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
3623 if (SLASH_P (dir
[len
- 1]))
3625 /* Remove the trailing slash unless this is a root directory
3626 (including a drive letter on non-Unix systems). */
3627 if (!(len
== 1) /* "/" */
3628 #if defined(_WIN32) || defined(__MSDOS__)
3629 && !(!SLASH_P (*dir
) && ROOTED_P (dir
) && len
<= 3) /* "d:/" */
3635 dir
= savestring (dir
, len
);
3637 current_directory
= dir
;
3640 if (SLASH_P (current_directory
[strlen (current_directory
) - 1]))
3641 current_directory
= concat (current_directory
, dir
, NULL
);
3643 current_directory
= concat (current_directory
, SLASH_STRING
, dir
, NULL
);
3647 /* Now simplify any occurrences of `.' and `..' in the pathname. */
3649 found_real_path
= 0;
3650 for (p
= current_directory
; *p
;)
3652 if (SLASH_P (p
[0]) && p
[1] == '.' && (p
[2] == 0 || SLASH_P (p
[2])))
3654 else if (SLASH_P (p
[0]) && p
[1] == '.' && p
[2] == '.'
3655 && (p
[3] == 0 || SLASH_P (p
[3])))
3657 if (found_real_path
)
3659 /* Search backwards for the directory just before the "/.."
3660 and obliterate it and the "/..". */
3662 while (q
!= current_directory
&& !SLASH_P (q
[-1]))
3665 if (q
== current_directory
)
3666 /* current_directory is
3667 a relative pathname ("can't happen"--leave it alone). */
3671 strcpy (q
- 1, p
+ 3);
3676 /* We are dealing with leading repetitions of "/..", for example
3677 "/../..", which is the Mach super-root. */
3682 found_real_path
= 1;
3687 forget_cached_source_info ();
3690 pwd_command ((char *) 0, 1);
3693 struct source_cleanup_lines_args
3697 char *old_pre_error
;
3698 char *old_error_pre_print
;
3702 source_cleanup_lines (PTR args
)
3704 struct source_cleanup_lines_args
*p
=
3705 (struct source_cleanup_lines_args
*) args
;
3706 source_line_number
= p
->old_line
;
3707 source_file_name
= p
->old_file
;
3708 source_pre_error
= p
->old_pre_error
;
3709 error_pre_print
= p
->old_error_pre_print
;
3714 do_fclose_cleanup (void *stream
)
3720 source_command (char *args
, int from_tty
)
3723 struct cleanup
*old_cleanups
;
3725 struct source_cleanup_lines_args old_lines
;
3730 error ("source command requires pathname of file to source.");
3733 file
= tilde_expand (file
);
3734 old_cleanups
= make_cleanup (free
, file
);
3736 stream
= fopen (file
, FOPEN_RT
);
3740 perror_with_name (file
);
3745 make_cleanup (do_fclose_cleanup
, stream
);
3747 old_lines
.old_line
= source_line_number
;
3748 old_lines
.old_file
= source_file_name
;
3749 old_lines
.old_pre_error
= source_pre_error
;
3750 old_lines
.old_error_pre_print
= error_pre_print
;
3751 make_cleanup (source_cleanup_lines
, &old_lines
);
3752 source_line_number
= 0;
3753 source_file_name
= file
;
3754 source_pre_error
= error_pre_print
== NULL
? "" : error_pre_print
;
3755 source_pre_error
= savestring (source_pre_error
, strlen (source_pre_error
));
3756 make_cleanup (free
, source_pre_error
);
3757 /* This will get set every time we read a line. So it won't stay "" for
3759 error_pre_print
= "";
3761 needed_length
= strlen (source_file_name
) + strlen (source_pre_error
) + 80;
3762 if (source_error_allocated
< needed_length
)
3764 source_error_allocated
*= 2;
3765 if (source_error_allocated
< needed_length
)
3766 source_error_allocated
= needed_length
;
3767 if (source_error
== NULL
)
3768 source_error
= xmalloc (source_error_allocated
);
3770 source_error
= xrealloc (source_error
, source_error_allocated
);
3773 read_command_file (stream
);
3775 do_cleanups (old_cleanups
);
3780 echo_command (char *text
, int from_tty
)
3786 while ((c
= *p
++) != '\0')
3790 /* \ at end of argument is used after spaces
3791 so they won't be lost. */
3795 c
= parse_escape (&p
);
3797 printf_filtered ("%c", c
);
3800 printf_filtered ("%c", c
);
3803 /* Force this output to appear now. */
3805 gdb_flush (gdb_stdout
);
3810 dont_repeat_command (char *ignored
, int from_tty
)
3812 *line
= 0; /* Can't call dont_repeat here because we're not
3813 necessarily reading from stdin. */
3816 /* Functions to manipulate command line editing control variables. */
3818 /* Number of commands to print in each call to show_commands. */
3819 #define Hist_print 10
3821 show_commands (char *args
, int from_tty
)
3823 /* Index for history commands. Relative to history_base. */
3826 /* Number of the history entry which we are planning to display next.
3827 Relative to history_base. */
3830 /* The first command in the history which doesn't exist (i.e. one more
3831 than the number of the last command). Relative to history_base. */
3834 extern HIST_ENTRY
*history_get (int);
3836 /* Print out some of the commands from the command history. */
3837 /* First determine the length of the history list. */
3838 hist_len
= history_size
;
3839 for (offset
= 0; offset
< history_size
; offset
++)
3841 if (!history_get (history_base
+ offset
))
3850 if (args
[0] == '+' && args
[1] == '\0')
3851 /* "info editing +" should print from the stored position. */
3854 /* "info editing <exp>" should print around command number <exp>. */
3855 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
3857 /* "show commands" means print the last Hist_print commands. */
3860 num
= hist_len
- Hist_print
;
3866 /* If there are at least Hist_print commands, we want to display the last
3867 Hist_print rather than, say, the last 6. */
3868 if (hist_len
- num
< Hist_print
)
3870 num
= hist_len
- Hist_print
;
3875 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
3877 printf_filtered ("%5d %s\n", history_base
+ offset
,
3878 (history_get (history_base
+ offset
))->line
);
3881 /* The next command we want to display is the next one that we haven't
3885 /* If the user repeats this command with return, it should do what
3886 "show commands +" does. This is unnecessary if arg is null,
3887 because "show commands +" is not useful after "show commands". */
3888 if (from_tty
&& args
)
3895 /* Called by do_setshow_command. */
3898 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
3900 if (history_size
== INT_MAX
)
3901 unstifle_history ();
3902 else if (history_size
>= 0)
3903 stifle_history (history_size
);
3906 history_size
= INT_MAX
;
3907 error ("History size must be non-negative");
3913 set_history (char *args
, int from_tty
)
3915 printf_unfiltered ("\"set history\" must be followed by the name of a history subcommand.\n");
3916 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
3921 show_history (char *args
, int from_tty
)
3923 cmd_show_list (showhistlist
, from_tty
, "");
3926 int info_verbose
= 0; /* Default verbose msgs off */
3928 /* Called by do_setshow_command. An elaborate joke. */
3931 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
3933 char *cmdname
= "verbose";
3934 struct cmd_list_element
*showcmd
;
3936 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
3940 c
->doc
= "Set verbose printing of informational messages.";
3941 showcmd
->doc
= "Show verbose printing of informational messages.";
3945 c
->doc
= "Set verbosity.";
3946 showcmd
->doc
= "Show verbosity.";
3951 float_handler (int signo
)
3953 /* This message is based on ANSI C, section 4.7. Note that integer
3954 divide by zero causes this, so "float" is a misnomer. */
3955 signal (SIGFPE
, float_handler
);
3956 error ("Erroneous arithmetic operation.");
3960 set_debug (char *arg
, int from_tty
)
3962 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
3963 help_list (setdebuglist
, "set debug ", -1, gdb_stdout
);
3967 show_debug (char *args
, int from_tty
)
3969 cmd_show_list (showdebuglist
, from_tty
, "");
3973 init_cmd_lists (void)
3982 enablebreaklist
= NULL
;
3987 showhistlist
= NULL
;
3988 unsethistlist
= NULL
;
3989 maintenancelist
= NULL
;
3990 maintenanceinfolist
= NULL
;
3991 maintenanceprintlist
= NULL
;
3992 setprintlist
= NULL
;
3993 showprintlist
= NULL
;
3994 setchecklist
= NULL
;
3995 showchecklist
= NULL
;
3998 /* Init the history buffer. Note that we are called after the init file(s)
3999 * have been read so that the user can change the history file via his
4000 * .gdbinit file (for instance). The GDBHISTFILE environment variable
4001 * overrides all of this.
4009 tmpenv
= getenv ("HISTSIZE");
4011 history_size
= atoi (tmpenv
);
4012 else if (!history_size
)
4015 stifle_history (history_size
);
4017 tmpenv
= getenv ("GDBHISTFILE");
4019 history_filename
= savestring (tmpenv
, strlen (tmpenv
));
4020 else if (!history_filename
)
4022 /* We include the current directory so that if the user changes
4023 directories the file written will be the same as the one
4026 /* No leading dots in file names are allowed on MSDOS. */
4027 history_filename
= concat (current_directory
, "/_gdb_history", NULL
);
4029 history_filename
= concat (current_directory
, "/.gdb_history", NULL
);
4032 read_history (history_filename
);
4038 struct cmd_list_element
*c
;
4040 /* If we are running the asynchronous version,
4041 we initialize the prompts differently. */
4044 gdb_prompt_string
= savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
4048 /* initialize the prompt stack to a simple "(gdb) " prompt or to
4049 whatever the DEFAULT_PROMPT is. */
4050 the_prompts
.top
= 0;
4052 PROMPT (0) = savestring (DEFAULT_PROMPT
, strlen (DEFAULT_PROMPT
));
4054 /* Set things up for annotation_level > 1, if the user ever decides
4056 async_annotation_suffix
= "prompt";
4057 /* Set the variable associated with the setshow prompt command. */
4058 new_async_prompt
= savestring (PROMPT (0), strlen (PROMPT (0)));
4060 gdb_prompt_escape
= 0; /* default to none. */
4062 /* Set the important stuff up for command editing. */
4063 command_editing_p
= 1;
4064 history_expansion_p
= 0;
4065 write_history_p
= 0;
4067 /* Setup important stuff for command line editing. */
4068 rl_completion_entry_function
= (int (*)()) readline_line_completion_function
;
4069 rl_completer_word_break_characters
= gdb_completer_word_break_characters
;
4070 rl_completer_quote_characters
= gdb_completer_quote_characters
;
4071 rl_readline_name
= "gdb";
4073 /* Define the classes of commands.
4074 They will appear in the help list in the reverse of this order. */
4076 add_cmd ("internals", class_maintenance
, NO_FUNCTION
,
4077 "Maintenance commands.\n\
4078 Some gdb commands are provided just for use by gdb maintainers.\n\
4079 These commands are subject to frequent change, and may not be as\n\
4080 well documented as user commands.",
4082 add_cmd ("obscure", class_obscure
, NO_FUNCTION
, "Obscure features.", &cmdlist
);
4083 add_cmd ("aliases", class_alias
, NO_FUNCTION
, "Aliases of other commands.", &cmdlist
);
4084 add_cmd ("user-defined", class_user
, NO_FUNCTION
, "User-defined commands.\n\
4085 The commands in this class are those defined by the user.\n\
4086 Use the \"define\" command to define a command.", &cmdlist
);
4087 add_cmd ("support", class_support
, NO_FUNCTION
, "Support facilities.", &cmdlist
);
4089 add_cmd ("status", class_info
, NO_FUNCTION
, "Status inquiries.", &cmdlist
);
4090 add_cmd ("files", class_files
, NO_FUNCTION
, "Specifying and examining files.", &cmdlist
);
4091 add_cmd ("breakpoints", class_breakpoint
, NO_FUNCTION
, "Making program stop at certain points.", &cmdlist
);
4092 add_cmd ("data", class_vars
, NO_FUNCTION
, "Examining data.", &cmdlist
);
4093 add_cmd ("stack", class_stack
, NO_FUNCTION
, "Examining the stack.\n\
4094 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
4095 counting from zero for the innermost (currently executing) frame.\n\n\
4096 At any time gdb identifies one frame as the \"selected\" frame.\n\
4097 Variable lookups are done with respect to the selected frame.\n\
4098 When the program being debugged stops, gdb selects the innermost frame.\n\
4099 The commands below can be used to select other frames by number or address.",
4101 add_cmd ("running", class_run
, NO_FUNCTION
, "Running the program.", &cmdlist
);
4103 add_com ("pwd", class_files
, pwd_command
,
4104 "Print working directory. This is used for your program as well.");
4105 c
= add_cmd ("cd", class_files
, cd_command
,
4106 "Set working directory to DIR for debugger and program being debugged.\n\
4107 The change does not take effect for the program being debugged\n\
4108 until the next time it is started.", &cmdlist
);
4109 c
->completer
= filename_completer
;
4111 /* The set prompt command is different depending whether or not the
4112 async version is run. NOTE: this difference is going to
4113 disappear as we make the event loop be the default engine of
4118 (add_set_cmd ("prompt", class_support
, var_string
,
4119 (char *) &gdb_prompt_string
, "Set gdb's prompt",
4125 c
= add_set_cmd ("prompt", class_support
, var_string
,
4126 (char *) &new_async_prompt
, "Set gdb's prompt",
4128 add_show_from_set (c
, &showlist
);
4129 c
->function
.sfunc
= set_async_prompt
;
4133 (add_set_cmd ("prompt-escape-char", class_support
, var_zinteger
,
4134 (char *) &gdb_prompt_escape
,
4135 "Set escape character for formatting of gdb's prompt",
4139 add_com ("echo", class_support
, echo_command
,
4140 "Print a constant string. Give string as argument.\n\
4141 C escape sequences may be used in the argument.\n\
4142 No newline is added at the end of the argument;\n\
4143 use \"\\n\" if you want a newline to be printed.\n\
4144 Since leading and trailing whitespace are ignored in command arguments,\n\
4145 if you want to print some you must use \"\\\" before leading whitespace\n\
4146 to be printed or after trailing whitespace.");
4147 add_com ("document", class_support
, document_command
,
4148 "Document a user-defined command.\n\
4149 Give command name as argument. Give documentation on following lines.\n\
4150 End with a line of just \"end\".");
4151 add_com ("define", class_support
, define_command
,
4152 "Define a new command name. Command name is argument.\n\
4153 Definition appears on following lines, one command per line.\n\
4154 End with a line of just \"end\".\n\
4155 Use the \"document\" command to give documentation for the new command.\n\
4156 Commands defined in this way may have up to ten arguments.");
4159 c
= add_cmd ("source", class_support
, source_command
,
4160 "Read commands from a file named FILE.\n\
4161 Note that the file \"" GDBINIT_FILENAME
"\" is read automatically in this way\n\
4162 when gdb is started.", &cmdlist
);
4164 /* Punt file name, we can't help it easily. */
4165 c
= add_cmd ("source", class_support
, source_command
,
4166 "Read commands from a file named FILE.\n\
4167 Note that the file \".gdbinit\" is read automatically in this way\n\
4168 when gdb is started.", &cmdlist
);
4170 c
->completer
= filename_completer
;
4172 add_com ("quit", class_support
, quit_command
, "Exit gdb.");
4173 add_com ("help", class_support
, help_command
, "Print list of commands.");
4174 add_com_alias ("q", "quit", class_support
, 1);
4175 add_com_alias ("h", "help", class_support
, 1);
4177 add_com ("dont-repeat", class_support
, dont_repeat_command
, "Don't repeat this command.\n\
4178 Primarily used inside of user-defined commands that should not be repeated when\n\
4181 c
= add_set_cmd ("verbose", class_support
, var_boolean
, (char *) &info_verbose
,
4184 add_show_from_set (c
, &showlist
);
4185 c
->function
.sfunc
= set_verbose
;
4186 set_verbose (NULL
, 0, c
);
4188 /* The set editing command is different depending whether or not the
4189 async version is run. NOTE: this difference is going to disappear
4190 as we make the event loop be the default engine of gdb. */
4194 (add_set_cmd ("editing", class_support
, var_boolean
, (char *) &command_editing_p
,
4195 "Set editing of command lines as they are typed.\n\
4196 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
4197 Without an argument, command line editing is enabled. To edit, use\n\
4198 EMACS-like or VI-like commands like control-P or ESC.", &setlist
),
4203 c
= add_set_cmd ("editing", class_support
, var_boolean
, (char *) &async_command_editing_p
,
4204 "Set editing of command lines as they are typed.\n\
4205 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
4206 Without an argument, command line editing is enabled. To edit, use\n\
4207 EMACS-like or VI-like commands like control-P or ESC.", &setlist
);
4209 add_show_from_set (c
, &showlist
);
4210 c
->function
.sfunc
= set_async_editing_command
;
4213 add_prefix_cmd ("history", class_support
, set_history
,
4214 "Generic command for setting command history parameters.",
4215 &sethistlist
, "set history ", 0, &setlist
);
4216 add_prefix_cmd ("history", class_support
, show_history
,
4217 "Generic command for showing command history parameters.",
4218 &showhistlist
, "show history ", 0, &showlist
);
4221 (add_set_cmd ("expansion", no_class
, var_boolean
, (char *) &history_expansion_p
,
4222 "Set history expansion on command input.\n\
4223 Without an argument, history expansion is enabled.", &sethistlist
),
4227 (add_set_cmd ("save", no_class
, var_boolean
, (char *) &write_history_p
,
4228 "Set saving of the history record on exit.\n\
4229 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
4230 Without an argument, saving is enabled.", &sethistlist
),
4233 c
= add_set_cmd ("size", no_class
, var_integer
, (char *) &history_size
,
4234 "Set the size of the command history, \n\
4235 ie. the number of previous commands to keep a record of.", &sethistlist
);
4236 add_show_from_set (c
, &showhistlist
);
4237 c
->function
.sfunc
= set_history_size_command
;
4240 (add_set_cmd ("filename", no_class
, var_filename
, (char *) &history_filename
,
4241 "Set the filename in which to record the command history\n\
4242 (the list of previous commands of which a record is kept).", &sethistlist
),
4246 (add_set_cmd ("confirm", class_support
, var_boolean
,
4248 "Set whether to confirm potentially dangerous operations.",
4252 add_prefix_cmd ("info", class_info
, info_command
,
4253 "Generic command for showing things about the program being debugged.",
4254 &infolist
, "info ", 0, &cmdlist
);
4255 add_com_alias ("i", "info", class_info
, 1);
4257 add_com ("complete", class_obscure
, complete_command
,
4258 "List the completions for the rest of the line as a command.");
4260 add_prefix_cmd ("show", class_info
, show_command
,
4261 "Generic command for showing things about the debugger.",
4262 &showlist
, "show ", 0, &cmdlist
);
4263 /* Another way to get at the same thing. */
4264 add_info ("set", show_command
, "Show all GDB settings.");
4266 add_cmd ("commands", no_class
, show_commands
,
4267 "Show the history of commands you typed.\n\
4268 You can supply a command number to start with, or a `+' to start after\n\
4269 the previous command number shown.",
4272 add_cmd ("version", no_class
, show_version
,
4273 "Show what version of GDB this is.", &showlist
);
4275 add_com ("while", class_support
, while_command
,
4276 "Execute nested commands WHILE the conditional expression is non zero.\n\
4277 The conditional expression must follow the word `while' and must in turn be\n\
4278 followed by a new line. The nested commands must be entered one per line,\n\
4279 and should be terminated by the word `end'.");
4281 add_com ("if", class_support
, if_command
,
4282 "Execute nested commands once IF the conditional expression is non zero.\n\
4283 The conditional expression must follow the word `if' and must in turn be\n\
4284 followed by a new line. The nested commands must be entered one per line,\n\
4285 and should be terminated by the word 'else' or `end'. If an else clause\n\
4286 is used, the same rules apply to its nested commands as to the first ones.");
4288 /* If target is open when baud changes, it doesn't take effect until the
4289 next open (I think, not sure). */
4290 add_show_from_set (add_set_cmd ("remotebaud", no_class
,
4291 var_zinteger
, (char *) &baud_rate
,
4292 "Set baud rate for remote serial I/O.\n\
4293 This value is used to set the speed of the serial port when debugging\n\
4294 using remote targets.", &setlist
),
4297 c
= add_set_cmd ("remotedebug", no_class
, var_zinteger
,
4298 (char *) &remote_debug
,
4299 "Set debugging of remote protocol.\n\
4300 When enabled, each packet sent or received with the remote target\n\
4301 is displayed.", &setlist
);
4302 deprecate_cmd (c
, "set debug remote");
4303 deprecate_cmd (add_show_from_set (c
, &showlist
), "show debug remote");
4305 add_show_from_set (add_set_cmd ("remote", no_class
, var_zinteger
,
4306 (char *) &remote_debug
,
4307 "Set debugging of remote protocol.\n\
4308 When enabled, each packet sent or received with the remote target\n\
4309 is displayed.", &setdebuglist
),
4313 add_set_cmd ("remotetimeout", no_class
, var_integer
, (char *) &remote_timeout
,
4314 "Set timeout limit to wait for target to respond.\n\
4315 This value is used to set the time limit for gdb to wait for a response\n\
4316 from the target.", &setlist
),
4319 /* The set annotate command is different depending whether or not
4320 the async version is run. NOTE: this difference is going to
4321 disappear as we make the event loop be the default engine of
4325 c
= add_set_cmd ("annotate", class_obscure
, var_zinteger
,
4326 (char *) &annotation_level
, "Set annotation_level.\n\
4327 0 == normal; 1 == fullname (for use when running under emacs)\n\
4328 2 == output annotated suitably for use by programs that control GDB.",
4330 c
= add_show_from_set (c
, &showlist
);
4334 c
= add_set_cmd ("annotate", class_obscure
, var_zinteger
,
4335 (char *) &annotation_level
, "Set annotation_level.\n\
4336 0 == normal; 1 == fullname (for use when running under emacs)\n\
4337 2 == output annotated suitably for use by programs that control GDB.",
4339 add_show_from_set (c
, &showlist
);
4340 c
->function
.sfunc
= set_async_annotation_level
;
4345 (add_set_cmd ("exec-done-display", class_support
, var_boolean
, (char *) &exec_done_display_p
,
4346 "Set notification of completion for asynchronous execution commands.\n\
4347 Use \"on\" to enable the notification, and \"off\" to disable it.", &setlist
),
4350 add_prefix_cmd ("debug", no_class
, set_debug
,
4351 "Generic command for setting gdb debugging flags",
4352 &setdebuglist
, "set debug ", 0, &setlist
);
4354 add_prefix_cmd ("debug", no_class
, show_debug
,
4355 "Generic command for showing gdb debugging flags",
4356 &showdebuglist
, "show debug ", 0, &showlist
);