1 /* Handle modules, which amounts to loading and saving symbols and
2 their attendant structures.
3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
4 Software Foundation, Inc.
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, AB_CRAY_POINTER,
1439 static const mstring attr_bits[] =
1441 minit ("ALLOCATABLE", AB_ALLOCATABLE),
1442 minit ("DIMENSION", AB_DIMENSION),
1443 minit ("EXTERNAL", AB_EXTERNAL),
1444 minit ("INTRINSIC", AB_INTRINSIC),
1445 minit ("OPTIONAL", AB_OPTIONAL),
1446 minit ("POINTER", AB_POINTER),
1447 minit ("SAVE", AB_SAVE),
1448 minit ("TARGET", AB_TARGET),
1449 minit ("DUMMY", AB_DUMMY),
1450 minit ("RESULT", AB_RESULT),
1451 minit ("DATA", AB_DATA),
1452 minit ("IN_NAMELIST", AB_IN_NAMELIST),
1453 minit ("IN_COMMON", AB_IN_COMMON),
1454 minit ("FUNCTION", AB_FUNCTION),
1455 minit ("SUBROUTINE", AB_SUBROUTINE),
1456 minit ("SEQUENCE", AB_SEQUENCE),
1457 minit ("ELEMENTAL", AB_ELEMENTAL),
1458 minit ("PURE", AB_PURE),
1459 minit ("RECURSIVE", AB_RECURSIVE),
1460 minit ("GENERIC", AB_GENERIC),
1461 minit ("ALWAYS_EXPLICIT", AB_ALWAYS_EXPLICIT),
1462 minit ("CRAY_POINTER", AB_CRAY_POINTER),
1463 minit ("CRAY_POINTEE", AB_CRAY_POINTEE),
1467 /* Specialization of mio_name. */
1468 DECL_MIO_NAME(ab_attribute)
1469 DECL_MIO_NAME(ar_type)
1470 DECL_MIO_NAME(array_type)
1472 DECL_MIO_NAME(expr_t)
1473 DECL_MIO_NAME(gfc_access)
1474 DECL_MIO_NAME(gfc_intrinsic_op)
1475 DECL_MIO_NAME(ifsrc)
1476 DECL_MIO_NAME(procedure_type)
1477 DECL_MIO_NAME(ref_type)
1478 DECL_MIO_NAME(sym_flavor)
1479 DECL_MIO_NAME(sym_intent)
1480 #undef DECL_MIO_NAME
1482 /* Symbol attributes are stored in list with the first three elements
1483 being the enumerated fields, while the remaining elements (if any)
1484 indicate the individual attribute bits. The access field is not
1485 saved-- it controls what symbols are exported when a module is
1489 mio_symbol_attribute (symbol_attribute * attr)
1495 attr->flavor = MIO_NAME(sym_flavor) (attr->flavor, flavors);
1496 attr->intent = MIO_NAME(sym_intent) (attr->intent, intents);
1497 attr->proc = MIO_NAME(procedure_type) (attr->proc, procedures);
1498 attr->if_source = MIO_NAME(ifsrc) (attr->if_source, ifsrc_types);
1500 if (iomode == IO_OUTPUT)
1502 if (attr->allocatable)
1503 MIO_NAME(ab_attribute) (AB_ALLOCATABLE, attr_bits);
1504 if (attr->dimension)
1505 MIO_NAME(ab_attribute) (AB_DIMENSION, attr_bits);
1507 MIO_NAME(ab_attribute) (AB_EXTERNAL, attr_bits);
1508 if (attr->intrinsic)
1509 MIO_NAME(ab_attribute) (AB_INTRINSIC, attr_bits);
1511 MIO_NAME(ab_attribute) (AB_OPTIONAL, attr_bits);
1513 MIO_NAME(ab_attribute) (AB_POINTER, attr_bits);
1515 MIO_NAME(ab_attribute) (AB_SAVE, attr_bits);
1517 MIO_NAME(ab_attribute) (AB_TARGET, attr_bits);
1519 MIO_NAME(ab_attribute) (AB_DUMMY, attr_bits);
1521 MIO_NAME(ab_attribute) (AB_RESULT, attr_bits);
1522 /* We deliberately don't preserve the "entry" flag. */
1525 MIO_NAME(ab_attribute) (AB_DATA, attr_bits);
1526 if (attr->in_namelist)
1527 MIO_NAME(ab_attribute) (AB_IN_NAMELIST, attr_bits);
1528 if (attr->in_common)
1529 MIO_NAME(ab_attribute) (AB_IN_COMMON, attr_bits);
1532 MIO_NAME(ab_attribute) (AB_FUNCTION, attr_bits);
1533 if (attr->subroutine)
1534 MIO_NAME(ab_attribute) (AB_SUBROUTINE, attr_bits);
1536 MIO_NAME(ab_attribute) (AB_GENERIC, attr_bits);
1539 MIO_NAME(ab_attribute) (AB_SEQUENCE, attr_bits);
1540 if (attr->elemental)
1541 MIO_NAME(ab_attribute) (AB_ELEMENTAL, attr_bits);
1543 MIO_NAME(ab_attribute) (AB_PURE, attr_bits);
1544 if (attr->recursive)
1545 MIO_NAME(ab_attribute) (AB_RECURSIVE, attr_bits);
1546 if (attr->always_explicit)
1547 MIO_NAME(ab_attribute) (AB_ALWAYS_EXPLICIT, attr_bits);
1548 if (attr->cray_pointer)
1549 MIO_NAME(ab_attribute) (AB_CRAY_POINTER, attr_bits);
1550 if (attr->cray_pointee)
1551 MIO_NAME(ab_attribute) (AB_CRAY_POINTEE, attr_bits);
1562 if (t == ATOM_RPAREN)
1565 bad_module ("Expected attribute bit name");
1567 switch ((ab_attribute) find_enum (attr_bits))
1569 case AB_ALLOCATABLE:
1570 attr->allocatable = 1;
1573 attr->dimension = 1;
1579 attr->intrinsic = 1;
1602 case AB_IN_NAMELIST:
1603 attr->in_namelist = 1;
1606 attr->in_common = 1;
1612 attr->subroutine = 1;
1621 attr->elemental = 1;
1627 attr->recursive = 1;
1629 case AB_ALWAYS_EXPLICIT:
1630 attr->always_explicit = 1;
1632 case AB_CRAY_POINTER:
1633 attr->cray_pointer = 1;
1635 case AB_CRAY_POINTEE:
1636 attr->cray_pointee = 1;
1644 static const mstring bt_types[] = {
1645 minit ("INTEGER", BT_INTEGER),
1646 minit ("REAL", BT_REAL),
1647 minit ("COMPLEX", BT_COMPLEX),
1648 minit ("LOGICAL", BT_LOGICAL),
1649 minit ("CHARACTER", BT_CHARACTER),
1650 minit ("DERIVED", BT_DERIVED),
1651 minit ("PROCEDURE", BT_PROCEDURE),
1652 minit ("UNKNOWN", BT_UNKNOWN),
1658 mio_charlen (gfc_charlen ** clp)
1664 if (iomode == IO_OUTPUT)
1668 mio_expr (&cl->length);
1673 if (peek_atom () != ATOM_RPAREN)
1675 cl = gfc_get_charlen ();
1676 mio_expr (&cl->length);
1680 cl->next = gfc_current_ns->cl_list;
1681 gfc_current_ns->cl_list = cl;
1689 /* Return a symtree node with a name that is guaranteed to be unique
1690 within the namespace and corresponds to an illegal fortran name. */
1692 static gfc_symtree *
1693 get_unique_symtree (gfc_namespace * ns)
1695 char name[GFC_MAX_SYMBOL_LEN + 1];
1696 static int serial = 0;
1698 sprintf (name, "@%d", serial++);
1699 return gfc_new_symtree (&ns->sym_root, name);
1703 /* See if a name is a generated name. */
1706 check_unique_name (const char *name)
1709 return *name == '@';
1714 mio_typespec (gfc_typespec * ts)
1719 ts->type = MIO_NAME(bt) (ts->type, bt_types);
1721 if (ts->type != BT_DERIVED)
1722 mio_integer (&ts->kind);
1724 mio_symbol_ref (&ts->derived);
1726 mio_charlen (&ts->cl);
1732 static const mstring array_spec_types[] = {
1733 minit ("EXPLICIT", AS_EXPLICIT),
1734 minit ("ASSUMED_SHAPE", AS_ASSUMED_SHAPE),
1735 minit ("DEFERRED", AS_DEFERRED),
1736 minit ("ASSUMED_SIZE", AS_ASSUMED_SIZE),
1742 mio_array_spec (gfc_array_spec ** asp)
1749 if (iomode == IO_OUTPUT)
1757 if (peek_atom () == ATOM_RPAREN)
1763 *asp = as = gfc_get_array_spec ();
1766 mio_integer (&as->rank);
1767 as->type = MIO_NAME(array_type) (as->type, array_spec_types);
1769 for (i = 0; i < as->rank; i++)
1771 mio_expr (&as->lower[i]);
1772 mio_expr (&as->upper[i]);
1780 /* Given a pointer to an array reference structure (which lives in a
1781 gfc_ref structure), find the corresponding array specification
1782 structure. Storing the pointer in the ref structure doesn't quite
1783 work when loading from a module. Generating code for an array
1784 reference also needs more information than just the array spec. */
1786 static const mstring array_ref_types[] = {
1787 minit ("FULL", AR_FULL),
1788 minit ("ELEMENT", AR_ELEMENT),
1789 minit ("SECTION", AR_SECTION),
1794 mio_array_ref (gfc_array_ref * ar)
1799 ar->type = MIO_NAME(ar_type) (ar->type, array_ref_types);
1800 mio_integer (&ar->dimen);
1808 for (i = 0; i < ar->dimen; i++)
1809 mio_expr (&ar->start[i]);
1814 for (i = 0; i < ar->dimen; i++)
1816 mio_expr (&ar->start[i]);
1817 mio_expr (&ar->end[i]);
1818 mio_expr (&ar->stride[i]);
1824 gfc_internal_error ("mio_array_ref(): Unknown array ref");
1827 for (i = 0; i < ar->dimen; i++)
1828 mio_integer ((int *) &ar->dimen_type[i]);
1830 if (iomode == IO_INPUT)
1832 ar->where = gfc_current_locus;
1834 for (i = 0; i < ar->dimen; i++)
1835 ar->c_where[i] = gfc_current_locus;
1842 /* Saves or restores a pointer. The pointer is converted back and
1843 forth from an integer. We return the pointer_info pointer so that
1844 the caller can take additional action based on the pointer type. */
1846 static pointer_info *
1847 mio_pointer_ref (void *gp)
1851 if (iomode == IO_OUTPUT)
1853 p = get_pointer (*((char **) gp));
1854 write_atom (ATOM_INTEGER, &p->integer);
1858 require_atom (ATOM_INTEGER);
1859 p = add_fixup (atom_int, gp);
1866 /* Save and load references to components that occur within
1867 expressions. We have to describe these references by a number and
1868 by name. The number is necessary for forward references during
1869 reading, and the name is necessary if the symbol already exists in
1870 the namespace and is not loaded again. */
1873 mio_component_ref (gfc_component ** cp, gfc_symbol * sym)
1875 char name[GFC_MAX_SYMBOL_LEN + 1];
1879 p = mio_pointer_ref (cp);
1880 if (p->type == P_UNKNOWN)
1881 p->type = P_COMPONENT;
1883 if (iomode == IO_OUTPUT)
1884 mio_pool_string (&(*cp)->name);
1887 mio_internal_string (name);
1889 /* It can happen that a component reference can be read before the
1890 associated derived type symbol has been loaded. Return now and
1891 wait for a later iteration of load_needed. */
1895 if (sym->components != NULL && p->u.pointer == NULL)
1897 /* Symbol already loaded, so search by name. */
1898 for (q = sym->components; q; q = q->next)
1899 if (strcmp (q->name, name) == 0)
1903 gfc_internal_error ("mio_component_ref(): Component not found");
1905 associate_integer_pointer (p, q);
1908 /* Make sure this symbol will eventually be loaded. */
1909 p = find_pointer2 (sym);
1910 if (p->u.rsym.state == UNUSED)
1911 p->u.rsym.state = NEEDED;
1917 mio_component (gfc_component * c)
1924 if (iomode == IO_OUTPUT)
1926 p = get_pointer (c);
1927 mio_integer (&p->integer);
1932 p = get_integer (n);
1933 associate_integer_pointer (p, c);
1936 if (p->type == P_UNKNOWN)
1937 p->type = P_COMPONENT;
1939 mio_pool_string (&c->name);
1940 mio_typespec (&c->ts);
1941 mio_array_spec (&c->as);
1943 mio_integer (&c->dimension);
1944 mio_integer (&c->pointer);
1946 mio_expr (&c->initializer);
1952 mio_component_list (gfc_component ** cp)
1954 gfc_component *c, *tail;
1958 if (iomode == IO_OUTPUT)
1960 for (c = *cp; c; c = c->next)
1971 if (peek_atom () == ATOM_RPAREN)
1974 c = gfc_get_component ();
1991 mio_actual_arg (gfc_actual_arglist * a)
1995 mio_pool_string (&a->name);
1996 mio_expr (&a->expr);
2002 mio_actual_arglist (gfc_actual_arglist ** ap)
2004 gfc_actual_arglist *a, *tail;
2008 if (iomode == IO_OUTPUT)
2010 for (a = *ap; a; a = a->next)
2020 if (peek_atom () != ATOM_LPAREN)
2023 a = gfc_get_actual_arglist ();
2039 /* Read and write formal argument lists. */
2042 mio_formal_arglist (gfc_symbol * sym)
2044 gfc_formal_arglist *f, *tail;
2048 if (iomode == IO_OUTPUT)
2050 for (f = sym->formal; f; f = f->next)
2051 mio_symbol_ref (&f->sym);
2056 sym->formal = tail = NULL;
2058 while (peek_atom () != ATOM_RPAREN)
2060 f = gfc_get_formal_arglist ();
2061 mio_symbol_ref (&f->sym);
2063 if (sym->formal == NULL)
2076 /* Save or restore a reference to a symbol node. */
2079 mio_symbol_ref (gfc_symbol ** symp)
2083 p = mio_pointer_ref (symp);
2084 if (p->type == P_UNKNOWN)
2087 if (iomode == IO_OUTPUT)
2089 if (p->u.wsym.state == UNREFERENCED)
2090 p->u.wsym.state = NEEDS_WRITE;
2094 if (p->u.rsym.state == UNUSED)
2095 p->u.rsym.state = NEEDED;
2100 /* Save or restore a reference to a symtree node. */
2103 mio_symtree_ref (gfc_symtree ** stp)
2107 gfc_symtree * ns_st = NULL;
2109 if (iomode == IO_OUTPUT)
2111 /* If this is a symtree for a symbol that came from a contained module
2112 namespace, it has a unique name and we should look in the current
2113 namespace to see if the required, non-contained symbol is available
2114 yet. If so, the latter should be written. */
2115 if ((*stp)->n.sym && check_unique_name((*stp)->name))
2116 ns_st = gfc_find_symtree (gfc_current_ns->sym_root,
2117 (*stp)->n.sym->name);
2119 /* On the other hand, if the existing symbol is the module name or the
2120 new symbol is a dummy argument, do not do the promotion. */
2121 if (ns_st && ns_st->n.sym
2122 && ns_st->n.sym->attr.flavor != FL_MODULE
2123 && !(*stp)->n.sym->attr.dummy)
2124 mio_symbol_ref (&ns_st->n.sym);
2126 mio_symbol_ref (&(*stp)->n.sym);
2130 require_atom (ATOM_INTEGER);
2131 p = get_integer (atom_int);
2132 if (p->type == P_UNKNOWN)
2135 if (p->u.rsym.state == UNUSED)
2136 p->u.rsym.state = NEEDED;
2138 if (p->u.rsym.symtree != NULL)
2140 *stp = p->u.rsym.symtree;
2144 f = gfc_getmem (sizeof (fixup_t));
2146 f->next = p->u.rsym.stfixup;
2147 p->u.rsym.stfixup = f;
2149 f->pointer = (void **)stp;
2155 mio_iterator (gfc_iterator ** ip)
2161 if (iomode == IO_OUTPUT)
2168 if (peek_atom () == ATOM_RPAREN)
2174 *ip = gfc_get_iterator ();
2179 mio_expr (&iter->var);
2180 mio_expr (&iter->start);
2181 mio_expr (&iter->end);
2182 mio_expr (&iter->step);
2191 mio_constructor (gfc_constructor ** cp)
2193 gfc_constructor *c, *tail;
2197 if (iomode == IO_OUTPUT)
2199 for (c = *cp; c; c = c->next)
2202 mio_expr (&c->expr);
2203 mio_iterator (&c->iterator);
2213 while (peek_atom () != ATOM_RPAREN)
2215 c = gfc_get_constructor ();
2225 mio_expr (&c->expr);
2226 mio_iterator (&c->iterator);
2236 static const mstring ref_types[] = {
2237 minit ("ARRAY", REF_ARRAY),
2238 minit ("COMPONENT", REF_COMPONENT),
2239 minit ("SUBSTRING", REF_SUBSTRING),
2245 mio_ref (gfc_ref ** rp)
2252 r->type = MIO_NAME(ref_type) (r->type, ref_types);
2257 mio_array_ref (&r->u.ar);
2261 mio_symbol_ref (&r->u.c.sym);
2262 mio_component_ref (&r->u.c.component, r->u.c.sym);
2266 mio_expr (&r->u.ss.start);
2267 mio_expr (&r->u.ss.end);
2268 mio_charlen (&r->u.ss.length);
2277 mio_ref_list (gfc_ref ** rp)
2279 gfc_ref *ref, *head, *tail;
2283 if (iomode == IO_OUTPUT)
2285 for (ref = *rp; ref; ref = ref->next)
2292 while (peek_atom () != ATOM_RPAREN)
2295 head = tail = gfc_get_ref ();
2298 tail->next = gfc_get_ref ();
2312 /* Read and write an integer value. */
2315 mio_gmp_integer (mpz_t * integer)
2319 if (iomode == IO_INPUT)
2321 if (parse_atom () != ATOM_STRING)
2322 bad_module ("Expected integer string");
2324 mpz_init (*integer);
2325 if (mpz_set_str (*integer, atom_string, 10))
2326 bad_module ("Error converting integer");
2328 gfc_free (atom_string);
2333 p = mpz_get_str (NULL, 10, *integer);
2334 write_atom (ATOM_STRING, p);
2341 mio_gmp_real (mpfr_t * real)
2346 if (iomode == IO_INPUT)
2348 if (parse_atom () != ATOM_STRING)
2349 bad_module ("Expected real string");
2352 mpfr_set_str (*real, atom_string, 16, GFC_RND_MODE);
2353 gfc_free (atom_string);
2358 p = mpfr_get_str (NULL, &exponent, 16, 0, *real, GFC_RND_MODE);
2359 atom_string = gfc_getmem (strlen (p) + 20);
2361 sprintf (atom_string, "0.%s@%ld", p, exponent);
2363 /* Fix negative numbers. */
2364 if (atom_string[2] == '-')
2366 atom_string[0] = '-';
2367 atom_string[1] = '0';
2368 atom_string[2] = '.';
2371 write_atom (ATOM_STRING, atom_string);
2373 gfc_free (atom_string);
2379 /* Save and restore the shape of an array constructor. */
2382 mio_shape (mpz_t ** pshape, int rank)
2388 /* A NULL shape is represented by (). */
2391 if (iomode == IO_OUTPUT)
2403 if (t == ATOM_RPAREN)
2410 shape = gfc_get_shape (rank);
2414 for (n = 0; n < rank; n++)
2415 mio_gmp_integer (&shape[n]);
2421 static const mstring expr_types[] = {
2422 minit ("OP", EXPR_OP),
2423 minit ("FUNCTION", EXPR_FUNCTION),
2424 minit ("CONSTANT", EXPR_CONSTANT),
2425 minit ("VARIABLE", EXPR_VARIABLE),
2426 minit ("SUBSTRING", EXPR_SUBSTRING),
2427 minit ("STRUCTURE", EXPR_STRUCTURE),
2428 minit ("ARRAY", EXPR_ARRAY),
2429 minit ("NULL", EXPR_NULL),
2433 /* INTRINSIC_ASSIGN is missing because it is used as an index for
2434 generic operators, not in expressions. INTRINSIC_USER is also
2435 replaced by the correct function name by the time we see it. */
2437 static const mstring intrinsics[] =
2439 minit ("UPLUS", INTRINSIC_UPLUS),
2440 minit ("UMINUS", INTRINSIC_UMINUS),
2441 minit ("PLUS", INTRINSIC_PLUS),
2442 minit ("MINUS", INTRINSIC_MINUS),
2443 minit ("TIMES", INTRINSIC_TIMES),
2444 minit ("DIVIDE", INTRINSIC_DIVIDE),
2445 minit ("POWER", INTRINSIC_POWER),
2446 minit ("CONCAT", INTRINSIC_CONCAT),
2447 minit ("AND", INTRINSIC_AND),
2448 minit ("OR", INTRINSIC_OR),
2449 minit ("EQV", INTRINSIC_EQV),
2450 minit ("NEQV", INTRINSIC_NEQV),
2451 minit ("EQ", INTRINSIC_EQ),
2452 minit ("NE", INTRINSIC_NE),
2453 minit ("GT", INTRINSIC_GT),
2454 minit ("GE", INTRINSIC_GE),
2455 minit ("LT", INTRINSIC_LT),
2456 minit ("LE", INTRINSIC_LE),
2457 minit ("NOT", INTRINSIC_NOT),
2458 minit ("PARENTHESES", INTRINSIC_PARENTHESES),
2462 /* Read and write expressions. The form "()" is allowed to indicate a
2466 mio_expr (gfc_expr ** ep)
2474 if (iomode == IO_OUTPUT)
2483 MIO_NAME(expr_t) (e->expr_type, expr_types);
2489 if (t == ATOM_RPAREN)
2496 bad_module ("Expected expression type");
2498 e = *ep = gfc_get_expr ();
2499 e->where = gfc_current_locus;
2500 e->expr_type = (expr_t) find_enum (expr_types);
2503 mio_typespec (&e->ts);
2504 mio_integer (&e->rank);
2506 switch (e->expr_type)
2509 e->value.op.operator
2510 = MIO_NAME(gfc_intrinsic_op) (e->value.op.operator, intrinsics);
2512 switch (e->value.op.operator)
2514 case INTRINSIC_UPLUS:
2515 case INTRINSIC_UMINUS:
2517 mio_expr (&e->value.op.op1);
2520 case INTRINSIC_PLUS:
2521 case INTRINSIC_MINUS:
2522 case INTRINSIC_TIMES:
2523 case INTRINSIC_DIVIDE:
2524 case INTRINSIC_POWER:
2525 case INTRINSIC_CONCAT:
2529 case INTRINSIC_NEQV:
2536 mio_expr (&e->value.op.op1);
2537 mio_expr (&e->value.op.op2);
2541 bad_module ("Bad operator");
2547 mio_symtree_ref (&e->symtree);
2548 mio_actual_arglist (&e->value.function.actual);
2550 if (iomode == IO_OUTPUT)
2552 e->value.function.name
2553 = mio_allocated_string (e->value.function.name);
2554 flag = e->value.function.esym != NULL;
2555 mio_integer (&flag);
2557 mio_symbol_ref (&e->value.function.esym);
2559 write_atom (ATOM_STRING, e->value.function.isym->name);
2564 require_atom (ATOM_STRING);
2565 e->value.function.name = gfc_get_string (atom_string);
2566 gfc_free (atom_string);
2568 mio_integer (&flag);
2570 mio_symbol_ref (&e->value.function.esym);
2573 require_atom (ATOM_STRING);
2574 e->value.function.isym = gfc_find_function (atom_string);
2575 gfc_free (atom_string);
2582 mio_symtree_ref (&e->symtree);
2583 mio_ref_list (&e->ref);
2586 case EXPR_SUBSTRING:
2587 e->value.character.string = (char *)
2588 mio_allocated_string (e->value.character.string);
2589 mio_ref_list (&e->ref);
2592 case EXPR_STRUCTURE:
2594 mio_constructor (&e->value.constructor);
2595 mio_shape (&e->shape, e->rank);
2602 mio_gmp_integer (&e->value.integer);
2606 gfc_set_model_kind (e->ts.kind);
2607 mio_gmp_real (&e->value.real);
2611 gfc_set_model_kind (e->ts.kind);
2612 mio_gmp_real (&e->value.complex.r);
2613 mio_gmp_real (&e->value.complex.i);
2617 mio_integer (&e->value.logical);
2621 mio_integer (&e->value.character.length);
2622 e->value.character.string = (char *)
2623 mio_allocated_string (e->value.character.string);
2627 bad_module ("Bad type in constant expression");
2640 /* Read and write namelists */
2643 mio_namelist (gfc_symbol * sym)
2645 gfc_namelist *n, *m;
2646 const char *check_name;
2650 if (iomode == IO_OUTPUT)
2652 for (n = sym->namelist; n; n = n->next)
2653 mio_symbol_ref (&n->sym);
2657 /* This departure from the standard is flagged as an error.
2658 It does, in fact, work correctly. TODO: Allow it
2660 if (sym->attr.flavor == FL_NAMELIST)
2662 check_name = find_use_name (sym->name);
2663 if (check_name && strcmp (check_name, sym->name) != 0)
2664 gfc_error("Namelist %s cannot be renamed by USE"
2665 " association to %s.",
2666 sym->name, check_name);
2670 while (peek_atom () != ATOM_RPAREN)
2672 n = gfc_get_namelist ();
2673 mio_symbol_ref (&n->sym);
2675 if (sym->namelist == NULL)
2682 sym->namelist_tail = m;
2689 /* Save/restore lists of gfc_interface stuctures. When loading an
2690 interface, we are really appending to the existing list of
2691 interfaces. Checking for duplicate and ambiguous interfaces has to
2692 be done later when all symbols have been loaded. */
2695 mio_interface_rest (gfc_interface ** ip)
2697 gfc_interface *tail, *p;
2699 if (iomode == IO_OUTPUT)
2702 for (p = *ip; p; p = p->next)
2703 mio_symbol_ref (&p->sym);
2719 if (peek_atom () == ATOM_RPAREN)
2722 p = gfc_get_interface ();
2723 p->where = gfc_current_locus;
2724 mio_symbol_ref (&p->sym);
2739 /* Save/restore a nameless operator interface. */
2742 mio_interface (gfc_interface ** ip)
2746 mio_interface_rest (ip);
2750 /* Save/restore a named operator interface. */
2753 mio_symbol_interface (const char **name, const char **module,
2754 gfc_interface ** ip)
2759 mio_pool_string (name);
2760 mio_pool_string (module);
2762 mio_interface_rest (ip);
2767 mio_namespace_ref (gfc_namespace ** nsp)
2772 p = mio_pointer_ref (nsp);
2774 if (p->type == P_UNKNOWN)
2775 p->type = P_NAMESPACE;
2777 if (iomode == IO_INPUT && p->integer != 0)
2779 ns = (gfc_namespace *)p->u.pointer;
2782 ns = gfc_get_namespace (NULL, 0);
2783 associate_integer_pointer (p, ns);
2791 /* Unlike most other routines, the address of the symbol node is
2792 already fixed on input and the name/module has already been filled
2796 mio_symbol (gfc_symbol * sym)
2798 gfc_formal_arglist *formal;
2802 mio_symbol_attribute (&sym->attr);
2803 mio_typespec (&sym->ts);
2805 /* Contained procedures don't have formal namespaces. Instead we output the
2806 procedure namespace. The will contain the formal arguments. */
2807 if (iomode == IO_OUTPUT)
2809 formal = sym->formal;
2810 while (formal && !formal->sym)
2811 formal = formal->next;
2814 mio_namespace_ref (&formal->sym->ns);
2816 mio_namespace_ref (&sym->formal_ns);
2820 mio_namespace_ref (&sym->formal_ns);
2823 sym->formal_ns->proc_name = sym;
2828 /* Save/restore common block links */
2829 mio_symbol_ref (&sym->common_next);
2831 mio_formal_arglist (sym);
2833 if (sym->attr.flavor == FL_PARAMETER)
2834 mio_expr (&sym->value);
2836 mio_array_spec (&sym->as);
2838 mio_symbol_ref (&sym->result);
2840 if (sym->attr.cray_pointee)
2841 mio_symbol_ref (&sym->cp_pointer);
2843 /* Note that components are always saved, even if they are supposed
2844 to be private. Component access is checked during searching. */
2846 mio_component_list (&sym->components);
2848 if (sym->components != NULL)
2849 sym->component_access =
2850 MIO_NAME(gfc_access) (sym->component_access, access_types);
2857 /************************* Top level subroutines *************************/
2859 /* Skip a list between balanced left and right parens. */
2869 switch (parse_atom ())
2880 gfc_free (atom_string);
2892 /* Load operator interfaces from the module. Interfaces are unusual
2893 in that they attach themselves to existing symbols. */
2896 load_operator_interfaces (void)
2899 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
2904 while (peek_atom () != ATOM_RPAREN)
2908 mio_internal_string (name);
2909 mio_internal_string (module);
2911 /* Decide if we need to load this one or not. */
2912 p = find_use_name (name);
2915 while (parse_atom () != ATOM_RPAREN);
2919 uop = gfc_get_uop (p);
2920 mio_interface_rest (&uop->operator);
2928 /* Load interfaces from the module. Interfaces are unusual in that
2929 they attach themselves to existing symbols. */
2932 load_generic_interfaces (void)
2935 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
2940 while (peek_atom () != ATOM_RPAREN)
2944 mio_internal_string (name);
2945 mio_internal_string (module);
2947 /* Decide if we need to load this one or not. */
2948 p = find_use_name (name);
2950 if (p == NULL || gfc_find_symbol (p, NULL, 0, &sym))
2952 while (parse_atom () != ATOM_RPAREN);
2958 gfc_get_symbol (p, NULL, &sym);
2960 sym->attr.flavor = FL_PROCEDURE;
2961 sym->attr.generic = 1;
2962 sym->attr.use_assoc = 1;
2965 mio_interface_rest (&sym->generic);
2972 /* Load common blocks. */
2977 char name[GFC_MAX_SYMBOL_LEN+1];
2982 while (peek_atom () != ATOM_RPAREN)
2985 mio_internal_string (name);
2987 p = gfc_get_common (name, 1);
2989 mio_symbol_ref (&p->head);
2990 mio_integer (&p->saved);
2999 /* load_equiv()-- Load equivalences. */
3004 gfc_equiv *head, *tail, *end;
3008 end = gfc_current_ns->equiv;
3009 while(end != NULL && end->next != NULL)
3012 while(peek_atom() != ATOM_RPAREN) {
3016 while(peek_atom() != ATOM_RPAREN)
3019 head = tail = gfc_get_equiv();
3022 tail->eq = gfc_get_equiv();
3026 mio_pool_string(&tail->module);
3027 mio_expr(&tail->expr);
3031 gfc_current_ns->equiv = head;
3042 /* Recursive function to traverse the pointer_info tree and load a
3043 needed symbol. We return nonzero if we load a symbol and stop the
3044 traversal, because the act of loading can alter the tree. */
3047 load_needed (pointer_info * p)
3055 if (load_needed (p->left))
3057 if (load_needed (p->right))
3060 if (p->type != P_SYMBOL || p->u.rsym.state != NEEDED)
3063 p->u.rsym.state = USED;
3065 set_module_locus (&p->u.rsym.where);
3067 sym = p->u.rsym.sym;
3070 q = get_integer (p->u.rsym.ns);
3072 ns = (gfc_namespace *) q->u.pointer;
3075 /* Create an interface namespace if necessary. These are
3076 the namespaces that hold the formal parameters of module
3079 ns = gfc_get_namespace (NULL, 0);
3080 associate_integer_pointer (q, ns);
3083 sym = gfc_new_symbol (p->u.rsym.true_name, ns);
3084 sym->module = gfc_get_string (p->u.rsym.module);
3086 associate_integer_pointer (p, sym);
3090 sym->attr.use_assoc = 1;
3096 /* Recursive function for cleaning up things after a module has been
3100 read_cleanup (pointer_info * p)
3108 read_cleanup (p->left);
3109 read_cleanup (p->right);
3111 if (p->type == P_SYMBOL && p->u.rsym.state == USED && !p->u.rsym.referenced)
3113 /* Add hidden symbols to the symtree. */
3114 q = get_integer (p->u.rsym.ns);
3115 st = get_unique_symtree ((gfc_namespace *) q->u.pointer);
3117 st->n.sym = p->u.rsym.sym;
3120 /* Fixup any symtree references. */
3121 p->u.rsym.symtree = st;
3122 resolve_fixups (p->u.rsym.stfixup, st);
3123 p->u.rsym.stfixup = NULL;
3126 /* Free unused symbols. */
3127 if (p->type == P_SYMBOL && p->u.rsym.state == UNUSED)
3128 gfc_free_symbol (p->u.rsym.sym);
3132 /* Read a module file. */
3137 module_locus operator_interfaces, user_operators;
3139 char name[GFC_MAX_SYMBOL_LEN + 1];
3141 int ambiguous, j, nuse, symbol;
3147 get_module_locus (&operator_interfaces); /* Skip these for now */
3150 get_module_locus (&user_operators);
3154 /* Skip commons and equivalences for now. */
3160 /* Create the fixup nodes for all the symbols. */
3162 while (peek_atom () != ATOM_RPAREN)
3164 require_atom (ATOM_INTEGER);
3165 info = get_integer (atom_int);
3167 info->type = P_SYMBOL;
3168 info->u.rsym.state = UNUSED;
3170 mio_internal_string (info->u.rsym.true_name);
3171 mio_internal_string (info->u.rsym.module);
3173 require_atom (ATOM_INTEGER);
3174 info->u.rsym.ns = atom_int;
3176 get_module_locus (&info->u.rsym.where);
3179 /* See if the symbol has already been loaded by a previous module.
3180 If so, we reference the existing symbol and prevent it from
3181 being loaded again. */
3183 sym = find_true_name (info->u.rsym.true_name, info->u.rsym.module);
3185 /* See if the symbol has already been loaded by a previous module.
3186 If so, we reference the existing symbol and prevent it from
3187 being loaded again. This should not happen if the symbol being
3188 read is an index for an assumed shape dummy array (ns != 1). */
3190 sym = find_true_name (info->u.rsym.true_name, info->u.rsym.module);
3193 || (sym->attr.flavor == FL_VARIABLE
3194 && info->u.rsym.ns !=1))
3197 info->u.rsym.state = USED;
3198 info->u.rsym.referenced = 1;
3199 info->u.rsym.sym = sym;
3204 /* Parse the symtree lists. This lets us mark which symbols need to
3205 be loaded. Renaming is also done at this point by replacing the
3210 while (peek_atom () != ATOM_RPAREN)
3212 mio_internal_string (name);
3213 mio_integer (&ambiguous);
3214 mio_integer (&symbol);
3216 info = get_integer (symbol);
3218 /* See how many use names there are. If none, go through the start
3219 of the loop at least once. */
3220 nuse = number_use_names (name);
3224 for (j = 1; j <= nuse; j++)
3226 /* Get the jth local name for this symbol. */
3227 p = find_use_name_n (name, &j);
3229 /* Skip symtree nodes not in an ONLY clause. */
3233 /* Check for ambiguous symbols. */
3234 st = gfc_find_symtree (gfc_current_ns->sym_root, p);
3238 if (st->n.sym != info->u.rsym.sym)
3240 info->u.rsym.symtree = st;
3244 /* Create a symtree node in the current namespace for this symbol. */
3245 st = check_unique_name (p) ? get_unique_symtree (gfc_current_ns) :
3246 gfc_new_symtree (&gfc_current_ns->sym_root, p);
3248 st->ambiguous = ambiguous;
3250 sym = info->u.rsym.sym;
3252 /* Create a symbol node if it doesn't already exist. */
3255 sym = info->u.rsym.sym =
3256 gfc_new_symbol (info->u.rsym.true_name,
3259 sym->module = gfc_get_string (info->u.rsym.module);
3265 /* Store the symtree pointing to this symbol. */
3266 info->u.rsym.symtree = st;
3268 if (info->u.rsym.state == UNUSED)
3269 info->u.rsym.state = NEEDED;
3270 info->u.rsym.referenced = 1;
3277 /* Load intrinsic operator interfaces. */
3278 set_module_locus (&operator_interfaces);
3281 for (i = GFC_INTRINSIC_BEGIN; i != GFC_INTRINSIC_END; i++)
3283 if (i == INTRINSIC_USER)
3288 u = find_use_operator (i);
3299 mio_interface (&gfc_current_ns->operator[i]);
3304 /* Load generic and user operator interfaces. These must follow the
3305 loading of symtree because otherwise symbols can be marked as
3308 set_module_locus (&user_operators);
3310 load_operator_interfaces ();
3311 load_generic_interfaces ();
3316 /* At this point, we read those symbols that are needed but haven't
3317 been loaded yet. If one symbol requires another, the other gets
3318 marked as NEEDED if its previous state was UNUSED. */
3320 while (load_needed (pi_root));
3322 /* Make sure all elements of the rename-list were found in the
3325 for (u = gfc_rename_list; u; u = u->next)
3330 if (u->operator == INTRINSIC_NONE)
3332 gfc_error ("Symbol '%s' referenced at %L not found in module '%s'",
3333 u->use_name, &u->where, module_name);
3337 if (u->operator == INTRINSIC_USER)
3340 ("User operator '%s' referenced at %L not found in module '%s'",
3341 u->use_name, &u->where, module_name);
3346 ("Intrinsic operator '%s' referenced at %L not found in module "
3347 "'%s'", gfc_op2string (u->operator), &u->where, module_name);
3350 gfc_check_interfaces (gfc_current_ns);
3352 /* Clean up symbol nodes that were never loaded, create references
3353 to hidden symbols. */
3355 read_cleanup (pi_root);
3359 /* Given an access type that is specific to an entity and the default
3360 access, return nonzero if the entity is publicly accessible. */
3363 gfc_check_access (gfc_access specific_access, gfc_access default_access)
3366 if (specific_access == ACCESS_PUBLIC)
3368 if (specific_access == ACCESS_PRIVATE)
3371 if (gfc_option.flag_module_access_private)
3372 return default_access == ACCESS_PUBLIC;
3374 return default_access != ACCESS_PRIVATE;
3380 /* Write a common block to the module */
3383 write_common (gfc_symtree *st)
3391 write_common(st->left);
3392 write_common(st->right);
3396 /* Write the unmangled name. */
3397 name = st->n.common->name;
3399 mio_pool_string(&name);
3402 mio_symbol_ref(&p->head);
3403 mio_integer(&p->saved);
3408 /* Write the blank common block to the module */
3411 write_blank_common (void)
3413 const char * name = BLANK_COMMON_NAME;
3415 if (gfc_current_ns->blank_common.head == NULL)
3420 mio_pool_string(&name);
3422 mio_symbol_ref(&gfc_current_ns->blank_common.head);
3423 mio_integer(&gfc_current_ns->blank_common.saved);
3428 /* Write equivalences to the module. */
3437 for(eq=gfc_current_ns->equiv; eq; eq=eq->next)
3441 for(e=eq; e; e=e->eq)
3443 if (e->module == NULL)
3444 e->module = gfc_get_string("%s.eq.%d", module_name, num);
3445 mio_allocated_string(e->module);
3454 /* Write a symbol to the module. */
3457 write_symbol (int n, gfc_symbol * sym)
3460 if (sym->attr.flavor == FL_UNKNOWN || sym->attr.flavor == FL_LABEL)
3461 gfc_internal_error ("write_symbol(): bad module symbol '%s'", sym->name);
3464 mio_pool_string (&sym->name);
3466 mio_pool_string (&sym->module);
3467 mio_pointer_ref (&sym->ns);
3474 /* Recursive traversal function to write the initial set of symbols to
3475 the module. We check to see if the symbol should be written
3476 according to the access specification. */
3479 write_symbol0 (gfc_symtree * st)
3487 write_symbol0 (st->left);
3488 write_symbol0 (st->right);
3491 if (sym->module == NULL)
3492 sym->module = gfc_get_string (module_name);
3494 if (sym->attr.flavor == FL_PROCEDURE && sym->attr.generic
3495 && !sym->attr.subroutine && !sym->attr.function)
3498 if (!gfc_check_access (sym->attr.access, sym->ns->default_access))
3501 p = get_pointer (sym);
3502 if (p->type == P_UNKNOWN)
3505 if (p->u.wsym.state == WRITTEN)
3508 write_symbol (p->integer, sym);
3509 p->u.wsym.state = WRITTEN;
3515 /* Recursive traversal function to write the secondary set of symbols
3516 to the module file. These are symbols that were not public yet are
3517 needed by the public symbols or another dependent symbol. The act
3518 of writing a symbol can modify the pointer_info tree, so we cease
3519 traversal if we find a symbol to write. We return nonzero if a
3520 symbol was written and pass that information upwards. */
3523 write_symbol1 (pointer_info * p)
3529 if (write_symbol1 (p->left))
3531 if (write_symbol1 (p->right))
3534 if (p->type != P_SYMBOL || p->u.wsym.state != NEEDS_WRITE)
3537 p->u.wsym.state = WRITTEN;
3538 write_symbol (p->integer, p->u.wsym.sym);
3544 /* Write operator interfaces associated with a symbol. */
3547 write_operator (gfc_user_op * uop)
3549 static char nullstring[] = "";
3550 const char *p = nullstring;
3552 if (uop->operator == NULL
3553 || !gfc_check_access (uop->access, uop->ns->default_access))
3556 mio_symbol_interface (&uop->name, &p, &uop->operator);
3560 /* Write generic interfaces associated with a symbol. */
3563 write_generic (gfc_symbol * sym)
3566 if (sym->generic == NULL
3567 || !gfc_check_access (sym->attr.access, sym->ns->default_access))
3570 mio_symbol_interface (&sym->name, &sym->module, &sym->generic);
3575 write_symtree (gfc_symtree * st)
3581 if (!gfc_check_access (sym->attr.access, sym->ns->default_access)
3582 || (sym->attr.flavor == FL_PROCEDURE && sym->attr.generic
3583 && !sym->attr.subroutine && !sym->attr.function))
3586 if (check_unique_name (st->name))
3589 p = find_pointer (sym);
3591 gfc_internal_error ("write_symtree(): Symbol not written");
3593 mio_pool_string (&st->name);
3594 mio_integer (&st->ambiguous);
3595 mio_integer (&p->integer);
3604 /* Write the operator interfaces. */
3607 for (i = GFC_INTRINSIC_BEGIN; i != GFC_INTRINSIC_END; i++)
3609 if (i == INTRINSIC_USER)
3612 mio_interface (gfc_check_access (gfc_current_ns->operator_access[i],
3613 gfc_current_ns->default_access)
3614 ? &gfc_current_ns->operator[i] : NULL);
3622 gfc_traverse_user_op (gfc_current_ns, write_operator);
3628 gfc_traverse_ns (gfc_current_ns, write_generic);
3634 write_blank_common ();
3635 write_common (gfc_current_ns->common_root);
3643 write_char('\n'); write_char('\n');
3645 /* Write symbol information. First we traverse all symbols in the
3646 primary namespace, writing those that need to be written.
3647 Sometimes writing one symbol will cause another to need to be
3648 written. A list of these symbols ends up on the write stack, and
3649 we end by popping the bottom of the stack and writing the symbol
3650 until the stack is empty. */
3654 write_symbol0 (gfc_current_ns->sym_root);
3655 while (write_symbol1 (pi_root));
3663 gfc_traverse_symtree (gfc_current_ns->sym_root, write_symtree);
3668 /* Given module, dump it to disk. If there was an error while
3669 processing the module, dump_flag will be set to zero and we delete
3670 the module file, even if it was already there. */
3673 gfc_dump_module (const char *name, int dump_flag)
3679 n = strlen (name) + strlen (MODULE_EXTENSION) + 1;
3680 if (gfc_option.module_dir != NULL)
3682 filename = (char *) alloca (n + strlen (gfc_option.module_dir));
3683 strcpy (filename, gfc_option.module_dir);
3684 strcat (filename, name);
3688 filename = (char *) alloca (n);
3689 strcpy (filename, name);
3691 strcat (filename, MODULE_EXTENSION);
3699 module_fp = fopen (filename, "w");
3700 if (module_fp == NULL)
3701 gfc_fatal_error ("Can't open module file '%s' for writing at %C: %s",
3702 filename, strerror (errno));
3707 *strchr (p, '\n') = '\0';
3709 fprintf (module_fp, "GFORTRAN module created from %s on %s\n",
3710 gfc_source_file, p);
3711 fputs ("If you edit this, you'll get what you deserve.\n\n", module_fp);
3714 strcpy (module_name, name);
3720 free_pi_tree (pi_root);
3725 if (fclose (module_fp))
3726 gfc_fatal_error ("Error writing module file '%s' for writing: %s",
3727 filename, strerror (errno));
3731 /* Process a USE directive. */
3734 gfc_use_module (void)
3740 filename = (char *) alloca(strlen(module_name) + strlen(MODULE_EXTENSION)
3742 strcpy (filename, module_name);
3743 strcat (filename, MODULE_EXTENSION);
3745 module_fp = gfc_open_included_file (filename, true);
3746 if (module_fp == NULL)
3747 gfc_fatal_error ("Can't open module file '%s' for reading at %C: %s",
3748 filename, strerror (errno));
3754 /* Skip the first two lines of the module. */
3755 /* FIXME: Could also check for valid two lines here, instead. */
3761 bad_module ("Unexpected end of module");
3766 /* Make sure we're not reading the same module that we may be building. */
3767 for (p = gfc_state_stack; p; p = p->previous)
3768 if (p->state == COMP_MODULE && strcmp (p->sym->name, module_name) == 0)
3769 gfc_fatal_error ("Can't USE the same module we're building!");
3772 init_true_name_tree ();
3776 free_true_name (true_name_root);
3777 true_name_root = NULL;
3779 free_pi_tree (pi_root);
3787 gfc_module_init_2 (void)
3790 last_atom = ATOM_LPAREN;
3795 gfc_module_done_2 (void)