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