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"
38 extern void _initialize_f_valprint (void);
39 static void info_common_command (char *, int);
40 static void list_all_visible_commons (const char *);
41 static void f77_create_arrayprint_offset_tbl (struct type *,
43 static void f77_get_dynamic_length_of_aggregate (struct type *);
45 int f77_array_offset_tbl[MAX_FORTRAN_DIMS + 1][2];
47 /* Array which holds offsets to be applied to get a row's elements
48 for a given array. Array also holds the size of each subarray. */
50 /* The following macro gives us the size of the nth dimension, Where
53 #define F77_DIM_SIZE(n) (f77_array_offset_tbl[n][1])
55 /* The following gives us the offset for row n where n is 1-based. */
57 #define F77_DIM_OFFSET(n) (f77_array_offset_tbl[n][0])
60 f77_get_lowerbound (struct type *type)
62 if (TYPE_ARRAY_LOWER_BOUND_IS_UNDEFINED (type))
63 error (_("Lower bound may not be '*' in F77"));
65 return TYPE_ARRAY_LOWER_BOUND_VALUE (type);
69 f77_get_upperbound (struct type *type)
71 if (TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type))
73 /* We have an assumed size array on our hands. Assume that
74 upper_bound == lower_bound so that we show at least 1 element.
75 If the user wants to see more elements, let him manually ask for 'em
76 and we'll subscript the array and show him. */
78 return f77_get_lowerbound (type);
81 return TYPE_ARRAY_UPPER_BOUND_VALUE (type);
84 /* Obtain F77 adjustable array dimensions. */
87 f77_get_dynamic_length_of_aggregate (struct type *type)
92 /* Recursively go all the way down into a possibly multi-dimensional
93 F77 array and get the bounds. For simple arrays, this is pretty
94 easy but when the bounds are dynamic, we must be very careful
95 to add up all the lengths correctly. Not doing this right
96 will lead to horrendous-looking arrays in parameter lists.
98 This function also works for strings which behave very
99 similarly to arrays. */
101 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_ARRAY
102 || TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_STRING)
103 f77_get_dynamic_length_of_aggregate (TYPE_TARGET_TYPE (type));
105 /* Recursion ends here, start setting up lengths. */
106 lower_bound = f77_get_lowerbound (type);
107 upper_bound = f77_get_upperbound (type);
109 /* Patch in a valid length value. */
112 (upper_bound - lower_bound + 1)
113 * TYPE_LENGTH (check_typedef (TYPE_TARGET_TYPE (type)));
116 /* Function that sets up the array offset,size table for the array
120 f77_create_arrayprint_offset_tbl (struct type *type, struct ui_file *stream)
122 struct type *tmp_type;
129 while ((TYPE_CODE (tmp_type) == TYPE_CODE_ARRAY))
131 upper = f77_get_upperbound (tmp_type);
132 lower = f77_get_lowerbound (tmp_type);
134 F77_DIM_SIZE (ndimen) = upper - lower + 1;
136 tmp_type = TYPE_TARGET_TYPE (tmp_type);
140 /* Now we multiply eltlen by all the offsets, so that later we
141 can print out array elements correctly. Up till now we
142 know an offset to apply to get the item but we also
143 have to know how much to add to get to the next item. */
146 eltlen = TYPE_LENGTH (tmp_type);
147 F77_DIM_OFFSET (ndimen) = eltlen;
150 eltlen *= F77_DIM_SIZE (ndimen + 1);
151 F77_DIM_OFFSET (ndimen) = eltlen;
157 /* Actual function which prints out F77 arrays, Valaddr == address in
158 the superior. Address == the address in the inferior. */
161 f77_print_array_1 (int nss, int ndimensions, struct type *type,
162 const gdb_byte *valaddr,
163 int embedded_offset, CORE_ADDR address,
164 struct ui_file *stream, int recurse,
165 const struct value *val,
166 const struct value_print_options *options,
171 if (nss != ndimensions)
174 (i < F77_DIM_SIZE (nss) && (*elts) < options->print_max);
177 fprintf_filtered (stream, "( ");
178 f77_print_array_1 (nss + 1, ndimensions, TYPE_TARGET_TYPE (type),
180 embedded_offset + i * F77_DIM_OFFSET (nss),
182 stream, recurse, val, options, elts);
183 fprintf_filtered (stream, ") ");
185 if (*elts >= options->print_max && i < F77_DIM_SIZE (nss))
186 fprintf_filtered (stream, "...");
190 for (i = 0; i < F77_DIM_SIZE (nss) && (*elts) < options->print_max;
193 val_print (TYPE_TARGET_TYPE (type),
195 embedded_offset + i * F77_DIM_OFFSET (ndimensions),
196 address, stream, recurse,
197 val, options, current_language);
199 if (i != (F77_DIM_SIZE (nss) - 1))
200 fprintf_filtered (stream, ", ");
202 if ((*elts == options->print_max - 1)
203 && (i != (F77_DIM_SIZE (nss) - 1)))
204 fprintf_filtered (stream, "...");
209 /* This function gets called to print an F77 array, we set up some
210 stuff and then immediately call f77_print_array_1(). */
213 f77_print_array (struct type *type, const gdb_byte *valaddr,
215 CORE_ADDR address, struct ui_file *stream,
217 const struct value *val,
218 const struct value_print_options *options)
223 ndimensions = calc_f77_array_dims (type);
225 if (ndimensions > MAX_FORTRAN_DIMS || ndimensions < 0)
227 Type node corrupt! F77 arrays cannot have %d subscripts (%d Max)"),
228 ndimensions, MAX_FORTRAN_DIMS);
230 /* Since F77 arrays are stored column-major, we set up an
231 offset table to get at the various row's elements. The
232 offset table contains entries for both offset and subarray size. */
234 f77_create_arrayprint_offset_tbl (type, stream);
236 f77_print_array_1 (1, ndimensions, type, valaddr, embedded_offset,
237 address, stream, recurse, val, options, &elts);
241 /* Decorations for Fortran. */
243 static const struct generic_val_print_decorations f_decorations =
253 /* See val_print for a description of the various parameters of this
254 function; they are identical. */
257 f_val_print (struct type *type, const gdb_byte *valaddr, int embedded_offset,
258 CORE_ADDR address, struct ui_file *stream, int recurse,
259 const struct value *original_value,
260 const struct value_print_options *options)
262 struct gdbarch *gdbarch = get_type_arch (type);
263 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
264 unsigned int i = 0; /* Number of characters printed. */
265 struct type *elttype;
269 CHECK_TYPEDEF (type);
270 switch (TYPE_CODE (type))
272 case TYPE_CODE_STRING:
273 f77_get_dynamic_length_of_aggregate (type);
274 LA_PRINT_STRING (stream, builtin_type (gdbarch)->builtin_char,
275 valaddr + embedded_offset,
276 TYPE_LENGTH (type), NULL, 0, options);
279 case TYPE_CODE_ARRAY:
280 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) != TYPE_CODE_CHAR)
282 fprintf_filtered (stream, "(");
283 f77_print_array (type, valaddr, embedded_offset,
284 address, stream, recurse, original_value, options);
285 fprintf_filtered (stream, ")");
289 struct type *ch_type = TYPE_TARGET_TYPE (type);
291 f77_get_dynamic_length_of_aggregate (type);
292 LA_PRINT_STRING (stream, ch_type,
293 valaddr + embedded_offset,
294 TYPE_LENGTH (type) / TYPE_LENGTH (ch_type),
300 if (options->format && options->format != 's')
302 val_print_scalar_formatted (type, valaddr, embedded_offset,
303 original_value, options, 0, stream);
310 addr = unpack_pointer (type, valaddr + embedded_offset);
311 elttype = check_typedef (TYPE_TARGET_TYPE (type));
313 if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
315 /* Try to print what function it points to. */
316 print_function_pointer_address (options, gdbarch, addr, stream);
320 if (options->symbol_print)
321 want_space = print_address_demangle (options, gdbarch, addr,
323 else if (options->addressprint && options->format != 's')
325 fputs_filtered (paddress (gdbarch, addr), stream);
329 /* For a pointer to char or unsigned char, also print the string
330 pointed to, unless pointer is null. */
331 if (TYPE_LENGTH (elttype) == 1
332 && TYPE_CODE (elttype) == TYPE_CODE_INT
333 && (options->format == 0 || options->format == 's')
337 fputs_filtered (" ", stream);
338 i = val_print_string (TYPE_TARGET_TYPE (type), NULL, addr, -1,
346 if (options->format || options->output_format)
348 struct value_print_options opts = *options;
350 opts.format = (options->format ? options->format
351 : options->output_format);
352 val_print_scalar_formatted (type, valaddr, embedded_offset,
353 original_value, options, 0, stream);
357 val_print_type_code_int (type, valaddr + embedded_offset, stream);
358 /* C and C++ has no single byte int type, char is used instead.
359 Since we don't know whether the value is really intended to
360 be used as an integer or a character, print the character
361 equivalent as well. */
362 if (TYPE_LENGTH (type) == 1)
366 fputs_filtered (" ", stream);
367 c = unpack_long (type, valaddr + embedded_offset);
368 LA_PRINT_CHAR ((unsigned char) c, type, stream);
373 case TYPE_CODE_STRUCT:
374 case TYPE_CODE_UNION:
375 /* Starting from the Fortran 90 standard, Fortran supports derived
377 fprintf_filtered (stream, "( ");
378 for (index = 0; index < TYPE_NFIELDS (type); index++)
380 int offset = TYPE_FIELD_BITPOS (type, index) / 8;
382 val_print (TYPE_FIELD_TYPE (type, index), valaddr,
383 embedded_offset + offset,
384 address, stream, recurse + 1,
385 original_value, options, current_language);
386 if (index != TYPE_NFIELDS (type) - 1)
387 fputs_filtered (", ", stream);
389 fprintf_filtered (stream, " )");
394 case TYPE_CODE_FLAGS:
397 case TYPE_CODE_ERROR:
398 case TYPE_CODE_RANGE:
399 case TYPE_CODE_UNDEF:
400 case TYPE_CODE_COMPLEX:
404 generic_val_print (type, valaddr, embedded_offset, address,
405 stream, recurse, original_value, options,
413 list_all_visible_commons (const char *funname)
415 SAVED_F77_COMMON_PTR tmp;
417 tmp = head_common_list;
419 printf_filtered (_("All COMMON blocks visible at this level:\n\n"));
423 if (strcmp (tmp->owning_function, funname) == 0)
424 printf_filtered ("%s\n", tmp->name);
430 /* This function is used to print out the values in a given COMMON
431 block. It will always use the most local common block of the
435 info_common_command (char *comname, int from_tty)
437 SAVED_F77_COMMON_PTR the_common;
438 COMMON_ENTRY_PTR entry;
439 struct frame_info *fi;
440 const char *funname = 0;
443 /* We have been told to display the contents of F77 COMMON
444 block supposedly visible in this function. Let us
445 first make sure that it is visible and if so, let
446 us display its contents. */
448 fi = get_selected_frame (_("No frame selected"));
450 /* The following is generally ripped off from stack.c's routine
451 print_frame_info(). */
453 func = find_pc_function (get_frame_pc (fi));
456 /* In certain pathological cases, the symtabs give the wrong
457 function (when we are in the first function in a file which
458 is compiled without debugging symbols, the previous function
459 is compiled with debugging symbols, and the "foo.o" symbol
460 that is supposed to tell us where the file with debugging symbols
461 ends has been truncated by ar because it is longer than 15
464 So look in the minimal symbol tables as well, and if it comes
465 up with a larger address for the function use that instead.
466 I don't think this can ever cause any problems; there shouldn't
467 be any minimal symbols in the middle of a function.
468 FIXME: (Not necessarily true. What about text labels?) */
470 struct minimal_symbol *msymbol =
471 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
474 && (SYMBOL_VALUE_ADDRESS (msymbol)
475 > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
476 funname = SYMBOL_LINKAGE_NAME (msymbol);
478 funname = SYMBOL_LINKAGE_NAME (func);
482 struct minimal_symbol *msymbol =
483 lookup_minimal_symbol_by_pc (get_frame_pc (fi));
486 funname = SYMBOL_LINKAGE_NAME (msymbol);
487 else /* Got no 'funname', code below will fail. */
488 error (_("No function found for frame."));
491 /* If comname is NULL, we assume the user wishes to see the
492 which COMMON blocks are visible here and then return. */
496 list_all_visible_commons (funname);
500 the_common = find_common_for_function (comname, funname);
504 struct frame_id frame_id = get_frame_id (fi);
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 fi = frame_find_by_id (frame_id);
519 warning (_("Unable to restore previously selected frame."));
523 print_variable_and_value (NULL, entry->symbol, fi, gdb_stdout, 0);
525 /* print_variable_and_value invalidates FI. */
532 printf_filtered (_("Cannot locate the common block %s in function '%s'\n"),
537 _initialize_f_valprint (void)
539 add_info ("common", info_common_command,
540 _("Print out the values contained in a Fortran COMMON block."));
542 add_com ("lc", class_info, info_common_command,
543 _("Print out the values contained in a Fortran COMMON block."));