*** empty log message ***

[gnu-emacs] / lisp / find-file.el

diff --git a/lisp/find-file.el b/lisp/find-file.el
index db03adce29fc4716ff51bf02bb91598a565277fa..d4e335def7019a597aff73c4b4c1f58d7bede0f5 100644 (file)
--- a/lisp/find-file.el
+++ b/lisp/find-file.el
@@ -4,15 +4,15 @@
 ;; Maintainer: FSF
 ;; Keywords: c, matching, tools
 
 ;; Maintainer: FSF
 ;; Keywords: c, matching, tools
 

-;; Copyright (C) 1994, 1995, 2002, 2003, 2004,
-;;   2005 Free Software Foundation, Inc.
+;; Copyright (C) 1994, 1995, 2001, 2002, 2003, 2004,
+;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.

 
 ;; This file is part of GNU Emacs.
 
 
 ;; 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
 ;; 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 Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -20,9 +20,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; 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., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 


@@ -132,54 +130,54 @@
   :group 'find-file)
 
 (defcustom ff-pre-find-hook nil
   :group 'find-file)
 
 (defcustom ff-pre-find-hook nil

-  "*List of functions to be called before the search for the file starts."
+  "List of functions to be called before the search for the file starts."

   :type 'hook
   :group 'ff)
 
 (defcustom ff-pre-load-hook nil
   :type 'hook
   :group 'ff)
 
 (defcustom ff-pre-load-hook nil

-  "*List of functions to be called before the other file is loaded."
+  "List of functions to be called before the other file is loaded."

   :type 'hook
   :group 'ff)
 
 (defcustom ff-post-load-hook nil
   :type 'hook
   :group 'ff)
 
 (defcustom ff-post-load-hook nil

-  "*List of functions to be called after the other file is loaded."
+  "List of functions to be called after the other file is loaded."

   :type 'hook
   :group 'ff)
 
 (defcustom ff-not-found-hook nil
   :type 'hook
   :group 'ff)
 
 (defcustom ff-not-found-hook nil

-  "*List of functions to be called if the other file could not be found."
+  "List of functions to be called if the other file could not be found."

   :type 'hook
   :group 'ff)
 
 (defcustom ff-file-created-hook nil
   :type 'hook
   :group 'ff)
 
 (defcustom ff-file-created-hook nil

-  "*List of functions to be called if the other file needs to be created."
+  "List of functions to be called if the other file needs to be created."

   :type 'hook
   :group 'ff)
 
 (defcustom ff-case-fold-search nil
   :type 'hook
   :group 'ff)
 
 (defcustom ff-case-fold-search nil

-  "*Non-nil means ignore cases in matches (see `case-fold-search').
+  "Non-nil means ignore cases in matches (see `case-fold-search').

 If you have extensions in different cases, you will want this to be nil."
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-always-in-other-window nil
 If you have extensions in different cases, you will want this to be nil."
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-always-in-other-window nil

-  "*If non-nil, find the corresponding file in another window by default.
+  "If non-nil, find the corresponding file in another window by default.

 To override this, give an argument to `ff-find-other-file'."
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-ignore-include nil
 To override this, give an argument to `ff-find-other-file'."
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-ignore-include nil

-  "*If non-nil, ignore `#include' lines."
+  "If non-nil, ignore `#include' lines."

   :type 'boolean
   :group 'ff)
 
 (defcustom ff-always-try-to-create t
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-always-try-to-create t

-  "*If non-nil, always attempt to create the other file if it was not found."
+  "If non-nil, always attempt to create the other file if it was not found."

   :type 'boolean
   :group 'ff)
 
 (defcustom ff-quiet-mode nil
   :type 'boolean
   :group 'ff)
 
 (defcustom ff-quiet-mode nil

-  "*If non-nil, trace which directories are being searched."
+  "If non-nil, trace which directories are being searched."

   :type 'boolean
   :group 'ff)
 
   :type 'boolean
   :group 'ff)
 


@@ -189,16 +187,20 @@ To override this, give an argument to `ff-find-other-file'."
     ;; C/C++ include, for NeXTSTEP too
     ("^\#\\s *\\(include\\|import\\)\\s +[<\"]\\(.*\\)[>\"]" .
      (lambda ()
     ;; C/C++ include, for NeXTSTEP too
     ("^\#\\s *\\(include\\|import\\)\\s +[<\"]\\(.*\\)[>\"]" .
      (lambda ()

-       (setq fname (buffer-substring (match-beginning 2) (match-end 2)))))
+       (buffer-substring (match-beginning 2) (match-end 2))))

     )
     )

-  "*A list of regular expressions for `ff-find-file'.
-Specifies how to recognize special constructs such as include files
-etc. and an associated method for extracting the filename from that
-construct.")
+  ;; We include `ff-treat-as-special' documentation here so that autoload
+  ;; can make it available to be read prior to loading this file.
+  "*List of special constructs for `ff-treat-as-special' to recognize.
+Each element, tried in order, has the form (REGEXP . EXTRACT).
+If REGEXP matches the current line (from the beginning of the line),
+`ff-treat-as-special' calls function EXTRACT with no args.
+If EXTRACT returns nil, keep trying.  Otherwise, return the
+filename that EXTRACT returned.")

 
 (defvaralias 'ff-related-file-alist 'ff-other-file-alist)
 (defcustom ff-other-file-alist 'cc-other-file-alist
 
 (defvaralias 'ff-related-file-alist 'ff-other-file-alist)
 (defcustom ff-other-file-alist 'cc-other-file-alist

-  "*Alist of extensions to find given the current file's extension.
+  "Alist of extensions to find given the current file's extension.

 
 This list should contain the most used extensions before the others,
 since the search algorithm searches sequentially through each
 
 This list should contain the most used extensions before the others,
 since the search algorithm searches sequentially through each


@@ -210,7 +212,7 @@ This alist should be set by the major mode."
   :group 'ff)
 
 (defcustom ff-search-directories 'cc-search-directories
   :group 'ff)
 
 (defcustom ff-search-directories 'cc-search-directories

-  "*List of directories to search for a specific file.
+  "List of directories to search for a specific file.

 
 Set by default to `cc-search-directories', expanded at run-time.
 
 
 Set by default to `cc-search-directories', expanded at run-time.
 


@@ -224,7 +226,7 @@ A typical format is
     '(\".\" \"/usr/include\" \"$PROJECT/*/include\")
 
 Environment variables can be inserted between slashes (`/').
     '(\".\" \"/usr/include\" \"$PROJECT/*/include\")
 
 Environment variables can be inserted between slashes (`/').

-They will be replaced by their definition. If a variable does
+They will be replaced by their definition.  If a variable does

 not exist, it is replaced (silently) with an empty string.
 
 The stars are *not* wildcards: they are searched for together with
 not exist, it is replaced (silently) with an empty string.
 
 The stars are *not* wildcards: they are searched for together with


@@ -235,7 +237,7 @@ the preceding slash.  The star represents all the subdirectories except
 
 (defcustom cc-search-directories
   '("." "/usr/include" "/usr/local/include/*")
 
 (defcustom cc-search-directories
   '("." "/usr/include" "/usr/local/include/*")

-  "*See the description of the `ff-search-directories' variable."
+  "See the description of the `ff-search-directories' variable."

   :type '(repeat directory)
   :group 'ff)
 
   :type '(repeat directory)
   :group 'ff)
 


@@ -260,7 +262,7 @@ the preceding slash.  The star represents all the subdirectories except
 
     ("\\.cxx\\'" (".hxx" ".hh" ".h"))
     ("\\.hxx\\'" (".cxx")))
 
     ("\\.cxx\\'" (".hxx" ".hh" ".h"))
     ("\\.hxx\\'" (".cxx")))

-  "*Alist of extensions to find given the current file's extension.
+  "Alist of extensions to find given the current file's extension.

 
 This list should contain the most used extensions before the others,
 since the search algorithm searches sequentially through each directory
 
 This list should contain the most used extensions before the others,
 since the search algorithm searches sequentially through each directory


@@ -274,7 +276,7 @@ is created with the first matching extension (`.cc' yields `.hh')."
     ("\\.mi$" (".md")) ;; Modula-2 module definition
     ("\\.md$" (".mi")) ;; and implementation.
     )
     ("\\.mi$" (".md")) ;; Modula-2 module definition
     ("\\.md$" (".mi")) ;; and implementation.
     )

-  "*See the description for the `ff-search-directories' variable."
+  "See the description for the `ff-search-directories' variable."

   :type '(repeat (list regexp (choice (repeat string) function)))
   :group 'ff)
 
   :type '(repeat (list regexp (choice (repeat string) function)))
   :group 'ff)
 


@@ -405,9 +407,7 @@ If optional IN-OTHER-WINDOW is non-nil, find the file in another window."
               (ff-list-replace-env-vars (symbol-value ff-search-directories))
             (ff-list-replace-env-vars ff-search-directories)))
 
               (ff-list-replace-env-vars (symbol-value ff-search-directories))
             (ff-list-replace-env-vars ff-search-directories)))
 

-    (save-excursion
-      (beginning-of-line 1)
-      (setq fname (ff-treat-as-special)))
+    (setq fname (ff-treat-as-special))

 
     (cond
      ((and (not ff-ignore-include) fname)
 
     (cond
      ((and (not ff-ignore-include) fname)


@@ -540,9 +540,7 @@ the `ff-ignore-include' variable."
               (ff-list-replace-env-vars (symbol-value ff-search-directories))
             (ff-list-replace-env-vars ff-search-directories)))
 
               (ff-list-replace-env-vars (symbol-value ff-search-directories))
             (ff-list-replace-env-vars ff-search-directories)))
 

-    (save-excursion
-      (beginning-of-line 1)
-      (setq fname (ff-treat-as-special)))
+    (setq fname (ff-treat-as-special))

 
     (cond
      ((and (not ff-ignore-include) fname)
 
     (cond
      ((and (not ff-ignore-include) fname)


@@ -613,8 +611,8 @@ the `ff-ignore-include' variable."
 
 (defun ff-get-file (search-dirs filename &optional suffix-list other-window)
   "Find a file in the SEARCH-DIRS with the given FILENAME (or filename stub).
 
 (defun ff-get-file (search-dirs filename &optional suffix-list other-window)
   "Find a file in the SEARCH-DIRS with the given FILENAME (or filename stub).

-If (optional) SUFFIX-LIST is nil, search for fname, otherwise search
-for fname with each of the given suffixes.  Get the file or the buffer
+If (optional) SUFFIX-LIST is nil, search for FILENAME, otherwise search
+for FILENAME with each of the given suffixes.  Get the file or the buffer

 corresponding to the name of the first file found, or nil."
   (let ((filename (ff-get-file-name search-dirs filename suffix-list)))
 
 corresponding to the name of the first file found, or nil."
   (let ((filename (ff-get-file-name search-dirs filename suffix-list)))
 


@@ -638,16 +636,16 @@ corresponding to the name of the first file found, or nil."
 If (optional) SUFFIX-LIST is nil, search for FNAME-STUB, otherwise
 search for FNAME-STUB with each of the given suffixes.  Return the
 name of the first file found."
 If (optional) SUFFIX-LIST is nil, search for FNAME-STUB, otherwise
 search for FNAME-STUB with each of the given suffixes.  Return the
 name of the first file found."

-  (let* (dirs         ;; working copy of dirs to search
-         dir          ;; the current dir considered
-         file         ;; filename being looked for
-         rest         ;; pathname after first /*
-         this-suffix  ;; the suffix we are currently considering
-         suffixes     ;; working copy of suffix-list
-         filename     ;; built filename
-         blist        ;; list of live buffers
-         buf          ;; current buffer in blist
-         found)       ;; whether we have found anything
+  (let (dirs         ;; working copy of dirs to search
+       dir          ;; the current dir considered
+       file         ;; filename being looked for
+       rest         ;; pathname after first /*
+       this-suffix  ;; the suffix we are currently considering
+       suffixes     ;; working copy of suffix-list
+       filename     ;; built filename
+       blist        ;; list of live buffers
+       buf          ;; current buffer in blist
+       found)       ;; whether we have found anything

 
     (setq suffixes suffix-list)
 
 
     (setq suffixes suffix-list)
 


@@ -771,20 +769,22 @@ The value used comes from `ff-case-fold-search'."
 
 (defun ff-treat-as-special ()
   "Return the file to look for if the construct was special, else nil.
 
 (defun ff-treat-as-special ()
   "Return the file to look for if the construct was special, else nil.

-The construct is defined in the variable `ff-special-constructs'."
-  (let* (fname
-         (list ff-special-constructs)
-         (elem (car list))
-         (regexp (car elem))
-         (match (cdr elem)))
-    (while (and list (not fname))
-      (if (and (looking-at regexp) match)
-          (setq fname (funcall match)))
-      (setq list (cdr list))
-      (setq elem (car list))
-      (setq regexp (car elem))
-      (setq match (cdr elem)))
-    fname))
+See variable `ff-special-constructs'."
+  (save-excursion
+    (beginning-of-line 1)
+    (let* (fname
+           (list ff-special-constructs)
+           (elem (car list))
+           (regexp (car elem))
+           (match (cdr elem)))
+      (while (and list (not fname))
+        (if (and (looking-at regexp) match)
+            (setq fname (funcall match)))
+        (setq list (cdr list))
+        (setq elem (car list))
+        (setq regexp (car elem))
+        (setq match (cdr elem)))
+      fname)))

 
 (defun ff-basename (string)
   "Return the basename of pathname STRING."
 
 (defun ff-basename (string)
   "Return the basename of pathname STRING."