]> code.delx.au - gnu-emacs/blobdiff - lisp/eshell/em-glob.el
Spelling fixes.
[gnu-emacs] / lisp / eshell / em-glob.el
index b281cee4fd769c8c1150e10762295bdc0f6a727b..db9b003895f1185a3bf812ced9af298a3cdd0290 100644 (file)
@@ -1,15 +1,15 @@
-;;; em-glob --- extended file name globbing
+;;; em-glob.el --- extended file name globbing
 
-;; Copyright (C) 1999, 2000 Free Software Foundation
+;; Copyright (C) 1999-2011  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
+;; 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 2, or (at your option)
-;; any later version.
+;; 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
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
-
-(provide 'em-glob)
-
-(eval-when-compile (require 'esh-maint))
-
-(defgroup eshell-glob nil
-  "This module provides extended globbing syntax, similar what is used
-by zsh for filename generation."
-  :tag "Extended filename globbing"
-  :group 'eshell-module)
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -59,47 +47,62 @@ by zsh for filename generation."
 ;; owned by the user 'johnw'.  See [Value modifiers and predicates],
 ;; for more information about argument predication.
 
+;;; Code:
+
+(eval-when-compile (require 'eshell))
+(require 'esh-util)
+
+;;;###autoload
+(eshell-defgroup eshell-glob nil
+  "This module provides extended globbing syntax, similar what is used
+by zsh for filename generation."
+  :tag "Extended filename globbing"
+  :group 'eshell-module)
+
 ;;; User Variables:
 
-(defcustom eshell-glob-load-hook '(eshell-glob-initialize)
-  "*A list of functions to run when `eshell-glob' is loaded."
+(defcustom eshell-glob-load-hook nil
+  "A list of functions to run when `eshell-glob' is loaded."
+  :version "24.1"                      ; removed eshell-glob-initialize
   :type 'hook
   :group 'eshell-glob)
 
 (defcustom eshell-glob-include-dot-files nil
-  "*If non-nil, glob patterns will match files beginning with a dot."
+  "If non-nil, glob patterns will match files beginning with a dot."
   :type 'boolean
   :group 'eshell-glob)
 
 (defcustom eshell-glob-include-dot-dot t
-  "*If non-nil, glob patterns that match dots will match . and .."
+  "If non-nil, glob patterns that match dots will match . and .."
   :type 'boolean
   :group 'eshell-glob)
 
 (defcustom eshell-glob-case-insensitive (eshell-under-windows-p)
-  "*If non-nil, glob pattern matching will ignore case."
+  "If non-nil, glob pattern matching will ignore case."
   :type 'boolean
   :group 'eshell-glob)
 
-(defcustom eshell-glob-show-progress t
-  "*If non-nil, display progress messages during a recursive glob."
+(defcustom eshell-glob-show-progress nil
+  "If non-nil, display progress messages during a recursive glob.
+This option slows down recursive glob processing by quite a bit."
   :type 'boolean
   :group 'eshell-glob)
 
 (defcustom eshell-error-if-no-glob nil
-  "*If non-nil, it is an error for a glob pattern not to match.
+  "If non-nil, it is an error for a glob pattern not to match.
  This mimcs the behavior of zsh if non-nil, but bash if nil."
   :type 'boolean
   :group 'eshell-glob)
 
-(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?#)
-  "*List of additional characters used in extended globbing."
+(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?# ?^)
+  "List of additional characters used in extended globbing."
   :type '(repeat character)
   :group 'eshell-glob)
 
 (defcustom eshell-glob-translate-alist
   '((?\] . "]")
     (?\[ . "[")
+    (?^  . "^")
     (??  . ".")
     (?*  . ".*")
     (?~  . "~")
@@ -114,26 +117,19 @@ by zsh for filename generation."
                         (if (eq (aref str (1+ pos)) ?*)
                             "*" "+")) (+ pos 2))
               (cons "*" (1+ pos))))))
-  "*An alist for translation of extended globbing characters."
+  "An alist for translation of extended globbing characters."
   :type '(repeat (cons character (choice regexp function)))
   :group 'eshell-glob)
 
-;;; Internal Variables:
-
-(defvar eshell-glob-chars-regexp nil)
-
 ;;; Functions:
 
 (defun eshell-glob-initialize ()
   "Initialize the extended globbing code."
   ;; it's important that `eshell-glob-chars-list' come first
-  (set (make-local-variable 'eshell-special-chars-outside-quoting)
-       (append eshell-glob-chars-list eshell-special-chars-outside-quoting))
-  (set (make-local-variable 'eshell-glob-chars-regexp)
-       (format "[%s]+" (apply 'string eshell-glob-chars-list)))
-  (make-local-hook 'eshell-parse-argument-hook)
+  (when (boundp 'eshell-special-chars-outside-quoting)
+    (set (make-local-variable 'eshell-special-chars-outside-quoting)
+        (append eshell-glob-chars-list eshell-special-chars-outside-quoting)))
   (add-hook 'eshell-parse-argument-hook 'eshell-parse-glob-chars t t)
-  (make-local-hook 'eshell-pre-rewrite-command-hook)
   (add-hook 'eshell-pre-rewrite-command-hook
            'eshell-no-command-globbing nil t))
 
@@ -152,10 +148,10 @@ by zsh for filename generation."
     ;; if this is a glob pattern than needs to be expanded, then it
     ;; will need to expand each member of the resulting glob list
     (add-to-list 'eshell-current-modifiers
-                '(lambda (list)
-                   (if (listp list)
-                       (mapcar 'expand-file-name list)
-                     (expand-file-name list)))))
+                (lambda (list)
+                   (if (listp list)
+                       (mapcar 'expand-file-name list)
+                     (expand-file-name list)))))
   (add-to-list 'eshell-current-modifiers 'eshell-extended-glob))
 
 (defun eshell-parse-glob-chars ()
@@ -181,6 +177,8 @@ interpretation."
                  (buffer-substring-no-properties (1- (point)) (1+ end))
                (goto-char (1+ end))))))))))
 
+(defvar eshell-glob-chars-regexp nil)
+
 (defun eshell-glob-regexp (pattern)
   "Convert glob-pattern PATTERN to a regular expression.
 The basic syntax is:
@@ -201,8 +199,11 @@ set to true, then these characters will match themselves in the
 resulting regular expression."
   (let ((matched-in-pattern 0)          ; How much of PATTERN handled
        regexp)
-    (while (string-match eshell-glob-chars-regexp
-                        pattern matched-in-pattern)
+    (while (string-match
+           (or eshell-glob-chars-regexp
+               (set (make-local-variable 'eshell-glob-chars-regexp)
+                    (format "[%s]+" (apply 'string eshell-glob-chars-list))))
+           pattern matched-in-pattern)
       (let* ((op-begin (match-beginning 0))
             (op-char (aref pattern op-begin)))
        (setq regexp
@@ -229,23 +230,23 @@ resulting regular expression."
 
 (defun eshell-extended-glob (glob)
   "Return a list of files generated from GLOB, perhaps looking for DIRS-ONLY.
- This function almost fully supports zsh style filename generation
- syntax.  Things that are not supported are:
+This function almost fully supports zsh style filename generation
+syntax.  Things that are not supported are:
 
    ^foo        for matching everything but foo
    (foo~bar)   tilde within a parenthesis group
    foo<1-10>   numeric ranges
    foo~x(a|b)  (a|b) will be interpreted as a predicate/modifier list
 
- Mainly they are not supported because file matching is done with Emacs
- regular expressions, and these cannot support the above constructs.
+Mainly they are not supported because file matching is done with Emacs
+regular expressions, and these cannot support the above constructs.
 
- If this routine fails, it returns nil.  Otherwise, it returns a list
- the form:
+If this routine fails, it returns nil.  Otherwise, it returns a list
+the form:
 
    (INCLUDE-REGEXP EXCLUDE-REGEXP (PRED-FUNC-LIST) (MOD-FUNC-LIST))"
   (let ((paths (eshell-split-path glob))
-       matches message-shown ange-cache)
+       eshell-glob-matches message-shown ange-cache)
     (unwind-protect
        (if (and (cdr paths)
                 (file-name-absolute-p (car paths)))
@@ -254,18 +255,15 @@ resulting regular expression."
          (eshell-glob-entries (file-name-as-directory ".") paths))
       (if message-shown
          (message nil)))
-    (or (and matches (nreverse matches))
+    (or (and eshell-glob-matches (sort eshell-glob-matches #'string<))
        (if eshell-error-if-no-glob
            (error "No matches found: %s" glob)
          glob))))
 
-(eval-when-compile
-  (defvar matches)
-  (defvar message-shown))
-
-;; jww (1999-11-18): this function assumes that directory-sep-char is
-;; a forward slash (/)
+(defvar eshell-glob-matches)
+(defvar message-shown)
 
+;; FIXME does this really need to abuse eshell-glob-matches, message-shown?
 (defun eshell-glob-entries (path globs &optional recurse-p)
   "Glob the entries in PATHS, possibly recursing if RECURSE-P is non-nil."
   (let* ((entries (ignore-errors
@@ -301,11 +299,11 @@ resulting regular expression."
     ;; can't use `directory-file-name' because it strips away text
     ;; properties in the string
     (let ((len (1- (length incl))))
-      (if (eq (aref incl len) directory-sep-char)
+      (if (eq (aref incl len) ?/)
          (setq incl (substring incl 0 len)))
       (when excl
        (setq len (1- (length excl)))
-       (if (eq (aref excl len) directory-sep-char)
+       (if (eq (aref excl len) ?/)
            (setq excl (substring excl 0 len)))))
     (setq incl (eshell-glob-regexp incl)
          excl (and excl (eshell-glob-regexp excl)))
@@ -321,20 +319,21 @@ resulting regular expression."
                   "\\`\\.")))
     (when (and recurse-p eshell-glob-show-progress)
       (message "Building file list...%d so far: %s"
-              (length matches) path)
+              (length eshell-glob-matches) path)
       (setq message-shown t))
     (if (equal path "./") (setq path ""))
     (while entries
       (setq name (car entries)
            len (length name)
-           isdir (eq (aref name (1- len)) directory-sep-char))
+           isdir (eq (aref name (1- len)) ?/))
       (if (let ((fname (directory-file-name name)))
            (and (not (and excl (string-match excl fname)))
                 (string-match incl fname)))
          (if (cdr globs)
              (if isdir
                  (setq dirs (cons (concat path name) dirs)))
-           (setq matches (cons (concat path name) matches))))
+           (setq eshell-glob-matches
+                 (cons (concat path name) eshell-glob-matches))))
       (if (and recurse-p isdir
               (or (> len 3)
                   (not (or (and (= len 2) (equal name "./"))
@@ -354,6 +353,10 @@ resulting regular expression."
       (eshell-glob-entries (car rdirs) globs recurse-p)
       (setq rdirs (cdr rdirs)))))
 
-;;; Code:
+(provide 'em-glob)
+
+;; Local Variables:
+;; generated-autoload-file: "esh-groups.el"
+;; End:
 
 ;;; em-glob.el ends here