Copyright updates for 2007.
[platform/upstream/binutils.git] / gdb / f-typeprint.c
1 /* Support for printing Fortran types for GDB, the GNU debugger.
2
3    Copyright (C) 1986, 1988, 1989, 1991, 1993, 1994, 1995, 1996, 1998, 2000,
4    2001, 2002, 2003, 2006, 2007 Free Software Foundation, Inc.
5
6    Contributed by Motorola.  Adapted from the C version by Farooq Butt
7    (fmbutt@engage.sps.mot.com).
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 2 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, write to the Free Software
23    Foundation, Inc., 51 Franklin Street, Fifth Floor,
24    Boston, MA 02110-1301, USA.  */
25
26 #include "defs.h"
27 #include "gdb_obstack.h"
28 #include "bfd.h"
29 #include "symtab.h"
30 #include "gdbtypes.h"
31 #include "expression.h"
32 #include "value.h"
33 #include "gdbcore.h"
34 #include "target.h"
35 #include "f-lang.h"
36
37 #include "gdb_string.h"
38 #include <errno.h>
39
40 #if 0                           /* Currently unused */
41 static void f_type_print_args (struct type *, struct ui_file *);
42 #endif
43
44 static void print_equivalent_f77_float_type (int level, struct type *,
45                                              struct ui_file *);
46
47 static void f_type_print_varspec_suffix (struct type *, struct ui_file *,
48                                          int, int, int);
49
50 void f_type_print_varspec_prefix (struct type *, struct ui_file *,
51                                   int, int);
52
53 void f_type_print_base (struct type *, struct ui_file *, int, int);
54 \f
55
56 /* LEVEL is the depth to indent lines by.  */
57
58 void
59 f_print_type (struct type *type, char *varstring, struct ui_file *stream,
60               int show, int level)
61 {
62   enum type_code code;
63   int demangled_args;
64
65   f_type_print_base (type, stream, show, level);
66   code = TYPE_CODE (type);
67   if ((varstring != NULL && *varstring != '\0')
68       ||
69   /* Need a space if going to print stars or brackets;
70      but not if we will print just a type name.  */
71       ((show > 0 || TYPE_NAME (type) == 0)
72        &&
73        (code == TYPE_CODE_PTR || code == TYPE_CODE_FUNC
74         || code == TYPE_CODE_METHOD
75         || code == TYPE_CODE_ARRAY
76         || code == TYPE_CODE_REF)))
77     fputs_filtered (" ", stream);
78   f_type_print_varspec_prefix (type, stream, show, 0);
79
80   fputs_filtered (varstring, stream);
81
82   /* For demangled function names, we have the arglist as part of the name,
83      so don't print an additional pair of ()'s */
84
85   demangled_args = varstring[strlen (varstring) - 1] == ')';
86   f_type_print_varspec_suffix (type, stream, show, 0, demangled_args);
87 }
88
89 /* Print any asterisks or open-parentheses needed before the
90    variable name (to describe its type).
91
92    On outermost call, pass 0 for PASSED_A_PTR.
93    On outermost call, SHOW > 0 means should ignore
94    any typename for TYPE and show its details.
95    SHOW is always zero on recursive calls.  */
96
97 void
98 f_type_print_varspec_prefix (struct type *type, struct ui_file *stream,
99                              int show, int passed_a_ptr)
100 {
101   if (type == 0)
102     return;
103
104   if (TYPE_NAME (type) && show <= 0)
105     return;
106
107   QUIT;
108
109   switch (TYPE_CODE (type))
110     {
111     case TYPE_CODE_PTR:
112       f_type_print_varspec_prefix (TYPE_TARGET_TYPE (type), stream, 0, 1);
113       break;
114
115     case TYPE_CODE_FUNC:
116       f_type_print_varspec_prefix (TYPE_TARGET_TYPE (type), stream, 0, 0);
117       if (passed_a_ptr)
118         fprintf_filtered (stream, "(");
119       break;
120
121     case TYPE_CODE_ARRAY:
122       f_type_print_varspec_prefix (TYPE_TARGET_TYPE (type), stream, 0, 0);
123       break;
124
125     case TYPE_CODE_UNDEF:
126     case TYPE_CODE_STRUCT:
127     case TYPE_CODE_UNION:
128     case TYPE_CODE_ENUM:
129     case TYPE_CODE_INT:
130     case TYPE_CODE_FLT:
131     case TYPE_CODE_VOID:
132     case TYPE_CODE_ERROR:
133     case TYPE_CODE_CHAR:
134     case TYPE_CODE_BOOL:
135     case TYPE_CODE_SET:
136     case TYPE_CODE_RANGE:
137     case TYPE_CODE_STRING:
138     case TYPE_CODE_BITSTRING:
139     case TYPE_CODE_METHOD:
140     case TYPE_CODE_REF:
141     case TYPE_CODE_COMPLEX:
142     case TYPE_CODE_TYPEDEF:
143       /* These types need no prefix.  They are listed here so that
144          gcc -Wall will reveal any types that haven't been handled.  */
145       break;
146     }
147 }
148
149 /* Print any array sizes, function arguments or close parentheses
150    needed after the variable name (to describe its type).
151    Args work like c_type_print_varspec_prefix.  */
152
153 static void
154 f_type_print_varspec_suffix (struct type *type, struct ui_file *stream,
155                              int show, int passed_a_ptr, int demangled_args)
156 {
157   int upper_bound, lower_bound;
158   int lower_bound_was_default = 0;
159   static int arrayprint_recurse_level = 0;
160   int retcode;
161
162   if (type == 0)
163     return;
164
165   if (TYPE_NAME (type) && show <= 0)
166     return;
167
168   QUIT;
169
170   switch (TYPE_CODE (type))
171     {
172     case TYPE_CODE_ARRAY:
173       arrayprint_recurse_level++;
174
175       if (arrayprint_recurse_level == 1)
176         fprintf_filtered (stream, "(");
177
178       if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_ARRAY)
179         f_type_print_varspec_suffix (TYPE_TARGET_TYPE (type), stream, 0, 0, 0);
180
181       retcode = f77_get_dynamic_lowerbound (type, &lower_bound);
182
183       lower_bound_was_default = 0;
184
185       if (retcode == BOUND_FETCH_ERROR)
186         fprintf_filtered (stream, "???");
187       else if (lower_bound == 1)        /* The default */
188         lower_bound_was_default = 1;
189       else
190         fprintf_filtered (stream, "%d", lower_bound);
191
192       if (lower_bound_was_default)
193         lower_bound_was_default = 0;
194       else
195         fprintf_filtered (stream, ":");
196
197       /* Make sure that, if we have an assumed size array, we
198          print out a warning and print the upperbound as '*' */
199
200       if (TYPE_ARRAY_UPPER_BOUND_TYPE (type) == BOUND_CANNOT_BE_DETERMINED)
201         fprintf_filtered (stream, "*");
202       else
203         {
204           retcode = f77_get_dynamic_upperbound (type, &upper_bound);
205
206           if (retcode == BOUND_FETCH_ERROR)
207             fprintf_filtered (stream, "???");
208           else
209             fprintf_filtered (stream, "%d", upper_bound);
210         }
211
212       if (TYPE_CODE (TYPE_TARGET_TYPE (type)) != TYPE_CODE_ARRAY)
213         f_type_print_varspec_suffix (TYPE_TARGET_TYPE (type), stream, 0, 0, 0);
214       if (arrayprint_recurse_level == 1)
215         fprintf_filtered (stream, ")");
216       else
217         fprintf_filtered (stream, ",");
218       arrayprint_recurse_level--;
219       break;
220
221     case TYPE_CODE_PTR:
222     case TYPE_CODE_REF:
223       f_type_print_varspec_suffix (TYPE_TARGET_TYPE (type), stream, 0, 1, 0);
224       fprintf_filtered (stream, ")");
225       break;
226
227     case TYPE_CODE_FUNC:
228       f_type_print_varspec_suffix (TYPE_TARGET_TYPE (type), stream, 0,
229                                    passed_a_ptr, 0);
230       if (passed_a_ptr)
231         fprintf_filtered (stream, ")");
232
233       fprintf_filtered (stream, "()");
234       break;
235
236     case TYPE_CODE_UNDEF:
237     case TYPE_CODE_STRUCT:
238     case TYPE_CODE_UNION:
239     case TYPE_CODE_ENUM:
240     case TYPE_CODE_INT:
241     case TYPE_CODE_FLT:
242     case TYPE_CODE_VOID:
243     case TYPE_CODE_ERROR:
244     case TYPE_CODE_CHAR:
245     case TYPE_CODE_BOOL:
246     case TYPE_CODE_SET:
247     case TYPE_CODE_RANGE:
248     case TYPE_CODE_STRING:
249     case TYPE_CODE_BITSTRING:
250     case TYPE_CODE_METHOD:
251     case TYPE_CODE_COMPLEX:
252     case TYPE_CODE_TYPEDEF:
253       /* These types do not need a suffix.  They are listed so that
254          gcc -Wall will report types that may not have been considered.  */
255       break;
256     }
257 }
258
259 static void
260 print_equivalent_f77_float_type (int level, struct type *type,
261                                  struct ui_file *stream)
262 {
263   /* Override type name "float" and make it the
264      appropriate real. XLC stupidly outputs -12 as a type
265      for real when it really should be outputting -18 */
266
267   fprintfi_filtered (level, stream, "real*%d", TYPE_LENGTH (type));
268 }
269
270 /* Print the name of the type (or the ultimate pointer target,
271    function value or array element), or the description of a
272    structure or union.
273
274    SHOW nonzero means don't print this type as just its name;
275    show its real definition even if it has a name.
276    SHOW zero means print just typename or struct tag if there is one
277    SHOW negative means abbreviate structure elements.
278    SHOW is decremented for printing of structure elements.
279
280    LEVEL is the depth to indent by.
281    We increase it for some recursive calls.  */
282
283 void
284 f_type_print_base (struct type *type, struct ui_file *stream, int show,
285                    int level)
286 {
287   int retcode;
288   int upper_bound;
289
290   int index;
291
292   QUIT;
293
294   wrap_here ("    ");
295   if (type == NULL)
296     {
297       fputs_filtered ("<type unknown>", stream);
298       return;
299     }
300
301   /* When SHOW is zero or less, and there is a valid type name, then always
302      just print the type name directly from the type. */
303
304   if ((show <= 0) && (TYPE_NAME (type) != NULL))
305     {
306       if (TYPE_CODE (type) == TYPE_CODE_FLT)
307         print_equivalent_f77_float_type (level, type, stream);
308       else
309         fputs_filtered (TYPE_NAME (type), stream);
310       return;
311     }
312
313   if (TYPE_CODE (type) != TYPE_CODE_TYPEDEF)
314     CHECK_TYPEDEF (type);
315
316   switch (TYPE_CODE (type))
317     {
318     case TYPE_CODE_TYPEDEF:
319       f_type_print_base (TYPE_TARGET_TYPE (type), stream, 0, level);
320       break;
321
322     case TYPE_CODE_ARRAY:
323     case TYPE_CODE_FUNC:
324       f_type_print_base (TYPE_TARGET_TYPE (type), stream, show, level);
325       break;
326
327     case TYPE_CODE_PTR:
328       fprintf_filtered (stream, "PTR TO -> ( ");
329       f_type_print_base (TYPE_TARGET_TYPE (type), stream, 0, level);
330       break;
331
332     case TYPE_CODE_REF:
333       fprintf_filtered (stream, "REF TO -> ( ");
334       f_type_print_base (TYPE_TARGET_TYPE (type), stream, 0, level);
335       break;
336
337     case TYPE_CODE_VOID:
338       fprintfi_filtered (level, stream, "VOID");
339       break;
340
341     case TYPE_CODE_UNDEF:
342       fprintfi_filtered (level, stream, "struct <unknown>");
343       break;
344
345     case TYPE_CODE_ERROR:
346       fprintfi_filtered (level, stream, "<unknown type>");
347       break;
348
349     case TYPE_CODE_RANGE:
350       /* This should not occur */
351       fprintfi_filtered (level, stream, "<range type>");
352       break;
353
354     case TYPE_CODE_CHAR:
355       /* Override name "char" and make it "character" */
356       fprintfi_filtered (level, stream, "character");
357       break;
358
359     case TYPE_CODE_INT:
360       /* There may be some character types that attempt to come
361          through as TYPE_CODE_INT since dbxstclass.h is so
362          C-oriented, we must change these to "character" from "char".  */
363
364       if (strcmp (TYPE_NAME (type), "char") == 0)
365         fprintfi_filtered (level, stream, "character");
366       else
367         goto default_case;
368       break;
369
370     case TYPE_CODE_COMPLEX:
371       fprintfi_filtered (level, stream, "complex*%d", TYPE_LENGTH (type));
372       break;
373
374     case TYPE_CODE_FLT:
375       print_equivalent_f77_float_type (level, type, stream);
376       break;
377
378     case TYPE_CODE_STRING:
379       /* Strings may have dynamic upperbounds (lengths) like arrays. */
380
381       if (TYPE_ARRAY_UPPER_BOUND_TYPE (type) == BOUND_CANNOT_BE_DETERMINED)
382         fprintfi_filtered (level, stream, "character*(*)");
383       else
384         {
385           retcode = f77_get_dynamic_upperbound (type, &upper_bound);
386
387           if (retcode == BOUND_FETCH_ERROR)
388             fprintf_filtered (stream, "character*???");
389           else
390             fprintf_filtered (stream, "character*%d", upper_bound);
391         }
392       break;
393
394     case TYPE_CODE_STRUCT:
395       fprintfi_filtered (level, stream, "Type ");
396       fputs_filtered (TYPE_TAG_NAME (type), stream);
397       fputs_filtered ("\n", stream);
398       for (index = 0; index < TYPE_NFIELDS (type); index++)
399         {
400           f_print_type (TYPE_FIELD_TYPE (type, index), "", stream, show, level + 4);
401           fputs_filtered (" :: ", stream);
402           fputs_filtered (TYPE_FIELD_NAME (type, index), stream);
403           fputs_filtered ("\n", stream);
404         } 
405       fprintfi_filtered (level, stream, "End Type ");
406       fputs_filtered (TYPE_TAG_NAME (type), stream);
407       break;
408
409     default_case:
410     default:
411       /* Handle types not explicitly handled by the other cases,
412          such as fundamental types.  For these, just print whatever
413          the type name is, as recorded in the type itself.  If there
414          is no type name, then complain. */
415       if (TYPE_NAME (type) != NULL)
416         fprintfi_filtered (level, stream, "%s", TYPE_NAME (type));
417       else
418         error (_("Invalid type code (%d) in symbol table."), TYPE_CODE (type));
419       break;
420     }
421 }