Imported Upstream version 7.5
[platform/upstream/gdb.git] / gdb / valprint.c
1 /* Print values for GDB, the GNU debugger.
2
3    Copyright (C) 1986, 1988-2012 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 3 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, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "gdb_string.h"
22 #include "symtab.h"
23 #include "gdbtypes.h"
24 #include "value.h"
25 #include "gdbcore.h"
26 #include "gdbcmd.h"
27 #include "target.h"
28 #include "language.h"
29 #include "annotate.h"
30 #include "valprint.h"
31 #include "floatformat.h"
32 #include "doublest.h"
33 #include "exceptions.h"
34 #include "dfp.h"
35 #include "python/python.h"
36 #include "ada-lang.h"
37 #include "gdb_obstack.h"
38 #include "charset.h"
39 #include <ctype.h>
40
41 #include <errno.h>
42
43 /* Prototypes for local functions */
44
45 static int partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
46                                 int len, int *errnoptr);
47
48 static void show_print (char *, int);
49
50 static void set_print (char *, int);
51
52 static void set_radix (char *, int);
53
54 static void show_radix (char *, int);
55
56 static void set_input_radix (char *, int, struct cmd_list_element *);
57
58 static void set_input_radix_1 (int, unsigned);
59
60 static void set_output_radix (char *, int, struct cmd_list_element *);
61
62 static void set_output_radix_1 (int, unsigned);
63
64 void _initialize_valprint (void);
65
66 #define PRINT_MAX_DEFAULT 200   /* Start print_max off at this value.  */
67
68 struct value_print_options user_print_options =
69 {
70   Val_pretty_default,           /* pretty */
71   0,                            /* prettyprint_arrays */
72   0,                            /* prettyprint_structs */
73   0,                            /* vtblprint */
74   1,                            /* unionprint */
75   1,                            /* addressprint */
76   0,                            /* objectprint */
77   PRINT_MAX_DEFAULT,            /* print_max */
78   10,                           /* repeat_count_threshold */
79   0,                            /* output_format */
80   0,                            /* format */
81   0,                            /* stop_print_at_null */
82   0,                            /* inspect_it */
83   0,                            /* print_array_indexes */
84   0,                            /* deref_ref */
85   1,                            /* static_field_print */
86   1,                            /* pascal_static_field_print */
87   0,                            /* raw */
88   0,                            /* summary */
89   1                             /* symbol_print */
90 };
91
92 /* Initialize *OPTS to be a copy of the user print options.  */
93 void
94 get_user_print_options (struct value_print_options *opts)
95 {
96   *opts = user_print_options;
97 }
98
99 /* Initialize *OPTS to be a copy of the user print options, but with
100    pretty-printing disabled.  */
101 void
102 get_raw_print_options (struct value_print_options *opts)
103 {  
104   *opts = user_print_options;
105   opts->pretty = Val_no_prettyprint;
106 }
107
108 /* Initialize *OPTS to be a copy of the user print options, but using
109    FORMAT as the formatting option.  */
110 void
111 get_formatted_print_options (struct value_print_options *opts,
112                              char format)
113 {
114   *opts = user_print_options;
115   opts->format = format;
116 }
117
118 static void
119 show_print_max (struct ui_file *file, int from_tty,
120                 struct cmd_list_element *c, const char *value)
121 {
122   fprintf_filtered (file,
123                     _("Limit on string chars or array "
124                       "elements to print is %s.\n"),
125                     value);
126 }
127
128
129 /* Default input and output radixes, and output format letter.  */
130
131 unsigned input_radix = 10;
132 static void
133 show_input_radix (struct ui_file *file, int from_tty,
134                   struct cmd_list_element *c, const char *value)
135 {
136   fprintf_filtered (file,
137                     _("Default input radix for entering numbers is %s.\n"),
138                     value);
139 }
140
141 unsigned output_radix = 10;
142 static void
143 show_output_radix (struct ui_file *file, int from_tty,
144                    struct cmd_list_element *c, const char *value)
145 {
146   fprintf_filtered (file,
147                     _("Default output radix for printing of values is %s.\n"),
148                     value);
149 }
150
151 /* By default we print arrays without printing the index of each element in
152    the array.  This behavior can be changed by setting PRINT_ARRAY_INDEXES.  */
153
154 static void
155 show_print_array_indexes (struct ui_file *file, int from_tty,
156                           struct cmd_list_element *c, const char *value)
157 {
158   fprintf_filtered (file, _("Printing of array indexes is %s.\n"), value);
159 }
160
161 /* Print repeat counts if there are more than this many repetitions of an
162    element in an array.  Referenced by the low level language dependent
163    print routines.  */
164
165 static void
166 show_repeat_count_threshold (struct ui_file *file, int from_tty,
167                              struct cmd_list_element *c, const char *value)
168 {
169   fprintf_filtered (file, _("Threshold for repeated print elements is %s.\n"),
170                     value);
171 }
172
173 /* If nonzero, stops printing of char arrays at first null.  */
174
175 static void
176 show_stop_print_at_null (struct ui_file *file, int from_tty,
177                          struct cmd_list_element *c, const char *value)
178 {
179   fprintf_filtered (file,
180                     _("Printing of char arrays to stop "
181                       "at first null char is %s.\n"),
182                     value);
183 }
184
185 /* Controls pretty printing of structures.  */
186
187 static void
188 show_prettyprint_structs (struct ui_file *file, int from_tty,
189                           struct cmd_list_element *c, const char *value)
190 {
191   fprintf_filtered (file, _("Prettyprinting of structures is %s.\n"), value);
192 }
193
194 /* Controls pretty printing of arrays.  */
195
196 static void
197 show_prettyprint_arrays (struct ui_file *file, int from_tty,
198                          struct cmd_list_element *c, const char *value)
199 {
200   fprintf_filtered (file, _("Prettyprinting of arrays is %s.\n"), value);
201 }
202
203 /* If nonzero, causes unions inside structures or other unions to be
204    printed.  */
205
206 static void
207 show_unionprint (struct ui_file *file, int from_tty,
208                  struct cmd_list_element *c, const char *value)
209 {
210   fprintf_filtered (file,
211                     _("Printing of unions interior to structures is %s.\n"),
212                     value);
213 }
214
215 /* If nonzero, causes machine addresses to be printed in certain contexts.  */
216
217 static void
218 show_addressprint (struct ui_file *file, int from_tty,
219                    struct cmd_list_element *c, const char *value)
220 {
221   fprintf_filtered (file, _("Printing of addresses is %s.\n"), value);
222 }
223
224 static void
225 show_symbol_print (struct ui_file *file, int from_tty,
226                    struct cmd_list_element *c, const char *value)
227 {
228   fprintf_filtered (file,
229                     _("Printing of symbols when printing pointers is %s.\n"),
230                     value);
231 }
232
233 \f
234
235 /* A helper function for val_print.  When printing in "summary" mode,
236    we want to print scalar arguments, but not aggregate arguments.
237    This function distinguishes between the two.  */
238
239 static int
240 scalar_type_p (struct type *type)
241 {
242   CHECK_TYPEDEF (type);
243   while (TYPE_CODE (type) == TYPE_CODE_REF)
244     {
245       type = TYPE_TARGET_TYPE (type);
246       CHECK_TYPEDEF (type);
247     }
248   switch (TYPE_CODE (type))
249     {
250     case TYPE_CODE_ARRAY:
251     case TYPE_CODE_STRUCT:
252     case TYPE_CODE_UNION:
253     case TYPE_CODE_SET:
254     case TYPE_CODE_STRING:
255     case TYPE_CODE_BITSTRING:
256       return 0;
257     default:
258       return 1;
259     }
260 }
261
262 /* See its definition in value.h.  */
263
264 int
265 valprint_check_validity (struct ui_file *stream,
266                          struct type *type,
267                          int embedded_offset,
268                          const struct value *val)
269 {
270   CHECK_TYPEDEF (type);
271
272   if (TYPE_CODE (type) != TYPE_CODE_UNION
273       && TYPE_CODE (type) != TYPE_CODE_STRUCT
274       && TYPE_CODE (type) != TYPE_CODE_ARRAY)
275     {
276       if (!value_bits_valid (val, TARGET_CHAR_BIT * embedded_offset,
277                              TARGET_CHAR_BIT * TYPE_LENGTH (type)))
278         {
279           val_print_optimized_out (stream);
280           return 0;
281         }
282
283       if (value_bits_synthetic_pointer (val, TARGET_CHAR_BIT * embedded_offset,
284                                         TARGET_CHAR_BIT * TYPE_LENGTH (type)))
285         {
286           fputs_filtered (_("<synthetic pointer>"), stream);
287           return 0;
288         }
289
290       if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
291         {
292           val_print_unavailable (stream);
293           return 0;
294         }
295     }
296
297   return 1;
298 }
299
300 void
301 val_print_optimized_out (struct ui_file *stream)
302 {
303   fprintf_filtered (stream, _("<optimized out>"));
304 }
305
306 void
307 val_print_unavailable (struct ui_file *stream)
308 {
309   fprintf_filtered (stream, _("<unavailable>"));
310 }
311
312 void
313 val_print_invalid_address (struct ui_file *stream)
314 {
315   fprintf_filtered (stream, _("<invalid address>"));
316 }
317
318 /* A generic val_print that is suitable for use by language
319    implementations of the la_val_print method.  This function can
320    handle most type codes, though not all, notably exception
321    TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
322    the caller.
323    
324    Most arguments are as to val_print.
325    
326    The additional DECORATIONS argument can be used to customize the
327    output in some small, language-specific ways.  */
328
329 void
330 generic_val_print (struct type *type, const gdb_byte *valaddr,
331                    int embedded_offset, CORE_ADDR address,
332                    struct ui_file *stream, int recurse,
333                    const struct value *original_value,
334                    const struct value_print_options *options,
335                    const struct generic_val_print_decorations *decorations)
336 {
337   struct gdbarch *gdbarch = get_type_arch (type);
338   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
339   unsigned int i = 0;   /* Number of characters printed.  */
340   unsigned len;
341   struct type *elttype, *unresolved_elttype;
342   struct type *unresolved_type = type;
343   LONGEST val;
344   CORE_ADDR addr;
345
346   CHECK_TYPEDEF (type);
347   switch (TYPE_CODE (type))
348     {
349     case TYPE_CODE_ARRAY:
350       unresolved_elttype = TYPE_TARGET_TYPE (type);
351       elttype = check_typedef (unresolved_elttype);
352       if (TYPE_LENGTH (type) > 0 && TYPE_LENGTH (unresolved_elttype) > 0)
353         {
354           LONGEST low_bound, high_bound;
355
356           if (!get_array_bounds (type, &low_bound, &high_bound))
357             error (_("Could not determine the array high bound"));
358
359           if (options->prettyprint_arrays)
360             {
361               print_spaces_filtered (2 + 2 * recurse, stream);
362             }
363
364           fprintf_filtered (stream, "{");
365           val_print_array_elements (type, valaddr, embedded_offset,
366                                     address, stream,
367                                     recurse, original_value, options, 0);
368           fprintf_filtered (stream, "}");
369           break;
370         }
371       /* Array of unspecified length: treat like pointer to first
372          elt.  */
373       addr = address + embedded_offset;
374       goto print_unpacked_pointer;
375
376     case TYPE_CODE_MEMBERPTR:
377       val_print_scalar_formatted (type, valaddr, embedded_offset,
378                                   original_value, options, 0, stream);
379       break;
380
381     case TYPE_CODE_PTR:
382       if (options->format && options->format != 's')
383         {
384           val_print_scalar_formatted (type, valaddr, embedded_offset,
385                                       original_value, options, 0, stream);
386           break;
387         }
388       unresolved_elttype = TYPE_TARGET_TYPE (type);
389       elttype = check_typedef (unresolved_elttype);
390         {
391           addr = unpack_pointer (type, valaddr + embedded_offset);
392         print_unpacked_pointer:
393
394           if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
395             {
396               /* Try to print what function it points to.  */
397               print_function_pointer_address (options, gdbarch, addr, stream);
398               return;
399             }
400
401           if (options->symbol_print)
402             print_address_demangle (options, gdbarch, addr, stream, demangle);
403           else if (options->addressprint)
404             fputs_filtered (paddress (gdbarch, addr), stream);
405         }
406       break;
407
408     case TYPE_CODE_REF:
409       elttype = check_typedef (TYPE_TARGET_TYPE (type));
410       if (options->addressprint)
411         {
412           CORE_ADDR addr
413             = extract_typed_address (valaddr + embedded_offset, type);
414
415           fprintf_filtered (stream, "@");
416           fputs_filtered (paddress (gdbarch, addr), stream);
417           if (options->deref_ref)
418             fputs_filtered (": ", stream);
419         }
420       /* De-reference the reference.  */
421       if (options->deref_ref)
422         {
423           if (TYPE_CODE (elttype) != TYPE_CODE_UNDEF)
424             {
425               struct value *deref_val;
426
427               deref_val = coerce_ref_if_computed (original_value);
428               if (deref_val != NULL)
429                 {
430                   /* More complicated computed references are not supported.  */
431                   gdb_assert (embedded_offset == 0);
432                 }
433               else
434                 deref_val = value_at (TYPE_TARGET_TYPE (type),
435                                       unpack_pointer (type,
436                                                       (valaddr
437                                                        + embedded_offset)));
438
439               common_val_print (deref_val, stream, recurse, options,
440                                 current_language);
441             }
442           else
443             fputs_filtered ("???", stream);
444         }
445       break;
446
447     case TYPE_CODE_ENUM:
448       if (options->format)
449         {
450           val_print_scalar_formatted (type, valaddr, embedded_offset,
451                                       original_value, options, 0, stream);
452           break;
453         }
454       len = TYPE_NFIELDS (type);
455       val = unpack_long (type, valaddr + embedded_offset);
456       for (i = 0; i < len; i++)
457         {
458           QUIT;
459           if (val == TYPE_FIELD_ENUMVAL (type, i))
460             {
461               break;
462             }
463         }
464       if (i < len)
465         {
466           fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
467         }
468       else if (TYPE_FLAG_ENUM (type))
469         {
470           int first = 1;
471
472           /* We have a "flag" enum, so we try to decompose it into
473              pieces as appropriate.  A flag enum has disjoint
474              constants by definition.  */
475           fputs_filtered ("(", stream);
476           for (i = 0; i < len; ++i)
477             {
478               QUIT;
479
480               if ((val & TYPE_FIELD_ENUMVAL (type, i)) != 0)
481                 {
482                   if (!first)
483                     fputs_filtered (" | ", stream);
484                   first = 0;
485
486                   val &= ~TYPE_FIELD_ENUMVAL (type, i);
487                   fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
488                 }
489             }
490
491           if (first || val != 0)
492             {
493               if (!first)
494                 fputs_filtered (" | ", stream);
495               fputs_filtered ("unknown: ", stream);
496               print_longest (stream, 'd', 0, val);
497             }
498
499           fputs_filtered (")", stream);
500         }
501       else
502         print_longest (stream, 'd', 0, val);
503       break;
504
505     case TYPE_CODE_FLAGS:
506       if (options->format)
507         val_print_scalar_formatted (type, valaddr, embedded_offset,
508                                     original_value, options, 0, stream);
509       else
510         val_print_type_code_flags (type, valaddr + embedded_offset,
511                                    stream);
512       break;
513
514     case TYPE_CODE_FUNC:
515     case TYPE_CODE_METHOD:
516       if (options->format)
517         {
518           val_print_scalar_formatted (type, valaddr, embedded_offset,
519                                       original_value, options, 0, stream);
520           break;
521         }
522       /* FIXME, we should consider, at least for ANSI C language,
523          eliminating the distinction made between FUNCs and POINTERs
524          to FUNCs.  */
525       fprintf_filtered (stream, "{");
526       type_print (type, "", stream, -1);
527       fprintf_filtered (stream, "} ");
528       /* Try to print what function it points to, and its address.  */
529       print_address_demangle (options, gdbarch, address, stream, demangle);
530       break;
531
532     case TYPE_CODE_BOOL:
533       if (options->format || options->output_format)
534         {
535           struct value_print_options opts = *options;
536           opts.format = (options->format ? options->format
537                          : options->output_format);
538           val_print_scalar_formatted (type, valaddr, embedded_offset,
539                                       original_value, &opts, 0, stream);
540         }
541       else
542         {
543           val = unpack_long (type, valaddr + embedded_offset);
544           if (val == 0)
545             fputs_filtered (decorations->false_name, stream);
546           else if (val == 1)
547             fputs_filtered (decorations->true_name, stream);
548           else
549             print_longest (stream, 'd', 0, val);
550         }
551       break;
552
553     case TYPE_CODE_RANGE:
554       /* FIXME: create_range_type does not set the unsigned bit in a
555          range type (I think it probably should copy it from the
556          target type), so we won't print values which are too large to
557          fit in a signed integer correctly.  */
558       /* FIXME: Doesn't handle ranges of enums correctly.  (Can't just
559          print with the target type, though, because the size of our
560          type and the target type might differ).  */
561
562       /* FALLTHROUGH */
563
564     case TYPE_CODE_INT:
565       if (options->format || options->output_format)
566         {
567           struct value_print_options opts = *options;
568
569           opts.format = (options->format ? options->format
570                          : options->output_format);
571           val_print_scalar_formatted (type, valaddr, embedded_offset,
572                                       original_value, &opts, 0, stream);
573         }
574       else
575         val_print_type_code_int (type, valaddr + embedded_offset, stream);
576       break;
577
578     case TYPE_CODE_CHAR:
579       if (options->format || options->output_format)
580         {
581           struct value_print_options opts = *options;
582
583           opts.format = (options->format ? options->format
584                          : options->output_format);
585           val_print_scalar_formatted (type, valaddr, embedded_offset,
586                                       original_value, &opts, 0, stream);
587         }
588       else
589         {
590           val = unpack_long (type, valaddr + embedded_offset);
591           if (TYPE_UNSIGNED (type))
592             fprintf_filtered (stream, "%u", (unsigned int) val);
593           else
594             fprintf_filtered (stream, "%d", (int) val);
595           fputs_filtered (" ", stream);
596           LA_PRINT_CHAR (val, unresolved_type, stream);
597         }
598       break;
599
600     case TYPE_CODE_FLT:
601       if (options->format)
602         {
603           val_print_scalar_formatted (type, valaddr, embedded_offset,
604                                       original_value, options, 0, stream);
605         }
606       else
607         {
608           print_floating (valaddr + embedded_offset, type, stream);
609         }
610       break;
611
612     case TYPE_CODE_DECFLOAT:
613       if (options->format)
614         val_print_scalar_formatted (type, valaddr, embedded_offset,
615                                     original_value, options, 0, stream);
616       else
617         print_decimal_floating (valaddr + embedded_offset,
618                                 type, stream);
619       break;
620
621     case TYPE_CODE_VOID:
622       fputs_filtered (decorations->void_name, stream);
623       break;
624
625     case TYPE_CODE_ERROR:
626       fprintf_filtered (stream, "%s", TYPE_ERROR_NAME (type));
627       break;
628
629     case TYPE_CODE_UNDEF:
630       /* This happens (without TYPE_FLAG_STUB set) on systems which
631          don't use dbx xrefs (NO_DBX_XREFS in gcc) if a file has a
632          "struct foo *bar" and no complete type for struct foo in that
633          file.  */
634       fprintf_filtered (stream, _("<incomplete type>"));
635       break;
636
637     case TYPE_CODE_COMPLEX:
638       fprintf_filtered (stream, "%s", decorations->complex_prefix);
639       if (options->format)
640         val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
641                                     valaddr, embedded_offset,
642                                     original_value, options, 0, stream);
643       else
644         print_floating (valaddr + embedded_offset,
645                         TYPE_TARGET_TYPE (type),
646                         stream);
647       fprintf_filtered (stream, "%s", decorations->complex_infix);
648       if (options->format)
649         val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
650                                     valaddr,
651                                     embedded_offset
652                                     + TYPE_LENGTH (TYPE_TARGET_TYPE (type)),
653                                     original_value,
654                                     options, 0, stream);
655       else
656         print_floating (valaddr + embedded_offset
657                         + TYPE_LENGTH (TYPE_TARGET_TYPE (type)),
658                         TYPE_TARGET_TYPE (type),
659                         stream);
660       fprintf_filtered (stream, "%s", decorations->complex_suffix);
661       break;
662
663     case TYPE_CODE_UNION:
664     case TYPE_CODE_STRUCT:
665     case TYPE_CODE_METHODPTR:
666     default:
667       error (_("Unhandled type code %d in symbol table."),
668              TYPE_CODE (type));
669     }
670   gdb_flush (stream);
671 }
672
673 /* Print using the given LANGUAGE the data of type TYPE located at
674    VALADDR + EMBEDDED_OFFSET (within GDB), which came from the
675    inferior at address ADDRESS + EMBEDDED_OFFSET, onto stdio stream
676    STREAM according to OPTIONS.  VAL is the whole object that came
677    from ADDRESS.  VALADDR must point to the head of VAL's contents
678    buffer.
679
680    The language printers will pass down an adjusted EMBEDDED_OFFSET to
681    further helper subroutines as subfields of TYPE are printed.  In
682    such cases, VALADDR is passed down unadjusted, as well as VAL, so
683    that VAL can be queried for metadata about the contents data being
684    printed, using EMBEDDED_OFFSET as an offset into VAL's contents
685    buffer.  For example: "has this field been optimized out", or "I'm
686    printing an object while inspecting a traceframe; has this
687    particular piece of data been collected?".
688
689    RECURSE indicates the amount of indentation to supply before
690    continuation lines; this amount is roughly twice the value of
691    RECURSE.  */
692
693 void
694 val_print (struct type *type, const gdb_byte *valaddr, int embedded_offset,
695            CORE_ADDR address, struct ui_file *stream, int recurse,
696            const struct value *val,
697            const struct value_print_options *options,
698            const struct language_defn *language)
699 {
700   volatile struct gdb_exception except;
701   int ret = 0;
702   struct value_print_options local_opts = *options;
703   struct type *real_type = check_typedef (type);
704
705   if (local_opts.pretty == Val_pretty_default)
706     local_opts.pretty = (local_opts.prettyprint_structs
707                          ? Val_prettyprint : Val_no_prettyprint);
708
709   QUIT;
710
711   /* Ensure that the type is complete and not just a stub.  If the type is
712      only a stub and we can't find and substitute its complete type, then
713      print appropriate string and return.  */
714
715   if (TYPE_STUB (real_type))
716     {
717       fprintf_filtered (stream, _("<incomplete type>"));
718       gdb_flush (stream);
719       return;
720     }
721
722   if (!valprint_check_validity (stream, real_type, embedded_offset, val))
723     return;
724
725   if (!options->raw)
726     {
727       ret = apply_val_pretty_printer (type, valaddr, embedded_offset,
728                                       address, stream, recurse,
729                                       val, options, language);
730       if (ret)
731         return;
732     }
733
734   /* Handle summary mode.  If the value is a scalar, print it;
735      otherwise, print an ellipsis.  */
736   if (options->summary && !scalar_type_p (type))
737     {
738       fprintf_filtered (stream, "...");
739       return;
740     }
741
742   TRY_CATCH (except, RETURN_MASK_ERROR)
743     {
744       language->la_val_print (type, valaddr, embedded_offset, address,
745                               stream, recurse, val,
746                               &local_opts);
747     }
748   if (except.reason < 0)
749     fprintf_filtered (stream, _("<error reading variable>"));
750 }
751
752 /* Check whether the value VAL is printable.  Return 1 if it is;
753    return 0 and print an appropriate error message to STREAM according to
754    OPTIONS if it is not.  */
755
756 static int
757 value_check_printable (struct value *val, struct ui_file *stream,
758                        const struct value_print_options *options)
759 {
760   if (val == 0)
761     {
762       fprintf_filtered (stream, _("<address of value unknown>"));
763       return 0;
764     }
765
766   if (value_entirely_optimized_out (val))
767     {
768       if (options->summary && !scalar_type_p (value_type (val)))
769         fprintf_filtered (stream, "...");
770       else
771         val_print_optimized_out (stream);
772       return 0;
773     }
774
775   if (TYPE_CODE (value_type (val)) == TYPE_CODE_INTERNAL_FUNCTION)
776     {
777       fprintf_filtered (stream, _("<internal function %s>"),
778                         value_internal_function_name (val));
779       return 0;
780     }
781
782   return 1;
783 }
784
785 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
786    to OPTIONS.
787
788    This is a preferable interface to val_print, above, because it uses
789    GDB's value mechanism.  */
790
791 void
792 common_val_print (struct value *val, struct ui_file *stream, int recurse,
793                   const struct value_print_options *options,
794                   const struct language_defn *language)
795 {
796   if (!value_check_printable (val, stream, options))
797     return;
798
799   if (language->la_language == language_ada)
800     /* The value might have a dynamic type, which would cause trouble
801        below when trying to extract the value contents (since the value
802        size is determined from the type size which is unknown).  So
803        get a fixed representation of our value.  */
804     val = ada_to_fixed_value (val);
805
806   val_print (value_type (val), value_contents_for_printing (val),
807              value_embedded_offset (val), value_address (val),
808              stream, recurse,
809              val, options, language);
810 }
811
812 /* Print on stream STREAM the value VAL according to OPTIONS.  The value
813    is printed using the current_language syntax.  */
814
815 void
816 value_print (struct value *val, struct ui_file *stream,
817              const struct value_print_options *options)
818 {
819   if (!value_check_printable (val, stream, options))
820     return;
821
822   if (!options->raw)
823     {
824       int r = apply_val_pretty_printer (value_type (val),
825                                         value_contents_for_printing (val),
826                                         value_embedded_offset (val),
827                                         value_address (val),
828                                         stream, 0,
829                                         val, options, current_language);
830
831       if (r)
832         return;
833     }
834
835   LA_VALUE_PRINT (val, stream, options);
836 }
837
838 /* Called by various <lang>_val_print routines to print
839    TYPE_CODE_INT's.  TYPE is the type.  VALADDR is the address of the
840    value.  STREAM is where to print the value.  */
841
842 void
843 val_print_type_code_int (struct type *type, const gdb_byte *valaddr,
844                          struct ui_file *stream)
845 {
846   enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
847
848   if (TYPE_LENGTH (type) > sizeof (LONGEST))
849     {
850       LONGEST val;
851
852       if (TYPE_UNSIGNED (type)
853           && extract_long_unsigned_integer (valaddr, TYPE_LENGTH (type),
854                                             byte_order, &val))
855         {
856           print_longest (stream, 'u', 0, val);
857         }
858       else
859         {
860           /* Signed, or we couldn't turn an unsigned value into a
861              LONGEST.  For signed values, one could assume two's
862              complement (a reasonable assumption, I think) and do
863              better than this.  */
864           print_hex_chars (stream, (unsigned char *) valaddr,
865                            TYPE_LENGTH (type), byte_order);
866         }
867     }
868   else
869     {
870       print_longest (stream, TYPE_UNSIGNED (type) ? 'u' : 'd', 0,
871                      unpack_long (type, valaddr));
872     }
873 }
874
875 void
876 val_print_type_code_flags (struct type *type, const gdb_byte *valaddr,
877                            struct ui_file *stream)
878 {
879   ULONGEST val = unpack_long (type, valaddr);
880   int bitpos, nfields = TYPE_NFIELDS (type);
881
882   fputs_filtered ("[ ", stream);
883   for (bitpos = 0; bitpos < nfields; bitpos++)
884     {
885       if (TYPE_FIELD_BITPOS (type, bitpos) != -1
886           && (val & ((ULONGEST)1 << bitpos)))
887         {
888           if (TYPE_FIELD_NAME (type, bitpos))
889             fprintf_filtered (stream, "%s ", TYPE_FIELD_NAME (type, bitpos));
890           else
891             fprintf_filtered (stream, "#%d ", bitpos);
892         }
893     }
894   fputs_filtered ("]", stream);
895 }
896
897 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
898    according to OPTIONS and SIZE on STREAM.  Format i is not supported
899    at this level.
900
901    This is how the elements of an array or structure are printed
902    with a format.  */
903
904 void
905 val_print_scalar_formatted (struct type *type,
906                             const gdb_byte *valaddr, int embedded_offset,
907                             const struct value *val,
908                             const struct value_print_options *options,
909                             int size,
910                             struct ui_file *stream)
911 {
912   gdb_assert (val != NULL);
913   gdb_assert (valaddr == value_contents_for_printing_const (val));
914
915   /* If we get here with a string format, try again without it.  Go
916      all the way back to the language printers, which may call us
917      again.  */
918   if (options->format == 's')
919     {
920       struct value_print_options opts = *options;
921       opts.format = 0;
922       opts.deref_ref = 0;
923       val_print (type, valaddr, embedded_offset, 0, stream, 0, val, &opts,
924                  current_language);
925       return;
926     }
927
928   /* A scalar object that does not have all bits available can't be
929      printed, because all bits contribute to its representation.  */
930   if (!value_bits_valid (val, TARGET_CHAR_BIT * embedded_offset,
931                               TARGET_CHAR_BIT * TYPE_LENGTH (type)))
932     val_print_optimized_out (stream);
933   else if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
934     val_print_unavailable (stream);
935   else
936     print_scalar_formatted (valaddr + embedded_offset, type,
937                             options, size, stream);
938 }
939
940 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
941    The raison d'etre of this function is to consolidate printing of 
942    LONG_LONG's into this one function.  The format chars b,h,w,g are 
943    from print_scalar_formatted().  Numbers are printed using C
944    format.
945
946    USE_C_FORMAT means to use C format in all cases.  Without it, 
947    'o' and 'x' format do not include the standard C radix prefix
948    (leading 0 or 0x). 
949    
950    Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
951    and was intended to request formating according to the current
952    language and would be used for most integers that GDB prints.  The
953    exceptional cases were things like protocols where the format of
954    the integer is a protocol thing, not a user-visible thing).  The
955    parameter remains to preserve the information of what things might
956    be printed with language-specific format, should we ever resurrect
957    that capability.  */
958
959 void
960 print_longest (struct ui_file *stream, int format, int use_c_format,
961                LONGEST val_long)
962 {
963   const char *val;
964
965   switch (format)
966     {
967     case 'd':
968       val = int_string (val_long, 10, 1, 0, 1); break;
969     case 'u':
970       val = int_string (val_long, 10, 0, 0, 1); break;
971     case 'x':
972       val = int_string (val_long, 16, 0, 0, use_c_format); break;
973     case 'b':
974       val = int_string (val_long, 16, 0, 2, 1); break;
975     case 'h':
976       val = int_string (val_long, 16, 0, 4, 1); break;
977     case 'w':
978       val = int_string (val_long, 16, 0, 8, 1); break;
979     case 'g':
980       val = int_string (val_long, 16, 0, 16, 1); break;
981       break;
982     case 'o':
983       val = int_string (val_long, 8, 0, 0, use_c_format); break;
984     default:
985       internal_error (__FILE__, __LINE__,
986                       _("failed internal consistency check"));
987     } 
988   fputs_filtered (val, stream);
989 }
990
991 /* This used to be a macro, but I don't think it is called often enough
992    to merit such treatment.  */
993 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
994    arguments to a function, number in a value history, register number, etc.)
995    where the value must not be larger than can fit in an int.  */
996
997 int
998 longest_to_int (LONGEST arg)
999 {
1000   /* Let the compiler do the work.  */
1001   int rtnval = (int) arg;
1002
1003   /* Check for overflows or underflows.  */
1004   if (sizeof (LONGEST) > sizeof (int))
1005     {
1006       if (rtnval != arg)
1007         {
1008           error (_("Value out of range."));
1009         }
1010     }
1011   return (rtnval);
1012 }
1013
1014 /* Print a floating point value of type TYPE (not always a
1015    TYPE_CODE_FLT), pointed to in GDB by VALADDR, on STREAM.  */
1016
1017 void
1018 print_floating (const gdb_byte *valaddr, struct type *type,
1019                 struct ui_file *stream)
1020 {
1021   DOUBLEST doub;
1022   int inv;
1023   const struct floatformat *fmt = NULL;
1024   unsigned len = TYPE_LENGTH (type);
1025   enum float_kind kind;
1026
1027   /* If it is a floating-point, check for obvious problems.  */
1028   if (TYPE_CODE (type) == TYPE_CODE_FLT)
1029     fmt = floatformat_from_type (type);
1030   if (fmt != NULL)
1031     {
1032       kind = floatformat_classify (fmt, valaddr);
1033       if (kind == float_nan)
1034         {
1035           if (floatformat_is_negative (fmt, valaddr))
1036             fprintf_filtered (stream, "-");
1037           fprintf_filtered (stream, "nan(");
1038           fputs_filtered ("0x", stream);
1039           fputs_filtered (floatformat_mantissa (fmt, valaddr), stream);
1040           fprintf_filtered (stream, ")");
1041           return;
1042         }
1043       else if (kind == float_infinite)
1044         {
1045           if (floatformat_is_negative (fmt, valaddr))
1046             fputs_filtered ("-", stream);
1047           fputs_filtered ("inf", stream);
1048           return;
1049         }
1050     }
1051
1052   /* NOTE: cagney/2002-01-15: The TYPE passed into print_floating()
1053      isn't necessarily a TYPE_CODE_FLT.  Consequently, unpack_double
1054      needs to be used as that takes care of any necessary type
1055      conversions.  Such conversions are of course direct to DOUBLEST
1056      and disregard any possible target floating point limitations.
1057      For instance, a u64 would be converted and displayed exactly on a
1058      host with 80 bit DOUBLEST but with loss of information on a host
1059      with 64 bit DOUBLEST.  */
1060
1061   doub = unpack_double (type, valaddr, &inv);
1062   if (inv)
1063     {
1064       fprintf_filtered (stream, "<invalid float value>");
1065       return;
1066     }
1067
1068   /* FIXME: kettenis/2001-01-20: The following code makes too much
1069      assumptions about the host and target floating point format.  */
1070
1071   /* NOTE: cagney/2002-02-03: Since the TYPE of what was passed in may
1072      not necessarily be a TYPE_CODE_FLT, the below ignores that and
1073      instead uses the type's length to determine the precision of the
1074      floating-point value being printed.  */
1075
1076   if (len < sizeof (double))
1077       fprintf_filtered (stream, "%.9g", (double) doub);
1078   else if (len == sizeof (double))
1079       fprintf_filtered (stream, "%.17g", (double) doub);
1080   else
1081 #ifdef PRINTF_HAS_LONG_DOUBLE
1082     fprintf_filtered (stream, "%.35Lg", doub);
1083 #else
1084     /* This at least wins with values that are representable as
1085        doubles.  */
1086     fprintf_filtered (stream, "%.17g", (double) doub);
1087 #endif
1088 }
1089
1090 void
1091 print_decimal_floating (const gdb_byte *valaddr, struct type *type,
1092                         struct ui_file *stream)
1093 {
1094   enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
1095   char decstr[MAX_DECIMAL_STRING];
1096   unsigned len = TYPE_LENGTH (type);
1097
1098   decimal_to_string (valaddr, len, byte_order, decstr);
1099   fputs_filtered (decstr, stream);
1100   return;
1101 }
1102
1103 void
1104 print_binary_chars (struct ui_file *stream, const gdb_byte *valaddr,
1105                     unsigned len, enum bfd_endian byte_order)
1106 {
1107
1108 #define BITS_IN_BYTES 8
1109
1110   const gdb_byte *p;
1111   unsigned int i;
1112   int b;
1113
1114   /* Declared "int" so it will be signed.
1115      This ensures that right shift will shift in zeros.  */
1116
1117   const int mask = 0x080;
1118
1119   /* FIXME: We should be not printing leading zeroes in most cases.  */
1120
1121   if (byte_order == BFD_ENDIAN_BIG)
1122     {
1123       for (p = valaddr;
1124            p < valaddr + len;
1125            p++)
1126         {
1127           /* Every byte has 8 binary characters; peel off
1128              and print from the MSB end.  */
1129
1130           for (i = 0; i < (BITS_IN_BYTES * sizeof (*p)); i++)
1131             {
1132               if (*p & (mask >> i))
1133                 b = 1;
1134               else
1135                 b = 0;
1136
1137               fprintf_filtered (stream, "%1d", b);
1138             }
1139         }
1140     }
1141   else
1142     {
1143       for (p = valaddr + len - 1;
1144            p >= valaddr;
1145            p--)
1146         {
1147           for (i = 0; i < (BITS_IN_BYTES * sizeof (*p)); i++)
1148             {
1149               if (*p & (mask >> i))
1150                 b = 1;
1151               else
1152                 b = 0;
1153
1154               fprintf_filtered (stream, "%1d", b);
1155             }
1156         }
1157     }
1158 }
1159
1160 /* VALADDR points to an integer of LEN bytes.
1161    Print it in octal on stream or format it in buf.  */
1162
1163 void
1164 print_octal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1165                    unsigned len, enum bfd_endian byte_order)
1166 {
1167   const gdb_byte *p;
1168   unsigned char octa1, octa2, octa3, carry;
1169   int cycle;
1170
1171   /* FIXME: We should be not printing leading zeroes in most cases.  */
1172
1173
1174   /* Octal is 3 bits, which doesn't fit.  Yuk.  So we have to track
1175    * the extra bits, which cycle every three bytes:
1176    *
1177    * Byte side:       0            1             2          3
1178    *                         |             |            |            |
1179    * bit number   123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1180    *
1181    * Octal side:   0   1   carry  3   4  carry ...
1182    *
1183    * Cycle number:    0             1            2
1184    *
1185    * But of course we are printing from the high side, so we have to
1186    * figure out where in the cycle we are so that we end up with no
1187    * left over bits at the end.
1188    */
1189 #define BITS_IN_OCTAL 3
1190 #define HIGH_ZERO     0340
1191 #define LOW_ZERO      0016
1192 #define CARRY_ZERO    0003
1193 #define HIGH_ONE      0200
1194 #define MID_ONE       0160
1195 #define LOW_ONE       0016
1196 #define CARRY_ONE     0001
1197 #define HIGH_TWO      0300
1198 #define MID_TWO       0070
1199 #define LOW_TWO       0007
1200
1201   /* For 32 we start in cycle 2, with two bits and one bit carry;
1202      for 64 in cycle in cycle 1, with one bit and a two bit carry.  */
1203
1204   cycle = (len * BITS_IN_BYTES) % BITS_IN_OCTAL;
1205   carry = 0;
1206
1207   fputs_filtered ("0", stream);
1208   if (byte_order == BFD_ENDIAN_BIG)
1209     {
1210       for (p = valaddr;
1211            p < valaddr + len;
1212            p++)
1213         {
1214           switch (cycle)
1215             {
1216             case 0:
1217               /* No carry in, carry out two bits.  */
1218
1219               octa1 = (HIGH_ZERO & *p) >> 5;
1220               octa2 = (LOW_ZERO & *p) >> 2;
1221               carry = (CARRY_ZERO & *p);
1222               fprintf_filtered (stream, "%o", octa1);
1223               fprintf_filtered (stream, "%o", octa2);
1224               break;
1225
1226             case 1:
1227               /* Carry in two bits, carry out one bit.  */
1228
1229               octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1230               octa2 = (MID_ONE & *p) >> 4;
1231               octa3 = (LOW_ONE & *p) >> 1;
1232               carry = (CARRY_ONE & *p);
1233               fprintf_filtered (stream, "%o", octa1);
1234               fprintf_filtered (stream, "%o", octa2);
1235               fprintf_filtered (stream, "%o", octa3);
1236               break;
1237
1238             case 2:
1239               /* Carry in one bit, no carry out.  */
1240
1241               octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1242               octa2 = (MID_TWO & *p) >> 3;
1243               octa3 = (LOW_TWO & *p);
1244               carry = 0;
1245               fprintf_filtered (stream, "%o", octa1);
1246               fprintf_filtered (stream, "%o", octa2);
1247               fprintf_filtered (stream, "%o", octa3);
1248               break;
1249
1250             default:
1251               error (_("Internal error in octal conversion;"));
1252             }
1253
1254           cycle++;
1255           cycle = cycle % BITS_IN_OCTAL;
1256         }
1257     }
1258   else
1259     {
1260       for (p = valaddr + len - 1;
1261            p >= valaddr;
1262            p--)
1263         {
1264           switch (cycle)
1265             {
1266             case 0:
1267               /* Carry out, no carry in */
1268
1269               octa1 = (HIGH_ZERO & *p) >> 5;
1270               octa2 = (LOW_ZERO & *p) >> 2;
1271               carry = (CARRY_ZERO & *p);
1272               fprintf_filtered (stream, "%o", octa1);
1273               fprintf_filtered (stream, "%o", octa2);
1274               break;
1275
1276             case 1:
1277               /* Carry in, carry out */
1278
1279               octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1280               octa2 = (MID_ONE & *p) >> 4;
1281               octa3 = (LOW_ONE & *p) >> 1;
1282               carry = (CARRY_ONE & *p);
1283               fprintf_filtered (stream, "%o", octa1);
1284               fprintf_filtered (stream, "%o", octa2);
1285               fprintf_filtered (stream, "%o", octa3);
1286               break;
1287
1288             case 2:
1289               /* Carry in, no carry out */
1290
1291               octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1292               octa2 = (MID_TWO & *p) >> 3;
1293               octa3 = (LOW_TWO & *p);
1294               carry = 0;
1295               fprintf_filtered (stream, "%o", octa1);
1296               fprintf_filtered (stream, "%o", octa2);
1297               fprintf_filtered (stream, "%o", octa3);
1298               break;
1299
1300             default:
1301               error (_("Internal error in octal conversion;"));
1302             }
1303
1304           cycle++;
1305           cycle = cycle % BITS_IN_OCTAL;
1306         }
1307     }
1308
1309 }
1310
1311 /* VALADDR points to an integer of LEN bytes.
1312    Print it in decimal on stream or format it in buf.  */
1313
1314 void
1315 print_decimal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1316                      unsigned len, enum bfd_endian byte_order)
1317 {
1318 #define TEN             10
1319 #define CARRY_OUT(  x ) ((x) / TEN)     /* extend char to int */
1320 #define CARRY_LEFT( x ) ((x) % TEN)
1321 #define SHIFT( x )      ((x) << 4)
1322 #define LOW_NIBBLE(  x ) ( (x) & 0x00F)
1323 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1324
1325   const gdb_byte *p;
1326   unsigned char *digits;
1327   int carry;
1328   int decimal_len;
1329   int i, j, decimal_digits;
1330   int dummy;
1331   int flip;
1332
1333   /* Base-ten number is less than twice as many digits
1334      as the base 16 number, which is 2 digits per byte.  */
1335
1336   decimal_len = len * 2 * 2;
1337   digits = xmalloc (decimal_len);
1338
1339   for (i = 0; i < decimal_len; i++)
1340     {
1341       digits[i] = 0;
1342     }
1343
1344   /* Ok, we have an unknown number of bytes of data to be printed in
1345    * decimal.
1346    *
1347    * Given a hex number (in nibbles) as XYZ, we start by taking X and
1348    * decemalizing it as "x1 x2" in two decimal nibbles.  Then we multiply
1349    * the nibbles by 16, add Y and re-decimalize.  Repeat with Z.
1350    *
1351    * The trick is that "digits" holds a base-10 number, but sometimes
1352    * the individual digits are > 10.
1353    *
1354    * Outer loop is per nibble (hex digit) of input, from MSD end to
1355    * LSD end.
1356    */
1357   decimal_digits = 0;           /* Number of decimal digits so far */
1358   p = (byte_order == BFD_ENDIAN_BIG) ? valaddr : valaddr + len - 1;
1359   flip = 0;
1360   while ((byte_order == BFD_ENDIAN_BIG) ? (p < valaddr + len) : (p >= valaddr))
1361     {
1362       /*
1363        * Multiply current base-ten number by 16 in place.
1364        * Each digit was between 0 and 9, now is between
1365        * 0 and 144.
1366        */
1367       for (j = 0; j < decimal_digits; j++)
1368         {
1369           digits[j] = SHIFT (digits[j]);
1370         }
1371
1372       /* Take the next nibble off the input and add it to what
1373        * we've got in the LSB position.  Bottom 'digit' is now
1374        * between 0 and 159.
1375        *
1376        * "flip" is used to run this loop twice for each byte.
1377        */
1378       if (flip == 0)
1379         {
1380           /* Take top nibble.  */
1381
1382           digits[0] += HIGH_NIBBLE (*p);
1383           flip = 1;
1384         }
1385       else
1386         {
1387           /* Take low nibble and bump our pointer "p".  */
1388
1389           digits[0] += LOW_NIBBLE (*p);
1390           if (byte_order == BFD_ENDIAN_BIG)
1391             p++;
1392           else
1393             p--;
1394           flip = 0;
1395         }
1396
1397       /* Re-decimalize.  We have to do this often enough
1398        * that we don't overflow, but once per nibble is
1399        * overkill.  Easier this way, though.  Note that the
1400        * carry is often larger than 10 (e.g. max initial
1401        * carry out of lowest nibble is 15, could bubble all
1402        * the way up greater than 10).  So we have to do
1403        * the carrying beyond the last current digit.
1404        */
1405       carry = 0;
1406       for (j = 0; j < decimal_len - 1; j++)
1407         {
1408           digits[j] += carry;
1409
1410           /* "/" won't handle an unsigned char with
1411            * a value that if signed would be negative.
1412            * So extend to longword int via "dummy".
1413            */
1414           dummy = digits[j];
1415           carry = CARRY_OUT (dummy);
1416           digits[j] = CARRY_LEFT (dummy);
1417
1418           if (j >= decimal_digits && carry == 0)
1419             {
1420               /*
1421                * All higher digits are 0 and we
1422                * no longer have a carry.
1423                *
1424                * Note: "j" is 0-based, "decimal_digits" is
1425                *       1-based.
1426                */
1427               decimal_digits = j + 1;
1428               break;
1429             }
1430         }
1431     }
1432
1433   /* Ok, now "digits" is the decimal representation, with
1434      the "decimal_digits" actual digits.  Print!  */
1435
1436   for (i = decimal_digits - 1; i >= 0; i--)
1437     {
1438       fprintf_filtered (stream, "%1d", digits[i]);
1439     }
1440   xfree (digits);
1441 }
1442
1443 /* VALADDR points to an integer of LEN bytes.  Print it in hex on stream.  */
1444
1445 void
1446 print_hex_chars (struct ui_file *stream, const gdb_byte *valaddr,
1447                  unsigned len, enum bfd_endian byte_order)
1448 {
1449   const gdb_byte *p;
1450
1451   /* FIXME: We should be not printing leading zeroes in most cases.  */
1452
1453   fputs_filtered ("0x", stream);
1454   if (byte_order == BFD_ENDIAN_BIG)
1455     {
1456       for (p = valaddr;
1457            p < valaddr + len;
1458            p++)
1459         {
1460           fprintf_filtered (stream, "%02x", *p);
1461         }
1462     }
1463   else
1464     {
1465       for (p = valaddr + len - 1;
1466            p >= valaddr;
1467            p--)
1468         {
1469           fprintf_filtered (stream, "%02x", *p);
1470         }
1471     }
1472 }
1473
1474 /* VALADDR points to a char integer of LEN bytes.
1475    Print it out in appropriate language form on stream.
1476    Omit any leading zero chars.  */
1477
1478 void
1479 print_char_chars (struct ui_file *stream, struct type *type,
1480                   const gdb_byte *valaddr,
1481                   unsigned len, enum bfd_endian byte_order)
1482 {
1483   const gdb_byte *p;
1484
1485   if (byte_order == BFD_ENDIAN_BIG)
1486     {
1487       p = valaddr;
1488       while (p < valaddr + len - 1 && *p == 0)
1489         ++p;
1490
1491       while (p < valaddr + len)
1492         {
1493           LA_EMIT_CHAR (*p, type, stream, '\'');
1494           ++p;
1495         }
1496     }
1497   else
1498     {
1499       p = valaddr + len - 1;
1500       while (p > valaddr && *p == 0)
1501         --p;
1502
1503       while (p >= valaddr)
1504         {
1505           LA_EMIT_CHAR (*p, type, stream, '\'');
1506           --p;
1507         }
1508     }
1509 }
1510
1511 /* Print function pointer with inferior address ADDRESS onto stdio
1512    stream STREAM.  */
1513
1514 void
1515 print_function_pointer_address (const struct value_print_options *options,
1516                                 struct gdbarch *gdbarch,
1517                                 CORE_ADDR address,
1518                                 struct ui_file *stream)
1519 {
1520   CORE_ADDR func_addr
1521     = gdbarch_convert_from_func_ptr_addr (gdbarch, address,
1522                                           &current_target);
1523
1524   /* If the function pointer is represented by a description, print
1525      the address of the description.  */
1526   if (options->addressprint && func_addr != address)
1527     {
1528       fputs_filtered ("@", stream);
1529       fputs_filtered (paddress (gdbarch, address), stream);
1530       fputs_filtered (": ", stream);
1531     }
1532   print_address_demangle (options, gdbarch, func_addr, stream, demangle);
1533 }
1534
1535
1536 /* Print on STREAM using the given OPTIONS the index for the element
1537    at INDEX of an array whose index type is INDEX_TYPE.  */
1538     
1539 void  
1540 maybe_print_array_index (struct type *index_type, LONGEST index,
1541                          struct ui_file *stream,
1542                          const struct value_print_options *options)
1543 {
1544   struct value *index_value;
1545
1546   if (!options->print_array_indexes)
1547     return; 
1548     
1549   index_value = value_from_longest (index_type, index);
1550
1551   LA_PRINT_ARRAY_INDEX (index_value, stream, options);
1552 }
1553
1554 /*  Called by various <lang>_val_print routines to print elements of an
1555    array in the form "<elem1>, <elem2>, <elem3>, ...".
1556
1557    (FIXME?)  Assumes array element separator is a comma, which is correct
1558    for all languages currently handled.
1559    (FIXME?)  Some languages have a notation for repeated array elements,
1560    perhaps we should try to use that notation when appropriate.  */
1561
1562 void
1563 val_print_array_elements (struct type *type,
1564                           const gdb_byte *valaddr, int embedded_offset,
1565                           CORE_ADDR address, struct ui_file *stream,
1566                           int recurse,
1567                           const struct value *val,
1568                           const struct value_print_options *options,
1569                           unsigned int i)
1570 {
1571   unsigned int things_printed = 0;
1572   unsigned len;
1573   struct type *elttype, *index_type;
1574   unsigned eltlen;
1575   /* Position of the array element we are examining to see
1576      whether it is repeated.  */
1577   unsigned int rep1;
1578   /* Number of repetitions we have detected so far.  */
1579   unsigned int reps;
1580   LONGEST low_bound, high_bound;
1581
1582   elttype = TYPE_TARGET_TYPE (type);
1583   eltlen = TYPE_LENGTH (check_typedef (elttype));
1584   index_type = TYPE_INDEX_TYPE (type);
1585
1586   if (get_array_bounds (type, &low_bound, &high_bound))
1587     {
1588       /* The array length should normally be HIGH_BOUND - LOW_BOUND + 1.
1589          But we have to be a little extra careful, because some languages
1590          such as Ada allow LOW_BOUND to be greater than HIGH_BOUND for
1591          empty arrays.  In that situation, the array length is just zero,
1592          not negative!  */
1593       if (low_bound > high_bound)
1594         len = 0;
1595       else
1596         len = high_bound - low_bound + 1;
1597     }
1598   else
1599     {
1600       warning (_("unable to get bounds of array, assuming null array"));
1601       low_bound = 0;
1602       len = 0;
1603     }
1604
1605   annotate_array_section_begin (i, elttype);
1606
1607   for (; i < len && things_printed < options->print_max; i++)
1608     {
1609       if (i != 0)
1610         {
1611           if (options->prettyprint_arrays)
1612             {
1613               fprintf_filtered (stream, ",\n");
1614               print_spaces_filtered (2 + 2 * recurse, stream);
1615             }
1616           else
1617             {
1618               fprintf_filtered (stream, ", ");
1619             }
1620         }
1621       wrap_here (n_spaces (2 + 2 * recurse));
1622       maybe_print_array_index (index_type, i + low_bound,
1623                                stream, options);
1624
1625       rep1 = i + 1;
1626       reps = 1;
1627       /* Only check for reps if repeat_count_threshold is not set to
1628          UINT_MAX (unlimited).  */
1629       if (options->repeat_count_threshold < UINT_MAX)
1630         {
1631           while (rep1 < len
1632                  && value_available_contents_eq (val,
1633                                                  embedded_offset + i * eltlen,
1634                                                  val,
1635                                                  (embedded_offset
1636                                                   + rep1 * eltlen),
1637                                                  eltlen))
1638             {
1639               ++reps;
1640               ++rep1;
1641             }
1642         }
1643
1644       if (reps > options->repeat_count_threshold)
1645         {
1646           val_print (elttype, valaddr, embedded_offset + i * eltlen,
1647                      address, stream, recurse + 1, val, options,
1648                      current_language);
1649           annotate_elt_rep (reps);
1650           fprintf_filtered (stream, " <repeats %u times>", reps);
1651           annotate_elt_rep_end ();
1652
1653           i = rep1 - 1;
1654           things_printed += options->repeat_count_threshold;
1655         }
1656       else
1657         {
1658           val_print (elttype, valaddr, embedded_offset + i * eltlen,
1659                      address,
1660                      stream, recurse + 1, val, options, current_language);
1661           annotate_elt ();
1662           things_printed++;
1663         }
1664     }
1665   annotate_array_section_end ();
1666   if (i < len)
1667     {
1668       fprintf_filtered (stream, "...");
1669     }
1670 }
1671
1672 /* Read LEN bytes of target memory at address MEMADDR, placing the
1673    results in GDB's memory at MYADDR.  Returns a count of the bytes
1674    actually read, and optionally an errno value in the location
1675    pointed to by ERRNOPTR if ERRNOPTR is non-null.  */
1676
1677 /* FIXME: cagney/1999-10-14: Only used by val_print_string.  Can this
1678    function be eliminated.  */
1679
1680 static int
1681 partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
1682                      int len, int *errnoptr)
1683 {
1684   int nread;                    /* Number of bytes actually read.  */
1685   int errcode;                  /* Error from last read.  */
1686
1687   /* First try a complete read.  */
1688   errcode = target_read_memory (memaddr, myaddr, len);
1689   if (errcode == 0)
1690     {
1691       /* Got it all.  */
1692       nread = len;
1693     }
1694   else
1695     {
1696       /* Loop, reading one byte at a time until we get as much as we can.  */
1697       for (errcode = 0, nread = 0; len > 0 && errcode == 0; nread++, len--)
1698         {
1699           errcode = target_read_memory (memaddr++, myaddr++, 1);
1700         }
1701       /* If an error, the last read was unsuccessful, so adjust count.  */
1702       if (errcode != 0)
1703         {
1704           nread--;
1705         }
1706     }
1707   if (errnoptr != NULL)
1708     {
1709       *errnoptr = errcode;
1710     }
1711   return (nread);
1712 }
1713
1714 /* Read a string from the inferior, at ADDR, with LEN characters of WIDTH bytes
1715    each.  Fetch at most FETCHLIMIT characters.  BUFFER will be set to a newly
1716    allocated buffer containing the string, which the caller is responsible to
1717    free, and BYTES_READ will be set to the number of bytes read.  Returns 0 on
1718    success, or errno on failure.
1719
1720    If LEN > 0, reads exactly LEN characters (including eventual NULs in
1721    the middle or end of the string).  If LEN is -1, stops at the first
1722    null character (not necessarily the first null byte) up to a maximum
1723    of FETCHLIMIT characters.  Set FETCHLIMIT to UINT_MAX to read as many
1724    characters as possible from the string.
1725
1726    Unless an exception is thrown, BUFFER will always be allocated, even on
1727    failure.  In this case, some characters might have been read before the
1728    failure happened.  Check BYTES_READ to recognize this situation.
1729
1730    Note: There was a FIXME asking to make this code use target_read_string,
1731    but this function is more general (can read past null characters, up to
1732    given LEN).  Besides, it is used much more often than target_read_string
1733    so it is more tested.  Perhaps callers of target_read_string should use
1734    this function instead?  */
1735
1736 int
1737 read_string (CORE_ADDR addr, int len, int width, unsigned int fetchlimit,
1738              enum bfd_endian byte_order, gdb_byte **buffer, int *bytes_read)
1739 {
1740   int found_nul;                /* Non-zero if we found the nul char.  */
1741   int errcode;                  /* Errno returned from bad reads.  */
1742   unsigned int nfetch;          /* Chars to fetch / chars fetched.  */
1743   unsigned int chunksize;       /* Size of each fetch, in chars.  */
1744   gdb_byte *bufptr;             /* Pointer to next available byte in
1745                                    buffer.  */
1746   gdb_byte *limit;              /* First location past end of fetch buffer.  */
1747   struct cleanup *old_chain = NULL;     /* Top of the old cleanup chain.  */
1748
1749   /* Decide how large of chunks to try to read in one operation.  This
1750      is also pretty simple.  If LEN >= zero, then we want fetchlimit chars,
1751      so we might as well read them all in one operation.  If LEN is -1, we
1752      are looking for a NUL terminator to end the fetching, so we might as
1753      well read in blocks that are large enough to be efficient, but not so
1754      large as to be slow if fetchlimit happens to be large.  So we choose the
1755      minimum of 8 and fetchlimit.  We used to use 200 instead of 8 but
1756      200 is way too big for remote debugging over a serial line.  */
1757
1758   chunksize = (len == -1 ? min (8, fetchlimit) : fetchlimit);
1759
1760   /* Loop until we either have all the characters, or we encounter
1761      some error, such as bumping into the end of the address space.  */
1762
1763   found_nul = 0;
1764   *buffer = NULL;
1765
1766   old_chain = make_cleanup (free_current_contents, buffer);
1767
1768   if (len > 0)
1769     {
1770       *buffer = (gdb_byte *) xmalloc (len * width);
1771       bufptr = *buffer;
1772
1773       nfetch = partial_memory_read (addr, bufptr, len * width, &errcode)
1774         / width;
1775       addr += nfetch * width;
1776       bufptr += nfetch * width;
1777     }
1778   else if (len == -1)
1779     {
1780       unsigned long bufsize = 0;
1781
1782       do
1783         {
1784           QUIT;
1785           nfetch = min (chunksize, fetchlimit - bufsize);
1786
1787           if (*buffer == NULL)
1788             *buffer = (gdb_byte *) xmalloc (nfetch * width);
1789           else
1790             *buffer = (gdb_byte *) xrealloc (*buffer,
1791                                              (nfetch + bufsize) * width);
1792
1793           bufptr = *buffer + bufsize * width;
1794           bufsize += nfetch;
1795
1796           /* Read as much as we can.  */
1797           nfetch = partial_memory_read (addr, bufptr, nfetch * width, &errcode)
1798                     / width;
1799
1800           /* Scan this chunk for the null character that terminates the string
1801              to print.  If found, we don't need to fetch any more.  Note
1802              that bufptr is explicitly left pointing at the next character
1803              after the null character, or at the next character after the end
1804              of the buffer.  */
1805
1806           limit = bufptr + nfetch * width;
1807           while (bufptr < limit)
1808             {
1809               unsigned long c;
1810
1811               c = extract_unsigned_integer (bufptr, width, byte_order);
1812               addr += width;
1813               bufptr += width;
1814               if (c == 0)
1815                 {
1816                   /* We don't care about any error which happened after
1817                      the NUL terminator.  */
1818                   errcode = 0;
1819                   found_nul = 1;
1820                   break;
1821                 }
1822             }
1823         }
1824       while (errcode == 0       /* no error */
1825              && bufptr - *buffer < fetchlimit * width   /* no overrun */
1826              && !found_nul);    /* haven't found NUL yet */
1827     }
1828   else
1829     {                           /* Length of string is really 0!  */
1830       /* We always allocate *buffer.  */
1831       *buffer = bufptr = xmalloc (1);
1832       errcode = 0;
1833     }
1834
1835   /* bufptr and addr now point immediately beyond the last byte which we
1836      consider part of the string (including a '\0' which ends the string).  */
1837   *bytes_read = bufptr - *buffer;
1838
1839   QUIT;
1840
1841   discard_cleanups (old_chain);
1842
1843   return errcode;
1844 }
1845
1846 /* Return true if print_wchar can display W without resorting to a
1847    numeric escape, false otherwise.  */
1848
1849 static int
1850 wchar_printable (gdb_wchar_t w)
1851 {
1852   return (gdb_iswprint (w)
1853           || w == LCST ('\a') || w == LCST ('\b')
1854           || w == LCST ('\f') || w == LCST ('\n')
1855           || w == LCST ('\r') || w == LCST ('\t')
1856           || w == LCST ('\v'));
1857 }
1858
1859 /* A helper function that converts the contents of STRING to wide
1860    characters and then appends them to OUTPUT.  */
1861
1862 static void
1863 append_string_as_wide (const char *string,
1864                        struct obstack *output)
1865 {
1866   for (; *string; ++string)
1867     {
1868       gdb_wchar_t w = gdb_btowc (*string);
1869       obstack_grow (output, &w, sizeof (gdb_wchar_t));
1870     }
1871 }
1872
1873 /* Print a wide character W to OUTPUT.  ORIG is a pointer to the
1874    original (target) bytes representing the character, ORIG_LEN is the
1875    number of valid bytes.  WIDTH is the number of bytes in a base
1876    characters of the type.  OUTPUT is an obstack to which wide
1877    characters are emitted.  QUOTER is a (narrow) character indicating
1878    the style of quotes surrounding the character to be printed.
1879    NEED_ESCAPE is an in/out flag which is used to track numeric
1880    escapes across calls.  */
1881
1882 static void
1883 print_wchar (gdb_wint_t w, const gdb_byte *orig,
1884              int orig_len, int width,
1885              enum bfd_endian byte_order,
1886              struct obstack *output,
1887              int quoter, int *need_escapep)
1888 {
1889   int need_escape = *need_escapep;
1890
1891   *need_escapep = 0;
1892   if (gdb_iswprint (w) && (!need_escape || (!gdb_iswdigit (w)
1893                                             && w != LCST ('8')
1894                                             && w != LCST ('9'))))
1895     {
1896       gdb_wchar_t wchar = w;
1897
1898       if (w == gdb_btowc (quoter) || w == LCST ('\\'))
1899         obstack_grow_wstr (output, LCST ("\\"));
1900       obstack_grow (output, &wchar, sizeof (gdb_wchar_t));
1901     }
1902   else
1903     {
1904       switch (w)
1905         {
1906         case LCST ('\a'):
1907           obstack_grow_wstr (output, LCST ("\\a"));
1908           break;
1909         case LCST ('\b'):
1910           obstack_grow_wstr (output, LCST ("\\b"));
1911           break;
1912         case LCST ('\f'):
1913           obstack_grow_wstr (output, LCST ("\\f"));
1914           break;
1915         case LCST ('\n'):
1916           obstack_grow_wstr (output, LCST ("\\n"));
1917           break;
1918         case LCST ('\r'):
1919           obstack_grow_wstr (output, LCST ("\\r"));
1920           break;
1921         case LCST ('\t'):
1922           obstack_grow_wstr (output, LCST ("\\t"));
1923           break;
1924         case LCST ('\v'):
1925           obstack_grow_wstr (output, LCST ("\\v"));
1926           break;
1927         default:
1928           {
1929             int i;
1930
1931             for (i = 0; i + width <= orig_len; i += width)
1932               {
1933                 char octal[30];
1934                 ULONGEST value;
1935
1936                 value = extract_unsigned_integer (&orig[i], width,
1937                                                   byte_order);
1938                 /* If the value fits in 3 octal digits, print it that
1939                    way.  Otherwise, print it as a hex escape.  */
1940                 if (value <= 0777)
1941                   sprintf (octal, "\\%.3o", (int) (value & 0777));
1942                 else
1943                   sprintf (octal, "\\x%lx", (long) value);
1944                 append_string_as_wide (octal, output);
1945               }
1946             /* If we somehow have extra bytes, print them now.  */
1947             while (i < orig_len)
1948               {
1949                 char octal[5];
1950
1951                 sprintf (octal, "\\%.3o", orig[i] & 0xff);
1952                 append_string_as_wide (octal, output);
1953                 ++i;
1954               }
1955
1956             *need_escapep = 1;
1957           }
1958           break;
1959         }
1960     }
1961 }
1962
1963 /* Print the character C on STREAM as part of the contents of a
1964    literal string whose delimiter is QUOTER.  ENCODING names the
1965    encoding of C.  */
1966
1967 void
1968 generic_emit_char (int c, struct type *type, struct ui_file *stream,
1969                    int quoter, const char *encoding)
1970 {
1971   enum bfd_endian byte_order
1972     = gdbarch_byte_order (get_type_arch (type));
1973   struct obstack wchar_buf, output;
1974   struct cleanup *cleanups;
1975   gdb_byte *buf;
1976   struct wchar_iterator *iter;
1977   int need_escape = 0;
1978
1979   buf = alloca (TYPE_LENGTH (type));
1980   pack_long (buf, type, c);
1981
1982   iter = make_wchar_iterator (buf, TYPE_LENGTH (type),
1983                               encoding, TYPE_LENGTH (type));
1984   cleanups = make_cleanup_wchar_iterator (iter);
1985
1986   /* This holds the printable form of the wchar_t data.  */
1987   obstack_init (&wchar_buf);
1988   make_cleanup_obstack_free (&wchar_buf);
1989
1990   while (1)
1991     {
1992       int num_chars;
1993       gdb_wchar_t *chars;
1994       const gdb_byte *buf;
1995       size_t buflen;
1996       int print_escape = 1;
1997       enum wchar_iterate_result result;
1998
1999       num_chars = wchar_iterate (iter, &result, &chars, &buf, &buflen);
2000       if (num_chars < 0)
2001         break;
2002       if (num_chars > 0)
2003         {
2004           /* If all characters are printable, print them.  Otherwise,
2005              we're going to have to print an escape sequence.  We
2006              check all characters because we want to print the target
2007              bytes in the escape sequence, and we don't know character
2008              boundaries there.  */
2009           int i;
2010
2011           print_escape = 0;
2012           for (i = 0; i < num_chars; ++i)
2013             if (!wchar_printable (chars[i]))
2014               {
2015                 print_escape = 1;
2016                 break;
2017               }
2018
2019           if (!print_escape)
2020             {
2021               for (i = 0; i < num_chars; ++i)
2022                 print_wchar (chars[i], buf, buflen,
2023                              TYPE_LENGTH (type), byte_order,
2024                              &wchar_buf, quoter, &need_escape);
2025             }
2026         }
2027
2028       /* This handles the NUM_CHARS == 0 case as well.  */
2029       if (print_escape)
2030         print_wchar (gdb_WEOF, buf, buflen, TYPE_LENGTH (type),
2031                      byte_order, &wchar_buf, quoter, &need_escape);
2032     }
2033
2034   /* The output in the host encoding.  */
2035   obstack_init (&output);
2036   make_cleanup_obstack_free (&output);
2037
2038   convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2039                              obstack_base (&wchar_buf),
2040                              obstack_object_size (&wchar_buf),
2041                              1, &output, translit_char);
2042   obstack_1grow (&output, '\0');
2043
2044   fputs_filtered (obstack_base (&output), stream);
2045
2046   do_cleanups (cleanups);
2047 }
2048
2049 /* Print the character string STRING, printing at most LENGTH
2050    characters.  LENGTH is -1 if the string is nul terminated.  TYPE is
2051    the type of each character.  OPTIONS holds the printing options;
2052    printing stops early if the number hits print_max; repeat counts
2053    are printed as appropriate.  Print ellipses at the end if we had to
2054    stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2055    QUOTE_CHAR is the character to print at each end of the string.  If
2056    C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2057    omitted.  */
2058
2059 void
2060 generic_printstr (struct ui_file *stream, struct type *type, 
2061                   const gdb_byte *string, unsigned int length, 
2062                   const char *encoding, int force_ellipses,
2063                   int quote_char, int c_style_terminator,
2064                   const struct value_print_options *options)
2065 {
2066   enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
2067   unsigned int i;
2068   unsigned int things_printed = 0;
2069   int in_quotes = 0;
2070   int need_comma = 0;
2071   int width = TYPE_LENGTH (type);
2072   struct obstack wchar_buf, output;
2073   struct cleanup *cleanup;
2074   struct wchar_iterator *iter;
2075   int finished = 0;
2076   int need_escape = 0;
2077   gdb_wchar_t wide_quote_char = gdb_btowc (quote_char);
2078
2079   if (length == -1)
2080     {
2081       unsigned long current_char = 1;
2082
2083       for (i = 0; current_char; ++i)
2084         {
2085           QUIT;
2086           current_char = extract_unsigned_integer (string + i * width,
2087                                                    width, byte_order);
2088         }
2089       length = i;
2090     }
2091
2092   /* If the string was not truncated due to `set print elements', and
2093      the last byte of it is a null, we don't print that, in
2094      traditional C style.  */
2095   if (c_style_terminator
2096       && !force_ellipses
2097       && length > 0
2098       && (extract_unsigned_integer (string + (length - 1) * width,
2099                                     width, byte_order) == 0))
2100     length--;
2101
2102   if (length == 0)
2103     {
2104       fputs_filtered ("\"\"", stream);
2105       return;
2106     }
2107
2108   /* Arrange to iterate over the characters, in wchar_t form.  */
2109   iter = make_wchar_iterator (string, length * width, encoding, width);
2110   cleanup = make_cleanup_wchar_iterator (iter);
2111
2112   /* WCHAR_BUF is the obstack we use to represent the string in
2113      wchar_t form.  */
2114   obstack_init (&wchar_buf);
2115   make_cleanup_obstack_free (&wchar_buf);
2116
2117   while (!finished && things_printed < options->print_max)
2118     {
2119       int num_chars;
2120       enum wchar_iterate_result result;
2121       gdb_wchar_t *chars;
2122       const gdb_byte *buf;
2123       size_t buflen;
2124
2125       QUIT;
2126
2127       if (need_comma)
2128         {
2129           obstack_grow_wstr (&wchar_buf, LCST (", "));
2130           need_comma = 0;
2131         }
2132
2133       num_chars = wchar_iterate (iter, &result, &chars, &buf, &buflen);
2134       /* We only look at repetitions when we were able to convert a
2135          single character in isolation.  This makes the code simpler
2136          and probably does the sensible thing in the majority of
2137          cases.  */
2138       while (num_chars == 1 && things_printed < options->print_max)
2139         {
2140           /* Count the number of repetitions.  */
2141           unsigned int reps = 0;
2142           gdb_wchar_t current_char = chars[0];
2143           const gdb_byte *orig_buf = buf;
2144           int orig_len = buflen;
2145
2146           if (need_comma)
2147             {
2148               obstack_grow_wstr (&wchar_buf, LCST (", "));
2149               need_comma = 0;
2150             }
2151
2152           while (num_chars == 1 && current_char == chars[0])
2153             {
2154               num_chars = wchar_iterate (iter, &result, &chars,
2155                                          &buf, &buflen);
2156               ++reps;
2157             }
2158
2159           /* Emit CURRENT_CHAR according to the repetition count and
2160              options.  */
2161           if (reps > options->repeat_count_threshold)
2162             {
2163               if (in_quotes)
2164                 {
2165                   if (options->inspect_it)
2166                     obstack_grow_wstr (&wchar_buf, LCST ("\\"));
2167                   obstack_grow (&wchar_buf, &wide_quote_char,
2168                                 sizeof (gdb_wchar_t));
2169                   obstack_grow_wstr (&wchar_buf, LCST (", "));
2170                   in_quotes = 0;
2171                 }
2172               obstack_grow_wstr (&wchar_buf, LCST ("'"));
2173               need_escape = 0;
2174               print_wchar (current_char, orig_buf, orig_len, width,
2175                            byte_order, &wchar_buf, '\'', &need_escape);
2176               obstack_grow_wstr (&wchar_buf, LCST ("'"));
2177               {
2178                 /* Painful gyrations.  */
2179                 int j;
2180                 char *s = xstrprintf (_(" <repeats %u times>"), reps);
2181
2182                 for (j = 0; s[j]; ++j)
2183                   {
2184                     gdb_wchar_t w = gdb_btowc (s[j]);
2185                     obstack_grow (&wchar_buf, &w, sizeof (gdb_wchar_t));
2186                   }
2187                 xfree (s);
2188               }
2189               things_printed += options->repeat_count_threshold;
2190               need_comma = 1;
2191             }
2192           else
2193             {
2194               /* Saw the character one or more times, but fewer than
2195                  the repetition threshold.  */
2196               if (!in_quotes)
2197                 {
2198                   if (options->inspect_it)
2199                     obstack_grow_wstr (&wchar_buf, LCST ("\\"));
2200                   obstack_grow (&wchar_buf, &wide_quote_char,
2201                                 sizeof (gdb_wchar_t));
2202                   in_quotes = 1;
2203                   need_escape = 0;
2204                 }
2205
2206               while (reps-- > 0)
2207                 {
2208                   print_wchar (current_char, orig_buf,
2209                                orig_len, width,
2210                                byte_order, &wchar_buf,
2211                                quote_char, &need_escape);
2212                   ++things_printed;
2213                 }
2214             }
2215         }
2216
2217       /* NUM_CHARS and the other outputs from wchar_iterate are valid
2218          here regardless of which branch was taken above.  */
2219       if (num_chars < 0)
2220         {
2221           /* Hit EOF.  */
2222           finished = 1;
2223           break;
2224         }
2225
2226       switch (result)
2227         {
2228         case wchar_iterate_invalid:
2229           if (!in_quotes)
2230             {
2231               if (options->inspect_it)
2232                 obstack_grow_wstr (&wchar_buf, LCST ("\\"));
2233               obstack_grow (&wchar_buf, &wide_quote_char,
2234                             sizeof (gdb_wchar_t));
2235               in_quotes = 1;
2236             }
2237           need_escape = 0;
2238           print_wchar (gdb_WEOF, buf, buflen, width, byte_order,
2239                        &wchar_buf, quote_char, &need_escape);
2240           break;
2241
2242         case wchar_iterate_incomplete:
2243           if (in_quotes)
2244             {
2245               if (options->inspect_it)
2246                 obstack_grow_wstr (&wchar_buf, LCST ("\\"));
2247               obstack_grow (&wchar_buf, &wide_quote_char,
2248                             sizeof (gdb_wchar_t));
2249               obstack_grow_wstr (&wchar_buf, LCST (","));
2250               in_quotes = 0;
2251             }
2252           obstack_grow_wstr (&wchar_buf,
2253                              LCST (" <incomplete sequence "));
2254           print_wchar (gdb_WEOF, buf, buflen, width,
2255                        byte_order, &wchar_buf,
2256                        0, &need_escape);
2257           obstack_grow_wstr (&wchar_buf, LCST (">"));
2258           finished = 1;
2259           break;
2260         }
2261     }
2262
2263   /* Terminate the quotes if necessary.  */
2264   if (in_quotes)
2265     {
2266       if (options->inspect_it)
2267         obstack_grow_wstr (&wchar_buf, LCST ("\\"));
2268       obstack_grow (&wchar_buf, &wide_quote_char,
2269                     sizeof (gdb_wchar_t));
2270     }
2271
2272   if (force_ellipses || !finished)
2273     obstack_grow_wstr (&wchar_buf, LCST ("..."));
2274
2275   /* OUTPUT is where we collect `char's for printing.  */
2276   obstack_init (&output);
2277   make_cleanup_obstack_free (&output);
2278
2279   convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2280                              obstack_base (&wchar_buf),
2281                              obstack_object_size (&wchar_buf),
2282                              1, &output, translit_char);
2283   obstack_1grow (&output, '\0');
2284
2285   fputs_filtered (obstack_base (&output), stream);
2286
2287   do_cleanups (cleanup);
2288 }
2289
2290 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2291    characters, of WIDTH bytes a piece, to STREAM.  If LEN is -1, printing
2292    stops at the first null byte, otherwise printing proceeds (including null
2293    bytes) until either print_max or LEN characters have been printed,
2294    whichever is smaller.  ENCODING is the name of the string's
2295    encoding.  It can be NULL, in which case the target encoding is
2296    assumed.  */
2297
2298 int
2299 val_print_string (struct type *elttype, const char *encoding,
2300                   CORE_ADDR addr, int len,
2301                   struct ui_file *stream,
2302                   const struct value_print_options *options)
2303 {
2304   int force_ellipsis = 0;       /* Force ellipsis to be printed if nonzero.  */
2305   int errcode;                  /* Errno returned from bad reads.  */
2306   int found_nul;                /* Non-zero if we found the nul char.  */
2307   unsigned int fetchlimit;      /* Maximum number of chars to print.  */
2308   int bytes_read;
2309   gdb_byte *buffer = NULL;      /* Dynamically growable fetch buffer.  */
2310   struct cleanup *old_chain = NULL;     /* Top of the old cleanup chain.  */
2311   struct gdbarch *gdbarch = get_type_arch (elttype);
2312   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
2313   int width = TYPE_LENGTH (elttype);
2314
2315   /* First we need to figure out the limit on the number of characters we are
2316      going to attempt to fetch and print.  This is actually pretty simple.  If
2317      LEN >= zero, then the limit is the minimum of LEN and print_max.  If
2318      LEN is -1, then the limit is print_max.  This is true regardless of
2319      whether print_max is zero, UINT_MAX (unlimited), or something in between,
2320      because finding the null byte (or available memory) is what actually
2321      limits the fetch.  */
2322
2323   fetchlimit = (len == -1 ? options->print_max : min (len,
2324                                                       options->print_max));
2325
2326   errcode = read_string (addr, len, width, fetchlimit, byte_order,
2327                          &buffer, &bytes_read);
2328   old_chain = make_cleanup (xfree, buffer);
2329
2330   addr += bytes_read;
2331
2332   /* We now have either successfully filled the buffer to fetchlimit,
2333      or terminated early due to an error or finding a null char when
2334      LEN is -1.  */
2335
2336   /* Determine found_nul by looking at the last character read.  */
2337   found_nul = extract_unsigned_integer (buffer + bytes_read - width, width,
2338                                         byte_order) == 0;
2339   if (len == -1 && !found_nul)
2340     {
2341       gdb_byte *peekbuf;
2342
2343       /* We didn't find a NUL terminator we were looking for.  Attempt
2344          to peek at the next character.  If not successful, or it is not
2345          a null byte, then force ellipsis to be printed.  */
2346
2347       peekbuf = (gdb_byte *) alloca (width);
2348
2349       if (target_read_memory (addr, peekbuf, width) == 0
2350           && extract_unsigned_integer (peekbuf, width, byte_order) != 0)
2351         force_ellipsis = 1;
2352     }
2353   else if ((len >= 0 && errcode != 0) || (len > bytes_read / width))
2354     {
2355       /* Getting an error when we have a requested length, or fetching less
2356          than the number of characters actually requested, always make us
2357          print ellipsis.  */
2358       force_ellipsis = 1;
2359     }
2360
2361   /* If we get an error before fetching anything, don't print a string.
2362      But if we fetch something and then get an error, print the string
2363      and then the error message.  */
2364   if (errcode == 0 || bytes_read > 0)
2365     {
2366       LA_PRINT_STRING (stream, elttype, buffer, bytes_read / width,
2367                        encoding, force_ellipsis, options);
2368     }
2369
2370   if (errcode != 0)
2371     {
2372       if (errcode == EIO)
2373         {
2374           fprintf_filtered (stream, "<Address ");
2375           fputs_filtered (paddress (gdbarch, addr), stream);
2376           fprintf_filtered (stream, " out of bounds>");
2377         }
2378       else
2379         {
2380           fprintf_filtered (stream, "<Error reading address ");
2381           fputs_filtered (paddress (gdbarch, addr), stream);
2382           fprintf_filtered (stream, ": %s>", safe_strerror (errcode));
2383         }
2384     }
2385
2386   gdb_flush (stream);
2387   do_cleanups (old_chain);
2388
2389   return (bytes_read / width);
2390 }
2391 \f
2392
2393 /* The 'set input-radix' command writes to this auxiliary variable.
2394    If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2395    it is left unchanged.  */
2396
2397 static unsigned input_radix_1 = 10;
2398
2399 /* Validate an input or output radix setting, and make sure the user
2400    knows what they really did here.  Radix setting is confusing, e.g.
2401    setting the input radix to "10" never changes it!  */
2402
2403 static void
2404 set_input_radix (char *args, int from_tty, struct cmd_list_element *c)
2405 {
2406   set_input_radix_1 (from_tty, input_radix_1);
2407 }
2408
2409 static void
2410 set_input_radix_1 (int from_tty, unsigned radix)
2411 {
2412   /* We don't currently disallow any input radix except 0 or 1, which don't
2413      make any mathematical sense.  In theory, we can deal with any input
2414      radix greater than 1, even if we don't have unique digits for every
2415      value from 0 to radix-1, but in practice we lose on large radix values.
2416      We should either fix the lossage or restrict the radix range more.
2417      (FIXME).  */
2418
2419   if (radix < 2)
2420     {
2421       input_radix_1 = input_radix;
2422       error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2423              radix);
2424     }
2425   input_radix_1 = input_radix = radix;
2426   if (from_tty)
2427     {
2428       printf_filtered (_("Input radix now set to "
2429                          "decimal %u, hex %x, octal %o.\n"),
2430                        radix, radix, radix);
2431     }
2432 }
2433
2434 /* The 'set output-radix' command writes to this auxiliary variable.
2435    If the requested radix is valid, OUTPUT_RADIX is updated,
2436    otherwise, it is left unchanged.  */
2437
2438 static unsigned output_radix_1 = 10;
2439
2440 static void
2441 set_output_radix (char *args, int from_tty, struct cmd_list_element *c)
2442 {
2443   set_output_radix_1 (from_tty, output_radix_1);
2444 }
2445
2446 static void
2447 set_output_radix_1 (int from_tty, unsigned radix)
2448 {
2449   /* Validate the radix and disallow ones that we aren't prepared to
2450      handle correctly, leaving the radix unchanged.  */
2451   switch (radix)
2452     {
2453     case 16:
2454       user_print_options.output_format = 'x';   /* hex */
2455       break;
2456     case 10:
2457       user_print_options.output_format = 0;     /* decimal */
2458       break;
2459     case 8:
2460       user_print_options.output_format = 'o';   /* octal */
2461       break;
2462     default:
2463       output_radix_1 = output_radix;
2464       error (_("Unsupported output radix ``decimal %u''; "
2465                "output radix unchanged."),
2466              radix);
2467     }
2468   output_radix_1 = output_radix = radix;
2469   if (from_tty)
2470     {
2471       printf_filtered (_("Output radix now set to "
2472                          "decimal %u, hex %x, octal %o.\n"),
2473                        radix, radix, radix);
2474     }
2475 }
2476
2477 /* Set both the input and output radix at once.  Try to set the output radix
2478    first, since it has the most restrictive range.  An radix that is valid as
2479    an output radix is also valid as an input radix.
2480
2481    It may be useful to have an unusual input radix.  If the user wishes to
2482    set an input radix that is not valid as an output radix, he needs to use
2483    the 'set input-radix' command.  */
2484
2485 static void
2486 set_radix (char *arg, int from_tty)
2487 {
2488   unsigned radix;
2489
2490   radix = (arg == NULL) ? 10 : parse_and_eval_long (arg);
2491   set_output_radix_1 (0, radix);
2492   set_input_radix_1 (0, radix);
2493   if (from_tty)
2494     {
2495       printf_filtered (_("Input and output radices now set to "
2496                          "decimal %u, hex %x, octal %o.\n"),
2497                        radix, radix, radix);
2498     }
2499 }
2500
2501 /* Show both the input and output radices.  */
2502
2503 static void
2504 show_radix (char *arg, int from_tty)
2505 {
2506   if (from_tty)
2507     {
2508       if (input_radix == output_radix)
2509         {
2510           printf_filtered (_("Input and output radices set to "
2511                              "decimal %u, hex %x, octal %o.\n"),
2512                            input_radix, input_radix, input_radix);
2513         }
2514       else
2515         {
2516           printf_filtered (_("Input radix set to decimal "
2517                              "%u, hex %x, octal %o.\n"),
2518                            input_radix, input_radix, input_radix);
2519           printf_filtered (_("Output radix set to decimal "
2520                              "%u, hex %x, octal %o.\n"),
2521                            output_radix, output_radix, output_radix);
2522         }
2523     }
2524 }
2525 \f
2526
2527 static void
2528 set_print (char *arg, int from_tty)
2529 {
2530   printf_unfiltered (
2531      "\"set print\" must be followed by the name of a print subcommand.\n");
2532   help_list (setprintlist, "set print ", -1, gdb_stdout);
2533 }
2534
2535 static void
2536 show_print (char *args, int from_tty)
2537 {
2538   cmd_show_list (showprintlist, from_tty, "");
2539 }
2540 \f
2541 void
2542 _initialize_valprint (void)
2543 {
2544   add_prefix_cmd ("print", no_class, set_print,
2545                   _("Generic command for setting how things print."),
2546                   &setprintlist, "set print ", 0, &setlist);
2547   add_alias_cmd ("p", "print", no_class, 1, &setlist);
2548   /* Prefer set print to set prompt.  */
2549   add_alias_cmd ("pr", "print", no_class, 1, &setlist);
2550
2551   add_prefix_cmd ("print", no_class, show_print,
2552                   _("Generic command for showing print settings."),
2553                   &showprintlist, "show print ", 0, &showlist);
2554   add_alias_cmd ("p", "print", no_class, 1, &showlist);
2555   add_alias_cmd ("pr", "print", no_class, 1, &showlist);
2556
2557   add_setshow_uinteger_cmd ("elements", no_class,
2558                             &user_print_options.print_max, _("\
2559 Set limit on string chars or array elements to print."), _("\
2560 Show limit on string chars or array elements to print."), _("\
2561 \"set print elements 0\" causes there to be no limit."),
2562                             NULL,
2563                             show_print_max,
2564                             &setprintlist, &showprintlist);
2565
2566   add_setshow_boolean_cmd ("null-stop", no_class,
2567                            &user_print_options.stop_print_at_null, _("\
2568 Set printing of char arrays to stop at first null char."), _("\
2569 Show printing of char arrays to stop at first null char."), NULL,
2570                            NULL,
2571                            show_stop_print_at_null,
2572                            &setprintlist, &showprintlist);
2573
2574   add_setshow_uinteger_cmd ("repeats", no_class,
2575                             &user_print_options.repeat_count_threshold, _("\
2576 Set threshold for repeated print elements."), _("\
2577 Show threshold for repeated print elements."), _("\
2578 \"set print repeats 0\" causes all elements to be individually printed."),
2579                             NULL,
2580                             show_repeat_count_threshold,
2581                             &setprintlist, &showprintlist);
2582
2583   add_setshow_boolean_cmd ("pretty", class_support,
2584                            &user_print_options.prettyprint_structs, _("\
2585 Set prettyprinting of structures."), _("\
2586 Show prettyprinting of structures."), NULL,
2587                            NULL,
2588                            show_prettyprint_structs,
2589                            &setprintlist, &showprintlist);
2590
2591   add_setshow_boolean_cmd ("union", class_support,
2592                            &user_print_options.unionprint, _("\
2593 Set printing of unions interior to structures."), _("\
2594 Show printing of unions interior to structures."), NULL,
2595                            NULL,
2596                            show_unionprint,
2597                            &setprintlist, &showprintlist);
2598
2599   add_setshow_boolean_cmd ("array", class_support,
2600                            &user_print_options.prettyprint_arrays, _("\
2601 Set prettyprinting of arrays."), _("\
2602 Show prettyprinting of arrays."), NULL,
2603                            NULL,
2604                            show_prettyprint_arrays,
2605                            &setprintlist, &showprintlist);
2606
2607   add_setshow_boolean_cmd ("address", class_support,
2608                            &user_print_options.addressprint, _("\
2609 Set printing of addresses."), _("\
2610 Show printing of addresses."), NULL,
2611                            NULL,
2612                            show_addressprint,
2613                            &setprintlist, &showprintlist);
2614
2615   add_setshow_boolean_cmd ("symbol", class_support,
2616                            &user_print_options.symbol_print, _("\
2617 Set printing of symbol names when printing pointers."), _("\
2618 Show printing of symbol names when printing pointers."),
2619                            NULL, NULL,
2620                            show_symbol_print,
2621                            &setprintlist, &showprintlist);
2622
2623   add_setshow_zuinteger_cmd ("input-radix", class_support, &input_radix_1,
2624                              _("\
2625 Set default input radix for entering numbers."), _("\
2626 Show default input radix for entering numbers."), NULL,
2627                              set_input_radix,
2628                              show_input_radix,
2629                              &setlist, &showlist);
2630
2631   add_setshow_zuinteger_cmd ("output-radix", class_support, &output_radix_1,
2632                              _("\
2633 Set default output radix for printing of values."), _("\
2634 Show default output radix for printing of values."), NULL,
2635                              set_output_radix,
2636                              show_output_radix,
2637                              &setlist, &showlist);
2638
2639   /* The "set radix" and "show radix" commands are special in that
2640      they are like normal set and show commands but allow two normally
2641      independent variables to be either set or shown with a single
2642      command.  So the usual deprecated_add_set_cmd() and [deleted]
2643      add_show_from_set() commands aren't really appropriate.  */
2644   /* FIXME: i18n: With the new add_setshow_integer command, that is no
2645      longer true - show can display anything.  */
2646   add_cmd ("radix", class_support, set_radix, _("\
2647 Set default input and output number radices.\n\
2648 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
2649 Without an argument, sets both radices back to the default value of 10."),
2650            &setlist);
2651   add_cmd ("radix", class_support, show_radix, _("\
2652 Show the default input and output number radices.\n\
2653 Use 'show input-radix' or 'show output-radix' to independently show each."),
2654            &showlist);
2655
2656   add_setshow_boolean_cmd ("array-indexes", class_support,
2657                            &user_print_options.print_array_indexes, _("\
2658 Set printing of array indexes."), _("\
2659 Show printing of array indexes"), NULL, NULL, show_print_array_indexes,
2660                            &setprintlist, &showprintlist);
2661 }