1 // options.h -- handle command line options for gold -*- C++ -*-
4 // Holds everything we get from the command line.
5 // General_options (from Command_line::options())
6 // Options which are not position dependent.
7 // Input_argument (from Command_line::inputs())
8 // The list of input files, including -l options.
9 // Position_dependent_options (from Input_argument::options())
10 // Position dependent options which apply to this argument.
12 #ifndef GOLD_OPTIONS_H
13 #define GOLD_OPTIONS_H
23 class Input_file_group;
27 class Command_line_options;
30 } // End namespace gold::options.
32 // The position independent options which apply to the whole link.
33 // There are a lot of them.
40 // -I: dynamic linker name.
42 dynamic_linker() const
43 { return this->dynamic_linker_; }
45 // -L: Library search path.
46 typedef std::vector<const char*> Dir_list;
50 { return this->search_path_; }
52 // -o: Output file name.
54 output_file_name() const
55 { return this->output_file_name_; }
57 // -r: Whether we are doing a relocatable link.
59 is_relocatable() const
60 { return this->is_relocatable_; }
62 // --rpath: The runtime search path.
65 { return this->rpath_; }
67 // --shared: Whether generating a shared object.
70 { return this->is_shared_; }
72 // --static: Whether doing a static link.
75 { return this->is_static_; }
78 // Don't copy this structure.
79 General_options(const General_options&);
80 General_options& operator=(const General_options&);
82 friend class Command_line;
83 friend class options::Command_line_options;
86 set_dynamic_linker(const char* arg)
87 { this->dynamic_linker_ = arg; }
90 add_to_search_path(const char* arg)
91 { this->search_path_.push_back(arg); }
94 set_output_file_name(const char* arg)
95 { this->output_file_name_ = arg; }
99 { this->is_relocatable_ = true; }
102 add_to_rpath(const char* arg)
103 { this->rpath_.push_back(arg); }
107 { this->is_shared_ = true; }
111 { this->is_static_ = true; }
117 const char* dynamic_linker_;
118 Dir_list search_path_;
119 const char* output_file_name_;
120 bool is_relocatable_;
126 // The current state of the position dependent options.
128 class Position_dependent_options
131 Position_dependent_options();
133 // -Bstatic: Whether we are searching for a static archive rather
134 // than a shared object.
136 do_static_search() const
137 { return this->do_static_search_; }
139 // --as-needed: Whether to add a DT_NEEDED argument only if the
140 // dynamic object is used.
143 { return this->as_needed_; }
147 { this->do_static_search_ = true; }
151 { this->do_static_search_ = false; }
155 { this->as_needed_ = true; }
159 { this->as_needed_ = false; }
162 bool do_static_search_;
166 // A single file or library argument from the command line.
168 class Input_file_argument
171 Input_file_argument()
172 : name_(), is_lib_(false), options_()
175 Input_file_argument(const char* name, bool is_lib,
176 const Position_dependent_options& options)
177 : name_(name), is_lib_(is_lib), options_(options)
182 { return this->name_.c_str(); }
184 const Position_dependent_options&
186 { return this->options_; }
190 { return this->is_lib_; }
193 // We use std::string, not const char*, here for convenience when
194 // using script files, so that we do not have to preserve the string
198 Position_dependent_options options_;
201 // A file or library, or a group, from the command line.
206 // Create a file or library argument.
207 explicit Input_argument(Input_file_argument file)
208 : is_file_(true), file_(file), group_(NULL)
211 // Create a group argument.
212 explicit Input_argument(Input_file_group* group)
213 : is_file_(false), group_(group)
216 // Return whether this is a file.
219 { return this->is_file_; }
221 // Return whether this is a group.
224 { return !this->is_file_; }
226 // Return the information about the file.
227 const Input_file_argument&
230 gold_assert(this->is_file_);
234 // Return the information about the group.
235 const Input_file_group*
238 gold_assert(!this->is_file_);
245 gold_assert(!this->is_file_);
251 Input_file_argument file_;
252 Input_file_group* group_;
255 // A group from the command line. This is a set of arguments within
256 // --start-group ... --end-group.
258 class Input_file_group
261 typedef std::vector<Input_argument> Files;
262 typedef Files::const_iterator const_iterator;
268 // Add a file to the end of the group.
270 add_file(const Input_file_argument& arg)
271 { this->files_.push_back(Input_argument(arg)); }
273 // Iterators to iterate over the group contents.
277 { return this->files_.begin(); }
281 { return this->files_.end(); }
287 // A list of files from the command line or a script.
289 class Input_arguments
292 typedef std::vector<Input_argument> Input_argument_list;
293 typedef Input_argument_list::const_iterator const_iterator;
296 : input_argument_list_(), in_group_(false)
301 add_file(const Input_file_argument& arg);
303 // Start a group (the --start-group option).
307 // End a group (the --end-group option).
311 // Return whether we are currently in a group.
314 { return this->in_group_; }
316 // Iterators to iterate over the list of input files.
320 { return this->input_argument_list_.begin(); }
324 { return this->input_argument_list_.end(); }
326 // Return whether the list is empty.
329 { return this->input_argument_list_.empty(); }
332 Input_argument_list input_argument_list_;
336 // All the information read from the command line.
341 typedef Input_arguments::const_iterator const_iterator;
345 // Process the command line options. This will exit with an
346 // appropriate error message if an unrecognized option is seen.
348 process(int argc, char** argv);
350 // Handle a -l option.
352 process_l_option(int, char**, char*);
354 // Handle a --start-group option.
356 start_group(const char* arg);
358 // Handle a --end-group option.
360 end_group(const char* arg);
362 // Get the general options.
363 const General_options&
365 { return this->options_; }
367 // Iterators to iterate over the list of input files.
371 { return this->inputs_.begin(); }
375 { return this->inputs_.end(); }
378 Command_line(const Command_line&);
379 Command_line& operator=(const Command_line&);
381 // Report usage error.
383 usage() ATTRIBUTE_NORETURN;
385 usage(const char* msg, const char* opt) ATTRIBUTE_NORETURN;
387 usage(const char* msg, char opt) ATTRIBUTE_NORETURN;
389 // Apply a command line option.
391 apply_option(const gold::options::One_option&, const char*);
395 add_file(const char* name, bool is_lib);
397 General_options options_;
398 Position_dependent_options position_options_;
399 Input_arguments inputs_;
402 } // End namespace gold.
404 #endif // !defined(GOLD_OPTIONS_H)