2011-01-24 Pedro Alves <pedro@codesourcery.com>
[external/binutils.git] / gdb / f-valprint.c
1 /* Support for printing Fortran values for GDB, the GNU debugger.
2
3    Copyright (C) 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2003, 2005, 2006,
4    2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5
6    Contributed by Motorola.  Adapted from the C definitions by Farooq Butt
7    (fmbutt@engage.sps.mot.com), additionally worked over by Stan Shebs.
8
9    This file is part of GDB.
10
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
23
24 #include "defs.h"
25 #include "gdb_string.h"
26 #include "symtab.h"
27 #include "gdbtypes.h"
28 #include "expression.h"
29 #include "value.h"
30 #include "valprint.h"
31 #include "language.h"
32 #include "f-lang.h"
33 #include "frame.h"
34 #include "gdbcore.h"
35 #include "command.h"
36 #include "block.h"
37
38 #if 0
39 static int there_is_a_visible_common_named (char *);
40 #endif
41
42 extern void _initialize_f_valprint (void);
43 static void info_common_command (char *, int);
44 static void list_all_visible_commons (char *);
45 static void f77_create_arrayprint_offset_tbl (struct type *,
46                                               struct ui_file *);
47 static void f77_get_dynamic_length_of_aggregate (struct type *);
48
49 int f77_array_offset_tbl[MAX_FORTRAN_DIMS + 1][2];
50
51 /* Array which holds offsets to be applied to get a row's elements
52    for a given array.  Array also holds the size of each subarray.  */
53
54 /* The following macro gives us the size of the nth dimension, Where 
55    n is 1 based.  */
56
57 #define F77_DIM_SIZE(n) (f77_array_offset_tbl[n][1])
58
59 /* The following gives us the offset for row n where n is 1-based.  */
60
61 #define F77_DIM_OFFSET(n) (f77_array_offset_tbl[n][0])
62
63 int
64 f77_get_lowerbound (struct type *type)
65 {
66   if (TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED (type))
67     error (_("Lower bound may not be '*' in F77"));
68
69   return TYPE_ARRAY_LOWER_BOUND_VALUE (type);
70 }
71
72 int
73 f77_get_upperbound (struct type *type)
74 {
75   if (TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type))
76     {
77       /* We have an assumed size array on our hands.  Assume that
78          upper_bound == lower_bound so that we show at least 1 element.
79          If the user wants to see more elements, let him manually ask for 'em
80          and we'll subscript the array and show him.  */
81
82       return f77_get_lowerbound (type);
83     }
84
85   return TYPE_ARRAY_UPPER_BOUND_VALUE (type);
86 }
87
88 /* Obtain F77 adjustable array dimensions.  */
89
90 static void
91 f77_get_dynamic_length_of_aggregate (struct type *type)
92 {
93   int upper_bound = -1;
94   int lower_bound = 1;
95
96   /* Recursively go all the way down into a possibly multi-dimensional
97      F77 array and get the bounds.  For simple arrays, this is pretty
98      easy but when the bounds are dynamic, we must be very careful 
99      to add up all the lengths correctly.  Not doing this right 
100      will lead to horrendous-looking arrays in parameter lists.
101
102      This function also works for strings which behave very 
103      similarly to arrays.  */
104
105   if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_ARRAY
106       || TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_STRING)
107     f77_get_dynamic_length_of_aggregate (TYPE_TARGET_TYPE (type));
108
109   /* Recursion ends here, start setting up lengths.  */
110   lower_bound = f77_get_lowerbound (type);
111   upper_bound = f77_get_upperbound (type);
112
113   /* Patch in a valid length value.  */
114
115   TYPE_LENGTH (type) =
116     (upper_bound - lower_bound + 1)
117     * TYPE_LENGTH (check_typedef (TYPE_TARGET_TYPE (type)));
118 }
119
120 /* Function that sets up the array offset,size table for the array 
121    type "type".  */
122
123 static void
124 f77_create_arrayprint_offset_tbl (struct type *type, struct ui_file *stream)
125 {
126   struct type *tmp_type;
127   int eltlen;
128   int ndimen = 1;
129   int upper, lower;
130
131   tmp_type = type;
132
133   while ((TYPE_CODE (tmp_type) == TYPE_CODE_ARRAY))
134     {
135       upper = f77_get_upperbound (tmp_type);
136       lower = f77_get_lowerbound (tmp_type);
137
138       F77_DIM_SIZE (ndimen) = upper - lower + 1;
139
140       tmp_type = TYPE_TARGET_TYPE (tmp_type);
141       ndimen++;
142     }
143
144   /* Now we multiply eltlen by all the offsets, so that later we 
145      can print out array elements correctly.  Up till now we 
146      know an offset to apply to get the item but we also 
147      have to know how much to add to get to the next item.  */
148
149   ndimen--;
150   eltlen = TYPE_LENGTH (tmp_type);
151   F77_DIM_OFFSET (ndimen) = eltlen;
152   while (--ndimen > 0)
153     {
154       eltlen *= F77_DIM_SIZE (ndimen + 1);
155       F77_DIM_OFFSET (ndimen) = eltlen;
156     }
157 }
158
159
160
161 /* Actual function which prints out F77 arrays, Valaddr == address in 
162    the superior.  Address == the address in the inferior.  */
163
164 static void
165 f77_print_array_1 (int nss, int ndimensions, struct type *type,
166                    const gdb_byte *valaddr,
167                    int embedded_offset, CORE_ADDR address,
168                    struct ui_file *stream, int recurse,
169                    const struct value *val,
170                    const struct value_print_options *options,
171                    int *elts)
172 {
173   int i;
174
175   if (nss != ndimensions)
176     {
177       for (i = 0;
178            (i < F77_DIM_SIZE (nss) && (*elts) < options->print_max);
179            i++)
180         {
181           fprintf_filtered (stream, "( ");
182           f77_print_array_1 (nss + 1, ndimensions, TYPE_TARGET_TYPE (type),
183                              valaddr,
184                              embedded_offset + i * F77_DIM_OFFSET (nss),
185                              address,
186                              stream, recurse, val, options, elts);
187           fprintf_filtered (stream, ") ");
188         }
189       if (*elts >= options->print_max && i < F77_DIM_SIZE (nss)) 
190         fprintf_filtered (stream, "...");
191     }
192   else
193     {
194       for (i = 0; i < F77_DIM_SIZE (nss) && (*elts) < options->print_max;
195            i++, (*elts)++)
196         {
197           val_print (TYPE_TARGET_TYPE (type),
198                      valaddr,
199                      embedded_offset + i * F77_DIM_OFFSET (ndimensions),
200                      address, stream, recurse,
201                      val, options, current_language);
202
203           if (i != (F77_DIM_SIZE (nss) - 1))
204             fprintf_filtered (stream, ", ");
205
206           if ((*elts == options->print_max - 1)
207               && (i != (F77_DIM_SIZE (nss) - 1)))
208             fprintf_filtered (stream, "...");
209         }
210     }
211 }
212
213 /* This function gets called to print an F77 array, we set up some 
214    stuff and then immediately call f77_print_array_1().  */
215
216 static void
217 f77_print_array (struct type *type, const gdb_byte *valaddr,
218                  int embedded_offset,
219                  CORE_ADDR address, struct ui_file *stream,
220                  int recurse,
221                  const struct value *val,
222                  const struct value_print_options *options)
223 {
224   int ndimensions;
225   int elts = 0;
226
227   ndimensions = calc_f77_array_dims (type);
228
229   if (ndimensions > MAX_FORTRAN_DIMS || ndimensions < 0)
230     error (_("\
231 Type node corrupt! F77 arrays cannot have %d subscripts (%d Max)"),
232            ndimensions, MAX_FORTRAN_DIMS);
233
234   /* Since F77 arrays are stored column-major, we set up an 
235      offset table to get at the various row's elements.  The 
236      offset table contains entries for both offset and subarray size.  */
237
238   f77_create_arrayprint_offset_tbl (type, stream);
239
240   f77_print_array_1 (1, ndimensions, type, valaddr, embedded_offset,
241                      address, stream, recurse, val, options, &elts);
242 }
243 \f
244
245 /* Print data of type TYPE located at VALADDR (within GDB), which came from
246    the inferior at address ADDRESS, onto stdio stream STREAM according to
247    OPTIONS.  The data at VALADDR is in target byte order.
248
249    If the data are a string pointer, returns the number of string characters
250    printed.  */
251
252 int
253 f_val_print (struct type *type, const gdb_byte *valaddr, int embedded_offset,
254              CORE_ADDR address, struct ui_file *stream, int recurse,
255              const struct value *original_value,
256              const struct value_print_options *options)
257 {
258   struct gdbarch *gdbarch = get_type_arch (type);
259   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
260   unsigned int i = 0;   /* Number of characters printed.  */
261   struct type *elttype;
262   LONGEST val;
263   CORE_ADDR addr;
264   int index;
265
266   CHECK_TYPEDEF (type);
267   switch (TYPE_CODE (type))
268     {
269     case TYPE_CODE_STRING:
270       f77_get_dynamic_length_of_aggregate (type);
271       LA_PRINT_STRING (stream, builtin_type (gdbarch)->builtin_char,
272                        valaddr + embedded_offset,
273                        TYPE_LENGTH (type), NULL, 0, options);
274       break;
275
276     case TYPE_CODE_ARRAY:
277       fprintf_filtered (stream, "(");
278       f77_print_array (type, valaddr, embedded_offset,
279                        address, stream, recurse, original_value, options);
280       fprintf_filtered (stream, ")");
281       break;
282
283     case TYPE_CODE_PTR:
284       if (options->format && options->format != 's')
285         {
286           print_scalar_formatted (valaddr + embedded_offset,
287                                   type, options, 0, stream);
288           break;
289         }
290       else
291         {
292           addr = unpack_pointer (type, valaddr + embedded_offset);
293           elttype = check_typedef (TYPE_TARGET_TYPE (type));
294
295           if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
296             {
297               /* Try to print what function it points to.  */
298               print_address_demangle (gdbarch, addr, stream, demangle);
299               /* Return value is irrelevant except for string pointers.  */
300               return 0;
301             }
302
303           if (options->addressprint && options->format != 's')
304             fputs_filtered (paddress (gdbarch, addr), stream);
305
306           /* For a pointer to char or unsigned char, also print the string
307              pointed to, unless pointer is null.  */
308           if (TYPE_LENGTH (elttype) == 1
309               && TYPE_CODE (elttype) == TYPE_CODE_INT
310               && (options->format == 0 || options->format == 's')
311               && addr != 0)
312             i = val_print_string (TYPE_TARGET_TYPE (type), NULL, addr, -1,
313                                   stream, options);
314
315           /* Return number of characters printed, including the terminating
316              '\0' if we reached the end.  val_print_string takes care including
317              the terminating '\0' if necessary.  */
318           return i;
319         }
320       break;
321
322     case TYPE_CODE_REF:
323       elttype = check_typedef (TYPE_TARGET_TYPE (type));
324       if (options->addressprint)
325         {
326           CORE_ADDR addr
327             = extract_typed_address (valaddr + embedded_offset, type);
328
329           fprintf_filtered (stream, "@");
330           fputs_filtered (paddress (gdbarch, addr), stream);
331           if (options->deref_ref)
332             fputs_filtered (": ", stream);
333         }
334       /* De-reference the reference.  */
335       if (options->deref_ref)
336         {
337           if (TYPE_CODE (elttype) != TYPE_CODE_UNDEF)
338             {
339               struct value *deref_val =
340                 value_at
341                 (TYPE_TARGET_TYPE (type),
342                  unpack_pointer (type, valaddr + embedded_offset));
343
344               common_val_print (deref_val, stream, recurse,
345                                 options, current_language);
346             }
347           else
348             fputs_filtered ("???", stream);
349         }
350       break;
351
352     case TYPE_CODE_FUNC:
353       if (options->format)
354         {
355           print_scalar_formatted (valaddr + embedded_offset,
356                                   type, options, 0, stream);
357           break;
358         }
359       /* FIXME, we should consider, at least for ANSI C language, eliminating
360          the distinction made between FUNCs and POINTERs to FUNCs.  */
361       fprintf_filtered (stream, "{");
362       type_print (type, "", stream, -1);
363       fprintf_filtered (stream, "} ");
364       /* Try to print what function it points to, and its address.  */
365       print_address_demangle (gdbarch, address, stream, demangle);
366       break;
367
368     case TYPE_CODE_INT:
369       if (options->format || options->output_format)
370         {
371           struct value_print_options opts = *options;
372
373           opts.format = (options->format ? options->format
374                          : options->output_format);
375           print_scalar_formatted (valaddr + embedded_offset,
376                                   type, &opts, 0, stream);
377         }
378       else
379         {
380           val_print_type_code_int (type, valaddr + embedded_offset, stream);
381           /* C and C++ has no single byte int type, char is used instead.
382              Since we don't know whether the value is really intended to
383              be used as an integer or a character, print the character
384              equivalent as well.  */
385           if (TYPE_LENGTH (type) == 1)
386             {
387               LONGEST c;
388
389               fputs_filtered (" ", stream);
390               c = unpack_long (type, valaddr + embedded_offset);
391               LA_PRINT_CHAR ((unsigned char) c, type, stream);
392             }
393         }
394       break;
395
396     case TYPE_CODE_FLAGS:
397       if (options->format)
398         print_scalar_formatted (valaddr + embedded_offset,
399                                 type, options, 0, stream);
400       else
401         val_print_type_code_flags (type, valaddr + embedded_offset, stream);
402       break;
403
404     case TYPE_CODE_FLT:
405       if (options->format)
406         print_scalar_formatted (valaddr + embedded_offset,
407                                 type, options, 0, stream);
408       else
409         print_floating (valaddr + embedded_offset, type, stream);
410       break;
411
412     case TYPE_CODE_VOID:
413       fprintf_filtered (stream, "VOID");
414       break;
415
416     case TYPE_CODE_ERROR:
417       fprintf_filtered (stream, "%s", TYPE_ERROR_NAME (type));
418       break;
419
420     case TYPE_CODE_RANGE:
421       /* FIXME, we should not ever have to print one of these yet.  */
422       fprintf_filtered (stream, "<range type>");
423       break;
424
425     case TYPE_CODE_BOOL:
426       if (options->format || options->output_format)
427         {
428           struct value_print_options opts = *options;
429
430           opts.format = (options->format ? options->format
431                          : options->output_format);
432           print_scalar_formatted (valaddr + embedded_offset,
433                                   type, &opts, 0, stream);
434         }
435       else
436         {
437           val = extract_unsigned_integer (valaddr + embedded_offset,
438                                           TYPE_LENGTH (type), byte_order);
439           if (val == 0)
440             fprintf_filtered (stream, ".FALSE.");
441           else if (val == 1)
442             fprintf_filtered (stream, ".TRUE.");
443           else
444             /* Not a legitimate logical type, print as an integer.  */
445             {
446               /* Bash the type code temporarily.  */
447               TYPE_CODE (type) = TYPE_CODE_INT;
448               val_print (type, valaddr, embedded_offset,
449                          address, stream, recurse,
450                          original_value, options, current_language);
451               /* Restore the type code so later uses work as intended.  */
452               TYPE_CODE (type) = TYPE_CODE_BOOL;
453             }
454         }
455       break;
456
457     case TYPE_CODE_COMPLEX:
458       type = TYPE_TARGET_TYPE (type);
459       fputs_filtered ("(", stream);
460       print_floating (valaddr + embedded_offset, type, stream);
461       fputs_filtered (",", stream);
462       print_floating (valaddr + embedded_offset + TYPE_LENGTH (type),
463                       type, stream);
464       fputs_filtered (")", stream);
465       break;
466
467     case TYPE_CODE_UNDEF:
468       /* This happens (without TYPE_FLAG_STUB set) on systems which don't use
469          dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
470          and no complete type for struct foo in that file.  */
471       fprintf_filtered (stream, "<incomplete type>");
472       break;
473
474     case TYPE_CODE_STRUCT:
475     case TYPE_CODE_UNION:
476       /* Starting from the Fortran 90 standard, Fortran supports derived
477          types.  */
478       fprintf_filtered (stream, "( ");
479       for (index = 0; index < TYPE_NFIELDS (type); index++)
480         {
481           int offset = TYPE_FIELD_BITPOS (type, index) / 8;
482
483           val_print (TYPE_FIELD_TYPE (type, index), valaddr,
484                      embedded_offset + offset,
485                      address, stream, recurse + 1,
486                      original_value, options, current_language);
487           if (index != TYPE_NFIELDS (type) - 1)
488             fputs_filtered (", ", stream);
489         }
490       fprintf_filtered (stream, " )");
491       break;     
492
493     default:
494       error (_("Invalid F77 type code %d in symbol table."), TYPE_CODE (type));
495     }
496   gdb_flush (stream);
497   return 0;
498 }
499
500 static void
501 list_all_visible_commons (char *funname)
502 {
503   SAVED_F77_COMMON_PTR tmp;
504
505   tmp = head_common_list;
506
507   printf_filtered (_("All COMMON blocks visible at this level:\n\n"));
508
509   while (tmp != NULL)
510     {
511       if (strcmp (tmp->owning_function, funname) == 0)
512         printf_filtered ("%s\n", tmp->name);
513
514       tmp = tmp->next;
515     }
516 }
517
518 /* This function is used to print out the values in a given COMMON 
519    block.  It will always use the most local common block of the 
520    given name.  */
521
522 static void
523 info_common_command (char *comname, int from_tty)
524 {
525   SAVED_F77_COMMON_PTR the_common;
526   COMMON_ENTRY_PTR entry;
527   struct frame_info *fi;
528   char *funname = 0;
529   struct symbol *func;
530
531   /* We have been told to display the contents of F77 COMMON 
532      block supposedly visible in this function.  Let us 
533      first make sure that it is visible and if so, let 
534      us display its contents.  */
535
536   fi = get_selected_frame (_("No frame selected"));
537
538   /* The following is generally ripped off from stack.c's routine 
539      print_frame_info().  */
540
541   func = find_pc_function (get_frame_pc (fi));
542   if (func)
543     {
544       /* In certain pathological cases, the symtabs give the wrong
545          function (when we are in the first function in a file which
546          is compiled without debugging symbols, the previous function
547          is compiled with debugging symbols, and the "foo.o" symbol
548          that is supposed to tell us where the file with debugging symbols
549          ends has been truncated by ar because it is longer than 15
550          characters).
551
552          So look in the minimal symbol tables as well, and if it comes
553          up with a larger address for the function use that instead.
554          I don't think this can ever cause any problems; there shouldn't
555          be any minimal symbols in the middle of a function.
556          FIXME:  (Not necessarily true.  What about text labels?)  */
557
558       struct minimal_symbol *msymbol = 
559         lookup_minimal_symbol_by_pc (get_frame_pc (fi));
560
561       if (msymbol != NULL
562           && (SYMBOL_VALUE_ADDRESS (msymbol)
563               > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
564         funname = SYMBOL_LINKAGE_NAME (msymbol);
565       else
566         funname = SYMBOL_LINKAGE_NAME (func);
567     }
568   else
569     {
570       struct minimal_symbol *msymbol =
571         lookup_minimal_symbol_by_pc (get_frame_pc (fi));
572
573       if (msymbol != NULL)
574         funname = SYMBOL_LINKAGE_NAME (msymbol);
575       else /* Got no 'funname', code below will fail.  */
576         error (_("No function found for frame."));
577     }
578
579   /* If comname is NULL, we assume the user wishes to see the 
580      which COMMON blocks are visible here and then return.  */
581
582   if (comname == 0)
583     {
584       list_all_visible_commons (funname);
585       return;
586     }
587
588   the_common = find_common_for_function (comname, funname);
589
590   if (the_common)
591     {
592       if (strcmp (comname, BLANK_COMMON_NAME_LOCAL) == 0)
593         printf_filtered (_("Contents of blank COMMON block:\n"));
594       else
595         printf_filtered (_("Contents of F77 COMMON block '%s':\n"), comname);
596
597       printf_filtered ("\n");
598       entry = the_common->entries;
599
600       while (entry != NULL)
601         {
602           print_variable_and_value (NULL, entry->symbol, fi, gdb_stdout, 0);
603           entry = entry->next;
604         }
605     }
606   else
607     printf_filtered (_("Cannot locate the common block %s in function '%s'\n"),
608                      comname, funname);
609 }
610
611 /* This function is used to determine whether there is a
612    F77 common block visible at the current scope called 'comname'.  */
613
614 #if 0
615 static int
616 there_is_a_visible_common_named (char *comname)
617 {
618   SAVED_F77_COMMON_PTR the_common;
619   struct frame_info *fi;
620   char *funname = 0;
621   struct symbol *func;
622
623   if (comname == NULL)
624     error (_("Cannot deal with NULL common name!"));
625
626   fi = get_selected_frame (_("No frame selected"));
627
628   /* The following is generally ripped off from stack.c's routine 
629      print_frame_info().  */
630
631   func = find_pc_function (fi->pc);
632   if (func)
633     {
634       /* In certain pathological cases, the symtabs give the wrong
635          function (when we are in the first function in a file which
636          is compiled without debugging symbols, the previous function
637          is compiled with debugging symbols, and the "foo.o" symbol
638          that is supposed to tell us where the file with debugging symbols
639          ends has been truncated by ar because it is longer than 15
640          characters).
641
642          So look in the minimal symbol tables as well, and if it comes
643          up with a larger address for the function use that instead.
644          I don't think this can ever cause any problems; there shouldn't
645          be any minimal symbols in the middle of a function.
646          FIXME:  (Not necessarily true.  What about text labels?)  */
647
648       struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (fi->pc);
649
650       if (msymbol != NULL
651           && (SYMBOL_VALUE_ADDRESS (msymbol)
652               > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
653         funname = SYMBOL_LINKAGE_NAME (msymbol);
654       else
655         funname = SYMBOL_LINKAGE_NAME (func);
656     }
657   else
658     {
659       struct minimal_symbol *msymbol =
660         lookup_minimal_symbol_by_pc (fi->pc);
661
662       if (msymbol != NULL)
663         funname = SYMBOL_LINKAGE_NAME (msymbol);
664     }
665
666   the_common = find_common_for_function (comname, funname);
667
668   return (the_common ? 1 : 0);
669 }
670 #endif
671
672 void
673 _initialize_f_valprint (void)
674 {
675   add_info ("common", info_common_command,
676             _("Print out the values contained in a Fortran COMMON block."));
677   if (xdb_commands)
678     add_com ("lc", class_info, info_common_command,
679              _("Print out the values contained in a Fortran COMMON block."));
680 }