Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

504 lines (416 sloc) 19.068 kb
(ns ^{:author "Gareth Jones, Sung Pae"}
(:use [clojure.string :as s :only [replace]]
[clojure.pprint :only [cl-format]])
(:refer-clojure :exclude [replace]))
(defn- tokenize-args
"Reduce arguments sequence into [opt-type opt ?optarg?] vectors and a vector
of remaining arguments. Returns as [option-tokens remaining-args].
Expands clumped short options like \"-abc\" into:
[[:short-opt \"-a\"] [:short-opt \"-b\"] [:short-opt \"-c\"]]
If \"-b\" were in the set of options that require arguments, \"-abc\" would
then be interpreted as: [[:short-opt \"-a\"] [:short-opt \"-b\" \"c\"]]
Long options with `=` are always parsed as option + optarg, even if nothing
follows the `=` sign.
If the :in-order flag is true, the first non-option, non-optarg argument
stops options processing. This is useful for handling subcommand options."
[required-set args & options]
(let [{:keys [in-order]} options]
(loop [opts [] argv [] [car & cdr] args]
(if car
(condp re-seq car
;; Double dash always ends options processing
#"^--$" (recur opts (into argv cdr) [])
;; Long options with assignment always passes optarg, required or not
#"^--\S+=" (recur (conj opts (into [:long-opt] (s/split car #"=" 2)))
argv cdr)
;; Long options, consumes cdr head if needed
#"^--" (let [[optarg cdr] (if (contains? required-set car)
[(first cdr) (rest cdr)]
[nil cdr])]
(recur (conj opts (into [:long-opt car] (if optarg [optarg] [])))
argv cdr))
;; Short options, expands clumped opts until an optarg is required
#"^-." (let [[os cdr] (loop [os [] [c & cs] (rest car)]
(let [o (str \- c)]
(if (contains? required-set o)
(if (seq cs)
;; Get optarg from rest of car
[(conj os [:short-opt o (s/join cs)]) cdr]
;; Get optarg from head of cdr
[(conj os [:short-opt o (first cdr)]) (rest cdr)])
(if (seq cs)
(recur (conj os [:short-opt o]) cs)
[(conj os [:short-opt o]) cdr]))))]
(recur (into opts os) argv cdr))
(if in-order
(recur opts (into argv (cons car cdr)) [])
(recur opts (conj argv car) cdr)))
[opts argv]))))
(defn- normalize-args
"Rewrite arguments sequence into a normalized form that is parsable by cli."
[specs args]
(let [required-opts (->> specs
(filter (complement :flag))
(mapcat :switches)
(into #{}))
;; Preserve double-dash since this is a pre-processing step
largs (take-while (partial not= "--") args)
rargs (drop (count largs) args)
[opts largs] (tokenize-args required-opts largs)]
(concat (mapcat rest opts) largs rargs)))
;; Legacy API
(defn- build-doc [{:keys [switches docs default]}]
[(apply str (interpose ", " switches))
(or (str default) "")
(or docs "")])
(defn- banner-for [desc specs]
(when desc
(println desc)
(let [docs (into (map build-doc specs)
[["--------" "-------" "----"]
["Switches" "Default" "Desc"]])
max-cols (->> (for [d docs] (map count d))
(apply map (fn [& c] (apply vector c)))
(map #(apply max %)))
vs (for [d docs]
(mapcat (fn [& x] (apply vector x)) max-cols d))]
(doseq [v vs]
(cl-format true "~{ ~vA ~vA ~vA ~}" v)
(defn- name-for [k]
(replace k #"^--no-|^--\[no-\]|^--|^-" ""))
(defn- flag-for [^String v]
(not (.startsWith v "--no-")))
(defn- opt? [^String x]
(.startsWith x "-"))
(defn- flag? [^String x]
(.startsWith x "--[no-]"))
(defn- end-of-args? [x]
(= "--" x))
(defn- spec-for
[arg specs]
(->> specs
(filter (fn [s]
(let [switches (set (s :switches))]
(contains? switches arg))))
(defn- default-values-for
(reduce (fn [m s]
(if (contains? s :default)
((:assoc-fn s) m (:name s) (:default s))
{} specs))
(defn- apply-specs
[specs args]
(loop [options (default-values-for specs)
extra-args []
args args]
(if-not (seq args)
[options extra-args]
(let [opt (first args)
spec (spec-for opt specs)]
(end-of-args? opt)
(recur options (into extra-args (vec (rest args))) nil)
(and (opt? opt) (nil? spec))
(throw (Exception. (str "'" opt "' is not a valid argument")))
(and (opt? opt) (spec :flag))
(recur ((spec :assoc-fn) options (spec :name) (flag-for opt))
(rest args))
(opt? opt)
(recur ((spec :assoc-fn) options (spec :name) ((spec :parse-fn) (second args)))
(drop 2 args))
(recur options (conj extra-args (first args)) (rest args)))))))
(defn- switches-for
[switches flag]
(-> (for [^String s switches]
(and flag (flag? s)) [(replace s #"\[no-\]" "no-") (replace s #"\[no-\]" "")]
(and flag (.startsWith s "--")) [(replace s #"--" "--no-") s]
:default [s]))
(defn- generate-spec
(let [[switches raw-spec] (split-with #(and (string? %) (opt? %)) raw-spec)
[docs raw-spec] (split-with string? raw-spec)
options (apply hash-map raw-spec)
aliases (map name-for switches)
flag (or (flag? (last switches)) (options :flag))]
(merge {:switches (switches-for switches flag)
:docs (first docs)
:aliases (set aliases)
:name (keyword (last aliases))
:parse-fn identity
:assoc-fn assoc
:flag flag}
(when flag {:default false})
(defn cli
"THIS IS A LEGACY FUNCTION and may be deprecated in the future. Please use in new applications.
Parse the provided args using the given specs. Specs are vectors
describing a command line argument. For example:
[\"-p\" \"--port\" \"Port to listen on\" :default 3000 :parse-fn #(Integer/parseInt %)]
First provide the switches (from least to most specific), then a doc
string, and pairs of options.
Valid options are :default, :parse-fn, and :flag. See for more
detailed examples.
Returns a vector containing a map of the parsed arguments, a vector
of extra arguments that did not match known switches, and a
documentation banner to provide usage instructions."
[args & specs]
(let [[desc specs] (if (string? (first specs))
[(first specs) (rest specs)]
[nil specs])
specs (map generate-spec specs)
args (normalize-args specs args)]
(let [[options extra-args] (apply-specs specs args)
banner (with-out-str (banner-for desc specs))]
[options extra-args banner])))
;; New API
(def ^{:private true} spec-keys
[:id :short-opt :long-opt :required :desc :default :default-desc :parse-fn
:assoc-fn :validate-fn :validate-msg])
(defn- compile-spec [spec]
(let [sopt-lopt-desc (take-while #(or (string? %) (nil? %)) spec)
spec-map (apply hash-map (drop (count sopt-lopt-desc) spec))
[short-opt long-opt desc] sopt-lopt-desc
long-opt (or long-opt (:long-opt spec-map))
[long-opt req] (when long-opt
(rest (re-find #"^(--[^ =]+)(?:[ =](.*))?" long-opt)))
id (when long-opt
(keyword (subs long-opt 2)))
[validate-fn validate-msg] (:validate spec-map)]
(merge {:id id
:short-opt short-opt
:long-opt long-opt
:required req
:desc desc
:validate-fn validate-fn
:validate-msg validate-msg}
(select-keys spec-map spec-keys))))
(defn- distinct?* [coll]
(if (seq coll)
(apply distinct? coll)
(defn- compile-option-specs
"Map a sequence of option specification vectors to a sequence of:
{:id Keyword ; :server
:short-opt String ; \"-s\"
:long-opt String ; \"--server\"
:required String ; \"HOSTNAME\"
:desc String ; \"Remote server\"
:default Object ; #<Inet4Address>
:default-desc String ; \"\"
:parse-fn IFn ; #(InetAddress/getByName %)
:assoc-fn IFn ; assoc
:validate-fn IFn ; (partial instance? Inet4Address)
:validate-msg String ; \"Must be an IPv4 host\"
:id defaults to the keywordized name of long-opt without leading dashes, but
may be overridden in the option spec.
The option spec entry `:validate [fn msg]` desugars into the two entries
:validate-fn and :validate-msg.
A :default entry will not be included in the compiled spec unless specified.
An option spec may also be passed as a map containing the entries above,
in which case that subset of the map is transferred directly to the result
An assertion error is thrown if any :id values are unset, or if there exist
any duplicate :id, :short-opt, or :long-opt values."
{:post [(every? (comp identity :id) %)
(distinct?* (map :id %))
(distinct?* (remove nil? (map :short-opt %)))
(distinct?* (remove nil? (map :long-opt %)))]}
(map (fn [spec]
(if (map? spec)
(select-keys spec spec-keys)
(compile-spec spec)))
(defn- default-option-map [specs]
(reduce (fn [m s]
(if (contains? s :default)
(assoc m (:id s) (:default s))
{} specs))
(defn- find-spec [specs opt-type opt]
(first (filter #(= opt (opt-type %)) specs)))
(defn- pr-join [& xs]
(pr-str (s/join \space xs)))
(defn- missing-required-error [opt example-required]
(str "Missing required argument for " (pr-join opt example-required)))
(defn- parse-error [opt optarg msg]
(str "Error while parsing option " (pr-join opt optarg) ": " msg))
(defn- validate-error [opt optarg msg]
(str "Failed to validate " (pr-join opt optarg)
(if msg (str ": " msg) "")))
(defn- validate [value spec opt optarg]
(let [{:keys [validate-fn validate-msg]} spec]
(if (or (nil? validate-fn)
(try (validate-fn value) (catch Throwable _)))
[value nil]
[::error (validate-error opt optarg validate-msg)])))
(defn- parse-value [value spec opt optarg]
(let [{:keys [parse-fn]} spec
[value error] (if parse-fn
[(parse-fn value) nil]
(catch Throwable e
[nil (parse-error opt optarg (str e))]))
[value nil])]
(if error
[::error error]
(validate value spec opt optarg))))
(defn- parse-optarg [spec opt optarg]
(let [{:keys [required]} spec]
(if (and required (nil? optarg))
[::error (missing-required-error opt required)]
(parse-value (if required optarg true) spec opt optarg))))
(defn- parse-option-tokens
"Reduce sequence of [opt-type opt ?optarg?] tokens into a map of
{option-id value} merged over the default values in the option
Unknown options, missing required arguments, option argument parsing
exceptions, and validation failures are collected into a vector of error
message strings.
Returns [option-map error-messages-vector]."
[specs tokens]
(fn [[m errors] [opt-type opt optarg]]
(if-let [spec (find-spec specs opt-type opt)]
(let [[value error] (parse-optarg spec opt optarg)]
(if-not (= value ::error)
[((:assoc-fn spec assoc) m (:id spec) value) errors]
[m (conj errors error)]))
[m (conj errors (str "Unknown option: " (pr-str opt)))]))
[(default-option-map specs) []] tokens))
(defn- make-summary-parts [show-defaults? specs]
(let [{:keys [short-opt long-opt required default default-desc desc]} specs
opt (cond (and short-opt long-opt) (str short-opt ", " long-opt)
long-opt (str " " long-opt)
short-opt short-opt)
[opt dd] (if required
[(str opt \space required)
(or default-desc (if default (str default) ""))]
[opt ""])]
(if show-defaults?
[opt dd (or desc "")]
[opt (or desc "")])))
(defn- format-lines [lens parts]
(let [fmt (case (count lens)
2 "~{ ~vA ~vA~}"
3 "~{ ~vA ~vA ~vA~}")]
(map #(s/trimr (cl-format nil fmt (interleave lens %))) parts)))
(defn ^{:added "0.3.0"} summarize
"Reduce options specs into a options summary for printing at a terminal."
(if (seq specs)
(let [show-defaults? (some #(and (:required %) (:default %)) specs)
parts (map (partial make-summary-parts show-defaults?) specs)
lens (apply map (fn [& cols] (apply max (map count cols))) parts)
lines (format-lines lens parts)]
(s/join \newline lines))
(defn- required-arguments [specs]
(fn [s {:keys [required short-opt long-opt]}]
(if required
(into s (remove nil? [short-opt long-opt]))
#{} specs))
(defn ^{:added "0.3.0"} parse-opts
"Parse arguments sequence according to given option specifications and the
GNU Program Argument Syntax Conventions:
Option specifications are a sequence of vectors with the following format:
[short-opt long-opt-with-required-description description
:property value]
The first three string parameters in an option spec are positional and
optional, and may be nil in order to specify a later parameter.
By default, options are boolean flags that are set to true when toggled, but
the second string parameter may be used to specify that an option requires
an argument.
e.g. [\"-p\" \"--port PORT\"] specifies that --port requires an argument,
of which PORT is a short description.
The :property value pairs are optional and take precedence over the
positional string arguments. The valid properties are:
:id The key for this option in the resulting option map. This
is normally set to the keywordized name of the long option
without the leading dashes.
Must be a unique truthy value.
:short-opt The short format for this option, normally set by the first
positional string parameter: e.g. \"-p\". Must be unique.
:long-opt The long format for this option, normally set by the second
positional string parameter; e.g. \"--port\". Must be unique.
:required A description of the required argument for this option if
one is required; normally set in the second positional
string parameter after the long option: \"--port PORT\".
The absence of this entry indicates that the option is a
boolean toggle that is set to true when specified on the
command line.
:desc A optional short description of this option.
:default The default value of this option. If none is specified, the
resulting option map will not contain an entry for this
option unless set on the command line.
:default-desc An optional description of the default value. This should be
used when the string representation of the default value is
too ugly to be printed on the command line.
:parse-fn A function that receives the required option argument and
returns the option value.
If this is a boolean option, parse-fn will receive the value
true. This may be used to invert the logic of this option:
[\"-q\" \"--quiet\"
:id :verbose
:default true
:parse-fn not]
:assoc-fn A function that receives the current option map, the current
option :id, and the current parsed option value, and returns
a new option map.
This may be used to create non-idempotent options, like
setting a verbosity level by specifying an option multiple
times. (\"-vvv\" -> 3)
[\"-v\" \"--verbose\"
:default 0
:assoc-fn (fn [m k _] (update-in m [k] inc))]
:validate A vector of [validate-fn validate-msg].
:validate-fn A function that receives the parsed option value and returns
a falsy value when the value is invalid.
:validate-msg An optional message that will be added to the :errors vector
on validation failure.
parse-opts returns a map with four entries:
{:options The options map, keyed by :id, mapped to the parsed value
:arguments A vector of unprocessed arguments
:summary A string containing a minimal options summary
:errors A possible vector of error message strings generated during
parsing; nil when no errors exist
A few function options may be specified to influence the behavior of
:in-order Stop option processing at the first unknown argument. Useful
for building programs with subcommands that have their own
option specs.
:summary-fn A function that receives the sequence of compiled option specs
(documented at #', and
returns a custom option summary string.
[args option-specs & options]
(let [{:keys [in-order summary-fn]} options
specs (compile-option-specs option-specs)
req (required-arguments specs)
[tokens rest-args] (tokenize-args req args :in-order in-order)
[opts errors] (parse-option-tokens specs tokens)]
{:options opts
:arguments rest-args
:summary ((or summary-fn summarize) specs)
:errors (when (seq errors) errors)}))
Jump to Line
Something went wrong with that request. Please try again.