parse.c

Go to the documentation of this file.

 
#include "config.h"
#include <getopt.h>
#include <stdbool.h>
#include <string.h>
#include <sys/param.h> // IWYU pragma: keep
#include <unistd.h>
#include "mutt/lib.h"
#include "objects.h"

static const struct option LongOptions[] = {
  // clang-format off
  // Shared options
  { "command",             required_argument, NULL, 'e' },
  { "config",              required_argument, NULL, 'F' },
  { "debug-file",          required_argument, NULL, 'l' },
  { "debug-level",         required_argument, NULL, 'd' },
  { "mbox-type",           required_argument, NULL, 'm' },
  { "no-system-config",    no_argument,       NULL, 'n' },
 
  // Help options
  { "help",                no_argument,       NULL, 'h' },
  { "license",             no_argument,       NULL, 'L' },
  { "version",             no_argument,       NULL, 'v' },
 
  // Info options
  { "alias",               required_argument, NULL, 'A' },
  { "dump-changed-config", no_argument,       NULL, 'X' },
  { "dump-config",         no_argument,       NULL, 'D' },
  { "hide-sensitive",      no_argument,       NULL, 'S' },
  { "query",               required_argument, NULL, 'Q' },
  { "with-docs",           no_argument,       NULL, 'O' },
 
  // Send options
  { "attach",              required_argument, NULL, 'a' },
  { "bcc",                 required_argument, NULL, 'b' },
  { "cc",                  required_argument, NULL, 'c' },
  { "crypto",              no_argument,       NULL, 'C' },
  { "draft",               required_argument, NULL, 'H' },
  { "edit-message",        no_argument,       NULL, 'E' },
  { "include",             required_argument, NULL, 'i' },
  { "subject",             required_argument, NULL, 's' },
 
  // TUI options
  { "browser",             no_argument,       NULL, 'y' },
  { "check-any-mail",      no_argument,       NULL, 'z' },
  { "check-new-mail",      no_argument,       NULL, 'Z' },
  { "folder",              required_argument, NULL, 'f' },
  { "nntp-browser",        no_argument,       NULL, 'G' },
  { "nntp-server",         required_argument, NULL, 'g' },
  { "postponed",           no_argument,       NULL, 'p' },
  { "read-only",           no_argument,       NULL, 'R' },
 
  { NULL, 0, NULL, 0 },
  // clang-format on
};

int check_help_mode(const char *mode)
{
  if (mutt_istr_equal(mode, "shared"))
    return HM_SHARED;
  if (mutt_istr_equal(mode, "help"))
    return HM_HELP;
  if (mutt_istr_equal(mode, "info"))
    return HM_INFO;
  if (mutt_istr_equal(mode, "send"))
    return HM_SEND;
  if (mutt_istr_equal(mode, "tui"))
    return HM_TUI;
  if (mutt_istr_equal(mode, "all"))
    return HM_ALL;
  return 0;
}

static int mop_up(int argc, char *const *argv, int index, struct StringArray *sa)
{
  int count = 0;
  for (int i = index; i < argc; i++, count++)
  {
    // Stop if we find '--' or '-X'
    if ((argv[i][0] == '-') && (argv[i][1] != '\0'))
      break;
 
    ARRAY_ADD(sa, mutt_str_dup(argv[i]));
  }
 
  return count;
}

