mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-24 10:38:38 +00:00
a464a6c73a
* woman.el, winner.el, vc/vc-rcs.el, vc/vc-hooks.el, vc/vc-hg.el: * vc/vc-git.el, vc/vc-dir.el, vc/vc-bzr.el, vc/vc-annotate.el: * textmodes/tex-mode.el, textmodes/sgml-mode.el, tar-mode.el: * strokes.el, ses.el, server.el, progmodes/js.el, progmodes/gdb-mi.el: * progmodes/flymake.el, progmodes/ebrowse.el, progmodes/compile.el: * play/tetris.el, play/snake.el, play/pong.el, play/landmark.el: * play/hanoi.el, play/decipher.el, play/5x5.el, nxml/nxml-mode.el: * net/secrets.el, net/quickurl.el, midnight.el, mail/footnote.el: * image-dired.el, ibuffer.el, ibuf-macs.el, ibuf-ext.el, hexl.el: * eshell/eshell.el, eshell/esh-io.el, eshell/esh-ext.el: * eshell/esh-cmd.el, eshell/em-ls.el, eshell/em-hist.el: * eshell/em-cmpl.el, eshell/em-banner.el: * url/url.el, url/url-queue.el, url/url-parse.el, url/url-http.el: * url/url-future.el, url/url-dav.el, url/url-cookie.el: * calendar/parse-time.el, test/eshell.el: Use cl-lib. * wid-browse.el, wdired.el, vc/vc.el, vc/vc-mtn.el, vc/vc-cvs.el: * vc/vc-arch.el, tree-widget.el, textmodes/texinfo.el: * textmodes/refill.el, textmodes/css-mode.el, term/tvi970.el: * term/ns-win.el, term.el, shell.el, ps-samp.el: * progmodes/perl-mode.el, progmodes/pascal.el, progmodes/gud.el: * progmodes/glasses.el, progmodes/etags.el, progmodes/cwarn.el: * play/gamegrid.el, play/bubbles.el, novice.el, notifications.el: * net/zeroconf.el, net/xesam.el, net/snmp-mode.el, net/mairix.el: * net/ldap.el, net/eudc.el, net/browse-url.el, man.el: * mail/mailheader.el, mail/feedmail.el: * url/url-util.el, url/url-privacy.el, url/url-nfs.el, url/url-misc.el: * url/url-methods.el, url/url-gw.el, url/url-file.el, url/url-expand.el: Dont use CL. * ibuf-ext.el (ibuffer-mark-old-buffers): Use float-time. * eshell/esh-opt.el (eshell-eval-using-options): Quote code with `lambda' rather than with `quote'. (eshell-do-opt): Adjust accordingly. (eshell-process-option): Simplify. * eshell/esh-var.el: * eshell/em-script.el: Require `esh-opt' for eshell-eval-using-options. * emacs-pcase.el (pcase--dontcare-upats, pcase--let*) (pcase--expand, pcase--u1): Rename pcase's internal `dontcare' pattern to `pcase--dontcare'. * emacs-cl.el (labels): Mark obsolete. (cl--letf, letf): Move to cl-lib. (cl--letf*, letf*): Remove. * emacs-cl-lib.el (cl-nth-value): Use defalias. * emacs-cl-macs.el (cl-dolist, cl-dotimes): Add indent rule. (cl-progv): Rewrite. (cl--letf, cl-letf): Move from cl.el. (cl-letf*): New macro. * emacs-cl-extra.el (cl--progv-before, cl--progv-after): Remove.
264 lines
9.0 KiB
EmacsLisp
264 lines
9.0 KiB
EmacsLisp
;;; esh-opt.el --- command options processing
|
|
|
|
;; Copyright (C) 1999-2012 Free Software Foundation, Inc.
|
|
|
|
;; Author: John Wiegley <johnw@gnu.org>
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;; Code:
|
|
|
|
(provide 'esh-opt)
|
|
|
|
(eval-when-compile (require 'esh-ext))
|
|
|
|
(defgroup eshell-opt nil
|
|
"The options processing code handles command argument parsing for
|
|
Eshell commands implemented in Lisp."
|
|
:tag "Command options processing"
|
|
:group 'eshell)
|
|
|
|
;;; User Functions:
|
|
|
|
(defmacro eshell-eval-using-options (name macro-args options &rest body-forms)
|
|
"Process NAME's MACRO-ARGS using a set of command line OPTIONS.
|
|
After doing so, stores settings in local symbols as declared by OPTIONS;
|
|
then evaluates BODY-FORMS -- assuming all was OK.
|
|
|
|
OPTIONS is a list, beginning with one or more elements of the form:
|
|
\(SHORT LONG VALUE SYMBOL HELP-STRING)
|
|
Each of these elements represents a particular command-line switch.
|
|
|
|
SHORT is either nil, or a character that can be used as a switch -SHORT.
|
|
LONG is either nil, or a string that can be used as a switch --LONG.
|
|
At least one of SHORT and LONG must be non-nil.
|
|
VALUE is the value associated with the option. It can be either:
|
|
t - the option needs a value to be specified after the switch;
|
|
nil - the option is given the value t;
|
|
anything else - specifies the actual value for the option.
|
|
SYMBOL is either nil, or the name of the Lisp symbol that will be bound
|
|
to VALUE. A nil SYMBOL calls `eshell-show-usage', and so is appropriate
|
|
for a \"--help\" type option.
|
|
HELP-STRING is a documentation string for the option.
|
|
|
|
Any remaining elements of OPTIONS are :KEYWORD arguments. Some take
|
|
arguments, some do not. The recognized :KEYWORDS are:
|
|
|
|
:external STRING
|
|
STRING is an external command to run if there are unknown switches.
|
|
|
|
:usage STRING
|
|
STRING is the initial part of the command's documentation string.
|
|
It appears before the options are listed.
|
|
|
|
:post-usage STRING
|
|
STRING is an optional trailing part of the command's documentation string.
|
|
It appears after the options, but before the final part of the
|
|
documentation about the associated external command (if there is one).
|
|
|
|
:show-usage
|
|
If present, then show the usage message if the command is called with no
|
|
arguments.
|
|
|
|
:preserve-args
|
|
If present, do not pass MACRO-ARGS through `eshell-flatten-list'
|
|
and `eshell-stringify-list'.
|
|
|
|
For example, OPTIONS might look like:
|
|
|
|
'((?C nil nil multi-column \"multi-column display\")
|
|
(nil \"help\" nil nil \"show this usage display\")
|
|
(?r \"reverse\" nil reverse-list \"reverse order while sorting\")
|
|
:external \"ls\"
|
|
:usage \"[OPTION]... [FILE]...
|
|
List information about the FILEs (the current directory by default).
|
|
Sort entries alphabetically across.\")
|
|
|
|
`eshell-eval-using-options' returns the value of the last form in
|
|
BODY-FORMS. If instead an external command is run (because of
|
|
an unknown option), the tag `eshell-external' will be thrown with
|
|
the new process for its value.
|
|
|
|
Lastly, any remaining arguments will be available in a locally
|
|
interned variable `args' (created using a `let' form)."
|
|
(declare (debug (form form sexp body)))
|
|
`(let ((temp-args
|
|
,(if (memq ':preserve-args (cadr options))
|
|
macro-args
|
|
(list 'eshell-stringify-list
|
|
(list 'eshell-flatten-list macro-args)))))
|
|
(let ,(append (delq nil (mapcar (lambda (opt)
|
|
(and (listp opt) (nth 3 opt)))
|
|
(cadr options)))
|
|
'(usage-msg last-value ext-command args))
|
|
;; FIXME: `options' ends up hiding some variable names under `quote',
|
|
;; which is incompatible with lexical scoping!!
|
|
(eshell-do-opt ,name ,options (lambda () ,@body-forms)))))
|
|
|
|
;;; Internal Functions:
|
|
|
|
(defvar temp-args)
|
|
(defvar last-value)
|
|
(defvar usage-msg)
|
|
(defvar ext-command)
|
|
;; Documented part of the interface; see eshell-eval-using-options.
|
|
(defvar args)
|
|
|
|
(defun eshell-do-opt (name options body-fun)
|
|
"Helper function for `eshell-eval-using-options'.
|
|
This code doesn't really need to be macro expanded everywhere."
|
|
(setq args temp-args)
|
|
(if (setq
|
|
ext-command
|
|
(catch 'eshell-ext-command
|
|
(when (setq
|
|
usage-msg
|
|
(catch 'eshell-usage
|
|
(setq last-value nil)
|
|
(if (and (= (length args) 0)
|
|
(memq ':show-usage options))
|
|
(throw 'eshell-usage
|
|
(eshell-show-usage name options)))
|
|
(setq args (eshell-process-args name args options)
|
|
last-value (funcall body-fun))
|
|
nil))
|
|
(error "%s" usage-msg))))
|
|
(throw 'eshell-external
|
|
(eshell-external-command ext-command args))
|
|
last-value))
|
|
|
|
(defun eshell-show-usage (name options)
|
|
"Display the usage message for NAME, using OPTIONS."
|
|
(let ((usage (format "usage: %s %s\n\n" name
|
|
(cadr (memq ':usage options))))
|
|
(extcmd (memq ':external options))
|
|
(post-usage (memq ':post-usage options))
|
|
had-option)
|
|
(while options
|
|
(when (listp (car options))
|
|
(let ((opt (car options)))
|
|
(setq had-option t)
|
|
(cond ((and (nth 0 opt)
|
|
(nth 1 opt))
|
|
(setq usage
|
|
(concat usage
|
|
(format " %-20s %s\n"
|
|
(format "-%c, --%s" (nth 0 opt)
|
|
(nth 1 opt))
|
|
(nth 4 opt)))))
|
|
((nth 0 opt)
|
|
(setq usage
|
|
(concat usage
|
|
(format " %-20s %s\n"
|
|
(format "-%c" (nth 0 opt))
|
|
(nth 4 opt)))))
|
|
((nth 1 opt)
|
|
(setq usage
|
|
(concat usage
|
|
(format " %-20s %s\n"
|
|
(format " --%s" (nth 1 opt))
|
|
(nth 4 opt)))))
|
|
(t (setq had-option nil)))))
|
|
(setq options (cdr options)))
|
|
(if post-usage
|
|
(setq usage (concat usage (and had-option "\n")
|
|
(cadr post-usage))))
|
|
(when extcmd
|
|
(setq extcmd (eshell-search-path (cadr extcmd)))
|
|
(if extcmd
|
|
(setq usage
|
|
(concat usage
|
|
(format "
|
|
This command is implemented in Lisp. If an unrecognized option is
|
|
passed to this command, the external version '%s'
|
|
will be called instead." extcmd)))))
|
|
(throw 'eshell-usage usage)))
|
|
|
|
(defun eshell-set-option (name ai opt options)
|
|
"Using NAME's remaining args (index AI), set the OPT within OPTIONS.
|
|
If the option consumes an argument for its value, the argument list
|
|
will be modified."
|
|
(if (not (nth 3 opt))
|
|
(eshell-show-usage name options)
|
|
(if (eq (nth 2 opt) t)
|
|
(if (> ai (length args))
|
|
(error "%s: missing option argument" name)
|
|
(set (nth 3 opt) (nth ai args))
|
|
(if (> ai 0)
|
|
(setcdr (nthcdr (1- ai) args) (nthcdr (1+ ai) args))
|
|
(setq args (cdr args))))
|
|
(set (nth 3 opt) (or (nth 2 opt) t)))))
|
|
|
|
(defun eshell-process-option (name switch kind ai options)
|
|
"For NAME, process SWITCH (of type KIND), from args at index AI.
|
|
The SWITCH will be looked up in the set of OPTIONS.
|
|
|
|
SWITCH should be either a string or character. KIND should be the
|
|
integer 0 if it's a character, or 1 if it's a string.
|
|
|
|
The SWITCH is then be matched against OPTIONS. If no matching handler
|
|
is found, and an :external command is defined (and available), it will
|
|
be called; otherwise, an error will be triggered to say that the
|
|
switch is unrecognized."
|
|
(let* ((opts options)
|
|
found)
|
|
(while opts
|
|
(if (and (listp (car opts))
|
|
(nth kind (car opts))
|
|
(equal switch (nth kind (car opts))))
|
|
(progn
|
|
(eshell-set-option name ai (car opts) options)
|
|
(setq found t opts nil))
|
|
(setq opts (cdr opts))))
|
|
(unless found
|
|
(let ((extcmd (memq ':external options)))
|
|
(when extcmd
|
|
(setq extcmd (eshell-search-path (cadr extcmd)))
|
|
(if extcmd
|
|
(throw 'eshell-ext-command extcmd)
|
|
(if (characterp switch)
|
|
(error "%s: unrecognized option -%c" name switch)
|
|
(error "%s: unrecognized option --%s" name switch))))))))
|
|
|
|
(defun eshell-process-args (name args options)
|
|
"Process the given ARGS using OPTIONS.
|
|
This assumes that symbols have been intern'd by `eshell-eval-using-options'."
|
|
(let ((ai 0) arg)
|
|
(while (< ai (length args))
|
|
(setq arg (nth ai args))
|
|
(if (not (and (stringp arg)
|
|
(string-match "^-\\(-\\)?\\(.*\\)" arg)))
|
|
(setq ai (1+ ai))
|
|
(let* ((dash (match-string 1 arg))
|
|
(switch (match-string 2 arg)))
|
|
(if (= ai 0)
|
|
(setq args (cdr args))
|
|
(setcdr (nthcdr (1- ai) args) (nthcdr (1+ ai) args)))
|
|
(if dash
|
|
(if (> (length switch) 0)
|
|
(eshell-process-option name switch 1 ai options)
|
|
(setq ai (length args)))
|
|
(let ((len (length switch))
|
|
(index 0))
|
|
(while (< index len)
|
|
(eshell-process-option name (aref switch index) 0 ai options)
|
|
(setq index (1+ index)))))))))
|
|
args)
|
|
|
|
;;; esh-opt.el ends here
|