Update/correct copyright notices.
[external/binutils.git] / gdb / f-lang.c
1 /* Fortran language support routines for GDB, the GNU debugger.
2    Copyright 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001
3    Free Software Foundation, Inc.
4    Contributed by Motorola.  Adapted from the C parser by Farooq Butt
5    (fmbutt@engage.sps.mot.com).
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 59 Temple Place - Suite 330,
22    Boston, MA 02111-1307, USA.  */
23
24 #include "defs.h"
25 #include "gdb_string.h"
26 #include "symtab.h"
27 #include "gdbtypes.h"
28 #include "expression.h"
29 #include "parser-defs.h"
30 #include "language.h"
31 #include "f-lang.h"
32 #include "valprint.h"
33
34 /* The built-in types of F77.  FIXME: integer*4 is missing, plain
35    logical is missing (builtin_type_logical is logical*4).  */
36
37 struct type *builtin_type_f_character;
38 struct type *builtin_type_f_logical;
39 struct type *builtin_type_f_logical_s1;
40 struct type *builtin_type_f_logical_s2;
41 struct type *builtin_type_f_integer;
42 struct type *builtin_type_f_integer_s2;
43 struct type *builtin_type_f_real;
44 struct type *builtin_type_f_real_s8;
45 struct type *builtin_type_f_real_s16;
46 struct type *builtin_type_f_complex_s8;
47 struct type *builtin_type_f_complex_s16;
48 struct type *builtin_type_f_complex_s32;
49 struct type *builtin_type_f_void;
50
51 /* Following is dubious stuff that had been in the xcoff reader. */
52
53 struct saved_fcn
54   {
55     long line_offset;           /* Line offset for function */
56     struct saved_fcn *next;
57   };
58
59
60 struct saved_bf_symnum
61   {
62     long symnum_fcn;            /* Symnum of function (i.e. .function directive) */
63     long symnum_bf;             /* Symnum of .bf for this function */
64     struct saved_bf_symnum *next;
65   };
66
67 typedef struct saved_fcn SAVED_FUNCTION, *SAVED_FUNCTION_PTR;
68 typedef struct saved_bf_symnum SAVED_BF, *SAVED_BF_PTR;
69
70 /* Local functions */
71
72 extern void _initialize_f_language (void);
73 #if 0
74 static void clear_function_list (void);
75 static long get_bf_for_fcn (long);
76 static void clear_bf_list (void);
77 static void patch_all_commons_by_name (char *, CORE_ADDR, int);
78 static SAVED_F77_COMMON_PTR find_first_common_named (char *);
79 static void add_common_entry (struct symbol *);
80 static void add_common_block (char *, CORE_ADDR, int, char *);
81 static SAVED_FUNCTION *allocate_saved_function_node (void);
82 static SAVED_BF_PTR allocate_saved_bf_node (void);
83 static COMMON_ENTRY_PTR allocate_common_entry_node (void);
84 static SAVED_F77_COMMON_PTR allocate_saved_f77_common_node (void);
85 static void patch_common_entries (SAVED_F77_COMMON_PTR, CORE_ADDR, int);
86 #endif
87
88 static struct type *f_create_fundamental_type (struct objfile *, int);
89 static void f_printstr (struct ui_file * stream, char *string,
90                         unsigned int length, int width,
91                         int force_ellipses);
92 static void f_printchar (int c, struct ui_file * stream);
93 static void f_emit_char (int c, struct ui_file * stream, int quoter);
94
95 /* Print the character C on STREAM as part of the contents of a literal
96    string whose delimiter is QUOTER.  Note that that format for printing
97    characters and strings is language specific.
98    FIXME:  This is a copy of the same function from c-exp.y.  It should
99    be replaced with a true F77 version.  */
100
101 static void
102 f_emit_char (register int c, struct ui_file *stream, int quoter)
103 {
104   c &= 0xFF;                    /* Avoid sign bit follies */
105
106   if (PRINT_LITERAL_FORM (c))
107     {
108       if (c == '\\' || c == quoter)
109         fputs_filtered ("\\", stream);
110       fprintf_filtered (stream, "%c", c);
111     }
112   else
113     {
114       switch (c)
115         {
116         case '\n':
117           fputs_filtered ("\\n", stream);
118           break;
119         case '\b':
120           fputs_filtered ("\\b", stream);
121           break;
122         case '\t':
123           fputs_filtered ("\\t", stream);
124           break;
125         case '\f':
126           fputs_filtered ("\\f", stream);
127           break;
128         case '\r':
129           fputs_filtered ("\\r", stream);
130           break;
131         case '\033':
132           fputs_filtered ("\\e", stream);
133           break;
134         case '\007':
135           fputs_filtered ("\\a", stream);
136           break;
137         default:
138           fprintf_filtered (stream, "\\%.3o", (unsigned int) c);
139           break;
140         }
141     }
142 }
143
144 /* FIXME:  This is a copy of the same function from c-exp.y.  It should
145    be replaced with a true F77version. */
146
147 static void
148 f_printchar (int c, struct ui_file *stream)
149 {
150   fputs_filtered ("'", stream);
151   LA_EMIT_CHAR (c, stream, '\'');
152   fputs_filtered ("'", stream);
153 }
154
155 /* Print the character string STRING, printing at most LENGTH characters.
156    Printing stops early if the number hits print_max; repeat counts
157    are printed as appropriate.  Print ellipses at the end if we
158    had to stop before printing LENGTH characters, or if FORCE_ELLIPSES.
159    FIXME:  This is a copy of the same function from c-exp.y.  It should
160    be replaced with a true F77 version. */
161
162 static void
163 f_printstr (struct ui_file *stream, char *string, unsigned int length,
164             int width, int force_ellipses)
165 {
166   register unsigned int i;
167   unsigned int things_printed = 0;
168   int in_quotes = 0;
169   int need_comma = 0;
170   extern int inspect_it;
171
172   if (length == 0)
173     {
174       fputs_filtered ("''", gdb_stdout);
175       return;
176     }
177
178   for (i = 0; i < length && things_printed < print_max; ++i)
179     {
180       /* Position of the character we are examining
181          to see whether it is repeated.  */
182       unsigned int rep1;
183       /* Number of repetitions we have detected so far.  */
184       unsigned int reps;
185
186       QUIT;
187
188       if (need_comma)
189         {
190           fputs_filtered (", ", stream);
191           need_comma = 0;
192         }
193
194       rep1 = i + 1;
195       reps = 1;
196       while (rep1 < length && string[rep1] == string[i])
197         {
198           ++rep1;
199           ++reps;
200         }
201
202       if (reps > repeat_count_threshold)
203         {
204           if (in_quotes)
205             {
206               if (inspect_it)
207                 fputs_filtered ("\\', ", stream);
208               else
209                 fputs_filtered ("', ", stream);
210               in_quotes = 0;
211             }
212           f_printchar (string[i], stream);
213           fprintf_filtered (stream, " <repeats %u times>", reps);
214           i = rep1 - 1;
215           things_printed += repeat_count_threshold;
216           need_comma = 1;
217         }
218       else
219         {
220           if (!in_quotes)
221             {
222               if (inspect_it)
223                 fputs_filtered ("\\'", stream);
224               else
225                 fputs_filtered ("'", stream);
226               in_quotes = 1;
227             }
228           LA_EMIT_CHAR (string[i], stream, '"');
229           ++things_printed;
230         }
231     }
232
233   /* Terminate the quotes if necessary.  */
234   if (in_quotes)
235     {
236       if (inspect_it)
237         fputs_filtered ("\\'", stream);
238       else
239         fputs_filtered ("'", stream);
240     }
241
242   if (force_ellipses || i < length)
243     fputs_filtered ("...", stream);
244 }
245
246 /* FIXME:  This is a copy of c_create_fundamental_type(), before
247    all the non-C types were stripped from it.  Needs to be fixed
248    by an experienced F77 programmer. */
249
250 static struct type *
251 f_create_fundamental_type (struct objfile *objfile, int typeid)
252 {
253   register struct type *type = NULL;
254
255   switch (typeid)
256     {
257     case FT_VOID:
258       type = init_type (TYPE_CODE_VOID,
259                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
260                         0, "VOID", objfile);
261       break;
262     case FT_BOOLEAN:
263       type = init_type (TYPE_CODE_BOOL,
264                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
265                         TYPE_FLAG_UNSIGNED, "boolean", objfile);
266       break;
267     case FT_STRING:
268       type = init_type (TYPE_CODE_STRING,
269                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
270                         0, "string", objfile);
271       break;
272     case FT_CHAR:
273       type = init_type (TYPE_CODE_INT,
274                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
275                         0, "character", objfile);
276       break;
277     case FT_SIGNED_CHAR:
278       type = init_type (TYPE_CODE_INT,
279                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
280                         0, "integer*1", objfile);
281       break;
282     case FT_UNSIGNED_CHAR:
283       type = init_type (TYPE_CODE_BOOL,
284                         TARGET_CHAR_BIT / TARGET_CHAR_BIT,
285                         TYPE_FLAG_UNSIGNED, "logical*1", objfile);
286       break;
287     case FT_SHORT:
288       type = init_type (TYPE_CODE_INT,
289                         TARGET_SHORT_BIT / TARGET_CHAR_BIT,
290                         0, "integer*2", objfile);
291       break;
292     case FT_SIGNED_SHORT:
293       type = init_type (TYPE_CODE_INT,
294                         TARGET_SHORT_BIT / TARGET_CHAR_BIT,
295                         0, "short", objfile);   /* FIXME-fnf */
296       break;
297     case FT_UNSIGNED_SHORT:
298       type = init_type (TYPE_CODE_BOOL,
299                         TARGET_SHORT_BIT / TARGET_CHAR_BIT,
300                         TYPE_FLAG_UNSIGNED, "logical*2", objfile);
301       break;
302     case FT_INTEGER:
303       type = init_type (TYPE_CODE_INT,
304                         TARGET_INT_BIT / TARGET_CHAR_BIT,
305                         0, "integer*4", objfile);
306       break;
307     case FT_SIGNED_INTEGER:
308       type = init_type (TYPE_CODE_INT,
309                         TARGET_INT_BIT / TARGET_CHAR_BIT,
310                         0, "integer", objfile);         /* FIXME -fnf */
311       break;
312     case FT_UNSIGNED_INTEGER:
313       type = init_type (TYPE_CODE_BOOL,
314                         TARGET_INT_BIT / TARGET_CHAR_BIT,
315                         TYPE_FLAG_UNSIGNED, "logical*4", objfile);
316       break;
317     case FT_FIXED_DECIMAL:
318       type = init_type (TYPE_CODE_INT,
319                         TARGET_INT_BIT / TARGET_CHAR_BIT,
320                         0, "fixed decimal", objfile);
321       break;
322     case FT_LONG:
323       type = init_type (TYPE_CODE_INT,
324                         TARGET_LONG_BIT / TARGET_CHAR_BIT,
325                         0, "long", objfile);
326       break;
327     case FT_SIGNED_LONG:
328       type = init_type (TYPE_CODE_INT,
329                         TARGET_LONG_BIT / TARGET_CHAR_BIT,
330                         0, "long", objfile);    /* FIXME -fnf */
331       break;
332     case FT_UNSIGNED_LONG:
333       type = init_type (TYPE_CODE_INT,
334                         TARGET_LONG_BIT / TARGET_CHAR_BIT,
335                         TYPE_FLAG_UNSIGNED, "unsigned long", objfile);
336       break;
337     case FT_LONG_LONG:
338       type = init_type (TYPE_CODE_INT,
339                         TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
340                         0, "long long", objfile);
341       break;
342     case FT_SIGNED_LONG_LONG:
343       type = init_type (TYPE_CODE_INT,
344                         TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
345                         0, "signed long long", objfile);
346       break;
347     case FT_UNSIGNED_LONG_LONG:
348       type = init_type (TYPE_CODE_INT,
349                         TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
350                         TYPE_FLAG_UNSIGNED, "unsigned long long", objfile);
351       break;
352     case FT_FLOAT:
353       type = init_type (TYPE_CODE_FLT,
354                         TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
355                         0, "real", objfile);
356       break;
357     case FT_DBL_PREC_FLOAT:
358       type = init_type (TYPE_CODE_FLT,
359                         TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
360                         0, "real*8", objfile);
361       break;
362     case FT_FLOAT_DECIMAL:
363       type = init_type (TYPE_CODE_FLT,
364                         TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
365                         0, "floating decimal", objfile);
366       break;
367     case FT_EXT_PREC_FLOAT:
368       type = init_type (TYPE_CODE_FLT,
369                         TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
370                         0, "real*16", objfile);
371       break;
372     case FT_COMPLEX:
373       type = init_type (TYPE_CODE_COMPLEX,
374                         2 * TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
375                         0, "complex*8", objfile);
376       TYPE_TARGET_TYPE (type) = builtin_type_f_real;
377       break;
378     case FT_DBL_PREC_COMPLEX:
379       type = init_type (TYPE_CODE_COMPLEX,
380                         2 * TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
381                         0, "complex*16", objfile);
382       TYPE_TARGET_TYPE (type) = builtin_type_f_real_s8;
383       break;
384     case FT_EXT_PREC_COMPLEX:
385       type = init_type (TYPE_CODE_COMPLEX,
386                         2 * TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
387                         0, "complex*32", objfile);
388       TYPE_TARGET_TYPE (type) = builtin_type_f_real_s16;
389       break;
390     default:
391       /* FIXME:  For now, if we are asked to produce a type not in this
392          language, create the equivalent of a C integer type with the
393          name "<?type?>".  When all the dust settles from the type
394          reconstruction work, this should probably become an error. */
395       type = init_type (TYPE_CODE_INT,
396                         TARGET_INT_BIT / TARGET_CHAR_BIT,
397                         0, "<?type?>", objfile);
398       warning ("internal error: no F77 fundamental type %d", typeid);
399       break;
400     }
401   return (type);
402 }
403 \f
404
405 /* Table of operators and their precedences for printing expressions.  */
406
407 static const struct op_print f_op_print_tab[] =
408 {
409   {"+", BINOP_ADD, PREC_ADD, 0},
410   {"+", UNOP_PLUS, PREC_PREFIX, 0},
411   {"-", BINOP_SUB, PREC_ADD, 0},
412   {"-", UNOP_NEG, PREC_PREFIX, 0},
413   {"*", BINOP_MUL, PREC_MUL, 0},
414   {"/", BINOP_DIV, PREC_MUL, 0},
415   {"DIV", BINOP_INTDIV, PREC_MUL, 0},
416   {"MOD", BINOP_REM, PREC_MUL, 0},
417   {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
418   {".OR.", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
419   {".AND.", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
420   {".NOT.", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
421   {".EQ.", BINOP_EQUAL, PREC_EQUAL, 0},
422   {".NE.", BINOP_NOTEQUAL, PREC_EQUAL, 0},
423   {".LE.", BINOP_LEQ, PREC_ORDER, 0},
424   {".GE.", BINOP_GEQ, PREC_ORDER, 0},
425   {".GT.", BINOP_GTR, PREC_ORDER, 0},
426   {".LT.", BINOP_LESS, PREC_ORDER, 0},
427   {"**", UNOP_IND, PREC_PREFIX, 0},
428   {"@", BINOP_REPEAT, PREC_REPEAT, 0},
429   {NULL, 0, 0, 0}
430 };
431 \f
432 struct type **CONST_PTR (f_builtin_types[]) =
433 {
434   &builtin_type_f_character,
435     &builtin_type_f_logical,
436     &builtin_type_f_logical_s1,
437     &builtin_type_f_logical_s2,
438     &builtin_type_f_integer,
439     &builtin_type_f_integer_s2,
440     &builtin_type_f_real,
441     &builtin_type_f_real_s8,
442     &builtin_type_f_real_s16,
443     &builtin_type_f_complex_s8,
444     &builtin_type_f_complex_s16,
445 #if 0
446     &builtin_type_f_complex_s32,
447 #endif
448     &builtin_type_f_void,
449     0
450 };
451
452 /* This is declared in c-lang.h but it is silly to import that file for what
453    is already just a hack. */
454 extern int c_value_print (struct value *, struct ui_file *, int,
455                           enum val_prettyprint);
456
457 const struct language_defn f_language_defn =
458 {
459   "fortran",
460   language_fortran,
461   f_builtin_types,
462   range_check_on,
463   type_check_on,
464   case_sensitive_off,
465   f_parse,                      /* parser */
466   f_error,                      /* parser error function */
467   evaluate_subexp_standard,
468   f_printchar,                  /* Print character constant */
469   f_printstr,                   /* function to print string constant */
470   f_emit_char,                  /* Function to print a single character */
471   f_create_fundamental_type,    /* Create fundamental type in this language */
472   f_print_type,                 /* Print a type using appropriate syntax */
473   f_val_print,                  /* Print a value using appropriate syntax */
474   c_value_print,                /* FIXME */
475   {"", "", "", ""},             /* Binary format info */
476   {"0%o", "0", "o", ""},        /* Octal format info */
477   {"%d", "", "d", ""},          /* Decimal format info */
478   {"0x%x", "0x", "x", ""},      /* Hex format info */
479   f_op_print_tab,               /* expression operators for printing */
480   0,                            /* arrays are first-class (not c-style) */
481   1,                            /* String lower bound */
482   &builtin_type_f_character,    /* Type of string elements */
483   LANG_MAGIC
484 };
485
486 void
487 _initialize_f_language (void)
488 {
489   builtin_type_f_void =
490     init_type (TYPE_CODE_VOID, 1,
491                0,
492                "VOID", (struct objfile *) NULL);
493
494   builtin_type_f_character =
495     init_type (TYPE_CODE_INT, TARGET_CHAR_BIT / TARGET_CHAR_BIT,
496                0,
497                "character", (struct objfile *) NULL);
498
499   builtin_type_f_logical_s1 =
500     init_type (TYPE_CODE_BOOL, TARGET_CHAR_BIT / TARGET_CHAR_BIT,
501                TYPE_FLAG_UNSIGNED,
502                "logical*1", (struct objfile *) NULL);
503
504   builtin_type_f_integer_s2 =
505     init_type (TYPE_CODE_INT, TARGET_SHORT_BIT / TARGET_CHAR_BIT,
506                0,
507                "integer*2", (struct objfile *) NULL);
508
509   builtin_type_f_logical_s2 =
510     init_type (TYPE_CODE_BOOL, TARGET_SHORT_BIT / TARGET_CHAR_BIT,
511                TYPE_FLAG_UNSIGNED,
512                "logical*2", (struct objfile *) NULL);
513
514   builtin_type_f_integer =
515     init_type (TYPE_CODE_INT, TARGET_INT_BIT / TARGET_CHAR_BIT,
516                0,
517                "integer", (struct objfile *) NULL);
518
519   builtin_type_f_logical =
520     init_type (TYPE_CODE_BOOL, TARGET_INT_BIT / TARGET_CHAR_BIT,
521                TYPE_FLAG_UNSIGNED,
522                "logical*4", (struct objfile *) NULL);
523
524   builtin_type_f_real =
525     init_type (TYPE_CODE_FLT, TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
526                0,
527                "real", (struct objfile *) NULL);
528
529   builtin_type_f_real_s8 =
530     init_type (TYPE_CODE_FLT, TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
531                0,
532                "real*8", (struct objfile *) NULL);
533
534   builtin_type_f_real_s16 =
535     init_type (TYPE_CODE_FLT, TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
536                0,
537                "real*16", (struct objfile *) NULL);
538
539   builtin_type_f_complex_s8 =
540     init_type (TYPE_CODE_COMPLEX, 2 * TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
541                0,
542                "complex*8", (struct objfile *) NULL);
543   TYPE_TARGET_TYPE (builtin_type_f_complex_s8) = builtin_type_f_real;
544
545   builtin_type_f_complex_s16 =
546     init_type (TYPE_CODE_COMPLEX, 2 * TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
547                0,
548                "complex*16", (struct objfile *) NULL);
549   TYPE_TARGET_TYPE (builtin_type_f_complex_s16) = builtin_type_f_real_s8;
550
551   /* We have a new size == 4 double floats for the
552      complex*32 data type */
553
554   builtin_type_f_complex_s32 =
555     init_type (TYPE_CODE_COMPLEX, 2 * TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
556                0,
557                "complex*32", (struct objfile *) NULL);
558   TYPE_TARGET_TYPE (builtin_type_f_complex_s32) = builtin_type_f_real_s16;
559
560   builtin_type_string =
561     init_type (TYPE_CODE_STRING, TARGET_CHAR_BIT / TARGET_CHAR_BIT,
562                0,
563                "character string", (struct objfile *) NULL);
564
565   add_language (&f_language_defn);
566 }
567
568 #if 0
569 static SAVED_BF_PTR
570 allocate_saved_bf_node (void)
571 {
572   SAVED_BF_PTR new;
573
574   new = (SAVED_BF_PTR) xmalloc (sizeof (SAVED_BF));
575   return (new);
576 }
577
578 static SAVED_FUNCTION *
579 allocate_saved_function_node (void)
580 {
581   SAVED_FUNCTION *new;
582
583   new = (SAVED_FUNCTION *) xmalloc (sizeof (SAVED_FUNCTION));
584   return (new);
585 }
586
587 static SAVED_F77_COMMON_PTR
588 allocate_saved_f77_common_node (void)
589 {
590   SAVED_F77_COMMON_PTR new;
591
592   new = (SAVED_F77_COMMON_PTR) xmalloc (sizeof (SAVED_F77_COMMON));
593   return (new);
594 }
595
596 static COMMON_ENTRY_PTR
597 allocate_common_entry_node (void)
598 {
599   COMMON_ENTRY_PTR new;
600
601   new = (COMMON_ENTRY_PTR) xmalloc (sizeof (COMMON_ENTRY));
602   return (new);
603 }
604 #endif
605
606 SAVED_F77_COMMON_PTR head_common_list = NULL;   /* Ptr to 1st saved COMMON  */
607 SAVED_F77_COMMON_PTR tail_common_list = NULL;   /* Ptr to last saved COMMON  */
608 SAVED_F77_COMMON_PTR current_common = NULL;     /* Ptr to current COMMON */
609
610 #if 0
611 static SAVED_BF_PTR saved_bf_list = NULL;       /* Ptr to (.bf,function) 
612                                                    list */
613 static SAVED_BF_PTR saved_bf_list_end = NULL;   /* Ptr to above list's end */
614 static SAVED_BF_PTR current_head_bf_list = NULL;        /* Current head of above list
615                                                          */
616
617 static SAVED_BF_PTR tmp_bf_ptr; /* Generic temporary for use 
618                                    in macros */
619
620 /* The following function simply enters a given common block onto 
621    the global common block chain */
622
623 static void
624 add_common_block (char *name, CORE_ADDR offset, int secnum, char *func_stab)
625 {
626   SAVED_F77_COMMON_PTR tmp;
627   char *c, *local_copy_func_stab;
628
629   /* If the COMMON block we are trying to add has a blank 
630      name (i.e. "#BLNK_COM") then we set it to __BLANK
631      because the darn "#" character makes GDB's input 
632      parser have fits. */
633
634
635   if (STREQ (name, BLANK_COMMON_NAME_ORIGINAL) ||
636       STREQ (name, BLANK_COMMON_NAME_MF77))
637     {
638
639       xfree (name);
640       name = alloca (strlen (BLANK_COMMON_NAME_LOCAL) + 1);
641       strcpy (name, BLANK_COMMON_NAME_LOCAL);
642     }
643
644   tmp = allocate_saved_f77_common_node ();
645
646   local_copy_func_stab = xmalloc (strlen (func_stab) + 1);
647   strcpy (local_copy_func_stab, func_stab);
648
649   tmp->name = xmalloc (strlen (name) + 1);
650
651   /* local_copy_func_stab is a stabstring, let us first extract the 
652      function name from the stab by NULLing out the ':' character. */
653
654
655   c = NULL;
656   c = strchr (local_copy_func_stab, ':');
657
658   if (c)
659     *c = '\0';
660   else
661     error ("Malformed function STAB found in add_common_block()");
662
663
664   tmp->owning_function = xmalloc (strlen (local_copy_func_stab) + 1);
665
666   strcpy (tmp->owning_function, local_copy_func_stab);
667
668   strcpy (tmp->name, name);
669   tmp->offset = offset;
670   tmp->next = NULL;
671   tmp->entries = NULL;
672   tmp->secnum = secnum;
673
674   current_common = tmp;
675
676   if (head_common_list == NULL)
677     {
678       head_common_list = tail_common_list = tmp;
679     }
680   else
681     {
682       tail_common_list->next = tmp;
683       tail_common_list = tmp;
684     }
685 }
686 #endif
687
688 /* The following function simply enters a given common entry onto 
689    the "current_common" block that has been saved away. */
690
691 #if 0
692 static void
693 add_common_entry (struct symbol *entry_sym_ptr)
694 {
695   COMMON_ENTRY_PTR tmp;
696
697
698
699   /* The order of this list is important, since 
700      we expect the entries to appear in decl.
701      order when we later issue "info common" calls */
702
703   tmp = allocate_common_entry_node ();
704
705   tmp->next = NULL;
706   tmp->symbol = entry_sym_ptr;
707
708   if (current_common == NULL)
709     error ("Attempt to add COMMON entry with no block open!");
710   else
711     {
712       if (current_common->entries == NULL)
713         {
714           current_common->entries = tmp;
715           current_common->end_of_entries = tmp;
716         }
717       else
718         {
719           current_common->end_of_entries->next = tmp;
720           current_common->end_of_entries = tmp;
721         }
722     }
723 }
724 #endif
725
726 /* This routine finds the first encountred COMMON block named "name" */
727
728 #if 0
729 static SAVED_F77_COMMON_PTR
730 find_first_common_named (char *name)
731 {
732
733   SAVED_F77_COMMON_PTR tmp;
734
735   tmp = head_common_list;
736
737   while (tmp != NULL)
738     {
739       if (STREQ (tmp->name, name))
740         return (tmp);
741       else
742         tmp = tmp->next;
743     }
744   return (NULL);
745 }
746 #endif
747
748 /* This routine finds the first encountred COMMON block named "name" 
749    that belongs to function funcname */
750
751 SAVED_F77_COMMON_PTR
752 find_common_for_function (char *name, char *funcname)
753 {
754
755   SAVED_F77_COMMON_PTR tmp;
756
757   tmp = head_common_list;
758
759   while (tmp != NULL)
760     {
761       if (STREQ (tmp->name, name) && STREQ (tmp->owning_function, funcname))
762         return (tmp);
763       else
764         tmp = tmp->next;
765     }
766   return (NULL);
767 }
768
769
770 #if 0
771
772 /* The following function is called to patch up the offsets 
773    for the statics contained in the COMMON block named
774    "name."  */
775
776 static void
777 patch_common_entries (SAVED_F77_COMMON_PTR blk, CORE_ADDR offset, int secnum)
778 {
779   COMMON_ENTRY_PTR entry;
780
781   blk->offset = offset;         /* Keep this around for future use. */
782
783   entry = blk->entries;
784
785   while (entry != NULL)
786     {
787       SYMBOL_VALUE (entry->symbol) += offset;
788       SYMBOL_SECTION (entry->symbol) = secnum;
789
790       entry = entry->next;
791     }
792   blk->secnum = secnum;
793 }
794
795 /* Patch all commons named "name" that need patching.Since COMMON
796    blocks occur with relative infrequency, we simply do a linear scan on
797    the name.  Eventually, the best way to do this will be a
798    hashed-lookup.  Secnum is the section number for the .bss section
799    (which is where common data lives). */
800
801 static void
802 patch_all_commons_by_name (char *name, CORE_ADDR offset, int secnum)
803 {
804
805   SAVED_F77_COMMON_PTR tmp;
806
807   /* For blank common blocks, change the canonical reprsentation 
808      of a blank name */
809
810   if ((STREQ (name, BLANK_COMMON_NAME_ORIGINAL)) ||
811       (STREQ (name, BLANK_COMMON_NAME_MF77)))
812     {
813       xfree (name);
814       name = alloca (strlen (BLANK_COMMON_NAME_LOCAL) + 1);
815       strcpy (name, BLANK_COMMON_NAME_LOCAL);
816     }
817
818   tmp = head_common_list;
819
820   while (tmp != NULL)
821     {
822       if (COMMON_NEEDS_PATCHING (tmp))
823         if (STREQ (tmp->name, name))
824           patch_common_entries (tmp, offset, secnum);
825
826       tmp = tmp->next;
827     }
828 }
829 #endif
830
831 /* This macro adds the symbol-number for the start of the function 
832    (the symbol number of the .bf) referenced by symnum_fcn to a 
833    list.  This list, in reality should be a FIFO queue but since 
834    #line pragmas sometimes cause line ranges to get messed up 
835    we simply create a linear list.  This list can then be searched 
836    first by a queueing algorithm and upon failure fall back to 
837    a linear scan. */
838
839 #if 0
840 #define ADD_BF_SYMNUM(bf_sym,fcn_sym) \
841   \
842   if (saved_bf_list == NULL) \
843 { \
844     tmp_bf_ptr = allocate_saved_bf_node(); \
845       \
846         tmp_bf_ptr->symnum_bf = (bf_sym); \
847           tmp_bf_ptr->symnum_fcn = (fcn_sym);  \
848             tmp_bf_ptr->next = NULL; \
849               \
850                 current_head_bf_list = saved_bf_list = tmp_bf_ptr; \
851                   saved_bf_list_end = tmp_bf_ptr; \
852                   } \
853 else \
854 {  \
855      tmp_bf_ptr = allocate_saved_bf_node(); \
856        \
857          tmp_bf_ptr->symnum_bf = (bf_sym);  \
858            tmp_bf_ptr->symnum_fcn = (fcn_sym);  \
859              tmp_bf_ptr->next = NULL;  \
860                \
861                  saved_bf_list_end->next = tmp_bf_ptr;  \
862                    saved_bf_list_end = tmp_bf_ptr; \
863                    }
864 #endif
865
866 /* This function frees the entire (.bf,function) list */
867
868 #if 0
869 static void
870 clear_bf_list (void)
871 {
872
873   SAVED_BF_PTR tmp = saved_bf_list;
874   SAVED_BF_PTR next = NULL;
875
876   while (tmp != NULL)
877     {
878       next = tmp->next;
879       xfree (tmp);
880       tmp = next;
881     }
882   saved_bf_list = NULL;
883 }
884 #endif
885
886 int global_remote_debug;
887
888 #if 0
889
890 static long
891 get_bf_for_fcn (long the_function)
892 {
893   SAVED_BF_PTR tmp;
894   int nprobes = 0;
895
896   /* First use a simple queuing algorithm (i.e. look and see if the 
897      item at the head of the queue is the one you want)  */
898
899   if (saved_bf_list == NULL)
900     internal_error (__FILE__, __LINE__,
901                     "cannot get .bf node off empty list");
902
903   if (current_head_bf_list != NULL)
904     if (current_head_bf_list->symnum_fcn == the_function)
905       {
906         if (global_remote_debug)
907           fprintf (stderr, "*");
908
909         tmp = current_head_bf_list;
910         current_head_bf_list = current_head_bf_list->next;
911         return (tmp->symnum_bf);
912       }
913
914   /* If the above did not work (probably because #line directives were 
915      used in the sourcefile and they messed up our internal tables) we now do
916      the ugly linear scan */
917
918   if (global_remote_debug)
919     fprintf (stderr, "\ndefaulting to linear scan\n");
920
921   nprobes = 0;
922   tmp = saved_bf_list;
923   while (tmp != NULL)
924     {
925       nprobes++;
926       if (tmp->symnum_fcn == the_function)
927         {
928           if (global_remote_debug)
929             fprintf (stderr, "Found in %d probes\n", nprobes);
930           current_head_bf_list = tmp->next;
931           return (tmp->symnum_bf);
932         }
933       tmp = tmp->next;
934     }
935
936   return (-1);
937 }
938
939 static SAVED_FUNCTION_PTR saved_function_list = NULL;
940 static SAVED_FUNCTION_PTR saved_function_list_end = NULL;
941
942 static void
943 clear_function_list (void)
944 {
945   SAVED_FUNCTION_PTR tmp = saved_function_list;
946   SAVED_FUNCTION_PTR next = NULL;
947
948   while (tmp != NULL)
949     {
950       next = tmp->next;
951       xfree (tmp);
952       tmp = next;
953     }
954
955   saved_function_list = NULL;
956 }
957 #endif