bool cli_parse(int argc, char *const *argv, struct CommandLine *cli)
{
  if ((argc < 1) || !argv || !cli)
    return false;
 
  // Check for unsupported '=' syntax in options
  for (int i = 1; i < argc; i++)
  {
    if ((argv[i][0] == '-') && (argv[i][1] != '\0'))
    {
      const char *equals = strchr(argv[i], '=');
      if (equals)
      {
        // L10N: Neomutt doesn't support `-X=VALUE` or `--OPTION=VALUE`
        //       Use `-X VALUE` or `--OPTION VALUE` instead
        mutt_warning(_("Invalid option syntax: %s (use space instead of '=')"), argv[i]);
        cli->help.help = true;
        cli->help.is_set = true;
        return false;
      }
    }
  }
 
  // Any leading non-options must be addresses
  int count = mop_up(argc, argv, 1, &cli->send.addresses);
  if (count > 0)
  {
    cli->send.is_set = true;
    argc -= count;
    argv += count;
  }
 
  bool rc = true;
 
  opterr = 0; // We'll handle the errors
// Always initialise getopt() or the tests will fail
#if defined(BSD) || defined(__APPLE__)
  optreset = 1;
  optind = 1;
#else
  optind = 0;
#endif
 
  while (rc && (argc > 1) && (optind < argc))
  {
    int opt = getopt_long(argc, argv, "+:A:a:b:Cc:Dd:Ee:F:f:Gg:H:hi:l:m:nOpQ:RSs:vyZz",
                          LongOptions, NULL);
    switch (opt)
    {
      // ------------------------------------------------------------
      // Shared
      case 'F': // user config file
      {
        ARRAY_ADD(&cli->shared.user_files, mutt_str_dup(optarg));
        cli->shared.is_set = true;
        break;
      }
      case 'n': // no system config file
      {
        cli->shared.disable_system = true;
        cli->shared.is_set = true;
        break;
      }
      case 'e': // enter commands
      {
        ARRAY_ADD(&cli->shared.commands, mutt_str_dup(optarg));
        cli->shared.is_set = true;
        break;
      }
      case 'm': // mbox type
      {
        buf_strcpy(&cli->shared.mbox_type, optarg);
        cli->shared.is_set = true;
        break;
      }
      case 'd': // log level
      {
        buf_strcpy(&cli->shared.log_level, optarg);
        cli->shared.is_set = true;
        break;
      }
      case 'l': // log file
      {
        buf_strcpy(&cli->shared.log_file, optarg);
        cli->shared.is_set = true;
        break;
      }
 
      // ------------------------------------------------------------
      // Help
      case 'h': // help
      {
        if (optind < argc)
        {
          cli->help.mode = check_help_mode(argv[optind]);
          if (cli->help.mode != HM_NONE)
            optind++;
        }
        cli->help.help = true;
        cli->help.is_set = true;
        break;
      }
      case 'L': // license
      {
        cli->help.license = true;
        cli->help.is_set = true;
        break;
      }
      case 'v': // version, license
      {
        if (cli->help.version)
          cli->help.license = true;
        else
          cli->help.version = true;
 
        cli->help.is_set = true;
        break;
      }
 
      // ------------------------------------------------------------
      // Info
      case 'A': // alias lookup
      {
        ARRAY_ADD(&cli->info.alias_queries, mutt_str_dup(optarg));
        // '-A' can take multiple arguments
        optind += mop_up(argc, argv, optind, &cli->info.alias_queries);
        cli->info.is_set = true;
        break;
      }
      case 'D': // dump config, dump changed
      {
        if (cli->info.dump_config)
          cli->info.dump_changed = true;
        else
          cli->info.dump_config = true;
 
        cli->info.is_set = true;
        break;
      }
      case 'O': // one-liner help
      {
        cli->info.show_help = true;
        cli->info.is_set = true;
        break;
      }
      case 'Q': // query config&cli->send.attach
      {
        ARRAY_ADD(&cli->info.queries, mutt_str_dup(optarg));
        // '-Q' can take multiple arguments
        optind += mop_up(argc, argv, optind, &cli->info.queries);
        cli->info.is_set = true;
        break;
      }
      case 'S': // hide sensitive
      {
        cli->info.hide_sensitive = true;
        cli->info.is_set = true;
        break;
      }
      case 'X': // dump changed
      {
        cli->info.dump_config = true;
        cli->info.dump_changed = true;
        cli->info.is_set = true;
        break;
      }
 
      // ------------------------------------------------------------
      // Send
      case 'a': // attach file
      {
        ARRAY_ADD(&cli->send.attach, mutt_str_dup(optarg));
        // `-a` can take multiple arguments
        optind += mop_up(argc, argv, optind, &cli->send.attach);
        cli->send.is_set = true;
        break;
      }
      case 'b': // bcc:
      {
        ARRAY_ADD(&cli->send.bcc_list, mutt_str_dup(optarg));
        cli->send.is_set = true;
        break;
      }
      case 'C': // crypto
      {
        cli->send.use_crypto = true;
        cli->send.is_set = true;
        break;
      }
      case 'c': // cc:
      {
        ARRAY_ADD(&cli->send.cc_list, mutt_str_dup(optarg));
        cli->send.is_set = true;
        break;
      }
      case 'E': // edit file
      {
        cli->send.edit_infile = true;
        cli->send.is_set = true;
        break;
      }
      case 'H': // draft file
      {
        buf_strcpy(&cli->send.draft_file, optarg);
        cli->send.is_set = true;
        break;
      }
      case 'i': // include file
      {
        buf_strcpy(&cli->send.include_file, optarg);
        cli->send.is_set = true;
        break;
      }
      case 's': // subject:
      {
        buf_strcpy(&cli->send.subject, optarg);
        cli->send.is_set = true;
        break;
      }
 
      // ------------------------------------------------------------
      // TUI
      case 'f': // start folder
      {
        buf_strcpy(&cli->tui.folder, optarg);
        cli->tui.is_set = true;
        break;
      }
      case 'G': // list newsgroups
      {
        cli->tui.start_nntp = true;
        cli->tui.is_set = true;
        break;
      }
      case 'g': // news server
      {
        cli->tui.start_nntp = true;
        buf_strcpy(&cli->tui.nntp_server, optarg);
        cli->tui.is_set = true;
        break;
      }
      case 'p': // postponed
      {
        cli->tui.start_postponed = true;
        cli->tui.is_set = true;
        break;
      }
      case 'R': // read-only
      {
        cli->tui.read_only = true;
        cli->tui.is_set = true;
        break;
      }
      case 'y': // browser
      {
        cli->tui.start_browser = true;
        cli->tui.is_set = true;
        break;
      }
      case 'Z': // new mail
      {
        cli->tui.start_new_mail = true;
        cli->tui.is_set = true;
        break;
      }
      case 'z': // any mail
      {
        cli->tui.start_any_mail = true;
        cli->tui.is_set = true;
        break;
      }
 
      // ------------------------------------------------------------
      case -1: // end of options
      {
        for (int i = optind; i < argc; i++)
        {
          ARRAY_ADD(&cli->send.addresses, mutt_str_dup(argv[i]));
        }
        cli->send.is_set = true;
        optind = argc; // finish parsing
        break;
      }
      default: // error
      {
        if (opt == '?')
        {
          // L10N: e.g. `neomutt -X`
          mutt_warning(_("Invalid option: %c"), optopt);
        }
        else if (opt == ':')
        {
          // L10N: e.g. `neomutt -F`
          mutt_warning(_("Option %c requires an argument"), optopt);
        }
 
        cli->help.help = true;
        cli->help.is_set = true;
        rc = false; // stop parsing
        break;
      }
    }
  }
 
  return rc;
}