
`string-search` is easier to understand, less error-prone, much faster, does not pollute the regexp cache, and does not mutate global state. Use it where applicable and obviously safe (erring on the conservative side). * admin/authors.el (authors-canonical-file-name) (authors-scan-change-log): * lisp/apropos.el (apropos-command) (apropos-documentation-property, apropos-symbols-internal): * lisp/arc-mode.el (archive-arc-summarize) (archive-zoo-summarize): * lisp/calc/calc-aent.el (math-read-factor): * lisp/calc/calc-ext.el (math-read-big-expr) (math-format-nice-expr, math-format-number-fancy): * lisp/calc/calc-forms.el (math-read-angle-brackets): * lisp/calc/calc-graph.el (calc-graph-set-range): * lisp/calc/calc-keypd.el (calc-keypad-press): * lisp/calc/calc-lang.el (tex, latex, math-read-big-rec): * lisp/calc/calc-prog.el (calc-fix-token-name) (calc-user-define-permanent, math-define-exp): * lisp/calc/calc.el (calc-record, calcDigit-key) (calc-count-lines): * lisp/calc/calcalg2.el (calc-solve-for, calc-poly-roots) (math-do-integral): * lisp/calc/calcalg3.el (calc-find-root, calc-find-minimum) (calc-get-fit-variables): * lisp/cedet/ede/speedbar.el (ede-tag-expand): * lisp/cedet/semantic/java.el (semantic-java-expand-tag): * lisp/cedet/semantic/sb.el (semantic-sb-show-extra) (semantic-sb-expand-group): * lisp/cedet/semantic/wisent/python.el (semantic-python-instance-variable-p): * lisp/cus-edit.el (get): * lisp/descr-text.el (describe-text-sexp): * lisp/dired-aux.el (dired-compress-file): * lisp/dired-x.el (dired-make-relative-symlink): * lisp/dired.el (dired-glob-regexp): * lisp/dos-fns.el (dos-convert-standard-filename, dos-8+3-filename): * lisp/edmacro.el (edmacro-format-keys): * lisp/emacs-lisp/eieio-opt.el (eieio-sb-expand): * lisp/emacs-lisp/eieio-speedbar.el (eieio-speedbar-object-expand): * lisp/emacs-lisp/lisp-mnt.el (lm-keywords-list): * lisp/emacs-lisp/warnings.el (display-warning): * lisp/emulation/viper-ex.el (viper-ex-read-file-name) (ex-print-display-lines): * lisp/env.el (read-envvar-name, setenv): * lisp/epa-mail.el (epa-mail-encrypt): * lisp/epg.el (epg--start): * lisp/erc/erc-backend.el (erc-parse-server-response): * lisp/erc/erc-dcc.el (erc-dcc-member): * lisp/erc/erc-speedbar.el (erc-speedbar-expand-server) (erc-speedbar-expand-channel, erc-speedbar-expand-user): * lisp/erc/erc.el (erc-send-input): * lisp/eshell/em-glob.el (eshell-glob-entries): * lisp/eshell/esh-proc.el (eshell-needs-pipe-p): * lisp/eshell/esh-util.el (eshell-convert): * lisp/eshell/esh-var.el (eshell-envvar-names): * lisp/faces.el (x-resolve-font-name): * lisp/ffap.el (ffap-file-at-point): * lisp/files.el (wildcard-to-regexp, shell-quote-wildcard-pattern): * lisp/forms.el (forms--update): * lisp/frameset.el (frameset-filter-unshelve-param): * lisp/gnus/gnus-art.el (article-decode-charset): * lisp/gnus/gnus-kill.el (gnus-kill-parse-rn-kill-file): * lisp/gnus/gnus-mlspl.el (gnus-group-split-fancy): * lisp/gnus/gnus-msg.el (gnus-summary-resend-message-insert-gcc) (gnus-inews-insert-gcc): * lisp/gnus/gnus-rfc1843.el (rfc1843-decode-article-body): * lisp/gnus/gnus-search.el (gnus-search-indexed-parse-output) (gnus-search--complete-key-data): * lisp/gnus/gnus-spec.el (gnus-parse-simple-format): * lisp/gnus/gnus-sum.el (gnus-summary-refer-article): * lisp/gnus/gnus-util.el (gnus-extract-address-components) (gnus-newsgroup-directory-form): * lisp/gnus/gnus-uu.el (gnus-uu-grab-view): * lisp/gnus/gnus.el (gnus-group-native-p, gnus-short-group-name): * lisp/gnus/message.el (message-check-news-header-syntax) (message-make-message-id, message-user-mail-address) (message-make-fqdn, message-get-reply-headers, message-followup): * lisp/gnus/mm-decode.el (mm-dissect-buffer): * lisp/gnus/nnheader.el (nnheader-insert): * lisp/gnus/nnimap.el (nnimap-process-quirk) (nnimap-imap-ranges-to-gnus-ranges): * lisp/gnus/nnmaildir.el (nnmaildir--ensure-suffix): * lisp/gnus/nnmairix.el (nnmairix-determine-original-group-from-path): * lisp/gnus/nnrss.el (nnrss-match-macro): * lisp/gnus/nntp.el (nntp-find-group-and-number): * lisp/help-fns.el (help--symbol-completion-table-affixation): * lisp/help.el (help-function-arglist): * lisp/hippie-exp.el (he-concat-directory-file-name): * lisp/htmlfontify.el (hfy-relstub): * lisp/ido.el (ido-make-prompt, ido-complete, ido-copy-current-word) (ido-exhibit): * lisp/image/image-converter.el (image-convert-p): * lisp/info-xref.el (info-xref-docstrings): * lisp/info.el (Info-toc-build, Info-follow-reference) (Info-backward-node, Info-finder-find-node) (Info-speedbar-expand-node): * lisp/international/mule-diag.el (print-fontset-element): * lisp/language/korea-util.el (default-korean-keyboard): * lisp/linum.el (linum-after-change): * lisp/mail/ietf-drums.el (ietf-drums-parse-address): * lisp/mail/mail-utils.el (mail-dont-reply-to): * lisp/mail/rfc2047.el (rfc2047-encode-1, rfc2047-decode-string): * lisp/mail/rfc2231.el (rfc2231-parse-string): * lisp/mail/rmailkwd.el (rmail-set-label): * lisp/mail/rmailsum.el (rmail-header-summary): * lisp/mail/smtpmail.el (smtpmail-maybe-append-domain) (smtpmail-user-mail-address): * lisp/mail/uce.el (uce-reply-to-uce): * lisp/man.el (Man-default-man-entry): * lisp/mh-e/mh-alias.el (mh-alias-gecos-name) (mh-alias-minibuffer-confirm-address): * lisp/mh-e/mh-comp.el (mh-forwarded-letter-subject): * lisp/mh-e/mh-speed.el (mh-speed-parse-flists-output): * lisp/mh-e/mh-utils.el (mh-collect-folder-names-filter) (mh-folder-completion-function): * lisp/minibuffer.el (completion--make-envvar-table) (completion-file-name-table, completion-flex-try-completion) (completion-flex-all-completions): * lisp/mpc.el (mpc--proc-quote-string, mpc-cmd-special-tag-p) (mpc-constraints-tag-lookup): * lisp/net/ange-ftp.el (ange-ftp-send-cmd) (ange-ftp-allow-child-lookup): * lisp/net/mailcap.el (mailcap-mime-types): * lisp/net/mairix.el (mairix-search-thread-this-article): * lisp/net/pop3.el (pop3-open-server): * lisp/net/soap-client.el (soap-decode-xs-complex-type): * lisp/net/socks.el (socks-filter): * lisp/nxml/nxml-outln.el (nxml-highlighted-qname): * lisp/nxml/rng-cmpct.el (rng-c-expand-name, rng-c-expand-datatype): * lisp/nxml/rng-uri.el (rng-uri-file-name-1): * lisp/obsolete/complete.el (partial-completion-mode) (PC-do-completion): * lisp/obsolete/longlines.el (longlines-encode-string): * lisp/obsolete/nnir.el (nnir-compose-result): * lisp/obsolete/terminal.el (te-quote-arg-for-sh): * lisp/obsolete/tpu-edt.el (tpu-check-search-case): * lisp/obsolete/url-ns.el (isPlainHostName): * lisp/pcmpl-unix.el (pcomplete/scp): * lisp/play/dunnet.el (dun-listify-string2, dun-get-path) (dun-unix-parse, dun-doassign, dun-cat, dun-batch-unix-interface): * lisp/progmodes/ebnf2ps.el: (ebnf-eps-header-footer-comment): * lisp/progmodes/gdb-mi.el (gdb-var-delete) (gdb-speedbar-expand-node, gdbmi-bnf-incomplete-record-result): * lisp/progmodes/gud.el (gud-find-expr): * lisp/progmodes/idlw-help.el (idlwave-do-context-help1): * lisp/progmodes/idlw-shell.el (idlwave-shell-mode) (idlwave-shell-filter-hidden-output, idlwave-shell-filter): * lisp/progmodes/idlwave.el (idlwave-skip-label-or-case) (idlwave-routine-info): * lisp/progmodes/octave.el (inferior-octave-completion-at-point): * lisp/progmodes/sh-script.el (sh-add-completer): * lisp/progmodes/sql.el (defun): * lisp/progmodes/xscheme.el (xscheme-process-filter): * lisp/replace.el (query-replace-compile-replacement) (map-query-replace-regexp): * lisp/shell.el (shell--command-completion-data) (shell-environment-variable-completion): * lisp/simple.el (display-message-or-buffer): * lisp/speedbar.el (speedbar-dired, speedbar-tag-file) (speedbar-tag-expand): * lisp/subr.el (split-string-and-unquote): * lisp/tar-mode.el (tar-extract): * lisp/term.el (term-command-hook, serial-read-name): * lisp/textmodes/bibtex.el (bibtex-print-help-message): * lisp/textmodes/ispell.el (ispell-lookup-words, ispell-filter) (ispell-parse-output, ispell-buffer-local-parsing): * lisp/textmodes/reftex-cite.el (reftex-do-citation): * lisp/textmodes/reftex-parse.el (reftex-notice-new): * lisp/textmodes/reftex-ref.el (reftex-show-entry): * lisp/textmodes/reftex.el (reftex-compile-variables): * lisp/textmodes/tex-mode.el (tex-send-command) (tex-start-tex, tex-append): * lisp/thingatpt.el (thing-at-point-url-at-point): * lisp/tmm.el (tmm-add-one-shortcut): * lisp/transient.el (transient-format-key): * lisp/url/url-auth.el (url-basic-auth) (url-digest-auth-directory-id-assoc): * lisp/url/url-news.el (url-news): * lisp/url/url-util.el (url-parse-query-string): * lisp/vc/vc-cvs.el (vc-cvs-parse-entry): * lisp/wid-browse.el (widget-browse-sexp): * lisp/woman.el (woman-parse-colon-path, woman-mini-help) (WoMan-getpage-in-background, woman-negative-vertical-space): * lisp/xml.el: * test/lisp/emacs-lisp/check-declare-tests.el (check-declare-tests-warn): * test/lisp/files-tests.el (files-tests-file-name-non-special-dired-compress-handler): * test/lisp/net/network-stream-tests.el (server-process-filter): * test/src/coding-tests.el (ert-test-unibyte-buffer-dos-eol-decode): Use `string-search` instead of `string-match` and `string-match-p`.
690 lines
23 KiB
EmacsLisp
690 lines
23 KiB
EmacsLisp
;;; esh-util.el --- general utilities -*- lexical-binding:t -*-
|
|
|
|
;; Copyright (C) 1999-2021 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 <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;; Code:
|
|
|
|
(require 'seq)
|
|
(eval-when-compile (require 'cl-lib))
|
|
|
|
(defgroup eshell-util nil
|
|
"This is general utility code, meant for use by Eshell itself."
|
|
:tag "General utilities"
|
|
:group 'eshell)
|
|
|
|
;;; User Variables:
|
|
|
|
(defcustom eshell-stringify-t t
|
|
"If non-nil, the string representation of t is \"t\".
|
|
If nil, t will be represented only in the exit code of the function,
|
|
and not printed as a string. This causes Lisp functions to behave
|
|
similarly to external commands, as far as successful result output."
|
|
:type 'boolean)
|
|
|
|
(defcustom eshell-group-file "/etc/group"
|
|
"If non-nil, the name of the group file on your system."
|
|
:type '(choice (const :tag "No group file" nil) file))
|
|
|
|
(defcustom eshell-passwd-file "/etc/passwd"
|
|
"If non-nil, the name of the passwd file on your system."
|
|
:type '(choice (const :tag "No passwd file" nil) file))
|
|
|
|
(defcustom eshell-hosts-file "/etc/hosts"
|
|
"The name of the /etc/hosts file.
|
|
Use `pcomplete-hosts-file' instead; this variable is obsolete and
|
|
has no effect."
|
|
:type '(choice (const :tag "No hosts file" nil) file))
|
|
;; Don't make it into an alias, because it doesn't really work with
|
|
;; custom and risks creating duplicate entries. Just point users to
|
|
;; the other variable, which is less frustrating.
|
|
(make-obsolete-variable 'eshell-hosts-file nil "28.1")
|
|
|
|
(defcustom eshell-handle-errors t
|
|
"If non-nil, Eshell will handle errors itself.
|
|
Setting this to nil is offered as an aid to debugging only."
|
|
:type 'boolean)
|
|
|
|
(defcustom eshell-private-file-modes 384 ; umask 177
|
|
"The file-modes value to use for creating \"private\" files."
|
|
:type 'integer)
|
|
|
|
(defcustom eshell-private-directory-modes 448 ; umask 077
|
|
"The file-modes value to use for creating \"private\" directories."
|
|
:type 'integer)
|
|
|
|
(defcustom eshell-tar-regexp
|
|
"\\.t\\(ar\\(\\.\\(gz\\|bz2\\|xz\\|Z\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'"
|
|
"Regular expression used to match tar file names."
|
|
:version "24.1" ; added xz
|
|
:type 'regexp)
|
|
|
|
(defcustom eshell-convert-numeric-arguments t
|
|
"If non-nil, converting arguments of numeric form to Lisp numbers.
|
|
Numeric form is tested using the regular expression
|
|
`eshell-number-regexp'.
|
|
|
|
NOTE: If you find that numeric conversions are interfering with the
|
|
specification of filenames (for example, in calling `find-file', or
|
|
some other Lisp function that deals with files, not numbers), add the
|
|
following in your init file:
|
|
|
|
(put \\='find-file \\='eshell-no-numeric-conversions t)
|
|
|
|
Any function with the property `eshell-no-numeric-conversions' set to
|
|
a non-nil value, will be passed strings, not numbers, even when an
|
|
argument matches `eshell-number-regexp'."
|
|
:type 'boolean)
|
|
|
|
(defcustom eshell-number-regexp "-?\\([0-9]*\\.\\)?[0-9]+\\(e[-0-9.]+\\)?"
|
|
"Regular expression used to match numeric arguments.
|
|
If `eshell-convert-numeric-arguments' is non-nil, and an argument
|
|
matches this regexp, it will be converted to a Lisp number, using the
|
|
function `string-to-number'."
|
|
:type 'regexp)
|
|
|
|
(defcustom eshell-ange-ls-uids nil
|
|
"List of user/host/id strings, used to determine remote ownership."
|
|
:type '(repeat (cons :tag "Host for User/UID map"
|
|
(string :tag "Hostname")
|
|
(repeat (cons :tag "User/UID List"
|
|
(string :tag "Username")
|
|
(repeat :tag "UIDs" string))))))
|
|
|
|
;;; Internal Variables:
|
|
|
|
(defvar eshell-group-names nil
|
|
"A cache to hold the names of groups.")
|
|
|
|
(defvar eshell-group-timestamp nil
|
|
"A timestamp of when the group file was read.")
|
|
|
|
(defvar eshell-user-names nil
|
|
"A cache to hold the names of users.")
|
|
|
|
(defvar eshell-user-timestamp nil
|
|
"A timestamp of when the user file was read.")
|
|
|
|
;;; Obsolete variables:
|
|
|
|
(define-obsolete-variable-alias 'eshell-host-names
|
|
'pcomplete--host-name-cache "28.1")
|
|
(define-obsolete-variable-alias 'eshell-host-timestamp
|
|
'pcomplete--host-name-cache-timestamp "28.1")
|
|
(defvar pcomplete--host-name-cache)
|
|
(defvar pcomplete--host-name-cache-timestamp)
|
|
|
|
;;; Functions:
|
|
|
|
(defsubst eshell-under-windows-p ()
|
|
"Return non-nil if we are running under MS-DOS/Windows."
|
|
(memq system-type '(ms-dos windows-nt)))
|
|
|
|
(defmacro eshell-condition-case (tag form &rest handlers)
|
|
"If `eshell-handle-errors' is non-nil, this is `condition-case'.
|
|
Otherwise, evaluates FORM with no error handling."
|
|
(declare (indent 2) (debug (sexp form &rest form)))
|
|
(if eshell-handle-errors
|
|
`(condition-case-unless-debug ,tag
|
|
,form
|
|
,@handlers)
|
|
form))
|
|
|
|
(defun eshell-find-delimiter
|
|
(open close &optional bound reverse-p backslash-p)
|
|
"From point, find the CLOSE delimiter corresponding to OPEN.
|
|
The matching is bounded by BOUND.
|
|
If REVERSE-P is non-nil, process the region backwards.
|
|
If BACKSLASH-P is non-nil, and OPEN and CLOSE are the same character,
|
|
then quoting is done by a backslash, rather than a doubled delimiter."
|
|
(save-excursion
|
|
(let ((depth 1)
|
|
(bound (or bound (point-max))))
|
|
(if (if reverse-p
|
|
(eq (char-before) close)
|
|
(eq (char-after) open))
|
|
(forward-char (if reverse-p -1 1)))
|
|
(while (and (> depth 0)
|
|
(funcall (if reverse-p '> '<) (point) bound))
|
|
(let ((c (if reverse-p (char-before) (char-after))) nc)
|
|
(cond ((and (not reverse-p)
|
|
(or (not (eq open close))
|
|
backslash-p)
|
|
(eq c ?\\)
|
|
(setq nc (char-after (1+ (point))))
|
|
(or (eq nc open) (eq nc close)))
|
|
(forward-char 1))
|
|
((and reverse-p
|
|
(or (not (eq open close))
|
|
backslash-p)
|
|
(or (eq c open) (eq c close))
|
|
(eq (char-before (1- (point)))
|
|
?\\))
|
|
(forward-char -1))
|
|
((eq open close)
|
|
(if (eq c open)
|
|
(if (and (not backslash-p)
|
|
(eq (if reverse-p
|
|
(char-before (1- (point)))
|
|
(char-after (1+ (point)))) open))
|
|
(forward-char (if reverse-p -1 1))
|
|
(setq depth (1- depth)))))
|
|
((= c open)
|
|
(setq depth (+ depth (if reverse-p -1 1))))
|
|
((= c close)
|
|
(setq depth (+ depth (if reverse-p 1 -1))))))
|
|
(forward-char (if reverse-p -1 1)))
|
|
(if (= depth 0)
|
|
(if reverse-p (point) (1- (point)))))))
|
|
|
|
(defun eshell-convert (string)
|
|
"Convert STRING into a more native looking Lisp object."
|
|
(if (not (stringp string))
|
|
string
|
|
(let ((len (length string)))
|
|
(if (= len 0)
|
|
string
|
|
(if (eq (aref string (1- len)) ?\n)
|
|
(setq string (substring string 0 (1- len))))
|
|
(if (string-search "\n" string)
|
|
(split-string string "\n")
|
|
(if (and eshell-convert-numeric-arguments
|
|
(string-match
|
|
(concat "\\`\\s-*" eshell-number-regexp
|
|
"\\s-*\\'") string))
|
|
(string-to-number string)
|
|
string))))))
|
|
|
|
(defvar-local eshell-path-env (getenv "PATH")
|
|
"Content of $PATH.
|
|
It might be different from \(getenv \"PATH\"), when
|
|
`default-directory' points to a remote host.")
|
|
|
|
(defun eshell-get-path ()
|
|
"Return $PATH as a list.
|
|
Add the current directory on MS-Windows."
|
|
(eshell-parse-colon-path
|
|
(if (eshell-under-windows-p)
|
|
(concat "." path-separator eshell-path-env)
|
|
eshell-path-env)))
|
|
|
|
(defun eshell-parse-colon-path (path-env)
|
|
"Split string with `parse-colon-path'.
|
|
Prepend remote identification of `default-directory', if any."
|
|
(let ((remote (file-remote-p default-directory)))
|
|
(if remote
|
|
(mapcar
|
|
(lambda (x) (concat remote x))
|
|
(parse-colon-path path-env))
|
|
(parse-colon-path path-env))))
|
|
|
|
(defun eshell-split-path (path)
|
|
"Split a path into multiple subparts."
|
|
(let ((len (length path))
|
|
(i 0) (li 0)
|
|
parts)
|
|
(if (and (eshell-under-windows-p)
|
|
(> len 2)
|
|
(eq (aref path 0) ?/)
|
|
(eq (aref path 1) ?/))
|
|
(setq i 2))
|
|
(while (< i len)
|
|
(if (and (eq (aref path i) ?/)
|
|
(not (get-text-property i 'escaped path)))
|
|
(setq parts (cons (if (= li i) "/"
|
|
(substring path li (1+ i))) parts)
|
|
li (1+ i)))
|
|
(setq i (1+ i)))
|
|
(if (< li i)
|
|
(setq parts (cons (substring path li i) parts)))
|
|
(if (and (eshell-under-windows-p)
|
|
(string-match "\\`[A-Za-z]:\\'" (car (last parts))))
|
|
(setcar (last parts) (concat (car (last parts)) "/")))
|
|
(nreverse parts)))
|
|
|
|
(defun eshell-to-flat-string (value)
|
|
"Make value a string. If separated by newlines change them to spaces."
|
|
(let ((text (eshell-stringify value)))
|
|
(if (string-match "\n+\\'" text)
|
|
(setq text (replace-match "" t t text)))
|
|
(while (string-match "\n+" text)
|
|
(setq text (replace-match " " t t text)))
|
|
text))
|
|
|
|
(defmacro eshell-for (for-var for-list &rest forms)
|
|
"Iterate through a list."
|
|
(declare (obsolete dolist "24.1"))
|
|
(declare (indent 2))
|
|
`(let ((list-iter ,for-list))
|
|
(while list-iter
|
|
(let ((,for-var (car list-iter)))
|
|
,@forms)
|
|
(setq list-iter (cdr list-iter)))))
|
|
|
|
(define-obsolete-function-alias 'eshell-flatten-list #'flatten-tree "27.1")
|
|
|
|
(defun eshell-stringify (object)
|
|
"Convert OBJECT into a string value."
|
|
(cond
|
|
((stringp object) object)
|
|
((and (listp object)
|
|
(not (eq object nil)))
|
|
(let ((string (pp-to-string object)))
|
|
(substring string 0 (1- (length string)))))
|
|
((numberp object)
|
|
(number-to-string object))
|
|
(t
|
|
(unless (and (eq object t)
|
|
(not eshell-stringify-t))
|
|
(pp-to-string object)))))
|
|
|
|
(defsubst eshell-stringify-list (args)
|
|
"Convert each element of ARGS into a string value."
|
|
(mapcar #'eshell-stringify args))
|
|
|
|
(defsubst eshell-flatten-and-stringify (&rest args)
|
|
"Flatten and stringify all of the ARGS into a single string."
|
|
(mapconcat #'eshell-stringify (flatten-tree args) " "))
|
|
|
|
(defsubst eshell-directory-files (regexp &optional directory)
|
|
"Return a list of files in the given DIRECTORY matching REGEXP."
|
|
(directory-files (or directory default-directory)
|
|
directory regexp))
|
|
|
|
(defun eshell-regexp-arg (prompt)
|
|
"Return list of regexp and prefix arg using PROMPT."
|
|
(let* (;; Don't clobber this.
|
|
(last-command last-command)
|
|
(regexp (read-from-minibuffer prompt nil nil nil
|
|
'minibuffer-history-search-history)))
|
|
(list (if (string-equal regexp "")
|
|
(setcar minibuffer-history-search-history
|
|
(nth 1 minibuffer-history-search-history))
|
|
regexp)
|
|
(prefix-numeric-value current-prefix-arg))))
|
|
|
|
(defun eshell-printable-size (filesize &optional human-readable
|
|
block-size use-colors)
|
|
"Return a printable FILESIZE."
|
|
(let ((size (float (or filesize 0))))
|
|
(if human-readable
|
|
(if (< size human-readable)
|
|
(if (= (round size) 0)
|
|
"0"
|
|
(if block-size
|
|
"1.0k"
|
|
(format "%.0f" size)))
|
|
(setq size (/ size human-readable))
|
|
(if (< size human-readable)
|
|
(if (<= size 9.94)
|
|
(format "%.1fk" size)
|
|
(format "%.0fk" size))
|
|
(setq size (/ size human-readable))
|
|
(if (< size human-readable)
|
|
(let ((str (if (<= size 9.94)
|
|
(format "%.1fM" size)
|
|
(format "%.0fM" size))))
|
|
(if use-colors
|
|
(put-text-property 0 (length str)
|
|
'face 'bold str))
|
|
str)
|
|
(setq size (/ size human-readable))
|
|
(if (< size human-readable)
|
|
(let ((str (if (<= size 9.94)
|
|
(format "%.1fG" size)
|
|
(format "%.0fG" size))))
|
|
(if use-colors
|
|
(put-text-property 0 (length str)
|
|
'face 'bold-italic str))
|
|
str)))))
|
|
(if block-size
|
|
(setq size (/ size block-size)))
|
|
(format "%.0f" size))))
|
|
|
|
(defun eshell-winnow-list (entries exclude &optional predicates)
|
|
"Pare down the ENTRIES list using the EXCLUDE regexp, and PREDICATES.
|
|
The original list is not affected. If the result is only one element
|
|
long, it will be returned itself, rather than returning a one-element
|
|
list."
|
|
(let ((flist (list t))
|
|
valid p listified)
|
|
(unless (listp entries)
|
|
(setq entries (list entries)
|
|
listified t))
|
|
(dolist (entry entries)
|
|
(unless (and exclude (string-match exclude entry))
|
|
(setq p predicates valid (null p))
|
|
(while p
|
|
(if (funcall (car p) entry)
|
|
(setq valid t)
|
|
(setq p nil valid nil))
|
|
(setq p (cdr p)))
|
|
(when valid
|
|
(nconc flist (list entry)))))
|
|
(if listified
|
|
(cadr flist)
|
|
(cdr flist))))
|
|
|
|
(defsubst eshell-redisplay ()
|
|
"Allow Emacs to redisplay buffers."
|
|
;; for some strange reason, Emacs 21 is prone to trigger an
|
|
;; "args out of range" error in `sit-for', if this function
|
|
;; runs while point is in the minibuffer and the users attempt
|
|
;; to use completion. Don't ask me.
|
|
(condition-case nil
|
|
(sit-for 0 0)
|
|
(error nil)))
|
|
|
|
(defun eshell-read-passwd-file (file)
|
|
"Return an alist correlating gids to group names in FILE."
|
|
(let (names)
|
|
(when (file-readable-p file)
|
|
(with-temp-buffer
|
|
(insert-file-contents file)
|
|
(goto-char (point-min))
|
|
(while (not (eobp))
|
|
(let* ((fields
|
|
(split-string (buffer-substring
|
|
(point) (progn (end-of-line)
|
|
(point))) ":")))
|
|
(if (and (and fields (nth 0 fields) (nth 2 fields))
|
|
(not (assq (string-to-number (nth 2 fields)) names)))
|
|
(setq names (cons (cons (string-to-number (nth 2 fields))
|
|
(nth 0 fields))
|
|
names))))
|
|
(forward-line))))
|
|
names))
|
|
|
|
(defun eshell-read-passwd (file result-var timestamp-var)
|
|
"Read the contents of /etc/passwd for user names."
|
|
(if (or (not (symbol-value result-var))
|
|
(not (symbol-value timestamp-var))
|
|
(time-less-p
|
|
(symbol-value timestamp-var)
|
|
(file-attribute-modification-time (file-attributes file))))
|
|
(progn
|
|
(set result-var (eshell-read-passwd-file file))
|
|
(set timestamp-var (current-time))))
|
|
(symbol-value result-var))
|
|
|
|
(defun eshell-read-group-names ()
|
|
"Read the contents of /etc/group for group names."
|
|
(if eshell-group-file
|
|
(eshell-read-passwd eshell-group-file 'eshell-group-names
|
|
'eshell-group-timestamp)))
|
|
|
|
(defsubst eshell-group-id (name)
|
|
"Return the user id for user NAME."
|
|
(car (rassoc name (eshell-read-group-names))))
|
|
|
|
(defsubst eshell-group-name (gid)
|
|
"Return the group name for the given GID."
|
|
(cdr (assoc gid (eshell-read-group-names))))
|
|
|
|
(defun eshell-read-user-names ()
|
|
"Read the contents of /etc/passwd for user names."
|
|
(if eshell-passwd-file
|
|
(eshell-read-passwd eshell-passwd-file 'eshell-user-names
|
|
'eshell-user-timestamp)))
|
|
|
|
(defsubst eshell-user-id (name)
|
|
"Return the user id for user NAME."
|
|
(car (rassoc name (eshell-read-user-names))))
|
|
|
|
(autoload 'pcomplete-read-hosts-file "pcomplete")
|
|
(autoload 'pcomplete-read-hosts "pcomplete")
|
|
(autoload 'pcomplete-read-host-names "pcomplete")
|
|
(define-obsolete-function-alias 'eshell-read-hosts-file
|
|
#'pcomplete-read-hosts-file "28.1")
|
|
(define-obsolete-function-alias 'eshell-read-hosts
|
|
#'pcomplete-read-hosts "28.1")
|
|
(define-obsolete-function-alias 'eshell-read-host-names
|
|
#'pcomplete-read-host-names "28.1")
|
|
|
|
(defsubst eshell-copy-environment ()
|
|
"Return an unrelated copy of `process-environment'."
|
|
(mapcar #'concat process-environment))
|
|
|
|
(defun eshell-subgroups (groupsym)
|
|
"Return all of the subgroups of GROUPSYM."
|
|
(let ((subgroups (get groupsym 'custom-group))
|
|
(subg (list t)))
|
|
(while subgroups
|
|
(if (eq (cadr (car subgroups)) 'custom-group)
|
|
(nconc subg (list (caar subgroups))))
|
|
(setq subgroups (cdr subgroups)))
|
|
(cdr subg)))
|
|
|
|
(defmacro eshell-with-file-modes (modes &rest forms)
|
|
"Evaluate, with file-modes set to MODES, the given FORMS."
|
|
(declare (obsolete with-file-modes "25.1"))
|
|
`(with-file-modes ,modes ,@forms))
|
|
|
|
(defmacro eshell-with-private-file-modes (&rest forms)
|
|
"Evaluate FORMS with private file modes set."
|
|
`(with-file-modes ,eshell-private-file-modes ,@forms))
|
|
|
|
(defsubst eshell-make-private-directory (dir &optional parents)
|
|
"Make DIR with file-modes set to `eshell-private-directory-modes'."
|
|
(with-file-modes eshell-private-directory-modes
|
|
(make-directory dir parents)))
|
|
|
|
(defsubst eshell-substring (string sublen)
|
|
"Return the beginning of STRING, up to SUBLEN bytes."
|
|
(if string
|
|
(if (> (length string) sublen)
|
|
(substring string 0 sublen)
|
|
string)))
|
|
|
|
(defun eshell-directory-files-and-attributes (dir &optional full match nosort id-format)
|
|
"Make sure to use the handler for `directory-files-and-attributes'."
|
|
(let* ((dir (expand-file-name dir)))
|
|
(if (string-equal (file-remote-p dir 'method) "ftp")
|
|
(let ((files (directory-files dir full match nosort)))
|
|
(mapcar
|
|
(lambda (file)
|
|
(cons file (eshell-file-attributes (expand-file-name file dir))))
|
|
files))
|
|
(directory-files-and-attributes dir full match nosort id-format))))
|
|
|
|
(defun eshell-current-ange-uids ()
|
|
(if (string-match "/\\([^@]+\\)@\\([^:]+\\):" default-directory)
|
|
(let* ((host (match-string 2 default-directory))
|
|
(user (match-string 1 default-directory))
|
|
(host-users (assoc host eshell-ange-ls-uids)))
|
|
(when host-users
|
|
(setq host-users (cdr host-users))
|
|
(cdr (assoc user host-users))))))
|
|
|
|
(autoload 'parse-time-string "parse-time")
|
|
|
|
(eval-when-compile
|
|
(require 'ange-ftp nil t)) ; ange-ftp-parse-filename
|
|
|
|
(defvar tramp-file-name-structure)
|
|
(declare-function ange-ftp-ls "ange-ftp"
|
|
(file lsargs parse &optional no-error wildcard))
|
|
(declare-function ange-ftp-file-modtime "ange-ftp" (file))
|
|
|
|
(defun eshell-parse-ange-ls (dir)
|
|
(require 'ange-ftp)
|
|
(require 'tramp)
|
|
(let ((ange-ftp-name-format
|
|
(list (nth 0 tramp-file-name-structure)
|
|
(nth 3 tramp-file-name-structure)
|
|
(nth 2 tramp-file-name-structure)
|
|
(nth 4 tramp-file-name-structure)))
|
|
;; ange-ftp uses `ange-ftp-ftp-name-arg' and `ange-ftp-ftp-name-res'
|
|
;; for optimization in `ange-ftp-ftp-name'. If Tramp wasn't active,
|
|
;; there could be incorrect values from previous calls in case the
|
|
;; "ftp" method is used in the Tramp file name. So we unset
|
|
;; those values.
|
|
(ange-ftp-ftp-name-arg "")
|
|
(ange-ftp-ftp-name-res nil)
|
|
entry)
|
|
(with-temp-buffer
|
|
(insert (ange-ftp-ls dir "-la" nil))
|
|
(goto-char (point-min))
|
|
(if (looking-at "^total [0-9]+$")
|
|
(forward-line 1))
|
|
;; Some systems put in a blank line here.
|
|
(if (eolp) (forward-line 1))
|
|
(while (looking-at
|
|
`,(concat "\\([dlscb-][rwxst-]+\\)"
|
|
"\\s-*" "\\([0-9]+\\)" "\\s-+"
|
|
"\\(\\S-+\\)" "\\s-+"
|
|
"\\(\\S-+\\)" "\\s-+"
|
|
"\\([0-9]+\\)" "\\s-+" "\\(.*\\)"))
|
|
(let* ((perms (match-string 1))
|
|
(links (string-to-number (match-string 2)))
|
|
(user (match-string 3))
|
|
(group (match-string 4))
|
|
(size (string-to-number (match-string 5)))
|
|
(name (ange-ftp-parse-filename))
|
|
(mtime
|
|
(let ((moment (parse-time-string (match-string 6))))
|
|
(if (decoded-time-second moment)
|
|
(setf (decoded-time-year moment)
|
|
(decoded-time-year (decode-time)))
|
|
(setf (decoded-time-second moment) 0)
|
|
(setf (decoded-time-minute moment) 0)
|
|
(setf (decoded-time-hour moment) 0))
|
|
(encode-time moment)))
|
|
symlink)
|
|
(if (string-match "\\(.+\\) -> \\(.+\\)" name)
|
|
(setq symlink (match-string 2 name)
|
|
name (match-string 1 name)))
|
|
(setq entry
|
|
(cons
|
|
(cons name
|
|
(list (if (eq (aref perms 0) ?d)
|
|
t
|
|
symlink)
|
|
links user group
|
|
nil mtime nil
|
|
size perms nil nil)) entry)))
|
|
(forward-line)))
|
|
entry))
|
|
|
|
(defun eshell-file-attributes (file &optional id-format)
|
|
"Return the attributes of FILE, playing tricks if it's over ange-ftp.
|
|
The optional argument ID-FORMAT specifies the preferred uid and
|
|
gid format. Valid values are `string' and `integer', defaulting to
|
|
`integer'. See `file-attributes'."
|
|
(let* ((file (expand-file-name file))
|
|
entry)
|
|
(if (string-equal (file-remote-p file 'method) "ftp")
|
|
(let ((base (file-name-nondirectory file))
|
|
(dir (file-name-directory file)))
|
|
(if (string-equal "" base) (setq base "."))
|
|
(unless entry
|
|
(setq entry (eshell-parse-ange-ls dir))
|
|
(if entry
|
|
(let ((fentry (assoc base (cdr entry))))
|
|
(if fentry
|
|
(setq entry (cdr fentry))
|
|
(setq entry nil)))))
|
|
entry)
|
|
(file-attributes file id-format))))
|
|
|
|
(defsubst eshell-processp (proc)
|
|
"If the `processp' function does not exist, PROC is not a process."
|
|
(and (fboundp 'processp) (processp proc)))
|
|
|
|
;; (defun eshell-copy-file
|
|
;; (file newname &optional ok-if-already-exists keep-date)
|
|
;; "Copy FILE to NEWNAME. See docs for `copy-file'."
|
|
;; (let (copied)
|
|
;; (if (string-match "\\`\\([^:]+\\):\\(.*\\)" file)
|
|
;; (let ((front (match-string 1 file))
|
|
;; (back (match-string 2 file))
|
|
;; buffer)
|
|
;; (if (and front (string-match eshell-tar-regexp front)
|
|
;; (setq buffer (find-file-noselect front)))
|
|
;; (with-current-buffer buffer
|
|
;; (goto-char (point-min))
|
|
;; (if (re-search-forward (concat " " (regexp-quote back)
|
|
;; "$") nil t)
|
|
;; (progn
|
|
;; (tar-copy (if (file-directory-p newname)
|
|
;; (expand-file-name
|
|
;; (file-name-nondirectory back) newname)
|
|
;; newname))
|
|
;; (setq copied t))
|
|
;; (error "%s not found in tar file %s" back front))))))
|
|
;; (unless copied
|
|
;; (copy-file file newname ok-if-already-exists keep-date))))
|
|
|
|
;; (defun eshell-file-attributes (filename)
|
|
;; "Return a list of attributes of file FILENAME.
|
|
;; See the documentation for `file-attributes'."
|
|
;; (let (result)
|
|
;; (when (string-match "\\`\\([^:]+\\):\\(.*\\)\\'" filename)
|
|
;; (let ((front (match-string 1 filename))
|
|
;; (back (match-string 2 filename))
|
|
;; buffer)
|
|
;; (when (and front (string-match eshell-tar-regexp front)
|
|
;; (setq buffer (find-file-noselect front)))
|
|
;; (with-current-buffer buffer
|
|
;; (goto-char (point-min))
|
|
;; (when (re-search-forward (concat " " (regexp-quote back)
|
|
;; "\\s-*$") nil t)
|
|
;; (let* ((descrip (tar-current-descriptor))
|
|
;; (tokens (tar-desc-tokens descrip)))
|
|
;; (setq result
|
|
;; (list
|
|
;; (cond
|
|
;; ((eq (tar-header-link-type tokens) 5)
|
|
;; t)
|
|
;; ((eq (tar-header-link-type tokens) t)
|
|
;; (tar-header-link-name tokens)))
|
|
;; 1
|
|
;; (tar-header-uid tokens)
|
|
;; (tar-header-gid tokens)
|
|
;; (tar-header-date tokens)
|
|
;; (tar-header-date tokens)
|
|
;; (tar-header-date tokens)
|
|
;; (tar-header-size tokens)
|
|
;; (file-modes-number-to-symbolic
|
|
;; (logior (tar-header-mode tokens)
|
|
;; (cond
|
|
;; ((eq (tar-header-link-type tokens) 5) 16384)
|
|
;; ((eq (tar-header-link-type tokens) t) 32768))))
|
|
;; nil nil nil))))))))
|
|
;; (or result
|
|
;; (file-attributes filename))))
|
|
|
|
;; Obsolete.
|
|
|
|
(define-obsolete-function-alias 'eshell-uniquify-list #'seq-uniq "28.1")
|
|
(define-obsolete-function-alias 'eshell-uniqify-list #'seq-uniq "28.1")
|
|
(define-obsolete-function-alias 'eshell-copy-tree #'copy-tree "28.1")
|
|
(define-obsolete-function-alias 'eshell-user-name #'user-login-name "28.1")
|
|
|
|
(defun eshell-sublist (l &optional n m)
|
|
"Return from LIST the N to M elements.
|
|
If N or M is nil, it means the end of the list."
|
|
(declare (obsolete seq-subseq "28.1"))
|
|
(seq-subseq l n (1+ m)))
|
|
|
|
(provide 'esh-util)
|
|
|
|
;;; esh-util.el ends here
|