gcc/fortran/cpp.c

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