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, 2007, 2008, 2009
4 Free 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 3, 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 COPYING3. If not see
21 <http://www.gnu.org/licenses/>. */
23 /* The syntax of gfortran modules resembles that of lisp lists, i.e. a
24 sequence of atoms, which can be left or right parenthesis, names,
25 integers or strings. Parenthesis are always matched which allows
26 us to skip over sections at high speed without having to know
27 anything about the internal structure of the lists. A "name" is
28 usually a fortran 95 identifier, but can also start with '@' in
29 order to reference a hidden symbol.
31 The first line of a module is an informational message about what
32 created the module, the file it came from and when it was created.
33 The second line is a warning for people not to edit the module.
34 The rest of the module looks like:
36 ( ( <Interface info for UPLUS> )
37 ( <Interface info for UMINUS> )
40 ( ( <name of operator interface> <module of op interface> <i/f1> ... )
43 ( ( <name of generic interface> <module of generic interface> <i/f1> ... )
46 ( ( <common name> <symbol> <saved flag>)
52 ( <Symbol Number (in no particular order)>
54 <Module name of symbol>
55 ( <symbol information> )
64 In general, symbols refer to other symbols by their symbol number,
65 which are zero based. Symbols are written to the module in no
73 #include "parse.h" /* FIXME */
76 #define MODULE_EXTENSION ".mod"
78 /* Don't put any single quote (') in MOD_VERSION,
79 if yout want it to be recognized. */
80 #define MOD_VERSION "0"
83 /* Structure that describes a position within a module file. */
92 /* Structure for list of symbols of intrinsic modules. */
105 P_UNKNOWN = 0, P_OTHER, P_NAMESPACE, P_COMPONENT, P_SYMBOL
109 /* The fixup structure lists pointers to pointers that have to
110 be updated when a pointer value becomes known. */
112 typedef struct fixup_t
115 struct fixup_t *next;
120 /* Structure for holding extra info needed for pointers being read. */
122 typedef struct pointer_info
124 BBT_HEADER (pointer_info);
128 /* The first component of each member of the union is the pointer
135 void *pointer; /* Member for doing pointer searches. */
140 char true_name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
142 { UNUSED, NEEDED, USED }
144 int ns, referenced, renamed;
147 gfc_symtree *symtree;
148 char binding_label[GFC_MAX_SYMBOL_LEN + 1];
156 { UNREFERENCED = 0, NEEDS_WRITE, WRITTEN }
166 #define gfc_get_pointer_info() XCNEW (pointer_info)
169 /* Local variables */
171 /* The FILE for the module we're reading or writing. */
172 static FILE *module_fp;
174 /* MD5 context structure. */
175 static struct md5_ctx ctx;
177 /* The name of the module we're reading (USE'ing) or writing. */
178 static char module_name[GFC_MAX_SYMBOL_LEN + 1];
180 /* The way the module we're reading was specified. */
181 static bool specified_nonint, specified_int;
183 static int module_line, module_column, only_flag;
185 { IO_INPUT, IO_OUTPUT }
188 static gfc_use_rename *gfc_rename_list;
189 static pointer_info *pi_root;
190 static int symbol_number; /* Counter for assigning symbol numbers */
192 /* Tells mio_expr_ref to make symbols for unused equivalence members. */
193 static bool in_load_equiv;
195 static locus use_locus;
199 /*****************************************************************/
201 /* Pointer/integer conversion. Pointers between structures are stored
202 as integers in the module file. The next couple of subroutines
203 handle this translation for reading and writing. */
205 /* Recursively free the tree of pointer structures. */
208 free_pi_tree (pointer_info *p)
213 if (p->fixup != NULL)
214 gfc_internal_error ("free_pi_tree(): Unresolved fixup");
216 free_pi_tree (p->left);
217 free_pi_tree (p->right);
223 /* Compare pointers when searching by pointer. Used when writing a
227 compare_pointers (void *_sn1, void *_sn2)
229 pointer_info *sn1, *sn2;
231 sn1 = (pointer_info *) _sn1;
232 sn2 = (pointer_info *) _sn2;
234 if (sn1->u.pointer < sn2->u.pointer)
236 if (sn1->u.pointer > sn2->u.pointer)
243 /* Compare integers when searching by integer. Used when reading a
247 compare_integers (void *_sn1, void *_sn2)
249 pointer_info *sn1, *sn2;
251 sn1 = (pointer_info *) _sn1;
252 sn2 = (pointer_info *) _sn2;
254 if (sn1->integer < sn2->integer)
256 if (sn1->integer > sn2->integer)
263 /* Initialize the pointer_info tree. */
272 compare = (iomode == IO_INPUT) ? compare_integers : compare_pointers;
274 /* Pointer 0 is the NULL pointer. */
275 p = gfc_get_pointer_info ();
280 gfc_insert_bbt (&pi_root, p, compare);
282 /* Pointer 1 is the current namespace. */
283 p = gfc_get_pointer_info ();
284 p->u.pointer = gfc_current_ns;
286 p->type = P_NAMESPACE;
288 gfc_insert_bbt (&pi_root, p, compare);
294 /* During module writing, call here with a pointer to something,
295 returning the pointer_info node. */
297 static pointer_info *
298 find_pointer (void *gp)
305 if (p->u.pointer == gp)
307 p = (gp < p->u.pointer) ? p->left : p->right;
314 /* Given a pointer while writing, returns the pointer_info tree node,
315 creating it if it doesn't exist. */
317 static pointer_info *
318 get_pointer (void *gp)
322 p = find_pointer (gp);
326 /* Pointer doesn't have an integer. Give it one. */
327 p = gfc_get_pointer_info ();
330 p->integer = symbol_number++;
332 gfc_insert_bbt (&pi_root, p, compare_pointers);
338 /* Given an integer during reading, find it in the pointer_info tree,
339 creating the node if not found. */
341 static pointer_info *
342 get_integer (int integer)
352 c = compare_integers (&t, p);
356 p = (c < 0) ? p->left : p->right;
362 p = gfc_get_pointer_info ();
363 p->integer = integer;
366 gfc_insert_bbt (&pi_root, p, compare_integers);
372 /* Recursive function to find a pointer within a tree by brute force. */
374 static pointer_info *
375 fp2 (pointer_info *p, const void *target)
382 if (p->u.pointer == target)
385 q = fp2 (p->left, target);
389 return fp2 (p->right, target);
393 /* During reading, find a pointer_info node from the pointer value.
394 This amounts to a brute-force search. */
396 static pointer_info *
397 find_pointer2 (void *p)
399 return fp2 (pi_root, p);
403 /* Resolve any fixups using a known pointer. */
406 resolve_fixups (fixup_t *f, void *gp)
419 /* Call here during module reading when we know what pointer to
420 associate with an integer. Any fixups that exist are resolved at
424 associate_integer_pointer (pointer_info *p, void *gp)
426 if (p->u.pointer != NULL)
427 gfc_internal_error ("associate_integer_pointer(): Already associated");
431 resolve_fixups (p->fixup, gp);
437 /* During module reading, given an integer and a pointer to a pointer,
438 either store the pointer from an already-known value or create a
439 fixup structure in order to store things later. Returns zero if
440 the reference has been actually stored, or nonzero if the reference
441 must be fixed later (i.e., associate_integer_pointer must be called
442 sometime later. Returns the pointer_info structure. */
444 static pointer_info *
445 add_fixup (int integer, void *gp)
451 p = get_integer (integer);
453 if (p->integer == 0 || p->u.pointer != NULL)
456 *cp = (char *) p->u.pointer;
465 f->pointer = (void **) gp;
472 /*****************************************************************/
474 /* Parser related subroutines */
476 /* Free the rename list left behind by a USE statement. */
481 gfc_use_rename *next;
483 for (; gfc_rename_list; gfc_rename_list = next)
485 next = gfc_rename_list->next;
486 gfc_free (gfc_rename_list);
491 /* Match a USE statement. */
496 char name[GFC_MAX_SYMBOL_LEN + 1], module_nature[GFC_MAX_SYMBOL_LEN + 1];
497 gfc_use_rename *tail = NULL, *new_use;
498 interface_type type, type2;
502 specified_int = false;
503 specified_nonint = false;
505 if (gfc_match (" , ") == MATCH_YES)
507 if ((m = gfc_match (" %n ::", module_nature)) == MATCH_YES)
509 if (gfc_notify_std (GFC_STD_F2003, "Fortran 2003: module "
510 "nature in USE statement at %C") == FAILURE)
513 if (strcmp (module_nature, "intrinsic") == 0)
514 specified_int = true;
517 if (strcmp (module_nature, "non_intrinsic") == 0)
518 specified_nonint = true;
521 gfc_error ("Module nature in USE statement at %C shall "
522 "be either INTRINSIC or NON_INTRINSIC");
529 /* Help output a better error message than "Unclassifiable
531 gfc_match (" %n", module_nature);
532 if (strcmp (module_nature, "intrinsic") == 0
533 || strcmp (module_nature, "non_intrinsic") == 0)
534 gfc_error ("\"::\" was expected after module nature at %C "
535 "but was not found");
541 m = gfc_match (" ::");
542 if (m == MATCH_YES &&
543 gfc_notify_std (GFC_STD_F2003, "Fortran 2003: "
544 "\"USE :: module\" at %C") == FAILURE)
549 m = gfc_match ("% ");
555 use_locus = gfc_current_locus;
557 m = gfc_match_name (module_name);
564 if (gfc_match_eos () == MATCH_YES)
566 if (gfc_match_char (',') != MATCH_YES)
569 if (gfc_match (" only :") == MATCH_YES)
572 if (gfc_match_eos () == MATCH_YES)
577 /* Get a new rename struct and add it to the rename list. */
578 new_use = gfc_get_use_rename ();
579 new_use->where = gfc_current_locus;
582 if (gfc_rename_list == NULL)
583 gfc_rename_list = new_use;
585 tail->next = new_use;
588 /* See what kind of interface we're dealing with. Assume it is
590 new_use->op = INTRINSIC_NONE;
591 if (gfc_match_generic_spec (&type, name, &op) == MATCH_ERROR)
596 case INTERFACE_NAMELESS:
597 gfc_error ("Missing generic specification in USE statement at %C");
600 case INTERFACE_USER_OP:
601 case INTERFACE_GENERIC:
602 m = gfc_match (" =>");
604 if (type == INTERFACE_USER_OP && m == MATCH_YES
605 && (gfc_notify_std (GFC_STD_F2003, "Fortran 2003: Renaming "
606 "operators in USE statements at %C")
610 if (type == INTERFACE_USER_OP)
611 new_use->op = INTRINSIC_USER;
616 strcpy (new_use->use_name, name);
619 strcpy (new_use->local_name, name);
620 m = gfc_match_generic_spec (&type2, new_use->use_name, &op);
625 if (m == MATCH_ERROR)
633 strcpy (new_use->local_name, name);
635 m = gfc_match_generic_spec (&type2, new_use->use_name, &op);
640 if (m == MATCH_ERROR)
644 if (strcmp (new_use->use_name, module_name) == 0
645 || strcmp (new_use->local_name, module_name) == 0)
647 gfc_error ("The name '%s' at %C has already been used as "
648 "an external module name.", module_name);
653 case INTERFACE_INTRINSIC_OP:
661 if (gfc_match_eos () == MATCH_YES)
663 if (gfc_match_char (',') != MATCH_YES)
670 gfc_syntax_error (ST_USE);
678 /* Given a name and a number, inst, return the inst name
679 under which to load this symbol. Returns NULL if this
680 symbol shouldn't be loaded. If inst is zero, returns
681 the number of instances of this name. If interface is
682 true, a user-defined operator is sought, otherwise only
683 non-operators are sought. */
686 find_use_name_n (const char *name, int *inst, bool interface)
692 for (u = gfc_rename_list; u; u = u->next)
694 if (strcmp (u->use_name, name) != 0
695 || (u->op == INTRINSIC_USER && !interface)
696 || (u->op != INTRINSIC_USER && interface))
709 return only_flag ? NULL : name;
713 return (u->local_name[0] != '\0') ? u->local_name : name;
717 /* Given a name, return the name under which to load this symbol.
718 Returns NULL if this symbol shouldn't be loaded. */
721 find_use_name (const char *name, bool interface)
724 return find_use_name_n (name, &i, interface);
728 /* Given a real name, return the number of use names associated with it. */
731 number_use_names (const char *name, bool interface)
735 c = find_use_name_n (name, &i, interface);
740 /* Try to find the operator in the current list. */
742 static gfc_use_rename *
743 find_use_operator (gfc_intrinsic_op op)
747 for (u = gfc_rename_list; u; u = u->next)
755 /*****************************************************************/
757 /* The next couple of subroutines maintain a tree used to avoid a
758 brute-force search for a combination of true name and module name.
759 While symtree names, the name that a particular symbol is known by
760 can changed with USE statements, we still have to keep track of the
761 true names to generate the correct reference, and also avoid
762 loading the same real symbol twice in a program unit.
764 When we start reading, the true name tree is built and maintained
765 as symbols are read. The tree is searched as we load new symbols
766 to see if it already exists someplace in the namespace. */
768 typedef struct true_name
770 BBT_HEADER (true_name);
775 static true_name *true_name_root;
778 /* Compare two true_name structures. */
781 compare_true_names (void *_t1, void *_t2)
786 t1 = (true_name *) _t1;
787 t2 = (true_name *) _t2;
789 c = ((t1->sym->module > t2->sym->module)
790 - (t1->sym->module < t2->sym->module));
794 return strcmp (t1->sym->name, t2->sym->name);
798 /* Given a true name, search the true name tree to see if it exists
799 within the main namespace. */
802 find_true_name (const char *name, const char *module)
808 sym.name = gfc_get_string (name);
810 sym.module = gfc_get_string (module);
818 c = compare_true_names ((void *) (&t), (void *) p);
822 p = (c < 0) ? p->left : p->right;
829 /* Given a gfc_symbol pointer that is not in the true name tree, add it. */
832 add_true_name (gfc_symbol *sym)
836 t = XCNEW (true_name);
839 gfc_insert_bbt (&true_name_root, t, compare_true_names);
843 /* Recursive function to build the initial true name tree by
844 recursively traversing the current namespace. */
847 build_tnt (gfc_symtree *st)
852 build_tnt (st->left);
853 build_tnt (st->right);
855 if (find_true_name (st->n.sym->name, st->n.sym->module) != NULL)
858 add_true_name (st->n.sym);
862 /* Initialize the true name tree with the current namespace. */
865 init_true_name_tree (void)
867 true_name_root = NULL;
868 build_tnt (gfc_current_ns->sym_root);
872 /* Recursively free a true name tree node. */
875 free_true_name (true_name *t)
879 free_true_name (t->left);
880 free_true_name (t->right);
886 /*****************************************************************/
888 /* Module reading and writing. */
892 ATOM_NAME, ATOM_LPAREN, ATOM_RPAREN, ATOM_INTEGER, ATOM_STRING
896 static atom_type last_atom;
899 /* The name buffer must be at least as long as a symbol name. Right
900 now it's not clear how we're going to store numeric constants--
901 probably as a hexadecimal string, since this will allow the exact
902 number to be preserved (this can't be done by a decimal
903 representation). Worry about that later. TODO! */
905 #define MAX_ATOM_SIZE 100
908 static char *atom_string, atom_name[MAX_ATOM_SIZE];
911 /* Report problems with a module. Error reporting is not very
912 elaborate, since this sorts of errors shouldn't really happen.
913 This subroutine never returns. */
915 static void bad_module (const char *) ATTRIBUTE_NORETURN;
918 bad_module (const char *msgid)
925 gfc_fatal_error ("Reading module %s at line %d column %d: %s",
926 module_name, module_line, module_column, msgid);
929 gfc_fatal_error ("Writing module %s at line %d column %d: %s",
930 module_name, module_line, module_column, msgid);
933 gfc_fatal_error ("Module %s at line %d column %d: %s",
934 module_name, module_line, module_column, msgid);
940 /* Set the module's input pointer. */
943 set_module_locus (module_locus *m)
945 module_column = m->column;
946 module_line = m->line;
947 fsetpos (module_fp, &m->pos);
951 /* Get the module's input pointer so that we can restore it later. */
954 get_module_locus (module_locus *m)
956 m->column = module_column;
957 m->line = module_line;
958 fgetpos (module_fp, &m->pos);
962 /* Get the next character in the module, updating our reckoning of
970 c = getc (module_fp);
973 bad_module ("Unexpected EOF");
986 /* Parse a string constant. The delimiter is guaranteed to be a
996 get_module_locus (&start);
1000 /* See how long the string is. */
1005 bad_module ("Unexpected end of module in string constant");
1023 set_module_locus (&start);
1025 atom_string = p = XCNEWVEC (char, len + 1);
1027 for (; len > 0; len--)
1031 module_char (); /* Guaranteed to be another \'. */
1035 module_char (); /* Terminating \'. */
1036 *p = '\0'; /* C-style string for debug purposes. */
1040 /* Parse a small integer. */
1043 parse_integer (int c)
1051 get_module_locus (&m);
1057 atom_int = 10 * atom_int + c - '0';
1058 if (atom_int > 99999999)
1059 bad_module ("Integer overflow");
1062 set_module_locus (&m);
1080 get_module_locus (&m);
1085 if (!ISALNUM (c) && c != '_' && c != '-')
1089 if (++len > GFC_MAX_SYMBOL_LEN)
1090 bad_module ("Name too long");
1095 fseek (module_fp, -1, SEEK_CUR);
1096 module_column = m.column + len - 1;
1103 /* Read the next atom in the module's input stream. */
1114 while (c == ' ' || c == '\r' || c == '\n');
1139 return ATOM_INTEGER;
1197 bad_module ("Bad name");
1204 /* Peek at the next atom on the input. */
1212 get_module_locus (&m);
1215 if (a == ATOM_STRING)
1216 gfc_free (atom_string);
1218 set_module_locus (&m);
1223 /* Read the next atom from the input, requiring that it be a
1227 require_atom (atom_type type)
1233 get_module_locus (&m);
1241 p = _("Expected name");
1244 p = _("Expected left parenthesis");
1247 p = _("Expected right parenthesis");
1250 p = _("Expected integer");
1253 p = _("Expected string");
1256 gfc_internal_error ("require_atom(): bad atom type required");
1259 set_module_locus (&m);
1265 /* Given a pointer to an mstring array, require that the current input
1266 be one of the strings in the array. We return the enum value. */
1269 find_enum (const mstring *m)
1273 i = gfc_string2code (m, atom_name);
1277 bad_module ("find_enum(): Enum not found");
1283 /**************** Module output subroutines ***************************/
1285 /* Output a character to a module file. */
1288 write_char (char out)
1290 if (putc (out, module_fp) == EOF)
1291 gfc_fatal_error ("Error writing modules file: %s", strerror (errno));
1293 /* Add this to our MD5. */
1294 md5_process_bytes (&out, sizeof (out), &ctx);
1306 /* Write an atom to a module. The line wrapping isn't perfect, but it
1307 should work most of the time. This isn't that big of a deal, since
1308 the file really isn't meant to be read by people anyway. */
1311 write_atom (atom_type atom, const void *v)
1321 p = (const char *) v;
1333 i = *((const int *) v);
1335 gfc_internal_error ("write_atom(): Writing negative integer");
1337 sprintf (buffer, "%d", i);
1342 gfc_internal_error ("write_atom(): Trying to write dab atom");
1346 if(p == NULL || *p == '\0')
1351 if (atom != ATOM_RPAREN)
1353 if (module_column + len > 72)
1358 if (last_atom != ATOM_LPAREN && module_column != 1)
1363 if (atom == ATOM_STRING)
1366 while (p != NULL && *p)
1368 if (atom == ATOM_STRING && *p == '\'')
1373 if (atom == ATOM_STRING)
1381 /***************** Mid-level I/O subroutines *****************/
1383 /* These subroutines let their caller read or write atoms without
1384 caring about which of the two is actually happening. This lets a
1385 subroutine concentrate on the actual format of the data being
1388 static void mio_expr (gfc_expr **);
1389 pointer_info *mio_symbol_ref (gfc_symbol **);
1390 pointer_info *mio_interface_rest (gfc_interface **);
1391 static void mio_symtree_ref (gfc_symtree **);
1393 /* Read or write an enumerated value. On writing, we return the input
1394 value for the convenience of callers. We avoid using an integer
1395 pointer because enums are sometimes inside bitfields. */
1398 mio_name (int t, const mstring *m)
1400 if (iomode == IO_OUTPUT)
1401 write_atom (ATOM_NAME, gfc_code2string (m, t));
1404 require_atom (ATOM_NAME);
1411 /* Specialization of mio_name. */
1413 #define DECL_MIO_NAME(TYPE) \
1414 static inline TYPE \
1415 MIO_NAME(TYPE) (TYPE t, const mstring *m) \
1417 return (TYPE) mio_name ((int) t, m); \
1419 #define MIO_NAME(TYPE) mio_name_##TYPE
1424 if (iomode == IO_OUTPUT)
1425 write_atom (ATOM_LPAREN, NULL);
1427 require_atom (ATOM_LPAREN);
1434 if (iomode == IO_OUTPUT)
1435 write_atom (ATOM_RPAREN, NULL);
1437 require_atom (ATOM_RPAREN);
1442 mio_integer (int *ip)
1444 if (iomode == IO_OUTPUT)
1445 write_atom (ATOM_INTEGER, ip);
1448 require_atom (ATOM_INTEGER);
1454 /* Read or write a character pointer that points to a string on the heap. */
1457 mio_allocated_string (const char *s)
1459 if (iomode == IO_OUTPUT)
1461 write_atom (ATOM_STRING, s);
1466 require_atom (ATOM_STRING);
1472 /* Functions for quoting and unquoting strings. */
1475 quote_string (const gfc_char_t *s, const size_t slength)
1477 const gfc_char_t *p;
1481 /* Calculate the length we'll need: a backslash takes two ("\\"),
1482 non-printable characters take 10 ("\Uxxxxxxxx") and others take 1. */
1483 for (p = s, i = 0; i < slength; p++, i++)
1487 else if (!gfc_wide_is_printable (*p))
1493 q = res = XCNEWVEC (char, len + 1);
1494 for (p = s, i = 0; i < slength; p++, i++)
1497 *q++ = '\\', *q++ = '\\';
1498 else if (!gfc_wide_is_printable (*p))
1500 sprintf (q, "\\U%08" HOST_WIDE_INT_PRINT "x",
1501 (unsigned HOST_WIDE_INT) *p);
1505 *q++ = (unsigned char) *p;
1513 unquote_string (const char *s)
1519 for (p = s, len = 0; *p; p++, len++)
1526 else if (p[1] == 'U')
1527 p += 9; /* That is a "\U????????". */
1529 gfc_internal_error ("unquote_string(): got bad string");
1532 res = gfc_get_wide_string (len + 1);
1533 for (i = 0, p = s; i < len; i++, p++)
1538 res[i] = (unsigned char) *p;
1539 else if (p[1] == '\\')
1541 res[i] = (unsigned char) '\\';
1546 /* We read the 8-digits hexadecimal constant that follows. */
1551 gcc_assert (p[1] == 'U');
1552 for (j = 0; j < 8; j++)
1555 gcc_assert (sscanf (&p[j+2], "%01x", &n) == 1);
1569 /* Read or write a character pointer that points to a wide string on the
1570 heap, performing quoting/unquoting of nonprintable characters using the
1571 form \U???????? (where each ? is a hexadecimal digit).
1572 Length is the length of the string, only known and used in output mode. */
1574 static const gfc_char_t *
1575 mio_allocated_wide_string (const gfc_char_t *s, const size_t length)
1577 if (iomode == IO_OUTPUT)
1579 char *quoted = quote_string (s, length);
1580 write_atom (ATOM_STRING, quoted);
1586 gfc_char_t *unquoted;
1588 require_atom (ATOM_STRING);
1589 unquoted = unquote_string (atom_string);
1590 gfc_free (atom_string);
1596 /* Read or write a string that is in static memory. */
1599 mio_pool_string (const char **stringp)
1601 /* TODO: one could write the string only once, and refer to it via a
1604 /* As a special case we have to deal with a NULL string. This
1605 happens for the 'module' member of 'gfc_symbol's that are not in a
1606 module. We read / write these as the empty string. */
1607 if (iomode == IO_OUTPUT)
1609 const char *p = *stringp == NULL ? "" : *stringp;
1610 write_atom (ATOM_STRING, p);
1614 require_atom (ATOM_STRING);
1615 *stringp = atom_string[0] == '\0' ? NULL : gfc_get_string (atom_string);
1616 gfc_free (atom_string);
1621 /* Read or write a string that is inside of some already-allocated
1625 mio_internal_string (char *string)
1627 if (iomode == IO_OUTPUT)
1628 write_atom (ATOM_STRING, string);
1631 require_atom (ATOM_STRING);
1632 strcpy (string, atom_string);
1633 gfc_free (atom_string);
1639 { AB_ALLOCATABLE, AB_DIMENSION, AB_EXTERNAL, AB_INTRINSIC, AB_OPTIONAL,
1640 AB_POINTER, AB_TARGET, AB_DUMMY, AB_RESULT, AB_DATA,
1641 AB_IN_NAMELIST, AB_IN_COMMON, AB_FUNCTION, AB_SUBROUTINE, AB_SEQUENCE,
1642 AB_ELEMENTAL, AB_PURE, AB_RECURSIVE, AB_GENERIC, AB_ALWAYS_EXPLICIT,
1643 AB_CRAY_POINTER, AB_CRAY_POINTEE, AB_THREADPRIVATE, AB_ALLOC_COMP,
1644 AB_POINTER_COMP, AB_PRIVATE_COMP, AB_VALUE, AB_VOLATILE, AB_PROTECTED,
1645 AB_IS_BIND_C, AB_IS_C_INTEROP, AB_IS_ISO_C, AB_ABSTRACT, AB_ZERO_COMP,
1646 AB_EXTENSION, AB_PROCEDURE, AB_PROC_POINTER
1650 static const mstring attr_bits[] =
1652 minit ("ALLOCATABLE", AB_ALLOCATABLE),
1653 minit ("DIMENSION", AB_DIMENSION),
1654 minit ("EXTERNAL", AB_EXTERNAL),
1655 minit ("INTRINSIC", AB_INTRINSIC),
1656 minit ("OPTIONAL", AB_OPTIONAL),
1657 minit ("POINTER", AB_POINTER),
1658 minit ("VOLATILE", AB_VOLATILE),
1659 minit ("TARGET", AB_TARGET),
1660 minit ("THREADPRIVATE", AB_THREADPRIVATE),
1661 minit ("DUMMY", AB_DUMMY),
1662 minit ("RESULT", AB_RESULT),
1663 minit ("DATA", AB_DATA),
1664 minit ("IN_NAMELIST", AB_IN_NAMELIST),
1665 minit ("IN_COMMON", AB_IN_COMMON),
1666 minit ("FUNCTION", AB_FUNCTION),
1667 minit ("SUBROUTINE", AB_SUBROUTINE),
1668 minit ("SEQUENCE", AB_SEQUENCE),
1669 minit ("ELEMENTAL", AB_ELEMENTAL),
1670 minit ("PURE", AB_PURE),
1671 minit ("RECURSIVE", AB_RECURSIVE),
1672 minit ("GENERIC", AB_GENERIC),
1673 minit ("ALWAYS_EXPLICIT", AB_ALWAYS_EXPLICIT),
1674 minit ("CRAY_POINTER", AB_CRAY_POINTER),
1675 minit ("CRAY_POINTEE", AB_CRAY_POINTEE),
1676 minit ("IS_BIND_C", AB_IS_BIND_C),
1677 minit ("IS_C_INTEROP", AB_IS_C_INTEROP),
1678 minit ("IS_ISO_C", AB_IS_ISO_C),
1679 minit ("VALUE", AB_VALUE),
1680 minit ("ALLOC_COMP", AB_ALLOC_COMP),
1681 minit ("POINTER_COMP", AB_POINTER_COMP),
1682 minit ("PRIVATE_COMP", AB_PRIVATE_COMP),
1683 minit ("ZERO_COMP", AB_ZERO_COMP),
1684 minit ("PROTECTED", AB_PROTECTED),
1685 minit ("ABSTRACT", AB_ABSTRACT),
1686 minit ("EXTENSION", AB_EXTENSION),
1687 minit ("PROCEDURE", AB_PROCEDURE),
1688 minit ("PROC_POINTER", AB_PROC_POINTER),
1692 /* For binding attributes. */
1693 static const mstring binding_passing[] =
1696 minit ("NOPASS", 1),
1699 static const mstring binding_overriding[] =
1701 minit ("OVERRIDABLE", 0),
1702 minit ("NON_OVERRIDABLE", 1),
1705 static const mstring binding_generic[] =
1707 minit ("SPECIFIC", 0),
1708 minit ("GENERIC", 1),
1713 /* Specialization of mio_name. */
1714 DECL_MIO_NAME (ab_attribute)
1715 DECL_MIO_NAME (ar_type)
1716 DECL_MIO_NAME (array_type)
1718 DECL_MIO_NAME (expr_t)
1719 DECL_MIO_NAME (gfc_access)
1720 DECL_MIO_NAME (gfc_intrinsic_op)
1721 DECL_MIO_NAME (ifsrc)
1722 DECL_MIO_NAME (save_state)
1723 DECL_MIO_NAME (procedure_type)
1724 DECL_MIO_NAME (ref_type)
1725 DECL_MIO_NAME (sym_flavor)
1726 DECL_MIO_NAME (sym_intent)
1727 #undef DECL_MIO_NAME
1729 /* Symbol attributes are stored in list with the first three elements
1730 being the enumerated fields, while the remaining elements (if any)
1731 indicate the individual attribute bits. The access field is not
1732 saved-- it controls what symbols are exported when a module is
1736 mio_symbol_attribute (symbol_attribute *attr)
1742 attr->flavor = MIO_NAME (sym_flavor) (attr->flavor, flavors);
1743 attr->intent = MIO_NAME (sym_intent) (attr->intent, intents);
1744 attr->proc = MIO_NAME (procedure_type) (attr->proc, procedures);
1745 attr->if_source = MIO_NAME (ifsrc) (attr->if_source, ifsrc_types);
1746 attr->save = MIO_NAME (save_state) (attr->save, save_status);
1748 if (iomode == IO_OUTPUT)
1750 if (attr->allocatable)
1751 MIO_NAME (ab_attribute) (AB_ALLOCATABLE, attr_bits);
1752 if (attr->dimension)
1753 MIO_NAME (ab_attribute) (AB_DIMENSION, attr_bits);
1755 MIO_NAME (ab_attribute) (AB_EXTERNAL, attr_bits);
1756 if (attr->intrinsic)
1757 MIO_NAME (ab_attribute) (AB_INTRINSIC, attr_bits);
1759 MIO_NAME (ab_attribute) (AB_OPTIONAL, attr_bits);
1761 MIO_NAME (ab_attribute) (AB_POINTER, attr_bits);
1762 if (attr->is_protected)
1763 MIO_NAME (ab_attribute) (AB_PROTECTED, attr_bits);
1765 MIO_NAME (ab_attribute) (AB_VALUE, attr_bits);
1766 if (attr->volatile_)
1767 MIO_NAME (ab_attribute) (AB_VOLATILE, attr_bits);
1769 MIO_NAME (ab_attribute) (AB_TARGET, attr_bits);
1770 if (attr->threadprivate)
1771 MIO_NAME (ab_attribute) (AB_THREADPRIVATE, attr_bits);
1773 MIO_NAME (ab_attribute) (AB_DUMMY, attr_bits);
1775 MIO_NAME (ab_attribute) (AB_RESULT, attr_bits);
1776 /* We deliberately don't preserve the "entry" flag. */
1779 MIO_NAME (ab_attribute) (AB_DATA, attr_bits);
1780 if (attr->in_namelist)
1781 MIO_NAME (ab_attribute) (AB_IN_NAMELIST, attr_bits);
1782 if (attr->in_common)
1783 MIO_NAME (ab_attribute) (AB_IN_COMMON, attr_bits);
1786 MIO_NAME (ab_attribute) (AB_FUNCTION, attr_bits);
1787 if (attr->subroutine)
1788 MIO_NAME (ab_attribute) (AB_SUBROUTINE, attr_bits);
1790 MIO_NAME (ab_attribute) (AB_GENERIC, attr_bits);
1792 MIO_NAME (ab_attribute) (AB_ABSTRACT, attr_bits);
1795 MIO_NAME (ab_attribute) (AB_SEQUENCE, attr_bits);
1796 if (attr->elemental)
1797 MIO_NAME (ab_attribute) (AB_ELEMENTAL, attr_bits);
1799 MIO_NAME (ab_attribute) (AB_PURE, attr_bits);
1800 if (attr->recursive)
1801 MIO_NAME (ab_attribute) (AB_RECURSIVE, attr_bits);
1802 if (attr->always_explicit)
1803 MIO_NAME (ab_attribute) (AB_ALWAYS_EXPLICIT, attr_bits);
1804 if (attr->cray_pointer)
1805 MIO_NAME (ab_attribute) (AB_CRAY_POINTER, attr_bits);
1806 if (attr->cray_pointee)
1807 MIO_NAME (ab_attribute) (AB_CRAY_POINTEE, attr_bits);
1808 if (attr->is_bind_c)
1809 MIO_NAME(ab_attribute) (AB_IS_BIND_C, attr_bits);
1810 if (attr->is_c_interop)
1811 MIO_NAME(ab_attribute) (AB_IS_C_INTEROP, attr_bits);
1813 MIO_NAME(ab_attribute) (AB_IS_ISO_C, attr_bits);
1814 if (attr->alloc_comp)
1815 MIO_NAME (ab_attribute) (AB_ALLOC_COMP, attr_bits);
1816 if (attr->pointer_comp)
1817 MIO_NAME (ab_attribute) (AB_POINTER_COMP, attr_bits);
1818 if (attr->private_comp)
1819 MIO_NAME (ab_attribute) (AB_PRIVATE_COMP, attr_bits);
1820 if (attr->zero_comp)
1821 MIO_NAME (ab_attribute) (AB_ZERO_COMP, attr_bits);
1822 if (attr->extension)
1823 MIO_NAME (ab_attribute) (AB_EXTENSION, attr_bits);
1824 if (attr->procedure)
1825 MIO_NAME (ab_attribute) (AB_PROCEDURE, attr_bits);
1826 if (attr->proc_pointer)
1827 MIO_NAME (ab_attribute) (AB_PROC_POINTER, attr_bits);
1837 if (t == ATOM_RPAREN)
1840 bad_module ("Expected attribute bit name");
1842 switch ((ab_attribute) find_enum (attr_bits))
1844 case AB_ALLOCATABLE:
1845 attr->allocatable = 1;
1848 attr->dimension = 1;
1854 attr->intrinsic = 1;
1863 attr->is_protected = 1;
1869 attr->volatile_ = 1;
1874 case AB_THREADPRIVATE:
1875 attr->threadprivate = 1;
1886 case AB_IN_NAMELIST:
1887 attr->in_namelist = 1;
1890 attr->in_common = 1;
1896 attr->subroutine = 1;
1908 attr->elemental = 1;
1914 attr->recursive = 1;
1916 case AB_ALWAYS_EXPLICIT:
1917 attr->always_explicit = 1;
1919 case AB_CRAY_POINTER:
1920 attr->cray_pointer = 1;
1922 case AB_CRAY_POINTEE:
1923 attr->cray_pointee = 1;
1926 attr->is_bind_c = 1;
1928 case AB_IS_C_INTEROP:
1929 attr->is_c_interop = 1;
1935 attr->alloc_comp = 1;
1937 case AB_POINTER_COMP:
1938 attr->pointer_comp = 1;
1940 case AB_PRIVATE_COMP:
1941 attr->private_comp = 1;
1944 attr->zero_comp = 1;
1947 attr->extension = 1;
1950 attr->procedure = 1;
1952 case AB_PROC_POINTER:
1953 attr->proc_pointer = 1;
1961 static const mstring bt_types[] = {
1962 minit ("INTEGER", BT_INTEGER),
1963 minit ("REAL", BT_REAL),
1964 minit ("COMPLEX", BT_COMPLEX),
1965 minit ("LOGICAL", BT_LOGICAL),
1966 minit ("CHARACTER", BT_CHARACTER),
1967 minit ("DERIVED", BT_DERIVED),
1968 minit ("PROCEDURE", BT_PROCEDURE),
1969 minit ("UNKNOWN", BT_UNKNOWN),
1970 minit ("VOID", BT_VOID),
1976 mio_charlen (gfc_charlen **clp)
1982 if (iomode == IO_OUTPUT)
1986 mio_expr (&cl->length);
1990 if (peek_atom () != ATOM_RPAREN)
1992 cl = gfc_get_charlen ();
1993 mio_expr (&cl->length);
1997 cl->next = gfc_current_ns->cl_list;
1998 gfc_current_ns->cl_list = cl;
2006 /* See if a name is a generated name. */
2009 check_unique_name (const char *name)
2011 return *name == '@';
2016 mio_typespec (gfc_typespec *ts)
2020 ts->type = MIO_NAME (bt) (ts->type, bt_types);
2022 if (ts->type != BT_DERIVED)
2023 mio_integer (&ts->kind);
2025 mio_symbol_ref (&ts->derived);
2027 /* Add info for C interop and is_iso_c. */
2028 mio_integer (&ts->is_c_interop);
2029 mio_integer (&ts->is_iso_c);
2031 /* If the typespec is for an identifier either from iso_c_binding, or
2032 a constant that was initialized to an identifier from it, use the
2033 f90_type. Otherwise, use the ts->type, since it shouldn't matter. */
2035 ts->f90_type = MIO_NAME (bt) (ts->f90_type, bt_types);
2037 ts->f90_type = MIO_NAME (bt) (ts->type, bt_types);
2039 if (ts->type != BT_CHARACTER)
2041 /* ts->cl is only valid for BT_CHARACTER. */
2046 mio_charlen (&ts->cl);
2052 static const mstring array_spec_types[] = {
2053 minit ("EXPLICIT", AS_EXPLICIT),
2054 minit ("ASSUMED_SHAPE", AS_ASSUMED_SHAPE),
2055 minit ("DEFERRED", AS_DEFERRED),
2056 minit ("ASSUMED_SIZE", AS_ASSUMED_SIZE),
2062 mio_array_spec (gfc_array_spec **asp)
2069 if (iomode == IO_OUTPUT)
2077 if (peek_atom () == ATOM_RPAREN)
2083 *asp = as = gfc_get_array_spec ();
2086 mio_integer (&as->rank);
2087 as->type = MIO_NAME (array_type) (as->type, array_spec_types);
2089 for (i = 0; i < as->rank; i++)
2091 mio_expr (&as->lower[i]);
2092 mio_expr (&as->upper[i]);
2100 /* Given a pointer to an array reference structure (which lives in a
2101 gfc_ref structure), find the corresponding array specification
2102 structure. Storing the pointer in the ref structure doesn't quite
2103 work when loading from a module. Generating code for an array
2104 reference also needs more information than just the array spec. */
2106 static const mstring array_ref_types[] = {
2107 minit ("FULL", AR_FULL),
2108 minit ("ELEMENT", AR_ELEMENT),
2109 minit ("SECTION", AR_SECTION),
2115 mio_array_ref (gfc_array_ref *ar)
2120 ar->type = MIO_NAME (ar_type) (ar->type, array_ref_types);
2121 mio_integer (&ar->dimen);
2129 for (i = 0; i < ar->dimen; i++)
2130 mio_expr (&ar->start[i]);
2135 for (i = 0; i < ar->dimen; i++)
2137 mio_expr (&ar->start[i]);
2138 mio_expr (&ar->end[i]);
2139 mio_expr (&ar->stride[i]);
2145 gfc_internal_error ("mio_array_ref(): Unknown array ref");
2148 /* Unfortunately, ar->dimen_type is an anonymous enumerated type so
2149 we can't call mio_integer directly. Instead loop over each element
2150 and cast it to/from an integer. */
2151 if (iomode == IO_OUTPUT)
2153 for (i = 0; i < ar->dimen; i++)
2155 int tmp = (int)ar->dimen_type[i];
2156 write_atom (ATOM_INTEGER, &tmp);
2161 for (i = 0; i < ar->dimen; i++)
2163 require_atom (ATOM_INTEGER);
2164 ar->dimen_type[i] = atom_int;
2168 if (iomode == IO_INPUT)
2170 ar->where = gfc_current_locus;
2172 for (i = 0; i < ar->dimen; i++)
2173 ar->c_where[i] = gfc_current_locus;
2180 /* Saves or restores a pointer. The pointer is converted back and
2181 forth from an integer. We return the pointer_info pointer so that
2182 the caller can take additional action based on the pointer type. */
2184 static pointer_info *
2185 mio_pointer_ref (void *gp)
2189 if (iomode == IO_OUTPUT)
2191 p = get_pointer (*((char **) gp));
2192 write_atom (ATOM_INTEGER, &p->integer);
2196 require_atom (ATOM_INTEGER);
2197 p = add_fixup (atom_int, gp);
2204 /* Save and load references to components that occur within
2205 expressions. We have to describe these references by a number and
2206 by name. The number is necessary for forward references during
2207 reading, and the name is necessary if the symbol already exists in
2208 the namespace and is not loaded again. */
2211 mio_component_ref (gfc_component **cp, gfc_symbol *sym)
2213 char name[GFC_MAX_SYMBOL_LEN + 1];
2217 p = mio_pointer_ref (cp);
2218 if (p->type == P_UNKNOWN)
2219 p->type = P_COMPONENT;
2221 if (iomode == IO_OUTPUT)
2222 mio_pool_string (&(*cp)->name);
2225 mio_internal_string (name);
2227 /* It can happen that a component reference can be read before the
2228 associated derived type symbol has been loaded. Return now and
2229 wait for a later iteration of load_needed. */
2233 if (sym->components != NULL && p->u.pointer == NULL)
2235 /* Symbol already loaded, so search by name. */
2236 for (q = sym->components; q; q = q->next)
2237 if (strcmp (q->name, name) == 0)
2241 gfc_internal_error ("mio_component_ref(): Component not found");
2243 associate_integer_pointer (p, q);
2246 /* Make sure this symbol will eventually be loaded. */
2247 p = find_pointer2 (sym);
2248 if (p->u.rsym.state == UNUSED)
2249 p->u.rsym.state = NEEDED;
2255 mio_component (gfc_component *c)
2262 if (iomode == IO_OUTPUT)
2264 p = get_pointer (c);
2265 mio_integer (&p->integer);
2270 p = get_integer (n);
2271 associate_integer_pointer (p, c);
2274 if (p->type == P_UNKNOWN)
2275 p->type = P_COMPONENT;
2277 mio_pool_string (&c->name);
2278 mio_typespec (&c->ts);
2279 mio_array_spec (&c->as);
2281 mio_symbol_attribute (&c->attr);
2282 c->attr.access = MIO_NAME (gfc_access) (c->attr.access, access_types);
2284 mio_expr (&c->initializer);
2290 mio_component_list (gfc_component **cp)
2292 gfc_component *c, *tail;
2296 if (iomode == IO_OUTPUT)
2298 for (c = *cp; c; c = c->next)
2308 if (peek_atom () == ATOM_RPAREN)
2311 c = gfc_get_component ();
2328 mio_actual_arg (gfc_actual_arglist *a)
2331 mio_pool_string (&a->name);
2332 mio_expr (&a->expr);
2338 mio_actual_arglist (gfc_actual_arglist **ap)
2340 gfc_actual_arglist *a, *tail;
2344 if (iomode == IO_OUTPUT)
2346 for (a = *ap; a; a = a->next)
2356 if (peek_atom () != ATOM_LPAREN)
2359 a = gfc_get_actual_arglist ();
2375 /* Read and write formal argument lists. */
2378 mio_formal_arglist (gfc_symbol *sym)
2380 gfc_formal_arglist *f, *tail;
2384 if (iomode == IO_OUTPUT)
2386 for (f = sym->formal; f; f = f->next)
2387 mio_symbol_ref (&f->sym);
2391 sym->formal = tail = NULL;
2393 while (peek_atom () != ATOM_RPAREN)
2395 f = gfc_get_formal_arglist ();
2396 mio_symbol_ref (&f->sym);
2398 if (sym->formal == NULL)
2411 /* Save or restore a reference to a symbol node. */
2414 mio_symbol_ref (gfc_symbol **symp)
2418 p = mio_pointer_ref (symp);
2419 if (p->type == P_UNKNOWN)
2422 if (iomode == IO_OUTPUT)
2424 if (p->u.wsym.state == UNREFERENCED)
2425 p->u.wsym.state = NEEDS_WRITE;
2429 if (p->u.rsym.state == UNUSED)
2430 p->u.rsym.state = NEEDED;
2436 /* Save or restore a reference to a symtree node. */
2439 mio_symtree_ref (gfc_symtree **stp)
2444 if (iomode == IO_OUTPUT)
2445 mio_symbol_ref (&(*stp)->n.sym);
2448 require_atom (ATOM_INTEGER);
2449 p = get_integer (atom_int);
2451 /* An unused equivalence member; make a symbol and a symtree
2453 if (in_load_equiv && p->u.rsym.symtree == NULL)
2455 /* Since this is not used, it must have a unique name. */
2456 p->u.rsym.symtree = gfc_get_unique_symtree (gfc_current_ns);
2458 /* Make the symbol. */
2459 if (p->u.rsym.sym == NULL)
2461 p->u.rsym.sym = gfc_new_symbol (p->u.rsym.true_name,
2463 p->u.rsym.sym->module = gfc_get_string (p->u.rsym.module);
2466 p->u.rsym.symtree->n.sym = p->u.rsym.sym;
2467 p->u.rsym.symtree->n.sym->refs++;
2468 p->u.rsym.referenced = 1;
2470 /* If the symbol is PRIVATE and in COMMON, load_commons will
2471 generate a fixup symbol, which must be associated. */
2473 resolve_fixups (p->fixup, p->u.rsym.sym);
2477 if (p->type == P_UNKNOWN)
2480 if (p->u.rsym.state == UNUSED)
2481 p->u.rsym.state = NEEDED;
2483 if (p->u.rsym.symtree != NULL)
2485 *stp = p->u.rsym.symtree;
2489 f = XCNEW (fixup_t);
2491 f->next = p->u.rsym.stfixup;
2492 p->u.rsym.stfixup = f;
2494 f->pointer = (void **) stp;
2501 mio_iterator (gfc_iterator **ip)
2507 if (iomode == IO_OUTPUT)
2514 if (peek_atom () == ATOM_RPAREN)
2520 *ip = gfc_get_iterator ();
2525 mio_expr (&iter->var);
2526 mio_expr (&iter->start);
2527 mio_expr (&iter->end);
2528 mio_expr (&iter->step);
2536 mio_constructor (gfc_constructor **cp)
2538 gfc_constructor *c, *tail;
2542 if (iomode == IO_OUTPUT)
2544 for (c = *cp; c; c = c->next)
2547 mio_expr (&c->expr);
2548 mio_iterator (&c->iterator);
2557 while (peek_atom () != ATOM_RPAREN)
2559 c = gfc_get_constructor ();
2569 mio_expr (&c->expr);
2570 mio_iterator (&c->iterator);
2579 static const mstring ref_types[] = {
2580 minit ("ARRAY", REF_ARRAY),
2581 minit ("COMPONENT", REF_COMPONENT),
2582 minit ("SUBSTRING", REF_SUBSTRING),
2588 mio_ref (gfc_ref **rp)
2595 r->type = MIO_NAME (ref_type) (r->type, ref_types);
2600 mio_array_ref (&r->u.ar);
2604 mio_symbol_ref (&r->u.c.sym);
2605 mio_component_ref (&r->u.c.component, r->u.c.sym);
2609 mio_expr (&r->u.ss.start);
2610 mio_expr (&r->u.ss.end);
2611 mio_charlen (&r->u.ss.length);
2620 mio_ref_list (gfc_ref **rp)
2622 gfc_ref *ref, *head, *tail;
2626 if (iomode == IO_OUTPUT)
2628 for (ref = *rp; ref; ref = ref->next)
2635 while (peek_atom () != ATOM_RPAREN)
2638 head = tail = gfc_get_ref ();
2641 tail->next = gfc_get_ref ();
2655 /* Read and write an integer value. */
2658 mio_gmp_integer (mpz_t *integer)
2662 if (iomode == IO_INPUT)
2664 if (parse_atom () != ATOM_STRING)
2665 bad_module ("Expected integer string");
2667 mpz_init (*integer);
2668 if (mpz_set_str (*integer, atom_string, 10))
2669 bad_module ("Error converting integer");
2671 gfc_free (atom_string);
2675 p = mpz_get_str (NULL, 10, *integer);
2676 write_atom (ATOM_STRING, p);
2683 mio_gmp_real (mpfr_t *real)
2688 if (iomode == IO_INPUT)
2690 if (parse_atom () != ATOM_STRING)
2691 bad_module ("Expected real string");
2694 mpfr_set_str (*real, atom_string, 16, GFC_RND_MODE);
2695 gfc_free (atom_string);
2699 p = mpfr_get_str (NULL, &exponent, 16, 0, *real, GFC_RND_MODE);
2701 if (mpfr_nan_p (*real) || mpfr_inf_p (*real))
2703 write_atom (ATOM_STRING, p);
2708 atom_string = XCNEWVEC (char, strlen (p) + 20);
2710 sprintf (atom_string, "0.%s@%ld", p, exponent);
2712 /* Fix negative numbers. */
2713 if (atom_string[2] == '-')
2715 atom_string[0] = '-';
2716 atom_string[1] = '0';
2717 atom_string[2] = '.';
2720 write_atom (ATOM_STRING, atom_string);
2722 gfc_free (atom_string);
2728 /* Save and restore the shape of an array constructor. */
2731 mio_shape (mpz_t **pshape, int rank)
2737 /* A NULL shape is represented by (). */
2740 if (iomode == IO_OUTPUT)
2752 if (t == ATOM_RPAREN)
2759 shape = gfc_get_shape (rank);
2763 for (n = 0; n < rank; n++)
2764 mio_gmp_integer (&shape[n]);
2770 static const mstring expr_types[] = {
2771 minit ("OP", EXPR_OP),
2772 minit ("FUNCTION", EXPR_FUNCTION),
2773 minit ("CONSTANT", EXPR_CONSTANT),
2774 minit ("VARIABLE", EXPR_VARIABLE),
2775 minit ("SUBSTRING", EXPR_SUBSTRING),
2776 minit ("STRUCTURE", EXPR_STRUCTURE),
2777 minit ("ARRAY", EXPR_ARRAY),
2778 minit ("NULL", EXPR_NULL),
2779 minit ("COMPCALL", EXPR_COMPCALL),
2783 /* INTRINSIC_ASSIGN is missing because it is used as an index for
2784 generic operators, not in expressions. INTRINSIC_USER is also
2785 replaced by the correct function name by the time we see it. */
2787 static const mstring intrinsics[] =
2789 minit ("UPLUS", INTRINSIC_UPLUS),
2790 minit ("UMINUS", INTRINSIC_UMINUS),
2791 minit ("PLUS", INTRINSIC_PLUS),
2792 minit ("MINUS", INTRINSIC_MINUS),
2793 minit ("TIMES", INTRINSIC_TIMES),
2794 minit ("DIVIDE", INTRINSIC_DIVIDE),
2795 minit ("POWER", INTRINSIC_POWER),
2796 minit ("CONCAT", INTRINSIC_CONCAT),
2797 minit ("AND", INTRINSIC_AND),
2798 minit ("OR", INTRINSIC_OR),
2799 minit ("EQV", INTRINSIC_EQV),
2800 minit ("NEQV", INTRINSIC_NEQV),
2801 minit ("EQ_SIGN", INTRINSIC_EQ),
2802 minit ("EQ", INTRINSIC_EQ_OS),
2803 minit ("NE_SIGN", INTRINSIC_NE),
2804 minit ("NE", INTRINSIC_NE_OS),
2805 minit ("GT_SIGN", INTRINSIC_GT),
2806 minit ("GT", INTRINSIC_GT_OS),
2807 minit ("GE_SIGN", INTRINSIC_GE),
2808 minit ("GE", INTRINSIC_GE_OS),
2809 minit ("LT_SIGN", INTRINSIC_LT),
2810 minit ("LT", INTRINSIC_LT_OS),
2811 minit ("LE_SIGN", INTRINSIC_LE),
2812 minit ("LE", INTRINSIC_LE_OS),
2813 minit ("NOT", INTRINSIC_NOT),
2814 minit ("PARENTHESES", INTRINSIC_PARENTHESES),
2819 /* Remedy a couple of situations where the gfc_expr's can be defective. */
2822 fix_mio_expr (gfc_expr *e)
2824 gfc_symtree *ns_st = NULL;
2827 if (iomode != IO_OUTPUT)
2832 /* If this is a symtree for a symbol that came from a contained module
2833 namespace, it has a unique name and we should look in the current
2834 namespace to see if the required, non-contained symbol is available
2835 yet. If so, the latter should be written. */
2836 if (e->symtree->n.sym && check_unique_name (e->symtree->name))
2837 ns_st = gfc_find_symtree (gfc_current_ns->sym_root,
2838 e->symtree->n.sym->name);
2840 /* On the other hand, if the existing symbol is the module name or the
2841 new symbol is a dummy argument, do not do the promotion. */
2842 if (ns_st && ns_st->n.sym
2843 && ns_st->n.sym->attr.flavor != FL_MODULE
2844 && !e->symtree->n.sym->attr.dummy)
2847 else if (e->expr_type == EXPR_FUNCTION && e->value.function.name)
2849 /* In some circumstances, a function used in an initialization
2850 expression, in one use associated module, can fail to be
2851 coupled to its symtree when used in a specification
2852 expression in another module. */
2853 fname = e->value.function.esym ? e->value.function.esym->name
2854 : e->value.function.isym->name;
2855 e->symtree = gfc_find_symtree (gfc_current_ns->sym_root, fname);
2860 /* Read and write expressions. The form "()" is allowed to indicate a
2864 mio_expr (gfc_expr **ep)
2872 if (iomode == IO_OUTPUT)
2881 MIO_NAME (expr_t) (e->expr_type, expr_types);
2886 if (t == ATOM_RPAREN)
2893 bad_module ("Expected expression type");
2895 e = *ep = gfc_get_expr ();
2896 e->where = gfc_current_locus;
2897 e->expr_type = (expr_t) find_enum (expr_types);
2900 mio_typespec (&e->ts);
2901 mio_integer (&e->rank);
2905 switch (e->expr_type)
2909 = MIO_NAME (gfc_intrinsic_op) (e->value.op.op, intrinsics);
2911 switch (e->value.op.op)
2913 case INTRINSIC_UPLUS:
2914 case INTRINSIC_UMINUS:
2916 case INTRINSIC_PARENTHESES:
2917 mio_expr (&e->value.op.op1);
2920 case INTRINSIC_PLUS:
2921 case INTRINSIC_MINUS:
2922 case INTRINSIC_TIMES:
2923 case INTRINSIC_DIVIDE:
2924 case INTRINSIC_POWER:
2925 case INTRINSIC_CONCAT:
2929 case INTRINSIC_NEQV:
2931 case INTRINSIC_EQ_OS:
2933 case INTRINSIC_NE_OS:
2935 case INTRINSIC_GT_OS:
2937 case INTRINSIC_GE_OS:
2939 case INTRINSIC_LT_OS:
2941 case INTRINSIC_LE_OS:
2942 mio_expr (&e->value.op.op1);
2943 mio_expr (&e->value.op.op2);
2947 bad_module ("Bad operator");
2953 mio_symtree_ref (&e->symtree);
2954 mio_actual_arglist (&e->value.function.actual);
2956 if (iomode == IO_OUTPUT)
2958 e->value.function.name
2959 = mio_allocated_string (e->value.function.name);
2960 flag = e->value.function.esym != NULL;
2961 mio_integer (&flag);
2963 mio_symbol_ref (&e->value.function.esym);
2965 write_atom (ATOM_STRING, e->value.function.isym->name);
2969 require_atom (ATOM_STRING);
2970 e->value.function.name = gfc_get_string (atom_string);
2971 gfc_free (atom_string);
2973 mio_integer (&flag);
2975 mio_symbol_ref (&e->value.function.esym);
2978 require_atom (ATOM_STRING);
2979 e->value.function.isym = gfc_find_function (atom_string);
2980 gfc_free (atom_string);
2987 mio_symtree_ref (&e->symtree);
2988 mio_ref_list (&e->ref);
2991 case EXPR_SUBSTRING:
2992 e->value.character.string
2993 = CONST_CAST (gfc_char_t *,
2994 mio_allocated_wide_string (e->value.character.string,
2995 e->value.character.length));
2996 mio_ref_list (&e->ref);
2999 case EXPR_STRUCTURE:
3001 mio_constructor (&e->value.constructor);
3002 mio_shape (&e->shape, e->rank);
3009 mio_gmp_integer (&e->value.integer);
3013 gfc_set_model_kind (e->ts.kind);
3014 mio_gmp_real (&e->value.real);
3018 gfc_set_model_kind (e->ts.kind);
3019 mio_gmp_real (&e->value.complex.r);
3020 mio_gmp_real (&e->value.complex.i);
3024 mio_integer (&e->value.logical);
3028 mio_integer (&e->value.character.length);
3029 e->value.character.string
3030 = CONST_CAST (gfc_char_t *,
3031 mio_allocated_wide_string (e->value.character.string,
3032 e->value.character.length));
3036 bad_module ("Bad type in constant expression");
3053 /* Read and write namelists. */
3056 mio_namelist (gfc_symbol *sym)
3058 gfc_namelist *n, *m;
3059 const char *check_name;
3063 if (iomode == IO_OUTPUT)
3065 for (n = sym->namelist; n; n = n->next)
3066 mio_symbol_ref (&n->sym);
3070 /* This departure from the standard is flagged as an error.
3071 It does, in fact, work correctly. TODO: Allow it
3073 if (sym->attr.flavor == FL_NAMELIST)
3075 check_name = find_use_name (sym->name, false);
3076 if (check_name && strcmp (check_name, sym->name) != 0)
3077 gfc_error ("Namelist %s cannot be renamed by USE "
3078 "association to %s", sym->name, check_name);
3082 while (peek_atom () != ATOM_RPAREN)
3084 n = gfc_get_namelist ();
3085 mio_symbol_ref (&n->sym);
3087 if (sym->namelist == NULL)
3094 sym->namelist_tail = m;
3101 /* Save/restore lists of gfc_interface structures. When loading an
3102 interface, we are really appending to the existing list of
3103 interfaces. Checking for duplicate and ambiguous interfaces has to
3104 be done later when all symbols have been loaded. */
3107 mio_interface_rest (gfc_interface **ip)
3109 gfc_interface *tail, *p;
3110 pointer_info *pi = NULL;
3112 if (iomode == IO_OUTPUT)
3115 for (p = *ip; p; p = p->next)
3116 mio_symbol_ref (&p->sym);
3131 if (peek_atom () == ATOM_RPAREN)
3134 p = gfc_get_interface ();
3135 p->where = gfc_current_locus;
3136 pi = mio_symbol_ref (&p->sym);
3152 /* Save/restore a nameless operator interface. */
3155 mio_interface (gfc_interface **ip)
3158 mio_interface_rest (ip);
3162 /* Save/restore a named operator interface. */
3165 mio_symbol_interface (const char **name, const char **module,
3169 mio_pool_string (name);
3170 mio_pool_string (module);
3171 mio_interface_rest (ip);
3176 mio_namespace_ref (gfc_namespace **nsp)
3181 p = mio_pointer_ref (nsp);
3183 if (p->type == P_UNKNOWN)
3184 p->type = P_NAMESPACE;
3186 if (iomode == IO_INPUT && p->integer != 0)
3188 ns = (gfc_namespace *) p->u.pointer;
3191 ns = gfc_get_namespace (NULL, 0);
3192 associate_integer_pointer (p, ns);
3200 /* Save/restore the f2k_derived namespace of a derived-type symbol. */
3202 static gfc_namespace* current_f2k_derived;
3205 mio_typebound_proc (gfc_typebound_proc** proc)
3209 if (iomode == IO_INPUT)
3211 *proc = gfc_get_typebound_proc ();
3212 (*proc)->where = gfc_current_locus;
3218 (*proc)->access = MIO_NAME (gfc_access) ((*proc)->access, access_types);
3220 (*proc)->nopass = mio_name ((*proc)->nopass, binding_passing);
3221 (*proc)->non_overridable = mio_name ((*proc)->non_overridable,
3222 binding_overriding);
3223 (*proc)->is_generic = mio_name ((*proc)->is_generic, binding_generic);
3225 if (iomode == IO_INPUT)
3226 (*proc)->pass_arg = NULL;
3228 flag = (int) (*proc)->pass_arg_num;
3229 mio_integer (&flag);
3230 (*proc)->pass_arg_num = (unsigned) flag;
3232 if ((*proc)->is_generic)
3238 if (iomode == IO_OUTPUT)
3239 for (g = (*proc)->u.generic; g; g = g->next)
3240 mio_allocated_string (g->specific_st->name);
3243 (*proc)->u.generic = NULL;
3244 while (peek_atom () != ATOM_RPAREN)
3246 g = gfc_get_tbp_generic ();
3249 require_atom (ATOM_STRING);
3250 gfc_get_sym_tree (atom_string, current_f2k_derived,
3252 gfc_free (atom_string);
3254 g->next = (*proc)->u.generic;
3255 (*proc)->u.generic = g;
3262 mio_symtree_ref (&(*proc)->u.specific);
3268 mio_typebound_symtree (gfc_symtree* st)
3270 if (iomode == IO_OUTPUT && !st->typebound)
3273 if (iomode == IO_OUTPUT)
3276 mio_allocated_string (st->name);
3278 /* For IO_INPUT, the above is done in mio_f2k_derived. */
3280 mio_typebound_proc (&st->typebound);
3285 mio_finalizer (gfc_finalizer **f)
3287 if (iomode == IO_OUTPUT)
3290 gcc_assert ((*f)->proc_tree); /* Should already be resolved. */
3291 mio_symtree_ref (&(*f)->proc_tree);
3295 *f = gfc_get_finalizer ();
3296 (*f)->where = gfc_current_locus; /* Value should not matter. */
3299 mio_symtree_ref (&(*f)->proc_tree);
3300 (*f)->proc_sym = NULL;
3305 mio_f2k_derived (gfc_namespace *f2k)
3307 current_f2k_derived = f2k;
3309 /* Handle the list of finalizer procedures. */
3311 if (iomode == IO_OUTPUT)
3314 for (f = f2k->finalizers; f; f = f->next)
3319 f2k->finalizers = NULL;
3320 while (peek_atom () != ATOM_RPAREN)
3323 mio_finalizer (&cur);
3324 cur->next = f2k->finalizers;
3325 f2k->finalizers = cur;
3330 /* Handle type-bound procedures. */
3332 if (iomode == IO_OUTPUT)
3333 gfc_traverse_symtree (f2k->sym_root, &mio_typebound_symtree);
3336 while (peek_atom () == ATOM_LPAREN)
3342 require_atom (ATOM_STRING);
3343 gfc_get_sym_tree (atom_string, f2k, &st);
3344 gfc_free (atom_string);
3346 mio_typebound_symtree (st);
3353 mio_full_f2k_derived (gfc_symbol *sym)
3357 if (iomode == IO_OUTPUT)
3359 if (sym->f2k_derived)
3360 mio_f2k_derived (sym->f2k_derived);
3364 if (peek_atom () != ATOM_RPAREN)
3366 sym->f2k_derived = gfc_get_namespace (NULL, 0);
3367 mio_f2k_derived (sym->f2k_derived);
3370 gcc_assert (!sym->f2k_derived);
3377 /* Unlike most other routines, the address of the symbol node is already
3378 fixed on input and the name/module has already been filled in. */
3381 mio_symbol (gfc_symbol *sym)
3383 int intmod = INTMOD_NONE;
3385 gfc_formal_arglist *formal;
3389 mio_symbol_attribute (&sym->attr);
3390 mio_typespec (&sym->ts);
3392 /* Contained procedures don't have formal namespaces. Instead we output the
3393 procedure namespace. The will contain the formal arguments. */
3394 if (iomode == IO_OUTPUT)
3396 formal = sym->formal;
3397 while (formal && !formal->sym)
3398 formal = formal->next;
3401 mio_namespace_ref (&formal->sym->ns);
3403 mio_namespace_ref (&sym->formal_ns);
3407 mio_namespace_ref (&sym->formal_ns);
3410 sym->formal_ns->proc_name = sym;
3415 /* Save/restore common block links. */
3416 mio_symbol_ref (&sym->common_next);
3418 mio_formal_arglist (sym);
3420 if (sym->attr.flavor == FL_PARAMETER)
3421 mio_expr (&sym->value);
3423 mio_array_spec (&sym->as);
3425 mio_symbol_ref (&sym->result);
3427 if (sym->attr.cray_pointee)
3428 mio_symbol_ref (&sym->cp_pointer);
3430 /* Note that components are always saved, even if they are supposed
3431 to be private. Component access is checked during searching. */
3433 mio_component_list (&sym->components);
3435 if (sym->components != NULL)
3436 sym->component_access
3437 = MIO_NAME (gfc_access) (sym->component_access, access_types);
3439 /* Load/save the f2k_derived namespace of a derived-type symbol. */
3440 mio_full_f2k_derived (sym);
3444 /* Add the fields that say whether this is from an intrinsic module,
3445 and if so, what symbol it is within the module. */
3446 /* mio_integer (&(sym->from_intmod)); */
3447 if (iomode == IO_OUTPUT)
3449 intmod = sym->from_intmod;
3450 mio_integer (&intmod);
3454 mio_integer (&intmod);
3455 sym->from_intmod = intmod;
3458 mio_integer (&(sym->intmod_sym_id));
3464 /************************* Top level subroutines *************************/
3466 /* Given a root symtree node and a symbol, try to find a symtree that
3467 references the symbol that is not a unique name. */
3469 static gfc_symtree *
3470 find_symtree_for_symbol (gfc_symtree *st, gfc_symbol *sym)
3472 gfc_symtree *s = NULL;
3477 s = find_symtree_for_symbol (st->right, sym);
3480 s = find_symtree_for_symbol (st->left, sym);
3484 if (st->n.sym == sym && !check_unique_name (st->name))
3491 /* A recursive function to look for a specific symbol by name and by
3492 module. Whilst several symtrees might point to one symbol, its
3493 is sufficient for the purposes here than one exist. Note that
3494 generic interfaces are distinguished as are symbols that have been
3495 renamed in another module. */
3496 static gfc_symtree *
3497 find_symbol (gfc_symtree *st, const char *name,
3498 const char *module, int generic)
3501 gfc_symtree *retval, *s;
3503 if (st == NULL || st->n.sym == NULL)
3506 c = strcmp (name, st->n.sym->name);
3507 if (c == 0 && st->n.sym->module
3508 && strcmp (module, st->n.sym->module) == 0
3509 && !check_unique_name (st->name))
3511 s = gfc_find_symtree (gfc_current_ns->sym_root, name);
3513 /* Detect symbols that are renamed by use association in another
3514 module by the absence of a symtree and null attr.use_rename,
3515 since the latter is not transmitted in the module file. */
3516 if (((!generic && !st->n.sym->attr.generic)
3517 || (generic && st->n.sym->attr.generic))
3518 && !(s == NULL && !st->n.sym->attr.use_rename))
3522 retval = find_symbol (st->left, name, module, generic);
3525 retval = find_symbol (st->right, name, module, generic);
3531 /* Skip a list between balanced left and right parens. */
3541 switch (parse_atom ())
3552 gfc_free (atom_string);
3564 /* Load operator interfaces from the module. Interfaces are unusual
3565 in that they attach themselves to existing symbols. */
3568 load_operator_interfaces (void)
3571 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
3573 pointer_info *pi = NULL;
3578 while (peek_atom () != ATOM_RPAREN)
3582 mio_internal_string (name);
3583 mio_internal_string (module);
3585 n = number_use_names (name, true);
3588 for (i = 1; i <= n; i++)
3590 /* Decide if we need to load this one or not. */
3591 p = find_use_name_n (name, &i, true);
3595 while (parse_atom () != ATOM_RPAREN);
3601 uop = gfc_get_uop (p);
3602 pi = mio_interface_rest (&uop->op);
3606 if (gfc_find_uop (p, NULL))
3608 uop = gfc_get_uop (p);
3609 uop->op = gfc_get_interface ();
3610 uop->op->where = gfc_current_locus;
3611 add_fixup (pi->integer, &uop->op->sym);
3620 /* Load interfaces from the module. Interfaces are unusual in that
3621 they attach themselves to existing symbols. */
3624 load_generic_interfaces (void)
3627 char name[GFC_MAX_SYMBOL_LEN + 1], module[GFC_MAX_SYMBOL_LEN + 1];
3629 gfc_interface *generic = NULL;
3634 while (peek_atom () != ATOM_RPAREN)
3638 mio_internal_string (name);
3639 mio_internal_string (module);
3641 n = number_use_names (name, false);
3642 renamed = n ? 1 : 0;
3645 for (i = 1; i <= n; i++)
3648 /* Decide if we need to load this one or not. */
3649 p = find_use_name_n (name, &i, false);
3651 st = find_symbol (gfc_current_ns->sym_root,
3652 name, module_name, 1);
3654 if (!p || gfc_find_symbol (p, NULL, 0, &sym))
3656 /* Skip the specific names for these cases. */
3657 while (i == 1 && parse_atom () != ATOM_RPAREN);
3662 /* If the symbol exists already and is being USEd without being
3663 in an ONLY clause, do not load a new symtree(11.3.2). */
3664 if (!only_flag && st)
3669 /* Make the symbol inaccessible if it has been added by a USE
3670 statement without an ONLY(11.3.2). */
3672 && !st->n.sym->attr.use_only
3673 && !st->n.sym->attr.use_rename
3674 && strcmp (st->n.sym->module, module_name) == 0)
3677 gfc_delete_symtree (&gfc_current_ns->sym_root, name);
3678 st = gfc_get_unique_symtree (gfc_current_ns);
3685 if (strcmp (st->name, p) != 0)
3687 st = gfc_new_symtree (&gfc_current_ns->sym_root, p);
3693 /* Since we haven't found a valid generic interface, we had
3697 gfc_get_symbol (p, NULL, &sym);
3698 sym->name = gfc_get_string (name);
3699 sym->module = gfc_get_string (module_name);
3700 sym->attr.flavor = FL_PROCEDURE;
3701 sym->attr.generic = 1;
3702 sym->attr.use_assoc = 1;
3707 /* Unless sym is a generic interface, this reference
3710 st = gfc_find_symtree (gfc_current_ns->sym_root, p);
3714 if (st && !sym->attr.generic
3716 && strcmp(module, sym->module))
3720 sym->attr.use_only = only_flag;
3721 sym->attr.use_rename = renamed;
3725 mio_interface_rest (&sym->generic);
3726 generic = sym->generic;
3728 else if (!sym->generic)
3730 sym->generic = generic;
3731 sym->attr.generic_copy = 1;
3740 /* Load common blocks. */
3745 char name[GFC_MAX_SYMBOL_LEN + 1];