1 /* Header file for modules that link with gcc.c
2    Copyright (C) 1999-2018 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10 
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef GCC_GCC_H
21 #define GCC_GCC_H
22 
23 #include "version.h"
24 #include "diagnostic-core.h"
25 
26 /* The top-level "main" within the driver would be ~1000 lines long.
27    This class breaks it up into smaller functions and contains some
28    state shared by them.  */
29 
30 class driver
31 {
32  public:
33   driver (bool can_finalize, bool debug);
34   ~driver ();
35   int main (int argc, char **argv);
36   void finalize ();
37 
38  private:
39   void set_progname (const char *argv0) const;
40   void expand_at_files (int *argc, char ***argv) const;
41   void decode_argv (int argc, const char **argv);
42   void global_initializations ();
43   void build_multilib_strings () const;
44   void set_up_specs () const;
45   void putenv_COLLECT_GCC (const char *argv0) const;
46   void maybe_putenv_COLLECT_LTO_WRAPPER () const;
47   void maybe_putenv_OFFLOAD_TARGETS () const;
48   void build_option_suggestions (void);
49   const char *suggest_option (const char *bad_opt);
50   void handle_unrecognized_options ();
51   int maybe_print_and_exit () const;
52   bool prepare_infiles ();
53   void do_spec_on_infiles () const;
54   void maybe_run_linker (const char *argv0) const;
55   void final_actions () const;
56   int get_exit_code () const;
57 
58  private:
59   char *explicit_link_files;
60   struct cl_decoded_option *decoded_options;
61   unsigned int decoded_options_count;
62   auto_vec <char *> *m_option_suggestions;
63 };
64 
65 /* The mapping of a spec function name to the C function that
66    implements it.  */
67 struct spec_function
68 {
69   const char *name;
70   const char *(*func) (int, const char **);
71 };
72 
73 /* These are exported by gcc.c.  */
74 extern int do_spec (const char *);
75 extern void record_temp_file (const char *, int, int);
76 extern void pfatal_with_name (const char *) ATTRIBUTE_NORETURN;
77 extern void set_input (const char *);
78 
79 /* Spec files linked with gcc.c must provide definitions for these.  */
80 
81 /* Called before processing to change/add/remove arguments.  */
82 extern void lang_specific_driver (struct cl_decoded_option **,
83 				  unsigned int *, int *);
84 
85 /* Called before linking.  Returns 0 on success and -1 on failure.  */
86 extern int lang_specific_pre_link (void);
87 
88 extern int n_infiles;
89 
90 /* Number of extra output files that lang_specific_pre_link may generate.  */
91 extern int lang_specific_extra_outfiles;
92 
93 /* A vector of corresponding output files is made up later.  */
94 
95 extern const char **outfiles;
96 
97 extern void
98 driver_get_configure_time_options (void (*cb)(const char *option,
99 					      void *user_data),
100 				   void *user_data);
101 
102 #endif /* ! GCC_GCC_H */
103