1 // options.c -- handle command line options for gold
11 // The information we keep for a single command line option.
13 struct options::One_option
15 // The single character option name, or '\0' if this is only a long
19 // The long option name, or NULL if this is only a short option.
20 const char* long_option;
22 // Description of the option for --help output, or NULL if there is none.
25 // How to print the option name in --help output, or NULL to use the
27 const char* help_output;
29 // Long option dash control. This is ignored if long_option is
33 // Long option normally takes one dash; two dashes are also
36 // Long option normally takes two dashes; one dash is also
39 // Long option always takes two dashes.
43 // Function for special handling, or NULL. Returns the number of
44 // arguments to skip. This will normally be at least 1, but it may
45 // be 0 if this function changes *argv. ARG points to the location
46 // in *ARGV where the option starts, which may be helpful for a
48 int (*special)(int argc, char** argv, char *arg, Command_line*);
50 // If this is a position independent option which does not take an
51 // argument, this is the member function to call to record it.
52 void (General_options::*general_noarg)();
54 // If this is a position independent function which takes an
55 // argument, this is the member function to call to record it.
56 void (General_options::*general_arg)(const char*);
58 // If this is a position dependent option which does not take an
59 // argument, this is the member function to call to record it.
60 void (Position_dependent_options::*dependent_noarg)();
62 // If this is a position dependent option which takes an argument,
63 // this is the member function to record it.
64 void (Position_dependent_options::*dependent_arg)(const char*);
66 // Return whether this option takes an argument.
68 takes_argument() const
69 { return this->general_arg != NULL || this->dependent_arg != NULL; }
72 class options::Command_line_options
75 static const One_option options[];
76 static const int options_size;
79 } // End namespace gold.
84 // Handle the special -l option, which adds an input file.
87 library(int argc, char** argv, char* arg, gold::Command_line* cmdline)
89 return cmdline->process_l_option(argc, argv, arg);
92 // Handle the special --start-group option.
95 start_group(int, char**, char* arg, gold::Command_line* cmdline)
97 cmdline->start_group(arg);
101 // Handle the special --end-group option.
104 end_group(int, char**, char* arg, gold::Command_line* cmdline)
106 cmdline->end_group(arg);
110 // Report usage information for ld --help, and exit.
113 help(int, char**, char*, gold::Command_line*)
115 printf(_("Usage: %s [options] file...\nOptions:\n"), gold::program_name);
117 const int options_size = gold::options::Command_line_options::options_size;
118 const gold::options::One_option* options =
119 gold::options::Command_line_options::options;
120 for (int i = 0; i < options_size; ++i)
122 if (options[i].doc == NULL)
132 if (options[j].help_output != NULL)
139 printf(options[j].help_output);
140 len += std::strlen(options[i].help_output);
144 if (options[j].short_option != '\0')
151 printf("-%c", options[j].short_option);
155 if (options[j].long_option != NULL)
162 if (options[j].dash == gold::options::One_option::ONE_DASH)
172 printf("%s", options[j].long_option);
173 len += std::strlen(options[j].long_option);
178 while (j < options_size && options[j].doc == NULL);
185 for (; len < 30; ++len)
188 std::puts(options[i].doc);
191 gold::gold_exit(true);
196 } // End anonymous namespace.
201 // Helper macros used to specify the options. We could also do this
202 // using constructors, but then g++ would generate code to initialize
203 // the array. We want the array to be initialized statically so that
204 // we get better startup time.
206 #define GENERAL_NOARG(short_option, long_option, doc, help, dash, func) \
207 { short_option, long_option, doc, help, options::One_option::dash, \
208 NULL, func, NULL, NULL, NULL }
209 #define GENERAL_ARG(short_option, long_option, doc, help, dash, func) \
210 { short_option, long_option, doc, help, options::One_option::dash, \
211 NULL, NULL, func, NULL, NULL }
212 #define POSDEP_NOARG(short_option, long_option, doc, help, dash, func) \
213 { short_option, long_option, doc, help, options::One_option::dash, \
214 NULL, NULL, NULL, func, NULL }
215 #define POSDEP_ARG(short_option, long_option, doc, help, dash, func) \
216 { short_option, long_option, doc, help, options::One_option::dash, \
217 NULL, NULL, NULL, NULL, func }
218 #define SPECIAL(short_option, long_option, doc, help, dash, func) \
219 { short_option, long_option, doc, help, options::One_option::dash, \
220 func, NULL, NULL, NULL, NULL }
222 // Here is the actual list of options which we accept.
224 const options::One_option
225 options::Command_line_options::options[] =
227 SPECIAL('l', "library", N_("Search for library LIBNAME"),
228 N_("-lLIBNAME --library LIBNAME"), TWO_DASHES,
230 SPECIAL('(', "start-group", N_("Start a library search group"), NULL,
231 TWO_DASHES, &start_group),
232 SPECIAL(')', "end-group", N_("End a library search group"), NULL,
233 TWO_DASHES, &end_group),
234 GENERAL_ARG('I', "dynamic-linker", N_("Set dynamic linker path"),
235 N_("-I PROGRAM, --dynamic-linker PROGRAM"), TWO_DASHES,
236 &General_options::set_dynamic_linker),
237 GENERAL_ARG('L', "library-path", N_("Add directory to search path"),
238 N_("-L DIR, --library-path DIR"), TWO_DASHES,
239 &General_options::add_to_search_path),
240 GENERAL_ARG('m', NULL, N_("Ignored for compatibility"), NULL, ONE_DASH,
241 &General_options::ignore),
242 GENERAL_ARG('o', "output", N_("Set output file name"),
243 N_("-o FILE, --output FILE"), TWO_DASHES,
244 &General_options::set_output_file_name),
245 GENERAL_NOARG('r', NULL, N_("Generate relocatable output"), NULL,
246 ONE_DASH, &General_options::set_relocatable),
247 GENERAL_ARG('R', "rpath", N_("Add directory to runtime search path"),
248 N_("-R DIR, -rpath DIR"), ONE_DASH,
249 &General_options::add_to_rpath),
250 GENERAL_NOARG('\0', "shared", N_("Generate shared library"),
251 NULL, ONE_DASH, &General_options::set_shared),
252 GENERAL_NOARG('\0', "static", N_("Do not link against shared libraries"),
253 NULL, ONE_DASH, &General_options::set_static),
254 POSDEP_NOARG('\0', "as-needed",
255 N_("Only set DT_NEEDED for following dynamic libs if used"),
256 NULL, TWO_DASHES, &Position_dependent_options::set_as_needed),
257 POSDEP_NOARG('\0', "no-as-needed",
258 N_("Always DT_NEEDED for following dynamic libs (default)"),
259 NULL, TWO_DASHES, &Position_dependent_options::clear_as_needed),
260 POSDEP_NOARG('\0', "whole-archive",
261 N_("Include all archive contents"),
263 &Position_dependent_options::set_whole_archive),
264 POSDEP_NOARG('\0', "no-whole-archive",
265 N_("Include only needed archive contents"),
267 &Position_dependent_options::clear_whole_archive),
268 SPECIAL('\0', "help", N_("Report usage information"), NULL,
272 const int options::Command_line_options::options_size =
273 sizeof (options) / sizeof (options[0]);
275 // The default values for the general options.
277 General_options::General_options()
278 : dynamic_linker_(NULL),
280 output_file_name_("a.out"),
281 is_relocatable_(false),
288 // The default values for the position dependent options.
290 Position_dependent_options::Position_dependent_options()
291 : do_static_search_(false),
293 include_whole_archive_(false)
297 // Input_arguments methods.
299 // Add a file to the list.
302 Input_arguments::add_file(const Input_file_argument& file)
304 if (!this->in_group_)
305 this->input_argument_list_.push_back(Input_argument(file));
308 gold_assert(!this->input_argument_list_.empty());
309 gold_assert(this->input_argument_list_.back().is_group());
310 this->input_argument_list_.back().group()->add_file(file);
317 Input_arguments::start_group()
319 gold_assert(!this->in_group_);
320 Input_file_group* group = new Input_file_group();
321 this->input_argument_list_.push_back(Input_argument(group));
322 this->in_group_ = true;
328 Input_arguments::end_group()
330 gold_assert(this->in_group_);
331 this->in_group_ = false;
334 // Command_line options.
336 Command_line::Command_line()
337 : options_(), position_options_(), inputs_()
341 // Process the command line options.
344 Command_line::process(int argc, char** argv)
346 const int options_size = options::Command_line_options::options_size;
347 const options::One_option* options =
348 options::Command_line_options::options;
349 bool no_more_options = false;
353 if (argv[i][0] != '-' || no_more_options)
355 this->add_file(argv[i], false);
360 // Option starting with '-'.
362 if (argv[i][1] == '-')
365 if (argv[i][2] == '\0')
367 no_more_options = true;
372 // Look for a long option match.
373 char* opt = argv[i] + dashes;
376 char* arg = strchr(opt, '=');
379 else if (i + 1 < argc)
386 for (j = 0; j < options_size; ++j)
388 if (options[j].long_option != NULL
391 != options::One_option::EXACTLY_TWO_DASHES))
392 && first == options[j].long_option[0]
393 && strcmp(opt, options[j].long_option) == 0)
395 if (options[j].special)
396 i += options[j].special(argc - 1, argv + i, opt, this);
399 if (!options[j].takes_argument())
407 this->usage(_("missing argument"), argv[i]);
409 this->apply_option(options[j], arg);
415 if (j < options_size)
418 // If we saw two dashes, we need to see a long option.
420 this->usage(_("unknown option"), argv[i]);
422 // Look for a short option match. There may be more than one
423 // short option in a given argument.
425 char* s = argv[i] + 1;
427 while (*s != '\0' && !done)
431 for (j = 0; j < options_size; ++j)
433 if (options[j].short_option == opt)
435 if (options[j].special)
437 // Undo the argument skip done above.
439 i += options[j].special(argc - i, argv + i, s, this);
445 if (options[j].takes_argument())
458 this->usage(_("missing argument"), opt);
460 this->apply_option(options[j], arg);
466 if (j >= options_size)
467 this->usage(_("unknown option"), *s);
473 if (this->inputs_.in_group())
475 fprintf(stderr, _("%s: missing group end"), program_name);
479 // FIXME: We should only do this when configured in native mode.
480 this->options_.add_to_search_path("/lib");
481 this->options_.add_to_search_path("/usr/lib");
484 // Apply a command line option.
487 Command_line::apply_option(const options::One_option& opt,
492 if (opt.general_noarg)
493 (this->options_.*(opt.general_noarg))();
494 else if (opt.dependent_noarg)
495 (this->position_options_.*(opt.dependent_noarg))();
502 (this->options_.*(opt.general_arg))(arg);
503 else if (opt.dependent_arg)
504 (this->position_options_.*(opt.dependent_arg))(arg);
510 // Add an input file or library.
513 Command_line::add_file(const char* name, bool is_lib)
515 Input_file_argument file(name, is_lib, this->position_options_);
516 this->inputs_.add_file(file);
519 // Handle the -l option, which requires special treatment.
522 Command_line::process_l_option(int argc, char** argv, char* arg)
534 libname = argv[argc + 1];
537 this->usage(_("missing argument"), arg);
539 this->add_file(libname, true);
544 // Handle the --start-group option.
547 Command_line::start_group(const char* arg)
549 if (this->inputs_.in_group())
550 this->usage(_("may not nest groups"), arg);
551 this->inputs_.start_group();
554 // Handle the --end-group option.
557 Command_line::end_group(const char* arg)
559 if (!this->inputs_.in_group())
560 this->usage(_("group end without group start"), arg);
561 this->inputs_.end_group();
564 // Report a usage error. */
567 Command_line::usage()
570 _("%s: use the --help option for usage information\n"),
576 Command_line::usage(const char* msg, const char *opt)
580 program_name, opt, msg);
585 Command_line::usage(const char* msg, char opt)
589 program_name, opt, msg);
593 } // End namespace gold.