* utils.c (strlen_paddr, paddr, paddr_nz): Use TARGET_ADDR_BIT,
[external/binutils.git] / gdb / utils.c
1 /* General utility routines for GDB, the GNU debugger.
2    Copyright 1986, 1989, 1990-1992, 1995, 1996, 1998, 2000
3    Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #include "defs.h"
23 #include <ctype.h>
24 #include "gdb_string.h"
25 #include "event-top.h"
26
27 #ifdef HAVE_CURSES_H
28 #include <curses.h>
29 #endif
30 #ifdef HAVE_TERM_H
31 #include <term.h>
32 #endif
33
34 #ifdef __GO32__
35 #include <pc.h>
36 #endif
37
38 /* SunOS's curses.h has a '#define reg register' in it.  Thank you Sun. */
39 #ifdef reg
40 #undef reg
41 #endif
42
43 #include "signals.h"
44 #include "gdbcmd.h"
45 #include "serial.h"
46 #include "bfd.h"
47 #include "target.h"
48 #include "demangle.h"
49 #include "expression.h"
50 #include "language.h"
51 #include "annotate.h"
52
53 #include "inferior.h" /* for signed_pointer_to_address */
54
55 #include <readline/readline.h>
56
57 #undef XMALLOC
58 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
59
60 /* readline defines this.  */
61 #undef savestring
62
63 void (*error_begin_hook) (void);
64
65 /* Holds the last error message issued by gdb */
66
67 static struct ui_file *gdb_lasterr;
68
69 /* Prototypes for local functions */
70
71 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
72                                      va_list, int);
73
74 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
75
76 #if defined (USE_MMALLOC) && !defined (NO_MMCHECK)
77 static void malloc_botch (void);
78 #endif
79
80 static void prompt_for_continue (void);
81
82 static void set_width_command (char *, int, struct cmd_list_element *);
83
84 static void set_width (void);
85
86 /* Chain of cleanup actions established with make_cleanup,
87    to be executed if an error happens.  */
88
89 static struct cleanup *cleanup_chain;   /* cleaned up after a failed command */
90 static struct cleanup *final_cleanup_chain;     /* cleaned up when gdb exits */
91 static struct cleanup *run_cleanup_chain;       /* cleaned up on each 'run' */
92 static struct cleanup *exec_cleanup_chain;      /* cleaned up on each execution command */
93 /* cleaned up on each error from within an execution command */
94 static struct cleanup *exec_error_cleanup_chain; 
95
96 /* Pointer to what is left to do for an execution command after the
97    target stops. Used only in asynchronous mode, by targets that
98    support async execution.  The finish and until commands use it. So
99    does the target extended-remote command. */
100 struct continuation *cmd_continuation;
101 struct continuation *intermediate_continuation;
102
103 /* Nonzero if we have job control. */
104
105 int job_control;
106
107 /* Nonzero means a quit has been requested.  */
108
109 int quit_flag;
110
111 /* Nonzero means quit immediately if Control-C is typed now, rather
112    than waiting until QUIT is executed.  Be careful in setting this;
113    code which executes with immediate_quit set has to be very careful
114    about being able to deal with being interrupted at any time.  It is
115    almost always better to use QUIT; the only exception I can think of
116    is being able to quit out of a system call (using EINTR loses if
117    the SIGINT happens between the previous QUIT and the system call).
118    To immediately quit in the case in which a SIGINT happens between
119    the previous QUIT and setting immediate_quit (desirable anytime we
120    expect to block), call QUIT after setting immediate_quit.  */
121
122 int immediate_quit;
123
124 /* Nonzero means that encoded C++ names should be printed out in their
125    C++ form rather than raw.  */
126
127 int demangle = 1;
128
129 /* Nonzero means that encoded C++ names should be printed out in their
130    C++ form even in assembler language displays.  If this is set, but
131    DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls.  */
132
133 int asm_demangle = 0;
134
135 /* Nonzero means that strings with character values >0x7F should be printed
136    as octal escapes.  Zero means just print the value (e.g. it's an
137    international character, and the terminal or window can cope.)  */
138
139 int sevenbit_strings = 0;
140
141 /* String to be printed before error messages, if any.  */
142
143 char *error_pre_print;
144
145 /* String to be printed before quit messages, if any.  */
146
147 char *quit_pre_print;
148
149 /* String to be printed before warning messages, if any.  */
150
151 char *warning_pre_print = "\nwarning: ";
152
153 int pagination_enabled = 1;
154 \f
155
156 /* Add a new cleanup to the cleanup_chain,
157    and return the previous chain pointer
158    to be passed later to do_cleanups or discard_cleanups.
159    Args are FUNCTION to clean up with, and ARG to pass to it.  */
160
161 struct cleanup *
162 make_cleanup (make_cleanup_ftype *function, void *arg)
163 {
164   return make_my_cleanup (&cleanup_chain, function, arg);
165 }
166
167 struct cleanup *
168 make_final_cleanup (make_cleanup_ftype *function, void *arg)
169 {
170   return make_my_cleanup (&final_cleanup_chain, function, arg);
171 }
172
173 struct cleanup *
174 make_run_cleanup (make_cleanup_ftype *function, void *arg)
175 {
176   return make_my_cleanup (&run_cleanup_chain, function, arg);
177 }
178
179 struct cleanup *
180 make_exec_cleanup (make_cleanup_ftype *function, void *arg)
181 {
182   return make_my_cleanup (&exec_cleanup_chain, function, arg);
183 }
184
185 struct cleanup *
186 make_exec_error_cleanup (make_cleanup_ftype *function, void *arg)
187 {
188   return make_my_cleanup (&exec_error_cleanup_chain, function, arg);
189 }
190
191 static void
192 do_freeargv (void *arg)
193 {
194   freeargv ((char **) arg);
195 }
196
197 struct cleanup *
198 make_cleanup_freeargv (char **arg)
199 {
200   return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
201 }
202
203 static void
204 do_bfd_close_cleanup (void *arg)
205 {
206   bfd_close (arg);
207 }
208
209 struct cleanup *
210 make_cleanup_bfd_close (bfd *abfd)
211 {
212   return make_cleanup (do_bfd_close_cleanup, abfd);
213 }
214
215 static void
216 do_close_cleanup (void *arg)
217 {
218   close ((int) arg);
219 }
220
221 struct cleanup *
222 make_cleanup_close (int fd)
223 {
224   /* int into void*. Outch!! */
225   return make_cleanup (do_close_cleanup, (void *) fd);
226 }
227
228 static void
229 do_ui_file_delete (void *arg)
230 {
231   ui_file_delete (arg);
232 }
233
234 struct cleanup *
235 make_cleanup_ui_file_delete (struct ui_file *arg)
236 {
237   return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
238 }
239
240 struct cleanup *
241 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
242                  void *arg)
243 {
244   register struct cleanup *new
245   = (struct cleanup *) xmalloc (sizeof (struct cleanup));
246   register struct cleanup *old_chain = *pmy_chain;
247
248   new->next = *pmy_chain;
249   new->function = function;
250   new->arg = arg;
251   *pmy_chain = new;
252
253   return old_chain;
254 }
255
256 /* Discard cleanups and do the actions they describe
257    until we get back to the point OLD_CHAIN in the cleanup_chain.  */
258
259 void
260 do_cleanups (register struct cleanup *old_chain)
261 {
262   do_my_cleanups (&cleanup_chain, old_chain);
263 }
264
265 void
266 do_final_cleanups (register struct cleanup *old_chain)
267 {
268   do_my_cleanups (&final_cleanup_chain, old_chain);
269 }
270
271 void
272 do_run_cleanups (register struct cleanup *old_chain)
273 {
274   do_my_cleanups (&run_cleanup_chain, old_chain);
275 }
276
277 void
278 do_exec_cleanups (register struct cleanup *old_chain)
279 {
280   do_my_cleanups (&exec_cleanup_chain, old_chain);
281 }
282
283 void
284 do_exec_error_cleanups (register struct cleanup *old_chain)
285 {
286   do_my_cleanups (&exec_error_cleanup_chain, old_chain);
287 }
288
289 void
290 do_my_cleanups (register struct cleanup **pmy_chain,
291                 register struct cleanup *old_chain)
292 {
293   register struct cleanup *ptr;
294   while ((ptr = *pmy_chain) != old_chain)
295     {
296       *pmy_chain = ptr->next;   /* Do this first incase recursion */
297       (*ptr->function) (ptr->arg);
298       free (ptr);
299     }
300 }
301
302 /* Discard cleanups, not doing the actions they describe,
303    until we get back to the point OLD_CHAIN in the cleanup_chain.  */
304
305 void
306 discard_cleanups (register struct cleanup *old_chain)
307 {
308   discard_my_cleanups (&cleanup_chain, old_chain);
309 }
310
311 void
312 discard_final_cleanups (register struct cleanup *old_chain)
313 {
314   discard_my_cleanups (&final_cleanup_chain, old_chain);
315 }
316
317 void
318 discard_exec_error_cleanups (register struct cleanup *old_chain)
319 {
320   discard_my_cleanups (&exec_error_cleanup_chain, old_chain);
321 }
322
323 void
324 discard_my_cleanups (register struct cleanup **pmy_chain,
325                      register struct cleanup *old_chain)
326 {
327   register struct cleanup *ptr;
328   while ((ptr = *pmy_chain) != old_chain)
329     {
330       *pmy_chain = ptr->next;
331       free (ptr);
332     }
333 }
334
335 /* Set the cleanup_chain to 0, and return the old cleanup chain.  */
336 struct cleanup *
337 save_cleanups (void)
338 {
339   return save_my_cleanups (&cleanup_chain);
340 }
341
342 struct cleanup *
343 save_final_cleanups (void)
344 {
345   return save_my_cleanups (&final_cleanup_chain);
346 }
347
348 struct cleanup *
349 save_my_cleanups (struct cleanup **pmy_chain)
350 {
351   struct cleanup *old_chain = *pmy_chain;
352
353   *pmy_chain = 0;
354   return old_chain;
355 }
356
357 /* Restore the cleanup chain from a previously saved chain.  */
358 void
359 restore_cleanups (struct cleanup *chain)
360 {
361   restore_my_cleanups (&cleanup_chain, chain);
362 }
363
364 void
365 restore_final_cleanups (struct cleanup *chain)
366 {
367   restore_my_cleanups (&final_cleanup_chain, chain);
368 }
369
370 void
371 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
372 {
373   *pmy_chain = chain;
374 }
375
376 /* This function is useful for cleanups.
377    Do
378
379    foo = xmalloc (...);
380    old_chain = make_cleanup (free_current_contents, &foo);
381
382    to arrange to free the object thus allocated.  */
383
384 void
385 free_current_contents (void *ptr)
386 {
387   void **location = ptr;
388   if (location == NULL)
389     internal_error ("free_current_contents: NULL pointer");
390   if (*location != NULL)
391     {
392       free (*location);
393       *location = NULL;
394     }
395 }
396
397 /* Provide a known function that does nothing, to use as a base for
398    for a possibly long chain of cleanups.  This is useful where we
399    use the cleanup chain for handling normal cleanups as well as dealing
400    with cleanups that need to be done as a result of a call to error().
401    In such cases, we may not be certain where the first cleanup is, unless
402    we have a do-nothing one to always use as the base. */
403
404 /* ARGSUSED */
405 void
406 null_cleanup (void *arg)
407 {
408 }
409
410 /* Add a continuation to the continuation list, the global list
411    cmd_continuation. The new continuation will be added at the front.*/
412 void
413 add_continuation (void (*continuation_hook) (struct continuation_arg *),
414                   struct continuation_arg *arg_list)
415 {
416   struct continuation *continuation_ptr;
417
418   continuation_ptr = (struct continuation *) xmalloc (sizeof (struct continuation));
419   continuation_ptr->continuation_hook = continuation_hook;
420   continuation_ptr->arg_list = arg_list;
421   continuation_ptr->next = cmd_continuation;
422   cmd_continuation = continuation_ptr;
423 }
424
425 /* Walk down the cmd_continuation list, and execute all the
426    continuations. There is a problem though. In some cases new
427    continuations may be added while we are in the middle of this
428    loop. If this happens they will be added in the front, and done
429    before we have a chance of exhausting those that were already
430    there. We need to then save the beginning of the list in a pointer
431    and do the continuations from there on, instead of using the
432    global beginning of list as our iteration pointer.*/
433 void
434 do_all_continuations (void)
435 {
436   struct continuation *continuation_ptr;
437   struct continuation *saved_continuation;
438
439   /* Copy the list header into another pointer, and set the global
440      list header to null, so that the global list can change as a side
441      effect of invoking the continuations and the processing of
442      the preexisting continuations will not be affected. */
443   continuation_ptr = cmd_continuation;
444   cmd_continuation = NULL;
445
446   /* Work now on the list we have set aside. */
447   while (continuation_ptr)
448      {
449        (continuation_ptr->continuation_hook) (continuation_ptr->arg_list);
450        saved_continuation = continuation_ptr;
451        continuation_ptr = continuation_ptr->next;
452        free (saved_continuation);
453      }
454 }
455
456 /* Walk down the cmd_continuation list, and get rid of all the
457    continuations. */
458 void
459 discard_all_continuations (void)
460 {
461   struct continuation *continuation_ptr;
462
463   while (cmd_continuation)
464     {
465       continuation_ptr = cmd_continuation;
466       cmd_continuation = continuation_ptr->next;
467       free (continuation_ptr);
468     }
469 }
470
471 /* Add a continuation to the continuation list, the global list
472    intermediate_continuation. The new continuation will be added at the front.*/
473 void
474 add_intermediate_continuation (void (*continuation_hook)
475                                (struct continuation_arg *),
476                                struct continuation_arg *arg_list)
477 {
478   struct continuation *continuation_ptr;
479
480   continuation_ptr = (struct continuation *) xmalloc (sizeof (struct continuation));
481   continuation_ptr->continuation_hook = continuation_hook;
482   continuation_ptr->arg_list = arg_list;
483   continuation_ptr->next = intermediate_continuation;
484   intermediate_continuation = continuation_ptr;
485 }
486
487 /* Walk down the cmd_continuation list, and execute all the
488    continuations. There is a problem though. In some cases new
489    continuations may be added while we are in the middle of this
490    loop. If this happens they will be added in the front, and done
491    before we have a chance of exhausting those that were already
492    there. We need to then save the beginning of the list in a pointer
493    and do the continuations from there on, instead of using the
494    global beginning of list as our iteration pointer.*/
495 void
496 do_all_intermediate_continuations (void)
497 {
498   struct continuation *continuation_ptr;
499   struct continuation *saved_continuation;
500
501   /* Copy the list header into another pointer, and set the global
502      list header to null, so that the global list can change as a side
503      effect of invoking the continuations and the processing of
504      the preexisting continuations will not be affected. */
505   continuation_ptr = intermediate_continuation;
506   intermediate_continuation = NULL;
507
508   /* Work now on the list we have set aside. */
509   while (continuation_ptr)
510      {
511        (continuation_ptr->continuation_hook) (continuation_ptr->arg_list);
512        saved_continuation = continuation_ptr;
513        continuation_ptr = continuation_ptr->next;
514        free (saved_continuation);
515      }
516 }
517
518 /* Walk down the cmd_continuation list, and get rid of all the
519    continuations. */
520 void
521 discard_all_intermediate_continuations (void)
522 {
523   struct continuation *continuation_ptr;
524
525   while (intermediate_continuation)
526     {
527       continuation_ptr = intermediate_continuation;
528       intermediate_continuation = continuation_ptr->next;
529       free (continuation_ptr);
530     }
531 }
532
533 \f
534
535 /* Print a warning message.  Way to use this is to call warning_begin,
536    output the warning message (use unfiltered output to gdb_stderr),
537    ending in a newline.  There is not currently a warning_end that you
538    call afterwards, but such a thing might be added if it is useful
539    for a GUI to separate warning messages from other output.
540
541    FIXME: Why do warnings use unfiltered output and errors filtered?
542    Is this anything other than a historical accident?  */
543
544 void
545 warning_begin (void)
546 {
547   target_terminal_ours ();
548   wrap_here ("");               /* Force out any buffered output */
549   gdb_flush (gdb_stdout);
550   if (warning_pre_print)
551     fprintf_unfiltered (gdb_stderr, warning_pre_print);
552 }
553
554 /* Print a warning message.
555    The first argument STRING is the warning message, used as a fprintf string,
556    and the remaining args are passed as arguments to it.
557    The primary difference between warnings and errors is that a warning
558    does not force the return to command level.  */
559
560 void
561 warning (const char *string,...)
562 {
563   va_list args;
564   va_start (args, string);
565   if (warning_hook)
566     (*warning_hook) (string, args);
567   else
568     {
569       warning_begin ();
570       vfprintf_unfiltered (gdb_stderr, string, args);
571       fprintf_unfiltered (gdb_stderr, "\n");
572       va_end (args);
573     }
574 }
575
576 /* Start the printing of an error message.  Way to use this is to call
577    this, output the error message (use filtered output to gdb_stderr
578    (FIXME: Some callers, like memory_error, use gdb_stdout)), ending
579    in a newline, and then call return_to_top_level (RETURN_ERROR).
580    error() provides a convenient way to do this for the special case
581    that the error message can be formatted with a single printf call,
582    but this is more general.  */
583 void
584 error_begin (void)
585 {
586   if (error_begin_hook)
587     error_begin_hook ();
588
589   target_terminal_ours ();
590   wrap_here ("");               /* Force out any buffered output */
591   gdb_flush (gdb_stdout);
592
593   annotate_error_begin ();
594
595   if (error_pre_print)
596     fprintf_filtered (gdb_stderr, error_pre_print);
597 }
598
599 /* Print an error message and return to command level.
600    The first argument STRING is the error message, used as a fprintf string,
601    and the remaining args are passed as arguments to it.  */
602
603 NORETURN void
604 verror (const char *string, va_list args)
605 {
606   char *err_string;
607   struct cleanup *err_string_cleanup;
608   /* FIXME: cagney/1999-11-10: All error calls should come here.
609      Unfortunately some code uses the sequence: error_begin(); print
610      error message; return_to_top_level.  That code should be
611      flushed. */
612   error_begin ();
613   /* NOTE: It's tempting to just do the following...
614         vfprintf_filtered (gdb_stderr, string, args);
615      and then follow with a similar looking statement to cause the message
616      to also go to gdb_lasterr.  But if we do this, we'll be traversing the
617      va_list twice which works on some platforms and fails miserably on
618      others. */
619   /* Save it as the last error */
620   ui_file_rewind (gdb_lasterr);
621   vfprintf_filtered (gdb_lasterr, string, args);
622   /* Retrieve the last error and print it to gdb_stderr */
623   err_string = error_last_message ();
624   err_string_cleanup = make_cleanup (free, err_string);
625   fputs_filtered (err_string, gdb_stderr);
626   fprintf_filtered (gdb_stderr, "\n");
627   do_cleanups (err_string_cleanup);
628   return_to_top_level (RETURN_ERROR);
629 }
630
631 NORETURN void
632 error (const char *string,...)
633 {
634   va_list args;
635   va_start (args, string);
636   verror (string, args);
637   va_end (args);
638 }
639
640 NORETURN void
641 error_stream (struct ui_file *stream)
642 {
643   long size;
644   char *msg = ui_file_xstrdup (stream, &size);
645   make_cleanup (free, msg);
646   error ("%s", msg);
647 }
648
649 /* Get the last error message issued by gdb */
650
651 char *
652 error_last_message (void)
653 {
654   long len;
655   return ui_file_xstrdup (gdb_lasterr, &len);
656 }
657   
658 /* This is to be called by main() at the very beginning */
659
660 void
661 error_init (void)
662 {
663   gdb_lasterr = mem_fileopen ();
664 }
665
666 /* Print a message reporting an internal error. Ask the user if they
667    want to continue, dump core, or just exit. */
668
669 NORETURN void
670 internal_verror (const char *fmt, va_list ap)
671 {
672   static char msg[] = "Internal GDB error: recursive internal error.\n";
673   static int dejavu = 0;
674   int continue_p;
675   int dump_core_p;
676
677   /* don't allow infinite error recursion. */
678   switch (dejavu)
679     {
680     case 0:
681       dejavu = 1;
682       break;
683     case 1:
684       dejavu = 2;
685       fputs_unfiltered (msg, gdb_stderr);
686       abort ();
687     default:
688       dejavu = 3;
689       write (STDERR_FILENO, msg, sizeof (msg));
690       exit (1);
691     }
692
693   /* Try to get the message out */
694   target_terminal_ours ();
695   fputs_unfiltered ("gdb-internal-error: ", gdb_stderr);
696   vfprintf_unfiltered (gdb_stderr, fmt, ap);
697   fputs_unfiltered ("\n", gdb_stderr);
698
699   /* Default (no case) is to quit GDB.  When in batch mode this
700      lessens the likelhood of GDB going into an infinate loop. */
701   continue_p = query ("\
702 An internal GDB error was detected.  This may make make further\n\
703 debugging unreliable.  Continue this debugging session? ");
704
705   /* Default (no case) is to not dump core.  Lessen the chance of GDB
706      leaving random core files around. */
707   dump_core_p = query ("\
708 Create a core file containing the current state of GDB? ");
709
710   if (continue_p)
711     {
712       if (dump_core_p)
713         {
714           if (fork () == 0)
715             abort ();
716         }
717     }
718   else
719     {
720       if (dump_core_p)
721         abort ();
722       else
723         exit (1);
724     }
725
726   dejavu = 0;
727   return_to_top_level (RETURN_ERROR);
728 }
729
730 NORETURN void
731 internal_error (char *string, ...)
732 {
733   va_list ap;
734   va_start (ap, string);
735
736   internal_verror (string, ap);
737   va_end (ap);
738 }
739
740 /* The strerror() function can return NULL for errno values that are
741    out of range.  Provide a "safe" version that always returns a
742    printable string. */
743
744 char *
745 safe_strerror (int errnum)
746 {
747   char *msg;
748   static char buf[32];
749
750   if ((msg = strerror (errnum)) == NULL)
751     {
752       sprintf (buf, "(undocumented errno %d)", errnum);
753       msg = buf;
754     }
755   return (msg);
756 }
757
758 /* Print the system error message for errno, and also mention STRING
759    as the file name for which the error was encountered.
760    Then return to command level.  */
761
762 NORETURN void
763 perror_with_name (char *string)
764 {
765   char *err;
766   char *combined;
767
768   err = safe_strerror (errno);
769   combined = (char *) alloca (strlen (err) + strlen (string) + 3);
770   strcpy (combined, string);
771   strcat (combined, ": ");
772   strcat (combined, err);
773
774   /* I understand setting these is a matter of taste.  Still, some people
775      may clear errno but not know about bfd_error.  Doing this here is not
776      unreasonable. */
777   bfd_set_error (bfd_error_no_error);
778   errno = 0;
779
780   error ("%s.", combined);
781 }
782
783 /* Print the system error message for ERRCODE, and also mention STRING
784    as the file name for which the error was encountered.  */
785
786 void
787 print_sys_errmsg (char *string, int errcode)
788 {
789   char *err;
790   char *combined;
791
792   err = safe_strerror (errcode);
793   combined = (char *) alloca (strlen (err) + strlen (string) + 3);
794   strcpy (combined, string);
795   strcat (combined, ": ");
796   strcat (combined, err);
797
798   /* We want anything which was printed on stdout to come out first, before
799      this message.  */
800   gdb_flush (gdb_stdout);
801   fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
802 }
803
804 /* Control C eventually causes this to be called, at a convenient time.  */
805
806 void
807 quit (void)
808 {
809   serial_t gdb_stdout_serial = serial_fdopen (1);
810
811   target_terminal_ours ();
812
813   /* We want all output to appear now, before we print "Quit".  We
814      have 3 levels of buffering we have to flush (it's possible that
815      some of these should be changed to flush the lower-level ones
816      too):  */
817
818   /* 1.  The _filtered buffer.  */
819   wrap_here ((char *) 0);
820
821   /* 2.  The stdio buffer.  */
822   gdb_flush (gdb_stdout);
823   gdb_flush (gdb_stderr);
824
825   /* 3.  The system-level buffer.  */
826   SERIAL_DRAIN_OUTPUT (gdb_stdout_serial);
827   SERIAL_UN_FDOPEN (gdb_stdout_serial);
828
829   annotate_error_begin ();
830
831   /* Don't use *_filtered; we don't want to prompt the user to continue.  */
832   if (quit_pre_print)
833     fprintf_unfiltered (gdb_stderr, quit_pre_print);
834
835 #ifdef __MSDOS__
836   /* No steenking SIGINT will ever be coming our way when the
837      program is resumed.  Don't lie.  */
838   fprintf_unfiltered (gdb_stderr, "Quit\n");
839 #else
840   if (job_control
841   /* If there is no terminal switching for this target, then we can't
842      possibly get screwed by the lack of job control.  */
843       || current_target.to_terminal_ours == NULL)
844     fprintf_unfiltered (gdb_stderr, "Quit\n");
845   else
846     fprintf_unfiltered (gdb_stderr,
847                "Quit (expect signal SIGINT when the program is resumed)\n");
848 #endif
849   return_to_top_level (RETURN_QUIT);
850 }
851
852
853 #if defined(_MSC_VER)           /* should test for wingdb instead? */
854
855 /*
856  * Windows translates all keyboard and mouse events 
857  * into a message which is appended to the message 
858  * queue for the process.
859  */
860
861 void
862 notice_quit (void)
863 {
864   int k = win32pollquit ();
865   if (k == 1)
866     quit_flag = 1;
867   else if (k == 2)
868     immediate_quit = 1;
869 }
870
871 #else /* !defined(_MSC_VER) */
872
873 void
874 notice_quit (void)
875 {
876   /* Done by signals */
877 }
878
879 #endif /* !defined(_MSC_VER) */
880
881 /* Control C comes here */
882 void
883 request_quit (int signo)
884 {
885   quit_flag = 1;
886   /* Restore the signal handler.  Harmless with BSD-style signals, needed
887      for System V-style signals.  So just always do it, rather than worrying
888      about USG defines and stuff like that.  */
889   signal (signo, request_quit);
890
891 #ifdef REQUEST_QUIT
892   REQUEST_QUIT;
893 #else
894   if (immediate_quit)
895     quit ();
896 #endif
897 }
898 \f
899 /* Memory management stuff (malloc friends).  */
900
901 /* Make a substitute size_t for non-ANSI compilers. */
902
903 #ifndef HAVE_STDDEF_H
904 #ifndef size_t
905 #define size_t unsigned int
906 #endif
907 #endif
908
909 #if !defined (USE_MMALLOC)
910
911 PTR
912 mcalloc (PTR md, size_t number, size_t size)
913 {
914   return calloc (number, size);
915 }
916
917 PTR
918 mmalloc (PTR md, size_t size)
919 {
920   return malloc (size);
921 }
922
923 PTR
924 mrealloc (PTR md, PTR ptr, size_t size)
925 {
926   if (ptr == 0)                 /* Guard against old realloc's */
927     return malloc (size);
928   else
929     return realloc (ptr, size);
930 }
931
932 void
933 mfree (PTR md, PTR ptr)
934 {
935   free (ptr);
936 }
937
938 #endif /* USE_MMALLOC */
939
940 #if !defined (USE_MMALLOC) || defined (NO_MMCHECK)
941
942 void
943 init_malloc (void *md)
944 {
945 }
946
947 #else /* Have mmalloc and want corruption checking */
948
949 static void
950 malloc_botch (void)
951 {
952   fprintf_unfiltered (gdb_stderr, "Memory corruption\n");
953   abort ();
954 }
955
956 /* Attempt to install hooks in mmalloc/mrealloc/mfree for the heap specified
957    by MD, to detect memory corruption.  Note that MD may be NULL to specify
958    the default heap that grows via sbrk.
959
960    Note that for freshly created regions, we must call mmcheckf prior to any
961    mallocs in the region.  Otherwise, any region which was allocated prior to
962    installing the checking hooks, which is later reallocated or freed, will
963    fail the checks!  The mmcheck function only allows initial hooks to be
964    installed before the first mmalloc.  However, anytime after we have called
965    mmcheck the first time to install the checking hooks, we can call it again
966    to update the function pointer to the memory corruption handler.
967
968    Returns zero on failure, non-zero on success. */
969
970 #ifndef MMCHECK_FORCE
971 #define MMCHECK_FORCE 0
972 #endif
973
974 void
975 init_malloc (void *md)
976 {
977   if (!mmcheckf (md, malloc_botch, MMCHECK_FORCE))
978     {
979       /* Don't use warning(), which relies on current_target being set
980          to something other than dummy_target, until after
981          initialize_all_files(). */
982
983       fprintf_unfiltered
984         (gdb_stderr, "warning: failed to install memory consistency checks; ");
985       fprintf_unfiltered
986         (gdb_stderr, "configuration should define NO_MMCHECK or MMCHECK_FORCE\n");
987     }
988
989   mmtrace ();
990 }
991
992 #endif /* Have mmalloc and want corruption checking  */
993
994 /* Called when a memory allocation fails, with the number of bytes of
995    memory requested in SIZE. */
996
997 NORETURN void
998 nomem (long size)
999 {
1000   if (size > 0)
1001     {
1002       internal_error ("virtual memory exhausted: can't allocate %ld bytes.", size);
1003     }
1004   else
1005     {
1006       internal_error ("virtual memory exhausted.");
1007     }
1008 }
1009
1010 /* Like mmalloc but get error if no storage available, and protect against
1011    the caller wanting to allocate zero bytes.  Whether to return NULL for
1012    a zero byte request, or translate the request into a request for one
1013    byte of zero'd storage, is a religious issue. */
1014
1015 PTR
1016 xmmalloc (PTR md, long size)
1017 {
1018   register PTR val;
1019
1020   if (size == 0)
1021     {
1022       val = NULL;
1023     }
1024   else if ((val = mmalloc (md, size)) == NULL)
1025     {
1026       nomem (size);
1027     }
1028   return (val);
1029 }
1030
1031 /* Like mrealloc but get error if no storage available.  */
1032
1033 PTR
1034 xmrealloc (PTR md, PTR ptr, long size)
1035 {
1036   register PTR val;
1037
1038   if (ptr != NULL)
1039     {
1040       val = mrealloc (md, ptr, size);
1041     }
1042   else
1043     {
1044       val = mmalloc (md, size);
1045     }
1046   if (val == NULL)
1047     {
1048       nomem (size);
1049     }
1050   return (val);
1051 }
1052
1053 /* Like malloc but get error if no storage available, and protect against
1054    the caller wanting to allocate zero bytes.  */
1055
1056 PTR
1057 xmalloc (size_t size)
1058 {
1059   return (xmmalloc ((PTR) NULL, size));
1060 }
1061
1062 /* Like calloc but get error if no storage available */
1063
1064 PTR
1065 xcalloc (size_t number, size_t size)
1066 {
1067   void *mem = mcalloc (NULL, number, size);
1068   if (mem == NULL)
1069     nomem (number * size);
1070   return mem;
1071 }
1072
1073 /* Like mrealloc but get error if no storage available.  */
1074
1075 PTR
1076 xrealloc (PTR ptr, size_t size)
1077 {
1078   return (xmrealloc ((PTR) NULL, ptr, size));
1079 }
1080 \f
1081
1082 /* My replacement for the read system call.
1083    Used like `read' but keeps going if `read' returns too soon.  */
1084
1085 int
1086 myread (int desc, char *addr, int len)
1087 {
1088   register int val;
1089   int orglen = len;
1090
1091   while (len > 0)
1092     {
1093       val = read (desc, addr, len);
1094       if (val < 0)
1095         return val;
1096       if (val == 0)
1097         return orglen - len;
1098       len -= val;
1099       addr += val;
1100     }
1101   return orglen;
1102 }
1103 \f
1104 /* Make a copy of the string at PTR with SIZE characters
1105    (and add a null character at the end in the copy).
1106    Uses malloc to get the space.  Returns the address of the copy.  */
1107
1108 char *
1109 savestring (const char *ptr, int size)
1110 {
1111   register char *p = (char *) xmalloc (size + 1);
1112   memcpy (p, ptr, size);
1113   p[size] = 0;
1114   return p;
1115 }
1116
1117 char *
1118 msavestring (void *md, const char *ptr, int size)
1119 {
1120   register char *p = (char *) xmmalloc (md, size + 1);
1121   memcpy (p, ptr, size);
1122   p[size] = 0;
1123   return p;
1124 }
1125
1126 /* The "const" is so it compiles under DGUX (which prototypes strsave
1127    in <string.h>.  FIXME: This should be named "xstrsave", shouldn't it?
1128    Doesn't real strsave return NULL if out of memory?  */
1129 char *
1130 strsave (const char *ptr)
1131 {
1132   return savestring (ptr, strlen (ptr));
1133 }
1134
1135 char *
1136 mstrsave (void *md, const char *ptr)
1137 {
1138   return (msavestring (md, ptr, strlen (ptr)));
1139 }
1140
1141 void
1142 print_spaces (register int n, register struct ui_file *file)
1143 {
1144   fputs_unfiltered (n_spaces (n), file);
1145 }
1146
1147 /* Print a host address.  */
1148
1149 void
1150 gdb_print_host_address (void *addr, struct ui_file *stream)
1151 {
1152
1153   /* We could use the %p conversion specifier to fprintf if we had any
1154      way of knowing whether this host supports it.  But the following
1155      should work on the Alpha and on 32 bit machines.  */
1156
1157   fprintf_filtered (stream, "0x%lx", (unsigned long) addr);
1158 }
1159
1160 /* Ask user a y-or-n question and return 1 iff answer is yes.
1161    Takes three args which are given to printf to print the question.
1162    The first, a control string, should end in "? ".
1163    It should not say how to answer, because we do that.  */
1164
1165 /* VARARGS */
1166 int
1167 query (char *ctlstr,...)
1168 {
1169   va_list args;
1170   register int answer;
1171   register int ans2;
1172   int retval;
1173
1174   va_start (args, ctlstr);
1175
1176   if (query_hook)
1177     {
1178       return query_hook (ctlstr, args);
1179     }
1180
1181   /* Automatically answer "yes" if input is not from a terminal.  */
1182   if (!input_from_terminal_p ())
1183     return 1;
1184 #ifdef MPW
1185   /* FIXME Automatically answer "yes" if called from MacGDB.  */
1186   if (mac_app)
1187     return 1;
1188 #endif /* MPW */
1189
1190   while (1)
1191     {
1192       wrap_here ("");           /* Flush any buffered output */
1193       gdb_flush (gdb_stdout);
1194
1195       if (annotation_level > 1)
1196         printf_filtered ("\n\032\032pre-query\n");
1197
1198       vfprintf_filtered (gdb_stdout, ctlstr, args);
1199       printf_filtered ("(y or n) ");
1200
1201       if (annotation_level > 1)
1202         printf_filtered ("\n\032\032query\n");
1203
1204 #ifdef MPW
1205       /* If not in MacGDB, move to a new line so the entered line doesn't
1206          have a prompt on the front of it. */
1207       if (!mac_app)
1208         fputs_unfiltered ("\n", gdb_stdout);
1209 #endif /* MPW */
1210
1211       wrap_here ("");
1212       gdb_flush (gdb_stdout);
1213
1214 #if defined(TUI)
1215       if (!tui_version || cmdWin == tuiWinWithFocus ())
1216 #endif
1217         answer = fgetc (stdin);
1218 #if defined(TUI)
1219       else
1220         answer = (unsigned char) tuiBufferGetc ();
1221
1222 #endif
1223       clearerr (stdin);         /* in case of C-d */
1224       if (answer == EOF)        /* C-d */
1225         {
1226           retval = 1;
1227           break;
1228         }
1229       /* Eat rest of input line, to EOF or newline */
1230       if ((answer != '\n') || (tui_version && answer != '\r'))
1231         do
1232           {
1233 #if defined(TUI)
1234             if (!tui_version || cmdWin == tuiWinWithFocus ())
1235 #endif
1236               ans2 = fgetc (stdin);
1237 #if defined(TUI)
1238             else
1239               ans2 = (unsigned char) tuiBufferGetc ();
1240 #endif
1241             clearerr (stdin);
1242           }
1243         while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1244       TUIDO (((TuiOpaqueFuncPtr) tui_vStartNewLines, 1));
1245
1246       if (answer >= 'a')
1247         answer -= 040;
1248       if (answer == 'Y')
1249         {
1250           retval = 1;
1251           break;
1252         }
1253       if (answer == 'N')
1254         {
1255           retval = 0;
1256           break;
1257         }
1258       printf_filtered ("Please answer y or n.\n");
1259     }
1260
1261   if (annotation_level > 1)
1262     printf_filtered ("\n\032\032post-query\n");
1263   return retval;
1264 }
1265 \f
1266
1267 /* Parse a C escape sequence.  STRING_PTR points to a variable
1268    containing a pointer to the string to parse.  That pointer
1269    should point to the character after the \.  That pointer
1270    is updated past the characters we use.  The value of the
1271    escape sequence is returned.
1272
1273    A negative value means the sequence \ newline was seen,
1274    which is supposed to be equivalent to nothing at all.
1275
1276    If \ is followed by a null character, we return a negative
1277    value and leave the string pointer pointing at the null character.
1278
1279    If \ is followed by 000, we return 0 and leave the string pointer
1280    after the zeros.  A value of 0 does not mean end of string.  */
1281
1282 int
1283 parse_escape (char **string_ptr)
1284 {
1285   register int c = *(*string_ptr)++;
1286   switch (c)
1287     {
1288     case 'a':
1289       return 007;               /* Bell (alert) char */
1290     case 'b':
1291       return '\b';
1292     case 'e':                   /* Escape character */
1293       return 033;
1294     case 'f':
1295       return '\f';
1296     case 'n':
1297       return '\n';
1298     case 'r':
1299       return '\r';
1300     case 't':
1301       return '\t';
1302     case 'v':
1303       return '\v';
1304     case '\n':
1305       return -2;
1306     case 0:
1307       (*string_ptr)--;
1308       return 0;
1309     case '^':
1310       c = *(*string_ptr)++;
1311       if (c == '\\')
1312         c = parse_escape (string_ptr);
1313       if (c == '?')
1314         return 0177;
1315       return (c & 0200) | (c & 037);
1316
1317     case '0':
1318     case '1':
1319     case '2':
1320     case '3':
1321     case '4':
1322     case '5':
1323     case '6':
1324     case '7':
1325       {
1326         register int i = c - '0';
1327         register int count = 0;
1328         while (++count < 3)
1329           {
1330             if ((c = *(*string_ptr)++) >= '0' && c <= '7')
1331               {
1332                 i *= 8;
1333                 i += c - '0';
1334               }
1335             else
1336               {
1337                 (*string_ptr)--;
1338                 break;
1339               }
1340           }
1341         return i;
1342       }
1343     default:
1344       return c;
1345     }
1346 }
1347 \f
1348 /* Print the character C on STREAM as part of the contents of a literal
1349    string whose delimiter is QUOTER.  Note that this routine should only
1350    be call for printing things which are independent of the language
1351    of the program being debugged. */
1352
1353 static void
1354 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1355            void (*do_fprintf) (struct ui_file *, const char *, ...),
1356            struct ui_file *stream, int quoter)
1357 {
1358
1359   c &= 0xFF;                    /* Avoid sign bit follies */
1360
1361   if (c < 0x20 ||               /* Low control chars */
1362       (c >= 0x7F && c < 0xA0) ||        /* DEL, High controls */
1363       (sevenbit_strings && c >= 0x80))
1364     {                           /* high order bit set */
1365       switch (c)
1366         {
1367         case '\n':
1368           do_fputs ("\\n", stream);
1369           break;
1370         case '\b':
1371           do_fputs ("\\b", stream);
1372           break;
1373         case '\t':
1374           do_fputs ("\\t", stream);
1375           break;
1376         case '\f':
1377           do_fputs ("\\f", stream);
1378           break;
1379         case '\r':
1380           do_fputs ("\\r", stream);
1381           break;
1382         case '\033':
1383           do_fputs ("\\e", stream);
1384           break;
1385         case '\007':
1386           do_fputs ("\\a", stream);
1387           break;
1388         default:
1389           do_fprintf (stream, "\\%.3o", (unsigned int) c);
1390           break;
1391         }
1392     }
1393   else
1394     {
1395       if (c == '\\' || c == quoter)
1396         do_fputs ("\\", stream);
1397       do_fprintf (stream, "%c", c);
1398     }
1399 }
1400
1401 /* Print the character C on STREAM as part of the contents of a
1402    literal string whose delimiter is QUOTER.  Note that these routines
1403    should only be call for printing things which are independent of
1404    the language of the program being debugged. */
1405
1406 void
1407 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1408 {
1409   while (*str)
1410     printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1411 }
1412
1413 void
1414 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1415 {
1416   while (*str)
1417     printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1418 }
1419
1420 void
1421 fputstrn_unfiltered (const char *str, int n, int quoter, struct ui_file *stream)
1422 {
1423   int i;
1424   for (i = 0; i < n; i++)
1425     printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1426 }
1427
1428 \f
1429
1430 /* Number of lines per page or UINT_MAX if paging is disabled.  */
1431 static unsigned int lines_per_page;
1432 /* Number of chars per line or UINT_MAX if line folding is disabled.  */
1433 static unsigned int chars_per_line;
1434 /* Current count of lines printed on this page, chars on this line.  */
1435 static unsigned int lines_printed, chars_printed;
1436
1437 /* Buffer and start column of buffered text, for doing smarter word-
1438    wrapping.  When someone calls wrap_here(), we start buffering output
1439    that comes through fputs_filtered().  If we see a newline, we just
1440    spit it out and forget about the wrap_here().  If we see another
1441    wrap_here(), we spit it out and remember the newer one.  If we see
1442    the end of the line, we spit out a newline, the indent, and then
1443    the buffered output.  */
1444
1445 /* Malloc'd buffer with chars_per_line+2 bytes.  Contains characters which
1446    are waiting to be output (they have already been counted in chars_printed).
1447    When wrap_buffer[0] is null, the buffer is empty.  */
1448 static char *wrap_buffer;
1449
1450 /* Pointer in wrap_buffer to the next character to fill.  */
1451 static char *wrap_pointer;
1452
1453 /* String to indent by if the wrap occurs.  Must not be NULL if wrap_column
1454    is non-zero.  */
1455 static char *wrap_indent;
1456
1457 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1458    is not in effect.  */
1459 static int wrap_column;
1460 \f
1461
1462 /* Inialize the lines and chars per page */
1463 void
1464 init_page_info (void)
1465 {
1466 #if defined(TUI)
1467   if (tui_version && m_winPtrNotNull (cmdWin))
1468     {
1469       lines_per_page = cmdWin->generic.height;
1470       chars_per_line = cmdWin->generic.width;
1471     }
1472   else
1473 #endif
1474     {
1475       /* These defaults will be used if we are unable to get the correct
1476          values from termcap.  */
1477 #if defined(__GO32__)
1478       lines_per_page = ScreenRows ();
1479       chars_per_line = ScreenCols ();
1480 #else
1481       lines_per_page = 24;
1482       chars_per_line = 80;
1483
1484 #if !defined (MPW) && !defined (_WIN32)
1485       /* No termcap under MPW, although might be cool to do something
1486          by looking at worksheet or console window sizes. */
1487       /* Initialize the screen height and width from termcap.  */
1488       {
1489         char *termtype = getenv ("TERM");
1490
1491         /* Positive means success, nonpositive means failure.  */
1492         int status;
1493
1494         /* 2048 is large enough for all known terminals, according to the
1495            GNU termcap manual.  */
1496         char term_buffer[2048];
1497
1498         if (termtype)
1499           {
1500             status = tgetent (term_buffer, termtype);
1501             if (status > 0)
1502               {
1503                 int val;
1504                 int running_in_emacs = getenv ("EMACS") != NULL;
1505
1506                 val = tgetnum ("li");
1507                 if (val >= 0 && !running_in_emacs)
1508                   lines_per_page = val;
1509                 else
1510                   /* The number of lines per page is not mentioned
1511                      in the terminal description.  This probably means
1512                      that paging is not useful (e.g. emacs shell window),
1513                      so disable paging.  */
1514                   lines_per_page = UINT_MAX;
1515
1516                 val = tgetnum ("co");
1517                 if (val >= 0)
1518                   chars_per_line = val;
1519               }
1520           }
1521       }
1522 #endif /* MPW */
1523
1524 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1525
1526       /* If there is a better way to determine the window size, use it. */
1527       SIGWINCH_HANDLER (SIGWINCH);
1528 #endif
1529 #endif
1530       /* If the output is not a terminal, don't paginate it.  */
1531       if (!ui_file_isatty (gdb_stdout))
1532         lines_per_page = UINT_MAX;
1533     }                           /* the command_line_version */
1534   set_width ();
1535 }
1536
1537 static void
1538 set_width (void)
1539 {
1540   if (chars_per_line == 0)
1541     init_page_info ();
1542
1543   if (!wrap_buffer)
1544     {
1545       wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1546       wrap_buffer[0] = '\0';
1547     }
1548   else
1549     wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1550   wrap_pointer = wrap_buffer;   /* Start it at the beginning */
1551 }
1552
1553 /* ARGSUSED */
1554 static void
1555 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1556 {
1557   set_width ();
1558 }
1559
1560 /* Wait, so the user can read what's on the screen.  Prompt the user
1561    to continue by pressing RETURN.  */
1562
1563 static void
1564 prompt_for_continue (void)
1565 {
1566   char *ignore;
1567   char cont_prompt[120];
1568
1569   if (annotation_level > 1)
1570     printf_unfiltered ("\n\032\032pre-prompt-for-continue\n");
1571
1572   strcpy (cont_prompt,
1573           "---Type <return> to continue, or q <return> to quit---");
1574   if (annotation_level > 1)
1575     strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1576
1577   /* We must do this *before* we call gdb_readline, else it will eventually
1578      call us -- thinking that we're trying to print beyond the end of the 
1579      screen.  */
1580   reinitialize_more_filter ();
1581
1582   immediate_quit++;
1583   /* On a real operating system, the user can quit with SIGINT.
1584      But not on GO32.
1585
1586      'q' is provided on all systems so users don't have to change habits
1587      from system to system, and because telling them what to do in
1588      the prompt is more user-friendly than expecting them to think of
1589      SIGINT.  */
1590   /* Call readline, not gdb_readline, because GO32 readline handles control-C
1591      whereas control-C to gdb_readline will cause the user to get dumped
1592      out to DOS.  */
1593   ignore = readline (cont_prompt);
1594
1595   if (annotation_level > 1)
1596     printf_unfiltered ("\n\032\032post-prompt-for-continue\n");
1597
1598   if (ignore)
1599     {
1600       char *p = ignore;
1601       while (*p == ' ' || *p == '\t')
1602         ++p;
1603       if (p[0] == 'q')
1604         {
1605           if (!event_loop_p)
1606             request_quit (SIGINT);
1607           else
1608             async_request_quit (0);
1609         }
1610       free (ignore);
1611     }
1612   immediate_quit--;
1613
1614   /* Now we have to do this again, so that GDB will know that it doesn't
1615      need to save the ---Type <return>--- line at the top of the screen.  */
1616   reinitialize_more_filter ();
1617
1618   dont_repeat ();               /* Forget prev cmd -- CR won't repeat it. */
1619 }
1620
1621 /* Reinitialize filter; ie. tell it to reset to original values.  */
1622
1623 void
1624 reinitialize_more_filter (void)
1625 {
1626   lines_printed = 0;
1627   chars_printed = 0;
1628 }
1629
1630 /* Indicate that if the next sequence of characters overflows the line,
1631    a newline should be inserted here rather than when it hits the end. 
1632    If INDENT is non-null, it is a string to be printed to indent the
1633    wrapped part on the next line.  INDENT must remain accessible until
1634    the next call to wrap_here() or until a newline is printed through
1635    fputs_filtered().
1636
1637    If the line is already overfull, we immediately print a newline and
1638    the indentation, and disable further wrapping.
1639
1640    If we don't know the width of lines, but we know the page height,
1641    we must not wrap words, but should still keep track of newlines
1642    that were explicitly printed.
1643
1644    INDENT should not contain tabs, as that will mess up the char count
1645    on the next line.  FIXME.
1646
1647    This routine is guaranteed to force out any output which has been
1648    squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1649    used to force out output from the wrap_buffer.  */
1650
1651 void
1652 wrap_here (char *indent)
1653 {
1654   /* This should have been allocated, but be paranoid anyway. */
1655   if (!wrap_buffer)
1656     abort ();
1657
1658   if (wrap_buffer[0])
1659     {
1660       *wrap_pointer = '\0';
1661       fputs_unfiltered (wrap_buffer, gdb_stdout);
1662     }
1663   wrap_pointer = wrap_buffer;
1664   wrap_buffer[0] = '\0';
1665   if (chars_per_line == UINT_MAX)       /* No line overflow checking */
1666     {
1667       wrap_column = 0;
1668     }
1669   else if (chars_printed >= chars_per_line)
1670     {
1671       puts_filtered ("\n");
1672       if (indent != NULL)
1673         puts_filtered (indent);
1674       wrap_column = 0;
1675     }
1676   else
1677     {
1678       wrap_column = chars_printed;
1679       if (indent == NULL)
1680         wrap_indent = "";
1681       else
1682         wrap_indent = indent;
1683     }
1684 }
1685
1686 /* Ensure that whatever gets printed next, using the filtered output
1687    commands, starts at the beginning of the line.  I.E. if there is
1688    any pending output for the current line, flush it and start a new
1689    line.  Otherwise do nothing. */
1690
1691 void
1692 begin_line (void)
1693 {
1694   if (chars_printed > 0)
1695     {
1696       puts_filtered ("\n");
1697     }
1698 }
1699
1700
1701 /* Like fputs but if FILTER is true, pause after every screenful.
1702
1703    Regardless of FILTER can wrap at points other than the final
1704    character of a line.
1705
1706    Unlike fputs, fputs_maybe_filtered does not return a value.
1707    It is OK for LINEBUFFER to be NULL, in which case just don't print
1708    anything.
1709
1710    Note that a longjmp to top level may occur in this routine (only if
1711    FILTER is true) (since prompt_for_continue may do so) so this
1712    routine should not be called when cleanups are not in place.  */
1713
1714 static void
1715 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
1716                       int filter)
1717 {
1718   const char *lineptr;
1719
1720   if (linebuffer == 0)
1721     return;
1722
1723   /* Don't do any filtering if it is disabled.  */
1724   if ((stream != gdb_stdout) || !pagination_enabled
1725       || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX))
1726     {
1727       fputs_unfiltered (linebuffer, stream);
1728       return;
1729     }
1730
1731   /* Go through and output each character.  Show line extension
1732      when this is necessary; prompt user for new page when this is
1733      necessary.  */
1734
1735   lineptr = linebuffer;
1736   while (*lineptr)
1737     {
1738       /* Possible new page.  */
1739       if (filter &&
1740           (lines_printed >= lines_per_page - 1))
1741         prompt_for_continue ();
1742
1743       while (*lineptr && *lineptr != '\n')
1744         {
1745           /* Print a single line.  */
1746           if (*lineptr == '\t')
1747             {
1748               if (wrap_column)
1749                 *wrap_pointer++ = '\t';
1750               else
1751                 fputc_unfiltered ('\t', stream);
1752               /* Shifting right by 3 produces the number of tab stops
1753                  we have already passed, and then adding one and
1754                  shifting left 3 advances to the next tab stop.  */
1755               chars_printed = ((chars_printed >> 3) + 1) << 3;
1756               lineptr++;
1757             }
1758           else
1759             {
1760               if (wrap_column)
1761                 *wrap_pointer++ = *lineptr;
1762               else
1763                 fputc_unfiltered (*lineptr, stream);
1764               chars_printed++;
1765               lineptr++;
1766             }
1767
1768           if (chars_printed >= chars_per_line)
1769             {
1770               unsigned int save_chars = chars_printed;
1771
1772               chars_printed = 0;
1773               lines_printed++;
1774               /* If we aren't actually wrapping, don't output newline --
1775                  if chars_per_line is right, we probably just overflowed
1776                  anyway; if it's wrong, let us keep going.  */
1777               if (wrap_column)
1778                 fputc_unfiltered ('\n', stream);
1779
1780               /* Possible new page.  */
1781               if (lines_printed >= lines_per_page - 1)
1782                 prompt_for_continue ();
1783
1784               /* Now output indentation and wrapped string */
1785               if (wrap_column)
1786                 {
1787                   fputs_unfiltered (wrap_indent, stream);
1788                   *wrap_pointer = '\0';         /* Null-terminate saved stuff */
1789                   fputs_unfiltered (wrap_buffer, stream);       /* and eject it */
1790                   /* FIXME, this strlen is what prevents wrap_indent from
1791                      containing tabs.  However, if we recurse to print it
1792                      and count its chars, we risk trouble if wrap_indent is
1793                      longer than (the user settable) chars_per_line. 
1794                      Note also that this can set chars_printed > chars_per_line
1795                      if we are printing a long string.  */
1796                   chars_printed = strlen (wrap_indent)
1797                     + (save_chars - wrap_column);
1798                   wrap_pointer = wrap_buffer;   /* Reset buffer */
1799                   wrap_buffer[0] = '\0';
1800                   wrap_column = 0;      /* And disable fancy wrap */
1801                 }
1802             }
1803         }
1804
1805       if (*lineptr == '\n')
1806         {
1807           chars_printed = 0;
1808           wrap_here ((char *) 0);       /* Spit out chars, cancel further wraps */
1809           lines_printed++;
1810           fputc_unfiltered ('\n', stream);
1811           lineptr++;
1812         }
1813     }
1814 }
1815
1816 void
1817 fputs_filtered (const char *linebuffer, struct ui_file *stream)
1818 {
1819   fputs_maybe_filtered (linebuffer, stream, 1);
1820 }
1821
1822 int
1823 putchar_unfiltered (int c)
1824 {
1825   char buf = c;
1826   ui_file_write (gdb_stdout, &buf, 1);
1827   return c;
1828 }
1829
1830 int
1831 fputc_unfiltered (int c, struct ui_file *stream)
1832 {
1833   char buf = c;
1834   ui_file_write (stream, &buf, 1);
1835   return c;
1836 }
1837
1838 int
1839 fputc_filtered (int c, struct ui_file *stream)
1840 {
1841   char buf[2];
1842
1843   buf[0] = c;
1844   buf[1] = 0;
1845   fputs_filtered (buf, stream);
1846   return c;
1847 }
1848
1849 /* puts_debug is like fputs_unfiltered, except it prints special
1850    characters in printable fashion.  */
1851
1852 void
1853 puts_debug (char *prefix, char *string, char *suffix)
1854 {
1855   int ch;
1856
1857   /* Print prefix and suffix after each line.  */
1858   static int new_line = 1;
1859   static int return_p = 0;
1860   static char *prev_prefix = "";
1861   static char *prev_suffix = "";
1862
1863   if (*string == '\n')
1864     return_p = 0;
1865
1866   /* If the prefix is changing, print the previous suffix, a new line,
1867      and the new prefix.  */
1868   if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
1869     {
1870       fputs_unfiltered (prev_suffix, gdb_stdlog);
1871       fputs_unfiltered ("\n", gdb_stdlog);
1872       fputs_unfiltered (prefix, gdb_stdlog);
1873     }
1874
1875   /* Print prefix if we printed a newline during the previous call.  */
1876   if (new_line)
1877     {
1878       new_line = 0;
1879       fputs_unfiltered (prefix, gdb_stdlog);
1880     }
1881
1882   prev_prefix = prefix;
1883   prev_suffix = suffix;
1884
1885   /* Output characters in a printable format.  */
1886   while ((ch = *string++) != '\0')
1887     {
1888       switch (ch)
1889         {
1890         default:
1891           if (isprint (ch))
1892             fputc_unfiltered (ch, gdb_stdlog);
1893
1894           else
1895             fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
1896           break;
1897
1898         case '\\':
1899           fputs_unfiltered ("\\\\", gdb_stdlog);
1900           break;
1901         case '\b':
1902           fputs_unfiltered ("\\b", gdb_stdlog);
1903           break;
1904         case '\f':
1905           fputs_unfiltered ("\\f", gdb_stdlog);
1906           break;
1907         case '\n':
1908           new_line = 1;
1909           fputs_unfiltered ("\\n", gdb_stdlog);
1910           break;
1911         case '\r':
1912           fputs_unfiltered ("\\r", gdb_stdlog);
1913           break;
1914         case '\t':
1915           fputs_unfiltered ("\\t", gdb_stdlog);
1916           break;
1917         case '\v':
1918           fputs_unfiltered ("\\v", gdb_stdlog);
1919           break;
1920         }
1921
1922       return_p = ch == '\r';
1923     }
1924
1925   /* Print suffix if we printed a newline.  */
1926   if (new_line)
1927     {
1928       fputs_unfiltered (suffix, gdb_stdlog);
1929       fputs_unfiltered ("\n", gdb_stdlog);
1930     }
1931 }
1932
1933
1934 /* Print a variable number of ARGS using format FORMAT.  If this
1935    information is going to put the amount written (since the last call
1936    to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1937    call prompt_for_continue to get the users permision to continue.
1938
1939    Unlike fprintf, this function does not return a value.
1940
1941    We implement three variants, vfprintf (takes a vararg list and stream),
1942    fprintf (takes a stream to write on), and printf (the usual).
1943
1944    Note also that a longjmp to top level may occur in this routine
1945    (since prompt_for_continue may do so) so this routine should not be
1946    called when cleanups are not in place.  */
1947
1948 static void
1949 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
1950                          va_list args, int filter)
1951 {
1952   char *linebuffer;
1953   struct cleanup *old_cleanups;
1954
1955   vasprintf (&linebuffer, format, args);
1956   if (linebuffer == NULL)
1957     {
1958       fputs_unfiltered ("\ngdb: virtual memory exhausted.\n", gdb_stderr);
1959       exit (1);
1960     }
1961   old_cleanups = make_cleanup (free, linebuffer);
1962   fputs_maybe_filtered (linebuffer, stream, filter);
1963   do_cleanups (old_cleanups);
1964 }
1965
1966
1967 void
1968 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
1969 {
1970   vfprintf_maybe_filtered (stream, format, args, 1);
1971 }
1972
1973 void
1974 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
1975 {
1976   char *linebuffer;
1977   struct cleanup *old_cleanups;
1978
1979   vasprintf (&linebuffer, format, args);
1980   if (linebuffer == NULL)
1981     {
1982       fputs_unfiltered ("\ngdb: virtual memory exhausted.\n", gdb_stderr);
1983       exit (1);
1984     }
1985   old_cleanups = make_cleanup (free, linebuffer);
1986   fputs_unfiltered (linebuffer, stream);
1987   do_cleanups (old_cleanups);
1988 }
1989
1990 void
1991 vprintf_filtered (const char *format, va_list args)
1992 {
1993   vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
1994 }
1995
1996 void
1997 vprintf_unfiltered (const char *format, va_list args)
1998 {
1999   vfprintf_unfiltered (gdb_stdout, format, args);
2000 }
2001
2002 void
2003 fprintf_filtered (struct ui_file * stream, const char *format,...)
2004 {
2005   va_list args;
2006   va_start (args, format);
2007   vfprintf_filtered (stream, format, args);
2008   va_end (args);
2009 }
2010
2011 void
2012 fprintf_unfiltered (struct ui_file * stream, const char *format,...)
2013 {
2014   va_list args;
2015   va_start (args, format);
2016   vfprintf_unfiltered (stream, format, args);
2017   va_end (args);
2018 }
2019
2020 /* Like fprintf_filtered, but prints its result indented.
2021    Called as fprintfi_filtered (spaces, stream, format, ...);  */
2022
2023 void
2024 fprintfi_filtered (int spaces, struct ui_file * stream, const char *format,...)
2025 {
2026   va_list args;
2027   va_start (args, format);
2028   print_spaces_filtered (spaces, stream);
2029
2030   vfprintf_filtered (stream, format, args);
2031   va_end (args);
2032 }
2033
2034
2035 void
2036 printf_filtered (const char *format,...)
2037 {
2038   va_list args;
2039   va_start (args, format);
2040   vfprintf_filtered (gdb_stdout, format, args);
2041   va_end (args);
2042 }
2043
2044
2045 void
2046 printf_unfiltered (const char *format,...)
2047 {
2048   va_list args;
2049   va_start (args, format);
2050   vfprintf_unfiltered (gdb_stdout, format, args);
2051   va_end (args);
2052 }
2053
2054 /* Like printf_filtered, but prints it's result indented.
2055    Called as printfi_filtered (spaces, format, ...);  */
2056
2057 void
2058 printfi_filtered (int spaces, const char *format,...)
2059 {
2060   va_list args;
2061   va_start (args, format);
2062   print_spaces_filtered (spaces, gdb_stdout);
2063   vfprintf_filtered (gdb_stdout, format, args);
2064   va_end (args);
2065 }
2066
2067 /* Easy -- but watch out!
2068
2069    This routine is *not* a replacement for puts()!  puts() appends a newline.
2070    This one doesn't, and had better not!  */
2071
2072 void
2073 puts_filtered (const char *string)
2074 {
2075   fputs_filtered (string, gdb_stdout);
2076 }
2077
2078 void
2079 puts_unfiltered (const char *string)
2080 {
2081   fputs_unfiltered (string, gdb_stdout);
2082 }
2083
2084 /* Return a pointer to N spaces and a null.  The pointer is good
2085    until the next call to here.  */
2086 char *
2087 n_spaces (int n)
2088 {
2089   char *t;
2090   static char *spaces = 0;
2091   static int max_spaces = -1;
2092
2093   if (n > max_spaces)
2094     {
2095       if (spaces)
2096         free (spaces);
2097       spaces = (char *) xmalloc (n + 1);
2098       for (t = spaces + n; t != spaces;)
2099         *--t = ' ';
2100       spaces[n] = '\0';
2101       max_spaces = n;
2102     }
2103
2104   return spaces + max_spaces - n;
2105 }
2106
2107 /* Print N spaces.  */
2108 void
2109 print_spaces_filtered (int n, struct ui_file *stream)
2110 {
2111   fputs_filtered (n_spaces (n), stream);
2112 }
2113 \f
2114 /* C++ demangler stuff.  */
2115
2116 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2117    LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2118    If the name is not mangled, or the language for the name is unknown, or
2119    demangling is off, the name is printed in its "raw" form. */
2120
2121 void
2122 fprintf_symbol_filtered (struct ui_file *stream, char *name, enum language lang,
2123                          int arg_mode)
2124 {
2125   char *demangled;
2126
2127   if (name != NULL)
2128     {
2129       /* If user wants to see raw output, no problem.  */
2130       if (!demangle)
2131         {
2132           fputs_filtered (name, stream);
2133         }
2134       else
2135         {
2136           switch (lang)
2137             {
2138             case language_cplus:
2139               demangled = cplus_demangle (name, arg_mode);
2140               break;
2141             case language_java:
2142               demangled = cplus_demangle (name, arg_mode | DMGL_JAVA);
2143               break;
2144             case language_chill:
2145               demangled = chill_demangle (name);
2146               break;
2147             default:
2148               demangled = NULL;
2149               break;
2150             }
2151           fputs_filtered (demangled ? demangled : name, stream);
2152           if (demangled != NULL)
2153             {
2154               free (demangled);
2155             }
2156         }
2157     }
2158 }
2159
2160 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2161    differences in whitespace.  Returns 0 if they match, non-zero if they
2162    don't (slightly different than strcmp()'s range of return values).
2163
2164    As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2165    This "feature" is useful when searching for matching C++ function names
2166    (such as if the user types 'break FOO', where FOO is a mangled C++
2167    function). */
2168
2169 int
2170 strcmp_iw (const char *string1, const char *string2)
2171 {
2172   while ((*string1 != '\0') && (*string2 != '\0'))
2173     {
2174       while (isspace (*string1))
2175         {
2176           string1++;
2177         }
2178       while (isspace (*string2))
2179         {
2180           string2++;
2181         }
2182       if (*string1 != *string2)
2183         {
2184           break;
2185         }
2186       if (*string1 != '\0')
2187         {
2188           string1++;
2189           string2++;
2190         }
2191     }
2192   return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2193 }
2194 \f
2195
2196 /*
2197    ** subset_compare()
2198    **    Answer whether string_to_compare is a full or partial match to
2199    **    template_string.  The partial match must be in sequence starting
2200    **    at index 0.
2201  */
2202 int
2203 subset_compare (char *string_to_compare, char *template_string)
2204 {
2205   int match;
2206   if (template_string != (char *) NULL && string_to_compare != (char *) NULL &&
2207       strlen (string_to_compare) <= strlen (template_string))
2208     match = (strncmp (template_string,
2209                       string_to_compare,
2210                       strlen (string_to_compare)) == 0);
2211   else
2212     match = 0;
2213   return match;
2214 }
2215
2216
2217 static void pagination_on_command (char *arg, int from_tty);
2218 static void
2219 pagination_on_command (char *arg, int from_tty)
2220 {
2221   pagination_enabled = 1;
2222 }
2223
2224 static void pagination_on_command (char *arg, int from_tty);
2225 static void
2226 pagination_off_command (char *arg, int from_tty)
2227 {
2228   pagination_enabled = 0;
2229 }
2230 \f
2231
2232 void
2233 initialize_utils (void)
2234 {
2235   struct cmd_list_element *c;
2236
2237   c = add_set_cmd ("width", class_support, var_uinteger,
2238                    (char *) &chars_per_line,
2239                    "Set number of characters gdb thinks are in a line.",
2240                    &setlist);
2241   add_show_from_set (c, &showlist);
2242   c->function.sfunc = set_width_command;
2243
2244   add_show_from_set
2245     (add_set_cmd ("height", class_support,
2246                   var_uinteger, (char *) &lines_per_page,
2247                   "Set number of lines gdb thinks are in a page.", &setlist),
2248      &showlist);
2249
2250   init_page_info ();
2251
2252   /* If the output is not a terminal, don't paginate it.  */
2253   if (!ui_file_isatty (gdb_stdout))
2254     lines_per_page = UINT_MAX;
2255
2256   set_width_command ((char *) NULL, 0, c);
2257
2258   add_show_from_set
2259     (add_set_cmd ("demangle", class_support, var_boolean,
2260                   (char *) &demangle,
2261              "Set demangling of encoded C++ names when displaying symbols.",
2262                   &setprintlist),
2263      &showprintlist);
2264
2265   add_show_from_set
2266     (add_set_cmd ("pagination", class_support,
2267                   var_boolean, (char *) &pagination_enabled,
2268                   "Set state of pagination.", &setlist),
2269      &showlist);
2270
2271   if (xdb_commands)
2272     {
2273       add_com ("am", class_support, pagination_on_command,
2274                "Enable pagination");
2275       add_com ("sm", class_support, pagination_off_command,
2276                "Disable pagination");
2277     }
2278
2279   add_show_from_set
2280     (add_set_cmd ("sevenbit-strings", class_support, var_boolean,
2281                   (char *) &sevenbit_strings,
2282                   "Set printing of 8-bit characters in strings as \\nnn.",
2283                   &setprintlist),
2284      &showprintlist);
2285
2286   add_show_from_set
2287     (add_set_cmd ("asm-demangle", class_support, var_boolean,
2288                   (char *) &asm_demangle,
2289                   "Set demangling of C++ names in disassembly listings.",
2290                   &setprintlist),
2291      &showprintlist);
2292 }
2293
2294 /* Machine specific function to handle SIGWINCH signal. */
2295
2296 #ifdef  SIGWINCH_HANDLER_BODY
2297 SIGWINCH_HANDLER_BODY
2298 #endif
2299 \f
2300 /* Support for converting target fp numbers into host DOUBLEST format.  */
2301
2302 /* XXX - This code should really be in libiberty/floatformat.c, however
2303    configuration issues with libiberty made this very difficult to do in the
2304    available time.  */
2305
2306 #include "floatformat.h"
2307 #include <math.h>               /* ldexp */
2308
2309 /* The odds that CHAR_BIT will be anything but 8 are low enough that I'm not
2310    going to bother with trying to muck around with whether it is defined in
2311    a system header, what we do if not, etc.  */
2312 #define FLOATFORMAT_CHAR_BIT 8
2313
2314 static unsigned long get_field (unsigned char *,
2315                                 enum floatformat_byteorders,
2316                                 unsigned int, unsigned int, unsigned int);
2317
2318 /* Extract a field which starts at START and is LEN bytes long.  DATA and
2319    TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER.  */
2320 static unsigned long
2321 get_field (unsigned char *data, enum floatformat_byteorders order,
2322            unsigned int total_len, unsigned int start, unsigned int len)
2323 {
2324   unsigned long result;
2325   unsigned int cur_byte;
2326   int cur_bitshift;
2327
2328   /* Start at the least significant part of the field.  */
2329   if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2330     {
2331       /* We start counting from the other end (i.e, from the high bytes
2332          rather than the low bytes).  As such, we need to be concerned
2333          with what happens if bit 0 doesn't start on a byte boundary. 
2334          I.e, we need to properly handle the case where total_len is
2335          not evenly divisible by 8.  So we compute ``excess'' which
2336          represents the number of bits from the end of our starting
2337          byte needed to get to bit 0. */
2338       int excess = FLOATFORMAT_CHAR_BIT - (total_len % FLOATFORMAT_CHAR_BIT);
2339       cur_byte = (total_len / FLOATFORMAT_CHAR_BIT) 
2340                  - ((start + len + excess) / FLOATFORMAT_CHAR_BIT);
2341       cur_bitshift = ((start + len + excess) % FLOATFORMAT_CHAR_BIT) 
2342                      - FLOATFORMAT_CHAR_BIT;
2343     }
2344   else
2345     {
2346       cur_byte = (start + len) / FLOATFORMAT_CHAR_BIT;
2347       cur_bitshift =
2348         ((start + len) % FLOATFORMAT_CHAR_BIT) - FLOATFORMAT_CHAR_BIT;
2349     }
2350   if (cur_bitshift > -FLOATFORMAT_CHAR_BIT)
2351     result = *(data + cur_byte) >> (-cur_bitshift);
2352   else
2353     result = 0;
2354   cur_bitshift += FLOATFORMAT_CHAR_BIT;
2355   if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2356     ++cur_byte;
2357   else
2358     --cur_byte;
2359
2360   /* Move towards the most significant part of the field.  */
2361   while (cur_bitshift < len)
2362     {
2363       result |= (unsigned long)*(data + cur_byte) << cur_bitshift;
2364       cur_bitshift += FLOATFORMAT_CHAR_BIT;
2365       if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2366         ++cur_byte;
2367       else
2368         --cur_byte;
2369     }
2370   if (len < sizeof(result) * FLOATFORMAT_CHAR_BIT)
2371     /* Mask out bits which are not part of the field */
2372     result &= ((1UL << len) - 1);
2373   return result;
2374 }
2375
2376 /* Convert from FMT to a DOUBLEST.
2377    FROM is the address of the extended float.
2378    Store the DOUBLEST in *TO.  */
2379
2380 void
2381 floatformat_to_doublest (const struct floatformat *fmt, char *from,
2382                          DOUBLEST *to)
2383 {
2384   unsigned char *ufrom = (unsigned char *) from;
2385   DOUBLEST dto;
2386   long exponent;
2387   unsigned long mant;
2388   unsigned int mant_bits, mant_off;
2389   int mant_bits_left;
2390   int special_exponent;         /* It's a NaN, denorm or zero */
2391
2392   /* If the mantissa bits are not contiguous from one end of the
2393      mantissa to the other, we need to make a private copy of the
2394      source bytes that is in the right order since the unpacking
2395      algorithm assumes that the bits are contiguous.
2396
2397      Swap the bytes individually rather than accessing them through
2398      "long *" since we have no guarantee that they start on a long
2399      alignment, and also sizeof(long) for the host could be different
2400      than sizeof(long) for the target.  FIXME: Assumes sizeof(long)
2401      for the target is 4. */
2402
2403   if (fmt->byteorder == floatformat_littlebyte_bigword)
2404     {
2405       static unsigned char *newfrom;
2406       unsigned char *swapin, *swapout;
2407       int longswaps;
2408
2409       longswaps = fmt->totalsize / FLOATFORMAT_CHAR_BIT;
2410       longswaps >>= 3;
2411
2412       if (newfrom == NULL)
2413         {
2414           newfrom = (unsigned char *) xmalloc (fmt->totalsize);
2415         }
2416       swapout = newfrom;
2417       swapin = ufrom;
2418       ufrom = newfrom;
2419       while (longswaps-- > 0)
2420         {
2421           /* This is ugly, but efficient */
2422           *swapout++ = swapin[4];
2423           *swapout++ = swapin[5];
2424           *swapout++ = swapin[6];
2425           *swapout++ = swapin[7];
2426           *swapout++ = swapin[0];
2427           *swapout++ = swapin[1];
2428           *swapout++ = swapin[2];
2429           *swapout++ = swapin[3];
2430           swapin += 8;
2431         }
2432     }
2433
2434   exponent = get_field (ufrom, fmt->byteorder, fmt->totalsize,
2435                         fmt->exp_start, fmt->exp_len);
2436   /* Note that if exponent indicates a NaN, we can't really do anything useful
2437      (not knowing if the host has NaN's, or how to build one).  So it will
2438      end up as an infinity or something close; that is OK.  */
2439
2440   mant_bits_left = fmt->man_len;
2441   mant_off = fmt->man_start;
2442   dto = 0.0;
2443
2444   special_exponent = exponent == 0 || exponent == fmt->exp_nan;
2445
2446 /* Don't bias NaNs. Use minimum exponent for denorms. For simplicity,
2447    we don't check for zero as the exponent doesn't matter. */
2448   if (!special_exponent)
2449     exponent -= fmt->exp_bias;
2450   else if (exponent == 0)
2451     exponent = 1 - fmt->exp_bias;
2452
2453   /* Build the result algebraically.  Might go infinite, underflow, etc;
2454      who cares. */
2455
2456 /* If this format uses a hidden bit, explicitly add it in now.  Otherwise,
2457    increment the exponent by one to account for the integer bit.  */
2458
2459   if (!special_exponent)
2460     {
2461       if (fmt->intbit == floatformat_intbit_no)
2462         dto = ldexp (1.0, exponent);
2463       else
2464         exponent++;
2465     }
2466
2467   while (mant_bits_left > 0)
2468     {
2469       mant_bits = min (mant_bits_left, 32);
2470
2471       mant = get_field (ufrom, fmt->byteorder, fmt->totalsize,
2472                         mant_off, mant_bits);
2473
2474       dto += ldexp ((double) mant, exponent - mant_bits);
2475       exponent -= mant_bits;
2476       mant_off += mant_bits;
2477       mant_bits_left -= mant_bits;
2478     }
2479
2480   /* Negate it if negative.  */
2481   if (get_field (ufrom, fmt->byteorder, fmt->totalsize, fmt->sign_start, 1))
2482     dto = -dto;
2483   *to = dto;
2484 }
2485 \f
2486 static void put_field (unsigned char *, enum floatformat_byteorders,
2487                        unsigned int,
2488                        unsigned int, unsigned int, unsigned long);
2489
2490 /* Set a field which starts at START and is LEN bytes long.  DATA and
2491    TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER.  */
2492 static void
2493 put_field (unsigned char *data, enum floatformat_byteorders order,
2494            unsigned int total_len, unsigned int start, unsigned int len,
2495            unsigned long stuff_to_put)
2496 {
2497   unsigned int cur_byte;
2498   int cur_bitshift;
2499
2500   /* Start at the least significant part of the field.  */
2501   if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2502     {
2503       int excess = FLOATFORMAT_CHAR_BIT - (total_len % FLOATFORMAT_CHAR_BIT);
2504       cur_byte = (total_len / FLOATFORMAT_CHAR_BIT) 
2505                  - ((start + len + excess) / FLOATFORMAT_CHAR_BIT);
2506       cur_bitshift = ((start + len + excess) % FLOATFORMAT_CHAR_BIT) 
2507                      - FLOATFORMAT_CHAR_BIT;
2508     }
2509   else
2510     {
2511       cur_byte = (start + len) / FLOATFORMAT_CHAR_BIT;
2512       cur_bitshift =
2513         ((start + len) % FLOATFORMAT_CHAR_BIT) - FLOATFORMAT_CHAR_BIT;
2514     }
2515   if (cur_bitshift > -FLOATFORMAT_CHAR_BIT)
2516     {
2517       *(data + cur_byte) &=
2518         ~(((1 << ((start + len) % FLOATFORMAT_CHAR_BIT)) - 1)
2519           << (-cur_bitshift));
2520       *(data + cur_byte) |=
2521         (stuff_to_put & ((1 << FLOATFORMAT_CHAR_BIT) - 1)) << (-cur_bitshift);
2522     }
2523   cur_bitshift += FLOATFORMAT_CHAR_BIT;
2524   if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2525     ++cur_byte;
2526   else
2527     --cur_byte;
2528
2529   /* Move towards the most significant part of the field.  */
2530   while (cur_bitshift < len)
2531     {
2532       if (len - cur_bitshift < FLOATFORMAT_CHAR_BIT)
2533         {
2534           /* This is the last byte.  */
2535           *(data + cur_byte) &=
2536             ~((1 << (len - cur_bitshift)) - 1);
2537           *(data + cur_byte) |= (stuff_to_put >> cur_bitshift);
2538         }
2539       else
2540         *(data + cur_byte) = ((stuff_to_put >> cur_bitshift)
2541                               & ((1 << FLOATFORMAT_CHAR_BIT) - 1));
2542       cur_bitshift += FLOATFORMAT_CHAR_BIT;
2543       if (order == floatformat_little || order == floatformat_littlebyte_bigword)
2544         ++cur_byte;
2545       else
2546         --cur_byte;
2547     }
2548 }
2549
2550 #ifdef HAVE_LONG_DOUBLE
2551 /* Return the fractional part of VALUE, and put the exponent of VALUE in *EPTR.
2552    The range of the returned value is >= 0.5 and < 1.0.  This is equivalent to
2553    frexp, but operates on the long double data type.  */
2554
2555 static long double ldfrexp (long double value, int *eptr);
2556
2557 static long double
2558 ldfrexp (long double value, int *eptr)
2559 {
2560   long double tmp;
2561   int exp;
2562
2563   /* Unfortunately, there are no portable functions for extracting the exponent
2564      of a long double, so we have to do it iteratively by multiplying or dividing
2565      by two until the fraction is between 0.5 and 1.0.  */
2566
2567   if (value < 0.0l)
2568     value = -value;
2569
2570   tmp = 1.0l;
2571   exp = 0;
2572
2573   if (value >= tmp)             /* Value >= 1.0 */
2574     while (value >= tmp)
2575       {
2576         tmp *= 2.0l;
2577         exp++;
2578       }
2579   else if (value != 0.0l)       /* Value < 1.0  and > 0.0 */
2580     {
2581       while (value < tmp)
2582         {
2583           tmp /= 2.0l;
2584           exp--;
2585         }
2586       tmp *= 2.0l;
2587       exp++;
2588     }
2589
2590   *eptr = exp;
2591   return value / tmp;
2592 }
2593 #endif /* HAVE_LONG_DOUBLE */
2594
2595
2596 /* The converse: convert the DOUBLEST *FROM to an extended float
2597    and store where TO points.  Neither FROM nor TO have any alignment
2598    restrictions.  */
2599
2600 void
2601 floatformat_from_doublest (CONST struct floatformat *fmt, DOUBLEST *from,
2602                            char *to)
2603 {
2604   DOUBLEST dfrom;
2605   int exponent;
2606   DOUBLEST mant;
2607   unsigned int mant_bits, mant_off;
2608   int mant_bits_left;
2609   unsigned char *uto = (unsigned char *) to;
2610
2611   memcpy (&dfrom, from, sizeof (dfrom));
2612   memset (uto, 0, (fmt->totalsize + FLOATFORMAT_CHAR_BIT - 1) 
2613                     / FLOATFORMAT_CHAR_BIT);
2614   if (dfrom == 0)
2615     return;                     /* Result is zero */
2616   if (dfrom != dfrom)           /* Result is NaN */
2617     {
2618       /* From is NaN */
2619       put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
2620                  fmt->exp_len, fmt->exp_nan);
2621       /* Be sure it's not infinity, but NaN value is irrel */
2622       put_field (uto, fmt->byteorder, fmt->totalsize, fmt->man_start,
2623                  32, 1);
2624       return;
2625     }
2626
2627   /* If negative, set the sign bit.  */
2628   if (dfrom < 0)
2629     {
2630       put_field (uto, fmt->byteorder, fmt->totalsize, fmt->sign_start, 1, 1);
2631       dfrom = -dfrom;
2632     }
2633
2634   if (dfrom + dfrom == dfrom && dfrom != 0.0)   /* Result is Infinity */
2635     {
2636       /* Infinity exponent is same as NaN's.  */
2637       put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start,
2638                  fmt->exp_len, fmt->exp_nan);
2639       /* Infinity mantissa is all zeroes.  */
2640       put_field (uto, fmt->byteorder, fmt->totalsize, fmt->man_start,
2641                  fmt->man_len, 0);
2642       return;
2643     }
2644
2645 #ifdef HAVE_LONG_DOUBLE
2646   mant = ldfrexp (dfrom, &exponent);
2647 #else
2648   mant = frexp (dfrom, &exponent);
2649 #endif
2650
2651   put_field (uto, fmt->byteorder, fmt->totalsize, fmt->exp_start, fmt->exp_len,
2652              exponent + fmt->exp_bias - 1);
2653
2654   mant_bits_left = fmt->man_len;
2655   mant_off = fmt->man_start;
2656   while (mant_bits_left > 0)
2657     {
2658       unsigned long mant_long;
2659       mant_bits = mant_bits_left < 32 ? mant_bits_left : 32;
2660
2661       mant *= 4294967296.0;
2662       mant_long = ((unsigned long) mant) & 0xffffffffL;
2663       mant -= mant_long;
2664
2665       /* If the integer bit is implicit, then we need to discard it.
2666          If we are discarding a zero, we should be (but are not) creating
2667          a denormalized number which means adjusting the exponent
2668          (I think).  */
2669       if (mant_bits_left == fmt->man_len
2670           && fmt->intbit == floatformat_intbit_no)
2671         {
2672           mant_long <<= 1;
2673           mant_long &= 0xffffffffL;
2674           mant_bits -= 1;
2675         }
2676
2677       if (mant_bits < 32)
2678         {
2679           /* The bits we want are in the most significant MANT_BITS bits of
2680              mant_long.  Move them to the least significant.  */
2681           mant_long >>= 32 - mant_bits;
2682         }
2683
2684       put_field (uto, fmt->byteorder, fmt->totalsize,
2685                  mant_off, mant_bits, mant_long);
2686       mant_off += mant_bits;
2687       mant_bits_left -= mant_bits;
2688     }
2689   if (fmt->byteorder == floatformat_littlebyte_bigword)
2690     {
2691       int count;
2692       unsigned char *swaplow = uto;
2693       unsigned char *swaphigh = uto + 4;
2694       unsigned char tmp;
2695
2696       for (count = 0; count < 4; count++)
2697         {
2698           tmp = *swaplow;
2699           *swaplow++ = *swaphigh;
2700           *swaphigh++ = tmp;
2701         }
2702     }
2703 }
2704
2705 /* print routines to handle variable size regs, etc. */
2706
2707 /* temporary storage using circular buffer */
2708 #define NUMCELLS 16
2709 #define CELLSIZE 32
2710 static char *
2711 get_cell (void)
2712 {
2713   static char buf[NUMCELLS][CELLSIZE];
2714   static int cell = 0;
2715   if (++cell >= NUMCELLS)
2716     cell = 0;
2717   return buf[cell];
2718 }
2719
2720 int
2721 strlen_paddr (void)
2722 {
2723   return (TARGET_ADDR_BIT / 8 * 2);
2724 }
2725
2726 char *
2727 paddr (CORE_ADDR addr)
2728 {
2729   return phex (addr, TARGET_ADDR_BIT / 8);
2730 }
2731
2732 char *
2733 paddr_nz (CORE_ADDR addr)
2734 {
2735   return phex_nz (addr, TARGET_ADDR_BIT / 8);
2736 }
2737
2738 static void
2739 decimal2str (char *paddr_str, char *sign, ULONGEST addr)
2740 {
2741   /* steal code from valprint.c:print_decimal().  Should this worry
2742      about the real size of addr as the above does? */
2743   unsigned long temp[3];
2744   int i = 0;
2745   do
2746     {
2747       temp[i] = addr % (1000 * 1000 * 1000);
2748       addr /= (1000 * 1000 * 1000);
2749       i++;
2750     }
2751   while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2752   switch (i)
2753     {
2754     case 1:
2755       sprintf (paddr_str, "%s%lu",
2756                sign, temp[0]);
2757       break;
2758     case 2:
2759       sprintf (paddr_str, "%s%lu%09lu",
2760                sign, temp[1], temp[0]);
2761       break;
2762     case 3:
2763       sprintf (paddr_str, "%s%lu%09lu%09lu",
2764                sign, temp[2], temp[1], temp[0]);
2765       break;
2766     default:
2767       abort ();
2768     }
2769 }
2770
2771 char *
2772 paddr_u (CORE_ADDR addr)
2773 {
2774   char *paddr_str = get_cell ();
2775   decimal2str (paddr_str, "", addr);
2776   return paddr_str;
2777 }
2778
2779 char *
2780 paddr_d (LONGEST addr)
2781 {
2782   char *paddr_str = get_cell ();
2783   if (addr < 0)
2784     decimal2str (paddr_str, "-", -addr);
2785   else
2786     decimal2str (paddr_str, "", addr);
2787   return paddr_str;
2788 }
2789
2790 /* eliminate warning from compiler on 32-bit systems */
2791 static int thirty_two = 32;
2792
2793 char *
2794 phex (ULONGEST l, int sizeof_l)
2795 {
2796   char *str = get_cell ();
2797   switch (sizeof_l)
2798     {
2799     case 8:
2800       sprintf (str, "%08lx%08lx",
2801                (unsigned long) (l >> thirty_two),
2802                (unsigned long) (l & 0xffffffff));
2803       break;
2804     case 4:
2805       sprintf (str, "%08lx", (unsigned long) l);
2806       break;
2807     case 2:
2808       sprintf (str, "%04x", (unsigned short) (l & 0xffff));
2809       break;
2810     default:
2811       phex (l, sizeof (l));
2812       break;
2813     }
2814   return str;
2815 }
2816
2817 char *
2818 phex_nz (ULONGEST l, int sizeof_l)
2819 {
2820   char *str = get_cell ();
2821   switch (sizeof_l)
2822     {
2823     case 8:
2824       {
2825         unsigned long high = (unsigned long) (l >> thirty_two);
2826         if (high == 0)
2827           sprintf (str, "%lx", (unsigned long) (l & 0xffffffff));
2828         else
2829           sprintf (str, "%lx%08lx",
2830                    high, (unsigned long) (l & 0xffffffff));
2831         break;
2832       }
2833     case 4:
2834       sprintf (str, "%lx", (unsigned long) l);
2835       break;
2836     case 2:
2837       sprintf (str, "%x", (unsigned short) (l & 0xffff));
2838       break;
2839     default:
2840       phex_nz (l, sizeof (l));
2841       break;
2842     }
2843   return str;
2844 }
2845
2846
2847 /* Convert to / from the hosts pointer to GDB's internal CORE_ADDR
2848    using the target's conversion routines. */
2849 CORE_ADDR
2850 host_pointer_to_address (void *ptr)
2851 {
2852   if (sizeof (ptr) != TYPE_LENGTH (builtin_type_ptr))
2853     internal_error ("core_addr_to_void_ptr: bad cast");
2854   return POINTER_TO_ADDRESS (builtin_type_ptr, &ptr);
2855 }
2856
2857 void *
2858 address_to_host_pointer (CORE_ADDR addr)
2859 {
2860   void *ptr;
2861   if (sizeof (ptr) != TYPE_LENGTH (builtin_type_ptr))
2862     internal_error ("core_addr_to_void_ptr: bad cast");
2863   ADDRESS_TO_POINTER (builtin_type_ptr, &ptr, addr);
2864   return ptr;
2865 }