xref: /dragonfly/contrib/gdb-7/gdb/p-lang.c (revision 8accc937)
1 /* Pascal language support routines for GDB, the GNU debugger.
2 
3    Copyright (C) 2000, 2002-2005, 2007-2012 Free Software Foundation,
4    Inc.
5 
6    This file is part of GDB.
7 
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12 
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17 
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20 
21 /* This file is derived from c-lang.c */
22 
23 #include "defs.h"
24 #include "gdb_string.h"
25 #include "symtab.h"
26 #include "gdbtypes.h"
27 #include "expression.h"
28 #include "parser-defs.h"
29 #include "language.h"
30 #include "p-lang.h"
31 #include "valprint.h"
32 #include "value.h"
33 #include <ctype.h>
34 
35 extern void _initialize_pascal_language (void);
36 
37 
38 /* All GPC versions until now (2007-09-27) also define a symbol called
39    '_p_initialize'.  Check for the presence of this symbol first.  */
40 static const char GPC_P_INITIALIZE[] = "_p_initialize";
41 
42 /* The name of the symbol that GPC uses as the name of the main
43    procedure (since version 20050212).  */
44 static const char GPC_MAIN_PROGRAM_NAME_1[] = "_p__M0_main_program";
45 
46 /* Older versions of GPC (versions older than 20050212) were using
47    a different name for the main procedure.  */
48 static const char GPC_MAIN_PROGRAM_NAME_2[] = "pascal_main_program";
49 
50 /* Function returning the special symbol name used
51    by GPC for the main procedure in the main program
52    if it is found in minimal symbol list.
53    This function tries to find minimal symbols generated by GPC
54    so that it finds the even if the program was compiled
55    without debugging information.
56    According to information supplied by Waldeck Hebisch,
57    this should work for all versions posterior to June 2000.  */
58 
59 const char *
60 pascal_main_name (void)
61 {
62   struct minimal_symbol *msym;
63 
64   msym = lookup_minimal_symbol (GPC_P_INITIALIZE, NULL, NULL);
65 
66   /*  If '_p_initialize' was not found, the main program is likely not
67      written in Pascal.  */
68   if (msym == NULL)
69     return NULL;
70 
71   msym = lookup_minimal_symbol (GPC_MAIN_PROGRAM_NAME_1, NULL, NULL);
72   if (msym != NULL)
73     {
74       return GPC_MAIN_PROGRAM_NAME_1;
75     }
76 
77   msym = lookup_minimal_symbol (GPC_MAIN_PROGRAM_NAME_2, NULL, NULL);
78   if (msym != NULL)
79     {
80       return GPC_MAIN_PROGRAM_NAME_2;
81     }
82 
83   /*  No known entry procedure found, the main program is probably
84       not compiled with GPC.  */
85   return NULL;
86 }
87 
88 /* Determines if type TYPE is a pascal string type.
89    Returns a positive value if the type is a known pascal string type.
90    This function is used by p-valprint.c code to allow better string display.
91    If it is a pascal string type, then it also sets info needed
92    to get the length and the data of the string
93    length_pos, length_size and string_pos are given in bytes.
94    char_size gives the element size in bytes.
95    FIXME: if the position or the size of these fields
96    are not multiple of TARGET_CHAR_BIT then the results are wrong
97    but this does not happen for Free Pascal nor for GPC.  */
98 int
99 is_pascal_string_type (struct type *type,int *length_pos,
100                        int *length_size, int *string_pos,
101 		       struct type **char_type,
102 		       char **arrayname)
103 {
104   if (type != NULL && TYPE_CODE (type) == TYPE_CODE_STRUCT)
105     {
106       /* Old Borland type pascal strings from Free Pascal Compiler.  */
107       /* Two fields: length and st.  */
108       if (TYPE_NFIELDS (type) == 2
109 	  && TYPE_FIELD_NAME (type, 0)
110 	  && strcmp (TYPE_FIELD_NAME (type, 0), "length") == 0
111 	  && TYPE_FIELD_NAME (type, 1)
112 	  && strcmp (TYPE_FIELD_NAME (type, 1), "st") == 0)
113         {
114           if (length_pos)
115 	    *length_pos = TYPE_FIELD_BITPOS (type, 0) / TARGET_CHAR_BIT;
116           if (length_size)
117 	    *length_size = TYPE_LENGTH (TYPE_FIELD_TYPE (type, 0));
118           if (string_pos)
119 	    *string_pos = TYPE_FIELD_BITPOS (type, 1) / TARGET_CHAR_BIT;
120           if (char_type)
121 	    *char_type = TYPE_TARGET_TYPE (TYPE_FIELD_TYPE (type, 1));
122  	  if (arrayname)
123 	    *arrayname = TYPE_FIELD_NAME (type, 1);
124          return 2;
125         };
126       /* GNU pascal strings.  */
127       /* Three fields: Capacity, length and schema$ or _p_schema.  */
128       if (TYPE_NFIELDS (type) == 3
129 	  && TYPE_FIELD_NAME (type, 0)
130 	  && strcmp (TYPE_FIELD_NAME (type, 0), "Capacity") == 0
131 	  && TYPE_FIELD_NAME (type, 1)
132 	  && strcmp (TYPE_FIELD_NAME (type, 1), "length") == 0)
133         {
134 	  if (length_pos)
135 	    *length_pos = TYPE_FIELD_BITPOS (type, 1) / TARGET_CHAR_BIT;
136 	  if (length_size)
137 	    *length_size = TYPE_LENGTH (TYPE_FIELD_TYPE (type, 1));
138 	  if (string_pos)
139 	    *string_pos = TYPE_FIELD_BITPOS (type, 2) / TARGET_CHAR_BIT;
140           /* FIXME: how can I detect wide chars in GPC ??  */
141           if (char_type)
142 	    {
143 	      *char_type = TYPE_TARGET_TYPE (TYPE_FIELD_TYPE (type, 2));
144 
145 	      if (TYPE_CODE (*char_type) == TYPE_CODE_ARRAY)
146 		*char_type = TYPE_TARGET_TYPE (*char_type);
147 	    }
148  	  if (arrayname)
149 	    *arrayname = TYPE_FIELD_NAME (type, 2);
150          return 3;
151         };
152     }
153   return 0;
154 }
155 
156 static void pascal_one_char (int, struct ui_file *, int *);
157 
158 /* Print the character C on STREAM as part of the contents of a literal
159    string.
160    In_quotes is reset to 0 if a char is written with #4 notation.  */
161 
162 static void
163 pascal_one_char (int c, struct ui_file *stream, int *in_quotes)
164 {
165   if (c == '\'' || ((unsigned int) c <= 0xff && (PRINT_LITERAL_FORM (c))))
166     {
167       if (!(*in_quotes))
168 	fputs_filtered ("'", stream);
169       *in_quotes = 1;
170       if (c == '\'')
171 	{
172 	  fputs_filtered ("''", stream);
173 	}
174       else
175 	fprintf_filtered (stream, "%c", c);
176     }
177   else
178     {
179       if (*in_quotes)
180 	fputs_filtered ("'", stream);
181       *in_quotes = 0;
182       fprintf_filtered (stream, "#%d", (unsigned int) c);
183     }
184 }
185 
186 static void pascal_emit_char (int c, struct type *type,
187 			      struct ui_file *stream, int quoter);
188 
189 /* Print the character C on STREAM as part of the contents of a literal
190    string whose delimiter is QUOTER.  Note that that format for printing
191    characters and strings is language specific.  */
192 
193 static void
194 pascal_emit_char (int c, struct type *type, struct ui_file *stream, int quoter)
195 {
196   int in_quotes = 0;
197 
198   pascal_one_char (c, stream, &in_quotes);
199   if (in_quotes)
200     fputs_filtered ("'", stream);
201 }
202 
203 void
204 pascal_printchar (int c, struct type *type, struct ui_file *stream)
205 {
206   int in_quotes = 0;
207 
208   pascal_one_char (c, stream, &in_quotes);
209   if (in_quotes)
210     fputs_filtered ("'", stream);
211 }
212 
213 /* Print the character string STRING, printing at most LENGTH characters.
214    Printing stops early if the number hits print_max; repeat counts
215    are printed as appropriate.  Print ellipses at the end if we
216    had to stop before printing LENGTH characters, or if FORCE_ELLIPSES.  */
217 
218 void
219 pascal_printstr (struct ui_file *stream, struct type *type,
220 		 const gdb_byte *string, unsigned int length,
221 		 const char *encoding, int force_ellipses,
222 		 const struct value_print_options *options)
223 {
224   enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
225   unsigned int i;
226   unsigned int things_printed = 0;
227   int in_quotes = 0;
228   int need_comma = 0;
229   int width;
230 
231   /* Preserve TYPE's original type, just set its LENGTH.  */
232   check_typedef (type);
233   width = TYPE_LENGTH (type);
234 
235   /* If the string was not truncated due to `set print elements', and
236      the last byte of it is a null, we don't print that, in traditional C
237      style.  */
238   if ((!force_ellipses) && length > 0
239 	&& extract_unsigned_integer (string + (length - 1) * width, width,
240 				     byte_order) == 0)
241     length--;
242 
243   if (length == 0)
244     {
245       fputs_filtered ("''", stream);
246       return;
247     }
248 
249   for (i = 0; i < length && things_printed < options->print_max; ++i)
250     {
251       /* Position of the character we are examining
252          to see whether it is repeated.  */
253       unsigned int rep1;
254       /* Number of repetitions we have detected so far.  */
255       unsigned int reps;
256       unsigned long int current_char;
257 
258       QUIT;
259 
260       if (need_comma)
261 	{
262 	  fputs_filtered (", ", stream);
263 	  need_comma = 0;
264 	}
265 
266       current_char = extract_unsigned_integer (string + i * width, width,
267 					       byte_order);
268 
269       rep1 = i + 1;
270       reps = 1;
271       while (rep1 < length
272 	     && extract_unsigned_integer (string + rep1 * width, width,
273 					  byte_order) == current_char)
274 	{
275 	  ++rep1;
276 	  ++reps;
277 	}
278 
279       if (reps > options->repeat_count_threshold)
280 	{
281 	  if (in_quotes)
282 	    {
283 	      if (options->inspect_it)
284 		fputs_filtered ("\\', ", stream);
285 	      else
286 		fputs_filtered ("', ", stream);
287 	      in_quotes = 0;
288 	    }
289 	  pascal_printchar (current_char, type, stream);
290 	  fprintf_filtered (stream, " <repeats %u times>", reps);
291 	  i = rep1 - 1;
292 	  things_printed += options->repeat_count_threshold;
293 	  need_comma = 1;
294 	}
295       else
296 	{
297 	  if ((!in_quotes) && (PRINT_LITERAL_FORM (current_char)))
298 	    {
299 	      if (options->inspect_it)
300 		fputs_filtered ("\\'", stream);
301 	      else
302 		fputs_filtered ("'", stream);
303 	      in_quotes = 1;
304 	    }
305 	  pascal_one_char (current_char, stream, &in_quotes);
306 	  ++things_printed;
307 	}
308     }
309 
310   /* Terminate the quotes if necessary.  */
311   if (in_quotes)
312     {
313       if (options->inspect_it)
314 	fputs_filtered ("\\'", stream);
315       else
316 	fputs_filtered ("'", stream);
317     }
318 
319   if (force_ellipses || i < length)
320     fputs_filtered ("...", stream);
321 }
322 
323 
324 /* Table mapping opcodes into strings for printing operators
325    and precedences of the operators.  */
326 
327 const struct op_print pascal_op_print_tab[] =
328 {
329   {",", BINOP_COMMA, PREC_COMMA, 0},
330   {":=", BINOP_ASSIGN, PREC_ASSIGN, 1},
331   {"or", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
332   {"xor", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
333   {"and", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
334   {"=", BINOP_EQUAL, PREC_EQUAL, 0},
335   {"<>", BINOP_NOTEQUAL, PREC_EQUAL, 0},
336   {"<=", BINOP_LEQ, PREC_ORDER, 0},
337   {">=", BINOP_GEQ, PREC_ORDER, 0},
338   {">", BINOP_GTR, PREC_ORDER, 0},
339   {"<", BINOP_LESS, PREC_ORDER, 0},
340   {"shr", BINOP_RSH, PREC_SHIFT, 0},
341   {"shl", BINOP_LSH, PREC_SHIFT, 0},
342   {"+", BINOP_ADD, PREC_ADD, 0},
343   {"-", BINOP_SUB, PREC_ADD, 0},
344   {"*", BINOP_MUL, PREC_MUL, 0},
345   {"/", BINOP_DIV, PREC_MUL, 0},
346   {"div", BINOP_INTDIV, PREC_MUL, 0},
347   {"mod", BINOP_REM, PREC_MUL, 0},
348   {"@", BINOP_REPEAT, PREC_REPEAT, 0},
349   {"-", UNOP_NEG, PREC_PREFIX, 0},
350   {"not", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
351   {"^", UNOP_IND, PREC_SUFFIX, 1},
352   {"@", UNOP_ADDR, PREC_PREFIX, 0},
353   {"sizeof", UNOP_SIZEOF, PREC_PREFIX, 0},
354   {NULL, 0, 0, 0}
355 };
356 
357 enum pascal_primitive_types {
358   pascal_primitive_type_int,
359   pascal_primitive_type_long,
360   pascal_primitive_type_short,
361   pascal_primitive_type_char,
362   pascal_primitive_type_float,
363   pascal_primitive_type_double,
364   pascal_primitive_type_void,
365   pascal_primitive_type_long_long,
366   pascal_primitive_type_signed_char,
367   pascal_primitive_type_unsigned_char,
368   pascal_primitive_type_unsigned_short,
369   pascal_primitive_type_unsigned_int,
370   pascal_primitive_type_unsigned_long,
371   pascal_primitive_type_unsigned_long_long,
372   pascal_primitive_type_long_double,
373   pascal_primitive_type_complex,
374   pascal_primitive_type_double_complex,
375   nr_pascal_primitive_types
376 };
377 
378 static void
379 pascal_language_arch_info (struct gdbarch *gdbarch,
380 			   struct language_arch_info *lai)
381 {
382   const struct builtin_type *builtin = builtin_type (gdbarch);
383 
384   lai->string_char_type = builtin->builtin_char;
385   lai->primitive_type_vector
386     = GDBARCH_OBSTACK_CALLOC (gdbarch, nr_pascal_primitive_types + 1,
387                               struct type *);
388   lai->primitive_type_vector [pascal_primitive_type_int]
389     = builtin->builtin_int;
390   lai->primitive_type_vector [pascal_primitive_type_long]
391     = builtin->builtin_long;
392   lai->primitive_type_vector [pascal_primitive_type_short]
393     = builtin->builtin_short;
394   lai->primitive_type_vector [pascal_primitive_type_char]
395     = builtin->builtin_char;
396   lai->primitive_type_vector [pascal_primitive_type_float]
397     = builtin->builtin_float;
398   lai->primitive_type_vector [pascal_primitive_type_double]
399     = builtin->builtin_double;
400   lai->primitive_type_vector [pascal_primitive_type_void]
401     = builtin->builtin_void;
402   lai->primitive_type_vector [pascal_primitive_type_long_long]
403     = builtin->builtin_long_long;
404   lai->primitive_type_vector [pascal_primitive_type_signed_char]
405     = builtin->builtin_signed_char;
406   lai->primitive_type_vector [pascal_primitive_type_unsigned_char]
407     = builtin->builtin_unsigned_char;
408   lai->primitive_type_vector [pascal_primitive_type_unsigned_short]
409     = builtin->builtin_unsigned_short;
410   lai->primitive_type_vector [pascal_primitive_type_unsigned_int]
411     = builtin->builtin_unsigned_int;
412   lai->primitive_type_vector [pascal_primitive_type_unsigned_long]
413     = builtin->builtin_unsigned_long;
414   lai->primitive_type_vector [pascal_primitive_type_unsigned_long_long]
415     = builtin->builtin_unsigned_long_long;
416   lai->primitive_type_vector [pascal_primitive_type_long_double]
417     = builtin->builtin_long_double;
418   lai->primitive_type_vector [pascal_primitive_type_complex]
419     = builtin->builtin_complex;
420   lai->primitive_type_vector [pascal_primitive_type_double_complex]
421     = builtin->builtin_double_complex;
422 
423   lai->bool_type_symbol = "boolean";
424   lai->bool_type_default = builtin->builtin_bool;
425 }
426 
427 const struct language_defn pascal_language_defn =
428 {
429   "pascal",			/* Language name */
430   language_pascal,
431   range_check_on,
432   type_check_on,
433   case_sensitive_on,
434   array_row_major,
435   macro_expansion_no,
436   &exp_descriptor_standard,
437   pascal_parse,
438   pascal_error,
439   null_post_parser,
440   pascal_printchar,		/* Print a character constant */
441   pascal_printstr,		/* Function to print string constant */
442   pascal_emit_char,		/* Print a single char */
443   pascal_print_type,		/* Print a type using appropriate syntax */
444   pascal_print_typedef,		/* Print a typedef using appropriate syntax */
445   pascal_val_print,		/* Print a value using appropriate syntax */
446   pascal_value_print,		/* Print a top-level value */
447   NULL,				/* Language specific skip_trampoline */
448   "this",		        /* name_of_this */
449   basic_lookup_symbol_nonlocal,	/* lookup_symbol_nonlocal */
450   basic_lookup_transparent_type,/* lookup_transparent_type */
451   NULL,				/* Language specific symbol demangler */
452   NULL,				/* Language specific class_name_from_physname */
453   pascal_op_print_tab,		/* expression operators for printing */
454   1,				/* c-style arrays */
455   0,				/* String lower bound */
456   default_word_break_characters,
457   default_make_symbol_completion_list,
458   pascal_language_arch_info,
459   default_print_array_index,
460   default_pass_by_reference,
461   default_get_string,
462   strcmp_iw_ordered,
463   iterate_over_symbols,
464   LANG_MAGIC
465 };
466 
467 void
468 _initialize_pascal_language (void)
469 {
470   add_language (&pascal_language_defn);
471 }
472