1 /* Support for printing Fortran values for GDB, the GNU debugger.
3 Copyright (C) 1993-1996, 1998-2000, 2003, 2005-2012 Free Software
6 Contributed by Motorola. Adapted from the C definitions by Farooq Butt
7 (fmbutt@engage.sps.mot.com), additionally worked over by Stan Shebs.
9 This file is part of GDB.
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.
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.
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/>. */
25 #include "gdb_string.h"
28 #include "expression.h"
39 static int there_is_a_visible_common_named (char *);
42 extern void _initialize_f_valprint (void);
43 static void info_common_command (char *, int);
44 static void list_all_visible_commons (const char *);
45 static void f77_create_arrayprint_offset_tbl (struct type *,
47 static void f77_get_dynamic_length_of_aggregate (struct type *);
49 int f77_array_offset_tbl[MAX_FORTRAN_DIMS + 1][2];
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. */
54 /* The following macro gives us the size of the nth dimension, Where
57 #define F77_DIM_SIZE(n) (f77_array_offset_tbl[n][1])
59 /* The following gives us the offset for row n where n is 1-based. */
61 #define F77_DIM_OFFSET(n) (f77_array_offset_tbl[n][0])
64 f77_get_lowerbound (struct type *type)
66 if (TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED (type))
67 error (_("Lower bound may not be '*' in F77"));
69 return TYPE_ARRAY_LOWER_BOUND_VALUE (type);
73 f77_get_upperbound (struct type *type)
75 if (TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type))
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. */
82 return f77_get_lowerbound (type);
85 return TYPE_ARRAY_UPPER_BOUND_VALUE (type);
88 /* Obtain F77 adjustable array dimensions. */
91 f77_get_dynamic_length_of_aggregate (struct type *type)
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.
102 This function also works for strings which behave very
103 similarly to arrays. */
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));
109 /* Recursion ends here, start setting up lengths. */
110 lower_bound = f77_get_lowerbound (type);
111 upper_bound = f77_get_upperbound (type);
113 /* Patch in a valid length value. */
116 (upper_bound - lower_bound + 1)
117 * TYPE_LENGTH (check_typedef (TYPE_TARGET_TYPE (type)));
120 /* Function that sets up the array offset,size table for the array
124 f77_create_arrayprint_offset_tbl (struct type *type, struct ui_file *stream)
126 struct type *tmp_type;
133 while ((TYPE_CODE (tmp_type) == TYPE_CODE_ARRAY))
135 upper = f77_get_upperbound (tmp_type);
136 lower = f77_get_lowerbound (tmp_type);
138 F77_DIM_SIZE (ndimen) = upper - lower + 1;
140 tmp_type = TYPE_TARGET_TYPE (tmp_type);
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. */
150 eltlen = TYPE_LENGTH (tmp_type);
151 F77_DIM_OFFSET (ndimen) = eltlen;
154 eltlen *= F77_DIM_SIZE (ndimen + 1);
155 F77_DIM_OFFSET (ndimen) = eltlen;
161 /* Actual function which prints out F77 arrays, Valaddr == address in
162 the superior. Address == the address in the inferior. */
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,
175 if (nss != ndimensions)
178 (i < F77_DIM_SIZE (nss) && (*elts) < options->print_max);
181 fprintf_filtered (stream, "( ");
182 f77_print_array_1 (nss + 1, ndimensions, TYPE_TARGET_TYPE (type),
184 embedded_offset + i * F77_DIM_OFFSET (nss),
186 stream, recurse, val, options, elts);
187 fprintf_filtered (stream, ") ");
189 if (*elts >= options->print_max && i < F77_DIM_SIZE (nss))
190 fprintf_filtered (stream, "...");
194 for (i = 0; i < F77_DIM_SIZE (nss) && (*elts) < options->print_max;
197 val_print (TYPE_TARGET_TYPE (type),
199 embedded_offset + i * F77_DIM_OFFSET (ndimensions),
200 address, stream, recurse,
201 val, options, current_language);
203 if (i != (F77_DIM_SIZE (nss) - 1))
204 fprintf_filtered (stream, ", ");
206 if ((*elts == options->print_max - 1)
207 && (i != (F77_DIM_SIZE (nss) - 1)))
208 fprintf_filtered (stream, "...");
213 /* This function gets called to print an F77 array, we set up some
214 stuff and then immediately call f77_print_array_1(). */
217 f77_print_array (struct type *type, const gdb_byte *valaddr,
219 CORE_ADDR address, struct ui_file *stream,
221 const struct value *val,
222 const struct value_print_options *options)
227 ndimensions = calc_f77_array_dims (type);
229 if (ndimensions > MAX_FORTRAN_DIMS || ndimensions < 0)
231 Type node corrupt! F77 arrays cannot have %d subscripts (%d Max)"),
232 ndimensions, MAX_FORTRAN_DIMS);
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. */
238 f77_create_arrayprint_offset_tbl (type, stream);
240 f77_print_array_1 (1, ndimensions, type, valaddr, embedded_offset,
241 address, stream, recurse, val, options, &elts);
245 /* Decorations for Fortran. */
247 static const struct generic_val_print_decorations f_decorations =
257 /* See val_print for a description of the various parameters of this
258 function; they are identical. */
261 f_val_print (struct type *type, const gdb_byte *valaddr, int embedded_offset,
262 CORE_ADDR address, struct ui_file *stream, int recurse,
263 const struct value *original_value,
264 const struct value_print_options *options)
266 struct gdbarch *gdbarch = get_type_arch (type);
267 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
268 unsigned int i = 0; /* Number of characters printed. */
269 struct type *elttype;
274 CHECK_TYPEDEF (type);
275 switch (TYPE_CODE (type))
277 case TYPE_CODE_STRING:
278 f77_get_dynamic_length_of_aggregate (type);
279 LA_PRINT_STRING (stream, builtin_type (gdbarch)->builtin_char,
280 valaddr + embedded_offset,
281 TYPE_LENGTH (type), NULL, 0, options);
284 case TYPE_CODE_ARRAY:
285 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) != TYPE_CODE_CHAR)
287 fprintf_filtered (stream, "(");
288 f77_print_array (type, valaddr, embedded_offset,
289 address, stream, recurse, original_value, options);
290 fprintf_filtered (stream, ")");
294 struct type *ch_type = TYPE_TARGET_TYPE (type);
296 f77_get_dynamic_length_of_aggregate (type);
297 LA_PRINT_STRING (stream, ch_type,
298 valaddr + embedded_offset,
299 TYPE_LENGTH (type) / TYPE_LENGTH (ch_type),
305 if (options->format && options->format != 's')
307 val_print_scalar_formatted (type, valaddr, embedded_offset,
308 original_value, options, 0, stream);
315 addr = unpack_pointer (type, valaddr + embedded_offset);
316 elttype = check_typedef (TYPE_TARGET_TYPE (type));
318 if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
320 /* Try to print what function it points to. */
321 print_function_pointer_address (options, gdbarch, addr, stream);
325 if (options->addressprint && options->format != 's')
327 fputs_filtered (paddress (gdbarch, addr), stream);
331 /* For a pointer to char or unsigned char, also print the string
332 pointed to, unless pointer is null. */
333 if (TYPE_LENGTH (elttype) == 1
334 && TYPE_CODE (elttype) == TYPE_CODE_INT
335 && (options->format == 0 || options->format == 's')
339 fputs_filtered (" ", stream);
340 i = val_print_string (TYPE_TARGET_TYPE (type), NULL, addr, -1,
348 if (options->format || options->output_format)
350 struct value_print_options opts = *options;
352 opts.format = (options->format ? options->format
353 : options->output_format);
354 val_print_scalar_formatted (type, valaddr, embedded_offset,
355 original_value, options, 0, stream);
359 val_print_type_code_int (type, valaddr + embedded_offset, stream);
360 /* C and C++ has no single byte int type, char is used instead.
361 Since we don't know whether the value is really intended to
362 be used as an integer or a character, print the character
363 equivalent as well. */
364 if (TYPE_LENGTH (type) == 1)
368 fputs_filtered (" ", stream);
369 c = unpack_long (type, valaddr + embedded_offset);
370 LA_PRINT_CHAR ((unsigned char) c, type, stream);
375 case TYPE_CODE_STRUCT:
376 case TYPE_CODE_UNION:
377 /* Starting from the Fortran 90 standard, Fortran supports derived
379 fprintf_filtered (stream, "( ");
380 for (index = 0; index < TYPE_NFIELDS (type); index++)
382 int offset = TYPE_FIELD_BITPOS (type, index) / 8;
384 val_print (TYPE_FIELD_TYPE (type, index), valaddr,
385 embedded_offset + offset,
386 address, stream, recurse + 1,
387 original_value, options, current_language);
388 if (index != TYPE_NFIELDS (type) - 1)
389 fputs_filtered (", ", stream);
391 fprintf_filtered (stream, " )");
396 case TYPE_CODE_FLAGS:
399 case TYPE_CODE_ERROR:
400 case TYPE_CODE_RANGE:
401 case TYPE_CODE_UNDEF:
402 case TYPE_CODE_COMPLEX:
406 generic_val_print (type, valaddr, embedded_offset, address,
407 stream, recurse, original_value, options,
415 list_all_visible_commons (const char *funname)
417 SAVED_F77_COMMON_PTR tmp;
419 tmp = head_common_list;
421 printf_filtered (_("All COMMON blocks visible at this level:\n\n"));
425 if (strcmp (tmp->owning_function, funname) == 0)
426 printf_filtered ("%s\n", tmp->name);
432 /* This function is used to print out the values in a given COMMON
433 block. It will always use the most local common block of the
437 info_common_command (char *comname, int from_tty)
439 SAVED_F77_COMMON_PTR the_common;
440 COMMON_ENTRY_PTR entry;
441 struct frame_info *fi;
442 const char *funname = 0;
445 /* We have been told to display the contents of F77 COMMON
446 block supposedly visible in this function. Let us
447 first make sure that it is visible and if so, let
448 us display its contents. */
450 fi = get_selected_frame (_("No frame selected"));
452 /* The following is generally ripped off from stack.c's routine
453 print_frame_info(). */
455 func = find_pc_function (get_frame_pc (fi));
458 /* In certain pathological cases, the symtabs give the wrong
459 function (when we are in the first function in a file which
460 is compiled without debugging symbols, the previous function
461 is compiled with debugging symbols, and the "foo.o" symbol
462 that is supposed to tell us where the file with debugging symbols
463 ends has been truncated by ar because it is longer than 15
466 So look in the minimal symbol tables as well, and if it comes
467 up with a larger address for the function use that instead.
468 I don't think this can ever cause any problems; there shouldn't
469 be any minimal symbols in the middle of a function.
470 FIXME: (Not necessarily true. What about text labels?) */
472 struct minimal_symbol *msymbol =
473 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
476 && (SYMBOL_VALUE_ADDRESS (msymbol)
477 > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
478 funname = SYMBOL_LINKAGE_NAME (msymbol);
480 funname = SYMBOL_LINKAGE_NAME (func);
484 struct minimal_symbol *msymbol =
485 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
488 funname = SYMBOL_LINKAGE_NAME (msymbol);
489 else /* Got no 'funname', code below will fail. */
490 error (_("No function found for frame."));
493 /* If comname is NULL, we assume the user wishes to see the
494 which COMMON blocks are visible here and then return. */
498 list_all_visible_commons (funname);
502 the_common = find_common_for_function (comname, funname);
506 if (strcmp (comname, BLANK_COMMON_NAME_LOCAL) == 0)
507 printf_filtered (_("Contents of blank COMMON block:\n"));
509 printf_filtered (_("Contents of F77 COMMON block '%s':\n"), comname);
511 printf_filtered ("\n");
512 entry = the_common->entries;
514 while (entry != NULL)
516 print_variable_and_value (NULL, entry->symbol, fi, gdb_stdout, 0);
521 printf_filtered (_("Cannot locate the common block %s in function '%s'\n"),
525 /* This function is used to determine whether there is a
526 F77 common block visible at the current scope called 'comname'. */
530 there_is_a_visible_common_named (char *comname)
532 SAVED_F77_COMMON_PTR the_common;
533 struct frame_info *fi;
538 error (_("Cannot deal with NULL common name!"));
540 fi = get_selected_frame (_("No frame selected"));
542 /* The following is generally ripped off from stack.c's routine
543 print_frame_info(). */
545 func = find_pc_function (fi->pc);
548 /* In certain pathological cases, the symtabs give the wrong
549 function (when we are in the first function in a file which
550 is compiled without debugging symbols, the previous function
551 is compiled with debugging symbols, and the "foo.o" symbol
552 that is supposed to tell us where the file with debugging symbols
553 ends has been truncated by ar because it is longer than 15
556 So look in the minimal symbol tables as well, and if it comes
557 up with a larger address for the function use that instead.
558 I don't think this can ever cause any problems; there shouldn't
559 be any minimal symbols in the middle of a function.
560 FIXME: (Not necessarily true. What about text labels?) */
562 struct minimal_symbol *msymbol = lookup_minimal_symbol_by_pc (fi->pc);
565 && (SYMBOL_VALUE_ADDRESS (msymbol)
566 > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
567 funname = SYMBOL_LINKAGE_NAME (msymbol);
569 funname = SYMBOL_LINKAGE_NAME (func);
573 struct minimal_symbol *msymbol =
574 lookup_minimal_symbol_by_pc (fi->pc);
577 funname = SYMBOL_LINKAGE_NAME (msymbol);
580 the_common = find_common_for_function (comname, funname);
582 return (the_common ? 1 : 0);
587 _initialize_f_valprint (void)
589 add_info ("common", info_common_command,
590 _("Print out the values contained in a Fortran COMMON block."));
592 add_com ("lc", class_info, info_common_command,
593 _("Print out the values contained in a Fortran COMMON block."));