1 /* Handle modules, which amounts to loading and saving symbols and
2 their attendant structures.
3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation,
5 Contributed by Andy Vaught
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 2, or (at your option) any later
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING. If not, write to the Free
21 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
24 /* The syntax of gfortran modules resembles that of lisp lists, ie a
25 sequence of atoms, which can be left or right parenthesis, names,
26 integers or strings. Parenthesis are always matched which allows
27 us to skip over sections at high speed without having to know
28 anything about the internal structure of the lists. A "name" is
29 usually a fortran 95 identifier, but can also start with '@' in
30 order to reference a hidden symbol.
32 The first line of a module is an informational message about what
33 created the module, the file it came from and when it was created.
34 The second line is a warning for people not to edit the module.
35 The rest of the module looks like:
37 ( ( <Interface info for UPLUS> )
38 ( <Interface info for UMINUS> )
41 ( ( <name of operator interface> <module of op interface> <i/f1> ... )
44 ( ( <name of generic interface> <module of generic interface> <i/f1> ... )
47 ( ( <common name> <symbol> <saved flag>)
53 ( <Symbol Number (in no particular order)>
55 <Module name of symbol>
56 ( <symbol information> )
65 In general, symbols refer to other symbols by their symbol number,
66 which are zero based. Symbols are written to the module in no
74 #include "parse.h" /* FIXME */
76 #define MODULE_EXTENSION ".mod"
79 /* Structure that describes a position within a module file. */
91 P_UNKNOWN
= 0, P_OTHER
, P_NAMESPACE
, P_COMPONENT
, P_SYMBOL
95 /* The fixup structure lists pointers to pointers that have to
96 be updated when a pointer value becomes known. */
98 typedef struct fixup_t
101 struct fixup_t
*next
;
106 /* Structure for holding extra info needed for pointers being read. */
108 typedef struct pointer_info
110 BBT_HEADER (pointer_info
);
114 /* The first component of each member of the union is the pointer
121 void *pointer
; /* Member for doing pointer searches. */
126 char true_name
[GFC_MAX_SYMBOL_LEN
+ 1], module
[GFC_MAX_SYMBOL_LEN
+ 1];
128 { UNUSED
, NEEDED
, USED
}
133 gfc_symtree
*symtree
;
141 { UNREFERENCED
= 0, NEEDS_WRITE
, WRITTEN
}
151 #define gfc_get_pointer_info() gfc_getmem(sizeof(pointer_info))
154 /* Lists of rename info for the USE statement. */
156 typedef struct gfc_use_rename
158 char local_name
[GFC_MAX_SYMBOL_LEN
+ 1], use_name
[GFC_MAX_SYMBOL_LEN
+ 1];
159 struct gfc_use_rename
*next
;
161 gfc_intrinsic_op
operator;
166 #define gfc_get_use_rename() gfc_getmem(sizeof(gfc_use_rename))
168 /* Local variables */
170 /* The FILE for the module we're reading or writing. */
171 static FILE *module_fp
;
173 /* The name of the module we're reading (USE'ing) or writing. */
174 static char module_name
[GFC_MAX_SYMBOL_LEN
+ 1];
176 static int module_line
, module_column
, only_flag
;
178 { IO_INPUT
, IO_OUTPUT
}
181 static gfc_use_rename
*gfc_rename_list
;
182 static pointer_info
*pi_root
;
183 static int symbol_number
; /* Counter for assigning symbol numbers */
187 /*****************************************************************/
189 /* Pointer/integer conversion. Pointers between structures are stored
190 as integers in the module file. The next couple of subroutines
191 handle this translation for reading and writing. */
193 /* Recursively free the tree of pointer structures. */
196 free_pi_tree (pointer_info
* p
)
201 if (p
->fixup
!= NULL
)
202 gfc_internal_error ("free_pi_tree(): Unresolved fixup");
204 free_pi_tree (p
->left
);
205 free_pi_tree (p
->right
);
211 /* Compare pointers when searching by pointer. Used when writing a
215 compare_pointers (void * _sn1
, void * _sn2
)
217 pointer_info
*sn1
, *sn2
;
219 sn1
= (pointer_info
*) _sn1
;
220 sn2
= (pointer_info
*) _sn2
;
222 if (sn1
->u
.pointer
< sn2
->u
.pointer
)
224 if (sn1
->u
.pointer
> sn2
->u
.pointer
)
231 /* Compare integers when searching by integer. Used when reading a
235 compare_integers (void * _sn1
, void * _sn2
)
237 pointer_info
*sn1
, *sn2
;
239 sn1
= (pointer_info
*) _sn1
;
240 sn2
= (pointer_info
*) _sn2
;
242 if (sn1
->integer
< sn2
->integer
)
244 if (sn1
->integer
> sn2
->integer
)
251 /* Initialize the pointer_info tree. */
260 compare
= (iomode
== IO_INPUT
) ? compare_integers
: compare_pointers
;
262 /* Pointer 0 is the NULL pointer. */
263 p
= gfc_get_pointer_info ();
268 gfc_insert_bbt (&pi_root
, p
, compare
);
270 /* Pointer 1 is the current namespace. */
271 p
= gfc_get_pointer_info ();
272 p
->u
.pointer
= gfc_current_ns
;
274 p
->type
= P_NAMESPACE
;
276 gfc_insert_bbt (&pi_root
, p
, compare
);
282 /* During module writing, call here with a pointer to something,
283 returning the pointer_info node. */
285 static pointer_info
*
286 find_pointer (void *gp
)
293 if (p
->u
.pointer
== gp
)
295 p
= (gp
< p
->u
.pointer
) ? p
->left
: p
->right
;
302 /* Given a pointer while writing, returns the pointer_info tree node,
303 creating it if it doesn't exist. */
305 static pointer_info
*
306 get_pointer (void *gp
)
310 p
= find_pointer (gp
);
314 /* Pointer doesn't have an integer. Give it one. */
315 p
= gfc_get_pointer_info ();
318 p
->integer
= symbol_number
++;
320 gfc_insert_bbt (&pi_root
, p
, compare_pointers
);
326 /* Given an integer during reading, find it in the pointer_info tree,
327 creating the node if not found. */
329 static pointer_info
*
330 get_integer (int integer
)
340 c
= compare_integers (&t
, p
);
344 p
= (c
< 0) ? p
->left
: p
->right
;
350 p
= gfc_get_pointer_info ();
351 p
->integer
= integer
;
354 gfc_insert_bbt (&pi_root
, p
, compare_integers
);
360 /* Recursive function to find a pointer within a tree by brute force. */
362 static pointer_info
*
363 fp2 (pointer_info
* p
, const void *target
)
370 if (p
->u
.pointer
== target
)
373 q
= fp2 (p
->left
, target
);
377 return fp2 (p
->right
, target
);
381 /* During reading, find a pointer_info node from the pointer value.
382 This amounts to a brute-force search. */
384 static pointer_info
*
385 find_pointer2 (void *p
)
388 return fp2 (pi_root
, p
);
392 /* Resolve any fixups using a known pointer. */
394 resolve_fixups (fixup_t
*f
, void * gp
)
406 /* Call here during module reading when we know what pointer to
407 associate with an integer. Any fixups that exist are resolved at
411 associate_integer_pointer (pointer_info
* p
, void *gp
)
413 if (p
->u
.pointer
!= NULL
)
414 gfc_internal_error ("associate_integer_pointer(): Already associated");
418 resolve_fixups (p
->fixup
, gp
);
424 /* During module reading, given an integer and a pointer to a pointer,
425 either store the pointer from an already-known value or create a
426 fixup structure in order to store things later. Returns zero if
427 the reference has been actually stored, or nonzero if the reference
428 must be fixed later (ie associate_integer_pointer must be called
429 sometime later. Returns the pointer_info structure. */
431 static pointer_info
*
432 add_fixup (int integer
, void *gp
)
438 p
= get_integer (integer
);
440 if (p
->integer
== 0 || p
->u
.pointer
!= NULL
)
447 f
= gfc_getmem (sizeof (fixup_t
));
459 /*****************************************************************/
461 /* Parser related subroutines */
463 /* Free the rename list left behind by a USE statement. */
468 gfc_use_rename
*next
;
470 for (; gfc_rename_list
; gfc_rename_list
= next
)
472 next
= gfc_rename_list
->next
;
473 gfc_free (gfc_rename_list
);
478 /* Match a USE statement. */
483 char name
[GFC_MAX_SYMBOL_LEN
+ 1];
484 gfc_use_rename
*tail
= NULL
, *new;
486 gfc_intrinsic_op
operator;
489 m
= gfc_match_name (module_name
);
496 if (gfc_match_eos () == MATCH_YES
)
498 if (gfc_match_char (',') != MATCH_YES
)
501 if (gfc_match (" only :") == MATCH_YES
)
504 if (gfc_match_eos () == MATCH_YES
)
509 /* Get a new rename struct and add it to the rename list. */
510 new = gfc_get_use_rename ();
511 new->where
= gfc_current_locus
;
514 if (gfc_rename_list
== NULL
)
515 gfc_rename_list
= new;
520 /* See what kind of interface we're dealing with. Assume it is
522 new->operator = INTRINSIC_NONE
;
523 if (gfc_match_generic_spec (&type
, name
, &operator) == MATCH_ERROR
)
528 case INTERFACE_NAMELESS
:
529 gfc_error ("Missing generic specification in USE statement at %C");
532 case INTERFACE_GENERIC
:
533 m
= gfc_match (" =>");
538 strcpy (new->use_name
, name
);
541 strcpy (new->local_name
, name
);
543 m
= gfc_match_name (new->use_name
);
546 if (m
== MATCH_ERROR
)
554 strcpy (new->local_name
, name
);
556 m
= gfc_match_name (new->use_name
);
559 if (m
== MATCH_ERROR
)
565 case INTERFACE_USER_OP
:
566 strcpy (new->use_name
, name
);
569 case INTERFACE_INTRINSIC_OP
:
570 new->operator = operator;
574 if (gfc_match_eos () == MATCH_YES
)
576 if (gfc_match_char (',') != MATCH_YES
)
583 gfc_syntax_error (ST_USE
);
591 /* Given a name and a number, inst, return the inst name
592 under which to load this symbol. Returns NULL if this
593 symbol shouldn't be loaded. If inst is zero, returns
594 the number of instances of this name. */
597 find_use_name_n (const char *name
, int *inst
)
603 for (u
= gfc_rename_list
; u
; u
= u
->next
)
605 if (strcmp (u
->use_name
, name
) != 0)
618 return only_flag
? NULL
: name
;
622 return (u
->local_name
[0] != '\0') ? u
->local_name
: name
;
625 /* Given a name, return the name under which to load this symbol.
626 Returns NULL if this symbol shouldn't be loaded. */
629 find_use_name (const char *name
)
632 return find_use_name_n (name
, &i
);
635 /* Given a real name, return the number of use names associated
639 number_use_names (const char *name
)
643 c
= find_use_name_n (name
, &i
);
648 /* Try to find the operator in the current list. */
650 static gfc_use_rename
*
651 find_use_operator (gfc_intrinsic_op
operator)
655 for (u
= gfc_rename_list
; u
; u
= u
->next
)
656 if (u
->operator == operator)
663 /*****************************************************************/
665 /* The next couple of subroutines maintain a tree used to avoid a
666 brute-force search for a combination of true name and module name.
667 While symtree names, the name that a particular symbol is known by
668 can changed with USE statements, we still have to keep track of the
669 true names to generate the correct reference, and also avoid
670 loading the same real symbol twice in a program unit.
672 When we start reading, the true name tree is built and maintained
673 as symbols are read. The tree is searched as we load new symbols
674 to see if it already exists someplace in the namespace. */
676 typedef struct true_name
678 BBT_HEADER (true_name
);
683 static true_name
*true_name_root
;
686 /* Compare two true_name structures. */
689 compare_true_names (void * _t1
, void * _t2
)
694 t1
= (true_name
*) _t1
;
695 t2
= (true_name
*) _t2
;
697 c
= ((t1
->sym
->module
> t2
->sym
->module
)
698 - (t1
->sym
->module
< t2
->sym
->module
));
702 return strcmp (t1
->sym
->name
, t2
->sym
->name
);
706 /* Given a true name, search the true name tree to see if it exists
707 within the main namespace. */
710 find_true_name (const char *name
, const char *module
)
716 sym
.name
= gfc_get_string (name
);
718 sym
.module
= gfc_get_string (module
);
726 c
= compare_true_names ((void *)(&t
), (void *) p
);
730 p
= (c
< 0) ? p
->left
: p
->right
;
737 /* Given a gfc_symbol pointer that is not in the true name tree, add
741 add_true_name (gfc_symbol
* sym
)
745 t
= gfc_getmem (sizeof (true_name
));
748 gfc_insert_bbt (&true_name_root
, t
, compare_true_names
);
752 /* Recursive function to build the initial true name tree by
753 recursively traversing the current namespace. */
756 build_tnt (gfc_symtree
* st
)
762 build_tnt (st
->left
);
763 build_tnt (st
->right
);
765 if (find_true_name (st
->n
.sym
->name
, st
->n
.sym
->module
) != NULL
)
768 add_true_name (st
->n
.sym
);
772 /* Initialize the true name tree with the current namespace. */
775 init_true_name_tree (void)
777 true_name_root
= NULL
;
779 build_tnt (gfc_current_ns
->sym_root
);
783 /* Recursively free a true name tree node. */
786 free_true_name (true_name
* t
)
791 free_true_name (t
->left
);
792 free_true_name (t
->right
);
798 /*****************************************************************/
800 /* Module reading and writing. */
804 ATOM_NAME
, ATOM_LPAREN
, ATOM_RPAREN
, ATOM_INTEGER
, ATOM_STRING
808 static atom_type last_atom
;
811 /* The name buffer must be at least as long as a symbol name. Right
812 now it's not clear how we're going to store numeric constants--
813 probably as a hexadecimal string, since this will allow the exact
814 number to be preserved (this can't be done by a decimal
815 representation). Worry about that later. TODO! */
817 #define MAX_ATOM_SIZE 100
820 static char *atom_string
, atom_name
[MAX_ATOM_SIZE
];
823 /* Report problems with a module. Error reporting is not very
824 elaborate, since this sorts of errors shouldn't really happen.
825 This subroutine never returns. */
827 static void bad_module (const char *) ATTRIBUTE_NORETURN
;
830 bad_module (const char *msgid
)
837 gfc_fatal_error ("Reading module %s at line %d column %d: %s",
838 module_name
, module_line
, module_column
, msgid
);
841 gfc_fatal_error ("Writing module %s at line %d column %d: %s",
842 module_name
, module_line
, module_column
, msgid
);
845 gfc_fatal_error ("Module %s at line %d column %d: %s",
846 module_name
, module_line
, module_column
, msgid
);
852 /* Set the module's input pointer. */
855 set_module_locus (module_locus
* m
)
858 module_column
= m
->column
;
859 module_line
= m
->line
;
860 fsetpos (module_fp
, &m
->pos
);
864 /* Get the module's input pointer so that we can restore it later. */
867 get_module_locus (module_locus
* m
)
870 m
->column
= module_column
;
871 m
->line
= module_line
;
872 fgetpos (module_fp
, &m
->pos
);
876 /* Get the next character in the module, updating our reckoning of
884 c
= fgetc (module_fp
);
887 bad_module ("Unexpected EOF");
900 /* Parse a string constant. The delimiter is guaranteed to be a
910 get_module_locus (&start
);
914 /* See how long the string is */
919 bad_module ("Unexpected end of module in string constant");
937 set_module_locus (&start
);
939 atom_string
= p
= gfc_getmem (len
+ 1);
941 for (; len
> 0; len
--)
945 module_char (); /* Guaranteed to be another \' */
949 module_char (); /* Terminating \' */
950 *p
= '\0'; /* C-style string for debug purposes */
954 /* Parse a small integer. */
957 parse_integer (int c
)
965 get_module_locus (&m
);
971 atom_int
= 10 * atom_int
+ c
- '0';
972 if (atom_int
> 99999999)
973 bad_module ("Integer overflow");
976 set_module_locus (&m
);
994 get_module_locus (&m
);
999 if (!ISALNUM (c
) && c
!= '_' && c
!= '-')
1003 if (++len
> GFC_MAX_SYMBOL_LEN
)
1004 bad_module ("Name too long");
1009 fseek (module_fp
, -1, SEEK_CUR
);
1010 module_column
= m
.column
+ len
- 1;
1017 /* Read the next atom in the module's input stream. */
1028 while (c
== ' ' || c
== '\n');
1053 return ATOM_INTEGER
;
1111 bad_module ("Bad name");
1118 /* Peek at the next atom on the input. */
1126 get_module_locus (&m
);
1129 if (a
== ATOM_STRING
)
1130 gfc_free (atom_string
);
1132 set_module_locus (&m
);
1137 /* Read the next atom from the input, requiring that it be a
1141 require_atom (atom_type type
)
1147 get_module_locus (&m
);
1155 p
= _("Expected name");
1158 p
= _("Expected left parenthesis");
1161 p
= _("Expected right parenthesis");
1164 p
= _("Expected integer");
1167 p
= _("Expected string");
1170 gfc_internal_error ("require_atom(): bad atom type required");
1173 set_module_locus (&m
);
1179 /* Given a pointer to an mstring array, require that the current input
1180 be one of the strings in the array. We return the enum value. */
1183 find_enum (const mstring
* m
)
1187 i
= gfc_string2code (m
, atom_name
);
1191 bad_module ("find_enum(): Enum not found");
1197 /**************** Module output subroutines ***************************/
1199 /* Output a character to a module file. */
1202 write_char (char out
)
1205 if (fputc (out
, module_fp
) == EOF
)
1206 gfc_fatal_error ("Error writing modules file: %s", strerror (errno
));
1218 /* Write an atom to a module. The line wrapping isn't perfect, but it
1219 should work most of the time. This isn't that big of a deal, since
1220 the file really isn't meant to be read by people anyway. */
1223 write_atom (atom_type atom
, const void *v
)
1245 i
= *((const int *) v
);
1247 gfc_internal_error ("write_atom(): Writing negative integer");
1249 sprintf (buffer
, "%d", i
);
1254 gfc_internal_error ("write_atom(): Trying to write dab atom");
1260 if (atom
!= ATOM_RPAREN
)
1262 if (module_column
+ len
> 72)
1267 if (last_atom
!= ATOM_LPAREN
&& module_column
!= 1)
1272 if (atom
== ATOM_STRING
)
1277 if (atom
== ATOM_STRING
&& *p
== '\'')
1282 if (atom
== ATOM_STRING
)
1290 /***************** Mid-level I/O subroutines *****************/
1292 /* These subroutines let their caller read or write atoms without
1293 caring about which of the two is actually happening. This lets a
1294 subroutine concentrate on the actual format of the data being
1297 static void mio_expr (gfc_expr
**);
1298 static void mio_symbol_ref (gfc_symbol
**);
1299 static void mio_symtree_ref (gfc_symtree
**);
1301 /* Read or write an enumerated value. On writing, we return the input
1302 value for the convenience of callers. We avoid using an integer
1303 pointer because enums are sometimes inside bitfields. */
1306 mio_name (int t
, const mstring
* m
)
1309 if (iomode
== IO_OUTPUT
)
1310 write_atom (ATOM_NAME
, gfc_code2string (m
, t
));
1313 require_atom (ATOM_NAME
);
1320 /* Specialization of mio_name. */
1322 #define DECL_MIO_NAME(TYPE) \
1323 static inline TYPE \
1324 MIO_NAME(TYPE) (TYPE t, const mstring * m) \
1326 return (TYPE)mio_name ((int)t, m); \
1328 #define MIO_NAME(TYPE) mio_name_##TYPE
1334 if (iomode
== IO_OUTPUT
)
1335 write_atom (ATOM_LPAREN
, NULL
);
1337 require_atom (ATOM_LPAREN
);
1345 if (iomode
== IO_OUTPUT
)
1346 write_atom (ATOM_RPAREN
, NULL
);
1348 require_atom (ATOM_RPAREN
);
1353 mio_integer (int *ip
)
1356 if (iomode
== IO_OUTPUT
)
1357 write_atom (ATOM_INTEGER
, ip
);
1360 require_atom (ATOM_INTEGER
);
1366 /* Read or write a character pointer that points to a string on the
1370 mio_allocated_string (const char *s
)
1372 if (iomode
== IO_OUTPUT
)
1374 write_atom (ATOM_STRING
, s
);
1379 require_atom (ATOM_STRING
);
1385 /* Read or write a string that is in static memory. */
1388 mio_pool_string (const char **stringp
)
1390 /* TODO: one could write the string only once, and refer to it via a
1393 /* As a special case we have to deal with a NULL string. This
1394 happens for the 'module' member of 'gfc_symbol's that are not in a
1395 module. We read / write these as the empty string. */
1396 if (iomode
== IO_OUTPUT
)
1398 const char *p
= *stringp
== NULL
? "" : *stringp
;
1399 write_atom (ATOM_STRING
, p
);
1403 require_atom (ATOM_STRING
);
1404 *stringp
= atom_string
[0] == '\0' ? NULL
: gfc_get_string (atom_string
);
1405 gfc_free (atom_string
);
1410 /* Read or write a string that is inside of some already-allocated
1414 mio_internal_string (char *string
)
1417 if (iomode
== IO_OUTPUT
)
1418 write_atom (ATOM_STRING
, string
);
1421 require_atom (ATOM_STRING
);
1422 strcpy (string
, atom_string
);
1423 gfc_free (atom_string
);
1430 { AB_ALLOCATABLE
, AB_DIMENSION
, AB_EXTERNAL
, AB_INTRINSIC
, AB_OPTIONAL
,
1431 AB_POINTER
, AB_SAVE
, AB_TARGET
, AB_DUMMY
, AB_RESULT
,
1432 AB_DATA
, AB_IN_NAMELIST
, AB_IN_COMMON
,
1433 AB_FUNCTION
, AB_SUBROUTINE
, AB_SEQUENCE
, AB_ELEMENTAL
, AB_PURE
,
1434 AB_RECURSIVE
, AB_GENERIC
, AB_ALWAYS_EXPLICIT
1438 static const mstring attr_bits
[] =
1440 minit ("ALLOCATABLE", AB_ALLOCATABLE
),
1441 minit ("DIMENSION", AB_DIMENSION
),
1442 minit ("EXTERNAL", AB_EXTERNAL
),
1443 minit ("INTRINSIC", AB_INTRINSIC
),
1444 minit ("OPTIONAL", AB_OPTIONAL
),
1445 minit ("POINTER", AB_POINTER
),
1446 minit ("SAVE", AB_SAVE
),
1447 minit ("TARGET", AB_TARGET
),
1448 minit ("DUMMY", AB_DUMMY
),
1449 minit ("RESULT", AB_RESULT
),
1450 minit ("DATA", AB_DATA
),
1451 minit ("IN_NAMELIST", AB_IN_NAMELIST
),
1452 minit ("IN_COMMON", AB_IN_COMMON
),
1453 minit ("FUNCTION", AB_FUNCTION
),
1454 minit ("SUBROUTINE", AB_SUBROUTINE
),
1455 minit ("SEQUENCE", AB_SEQUENCE
),
1456 minit ("ELEMENTAL", AB_ELEMENTAL
),
1457 minit ("PURE", AB_PURE
),
1458 minit ("RECURSIVE", AB_RECURSIVE
),
1459 minit ("GENERIC", AB_GENERIC
),
1460 minit ("ALWAYS_EXPLICIT", AB_ALWAYS_EXPLICIT
),
1464 /* Specialization of mio_name. */
1465 DECL_MIO_NAME(ab_attribute
)
1466 DECL_MIO_NAME(ar_type
)
1467 DECL_MIO_NAME(array_type
)
1469 DECL_MIO_NAME(expr_t
)
1470 DECL_MIO_NAME(gfc_access
)
1471 DECL_MIO_NAME(gfc_intrinsic_op
)
1472 DECL_MIO_NAME(ifsrc
)
1473 DECL_MIO_NAME(procedure_type
)
1474 DECL_MIO_NAME(ref_type
)
1475 DECL_MIO_NAME(sym_flavor
)
1476 DECL_MIO_NAME(sym_intent
)
1477 #undef DECL_MIO_NAME
1479 /* Symbol attributes are stored in list with the first three elements
1480 being the enumerated fields, while the remaining elements (if any)
1481 indicate the individual attribute bits. The access field is not
1482 saved-- it controls what symbols are exported when a module is
1486 mio_symbol_attribute (symbol_attribute
* attr
)
1492 attr
->flavor
= MIO_NAME(sym_flavor
) (attr
->flavor
, flavors
);
1493 attr
->intent
= MIO_NAME(sym_intent
) (attr
->intent
, intents
);
1494 attr
->proc
= MIO_NAME(procedure_type
) (attr
->proc
, procedures
);
1495 attr
->if_source
= MIO_NAME(ifsrc
) (attr
->if_source
, ifsrc_types
);
1497 if (iomode
== IO_OUTPUT
)
1499 if (attr
->allocatable
)
1500 MIO_NAME(ab_attribute
) (AB_ALLOCATABLE
, attr_bits
);
1501 if (attr
->dimension
)
1502 MIO_NAME(ab_attribute
) (AB_DIMENSION
, attr_bits
);
1504 MIO_NAME(ab_attribute
) (AB_EXTERNAL
, attr_bits
);
1505 if (attr
->intrinsic
)
1506 MIO_NAME(ab_attribute
) (AB_INTRINSIC
, attr_bits
);
1508 MIO_NAME(ab_attribute
) (AB_OPTIONAL
, attr_bits
);
1510 MIO_NAME(ab_attribute
) (AB_POINTER
, attr_bits
);
1512 MIO_NAME(ab_attribute
) (AB_SAVE
, attr_bits
);
1514 MIO_NAME(ab_attribute
) (AB_TARGET
, attr_bits
);
1516 MIO_NAME(ab_attribute
) (AB_DUMMY
, attr_bits
);
1518 MIO_NAME(ab_attribute
) (AB_RESULT
, attr_bits
);
1519 /* We deliberately don't preserve the "entry" flag. */
1522 MIO_NAME(ab_attribute
) (AB_DATA
, attr_bits
);
1523 if (attr
->in_namelist
)
1524 MIO_NAME(ab_attribute
) (AB_IN_NAMELIST
, attr_bits
);
1525 if (attr
->in_common
)
1526 MIO_NAME(ab_attribute
) (AB_IN_COMMON
, attr_bits
);
1529 MIO_NAME(ab_attribute
) (AB_FUNCTION
, attr_bits
);
1530 if (attr
->subroutine
)
1531 MIO_NAME(ab_attribute
) (AB_SUBROUTINE
, attr_bits
);
1533 MIO_NAME(ab_attribute
) (AB_GENERIC
, attr_bits
);
1536 MIO_NAME(ab_attribute
) (AB_SEQUENCE
, attr_bits
);
1537 if (attr
->elemental
)
1538 MIO_NAME(ab_attribute
) (AB_ELEMENTAL
, attr_bits
);
1540 MIO_NAME(ab_attribute
) (AB_PURE
, attr_bits
);
1541 if (attr
->recursive
)
1542 MIO_NAME(ab_attribute
) (AB_RECURSIVE
, attr_bits
);
1543 if (attr
->always_explicit
)
1544 MIO_NAME(ab_attribute
) (AB_ALWAYS_EXPLICIT
, attr_bits
);
1555 if (t
== ATOM_RPAREN
)
1558 bad_module ("Expected attribute bit name");
1560 switch ((ab_attribute
) find_enum (attr_bits
))
1562 case AB_ALLOCATABLE
:
1563 attr
->allocatable
= 1;
1566 attr
->dimension
= 1;
1572 attr
->intrinsic
= 1;
1595 case AB_IN_NAMELIST
:
1596 attr
->in_namelist
= 1;
1599 attr
->in_common
= 1;
1605 attr
->subroutine
= 1;
1614 attr
->elemental
= 1;
1620 attr
->recursive
= 1;
1622 case AB_ALWAYS_EXPLICIT
:
1623 attr
->always_explicit
= 1;
1631 static const mstring bt_types
[] = {
1632 minit ("INTEGER", BT_INTEGER
),
1633 minit ("REAL", BT_REAL
),
1634 minit ("COMPLEX", BT_COMPLEX
),
1635 minit ("LOGICAL", BT_LOGICAL
),
1636 minit ("CHARACTER", BT_CHARACTER
),
1637 minit ("DERIVED", BT_DERIVED
),
1638 minit ("PROCEDURE", BT_PROCEDURE
),
1639 minit ("UNKNOWN", BT_UNKNOWN
),
1645 mio_charlen (gfc_charlen
** clp
)
1651 if (iomode
== IO_OUTPUT
)
1655 mio_expr (&cl
->length
);
1660 if (peek_atom () != ATOM_RPAREN
)
1662 cl
= gfc_get_charlen ();
1663 mio_expr (&cl
->length
);
1667 cl
->next
= gfc_current_ns
->cl_list
;
1668 gfc_current_ns
->cl_list
= cl
;
1676 /* Return a symtree node with a name that is guaranteed to be unique
1677 within the namespace and corresponds to an illegal fortran name. */
1679 static gfc_symtree
*
1680 get_unique_symtree (gfc_namespace
* ns
)
1682 char name
[GFC_MAX_SYMBOL_LEN
+ 1];
1683 static int serial
= 0;
1685 sprintf (name
, "@%d", serial
++);
1686 return gfc_new_symtree (&ns
->sym_root
, name
);
1690 /* See if a name is a generated name. */
1693 check_unique_name (const char *name
)
1696 return *name
== '@';
1701 mio_typespec (gfc_typespec
* ts
)
1706 ts
->type
= MIO_NAME(bt
) (ts
->type
, bt_types
);
1708 if (ts
->type
!= BT_DERIVED
)
1709 mio_integer (&ts
->kind
);
1711 mio_symbol_ref (&ts
->derived
);
1713 mio_charlen (&ts
->cl
);
1719 static const mstring array_spec_types
[] = {
1720 minit ("EXPLICIT", AS_EXPLICIT
),
1721 minit ("ASSUMED_SHAPE", AS_ASSUMED_SHAPE
),
1722 minit ("DEFERRED", AS_DEFERRED
),
1723 minit ("ASSUMED_SIZE", AS_ASSUMED_SIZE
),
1729 mio_array_spec (gfc_array_spec
** asp
)
1736 if (iomode
== IO_OUTPUT
)
1744 if (peek_atom () == ATOM_RPAREN
)
1750 *asp
= as
= gfc_get_array_spec ();
1753 mio_integer (&as
->rank
);
1754 as
->type
= MIO_NAME(array_type
) (as
->type
, array_spec_types
);
1756 for (i
= 0; i
< as
->rank
; i
++)
1758 mio_expr (&as
->lower
[i
]);
1759 mio_expr (&as
->upper
[i
]);
1767 /* Given a pointer to an array reference structure (which lives in a
1768 gfc_ref structure), find the corresponding array specification
1769 structure. Storing the pointer in the ref structure doesn't quite
1770 work when loading from a module. Generating code for an array
1771 reference also needs more information than just the array spec. */
1773 static const mstring array_ref_types
[] = {
1774 minit ("FULL", AR_FULL
),
1775 minit ("ELEMENT", AR_ELEMENT
),
1776 minit ("SECTION", AR_SECTION
),
1781 mio_array_ref (gfc_array_ref
* ar
)
1786 ar
->type
= MIO_NAME(ar_type
) (ar
->type
, array_ref_types
);
1787 mio_integer (&ar
->dimen
);
1795 for (i
= 0; i
< ar
->dimen
; i
++)
1796 mio_expr (&ar
->start
[i
]);
1801 for (i
= 0; i
< ar
->dimen
; i
++)
1803 mio_expr (&ar
->start
[i
]);
1804 mio_expr (&ar
->end
[i
]);
1805 mio_expr (&ar
->stride
[i
]);
1811 gfc_internal_error ("mio_array_ref(): Unknown array ref");
1814 for (i
= 0; i
< ar
->dimen
; i
++)
1815 mio_integer ((int *) &ar
->dimen_type
[i
]);
1817 if (iomode
== IO_INPUT
)
1819 ar
->where
= gfc_current_locus
;
1821 for (i
= 0; i
< ar
->dimen
; i
++)
1822 ar
->c_where
[i
] = gfc_current_locus
;
1829 /* Saves or restores a pointer. The pointer is converted back and
1830 forth from an integer. We return the pointer_info pointer so that
1831 the caller can take additional action based on the pointer type. */
1833 static pointer_info
*
1834 mio_pointer_ref (void *gp
)
1838 if (iomode
== IO_OUTPUT
)
1840 p
= get_pointer (*((char **) gp
));
1841 write_atom (ATOM_INTEGER
, &p
->integer
);
1845 require_atom (ATOM_INTEGER
);
1846 p
= add_fixup (atom_int
, gp
);
1853 /* Save and load references to components that occur within
1854 expressions. We have to describe these references by a number and
1855 by name. The number is necessary for forward references during
1856 reading, and the name is necessary if the symbol already exists in
1857 the namespace and is not loaded again. */
1860 mio_component_ref (gfc_component
** cp
, gfc_symbol
* sym
)
1862 char name
[GFC_MAX_SYMBOL_LEN
+ 1];
1866 p
= mio_pointer_ref (cp
);
1867 if (p
->type
== P_UNKNOWN
)
1868 p
->type
= P_COMPONENT
;
1870 if (iomode
== IO_OUTPUT
)
1871 mio_pool_string (&(*cp
)->name
);
1874 mio_internal_string (name
);
1876 /* It can happen that a component reference can be read before the
1877 associated derived type symbol has been loaded. Return now and
1878 wait for a later iteration of load_needed. */
1882 if (sym
->components
!= NULL
&& p
->u
.pointer
== NULL
)
1884 /* Symbol already loaded, so search by name. */
1885 for (q
= sym
->components
; q
; q
= q
->next
)
1886 if (strcmp (q
->name
, name
) == 0)
1890 gfc_internal_error ("mio_component_ref(): Component not found");
1892 associate_integer_pointer (p
, q
);
1895 /* Make sure this symbol will eventually be loaded. */
1896 p
= find_pointer2 (sym
);
1897 if (p
->u
.rsym
.state
== UNUSED
)
1898 p
->u
.rsym
.state
= NEEDED
;
1904 mio_component (gfc_component
* c
)
1911 if (iomode
== IO_OUTPUT
)
1913 p
= get_pointer (c
);
1914 mio_integer (&p
->integer
);
1919 p
= get_integer (n
);
1920 associate_integer_pointer (p
, c
);
1923 if (p
->type
== P_UNKNOWN
)
1924 p
->type
= P_COMPONENT
;
1926 mio_pool_string (&c
->name
);
1927 mio_typespec (&c
->ts
);
1928 mio_array_spec (&c
->as
);
1930 mio_integer (&c
->dimension
);
1931 mio_integer (&c
->pointer
);
1933 mio_expr (&c
->initializer
);
1939 mio_component_list (gfc_component
** cp
)
1941 gfc_component
*c
, *tail
;
1945 if (iomode
== IO_OUTPUT
)
1947 for (c
= *cp
; c
; c
= c
->next
)
1958 if (peek_atom () == ATOM_RPAREN
)
1961 c
= gfc_get_component ();
1978 mio_actual_arg (gfc_actual_arglist
* a
)
1982 mio_pool_string (&a
->name
);
1983 mio_expr (&a
->expr
);
1989 mio_actual_arglist (gfc_actual_arglist
** ap
)
1991 gfc_actual_arglist
*a
, *tail
;
1995 if (iomode
== IO_OUTPUT
)
1997 for (a
= *ap
; a
; a
= a
->next
)
2007 if (peek_atom () != ATOM_LPAREN
)
2010 a
= gfc_get_actual_arglist ();
2026 /* Read and write formal argument lists. */
2029 mio_formal_arglist (gfc_symbol
* sym
)
2031 gfc_formal_arglist
*f
, *tail
;
2035 if (iomode
== IO_OUTPUT
)
2037 for (f
= sym
->formal
; f
; f
= f
->next
)
2038 mio_symbol_ref (&f
->sym
);
2043 sym
->formal
= tail
= NULL
;
2045 while (peek_atom () != ATOM_RPAREN
)
2047 f
= gfc_get_formal_arglist ();
2048 mio_symbol_ref (&f
->sym
);
2050 if (sym
->formal
== NULL
)
2063 /* Save or restore a reference to a symbol node. */
2066 mio_symbol_ref (gfc_symbol
** symp
)
2070 p
= mio_pointer_ref (symp
);
2071 if (p
->type
== P_UNKNOWN
)
2074 if (iomode
== IO_OUTPUT
)
2076 if (p
->u
.wsym
.state
== UNREFERENCED
)
2077 p
->u
.wsym
.state
= NEEDS_WRITE
;
2081 if (p
->u
.rsym
.state
== UNUSED
)
2082 p
->u
.rsym
.state
= NEEDED
;
2087 /* Save or restore a reference to a symtree node. */
2090 mio_symtree_ref (gfc_symtree
** stp
)
2094 gfc_symtree
* ns_st
= NULL
;
2096 if (iomode
== IO_OUTPUT
)
2098 /* If this is a symtree for a symbol that came from a contained module
2099 namespace, it has a unique name and we should look in the current
2100 namespace to see if the required, non-contained symbol is available
2101 yet. If so, the latter should be written. */
2102 if ((*stp
)->n
.sym
&& check_unique_name((*stp
)->name
))
2103 ns_st
= gfc_find_symtree (gfc_current_ns
->sym_root
, (*stp
)->n
.sym
->name
);
2105 mio_symbol_ref (ns_st
? &ns_st
->n
.sym
: &(*stp
)->n
.sym
);
2109 require_atom (ATOM_INTEGER
);
2110 p
= get_integer (atom_int
);
2111 if (p
->type
== P_UNKNOWN
)
2114 if (p
->u
.rsym
.state
== UNUSED
)
2115 p
->u
.rsym
.state
= NEEDED
;
2117 if (p
->u
.rsym
.symtree
!= NULL
)
2119 *stp
= p
->u
.rsym
.symtree
;
2123 f
= gfc_getmem (sizeof (fixup_t
));
2125 f
->next
= p
->u
.rsym
.stfixup
;
2126 p
->u
.rsym
.stfixup
= f
;
2128 f
->pointer
= (void **)stp
;
2134 mio_iterator (gfc_iterator
** ip
)
2140 if (iomode
== IO_OUTPUT
)
2147 if (peek_atom () == ATOM_RPAREN
)
2153 *ip
= gfc_get_iterator ();
2158 mio_expr (&iter
->var
);
2159 mio_expr (&iter
->start
);
2160 mio_expr (&iter
->end
);
2161 mio_expr (&iter
->step
);
2170 mio_constructor (gfc_constructor
** cp
)
2172 gfc_constructor
*c
, *tail
;
2176 if (iomode
== IO_OUTPUT
)
2178 for (c
= *cp
; c
; c
= c
->next
)
2181 mio_expr (&c
->expr
);
2182 mio_iterator (&c
->iterator
);
2192 while (peek_atom () != ATOM_RPAREN
)
2194 c
= gfc_get_constructor ();
2204 mio_expr (&c
->expr
);
2205 mio_iterator (&c
->iterator
);
2215 static const mstring ref_types
[] = {
2216 minit ("ARRAY", REF_ARRAY
),
2217 minit ("COMPONENT", REF_COMPONENT
),
2218 minit ("SUBSTRING", REF_SUBSTRING
),
2224 mio_ref (gfc_ref
** rp
)
2231 r
->type
= MIO_NAME(ref_type
) (r
->type
, ref_types
);
2236 mio_array_ref (&r
->u
.ar
);
2240 mio_symbol_ref (&r
->u
.c
.sym
);
2241 mio_component_ref (&r
->u
.c
.component
, r
->u
.c
.sym
);
2245 mio_expr (&r
->u
.ss
.start
);
2246 mio_expr (&r
->u
.ss
.end
);
2247 mio_charlen (&r
->u
.ss
.length
);
2256 mio_ref_list (gfc_ref
** rp
)
2258 gfc_ref
*ref
, *head
, *tail
;
2262 if (iomode
== IO_OUTPUT
)
2264 for (ref
= *rp
; ref
; ref
= ref
->next
)
2271 while (peek_atom () != ATOM_RPAREN
)
2274 head
= tail
= gfc_get_ref ();
2277 tail
->next
= gfc_get_ref ();
2291 /* Read and write an integer value. */
2294 mio_gmp_integer (mpz_t
* integer
)
2298 if (iomode
== IO_INPUT
)
2300 if (parse_atom () != ATOM_STRING
)
2301 bad_module ("Expected integer string");
2303 mpz_init (*integer
);
2304 if (mpz_set_str (*integer
, atom_string
, 10))
2305 bad_module ("Error converting integer");
2307 gfc_free (atom_string
);
2312 p
= mpz_get_str (NULL
, 10, *integer
);
2313 write_atom (ATOM_STRING
, p
);
2320 mio_gmp_real (mpfr_t
* real
)
2325 if (iomode
== IO_INPUT
)
2327 if (parse_atom () != ATOM_STRING
)
2328 bad_module ("Expected real string");
2331 mpfr_set_str (*real
, atom_string
, 16, GFC_RND_MODE
);
2332 gfc_free (atom_string
);
2337 p
= mpfr_get_str (NULL
, &exponent
, 16, 0, *real
, GFC_RND_MODE
);
2338 atom_string
= gfc_getmem (strlen (p
) + 20);
2340 sprintf (atom_string
, "0.%s@%ld", p
, exponent
);
2342 /* Fix negative numbers. */
2343 if (atom_string
[2] == '-')
2345 atom_string
[0] = '-';
2346 atom_string
[1] = '0';
2347 atom_string
[2] = '.';
2350 write_atom (ATOM_STRING
, atom_string
);
2352 gfc_free (atom_string
);
2358 /* Save and restore the shape of an array constructor. */
2361 mio_shape (mpz_t
** pshape
, int rank
)
2367 /* A NULL shape is represented by (). */
2370 if (iomode
== IO_OUTPUT
)
2382 if (t
== ATOM_RPAREN
)
2389 shape
= gfc_get_shape (rank
);
2393 for (n
= 0; n
< rank
; n
++)
2394 mio_gmp_integer (&shape
[n
]);
2400 static const mstring expr_types
[] = {
2401 minit ("OP", EXPR_OP
),
2402 minit ("FUNCTION", EXPR_FUNCTION
),
2403 minit ("CONSTANT", EXPR_CONSTANT
),
2404 minit ("VARIABLE", EXPR_VARIABLE
),
2405 minit ("SUBSTRING", EXPR_SUBSTRING
),
2406 minit ("STRUCTURE", EXPR_STRUCTURE
),
2407 minit ("ARRAY", EXPR_ARRAY
),
2408 minit ("NULL", EXPR_NULL
),
2412 /* INTRINSIC_ASSIGN is missing because it is used as an index for
2413 generic operators, not in expressions. INTRINSIC_USER is also
2414 replaced by the correct function name by the time we see it. */
2416 static const mstring intrinsics
[] =
2418 minit ("UPLUS", INTRINSIC_UPLUS
),
2419 minit ("UMINUS", INTRINSIC_UMINUS
),
2420 minit ("PLUS", INTRINSIC_PLUS
),
2421 minit ("MINUS", INTRINSIC_MINUS
),
2422 minit ("TIMES", INTRINSIC_TIMES
),
2423 minit ("DIVIDE", INTRINSIC_DIVIDE
),
2424 minit ("POWER", INTRINSIC_POWER
),
2425 minit ("CONCAT", INTRINSIC_CONCAT
),
2426 minit ("AND", INTRINSIC_AND
),
2427 minit ("OR", INTRINSIC_OR
),
2428 minit ("EQV", INTRINSIC_EQV
),
2429 minit ("NEQV", INTRINSIC_NEQV
),
2430 minit ("EQ", INTRINSIC_EQ
),
2431 minit ("NE", INTRINSIC_NE
),
2432 minit ("GT", INTRINSIC_GT
),
2433 minit ("GE", INTRINSIC_GE
),
2434 minit ("LT", INTRINSIC_LT
),
2435 minit ("LE", INTRINSIC_LE
),
2436 minit ("NOT", INTRINSIC_NOT
),
2440 /* Read and write expressions. The form "()" is allowed to indicate a
2444 mio_expr (gfc_expr
** ep
)
2452 if (iomode
== IO_OUTPUT
)
2461 MIO_NAME(expr_t
) (e
->expr_type
, expr_types
);
2467 if (t
== ATOM_RPAREN
)
2474 bad_module ("Expected expression type");
2476 e
= *ep
= gfc_get_expr ();
2477 e
->where
= gfc_current_locus
;
2478 e
->expr_type
= (expr_t
) find_enum (expr_types
);
2481 mio_typespec (&e
->ts
);
2482 mio_integer (&e
->rank
);
2484 switch (e
->expr_type
)
2487 e
->value
.op
.operator
2488 = MIO_NAME(gfc_intrinsic_op
) (e
->value
.op
.operator, intrinsics
);
2490 switch (e
->value
.op
.operator)
2492 case INTRINSIC_UPLUS
:
2493 case INTRINSIC_UMINUS
:
2495 mio_expr (&e
->value
.op
.op1
);
2498 case INTRINSIC_PLUS
:
2499 case INTRINSIC_MINUS
:
2500 case INTRINSIC_TIMES
:
2501 case INTRINSIC_DIVIDE
:
2502 case INTRINSIC_POWER
:
2503 case INTRINSIC_CONCAT
:
2507 case INTRINSIC_NEQV
:
2514 mio_expr (&e
->value
.op
.op1
);
2515 mio_expr (&e
->value
.op
.op2
);
2519 bad_module ("Bad operator");
2525 mio_symtree_ref (&e
->symtree
);
2526 mio_actual_arglist (&e
->value
.function
.actual
);
2528 if (iomode
== IO_OUTPUT
)
2530 e
->value
.function
.name
2531 = mio_allocated_string (e
->value
.function
.name
);
2532 flag
= e
->value
.function
.esym
!= NULL
;
2533 mio_integer (&flag
);
2535 mio_symbol_ref (&e
->value
.function
.esym
);
2537 write_atom (ATOM_STRING
, e
->value
.function
.isym
->name
);
2542 require_atom (ATOM_STRING
);
2543 e
->value
.function
.name
= gfc_get_string (atom_string
);
2544 gfc_free (atom_string
);
2546 mio_integer (&flag
);
2548 mio_symbol_ref (&e
->value
.function
.esym
);
2551 require_atom (ATOM_STRING
);
2552 e
->value
.function
.isym
= gfc_find_function (atom_string
);
2553 gfc_free (atom_string
);
2560 mio_symtree_ref (&e
->symtree
);
2561 mio_ref_list (&e
->ref
);
2564 case EXPR_SUBSTRING
:
2565 e
->value
.character
.string
= (char *)
2566 mio_allocated_string (e
->value
.character
.string
);
2567 mio_ref_list (&e
->ref
);
2570 case EXPR_STRUCTURE
:
2572 mio_constructor (&e
->value
.constructor
);
2573 mio_shape (&e
->shape
, e
->rank
);
2580 mio_gmp_integer (&e
->value
.integer
);
2584 gfc_set_model_kind (e
->ts
.kind
);
2585 mio_gmp_real (&e
->value
.real
);
2589 gfc_set_model_kind (e
->ts
.kind
);
2590 mio_gmp_real (&e
->value
.complex.r
);
2591 mio_gmp_real (&e
->value
.complex.i
);
2595 mio_integer (&e
->value
.logical
);
2599 mio_integer (&e
->value
.character
.length
);
2600 e
->value
.character
.string
= (char *)
2601 mio_allocated_string (e
->value
.character
.string
);
2605 bad_module ("Bad type in constant expression");
2618 /* Read and write namelists */
2621 mio_namelist (gfc_symbol
* sym
)
2623 gfc_namelist
*n
, *m
;
2624 const char *check_name
;
2628 if (iomode
== IO_OUTPUT
)
2630 for (n
= sym
->namelist
; n
; n
= n
->next
)
2631 mio_symbol_ref (&n
->sym
);
2635 /* This departure from the standard is flagged as an error.
2636 It does, in fact, work correctly. TODO: Allow it
2638 if (sym
->attr
.flavor
== FL_NAMELIST
)
2640 check_name
= find_use_name (sym
->name
);
2641 if (check_name
&& strcmp (check_name
, sym
->name
) != 0)
2642 gfc_error("Namelist %s cannot be renamed by USE"
2643 " association to %s.",
2644 sym
->name
, check_name
);
2648 while (peek_atom () != ATOM_RPAREN
)
2650 n
= gfc_get_namelist ();
2651 mio_symbol_ref (&n
->sym
);
2653 if (sym
->namelist
== NULL
)
2660 sym
->namelist_tail
= m
;
2667 /* Save/restore lists of gfc_interface stuctures. When loading an
2668 interface, we are really appending to the existing list of
2669 interfaces. Checking for duplicate and ambiguous interfaces has to
2670 be done later when all symbols have been loaded. */
2673 mio_interface_rest (gfc_interface
** ip
)
2675 gfc_interface
*tail
, *p
;
2677 if (iomode
== IO_OUTPUT
)
2680 for (p
= *ip
; p
; p
= p
->next
)
2681 mio_symbol_ref (&p
->sym
);
2697 if (peek_atom () == ATOM_RPAREN
)
2700 p
= gfc_get_interface ();
2701 p
->where
= gfc_current_locus
;
2702 mio_symbol_ref (&p
->sym
);
2717 /* Save/restore a nameless operator interface. */
2720 mio_interface (gfc_interface
** ip
)
2724 mio_interface_rest (ip
);
2728 /* Save/restore a named operator interface. */
2731 mio_symbol_interface (const char **name
, const char **module
,
2732 gfc_interface
** ip
)
2737 mio_pool_string (name
);
2738 mio_pool_string (module
);
2740 mio_interface_rest (ip
);
2745 mio_namespace_ref (gfc_namespace
** nsp
)
2750 p
= mio_pointer_ref (nsp
);
2752 if (p
->type
== P_UNKNOWN
)
2753 p
->type
= P_NAMESPACE
;
2755 if (iomode
== IO_INPUT
&& p
->integer
!= 0)
2757 ns
= (gfc_namespace
*)p
->u
.pointer
;
2760 ns
= gfc_get_namespace (NULL
, 0);
2761 associate_integer_pointer (p
, ns
);
2769 /* Unlike most other routines, the address of the symbol node is
2770 already fixed on input and the name/module has already been filled
2774 mio_symbol (gfc_symbol
* sym
)
2776 gfc_formal_arglist
*formal
;
2780 mio_symbol_attribute (&sym
->attr
);
2781 mio_typespec (&sym
->ts
);
2783 /* Contained procedures don't have formal namespaces. Instead we output the
2784 procedure namespace. The will contain the formal arguments. */
2785 if (iomode
== IO_OUTPUT
)
2787 formal
= sym
->formal
;
2788 while (formal
&& !formal
->sym
)
2789 formal
= formal
->next
;
2792 mio_namespace_ref (&formal
->sym
->ns
);
2794 mio_namespace_ref (&sym
->formal_ns
);
2798 mio_namespace_ref (&sym
->formal_ns
);
2801 sym
->formal_ns
->proc_name
= sym
;
2806 /* Save/restore common block links */
2807 mio_symbol_ref (&sym
->common_next
);
2809 mio_formal_arglist (sym
);
2811 if (sym
->attr
.flavor
== FL_PARAMETER
)
2812 mio_expr (&sym
->value
);
2814 mio_array_spec (&sym
->as
);
2816 mio_symbol_ref (&sym
->result
);
2818 /* Note that components are always saved, even if they are supposed
2819 to be private. Component access is checked during searching. */
2821 mio_component_list (&sym
->components
);
2823 if (sym
->components
!= NULL
)
2824 sym
->component_access
=
2825 MIO_NAME(gfc_access
) (sym
->component_access
, access_types
);
2832 /************************* Top level subroutines *************************/
2834 /* Skip a list between balanced left and right parens. */
2844 switch (parse_atom ())
2855 gfc_free (atom_string
);
2867 /* Load operator interfaces from the module. Interfaces are unusual
2868 in that they attach themselves to existing symbols. */
2871 load_operator_interfaces (void)
2874 char name
[GFC_MAX_SYMBOL_LEN
+ 1], module
[GFC_MAX_SYMBOL_LEN
+ 1];
2879 while (peek_atom () != ATOM_RPAREN
)
2883 mio_internal_string (name
);
2884 mio_internal_string (module
);
2886 /* Decide if we need to load this one or not. */
2887 p
= find_use_name (name
);
2890 while (parse_atom () != ATOM_RPAREN
);
2894 uop
= gfc_get_uop (p
);
2895 mio_interface_rest (&uop
->operator);
2903 /* Load interfaces from the module. Interfaces are unusual in that
2904 they attach themselves to existing symbols. */
2907 load_generic_interfaces (void)
2910 char name
[GFC_MAX_SYMBOL_LEN
+ 1], module
[GFC_MAX_SYMBOL_LEN
+ 1];
2915 while (peek_atom () != ATOM_RPAREN
)
2919 mio_internal_string (name
);
2920 mio_internal_string (module
);
2922 /* Decide if we need to load this one or not. */
2923 p
= find_use_name (name
);
2925 if (p
== NULL
|| gfc_find_symbol (p
, NULL
, 0, &sym
))
2927 while (parse_atom () != ATOM_RPAREN
);
2933 gfc_get_symbol (p
, NULL
, &sym
);
2935 sym
->attr
.flavor
= FL_PROCEDURE
;
2936 sym
->attr
.generic
= 1;
2937 sym
->attr
.use_assoc
= 1;
2940 mio_interface_rest (&sym
->generic
);
2947 /* Load common blocks. */
2952 char name
[GFC_MAX_SYMBOL_LEN
+1];
2957 while (peek_atom () != ATOM_RPAREN
)
2960 mio_internal_string (name
);
2962 p
= gfc_get_common (name
, 1);
2964 mio_symbol_ref (&p
->head
);
2965 mio_integer (&p
->saved
);
2974 /* load_equiv()-- Load equivalences. */
2979 gfc_equiv
*head
, *tail
, *end
;
2983 end
= gfc_current_ns
->equiv
;
2984 while(end
!= NULL
&& end
->next
!= NULL
)
2987 while(peek_atom() != ATOM_RPAREN
) {
2991 while(peek_atom() != ATOM_RPAREN
)
2994 head
= tail
= gfc_get_equiv();
2997 tail
->eq
= gfc_get_equiv();
3001 mio_pool_string(&tail
->module
);
3002 mio_expr(&tail
->expr
);
3006 gfc_current_ns
->equiv
= head
;
3017 /* Recursive function to traverse the pointer_info tree and load a
3018 needed symbol. We return nonzero if we load a symbol and stop the
3019 traversal, because the act of loading can alter the tree. */
3022 load_needed (pointer_info
* p
)
3030 if (load_needed (p
->left
))
3032 if (load_needed (p
->right
))
3035 if (p
->type
!= P_SYMBOL
|| p
->u
.rsym
.state
!= NEEDED
)
3038 p
->u
.rsym
.state
= USED
;
3040 set_module_locus (&p
->u
.rsym
.where
);
3042 sym
= p
->u
.rsym
.sym
;
3045 q
= get_integer (p
->u
.rsym
.ns
);
3047 ns
= (gfc_namespace
*) q
->u
.pointer
;
3050 /* Create an interface namespace if necessary. These are
3051 the namespaces that hold the formal parameters of module
3054 ns
= gfc_get_namespace (NULL
, 0);
3055 associate_integer_pointer (q
, ns
);
3058 sym
= gfc_new_symbol (p
->u
.rsym
.true_name
, ns
);
3059 sym
->module
= gfc_get_string (p
->u
.rsym
.module
);
3061 associate_integer_pointer (p
, sym
);
3065 sym
->attr
.use_assoc
= 1;
3071 /* Recursive function for cleaning up things after a module has been
3075 read_cleanup (pointer_info
* p
)
3083 read_cleanup (p
->left
);
3084 read_cleanup (p
->right
);
3086 if (p
->type
== P_SYMBOL
&& p
->u
.rsym
.state
== USED
&& !p
->u
.rsym
.referenced
)
3088 /* Add hidden symbols to the symtree. */
3089 q
= get_integer (p
->u
.rsym
.ns
);
3090 st
= get_unique_symtree ((gfc_namespace
*) q
->u
.pointer
);
3092 st
->n
.sym
= p
->u
.rsym
.sym
;
3095 /* Fixup any symtree references. */
3096 p
->u
.rsym
.symtree
= st
;
3097 resolve_fixups (p
->u
.rsym
.stfixup
, st
);
3098 p
->u
.rsym
.stfixup
= NULL
;
3101 /* Free unused symbols. */
3102 if (p
->type
== P_SYMBOL
&& p
->u
.rsym
.state
== UNUSED
)
3103 gfc_free_symbol (p
->u
.rsym
.sym
);
3107 /* Read a module file. */
3112 module_locus operator_interfaces
, user_operators
;
3114 char name
[GFC_MAX_SYMBOL_LEN
+ 1];
3116 int ambiguous
, j
, nuse
, symbol
;
3122 get_module_locus (&operator_interfaces
); /* Skip these for now */
3125 get_module_locus (&user_operators
);
3129 /* Skip commons and equivalences for now. */
3135 /* Create the fixup nodes for all the symbols. */
3137 while (peek_atom () != ATOM_RPAREN
)
3139 require_atom (ATOM_INTEGER
);
3140 info
= get_integer (atom_int
);
3142 info
->type
= P_SYMBOL
;
3143 info
->u
.rsym
.state
= UNUSED
;
3145 mio_internal_string (info
->u
.rsym
.true_name
);
3146 mio_internal_string (info
->u
.rsym
.module
);
3148 require_atom (ATOM_INTEGER
);
3149 info
->u
.rsym
.ns
= atom_int
;
3151 get_module_locus (&info
->u
.rsym
.where
);
3154 /* See if the symbol has already been loaded by a previous module.
3155 If so, we reference the existing symbol and prevent it from
3156 being loaded again. */
3158 sym
= find_true_name (info
->u
.rsym
.true_name
, info
->u
.rsym
.module
);
3160 /* See if the symbol has already been loaded by a previous module.
3161 If so, we reference the existing symbol and prevent it from
3162 being loaded again. This should not happen if the symbol being
3163 read is an index for an assumed shape dummy array (ns != 1). */
3165 sym
= find_true_name (info
->u
.rsym
.true_name
, info
->u
.rsym
.module
);
3168 || (sym
->attr
.flavor
== FL_VARIABLE
3169 && info
->u
.rsym
.ns
!=1))
3172 info
->u
.rsym
.state
= USED
;
3173 info
->u
.rsym
.referenced
= 1;
3174 info
->u
.rsym
.sym
= sym
;
3179 /* Parse the symtree lists. This lets us mark which symbols need to
3180 be loaded. Renaming is also done at this point by replacing the
3185 while (peek_atom () != ATOM_RPAREN
)
3187 mio_internal_string (name
);
3188 mio_integer (&ambiguous
);
3189 mio_integer (&symbol
);
3191 info
= get_integer (symbol
);
3193 /* See how many use names there are. If none, go through the start
3194 of the loop at least once. */
3195 nuse
= number_use_names (name
);
3199 for (j
= 1; j
<= nuse
; j
++)
3201 /* Get the jth local name for this symbol. */
3202 p
= find_use_name_n (name
, &j
);
3204 /* Skip symtree nodes not in an ONLY clause. */
3208 /* Check for ambiguous symbols. */
3209 st
= gfc_find_symtree (gfc_current_ns
->sym_root
, p
);
3213 if (st
->n
.sym
!= info
->u
.rsym
.sym
)
3215 info
->u
.rsym
.symtree
= st
;
3219 /* Create a symtree node in the current namespace for this symbol. */
3220 st
= check_unique_name (p
) ? get_unique_symtree (gfc_current_ns
) :
3221 gfc_new_symtree (&gfc_current_ns
->sym_root
, p
);
3223 st
->ambiguous
= ambiguous
;
3225 sym
= info
->u
.rsym
.sym
;
3227 /* Create a symbol node if it doesn't already exist. */
3230 sym
= info
->u
.rsym
.sym
=
3231 gfc_new_symbol (info
->u
.rsym
.true_name
,
3234 sym
->module
= gfc_get_string (info
->u
.rsym
.module
);
3240 /* Store the symtree pointing to this symbol. */
3241 info
->u
.rsym
.symtree
= st
;
3243 if (info
->u
.rsym
.state
== UNUSED
)
3244 info
->u
.rsym
.state
= NEEDED
;
3245 info
->u
.rsym
.referenced
= 1;
3252 /* Load intrinsic operator interfaces. */
3253 set_module_locus (&operator_interfaces
);
3256 for (i
= GFC_INTRINSIC_BEGIN
; i
!= GFC_INTRINSIC_END
; i
++)
3258 if (i
== INTRINSIC_USER
)
3263 u
= find_use_operator (i
);
3274 mio_interface (&gfc_current_ns
->operator[i
]);
3279 /* Load generic and user operator interfaces. These must follow the
3280 loading of symtree because otherwise symbols can be marked as
3283 set_module_locus (&user_operators
);
3285 load_operator_interfaces ();
3286 load_generic_interfaces ();
3291 /* At this point, we read those symbols that are needed but haven't
3292 been loaded yet. If one symbol requires another, the other gets
3293 marked as NEEDED if its previous state was UNUSED. */
3295 while (load_needed (pi_root
));
3297 /* Make sure all elements of the rename-list were found in the
3300 for (u
= gfc_rename_list
; u
; u
= u
->next
)
3305 if (u
->operator == INTRINSIC_NONE
)
3307 gfc_error ("Symbol '%s' referenced at %L not found in module '%s'",
3308 u
->use_name
, &u
->where
, module_name
);
3312 if (u
->operator == INTRINSIC_USER
)
3315 ("User operator '%s' referenced at %L not found in module '%s'",
3316 u
->use_name
, &u
->where
, module_name
);
3321 ("Intrinsic operator '%s' referenced at %L not found in module "
3322 "'%s'", gfc_op2string (u
->operator), &u
->where
, module_name
);
3325 gfc_check_interfaces (gfc_current_ns
);
3327 /* Clean up symbol nodes that were never loaded, create references
3328 to hidden symbols. */
3330 read_cleanup (pi_root
);
3334 /* Given an access type that is specific to an entity and the default
3335 access, return nonzero if the entity is publicly accessible. */
3338 gfc_check_access (gfc_access specific_access
, gfc_access default_access
)
3341 if (specific_access
== ACCESS_PUBLIC
)
3343 if (specific_access
== ACCESS_PRIVATE
)
3346 if (gfc_option
.flag_module_access_private
)
3347 return default_access
== ACCESS_PUBLIC
;
3349 return default_access
!= ACCESS_PRIVATE
;
3355 /* Write a common block to the module */
3358 write_common (gfc_symtree
*st
)
3366 write_common(st
->left
);
3367 write_common(st
->right
);
3371 /* Write the unmangled name. */
3372 name
= st
->n
.common
->name
;
3374 mio_pool_string(&name
);
3377 mio_symbol_ref(&p
->head
);
3378 mio_integer(&p
->saved
);
3383 /* Write the blank common block to the module */
3386 write_blank_common (void)
3388 const char * name
= BLANK_COMMON_NAME
;
3390 if (gfc_current_ns
->blank_common
.head
== NULL
)
3395 mio_pool_string(&name
);
3397 mio_symbol_ref(&gfc_current_ns
->blank_common
.head
);
3398 mio_integer(&gfc_current_ns
->blank_common
.saved
);
3403 /* Write equivalences to the module. */
3412 for(eq
=gfc_current_ns
->equiv
; eq
; eq
=eq
->next
)
3416 for(e
=eq
; e
; e
=e
->eq
)
3418 if (e
->module
== NULL
)
3419 e
->module
= gfc_get_string("%s.eq.%d", module_name
, num
);
3420 mio_allocated_string(e
->module
);
3429 /* Write a symbol to the module. */
3432 write_symbol (int n
, gfc_symbol
* sym
)
3435 if (sym
->attr
.flavor
== FL_UNKNOWN
|| sym
->attr
.flavor
== FL_LABEL
)
3436 gfc_internal_error ("write_symbol(): bad module symbol '%s'", sym
->name
);
3439 mio_pool_string (&sym
->name
);
3441 mio_pool_string (&sym
->module
);
3442 mio_pointer_ref (&sym
->ns
);
3449 /* Recursive traversal function to write the initial set of symbols to
3450 the module. We check to see if the symbol should be written
3451 according to the access specification. */
3454 write_symbol0 (gfc_symtree
* st
)
3462 write_symbol0 (st
->left
);
3463 write_symbol0 (st
->right
);
3466 if (sym
->module
== NULL
)
3467 sym
->module
= gfc_get_string (module_name
);
3469 if (sym
->attr
.flavor
== FL_PROCEDURE
&& sym
->attr
.generic
3470 && !sym
->attr
.subroutine
&& !sym
->attr
.function
)
3473 if (!gfc_check_access (sym
->attr
.access
, sym
->ns
->default_access
))
3476 p
= get_pointer (sym
);
3477 if (p
->type
== P_UNKNOWN
)
3480 if (p
->u
.wsym
.state
== WRITTEN
)
3483 write_symbol (p
->integer
, sym
);
3484 p
->u
.wsym
.state
= WRITTEN
;
3490 /* Recursive traversal function to write the secondary set of symbols
3491 to the module file. These are symbols that were not public yet are
3492 needed by the public symbols or another dependent symbol. The act
3493 of writing a symbol can modify the pointer_info tree, so we cease
3494 traversal if we find a symbol to write. We return nonzero if a
3495 symbol was written and pass that information upwards. */
3498 write_symbol1 (pointer_info
* p
)
3504 if (write_symbol1 (p
->left
))
3506 if (write_symbol1 (p
->right
))
3509 if (p
->type
!= P_SYMBOL
|| p
->u
.wsym
.state
!= NEEDS_WRITE
)
3512 p
->u
.wsym
.state
= WRITTEN
;
3513 write_symbol (p
->integer
, p
->u
.wsym
.sym
);
3519 /* Write operator interfaces associated with a symbol. */
3522 write_operator (gfc_user_op
* uop
)
3524 static char nullstring
[] = "";
3525 const char *p
= nullstring
;
3527 if (uop
->operator == NULL
3528 || !gfc_check_access (uop
->access
, uop
->ns
->default_access
))
3531 mio_symbol_interface (&uop
->name
, &p
, &uop
->operator);
3535 /* Write generic interfaces associated with a symbol. */
3538 write_generic (gfc_symbol
* sym
)
3541 if (sym
->generic
== NULL
3542 || !gfc_check_access (sym
->attr
.access
, sym
->ns
->default_access
))
3545 mio_symbol_interface (&sym
->name
, &sym
->module
, &sym
->generic
);
3550 write_symtree (gfc_symtree
* st
)
3556 if (!gfc_check_access (sym
->attr
.access
, sym
->ns
->default_access
)
3557 || (sym
->attr
.flavor
== FL_PROCEDURE
&& sym
->attr
.generic
3558 && !sym
->attr
.subroutine
&& !sym
->attr
.function
))
3561 if (check_unique_name (st
->name
))
3564 p
= find_pointer (sym
);
3566 gfc_internal_error ("write_symtree(): Symbol not written");
3568 mio_pool_string (&st
->name
);
3569 mio_integer (&st
->ambiguous
);
3570 mio_integer (&p
->integer
);
3579 /* Write the operator interfaces. */
3582 for (i
= GFC_INTRINSIC_BEGIN
; i
!= GFC_INTRINSIC_END
; i
++)
3584 if (i
== INTRINSIC_USER
)
3587 mio_interface (gfc_check_access (gfc_current_ns
->operator_access
[i
],
3588 gfc_current_ns
->default_access
)
3589 ? &gfc_current_ns
->operator[i
] : NULL
);
3597 gfc_traverse_user_op (gfc_current_ns
, write_operator
);
3603 gfc_traverse_ns (gfc_current_ns
, write_generic
);
3609 write_blank_common ();
3610 write_common (gfc_current_ns
->common_root
);
3618 write_char('\n'); write_char('\n');
3620 /* Write symbol information. First we traverse all symbols in the
3621 primary namespace, writing those that need to be written.
3622 Sometimes writing one symbol will cause another to need to be
3623 written. A list of these symbols ends up on the write stack, and
3624 we end by popping the bottom of the stack and writing the symbol
3625 until the stack is empty. */
3629 write_symbol0 (gfc_current_ns
->sym_root
);
3630 while (write_symbol1 (pi_root
));
3638 gfc_traverse_symtree (gfc_current_ns
->sym_root
, write_symtree
);
3643 /* Given module, dump it to disk. If there was an error while
3644 processing the module, dump_flag will be set to zero and we delete
3645 the module file, even if it was already there. */
3648 gfc_dump_module (const char *name
, int dump_flag
)
3654 n
= strlen (name
) + strlen (MODULE_EXTENSION
) + 1;
3655 if (gfc_option
.module_dir
!= NULL
)
3657 filename
= (char *) alloca (n
+ strlen (gfc_option
.module_dir
));
3658 strcpy (filename
, gfc_option
.module_dir
);
3659 strcat (filename
, name
);
3663 filename
= (char *) alloca (n
);
3664 strcpy (filename
, name
);
3666 strcat (filename
, MODULE_EXTENSION
);
3674 module_fp
= fopen (filename
, "w");
3675 if (module_fp
== NULL
)
3676 gfc_fatal_error ("Can't open module file '%s' for writing at %C: %s",
3677 filename
, strerror (errno
));
3682 *strchr (p
, '\n') = '\0';
3684 fprintf (module_fp
, "GFORTRAN module created from %s on %s\n",
3685 gfc_source_file
, p
);
3686 fputs ("If you edit this, you'll get what you deserve.\n\n", module_fp
);
3689 strcpy (module_name
, name
);
3695 free_pi_tree (pi_root
);
3700 if (fclose (module_fp
))
3701 gfc_fatal_error ("Error writing module file '%s' for writing: %s",
3702 filename
, strerror (errno
));
3706 /* Process a USE directive. */
3709 gfc_use_module (void)
3715 filename
= (char *) alloca(strlen(module_name
) + strlen(MODULE_EXTENSION
)
3717 strcpy (filename
, module_name
);
3718 strcat (filename
, MODULE_EXTENSION
);
3720 module_fp
= gfc_open_included_file (filename
);
3721 if (module_fp
== NULL
)
3722 gfc_fatal_error ("Can't open module file '%s' for reading at %C: %s",
3723 filename
, strerror (errno
));
3729 /* Skip the first two lines of the module. */
3730 /* FIXME: Could also check for valid two lines here, instead. */
3736 bad_module ("Unexpected end of module");
3741 /* Make sure we're not reading the same module that we may be building. */
3742 for (p
= gfc_state_stack
; p
; p
= p
->previous
)
3743 if (p
->state
== COMP_MODULE
&& strcmp (p
->sym
->name
, module_name
) == 0)
3744 gfc_fatal_error ("Can't USE the same module we're building!");
3747 init_true_name_tree ();
3751 free_true_name (true_name_root
);
3752 true_name_root
= NULL
;
3754 free_pi_tree (pi_root
);
3762 gfc_module_init_2 (void)
3765 last_atom
= ATOM_LPAREN
;
3770 gfc_module_done_2 (void)