1 /* Supporting functions for resolving DATA statement.
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
3 Free Software Foundation, Inc.
4 Contributed by Lifang Zeng <zlf605@hotmail.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
23 /* Notes for DATA statement implementation:
25 We first assign initial value to each symbol by gfc_assign_data_value
26 during resolveing DATA statement. Refer to check_data_variable and
27 traverse_data_list in resolve.c.
29 The complexity exists in the handling of array section, implied do
30 and array of struct appeared in DATA statement.
32 We call gfc_conv_structure, gfc_con_array_array_initializer,
33 etc., to convert the initial value. Refer to trans-expr.c and
40 static void formalize_init_expr (gfc_expr *);
42 /* Calculate the array element offset. */
45 get_array_index (gfc_array_ref *ar, mpz_t *offset)
54 mpz_set_si (*offset, 0);
55 mpz_init_set_si (delta, 1);
56 for (i = 0; i < ar->dimen; i++)
58 e = gfc_copy_expr (ar->start[i]);
59 re = gfc_simplify_expr (e, 1);
61 if ((gfc_is_constant_expr (ar->as->lower[i]) == 0)
62 || (gfc_is_constant_expr (ar->as->upper[i]) == 0)
63 || (gfc_is_constant_expr (e) == 0))
64 gfc_error ("non-constant array in DATA statement %L", &ar->where);
66 mpz_set (tmp, e->value.integer);
67 mpz_sub (tmp, tmp, ar->as->lower[i]->value.integer);
68 mpz_mul (tmp, tmp, delta);
69 mpz_add (*offset, tmp, *offset);
71 mpz_sub (tmp, ar->as->upper[i]->value.integer,
72 ar->as->lower[i]->value.integer);
73 mpz_add_ui (tmp, tmp, 1);
74 mpz_mul (delta, tmp, delta);
81 /* Find if there is a constructor which offset is equal to OFFSET. */
83 static gfc_constructor *
84 find_con_by_offset (splay_tree spt, mpz_t offset)
87 gfc_constructor *ret = NULL;
91 /* The complexity is due to needing quick access to the linked list of
92 constructors. Both a linked list and a splay tree are used, and both
93 are kept up to date if they are array elements (which is the only time
94 that a specific constructor has to be found). */
96 gcc_assert (spt != NULL);
99 sptn = splay_tree_lookup (spt, (splay_tree_key) mpz_get_si (offset));
102 ret = (gfc_constructor*) sptn->value;
105 /* Need to check and see if we match a range, so we will pull
106 the next lowest index and see if the range matches. */
107 sptn = splay_tree_predecessor (spt,
108 (splay_tree_key) mpz_get_si (offset));
111 con = (gfc_constructor*) sptn->value;
112 if (mpz_cmp_ui (con->repeat, 1) > 0)
115 mpz_add (tmp, con->n.offset, con->repeat);
116 if (mpz_cmp (offset, tmp) < 0)
121 ret = NULL; /* The range did not match. */
124 ret = NULL; /* No pred, so no match. */
131 /* Find if there is a constructor which component is equal to COM. */
133 static gfc_constructor *
134 find_con_by_component (gfc_component *com, gfc_constructor *con)
136 for (; con; con = con->next)
138 if (com == con->n.component)
145 /* Create a character type initialization expression from RVALUE.
146 TS [and REF] describe [the substring of] the variable being initialized.
147 INIT is thh existing initializer, not NULL. Initialization is performed
148 according to normal assignment rules. */
151 create_character_intializer (gfc_expr *init, gfc_typespec *ts,
152 gfc_ref *ref, gfc_expr *rvalue)
157 char *dest, *rvalue_string;
159 gfc_extract_int (ts->cl->length, &len);
163 /* Create a new initializer. */
164 init = gfc_get_expr ();
165 init->expr_type = EXPR_CONSTANT;
168 dest = gfc_getmem (len + 1);
170 init->value.character.length = len;
171 init->value.character.string = dest;
172 /* Blank the string if we're only setting a substring. */
174 memset (dest, ' ', len);
177 dest = init->value.character.string;
181 gfc_expr *start_expr, *end_expr;
183 gcc_assert (ref->type == REF_SUBSTRING);
185 /* Only set a substring of the destination. Fortran substring bounds
186 are one-based [start, end], we want zero based [start, end). */
187 start_expr = gfc_copy_expr (ref->u.ss.start);
188 end_expr = gfc_copy_expr (ref->u.ss.end);
190 if ((gfc_simplify_expr (start_expr, 1) == FAILURE)
191 || (gfc_simplify_expr (end_expr, 1)) == FAILURE)
193 gfc_error ("failure to simplify substring reference in DATA "
194 "statement at %L", &ref->u.ss.start->where);
198 gfc_extract_int (start_expr, &start);
200 gfc_extract_int (end_expr, &end);
204 /* Set the whole string. */
209 /* Copy the initial value. */
210 if (rvalue->ts.type == BT_HOLLERITH)
212 len = rvalue->representation.length;
213 rvalue_string = rvalue->representation.string;
217 len = rvalue->value.character.length;
218 rvalue_string = rvalue->value.character.string;
221 if (len > end - start)
224 gfc_warning_now ("initialization string truncated to match variable "
225 "at %L", &rvalue->where);
228 memcpy (&dest[start], rvalue_string, len);
230 /* Pad with spaces. Substrings will already be blanked. */
231 if (len < end - start && ref == NULL)
232 memset (&dest[start + len], ' ', end - (start + len));
234 if (rvalue->ts.type == BT_HOLLERITH)
236 init->representation.length = init->value.character.length;
237 init->representation.string = init->value.character.string;
244 /* Assign the initial value RVALUE to LVALUE's symbol->value. If the
245 LVALUE already has an initialization, we extend this, otherwise we
249 gfc_assign_data_value (gfc_expr *lvalue, gfc_expr *rvalue, mpz_t index)
254 gfc_constructor *con;
255 gfc_constructor *last_con;
256 gfc_constructor *pred;
258 gfc_typespec *last_ts;
261 splay_tree_node sptn;
263 symbol = lvalue->symtree->n.sym;
264 init = symbol->value;
265 last_ts = &symbol->ts;
267 mpz_init_set_si (offset, 0);
269 /* Find/create the parent expressions for subobject references. */
270 for (ref = lvalue->ref; ref; ref = ref->next)
272 /* Break out of the loop if we find a substring. */
273 if (ref->type == REF_SUBSTRING)
275 /* A substring should always be the last subobject reference. */
276 gcc_assert (ref->next == NULL);
280 /* Use the existing initializer expression if it exists. Otherwise
283 expr = gfc_get_expr ();
287 /* Find or create this element. */
291 if (init && expr->expr_type != EXPR_ARRAY)
293 gfc_error ("'%s' at %L already is initialized at %L",
294 lvalue->symtree->n.sym->name, &lvalue->where,
301 /* The element typespec will be the same as the array
304 /* Setup the expression to hold the constructor. */
305 expr->expr_type = EXPR_ARRAY;
306 expr->rank = ref->u.ar.as->rank;
309 if (ref->u.ar.type == AR_ELEMENT)
310 get_array_index (&ref->u.ar, &offset);
312 mpz_set (offset, index);
314 /* Check the bounds. */
315 if (mpz_cmp_si (offset, 0) < 0)
317 gfc_error ("Data element below array lower bound at %L",
324 if (spec_size (ref->u.ar.as, &size) == SUCCESS)
326 if (mpz_cmp (offset, size) >= 0)
329 gfc_error ("Data element above array upper bound at %L",
337 /* Splay tree containing offset and gfc_constructor. */
338 spt = expr->con_by_offset;
342 spt = splay_tree_new (splay_tree_compare_ints, NULL, NULL);
343 expr->con_by_offset = spt;
347 con = find_con_by_offset (spt, offset);
353 /* Create a new constructor. */
354 con = gfc_get_constructor ();
355 mpz_set (con->n.offset, offset);
356 j = (splay_tree_key) mpz_get_si (offset);
357 sptn = splay_tree_insert (spt, j, (splay_tree_value) con);
358 /* Fix up the linked list. */
359 sptn = splay_tree_predecessor (spt, j);
361 { /* Insert at the head. */
362 con->next = expr->value.constructor;
363 expr->value.constructor = con;
366 { /* Insert in the chain. */
367 pred = (gfc_constructor*) sptn->value;
368 con->next = pred->next;
377 /* Setup the expression to hold the constructor. */
378 expr->expr_type = EXPR_STRUCTURE;
379 expr->ts.type = BT_DERIVED;
380 expr->ts.derived = ref->u.c.sym;
383 gcc_assert (expr->expr_type == EXPR_STRUCTURE);
384 last_ts = &ref->u.c.component->ts;
386 /* Find the same element in the existing constructor. */
387 con = expr->value.constructor;
388 con = find_con_by_component (ref->u.c.component, con);
392 /* Create a new constructor. */
393 con = gfc_get_constructor ();
394 con->n.component = ref->u.c.component;
395 con->next = expr->value.constructor;
396 expr->value.constructor = con;
406 /* Point the container at the new expression. */
407 if (last_con == NULL)
408 symbol->value = expr;
410 last_con->expr = expr;
416 if (ref || last_ts->type == BT_CHARACTER)
417 expr = create_character_intializer (init, last_ts, ref, rvalue);
420 /* Overwriting an existing initializer is non-standard but usually only
421 provokes a warning from other compilers. */
424 /* Order in which the expressions arrive here depends on whether
425 they are from data statements or F95 style declarations.
426 Therefore, check which is the most recent. */
427 expr = (LOCATION_LINE (init->where.lb->location)
428 > LOCATION_LINE (rvalue->where.lb->location))
430 gfc_notify_std (GFC_STD_GNU, "Extension: re-initialization "
431 "of '%s' at %L", symbol->name, &expr->where);
434 expr = gfc_copy_expr (rvalue);
435 if (!gfc_compare_types (&lvalue->ts, &expr->ts))
436 gfc_convert_type (expr, &lvalue->ts, 0);
439 if (last_con == NULL)
440 symbol->value = expr;
442 last_con->expr = expr;
448 /* Similarly, but initialize REPEAT consecutive values in LVALUE the same
449 value in RVALUE. For the nonce, LVALUE must refer to a full array, not
453 gfc_assign_data_value_range (gfc_expr *lvalue, gfc_expr *rvalue,
454 mpz_t index, mpz_t repeat)
457 gfc_expr *init, *expr;
458 gfc_constructor *con, *last_con;
459 gfc_constructor *pred;
461 gfc_typespec *last_ts;
464 splay_tree_node sptn;
466 symbol = lvalue->symtree->n.sym;
467 init = symbol->value;
468 last_ts = &symbol->ts;
470 mpz_init_set_si (offset, 0);
472 /* Find/create the parent expressions for subobject references. */
473 for (ref = lvalue->ref; ref; ref = ref->next)
475 /* Use the existing initializer expression if it exists.
476 Otherwise create a new one. */
478 expr = gfc_get_expr ();
482 /* Find or create this element. */
488 /* The element typespec will be the same as the array
491 /* Setup the expression to hold the constructor. */
492 expr->expr_type = EXPR_ARRAY;
493 expr->rank = ref->u.ar.as->rank;
496 gcc_assert (expr->expr_type == EXPR_ARRAY);
498 if (ref->u.ar.type == AR_ELEMENT)
500 get_array_index (&ref->u.ar, &offset);
502 /* This had better not be the bottom of the reference.
503 We can still get to a full array via a component. */
504 gcc_assert (ref->next != NULL);
508 mpz_set (offset, index);
510 /* We're at a full array or an array section. This means
511 that we've better have found a full array, and that we're
512 at the bottom of the reference. */
513 gcc_assert (ref->u.ar.type == AR_FULL);
514 gcc_assert (ref->next == NULL);
517 /* Find the same element in the existing constructor. */
519 /* Splay tree containing offset and gfc_constructor. */
520 spt = expr->con_by_offset;
524 spt = splay_tree_new (splay_tree_compare_ints, NULL, NULL);
525 expr->con_by_offset = spt;
529 con = find_con_by_offset (spt, offset);
534 /* Create a new constructor. */
535 con = gfc_get_constructor ();
536 mpz_set (con->n.offset, offset);
537 j = (splay_tree_key) mpz_get_si (offset);
539 if (ref->next == NULL)
540 mpz_set (con->repeat, repeat);
541 sptn = splay_tree_insert (spt, j, (splay_tree_value) con);
542 /* Fix up the linked list. */
543 sptn = splay_tree_predecessor (spt, j);
545 { /* Insert at the head. */
546 con->next = expr->value.constructor;
547 expr->value.constructor = con;
550 { /* Insert in the chain. */
551 pred = (gfc_constructor*) sptn->value;
552 con->next = pred->next;
557 gcc_assert (ref->next != NULL);
563 /* Setup the expression to hold the constructor. */
564 expr->expr_type = EXPR_STRUCTURE;
565 expr->ts.type = BT_DERIVED;
566 expr->ts.derived = ref->u.c.sym;
569 gcc_assert (expr->expr_type == EXPR_STRUCTURE);
570 last_ts = &ref->u.c.component->ts;
572 /* Find the same element in the existing constructor. */
573 con = expr->value.constructor;
574 con = find_con_by_component (ref->u.c.component, con);
578 /* Create a new constructor. */
579 con = gfc_get_constructor ();
580 con->n.component = ref->u.c.component;
581 con->next = expr->value.constructor;
582 expr->value.constructor = con;
585 /* Since we're only intending to initialize arrays here,
586 there better be an inner reference. */
587 gcc_assert (ref->next != NULL);
597 /* Point the container at the new expression. */
598 if (last_con == NULL)
599 symbol->value = expr;
601 last_con->expr = expr;
607 if (last_ts->type == BT_CHARACTER)
608 expr = create_character_intializer (init, last_ts, NULL, rvalue);
611 /* We should never be overwriting an existing initializer. */
614 expr = gfc_copy_expr (rvalue);
615 if (!gfc_compare_types (&lvalue->ts, &expr->ts))
616 gfc_convert_type (expr, &lvalue->ts, 0);
619 if (last_con == NULL)
620 symbol->value = expr;
622 last_con->expr = expr;
625 /* Modify the index of array section and re-calculate the array offset. */
628 gfc_advance_section (mpz_t *section_index, gfc_array_ref *ar,
637 for (i = 0; i < ar->dimen; i++)
639 if (ar->dimen_type[i] != DIMEN_RANGE)
644 mpz_add (section_index[i], section_index[i],
645 ar->stride[i]->value.integer);
646 if (mpz_cmp_si (ar->stride[i]->value.integer, 0) >= 0)
653 mpz_add_ui (section_index[i], section_index[i], 1);
658 cmp = mpz_cmp (section_index[i], ar->end[i]->value.integer);
660 cmp = mpz_cmp (section_index[i], ar->as->upper[i]->value.integer);
662 if ((cmp > 0 && forwards) || (cmp < 0 && !forwards))
664 /* Reset index to start, then loop to advance the next index. */
666 mpz_set (section_index[i], ar->start[i]->value.integer);
668 mpz_set (section_index[i], ar->as->lower[i]->value.integer);
674 mpz_set_si (*offset_ret, 0);
675 mpz_init_set_si (delta, 1);
677 for (i = 0; i < ar->dimen; i++)
679 mpz_sub (tmp, section_index[i], ar->as->lower[i]->value.integer);
680 mpz_mul (tmp, tmp, delta);
681 mpz_add (*offset_ret, tmp, *offset_ret);
683 mpz_sub (tmp, ar->as->upper[i]->value.integer,
684 ar->as->lower[i]->value.integer);
685 mpz_add_ui (tmp, tmp, 1);
686 mpz_mul (delta, tmp, delta);
693 /* Rearrange a structure constructor so the elements are in the specified
694 order. Also insert NULL entries if necessary. */
697 formalize_structure_cons (gfc_expr *expr)
699 gfc_constructor *head;
700 gfc_constructor *tail;
701 gfc_constructor *cur;
702 gfc_constructor *last;
704 gfc_component *order;
706 c = expr->value.constructor;
708 /* Constructor is already formalized. */
709 if (!c || c->n.component == NULL)
713 for (order = expr->ts.derived->components; order; order = order->next)
715 /* Find the next component. */
718 while (cur != NULL && cur->n.component != order)
726 /* Create a new one. */
727 cur = gfc_get_constructor ();
731 /* Remove it from the chain. */
735 last->next = cur->next;
738 formalize_init_expr (cur->expr);
741 /* Add it to the new constructor. */
750 gcc_assert (c == NULL);
751 expr->value.constructor = head;
755 /* Make sure an initialization expression is in normalized form. Ie. all
756 elements of the constructors are in the correct order. */
759 formalize_init_expr (gfc_expr *expr)
767 type = expr->expr_type;
771 c = expr->value.constructor;
774 formalize_init_expr (c->expr);
780 formalize_structure_cons (expr);
789 /* Resolve symbol's initial value after all data statement. */
792 gfc_formalize_init_value (gfc_symbol *sym)
794 formalize_init_expr (sym->value);
798 /* Get the integer value into RET_AS and SECTION from AS and AR, and return
802 gfc_get_section_index (gfc_array_ref *ar, mpz_t *section_index, mpz_t *offset)
808 mpz_set_si (*offset, 0);
810 mpz_init_set_si (delta, 1);
811 for (i = 0; i < ar->dimen; i++)
813 mpz_init (section_index[i]);
814 switch (ar->dimen_type[i])
820 mpz_sub (tmp, ar->start[i]->value.integer,
821 ar->as->lower[i]->value.integer);
822 mpz_mul (tmp, tmp, delta);
823 mpz_add (*offset, tmp, *offset);
824 mpz_set (section_index[i], ar->start[i]->value.integer);
827 mpz_set (section_index[i], ar->as->lower[i]->value.integer);
831 gfc_internal_error ("TODO: Vector sections in data statements");
837 mpz_sub (tmp, ar->as->upper[i]->value.integer,
838 ar->as->lower[i]->value.integer);
839 mpz_add_ui (tmp, tmp, 1);
840 mpz_mul (delta, tmp, delta);