38414
|
1 ;;; em-glob.el --- extended file name globbing
|
29876
|
2
|
29934
|
3 ;; Copyright (C) 1999, 2000 Free Software Foundation
|
29876
|
4
|
32526
|
5 ;; Author: John Wiegley <johnw@gnu.org>
|
|
6
|
29876
|
7 ;; This file is part of GNU Emacs.
|
|
8
|
|
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
10 ;; it under the terms of the GNU General Public License as published by
|
|
11 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
12 ;; any later version.
|
|
13
|
|
14 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
17 ;; GNU General Public License for more details.
|
|
18
|
|
19 ;; You should have received a copy of the GNU General Public License
|
|
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
64085
|
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
22 ;; Boston, MA 02110-1301, USA.
|
29876
|
23
|
48210
|
24 ;;; Code:
|
|
25
|
29876
|
26 (provide 'em-glob)
|
|
27
|
|
28 (eval-when-compile (require 'esh-maint))
|
48210
|
29 (require 'esh-util)
|
29876
|
30
|
|
31 (defgroup eshell-glob nil
|
|
32 "This module provides extended globbing syntax, similar what is used
|
|
33 by zsh for filename generation."
|
|
34 :tag "Extended filename globbing"
|
|
35 :group 'eshell-module)
|
|
36
|
|
37 ;;; Commentary:
|
|
38
|
|
39 ;; The globbing code used by Eshell closely follows the syntax used by
|
|
40 ;; zsh. Basically, here is a summary of examples:
|
|
41 ;;
|
|
42 ;; echo a* ; anything starting with 'a'
|
|
43 ;; echo a#b ; zero or more 'a's, then 'b'
|
|
44 ;; echo a##b ; one or more 'a's, then 'b'
|
|
45 ;; echo a? ; a followed by any character
|
|
46 ;; echo a*~ab ; 'a', then anything, but not 'ab'
|
|
47 ;; echo c*~*~ ; all files beginning with 'c', except backups (*~)
|
|
48 ;;
|
|
49 ;; Recursive globbing is also supported:
|
|
50 ;;
|
|
51 ;; echo **/*.c ; all '.c' files at or under current directory
|
|
52 ;; echo ***/*.c ; same as above, but traverse symbolic links
|
|
53 ;;
|
|
54 ;; Using argument predication, the recursive globbing syntax is
|
|
55 ;; sufficient to replace the use of 'find <expr> | xargs <cmd>' in
|
|
56 ;; most cases. For example, to change the readership of all files
|
|
57 ;; belonging to 'johnw' in the '/tmp' directory or lower, use:
|
|
58 ;;
|
|
59 ;; chmod go-r /tmp/**/*(u'johnw')
|
|
60 ;;
|
|
61 ;; The glob above matches all of the files beneath '/tmp' that are
|
|
62 ;; owned by the user 'johnw'. See [Value modifiers and predicates],
|
|
63 ;; for more information about argument predication.
|
|
64
|
|
65 ;;; User Variables:
|
|
66
|
|
67 (defcustom eshell-glob-load-hook '(eshell-glob-initialize)
|
|
68 "*A list of functions to run when `eshell-glob' is loaded."
|
|
69 :type 'hook
|
|
70 :group 'eshell-glob)
|
|
71
|
|
72 (defcustom eshell-glob-include-dot-files nil
|
|
73 "*If non-nil, glob patterns will match files beginning with a dot."
|
|
74 :type 'boolean
|
|
75 :group 'eshell-glob)
|
|
76
|
|
77 (defcustom eshell-glob-include-dot-dot t
|
|
78 "*If non-nil, glob patterns that match dots will match . and .."
|
|
79 :type 'boolean
|
|
80 :group 'eshell-glob)
|
|
81
|
46852
|
82 (defcustom eshell-glob-case-insensitive (eshell-under-windows-p)
|
29876
|
83 "*If non-nil, glob pattern matching will ignore case."
|
|
84 :type 'boolean
|
|
85 :group 'eshell-glob)
|
|
86
|
33020
|
87 (defcustom eshell-glob-show-progress nil
|
|
88 "*If non-nil, display progress messages during a recursive glob.
|
|
89 This option slows down recursive glob processing by quite a bit."
|
29876
|
90 :type 'boolean
|
|
91 :group 'eshell-glob)
|
|
92
|
|
93 (defcustom eshell-error-if-no-glob nil
|
|
94 "*If non-nil, it is an error for a glob pattern not to match.
|
|
95 This mimcs the behavior of zsh if non-nil, but bash if nil."
|
|
96 :type 'boolean
|
|
97 :group 'eshell-glob)
|
|
98
|
|
99 (defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?#)
|
|
100 "*List of additional characters used in extended globbing."
|
|
101 :type '(repeat character)
|
|
102 :group 'eshell-glob)
|
|
103
|
|
104 (defcustom eshell-glob-translate-alist
|
|
105 '((?\] . "]")
|
|
106 (?\[ . "[")
|
|
107 (?? . ".")
|
|
108 (?* . ".*")
|
|
109 (?~ . "~")
|
|
110 (?\( . "\\(")
|
|
111 (?\) . "\\)")
|
|
112 (?\| . "\\|")
|
|
113 (?# . (lambda (str pos)
|
|
114 (if (and (< (1+ pos) (length str))
|
|
115 (memq (aref str (1+ pos)) '(?* ?# ?+ ??)))
|
|
116 (cons (if (eq (aref str (1+ pos)) ??)
|
|
117 "?"
|
|
118 (if (eq (aref str (1+ pos)) ?*)
|
|
119 "*" "+")) (+ pos 2))
|
|
120 (cons "*" (1+ pos))))))
|
|
121 "*An alist for translation of extended globbing characters."
|
|
122 :type '(repeat (cons character (choice regexp function)))
|
|
123 :group 'eshell-glob)
|
|
124
|
|
125 ;;; Functions:
|
|
126
|
|
127 (defun eshell-glob-initialize ()
|
|
128 "Initialize the extended globbing code."
|
|
129 ;; it's important that `eshell-glob-chars-list' come first
|
48210
|
130 (when (boundp 'eshell-special-chars-outside-quoting)
|
|
131 (set (make-local-variable 'eshell-special-chars-outside-quoting)
|
|
132 (append eshell-glob-chars-list eshell-special-chars-outside-quoting)))
|
29876
|
133 (add-hook 'eshell-parse-argument-hook 'eshell-parse-glob-chars t t)
|
|
134 (add-hook 'eshell-pre-rewrite-command-hook
|
|
135 'eshell-no-command-globbing nil t))
|
|
136
|
|
137 (defun eshell-no-command-globbing (terms)
|
|
138 "Don't glob the command argument. Reflect this by modifying TERMS."
|
|
139 (ignore
|
|
140 (when (and (listp (car terms))
|
|
141 (eq (caar terms) 'eshell-extended-glob))
|
|
142 (setcar terms (cadr (car terms))))))
|
|
143
|
|
144 (defun eshell-add-glob-modifier ()
|
|
145 "Add `eshell-extended-glob' to the argument modifier list."
|
|
146 (when (memq 'expand-file-name eshell-current-modifiers)
|
|
147 (setq eshell-current-modifiers
|
|
148 (delq 'expand-file-name eshell-current-modifiers))
|
|
149 ;; if this is a glob pattern than needs to be expanded, then it
|
|
150 ;; will need to expand each member of the resulting glob list
|
|
151 (add-to-list 'eshell-current-modifiers
|
|
152 '(lambda (list)
|
|
153 (if (listp list)
|
|
154 (mapcar 'expand-file-name list)
|
|
155 (expand-file-name list)))))
|
|
156 (add-to-list 'eshell-current-modifiers 'eshell-extended-glob))
|
|
157
|
|
158 (defun eshell-parse-glob-chars ()
|
|
159 "Parse a globbing delimiter.
|
|
160 The character is not advanced for ordinary globbing characters, so
|
|
161 that other function may have a chance to override the globbing
|
|
162 interpretation."
|
|
163 (when (memq (char-after) eshell-glob-chars-list)
|
|
164 (if (not (memq (char-after) '(?\( ?\[)))
|
|
165 (ignore (eshell-add-glob-modifier))
|
|
166 (let ((here (point)))
|
|
167 (forward-char)
|
|
168 (let* ((delim (char-before))
|
|
169 (end (eshell-find-delimiter
|
|
170 delim (if (eq delim ?\[) ?\] ?\)))))
|
|
171 (if (not end)
|
|
172 (throw 'eshell-incomplete delim)
|
|
173 (if (and (eshell-using-module 'eshell-pred)
|
|
174 (eshell-arg-delimiter (1+ end)))
|
|
175 (ignore (goto-char here))
|
|
176 (eshell-add-glob-modifier)
|
|
177 (prog1
|
|
178 (buffer-substring-no-properties (1- (point)) (1+ end))
|
|
179 (goto-char (1+ end))))))))))
|
|
180
|
55430
|
181 (defvar eshell-glob-chars-regexp nil)
|
|
182
|
29876
|
183 (defun eshell-glob-regexp (pattern)
|
|
184 "Convert glob-pattern PATTERN to a regular expression.
|
|
185 The basic syntax is:
|
|
186
|
|
187 glob regexp meaning
|
|
188 ---- ------ -------
|
|
189 ? . matches any single character
|
|
190 * .* matches any group of characters (or none)
|
|
191 # * matches zero or more occurrences of preceding
|
|
192 ## + matches one or more occurrences of preceding
|
|
193 (x) \(x\) makes 'x' a regular expression group
|
|
194 | \| boolean OR within an expression group
|
|
195 [a-b] [a-b] matches a character or range
|
|
196 [^a] [^a] excludes a character or range
|
|
197
|
|
198 If any characters in PATTERN have the text property `eshell-escaped'
|
|
199 set to true, then these characters will match themselves in the
|
|
200 resulting regular expression."
|
|
201 (let ((matched-in-pattern 0) ; How much of PATTERN handled
|
|
202 regexp)
|
55430
|
203 (while (string-match
|
|
204 (or eshell-glob-chars-regexp
|
|
205 (set (make-local-variable 'eshell-glob-chars-regexp)
|
|
206 (format "[%s]+" (apply 'string eshell-glob-chars-list))))
|
|
207 pattern matched-in-pattern)
|
29876
|
208 (let* ((op-begin (match-beginning 0))
|
|
209 (op-char (aref pattern op-begin)))
|
|
210 (setq regexp
|
|
211 (concat regexp
|
|
212 (regexp-quote
|
|
213 (substring pattern matched-in-pattern op-begin))))
|
|
214 (if (get-text-property op-begin 'escaped pattern)
|
|
215 (setq regexp (concat regexp
|
|
216 (regexp-quote (char-to-string op-char)))
|
|
217 matched-in-pattern (1+ op-begin))
|
|
218 (let ((xlat (assq op-char eshell-glob-translate-alist)))
|
|
219 (if (not xlat)
|
|
220 (error "Unrecognized globbing character '%c'" op-char)
|
|
221 (if (stringp (cdr xlat))
|
|
222 (setq regexp (concat regexp (cdr xlat))
|
|
223 matched-in-pattern (1+ op-begin))
|
|
224 (let ((result (funcall (cdr xlat) pattern op-begin)))
|
|
225 (setq regexp (concat regexp (car result))
|
|
226 matched-in-pattern (cdr result)))))))))
|
|
227 (concat "\\`"
|
|
228 regexp
|
|
229 (regexp-quote (substring pattern matched-in-pattern))
|
|
230 "\\'")))
|
|
231
|
|
232 (defun eshell-extended-glob (glob)
|
|
233 "Return a list of files generated from GLOB, perhaps looking for DIRS-ONLY.
|
48210
|
234 This function almost fully supports zsh style filename generation
|
|
235 syntax. Things that are not supported are:
|
29876
|
236
|
|
237 ^foo for matching everything but foo
|
|
238 (foo~bar) tilde within a parenthesis group
|
|
239 foo<1-10> numeric ranges
|
|
240 foo~x(a|b) (a|b) will be interpreted as a predicate/modifier list
|
|
241
|
48210
|
242 Mainly they are not supported because file matching is done with Emacs
|
|
243 regular expressions, and these cannot support the above constructs.
|
29876
|
244
|
48210
|
245 If this routine fails, it returns nil. Otherwise, it returns a list
|
|
246 the form:
|
29876
|
247
|
|
248 (INCLUDE-REGEXP EXCLUDE-REGEXP (PRED-FUNC-LIST) (MOD-FUNC-LIST))"
|
|
249 (let ((paths (eshell-split-path glob))
|
32446
aab90b31807c
Added better remote directory support to Eshell, as well as a few bug
John Wiegley <johnw@newartisans.com>
diff
changeset
|
250 matches message-shown ange-cache)
|
29876
|
251 (unwind-protect
|
|
252 (if (and (cdr paths)
|
|
253 (file-name-absolute-p (car paths)))
|
|
254 (eshell-glob-entries (file-name-as-directory (car paths))
|
|
255 (cdr paths))
|
|
256 (eshell-glob-entries (file-name-as-directory ".") paths))
|
|
257 (if message-shown
|
|
258 (message nil)))
|
|
259 (or (and matches (nreverse matches))
|
|
260 (if eshell-error-if-no-glob
|
|
261 (error "No matches found: %s" glob)
|
|
262 glob))))
|
|
263
|
|
264 (eval-when-compile
|
|
265 (defvar matches)
|
|
266 (defvar message-shown))
|
|
267
|
|
268 (defun eshell-glob-entries (path globs &optional recurse-p)
|
|
269 "Glob the entries in PATHS, possibly recursing if RECURSE-P is non-nil."
|
|
270 (let* ((entries (ignore-errors
|
|
271 (file-name-all-completions "" path)))
|
|
272 (case-fold-search eshell-glob-case-insensitive)
|
|
273 (glob (car globs))
|
|
274 (len (length glob))
|
|
275 dirs rdirs
|
|
276 incl excl
|
|
277 name isdir pathname)
|
|
278 (while (cond
|
|
279 ((and (= len 3) (equal glob "**/"))
|
|
280 (setq recurse-p 2
|
|
281 globs (cdr globs)
|
|
282 glob (car globs)
|
|
283 len (length glob)))
|
|
284 ((and (= len 4) (equal glob "***/"))
|
|
285 (setq recurse-p 3
|
|
286 globs (cdr globs)
|
|
287 glob (car globs)
|
|
288 len (length glob)))))
|
|
289 (if (and recurse-p (not glob))
|
|
290 (error "'**' cannot end a globbing pattern"))
|
|
291 (let ((index 1))
|
|
292 (setq incl glob)
|
|
293 (while (and (eq incl glob)
|
|
294 (setq index (string-match "~" glob index)))
|
|
295 (if (or (get-text-property index 'escaped glob)
|
|
296 (or (= (1+ index) len)))
|
|
297 (setq index (1+ index))
|
|
298 (setq incl (substring glob 0 index)
|
|
299 excl (substring glob (1+ index))))))
|
|
300 ;; can't use `directory-file-name' because it strips away text
|
|
301 ;; properties in the string
|
|
302 (let ((len (1- (length incl))))
|
62915
b89e30bcd2bb
Changed all uses of `directory-sep-char' to ?/, and all uses of
John Wiegley <johnw@newartisans.com>
diff
changeset
|
303 (if (eq (aref incl len) ?/)
|
29876
|
304 (setq incl (substring incl 0 len)))
|
|
305 (when excl
|
|
306 (setq len (1- (length excl)))
|
62915
b89e30bcd2bb
Changed all uses of `directory-sep-char' to ?/, and all uses of
John Wiegley <johnw@newartisans.com>
diff
changeset
|
307 (if (eq (aref excl len) ?/)
|
29876
|
308 (setq excl (substring excl 0 len)))))
|
|
309 (setq incl (eshell-glob-regexp incl)
|
|
310 excl (and excl (eshell-glob-regexp excl)))
|
|
311 (if (or eshell-glob-include-dot-files
|
|
312 (eq (aref glob 0) ?.))
|
|
313 (unless (or eshell-glob-include-dot-dot
|
|
314 (cdr globs))
|
|
315 (setq excl (if excl
|
|
316 (concat "\\(\\`\\.\\.?\\'\\|" excl "\\)")
|
|
317 "\\`\\.\\.?\\'")))
|
|
318 (setq excl (if excl
|
|
319 (concat "\\(\\`\\.\\|" excl "\\)")
|
|
320 "\\`\\.")))
|
|
321 (when (and recurse-p eshell-glob-show-progress)
|
|
322 (message "Building file list...%d so far: %s"
|
|
323 (length matches) path)
|
|
324 (setq message-shown t))
|
|
325 (if (equal path "./") (setq path ""))
|
|
326 (while entries
|
|
327 (setq name (car entries)
|
|
328 len (length name)
|
62915
b89e30bcd2bb
Changed all uses of `directory-sep-char' to ?/, and all uses of
John Wiegley <johnw@newartisans.com>
diff
changeset
|
329 isdir (eq (aref name (1- len)) ?/))
|
29876
|
330 (if (let ((fname (directory-file-name name)))
|
|
331 (and (not (and excl (string-match excl fname)))
|
|
332 (string-match incl fname)))
|
|
333 (if (cdr globs)
|
|
334 (if isdir
|
|
335 (setq dirs (cons (concat path name) dirs)))
|
|
336 (setq matches (cons (concat path name) matches))))
|
|
337 (if (and recurse-p isdir
|
|
338 (or (> len 3)
|
|
339 (not (or (and (= len 2) (equal name "./"))
|
|
340 (and (= len 3) (equal name "../")))))
|
|
341 (setq pathname (concat path name))
|
|
342 (not (and (= recurse-p 2)
|
|
343 (file-symlink-p
|
|
344 (directory-file-name pathname)))))
|
|
345 (setq rdirs (cons pathname rdirs)))
|
|
346 (setq entries (cdr entries)))
|
|
347 (setq dirs (nreverse dirs)
|
|
348 rdirs (nreverse rdirs))
|
|
349 (while dirs
|
|
350 (eshell-glob-entries (car dirs) (cdr globs))
|
|
351 (setq dirs (cdr dirs)))
|
|
352 (while rdirs
|
|
353 (eshell-glob-entries (car rdirs) globs recurse-p)
|
|
354 (setq rdirs (cdr rdirs)))))
|
|
355
|
52401
|
356 ;;; arch-tag: d0548f54-fb7c-4978-a88e-f7c26f7f68ca
|
29876
|
357 ;;; em-glob.el ends here
|