gcc/fortran/data.c

   1 /* Supporting functions for resolving DATA statement.
   2    Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   3    Contributed by Lifang Zeng <zlf605@hotmail.com>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 51 Franklin Street, Fifth Floor,Boston, MA
  20 02110-1301, USA.  */
  21
  22
  23 /* Notes for DATA statement implementation:
  24
  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.
  28
  29    The complexity exists in the handling of array section, implied do
  30    and array of struct appeared in DATA statement.
  31
  32    We call gfc_conv_structure, gfc_con_array_array_initializer,
  33    etc., to convert the initial value. Refer to trans-expr.c and
  34    trans-array.c.  */
  35
  36 #include "config.h"
  37 #include "gfortran.h"
  38
  39 static void formalize_init_expr (gfc_expr *);
  40
  41 /* Calculate the array element offset.  */
  42
  43 static void
  44 get_array_index (gfc_array_ref * ar, mpz_t * offset)
  45 {
  46   gfc_expr *e;
  47   int i;
  48   try re;
  49   mpz_t delta;
  50   mpz_t tmp;
  51
  52   mpz_init (tmp);
  53   mpz_set_si (*offset, 0);
  54   mpz_init_set_si (delta, 1);
  55   for (i = 0; i < ar->dimen; i++)
  56     {
  57       e = gfc_copy_expr (ar->start[i]);
  58       re = gfc_simplify_expr (e, 1);
  59
  60       if ((gfc_is_constant_expr (ar->as->lower[i]) == 0)
  61           || (gfc_is_constant_expr (ar->as->upper[i]) == 0)
  62           || (gfc_is_constant_expr (e) == 0))
  63         gfc_error ("non-constant array in DATA statement %L.", &ar->where);
  64       mpz_set (tmp, e->value.integer);
  65       mpz_sub (tmp, tmp, ar->as->lower[i]->value.integer);
  66       mpz_mul (tmp, tmp, delta);
  67       mpz_add (*offset, tmp, *offset);
  68
  69       mpz_sub (tmp, ar->as->upper[i]->value.integer,
  70       ar->as->lower[i]->value.integer);
  71       mpz_add_ui (tmp, tmp, 1);
  72       mpz_mul (delta, tmp, delta);
  73     }
  74   mpz_clear (delta);
  75   mpz_clear (tmp);
  76 }
  77
  78
  79 /* Find if there is a constructor which offset is equal to OFFSET.  */
  80
  81 static gfc_constructor *
  82 find_con_by_offset (mpz_t offset, gfc_constructor *con)
  83 {
  84   mpz_t tmp;
  85   gfc_constructor *ret = NULL;
  86
  87   mpz_init (tmp);
  88
  89   for (; con; con = con->next)
  90     {
  91       int cmp = mpz_cmp (offset, con->n.offset);
  92
  93       /* We retain a sorted list, so if we're too large, we're done.  */
  94       if (cmp < 0)
  95         break;
  96
  97       /* Yaye for exact matches.  */
  98       if (cmp == 0)
  99         {
 100           ret = con;
 101           break;
 102         }
 103
 104       /* If the constructor element is a range, match any element.  */
 105       if (mpz_cmp_ui (con->repeat, 1) > 0)
 106         {
 107           mpz_add (tmp, con->n.offset, con->repeat);
 108           if (mpz_cmp (offset, tmp) < 0)
 109             {
 110               ret = con;
 111               break;
 112             }
 113         }
 114     }
 115
 116   mpz_clear (tmp);
 117   return ret;
 118 }
 119
 120
 121 /* Find if there is a constructor which component is equal to COM.  */
 122
 123 static gfc_constructor *
 124 find_con_by_component (gfc_component *com, gfc_constructor *con)
 125 {
 126   for (; con; con = con->next)
 127     {
 128       if (com == con->n.component)
 129         return con;
 130     }
 131   return NULL;
 132 }
 133
 134
 135 /* Create a character type initialization expression from RVALUE.
 136    TS [and REF] describe [the substring of] the variable being initialized.
 137    INIT is thh existing initializer, not NULL.  Initialization is performed
 138    according to normal assignment rules.  */
 139
 140 static gfc_expr *
 141 create_character_intializer (gfc_expr * init, gfc_typespec * ts,
 142                              gfc_ref * ref, gfc_expr * rvalue)
 143 {
 144   int len;
 145   int start;
 146   int end;
 147   char *dest;
 148
 149   gfc_extract_int (ts->cl->length, &len);
 150
 151   if (init == NULL)
 152     {
 153       /* Create a new initializer.  */
 154       init = gfc_get_expr ();
 155       init->expr_type = EXPR_CONSTANT;
 156       init->ts = *ts;
 157
 158       dest = gfc_getmem (len);
 159       init->value.character.length = len;
 160       init->value.character.string = dest;
 161       /* Blank the string if we're only setting a substring.  */
 162       if (ref != NULL)
 163         memset (dest, ' ', len);
 164     }
 165   else
 166     dest = init->value.character.string;
 167
 168   if (ref)
 169     {
 170       gcc_assert (ref->type == REF_SUBSTRING);
 171
 172       /* Only set a substring of the destination.  Fortran substring bounds
 173          are one-based [start, end], we want zero based [start, end).  */
 174       gfc_extract_int (ref->u.ss.start, &start);
 175       start--;
 176       gfc_extract_int (ref->u.ss.end, &end);
 177     }
 178   else
 179     {
 180       /* Set the whole string.  */
 181       start = 0;
 182       end = len;
 183     }
 184
 185   /* Copy the initial value.  */
 186   len = rvalue->value.character.length;
 187   if (len > end - start)
 188     {
 189       len = end - start;
 190       gfc_warning_now ("initialization string truncated to match variable "
 191                        "at %L", &rvalue->where);
 192     }
 193
 194   memcpy (&dest[start], rvalue->value.character.string, len);
 195
 196   /* Pad with spaces.  Substrings will already be blanked.  */
 197   if (len < end - start && ref == NULL)
 198     memset (&dest[start + len], ' ', end - (start + len));
 199
 200   if (rvalue->ts.type == BT_HOLLERITH)
 201     init->from_H = 1;
 202
 203   return init;
 204 }
 205
 206 /* Assign the initial value RVALUE to  LVALUE's symbol->value. If the
 207    LVALUE already has an initialization, we extend this, otherwise we
 208    create a new one.  */
 209
 210 void
 211 gfc_assign_data_value (gfc_expr * lvalue, gfc_expr * rvalue, mpz_t index)
 212 {
 213   gfc_ref *ref;
 214   gfc_expr *init;
 215   gfc_expr *expr;
 216   gfc_constructor *con;
 217   gfc_constructor *last_con;
 218   gfc_symbol *symbol;
 219   gfc_typespec *last_ts;
 220   mpz_t offset;
 221
 222   symbol = lvalue->symtree->n.sym;
 223   init = symbol->value;
 224   last_ts = &symbol->ts;
 225   last_con = NULL;
 226   mpz_init_set_si (offset, 0);
 227
 228   /* Find/create the parent expressions for subobject references.  */
 229   for (ref = lvalue->ref; ref; ref = ref->next)
 230     {
 231       /* Break out of the loop if we find a substring.  */
 232       if (ref->type == REF_SUBSTRING)
 233         {
 234           /* A substring should always be the last subobject reference.  */
 235           gcc_assert (ref->next == NULL);
 236           break;
 237         }
 238
 239       /* Use the existing initializer expression if it exists.  Otherwise
 240          create a new one.  */
 241       if (init == NULL)
 242         expr = gfc_get_expr ();
 243       else
 244         expr = init;
 245
 246       /* Find or create this element.  */
 247       switch (ref->type)
 248         {
 249         case REF_ARRAY:
 250           if (init == NULL)
 251             {
 252               /* The element typespec will be the same as the array
 253                  typespec.  */
 254               expr->ts = *last_ts;
 255               /* Setup the expression to hold the constructor.  */
 256               expr->expr_type = EXPR_ARRAY;
 257               expr->rank = ref->u.ar.as->rank;
 258             }
 259           else
 260             gcc_assert (expr->expr_type == EXPR_ARRAY);
 261
 262           if (ref->u.ar.type == AR_ELEMENT)
 263             get_array_index (&ref->u.ar, &offset);
 264           else
 265             mpz_set (offset, index);
 266
 267           /* Find the same element in the existing constructor.  */
 268           con = expr->value.constructor;
 269           con = find_con_by_offset (offset, con);
 270
 271           if (con == NULL)
 272             {
 273               /* Create a new constructor.  */
 274               con = gfc_get_constructor ();
 275               mpz_set (con->n.offset, offset);
 276               gfc_insert_constructor (expr, con);
 277             }
 278           break;
 279
 280         case REF_COMPONENT:
 281           if (init == NULL)
 282             {
 283               /* Setup the expression to hold the constructor.  */
 284               expr->expr_type = EXPR_STRUCTURE;
 285               expr->ts.type = BT_DERIVED;
 286               expr->ts.derived = ref->u.c.sym;
 287             }
 288           else
 289             gcc_assert (expr->expr_type == EXPR_STRUCTURE);
 290           last_ts = &ref->u.c.component->ts;
 291
 292           /* Find the same element in the existing constructor.  */
 293           con = expr->value.constructor;
 294           con = find_con_by_component (ref->u.c.component, con);
 295
 296           if (con == NULL)
 297             {
 298               /* Create a new constructor.  */
 299               con = gfc_get_constructor ();
 300               con->n.component = ref->u.c.component;
 301               con->next = expr->value.constructor;
 302               expr->value.constructor = con;
 303             }
 304           break;
 305
 306         default:
 307           gcc_unreachable ();
 308         }
 309
 310       if (init == NULL)
 311         {
 312           /* Point the container at the new expression.  */
 313           if (last_con == NULL)
 314             symbol->value = expr;
 315           else
 316             last_con->expr = expr;
 317         }
 318       init = con->expr;
 319       last_con = con;
 320     }
 321
 322   if (ref || last_ts->type == BT_CHARACTER)
 323     expr = create_character_intializer (init, last_ts, ref, rvalue);
 324   else
 325     {
 326       /* Overwriting an existing initializer is non-standard but usually only
 327          provokes a warning from other compilers.  */
 328       if (init != NULL)
 329         {
 330           /* Order in which the expressions arrive here depends on whether they
 331              are from data statements or F95 style declarations. Therefore,
 332              check which is the most recent.  */
 333 #ifdef USE_MAPPED_LOCATION
 334           expr = (LOCATION_LINE (init->where.lb->location)
 335                   > LOCATION_LINE (rvalue->where.lb->location))
 336             ? init : rvalue;
 337 #else
 338           expr = (init->where.lb->linenum > rvalue->where.lb->linenum) ?
 339                     init : rvalue;
 340 #endif
 341           gfc_notify_std (GFC_STD_GNU, "Extension: re-initialization "
 342                           "of '%s' at %L",  symbol->name, &expr->where);
 343         }
 344
 345       expr = gfc_copy_expr (rvalue);
 346       if (!gfc_compare_types (&lvalue->ts, &expr->ts))
 347         gfc_convert_type (expr, &lvalue->ts, 0);
 348     }
 349
 350   if (last_con == NULL)
 351     symbol->value = expr;
 352   else
 353     last_con->expr = expr;
 354 }
 355
 356 /* Similarly, but initialize REPEAT consecutive values in LVALUE the same
 357    value in RVALUE.  For the nonce, LVALUE must refer to a full array, not
 358    an array section.  */
 359
 360 void
 361 gfc_assign_data_value_range (gfc_expr * lvalue, gfc_expr * rvalue,
 362                              mpz_t index, mpz_t repeat)
 363 {
 364   gfc_ref *ref;
 365   gfc_expr *init, *expr;
 366   gfc_constructor *con, *last_con;
 367   gfc_symbol *symbol;
 368   gfc_typespec *last_ts;
 369   mpz_t offset;
 370
 371   symbol = lvalue->symtree->n.sym;
 372   init = symbol->value;
 373   last_ts = &symbol->ts;
 374   last_con = NULL;
 375   mpz_init_set_si (offset, 0);
 376
 377   /* Find/create the parent expressions for subobject references.  */
 378   for (ref = lvalue->ref; ref; ref = ref->next)
 379     {
 380       /* Use the existing initializer expression if it exists.
 381          Otherwise create a new one.  */
 382       if (init == NULL)
 383         expr = gfc_get_expr ();
 384       else
 385         expr = init;
 386
 387       /* Find or create this element.  */
 388       switch (ref->type)
 389         {
 390         case REF_ARRAY:
 391           if (init == NULL)
 392             {
 393               /* The element typespec will be the same as the array
 394                  typespec.  */
 395               expr->ts = *last_ts;
 396               /* Setup the expression to hold the constructor.  */
 397               expr->expr_type = EXPR_ARRAY;
 398               expr->rank = ref->u.ar.as->rank;
 399             }
 400           else
 401             gcc_assert (expr->expr_type == EXPR_ARRAY);
 402
 403           if (ref->u.ar.type == AR_ELEMENT)
 404             {
 405               get_array_index (&ref->u.ar, &offset);
 406
 407               /* This had better not be the bottom of the reference.
 408                  We can still get to a full array via a component.  */
 409               gcc_assert (ref->next != NULL);
 410             }
 411           else
 412             {
 413               mpz_set (offset, index);
 414
 415               /* We're at a full array or an array section.  This means
 416                  that we've better have found a full array, and that we're
 417                  at the bottom of the reference.  */
 418               gcc_assert (ref->u.ar.type == AR_FULL);
 419               gcc_assert (ref->next == NULL);
 420             }
 421
 422           /* Find the same element in the existing constructor.  */
 423           con = expr->value.constructor;
 424           con = find_con_by_offset (offset, con);
 425
 426           /* Create a new constructor.  */
 427           if (con == NULL)
 428             {
 429               con = gfc_get_constructor ();
 430               mpz_set (con->n.offset, offset);
 431               if (ref->next == NULL)
 432                 mpz_set (con->repeat, repeat);
 433               gfc_insert_constructor (expr, con);
 434             }
 435           else
 436             gcc_assert (ref->next != NULL);
 437           break;
 438
 439         case REF_COMPONENT:
 440           if (init == NULL)
 441             {
 442               /* Setup the expression to hold the constructor.  */
 443               expr->expr_type = EXPR_STRUCTURE;
 444               expr->ts.type = BT_DERIVED;
 445               expr->ts.derived = ref->u.c.sym;
 446             }
 447           else
 448             gcc_assert (expr->expr_type == EXPR_STRUCTURE);
 449           last_ts = &ref->u.c.component->ts;
 450
 451           /* Find the same element in the existing constructor.  */
 452           con = expr->value.constructor;
 453           con = find_con_by_component (ref->u.c.component, con);
 454
 455           if (con == NULL)
 456             {
 457               /* Create a new constructor.  */
 458               con = gfc_get_constructor ();
 459               con->n.component = ref->u.c.component;
 460               con->next = expr->value.constructor;
 461               expr->value.constructor = con;
 462             }
 463
 464           /* Since we're only intending to initialize arrays here,
 465              there better be an inner reference.  */
 466           gcc_assert (ref->next != NULL);
 467           break;
 468
 469         case REF_SUBSTRING:
 470         default:
 471           gcc_unreachable ();
 472         }
 473
 474       if (init == NULL)
 475         {
 476           /* Point the container at the new expression.  */
 477           if (last_con == NULL)
 478             symbol->value = expr;
 479           else
 480             last_con->expr = expr;
 481         }
 482       init = con->expr;
 483       last_con = con;
 484     }
 485
 486   if (last_ts->type == BT_CHARACTER)
 487     expr = create_character_intializer (init, last_ts, NULL, rvalue);
 488   else
 489     {
 490       /* We should never be overwriting an existing initializer.  */
 491       gcc_assert (!init);
 492
 493       expr = gfc_copy_expr (rvalue);
 494       if (!gfc_compare_types (&lvalue->ts, &expr->ts))
 495         gfc_convert_type (expr, &lvalue->ts, 0);
 496     }
 497
 498   if (last_con == NULL)
 499     symbol->value = expr;
 500   else
 501     last_con->expr = expr;
 502 }
 503
 504 /* Modify the index of array section and re-calculate the array offset.  */
 505
 506 void
 507 gfc_advance_section (mpz_t *section_index, gfc_array_ref *ar,
 508                      mpz_t *offset_ret)
 509 {
 510   int i;
 511   mpz_t delta;
 512   mpz_t tmp;
 513   bool forwards;
 514   int cmp;
 515
 516   for (i = 0; i < ar->dimen; i++)
 517     {
 518       if (ar->dimen_type[i] != DIMEN_RANGE)
 519         continue;
 520
 521       if (ar->stride[i])
 522         {
 523           mpz_add (section_index[i], section_index[i],
 524                    ar->stride[i]->value.integer);
 525         if (mpz_cmp_si (ar->stride[i]->value.integer, 0) >= 0)
 526           forwards = true;
 527         else
 528           forwards = false;
 529         }
 530       else
 531         {
 532           mpz_add_ui (section_index[i], section_index[i], 1);
 533           forwards = true;
 534         }
 535
 536       if (ar->end[i])
 537         cmp = mpz_cmp (section_index[i], ar->end[i]->value.integer);
 538       else
 539         cmp = mpz_cmp (section_index[i], ar->as->upper[i]->value.integer);
 540
 541       if ((cmp > 0 && forwards)
 542           || (cmp < 0 && ! forwards))
 543         {
 544           /* Reset index to start, then loop to advance the next index.  */
 545           if (ar->start[i])
 546             mpz_set (section_index[i], ar->start[i]->value.integer);
 547           else
 548             mpz_set (section_index[i], ar->as->lower[i]->value.integer);
 549         }
 550       else
 551         break;
 552     }
 553
 554   mpz_set_si (*offset_ret, 0);
 555   mpz_init_set_si (delta, 1);
 556   mpz_init (tmp);
 557   for (i = 0; i < ar->dimen; i++)
 558     {
 559       mpz_sub (tmp, section_index[i], ar->as->lower[i]->value.integer);
 560       mpz_mul (tmp, tmp, delta);
 561       mpz_add (*offset_ret, tmp, *offset_ret);
 562
 563       mpz_sub (tmp, ar->as->upper[i]->value.integer,
 564                ar->as->lower[i]->value.integer);
 565       mpz_add_ui (tmp, tmp, 1);
 566       mpz_mul (delta, tmp, delta);
 567     }
 568   mpz_clear (tmp);
 569   mpz_clear (delta);
 570 }
 571
 572
 573 /* Rearrange a structure constructor so the elements are in the specified
 574    order.  Also insert NULL entries if necessary.  */
 575
 576 static void
 577 formalize_structure_cons (gfc_expr * expr)
 578 {
 579   gfc_constructor *head;
 580   gfc_constructor *tail;
 581   gfc_constructor *cur;
 582   gfc_constructor *last;
 583   gfc_constructor *c;
 584   gfc_component *order;
 585
 586   c = expr->value.constructor;
 587
 588   /* Constructor is already formalized.  */
 589   if (c->n.component == NULL)
 590     return;
 591
 592   head = tail = NULL;
 593   for (order = expr->ts.derived->components; order; order = order->next)
 594     {
 595       /* Find the next component.  */
 596       last = NULL;
 597       cur = c;
 598       while (cur != NULL && cur->n.component != order)
 599         {
 600           last = cur;
 601           cur = cur->next;
 602         }
 603
 604       if (cur == NULL)
 605         {
 606           /* Create a new one.  */
 607           cur = gfc_get_constructor ();
 608         }
 609       else
 610         {
 611           /* Remove it from the chain.  */
 612           if (last == NULL)
 613             c = cur->next;
 614           else
 615             last->next = cur->next;
 616           cur->next = NULL;
 617
 618           formalize_init_expr (cur->expr);
 619         }
 620
 621       /* Add it to the new constructor.  */
 622       if (head == NULL)
 623         head = tail = cur;
 624       else
 625         {
 626           tail->next = cur;
 627           tail = tail->next;
 628         }
 629     }
 630   gcc_assert (c == NULL);
 631   expr->value.constructor = head;
 632 }
 633
 634
 635 /* Make sure an initialization expression is in normalized form.  Ie. all
 636    elements of the constructors are in the correct order.  */
 637
 638 static void
 639 formalize_init_expr (gfc_expr * expr)
 640 {
 641   expr_t type;
 642   gfc_constructor *c;
 643
 644   if (expr == NULL)
 645     return;
 646
 647   type = expr->expr_type;
 648   switch (type)
 649     {
 650     case EXPR_ARRAY:
 651       c = expr->value.constructor;
 652       while (c)
 653         {
 654           formalize_init_expr (c->expr);
 655           c = c->next;
 656         }
 657       break;
 658
 659     case EXPR_STRUCTURE:
 660       formalize_structure_cons (expr);
 661       break;
 662
 663     default:
 664       break;
 665     }
 666 }
 667
 668
 669 /* Resolve symbol's initial value after all data statement.  */
 670
 671 void
 672 gfc_formalize_init_value (gfc_symbol *sym)
 673 {
 674   formalize_init_expr (sym->value);
 675 }
 676
 677
 678 /* Get the integer value into RET_AS and SECTION from AS and AR, and return
 679    offset.  */
 680
 681 void
 682 gfc_get_section_index (gfc_array_ref *ar, mpz_t *section_index, mpz_t *offset)
 683 {
 684   int i;
 685   mpz_t delta;
 686   mpz_t tmp;
 687
 688   mpz_set_si (*offset, 0);
 689   mpz_init (tmp);
 690   mpz_init_set_si (delta, 1);
 691   for (i = 0; i < ar->dimen; i++)
 692     {
 693       mpz_init (section_index[i]);
 694       switch (ar->dimen_type[i])
 695         {
 696         case DIMEN_ELEMENT:
 697         case DIMEN_RANGE:
 698           if (ar->start[i])
 699             {
 700               mpz_sub (tmp, ar->start[i]->value.integer,
 701                        ar->as->lower[i]->value.integer);
 702               mpz_mul (tmp, tmp, delta);
 703               mpz_add (*offset, tmp, *offset);
 704               mpz_set (section_index[i], ar->start[i]->value.integer);
 705             }
 706           else
 707               mpz_set (section_index[i], ar->as->lower[i]->value.integer);
 708           break;
 709
 710         case DIMEN_VECTOR:
 711           gfc_internal_error ("TODO: Vector sections in data statements");
 712
 713         default:
 714           gcc_unreachable ();
 715         }
 716
 717       mpz_sub (tmp, ar->as->upper[i]->value.integer,
 718                ar->as->lower[i]->value.integer);
 719       mpz_add_ui (tmp, tmp, 1);
 720       mpz_mul (delta, tmp, delta);
 721     }
 722
 723   mpz_clear (tmp);
 724   mpz_clear (delta);
 725 }
 726