555 lines
17 KiB
Ruby
555 lines
17 KiB
Ruby
# typed: false
|
|
# frozen_string_literal: true
|
|
|
|
require "env_config"
|
|
require "cask/config"
|
|
require "cli/args"
|
|
require "optparse"
|
|
require "set"
|
|
require "utils/tty"
|
|
|
|
COMMAND_DESC_WIDTH = 80
|
|
OPTION_DESC_WIDTH = 43
|
|
|
|
module Homebrew
|
|
module CLI
|
|
class Parser
|
|
attr_reader :processed_options, :hide_from_man_page
|
|
|
|
def self.from_cmd_path(cmd_path)
|
|
cmd_args_method_name = Commands.args_method_name(cmd_path)
|
|
|
|
begin
|
|
Homebrew.send(cmd_args_method_name) if require?(cmd_path)
|
|
rescue NoMethodError => e
|
|
raise if e.name != cmd_args_method_name
|
|
|
|
nil
|
|
end
|
|
end
|
|
|
|
def self.global_cask_options
|
|
[
|
|
[:flag, "--appdir=", {
|
|
description: "Target location for Applications. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`",
|
|
}],
|
|
[:flag, "--colorpickerdir=", {
|
|
description: "Target location for Color Pickers. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`",
|
|
}],
|
|
[:flag, "--prefpanedir=", {
|
|
description: "Target location for Preference Panes. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`",
|
|
}],
|
|
[:flag, "--qlplugindir=", {
|
|
description: "Target location for QuickLook Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`",
|
|
}],
|
|
[:flag, "--mdimporterdir=", {
|
|
description: "Target location for Spotlight Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`",
|
|
}],
|
|
[:flag, "--dictionarydir=", {
|
|
description: "Target location for Dictionaries. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`",
|
|
}],
|
|
[:flag, "--fontdir=", {
|
|
description: "Target location for Fonts. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`",
|
|
}],
|
|
[:flag, "--servicedir=", {
|
|
description: "Target location for Services. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`",
|
|
}],
|
|
[:flag, "--input_methoddir=", {
|
|
description: "Target location for Input Methods. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`",
|
|
}],
|
|
[:flag, "--internet_plugindir=", {
|
|
description: "Target location for Internet Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`",
|
|
}],
|
|
[:flag, "--audio_unit_plugindir=", {
|
|
description: "Target location for Audio Unit Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`",
|
|
}],
|
|
[:flag, "--vst_plugindir=", {
|
|
description: "Target location for VST Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`",
|
|
}],
|
|
[:flag, "--vst3_plugindir=", {
|
|
description: "Target location for VST3 Plugins. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`",
|
|
}],
|
|
[:flag, "--screen_saverdir=", {
|
|
description: "Target location for Screen Savers. " \
|
|
"Default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`",
|
|
}],
|
|
[:comma_array, "--language", {
|
|
description: "Set language of the Cask to install. The first matching " \
|
|
"language is used, otherwise the default language on the Cask. " \
|
|
"The default value is the `language of your system`",
|
|
}],
|
|
]
|
|
end
|
|
|
|
def self.global_options
|
|
[
|
|
["-d", "--debug", "Display any debugging information."],
|
|
["-q", "--quiet", "Suppress any warnings."],
|
|
["-v", "--verbose", "Make some output more verbose."],
|
|
["-h", "--help", "Show this message."],
|
|
]
|
|
end
|
|
|
|
def initialize(&block)
|
|
@parser = OptionParser.new
|
|
|
|
@parser.summary_indent = " " * 2
|
|
|
|
# Disable default handling of `--version` switch.
|
|
@parser.base.long.delete("version")
|
|
|
|
# Disable default handling of `--help` switch.
|
|
@parser.base.long.delete("help")
|
|
|
|
@args = Homebrew::CLI::Args.new
|
|
|
|
@constraints = []
|
|
@conflicts = []
|
|
@switch_sources = {}
|
|
@processed_options = []
|
|
@max_named_args = nil
|
|
@min_named_args = nil
|
|
@min_named_type = nil
|
|
@hide_from_man_page = false
|
|
@formula_options = false
|
|
|
|
self.class.global_options.each do |short, long, desc|
|
|
switch short, long, description: desc, env: option_to_name(long), method: :on_tail
|
|
end
|
|
|
|
instance_eval(&block) if block_given?
|
|
end
|
|
|
|
def switch(*names, description: nil, env: nil, required_for: nil, depends_on: nil, method: :on)
|
|
global_switch = names.first.is_a?(Symbol)
|
|
return if global_switch
|
|
|
|
description = option_to_description(*names) if description.nil?
|
|
process_option(*names, description)
|
|
@parser.public_send(method, *names, *wrap_option_desc(description)) do |value|
|
|
value = if names.any? { |name| name.start_with?("--[no-]") }
|
|
value
|
|
else
|
|
true
|
|
end
|
|
|
|
set_switch(*names, value: value, from: :args)
|
|
end
|
|
|
|
names.each do |name|
|
|
set_constraints(name, required_for: required_for, depends_on: depends_on)
|
|
end
|
|
|
|
env_value = env?(env)
|
|
set_switch(*names, value: env_value, from: :env) unless env_value.nil?
|
|
end
|
|
alias switch_option switch
|
|
|
|
def env?(env)
|
|
return if env.blank?
|
|
|
|
Homebrew::EnvConfig.try(:"#{env}?")
|
|
end
|
|
|
|
def usage_banner(text)
|
|
@parser.banner = "#{text}\n"
|
|
end
|
|
|
|
def usage_banner_text
|
|
@parser.banner
|
|
.gsub(/^ - (`[^`]+`)\s+/, "\n- \\1 \n ") # Format `cask` subcommands as MarkDown list.
|
|
end
|
|
|
|
def comma_array(name, description: nil)
|
|
name = name.chomp "="
|
|
description = option_to_description(name) if description.nil?
|
|
process_option(name, description)
|
|
@parser.on(name, OptionParser::REQUIRED_ARGUMENT, Array, *wrap_option_desc(description)) do |list|
|
|
@args[option_to_name(name)] = list
|
|
end
|
|
end
|
|
|
|
def flag(*names, description: nil, required_for: nil, depends_on: nil)
|
|
required = if names.any? { |name| name.end_with? "=" }
|
|
OptionParser::REQUIRED_ARGUMENT
|
|
else
|
|
OptionParser::OPTIONAL_ARGUMENT
|
|
end
|
|
names.map! { |name| name.chomp "=" }
|
|
description = option_to_description(*names) if description.nil?
|
|
process_option(*names, description)
|
|
@parser.on(*names, *wrap_option_desc(description), required) do |option_value|
|
|
names.each do |name|
|
|
@args[option_to_name(name)] = option_value
|
|
end
|
|
end
|
|
|
|
names.each do |name|
|
|
set_constraints(name, required_for: required_for, depends_on: depends_on)
|
|
end
|
|
end
|
|
|
|
def conflicts(*options)
|
|
@conflicts << options.map { |option| option_to_name(option) }
|
|
end
|
|
|
|
def option_to_name(option)
|
|
option.sub(/\A--?(\[no-\])?/, "")
|
|
.tr("-", "_")
|
|
.delete("=")
|
|
end
|
|
|
|
def name_to_option(name)
|
|
if name.length == 1
|
|
"-#{name}"
|
|
else
|
|
"--#{name.tr("_", "-")}"
|
|
end
|
|
end
|
|
|
|
def option_to_description(*names)
|
|
names.map { |name| name.to_s.sub(/\A--?/, "").tr("-", " ") }.max
|
|
end
|
|
|
|
def parse_remaining(argv, ignore_invalid_options: false)
|
|
i = 0
|
|
remaining = []
|
|
|
|
argv, non_options = split_non_options(argv)
|
|
|
|
while i < argv.count
|
|
begin
|
|
begin
|
|
arg = argv[i]
|
|
|
|
remaining << arg unless @parser.parse([arg]).empty?
|
|
rescue OptionParser::MissingArgument
|
|
raise if i + 1 >= argv.count
|
|
|
|
args = argv[i..(i + 1)]
|
|
@parser.parse(args)
|
|
i += 1
|
|
end
|
|
rescue OptionParser::InvalidOption
|
|
if ignore_invalid_options
|
|
remaining << arg
|
|
else
|
|
$stderr.puts generate_help_text
|
|
raise
|
|
end
|
|
end
|
|
|
|
i += 1
|
|
end
|
|
|
|
[remaining, non_options]
|
|
end
|
|
|
|
def parse(argv = ARGV.freeze, ignore_invalid_options: false)
|
|
raise "Arguments were already parsed!" if @args_parsed
|
|
|
|
# If we accept formula options, parse once allowing invalid options
|
|
# so we can get the remaining list containing formula names.
|
|
if @formula_options
|
|
remaining, non_options = parse_remaining(argv, ignore_invalid_options: true)
|
|
|
|
argv = [*remaining, "--", *non_options]
|
|
|
|
formulae(argv).each do |f|
|
|
next if f.options.empty?
|
|
|
|
f.options.each do |o|
|
|
name = o.flag
|
|
description = "`#{f.name}`: #{o.description}"
|
|
if name.end_with? "="
|
|
flag name, description: description
|
|
else
|
|
switch name, description: description
|
|
end
|
|
|
|
conflicts "--cask", name
|
|
end
|
|
end
|
|
end
|
|
|
|
remaining, non_options = parse_remaining(argv, ignore_invalid_options: ignore_invalid_options)
|
|
|
|
named_args = if ignore_invalid_options
|
|
[]
|
|
else
|
|
remaining + non_options
|
|
end
|
|
|
|
unless ignore_invalid_options
|
|
check_constraint_violations
|
|
check_named_args(named_args)
|
|
end
|
|
|
|
@args.freeze_named_args!(named_args)
|
|
@args.freeze_remaining_args!(non_options.empty? ? remaining : [*remaining, "--", non_options])
|
|
@args.freeze_processed_options!(@processed_options)
|
|
|
|
@args_parsed = true
|
|
|
|
if !ignore_invalid_options && @args.help?
|
|
puts generate_help_text
|
|
exit
|
|
end
|
|
|
|
@args
|
|
end
|
|
|
|
def generate_help_text
|
|
Formatter.wrap(
|
|
@parser.to_s.gsub(/^ - (`[^`]+`\s+)/, " \\1"), # Remove `-` from `cask` subcommand listing.
|
|
COMMAND_DESC_WIDTH,
|
|
)
|
|
.sub(/^/, "#{Tty.bold}Usage: brew#{Tty.reset} ")
|
|
.gsub(/`(.*?)`/m, "#{Tty.bold}\\1#{Tty.reset}")
|
|
.gsub(%r{<([^\s]+?://[^\s]+?)>}) { |url| Formatter.url(url) }
|
|
.gsub(/<(.*?)>/m, "#{Tty.underline}\\1#{Tty.reset}")
|
|
.gsub(/\*(.*?)\*/m, "#{Tty.underline}\\1#{Tty.reset}")
|
|
end
|
|
|
|
def cask_options
|
|
self.class.global_cask_options.each do |method, *args, **options|
|
|
send(method, *args, **options)
|
|
conflicts "--formula", args.last
|
|
end
|
|
end
|
|
|
|
def formula_options
|
|
@formula_options = true
|
|
end
|
|
|
|
def max_named(count)
|
|
raise TypeError, "Unsupported type #{count.class.name} for max_named" unless count.is_a?(Integer)
|
|
|
|
@max_named_args = count
|
|
end
|
|
|
|
def min_named(count_or_type)
|
|
case count_or_type
|
|
when Integer
|
|
@min_named_args = count_or_type
|
|
@min_named_type = nil
|
|
when Symbol
|
|
@min_named_args = 1
|
|
@min_named_type = count_or_type
|
|
else
|
|
raise TypeError, "Unsupported type #{count_or_type.class.name} for min_named"
|
|
end
|
|
end
|
|
|
|
def named(count_or_type)
|
|
case count_or_type
|
|
when Integer
|
|
@max_named_args = @min_named_args = count_or_type
|
|
@min_named_type = nil
|
|
when Symbol
|
|
@max_named_args = @min_named_args = 1
|
|
@min_named_type = count_or_type
|
|
else
|
|
raise TypeError, "Unsupported type #{count_or_type.class.name} for named"
|
|
end
|
|
end
|
|
|
|
def hide_from_man_page!
|
|
@hide_from_man_page = true
|
|
end
|
|
|
|
private
|
|
|
|
def set_switch(*names, value:, from:)
|
|
names.each do |name|
|
|
@switch_sources[option_to_name(name)] = from
|
|
@args["#{option_to_name(name)}?"] = value
|
|
end
|
|
end
|
|
|
|
def disable_switch(*names)
|
|
names.each do |name|
|
|
@args.delete_field("#{option_to_name(name)}?")
|
|
end
|
|
end
|
|
|
|
def option_passed?(name)
|
|
@args[name.to_sym] || @args["#{name}?".to_sym]
|
|
end
|
|
|
|
def wrap_option_desc(desc)
|
|
Formatter.wrap(desc, OPTION_DESC_WIDTH).split("\n")
|
|
end
|
|
|
|
def set_constraints(name, depends_on:, required_for:)
|
|
secondary = option_to_name(name)
|
|
unless required_for.nil?
|
|
primary = option_to_name(required_for)
|
|
@constraints << [primary, secondary, :mandatory]
|
|
end
|
|
|
|
return if depends_on.nil?
|
|
|
|
primary = option_to_name(depends_on)
|
|
@constraints << [primary, secondary, :optional]
|
|
end
|
|
|
|
def check_constraints
|
|
@constraints.each do |primary, secondary, constraint_type|
|
|
primary_passed = option_passed?(primary)
|
|
secondary_passed = option_passed?(secondary)
|
|
if :mandatory.equal?(constraint_type) && primary_passed && !secondary_passed
|
|
raise OptionConstraintError.new(primary, secondary)
|
|
end
|
|
raise OptionConstraintError.new(primary, secondary, missing: true) if secondary_passed && !primary_passed
|
|
end
|
|
end
|
|
|
|
def check_conflicts
|
|
@conflicts.each do |mutually_exclusive_options_group|
|
|
violations = mutually_exclusive_options_group.select do |option|
|
|
option_passed? option
|
|
end
|
|
|
|
next if violations.count < 2
|
|
|
|
env_var_options = violations.select do |option|
|
|
@switch_sources[option_to_name(option)] == :env
|
|
end
|
|
|
|
select_cli_arg = violations.count - env_var_options.count == 1
|
|
raise OptionConflictError, violations.map(&method(:name_to_option)) unless select_cli_arg
|
|
|
|
env_var_options.each(&method(:disable_switch))
|
|
end
|
|
end
|
|
|
|
def check_invalid_constraints
|
|
@conflicts.each do |mutually_exclusive_options_group|
|
|
@constraints.each do |p, s|
|
|
next unless Set[p, s].subset?(Set[*mutually_exclusive_options_group])
|
|
|
|
raise InvalidConstraintError.new(p, s)
|
|
end
|
|
end
|
|
end
|
|
|
|
def check_constraint_violations
|
|
check_invalid_constraints
|
|
check_conflicts
|
|
check_constraints
|
|
end
|
|
|
|
def check_named_args(args)
|
|
min_exception = case @min_named_type
|
|
when :cask
|
|
Cask::CaskUnspecifiedError
|
|
when :formula
|
|
FormulaUnspecifiedError
|
|
when :formula_or_cask
|
|
FormulaOrCaskUnspecifiedError
|
|
when :keg
|
|
KegUnspecifiedError
|
|
else
|
|
MinNamedArgumentsError.new(@min_named_args)
|
|
end
|
|
raise min_exception if @min_named_args && args.size < @min_named_args
|
|
raise MaxNamedArgumentsError, @max_named_args if @max_named_args && args.size > @max_named_args
|
|
end
|
|
|
|
def process_option(*args)
|
|
option, = @parser.make_switch(args)
|
|
@processed_options << [option.short.first, option.long.first, option.arg, option.desc.first]
|
|
end
|
|
|
|
def split_non_options(argv)
|
|
if sep = argv.index("--")
|
|
[argv.take(sep), argv.drop(sep + 1)]
|
|
else
|
|
[argv, []]
|
|
end
|
|
end
|
|
|
|
def formulae(argv)
|
|
argv, non_options = split_non_options(argv)
|
|
|
|
named_args = argv.reject { |arg| arg.start_with?("-") } + non_options
|
|
spec = if argv.include?("--HEAD")
|
|
:head
|
|
else
|
|
:stable
|
|
end
|
|
|
|
# Only lowercase names, not paths, bottle filenames or URLs
|
|
named_args.map do |arg|
|
|
next if arg.match?(HOMEBREW_CASK_TAP_CASK_REGEX)
|
|
|
|
begin
|
|
Formulary.factory(arg, spec, flags: argv.select { |a| a.start_with?("--") })
|
|
rescue FormulaUnavailableError
|
|
nil
|
|
end
|
|
end.compact.uniq(&:name)
|
|
end
|
|
end
|
|
|
|
class OptionConstraintError < UsageError
|
|
def initialize(arg1, arg2, missing: false)
|
|
arg1 = "--#{arg1.tr("_", "-")}"
|
|
arg2 = "--#{arg2.tr("_", "-")}"
|
|
|
|
message = if missing
|
|
"`#{arg2}` cannot be passed without `#{arg1}`."
|
|
else
|
|
"`#{arg1}` and `#{arg2}` should be passed together."
|
|
end
|
|
super message
|
|
end
|
|
end
|
|
|
|
class OptionConflictError < UsageError
|
|
def initialize(args)
|
|
args_list = args.map(&Formatter.public_method(:option))
|
|
.join(" and ")
|
|
super "Options #{args_list} are mutually exclusive."
|
|
end
|
|
end
|
|
|
|
class InvalidConstraintError < UsageError
|
|
def initialize(arg1, arg2)
|
|
super "`#{arg1}` and `#{arg2}` cannot be mutually exclusive and mutually dependent simultaneously."
|
|
end
|
|
end
|
|
|
|
class MaxNamedArgumentsError < UsageError
|
|
def initialize(maximum)
|
|
super case maximum
|
|
when 0
|
|
"This command does not take named arguments."
|
|
else
|
|
"This command does not take more than #{maximum} named #{"argument".pluralize(maximum)}"
|
|
end
|
|
end
|
|
end
|
|
|
|
class MinNamedArgumentsError < UsageError
|
|
def initialize(minimum)
|
|
super "This command requires at least #{minimum} named #{"argument".pluralize(minimum)}."
|
|
end
|
|
end
|
|
end
|
|
end
|