2N/A/* arg.c - argument parser */
2N/A/*
2N/A * GRUB -- GRand Unified Bootloader
2N/A * Copyright (C) 2003,2004,2005,2007,2008 Free Software Foundation, Inc.
2N/A *
2N/A * GRUB is free software: you can redistribute it and/or modify
2N/A * it under the terms of the GNU General Public License as published by
2N/A * the Free Software Foundation, either version 3 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * GRUB is distributed in the hope that it will be useful,
2N/A * but WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
2N/A */
2N/A
2N/A#include <grub/misc.h>
2N/A#include <grub/mm.h>
2N/A#include <grub/err.h>
2N/A#include <grub/term.h>
2N/A#include <grub/extcmd.h>
2N/A#include <grub/i18n.h>
2N/A
2N/A/* Built-in parser for default options. */
2N/Astatic const struct grub_arg_option help_options[] =
2N/A {
2N/A {"help", 0, 0,
2N/A N_("Display this help and exit."), 0, ARG_TYPE_NONE},
2N/A {"usage", 0, 0,
2N/A N_("Display the usage of this command and exit."), 0, ARG_TYPE_NONE},
2N/A {0, 0, 0, 0, 0, 0}
2N/A };
2N/A
2N/Astatic struct grub_arg_option *
2N/Afind_short (const struct grub_arg_option *options, char c)
2N/A{
2N/A struct grub_arg_option *found = 0;
2N/A auto struct grub_arg_option *fnd_short (const struct grub_arg_option *opt);
2N/A
2N/A struct grub_arg_option *fnd_short (const struct grub_arg_option *opt)
2N/A {
2N/A while (opt->doc)
2N/A {
2N/A if (opt->shortarg == c)
2N/A return (struct grub_arg_option *) opt;
2N/A opt++;
2N/A }
2N/A return 0;
2N/A }
2N/A
2N/A if (options)
2N/A found = fnd_short (options);
2N/A
2N/A if (! found)
2N/A {
2N/A switch (c)
2N/A {
2N/A case 'h':
2N/A found = (struct grub_arg_option *) help_options;
2N/A break;
2N/A
2N/A case 'u':
2N/A found = (struct grub_arg_option *) (help_options + 1);
2N/A break;
2N/A
2N/A default:
2N/A break;
2N/A }
2N/A }
2N/A
2N/A return found;
2N/A}
2N/A
2N/Astatic struct grub_arg_option *
2N/Afind_long (const struct grub_arg_option *options, const char *s, int len)
2N/A{
2N/A struct grub_arg_option *found = 0;
2N/A auto struct grub_arg_option *fnd_long (const struct grub_arg_option *opt);
2N/A
2N/A struct grub_arg_option *fnd_long (const struct grub_arg_option *opt)
2N/A {
2N/A while (opt->doc)
2N/A {
2N/A if (opt->longarg && ! grub_strncmp (opt->longarg, s, len) &&
2N/A opt->longarg[len] == '\0')
2N/A return (struct grub_arg_option *) opt;
2N/A opt++;
2N/A }
2N/A return 0;
2N/A }
2N/A
2N/A if (options)
2N/A found = fnd_long (options);
2N/A
2N/A if (! found)
2N/A found = fnd_long (help_options);
2N/A
2N/A return found;
2N/A}
2N/A
2N/Astatic void
2N/Ashow_usage (grub_extcmd_t cmd)
2N/A{
2N/A grub_printf ("%s %s %s\n", _("Usage:"), cmd->cmd->name, _(cmd->cmd->summary));
2N/A}
2N/A
2N/Avoid
2N/Agrub_arg_show_help (grub_extcmd_t cmd)
2N/A{
2N/A auto void showargs (const struct grub_arg_option *opt);
2N/A int h_is_used = 0;
2N/A int u_is_used = 0;
2N/A
2N/A auto void showargs (const struct grub_arg_option *opt)
2N/A {
2N/A for (; opt->doc; opt++)
2N/A {
2N/A int spacing = 20;
2N/A
2N/A if (opt->shortarg && grub_isgraph (opt->shortarg))
2N/A grub_printf ("-%c%c ", opt->shortarg, opt->longarg ? ',':' ');
2N/A else if (opt == help_options && ! h_is_used)
2N/A grub_printf ("-h, ");
2N/A else if (opt == help_options + 1 && ! u_is_used)
2N/A grub_printf ("-u, ");
2N/A else
2N/A grub_printf (" ");
2N/A
2N/A if (opt->longarg)
2N/A {
2N/A grub_printf ("--%s", opt->longarg);
2N/A spacing -= grub_strlen (opt->longarg) + 2;
2N/A
2N/A if (opt->arg)
2N/A {
2N/A grub_printf ("=%s", opt->arg);
2N/A spacing -= grub_strlen (opt->arg) + 1;
2N/A }
2N/A }
2N/A
2N/A if (spacing < 0)
2N/A spacing = 3;
2N/A
2N/A while (spacing--)
2N/A grub_xputs (" ");
2N/A
2N/A grub_printf ("%s\n", _(opt->doc));
2N/A
2N/A switch (opt->shortarg)
2N/A {
2N/A case 'h':
2N/A h_is_used = 1;
2N/A break;
2N/A
2N/A case 'u':
2N/A u_is_used = 1;
2N/A break;
2N/A
2N/A default:
2N/A break;
2N/A }
2N/A }
2N/A }
2N/A
2N/A show_usage (cmd);
2N/A grub_printf ("%s\n\n", _(cmd->cmd->description));
2N/A if (cmd->options)
2N/A showargs (cmd->options);
2N/A showargs (help_options);
2N/A#if 0
2N/A grub_printf ("\nReport bugs to <%s>.\n", PACKAGE_BUGREPORT);
2N/A#endif
2N/A}
2N/A
2N/A
2N/Astatic int
2N/Aparse_option (grub_extcmd_t cmd, const struct grub_arg_option *opt,
2N/A char *arg, struct grub_arg_list *usr)
2N/A{
2N/A if (opt == help_options)
2N/A {
2N/A grub_arg_show_help (cmd);
2N/A return -1;
2N/A }
2N/A
2N/A if (opt == help_options + 1)
2N/A {
2N/A show_usage (cmd);
2N/A return -1;
2N/A }
2N/A {
2N/A int found = opt - cmd->options;
2N/A
2N/A if (opt->flags & GRUB_ARG_OPTION_REPEATABLE)
2N/A {
2N/A usr[found].args[usr[found].set++] = arg;
2N/A usr[found].args[usr[found].set] = NULL;
2N/A }
2N/A else
2N/A {
2N/A usr[found].set = 1;
2N/A usr[found].arg = arg;
2N/A }
2N/A }
2N/A
2N/A return 0;
2N/A}
2N/A
2N/Aint
2N/Agrub_arg_parse (grub_extcmd_t cmd, int argc, char **argv,
2N/A struct grub_arg_list *usr, char ***args, int *argnum)
2N/A{
2N/A int curarg;
2N/A int arglen;
2N/A char **argl = 0;
2N/A int num = 0;
2N/A auto grub_err_t add_arg (char *s);
2N/A
2N/A grub_err_t add_arg (char *s)
2N/A {
2N/A char **p = argl;
2N/A argl = grub_realloc (argl, (++num + 1) * sizeof (char *));
2N/A if (! argl)
2N/A {
2N/A grub_free (p);
2N/A return grub_errno;
2N/A }
2N/A argl[num - 1] = s;
2N/A argl[num] = NULL;
2N/A return 0;
2N/A }
2N/A
2N/A
2N/A for (curarg = 0; curarg < argc; curarg++)
2N/A {
2N/A char *arg = argv[curarg];
2N/A struct grub_arg_option *opt;
2N/A char *option = 0;
2N/A
2N/A /* No option is used. */
2N/A if ((num && (cmd->cmd->flags & GRUB_COMMAND_OPTIONS_AT_START))
2N/A || arg[0] != '-' || grub_strlen (arg) == 1)
2N/A {
2N/A if (add_arg (arg) != 0)
2N/A goto fail;
2N/A
2N/A continue;
2N/A }
2N/A
2N/A /* One or more short options. */
2N/A if (arg[1] != '-')
2N/A {
2N/A char *curshort;
2N/A
2N/A if (cmd->cmd->flags & GRUB_COMMAND_ACCEPT_DASH)
2N/A {
2N/A for (curshort = arg + 1; *curshort; curshort++)
2N/A if (!find_short (cmd->options, *curshort))
2N/A break;
2N/A
2N/A if (*curshort)
2N/A {
2N/A if (add_arg (arg) != 0)
2N/A goto fail;
2N/A continue;
2N/A }
2N/A }
2N/A
2N/A curshort = arg + 1;
2N/A
2N/A while (1)
2N/A {
2N/A opt = find_short (cmd->options, *curshort);
2N/A
2N/A if (! opt)
2N/A {
2N/A grub_error (GRUB_ERR_BAD_ARGUMENT,
2N/A "unknown argument `-%c'", *curshort);
2N/A goto fail;
2N/A }
2N/A
2N/A curshort++;
2N/A
2N/A /* Parse all arguments here except the last one because
2N/A it can have an argument value. */
2N/A if (*curshort)
2N/A {
2N/A if (parse_option (cmd, opt, 0, usr) || grub_errno)
2N/A goto fail;
2N/A }
2N/A else
2N/A {
2N/A if (opt->type != ARG_TYPE_NONE)
2N/A {
2N/A if (curarg + 1 < argc)
2N/A {
2N/A char *nextarg = argv[curarg + 1];
2N/A if (!(opt->flags & GRUB_ARG_OPTION_OPTIONAL)
2N/A || (grub_strlen (nextarg) < 2 || nextarg[0] != '-'))
2N/A option = argv[++curarg];
2N/A }
2N/A }
2N/A break;
2N/A }
2N/A }
2N/A
2N/A }
2N/A else /* The argument starts with "--". */
2N/A {
2N/A /* If the argument "--" is used just pass the other
2N/A arguments. */
2N/A if (grub_strlen (arg) == 2)
2N/A {
2N/A for (curarg++; curarg < argc; curarg++)
2N/A if (add_arg (argv[curarg]) != 0)
2N/A goto fail;
2N/A break;
2N/A }
2N/A
2N/A option = grub_strchr (arg, '=');
2N/A if (option)
2N/A {
2N/A arglen = option - arg - 2;
2N/A option++;
2N/A }
2N/A else
2N/A arglen = grub_strlen (arg) - 2;
2N/A
2N/A opt = find_long (cmd->options, arg + 2, arglen);
2N/A
2N/A if (!option && argv[curarg + 1] && argv[curarg + 1][0] != '-'
2N/A && opt && opt->type != ARG_TYPE_NONE)
2N/A option = argv[++curarg];
2N/A
2N/A if (!opt && (cmd->cmd->flags & GRUB_COMMAND_ACCEPT_DASH))
2N/A {
2N/A if (add_arg (arg) != 0)
2N/A goto fail;
2N/A continue;
2N/A }
2N/A
2N/A if (! opt)
2N/A {
2N/A grub_error (GRUB_ERR_BAD_ARGUMENT, "unknown argument `%s'", arg);
2N/A goto fail;
2N/A }
2N/A }
2N/A
2N/A if (! (opt->type == ARG_TYPE_NONE
2N/A || (! option && (opt->flags & GRUB_ARG_OPTION_OPTIONAL))))
2N/A {
2N/A if (! option)
2N/A {
2N/A grub_error (GRUB_ERR_BAD_ARGUMENT,
2N/A "missing mandatory option for `%s'", opt->longarg);
2N/A goto fail;
2N/A }
2N/A
2N/A switch (opt->type)
2N/A {
2N/A case ARG_TYPE_NONE:
2N/A /* This will never happen. */
2N/A break;
2N/A
2N/A case ARG_TYPE_STRING:
2N/A /* No need to do anything. */
2N/A break;
2N/A
2N/A case ARG_TYPE_INT:
2N/A {
2N/A char *tail;
2N/A
2N/A grub_strtoull (option, &tail, 0);
2N/A if (tail == 0 || tail == option || *tail != '\0' || grub_errno)
2N/A {
2N/A grub_error (GRUB_ERR_BAD_ARGUMENT,
2N/A "the argument `%s' requires an integer",
2N/A arg);
2N/A
2N/A goto fail;
2N/A }
2N/A break;
2N/A }
2N/A
2N/A case ARG_TYPE_DEVICE:
2N/A case ARG_TYPE_DIR:
2N/A case ARG_TYPE_FILE:
2N/A case ARG_TYPE_PATHNAME:
2N/A /* XXX: Not implemented. */
2N/A break;
2N/A }
2N/A if (parse_option (cmd, opt, option, usr) || grub_errno)
2N/A goto fail;
2N/A }
2N/A else
2N/A {
2N/A if (option)
2N/A {
2N/A grub_error (GRUB_ERR_BAD_ARGUMENT,
2N/A "a value was assigned to the argument `%s' while it "
2N/A "doesn't require an argument", arg);
2N/A goto fail;
2N/A }
2N/A
2N/A if (parse_option (cmd, opt, 0, usr) || grub_errno)
2N/A goto fail;
2N/A }
2N/A }
2N/A
2N/A *args = argl;
2N/A *argnum = num;
2N/A return 1;
2N/A
2N/A fail:
2N/A return 0;
2N/A}
2N/A
2N/Astruct grub_arg_list*
2N/Agrub_arg_list_alloc(grub_extcmd_t extcmd, int argc,
2N/A char **argv __attribute__((unused)))
2N/A{
2N/A int i;
2N/A char **args;
2N/A unsigned argcnt;
2N/A struct grub_arg_list *list;
2N/A const struct grub_arg_option *options;
2N/A
2N/A options = extcmd->options;
2N/A if (! options)
2N/A return 0;
2N/A
2N/A argcnt = 0;
2N/A for (i = 0; options[i].doc; i++)
2N/A {
2N/A if (options[i].flags & GRUB_ARG_OPTION_REPEATABLE)
2N/A argcnt += (argc + 1) / 2 + 1; /* max possible for any option */
2N/A }
2N/A
2N/A list = grub_zalloc (sizeof (*list) * i + sizeof (char*) * argcnt);
2N/A if (! list)
2N/A return 0;
2N/A
2N/A args = (char**) (list + i);
2N/A for (i = 0; options[i].doc; i++)
2N/A {
2N/A list[i].set = 0;
2N/A list[i].arg = 0;
2N/A
2N/A if (options[i].flags & GRUB_ARG_OPTION_REPEATABLE)
2N/A {
2N/A list[i].args = args;
2N/A args += argc / 2 + 1;
2N/A }
2N/A }
2N/A return list;
2N/A}