gcc/fortran/cpp.c

   1 /* Copyright (C) 2008, 2009 Free Software Foundation, Inc.
   2
   3 This file is part of GCC.
   4
   5 GCC is free software; you can redistribute it and/or modify it under
   6 the terms of the GNU General Public License as published by the Free
   7 Software Foundation; either version 3, or (at your option) any later
   8 version.
   9
  10 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  11 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13 for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with GCC; see the file COPYING3.  If not see
  17 <http://www.gnu.org/licenses/>.  */
  18
  19 #include "config.h"
  20 #include "system.h"
  21 #include "coretypes.h"
  22 #include "tm.h"
  23 #include "tree.h"
  24 #include "version.h"
  25 #include "flags.h"
  26
  27
  28 #include "options.h"
  29 #include "gfortran.h"
  30 #include "tm_p.h"               /* Target prototypes.  */
  31 #include "target.h"
  32 #include "toplev.h"
  33 #include "diagnostic.h"
  34
  35 #include "../../libcpp/internal.h"
  36 #include "cpp.h"
  37 #include "incpath.h"
  38
  39 #ifndef TARGET_OS_CPP_BUILTINS
  40 # define TARGET_OS_CPP_BUILTINS()
  41 #endif
  42
  43 #ifndef TARGET_OBJFMT_CPP_BUILTINS
  44 # define TARGET_OBJFMT_CPP_BUILTINS()
  45 #endif
  46
  47
  48 /* Holds switches parsed by gfc_cpp_handle_option (), but whose
  49    handling is deferred to gfc_cpp_init ().  */
  50 typedef struct
  51 {
  52     enum opt_code code;
  53     const char *arg;
  54 }
  55 gfc_cpp_deferred_opt_t;
  56
  57
  58 /* Defined and undefined macros being queued for output with -dU at
  59    the next newline.  */
  60 typedef struct gfc_cpp_macro_queue
  61 {
  62   struct gfc_cpp_macro_queue *next;     /* Next macro in the list.  */
  63   char *macro;                          /* The name of the macro if not
  64                                            defined, the full definition if
  65                                            defined.  */
  66 } gfc_cpp_macro_queue;
  67 static gfc_cpp_macro_queue *cpp_define_queue, *cpp_undefine_queue;
  68
  69 struct gfc_cpp_option_data
  70 {
  71   /* Argument of -cpp, implied by SPEC;
  72      if NULL, preprocessing disabled.  */
  73   const char *temporary_filename;
  74
  75   const char *output_filename;          /* -o <arg>  */
  76   int preprocess_only;                  /* -E  */
  77   int discard_comments;                 /* -C  */
  78   int discard_comments_in_macro_exp;    /* -CC  */
  79   int print_include_names;              /* -H  */
  80   int no_line_commands;                 /* -P  */
  81   char dump_macros;                     /* -d[DMNU]  */
  82   int dump_includes;                    /* -dI  */
  83   int working_directory;                /* -fworking-directory  */
  84   int no_predefined;                    /* -undef */
  85   int standard_include_paths;           /* -nostdinc */
  86   int verbose;                          /* -v */
  87
  88   const char *multilib;                 /* -imultilib <dir>  */
  89   const char *prefix;                   /* -iprefix <dir>  */
  90   const char *sysroot;                  /* -isysroot <dir>  */
  91
  92   /* Options whose handling needs to be deferred until the
  93      appropriate cpp-objects are created:
  94       -A predicate=answer
  95       -D <macro>[=<val>]
  96       -U <macro>  */
  97   gfc_cpp_deferred_opt_t *deferred_opt;
  98   int deferred_opt_count;
  99 }
 100 gfc_cpp_option;
 101
 102 /* Structures used with libcpp:  */
 103 static cpp_options *cpp_option = NULL;
 104 static cpp_reader *cpp_in = NULL;
 105
 106 /* Defined in toplev.c.  */
 107 extern const char *asm_file_name;
 108
 109
 110
 111
 112 /* Encapsulates state used to convert a stream of cpp-tokens into
 113    a text file.  */
 114 static struct
 115 {
 116   FILE *outf;                   /* Stream to write to.  */
 117   const cpp_token *prev;        /* Previous token.  */
 118   const cpp_token *source;      /* Source token for spacing.  */
 119   int src_line;                 /* Line number currently being written.  */
 120   unsigned char printed;        /* Nonzero if something output at line.  */
 121   bool first_time;              /* cb_file_change hasn't been called yet.  */
 122 } print;
 123
 124 /* General output routines.  */
 125 static void scan_translation_unit (cpp_reader *);
 126 static void scan_translation_unit_trad (cpp_reader *);
 127
 128 /* Callback routines for the parser. Most of these are active only
 129    in specific modes.  */
 130 static void cb_file_change (cpp_reader *, const struct line_map *);
 131 static void cb_line_change (cpp_reader *, const cpp_token *, int);
 132 static void cb_define (cpp_reader *, source_location, cpp_hashnode *);
 133 static void cb_undef (cpp_reader *, source_location, cpp_hashnode *);
 134 static void cb_def_pragma (cpp_reader *, source_location);
 135 static void cb_include (cpp_reader *, source_location, const unsigned char *,
 136                         const char *, int, const cpp_token **);
 137 static void cb_ident (cpp_reader *, source_location, const cpp_string *);
 138 static void cb_used_define (cpp_reader *, source_location, cpp_hashnode *);
 139 static void cb_used_undef (cpp_reader *, source_location, cpp_hashnode *);
 140 static bool cb_cpp_error (cpp_reader *, int, int, location_t, unsigned int,
 141                           const char *, va_list *)
 142      ATTRIBUTE_GCC_DIAG(6,0);
 143 void pp_dir_change (cpp_reader *, const char *);
 144
 145 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
 146 static void dump_queued_macros (cpp_reader *);
 147
 148
 149 static void
 150 cpp_define_builtins (cpp_reader *pfile)
 151 {
 152   int major, minor, patchlevel;
 153
 154   /* Initialize CPP built-ins; '1' corresponds to 'flag_hosted'
 155      in C, defines __STDC_HOSTED__?!  */
 156   cpp_init_builtins (pfile, 0);
 157
 158   /* Initialize GFORTRAN specific builtins.
 159      These are documented.  */
 160   if (sscanf (BASEVER, "%d.%d.%d", &major, &minor, &patchlevel) != 3)
 161     {
 162       sscanf (BASEVER, "%d.%d", &major, &minor);
 163       patchlevel = 0;
 164     }
 165   cpp_define_formatted (pfile, "__GNUC__=%d", major);
 166   cpp_define_formatted (pfile, "__GNUC_MINOR__=%d", minor);
 167   cpp_define_formatted (pfile, "__GNUC_PATCHLEVEL__=%d", patchlevel);
 168
 169   cpp_define (pfile, "__GFORTRAN__=1");
 170   cpp_define (pfile, "_LANGUAGE_FORTRAN=1");
 171
 172   if (gfc_option.flag_openmp)
 173     cpp_define (pfile, "_OPENMP=200805");
 174
 175
 176   /* More builtins that might be useful, but are not documented
 177      (in no particular order).  */
 178   cpp_define_formatted (pfile, "__VERSION__=\"%s\"", version_string);
 179
 180   if (flag_pic)
 181     {
 182       cpp_define_formatted (pfile, "__pic__=%d", flag_pic);
 183       cpp_define_formatted (pfile, "__PIC__=%d", flag_pic);
 184     }
 185   if (flag_pie)
 186     {
 187       cpp_define_formatted (pfile, "__pie__=%d", flag_pie);
 188       cpp_define_formatted (pfile, "__PIE__=%d", flag_pie);
 189     }
 190
 191   if (optimize_size)
 192     cpp_define (pfile, "__OPTIMIZE_SIZE__");
 193   if (optimize)
 194     cpp_define (pfile, "__OPTIMIZE__");
 195
 196   if (fast_math_flags_set_p ())
 197     cpp_define (pfile, "__FAST_MATH__");
 198   if (flag_signaling_nans)
 199     cpp_define (pfile, "__SUPPORT_SNAN__");
 200
 201   cpp_define_formatted (pfile, "__FINITE_MATH_ONLY__=%d", flag_finite_math_only);
 202
 203   /* Definitions for LP64 model. */
 204   if (TYPE_PRECISION (long_integer_type_node) == 64
 205       && POINTER_SIZE == 64
 206       && TYPE_PRECISION (integer_type_node) == 32)
 207     {
 208       cpp_define (pfile, "_LP64");
 209       cpp_define (pfile, "__LP64__");
 210     }
 211
 212   /* Define NAME with value TYPE size_unit.
 213      The C-side also defines __SIZEOF_WCHAR_T__, __SIZEOF_WINT_T__
 214      __SIZEOF_PTRDIFF_T__, however, fortran seems to lack the
 215      appropriate type nodes.  */
 216
 217 #define define_type_sizeof(NAME, TYPE)                             \
 218     cpp_define_formatted (pfile, NAME"="HOST_WIDE_INT_PRINT_DEC,   \
 219                           tree_low_cst (TYPE_SIZE_UNIT (TYPE), 1))
 220
 221   define_type_sizeof ("__SIZEOF_INT__", integer_type_node);
 222   define_type_sizeof ("__SIZEOF_LONG__", long_integer_type_node);
 223   define_type_sizeof ("__SIZEOF_LONG_LONG__", long_long_integer_type_node);
 224   define_type_sizeof ("__SIZEOF_SHORT__", short_integer_type_node);
 225   define_type_sizeof ("__SIZEOF_FLOAT__", float_type_node);
 226   define_type_sizeof ("__SIZEOF_DOUBLE__", double_type_node);
 227   define_type_sizeof ("__SIZEOF_LONG_DOUBLE__", long_double_type_node);
 228   define_type_sizeof ("__SIZEOF_SIZE_T__", size_type_node);
 229
 230 #undef define_type_sizeof
 231
 232   /* The defines below are necessary for the TARGET_* macros.
 233
 234      FIXME:  Note that builtin_define_std() actually is a function
 235      in c-cppbuiltin.c which uses flags undefined for Fortran.
 236      Let's skip this for now. If needed, one needs to look into it
 237      once more.  */
 238
 239 # define builtin_define(TXT) cpp_define (pfile, TXT)
 240 # define builtin_define_std(TXT)
 241 # define builtin_assert(TXT) cpp_assert (pfile, TXT)
 242
 243   /* FIXME: Pandora's Box
 244     Using the macros below results in multiple breakages:
 245      - mingw will fail to compile this file as dependent macros
 246        assume to be used in c-cppbuiltin.c only. Further, they use
 247        flags only valid/defined in C (same as noted above).
 248        [config/i386/mingw32.h, config/i386/cygming.h]
 249      - other platforms (not as popular) break similarly
 250        [grep for 'builtin_define_with_int_value' in gcc/config/]
 251
 252   TARGET_CPU_CPP_BUILTINS ();
 253   TARGET_OS_CPP_BUILTINS ();
 254   TARGET_OBJFMT_CPP_BUILTINS (); */
 255
 256 #undef builtin_define
 257 #undef builtin_define_std
 258 #undef builtin_assert
 259 }
 260
 261 bool
 262 gfc_cpp_enabled (void)
 263 {
 264   return gfc_cpp_option.temporary_filename != NULL;
 265 }
 266
 267 bool
 268 gfc_cpp_preprocess_only (void)
 269 {
 270   return gfc_cpp_option.preprocess_only;
 271 }
 272
 273 const char *
 274 gfc_cpp_temporary_file (void)
 275 {
 276   return gfc_cpp_option.temporary_filename;
 277 }
 278
 279 void
 280 gfc_cpp_init_options (unsigned int argc,
 281                       const char **argv ATTRIBUTE_UNUSED)
 282 {
 283   /* Do not create any objects from libcpp here. If no
 284      preprocessing is requested, this would be wasted
 285      time and effort.
 286
 287      See gfc_cpp_post_options() instead.  */
 288
 289   gfc_cpp_option.temporary_filename = NULL;
 290   gfc_cpp_option.output_filename = NULL;
 291   gfc_cpp_option.preprocess_only = 0;
 292   gfc_cpp_option.discard_comments = 1;
 293   gfc_cpp_option.discard_comments_in_macro_exp = 1;
 294   gfc_cpp_option.print_include_names = 0;
 295   gfc_cpp_option.no_line_commands = 0;
 296   gfc_cpp_option.dump_macros = '\0';
 297   gfc_cpp_option.dump_includes = 0;
 298   gfc_cpp_option.working_directory = -1;
 299   gfc_cpp_option.no_predefined = 0;
 300   gfc_cpp_option.standard_include_paths = 1;
 301   gfc_cpp_option.verbose = 0;
 302
 303   gfc_cpp_option.multilib = NULL;
 304   gfc_cpp_option.prefix = NULL;
 305   gfc_cpp_option.sysroot = NULL;
 306
 307   gfc_cpp_option.deferred_opt = XNEWVEC (gfc_cpp_deferred_opt_t, argc);
 308   gfc_cpp_option.deferred_opt_count = 0;
 309 }
 310
 311 int
 312 gfc_cpp_handle_option (size_t scode, const char *arg, int value ATTRIBUTE_UNUSED)
 313 {
 314   int result = 1;
 315   enum opt_code code = (enum opt_code) scode;
 316
 317   switch (code)
 318   {
 319     default:
 320       result = 0;
 321       break;
 322
 323     case OPT_cpp:
 324       gfc_cpp_option.temporary_filename = arg;
 325       break;
 326
 327     case OPT_nocpp:
 328       gfc_cpp_option.temporary_filename = 0L;
 329       break;
 330
 331     case OPT_d:
 332       for ( ; *arg; ++arg)
 333         switch (*arg)
 334         {
 335           case 'D':
 336           case 'M':
 337           case 'N':
 338           case 'U':
 339             gfc_cpp_option.dump_macros = *arg;
 340             break;
 341
 342           case 'I':
 343             gfc_cpp_option.dump_includes = 1;
 344             break;
 345         }
 346       break;
 347
 348     case OPT_fworking_directory:
 349       gfc_cpp_option.working_directory = value;
 350       break;
 351
 352     case OPT_idirafter:
 353       gfc_cpp_add_include_path_after (xstrdup(arg), true);
 354       break;
 355
 356     case OPT_imultilib:
 357       gfc_cpp_option.multilib = arg;
 358       break;
 359
 360     case OPT_iprefix:
 361       gfc_cpp_option.prefix = arg;
 362       break;
 363
 364     case OPT_isysroot:
 365       gfc_cpp_option.sysroot = arg;
 366       break;
 367
 368     case OPT_iquote:
 369     case OPT_isystem:
 370       gfc_cpp_add_include_path (xstrdup(arg), true);
 371       break;
 372
 373     case OPT_nostdinc:
 374       gfc_cpp_option.standard_include_paths = value;
 375       break;
 376
 377     case OPT_o:
 378       if (!gfc_cpp_option.output_filename)
 379         gfc_cpp_option.output_filename = arg;
 380       else
 381         gfc_fatal_error ("output filename specified twice");
 382       break;
 383
 384     case OPT_undef:
 385       gfc_cpp_option.no_predefined = value;
 386       break;
 387
 388     case OPT_v:
 389       gfc_cpp_option.verbose = value;
 390       break;
 391
 392     case OPT_A:
 393     case OPT_D:
 394     case OPT_U:
 395       gfc_cpp_option.deferred_opt[gfc_cpp_option.deferred_opt_count].code = code;
 396       gfc_cpp_option.deferred_opt[gfc_cpp_option.deferred_opt_count].arg = arg;
 397       gfc_cpp_option.deferred_opt_count++;
 398       break;
 399
 400     case OPT_C:
 401       gfc_cpp_option.discard_comments = 0;
 402       break;
 403
 404     case OPT_CC:
 405       gfc_cpp_option.discard_comments = 0;
 406       gfc_cpp_option.discard_comments_in_macro_exp = 0;
 407       break;
 408
 409     case OPT_E:
 410       gfc_cpp_option.preprocess_only = 1;
 411       break;
 412
 413     case OPT_H:
 414       gfc_cpp_option.print_include_names = 1;
 415       break;
 416
 417     case OPT_P:
 418       gfc_cpp_option.no_line_commands = 1;
 419       break;
 420   }
 421
 422   return result;
 423 }
 424
 425
 426 void
 427 gfc_cpp_post_options (void)
 428 {
 429   /* Any preprocessing-related option without '-cpp' is considered
 430      an error.  */
 431   if (!gfc_cpp_enabled ()
 432       && (gfc_cpp_preprocess_only ()
 433           || !gfc_cpp_option.discard_comments
 434           || !gfc_cpp_option.discard_comments_in_macro_exp
 435           || gfc_cpp_option.print_include_names
 436           || gfc_cpp_option.no_line_commands
 437           || gfc_cpp_option.dump_macros
 438           || gfc_cpp_option.dump_includes))
 439     gfc_fatal_error("To enable preprocessing, use -cpp");
 440
 441   cpp_in = cpp_create_reader (CLK_GNUC89, NULL, line_table);
 442   if (!gfc_cpp_enabled())
 443     return;
 444
 445   gcc_assert (cpp_in);
 446
 447   /* The cpp_options-structure defines far more flags than those set here.
 448      If any other is implemented, see c-opt.c (sanitize_cpp_opts) for
 449      inter-option dependencies that may need to be enforced.  */
 450   cpp_option = cpp_get_options (cpp_in);
 451   gcc_assert (cpp_option);
 452
 453   /* TODO: allow non-traditional modes, e.g. by -cpp-std=...?  */
 454   cpp_option->traditional = 1;
 455   cpp_option->cplusplus_comments = 0;
 456
 457   cpp_option->pedantic = pedantic;
 458
 459   cpp_option->dollars_in_ident = gfc_option.flag_dollar_ok;
 460   cpp_option->discard_comments = gfc_cpp_option.discard_comments;
 461   cpp_option->discard_comments_in_macro_exp = gfc_cpp_option.discard_comments_in_macro_exp;
 462   cpp_option->print_include_names = gfc_cpp_option.print_include_names;
 463   cpp_option->preprocessed = gfc_option.flag_preprocessed;
 464
 465   if (gfc_cpp_option.working_directory == -1)
 466     gfc_cpp_option.working_directory = (debug_info_level != DINFO_LEVEL_NONE);
 467
 468   cpp_post_options (cpp_in);
 469
 470   gfc_cpp_register_include_paths ();
 471 }
 472
 473
 474 void
 475 gfc_cpp_init_0 (void)
 476 {
 477   struct cpp_callbacks *cb;
 478
 479   cb = cpp_get_callbacks (cpp_in);
 480   cb->file_change = cb_file_change;
 481   cb->line_change = cb_line_change;
 482   cb->ident = cb_ident;
 483   cb->def_pragma = cb_def_pragma;
 484   cb->error = cb_cpp_error;
 485
 486   if (gfc_cpp_option.dump_includes)
 487     cb->include = cb_include;
 488
 489   if ((gfc_cpp_option.dump_macros == 'D')
 490       || (gfc_cpp_option.dump_macros == 'N'))
 491     {
 492       cb->define = cb_define;
 493       cb->undef  = cb_undef;
 494     }
 495
 496   if (gfc_cpp_option.dump_macros == 'U')
 497     {
 498       cb->before_define = dump_queued_macros;
 499       cb->used_define = cb_used_define;
 500       cb->used_undef = cb_used_undef;
 501     }
 502
 503   /* Initialize the print structure.  Setting print.src_line to -1 here is
 504      a trick to guarantee that the first token of the file will cause
 505      a linemarker to be output by maybe_print_line.  */
 506   print.src_line = -1;
 507   print.printed = 0;
 508   print.prev = 0;
 509   print.first_time = 1;
 510
 511   if (gfc_cpp_preprocess_only ())
 512     {
 513       if (gfc_cpp_option.output_filename)
 514         {
 515           /* This needs cheating: with "-E -o <file>", the user wants the
 516              preprocessed output in <file>. However, if nothing is done
 517              about it <file> is also used for assembler output. Hence, it
 518              is necessary to redirect assembler output (actually nothing
 519              as -E implies -fsyntax-only) to another file, otherwise the
 520              output from preprocessing is lost.  */
 521           asm_file_name = gfc_cpp_option.temporary_filename;
 522
 523           print.outf = fopen (gfc_cpp_option.output_filename, "w");
 524           if (print.outf == NULL)
 525             gfc_fatal_error ("opening output file %s: %s",
 526                              gfc_cpp_option.output_filename, strerror(errno));
 527         }
 528       else
 529         print.outf = stdout;
 530     }
 531   else
 532     {
 533       print.outf = fopen (gfc_cpp_option.temporary_filename, "w");
 534       if (print.outf == NULL)
 535         gfc_fatal_error ("opening output file %s: %s",
 536                          gfc_cpp_option.temporary_filename, strerror(errno));
 537     }
 538
 539   gcc_assert(cpp_in);
 540   if (!cpp_read_main_file (cpp_in, gfc_source_file))
 541     errorcount++;
 542 }
 543
 544 void
 545 gfc_cpp_init (void)
 546 {
 547   int i;
 548
 549   if (gfc_option.flag_preprocessed)
 550     return;
 551
 552   cpp_change_file (cpp_in, LC_RENAME, _("<built-in>"));
 553   if (!gfc_cpp_option.no_predefined)
 554     cpp_define_builtins (cpp_in);
 555
 556   /* Handle deferred options from command-line.  */
 557   cpp_change_file (cpp_in, LC_RENAME, _("<command-line>"));
 558
 559   for (i = 0; i < gfc_cpp_option.deferred_opt_count; i++)
 560     {
 561       gfc_cpp_deferred_opt_t *opt = &gfc_cpp_option.deferred_opt[i];
 562
 563       if (opt->code == OPT_D)
 564         cpp_define (cpp_in, opt->arg);
 565       else if (opt->code == OPT_U)
 566         cpp_undef (cpp_in, opt->arg);
 567       else if (opt->code == OPT_A)
 568         {
 569           if (opt->arg[0] == '-')
 570             cpp_unassert (cpp_in, opt->arg + 1);
 571           else
 572             cpp_assert (cpp_in, opt->arg);
 573         }
 574     }
 575
 576   if (gfc_cpp_option.working_directory
 577       && gfc_cpp_option.preprocess_only && !gfc_cpp_option.no_line_commands)
 578     pp_dir_change (cpp_in, get_src_pwd ());
 579 }
 580
 581 gfc_try
 582 gfc_cpp_preprocess (const char *source_file)
 583 {
 584   if (!gfc_cpp_enabled ())
 585     return FAILURE;
 586
 587   cpp_change_file (cpp_in, LC_RENAME, source_file);
 588
 589   if (cpp_option->traditional)
 590     scan_translation_unit_trad (cpp_in);
 591   else
 592     scan_translation_unit (cpp_in);
 593
 594   /* -dM command line option.  */
 595   if (gfc_cpp_preprocess_only () &&
 596       gfc_cpp_option.dump_macros == 'M')
 597     {
 598       putc ('\n', print.outf);
 599       cpp_forall_identifiers (cpp_in, dump_macro, NULL);
 600     }
 601
 602   putc ('\n', print.outf);
 603
 604   if (!gfc_cpp_preprocess_only ()
 605       || (gfc_cpp_preprocess_only () && gfc_cpp_option.output_filename))
 606     fclose (print.outf);
 607
 608   return SUCCESS;
 609 }
 610
 611 void
 612 gfc_cpp_done (void)
 613 {
 614   if (!gfc_cpp_enabled ())
 615     return;
 616
 617   /* TODO: if dependency tracking was enabled, call
 618      cpp_finish() here to write dependencies.
 619
 620      Use cpp_get_deps() to access the current source's
 621      dependencies during parsing. Add dependencies using
 622      the mkdeps-interface (defined in libcpp).  */
 623
 624   gcc_assert (cpp_in);
 625   cpp_undef_all (cpp_in);
 626   cpp_clear_file_cache (cpp_in);
 627 }
 628
 629 /* PATH must be malloc-ed and NULL-terminated.  */
 630 void
 631 gfc_cpp_add_include_path (char *path, bool user_supplied)
 632 {
 633   /* CHAIN sets cpp_dir->sysp which differs from 0 if PATH is a system
 634      include path. Fortran does not define any system include paths.  */
 635   int cxx_aware = 0;
 636
 637   add_path (path, BRACKET, cxx_aware, user_supplied);
 638 }
 639
 640 void
 641 gfc_cpp_add_include_path_after (char *path, bool user_supplied)
 642 {
 643   int cxx_aware = 0;
 644   add_path (path, AFTER, cxx_aware, user_supplied);
 645 }
 646
 647 void
 648 gfc_cpp_register_include_paths (void)
 649 {
 650   int cxx_stdinc = 0;
 651   register_include_chains (cpp_in, gfc_cpp_option.sysroot,
 652                            gfc_cpp_option.prefix, gfc_cpp_option.multilib,
 653                            gfc_cpp_option.standard_include_paths, cxx_stdinc,
 654                            gfc_cpp_option.verbose);
 655 }
 656
 657
 658
 659 static void scan_translation_unit_trad (cpp_reader *);
 660 static void account_for_newlines (const unsigned char *, size_t);
 661 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
 662
 663 static void print_line (source_location, const char *);
 664 static void maybe_print_line (source_location);
 665
 666
 667 /* Writes out the preprocessed file, handling spacing and paste
 668    avoidance issues.  */
 669 static void
 670 scan_translation_unit (cpp_reader *pfile)
 671 {
 672   bool avoid_paste = false;
 673
 674   print.source = NULL;
 675   for (;;)
 676     {
 677       const cpp_token *token = cpp_get_token (pfile);
 678
 679       if (token->type == CPP_PADDING)
 680         {
 681           avoid_paste = true;
 682           if (print.source == NULL
 683               || (!(print.source->flags & PREV_WHITE)
 684                   && token->val.source == NULL))
 685             print.source = token->val.source;
 686           continue;
 687         }
 688
 689       if (token->type == CPP_EOF)
 690         break;
 691
 692       /* Subtle logic to output a space if and only if necessary.  */
 693       if (avoid_paste)
 694         {
 695           if (print.source == NULL)
 696             print.source = token;
 697           if (print.source->flags & PREV_WHITE
 698               || (print.prev
 699                   && cpp_avoid_paste (pfile, print.prev, token))
 700               || (print.prev == NULL && token->type == CPP_HASH))
 701             putc (' ', print.outf);
 702         }
 703       else if (token->flags & PREV_WHITE)
 704         putc (' ', print.outf);
 705
 706       avoid_paste = false;
 707       print.source = NULL;
 708       print.prev = token;
 709       cpp_output_token (token, print.outf);
 710
 711       if (token->type == CPP_COMMENT)
 712         account_for_newlines (token->val.str.text, token->val.str.len);
 713     }
 714 }
 715
 716 /* Adjust print.src_line for newlines embedded in output.  */
 717 static void
 718 account_for_newlines (const unsigned char *str, size_t len)
 719 {
 720   while (len--)
 721     if (*str++ == '\n')
 722       print.src_line++;
 723 }
 724
 725 /* Writes out a traditionally preprocessed file.  */
 726 static void
 727 scan_translation_unit_trad (cpp_reader *pfile)
 728 {
 729   while (_cpp_read_logical_line_trad (pfile))
 730     {
 731       size_t len = pfile->out.cur - pfile->out.base;
 732       maybe_print_line (pfile->out.first_line);
 733       fwrite (pfile->out.base, 1, len, print.outf);
 734       print.printed = 1;
 735       if (!CPP_OPTION (pfile, discard_comments))
 736         account_for_newlines (pfile->out.base, len);
 737     }
 738 }
 739
 740 /* If the token read on logical line LINE needs to be output on a
 741    different line to the current one, output the required newlines or
 742    a line marker.  */
 743 static void
 744 maybe_print_line (source_location src_loc)
 745 {
 746   const struct line_map *map = linemap_lookup (line_table, src_loc);
 747   int src_line = SOURCE_LINE (map, src_loc);
 748
 749   /* End the previous line of text.  */
 750   if (print.printed)
 751     {
 752       putc ('\n', print.outf);
 753       print.src_line++;
 754       print.printed = 0;
 755     }
 756
 757   if (src_line >= print.src_line && src_line < print.src_line + 8)
 758     {
 759       while (src_line > print.src_line)
 760         {
 761           putc ('\n', print.outf);
 762           print.src_line++;
 763         }
 764     }
 765   else
 766     print_line (src_loc, "");
 767 }
 768
 769 /* Output a line marker for logical line LINE.  Special flags are "1"
 770    or "2" indicating entering or leaving a file.  */
 771 static void
 772 print_line (source_location src_loc, const char *special_flags)
 773 {
 774   /* End any previous line of text.  */
 775   if (print.printed)
 776     putc ('\n', print.outf);
 777   print.printed = 0;
 778
 779   if (!gfc_cpp_option.no_line_commands)
 780     {
 781       const struct line_map *map = linemap_lookup (line_table, src_loc);
 782
 783       size_t to_file_len = strlen (map->to_file);
 784       unsigned char *to_file_quoted =
 785          (unsigned char *) alloca (to_file_len * 4 + 1);
 786       unsigned char *p;
 787
 788       print.src_line = SOURCE_LINE (map, src_loc);
 789
 790       /* cpp_quote_string does not nul-terminate, so we have to do it
 791          ourselves.  */
 792       p = cpp_quote_string (to_file_quoted,
 793                             (const unsigned char *) map->to_file, to_file_len);
 794       *p = '\0';
 795       fprintf (print.outf, "# %u \"%s\"%s",
 796                print.src_line == 0 ? 1 : print.src_line,
 797                to_file_quoted, special_flags);
 798
 799       if (map->sysp == 2)
 800         fputs (" 3 4", print.outf);
 801       else if (map->sysp == 1)
 802         fputs (" 3", print.outf);
 803
 804       putc ('\n', print.outf);
 805     }
 806 }
 807
 808 static void
 809 cb_file_change (cpp_reader * ARG_UNUSED (pfile), const struct line_map *map)
 810 {
 811   const char *flags = "";
 812
 813   if (gfc_cpp_option.no_line_commands)
 814     return;
 815
 816   if (!map)
 817     return;
 818
 819       if (print.first_time)
 820         {
 821           /* Avoid printing foo.i when the main file is foo.c.  */
 822           if (!cpp_get_options (cpp_in)->preprocessed)
 823             print_line (map->start_location, flags);
 824           print.first_time = 0;
 825         }
 826       else
 827         {
 828           /* Bring current file to correct line when entering a new file.  */
 829           if (map->reason == LC_ENTER)
 830             {
 831               const struct line_map *from = INCLUDED_FROM (line_table, map);
 832               maybe_print_line (LAST_SOURCE_LINE_LOCATION (from));
 833             }
 834           if (map->reason == LC_ENTER)
 835             flags = " 1";
 836           else if (map->reason == LC_LEAVE)
 837             flags = " 2";
 838           print_line (map->start_location, flags);
 839         }
 840
 841 }
 842
 843 /* Called when a line of output is started.  TOKEN is the first token
 844    of the line, and at end of file will be CPP_EOF.  */
 845 static void
 846 cb_line_change (cpp_reader *pfile, const cpp_token *token,
 847                 int parsing_args)
 848 {
 849   source_location src_loc = token->src_loc;
 850
 851   if (token->type == CPP_EOF || parsing_args)
 852     return;
 853
 854   maybe_print_line (src_loc);
 855   print.prev = 0;
 856   print.source = 0;
 857
 858   /* Supply enough spaces to put this token in its original column,
 859      one space per column greater than 2, since scan_translation_unit
 860      will provide a space if PREV_WHITE.  Don't bother trying to
 861      reconstruct tabs; we can't get it right in general, and nothing
 862      ought to care.  Some things do care; the fault lies with them.  */
 863   if (!CPP_OPTION (pfile, traditional))
 864     {
 865       const struct line_map *map = linemap_lookup (line_table, src_loc);
 866       int spaces = SOURCE_COLUMN (map, src_loc) - 2;
 867       print.printed = 1;
 868
 869       while (-- spaces >= 0)
 870         putc (' ', print.outf);
 871     }
 872 }
 873
 874 static void
 875 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
 876           const cpp_string *str)
 877 {
 878   maybe_print_line (line);
 879   fprintf (print.outf, "#ident %s\n", str->text);
 880   print.src_line++;
 881 }
 882
 883 static void
 884 cb_define (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
 885            cpp_hashnode *node ATTRIBUTE_UNUSED)
 886 {
 887   maybe_print_line (line);
 888   fputs ("#define ", print.outf);
 889
 890   /* 'D' is whole definition; 'N' is name only.  */
 891   if (gfc_cpp_option.dump_macros == 'D')
 892     fputs ((const char *) cpp_macro_definition (pfile, node),
 893            print.outf);
 894   else
 895     fputs ((const char *) NODE_NAME (node), print.outf);
 896
 897   putc ('\n', print.outf);
 898   if (linemap_lookup (line_table, line)->to_line != 0)
 899     print.src_line++;
 900 }
 901
 902 static void
 903 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
 904           cpp_hashnode *node)
 905 {
 906   maybe_print_line (line);
 907   fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
 908   print.src_line++;
 909 }
 910
 911 static void
 912 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
 913             const unsigned char *dir, const char *header, int angle_brackets,
 914             const cpp_token **comments)
 915 {
 916   maybe_print_line (line);
 917   if (angle_brackets)
 918     fprintf (print.outf, "#%s <%s>", dir, header);
 919   else
 920     fprintf (print.outf, "#%s \"%s\"", dir, header);
 921
 922   if (comments != NULL)
 923     {
 924       while (*comments != NULL)
 925         {
 926           if ((*comments)->flags & PREV_WHITE)
 927             putc (' ', print.outf);
 928           cpp_output_token (*comments, print.outf);
 929           ++comments;
 930         }
 931     }
 932
 933   putc ('\n', print.outf);
 934   print.src_line++;
 935 }
 936
 937 /* Dump out the hash table.  */
 938 static int
 939 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
 940 {
 941   if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
 942     {
 943       fputs ("#define ", print.outf);
 944       fputs ((const char *) cpp_macro_definition (pfile, node),
 945              print.outf);
 946       putc ('\n', print.outf);
 947       print.src_line++;
 948     }
 949
 950   return 1;
 951 }
 952
 953 static void
 954 cb_used_define (cpp_reader *pfile, source_location line ATTRIBUTE_UNUSED,
 955                 cpp_hashnode *node)
 956 {
 957   gfc_cpp_macro_queue *q;
 958   q = XNEW (gfc_cpp_macro_queue);
 959   q->macro = xstrdup ((const char *) cpp_macro_definition (pfile, node));
 960   q->next = cpp_define_queue;
 961   cpp_define_queue = q;
 962 }
 963
 964 /* Callback from cpp_error for PFILE to print diagnostics from the
 965    preprocessor.  The diagnostic is of type LEVEL, with REASON set
 966    to the reason code if LEVEL is represents a warning, at location
 967    LOCATION, with column number possibly overridden by COLUMN_OVERRIDE
 968    if not zero; MSG is the translated message and AP the arguments.
 969    Returns true if a diagnostic was emitted, false otherwise.  */
 970
 971 static bool
 972 cb_cpp_error (cpp_reader *pfile ATTRIBUTE_UNUSED, int level, int reason,
 973               location_t location, unsigned int column_override,
 974               const char *msg, va_list *ap)
 975 {
 976   diagnostic_info diagnostic;
 977   diagnostic_t dlevel;
 978   int save_warn_system_headers = warn_system_headers;
 979   bool ret;
 980
 981   switch (level)
 982     {
 983     case CPP_DL_WARNING_SYSHDR:
 984       warn_system_headers = 1;
 985       /* Fall through.  */
 986     case CPP_DL_WARNING:
 987       dlevel = DK_WARNING;
 988       break;
 989     case CPP_DL_PEDWARN:
 990       dlevel = DK_PEDWARN;
 991       break;
 992     case CPP_DL_ERROR:
 993       dlevel = DK_ERROR;
 994       break;
 995     case CPP_DL_ICE:
 996       dlevel = DK_ICE;
 997       break;
 998     case CPP_DL_NOTE:
 999       dlevel = DK_NOTE;
1000       break;
1001     case CPP_DL_FATAL:
1002       dlevel = DK_FATAL;
1003       break;
1004     default:
1005       gcc_unreachable ();
1006     }
1007   diagnostic_set_info_translated (&diagnostic, msg, ap,
1008                                   location, dlevel);
1009   if (column_override)
1010     diagnostic_override_column (&diagnostic, column_override);
1011   if (reason == CPP_W_WARNING_DIRECTIVE)
1012     diagnostic_override_option_index (&diagnostic, OPT_Wcpp);
1013   ret = report_diagnostic (&diagnostic);
1014   if (level == CPP_DL_WARNING_SYSHDR)
1015     warn_system_headers = save_warn_system_headers;
1016   return ret;
1017 }
1018
1019 /* Callback called when -fworking-director and -E to emit working
1020    directory in cpp output file.  */
1021
1022 void
1023 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
1024 {
1025   size_t to_file_len = strlen (dir);
1026   unsigned char *to_file_quoted =
1027      (unsigned char *) alloca (to_file_len * 4 + 1);
1028   unsigned char *p;
1029
1030   /* cpp_quote_string does not nul-terminate, so we have to do it ourselves.  */
1031   p = cpp_quote_string (to_file_quoted, (const unsigned char *) dir, to_file_len);
1032   *p = '\0';
1033   fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
1034 }
1035
1036 /* Copy a #pragma directive to the preprocessed output.  */
1037 static void
1038 cb_def_pragma (cpp_reader *pfile, source_location line)
1039 {
1040   maybe_print_line (line);
1041   fputs ("#pragma ", print.outf);
1042   cpp_output_line (pfile, print.outf);
1043   print.src_line++;
1044 }
1045
1046 static void
1047 cb_used_undef (cpp_reader *pfile ATTRIBUTE_UNUSED,
1048                source_location line ATTRIBUTE_UNUSED,
1049                cpp_hashnode *node)
1050 {
1051   gfc_cpp_macro_queue *q;
1052   q = XNEW (gfc_cpp_macro_queue);
1053   q->macro = xstrdup ((const char *) NODE_NAME (node));
1054   q->next = cpp_undefine_queue;
1055   cpp_undefine_queue = q;
1056 }
1057
1058 static void
1059 dump_queued_macros (cpp_reader *pfile ATTRIBUTE_UNUSED)
1060 {
1061   gfc_cpp_macro_queue *q;
1062
1063   /* End the previous line of text.  */
1064   if (print.printed)
1065     {
1066       putc ('\n', print.outf);
1067       print.src_line++;
1068       print.printed = 0;
1069     }
1070
1071   for (q = cpp_define_queue; q;)
1072     {
1073       gfc_cpp_macro_queue *oq;
1074       fputs ("#define ", print.outf);
1075       fputs (q->macro, print.outf);
1076       putc ('\n', print.outf);
1077       print.src_line++;
1078       oq = q;
1079       q = q->next;
1080       gfc_free (oq->macro);
1081       gfc_free (oq);
1082     }
1083   cpp_define_queue = NULL;
1084   for (q = cpp_undefine_queue; q;)
1085     {
1086       gfc_cpp_macro_queue *oq;
1087       fprintf (print.outf, "#undef %s\n", q->macro);
1088       print.src_line++;
1089       oq = q;
1090       q = q->next;
1091       gfc_free (oq->macro);
1092       gfc_free (oq);
1093     }
1094   cpp_undefine_queue = NULL;
1095 }