* NEWS: Add info macros and info definitions commands.
[deliverable/binutils-gdb.git] / gdb / utils.c
CommitLineData
c906108c 1/* General utility routines for GDB, the GNU debugger.
1bac305b 2
6aba47ca 3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
0fb0cc75 4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
7b6bb8da 5 2009, 2010, 2011 Free Software Foundation, Inc.
c906108c 6
c5aa993b 7 This file is part of GDB.
c906108c 8
c5aa993b
JM
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
c5aa993b 12 (at your option) any later version.
c906108c 13
c5aa993b
JM
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
c906108c 18
c5aa993b 19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c 21
4e8f7a8b
DJ
22#include "defs.h"
23#include "gdb_assert.h"
24#include <ctype.h>
25#include "gdb_string.h"
26#include "event-top.h"
60250e8b 27#include "exceptions.h"
95e54da7 28#include "gdbthread.h"
7991dee7
JK
29#ifdef HAVE_SYS_RESOURCE_H
30#include <sys/resource.h>
31#endif /* HAVE_SYS_RESOURCE_H */
4e8f7a8b 32
6a83354a
AC
33#ifdef TUI
34#include "tui/tui.h" /* For tui_get_command_dimension. */
35#endif
36
9d271fd8
AC
37#ifdef __GO32__
38#include <pc.h>
39#endif
40
581e13c1 41/* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
c906108c
SS
42#ifdef reg
43#undef reg
44#endif
45
042be3a9 46#include <signal.h>
c906108c
SS
47#include "gdbcmd.h"
48#include "serial.h"
49#include "bfd.h"
50#include "target.h"
51#include "demangle.h"
52#include "expression.h"
53#include "language.h"
234b45d4 54#include "charset.h"
c906108c 55#include "annotate.h"
303c8ebd 56#include "filenames.h"
7b90c3f9 57#include "symfile.h"
ae5a43e0 58#include "gdb_obstack.h"
9544c605 59#include "gdbcore.h"
698ba934 60#include "top.h"
7c953934 61#include "main.h"
c906108c 62
8731e58e 63#include "inferior.h" /* for signed_pointer_to_address */
ac2e2ef7 64
2d1b2124
AC
65#include <sys/param.h> /* For MAXPATHLEN */
66
3b78cdbb 67#include "gdb_curses.h"
020cc13c 68
dbda9972 69#include "readline/readline.h"
c906108c 70
75feb17d
DJ
71#include <sys/time.h>
72#include <time.h>
73
8626589c 74#include "gdb_usleep.h"
390a8aca 75#include "interps.h"
dc92e161 76#include "gdb_regex.h"
8626589c 77
a3828db0 78#if !HAVE_DECL_MALLOC
5ac79d78 79extern PTR malloc (); /* ARI: PTR */
3c37485b 80#endif
a3828db0 81#if !HAVE_DECL_REALLOC
5ac79d78 82extern PTR realloc (); /* ARI: PTR */
0e52036f 83#endif
a3828db0 84#if !HAVE_DECL_FREE
81b8eb80
AC
85extern void free ();
86#endif
81b8eb80 87
c906108c
SS
88/* readline defines this. */
89#undef savestring
90
9a4105ab 91void (*deprecated_error_begin_hook) (void);
c906108c
SS
92
93/* Prototypes for local functions */
94
d9fcf2fb 95static void vfprintf_maybe_filtered (struct ui_file *, const char *,
a0b31db1 96 va_list, int) ATTRIBUTE_PRINTF (2, 0);
c906108c 97
d9fcf2fb 98static void fputs_maybe_filtered (const char *, struct ui_file *, int);
c906108c 99
e42c9534
AC
100static void do_my_cleanups (struct cleanup **, struct cleanup *);
101
a14ed312 102static void prompt_for_continue (void);
c906108c 103
eb0d3137 104static void set_screen_size (void);
a14ed312 105static void set_width (void);
c906108c 106
75feb17d
DJ
107/* A flag indicating whether to timestamp debugging messages. */
108
109static int debug_timestamp = 0;
110
c906108c
SS
111/* Chain of cleanup actions established with make_cleanup,
112 to be executed if an error happens. */
113
c5aa993b
JM
114static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
115static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
43ff13b4 116
581e13c1 117/* Nonzero if we have job control. */
c906108c
SS
118
119int job_control;
120
121/* Nonzero means a quit has been requested. */
122
123int quit_flag;
124
125/* Nonzero means quit immediately if Control-C is typed now, rather
126 than waiting until QUIT is executed. Be careful in setting this;
127 code which executes with immediate_quit set has to be very careful
128 about being able to deal with being interrupted at any time. It is
129 almost always better to use QUIT; the only exception I can think of
130 is being able to quit out of a system call (using EINTR loses if
131 the SIGINT happens between the previous QUIT and the system call).
132 To immediately quit in the case in which a SIGINT happens between
133 the previous QUIT and setting immediate_quit (desirable anytime we
134 expect to block), call QUIT after setting immediate_quit. */
135
136int immediate_quit;
137
4a351cef
AF
138/* Nonzero means that encoded C++/ObjC names should be printed out in their
139 C++/ObjC form rather than raw. */
c906108c
SS
140
141int demangle = 1;
920d2a44
AC
142static void
143show_demangle (struct ui_file *file, int from_tty,
144 struct cmd_list_element *c, const char *value)
145{
3e43a32a
MS
146 fprintf_filtered (file,
147 _("Demangling of encoded C++/ObjC names "
148 "when displaying symbols is %s.\n"),
920d2a44
AC
149 value);
150}
c906108c 151
4a351cef
AF
152/* Nonzero means that encoded C++/ObjC names should be printed out in their
153 C++/ObjC form even in assembler language displays. If this is set, but
c906108c
SS
154 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
155
156int asm_demangle = 0;
920d2a44
AC
157static void
158show_asm_demangle (struct ui_file *file, int from_tty,
159 struct cmd_list_element *c, const char *value)
160{
3e43a32a
MS
161 fprintf_filtered (file,
162 _("Demangling of C++/ObjC names in "
163 "disassembly listings is %s.\n"),
920d2a44
AC
164 value);
165}
c906108c
SS
166
167/* Nonzero means that strings with character values >0x7F should be printed
168 as octal escapes. Zero means just print the value (e.g. it's an
169 international character, and the terminal or window can cope.) */
170
171int sevenbit_strings = 0;
920d2a44
AC
172static void
173show_sevenbit_strings (struct ui_file *file, int from_tty,
174 struct cmd_list_element *c, const char *value)
175{
3e43a32a
MS
176 fprintf_filtered (file, _("Printing of 8-bit characters "
177 "in strings as \\nnn is %s.\n"),
920d2a44
AC
178 value);
179}
c906108c
SS
180
181/* String to be printed before error messages, if any. */
182
183char *error_pre_print;
184
185/* String to be printed before quit messages, if any. */
186
187char *quit_pre_print;
188
189/* String to be printed before warning messages, if any. */
190
191char *warning_pre_print = "\nwarning: ";
192
193int pagination_enabled = 1;
920d2a44
AC
194static void
195show_pagination_enabled (struct ui_file *file, int from_tty,
196 struct cmd_list_element *c, const char *value)
197{
198 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
199}
200
c906108c 201\f
c5aa993b 202
c906108c
SS
203/* Add a new cleanup to the cleanup_chain,
204 and return the previous chain pointer
205 to be passed later to do_cleanups or discard_cleanups.
206 Args are FUNCTION to clean up with, and ARG to pass to it. */
207
208struct cleanup *
e4005526 209make_cleanup (make_cleanup_ftype *function, void *arg)
c906108c 210{
c5aa993b 211 return make_my_cleanup (&cleanup_chain, function, arg);
c906108c
SS
212}
213
4f8d22e3
PA
214struct cleanup *
215make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
216 void (*dtor) (void *))
217{
218 return make_my_cleanup2 (&cleanup_chain,
219 function, arg, dtor);
220}
221
c906108c 222struct cleanup *
e4005526 223make_final_cleanup (make_cleanup_ftype *function, void *arg)
c906108c 224{
c5aa993b 225 return make_my_cleanup (&final_cleanup_chain, function, arg);
c906108c 226}
7a292a7a 227
7a292a7a 228static void
fba45db2 229do_freeargv (void *arg)
7a292a7a 230{
c5aa993b 231 freeargv ((char **) arg);
7a292a7a
SS
232}
233
234struct cleanup *
fba45db2 235make_cleanup_freeargv (char **arg)
7a292a7a
SS
236{
237 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
238}
239
5c65bbb6
AC
240static void
241do_bfd_close_cleanup (void *arg)
242{
243 bfd_close (arg);
244}
245
246struct cleanup *
247make_cleanup_bfd_close (bfd *abfd)
248{
249 return make_cleanup (do_bfd_close_cleanup, abfd);
250}
251
f5ff8c83
AC
252static void
253do_close_cleanup (void *arg)
254{
f042532c 255 int *fd = arg;
e0627e85 256
f042532c 257 close (*fd);
f5ff8c83
AC
258}
259
260struct cleanup *
261make_cleanup_close (int fd)
262{
f042532c 263 int *saved_fd = xmalloc (sizeof (fd));
e0627e85 264
f042532c 265 *saved_fd = fd;
a05016c0 266 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
f5ff8c83
AC
267}
268
7c8a8b04
TT
269/* Helper function which does the work for make_cleanup_fclose. */
270
271static void
272do_fclose_cleanup (void *arg)
273{
c02866a0 274 FILE *file = arg;
e0627e85 275
c02866a0 276 fclose (file);
7c8a8b04
TT
277}
278
279/* Return a new cleanup that closes FILE. */
280
281struct cleanup *
282make_cleanup_fclose (FILE *file)
283{
284 return make_cleanup (do_fclose_cleanup, file);
285}
286
16ad9370
TT
287/* Helper function which does the work for make_cleanup_obstack_free. */
288
289static void
290do_obstack_free (void *arg)
291{
292 struct obstack *ob = arg;
e0627e85 293
16ad9370
TT
294 obstack_free (ob, NULL);
295}
296
297/* Return a new cleanup that frees OBSTACK. */
298
299struct cleanup *
300make_cleanup_obstack_free (struct obstack *obstack)
301{
302 return make_cleanup (do_obstack_free, obstack);
303}
304
11cf8741 305static void
d9fcf2fb 306do_ui_file_delete (void *arg)
11cf8741 307{
d9fcf2fb 308 ui_file_delete (arg);
11cf8741
JM
309}
310
311struct cleanup *
d9fcf2fb 312make_cleanup_ui_file_delete (struct ui_file *arg)
11cf8741 313{
d9fcf2fb 314 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
11cf8741
JM
315}
316
8d4d924b
JK
317/* Helper function for make_cleanup_ui_out_redirect_pop. */
318
319static void
320do_ui_out_redirect_pop (void *arg)
321{
322 struct ui_out *uiout = arg;
323
324 if (ui_out_redirect (uiout, NULL) < 0)
325 warning (_("Cannot restore redirection of the current output protocol"));
326}
327
328/* Return a new cleanup that pops the last redirection by ui_out_redirect
329 with NULL parameter. */
330
331struct cleanup *
332make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
333{
334 return make_my_cleanup (&cleanup_chain, do_ui_out_redirect_pop, uiout);
335}
336
7b90c3f9
JB
337static void
338do_free_section_addr_info (void *arg)
339{
340 free_section_addr_info (arg);
341}
342
343struct cleanup *
344make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
345{
346 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
347}
348
0b080f59
VP
349struct restore_integer_closure
350{
351 int *variable;
352 int value;
353};
354
355static void
356restore_integer (void *p)
357{
358 struct restore_integer_closure *closure = p;
e0627e85 359
0b080f59
VP
360 *(closure->variable) = closure->value;
361}
7b90c3f9 362
3e43a32a
MS
363/* Remember the current value of *VARIABLE and make it restored when
364 the cleanup is run. */
5da1313b 365
c906108c 366struct cleanup *
0b080f59
VP
367make_cleanup_restore_integer (int *variable)
368{
369 struct restore_integer_closure *c =
370 xmalloc (sizeof (struct restore_integer_closure));
e0627e85 371
0b080f59
VP
372 c->variable = variable;
373 c->value = *variable;
374
375 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
376 xfree);
377}
378
3e43a32a
MS
379/* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
5da1313b
JK
381
382struct cleanup *
383make_cleanup_restore_uinteger (unsigned int *variable)
384{
385 return make_cleanup_restore_integer ((int *) variable);
386}
387
c0edd9ed
JK
388/* Helper for make_cleanup_unpush_target. */
389
390static void
391do_unpush_target (void *arg)
392{
393 struct target_ops *ops = arg;
394
395 unpush_target (ops);
396}
397
398/* Return a new cleanup that unpushes OPS. */
399
400struct cleanup *
401make_cleanup_unpush_target (struct target_ops *ops)
402{
403 return make_my_cleanup (&cleanup_chain, do_unpush_target, ops);
404}
405
5da1313b
JK
406struct restore_ui_file_closure
407{
408 struct ui_file **variable;
409 struct ui_file *value;
410};
411
412static void
413do_restore_ui_file (void *p)
414{
415 struct restore_ui_file_closure *closure = p;
416
417 *(closure->variable) = closure->value;
418}
419
420/* Remember the current value of *VARIABLE and make it restored when
421 the cleanup is run. */
422
423struct cleanup *
424make_cleanup_restore_ui_file (struct ui_file **variable)
425{
426 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
427
428 c->variable = variable;
429 c->value = *variable;
430
431 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
432}
433
028d0ed5
TJB
434/* Helper for make_cleanup_value_free_to_mark. */
435
436static void
437do_value_free_to_mark (void *value)
438{
439 value_free_to_mark ((struct value *) value);
440}
441
442/* Free all values allocated since MARK was obtained by value_mark
443 (except for those released) when the cleanup is run. */
444
445struct cleanup *
446make_cleanup_value_free_to_mark (struct value *mark)
447{
448 return make_my_cleanup (&cleanup_chain, do_value_free_to_mark, mark);
449}
450
72fc29ff
TT
451/* Helper for make_cleanup_value_free. */
452
453static void
454do_value_free (void *value)
455{
456 value_free (value);
457}
458
459/* Free VALUE. */
460
461struct cleanup *
462make_cleanup_value_free (struct value *value)
463{
464 return make_my_cleanup (&cleanup_chain, do_value_free, value);
465}
466
0b080f59
VP
467struct cleanup *
468make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
469 void *arg, void (*free_arg) (void *))
c906108c 470{
52f0bd74 471 struct cleanup *new
8731e58e 472 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
52f0bd74 473 struct cleanup *old_chain = *pmy_chain;
c906108c
SS
474
475 new->next = *pmy_chain;
476 new->function = function;
0b080f59 477 new->free_arg = free_arg;
c906108c
SS
478 new->arg = arg;
479 *pmy_chain = new;
480
481 return old_chain;
482}
483
0b080f59
VP
484struct cleanup *
485make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
486 void *arg)
487{
488 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
489}
490
c906108c
SS
491/* Discard cleanups and do the actions they describe
492 until we get back to the point OLD_CHAIN in the cleanup_chain. */
493
494void
aa1ee363 495do_cleanups (struct cleanup *old_chain)
c906108c 496{
c5aa993b 497 do_my_cleanups (&cleanup_chain, old_chain);
c906108c
SS
498}
499
500void
aa1ee363 501do_final_cleanups (struct cleanup *old_chain)
c906108c 502{
c5aa993b 503 do_my_cleanups (&final_cleanup_chain, old_chain);
c906108c
SS
504}
505
e42c9534 506static void
aa1ee363
AC
507do_my_cleanups (struct cleanup **pmy_chain,
508 struct cleanup *old_chain)
c906108c 509{
52f0bd74 510 struct cleanup *ptr;
e0627e85 511
c906108c
SS
512 while ((ptr = *pmy_chain) != old_chain)
513 {
5f2302ab 514 *pmy_chain = ptr->next; /* Do this first in case of recursion. */
c906108c 515 (*ptr->function) (ptr->arg);
0b080f59
VP
516 if (ptr->free_arg)
517 (*ptr->free_arg) (ptr->arg);
b8c9b27d 518 xfree (ptr);
c906108c
SS
519 }
520}
521
522/* Discard cleanups, not doing the actions they describe,
523 until we get back to the point OLD_CHAIN in the cleanup_chain. */
524
525void
aa1ee363 526discard_cleanups (struct cleanup *old_chain)
c906108c 527{
c5aa993b 528 discard_my_cleanups (&cleanup_chain, old_chain);
c906108c
SS
529}
530
531void
aa1ee363 532discard_final_cleanups (struct cleanup *old_chain)
c906108c 533{
c5aa993b 534 discard_my_cleanups (&final_cleanup_chain, old_chain);
c906108c
SS
535}
536
537void
aa1ee363
AC
538discard_my_cleanups (struct cleanup **pmy_chain,
539 struct cleanup *old_chain)
c906108c 540{
52f0bd74 541 struct cleanup *ptr;
e0627e85 542
c906108c
SS
543 while ((ptr = *pmy_chain) != old_chain)
544 {
545 *pmy_chain = ptr->next;
0b080f59
VP
546 if (ptr->free_arg)
547 (*ptr->free_arg) (ptr->arg);
b8c9b27d 548 xfree (ptr);
c906108c
SS
549 }
550}
551
552/* Set the cleanup_chain to 0, and return the old cleanup chain. */
553struct cleanup *
fba45db2 554save_cleanups (void)
c906108c 555{
c5aa993b 556 return save_my_cleanups (&cleanup_chain);
c906108c
SS
557}
558
559struct cleanup *
fba45db2 560save_final_cleanups (void)
c906108c 561{
c5aa993b 562 return save_my_cleanups (&final_cleanup_chain);
c906108c
SS
563}
564
565struct cleanup *
fba45db2 566save_my_cleanups (struct cleanup **pmy_chain)
c906108c
SS
567{
568 struct cleanup *old_chain = *pmy_chain;
569
570 *pmy_chain = 0;
571 return old_chain;
572}
573
574/* Restore the cleanup chain from a previously saved chain. */
575void
fba45db2 576restore_cleanups (struct cleanup *chain)
c906108c 577{
c5aa993b 578 restore_my_cleanups (&cleanup_chain, chain);
c906108c
SS
579}
580
581void
fba45db2 582restore_final_cleanups (struct cleanup *chain)
c906108c 583{
c5aa993b 584 restore_my_cleanups (&final_cleanup_chain, chain);
c906108c
SS
585}
586
587void
fba45db2 588restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
c906108c
SS
589{
590 *pmy_chain = chain;
591}
592
593/* This function is useful for cleanups.
594 Do
595
c5aa993b
JM
596 foo = xmalloc (...);
597 old_chain = make_cleanup (free_current_contents, &foo);
c906108c
SS
598
599 to arrange to free the object thus allocated. */
600
601void
2f9429ae 602free_current_contents (void *ptr)
c906108c 603{
2f9429ae 604 void **location = ptr;
e0627e85 605
e2f9c474 606 if (location == NULL)
8e65ff28 607 internal_error (__FILE__, __LINE__,
e2e0b3e5 608 _("free_current_contents: NULL pointer"));
2f9429ae 609 if (*location != NULL)
e2f9c474 610 {
b8c9b27d 611 xfree (*location);
e2f9c474
AC
612 *location = NULL;
613 }
c906108c
SS
614}
615
616/* Provide a known function that does nothing, to use as a base for
7a9dd1b2 617 a possibly long chain of cleanups. This is useful where we
c906108c
SS
618 use the cleanup chain for handling normal cleanups as well as dealing
619 with cleanups that need to be done as a result of a call to error().
620 In such cases, we may not be certain where the first cleanup is, unless
581e13c1 621 we have a do-nothing one to always use as the base. */
c906108c 622
c906108c 623void
e4005526 624null_cleanup (void *arg)
c906108c
SS
625{
626}
627
0f3bb72e
PH
628/* If nonzero, display time usage both at startup and for each command. */
629
630static int display_time;
631
632/* If nonzero, display space usage both at startup and for each command. */
633
634static int display_space;
635
636/* Records a run time and space usage to be used as a base for
637 reporting elapsed time or change in space. In addition,
638 the msg_type field indicates whether the saved time is from the
639 beginning of GDB execution (0) or the beginning of an individual
640 command execution (1). */
641struct cmd_stats
642{
643 int msg_type;
644 long start_time;
645 long start_space;
646};
647
648/* Set whether to display time statistics to NEW_VALUE (non-zero
649 means true). */
650void
651set_display_time (int new_value)
652{
653 display_time = new_value;
654}
655
656/* Set whether to display space statistics to NEW_VALUE (non-zero
657 means true). */
658void
659set_display_space (int new_value)
660{
661 display_space = new_value;
662}
663
664/* As indicated by display_time and display_space, report GDB's elapsed time
665 and space usage from the base time and space provided in ARG, which
581e13c1
MS
666 must be a pointer to a struct cmd_stat. This function is intended
667 to be called as a cleanup. */
0f3bb72e
PH
668static void
669report_command_stats (void *arg)
670{
671 struct cmd_stats *start_stats = (struct cmd_stats *) arg;
672 int msg_type = start_stats->msg_type;
673
674 if (display_time)
675 {
676 long cmd_time = get_run_time () - start_stats->start_time;
677
678 printf_unfiltered (msg_type == 0
679 ? _("Startup time: %ld.%06ld\n")
680 : _("Command execution time: %ld.%06ld\n"),
681 cmd_time / 1000000, cmd_time % 1000000);
682 }
683
684 if (display_space)
685 {
686#ifdef HAVE_SBRK
687 char *lim = (char *) sbrk (0);
688
689 long space_now = lim - lim_at_start;
690 long space_diff = space_now - start_stats->start_space;
691
692 printf_unfiltered (msg_type == 0
5d901a73
TT
693 ? _("Space used: %ld (%s%ld during startup)\n")
694 : _("Space used: %ld (%s%ld for this command)\n"),
0f3bb72e 695 space_now,
5d901a73 696 (space_diff >= 0 ? "+" : ""),
0f3bb72e
PH
697 space_diff);
698#endif
699 }
700}
701
702/* Create a cleanup that reports time and space used since its
703 creation. Precise messages depend on MSG_TYPE:
704 0: Initial time/space
705 1: Individual command time/space. */
706struct cleanup *
707make_command_stats_cleanup (int msg_type)
708{
709 struct cmd_stats *new_stat = XMALLOC (struct cmd_stats);
710
711#ifdef HAVE_SBRK
712 char *lim = (char *) sbrk (0);
713 new_stat->start_space = lim - lim_at_start;
714#endif
715
716 new_stat->msg_type = msg_type;
717 new_stat->start_time = get_run_time ();
718
719 return make_cleanup_dtor (report_command_stats, new_stat, xfree);
720}
c906108c 721\f
c5aa993b 722
8731e58e 723
f5a96129
AC
724/* Print a warning message. The first argument STRING is the warning
725 message, used as an fprintf format string, the second is the
726 va_list of arguments for that string. A warning is unfiltered (not
727 paginated) so that the user does not need to page through each
728 screen full of warnings when there are lots of them. */
c906108c
SS
729
730void
f5a96129 731vwarning (const char *string, va_list args)
c906108c 732{
9a4105ab
AC
733 if (deprecated_warning_hook)
734 (*deprecated_warning_hook) (string, args);
f5a96129
AC
735 else
736 {
737 target_terminal_ours ();
581e13c1 738 wrap_here (""); /* Force out any buffered output. */
f5a96129
AC
739 gdb_flush (gdb_stdout);
740 if (warning_pre_print)
306d9ac5 741 fputs_unfiltered (warning_pre_print, gdb_stderr);
f5a96129
AC
742 vfprintf_unfiltered (gdb_stderr, string, args);
743 fprintf_unfiltered (gdb_stderr, "\n");
744 va_end (args);
745 }
c906108c
SS
746}
747
748/* Print a warning message.
749 The first argument STRING is the warning message, used as a fprintf string,
750 and the remaining args are passed as arguments to it.
751 The primary difference between warnings and errors is that a warning
752 does not force the return to command level. */
753
c906108c 754void
8731e58e 755warning (const char *string, ...)
c906108c
SS
756{
757 va_list args;
e0627e85 758
c906108c 759 va_start (args, string);
f5a96129
AC
760 vwarning (string, args);
761 va_end (args);
c906108c
SS
762}
763
c906108c
SS
764/* Print an error message and return to command level.
765 The first argument STRING is the error message, used as a fprintf string,
766 and the remaining args are passed as arguments to it. */
767
c25c4a8b 768void
4ce44c66
JM
769verror (const char *string, va_list args)
770{
6b1b7650 771 throw_verror (GENERIC_ERROR, string, args);
4ce44c66
JM
772}
773
c25c4a8b 774void
8731e58e 775error (const char *string, ...)
c906108c
SS
776{
777 va_list args;
e0627e85 778
c906108c 779 va_start (args, string);
6b1b7650 780 throw_verror (GENERIC_ERROR, string, args);
4ce44c66 781 va_end (args);
c906108c
SS
782}
783
d75e3c94
JJ
784/* Print an error message and quit.
785 The first argument STRING is the error message, used as a fprintf string,
786 and the remaining args are passed as arguments to it. */
787
c25c4a8b 788void
d75e3c94
JJ
789vfatal (const char *string, va_list args)
790{
6b1b7650 791 throw_vfatal (string, args);
d75e3c94
JJ
792}
793
c25c4a8b 794void
d75e3c94
JJ
795fatal (const char *string, ...)
796{
797 va_list args;
e0627e85 798
d75e3c94 799 va_start (args, string);
6b1b7650 800 throw_vfatal (string, args);
d75e3c94
JJ
801 va_end (args);
802}
803
c25c4a8b 804void
d75e3c94 805error_stream (struct ui_file *stream)
2acceee2 806{
759ef836 807 char *message = ui_file_xstrdup (stream, NULL);
e0627e85 808
6b1b7650 809 make_cleanup (xfree, message);
8a3fe4f8 810 error (("%s"), message);
2acceee2 811}
c906108c 812
7991dee7
JK
813/* Dump core trying to increase the core soft limit to hard limit first. */
814
815static void
816dump_core (void)
817{
818#ifdef HAVE_SETRLIMIT
819 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
820
821 setrlimit (RLIMIT_CORE, &rlim);
822#endif /* HAVE_SETRLIMIT */
823
824 abort (); /* NOTE: GDB has only three calls to abort(). */
825}
826
3e43a32a
MS
827/* Check whether GDB will be able to dump core using the dump_core
828 function. */
7991dee7
JK
829
830static int
831can_dump_core (const char *reason)
832{
833#ifdef HAVE_GETRLIMIT
834 struct rlimit rlim;
835
836 /* Be quiet and assume we can dump if an error is returned. */
837 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
838 return 1;
839
840 if (rlim.rlim_max == 0)
841 {
842 fprintf_unfiltered (gdb_stderr,
3e43a32a
MS
843 _("%s\nUnable to dump core, use `ulimit -c"
844 " unlimited' before executing GDB next time.\n"),
845 reason);
7991dee7
JK
846 return 0;
847 }
848#endif /* HAVE_GETRLIMIT */
849
850 return 1;
851}
852
3c16cced
PA
853/* Allow the user to configure the debugger behavior with respect to
854 what to do when an internal problem is detected. */
855
856const char internal_problem_ask[] = "ask";
857const char internal_problem_yes[] = "yes";
858const char internal_problem_no[] = "no";
859static const char *internal_problem_modes[] =
860{
861 internal_problem_ask,
862 internal_problem_yes,
863 internal_problem_no,
864 NULL
865};
3c16cced 866
581e13c1 867/* Print a message reporting an internal error/warning. Ask the user
dec43320
AC
868 if they want to continue, dump core, or just exit. Return
869 something to indicate a quit. */
c906108c 870
dec43320 871struct internal_problem
c906108c 872{
dec43320 873 const char *name;
3c16cced
PA
874 const char *should_quit;
875 const char *should_dump_core;
dec43320
AC
876};
877
878/* Report a problem, internal to GDB, to the user. Once the problem
879 has been reported, and assuming GDB didn't quit, the caller can
880 either allow execution to resume or throw an error. */
881
a0b31db1 882static void ATTRIBUTE_PRINTF (4, 0)
dec43320 883internal_vproblem (struct internal_problem *problem,
8731e58e 884 const char *file, int line, const char *fmt, va_list ap)
dec43320 885{
dec43320 886 static int dejavu;
375fc983 887 int quit_p;
7be570e7 888 int dump_core_p;
714b1282 889 char *reason;
c906108c 890
dec43320 891 /* Don't allow infinite error/warning recursion. */
714b1282
AC
892 {
893 static char msg[] = "Recursive internal problem.\n";
5d502164 894
714b1282
AC
895 switch (dejavu)
896 {
897 case 0:
898 dejavu = 1;
899 break;
900 case 1:
901 dejavu = 2;
902 fputs_unfiltered (msg, gdb_stderr);
7991dee7 903 abort (); /* NOTE: GDB has only three calls to abort(). */
714b1282
AC
904 default:
905 dejavu = 3;
bf1d7d9c
JB
906 /* Newer GLIBC versions put the warn_unused_result attribute
907 on write, but this is one of those rare cases where
908 ignoring the return value is correct. Casting to (void)
909 does not fix this problem. This is the solution suggested
910 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
911 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
7991dee7 912 abort (); /* NOTE: GDB has only three calls to abort(). */
714b1282
AC
913 exit (1);
914 }
915 }
c906108c 916
dec43320 917 /* Try to get the message out and at the start of a new line. */
4261bedc 918 target_terminal_ours ();
dec43320
AC
919 begin_line ();
920
714b1282
AC
921 /* Create a string containing the full error/warning message. Need
922 to call query with this full string, as otherwize the reason
923 (error/warning) and question become separated. Format using a
924 style similar to a compiler error message. Include extra detail
925 so that the user knows that they are living on the edge. */
926 {
927 char *msg;
5d502164 928
e623b504 929 msg = xstrvprintf (fmt, ap);
3e43a32a
MS
930 reason = xstrprintf ("%s:%d: %s: %s\n"
931 "A problem internal to GDB has been detected,\n"
932 "further debugging may prove unreliable.",
933 file, line, problem->name, msg);
714b1282
AC
934 xfree (msg);
935 make_cleanup (xfree, reason);
936 }
7be570e7 937
3c16cced 938 if (problem->should_quit == internal_problem_ask)
dec43320 939 {
dec43320 940 /* Default (yes/batch case) is to quit GDB. When in batch mode
3c16cced
PA
941 this lessens the likelihood of GDB going into an infinite
942 loop. */
26bb68be
PP
943 if (caution == 0)
944 {
945 /* Emit the message and quit. */
946 fputs_unfiltered (reason, gdb_stderr);
947 fputs_unfiltered ("\n", gdb_stderr);
948 quit_p = 1;
949 }
950 else
951 quit_p = query (_("%s\nQuit this debugging session? "), reason);
dec43320 952 }
3c16cced
PA
953 else if (problem->should_quit == internal_problem_yes)
954 quit_p = 1;
955 else if (problem->should_quit == internal_problem_no)
956 quit_p = 0;
957 else
958 internal_error (__FILE__, __LINE__, _("bad switch"));
dec43320 959
3c16cced 960 if (problem->should_dump_core == internal_problem_ask)
dec43320 961 {
7991dee7
JK
962 if (!can_dump_core (reason))
963 dump_core_p = 0;
964 else
965 {
966 /* Default (yes/batch case) is to dump core. This leaves a GDB
967 `dropping' so that it is easier to see that something went
968 wrong in GDB. */
969 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
970 }
dec43320 971 }
3c16cced 972 else if (problem->should_dump_core == internal_problem_yes)
7991dee7 973 dump_core_p = can_dump_core (reason);
3c16cced
PA
974 else if (problem->should_dump_core == internal_problem_no)
975 dump_core_p = 0;
976 else
977 internal_error (__FILE__, __LINE__, _("bad switch"));
7be570e7 978
375fc983 979 if (quit_p)
7be570e7
JM
980 {
981 if (dump_core_p)
7991dee7 982 dump_core ();
375fc983
AC
983 else
984 exit (1);
7be570e7
JM
985 }
986 else
987 {
988 if (dump_core_p)
375fc983 989 {
9b265ec2 990#ifdef HAVE_WORKING_FORK
375fc983 991 if (fork () == 0)
7991dee7 992 dump_core ();
9b265ec2 993#endif
375fc983 994 }
7be570e7 995 }
96baa820
JM
996
997 dejavu = 0;
dec43320
AC
998}
999
1000static struct internal_problem internal_error_problem = {
3c16cced 1001 "internal-error", internal_problem_ask, internal_problem_ask
dec43320
AC
1002};
1003
c25c4a8b 1004void
8731e58e 1005internal_verror (const char *file, int line, const char *fmt, va_list ap)
dec43320
AC
1006{
1007 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
315a522e 1008 deprecated_throw_reason (RETURN_ERROR);
c906108c
SS
1009}
1010
c25c4a8b 1011void
8e65ff28 1012internal_error (const char *file, int line, const char *string, ...)
4ce44c66
JM
1013{
1014 va_list ap;
e0627e85 1015
4ce44c66 1016 va_start (ap, string);
8e65ff28 1017 internal_verror (file, line, string, ap);
4ce44c66
JM
1018 va_end (ap);
1019}
1020
dec43320 1021static struct internal_problem internal_warning_problem = {
3c16cced 1022 "internal-warning", internal_problem_ask, internal_problem_ask
dec43320
AC
1023};
1024
1025void
8731e58e 1026internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
dec43320
AC
1027{
1028 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1029}
1030
1031void
1032internal_warning (const char *file, int line, const char *string, ...)
1033{
1034 va_list ap;
e0627e85 1035
dec43320
AC
1036 va_start (ap, string);
1037 internal_vwarning (file, line, string, ap);
1038 va_end (ap);
1039}
1040
3c16cced
PA
1041/* Dummy functions to keep add_prefix_cmd happy. */
1042
1043static void
1044set_internal_problem_cmd (char *args, int from_tty)
1045{
1046}
1047
1048static void
1049show_internal_problem_cmd (char *args, int from_tty)
1050{
1051}
1052
1053/* When GDB reports an internal problem (error or warning) it gives
1054 the user the opportunity to quit GDB and/or create a core file of
1055 the current debug session. This function registers a few commands
1056 that make it possible to specify that GDB should always or never
1057 quit or create a core file, without asking. The commands look
1058 like:
1059
1060 maint set PROBLEM-NAME quit ask|yes|no
1061 maint show PROBLEM-NAME quit
1062 maint set PROBLEM-NAME corefile ask|yes|no
1063 maint show PROBLEM-NAME corefile
1064
1065 Where PROBLEM-NAME is currently "internal-error" or
1066 "internal-warning". */
1067
1068static void
1069add_internal_problem_command (struct internal_problem *problem)
1070{
1071 struct cmd_list_element **set_cmd_list;
1072 struct cmd_list_element **show_cmd_list;
1073 char *set_doc;
1074 char *show_doc;
1075
1076 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1077 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1078 *set_cmd_list = NULL;
1079 *show_cmd_list = NULL;
1080
1081 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1082 problem->name);
1083
1084 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1085 problem->name);
1086
1087 add_prefix_cmd ((char*) problem->name,
1088 class_maintenance, set_internal_problem_cmd, set_doc,
1089 set_cmd_list,
c4f7c687
MK
1090 concat ("maintenance set ", problem->name, " ",
1091 (char *) NULL),
3c16cced
PA
1092 0/*allow-unknown*/, &maintenance_set_cmdlist);
1093
1094 add_prefix_cmd ((char*) problem->name,
1095 class_maintenance, show_internal_problem_cmd, show_doc,
1096 show_cmd_list,
c4f7c687
MK
1097 concat ("maintenance show ", problem->name, " ",
1098 (char *) NULL),
3c16cced
PA
1099 0/*allow-unknown*/, &maintenance_show_cmdlist);
1100
3e43a32a
MS
1101 set_doc = xstrprintf (_("Set whether GDB should quit "
1102 "when an %s is detected"),
3c16cced 1103 problem->name);
3e43a32a
MS
1104 show_doc = xstrprintf (_("Show whether GDB will quit "
1105 "when an %s is detected"),
3c16cced
PA
1106 problem->name);
1107 add_setshow_enum_cmd ("quit", class_maintenance,
1108 internal_problem_modes,
1109 &problem->should_quit,
1110 set_doc,
1111 show_doc,
1112 NULL, /* help_doc */
1113 NULL, /* setfunc */
1114 NULL, /* showfunc */
1115 set_cmd_list,
1116 show_cmd_list);
1117
1eefb858
TT
1118 xfree (set_doc);
1119 xfree (show_doc);
1120
3e43a32a
MS
1121 set_doc = xstrprintf (_("Set whether GDB should create a core "
1122 "file of GDB when %s is detected"),
3c16cced 1123 problem->name);
3e43a32a
MS
1124 show_doc = xstrprintf (_("Show whether GDB will create a core "
1125 "file of GDB when %s is detected"),
3c16cced
PA
1126 problem->name);
1127 add_setshow_enum_cmd ("corefile", class_maintenance,
1128 internal_problem_modes,
1129 &problem->should_dump_core,
1130 set_doc,
1131 show_doc,
1132 NULL, /* help_doc */
1133 NULL, /* setfunc */
1134 NULL, /* showfunc */
1135 set_cmd_list,
1136 show_cmd_list);
1eefb858
TT
1137
1138 xfree (set_doc);
1139 xfree (show_doc);
3c16cced
PA
1140}
1141
c906108c
SS
1142/* Print the system error message for errno, and also mention STRING
1143 as the file name for which the error was encountered.
1144 Then return to command level. */
1145
c25c4a8b 1146void
6972bc8b 1147perror_with_name (const char *string)
c906108c
SS
1148{
1149 char *err;
1150 char *combined;
1151
1152 err = safe_strerror (errno);
1153 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1154 strcpy (combined, string);
1155 strcat (combined, ": ");
1156 strcat (combined, err);
1157
1158 /* I understand setting these is a matter of taste. Still, some people
1159 may clear errno but not know about bfd_error. Doing this here is not
581e13c1 1160 unreasonable. */
c906108c
SS
1161 bfd_set_error (bfd_error_no_error);
1162 errno = 0;
1163
8a3fe4f8 1164 error (_("%s."), combined);
c906108c
SS
1165}
1166
1167/* Print the system error message for ERRCODE, and also mention STRING
1168 as the file name for which the error was encountered. */
1169
1170void
6972bc8b 1171print_sys_errmsg (const char *string, int errcode)
c906108c
SS
1172{
1173 char *err;
1174 char *combined;
1175
1176 err = safe_strerror (errcode);
1177 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1178 strcpy (combined, string);
1179 strcat (combined, ": ");
1180 strcat (combined, err);
1181
1182 /* We want anything which was printed on stdout to come out first, before
1183 this message. */
1184 gdb_flush (gdb_stdout);
1185 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1186}
1187
1188/* Control C eventually causes this to be called, at a convenient time. */
1189
1190void
fba45db2 1191quit (void)
c906108c 1192{
7be570e7
JM
1193#ifdef __MSDOS__
1194 /* No steenking SIGINT will ever be coming our way when the
1195 program is resumed. Don't lie. */
e06e2353 1196 fatal ("Quit");
7be570e7 1197#else
c906108c 1198 if (job_control
8731e58e
AC
1199 /* If there is no terminal switching for this target, then we can't
1200 possibly get screwed by the lack of job control. */
c906108c 1201 || current_target.to_terminal_ours == NULL)
e06e2353 1202 fatal ("Quit");
c906108c 1203 else
e06e2353 1204 fatal ("Quit (expect signal SIGINT when the program is resumed)");
7be570e7 1205#endif
c906108c
SS
1206}
1207
c906108c 1208\f
c906108c 1209/* Called when a memory allocation fails, with the number of bytes of
581e13c1 1210 memory requested in SIZE. */
c906108c 1211
c25c4a8b 1212void
fba45db2 1213nomem (long size)
c906108c
SS
1214{
1215 if (size > 0)
1216 {
8e65ff28 1217 internal_error (__FILE__, __LINE__,
e2e0b3e5 1218 _("virtual memory exhausted: can't allocate %ld bytes."),
8731e58e 1219 size);
c906108c
SS
1220 }
1221 else
1222 {
e2e0b3e5 1223 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
c906108c
SS
1224 }
1225}
1226
c0e61796
AC
1227/* The xmalloc() (libiberty.h) family of memory management routines.
1228
1229 These are like the ISO-C malloc() family except that they implement
1230 consistent semantics and guard against typical memory management
7936743b 1231 problems. */
c0e61796
AC
1232
1233/* NOTE: These are declared using PTR to ensure consistency with
1234 "libiberty.h". xfree() is GDB local. */
1235
5ac79d78 1236PTR /* ARI: PTR */
c0e61796
AC
1237xmalloc (size_t size)
1238{
7936743b
AC
1239 void *val;
1240
1241 /* See libiberty/xmalloc.c. This function need's to match that's
1242 semantics. It never returns NULL. */
1243 if (size == 0)
1244 size = 1;
1245
5ac79d78 1246 val = malloc (size); /* ARI: malloc */
7936743b
AC
1247 if (val == NULL)
1248 nomem (size);
1249
1250 return (val);
c0e61796 1251}
c906108c 1252
5b90c7b5
AC
1253void *
1254xzalloc (size_t size)
1255{
1256 return xcalloc (1, size);
1257}
1258
5ac79d78
PM
1259PTR /* ARI: PTR */
1260xrealloc (PTR ptr, size_t size) /* ARI: PTR */
c906108c 1261{
0efffb96
AC
1262 void *val;
1263
1264 /* See libiberty/xmalloc.c. This function need's to match that's
1265 semantics. It never returns NULL. */
1266 if (size == 0)
1267 size = 1;
1268
1269 if (ptr != NULL)
5ac79d78 1270 val = realloc (ptr, size); /* ARI: realloc */
0efffb96 1271 else
5ac79d78 1272 val = malloc (size); /* ARI: malloc */
0efffb96
AC
1273 if (val == NULL)
1274 nomem (size);
1275
1276 return (val);
c906108c 1277}
b8c9b27d 1278
5ac79d78 1279PTR /* ARI: PTR */
c0e61796
AC
1280xcalloc (size_t number, size_t size)
1281{
aa2ee5f6
AC
1282 void *mem;
1283
1284 /* See libiberty/xmalloc.c. This function need's to match that's
1285 semantics. It never returns NULL. */
1286 if (number == 0 || size == 0)
1287 {
1288 number = 1;
1289 size = 1;
1290 }
1291
5ac79d78 1292 mem = calloc (number, size); /* ARI: xcalloc */
aa2ee5f6
AC
1293 if (mem == NULL)
1294 nomem (number * size);
1295
1296 return mem;
c0e61796 1297}
b8c9b27d
KB
1298
1299void
1300xfree (void *ptr)
1301{
2dc74dc1 1302 if (ptr != NULL)
5ac79d78 1303 free (ptr); /* ARI: free */
b8c9b27d 1304}
c906108c 1305\f
c5aa993b 1306
76995688 1307/* Like asprintf/vasprintf but get an internal_error if the call
581e13c1 1308 fails. */
76995688 1309
9ebf4acf
AC
1310char *
1311xstrprintf (const char *format, ...)
1312{
1313 char *ret;
1314 va_list args;
e0627e85 1315
9ebf4acf 1316 va_start (args, format);
e623b504 1317 ret = xstrvprintf (format, args);
9ebf4acf
AC
1318 va_end (args);
1319 return ret;
1320}
1321
76995688
AC
1322void
1323xasprintf (char **ret, const char *format, ...)
1324{
1325 va_list args;
e0627e85 1326
76995688 1327 va_start (args, format);
e623b504 1328 (*ret) = xstrvprintf (format, args);
76995688
AC
1329 va_end (args);
1330}
1331
1332void
1333xvasprintf (char **ret, const char *format, va_list ap)
1334{
a552edd9 1335 (*ret) = xstrvprintf (format, ap);
76995688
AC
1336}
1337
e623b504
AC
1338char *
1339xstrvprintf (const char *format, va_list ap)
1340{
1341 char *ret = NULL;
1342 int status = vasprintf (&ret, format, ap);
e0627e85 1343
46e9880c
DJ
1344 /* NULL is returned when there was a memory allocation problem, or
1345 any other error (for instance, a bad format string). A negative
1346 status (the printed length) with a non-NULL buffer should never
1347 happen, but just to be sure. */
1348 if (ret == NULL || status < 0)
1349 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
e623b504
AC
1350 return ret;
1351}
76995688 1352
bde2058d
MK
1353int
1354xsnprintf (char *str, size_t size, const char *format, ...)
1355{
1356 va_list args;
1357 int ret;
1358
1359 va_start (args, format);
1360 ret = vsnprintf (str, size, format, args);
1361 gdb_assert (ret < size);
1362 va_end (args);
1363
1364 return ret;
1365}
1366
c906108c
SS
1367/* My replacement for the read system call.
1368 Used like `read' but keeps going if `read' returns too soon. */
1369
1370int
fba45db2 1371myread (int desc, char *addr, int len)
c906108c 1372{
52f0bd74 1373 int val;
c906108c
SS
1374 int orglen = len;
1375
1376 while (len > 0)
1377 {
1378 val = read (desc, addr, len);
1379 if (val < 0)
1380 return val;
1381 if (val == 0)
1382 return orglen - len;
1383 len -= val;
1384 addr += val;
1385 }
1386 return orglen;
1387}
1388\f
1389/* Make a copy of the string at PTR with SIZE characters
1390 (and add a null character at the end in the copy).
1391 Uses malloc to get the space. Returns the address of the copy. */
1392
1393char *
5565b556 1394savestring (const char *ptr, size_t size)
c906108c 1395{
52f0bd74 1396 char *p = (char *) xmalloc (size + 1);
e0627e85 1397
c906108c
SS
1398 memcpy (p, ptr, size);
1399 p[size] = 0;
1400 return p;
1401}
1402
c906108c 1403void
aa1ee363 1404print_spaces (int n, struct ui_file *file)
c906108c 1405{
392a587b 1406 fputs_unfiltered (n_spaces (n), file);
c906108c
SS
1407}
1408
1409/* Print a host address. */
1410
1411void
ac16bf07 1412gdb_print_host_address (const void *addr, struct ui_file *stream)
c906108c 1413{
ea8992ce 1414 fprintf_filtered (stream, "%s", host_address_to_string (addr));
c906108c 1415}
c906108c 1416\f
c5aa993b 1417
dc92e161
TT
1418/* A cleanup function that calls regfree. */
1419
1420static void
1421do_regfree_cleanup (void *r)
1422{
1423 regfree (r);
1424}
1425
1426/* Create a new cleanup that frees the compiled regular expression R. */
1427
1428struct cleanup *
1429make_regfree_cleanup (regex_t *r)
1430{
1431 return make_cleanup (do_regfree_cleanup, r);
1432}
1433
1434/* Return an xmalloc'd error message resulting from a regular
1435 expression compilation failure. */
1436
1437char *
1438get_regcomp_error (int code, regex_t *rx)
1439{
1440 size_t length = regerror (code, rx, NULL, 0);
1441 char *result = xmalloc (length);
1442
1443 regerror (code, rx, result, length);
1444 return result;
1445}
1446
1447\f
1448
981c7f5a 1449/* This function supports the query, nquery, and yquery functions.
cbdeadca 1450 Ask user a y-or-n question and return 0 if answer is no, 1 if
981c7f5a
DJ
1451 answer is yes, or default the answer to the specified default
1452 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1453 default answer, or '\0' for no default.
cbdeadca
JJ
1454 CTLSTR is the control string and should end in "? ". It should
1455 not say how to answer, because we do that.
1456 ARGS are the arguments passed along with the CTLSTR argument to
1457 printf. */
1458
a0b31db1 1459static int ATTRIBUTE_PRINTF (1, 0)
cbdeadca
JJ
1460defaulted_query (const char *ctlstr, const char defchar, va_list args)
1461{
1462 int answer;
1463 int ans2;
1464 int retval;
1465 int def_value;
1466 char def_answer, not_def_answer;
981c7f5a 1467 char *y_string, *n_string, *question;
cbdeadca
JJ
1468
1469 /* Set up according to which answer is the default. */
981c7f5a
DJ
1470 if (defchar == '\0')
1471 {
1472 def_value = 1;
1473 def_answer = 'Y';
1474 not_def_answer = 'N';
1475 y_string = "y";
1476 n_string = "n";
1477 }
1478 else if (defchar == 'y')
cbdeadca
JJ
1479 {
1480 def_value = 1;
1481 def_answer = 'Y';
1482 not_def_answer = 'N';
1483 y_string = "[y]";
1484 n_string = "n";
1485 }
1486 else
1487 {
1488 def_value = 0;
1489 def_answer = 'N';
1490 not_def_answer = 'Y';
1491 y_string = "y";
1492 n_string = "[n]";
1493 }
1494
981c7f5a 1495 /* Automatically answer the default value if the user did not want
a502cf95
NR
1496 prompts or the command was issued with the server prefix. */
1497 if (! caution || server_command)
981c7f5a
DJ
1498 return def_value;
1499
1500 /* If input isn't coming from the user directly, just say what
7a01c6e0 1501 question we're asking, and then answer the default automatically. This
981c7f5a
DJ
1502 way, important error messages don't get lost when talking to GDB
1503 over a pipe. */
c63a1f86 1504 if (! input_from_terminal_p ())
981c7f5a
DJ
1505 {
1506 wrap_here ("");
1507 vfprintf_filtered (gdb_stdout, ctlstr, args);
1508
3e43a32a
MS
1509 printf_filtered (_("(%s or %s) [answered %c; "
1510 "input not from terminal]\n"),
981c7f5a
DJ
1511 y_string, n_string, def_answer);
1512 gdb_flush (gdb_stdout);
1513
1514 return def_value;
1515 }
1516
9a4105ab 1517 if (deprecated_query_hook)
cbdeadca 1518 {
9a4105ab 1519 return deprecated_query_hook (ctlstr, args);
cbdeadca
JJ
1520 }
1521
981c7f5a
DJ
1522 /* Format the question outside of the loop, to avoid reusing args. */
1523 question = xstrvprintf (ctlstr, args);
1524
cbdeadca
JJ
1525 while (1)
1526 {
581e13c1 1527 wrap_here (""); /* Flush any buffered output. */
cbdeadca
JJ
1528 gdb_flush (gdb_stdout);
1529
1530 if (annotation_level > 1)
a3f17187 1531 printf_filtered (("\n\032\032pre-query\n"));
cbdeadca 1532
981c7f5a 1533 fputs_filtered (question, gdb_stdout);
a3f17187 1534 printf_filtered (_("(%s or %s) "), y_string, n_string);
cbdeadca
JJ
1535
1536 if (annotation_level > 1)
a3f17187 1537 printf_filtered (("\n\032\032query\n"));
cbdeadca
JJ
1538
1539 wrap_here ("");
1540 gdb_flush (gdb_stdout);
1541
1542 answer = fgetc (stdin);
8626589c
JB
1543
1544 /* We expect fgetc to block until a character is read. But
1545 this may not be the case if the terminal was opened with
1546 the NONBLOCK flag. In that case, if there is nothing to
1547 read on stdin, fgetc returns EOF, but also sets the error
1548 condition flag on stdin and errno to EAGAIN. With a true
1549 EOF, stdin's error condition flag is not set.
1550
1551 A situation where this behavior was observed is a pseudo
1552 terminal on AIX. */
1553 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1554 {
1555 /* Not a real EOF. Wait a little while and try again until
1556 we read something. */
1557 clearerr (stdin);
1558 gdb_usleep (10000);
1559 answer = fgetc (stdin);
1560 }
1561
cbdeadca
JJ
1562 clearerr (stdin); /* in case of C-d */
1563 if (answer == EOF) /* C-d */
1564 {
fa3fd85b 1565 printf_filtered ("EOF [assumed %c]\n", def_answer);
cbdeadca
JJ
1566 retval = def_value;
1567 break;
1568 }
581e13c1 1569 /* Eat rest of input line, to EOF or newline. */
cbdeadca
JJ
1570 if (answer != '\n')
1571 do
1572 {
1573 ans2 = fgetc (stdin);
1574 clearerr (stdin);
1575 }
1576 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1577
1578 if (answer >= 'a')
1579 answer -= 040;
1580 /* Check answer. For the non-default, the user must specify
1581 the non-default explicitly. */
1582 if (answer == not_def_answer)
1583 {
1584 retval = !def_value;
1585 break;
1586 }
981c7f5a
DJ
1587 /* Otherwise, if a default was specified, the user may either
1588 specify the required input or have it default by entering
1589 nothing. */
1590 if (answer == def_answer
1591 || (defchar != '\0' &&
1592 (answer == '\n' || answer == '\r' || answer == EOF)))
cbdeadca
JJ
1593 {
1594 retval = def_value;
1595 break;
1596 }
1597 /* Invalid entries are not defaulted and require another selection. */
a3f17187 1598 printf_filtered (_("Please answer %s or %s.\n"),
cbdeadca
JJ
1599 y_string, n_string);
1600 }
1601
981c7f5a 1602 xfree (question);
cbdeadca 1603 if (annotation_level > 1)
a3f17187 1604 printf_filtered (("\n\032\032post-query\n"));
cbdeadca
JJ
1605 return retval;
1606}
1607\f
1608
1609/* Ask user a y-or-n question and return 0 if answer is no, 1 if
1610 answer is yes, or 0 if answer is defaulted.
1611 Takes three args which are given to printf to print the question.
1612 The first, a control string, should end in "? ".
1613 It should not say how to answer, because we do that. */
1614
1615int
1616nquery (const char *ctlstr, ...)
1617{
1618 va_list args;
899500d6 1619 int ret;
cbdeadca
JJ
1620
1621 va_start (args, ctlstr);
899500d6 1622 ret = defaulted_query (ctlstr, 'n', args);
cbdeadca 1623 va_end (args);
899500d6 1624 return ret;
cbdeadca
JJ
1625}
1626
1627/* Ask user a y-or-n question and return 0 if answer is no, 1 if
1628 answer is yes, or 1 if answer is defaulted.
1629 Takes three args which are given to printf to print the question.
1630 The first, a control string, should end in "? ".
1631 It should not say how to answer, because we do that. */
1632
1633int
1634yquery (const char *ctlstr, ...)
1635{
1636 va_list args;
899500d6 1637 int ret;
cbdeadca
JJ
1638
1639 va_start (args, ctlstr);
899500d6 1640 ret = defaulted_query (ctlstr, 'y', args);
cbdeadca 1641 va_end (args);
899500d6 1642 return ret;
cbdeadca
JJ
1643}
1644
981c7f5a
DJ
1645/* Ask user a y-or-n question and return 1 iff answer is yes.
1646 Takes three args which are given to printf to print the question.
1647 The first, a control string, should end in "? ".
1648 It should not say how to answer, because we do that. */
1649
1650int
1651query (const char *ctlstr, ...)
1652{
1653 va_list args;
899500d6 1654 int ret;
981c7f5a
DJ
1655
1656 va_start (args, ctlstr);
899500d6 1657 ret = defaulted_query (ctlstr, '\0', args);
981c7f5a 1658 va_end (args);
899500d6 1659 return ret;
981c7f5a
DJ
1660}
1661
6c7a06a3
TT
1662/* A helper for parse_escape that converts a host character to a
1663 target character. C is the host character. If conversion is
1664 possible, then the target character is stored in *TARGET_C and the
1665 function returns 1. Otherwise, the function returns 0. */
1666
1667static int
f870a310 1668host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
234b45d4 1669{
6c7a06a3
TT
1670 struct obstack host_data;
1671 char the_char = c;
1672 struct cleanup *cleanups;
1673 int result = 0;
234b45d4 1674
6c7a06a3
TT
1675 obstack_init (&host_data);
1676 cleanups = make_cleanup_obstack_free (&host_data);
234b45d4 1677
f870a310 1678 convert_between_encodings (target_charset (gdbarch), host_charset (),
6c7a06a3
TT
1679 &the_char, 1, 1, &host_data, translit_none);
1680
1681 if (obstack_object_size (&host_data) == 1)
1682 {
1683 result = 1;
1684 *target_c = *(char *) obstack_base (&host_data);
1685 }
1686
1687 do_cleanups (cleanups);
1688 return result;
234b45d4
KB
1689}
1690
c906108c
SS
1691/* Parse a C escape sequence. STRING_PTR points to a variable
1692 containing a pointer to the string to parse. That pointer
1693 should point to the character after the \. That pointer
1694 is updated past the characters we use. The value of the
1695 escape sequence is returned.
1696
1697 A negative value means the sequence \ newline was seen,
1698 which is supposed to be equivalent to nothing at all.
1699
1700 If \ is followed by a null character, we return a negative
1701 value and leave the string pointer pointing at the null character.
1702
1703 If \ is followed by 000, we return 0 and leave the string pointer
1704 after the zeros. A value of 0 does not mean end of string. */
1705
1706int
f870a310 1707parse_escape (struct gdbarch *gdbarch, char **string_ptr)
c906108c 1708{
581e13c1 1709 int target_char = -2; /* Initialize to avoid GCC warnings. */
52f0bd74 1710 int c = *(*string_ptr)++;
e0627e85 1711
6c7a06a3
TT
1712 switch (c)
1713 {
8731e58e
AC
1714 case '\n':
1715 return -2;
1716 case 0:
1717 (*string_ptr)--;
1718 return 0;
8731e58e
AC
1719
1720 case '0':
1721 case '1':
1722 case '2':
1723 case '3':
1724 case '4':
1725 case '5':
1726 case '6':
1727 case '7':
1728 {
6c7a06a3 1729 int i = host_hex_value (c);
aa1ee363 1730 int count = 0;
8731e58e
AC
1731 while (++count < 3)
1732 {
5cb316ef 1733 c = (**string_ptr);
6c7a06a3 1734 if (isdigit (c) && c != '8' && c != '9')
8731e58e 1735 {
5cb316ef 1736 (*string_ptr)++;
8731e58e 1737 i *= 8;
6c7a06a3 1738 i += host_hex_value (c);
8731e58e
AC
1739 }
1740 else
1741 {
8731e58e
AC
1742 break;
1743 }
1744 }
1745 return i;
1746 }
6c7a06a3
TT
1747
1748 case 'a':
1749 c = '\a';
1750 break;
1751 case 'b':
1752 c = '\b';
1753 break;
1754 case 'f':
1755 c = '\f';
1756 break;
1757 case 'n':
1758 c = '\n';
1759 break;
1760 case 'r':
1761 c = '\r';
1762 break;
1763 case 't':
1764 c = '\t';
1765 break;
1766 case 'v':
1767 c = '\v';
1768 break;
1769
1770 default:
1771 break;
1772 }
1773
f870a310 1774 if (!host_char_to_target (gdbarch, c, &target_char))
3351ea09
JB
1775 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1776 " which has no equivalent\nin the `%s' character set."),
905b671b 1777 c, c, target_charset (gdbarch));
6c7a06a3 1778 return target_char;
c906108c
SS
1779}
1780\f
1781/* Print the character C on STREAM as part of the contents of a literal
1782 string whose delimiter is QUOTER. Note that this routine should only
1783 be call for printing things which are independent of the language
581e13c1 1784 of the program being debugged. */
c906108c 1785
43e526b9 1786static void
74f832da 1787printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
bee0189a
DJ
1788 void (*do_fprintf) (struct ui_file *, const char *, ...)
1789 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
c906108c 1790{
c906108c
SS
1791 c &= 0xFF; /* Avoid sign bit follies */
1792
c5aa993b
JM
1793 if (c < 0x20 || /* Low control chars */
1794 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1795 (sevenbit_strings && c >= 0x80))
1796 { /* high order bit set */
1797 switch (c)
1798 {
1799 case '\n':
43e526b9 1800 do_fputs ("\\n", stream);
c5aa993b
JM
1801 break;
1802 case '\b':
43e526b9 1803 do_fputs ("\\b", stream);
c5aa993b
JM
1804 break;
1805 case '\t':
43e526b9 1806 do_fputs ("\\t", stream);
c5aa993b
JM
1807 break;
1808 case '\f':
43e526b9 1809 do_fputs ("\\f", stream);
c5aa993b
JM
1810 break;
1811 case '\r':
43e526b9 1812 do_fputs ("\\r", stream);
c5aa993b
JM
1813 break;
1814 case '\033':
43e526b9 1815 do_fputs ("\\e", stream);
c5aa993b
JM
1816 break;
1817 case '\007':
43e526b9 1818 do_fputs ("\\a", stream);
c5aa993b
JM
1819 break;
1820 default:
43e526b9 1821 do_fprintf (stream, "\\%.3o", (unsigned int) c);
c5aa993b
JM
1822 break;
1823 }
1824 }
1825 else
1826 {
1827 if (c == '\\' || c == quoter)
43e526b9
JM
1828 do_fputs ("\\", stream);
1829 do_fprintf (stream, "%c", c);
c5aa993b 1830 }
c906108c 1831}
43e526b9
JM
1832
1833/* Print the character C on STREAM as part of the contents of a
1834 literal string whose delimiter is QUOTER. Note that these routines
1835 should only be call for printing things which are independent of
581e13c1 1836 the language of the program being debugged. */
43e526b9
JM
1837
1838void
fba45db2 1839fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
43e526b9
JM
1840{
1841 while (*str)
1842 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1843}
1844
1845void
fba45db2 1846fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
43e526b9
JM
1847{
1848 while (*str)
1849 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1850}
1851
0876f84a
DJ
1852void
1853fputstrn_filtered (const char *str, int n, int quoter,
1854 struct ui_file *stream)
1855{
1856 int i;
e0627e85 1857
0876f84a
DJ
1858 for (i = 0; i < n; i++)
1859 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1860}
1861
43e526b9 1862void
8731e58e
AC
1863fputstrn_unfiltered (const char *str, int n, int quoter,
1864 struct ui_file *stream)
43e526b9
JM
1865{
1866 int i;
5d502164 1867
43e526b9
JM
1868 for (i = 0; i < n; i++)
1869 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1870}
c906108c 1871\f
c5aa993b 1872
c906108c
SS
1873/* Number of lines per page or UINT_MAX if paging is disabled. */
1874static unsigned int lines_per_page;
920d2a44
AC
1875static void
1876show_lines_per_page (struct ui_file *file, int from_tty,
1877 struct cmd_list_element *c, const char *value)
1878{
3e43a32a
MS
1879 fprintf_filtered (file,
1880 _("Number of lines gdb thinks are in a page is %s.\n"),
920d2a44
AC
1881 value);
1882}
eb0d3137 1883
cbfbd72a 1884/* Number of chars per line or UINT_MAX if line folding is disabled. */
c906108c 1885static unsigned int chars_per_line;
920d2a44
AC
1886static void
1887show_chars_per_line (struct ui_file *file, int from_tty,
1888 struct cmd_list_element *c, const char *value)
1889{
3e43a32a
MS
1890 fprintf_filtered (file,
1891 _("Number of characters gdb thinks "
1892 "are in a line is %s.\n"),
920d2a44
AC
1893 value);
1894}
eb0d3137 1895
c906108c
SS
1896/* Current count of lines printed on this page, chars on this line. */
1897static unsigned int lines_printed, chars_printed;
1898
1899/* Buffer and start column of buffered text, for doing smarter word-
1900 wrapping. When someone calls wrap_here(), we start buffering output
1901 that comes through fputs_filtered(). If we see a newline, we just
1902 spit it out and forget about the wrap_here(). If we see another
1903 wrap_here(), we spit it out and remember the newer one. If we see
1904 the end of the line, we spit out a newline, the indent, and then
1905 the buffered output. */
1906
1907/* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1908 are waiting to be output (they have already been counted in chars_printed).
1909 When wrap_buffer[0] is null, the buffer is empty. */
1910static char *wrap_buffer;
1911
1912/* Pointer in wrap_buffer to the next character to fill. */
1913static char *wrap_pointer;
1914
1915/* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1916 is non-zero. */
1917static char *wrap_indent;
1918
1919/* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1920 is not in effect. */
1921static int wrap_column;
c906108c 1922\f
c5aa993b 1923
eb0d3137
MK
1924/* Inialize the number of lines per page and chars per line. */
1925
c906108c 1926void
fba45db2 1927init_page_info (void)
c906108c 1928{
5da1313b
JK
1929 if (batch_flag)
1930 {
1931 lines_per_page = UINT_MAX;
1932 chars_per_line = UINT_MAX;
1933 }
1934 else
c906108c 1935#if defined(TUI)
5ecb1806 1936 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
c906108c
SS
1937#endif
1938 {
eb0d3137 1939 int rows, cols;
c906108c 1940
ec145965
EZ
1941#if defined(__GO32__)
1942 rows = ScreenRows ();
1943 cols = ScreenCols ();
1944 lines_per_page = rows;
1945 chars_per_line = cols;
1946#else
eb0d3137
MK
1947 /* Make sure Readline has initialized its terminal settings. */
1948 rl_reset_terminal (NULL);
c906108c 1949
eb0d3137
MK
1950 /* Get the screen size from Readline. */
1951 rl_get_screen_size (&rows, &cols);
1952 lines_per_page = rows;
1953 chars_per_line = cols;
c906108c 1954
eb0d3137
MK
1955 /* Readline should have fetched the termcap entry for us. */
1956 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1957 {
1958 /* The number of lines per page is not mentioned in the
1959 terminal description. This probably means that paging is
1960 not useful (e.g. emacs shell window), so disable paging. */
1961 lines_per_page = UINT_MAX;
1962 }
c906108c 1963
eb0d3137 1964 /* FIXME: Get rid of this junk. */
c906108c 1965#if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
c906108c
SS
1966 SIGWINCH_HANDLER (SIGWINCH);
1967#endif
eb0d3137 1968
c906108c 1969 /* If the output is not a terminal, don't paginate it. */
d9fcf2fb 1970 if (!ui_file_isatty (gdb_stdout))
c5aa993b 1971 lines_per_page = UINT_MAX;
eb0d3137 1972#endif
ec145965 1973 }
eb0d3137
MK
1974
1975 set_screen_size ();
c5aa993b 1976 set_width ();
c906108c
SS
1977}
1978
5da1313b
JK
1979/* Helper for make_cleanup_restore_page_info. */
1980
1981static void
1982do_restore_page_info_cleanup (void *arg)
1983{
1984 set_screen_size ();
1985 set_width ();
1986}
1987
1988/* Provide cleanup for restoring the terminal size. */
1989
1990struct cleanup *
1991make_cleanup_restore_page_info (void)
1992{
1993 struct cleanup *back_to;
1994
1995 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1996 make_cleanup_restore_uinteger (&lines_per_page);
1997 make_cleanup_restore_uinteger (&chars_per_line);
1998
1999 return back_to;
2000}
2001
2002/* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
2003 Provide cleanup for restoring the original state. */
2004
2005struct cleanup *
2006set_batch_flag_and_make_cleanup_restore_page_info (void)
2007{
2008 struct cleanup *back_to = make_cleanup_restore_page_info ();
2009
2010 make_cleanup_restore_integer (&batch_flag);
2011 batch_flag = 1;
2012 init_page_info ();
2013
2014 return back_to;
2015}
2016
eb0d3137
MK
2017/* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
2018
2019static void
2020set_screen_size (void)
2021{
2022 int rows = lines_per_page;
2023 int cols = chars_per_line;
2024
2025 if (rows <= 0)
2026 rows = INT_MAX;
2027
2028 if (cols <= 0)
0caa462c 2029 cols = INT_MAX;
eb0d3137
MK
2030
2031 /* Update Readline's idea of the terminal size. */
2032 rl_set_screen_size (rows, cols);
2033}
2034
2035/* Reinitialize WRAP_BUFFER according to the current value of
2036 CHARS_PER_LINE. */
2037
c906108c 2038static void
fba45db2 2039set_width (void)
c906108c
SS
2040{
2041 if (chars_per_line == 0)
c5aa993b 2042 init_page_info ();
c906108c
SS
2043
2044 if (!wrap_buffer)
2045 {
2046 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
2047 wrap_buffer[0] = '\0';
2048 }
2049 else
2050 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
eb0d3137 2051 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
c906108c
SS
2052}
2053
c5aa993b 2054static void
fba45db2 2055set_width_command (char *args, int from_tty, struct cmd_list_element *c)
c906108c 2056{
eb0d3137 2057 set_screen_size ();
c906108c
SS
2058 set_width ();
2059}
2060
eb0d3137
MK
2061static void
2062set_height_command (char *args, int from_tty, struct cmd_list_element *c)
2063{
2064 set_screen_size ();
2065}
2066
c906108c
SS
2067/* Wait, so the user can read what's on the screen. Prompt the user
2068 to continue by pressing RETURN. */
2069
2070static void
fba45db2 2071prompt_for_continue (void)
c906108c
SS
2072{
2073 char *ignore;
2074 char cont_prompt[120];
2075
2076 if (annotation_level > 1)
a3f17187 2077 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
c906108c
SS
2078
2079 strcpy (cont_prompt,
2080 "---Type <return> to continue, or q <return> to quit---");
2081 if (annotation_level > 1)
2082 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
2083
2084 /* We must do this *before* we call gdb_readline, else it will eventually
2085 call us -- thinking that we're trying to print beyond the end of the
2086 screen. */
2087 reinitialize_more_filter ();
2088
2089 immediate_quit++;
2090 /* On a real operating system, the user can quit with SIGINT.
2091 But not on GO32.
2092
2093 'q' is provided on all systems so users don't have to change habits
2094 from system to system, and because telling them what to do in
2095 the prompt is more user-friendly than expecting them to think of
2096 SIGINT. */
2097 /* Call readline, not gdb_readline, because GO32 readline handles control-C
2098 whereas control-C to gdb_readline will cause the user to get dumped
2099 out to DOS. */
b4f5539f 2100 ignore = gdb_readline_wrapper (cont_prompt);
c906108c
SS
2101
2102 if (annotation_level > 1)
a3f17187 2103 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
c906108c
SS
2104
2105 if (ignore)
2106 {
2107 char *p = ignore;
5d502164 2108
c906108c
SS
2109 while (*p == ' ' || *p == '\t')
2110 ++p;
2111 if (p[0] == 'q')
362646f5 2112 async_request_quit (0);
b8c9b27d 2113 xfree (ignore);
c906108c
SS
2114 }
2115 immediate_quit--;
2116
2117 /* Now we have to do this again, so that GDB will know that it doesn't
2118 need to save the ---Type <return>--- line at the top of the screen. */
2119 reinitialize_more_filter ();
2120
581e13c1 2121 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
c906108c
SS
2122}
2123
2124/* Reinitialize filter; ie. tell it to reset to original values. */
2125
2126void
fba45db2 2127reinitialize_more_filter (void)
c906108c
SS
2128{
2129 lines_printed = 0;
2130 chars_printed = 0;
2131}
2132
2133/* Indicate that if the next sequence of characters overflows the line,
581e13c1 2134 a newline should be inserted here rather than when it hits the end.
c906108c
SS
2135 If INDENT is non-null, it is a string to be printed to indent the
2136 wrapped part on the next line. INDENT must remain accessible until
2137 the next call to wrap_here() or until a newline is printed through
2138 fputs_filtered().
2139
2140 If the line is already overfull, we immediately print a newline and
2141 the indentation, and disable further wrapping.
2142
2143 If we don't know the width of lines, but we know the page height,
2144 we must not wrap words, but should still keep track of newlines
2145 that were explicitly printed.
2146
2147 INDENT should not contain tabs, as that will mess up the char count
2148 on the next line. FIXME.
2149
2150 This routine is guaranteed to force out any output which has been
2151 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2152 used to force out output from the wrap_buffer. */
2153
2154void
fba45db2 2155wrap_here (char *indent)
c906108c 2156{
581e13c1 2157 /* This should have been allocated, but be paranoid anyway. */
c906108c 2158 if (!wrap_buffer)
3e43a32a
MS
2159 internal_error (__FILE__, __LINE__,
2160 _("failed internal consistency check"));
c906108c
SS
2161
2162 if (wrap_buffer[0])
2163 {
2164 *wrap_pointer = '\0';
2165 fputs_unfiltered (wrap_buffer, gdb_stdout);
2166 }
2167 wrap_pointer = wrap_buffer;
2168 wrap_buffer[0] = '\0';
3e43a32a 2169 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
c906108c
SS
2170 {
2171 wrap_column = 0;
2172 }
2173 else if (chars_printed >= chars_per_line)
2174 {
2175 puts_filtered ("\n");
2176 if (indent != NULL)
2177 puts_filtered (indent);
2178 wrap_column = 0;
2179 }
2180 else
2181 {
2182 wrap_column = chars_printed;
2183 if (indent == NULL)
2184 wrap_indent = "";
2185 else
2186 wrap_indent = indent;
2187 }
2188}
2189
4a351cef 2190/* Print input string to gdb_stdout, filtered, with wrap,
581e13c1 2191 arranging strings in columns of n chars. String can be
4a351cef
AF
2192 right or left justified in the column. Never prints
2193 trailing spaces. String should never be longer than
2194 width. FIXME: this could be useful for the EXAMINE
581e13c1 2195 command, which currently doesn't tabulate very well. */
4a351cef
AF
2196
2197void
2198puts_filtered_tabular (char *string, int width, int right)
2199{
2200 int spaces = 0;
2201 int stringlen;
2202 char *spacebuf;
2203
2204 gdb_assert (chars_per_line > 0);
2205 if (chars_per_line == UINT_MAX)
2206 {
2207 fputs_filtered (string, gdb_stdout);
2208 fputs_filtered ("\n", gdb_stdout);
2209 return;
2210 }
2211
2212 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2213 fputs_filtered ("\n", gdb_stdout);
2214
2215 if (width >= chars_per_line)
2216 width = chars_per_line - 1;
2217
2218 stringlen = strlen (string);
2219
2220 if (chars_printed > 0)
2221 spaces = width - (chars_printed - 1) % width - 1;
2222 if (right)
2223 spaces += width - stringlen;
2224
2225 spacebuf = alloca (spaces + 1);
2226 spacebuf[spaces] = '\0';
2227 while (spaces--)
2228 spacebuf[spaces] = ' ';
2229
2230 fputs_filtered (spacebuf, gdb_stdout);
2231 fputs_filtered (string, gdb_stdout);
2232}
2233
2234
c906108c 2235/* Ensure that whatever gets printed next, using the filtered output
581e13c1 2236 commands, starts at the beginning of the line. I.e. if there is
c906108c 2237 any pending output for the current line, flush it and start a new
581e13c1 2238 line. Otherwise do nothing. */
c906108c
SS
2239
2240void
fba45db2 2241begin_line (void)
c906108c
SS
2242{
2243 if (chars_printed > 0)
2244 {
2245 puts_filtered ("\n");
2246 }
2247}
2248
ac9a91a7 2249
c906108c
SS
2250/* Like fputs but if FILTER is true, pause after every screenful.
2251
2252 Regardless of FILTER can wrap at points other than the final
2253 character of a line.
2254
2255 Unlike fputs, fputs_maybe_filtered does not return a value.
2256 It is OK for LINEBUFFER to be NULL, in which case just don't print
2257 anything.
2258
2259 Note that a longjmp to top level may occur in this routine (only if
2260 FILTER is true) (since prompt_for_continue may do so) so this
2261 routine should not be called when cleanups are not in place. */
2262
2263static void
fba45db2
KB
2264fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2265 int filter)
c906108c
SS
2266{
2267 const char *lineptr;
2268
2269 if (linebuffer == 0)
2270 return;
2271
2272 /* Don't do any filtering if it is disabled. */
390a8aca 2273 if (stream != gdb_stdout
c63a1f86
JK
2274 || ! pagination_enabled
2275 || ! input_from_terminal_p ()
390a8aca 2276 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
58dadb1b 2277 || top_level_interpreter () == NULL
390a8aca 2278 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
c906108c
SS
2279 {
2280 fputs_unfiltered (linebuffer, stream);
2281 return;
2282 }
2283
2284 /* Go through and output each character. Show line extension
2285 when this is necessary; prompt user for new page when this is
2286 necessary. */
c5aa993b 2287
c906108c
SS
2288 lineptr = linebuffer;
2289 while (*lineptr)
2290 {
2291 /* Possible new page. */
8731e58e 2292 if (filter && (lines_printed >= lines_per_page - 1))
c906108c
SS
2293 prompt_for_continue ();
2294
2295 while (*lineptr && *lineptr != '\n')
2296 {
2297 /* Print a single line. */
2298 if (*lineptr == '\t')
2299 {
2300 if (wrap_column)
2301 *wrap_pointer++ = '\t';
2302 else
2303 fputc_unfiltered ('\t', stream);
2304 /* Shifting right by 3 produces the number of tab stops
2305 we have already passed, and then adding one and
c5aa993b 2306 shifting left 3 advances to the next tab stop. */
c906108c
SS
2307 chars_printed = ((chars_printed >> 3) + 1) << 3;
2308 lineptr++;
2309 }
2310 else
2311 {
2312 if (wrap_column)
2313 *wrap_pointer++ = *lineptr;
2314 else
c5aa993b 2315 fputc_unfiltered (*lineptr, stream);
c906108c
SS
2316 chars_printed++;
2317 lineptr++;
2318 }
c5aa993b 2319
c906108c
SS
2320 if (chars_printed >= chars_per_line)
2321 {
2322 unsigned int save_chars = chars_printed;
2323
2324 chars_printed = 0;
2325 lines_printed++;
2326 /* If we aren't actually wrapping, don't output newline --
c5aa993b
JM
2327 if chars_per_line is right, we probably just overflowed
2328 anyway; if it's wrong, let us keep going. */
c906108c
SS
2329 if (wrap_column)
2330 fputc_unfiltered ('\n', stream);
2331
2332 /* Possible new page. */
2333 if (lines_printed >= lines_per_page - 1)
2334 prompt_for_continue ();
2335
581e13c1 2336 /* Now output indentation and wrapped string. */
c906108c
SS
2337 if (wrap_column)
2338 {
2339 fputs_unfiltered (wrap_indent, stream);
581e13c1
MS
2340 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2341 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
c906108c
SS
2342 /* FIXME, this strlen is what prevents wrap_indent from
2343 containing tabs. However, if we recurse to print it
2344 and count its chars, we risk trouble if wrap_indent is
581e13c1 2345 longer than (the user settable) chars_per_line.
c906108c
SS
2346 Note also that this can set chars_printed > chars_per_line
2347 if we are printing a long string. */
2348 chars_printed = strlen (wrap_indent)
c5aa993b 2349 + (save_chars - wrap_column);
c906108c
SS
2350 wrap_pointer = wrap_buffer; /* Reset buffer */
2351 wrap_buffer[0] = '\0';
c5aa993b
JM
2352 wrap_column = 0; /* And disable fancy wrap */
2353 }
c906108c
SS
2354 }
2355 }
2356
2357 if (*lineptr == '\n')
2358 {
2359 chars_printed = 0;
3e43a32a
MS
2360 wrap_here ((char *) 0); /* Spit out chars, cancel
2361 further wraps. */
c906108c
SS
2362 lines_printed++;
2363 fputc_unfiltered ('\n', stream);
2364 lineptr++;
2365 }
2366 }
2367}
2368
2369void
fba45db2 2370fputs_filtered (const char *linebuffer, struct ui_file *stream)
c906108c
SS
2371{
2372 fputs_maybe_filtered (linebuffer, stream, 1);
2373}
2374
2375int
fba45db2 2376putchar_unfiltered (int c)
c906108c 2377{
11cf8741 2378 char buf = c;
e0627e85 2379
d9fcf2fb 2380 ui_file_write (gdb_stdout, &buf, 1);
c906108c
SS
2381 return c;
2382}
2383
d1f4cff8
AC
2384/* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2385 May return nonlocally. */
2386
2387int
2388putchar_filtered (int c)
2389{
2390 return fputc_filtered (c, gdb_stdout);
2391}
2392
c906108c 2393int
fba45db2 2394fputc_unfiltered (int c, struct ui_file *stream)
c906108c 2395{
11cf8741 2396 char buf = c;
e0627e85 2397
d9fcf2fb 2398 ui_file_write (stream, &buf, 1);
c906108c
SS
2399 return c;
2400}
2401
2402int
fba45db2 2403fputc_filtered (int c, struct ui_file *stream)
c906108c
SS
2404{
2405 char buf[2];
2406
2407 buf[0] = c;
2408 buf[1] = 0;
2409 fputs_filtered (buf, stream);
2410 return c;
2411}
2412
2413/* puts_debug is like fputs_unfiltered, except it prints special
2414 characters in printable fashion. */
2415
2416void
fba45db2 2417puts_debug (char *prefix, char *string, char *suffix)
c906108c
SS
2418{
2419 int ch;
2420
2421 /* Print prefix and suffix after each line. */
2422 static int new_line = 1;
2423 static int return_p = 0;
2424 static char *prev_prefix = "";
2425 static char *prev_suffix = "";
2426
2427 if (*string == '\n')
2428 return_p = 0;
2429
2430 /* If the prefix is changing, print the previous suffix, a new line,
2431 and the new prefix. */
c5aa993b 2432 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
c906108c 2433 {
9846de1b
JM
2434 fputs_unfiltered (prev_suffix, gdb_stdlog);
2435 fputs_unfiltered ("\n", gdb_stdlog);
2436 fputs_unfiltered (prefix, gdb_stdlog);
c906108c
SS
2437 }
2438
2439 /* Print prefix if we printed a newline during the previous call. */
2440 if (new_line)
2441 {
2442 new_line = 0;
9846de1b 2443 fputs_unfiltered (prefix, gdb_stdlog);
c906108c
SS
2444 }
2445
2446 prev_prefix = prefix;
2447 prev_suffix = suffix;
2448
2449 /* Output characters in a printable format. */
2450 while ((ch = *string++) != '\0')
2451 {
2452 switch (ch)
c5aa993b 2453 {
c906108c
SS
2454 default:
2455 if (isprint (ch))
9846de1b 2456 fputc_unfiltered (ch, gdb_stdlog);
c906108c
SS
2457
2458 else
9846de1b 2459 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
c906108c
SS
2460 break;
2461
c5aa993b
JM
2462 case '\\':
2463 fputs_unfiltered ("\\\\", gdb_stdlog);
2464 break;
2465 case '\b':
2466 fputs_unfiltered ("\\b", gdb_stdlog);
2467 break;
2468 case '\f':
2469 fputs_unfiltered ("\\f", gdb_stdlog);
2470 break;
2471 case '\n':
2472 new_line = 1;
2473 fputs_unfiltered ("\\n", gdb_stdlog);
2474 break;
2475 case '\r':
2476 fputs_unfiltered ("\\r", gdb_stdlog);
2477 break;
2478 case '\t':
2479 fputs_unfiltered ("\\t", gdb_stdlog);
2480 break;
2481 case '\v':
2482 fputs_unfiltered ("\\v", gdb_stdlog);
2483 break;
2484 }
c906108c
SS
2485
2486 return_p = ch == '\r';
2487 }
2488
2489 /* Print suffix if we printed a newline. */
2490 if (new_line)
2491 {
9846de1b
JM
2492 fputs_unfiltered (suffix, gdb_stdlog);
2493 fputs_unfiltered ("\n", gdb_stdlog);
c906108c
SS
2494 }
2495}
2496
2497
2498/* Print a variable number of ARGS using format FORMAT. If this
2499 information is going to put the amount written (since the last call
2500 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2501 call prompt_for_continue to get the users permision to continue.
2502
2503 Unlike fprintf, this function does not return a value.
2504
2505 We implement three variants, vfprintf (takes a vararg list and stream),
2506 fprintf (takes a stream to write on), and printf (the usual).
2507
2508 Note also that a longjmp to top level may occur in this routine
2509 (since prompt_for_continue may do so) so this routine should not be
2510 called when cleanups are not in place. */
2511
2512static void
fba45db2
KB
2513vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2514 va_list args, int filter)
c906108c
SS
2515{
2516 char *linebuffer;
2517 struct cleanup *old_cleanups;
2518
e623b504 2519 linebuffer = xstrvprintf (format, args);
b8c9b27d 2520 old_cleanups = make_cleanup (xfree, linebuffer);
c906108c
SS
2521 fputs_maybe_filtered (linebuffer, stream, filter);
2522 do_cleanups (old_cleanups);
2523}
2524
2525
2526void
fba45db2 2527vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
c906108c
SS
2528{
2529 vfprintf_maybe_filtered (stream, format, args, 1);
2530}
2531
2532void
fba45db2 2533vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
c906108c
SS
2534{
2535 char *linebuffer;
2536 struct cleanup *old_cleanups;
2537
e623b504 2538 linebuffer = xstrvprintf (format, args);
b8c9b27d 2539 old_cleanups = make_cleanup (xfree, linebuffer);
75feb17d
DJ
2540 if (debug_timestamp && stream == gdb_stdlog)
2541 {
2542 struct timeval tm;
2543 char *timestamp;
6e5abd65 2544 int len, need_nl;
75feb17d
DJ
2545
2546 gettimeofday (&tm, NULL);
6e5abd65
PA
2547
2548 len = strlen (linebuffer);
2549 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2550
2551 timestamp = xstrprintf ("%ld:%ld %s%s",
2552 (long) tm.tv_sec, (long) tm.tv_usec,
2553 linebuffer,
2554 need_nl ? "\n": "");
75feb17d
DJ
2555 make_cleanup (xfree, timestamp);
2556 fputs_unfiltered (timestamp, stream);
2557 }
6e5abd65
PA
2558 else
2559 fputs_unfiltered (linebuffer, stream);
c906108c
SS
2560 do_cleanups (old_cleanups);
2561}
2562
2563void
fba45db2 2564vprintf_filtered (const char *format, va_list args)
c906108c
SS
2565{
2566 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2567}
2568
2569void
fba45db2 2570vprintf_unfiltered (const char *format, va_list args)
c906108c
SS
2571{
2572 vfprintf_unfiltered (gdb_stdout, format, args);
2573}
2574
c906108c 2575void
8731e58e 2576fprintf_filtered (struct ui_file *stream, const char *format, ...)
c906108c
SS
2577{
2578 va_list args;
e0627e85 2579
c906108c 2580 va_start (args, format);
c906108c
SS
2581 vfprintf_filtered (stream, format, args);
2582 va_end (args);
2583}
2584
c906108c 2585void
8731e58e 2586fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
c906108c
SS
2587{
2588 va_list args;
e0627e85 2589
c906108c 2590 va_start (args, format);
c906108c
SS
2591 vfprintf_unfiltered (stream, format, args);
2592 va_end (args);
2593}
2594
2595/* Like fprintf_filtered, but prints its result indented.
2596 Called as fprintfi_filtered (spaces, stream, format, ...); */
2597
c906108c 2598void
8731e58e
AC
2599fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2600 ...)
c906108c
SS
2601{
2602 va_list args;
e0627e85 2603
c906108c 2604 va_start (args, format);
c906108c
SS
2605 print_spaces_filtered (spaces, stream);
2606
2607 vfprintf_filtered (stream, format, args);
2608 va_end (args);
2609}
2610
2611
c906108c 2612void
8731e58e 2613printf_filtered (const char *format, ...)
c906108c
SS
2614{
2615 va_list args;
e0627e85 2616
c906108c 2617 va_start (args, format);
c906108c
SS
2618 vfprintf_filtered (gdb_stdout, format, args);
2619 va_end (args);
2620}
2621
2622
c906108c 2623void
8731e58e 2624printf_unfiltered (const char *format, ...)
c906108c
SS
2625{
2626 va_list args;
e0627e85 2627
c906108c 2628 va_start (args, format);
c906108c
SS
2629 vfprintf_unfiltered (gdb_stdout, format, args);
2630 va_end (args);
2631}
2632
2633/* Like printf_filtered, but prints it's result indented.
2634 Called as printfi_filtered (spaces, format, ...); */
2635
c906108c 2636void
8731e58e 2637printfi_filtered (int spaces, const char *format, ...)
c906108c
SS
2638{
2639 va_list args;
e0627e85 2640
c906108c 2641 va_start (args, format);
c906108c
SS
2642 print_spaces_filtered (spaces, gdb_stdout);
2643 vfprintf_filtered (gdb_stdout, format, args);
2644 va_end (args);
2645}
2646
2647/* Easy -- but watch out!
2648
2649 This routine is *not* a replacement for puts()! puts() appends a newline.
2650 This one doesn't, and had better not! */
2651
2652void
fba45db2 2653puts_filtered (const char *string)
c906108c
SS
2654{
2655 fputs_filtered (string, gdb_stdout);
2656}
2657
2658void
fba45db2 2659puts_unfiltered (const char *string)
c906108c
SS
2660{
2661 fputs_unfiltered (string, gdb_stdout);
2662}
2663
2664/* Return a pointer to N spaces and a null. The pointer is good
2665 until the next call to here. */
2666char *
fba45db2 2667n_spaces (int n)
c906108c 2668{
392a587b
JM
2669 char *t;
2670 static char *spaces = 0;
2671 static int max_spaces = -1;
c906108c
SS
2672
2673 if (n > max_spaces)
2674 {
2675 if (spaces)
b8c9b27d 2676 xfree (spaces);
c5aa993b
JM
2677 spaces = (char *) xmalloc (n + 1);
2678 for (t = spaces + n; t != spaces;)
c906108c
SS
2679 *--t = ' ';
2680 spaces[n] = '\0';
2681 max_spaces = n;
2682 }
2683
2684 return spaces + max_spaces - n;
2685}
2686
2687/* Print N spaces. */
2688void
fba45db2 2689print_spaces_filtered (int n, struct ui_file *stream)
c906108c
SS
2690{
2691 fputs_filtered (n_spaces (n), stream);
2692}
2693\f
4a351cef 2694/* C++/ObjC demangler stuff. */
c906108c 2695
389e51db
AC
2696/* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2697 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2698 If the name is not mangled, or the language for the name is unknown, or
581e13c1 2699 demangling is off, the name is printed in its "raw" form. */
c906108c
SS
2700
2701void
8731e58e
AC
2702fprintf_symbol_filtered (struct ui_file *stream, char *name,
2703 enum language lang, int arg_mode)
c906108c
SS
2704{
2705 char *demangled;
2706
2707 if (name != NULL)
2708 {
2709 /* If user wants to see raw output, no problem. */
2710 if (!demangle)
2711 {
2712 fputs_filtered (name, stream);
2713 }
2714 else
2715 {
9a3d7dfd 2716 demangled = language_demangle (language_def (lang), name, arg_mode);
c906108c
SS
2717 fputs_filtered (demangled ? demangled : name, stream);
2718 if (demangled != NULL)
2719 {
b8c9b27d 2720 xfree (demangled);
c906108c
SS
2721 }
2722 }
2723 }
2724}
2725
2726/* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2727 differences in whitespace. Returns 0 if they match, non-zero if they
2728 don't (slightly different than strcmp()'s range of return values).
c5aa993b 2729
c906108c
SS
2730 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2731 This "feature" is useful when searching for matching C++ function names
2732 (such as if the user types 'break FOO', where FOO is a mangled C++
581e13c1 2733 function). */
c906108c
SS
2734
2735int
fba45db2 2736strcmp_iw (const char *string1, const char *string2)
c906108c
SS
2737{
2738 while ((*string1 != '\0') && (*string2 != '\0'))
2739 {
2740 while (isspace (*string1))
2741 {
2742 string1++;
2743 }
2744 while (isspace (*string2))
2745 {
2746 string2++;
2747 }
559a7a62
JK
2748 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2749 break;
2750 if (case_sensitivity == case_sensitive_off
2751 && (tolower ((unsigned char) *string1)
2752 != tolower ((unsigned char) *string2)))
2753 break;
c906108c
SS
2754 if (*string1 != '\0')
2755 {
2756 string1++;
2757 string2++;
2758 }
2759 }
2760 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2761}
2de7ced7 2762
0fe19209
DC
2763/* This is like strcmp except that it ignores whitespace and treats
2764 '(' as the first non-NULL character in terms of ordering. Like
2765 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2766 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2767 according to that ordering.
2768
2769 If a list is sorted according to this function and if you want to
2770 find names in the list that match some fixed NAME according to
2771 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2772 where this function would put NAME.
2773
559a7a62
JK
2774 This function must be neutral to the CASE_SENSITIVITY setting as the user
2775 may choose it during later lookup. Therefore this function always sorts
2776 primarily case-insensitively and secondarily case-sensitively.
2777
0fe19209
DC
2778 Here are some examples of why using strcmp to sort is a bad idea:
2779
2780 Whitespace example:
2781
2782 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2783 we try to do a search for "foo<char*>", strcmp will locate this
2784 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2785 will start looking at strings beginning with "goo", and will never
2786 see the correct match of "foo<char *>".
2787
2788 Parenthesis example:
2789
2790 In practice, this is less like to be an issue, but I'll give it a
2791 shot. Let's assume that '$' is a legitimate character to occur in
2792 symbols. (Which may well even be the case on some systems.) Then
2793 say that the partial symbol table contains "foo$" and "foo(int)".
2794 strcmp will put them in this order, since '$' < '('. Now, if the
2795 user searches for "foo", then strcmp will sort "foo" before "foo$".
2796 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2797 "foo") is false, so it won't proceed to the actual match of
2798 "foo(int)" with "foo". */
2799
2800int
2801strcmp_iw_ordered (const char *string1, const char *string2)
2802{
559a7a62
JK
2803 const char *saved_string1 = string1, *saved_string2 = string2;
2804 enum case_sensitivity case_pass = case_sensitive_off;
2805
2806 for (;;)
0fe19209 2807 {
b11b1f88
JK
2808 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2809 Provide stub characters if we are already at the end of one of the
2810 strings. */
2811 char c1 = 'X', c2 = 'X';
2812
2813 while (*string1 != '\0' && *string2 != '\0')
0fe19209 2814 {
b11b1f88
JK
2815 while (isspace (*string1))
2816 string1++;
2817 while (isspace (*string2))
2818 string2++;
2819
559a7a62
JK
2820 switch (case_pass)
2821 {
2822 case case_sensitive_off:
2823 c1 = tolower ((unsigned char) *string1);
2824 c2 = tolower ((unsigned char) *string2);
2825 break;
2826 case case_sensitive_on:
b11b1f88
JK
2827 c1 = *string1;
2828 c2 = *string2;
559a7a62
JK
2829 break;
2830 }
b11b1f88
JK
2831 if (c1 != c2)
2832 break;
2833
2834 if (*string1 != '\0')
2835 {
2836 string1++;
2837 string2++;
2838 }
0fe19209 2839 }
b11b1f88
JK
2840
2841 switch (*string1)
0fe19209 2842 {
b11b1f88
JK
2843 /* Characters are non-equal unless they're both '\0'; we want to
2844 make sure we get the comparison right according to our
2845 comparison in the cases where one of them is '\0' or '('. */
2846 case '\0':
2847 if (*string2 == '\0')
559a7a62 2848 break;
b11b1f88
JK
2849 else
2850 return -1;
2851 case '(':
2852 if (*string2 == '\0')
2853 return 1;
2854 else
2855 return -1;
2856 default:
2857 if (*string2 == '\0' || *string2 == '(')
2858 return 1;
559a7a62
JK
2859 else if (c1 > c2)
2860 return 1;
2861 else if (c1 < c2)
2862 return -1;
2863 /* PASSTHRU */
0fe19209 2864 }
559a7a62
JK
2865
2866 if (case_pass == case_sensitive_on)
2867 return 0;
2868
2869 /* Otherwise the strings were equal in case insensitive way, make
2870 a more fine grained comparison in a case sensitive way. */
2871
2872 case_pass = case_sensitive_on;
2873 string1 = saved_string1;
2874 string2 = saved_string2;
0fe19209 2875 }
0fe19209
DC
2876}
2877
2de7ced7
DJ
2878/* A simple comparison function with opposite semantics to strcmp. */
2879
2880int
2881streq (const char *lhs, const char *rhs)
2882{
2883 return !strcmp (lhs, rhs);
2884}
c906108c 2885\f
c5aa993b 2886
c906108c 2887/*
c5aa993b
JM
2888 ** subset_compare()
2889 ** Answer whether string_to_compare is a full or partial match to
2890 ** template_string. The partial match must be in sequence starting
2891 ** at index 0.
2892 */
c906108c 2893int
fba45db2 2894subset_compare (char *string_to_compare, char *template_string)
7a292a7a
SS
2895{
2896 int match;
e0627e85 2897
8731e58e
AC
2898 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2899 && strlen (string_to_compare) <= strlen (template_string))
2900 match =
2901 (strncmp
2902 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
7a292a7a
SS
2903 else
2904 match = 0;
2905 return match;
2906}
c906108c 2907
7a292a7a 2908static void
fba45db2 2909pagination_on_command (char *arg, int from_tty)
c906108c
SS
2910{
2911 pagination_enabled = 1;
2912}
2913
7a292a7a 2914static void
fba45db2 2915pagination_off_command (char *arg, int from_tty)
c906108c
SS
2916{
2917 pagination_enabled = 0;
2918}
75feb17d
DJ
2919
2920static void
2921show_debug_timestamp (struct ui_file *file, int from_tty,
2922 struct cmd_list_element *c, const char *value)
2923{
3e43a32a
MS
2924 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2925 value);
75feb17d 2926}
c906108c 2927\f
c5aa993b 2928
c906108c 2929void
fba45db2 2930initialize_utils (void)
c906108c 2931{
35096d9d
AC
2932 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2933Set number of characters gdb thinks are in a line."), _("\
2934Show number of characters gdb thinks are in a line."), NULL,
2935 set_width_command,
920d2a44 2936 show_chars_per_line,
35096d9d
AC
2937 &setlist, &showlist);
2938
2939 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2940Set number of lines gdb thinks are in a page."), _("\
2941Show number of lines gdb thinks are in a page."), NULL,
2942 set_height_command,
920d2a44 2943 show_lines_per_page,
35096d9d 2944 &setlist, &showlist);
c5aa993b 2945
c906108c
SS
2946 init_page_info ();
2947
5bf193a2
AC
2948 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2949Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2950Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2951 NULL,
920d2a44 2952 show_demangle,
5bf193a2
AC
2953 &setprintlist, &showprintlist);
2954
2955 add_setshow_boolean_cmd ("pagination", class_support,
2956 &pagination_enabled, _("\
2957Set state of pagination."), _("\
2958Show state of pagination."), NULL,
2959 NULL,
920d2a44 2960 show_pagination_enabled,
5bf193a2 2961 &setlist, &showlist);
4261bedc 2962
c906108c
SS
2963 if (xdb_commands)
2964 {
c5aa993b 2965 add_com ("am", class_support, pagination_on_command,
1bedd215 2966 _("Enable pagination"));
c5aa993b 2967 add_com ("sm", class_support, pagination_off_command,
1bedd215 2968 _("Disable pagination"));
c906108c
SS
2969 }
2970
5bf193a2
AC
2971 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2972 &sevenbit_strings, _("\
2973Set printing of 8-bit characters in strings as \\nnn."), _("\
2974Show printing of 8-bit characters in strings as \\nnn."), NULL,
2975 NULL,
920d2a44 2976 show_sevenbit_strings,
5bf193a2
AC
2977 &setprintlist, &showprintlist);
2978
2979 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
2980Set demangling of C++/ObjC names in disassembly listings."), _("\
2981Show demangling of C++/ObjC names in disassembly listings."), NULL,
2982 NULL,
920d2a44 2983 show_asm_demangle,
5bf193a2 2984 &setprintlist, &showprintlist);
75feb17d
DJ
2985
2986 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2987 &debug_timestamp, _("\
2988Set timestamping of debugging messages."), _("\
2989Show timestamping of debugging messages."), _("\
2990When set, debugging messages will be marked with seconds and microseconds."),
2991 NULL,
2992 show_debug_timestamp,
2993 &setdebuglist, &showdebuglist);
c906108c
SS
2994}
2995
581e13c1 2996/* Machine specific function to handle SIGWINCH signal. */
c906108c
SS
2997
2998#ifdef SIGWINCH_HANDLER_BODY
c5aa993b 2999SIGWINCH_HANDLER_BODY
c906108c 3000#endif
581e13c1
MS
3001/* Print routines to handle variable size regs, etc. */
3002/* Temporary storage using circular buffer. */
c906108c 3003#define NUMCELLS 16
0759e0bf 3004#define CELLSIZE 50
c5aa993b 3005static char *
fba45db2 3006get_cell (void)
c906108c
SS
3007{
3008 static char buf[NUMCELLS][CELLSIZE];
c5aa993b 3009 static int cell = 0;
e0627e85 3010
c5aa993b
JM
3011 if (++cell >= NUMCELLS)
3012 cell = 0;
c906108c
SS
3013 return buf[cell];
3014}
3015
66bf4b3a 3016const char *
5af949e3 3017paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
66bf4b3a
AC
3018{
3019 /* Truncate address to the size of a target address, avoiding shifts
3020 larger or equal than the width of a CORE_ADDR. The local
3021 variable ADDR_BIT stops the compiler reporting a shift overflow
581e13c1 3022 when it won't occur. */
66bf4b3a
AC
3023 /* NOTE: This assumes that the significant address information is
3024 kept in the least significant bits of ADDR - the upper bits were
76e71323 3025 either zero or sign extended. Should gdbarch_address_to_pointer or
66bf4b3a
AC
3026 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
3027
5af949e3 3028 int addr_bit = gdbarch_addr_bit (gdbarch);
66bf4b3a
AC
3029
3030 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3031 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
3032 return hex_string (addr);
3033}
3034
f1310107
TJB
3035/* This function is described in "defs.h". */
3036
3037const char *
3038print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
3039{
3040 int addr_bit = gdbarch_addr_bit (gdbarch);
3041
3042 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3043 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
3044
3045 /* FIXME: cagney/2002-05-03: Need local_address_string() function
3046 that returns the language localized string formatted to a width
3047 based on gdbarch_addr_bit. */
3048 if (addr_bit <= 32)
3049 return hex_string_custom (address, 8);
3050 else
3051 return hex_string_custom (address, 16);
3052}
3053
8cf46f62
MK
3054static char *
3055decimal2str (char *sign, ULONGEST addr, int width)
104c1213 3056{
8cf46f62 3057 /* Steal code from valprint.c:print_decimal(). Should this worry
581e13c1 3058 about the real size of addr as the above does? */
104c1213 3059 unsigned long temp[3];
8cf46f62 3060 char *str = get_cell ();
104c1213 3061 int i = 0;
5d502164 3062
104c1213
JM
3063 do
3064 {
3065 temp[i] = addr % (1000 * 1000 * 1000);
3066 addr /= (1000 * 1000 * 1000);
3067 i++;
bb599908 3068 width -= 9;
104c1213
JM
3069 }
3070 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
8cf46f62 3071
bb599908
PH
3072 width += 9;
3073 if (width < 0)
3074 width = 0;
8cf46f62 3075
104c1213
JM
3076 switch (i)
3077 {
3078 case 1:
8cf46f62 3079 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
104c1213
JM
3080 break;
3081 case 2:
8cf46f62
MK
3082 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
3083 temp[1], temp[0]);
104c1213
JM
3084 break;
3085 case 3:
8cf46f62
MK
3086 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
3087 temp[2], temp[1], temp[0]);
bb599908
PH
3088 break;
3089 default:
3090 internal_error (__FILE__, __LINE__,
e2e0b3e5 3091 _("failed internal consistency check"));
bb599908 3092 }
8cf46f62
MK
3093
3094 return str;
bb599908
PH
3095}
3096
8cf46f62
MK
3097static char *
3098octal2str (ULONGEST addr, int width)
bb599908
PH
3099{
3100 unsigned long temp[3];
8cf46f62 3101 char *str = get_cell ();
bb599908 3102 int i = 0;
5d502164 3103
bb599908
PH
3104 do
3105 {
3106 temp[i] = addr % (0100000 * 0100000);
3107 addr /= (0100000 * 0100000);
3108 i++;
3109 width -= 10;
3110 }
3111 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
8cf46f62 3112
bb599908
PH
3113 width += 10;
3114 if (width < 0)
3115 width = 0;
8cf46f62 3116
bb599908
PH
3117 switch (i)
3118 {
3119 case 1:
3120 if (temp[0] == 0)
8cf46f62 3121 xsnprintf (str, CELLSIZE, "%*o", width, 0);
bb599908 3122 else
8cf46f62 3123 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
bb599908
PH
3124 break;
3125 case 2:
8cf46f62 3126 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
bb599908
PH
3127 break;
3128 case 3:
8cf46f62
MK
3129 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
3130 temp[2], temp[1], temp[0]);
104c1213
JM
3131 break;
3132 default:
8731e58e 3133 internal_error (__FILE__, __LINE__,
e2e0b3e5 3134 _("failed internal consistency check"));
104c1213 3135 }
8cf46f62
MK
3136
3137 return str;
104c1213
JM
3138}
3139
3140char *
623d3eb1 3141pulongest (ULONGEST u)
104c1213 3142{
623d3eb1 3143 return decimal2str ("", u, 0);
104c1213
JM
3144}
3145
3146char *
623d3eb1 3147plongest (LONGEST l)
104c1213 3148{
623d3eb1
DE
3149 if (l < 0)
3150 return decimal2str ("-", -l, 0);
104c1213 3151 else
623d3eb1 3152 return decimal2str ("", l, 0);
104c1213
JM
3153}
3154
8cf46f62 3155/* Eliminate warning from compiler on 32-bit systems. */
5683e87a
AC
3156static int thirty_two = 32;
3157
104c1213 3158char *
5683e87a 3159phex (ULONGEST l, int sizeof_l)
104c1213 3160{
45a1e866 3161 char *str;
8cf46f62 3162
5683e87a 3163 switch (sizeof_l)
104c1213
JM
3164 {
3165 case 8:
45a1e866 3166 str = get_cell ();
8cf46f62
MK
3167 xsnprintf (str, CELLSIZE, "%08lx%08lx",
3168 (unsigned long) (l >> thirty_two),
3169 (unsigned long) (l & 0xffffffff));
104c1213
JM
3170 break;
3171 case 4:
45a1e866 3172 str = get_cell ();
8cf46f62 3173 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
104c1213
JM
3174 break;
3175 case 2:
45a1e866 3176 str = get_cell ();
8cf46f62 3177 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
104c1213
JM
3178 break;
3179 default:
45a1e866 3180 str = phex (l, sizeof (l));
5683e87a 3181 break;
104c1213 3182 }
8cf46f62 3183
5683e87a 3184 return str;
104c1213
JM
3185}
3186
c5aa993b 3187char *
5683e87a 3188phex_nz (ULONGEST l, int sizeof_l)
c906108c 3189{
faf833ca 3190 char *str;
8cf46f62 3191
5683e87a 3192 switch (sizeof_l)
c906108c 3193 {
c5aa993b
JM
3194 case 8:
3195 {
5683e87a 3196 unsigned long high = (unsigned long) (l >> thirty_two);
5d502164 3197
faf833ca 3198 str = get_cell ();
c5aa993b 3199 if (high == 0)
8cf46f62
MK
3200 xsnprintf (str, CELLSIZE, "%lx",
3201 (unsigned long) (l & 0xffffffff));
c5aa993b 3202 else
8cf46f62
MK
3203 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3204 (unsigned long) (l & 0xffffffff));
c906108c 3205 break;
c5aa993b
JM
3206 }
3207 case 4:
faf833ca 3208 str = get_cell ();
8cf46f62 3209 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
c5aa993b
JM
3210 break;
3211 case 2:
faf833ca 3212 str = get_cell ();
8cf46f62 3213 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
c5aa993b
JM
3214 break;
3215 default:
faf833ca 3216 str = phex_nz (l, sizeof (l));
5683e87a 3217 break;
c906108c 3218 }
8cf46f62 3219
5683e87a 3220 return str;
c906108c 3221}
ac2e2ef7 3222
0759e0bf
AC
3223/* Converts a LONGEST to a C-format hexadecimal literal and stores it
3224 in a static string. Returns a pointer to this string. */
3225char *
3226hex_string (LONGEST num)
3227{
3228 char *result = get_cell ();
e0627e85 3229
8cf46f62 3230 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
0759e0bf
AC
3231 return result;
3232}
3233
3234/* Converts a LONGEST number to a C-format hexadecimal literal and
3235 stores it in a static string. Returns a pointer to this string
3236 that is valid until the next call. The number is padded on the
3237 left with 0s to at least WIDTH characters. */
3238char *
3239hex_string_custom (LONGEST num, int width)
3240{
3241 char *result = get_cell ();
3242 char *result_end = result + CELLSIZE - 1;
3243 const char *hex = phex_nz (num, sizeof (num));
3244 int hex_len = strlen (hex);
3245
3246 if (hex_len > width)
3247 width = hex_len;
3248 if (width + 2 >= CELLSIZE)
3e43a32a
MS
3249 internal_error (__FILE__, __LINE__, _("\
3250hex_string_custom: insufficient space to store result"));
0759e0bf
AC
3251
3252 strcpy (result_end - width - 2, "0x");
3253 memset (result_end - width, '0', width);
3254 strcpy (result_end - hex_len, hex);
3255 return result_end - width - 2;
3256}
ac2e2ef7 3257
bb599908
PH
3258/* Convert VAL to a numeral in the given radix. For
3259 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3260 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3261 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3262 * to use C format in all cases. If it is false, then 'x'
581e13c1 3263 * and 'o' formats do not include a prefix (0x or leading 0). */
bb599908
PH
3264
3265char *
3266int_string (LONGEST val, int radix, int is_signed, int width,
3267 int use_c_format)
3268{
3269 switch (radix)
3270 {
3271 case 16:
3272 {
3273 char *result;
5d502164 3274
bb599908
PH
3275 if (width == 0)
3276 result = hex_string (val);
3277 else
3278 result = hex_string_custom (val, width);
3279 if (! use_c_format)
3280 result += 2;
3281 return result;
3282 }
3283 case 10:
3284 {
bb599908 3285 if (is_signed && val < 0)
8cf46f62 3286 return decimal2str ("-", -val, width);
bb599908 3287 else
8cf46f62 3288 return decimal2str ("", val, width);
bb599908
PH
3289 }
3290 case 8:
3291 {
8cf46f62 3292 char *result = octal2str (val, width);
5d502164 3293
bb599908
PH
3294 if (use_c_format || val == 0)
3295 return result;
3296 else
3297 return result + 1;
3298 }
3299 default:
3300 internal_error (__FILE__, __LINE__,
e2e0b3e5 3301 _("failed internal consistency check"));
bb599908
PH
3302 }
3303}
3304
03dd37c3
AC
3305/* Convert a CORE_ADDR into a string. */
3306const char *
3307core_addr_to_string (const CORE_ADDR addr)
49b563f9
KS
3308{
3309 char *str = get_cell ();
e0627e85 3310
49b563f9
KS
3311 strcpy (str, "0x");
3312 strcat (str, phex (addr, sizeof (addr)));
3313 return str;
3314}
3315
3316const char *
3317core_addr_to_string_nz (const CORE_ADDR addr)
03dd37c3
AC
3318{
3319 char *str = get_cell ();
e0627e85 3320
03dd37c3
AC
3321 strcpy (str, "0x");
3322 strcat (str, phex_nz (addr, sizeof (addr)));
3323 return str;
3324}
3325
3326/* Convert a string back into a CORE_ADDR. */
3327CORE_ADDR
3328string_to_core_addr (const char *my_string)
3329{
3330 CORE_ADDR addr = 0;
9544c605 3331
03dd37c3
AC
3332 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3333 {
ced572fe 3334 /* Assume that it is in hex. */
03dd37c3 3335 int i;
5d502164 3336
03dd37c3
AC
3337 for (i = 2; my_string[i] != '\0'; i++)
3338 {
3339 if (isdigit (my_string[i]))
3340 addr = (my_string[i] - '0') + (addr * 16);
8731e58e 3341 else if (isxdigit (my_string[i]))
03dd37c3
AC
3342 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3343 else
63f06803 3344 error (_("invalid hex \"%s\""), my_string);
03dd37c3
AC
3345 }
3346 }
3347 else
3348 {
3349 /* Assume that it is in decimal. */
3350 int i;
5d502164 3351
03dd37c3
AC
3352 for (i = 0; my_string[i] != '\0'; i++)
3353 {
3354 if (isdigit (my_string[i]))
3355 addr = (my_string[i] - '0') + (addr * 10);
3356 else
63f06803 3357 error (_("invalid decimal \"%s\""), my_string);
03dd37c3
AC
3358 }
3359 }
9544c605 3360
03dd37c3
AC
3361 return addr;
3362}
58d370e0 3363
17ea7499
CES
3364const char *
3365host_address_to_string (const void *addr)
3366{
3367 char *str = get_cell ();
ea8992ce 3368
773698b5 3369 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
17ea7499
CES
3370 return str;
3371}
3372
58d370e0
TT
3373char *
3374gdb_realpath (const char *filename)
3375{
70d35819
AC
3376 /* Method 1: The system has a compile time upper bound on a filename
3377 path. Use that and realpath() to canonicalize the name. This is
3378 the most common case. Note that, if there isn't a compile time
3379 upper bound, you want to avoid realpath() at all costs. */
a4db0f07 3380#if defined(HAVE_REALPATH)
70d35819 3381 {
a4db0f07 3382# if defined (PATH_MAX)
70d35819 3383 char buf[PATH_MAX];
a4db0f07
RH
3384# define USE_REALPATH
3385# elif defined (MAXPATHLEN)
70d35819 3386 char buf[MAXPATHLEN];
a4db0f07
RH
3387# define USE_REALPATH
3388# endif
70d35819 3389# if defined (USE_REALPATH)
82c0260e 3390 const char *rp = realpath (filename, buf);
5d502164 3391
70d35819
AC
3392 if (rp == NULL)
3393 rp = filename;
3394 return xstrdup (rp);
70d35819 3395# endif
6f88d630 3396 }
a4db0f07
RH
3397#endif /* HAVE_REALPATH */
3398
70d35819
AC
3399 /* Method 2: The host system (i.e., GNU) has the function
3400 canonicalize_file_name() which malloc's a chunk of memory and
3401 returns that, use that. */
3402#if defined(HAVE_CANONICALIZE_FILE_NAME)
3403 {
3404 char *rp = canonicalize_file_name (filename);
5d502164 3405
70d35819
AC
3406 if (rp == NULL)
3407 return xstrdup (filename);
3408 else
3409 return rp;
3410 }
58d370e0 3411#endif
70d35819 3412
6411e720
AC
3413 /* FIXME: cagney/2002-11-13:
3414
3415 Method 2a: Use realpath() with a NULL buffer. Some systems, due
7a9dd1b2 3416 to the problems described in method 3, have modified their
6411e720
AC
3417 realpath() implementation so that it will allocate a buffer when
3418 NULL is passed in. Before this can be used, though, some sort of
3419 configure time test would need to be added. Otherwize the code
3420 will likely core dump. */
3421
70d35819
AC
3422 /* Method 3: Now we're getting desperate! The system doesn't have a
3423 compile time buffer size and no alternative function. Query the
3424 OS, using pathconf(), for the buffer limit. Care is needed
3425 though, some systems do not limit PATH_MAX (return -1 for
3426 pathconf()) making it impossible to pass a correctly sized buffer
3427 to realpath() (it could always overflow). On those systems, we
3428 skip this. */
3429#if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3430 {
3431 /* Find out the max path size. */
3432 long path_max = pathconf ("/", _PC_PATH_MAX);
5d502164 3433
70d35819
AC
3434 if (path_max > 0)
3435 {
3436 /* PATH_MAX is bounded. */
3437 char *buf = alloca (path_max);
3438 char *rp = realpath (filename, buf);
5d502164 3439
70d35819
AC
3440 return xstrdup (rp ? rp : filename);
3441 }
3442 }
3443#endif
3444
3445 /* This system is a lost cause, just dup the buffer. */
3446 return xstrdup (filename);
58d370e0 3447}
303c8ebd
JB
3448
3449/* Return a copy of FILENAME, with its directory prefix canonicalized
3450 by gdb_realpath. */
3451
3452char *
3453xfullpath (const char *filename)
3454{
3455 const char *base_name = lbasename (filename);
3456 char *dir_name;
3457 char *real_path;
3458 char *result;
3459
3460 /* Extract the basename of filename, and return immediately
581e13c1 3461 a copy of filename if it does not contain any directory prefix. */
303c8ebd
JB
3462 if (base_name == filename)
3463 return xstrdup (filename);
3464
3465 dir_name = alloca ((size_t) (base_name - filename + 2));
3466 /* Allocate enough space to store the dir_name + plus one extra
3467 character sometimes needed under Windows (see below), and
581e13c1 3468 then the closing \000 character. */
303c8ebd
JB
3469 strncpy (dir_name, filename, base_name - filename);
3470 dir_name[base_name - filename] = '\000';
3471
3472#ifdef HAVE_DOS_BASED_FILE_SYSTEM
3473 /* We need to be careful when filename is of the form 'd:foo', which
3474 is equivalent of d:./foo, which is totally different from d:/foo. */
8731e58e 3475 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
303c8ebd
JB
3476 {
3477 dir_name[2] = '.';
3478 dir_name[3] = '\000';
3479 }
3480#endif
3481
3482 /* Canonicalize the directory prefix, and build the resulting
581e13c1 3483 filename. If the dirname realpath already contains an ending
303c8ebd
JB
3484 directory separator, avoid doubling it. */
3485 real_path = gdb_realpath (dir_name);
3486 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
c4f7c687 3487 result = concat (real_path, base_name, (char *) NULL);
303c8ebd 3488 else
c4f7c687 3489 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
303c8ebd
JB
3490
3491 xfree (real_path);
3492 return result;
3493}
5b5d99cf
JB
3494
3495
3496/* This is the 32-bit CRC function used by the GNU separate debug
3497 facility. An executable may contain a section named
3498 .gnu_debuglink, which holds the name of a separate executable file
3499 containing its debug info, and a checksum of that file's contents,
3500 computed using this function. */
3501unsigned long
3502gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3503{
6e0a4fbc 3504 static const unsigned int crc32_table[256] = {
8731e58e
AC
3505 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3506 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3507 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3508 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3509 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3510 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3511 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3512 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3513 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3514 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3515 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3516 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3517 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3518 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3519 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3520 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3521 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3522 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3523 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3524 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3525 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3526 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3527 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3528 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3529 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3530 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3531 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3532 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3533 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3534 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3535 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3536 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3537 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3538 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3539 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3540 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3541 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3542 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3543 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3544 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3545 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3546 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3547 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3548 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3549 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3550 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3551 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3552 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3553 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3554 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3555 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3556 0x2d02ef8d
3557 };
5b5d99cf
JB
3558 unsigned char *end;
3559
3560 crc = ~crc & 0xffffffff;
3561 for (end = buf + len; buf < end; ++buf)
3562 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
82ae4854 3563 return ~crc & 0xffffffff;
5b5d99cf 3564}
5b03f266
AC
3565
3566ULONGEST
3567align_up (ULONGEST v, int n)
3568{
3569 /* Check that N is really a power of two. */
3570 gdb_assert (n && (n & (n-1)) == 0);
3571 return (v + n - 1) & -n;
3572}
3573
3574ULONGEST
3575align_down (ULONGEST v, int n)
3576{
3577 /* Check that N is really a power of two. */
3578 gdb_assert (n && (n & (n-1)) == 0);
3579 return (v & -n);
3580}
ae5a43e0
DJ
3581
3582/* Allocation function for the libiberty hash table which uses an
3583 obstack. The obstack is passed as DATA. */
3584
3585void *
3586hashtab_obstack_allocate (void *data, size_t size, size_t count)
3587{
3588 unsigned int total = size * count;
3589 void *ptr = obstack_alloc ((struct obstack *) data, total);
e0627e85 3590
ae5a43e0
DJ
3591 memset (ptr, 0, total);
3592 return ptr;
3593}
3594
3595/* Trivial deallocation function for the libiberty splay tree and hash
3596 table - don't deallocate anything. Rely on later deletion of the
3597 obstack. DATA will be the obstack, although it is not needed
3598 here. */
3599
3600void
3601dummy_obstack_deallocate (void *object, void *data)
3602{
3603 return;
3604}
253c8abb
DJ
3605
3606/* The bit offset of the highest byte in a ULONGEST, for overflow
3607 checking. */
3608
3609#define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3610
3611/* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3612 where 2 <= BASE <= 36. */
3613
3614static int
3615is_digit_in_base (unsigned char digit, int base)
3616{
3617 if (!isalnum (digit))
3618 return 0;
3619 if (base <= 10)
3620 return (isdigit (digit) && digit < base + '0');
3621 else
3622 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3623}
3624
3625static int
3626digit_to_int (unsigned char c)
3627{
3628 if (isdigit (c))
3629 return c - '0';
3630 else
3631 return tolower (c) - 'a' + 10;
3632}
3633
3634/* As for strtoul, but for ULONGEST results. */
3635
3636ULONGEST
3637strtoulst (const char *num, const char **trailer, int base)
3638{
3639 unsigned int high_part;
3640 ULONGEST result;
3641 int minus = 0;
3642 int i = 0;
3643
3644 /* Skip leading whitespace. */
3645 while (isspace (num[i]))
3646 i++;
3647
3648 /* Handle prefixes. */
3649 if (num[i] == '+')
3650 i++;
3651 else if (num[i] == '-')
3652 {
3653 minus = 1;
3654 i++;
3655 }
3656
3657 if (base == 0 || base == 16)
3658 {
3659 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3660 {
3661 i += 2;
3662 if (base == 0)
3663 base = 16;
3664 }
3665 }
3666
3667 if (base == 0 && num[i] == '0')
3668 base = 8;
3669
3670 if (base == 0)
3671 base = 10;
3672
3673 if (base < 2 || base > 36)
3674 {
3675 errno = EINVAL;
3676 return 0;
3677 }
3678
3679 result = high_part = 0;
3680 for (; is_digit_in_base (num[i], base); i += 1)
3681 {
3682 result = result * base + digit_to_int (num[i]);
3683 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3684 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3685 if (high_part > 0xff)
3686 {
3687 errno = ERANGE;
3688 result = ~ (ULONGEST) 0;
3689 high_part = 0;
3690 minus = 0;
3691 break;
3692 }
3693 }
3694
3695 if (trailer != NULL)
3696 *trailer = &num[i];
3697
3698 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3699 if (minus)
3700 return -result;
3701 else
3702 return result;
3703}
e1024ff1
DJ
3704
3705/* Simple, portable version of dirname that does not modify its
3706 argument. */
3707
3708char *
3709ldirname (const char *filename)
3710{
3711 const char *base = lbasename (filename);
3712 char *dirname;
3713
3714 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3715 --base;
3716
3717 if (base == filename)
3718 return NULL;
3719
3720 dirname = xmalloc (base - filename + 2);
3721 memcpy (dirname, filename, base - filename);
3722
3723 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3724 create "d:./bar" later instead of the (different) "d:/bar". */
3725 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3726 && !IS_DIR_SEPARATOR (filename[0]))
3727 dirname[base++ - filename] = '.';
3728
3729 dirname[base - filename] = '\0';
3730 return dirname;
3731}
d1a41061
PP
3732
3733/* Call libiberty's buildargv, and return the result.
3734 If buildargv fails due to out-of-memory, call nomem.
3735 Therefore, the returned value is guaranteed to be non-NULL,
3736 unless the parameter itself is NULL. */
3737
3738char **
3739gdb_buildargv (const char *s)
3740{
3741 char **argv = buildargv (s);
e0627e85 3742
d1a41061
PP
3743 if (s != NULL && argv == NULL)
3744 nomem (0);
3745 return argv;
3746}
3c16cced 3747
dc146f7c
VP
3748int
3749compare_positive_ints (const void *ap, const void *bp)
3750{
3751 /* Because we know we're comparing two ints which are positive,
3752 there's no danger of overflow here. */
3753 return * (int *) ap - * (int *) bp;
3754}
3755
d18b8b7a 3756#define AMBIGUOUS_MESS1 ".\nMatching formats:"
3e43a32a
MS
3757#define AMBIGUOUS_MESS2 \
3758 ".\nUse \"set gnutarget format-name\" to specify the format."
d18b8b7a
HZ
3759
3760const char *
3761gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3762{
3763 char *ret, *retp;
3764 int ret_len;
3765 char **p;
3766
3767 /* Check if errmsg just need simple return. */
3768 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3769 return bfd_errmsg (error_tag);
3770
3771 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3772 + strlen (AMBIGUOUS_MESS2);
3773 for (p = matching; *p; p++)
3774 ret_len += strlen (*p) + 1;
3775 ret = xmalloc (ret_len + 1);
3776 retp = ret;
3777 make_cleanup (xfree, ret);
3778
3779 strcpy (retp, bfd_errmsg (error_tag));
3780 retp += strlen (retp);
3781
3782 strcpy (retp, AMBIGUOUS_MESS1);
3783 retp += strlen (retp);
3784
3785 for (p = matching; *p; p++)
3786 {
3787 sprintf (retp, " %s", *p);
3788 retp += strlen (retp);
3789 }
3790 xfree (matching);
3791
3792 strcpy (retp, AMBIGUOUS_MESS2);
3793
3794 return ret;
3795}
3796
74164c56
JK
3797/* Return ARGS parsed as a valid pid, or throw an error. */
3798
3799int
3800parse_pid_to_attach (char *args)
3801{
3802 unsigned long pid;
3803 char *dummy;
3804
3805 if (!args)
3806 error_no_arg (_("process-id to attach"));
3807
3808 dummy = args;
3809 pid = strtoul (args, &dummy, 0);
3810 /* Some targets don't set errno on errors, grrr! */
3811 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3812 error (_("Illegal process-id: %s."), args);
3813
3814 return pid;
3815}
3816
2c0b251b
PA
3817/* Provide a prototype to silence -Wmissing-prototypes. */
3818extern initialize_file_ftype _initialize_utils;
3819
3c16cced
PA
3820void
3821_initialize_utils (void)
3822{
3823 add_internal_problem_command (&internal_error_problem);
3824 add_internal_problem_command (&internal_warning_problem);
3825}
This page took 2.254726 seconds and 4 git commands to generate.