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 /* The way the module we're reading was specified. */
177 static bool specified_nonint, specified_int;
179 static int module_line, module_column, only_flag;
181 { IO_INPUT, IO_OUTPUT }
184 static gfc_use_rename *gfc_rename_list;
185 static pointer_info *pi_root;
186 static int symbol_number; /* Counter for assigning symbol numbers */
188 /* Tells mio_expr_ref not to load unused equivalence members. */
189 static bool in_load_equiv;
193 /*****************************************************************/
195 /* Pointer/integer conversion. Pointers between structures are stored
196 as integers in the module file. The next couple of subroutines
197 handle this translation for reading and writing. */
199 /* Recursively free the tree of pointer structures. */
202 free_pi_tree (pointer_info * p)
207 if (p->fixup != NULL)
208 gfc_internal_error ("free_pi_tree(): Unresolved fixup");
210 free_pi_tree (p->left);
211 free_pi_tree (p->right);
217 /* Compare pointers when searching by pointer. Used when writing a
221 compare_pointers (void * _sn1, void * _sn2)
223 pointer_info *sn1, *sn2;
225 sn1 = (pointer_info *) _sn1;
226 sn2 = (pointer_info *) _sn2;
228 if (sn1->u.pointer < sn2->u.pointer)
230 if (sn1->u.pointer > sn2->u.pointer)
237 /* Compare integers when searching by integer. Used when reading a
241 compare_integers (void * _sn1, void * _sn2)
243 pointer_info *sn1, *sn2;
245 sn1 = (pointer_info *) _sn1;
246 sn2 = (pointer_info *) _sn2;
248 if (sn1->integer < sn2->integer)
250 if (sn1->integer > sn2->integer)
257 /* Initialize the pointer_info tree. */
266 compare = (iomode == IO_INPUT) ? compare_integers : compare_pointers;
268 /* Pointer 0 is the NULL pointer. */
269 p = gfc_get_pointer_info ();
274 gfc_insert_bbt (&pi_root, p, compare);
276 /* Pointer 1 is the current namespace. */
277 p = gfc_get_pointer_info ();
278 p->u.pointer = gfc_current_ns;
280 p->type = P_NAMESPACE;
282 gfc_insert_bbt (&pi_root, p, compare);
288 /* During module writing, call here with a pointer to something,
289 returning the pointer_info node. */
291 static pointer_info *
292 find_pointer (void *gp)
299 if (p->u.pointer == gp)
301 p = (gp < p->u.pointer) ? p->left : p->right;
308 /* Given a pointer while writing, returns the pointer_info tree node,
309 creating it if it doesn't exist. */
311 static pointer_info *
312 get_pointer (void *gp)
316 p = find_pointer (gp);
320 /* Pointer doesn't have an integer. Give it one. */
321 p = gfc_get_pointer_info ();
324 p->integer = symbol_number++;
326 gfc_insert_bbt (&pi_root, p, compare_pointers);
332 /* Given an integer during reading, find it in the pointer_info tree,
333 creating the node if not found. */
335 static pointer_info *
336 get_integer (int integer)
346 c = compare_integers (&t, p);
350 p = (c < 0) ? p->left : p->right;
356 p = gfc_get_pointer_info ();
357 p->integer = integer;
360 gfc_insert_bbt (&pi_root, p, compare_integers);
366 /* Recursive function to find a pointer within a tree by brute force. */
368 static pointer_info *
369 fp2 (pointer_info * p, const void *target)
376 if (p->u.pointer == target)
379 q = fp2 (p->left, target);
383 return fp2 (p->right, target);
387 /* During reading, find a pointer_info node from the pointer value.
388 This amounts to a brute-force search. */
390 static pointer_info *
391 find_pointer2 (void *p)
394 return fp2 (pi_root, p);
398 /* Resolve any fixups using a known pointer. */
400 resolve_fixups (fixup_t *f, void * gp)
412 /* Call here during module reading when we know what pointer to
413 associate with an integer. Any fixups that exist are resolved at
417 associate_integer_pointer (pointer_info * p, void *gp)
419 if (p->u.pointer != NULL)
420 gfc_internal_error ("associate_integer_pointer(): Already associated");
424 resolve_fixups (p->fixup, gp);
430 /* During module reading, given an integer and a pointer to a pointer,
431 either store the pointer from an already-known value or create a
432 fixup structure in order to store things later. Returns zero if
433 the reference has been actually stored, or nonzero if the reference
434 must be fixed later (ie associate_integer_pointer must be called
435 sometime later. Returns the pointer_info structure. */
437 static pointer_info *
438 add_fixup (int integer, void *gp)
444 p = get_integer (integer);
446 if (p->integer == 0 || p->u.pointer != NULL)
453 f = gfc_getmem (sizeof (fixup_t));
465 /*****************************************************************/
467 /* Parser related subroutines */
469 /* Free the rename list left behind by a USE statement. */
474 gfc_use_rename *next;
476 for (; gfc_rename_list; gfc_rename_list = next)
478 next = gfc_rename_list->next;
479 gfc_free (gfc_rename_list);
484 /* Match a USE statement. */
489 char name[GFC_MAX_SYMBOL_LEN + 1], module_nature[GFC_MAX_SYMBOL_LEN + 1];
490 gfc_use_rename *tail = NULL, *new;
492 gfc_intrinsic_op operator;
495 specified_int = false;
496 specified_nonint = false;
498 if (gfc_match (" , ") == MATCH_YES)
500 if ((m = gfc_match (" %n ::", module_nature)) == MATCH_YES)
502 if (gfc_notify_std (GFC_STD_F2003, "Fortran 2003: module "
503 "nature in USE statement at %C") == FAILURE)
506 if (strcmp (module_nature, "intrinsic") == 0)
507 specified_int = true;
510 if (strcmp (module_nature, "non_intrinsic") == 0)
511 specified_nonint = true;
514 gfc_error ("Module nature in USE statement at %C shall "
515 "be either INTRINSIC or NON_INTRINSIC");
522 /* Help output a better error message than "Unclassifiable
524 gfc_match (" %n", module_nature);
525 if (strcmp (module_nature, "intrinsic") == 0
526 || strcmp (module_nature, "non_intrinsic") == 0)
527 gfc_error ("\"::\" was expected after module nature at %C "
528 "but was not found");
534 m = gfc_match (" ::");
535 if (m == MATCH_YES &&
536 gfc_notify_std (GFC_STD_F2003, "Fortran 2003: "
537 "\"USE :: module\" at %C") == FAILURE)
542 m = gfc_match ("% ");
548 m = gfc_match_name (module_name);
555 if (gfc_match_eos () == MATCH_YES)
557 if (gfc_match_char (',') != MATCH_YES)
560 if (gfc_match (" only :") == MATCH_YES)
563 if (gfc_match_eos () == MATCH_YES)
568 /* Get a new rename struct and add it to the rename list. */
569 new = gfc_get_use_rename ();
570 new->where = gfc_current_locus;
573 if (gfc_rename_list == NULL)
574 gfc_rename_list = new;
579 /* See what kind of interface we're dealing with. Assume it is
581 new->operator = INTRINSIC_NONE;
582 if (gfc_match_generic_spec (&type, name, &operator) == MATCH_ERROR)
587 case INTERFACE_NAMELESS:
588 gfc_error ("Missing generic specification in USE statement at %C");
591 case INTERFACE_GENERIC:
592 m = gfc_match (" =>");
597 strcpy (new->use_name, name);
600 strcpy (new->local_name, name);
602 m = gfc_match_name (new->use_name);
605 if (m == MATCH_ERROR)
613 strcpy (new->local_name, name);
615 m = gfc_match_name (new->use_name);
618 if (m == MATCH_ERROR)
624 case INTERFACE_USER_OP:
625 strcpy (new->use_name, name);
628 case INTERFACE_INTRINSIC_OP:
629 new->operator = operator;
633 if (gfc_match_eos () == MATCH_YES)
635 if (gfc_match_char (',') != MATCH_YES)
642 gfc_syntax_error (ST_USE);
650 /* Given a name and a number, inst, return the inst name
651 under which to load this symbol. Returns NULL if this
652 symbol shouldn't be loaded. If inst is zero, returns
653 the number of instances of this name. */
656 find_use_name_n (const char *name, int *inst)
662 for (u = gfc_rename_list; u; u = u->next)
664 if (strcmp (u->use_name, name) != 0)
677 return only_flag ? NULL : name;
681 return (u->local_name[0] != '\0') ? u->local_name : name;
684 /* Given a name, return the name under which to load this symbol.
685 Returns NULL if this symbol shouldn't be loaded. */
688 find_use_name (const char *name)
691 return find_use_name_n (name, &i);
694 /* Given a real name, return the number of use names associated
698 number_use_names (const char *name)
702 c = find_use_name_n (name, &i);
707 /* Try to find the operator in the current list. */
709 static gfc_use_rename *
710 find_use_operator (gfc_intrinsic_op operator)
714 for (u = gfc_rename_list; u; u = u->next)
715 if (u->operator == operator)
722 /*****************************************************************/
724 /* The next couple of subroutines maintain a tree used to avoid a
725 brute-force search for a combination of true name and module name.
726 While symtree names, the name that a particular symbol is known by
727 can changed with USE statements, we still have to keep track of the
728 true names to generate the correct reference, and also avoid
729 loading the same real symbol twice in a program unit.
731 When we start reading, the true name tree is built and maintained
732 as symbols are read. The tree is searched as we load new symbols
733 to see if it already exists someplace in the namespace. */
735 typedef struct true_name
737 BBT_HEADER (true_name);
742 static true_name *true_name_root;
745 /* Compare two true_name structures. */
748 compare_true_names (void * _t1, void * _t2)
753 t1 = (true_name *) _t1;
754 t2 = (true_name *) _t2;
756 c = ((t1->sym->module > t2->sym->module)
757 - (t1->sym->module < t2->sym->module));
761 return strcmp (t1->sym->name, t2->sym->name);
765 /* Given a true name, search the true name tree to see if it exists
766 within the main namespace. */
769 find_true_name (const char *name, const char *module)
775 sym.name = gfc_get_string (name);
777 sym.module = gfc_get_string (module);
785 c = compare_true_names ((void *)(&t), (void *) p);
789 p = (c < 0) ? p->left : p->right;
796 /* Given a gfc_symbol pointer that is not in the true name tree, add
800 add_true_name (gfc_symbol * sym)
804 t = gfc_getmem (sizeof (true_name));
807 gfc_insert_bbt (&true_name_root, t, compare_true_names);
811 /* Recursive function to build the initial true name tree by
812 recursively traversing the current namespace. */
815 build_tnt (gfc_symtree * st)
821 build_tnt (st->left);
822 build_tnt (st->right);
824 if (find_true_name (st->n.sym->name, st->n.sym->module) != NULL)
827 add_true_name (st->n.sym);
831 /* Initialize the true name tree with the current namespace. */
834 init_true_name_tree (void)
836 true_name_root = NULL;
838 build_tnt (gfc_current_ns->sym_root);
842 /* Recursively free a true name tree node. */
845 free_true_name (true_name * t)
850 free_true_name (t->left);
851 free_true_name (t->right);
857 /*****************************************************************/
859 /* Module reading and writing. */
863 ATOM_NAME, ATOM_LPAREN, ATOM_RPAREN, ATOM_INTEGER, ATOM_STRING
867 static atom_type last_atom;
870 /* The name buffer must be at least as long as a symbol name. Right
871 now it's not clear how we're going to store numeric constants--
872 probably as a hexadecimal string, since this will allow the exact
873 number to be preserved (this can't be done by a decimal
874 representation). Worry about that later. TODO! */
876 #define MAX_ATOM_SIZE 100
879 static char *atom_string, atom_name[MAX_ATOM_SIZE];
882 /* Report problems with a module. Error reporting is not very
883 elaborate, since this sorts of errors shouldn't really happen.
884 This subroutine never returns. */
886 static void bad_module (const char *) ATTRIBUTE_NORETURN;
889 bad_module (const char *msgid)
896 gfc_fatal_error ("Reading module %s at line %d column %d: %s",
897 module_name, module_line, module_column, msgid);
900 gfc_fatal_error ("Writing module %s at line %d column %d: %s",
901 module_name, module_line, module_column, msgid);
904 gfc_fatal_error ("Module %s at line %d column %d: %s",
905 module_name, module_line, module_column, msgid);
911 /* Set the module's input pointer. */
914 set_module_locus (module_locus * m)
917 module_column = m->column;
918 module_line = m->line;
919 fsetpos (module_fp, &m->pos);
923 /* Get the module's input pointer so that we can restore it later. */
926 get_module_locus (module_locus * m)
929 m->column = module_column;
930 m->line = module_line;
931 fgetpos (module_fp, &m->pos);
935 /* Get the next character in the module, updating our reckoning of
943 c = fgetc (module_fp);
946 bad_module ("Unexpected EOF");
959 /* Parse a string constant. The delimiter is guaranteed to be a
969 get_module_locus (&start);
973 /* See how long the string is */
978 bad_module ("Unexpected end of module in string constant");
996 set_module_locus (&start);
998 atom_string = p = gfc_getmem (len + 1);
1000 for (; len > 0; len--)
1004 module_char (); /* Guaranteed to be another \' */
1008 module_char (); /* Terminating \' */
1009 *p = '\0'; /* C-style string for debug purposes */
1013 /* Parse a small integer. */
1016 parse_integer (int c)
1024 get_module_locus (&m);
1030 atom_int = 10 * atom_int + c - '0';
1031 if (atom_int > 99999999)
1032 bad_module ("Integer overflow");
1035 set_module_locus (&m);
1053 get_module_locus (&m);
1058 if (!ISALNUM (c) && c != '_' && c != '-')
1062 if (++len > GFC_MAX_SYMBOL_LEN)
1063 bad_module ("Name too long");
1068 fseek (module_fp, -1, SEEK_CUR);
1069 module_column = m.column + len - 1;
1076 /* Read the next atom in the module's input stream. */
1087 while (c == ' ' || c == '\n');
1112 return ATOM_INTEGER;
1170 bad_module ("Bad name");
1177 /* Peek at the next atom on the input. */
1185 get_module_locus (&m);
1188 if (a == ATOM_STRING)
1189 gfc_free (atom_string);
1191 set_module_locus (&m);
1196 /* Read the next atom from the input, requiring that it be a
1200 require_atom (atom_type type)
1206 get_module_locus (&m);
1214 p = _("Expected name");
1217 p = _("Expected left parenthesis");
1220 p = _("Expected right parenthesis");
1223 p = _("Expected integer");
1226 p = _("Expected string");
1229 gfc_internal_error ("require_atom(): bad atom type required");
1232 set_module_locus (&m);
1238 /* Given a pointer to an mstring array, require that the current input
1239 be one of the strings in the array. We return the enum value. */
1242 find_enum (const mstring * m)
1246 i = gfc_string2code (m, atom_name);
1250 bad_module ("find_enum(): Enum not found");
1256 /**************** Module output subroutines ***************************/
1258 /* Output a character to a module file. */
1261 write_char (char out)
1264 if (fputc (out, module_fp) == EOF)
1265 gfc_fatal_error ("Error writing modules file: %s", strerror (errno));
1277 /* Write an atom to a module. The line wrapping isn't perfect, but it
1278 should work most of the time. This isn't that big of a deal, since
1279 the file really isn't meant to be read by people anyway. */
1282 write_atom (atom_type atom, const void *v)
1304 i = *((const int *) v);
1306 gfc_internal_error ("write_atom(): Writing negative integer");
1308 sprintf (buffer, "%d", i);
1313 gfc_internal_error ("write_atom(): Trying to write dab atom");
1319 if (atom != ATOM_RPAREN)
1321 if (module_column + len > 72)
1326 if (last_atom != ATOM_LPAREN && module_column != 1)
1331 if (atom == ATOM_STRING)
1336 if (atom == ATOM_STRING && *p == '\'')
1341 if (atom == ATOM_STRING)
1349 /***************** Mid-level I/O subroutines *****************/
1351 /* These subroutines let their caller read or write atoms without
1352 caring about which of the two is actually happening. This lets a
1353 subroutine concentrate on the actual format of the data being
1356 static void mio_expr (gfc_expr **);
1357 static void mio_symbol_ref (gfc_symbol **);
1358 static void mio_symtree_ref (gfc_symtree **);
1360 /* Read or write an enumerated value. On writing, we return the input
1361 value for the convenience of callers. We avoid using an integer
1362 pointer because enums are sometimes inside bitfields. */
1365 mio_name (int t, const mstring * m)
1368 if (iomode == IO_OUTPUT)
1369 write_atom (ATOM_NAME, gfc_code2string (m, t));
1372 require_atom (ATOM_NAME);
1379 /* Specialization of mio_name. */
1381 #define DECL_MIO_NAME(TYPE) \
1382 static inline TYPE \
1383 MIO_NAME(TYPE) (TYPE t, const mstring * m) \
1385 return (TYPE)mio_name ((int)t, m); \
1387 #define MIO_NAME(TYPE) mio_name_##TYPE
1393 if (iomode == IO_OUTPUT)
1394 write_atom (ATOM_LPAREN, NULL);
1396 require_atom (ATOM_LPAREN);
1404 if (iomode == IO_OUTPUT)
1405 write_atom (ATOM_RPAREN, NULL);
1407 require_atom (ATOM_RPAREN);
1412 mio_integer (int *ip)
1415 if (iomode == IO_OUTPUT)
1416 write_atom (ATOM_INTEGER, ip);
1419 require_atom (ATOM_INTEGER);
1425 /* Read or write a character pointer that points to a string on the
1429 mio_allocated_string (const char *s)
1431 if (iomode == IO_OUTPUT)
1433 write_atom (ATOM_STRING, s);
1438 require_atom (ATOM_STRING);
1444 /* Read or write a string that is in static memory. */
1447 mio_pool_string (const char **stringp)
1449 /* TODO: one could write the string only once, and refer to it via a
1452 /* As a special case we have to deal with a NULL string. This
1453 happens for the 'module' member of 'gfc_symbol's that are not in a
1454 module. We read / write these as the empty string. */
1455 if (iomode == IO_OUTPUT)
1457 const char *p = *stringp == NULL ? "" : *stringp;
1458 write_atom (ATOM_STRING, p);
1462 require_atom (ATOM_STRING);
1463 *stringp = atom_string[0] == '\0' ? NULL : gfc_get_string (atom_string);
1464 gfc_free (atom_string);
1469 /* Read or write a string that is inside of some already-allocated
1473 mio_internal_string (char *string)
1476 if (iomode == IO_OUTPUT)
1477 write_atom (ATOM_STRING, string);
1480 require_atom (ATOM_STRING);
1481 strcpy (string, atom_string);
1482 gfc_free (atom_string);
1489 { AB_ALLOCATABLE, AB_DIMENSION, AB_EXTERNAL, AB_INTRINSIC, AB_OPTIONAL,
1490 AB_POINTER, AB_SAVE, AB_TARGET, AB_DUMMY, AB_RESULT,
1491 AB_DATA, AB_IN_NAMELIST, AB_IN_COMMON,
1492 AB_FUNCTION, AB_SUBROUTINE, AB_SEQUENCE, AB_ELEMENTAL, AB_PURE,
1493 AB_RECURSIVE, AB_GENERIC, AB_ALWAYS_EXPLICIT, AB_CRAY_POINTER,
1494 AB_CRAY_POINTEE, AB_THREADPRIVATE, AB_ALLOC_COMP, AB_VOLATILE
1498 static const mstring attr_bits[] =
1500 minit ("ALLOCATABLE", AB_ALLOCATABLE),
1501 minit ("DIMENSION", AB_DIMENSION),
1502 minit ("EXTERNAL", AB_EXTERNAL),
1503 minit ("INTRINSIC", AB_INTRINSIC),
1504 minit ("OPTIONAL", AB_OPTIONAL),
1505 minit ("POINTER", AB_POINTER),
1506 minit ("SAVE", AB_SAVE),
1507 minit ("VOLATILE", AB_VOLATILE),
1508 minit ("TARGET", AB_TARGET),
1509 minit ("THREADPRIVATE", AB_THREADPRIVATE),
1510 minit ("DUMMY", AB_DUMMY),
1511 minit ("RESULT", AB_RESULT),
1512 minit ("DATA", AB_DATA),
1513 minit ("IN_NAMELIST", AB_IN_NAMELIST),
1514 minit ("IN_COMMON", AB_IN_COMMON),
1515 minit ("FUNCTION", AB_FUNCTION),
1516 minit ("SUBROUTINE", AB_SUBROUTINE),
1517 minit ("SEQUENCE", AB_SEQUENCE),
1518 minit ("ELEMENTAL", AB_ELEMENTAL),
1519 minit ("PURE", AB_PURE),
1520 minit ("RECURSIVE", AB_RECURSIVE),
1521 minit ("GENERIC", AB_GENERIC),
1522 minit ("ALWAYS_EXPLICIT", AB_ALWAYS_EXPLICIT),
1523 minit ("CRAY_POINTER", AB_CRAY_POINTER),
1524 minit ("CRAY_POINTEE", AB_CRAY_POINTEE),
1525 minit ("ALLOC_COMP", AB_ALLOC_COMP),
1529 /* Specialization of mio_name. */
1530 DECL_MIO_NAME(ab_attribute)
1531 DECL_MIO_NAME(ar_type)
1532 DECL_MIO_NAME(array_type)
1534 DECL_MIO_NAME(expr_t)
1535 DECL_MIO_NAME(gfc_access)
1536 DECL_MIO_NAME(gfc_intrinsic_op)
1537 DECL_MIO_NAME(ifsrc)
1538 DECL_MIO_NAME(procedure_type)
1539 DECL_MIO_NAME(ref_type)
1540 DECL_MIO_NAME(sym_flavor)
1541 DECL_MIO_NAME(sym_intent)
1542 #undef DECL_MIO_NAME
1544 /* Symbol attributes are stored in list with the first three elements
1545 being the enumerated fields, while the remaining elements (if any)
1546 indicate the individual attribute bits. The access field is not
1547 saved-- it controls what symbols are exported when a module is
1551 mio_symbol_attribute (symbol_attribute * attr)
1557 attr->flavor = MIO_NAME(sym_flavor) (attr->flavor, flavors);
1558 attr->intent = MIO_NAME(sym_intent) (attr->intent, intents);
1559 attr->proc = MIO_NAME(procedure_type) (attr->proc, procedures);
1560 attr->if_source = MIO_NAME(ifsrc) (attr->if_source, ifsrc_types);
1562 if (iomode == IO_OUTPUT)
1564 if (attr->allocatable)
1565 MIO_NAME(ab_attribute) (AB_ALLOCATABLE, attr_bits);
1566 if (attr->dimension)
1567 MIO_NAME(ab_attribute) (AB_DIMENSION, attr_bits);
1569 MIO_NAME(ab_attribute) (AB_EXTERNAL, attr_bits);
1570 if (attr->intrinsic)
1571 MIO_NAME(ab_attribute) (AB_INTRINSIC, attr_bits);
1573 MIO_NAME(ab_attribute) (AB_OPTIONAL, attr_bits);
1575 MIO_NAME(ab_attribute) (AB_POINTER, attr_bits);
1577 MIO_NAME(ab_attribute) (AB_SAVE, attr_bits);
1578 if (attr->volatile_)
1579 MIO_NAME(ab_attribute) (AB_VOLATILE, attr_bits);
1581 MIO_NAME(ab_attribute) (AB_TARGET, attr_bits);
1582 if (attr->threadprivate)
1583 MIO_NAME(ab_attribute) (AB_THREADPRIVATE, attr_bits);
1585 MIO_NAME(ab_attribute) (AB_DUMMY, attr_bits);
1587 MIO_NAME(ab_attribute) (AB_RESULT, attr_bits);
1588 /* We deliberately don't preserve the "entry" flag. */
1591 MIO_NAME(ab_attribute) (AB_DATA, attr_bits);
1592 if (attr->in_namelist)
1593 MIO_NAME(ab_attribute) (AB_IN_NAMELIST, attr_bits);
1594 if (attr->in_common)
1595 MIO_NAME(ab_attribute) (AB_IN_COMMON, attr_bits);
1598 MIO_NAME(ab_attribute) (AB_FUNCTION, attr_bits);
1599 if (attr->subroutine)
1600 MIO_NAME(ab_attribute) (AB_SUBROUTINE, attr_bits);
1602 MIO_NAME(ab_attribute) (AB_GENERIC, attr_bits);
1605 MIO_NAME(ab_attribute) (AB_SEQUENCE, attr_bits);
1606 if (attr->elemental)
1607 MIO_NAME(ab_attribute) (AB_ELEMENTAL, attr_bits);
1609 MIO_NAME(ab_attribute) (AB_PURE, attr_bits);
1610 if (attr->recursive)
1611 MIO_NAME(ab_attribute) (AB_RECURSIVE, attr_bits);
1612 if (attr->always_explicit)
1613 MIO_NAME(ab_attribute) (AB_ALWAYS_EXPLICIT, attr_bits);
1614 if (attr->cray_pointer)
1615 MIO_NAME(ab_attribute) (AB_CRAY_POINTER, attr_bits);
1616 if (attr->cray_pointee)
1617 MIO_NAME(ab_attribute) (AB_CRAY_POINTEE, attr_bits);
1618 if (attr->alloc_comp)
1619 MIO_NAME(ab_attribute) (AB_ALLOC_COMP, attr_bits);
1630 if (t == ATOM_RPAREN)
1633 bad_module ("Expected attribute bit name");
1635 switch ((ab_attribute) find_enum (attr_bits))
1637 case AB_ALLOCATABLE:
1638 attr->allocatable = 1;
1641 attr->dimension = 1;
1647 attr->intrinsic = 1;
1659 attr->volatile_ = 1;
1664 case AB_THREADPRIVATE:
1665 attr->threadprivate = 1;
1676 case AB_IN_NAMELIST:
1677 attr->in_namelist = 1;
1680 attr->in_common = 1;
1686 attr->subroutine = 1;
1695 attr->elemental = 1;
1701 attr->recursive = 1;
1703 case AB_ALWAYS_EXPLICIT:
1704 attr->always_explicit = 1;
1706 case AB_CRAY_POINTER:
1707 attr->cray_pointer = 1;
1709 case AB_CRAY_POINTEE:
1710 attr->cray_pointee = 1;
1713 attr->alloc_comp = 1;
1721 static const mstring bt_types[] = {
1722 minit ("INTEGER", BT_INTEGER),
1723 minit ("REAL", BT_REAL),
1724 minit ("COMPLEX", BT_COMPLEX),
1725 minit ("LOGICAL", BT_LOGICAL),
1726 minit ("CHARACTER", BT_CHARACTER),
1727 minit ("DERIVED", BT_DERIVED),
1728 minit ("PROCEDURE", BT_PROCEDURE),
1729 minit ("UNKNOWN", BT_UNKNOWN),
1735 mio_charlen (gfc_charlen ** clp)
1741 if (iomode == IO_OUTPUT)
1745 mio_expr (&cl->length);
1750 if (peek_atom () != ATOM_RPAREN)
1752 cl = gfc_get_charlen ();
1753 mio_expr (&cl->length);
1757 cl->next = gfc_current_ns->cl_list;
1758 gfc_current_ns->cl_list = cl;
1766 /* Return a symtree node with a name that is guaranteed to be unique
1767 within the namespace and corresponds to an illegal fortran name. */
1769 static gfc_symtree *
1770 get_unique_symtree (gfc_namespace * ns)
1772 char name[GFC_MAX_SYMBOL_LEN + 1];
1773 static int serial = 0;
1775 sprintf (name, "@%d", serial++);
1776 return gfc_new_symtree (&ns->sym_root, name);
1780 /* See if a name is a generated name. */
1783 check_unique_name (const char *name)
1786 return *name == '@';
1791 mio_typespec (gfc_typespec * ts)
1796 ts->type = MIO_NAME(bt) (ts->type, bt_types);
1798 if (ts->type != BT_DERIVED)
1799 mio_integer (&ts->kind);
1801 mio_symbol_ref (&ts->derived);
1803 mio_charlen (&ts->cl);
1809 static const mstring array_spec_types[] = {
1810 minit ("EXPLICIT", AS_EXPLICIT),
1811 minit ("ASSUMED_SHAPE", AS_ASSUMED_SHAPE),
1812 minit ("DEFERRED", AS_DEFERRED),
1813 minit ("ASSUMED_SIZE", AS_ASSUMED_SIZE),
1819 mio_array_spec (gfc_array_spec ** asp)
1826 if (iomode == IO_OUTPUT)
1834 if (peek_atom () == ATOM_RPAREN)
1840 *asp = as = gfc_get_array_spec ();
1843 mio_integer (&as->rank);
1844 as->type = MIO_NAME(array_type) (as->type, array_spec_types);
1846 for (i = 0; i < as->rank; i++)
1848 mio_expr (&as->lower[i]);
1849 mio_expr (&as->upper[i]);
1857 /* Given a pointer to an array reference structure (which lives in a
1858 gfc_ref structure), find the corresponding array specification
1859 structure. Storing the pointer in the ref structure doesn't quite
1860 work when loading from a module. Generating code for an array
1861 reference also needs more information than just the array spec. */
1863 static const mstring array_ref_types[] = {
1864 minit ("FULL", AR_FULL),
1865 minit ("ELEMENT", AR_ELEMENT),
1866 minit ("SECTION", AR_SECTION),
1871 mio_array_ref (gfc_array_ref * ar)
1876 ar->type = MIO_NAME(ar_type) (ar->type, array_ref_types);
1877 mio_integer (&ar->dimen);
1885 for (i = 0; i < ar->dimen; i++)
1886 mio_expr (&ar->start[i]);
1891 for (i = 0; i < ar->dimen; i++)
1893 mio_expr (&ar->start[i]);
1894 mio_expr (&ar->end[i]);
1895 mio_expr (&ar->stride[i]);
1901 gfc_internal_error ("mio_array_ref(): Unknown array ref");
1904 for (i = 0; i < ar->dimen; i++)
1905 mio_integer ((int *) &ar->dimen_type[i]);
1907 if (iomode == IO_INPUT)
1909 ar->where = gfc_current_locus;
1911 for (i = 0; i < ar->dimen; i++)
1912 ar->c_where[i] = gfc_current_locus;
1919 /* Saves or restores a pointer. The pointer is converted back and
1920 forth from an integer. We return the pointer_info pointer so that
1921 the caller can take additional action based on the pointer type. */
1923 static pointer_info *
1924 mio_pointer_ref (void *gp)
1928 if (iomode == IO_OUTPUT)
1930 p = get_pointer (*((char **) gp));
1931 write_atom (ATOM_INTEGER, &p->integer);
1935 require_atom (ATOM_INTEGER);
1936 p = add_fixup (atom_int, gp);
1943 /* Save and load references to components that occur within
1944 expressions. We have to describe these references by a number and
1945 by name. The number is necessary for forward references during
1946 reading, and the name is necessary if the symbol already exists in
1947 the namespace and is not loaded again. */
1950 mio_component_ref (gfc_component ** cp, gfc_symbol * sym)
1952 char name[GFC_MAX_SYMBOL_LEN + 1];
1956 p = mio_pointer_ref (cp);
1957 if (p->type == P_UNKNOWN)
1958 p->type = P_COMPONENT;
1960 if (iomode == IO_OUTPUT)
1961 mio_pool_string (&(*cp)->name);
1964 mio_internal_string (name);
1966 /* It can happen that a component reference can be read before the
1967 associated derived type symbol has been loaded. Return now and
1968 wait for a later iteration of load_needed. */
1972 if (sym->components != NULL && p->u.pointer == NULL)
1974 /* Symbol already loaded, so search by name. */
1975 for (q = sym->components; q; q = q->next)
1976 if (strcmp (q->name, name) == 0)
1980 gfc_internal_error ("mio_component_ref(): Component not found");
1982 associate_integer_pointer (p, q);
1985 /* Make sure this symbol will eventually be loaded. */
1986 p = find_pointer2 (sym);
1987 if (p->u.rsym.state == UNUSED)
1988 p->u.rsym.state = NEEDED;
1994 mio_component (gfc_component * c)
2001 if (iomode == IO_OUTPUT)
2003 p = get_pointer (c);
2004 mio_integer (&p->integer);
2009 p = get_integer (n);
2010 associate_integer_pointer (p, c);
2013 if (p->type == P_UNKNOWN)
2014 p->type = P_COMPONENT;
2016 mio_pool_string (&c->name);
2017 mio_typespec (&c->ts);
2018 mio_array_spec (&c->as);
2020 mio_integer (&c->dimension);
2021 mio_integer (&c->pointer);
2022 mio_integer (&c->allocatable);
2024 mio_expr (&c->initializer);
2030 mio_component_list (gfc_component ** cp)
2032 gfc_component *c, *tail;
2036 if (iomode == IO_OUTPUT)
2038 for (c = *cp; c; c = c->next)
2049 if (peek_atom () == ATOM_RPAREN)
2052 c = gfc_get_component ();
2069 mio_actual_arg (gfc_actual_arglist * a)
2073 mio_pool_string (&a->name);
2074 mio_expr (&a->expr);
2080 mio_actual_arglist (gfc_actual_arglist ** ap)
2082 gfc_actual_arglist *a, *tail;
2086 if (iomode == IO_OUTPUT)
2088 for (a = *ap; a; a = a->next)
2098 if (peek_atom () != ATOM_LPAREN)
2101 a = gfc_get_actual_arglist ();
2117 /* Read and write formal argument lists. */
2120 mio_formal_arglist (gfc_symbol * sym)
2122 gfc_formal_arglist *f, *tail;
2126 if (iomode == IO_OUTPUT)
2128 for (f = sym->formal; f; f = f->next)
2129 mio_symbol_ref (&f->sym);
2134 sym->formal = tail = NULL;
2136 while (peek_atom () != ATOM_RPAREN)
2138 f = gfc_get_formal_arglist ();
2139 mio_symbol_ref (&f->sym);
2141 if (sym->formal == NULL)
2154 /* Save or restore a reference to a symbol node. */
2157 mio_symbol_ref (gfc_symbol ** symp)
2161 p = mio_pointer_ref (symp);
2162 if (p->type == P_UNKNOWN)
2165 if (iomode == IO_OUTPUT)
2167 if (p->u.wsym.state == UNREFERENCED)
2168 p->u.wsym.state = NEEDS_WRITE;
2172 if (p->u.rsym.state == UNUSED)
2173 p->u.rsym.state = NEEDED;
2178 /* Save or restore a reference to a symtree node. */
2181 mio_symtree_ref (gfc_symtree ** stp)
2185 gfc_symtree * ns_st = NULL;
2187 if (iomode == IO_OUTPUT)
2189 /* If this is a symtree for a symbol that came from a contained module
2190 namespace, it has a unique name and we should look in the current
2191 namespace to see if the required, non-contained symbol is available
2192 yet. If so, the latter should be written. */
2193 if ((*stp)->n.sym && check_unique_name((*stp)->name))
2194 ns_st = gfc_find_symtree (gfc_current_ns->sym_root,
2195 (*stp)->n.sym->name);
2197 /* On the other hand, if the existing symbol is the module name or the
2198 new symbol is a dummy argument, do not do the promotion. */
2199 if (ns_st && ns_st->n.sym
2200 && ns_st->n.sym->attr.flavor != FL_MODULE
2201 && !(*stp)->n.sym->attr.dummy)
2202 mio_symbol_ref (&ns_st->n.sym);
2204 mio_symbol_ref (&(*stp)->n.sym);
2208 require_atom (ATOM_INTEGER);
2209 p = get_integer (atom_int);
2211 /* An unused equivalence member; bail out. */
2212 if (in_load_equiv && p->u.rsym.symtree == NULL)
2215 if (p->type == P_UNKNOWN)
2218 if (p->u.rsym.state == UNUSED)
2219 p->u.rsym.state = NEEDED;
2221 if (p->u.rsym.symtree != NULL)
2223 *stp = p->u.rsym.symtree;
2227 f = gfc_getmem (sizeof (fixup_t));
2229 f->next = p->u.rsym.stfixup;
2230 p->u.rsym.stfixup = f;
2232 f->pointer = (void **)stp;
2238 mio_iterator (gfc_iterator ** ip)
2244 if (iomode == IO_OUTPUT)
2251 if (peek_atom () == ATOM_RPAREN)
2257 *ip = gfc_get_iterator ();
2262 mio_expr (&iter->var);
2263 mio_expr (&iter->start);
2264 mio_expr (&iter->end);
2265 mio_expr (&iter->step);
2274 mio_constructor (gfc_constructor ** cp)
2276 gfc_constructor *c, *tail;
2280 if (iomode == IO_OUTPUT)
2282 for (c = *cp; c; c = c->next)
2285 mio_expr (&c->expr);
2286 mio_iterator (&c->iterator);
2296 while (peek_atom () != ATOM_RPAREN)
2298 c = gfc_get_constructor ();
2308 mio_expr (&c->expr);
2309 mio_iterator (&c->iterator);
2319 static const mstring ref_types[] = {
2320 minit ("ARRAY", REF_ARRAY),
2321 minit ("COMPONENT", REF_COMPONENT),
2322 minit ("SUBSTRING", REF_SUBSTRING),
2328 mio_ref (gfc_ref ** rp)
2335 r->type = MIO_NAME(ref_type) (r->type, ref_types);
2340 mio_array_ref (&r->u.ar);
2344 mio_symbol_ref (&r->u.c.sym);
2345 mio_component_ref (&r->u.c.component, r->u.c.sym);
2349 mio_expr (&r->u.ss.start);
2350 mio_expr (&r->u.ss.end);
2351 mio_charlen (&r->u.ss.length);
2360 mio_ref_list (gfc_ref ** rp)
2362 gfc_ref *ref, *head, *tail;
2366 if (iomode == IO_OUTPUT)
2368 for (ref = *rp; ref; ref = ref->next)
2375 while (peek_atom () != ATOM_RPAREN)
2378 head = tail = gfc_get_ref ();
2381 tail->next = gfc_get_ref ();
2395 /* Read and write an integer value. */
2398 mio_gmp_integer (mpz_t * integer)
2402 if (iomode == IO_INPUT)
2404 if (parse_atom () != ATOM_STRING)
2405 bad_module ("Expected integer string");
2407 mpz_init (*integer);
2408 if (mpz_set_str (*integer, atom_string, 10))
2409 bad_module ("Error converting integer");
2411 gfc_free (atom_string);
2416 p = mpz_get_str (NULL, 10, *integer);
2417 write_atom (ATOM_STRING, p);
2424 mio_gmp_real (mpfr_t * real)
2429 if (iomode == IO_INPUT)
2431 if (parse_atom () != ATOM_STRING)
2432 bad_module ("Expected real string");
2435 mpfr_set_str (*real, atom_string, 16, GFC_RND_MODE);
2436 gfc_free (atom_string);
2441 p = mpfr_get_str (NULL, &exponent, 16, 0, *real, GFC_RND_MODE);
2442 atom_string = gfc_getmem (strlen (p) + 20);
2444 sprintf (atom_string, "0.%s@%ld", p, exponent);
2446 /* Fix negative numbers. */
2447 if (atom_string[2] == '-')
2449 atom_string[0] = '-';
2450 atom_string[1] = '0';
2451 atom_string[2] = '.';
2454 write_atom (ATOM_STRING, atom_string);
2456 gfc_free (atom_string);
2462 /* Save and restore the shape of an array constructor. */
2465 mio_shape (mpz_t ** pshape, int rank)
2471 /* A NULL shape is represented by (). */
2474 if (iomode == IO_OUTPUT)
2486 if (t == ATOM_RPAREN)
2493 shape = gfc_get_shape (rank);
2497 for (n = 0; n < rank; n++)
2498 mio_gmp_integer (&shape[n]);
2504 static const mstring expr_types[] = {
2505 minit ("OP", EXPR_OP),
2506 minit ("FUNCTION", EXPR_FUNCTION),
2507 minit ("CONSTANT", EXPR_CONSTANT),
2508 minit ("VARIABLE", EXPR_VARIABLE),
2509 minit ("SUBSTRING", EXPR_SUBSTRING),
2510 minit ("STRUCTURE", EXPR_STRUCTURE),
2511 minit ("ARRAY", EXPR_ARRAY),
2512 minit ("NULL", EXPR_NULL),
2516 /* INTRINSIC_ASSIGN is missing because it is used as an index for
2517 generic operators, not in expressions. INTRINSIC_USER is also
2518 replaced by the correct function name by the time we see it. */
2520 static const mstring intrinsics[] =
2522 minit ("UPLUS", INTRINSIC_UPLUS),
2523 minit ("UMINUS", INTRINSIC_UMINUS),
2524 minit ("PLUS", INTRINSIC_PLUS),
2525 minit ("MINUS", INTRINSIC_MINUS),
2526 minit ("TIMES", INTRINSIC_TIMES),
2527 minit ("DIVIDE", INTRINSIC_DIVIDE),
2528 minit ("POWER", INTRINSIC_POWER),
2529 minit ("CONCAT", INTRINSIC_CONCAT),
2530 minit ("AND", INTRINSIC_AND),
2531 minit ("OR", INTRINSIC_OR),
2532 minit ("EQV", INTRINSIC_EQV),
2533 minit ("NEQV", INTRINSIC_NEQV),
2534 minit ("EQ", INTRINSIC_EQ),
2535 minit ("NE", INTRINSIC_NE),
2536 minit ("GT", INTRINSIC_GT),
2537 minit ("GE", INTRINSIC_GE),
2538 minit ("LT", INTRINSIC_LT),
2539 minit ("LE", INTRINSIC_LE),
2540 minit ("NOT", INTRINSIC_NOT),
2541 minit ("PARENTHESES", INTRINSIC_PARENTHESES),
2545 /* Read and write expressions. The form "()" is allowed to indicate a
2549 mio_expr (gfc_expr ** ep)
2557 if (iomode == IO_OUTPUT)
2566 MIO_NAME(expr_t) (e->expr_type, expr_types);
2572 if (t == ATOM_RPAREN)
2579 bad_module ("Expected expression type");
2581 e = *ep = gfc_get_expr ();
2582 e->where = gfc_current_locus;
2583 e->expr_type = (expr_t) find_enum (expr_types);
2586 mio_typespec (&e->ts);
2587 mio_integer (&e->rank);
2589 switch (e->expr_type)
2592 e->value.op.operator
2593 = MIO_NAME(gfc_intrinsic_op) (e->value.op.operator, intrinsics);
2595 switch (e->value.op.operator)
2597 case INTRINSIC_UPLUS:
2598 case INTRINSIC_UMINUS:
2600 case INTRINSIC_PARENTHESES:
2601 mio_expr (&e->value.op.op1);
2604 case INTRINSIC_PLUS:
2605 case INTRINSIC_MINUS:
2606 case INTRINSIC_TIMES:
2607 case INTRINSIC_DIVIDE:
2608 case INTRINSIC_POWER:
2609 case INTRINSIC_CONCAT:
2613 case INTRINSIC_NEQV:
2620 mio_expr (&e->value.op.op1);
2621 mio_expr (&e->value.op.op2);
2625 bad_module ("Bad operator");
2631 mio_symtree_ref (&e->symtree);
2632 mio_actual_arglist (&e->value.function.actual);
2634 if (iomode == IO_OUTPUT)
2636 e->value.function.name
2637 = mio_allocated_string (e->value.function.name);
2638 flag = e->value.function.esym != NULL;
2639 mio_integer (&flag);
2641 mio_symbol_ref (&e->value.function.esym);
2643 write_atom (ATOM_STRING, e->value.function.isym->name);
2648 require_atom (ATOM_STRING);
2649 e->value.function.name = gfc_get_string (atom_string);
2650 gfc_free (atom_string);
2652 mio_integer (&flag);
2654 mio_symbol_ref (&e->value.function.esym);
2657 require_atom (ATOM_STRING);
2658 e->value.function.isym = gfc_find_function (atom_string);
2659 gfc_free (atom_string);
2666 mio_symtree_ref (&e->symtree);
2667 mio_ref_list (&e->ref);
2670 case EXPR_SUBSTRING:
2671 e->value.character.string = (char *)
2672 mio_allocated_string (e->value.character.string);
2673 mio_ref_list (&e->ref);
2676 case EXPR_STRUCTURE:
2678 mio_constructor (&e->value.constructor);
2679 mio_shape (&e->shape, e->rank);
2686 mio_gmp_integer (&e->value.integer);
2690 gfc_set_model_kind (e->ts.kind);
2691 mio_gmp_real (&e->value.real);
2695 gfc_set_model_kind (e->ts.kind);
2696 mio_gmp_real (&e->value.complex.r);
2697 mio_gmp_real (&e->value.complex.i);
2701 mio_integer (&e->value.logical);
2705 mio_integer (&e->value.character.length);
2706 e->value.character.string = (char *)
2707 mio_allocated_string (e->value.character.string);
2711 bad_module ("Bad type in constant expression");
2724 /* Read and write namelists */
2727 mio_namelist (gfc_symbol * sym)
2729 gfc_namelist *n, *m;
2730 const char *check_name;
2734 if (iomode == IO_OUTPUT)
2736 for (n = sym->namelist; n; n = n->next)
2737 mio_symbol_ref (&n->sym);
2741 /* This departure from the standard is flagged as an error.
2742 It does, in fact, work correctly. TODO: Allow it
2744 if (sym->attr.flavor == FL_NAMELIST)
2746 check_name = find_use_name (sym->name);
2747 if (check_name && strcmp (check_name, sym->name) != 0)
2748 gfc_error("Namelist %s cannot be renamed by USE"
2749 " association to %s",
2750 sym->name, check_name);
2754 while (peek_atom () != ATOM_RPAREN)
2756 n = gfc_get_namelist ();
2757 mio_symbol_ref (&n->sym);
2759 if (sym->namelist == NULL)
2766 sym->namelist_tail = m;
2773 /* Save/restore lists of gfc_interface stuctures. When loading an
2774 interface, we are really appending to the existing list of
2775 interfaces. Checking for duplicate and ambiguous interfaces has to
2776 be done later when all symbols have been loaded. */
2779 mio_interface_rest (gfc_interface ** ip)
2781 gfc_interface *tail, *p;
2783 if (iomode == IO_OUTPUT)
2786 for (p = *ip; p; p = p->next)
2787 mio_symbol_ref (&p->sym);
2803 if (peek_atom () == ATOM_RPAREN)
2806 p = gfc_get_interface ();
2807 p->where = gfc_current_locus;
2808 mio_symbol_ref (&p->sym);
2823 /* Save/restore a nameless operator interface. */
2826 mio_interface (gfc_interface ** ip)
2830 mio_interface_rest (ip);
2834 /* Save/restore a named operator interface. */
2837 mio_symbol_interface (const char **name, const char **module,
2838 gfc_interface ** ip)
2843 mio_pool_string (name);
2844 mio_pool_string (module);
2846 mio_interface_rest (ip);
2851 mio_namespace_ref (gfc_namespace ** nsp)
2856 p = mio_pointer_ref (nsp);
2858 if (p->type == P_UNKNOWN)
2859 p->type = P_NAMESPACE;
2861 if (iomode == IO_INPUT && p->integer != 0)
2863 ns = (gfc_namespace *)p->u.pointer;
2866 ns = gfc_get_namespace (NULL, 0);
2867 associate_integer_pointer (p, ns);
2875 /* Unlike most other routines, the address of the symbol node is
2876 already fixed on input and the name/module has already been filled
2880 mio_symbol (gfc_symbol * sym)
2882 gfc_formal_arglist *formal;
2886 mio_symbol_attribute (&sym->attr);
2887 mio_typespec (&sym->ts);
2889 /* Contained procedures don't have formal namespaces. Instead we output the
2890 procedure namespace. The will contain the formal arguments. */
2891 if (iomode == IO_OUTPUT)
2893 formal = sym->formal;
2894 while (formal && !formal->sym)
2895 formal = formal->next;
2898 mio_namespace_ref (&formal->sym->ns);
2900 mio_namespace_ref (&sym->formal_ns);
2904 mio_namespace_ref (&sym->formal_ns);
2907 sym->formal_ns->proc_name = sym;
2912 /* Save/restore common block links */
2913 mio_symbol_ref (&sym->common_next);
2915 mio_formal_arglist (sym);
2917 if (sym->attr.flavor == FL_PARAMETER)
2918 mio_expr (&sym->value);
2920 mio_array_spec (&sym->as);
2922 mio_symbol_ref (&sym->result);
2924 if (sym->attr.cray_pointee)
2925 mio_symbol_ref (&sym->cp_pointer);
2927 /* Note that components are always saved, even if they are supposed
2928 to be private. Component access is checked during searching. */
2930 mio_component_list (&sym->components);
2932 if (sym->components != NULL)
2933 sym->component_access =
2934 MIO_NAME(gfc_access) (sym->component_access, access_types);
2941 /************************* Top level subroutines *************************/
2943 /* Skip a list between balanced left and right parens. */
2953 switch (parse_atom ())
2964 gfc_free (atom_string);
2976 /* Load operator interfaces from the module. Interfaces are unusual
2977 in that they attach themselves to existing symbols. */
2980 load_operator_interfaces (void)
2983 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
2988 while (peek_atom () != ATOM_RPAREN)
2992 mio_internal_string (name);
2993 mio_internal_string (module);
2995 /* Decide if we need to load this one or not. */
2996 p = find_use_name (name);
2999 while (parse_atom () != ATOM_RPAREN);
3003 uop = gfc_get_uop (p);
3004 mio_interface_rest (&uop->operator);
3012 /* Load interfaces from the module. Interfaces are unusual in that
3013 they attach themselves to existing symbols. */
3016 load_generic_interfaces (void)
3019 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
3024 while (peek_atom () != ATOM_RPAREN)
3028 mio_internal_string (name);
3029 mio_internal_string (module);
3031 /* Decide if we need to load this one or not. */
3032 p = find_use_name (name);
3034 if (p == NULL || gfc_find_symbol (p, NULL, 0, &sym))
3036 while (parse_atom () != ATOM_RPAREN);
3042 gfc_get_symbol (p, NULL, &sym);
3044 sym->attr.flavor = FL_PROCEDURE;
3045 sym->attr.generic = 1;
3046 sym->attr.use_assoc = 1;
3049 mio_interface_rest (&sym->generic);
3056 /* Load common blocks. */
3061 char name[GFC_MAX_SYMBOL_LEN+1];
3066 while (peek_atom () != ATOM_RPAREN)
3070 mio_internal_string (name);
3072 p = gfc_get_common (name, 1);
3074 mio_symbol_ref (&p->head);
3075 mio_integer (&flags);
3079 p->threadprivate = 1;
3088 /* load_equiv()-- Load equivalences. The flag in_load_equiv informs
3089 mio_expr_ref of this so that unused variables are not loaded and
3090 so that the expression can be safely freed.*/
3095 gfc_equiv *head, *tail, *end, *eq;
3099 in_load_equiv = true;
3101 end = gfc_current_ns->equiv;
3102 while(end != NULL && end->next != NULL)
3105 while(peek_atom() != ATOM_RPAREN) {
3109 while(peek_atom() != ATOM_RPAREN)
3112 head = tail = gfc_get_equiv();
3115 tail->eq = gfc_get_equiv();
3119 mio_pool_string(&tail->module);
3120 mio_expr(&tail->expr);
3123 /* Unused variables have no symtree. */
3125 for (eq = head; eq; eq = eq->eq)
3127 if (!eq->expr->symtree)
3136 for (eq = head; eq; eq = head)
3139 gfc_free_expr (eq->expr);
3145 gfc_current_ns->equiv = head;
3156 in_load_equiv = false;
3159 /* Recursive function to traverse the pointer_info tree and load a
3160 needed symbol. We return nonzero if we load a symbol and stop the
3161 traversal, because the act of loading can alter the tree. */
3164 load_needed (pointer_info * p)
3175 rv |= load_needed (p->left);
3176 rv |= load_needed (p->right);
3178 if (p->type != P_SYMBOL || p->u.rsym.state != NEEDED)
3181 p->u.rsym.state = USED;
3183 set_module_locus (&p->u.rsym.where);
3185 sym = p->u.rsym.sym;
3188 q = get_integer (p->u.rsym.ns);
3190 ns = (gfc_namespace *) q->u.pointer;
3193 /* Create an interface namespace if necessary. These are
3194 the namespaces that hold the formal parameters of module
3197 ns = gfc_get_namespace (NULL, 0);
3198 associate_integer_pointer (q, ns);
3201 sym = gfc_new_symbol (p->u.rsym.true_name, ns);
3202 sym->module = gfc_get_string (p->u.rsym.module);
3204 associate_integer_pointer (p, sym);
3208 sym->attr.use_assoc = 1;
3214 /* Recursive function for cleaning up things after a module has been
3218 read_cleanup (pointer_info * p)
3226 read_cleanup (p->left);
3227 read_cleanup (p->right);
3229 if (p->type == P_SYMBOL && p->u.rsym.state == USED && !p->u.rsym.referenced)
3231 /* Add hidden symbols to the symtree. */
3232 q = get_integer (p->u.rsym.ns);
3233 st = get_unique_symtree ((gfc_namespace *) q->u.pointer);
3235 st->n.sym = p->u.rsym.sym;
3238 /* Fixup any symtree references. */
3239 p->u.rsym.symtree = st;
3240 resolve_fixups (p->u.rsym.stfixup, st);
3241 p->u.rsym.stfixup = NULL;
3244 /* Free unused symbols. */
3245 if (p->type == P_SYMBOL && p->u.rsym.state == UNUSED)
3246 gfc_free_symbol (p->u.rsym.sym);
3250 /* Read a module file. */
3255 module_locus operator_interfaces, user_operators;
3257 char name[GFC_MAX_SYMBOL_LEN + 1];
3259 int ambiguous, j, nuse, symbol;
3265 get_module_locus (&operator_interfaces); /* Skip these for now */
3268 get_module_locus (&user_operators);
3272 /* Skip commons and equivalences for now. */
3278 /* Create the fixup nodes for all the symbols. */
3280 while (peek_atom () != ATOM_RPAREN)
3282 require_atom (ATOM_INTEGER);
3283 info = get_integer (atom_int);
3285 info->type = P_SYMBOL;
3286 info->u.rsym.state = UNUSED;
3288 mio_internal_string (info->u.rsym.true_name);
3289 mio_internal_string (info->u.rsym.module);
3291 require_atom (ATOM_INTEGER);
3292 info->u.rsym.ns = atom_int;
3294 get_module_locus (&info->u.rsym.where);
3297 /* See if the symbol has already been loaded by a previous module.
3298 If so, we reference the existing symbol and prevent it from
3299 being loaded again. This should not happen if the symbol being
3300 read is an index for an assumed shape dummy array (ns != 1). */
3302 sym = find_true_name (info->u.rsym.true_name, info->u.rsym.module);
3305 || (sym->attr.flavor == FL_VARIABLE
3306 && info->u.rsym.ns !=1))
3309 info->u.rsym.state = USED;
3310 info->u.rsym.referenced = 1;
3311 info->u.rsym.sym = sym;
3316 /* Parse the symtree lists. This lets us mark which symbols need to
3317 be loaded. Renaming is also done at this point by replacing the
3322 while (peek_atom () != ATOM_RPAREN)
3324 mio_internal_string (name);
3325 mio_integer (&ambiguous);
3326 mio_integer (&symbol);
3328 info = get_integer (symbol);
3330 /* See how many use names there are. If none, go through the start
3331 of the loop at least once. */
3332 nuse = number_use_names (name);
3336 for (j = 1; j <= nuse; j++)
3338 /* Get the jth local name for this symbol. */
3339 p = find_use_name_n (name, &j);
3341 /* Skip symtree nodes not in an ONLY clause. */
3345 /* Check for ambiguous symbols. */
3346 st = gfc_find_symtree (gfc_current_ns->sym_root, p);
3350 if (st->n.sym != info->u.rsym.sym)
3352 info->u.rsym.symtree = st;
3356 /* Create a symtree node in the current namespace for this symbol. */
3357 st = check_unique_name (p) ? get_unique_symtree (gfc_current_ns) :
3358 gfc_new_symtree (&gfc_current_ns->sym_root, p);
3360 st->ambiguous = ambiguous;
3362 sym = info->u.rsym.sym;
3364 /* Create a symbol node if it doesn't already exist. */
3367 sym = info->u.rsym.sym =
3368 gfc_new_symbol (info->u.rsym.true_name,
3371 sym->module = gfc_get_string (info->u.rsym.module);
3377 /* Store the symtree pointing to this symbol. */
3378 info->u.rsym.symtree = st;
3380 if (info->u.rsym.state == UNUSED)
3381 info->u.rsym.state = NEEDED;
3382 info->u.rsym.referenced = 1;
3389 /* Load intrinsic operator interfaces. */
3390 set_module_locus (&operator_interfaces);
3393 for (i = GFC_INTRINSIC_BEGIN; i != GFC_INTRINSIC_END; i++)
3395 if (i == INTRINSIC_USER)
3400 u = find_use_operator (i);
3411 mio_interface (&gfc_current_ns->operator[i]);
3416 /* Load generic and user operator interfaces. These must follow the
3417 loading of symtree because otherwise symbols can be marked as
3420 set_module_locus (&user_operators);
3422 load_operator_interfaces ();
3423 load_generic_interfaces ();
3428 /* At this point, we read those symbols that are needed but haven't
3429 been loaded yet. If one symbol requires another, the other gets
3430 marked as NEEDED if its previous state was UNUSED. */
3432 while (load_needed (pi_root));
3434 /* Make sure all elements of the rename-list were found in the
3437 for (u = gfc_rename_list; u; u = u->next)
3442 if (u->operator == INTRINSIC_NONE)
3444 gfc_error ("Symbol '%s' referenced at %L not found in module '%s'",
3445 u->use_name, &u->where, module_name);
3449 if (u->operator == INTRINSIC_USER)
3452 ("User operator '%s' referenced at %L not found in module '%s'",
3453 u->use_name, &u->where, module_name);
3458 ("Intrinsic operator '%s' referenced at %L not found in module "
3459 "'%s'", gfc_op2string (u->operator), &u->where, module_name);
3462 gfc_check_interfaces (gfc_current_ns);
3464 /* Clean up symbol nodes that were never loaded, create references
3465 to hidden symbols. */
3467 read_cleanup (pi_root);
3471 /* Given an access type that is specific to an entity and the default
3472 access, return nonzero if the entity is publicly accessible. If the
3473 element is declared as PUBLIC, then it is public; if declared
3474 PRIVATE, then private, and otherwise it is public unless the default
3475 access in this context has been declared PRIVATE. */
3478 gfc_check_access (gfc_access specific_access, gfc_access default_access)
3481 if (specific_access == ACCESS_PUBLIC)
3483 if (specific_access == ACCESS_PRIVATE)
3486 return default_access != ACCESS_PRIVATE;
3490 /* Write a common block to the module */
3493 write_common (gfc_symtree *st)
3502 write_common(st->left);
3503 write_common(st->right);
3507 /* Write the unmangled name. */
3508 name = st->n.common->name;
3510 mio_pool_string(&name);
3513 mio_symbol_ref(&p->head);
3514 flags = p->saved ? 1 : 0;
3515 if (p->threadprivate) flags |= 2;
3516 mio_integer(&flags);
3521 /* Write the blank common block to the module */
3524 write_blank_common (void)
3526 const char * name = BLANK_COMMON_NAME;
3529 if (gfc_current_ns->blank_common.head == NULL)
3534 mio_pool_string(&name);
3536 mio_symbol_ref(&gfc_current_ns->blank_common.head);
3537 saved = gfc_current_ns->blank_common.saved;
3538 mio_integer(&saved);
3543 /* Write equivalences to the module. */
3552 for(eq=gfc_current_ns->equiv; eq; eq=eq->next)
3556 for(e=eq; e; e=e->eq)
3558 if (e->module == NULL)
3559 e->module = gfc_get_string("%s.eq.%d", module_name, num);
3560 mio_allocated_string(e->module);
3569 /* Write a symbol to the module. */
3572 write_symbol (int n, gfc_symbol * sym)
3575 if (sym->attr.flavor == FL_UNKNOWN || sym->attr.flavor == FL_LABEL)
3576 gfc_internal_error ("write_symbol(): bad module symbol '%s'", sym->name);
3579 mio_pool_string (&sym->name);
3581 mio_pool_string (&sym->module);
3582 mio_pointer_ref (&sym->ns);
3589 /* Recursive traversal function to write the initial set of symbols to
3590 the module. We check to see if the symbol should be written
3591 according to the access specification. */
3594 write_symbol0 (gfc_symtree * st)
3602 write_symbol0 (st->left);
3603 write_symbol0 (st->right);
3606 if (sym->module == NULL)
3607 sym->module = gfc_get_string (module_name);
3609 if (sym->attr.flavor == FL_PROCEDURE && sym->attr.generic
3610 && !sym->attr.subroutine && !sym->attr.function)
3613 if (!gfc_check_access (sym->attr.access, sym->ns->default_access))
3616 p = get_pointer (sym);
3617 if (p->type == P_UNKNOWN)
3620 if (p->u.wsym.state == WRITTEN)
3623 write_symbol (p->integer, sym);
3624 p->u.wsym.state = WRITTEN;
3630 /* Recursive traversal function to write the secondary set of symbols
3631 to the module file. These are symbols that were not public yet are
3632 needed by the public symbols or another dependent symbol. The act
3633 of writing a symbol can modify the pointer_info tree, so we cease
3634 traversal if we find a symbol to write. We return nonzero if a
3635 symbol was written and pass that information upwards. */
3638 write_symbol1 (pointer_info * p)
3644 if (write_symbol1 (p->left))
3646 if (write_symbol1 (p->right))
3649 if (p->type != P_SYMBOL || p->u.wsym.state != NEEDS_WRITE)
3652 p->u.wsym.state = WRITTEN;
3653 write_symbol (p->integer, p->u.wsym.sym);
3659 /* Write operator interfaces associated with a symbol. */
3662 write_operator (gfc_user_op * uop)
3664 static char nullstring[] = "";
3665 const char *p = nullstring;
3667 if (uop->operator == NULL
3668 || !gfc_check_access (uop->access, uop->ns->default_access))
3671 mio_symbol_interface (&uop->name, &p, &uop->operator);
3675 /* Write generic interfaces associated with a symbol. */
3678 write_generic (gfc_symbol * sym)
3681 if (sym->generic == NULL
3682 || !gfc_check_access (sym->attr.access, sym->ns->default_access))
3685 mio_symbol_interface (&sym->name, &sym->module, &sym->generic);
3690 write_symtree (gfc_symtree * st)
3696 if (!gfc_check_access (sym->attr.access, sym->ns->default_access)
3697 || (sym->attr.flavor == FL_PROCEDURE && sym->attr.generic
3698 && !sym->attr.subroutine && !sym->attr.function))
3701 if (check_unique_name (st->name))
3704 p = find_pointer (sym);
3706 gfc_internal_error ("write_symtree(): Symbol not written");
3708 mio_pool_string (&st->name);
3709 mio_integer (&st->ambiguous);
3710 mio_integer (&p->integer);
3719 /* Write the operator interfaces. */
3722 for (i = GFC_INTRINSIC_BEGIN; i != GFC_INTRINSIC_END; i++)
3724 if (i == INTRINSIC_USER)
3727 mio_interface (gfc_check_access (gfc_current_ns->operator_access[i],
3728 gfc_current_ns->default_access)
3729 ? &gfc_current_ns->operator[i] : NULL);
3737 gfc_traverse_user_op (gfc_current_ns, write_operator);
3743 gfc_traverse_ns (gfc_current_ns, write_generic);
3749 write_blank_common ();
3750 write_common (gfc_current_ns->common_root);
3758 write_char('\n'); write_char('\n');
3760 /* Write symbol information. First we traverse all symbols in the
3761 primary namespace, writing those that need to be written.
3762 Sometimes writing one symbol will cause another to need to be
3763 written. A list of these symbols ends up on the write stack, and
3764 we end by popping the bottom of the stack and writing the symbol
3765 until the stack is empty. */
3769 write_symbol0 (gfc_current_ns->sym_root);
3770 while (write_symbol1 (pi_root));
3778 gfc_traverse_symtree (gfc_current_ns->sym_root, write_symtree);
3783 /* Given module, dump it to disk. If there was an error while
3784 processing the module, dump_flag will be set to zero and we delete
3785 the module file, even if it was already there. */
3788 gfc_dump_module (const char *name, int dump_flag)
3794 n = strlen (name) + strlen (MODULE_EXTENSION) + 1;
3795 if (gfc_option.module_dir != NULL)
3797 filename = (char *) alloca (n + strlen (gfc_option.module_dir));
3798 strcpy (filename, gfc_option.module_dir);
3799 strcat (filename, name);
3803 filename = (char *) alloca (n);
3804 strcpy (filename, name);
3806 strcat (filename, MODULE_EXTENSION);
3814 module_fp = fopen (filename, "w");
3815 if (module_fp == NULL)
3816 gfc_fatal_error ("Can't open module file '%s' for writing at %C: %s",
3817 filename, strerror (errno));
3822 *strchr (p, '\n') = '\0';
3824 fprintf (module_fp, "GFORTRAN module created from %s on %s\n",
3825 gfc_source_file, p);
3826 fputs ("If you edit this, you'll get what you deserve.\n\n", module_fp);
3829 strcpy (module_name, name);
3835 free_pi_tree (pi_root);
3840 if (fclose (module_fp))
3841 gfc_fatal_error ("Error writing module file '%s' for writing: %s",
3842 filename, strerror (errno));
3846 /* Process a USE directive. */
3849 gfc_use_module (void)
3855 filename = (char *) alloca(strlen(module_name) + strlen(MODULE_EXTENSION)
3857 strcpy (filename, module_name);
3858 strcat (filename, MODULE_EXTENSION);
3860 /* First, try to find an non-intrinsic module, unless the USE statement
3861 specified that the module is intrinsic. */
3864 module_fp = gfc_open_included_file (filename, true, true);
3866 /* Then, see if it's an intrinsic one, unless the USE statement
3867 specified that the module is non-intrinsic. */
3868 if (module_fp == NULL && !specified_nonint)
3871 if (strcmp (module_name, "iso_fortran_env") == 0
3872 && gfc_notify_std (GFC_STD_F2003, "Fortran 2003: "
3873 "ISO_FORTRAN_ENV intrinsic module at %C") != FAILURE)
3875 use_iso_fortran_env_module ();
3880 module_fp = gfc_open_intrinsic_module (filename);
3882 if (module_fp == NULL && specified_int)
3883 gfc_fatal_error ("Can't find an intrinsic module named '%s' at %C",
3887 if (module_fp == NULL)
3888 gfc_fatal_error ("Can't open module file '%s' for reading at %C: %s",
3889 filename, strerror (errno));
3896 /* Skip the first two lines of the module, after checking that this is
3897 a gfortran module file. */
3903 bad_module ("Unexpected end of module");
3906 if ((start == 1 && strcmp (atom_name, "GFORTRAN") != 0)
3907 || (start == 2 && strcmp (atom_name, " module") != 0))
3908 gfc_fatal_error ("File '%s' opened at %C is not a GFORTRAN module "
3915 /* Make sure we're not reading the same module that we may be building. */
3916 for (p = gfc_state_stack; p; p = p->previous)
3917 if (p->state == COMP_MODULE && strcmp (p->sym->name, module_name) == 0)
3918 gfc_fatal_error ("Can't USE the same module we're building!");
3921 init_true_name_tree ();
3925 free_true_name (true_name_root);
3926 true_name_root = NULL;
3928 free_pi_tree (pi_root);
3936 gfc_module_init_2 (void)
3939 last_atom = ATOM_LPAREN;
3944 gfc_module_done_2 (void)