XEmacs 21.2-b3
[chise/xemacs-chise.git.1] / lisp / files.el
1 ;;; files.el --- file input and output commands for XEmacs.
2
3 ;; Copyright (C) 1985-1987, 1992-1995, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Sun Microsystems.
5
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: extensions, dumped
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
23 ;; Software Foundation, Inc. 59 Temple Place - Suite 330, Boston, MA
24 ;; 02111-1307, USA.
25
26 ;;; Synched up with: FSF 20.3 (but diverging)
27 ;;; Warning: Merging this file is tough.  Beware.
28
29 ;;; Commentary:
30
31 ;; This file is dumped with XEmacs.
32
33 ;; Defines most of XEmacs's file- and directory-handling functions,
34 ;; including basic file visiting, backup generation, link handling,
35 ;; ITS-id version control, load- and write-hook handling, and the like.
36
37 ;;; Code:
38
39 ;; XEmacs: Avoid compilation warnings.
40 (defvar coding-system-for-read)
41 (defvar buffer-file-coding-system)
42
43 (defgroup files nil
44   "Support editing files."
45   :group 'emacs)
46
47 (defgroup backup nil
48   "Backups of edited data files."
49   :group 'files)
50
51 (defgroup find-file nil
52   "Finding and editing files."
53   :group 'files)
54
55
56 ;; XEmacs: In buffer.c
57 ;(defconst delete-auto-save-files t
58 ;  "*Non-nil means delete auto-save file when a buffer is saved or killed.")
59
60 ;; FSF has automount-dir-prefix.  Our directory-abbrev-alist is more general.
61 ;; note: tmp_mnt bogosity conversion is established in paths.el.
62 (defcustom directory-abbrev-alist nil
63   "*Alist of abbreviations for file directories.
64 A list of elements of the form (FROM . TO), each meaning to replace
65 FROM with TO when it appears in a directory name.
66 This replacement is done when setting up the default directory of a
67 newly visited file.  *Every* FROM string should start with \\\\` or ^.
68
69 Use this feature when you have directories which you normally refer to
70 via absolute symbolic links or to eliminate automounter mount points
71 from the beginning of your filenames.  Make TO the name of the link,
72 and FROM the name it is linked to."
73   :type '(repeat (cons :format "%v"
74                        :value ("\\`" . "")
75                        (regexp :tag "From")
76                        (regexp :tag "To")))
77   :group 'find-file)
78
79 ;;; Turn off backup files on VMS since it has version numbers.
80 (defcustom make-backup-files (not (eq system-type 'vax-vms))
81   "*Non-nil means make a backup of a file the first time it is saved.
82 This can be done by renaming the file or by copying.
83
84 Renaming means that XEmacs renames the existing file so that it is a
85 backup file, then writes the buffer into a new file.  Any other names
86 that the old file had will now refer to the backup file.  The new file
87 is owned by you and its group is defaulted.
88
89 Copying means that XEmacs copies the existing file into the backup
90 file, then writes the buffer on top of the existing file.  Any other
91 names that the old file had will now refer to the new (edited) file.
92 The file's owner and group are unchanged.
93
94 The choice of renaming or copying is controlled by the variables
95 `backup-by-copying', `backup-by-copying-when-linked' and
96 `backup-by-copying-when-mismatch'.  See also `backup-inhibited'."
97   :type 'boolean
98   :group 'backup)
99
100 ;; Do this so that local variables based on the file name
101 ;; are not overridden by the major mode.
102 (defvar backup-inhibited nil
103   "Non-nil means don't make a backup, regardless of the other parameters.
104 This variable is intended for use by making it local to a buffer.
105 But it is local only if you make it local.")
106 (put 'backup-inhibited 'permanent-local t)
107
108 (defcustom backup-by-copying nil
109  "*Non-nil means always use copying to create backup files.
110 See documentation of variable `make-backup-files'."
111  :type 'boolean
112  :group 'backup)
113
114 (defcustom backup-by-copying-when-linked nil
115  "*Non-nil means use copying to create backups for files with multiple names.
116 This causes the alternate names to refer to the latest version as edited.
117 This variable is relevant only if `backup-by-copying' is nil."
118  :type 'boolean
119  :group 'backup)
120
121 (defcustom backup-by-copying-when-mismatch nil
122   "*Non-nil means create backups by copying if this preserves owner or group.
123 Renaming may still be used (subject to control of other variables)
124 when it would not result in changing the owner or group of the file;
125 that is, for files which are owned by you and whose group matches
126 the default for a new file created there by you.
127 This variable is relevant only if `backup-by-copying' is nil."
128   :type 'boolean
129   :group 'backup)
130
131 (defvar backup-enable-predicate
132   #'(lambda (name)
133      (not (or (null name)
134               (string-match "^/tmp/" name)
135               (let ((tmpdir (temp-directory)))
136                 (and tmpdir
137                      (string-match (concat "\\`" (regexp-quote tmpdir) "/")
138                                    tmpdir))))))
139   "Predicate that looks at a file name and decides whether to make backups.
140 Called with an absolute file name as argument, it returns t to enable backup.")
141
142 (defcustom buffer-offer-save nil
143   "*Non-nil in a buffer means offer to save the buffer on exit
144 even if the buffer is not visiting a file.
145 Automatically local in all buffers."
146   :type 'boolean
147   :group 'find-file)
148 (make-variable-buffer-local 'buffer-offer-save)
149
150 ;; FSF uses normal defconst
151 (defvaralias 'find-file-visit-truename 'find-file-use-truenames)
152 (defvaralias 'find-file-existing-other-name 'find-file-compare-truenames)
153
154 (defcustom revert-without-query nil
155   "*Specify which files should be reverted without query.
156 The value is a list of regular expressions.
157 If the file name matches one of these regular expressions,
158 then `revert-buffer' reverts the file without querying
159 if the file has changed on disk and you have not edited the buffer."
160   :type '(repeat (regexp ""))
161   :group 'find-file)
162
163 (defvar buffer-file-number nil
164   "The device number and file number of the file visited in the current buffer.
165 The value is a list of the form (FILENUM DEVNUM).
166 This pair of numbers uniquely identifies the file.
167 If the buffer is visiting a new file, the value is nil.")
168 (make-variable-buffer-local 'buffer-file-number)
169 (put 'buffer-file-number 'permanent-local t)
170
171 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
172   "Non-nil means that buffer-file-number uniquely identifies files.")
173
174 (defcustom file-precious-flag nil
175   "*Non-nil means protect against I/O errors while saving files.
176 Some modes set this non-nil in particular buffers.
177
178 This feature works by writing the new contents into a temporary file
179 and then renaming the temporary file to replace the original.
180 In this way, any I/O error in writing leaves the original untouched,
181 and there is never any instant where the file is nonexistent.
182
183 Note that this feature forces backups to be made by copying.
184 Yet, at the same time, saving a precious file
185 breaks any hard links between it and other files."
186   :type 'boolean
187   :group 'backup)
188
189 (defcustom version-control nil
190   "*Control use of version numbers for backup files.
191 t means make numeric backup versions unconditionally.
192 nil means make them for files that have some already.
193 `never' means do not make them."
194   :type 'boolean
195   :group 'backup
196   :group 'vc)
197
198 ;; This is now defined in efs.
199 ;(defvar dired-kept-versions 2
200 ;  "*When cleaning directory, number of versions to keep.")
201
202 (defcustom delete-old-versions nil
203   "*If t, delete excess backup versions silently.
204 If nil, ask confirmation.  Any other value prevents any trimming."
205   :type '(choice (const :tag "Delete" t)
206                  (const :tag "Ask" nil)
207                  (sexp :tag "Leave" :format "%t\n" other))
208   :group 'backup)
209
210 (defcustom kept-old-versions 2
211   "*Number of oldest versions to keep when a new numbered backup is made."
212   :type 'integer
213   :group 'backup)
214
215 (defcustom kept-new-versions 2
216   "*Number of newest versions to keep when a new numbered backup is made.
217 Includes the new backup.  Must be > 0"
218   :type 'integer
219   :group 'backup)
220
221 (defcustom require-final-newline nil
222   "*Value of t says silently ensure a file ends in a newline when it is saved.
223 Non-nil but not t says ask user whether to add a newline when there isn't one.
224 nil means don't add newlines."
225   :type '(choice (const :tag "Off" nil)
226                  (const :tag "Add" t)
227                  (sexp :tag "Ask" :format "%t\n" ask))
228   :group 'editing-basics)
229
230 (defcustom auto-save-default t
231   "*Non-nil says by default do auto-saving of every file-visiting buffer."
232   :type 'boolean
233   :group 'auto-save)
234
235 (defcustom auto-save-visited-file-name nil
236   "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
237 Normally auto-save files are written under other names."
238   :type 'boolean
239   :group 'auto-save)
240
241 (defcustom save-abbrevs nil
242   "*Non-nil means save word abbrevs too when files are saved.
243 Loading an abbrev file sets this to t."
244   :type 'boolean
245   :group 'abbrev)
246
247 (defcustom find-file-run-dired t
248   "*Non-nil says run dired if `find-file' is given the name of a directory."
249   :type 'boolean
250   :group 'find-file)
251
252 ;;;It is not useful to make this a local variable.
253 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
254 (defvar find-file-not-found-hooks nil
255   "List of functions to be called for `find-file' on nonexistent file.
256 These functions are called as soon as the error is detected.
257 `buffer-file-name' is already set up.
258 The functions are called in the order given until one of them returns non-nil.")
259
260 ;;;It is not useful to make this a local variable.
261 ;;;(put 'find-file-hooks 'permanent-local t)
262 (defvar find-file-hooks nil
263   "List of functions to be called after a buffer is loaded from a file.
264 The buffer's local variables (if any) will have been processed before the
265 functions are called.")
266
267 (defvar write-file-hooks nil
268   "List of functions to be called before writing out a buffer to a file.
269 If one of them returns non-nil, the file is considered already written
270 and the rest are not called.
271 These hooks are considered to pertain to the visited file.
272 So this list is cleared if you change the visited file name.
273 See also `write-contents-hooks' and `continue-save-buffer'.")
274 ;;; However, in case someone does make it local...
275 (put 'write-file-hooks 'permanent-local t)
276
277 (defvar local-write-file-hooks nil
278   "Just like `write-file-hooks', except intended for per-buffer use.
279 The functions in this list are called before the ones in
280 `write-file-hooks'.
281
282 This variable is meant to be used for hooks that have to do with a
283 particular visited file.  Therefore, it is a permanent local, so that
284 changing the major mode does not clear it.  However, calling
285 `set-visited-file-name' does clear it.")
286 (make-variable-buffer-local 'local-write-file-hooks)
287 (put 'local-write-file-hooks 'permanent-local t)
288
289
290 ;; #### think about this (added by Sun).
291 (put 'after-set-visited-file-name-hooks 'permanent-local t)
292 (defvar after-set-visited-file-name-hooks nil
293   "List of functions to be called after \\[set-visited-file-name]
294 or during \\[write-file].
295 You can use this hook to restore local values of write-file-hooks,
296 after-save-hook, and revert-buffer-function, which pertain
297 to a specific file and therefore are normally killed by a rename.
298 Put hooks pertaining to the buffer contents on write-contents-hooks
299 and revert-buffer-insert-file-contents-function.")
300
301 (defvar write-contents-hooks nil
302   "List of functions to be called before writing out a buffer to a file.
303 If one of them returns non-nil, the file is considered already written
304 and the rest are not called.
305 These hooks are considered to pertain to the buffer's contents,
306 not to the particular visited file; thus, `set-visited-file-name' does
307 not clear this variable, but changing the major mode does clear it.
308 See also `write-file-hooks' and `continue-save-buffer'.")
309
310 ;;  XEmacs addition
311 ;;  Energize needed this to hook into save-buffer at a lower level; we need
312 ;;  to provide a new output method, but don't want to have to duplicate all
313 ;;  of the backup file and file modes logic.that does not occur if one uses
314 ;;  a write-file-hook which returns non-nil.
315 (put 'write-file-data-hooks 'permanent-local t)
316 (defvar write-file-data-hooks nil
317   "List of functions to be called to put the bytes on disk.
318 These functions receive the name of the file to write to as argument.
319 The default behavior is to call
320   (write-region (point-min) (point-max) filename nil t)
321 If one of them returns non-nil, the file is considered already written
322 and the rest are not called.
323 These hooks are considered to pertain to the visited file.
324 So this list is cleared if you change the visited file name.
325 See also `write-file-hooks'.")
326
327 (defcustom enable-local-variables t
328   "*Control use of local-variables lists in files you visit.
329 The value can be t, nil or something else.
330 A value of t means local-variables lists are obeyed;
331 nil means they are ignored; anything else means query.
332
333 The command \\[normal-mode] always obeys local-variables lists
334 and ignores this variable."
335   :type '(choice (const :tag "Obey" t)
336                  (const :tag "Ignore" nil)
337                  (sexp :tag "Query" :format "%t\n" other))
338   :group 'find-file)
339
340 (defcustom enable-local-eval 'maybe
341   "*Control processing of the \"variable\" `eval' in a file's local variables.
342 The value can be t, nil or something else.
343 A value of t means obey `eval' variables;
344 nil means ignore them; anything else means query.
345
346 The command \\[normal-mode] always obeys local-variables lists
347 and ignores this variable."
348   :type '(choice (const :tag "Obey" t)
349                  (const :tag "Ignore" nil)
350                  (sexp :tag "Query" :format "%t\n" other))
351   :group 'find-file)
352
353 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
354 (or (fboundp 'lock-buffer)
355     (defalias 'lock-buffer 'ignore))
356 (or (fboundp 'unlock-buffer)
357     (defalias 'unlock-buffer 'ignore))
358 \f
359 ;;FSFmacs bastardized ange-ftp cruft
360 ;; This hook function provides support for ange-ftp host name
361 ;; completion.  It runs the usual ange-ftp hook, but only for
362 ;; completion operations.  Having this here avoids the need
363 ;; to load ange-ftp when it's not really in use.
364 ;(defun ange-ftp-completion-hook-function (op &rest args)
365 ;  (if (memq op '(file-name-completion file-name-all-completions))
366 ;      (apply 'ange-ftp-hook-function op args)
367 ;    (let ((inhibit-file-name-handlers
368 ;          (cons 'ange-ftp-completion-hook-function
369 ;                (and (eq inhibit-file-name-operation op)
370 ;                     inhibit-file-name-handlers)))
371 ;         (inhibit-file-name-operation op))
372 ;      (apply op args))
373
374 (defun convert-standard-filename (filename)
375   "Convert a standard file's name to something suitable for the current OS.
376 This function's standard definition is trivial; it just returns the argument.
377 However, on some systems, the function is redefined
378 with a definition that really does change some file names."
379   filename)
380 \f
381 (defun pwd ()
382   "Show the current default directory."
383   (interactive nil)
384   (message "Directory %s" default-directory))
385
386 (defvar cd-path nil
387   "Value of the CDPATH environment variable, as a list.
388 Not actually set up until the first time you use it.")
389
390 (defvar cdpath-previous nil
391   "Prior value of the CDPATH environment variable.")
392
393 (defun parse-colon-path (cd-path)
394   "Explode a colon-separated search path into a list of directory names.
395
396 If you think you want to use this, you probably don't.  This function
397 is provided for backward compatibility.  A more robust implementation
398 of the same functionality is available as `split-path', which see."
399   (and cd-path
400        (let (cd-list (cd-start 0) cd-colon)
401          (setq cd-path (concat cd-path path-separator))
402          (while (setq cd-colon (string-match path-separator cd-path cd-start))
403            (setq cd-list
404                  (nconc cd-list
405                         (list (if (= cd-start cd-colon)
406                                    nil
407                                 (substitute-in-file-name
408                                  (file-name-as-directory
409                                   (substring cd-path cd-start cd-colon)))))))
410            (setq cd-start (+ cd-colon 1)))
411          cd-list)))
412
413 (defun cd-absolute (dir)
414   "Change current directory to given absolute file name DIR."
415   ;; Put the name into directory syntax now,
416   ;; because otherwise expand-file-name may give some bad results.
417   (if (not (eq system-type 'vax-vms))
418       (setq dir (file-name-as-directory dir)))
419   ;; XEmacs change: stig@hackvan.com
420   (if find-file-use-truenames
421       (setq dir (file-truename dir)))
422   (setq dir (abbreviate-file-name (expand-file-name dir)))
423   (cond ((not (file-directory-p dir))
424          (error "%s is not a directory" dir))
425         ;; this breaks ange-ftp, which doesn't (can't?) overload `file-executable-p'.
426         ;;((not (file-executable-p dir))
427         ;; (error "Cannot cd to %s:  Permission denied" dir))
428         (t
429          (setq default-directory dir))))
430
431 (defun cd (dir)
432   "Make DIR become the current buffer's default directory.
433 If your environment includes a `CDPATH' variable, try each one of that
434 colon-separated list of directories when resolving a relative directory name."
435   (interactive
436    ;; XEmacs change? (read-file-name => read-directory-name)
437    (list (read-directory-name "Change default directory: "
438                               default-directory default-directory
439                               (and (member cd-path '(nil ("./")))
440                                    (null (getenv "CDPATH"))))))
441   (if (file-name-absolute-p dir)
442       (cd-absolute (expand-file-name dir))
443     ;; XEmacs
444     (unless (and cd-path (equal (getenv "CDPATH") cdpath-previous))
445       ;;#### Unix-specific
446       (let ((trypath (parse-colon-path
447                       (setq cdpath-previous (getenv "CDPATH")))))
448         (setq cd-path (or trypath (list "./")))))
449     (or (catch 'found
450           (mapcar #'(lambda (x)
451                         (let ((f (expand-file-name (concat x dir))))
452                           (if (file-directory-p f)
453                               (progn
454                                 (cd-absolute f)
455                                 (throw 'found t)))))
456                   cd-path)
457           nil)
458         ;; jwz: give a better error message to those of us with the
459         ;; good taste not to use a kludge like $CDPATH.
460         (if (equal cd-path '("./"))
461             (error "No such directory: %s" (expand-file-name dir))
462           (error "Directory not found in $CDPATH: %s" dir)))))
463
464 (defun load-file (file)
465   "Load the Lisp file named FILE."
466   (interactive "fLoad file: ")
467   (load (expand-file-name file) nil nil t))
468
469 ; We now dump utils/lib-complete.el which has improved versions of this.
470 ;(defun load-library (library)
471 ;  "Load the library named LIBRARY.
472 ;This is an interface to the function `load'."
473 ;  (interactive "sLoad library: ")
474 ;  (load library))
475 ;
476 ;(defun find-library (library)
477 ;  "Find the library of Lisp code named LIBRARY.
478 ;This searches `load-path' for a file named either \"LIBRARY\" or \"LIBRARY.el\"."
479 ;  (interactive "sFind library file: ")
480 ;  (let ((f (locate-file library load-path ":.el:")))
481 ;    (if f
482 ;        (find-file f)
483 ;        (error "Couldn't locate library %s" library))))
484
485 (defun file-local-copy (file &optional buffer)
486   "Copy the file FILE into a temporary file on this machine.
487 Returns the name of the local copy, or nil, if FILE is directly
488 accessible."
489   (let ((handler (find-file-name-handler file 'file-local-copy)))
490     (if handler
491         (funcall handler 'file-local-copy file)
492       nil)))
493
494 ;; XEmacs change block
495 ; We have this in C and use the realpath() system call.
496
497 ;(defun file-truename (filename &optional counter prev-dirs)
498 ; [... lots of code snipped ...]
499 ;    filename))
500
501 ;; XEmacs addition.  Called from `insert-file-contents-internal'
502 ;; at the appropriate time.
503 (defun compute-buffer-file-truename (&optional buffer)
504   "Recompute BUFFER's value of `buffer-file-truename'
505 based on the current value of `buffer-file-name'.
506 BUFFER defaults to the current buffer if unspecified."
507   (save-excursion
508     (set-buffer (or buffer (current-buffer)))
509     (cond ((null buffer-file-name)
510            (setq buffer-file-truename nil))
511           ((setq buffer-file-truename (file-truename buffer-file-name))
512            ;; it exists, we're done.
513            nil)
514           (t
515            ;; the file doesn't exist, but maybe the directory does.
516            (let* ((dir (file-name-directory buffer-file-name))
517                   (truedir (file-truename dir)))
518              (if truedir (setq dir truedir))
519              (setq buffer-file-truename
520                    (expand-file-name (file-name-nondirectory buffer-file-name)
521                                      dir)))))
522     (if (and find-file-use-truenames buffer-file-truename)
523         (setq buffer-file-name (abbreviate-file-name buffer-file-truename)
524               default-directory (file-name-directory buffer-file-name)))
525     buffer-file-truename))
526 ;; End XEmacs change block
527
528 (defun file-chase-links (filename)
529   "Chase links in FILENAME until a name that is not a link.
530 Does not examine containing directories for links,
531 unlike `file-truename'."
532   (let (tem (count 100) (newname filename))
533     (while (setq tem (file-symlink-p newname))
534       (save-match-data
535         (if (= count 0)
536             (error "Apparent cycle of symbolic links for %s" filename))
537         ;; In the context of a link, `//' doesn't mean what XEmacs thinks.
538         (while (string-match "//+" tem)
539           (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
540                             (substring tem (match-end 0)))))
541         ;; Handle `..' by hand, since it needs to work in the
542         ;; target of any directory symlink.
543         ;; This code is not quite complete; it does not handle
544         ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
545         (while (string-match "\\`\\.\\./" tem) ;#### Unix specific
546           (setq tem (substring tem 3))
547           (setq newname (file-name-as-directory
548                          ;; Do the .. by hand.
549                          (directory-file-name
550                           (file-name-directory
551                            ;; Chase links in the default dir of the symlink.
552                            (file-chase-links
553                             (directory-file-name
554                              (file-name-directory newname))))))))
555         (setq newname (expand-file-name tem (file-name-directory newname)))
556         (setq count (1- count))))
557     newname))
558 \f
559 (defun switch-to-other-buffer (arg)
560   "Switch to the previous buffer.  With a numeric arg, n, switch to the nth
561 most recent buffer.  With an arg of 0, buries the current buffer at the
562 bottom of the buffer stack."
563   (interactive "p")
564   (if (eq arg 0)
565       (bury-buffer (current-buffer)))
566   (switch-to-buffer
567    (if (<= arg 1) (other-buffer (current-buffer))
568      (nth (1+ arg) (buffer-list)))))
569
570 (defun switch-to-buffer-other-window (buffer)
571   "Select buffer BUFFER in another window."
572   (interactive "BSwitch to buffer in other window: ")
573   (let ((pop-up-windows t))
574     ;; XEmacs: this used to have (selected-frame) as the third argument,
575     ;; but this is obnoxious.  If the user wants the buffer in a
576     ;; different frame, then it should be this way.
577
578     ;; Change documented above undone --mrb
579     (pop-to-buffer buffer t (selected-frame))))
580
581 (defun switch-to-buffer-other-frame (buffer)
582   "Switch to buffer BUFFER in a newly-created frame."
583   (interactive "BSwitch to buffer in other frame: ")
584   (let* ((name (get-frame-name-for-buffer buffer))
585          (frame (make-frame (if name
586                                   (list (cons 'name (symbol-name name)))))))
587     (pop-to-buffer buffer t frame)
588     (make-frame-visible frame)
589     buffer))
590
591 (defun find-file (filename &optional codesys)
592   "Edit file FILENAME.
593 Switch to a buffer visiting file FILENAME,
594 creating one if none already exists.
595 Under XEmacs/Mule, optional second argument specifies the
596 coding system to use when decoding the file.  Interactively,
597 with a prefix argument, you will be prompted for the coding system."
598   (interactive "FFind file: \nZCoding system: ")
599   (if codesys
600       (let ((coding-system-for-read
601              (get-coding-system codesys)))
602         (switch-to-buffer (find-file-noselect filename)))
603     (switch-to-buffer (find-file-noselect filename))))
604
605 (defun find-file-other-window (filename &optional codesys)
606   "Edit file FILENAME, in another window.
607 May create a new window, or reuse an existing one.
608 See the function `display-buffer'.
609 Under XEmacs/Mule, optional second argument specifies the
610 coding system to use when decoding the file.  Interactively,
611 with a prefix argument, you will be prompted for the coding system."
612   (interactive "FFind file in other window: \nZCoding system: ")
613   (if codesys
614       (let ((coding-system-for-read
615              (get-coding-system codesys)))
616         (switch-to-buffer-other-window (find-file-noselect filename)))
617     (switch-to-buffer-other-window (find-file-noselect filename))))
618
619 (defun find-file-other-frame (filename &optional codesys)
620   "Edit file FILENAME, in a newly-created frame.
621 Under XEmacs/Mule, optional second argument specifies the
622 coding system to use when decoding the file.  Interactively,
623 with a prefix argument, you will be prompted for the coding system."
624   (interactive "FFind file in other frame: \nZCoding system: ")
625   (if codesys
626       (let ((coding-system-for-read
627              (get-coding-system codesys)))
628         (switch-to-buffer-other-frame (find-file-noselect filename)))
629     (switch-to-buffer-other-frame (find-file-noselect filename))))
630
631 (defun find-file-read-only (filename &optional codesys)
632   "Edit file FILENAME but don't allow changes.
633 Like \\[find-file] but marks buffer as read-only.
634 Use \\[toggle-read-only] to permit editing.
635 Under XEmacs/Mule, optional second argument specifies the
636 coding system to use when decoding the file.  Interactively,
637 with a prefix argument, you will be prompted for the coding system."
638   (interactive "fFind file read-only: \nZCoding system: ")
639   (if codesys
640       (let ((coding-system-for-read
641              (get-coding-system codesys)))
642         (find-file filename))
643     (find-file filename))
644   (setq buffer-read-only t)
645   (current-buffer))
646
647 (defun find-file-read-only-other-window (filename &optional codesys)
648   "Edit file FILENAME in another window but don't allow changes.
649 Like \\[find-file-other-window] but marks buffer as read-only.
650 Use \\[toggle-read-only] to permit editing.
651 Under XEmacs/Mule, optional second argument specifies the
652 coding system to use when decoding the file.  Interactively,
653 with a prefix argument, you will be prompted for the coding system."
654   (interactive "fFind file read-only other window: \nZCoding system: ")
655   (if codesys
656       (let ((coding-system-for-read
657              (get-coding-system codesys)))
658         (find-file-other-window filename))
659     (find-file-other-window filename))
660   (setq buffer-read-only t)
661   (current-buffer))
662
663 (defun find-file-read-only-other-frame (filename &optional codesys)
664   "Edit file FILENAME in another frame but don't allow changes.
665 Like \\[find-file-other-frame] but marks buffer as read-only.
666 Use \\[toggle-read-only] to permit editing.
667 Under XEmacs/Mule, optional second argument specifies the
668 coding system to use when decoding the file.  Interactively,
669 with a prefix argument, you will be prompted for the coding system."
670   (interactive "fFind file read-only other frame: \nZCoding system: ")
671   (if codesys
672       (let ((coding-system-for-read
673              (get-coding-system codesys)))
674         (find-file-other-frame filename))
675     (find-file-other-frame filename))
676   (setq buffer-read-only t)
677   (current-buffer))
678
679 (defun find-alternate-file-other-window (filename &optional codesys)
680   "Find file FILENAME as a replacement for the file in the next window.
681 This command does not select that window.
682 Under XEmacs/Mule, optional second argument specifies the
683 coding system to use when decoding the file.  Interactively,
684 with a prefix argument, you will be prompted for the coding system."
685   (interactive
686    (save-selected-window
687      (other-window 1)
688      (let ((file buffer-file-name)
689            (file-name nil)
690            (file-dir nil))
691        (and file
692             (setq file-name (file-name-nondirectory file)
693                   file-dir (file-name-directory file)))
694        (list (read-file-name
695               "Find alternate file: " file-dir nil nil file-name)
696              (if (and current-prefix-arg (featurep 'mule))
697                  (read-coding-system "Coding-system: "))))))
698   (if (one-window-p)
699       (find-file-other-window filename)
700     (save-selected-window
701       (other-window 1)
702       (find-alternate-file filename codesys))))
703
704 (defun find-alternate-file (filename &optional codesys)
705   "Find file FILENAME, select its buffer, kill previous buffer.
706 If the current buffer now contains an empty file that you just visited
707 \(presumably by mistake), use this command to visit the file you really want.
708 Under XEmacs/Mule, optional second argument specifies the
709 coding system to use when decoding the file.  Interactively,
710 with a prefix argument, you will be prompted for the coding system."
711   (interactive
712    (let ((file buffer-file-name)
713          (file-name nil)
714          (file-dir nil))
715      (and file
716           (setq file-name (file-name-nondirectory file)
717                 file-dir (file-name-directory file)))
718      (list (read-file-name
719             "Find alternate file: " file-dir nil nil file-name)
720            (if (and current-prefix-arg (featurep 'mule))
721                (read-coding-system "Coding-system: ")))))
722   (and (buffer-modified-p) (buffer-file-name)
723        ;; (not buffer-read-only)
724        (not (yes-or-no-p (format
725                           "Buffer %s is modified; kill anyway? "
726                           (buffer-name))))
727        (error "Aborted"))
728   (let ((obuf (current-buffer))
729         (ofile buffer-file-name)
730         (onum buffer-file-number)
731         (otrue buffer-file-truename)
732         (oname (buffer-name)))
733     (if (get-buffer " **lose**")
734         (kill-buffer " **lose**"))
735     (rename-buffer " **lose**")
736     (setq buffer-file-name nil)
737     (setq buffer-file-number nil)
738     (setq buffer-file-truename nil)
739     (unwind-protect
740         (progn
741           (unlock-buffer)
742           (if codesys
743               (let ((coding-system-for-read
744                      (get-coding-system codesys)))
745                 (find-file filename))
746             (find-file filename)))
747       (cond ((eq obuf (current-buffer))
748              (setq buffer-file-name ofile)
749              (setq buffer-file-number onum)
750              (setq buffer-file-truename otrue)
751              (lock-buffer)
752              (rename-buffer oname))))
753     (or (eq (current-buffer) obuf)
754         (kill-buffer obuf))))
755
756 (defun create-file-buffer (filename)
757   "Create a suitably named buffer for visiting FILENAME, and return it.
758 FILENAME (sans directory) is used unchanged if that name is free;
759 otherwise a string <2> or <3> or ... is appended to get an unused name."
760     (let ((handler (find-file-name-handler filename 'create-file-buffer)))
761       (if handler
762           (funcall handler 'create-file-buffer filename)
763         (let ((lastname (file-name-nondirectory filename)))
764           (if (string= lastname "")
765               (setq lastname filename))
766           (generate-new-buffer lastname)))))
767
768 (defun generate-new-buffer (name)
769   "Create and return a buffer with a name based on NAME.
770 Choose the buffer's name using `generate-new-buffer-name'."
771   (get-buffer-create (generate-new-buffer-name name)))
772
773 (defvar abbreviated-home-dir nil
774   "The user's homedir abbreviated according to `directory-abbrev-alist'.")
775
776 (defun abbreviate-file-name (filename &optional hack-homedir)
777   "Return a version of FILENAME shortened using `directory-abbrev-alist'.
778 See documentation of variable `directory-abbrev-alist' for more information.
779 If optional argument HACK-HOMEDIR is non-nil, then this also substitutes
780 \"~\" for the user's home directory."
781   (let ((handler (find-file-name-handler filename 'abbreviate-file-name)))
782     (if handler
783         (funcall handler 'abbreviate-file-name filename hack-homedir)
784       ;; Get rid of the prefixes added by the automounter.
785       ;;(if (and (string-match automount-dir-prefix filename)
786       ;;         (file-exists-p (file-name-directory
787       ;;                         (substring filename (1- (match-end 0))))))
788       ;;    (setq filename (substring filename (1- (match-end 0)))))
789       (let ((tail directory-abbrev-alist))
790         ;; If any elt of directory-abbrev-alist matches this name,
791         ;; abbreviate accordingly.
792         (while tail
793           (if (string-match (car (car tail)) filename)
794               (setq filename
795                     (concat (cdr (car tail)) (substring filename (match-end 0)))))
796           (setq tail (cdr tail))))
797       (if hack-homedir
798           (progn
799             ;; Compute and save the abbreviated homedir name.
800             ;; We defer computing this until the first time it's needed, to
801             ;; give time for directory-abbrev-alist to be set properly.
802             ;; We include a slash at the end, to avoid spurious matches
803             ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
804             (or abbreviated-home-dir
805                 (setq abbreviated-home-dir
806                       (let ((abbreviated-home-dir "$foo"))
807                         (concat "\\`" (regexp-quote (abbreviate-file-name
808                                                      (expand-file-name "~")))
809                                 "\\(/\\|\\'\\)"))))
810             ;; If FILENAME starts with the abbreviated homedir,
811             ;; make it start with `~' instead.
812             (if (and (string-match abbreviated-home-dir filename)
813                      ;; If the home dir is just /, don't change it.
814                      (not (and (= (match-end 0) 1) ;#### unix-specific
815                                (= (aref filename 0) ?/)))
816                      (not (and (or (eq system-type 'ms-dos)
817                                    (eq system-type 'windows-nt))
818                                (save-match-data
819                                  (string-match "^[a-zA-Z]:/$" filename)))))
820                 (setq filename
821                       (concat "~"
822                               (substring filename
823                                          (match-beginning 1) (match-end 1))
824                               (substring filename (match-end 0)))))))
825       filename)))
826
827 (defcustom find-file-not-true-dirname-list nil
828   "*List of logical names for which visiting shouldn't save the true dirname.
829 On VMS, when you visit a file using a logical name that searches a path,
830 you may or may not want the visited file name to record the specific
831 directory where the file was found.  If you *do not* want that, add the logical
832 name to this list as a string."
833   :type '(repeat (string :tag "Name"))
834   :group 'find-file)
835
836 ;; This function is needed by FSF vc.el.  I hope somebody can make it
837 ;; work for XEmacs.  -sb.
838 ;; #### In what way does it not work?  --hniksic
839 (defun find-buffer-visiting (filename)
840   "Return the buffer visiting file FILENAME (a string).
841 This is like `get-file-buffer', except that it checks for any buffer
842 visiting the same file, possibly under a different name.
843 If there is no such live buffer, return nil."
844   (let ((buf (get-file-buffer filename))
845         (truename (abbreviate-file-name (file-truename filename))))
846     (or buf
847         (let ((list (buffer-list)) found)
848           (while (and (not found) list)
849             (save-excursion
850               (set-buffer (car list))
851               (if (and buffer-file-name
852                        (string= buffer-file-truename truename))
853                   (setq found (car list))))
854             (setq list (cdr list)))
855           found)
856         (let ((number (nthcdr 10 (file-attributes truename)))
857               (list (buffer-list)) found)
858           (and buffer-file-numbers-unique
859                number
860                (while (and (not found) list)
861                  (save-excursion
862                    (set-buffer (car list))
863                    (if (and buffer-file-number
864                            (equal buffer-file-number number)
865                             ;; Verify this buffer's file number
866                             ;; still belongs to its file.
867                             (file-exists-p buffer-file-name)
868                             (equal (nthcdr 10 (file-attributes buffer-file-name))
869                                    number))
870                        (setq found (car list))))
871                  (setq list (cdr list))))
872           found))))
873
874 (defun insert-file-contents-literally (filename &optional visit beg end replace)
875   "Like `insert-file-contents', q.v., but only reads in the file.
876 A buffer may be modified in several ways after reading into the buffer due
877 to advanced Emacs features, such as file-name-handlers, format decoding,
878 find-file-hooks, etc.
879   This function ensures that none of these modifications will take place."
880   (let ((file-name-handler-alist nil)
881         (format-alist nil)
882         (after-insert-file-functions nil)
883         (find-buffer-file-type-function
884          (if (fboundp 'find-buffer-file-type)
885              (symbol-function 'find-buffer-file-type)
886            nil)))
887     (unwind-protect
888         (progn
889           (fset 'find-buffer-file-type (lambda (filename) t))
890           (insert-file-contents filename visit beg end replace))
891       (if find-buffer-file-type-function
892           (fset 'find-buffer-file-type find-buffer-file-type-function)
893         (fmakunbound 'find-buffer-file-type)))))
894
895 (defun find-file-noselect (filename &optional nowarn rawfile)
896   "Read file FILENAME into a buffer and return the buffer.
897 If a buffer exists visiting FILENAME, return that one, but
898 verify that the file has not changed since visited or saved.
899 The buffer is not selected, just returned to the caller.
900 If NOWARN is non-nil, warning messages will be suppressed.
901 If RAWFILE is non-nil, the file is read literally."
902   (setq filename (abbreviate-file-name (expand-file-name filename)))
903   (if (file-directory-p filename)
904       (if (and (fboundp 'dired-noselect) find-file-run-dired)
905           (dired-noselect (if find-file-use-truenames
906                               (abbreviate-file-name (file-truename filename))
907                             filename))
908         (error "%s is a directory" filename))
909     (let* ((buf (get-file-buffer filename))
910            (truename (abbreviate-file-name (file-truename filename)))
911            (number (nthcdr 10 (file-attributes truename)))
912 ;          ;; Find any buffer for a file which has same truename.
913 ;          (other (and (not buf) (find-buffer-visiting filename)))
914            (error nil))
915
916 ;     ;; Let user know if there is a buffer with the same truename.
917 ;      (if (and (not buf) same-truename (not nowarn))
918 ;         (message "%s and %s are the same file (%s)"
919 ;                  filename (buffer-file-name same-truename)
920 ;                  truename)
921 ;       (if (and (not buf) same-number (not nowarn))
922 ;         (message "%s and %s are the same file"
923 ;                  filename (buffer-file-name same-number))))
924 ;      ;; Optionally also find that buffer.
925 ;      (if (or find-file-existing-other-name find-file-visit-truename)
926 ;         (setq buf (or same-truename same-number)))
927
928       (when (and buf
929                  (or find-file-compare-truenames find-file-use-truenames)
930                  (not nowarn))
931         (save-excursion
932           (set-buffer buf)
933           (if (not (string-equal buffer-file-name filename))
934               (message "%s and %s are the same file (%s)"
935                        filename buffer-file-name
936                        buffer-file-truename))))
937
938       (if buf
939           (or nowarn
940               (verify-visited-file-modtime buf)
941               (cond ((not (file-exists-p filename))
942                      (error "File %s no longer exists!" filename))
943                     ;; Certain files should be reverted automatically
944                     ;; if they have changed on disk and not in the buffer.
945                     ((and (not (buffer-modified-p buf))
946                           (dolist (rx revert-without-query nil)
947                             (when (string-match rx filename)
948                               (return t))))
949                      (with-current-buffer buf
950                        (message "Reverting file %s..." filename)
951                        (revert-buffer t t)
952                        (message "Reverting file %s... done" filename)))
953                     ((yes-or-no-p
954                       (if (string= (file-name-nondirectory filename)
955                                    (buffer-name buf))
956                           (format
957                            (if (buffer-modified-p buf)
958         (gettext "File %s changed on disk.  Discard your edits? ")
959         (gettext "File %s changed on disk.  Reread from disk? "))
960                            (file-name-nondirectory filename))
961                         (format
962                          (if (buffer-modified-p buf)
963       (gettext "File %s changed on disk.  Discard your edits in %s? ")
964       (gettext "File %s changed on disk.  Reread from disk into %s? "))
965                          (file-name-nondirectory filename)
966                          (buffer-name buf))))
967                      (with-current-buffer buf
968                        (revert-buffer t t)))))
969         ;; Else: we must create a new buffer for filename
970         (save-excursion
971 ;;; The truename stuff makes this obsolete.
972 ;;;       (let* ((link-name (car (file-attributes filename)))
973 ;;;              (linked-buf (and (stringp link-name)
974 ;;;                               (get-file-buffer link-name))))
975 ;;;         (if (bufferp linked-buf)
976 ;;;             (message "Symbolic link to file in buffer %s"
977 ;;;                      (buffer-name linked-buf))))
978           (setq buf (create-file-buffer filename))
979           ;; Catch various signals, such as QUIT, and kill the buffer
980           ;; in that case.
981           (condition-case data
982               (progn
983                 (set-buffer-major-mode buf)
984                 (set-buffer buf)
985                 (erase-buffer)
986                 (condition-case ()
987                     (if rawfile
988                         (insert-file-contents-literally filename t)
989                       (insert-file-contents filename t))
990                   (file-error
991                    (when (and (file-exists-p filename)
992                               (not (file-readable-p filename)))
993                      (signal 'file-error (list "File is not readable" filename)))
994                    (if rawfile
995                        ;; Unconditionally set error
996                        (setq error t)
997                      (or
998                       ;; Run find-file-not-found-hooks until one returns non-nil.
999                       (run-hook-with-args-until-success 'find-file-not-found-hooks)
1000                       ;; If they fail too, set error.
1001                       (setq error t)))))
1002                 ;; Find the file's truename, and maybe use that as visited name.
1003                 ;; automatically computed in XEmacs, unless jka-compr was used!
1004                 (unless buffer-file-truename
1005                   (setq buffer-file-truename truename))
1006                 (setq buffer-file-number number)
1007                 ;; On VMS, we may want to remember which directory in
1008                 ;; a search list the file was found in.
1009                 (and (eq system-type 'vax-vms)
1010                      (let (logical)
1011                        (if (string-match ":" (file-name-directory filename))
1012                            (setq logical (substring (file-name-directory filename)
1013                                                     0 (match-beginning 0))))
1014                        (not (member logical find-file-not-true-dirname-list)))
1015                      (setq buffer-file-name buffer-file-truename))
1016                 (and find-file-use-truenames
1017                      ;; This should be in C.  Put pathname
1018                      ;; abbreviations that have been explicitly
1019                      ;; requested back into the pathname.  Most
1020                      ;; importantly, strip out automounter /tmp_mnt
1021                      ;; directories so that auto-save will work
1022                      (setq buffer-file-name (abbreviate-file-name buffer-file-name)))
1023                 ;; Set buffer's default directory to that of the file.
1024                 (setq default-directory (file-name-directory buffer-file-name))
1025                 ;; Turn off backup files for certain file names.  Since
1026                 ;; this is a permanent local, the major mode won't eliminate it.
1027                 (and (not (funcall backup-enable-predicate buffer-file-name))
1028                      (progn
1029                        (make-local-variable 'backup-inhibited)
1030                        (setq backup-inhibited t)))
1031                 (if rawfile
1032                     ;; #### FSF 20.3 sets buffer-file-coding-system to
1033                     ;; `no-conversion' here.  Should we copy?  It also
1034                     ;; makes `find-file-literally' a local variable
1035                     ;; and sets it to t.
1036                     nil
1037                   (after-find-file error (not nowarn))
1038                   (setq buf (current-buffer))))
1039             (t
1040              (kill-buffer buf)
1041              (signal (car data) (cdr data))))))
1042       buf)))
1043 \f
1044 ;; FSF has `insert-file-literally' and `find-file-literally' here.
1045
1046 (defvar after-find-file-from-revert-buffer nil)
1047
1048 (defun after-find-file (&optional error warn noauto
1049                                   after-find-file-from-revert-buffer
1050                                   nomodes)
1051   "Called after finding a file and by the default revert function.
1052 Sets buffer mode, parses local variables.
1053 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1054 error in reading the file.  WARN non-nil means warn if there
1055 exists an auto-save file more recent than the visited file.
1056 NOAUTO means don't mess with auto-save mode.
1057 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1058  means this call was from `revert-buffer'.
1059 Fifth arg NOMODES non-nil means don't alter the file's modes.
1060 Finishes by calling the functions in `find-file-hooks'."
1061   (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1062   (if noninteractive
1063       nil
1064     (let* (not-serious
1065            (msg
1066             (cond ((and error (file-attributes buffer-file-name))
1067                    (setq buffer-read-only t)
1068                    (gettext "File exists, but cannot be read."))
1069                   ((not buffer-read-only)
1070                    (if (and warn
1071                             (file-newer-than-file-p (make-auto-save-file-name)
1072                                                     buffer-file-name))
1073                        (format "%s has auto save data; consider M-x recover-file"
1074                                (file-name-nondirectory buffer-file-name))
1075                      (setq not-serious t)
1076                      (if error (gettext "(New file)") nil)))
1077                   ((not error)
1078                    (setq not-serious t)
1079                    (gettext "Note: file is write protected"))
1080                   ((file-attributes (directory-file-name default-directory))
1081                    (gettext "File not found and directory write-protected"))
1082                   ((file-exists-p (file-name-directory buffer-file-name))
1083                    (setq buffer-read-only nil))
1084                   (t
1085                    ;; If the directory the buffer is in doesn't exist,
1086                    ;; offer to create it.  It's better to do this now
1087                    ;; than when we save the buffer, because we want
1088                    ;; autosaving to work.
1089                    (setq buffer-read-only nil)
1090                    ;; XEmacs
1091                    (or (file-exists-p (file-name-directory buffer-file-name))
1092                        (condition-case nil
1093                            (if (yes-or-no-p
1094                                 (format
1095                                  "\
1096 The directory containing %s does not exist.  Create? "
1097                                  (abbreviate-file-name buffer-file-name)))
1098                                (make-directory (file-name-directory
1099                                                 buffer-file-name)
1100                                                t))
1101                          (quit
1102                           (kill-buffer (current-buffer))
1103                           (signal 'quit nil))))
1104                    nil))))
1105       (if msg
1106           (progn
1107             (message "%s" msg)
1108             (or not-serious (sit-for 1 t)))))
1109     (if (and auto-save-default (not noauto))
1110         (auto-save-mode t)))
1111   (unless nomodes
1112     (normal-mode t)
1113     (run-hooks 'find-file-hooks)))
1114
1115 (defun normal-mode (&optional find-file)
1116   "Choose the major mode for this buffer automatically.
1117 Also sets up any specified local variables of the file.
1118 Uses the visited file name, the -*- line, and the local variables spec.
1119
1120 This function is called automatically from `find-file'.  In that case,
1121 we may set up specified local variables depending on the value of
1122 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1123 otherwise, we query.  `enable-local-variables' is ignored if you
1124 run `normal-mode' explicitly."
1125   (interactive)
1126   (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1127   (and (condition-case err
1128            (progn (set-auto-mode)
1129                   t)
1130          (error (message "File mode specification error: %s"
1131                          (prin1-to-string err))
1132                 nil))
1133        (condition-case err
1134            (hack-local-variables (not find-file))
1135          (error (lwarn 'local-variables 'warning
1136                   "File local-variables error: %s"
1137                   (error-message-string err))))))
1138
1139 ;; #### This variable sucks in the package model.  There should be a
1140 ;; way for new packages to add their entries to auto-mode-alist in a
1141 ;; clean way.  Per Abrahamsen suggested splitting auto-mode-alist to
1142 ;; several distinct variables such as, in order of precedence,
1143 ;; `user-auto-mode-alist' for users, `package-auto-mode-alist' for
1144 ;; packages and `auto-mode-alist' (which might also be called
1145 ;; `default-auto-mode-alist') for default stuff, such as some of the
1146 ;; entries below.
1147
1148 (defvar auto-mode-alist
1149   '(("\\.te?xt\\'" . text-mode)
1150     ("\\.[ch]\\'" . c-mode)
1151     ("\\.el\\'" . emacs-lisp-mode)
1152     ("\\.\\([CH]\\|cc\\|hh\\)\\'" . c++-mode)
1153     ("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode)
1154     ("\\.java\\'" . java-mode)
1155     ("\\.idl\\'" . idl-mode)
1156     ("\\.f\\(or\\)?\\'" . fortran-mode)
1157     ("\\.F\\(OR\\)?\\'" . fortran-mode)
1158     ("\\.[fF]90\\'" . f90-mode)
1159 ;;; Less common extensions come here
1160 ;;; so more common ones above are found faster.
1161     ("\\.\\([pP][Llm]\\|al\\)\\'" . perl-mode)
1162     ("\\.py\\'" . python-mode)
1163     ("\\.texi\\(nfo\\)?\\'" . texinfo-mode)
1164     ("\\.ad[abs]\\'" . ada-mode)
1165     ("\\.c?l\\(i?sp\\)?\\'" . lisp-mode)
1166     ("\\.p\\(as\\)?\\'" . pascal-mode)
1167     ("\\.ltx\\'" . latex-mode)
1168     ("\\.[sS]\\'" . asm-mode)
1169     ("[Cc]hange.?[Ll]og?\\(.[0-9]+\\)?\\'" . change-log-mode)
1170     ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1171     ("\\.scm?\\(?:\\.[0-9]*\\)?\\'" . scheme-mode)
1172     ("\\.e\\'" . eiffel-mode)
1173     ("\\.mss\\'" . scribe-mode)
1174     ("\\.m\\([mes]\\|an\\)\\'" . nroff-mode)
1175     ("\\.icn\\'" . icon-mode)
1176     ("\\.\\([ckz]?sh\\|shar\\)\\'" . sh-mode)
1177     ;; #### Unix-specific!
1178     ("/\\.\\(bash_\\|z\\)?\\(profile\\|login\||logout\\)\\'" . sh-mode)
1179     ("/\\.\\([ckz]sh\\|bash\\|tcsh\\|es\\|xinit\\|startx\\)rc\\'" . sh-mode)
1180     ("/\\.\\([kz]shenv\\|xsession\\)\\'" . sh-mode)
1181     ;; The following come after the ChangeLog pattern for the sake of
1182     ;; ChangeLog.1, etc. and after the .scm.[0-9] pattern too.
1183     ("\\.[12345678]\\'" . nroff-mode)
1184     ("\\.[tT]e[xX]\\'" . tex-mode)
1185     ("\\.\\(sty\\|cls\\|bbl\\)\\'" . latex-mode)
1186     ("\\.bib\\'" . bibtex-mode)
1187     ("\\.article\\'" . text-mode)
1188     ("\\.letter\\'" . text-mode)
1189     ("\\.\\(tcl\\|exp\\)\\'" . tcl-mode)
1190     ("\\.wrl\\'" . vrml-mode)
1191     ("\\.awk\\'" . awk-mode)
1192     ("\\.prolog\\'" . prolog-mode)
1193     ("\\.tar\\'" . tar-mode)
1194     ("\\.\\(arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
1195     ;; Mailer puts message to be edited in /tmp/Re.... or Message
1196     ;; #### Unix-specific!
1197     ("\\`/tmp/Re" . text-mode)
1198     ("/Message[0-9]*\\'" . text-mode)
1199     ("/drafts/[0-9]+\\'" . mh-letter-mode)
1200     ;; some news reader is reported to use this
1201     ("^/tmp/fol/" . text-mode)
1202     ("\\.y\\'" . c-mode)
1203     ("\\.lex\\'" . c-mode)
1204     ("\\.m\\'" . objc-mode)
1205     ("\\.oak\\'" . scheme-mode)
1206     ("\\.s?html?\\'" . html-mode)
1207     ("\\.htm?l?3\\'" . html3-mode)
1208     ("\\.\\(sgml?\\|dtd\\)\\'" . sgml-mode)
1209     ("\\.c?ps\\'" . postscript-mode)
1210     ;; .emacs following a directory delimiter in either Unix or
1211     ;; Windows syntax.
1212     ("[/\\][._].*emacs\\'" . emacs-lisp-mode)
1213     ("\\.m4\\'" . autoconf-mode)
1214     ("configure\\.in\\'" . autoconf-mode)
1215     ("\\.ml\\'" . lisp-mode)
1216     ("\\.ma?k\\'" . makefile-mode)
1217     ("[Mm]akefile\\(\\.\\|\\'\\)" . makefile-mode)
1218     ("\\.X\\(defaults\\|environment\\|resources\\|modmap\\)\\'" . xrdb-mode)
1219     ;; #### The following three are Unix-specific (but do we care?)
1220     ("/app-defaults/" . xrdb-mode)
1221     ("\\.[^/]*wm\\'" . winmgr-mode)
1222     ("\\.[^/]*wm2?rc" . winmgr-mode)
1223     ("\\.[Jj][Pp][Ee]?[Gg]\\'" . image-mode)
1224     ("\\.[Pp][Nn][Gg]\\'" . image-mode)
1225     ("\\.[Gg][Ii][Ff]\\'" . image-mode)
1226     )
1227 "Alist of filename patterns vs. corresponding major mode functions.
1228 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1229 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1230 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1231 mode function to use.  FUNCTION will be called, unless it is nil.
1232
1233 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1234 calling FUNCTION (if it's not nil), we delete the suffix that matched
1235 REGEXP and search the list again for another match.")
1236
1237 (defvar interpreter-mode-alist
1238   '(("^#!.*csh"   . sh-mode)
1239     ("^#!.*\\b\\(scope\\|wish\\|tcl\\|tclsh\\|expect\\)" . tcl-mode)
1240     ("^#!.*sh\\b" . sh-mode)
1241     ("perl"   . perl-mode)
1242     ("python" . python-mode)
1243     ("awk\\b" . awk-mode)
1244     ("rexx"   . rexx-mode)
1245     ("scm"    . scheme-mode)
1246     ("^:"     . sh-mode))
1247   "Alist mapping interpreter names to major modes.
1248 This alist is used to guess the major mode of a file based on the
1249 contents of the first line.  This line often contains something like:
1250 #!/bin/sh
1251 but may contain something more imaginative like
1252 #! /bin/env python
1253 or
1254 eval 'exec perl -w -S $0 ${1+\"$@\"}'.
1255
1256 Each alist element looks like (INTERPRETER . MODE).
1257 The car of each element is a regular expression which is compared
1258 with the name of the interpreter specified in the first line.
1259 If it matches, mode MODE is selected.")
1260
1261 (defvar inhibit-first-line-modes-regexps (purecopy '("\\.tar\\'" "\\.tgz\\'"
1262                                                      "\\.tar\\.gz\\'"))
1263   "List of regexps; if one matches a file name, don't look for `-*-'.")
1264
1265 (defvar inhibit-first-line-modes-suffixes nil
1266   "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1267 When checking `inhibit-first-line-modes-regexps', we first discard
1268 from the end of the file name anything that matches one of these regexps.")
1269
1270 (defvar user-init-file
1271   "" ; set by command-line
1272   "File name including directory of user's initialization file.")
1273
1274 (defun set-auto-mode (&optional just-from-file-name)
1275   "Select major mode appropriate for current buffer.
1276 This checks for a -*- mode tag in the buffer's text,
1277 compares the filename against the entries in `auto-mode-alist',
1278 or checks the interpreter that runs this file against
1279 `interpreter-mode-alist'.
1280
1281 It does not check for the `mode:' local variable in the
1282 Local Variables section of the file; for that, use `hack-local-variables'.
1283
1284 If `enable-local-variables' is nil, this function does not check for a
1285 -*- mode tag.
1286
1287 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1288 then we do not set anything but the major mode,
1289 and we don't even do that unless it would come from the file name."
1290   (save-excursion
1291     ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1292     ;; Do this by calling the hack-local-variables helper to avoid redundancy.
1293     ;; We bind enable-local-variables to nil this time because we're going to
1294     ;; call hack-local-variables-prop-line again later, "for real."  Note that
1295     ;; this temporary binding does not prevent hack-local-variables-prop-line
1296     ;; from setting the major mode.
1297     (or (and enable-local-variables
1298              (let ((enable-local-variables nil))
1299                (hack-local-variables-prop-line nil))
1300              )
1301         ;; It's not in the -*- line, so check the auto-mode-alist, unless
1302         ;; this buffer isn't associated with a file.
1303         (null buffer-file-name)
1304         (let ((name (file-name-sans-versions buffer-file-name))
1305               (keep-going t))
1306           (while keep-going
1307             (setq keep-going nil)
1308             (let ((alist auto-mode-alist)
1309                   (mode nil))
1310               ;; Find first matching alist entry.
1311               (let ((case-fold-search
1312                      (memq system-type '(vax-vms windows-nt))))
1313                 (while (and (not mode) alist)
1314                   (if (string-match (car (car alist)) name)
1315                       (if (and (consp (cdr (car alist)))
1316                                (nth 2 (car alist)))
1317                           (progn
1318                             (setq mode (car (cdr (car alist)))
1319                                   name (substring name 0 (match-beginning 0))
1320                                   keep-going t))
1321                         (setq mode (cdr (car alist))
1322                               keep-going nil)))
1323                   (setq alist (cdr alist))))
1324               (unless just-from-file-name
1325                 ;; If we can't deduce a mode from the file name,
1326                 ;; look for an interpreter specified in the first line.
1327                 (if (and (null mode)
1328                          (save-excursion ; XEmacs
1329                            (goto-char (point-min))
1330                            (looking-at "#!")))
1331                     (let ((firstline
1332                            (buffer-substring
1333                             (point-min)
1334                             (save-excursion
1335                               (goto-char (point-min)) (end-of-line) (point)))))
1336                       (setq alist interpreter-mode-alist)
1337                       (while alist
1338                         (if (string-match (car (car alist)) firstline)
1339                             (progn
1340                               (setq mode (cdr (car alist)))
1341                               (setq alist nil))
1342                           (setq alist (cdr alist)))))))
1343               (if mode
1344                   (if (not (fboundp mode))
1345                       (let ((name (package-get-package-provider mode)))
1346                         (if name
1347                             (message "Mode %s is not installed.  Download package %s" mode name)
1348                           (message "Mode %s either doesn't exist or is not a known package" mode))
1349                         (sit-for 2)
1350                         (error "%s" mode))
1351                     (unless (and just-from-file-name
1352                                  (or
1353                                   ;; Don't reinvoke major mode.
1354                                   (eq mode major-mode)
1355                                   ;; Don't lose on minor modes.
1356                                   (assq mode minor-mode-alist)))
1357                       (funcall mode))))))))))
1358
1359 (defvar hack-local-variables-hook nil
1360   "Normal hook run after processing a file's local variables specs.
1361 Major modes can use this to examine user-specified local variables
1362 in order to initialize other data structure based on them.
1363
1364 This hook runs even if there were no local variables or if their
1365 evaluation was suppressed.  See also `enable-local-variables' and
1366 `enable-local-eval'.")
1367
1368 (defun hack-local-variables (&optional force)
1369   "Parse, and bind or evaluate as appropriate, any local variables
1370 for current buffer."
1371   ;; Don't look for -*- if this file name matches any
1372   ;; of the regexps in inhibit-first-line-modes-regexps.
1373   (if (or (null buffer-file-name) ; don't lose if buffer has no file!
1374           (not (let ((temp inhibit-first-line-modes-regexps)
1375                      (name (if buffer-file-name
1376                                (file-name-sans-versions buffer-file-name)
1377                              (buffer-name))))
1378                  (while (let ((sufs inhibit-first-line-modes-suffixes))
1379                           (while (and sufs (not
1380                                             (string-match (car sufs) name)))
1381                             (setq sufs (cdr sufs)))
1382                           sufs)
1383                    (setq name (substring name 0 (match-beginning 0))))
1384                  (while (and temp
1385                              (not (string-match (car temp) name)))
1386                    (setq temp (cdr temp))
1387                    temp))))
1388       (progn
1389         ;; Look for variables in the -*- line.
1390         (hack-local-variables-prop-line force)
1391         ;; Look for "Local variables:" block in last page.
1392         (hack-local-variables-last-page force)))
1393   (run-hooks 'hack-local-variables-hook))
1394
1395 ;;; Local variables may be specified in the last page of the file (within 3k
1396 ;;; from the end of the file and after the last ^L) in the form
1397 ;;;
1398 ;;;   Local variables:
1399 ;;;   variable-name: variable-value
1400 ;;;   end:
1401 ;;;
1402 ;;; The lines may begin with a common prefix, like ";;;   " in the above
1403 ;;; example.  They may also have a common suffix (" */" for example).  In
1404 ;;; this form, the local variable "mode" can be used to change the major
1405 ;;; mode, and the local variable "eval" can be used to evaluate an arbitrary
1406 ;;; form.
1407 ;;;
1408 ;;; Local variables may also be specified in the first line of the file.
1409 ;;; Embedded in this line are a pair of "-*-" sequences.  What lies between
1410 ;;; them are variable-name/variable-value pairs, like:
1411 ;;;
1412 ;;;      -*- mode: emacs-lisp -*-
1413 ;;; or   -*- mode: postscript; version-control: never -*-
1414 ;;; or   -*- tags-file-name: "/foo/bar/TAGS" -*-
1415 ;;;
1416 ;;; The local variable "eval" is not used with this form. For hysterical
1417 ;;; reasons, the syntax "-*- modename -*-" is allowed as well.
1418 ;;;
1419
1420 (defun hack-local-variables-p (modeline)
1421   (or (eq enable-local-variables t)
1422       (and enable-local-variables
1423            (save-window-excursion
1424              (condition-case nil
1425                  (switch-to-buffer (current-buffer))
1426                (error
1427                 ;; If we fail to switch in the selected window,
1428                 ;; it is probably a minibuffer.
1429                 ;; So try another window.
1430                 (condition-case nil
1431                     (switch-to-buffer-other-window (current-buffer))
1432                   (error
1433                    (switch-to-buffer-other-frame (current-buffer))))))
1434              (or modeline (save-excursion
1435                              (beginning-of-line)
1436                              (set-window-start (selected-window) (point))))
1437              (y-or-n-p (format
1438                         "Set local variables as specified %s of %s? "
1439                         (if modeline "in -*- line" "at end")
1440                         (if buffer-file-name
1441                             (file-name-nondirectory buffer-file-name)
1442                             (concat "buffer " (buffer-name)))))))))
1443
1444 (defun hack-local-variables-last-page (&optional force)
1445   ;; Set local variables set in the "Local Variables:" block of the last page.
1446   (save-excursion
1447     (goto-char (point-max))
1448     (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1449     (if (let ((case-fold-search t))
1450           (and (search-forward "Local Variables:" nil t)
1451                (or force
1452                    (hack-local-variables-p nil))))
1453         (let ((continue t)
1454               prefix prefixlen suffix beg
1455               (enable-local-eval enable-local-eval))
1456           ;; The prefix is what comes before "local variables:" in its line.
1457           ;; The suffix is what comes after "local variables:" in its line.
1458           (skip-chars-forward " \t")
1459           (or (eolp)
1460               (setq suffix (buffer-substring (point)
1461                                              (progn (end-of-line) (point)))))
1462           (goto-char (match-beginning 0))
1463           (or (bolp)
1464               (setq prefix
1465                     (buffer-substring (point)
1466                                       (progn (beginning-of-line) (point)))))
1467           (if prefix (setq prefixlen (length prefix)
1468                            prefix (regexp-quote prefix)))
1469           (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1470           (while continue
1471             ;; Look at next local variable spec.
1472             (if selective-display (re-search-forward "[\n\C-m]")
1473               (forward-line 1))
1474             ;; Skip the prefix, if any.
1475             (if prefix
1476                 (if (looking-at prefix)
1477                     (forward-char prefixlen)
1478                   (error "Local variables entry is missing the prefix")))
1479             ;; Find the variable name; strip whitespace.
1480             (skip-chars-forward " \t")
1481             (setq beg (point))
1482             (skip-chars-forward "^:\n")
1483             (if (eolp) (error "Missing colon in local variables entry"))
1484             (skip-chars-backward " \t")
1485             (let* ((str (buffer-substring beg (point)))
1486                    (var (read str))
1487                   val)
1488               ;; Setting variable named "end" means end of list.
1489               (if (string-equal (downcase str) "end")
1490                   (setq continue nil)
1491                 ;; Otherwise read the variable value.
1492                 (skip-chars-forward "^:")
1493                 (forward-char 1)
1494                 (setq val (read (current-buffer)))
1495                 (skip-chars-backward "\n")
1496                 (skip-chars-forward " \t")
1497                 (or (if suffix (looking-at suffix) (eolp))
1498                     (error "Local variables entry is terminated incorrectly"))
1499                 ;; Set the variable.  "Variables" mode and eval are funny.
1500                 (hack-one-local-variable var val))))))))
1501
1502 ;; jwz - New Version 20.1/19.15
1503 (defun hack-local-variables-prop-line (&optional force)
1504   ;; Set local variables specified in the -*- line.
1505   ;; Returns t if mode was set.
1506   (let ((result nil))
1507     (save-excursion
1508       (goto-char (point-min))
1509       (skip-chars-forward " \t\n\r")
1510       (let ((end (save-excursion
1511                    ;; If the file begins with "#!"
1512                    ;; (un*x exec interpreter magic), look
1513                    ;; for mode frobs in the first two
1514                    ;; lines.  You cannot necessarily
1515                    ;; put them in the first line of
1516                    ;; such a file without screwing up
1517                    ;; the interpreter invocation.
1518                    (end-of-line (and (looking-at "^#!") 2))
1519                    (point))))
1520         ;; Parse the -*- line into the `result' alist.
1521         (cond ((not (search-forward "-*-" end t))
1522                ;; doesn't have one.
1523                (setq force t))
1524               ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1525                ;; Antiquated form: "-*- ModeName -*-".
1526                (setq result
1527                      (list (cons 'mode
1528                                  (intern (buffer-substring
1529                                           (match-beginning 1)
1530                                           (match-end 1)))))
1531                      ))
1532               (t
1533                ;; Usual form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1534                ;; (last ";" is optional).
1535                (save-excursion
1536                  (if (search-forward "-*-" end t)
1537                      (setq end (- (point) 3))
1538                    (error "-*- not terminated before end of line")))
1539                (while (< (point) end)
1540                  (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1541                      (error "malformed -*- line"))
1542                  (goto-char (match-end 0))
1543                  ;; There used to be a downcase here,
1544                  ;; but the manual didn't say so,
1545                  ;; and people want to set var names that aren't all lc.
1546                  (let ((key (intern (buffer-substring
1547                                      (match-beginning 1)
1548                                      (match-end 1))))
1549                        (val (save-restriction
1550                               (narrow-to-region (point) end)
1551                               (read (current-buffer)))))
1552                    ;; Case sensitivity!  Icepicks in my forehead!
1553                    (if (equal (downcase (symbol-name key)) "mode")
1554                        (setq key 'mode))
1555                    (setq result (cons (cons key val) result))
1556                    (skip-chars-forward " \t;")))
1557                (setq result (nreverse result))))))
1558
1559     (let ((set-any-p (or force
1560                          ;; It's OK to force null specifications.
1561                          (null result)
1562                          ;; It's OK to force mode-only specifications.
1563                          (let ((remaining result)
1564                                (mode-specs-only t))
1565                            (while remaining
1566                              (if (eq (car (car remaining)) 'mode)
1567                                  (setq remaining (cdr remaining))
1568                                ;; Otherwise, we have a real local.
1569                                (setq mode-specs-only nil
1570                                      remaining nil))
1571                              )
1572                            mode-specs-only)
1573                          ;; Otherwise, check.
1574                          (hack-local-variables-p t)))
1575           (mode-p nil))
1576       (while result
1577         (let ((key (car (car result)))
1578               (val (cdr (car result))))
1579           (cond ((eq key 'mode)
1580                  (setq mode-p t)
1581                  (let ((mode (intern (concat (downcase (symbol-name val))
1582                                              "-mode"))))
1583                    ;; Without this guard, `normal-mode' would potentially run
1584                    ;; the major mode function twice: once via `set-auto-mode'
1585                    ;; and once via `hack-local-variables'.
1586                    (if (not (eq mode major-mode))
1587                        (funcall mode))
1588                    ))
1589                 (set-any-p
1590                  (hack-one-local-variable key val))
1591                 (t
1592                  nil)))
1593         (setq result (cdr result)))
1594       mode-p)))
1595
1596 (defconst ignored-local-variables
1597   (list 'enable-local-eval)
1598   "Variables to be ignored in a file's local variable spec.")
1599
1600 ;; Get confirmation before setting these variables as locals in a file.
1601 (put 'debugger 'risky-local-variable t)
1602 (put 'enable-local-eval 'risky-local-variable t)
1603 (put 'ignored-local-variables 'risky-local-variable t)
1604 (put 'eval 'risky-local-variable t)
1605 (put 'file-name-handler-alist 'risky-local-variable t)
1606 (put 'minor-mode-map-alist 'risky-local-variable t)
1607 (put 'after-load-alist 'risky-local-variable t)
1608 (put 'buffer-file-name 'risky-local-variable t)
1609 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1610 (put 'buffer-file-truename 'risky-local-variable t)
1611 (put 'exec-path 'risky-local-variable t)
1612 (put 'load-path 'risky-local-variable t)
1613 (put 'exec-directory 'risky-local-variable t)
1614 (put 'process-environment 'risky-local-variable t)
1615 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1616 (put 'outline-level 'risky-local-variable t)
1617 (put 'rmail-output-file-alist 'risky-local-variable t)
1618
1619 ;; This one is safe because the user gets to check it before it is used.
1620 (put 'compile-command 'safe-local-variable t)
1621
1622 ;(defun hack-one-local-variable-quotep (exp)
1623 ;  (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1624
1625 ;; "Set" one variable in a local variables spec.
1626 ;; A few variable names are treated specially.
1627 (defun hack-one-local-variable (var val)
1628   (cond ((eq var 'mode)
1629          (funcall (intern (concat (downcase (symbol-name val))
1630                                   "-mode"))))
1631         ((memq var ignored-local-variables)
1632          nil)
1633         ;; "Setting" eval means either eval it or do nothing.
1634         ;; Likewise for setting hook variables.
1635         ((or (get var 'risky-local-variable)
1636              (and
1637               (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1638                             (symbol-name var))
1639               (not (get var 'safe-local-variable))))
1640 ;        ;; Permit evaling a put of a harmless property
1641 ;        ;; if the args do nothing tricky.
1642 ;        (if (or (and (eq var 'eval)
1643 ;                     (consp val)
1644 ;                     (eq (car val) 'put)
1645 ;                     (hack-one-local-variable-quotep (nth 1 val))
1646 ;                     (hack-one-local-variable-quotep (nth 2 val))
1647 ;                     ;; Only allow safe values of lisp-indent-hook;
1648 ;                     ;; not functions.
1649 ;                     (or (numberp (nth 3 val))
1650 ;                         (equal (nth 3 val) ''defun))
1651 ;                     (memq (nth 1 (nth 2 val))
1652 ;                           '(lisp-indent-hook)))
1653          (if (and (not (zerop (user-uid)))
1654                   (or (eq enable-local-eval t)
1655                       (and enable-local-eval
1656                            (save-window-excursion
1657                              (switch-to-buffer (current-buffer))
1658                              (save-excursion
1659                                (beginning-of-line)
1660                                (set-window-start (selected-window) (point)))
1661                              (setq enable-local-eval
1662                                    (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1663                                                      (file-name-nondirectory buffer-file-name))))))))
1664              (if (eq var 'eval)
1665                  (save-excursion (eval val))
1666                (make-local-variable var)
1667                (set var val))
1668            (message "Ignoring `eval:' in file's local variables")))
1669         ;; Ordinary variable, really set it.
1670         (t (make-local-variable var)
1671            (set var val))))
1672 \f
1673 (defcustom change-major-mode-with-file-name t
1674   "*Non-nil means \\[write-file] should set the major mode from the file name.
1675 However, the mode will not be changed if
1676 \(1) a local variables list or the `-*-' line specifies a major mode, or
1677 \(2) the current major mode is a \"special\" mode,
1678 \    not suitable for ordinary files, or
1679 \(3) the new file name does not particularly specify any mode."
1680   :type 'boolean
1681   :group 'editing-basics)
1682
1683 (defun set-visited-file-name (filename &optional no-query along-with-file)
1684   "Change name of file visited in current buffer to FILENAME.
1685 The next time the buffer is saved it will go in the newly specified file.
1686 nil or empty string as argument means make buffer not be visiting any file.
1687 Remember to delete the initial contents of the minibuffer
1688 if you wish to pass an empty string as the argument.
1689
1690 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1691 confirmation in the case where another buffer is already visiting FILENAME.
1692
1693 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1694 the old visited file has been renamed to the new name FILENAME."
1695   (interactive "FSet visited file name: ")
1696   (if (buffer-base-buffer)
1697       (error "An indirect buffer cannot visit a file"))
1698   (let (truename)
1699     (if filename
1700         (setq filename
1701               (if (string-equal filename "")
1702                   nil
1703                 (expand-file-name filename))))
1704     (if filename
1705         (progn
1706           (setq truename (file-truename filename))
1707           ;; #### Do we need to check if truename is non-nil?
1708           (if find-file-use-truenames
1709               (setq filename truename))))
1710     (let ((buffer (and filename (find-buffer-visiting filename))))
1711       (and buffer (not (eq buffer (current-buffer)))
1712            (not no-query)
1713            (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1714                                    filename)))
1715            (error "Aborted")))
1716     (or (equal filename buffer-file-name)
1717         (progn
1718           (and filename (lock-buffer filename))
1719           (unlock-buffer)))
1720     (setq buffer-file-name filename)
1721     (if filename                        ; make buffer name reflect filename.
1722         (let ((new-name (file-name-nondirectory buffer-file-name)))
1723           (if (string= new-name "")
1724               (error "Empty file name"))
1725           (if (eq system-type 'vax-vms)
1726               (setq new-name (downcase new-name)))
1727           (setq default-directory (file-name-directory buffer-file-name))
1728           (or (string= new-name (buffer-name))
1729               (rename-buffer new-name t))))
1730     (setq buffer-backed-up nil)
1731     (or along-with-file
1732         (clear-visited-file-modtime))
1733     (compute-buffer-file-truename) ; insert-file-contents does this too.
1734 ;    ;; Abbreviate the file names of the buffer.
1735 ;    (if truename
1736 ;        (progn
1737 ;          (setq buffer-file-truename (abbreviate-file-name truename))
1738 ;          (if find-file-visit-truename
1739 ;              (setq buffer-file-name buffer-file-truename))))
1740     (setq buffer-file-number
1741           (if filename
1742               (nthcdr 10 (file-attributes buffer-file-name))
1743               nil)))
1744   ;; write-file-hooks is normally used for things like ftp-find-file
1745   ;; that visit things that are not local files as if they were files.
1746   ;; Changing to visit an ordinary local file instead should flush the hook.
1747   (kill-local-variable 'write-file-hooks)
1748   (kill-local-variable 'after-save-hook)
1749   (kill-local-variable 'local-write-file-hooks)
1750   (kill-local-variable 'write-file-data-hooks)
1751   (kill-local-variable 'revert-buffer-function)
1752   (kill-local-variable 'backup-inhibited)
1753   ;; If buffer was read-only because of version control,
1754   ;; that reason is gone now, so make it writable.
1755   (when (boundp 'vc-mode)
1756     (if vc-mode
1757         (setq buffer-read-only nil))
1758     (kill-local-variable 'vc-mode))
1759   ;; Turn off backup files for certain file names.
1760   ;; Since this is a permanent local, the major mode won't eliminate it.
1761   (and buffer-file-name
1762        (not (funcall backup-enable-predicate buffer-file-name))
1763        (progn
1764          (make-local-variable 'backup-inhibited)
1765          (setq backup-inhibited t)))
1766   (let ((oauto buffer-auto-save-file-name))
1767     ;; If auto-save was not already on, turn it on if appropriate.
1768     (if (not buffer-auto-save-file-name)
1769         (and buffer-file-name auto-save-default
1770              (auto-save-mode t))
1771       ;; If auto save is on, start using a new name.
1772       ;; We deliberately don't rename or delete the old auto save
1773       ;; for the old visited file name.  This is because perhaps
1774       ;; the user wants to save the new state and then compare with the
1775       ;; previous state from the auto save file.
1776       (setq buffer-auto-save-file-name
1777             (make-auto-save-file-name)))
1778     ;; Rename the old auto save file if any.
1779     (and oauto buffer-auto-save-file-name
1780          (file-exists-p oauto)
1781          (rename-file oauto buffer-auto-save-file-name t)))
1782   (if buffer-file-name
1783       (not along-with-file)
1784       (set-buffer-modified-p t))
1785   ;; Update the major mode, if the file name determines it.
1786   (condition-case nil
1787       ;; Don't change the mode if it is special.
1788       (or (not change-major-mode-with-file-name)
1789           (get major-mode 'mode-class)
1790           ;; Don't change the mode if the local variable list specifies it.
1791           (hack-local-variables t)
1792           (set-auto-mode t))
1793     (error nil))
1794   ;; #### ??
1795   (run-hooks 'after-set-visited-file-name-hooks))
1796
1797 (defun write-file (filename &optional confirm codesys)
1798   "Write current buffer into file FILENAME.
1799 Makes buffer visit that file, and marks it not modified.
1800 If the buffer is already visiting a file, you can specify
1801 a directory name as FILENAME, to write a file of the same
1802 old name in that directory.
1803 If optional second arg CONFIRM is non-nil,
1804 ask for confirmation for overwriting an existing file.
1805 Under XEmacs/Mule, optional third argument specifies the
1806 coding system to use when encoding the file.  Interactively,
1807 with a prefix argument, you will be prompted for the coding system."
1808 ;;  (interactive "FWrite file: ")
1809   (interactive
1810    (list (if buffer-file-name
1811              (read-file-name "Write file: "
1812                                  nil nil nil nil)
1813            (read-file-name "Write file: "
1814                                (cdr (assq 'default-directory
1815                                           (buffer-local-variables)))
1816                                nil nil (buffer-name)))
1817          t
1818          (if (and current-prefix-arg (featurep 'mule))
1819              (read-coding-system "Coding system: "))))
1820   (and (eq (current-buffer) mouse-grabbed-buffer)
1821        (error "Can't write minibuffer window"))
1822   (or (null filename) (string-equal filename "")
1823       (progn
1824         ;; If arg is just a directory,
1825         ;; use same file name, but in that directory.
1826         (if (and (file-directory-p filename) buffer-file-name)
1827             (setq filename (concat (file-name-as-directory filename)
1828                                    (file-name-nondirectory buffer-file-name))))
1829         (and confirm
1830              (file-exists-p filename)
1831              (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1832                  (error "Canceled")))
1833         (set-visited-file-name filename)))
1834   (set-buffer-modified-p t)
1835   (setq buffer-read-only nil)
1836   (if codesys
1837       (let ((buffer-file-coding-system (get-coding-system codesys)))
1838         (save-buffer))
1839     (save-buffer)))
1840 \f
1841 (defun backup-buffer ()
1842   "Make a backup of the disk file visited by the current buffer, if appropriate.
1843 This is normally done before saving the buffer the first time.
1844 If the value is non-nil, it is the result of `file-modes' on the original file;
1845 this means that the caller, after saving the buffer, should change the modes
1846 of the new file to agree with the old modes."
1847   (if buffer-file-name
1848       (let ((handler (find-file-name-handler buffer-file-name 'backup-buffer)))
1849         (if handler
1850             (funcall handler 'backup-buffer)
1851           (if (and make-backup-files
1852                    (not backup-inhibited)
1853                    (not buffer-backed-up)
1854                    (file-exists-p buffer-file-name)
1855                    (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1856                          '(?- ?l)))
1857               (let ((real-file-name buffer-file-name)
1858                     backup-info backupname targets setmodes)
1859                 ;; If specified name is a symbolic link, chase it to the target.
1860                 ;; Thus we make the backups in the directory where the real file is.
1861                 (setq real-file-name (file-chase-links real-file-name))
1862                 (setq backup-info (find-backup-file-name real-file-name)
1863                       backupname (car backup-info)
1864                       targets (cdr backup-info))
1865 ;;;     (if (file-directory-p buffer-file-name)
1866 ;;;         (error "Cannot save buffer in directory %s" buffer-file-name))
1867                 (if backup-info
1868                     (condition-case ()
1869                         (let ((delete-old-versions
1870                                ;; If have old versions to maybe delete,
1871                                ;; ask the user to confirm now, before doing anything.
1872                                ;; But don't actually delete til later.
1873                                (and targets
1874                                     (or (eq delete-old-versions t)
1875                                         (eq delete-old-versions nil))
1876                                     (or delete-old-versions
1877                                         (y-or-n-p (format "Delete excess backup versions of %s? "
1878                                                           real-file-name))))))
1879                           ;; Actually write the back up file.
1880                           (condition-case ()
1881                               (if (or file-precious-flag
1882                                         ;                         (file-symlink-p buffer-file-name)
1883                                       backup-by-copying
1884                                       (and backup-by-copying-when-linked
1885                                            (> (file-nlinks real-file-name) 1))
1886                                       (and backup-by-copying-when-mismatch
1887                                            (let ((attr (file-attributes real-file-name)))
1888                                              (or (nth 9 attr)
1889                                                  (not (file-ownership-preserved-p real-file-name))))))
1890                                   (condition-case ()
1891                                       (copy-file real-file-name backupname t t)
1892                                     (file-error
1893                                      ;; If copying fails because file BACKUPNAME
1894                                      ;; is not writable, delete that file and try again.
1895                                      (if (and (file-exists-p backupname)
1896                                               (not (file-writable-p backupname)))
1897                                          (delete-file backupname))
1898                                      (copy-file real-file-name backupname t t)))
1899                                 ;; rename-file should delete old backup.
1900                                 (rename-file real-file-name backupname t)
1901                                 (setq setmodes (file-modes backupname)))
1902                             (file-error
1903                              ;; If trouble writing the backup, write it in ~.
1904                              (setq backupname (expand-file-name "~/%backup%~"))
1905                              (message "Cannot write backup file; backing up in ~/%%backup%%~")
1906                              (sleep-for 1)
1907                              (condition-case ()
1908                                  (copy-file real-file-name backupname t t)
1909                                (file-error
1910                                 ;; If copying fails because file BACKUPNAME
1911                                 ;; is not writable, delete that file and try again.
1912                                 (if (and (file-exists-p backupname)
1913                                          (not (file-writable-p backupname)))
1914                                     (delete-file backupname))
1915                                 (copy-file real-file-name backupname t t)))))
1916                           (setq buffer-backed-up t)
1917                           ;; Now delete the old versions, if desired.
1918                           (if delete-old-versions
1919                               (while targets
1920                                 (condition-case ()
1921                                     (delete-file (car targets))
1922                                   (file-error nil))
1923                                 (setq targets (cdr targets))))
1924                           setmodes)
1925                       (file-error nil)))))))))
1926
1927 (defun file-name-sans-versions (name &optional keep-backup-version)
1928   "Return FILENAME sans backup versions or strings.
1929 This is a separate procedure so your site-init or startup file can
1930 redefine it.
1931 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1932 we do not remove backup version numbers, only true file version numbers."
1933   (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1934     (if handler
1935         (funcall handler 'file-name-sans-versions name keep-backup-version)
1936       (substring name 0
1937                  (if (eq system-type 'vax-vms)
1938                      ;; VMS version number is (a) semicolon, optional
1939                      ;; sign, zero or more digits or (b) period, option
1940                      ;; sign, zero or more digits, provided this is the
1941                      ;; second period encountered outside of the
1942                      ;; device/directory part of the file name.
1943                      (or (string-match ";[-+]?[0-9]*\\'" name)
1944                          (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
1945                                            name)
1946                              (match-beginning 1))
1947                          (length name))
1948                    (if keep-backup-version
1949                        (length name)
1950                      (or (string-match "\\.~[0-9.]+~\\'" name)
1951                          ;; XEmacs - VC uses extensions like ".~tagname~" or ".~1.1.5.2~"
1952                          (let ((pos (string-match "\\.~\\([^.~ \t]+\\|[0-9.]+\\)~\\'" name)))
1953                            (and pos
1954                                 ;; #### - is this filesystem check too paranoid?
1955                                 (file-exists-p (substring name 0 pos))
1956                                 pos))
1957                          (string-match "~\\'" name)
1958                          (length name))))))))
1959
1960 (defun file-ownership-preserved-p (file)
1961   "Return t if deleting FILE and rewriting it would preserve the owner."
1962   (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1963     (if handler
1964         (funcall handler 'file-ownership-preserved-p file)
1965       (let ((attributes (file-attributes file)))
1966         ;; Return t if the file doesn't exist, since it's true that no
1967         ;; information would be lost by an (attempted) delete and create.
1968         (or (null attributes)
1969             (= (nth 2 attributes) (user-uid)))))))
1970
1971 (defun file-name-sans-extension (filename)
1972   "Return FILENAME sans final \"extension\".
1973 The extension, in a file name, is the part that follows the last `.'."
1974   (save-match-data
1975     (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1976           directory)
1977       (if (string-match "\\.[^.]*\\'" file)
1978           (if (setq directory (file-name-directory filename))
1979               (expand-file-name (substring file 0 (match-beginning 0))
1980                                 directory)
1981             (substring file 0 (match-beginning 0)))
1982         filename))))
1983
1984 (defun file-name-extension (filename &optional period)
1985   "Return FILENAME's final \"extension\".
1986 The extension, in a file name, is the part that follows the last `.'.
1987 Return nil for extensionless file names such as `foo'.
1988 Return the empty string for file names such as `foo.'.
1989
1990 If PERIOD is non-nil, then the returned value includes the period
1991 that delimits the extension, and if FILENAME has no extension,
1992 the value is \"\"."
1993   (save-match-data
1994     (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1995       (if (string-match "\\.[^.]*\\'" file)
1996           (substring file (+ (match-beginning 0) (if period 0 1)))
1997         (if period
1998             "")))))
1999
2000 (defun make-backup-file-name (file)
2001   "Create the non-numeric backup file name for FILE.
2002 This is a separate function so you can redefine it for customization."
2003   (if (eq system-type 'ms-dos)
2004       (let ((fn (file-name-nondirectory file)))
2005         (concat (file-name-directory file)
2006                 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
2007                     (substring fn 0 (match-end 1)))
2008                 ".bak"))
2009     (concat file "~")))
2010
2011 (defun backup-file-name-p (file)
2012   "Return non-nil if FILE is a backup file name (numeric or not).
2013 This is a separate function so you can redefine it for customization.
2014 You may need to redefine `file-name-sans-versions' as well."
2015   (if (eq system-type 'ms-dos)
2016       (string-match "\\.bak\\'" file)
2017       (string-match "~\\'" file)))
2018
2019 ;; This is used in various files.
2020 ;; The usage of bv-length is not very clean,
2021 ;; but I can't see a good alternative,
2022 ;; so as of now I am leaving it alone.
2023 (defun backup-extract-version (fn)
2024   "Given the name of a numeric backup file, return the backup number.
2025 Uses the free variable `bv-length', whose value should be
2026 the index in the name where the version number begins."
2027   (declare (special bv-length))
2028   (if (and (string-match "[0-9]+~\\'" fn bv-length)
2029            (= (match-beginning 0) bv-length))
2030       (string-to-int (substring fn bv-length -1))
2031       0))
2032
2033 ;; I believe there is no need to alter this behavior for VMS;
2034 ;; since backup files are not made on VMS, it should not get called.
2035 (defun find-backup-file-name (fn)
2036   "Find a file name for a backup file, and suggestions for deletions.
2037 Value is a list whose car is the name for the backup file
2038  and whose cdr is a list of old versions to consider deleting now.
2039 If the value is nil, don't make a backup."
2040   (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2041     ;; Run a handler for this function so that ange-ftp can refuse to do it.
2042     (if handler
2043         (funcall handler 'find-backup-file-name fn)
2044       (if (eq version-control 'never)
2045           (list (make-backup-file-name fn))
2046         (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
2047                ;; used by backup-extract-version:
2048                (bv-length (length base-versions))
2049                possibilities
2050                (versions nil)
2051                (high-water-mark 0)
2052                (deserve-versions-p nil)
2053                (number-to-delete 0))
2054           (condition-case ()
2055               (setq possibilities (file-name-all-completions
2056                                    base-versions
2057                                    (file-name-directory fn))
2058                     versions (sort (mapcar
2059                                     #'backup-extract-version
2060                                     possibilities)
2061                                    '<)
2062                     high-water-mark (apply #'max 0 versions)
2063                     deserve-versions-p (or version-control
2064                                            (> high-water-mark 0))
2065                     number-to-delete (- (length versions)
2066                                         kept-old-versions kept-new-versions -1))
2067             (file-error
2068              (setq possibilities nil)))
2069           (if (not deserve-versions-p)
2070               (list (make-backup-file-name fn))
2071             (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2072                   (if (and (> number-to-delete 0)
2073                            ;; Delete nothing if there is overflow
2074                            ;; in the number of versions to keep.
2075                            (>= (+ kept-new-versions kept-old-versions -1) 0))
2076                       (mapcar #'(lambda (n)
2077                                   (concat fn ".~" (int-to-string n) "~"))
2078                               (let ((v (nthcdr kept-old-versions versions)))
2079                                 (rplacd (nthcdr (1- number-to-delete) v) ())
2080                                 v))))))))))
2081
2082 (defun file-nlinks (filename)
2083   "Return number of names file FILENAME has."
2084   (car (cdr (file-attributes filename))))
2085
2086 (defun file-relative-name (filename &optional directory)
2087   "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2088 This function returns a relative file name which is equivalent to FILENAME
2089 when used with that default directory as the default.
2090 If this is impossible (which can happen on MSDOS and Windows
2091 when the file name and directory use different drive names)
2092 then it returns FILENAME."
2093   (save-match-data
2094     (let ((fname (expand-file-name filename)))
2095       (setq directory (file-name-as-directory
2096                        (expand-file-name (or directory default-directory))))
2097       ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2098       ;; drive names, they can't be relative, so return the absolute name.
2099       (if (and (or (eq system-type 'ms-dos)
2100                    (eq system-type 'windows-nt))
2101                (not (string-equal (substring fname  0 2)
2102                                   (substring directory 0 2))))
2103           filename
2104         (let ((ancestor ".")
2105               (fname-dir (file-name-as-directory fname)))
2106           (while (and (not (string-match (concat "^" (regexp-quote directory))
2107                                          fname-dir))
2108                       (not (string-match (concat "^" (regexp-quote directory)) fname)))
2109             (setq directory (file-name-directory (substring directory 0 -1))
2110                   ancestor (if (equal ancestor ".")
2111                                ".."
2112                              (concat "../" ancestor))))
2113           ;; Now ancestor is empty, or .., or ../.., etc.
2114           (if (string-match (concat "^" (regexp-quote directory)) fname)
2115               ;; We matched within FNAME's directory part.
2116               ;; Add the rest of FNAME onto ANCESTOR.
2117               (let ((rest (substring fname (match-end 0))))
2118                 (if (and (equal ancestor ".")
2119                          (not (equal rest "")))
2120                     ;; But don't bother with ANCESTOR if it would give us `./'.
2121                     rest
2122                   (concat (file-name-as-directory ancestor) rest)))
2123             ;; We matched FNAME's directory equivalent.
2124             ancestor))))))
2125 \f
2126 (defun save-buffer (&optional args)
2127   "Save current buffer in visited file if modified.  Versions described below.
2128
2129 By default, makes the previous version into a backup file
2130  if previously requested or if this is the first save.
2131 With 1 or 3 \\[universal-argument]'s, marks this version
2132  to become a backup when the next save is done.
2133 With 2 or 3 \\[universal-argument]'s,
2134  unconditionally makes the previous version into a backup file.
2135 With argument of 0, never makes the previous version into a backup file.
2136
2137 If a file's name is FOO, the names of its numbered backup versions are
2138  FOO.~i~ for various integers i.  A non-numbered backup file is called FOO~.
2139 Numeric backups (rather than FOO~) will be made if value of
2140  `version-control' is not the atom `never' and either there are already
2141  numeric versions of the file being backed up, or `version-control' is
2142  non-nil.
2143 We don't want excessive versions piling up, so there are variables
2144  `kept-old-versions', which tells XEmacs how many oldest versions to keep,
2145  and `kept-new-versions', which tells how many newest versions to keep.
2146  Defaults are 2 old versions and 2 new.
2147 `dired-kept-versions' controls dired's clean-directory (.) command.
2148 If `delete-old-versions' is nil, system will query user
2149  before trimming versions.  Otherwise it does it silently."
2150   (interactive "_p")
2151   (let ((modp (buffer-modified-p))
2152         (large (> (buffer-size) 50000))
2153         (make-backup-files (or (and make-backup-files (not (eq args 0)))
2154                                (memq args '(16 64)))))
2155     (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2156     (if (and modp large) (display-message
2157                           'progress (format "Saving file %s..."
2158                                             (buffer-file-name))))
2159     (basic-save-buffer)
2160     (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2161
2162 (defun delete-auto-save-file-if-necessary (&optional force)
2163   "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2164 Normally delete only if the file was written by this XEmacs
2165 since the last real save, but optional arg FORCE non-nil means delete anyway."
2166   (and buffer-auto-save-file-name delete-auto-save-files
2167        (not (string= buffer-file-name buffer-auto-save-file-name))
2168        (or force (recent-auto-save-p))
2169        (progn
2170          (condition-case ()
2171              (delete-file buffer-auto-save-file-name)
2172            (file-error nil))
2173          (set-buffer-auto-saved))))
2174
2175 ;; XEmacs change (from Sun)
2176 ;; used to communicate with continue-save-buffer:
2177 (defvar continue-save-buffer-hooks-tail nil)
2178
2179 ;; Not in FSFmacs
2180 (defun basic-write-file-data (realname truename)
2181   ;; call the hooks until the bytes are put
2182   ;; call write-region as a last resort
2183   (let ((region-written nil)
2184         (hooks write-file-data-hooks))
2185     (while (and hooks (not region-written))
2186       (setq region-written (funcall (car hooks) realname)
2187             hooks (cdr hooks)))
2188     (if (not region-written)
2189         (write-region (point-min) (point-max) realname nil t truename))))
2190
2191 (put 'after-save-hook 'permanent-local t)
2192 (defvar after-save-hook nil
2193   "Normal hook that is run after a buffer is saved to its file.
2194 These hooks are considered to pertain to the visited file.
2195 So this list is cleared if you change the visited file name.")
2196
2197 (defun files-fetch-hook-value (hook)
2198   (let ((localval (symbol-value hook))
2199         (globalval (default-value hook)))
2200     (if (memq t localval)
2201         (setq localval (append (delq t localval) (delq t globalval))))
2202     localval))
2203
2204 (defun basic-save-buffer ()
2205   "Save the current buffer in its visited file, if it has been modified.
2206 After saving the buffer, run `after-save-hook'."
2207   (interactive)
2208   (save-excursion
2209     ;; In an indirect buffer, save its base buffer instead.
2210     (if (buffer-base-buffer)
2211         (set-buffer (buffer-base-buffer)))
2212     (if (buffer-modified-p)
2213         (let ((recent-save (recent-auto-save-p)))
2214           ;; On VMS, rename file and buffer to get rid of version number.
2215           (if (and (eq system-type 'vax-vms)
2216                    (not (string= buffer-file-name
2217                                  (file-name-sans-versions buffer-file-name))))
2218               (let (buffer-new-name)
2219                 ;; Strip VMS version number before save.
2220                 (setq buffer-file-name
2221                       (file-name-sans-versions buffer-file-name))
2222                 ;; Construct a (unique) buffer name to correspond.
2223                 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2224                   (setq buffer-new-name (buffer-name buf))
2225                   (kill-buffer buf))
2226                 (rename-buffer buffer-new-name)))
2227           ;; If buffer has no file name, ask user for one.
2228           (or buffer-file-name
2229               (let ((filename
2230                      (expand-file-name
2231                       (read-file-name "File to save in: ") nil)))
2232                 (and (file-exists-p filename)
2233                      (or (y-or-n-p (format "File `%s' exists; overwrite? "
2234                                            filename))
2235                          (error "Canceled")))
2236                 (set-visited-file-name filename)))
2237           (or (verify-visited-file-modtime (current-buffer))
2238               (not (file-exists-p buffer-file-name))
2239               (yes-or-no-p
2240                (format "%s has changed since visited or saved.  Save anyway? "
2241                        (file-name-nondirectory buffer-file-name)))
2242               (error "Save not confirmed"))
2243           (save-restriction
2244             (widen)
2245             (and (> (point-max) 1)
2246                  (/= (char-after (1- (point-max))) ?\n)
2247                  (not (and (eq selective-display t)
2248                            (= (char-after (1- (point-max))) ?\r)))
2249                  (or (eq require-final-newline t)
2250                      (and require-final-newline
2251                           (y-or-n-p
2252                            (format "Buffer %s does not end in newline.  Add one? "
2253                                    (buffer-name)))))
2254                  (save-excursion
2255                    (goto-char (point-max))
2256                    (insert ?\n)))
2257             ;;
2258             ;; Run the write-file-hooks until one returns non-null.
2259             ;; Bind after-save-hook to nil while running the
2260             ;; write-file-hooks so that if this function is called
2261             ;; recursively (from inside a write-file-hook) the
2262             ;; after-hooks will only get run once (from the
2263             ;; outermost call).
2264             ;;
2265             ;; Ugh, have to duplicate logic of run-hook-with-args-until-success
2266             (let ((hooks (append (files-fetch-hook-value 'write-contents-hooks)
2267                                  (files-fetch-hook-value
2268                                   'local-write-file-hooks)
2269                                  (files-fetch-hook-value 'write-file-hooks)))
2270                   (after-save-hook nil)
2271                   (local-write-file-hooks nil)
2272                   (write-contents-hooks nil)
2273                   (write-file-hooks nil)
2274                   done)
2275               (while (and hooks
2276                           (let ((continue-save-buffer-hooks-tail hooks))
2277                             (not (setq done (funcall (car hooks))))))
2278                 (setq hooks (cdr hooks)))
2279               ;; If a hook returned t, file is already "written".
2280               ;; Otherwise, write it the usual way now.
2281               (if (not done)
2282                   (basic-save-buffer-1)))
2283             ;; XEmacs: next two clauses (buffer-file-number setting and
2284             ;; set-file-modes) moved into basic-save-buffer-1.
2285             )
2286           ;; If the auto-save file was recent before this command,
2287           ;; delete it now.
2288           (delete-auto-save-file-if-necessary recent-save)
2289           ;; Support VC `implicit' locking.
2290           (when (fboundp 'vc-after-save)
2291             (vc-after-save))
2292           (run-hooks 'after-save-hook))
2293       (display-message 'no-log "(No changes need to be saved)"))))
2294
2295 ;; This does the "real job" of writing a buffer into its visited file
2296 ;; and making a backup file.  This is what is normally done
2297 ;; but inhibited if one of write-file-hooks returns non-nil.
2298 ;; It returns a value to store in setmodes.
2299 (defun basic-save-buffer-1 ()
2300   (let (setmodes tempsetmodes)
2301     (if (not (file-writable-p buffer-file-name))
2302         (let ((dir (file-name-directory buffer-file-name)))
2303           (if (not (file-directory-p dir))
2304               (error "%s is not a directory" dir)
2305             (if (not (file-exists-p buffer-file-name))
2306                 (error "Directory %s write-protected" dir)
2307               (if (yes-or-no-p
2308                    (format "File %s is write-protected; try to save anyway? "
2309                            (file-name-nondirectory
2310                             buffer-file-name)))
2311                   (setq tempsetmodes t)
2312                 (error
2313                  "Attempt to save to a file which you aren't allowed to write"))))))
2314     (or buffer-backed-up
2315         (setq setmodes (backup-buffer)))
2316     (let ((dir (file-name-directory buffer-file-name)))
2317       (if (and file-precious-flag
2318                (file-writable-p dir))
2319           ;; If file is precious, write temp name, then rename it.
2320           ;; This requires write access to the containing dir,
2321           ;; which is why we don't try it if we don't have that access.
2322           (let ((realname buffer-file-name)
2323                 tempname nogood i succeed
2324                 (old-modtime (visited-file-modtime)))
2325             (setq i 0)
2326             (setq nogood t)
2327             ;; Find the temporary name to write under.
2328             (while nogood
2329               (setq tempname (format "%s#tmp#%d" dir i))
2330               (setq nogood (file-exists-p tempname))
2331               (setq i (1+ i)))
2332             (unwind-protect
2333                 (progn (clear-visited-file-modtime)
2334                        (write-region (point-min) (point-max)
2335                                      tempname nil realname
2336                                      buffer-file-truename)
2337                        (setq succeed t))
2338               ;; If writing the temp file fails,
2339               ;; delete the temp file.
2340               (or succeed
2341                   (progn
2342                     (delete-file tempname)
2343                     (set-visited-file-modtime old-modtime))))
2344             ;; Since we have created an entirely new file
2345             ;; and renamed it, make sure it gets the
2346             ;; right permission bits set.
2347             (setq setmodes (file-modes buffer-file-name))
2348             ;; We succeeded in writing the temp file,
2349             ;; so rename it.
2350             (rename-file tempname buffer-file-name t))
2351         ;; If file not writable, see if we can make it writable
2352         ;; temporarily while we write it.
2353         ;; But no need to do so if we have just backed it up
2354         ;; (setmodes is set) because that says we're superseding.
2355         (cond ((and tempsetmodes (not setmodes))
2356                ;; Change the mode back, after writing.
2357                (setq setmodes (file-modes buffer-file-name))
2358                (set-file-modes buffer-file-name 511)))
2359         (basic-write-file-data buffer-file-name buffer-file-truename)))
2360     (setq buffer-file-number
2361           (if buffer-file-name
2362               (nth 10 (file-attributes buffer-file-name))
2363             nil))
2364     (if setmodes
2365         (condition-case ()
2366             (set-file-modes buffer-file-name setmodes)
2367           (error nil)))))
2368
2369 ;; XEmacs change, from Sun
2370 (defun continue-save-buffer ()
2371   "Provide a clean way for a write-file-hook to wrap AROUND
2372 the execution of the remaining hooks and writing to disk.
2373 Do not call this function except from a functions
2374 on the write-file-hooks or write-contents-hooks list.
2375 A hook that calls this function must return non-nil,
2376 to signal completion to its caller.  continue-save-buffer
2377 always returns non-nil."
2378   (let ((hooks (cdr (or continue-save-buffer-hooks-tail
2379                         (error
2380          "continue-save-buffer called outside a write-file-hook!"))))
2381         (done nil))
2382     ;; Do something like this:
2383     ;; (let ((write-file-hooks hooks)) (basic-save-buffer))
2384     ;; First run the rest of the hooks.
2385     (while (and hooks
2386                 (let ((continue-save-buffer-hooks-tail hooks))
2387                   (not (setq done (funcall (car hooks))))))
2388       (setq hooks (cdr hooks)))
2389     ;;
2390     ;; If a hook returned t, file is already "written".
2391     (if (not done)
2392         (basic-save-buffer-1))
2393     'continue-save-buffer))
2394
2395 (defcustom save-some-buffers-query-display-buffer t
2396   "*Non-nil makes `\\[save-some-buffers]' switch to the buffer offered for saving."
2397   :type 'boolean
2398   :group 'editing-basics)
2399
2400 (defun save-some-buffers (&optional arg exiting)
2401   "Save some modified file-visiting buffers.  Asks user about each one.
2402 Optional argument (the prefix) non-nil means save all with no questions.
2403 Optional second argument EXITING means ask about certain non-file buffers
2404  as well as about file buffers."
2405   (interactive "P")
2406   (save-excursion
2407     ;; `delete-other-windows' can bomb during autoloads generation, so
2408     ;; guard it well.
2409     (if (or noninteractive
2410             (eq (selected-window) (minibuffer-window))
2411             (not save-some-buffers-query-display-buffer))
2412         ;; If playing with windows is unsafe or undesired, just do the
2413         ;; usual drill.
2414         (save-some-buffers-1 arg exiting nil)
2415       ;; Else, protect the windows.
2416       (when (save-window-excursion
2417               (save-some-buffers-1 arg exiting t))
2418         ;; Force redisplay.
2419         (sit-for 0)))))
2420
2421 ;; XEmacs - do not use queried flag
2422 (defun save-some-buffers-1 (arg exiting switch-buffer)
2423   (let* ((switched nil)
2424          (files-done
2425           (map-y-or-n-p
2426            (lambda (buffer)
2427              (and (buffer-modified-p buffer)
2428                   (not (buffer-base-buffer buffer))
2429                   ;; XEmacs addition:
2430                   (not (symbol-value-in-buffer 'save-buffers-skip buffer))
2431                   (or
2432                    (buffer-file-name buffer)
2433                    (and exiting
2434                         (progn
2435                           (set-buffer buffer)
2436                           (and buffer-offer-save (> (buffer-size) 0)))))
2437                   (if arg
2438                       t
2439                     ;; #### We should provide a per-buffer means to
2440                     ;; disable the switching.  For instance, you might
2441                     ;; want to turn it off for buffers the contents of
2442                     ;; which is meaningless to humans, such as
2443                     ;; `.newsrc.eld'.
2444                     (when switch-buffer
2445                       (unless (one-window-p)
2446                         (delete-other-windows))
2447                       (setq switched t)
2448                       ;; #### Consider using `display-buffer' here for 21.1!
2449                       ;;(display-buffer buffer nil (selected-frame)))
2450                       (switch-to-buffer buffer t))
2451                     (if (buffer-file-name buffer)
2452                         (format "Save file %s? "
2453                                 (buffer-file-name buffer))
2454                       (format "Save buffer %s? "
2455                               (buffer-name buffer))))))
2456            (lambda (buffer)
2457              (set-buffer buffer)
2458              (condition-case ()
2459                  (save-buffer)
2460                (error nil)))
2461            (buffer-list)
2462            '("buffer" "buffers" "save")
2463            ;;instead of this we just say "yes all", "no all", etc.
2464            ;;"save all the rest"
2465            ;;"save only this buffer" "save no more buffers")
2466            ;; this is rather bogus. --ben
2467            ;; (it makes the dialog box too big, and you get an error
2468            ;; "wrong type argument: framep, nil" when you hit q after
2469            ;; choosing the option from the dialog box)
2470
2471            ;; We should fix the dialog box rather than disabling
2472            ;; this!  --hniksic
2473            (list (list ?\C-r (lambda (buf)
2474                                ;; #### FSF has an EXIT-ACTION argument
2475                                ;; to `view-buffer'.
2476                                (view-buffer buf)
2477                                (setq view-exit-action
2478                                      (lambda (ignore)
2479                                        (exit-recursive-edit)))
2480                                (recursive-edit)
2481                                ;; Return nil to ask about BUF again.
2482                                nil)
2483                        "display the current buffer"))))
2484          (abbrevs-done
2485           (and save-abbrevs abbrevs-changed
2486                (progn
2487                  (if (or arg
2488                          (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
2489                      (write-abbrev-file nil))
2490                  ;; Don't keep bothering user if he says no.
2491                  (setq abbrevs-changed nil)
2492                  t))))
2493     (or (> files-done 0) abbrevs-done
2494         (display-message 'no-log "(No files need saving)"))
2495     switched))
2496
2497 \f
2498 (defun not-modified (&optional arg)
2499   "Mark current buffer as unmodified, not needing to be saved.
2500 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2501
2502 It is not a good idea to use this function in Lisp programs, because it
2503 prints a message in the minibuffer.  Instead, use `set-buffer-modified-p'."
2504   (interactive "_P")
2505   (if arg ;; rewritten for I18N3 snarfing
2506       (display-message 'command "Modification-flag set")
2507     (display-message 'command "Modification-flag cleared"))
2508   (set-buffer-modified-p arg))
2509
2510 (defun toggle-read-only (&optional arg)
2511   "Toggle the current buffer's read-only status.
2512 With arg, set read-only iff arg is positive."
2513   (interactive "_P")
2514   (setq buffer-read-only
2515         (if (null arg)
2516             (not buffer-read-only)
2517             (> (prefix-numeric-value arg) 0)))
2518   ;; Force modeline redisplay
2519   (redraw-modeline))
2520
2521 (defun insert-file (filename &optional codesys)
2522   "Insert contents of file FILENAME into buffer after point.
2523 Set mark after the inserted text.
2524
2525 Under XEmacs/Mule, optional second argument specifies the
2526 coding system to use when decoding the file.  Interactively,
2527 with a prefix argument, you will be prompted for the coding system.
2528
2529 This function is meant for the user to run interactively.
2530 Don't call it from programs!  Use `insert-file-contents' instead.
2531 \(Its calling sequence is different; see its documentation)."
2532   (interactive "*fInsert file: \nZCoding system: ")
2533   (if (file-directory-p filename)
2534       (signal 'file-error (list "Opening input file" "file is a directory"
2535                                 filename)))
2536   (let ((tem
2537          (if codesys
2538              (let ((coding-system-for-read
2539                     (get-coding-system codesys)))
2540                (insert-file-contents filename))
2541            (insert-file-contents filename))))
2542     (push-mark (+ (point) (car (cdr tem))))))
2543
2544 (defun append-to-file (start end filename &optional codesys)
2545   "Append the contents of the region to the end of file FILENAME.
2546 When called from a function, expects three arguments,
2547 START, END and FILENAME.  START and END are buffer positions
2548 saying what text to write.
2549 Under XEmacs/Mule, optional fourth argument specifies the
2550 coding system to use when encoding the file.  Interactively,
2551 with a prefix argument, you will be prompted for the coding system."
2552   (interactive "r\nFAppend to file: \nZCoding system: ")
2553   (if codesys
2554       (let ((buffer-file-coding-system (get-coding-system codesys)))
2555         (write-region start end filename t))
2556     (write-region start end filename t)))
2557
2558 (defun file-newest-backup (filename)
2559   "Return most recent backup file for FILENAME or nil if no backups exist."
2560   (let* ((filename (expand-file-name filename))
2561          (file (file-name-nondirectory filename))
2562          (dir  (file-name-directory    filename))
2563          (comp (file-name-all-completions file dir))
2564          newest)
2565     (while comp
2566       (setq file (concat dir (car comp))
2567             comp (cdr comp))
2568       (if (and (backup-file-name-p file)
2569                (or (null newest) (file-newer-than-file-p file newest)))
2570           (setq newest file)))
2571     newest))
2572
2573 (defun rename-uniquely ()
2574   "Rename current buffer to a similar name not already taken.
2575 This function is useful for creating multiple shell process buffers
2576 or multiple mail buffers, etc."
2577   (interactive)
2578   (save-match-data
2579     (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2580                                (not (and buffer-file-name
2581                                          (string= (buffer-name)
2582                                                   (file-name-nondirectory
2583                                                    buffer-file-name)))))
2584                           ;; If the existing buffer name has a <NNN>,
2585                           ;; which isn't part of the file name (if any),
2586                           ;; then get rid of that.
2587                           (substring (buffer-name) 0 (match-beginning 0))
2588                         (buffer-name)))
2589            (new-buf (generate-new-buffer base-name))
2590            (name (buffer-name new-buf)))
2591       (kill-buffer new-buf)
2592       (rename-buffer name)
2593       (redraw-modeline))))
2594
2595 (defun make-directory-path (path)
2596   "Create all the directories along path that don't exist yet."
2597   (interactive "Fdirectory path to create: ")
2598   (make-directory path t))
2599
2600 (defun make-directory (dir &optional parents)
2601   "Create the directory DIR and any nonexistent parent dirs.
2602 Interactively, the default choice of directory to create
2603 is the current default directory for file names.
2604 That is useful when you have visited a file in a nonexistent directory.
2605
2606 Noninteractively, the second (optional) argument PARENTS says whether
2607 to create parent directories if they don't exist."
2608   (interactive (list (let ((current-prefix-arg current-prefix-arg))
2609                        (read-directory-name "Create directory: "))
2610                      current-prefix-arg))
2611   (let ((handler (find-file-name-handler dir 'make-directory)))
2612     (if handler
2613         (funcall handler 'make-directory dir parents)
2614       (if (not parents)
2615           (make-directory-internal dir)
2616         (let ((dir (directory-file-name (expand-file-name dir)))
2617               create-list)
2618           (while (not (file-exists-p dir))
2619             (setq create-list (cons dir create-list)
2620                   dir (directory-file-name (file-name-directory dir))))
2621           (while create-list
2622             (make-directory-internal (car create-list))
2623             (setq create-list (cdr create-list))))))))
2624 \f
2625 (put 'revert-buffer-function 'permanent-local t)
2626 (defvar revert-buffer-function nil
2627   "Function to use to revert this buffer, or nil to do the default.
2628 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2629 which are the arguments that `revert-buffer' received.")
2630
2631 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2632 (defvar revert-buffer-insert-file-contents-function nil
2633   "Function to use to insert contents when reverting this buffer.
2634 Gets two args, first the nominal file name to use,
2635 and second, t if reading the auto-save file.")
2636
2637 (defvar before-revert-hook nil
2638   "Normal hook for `revert-buffer' to run before reverting.
2639 If `revert-buffer-function' is used to override the normal revert
2640 mechanism, this hook is not used.")
2641
2642 (defvar after-revert-hook nil
2643   "Normal hook for `revert-buffer' to run after reverting.
2644 Note that the hook value that it runs is the value that was in effect
2645 before reverting; that makes a difference if you have buffer-local
2646 hook functions.
2647
2648 If `revert-buffer-function' is used to override the normal revert
2649 mechanism, this hook is not used.")
2650
2651 (defvar revert-buffer-internal-hook nil
2652   "Don't use this.")
2653
2654 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2655   "Replace the buffer text with the text of the visited file on disk.
2656 This undoes all changes since the file was visited or saved.
2657 With a prefix argument, offer to revert from latest auto-save file, if
2658 that is more recent than the visited file.
2659
2660 This command also works for special buffers that contain text which
2661 doesn't come from a file, but reflects some other data base instead:
2662 for example, Dired buffers and buffer-list buffers.  In these cases,
2663 it reconstructs the buffer contents from the appropriate data base.
2664
2665 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2666 to revert from the auto-save file when this is nil.  Note that the
2667 sense of this argument is the reverse of the prefix argument, for the
2668 sake of backward compatibility.  IGNORE-AUTO is optional, defaulting
2669 to nil.
2670
2671 Optional second argument NOCONFIRM means don't ask for confirmation at
2672 all.
2673
2674 Optional third argument PRESERVE-MODES non-nil means don't alter
2675 the files modes.  Normally we reinitialize them using `normal-mode'.
2676
2677 If the value of `revert-buffer-function' is non-nil, it is called to
2678 do all the work for this command.  Otherwise, the hooks
2679 `before-revert-hook' and `after-revert-hook' are run at the beginning
2680 and the end, and if `revert-buffer-insert-file-contents-function' is
2681 non-nil, it is called instead of rereading visited file contents."
2682
2683   ;; I admit it's odd to reverse the sense of the prefix argument, but
2684   ;; there is a lot of code out there which assumes that the first
2685   ;; argument should be t to avoid consulting the auto-save file, and
2686   ;; there's no straightforward way to encourage authors to notice a
2687   ;; reversal of the argument sense.  So I'm just changing the user
2688   ;; interface, but leaving the programmatic interface the same.
2689   (interactive (list (not current-prefix-arg)))
2690   (if revert-buffer-function
2691       (funcall revert-buffer-function ignore-auto noconfirm)
2692     (let* ((opoint (point))
2693            (auto-save-p (and (not ignore-auto)
2694                              (recent-auto-save-p)
2695                              buffer-auto-save-file-name
2696                              (file-readable-p buffer-auto-save-file-name)
2697                              (y-or-n-p
2698    "Buffer has been auto-saved recently.  Revert from auto-save file? ")))
2699            (file-name (if auto-save-p
2700                           buffer-auto-save-file-name
2701                         buffer-file-name)))
2702       (cond ((null file-name)
2703              (error "Buffer does not seem to be associated with any file"))
2704             ((or noconfirm
2705                  (and (not (buffer-modified-p))
2706                       (let (found)
2707                         (dolist (rx revert-without-query found)
2708                           (when (string-match rx file-name)
2709                             (setq found t)))))
2710                  (yes-or-no-p (format "Revert buffer from file %s? "
2711                                       file-name)))
2712              (run-hooks 'before-revert-hook)
2713              ;; If file was backed up but has changed since,
2714              ;; we shd make another backup.
2715              (and (not auto-save-p)
2716                   (not (verify-visited-file-modtime (current-buffer)))
2717                   (setq buffer-backed-up nil))
2718              ;; Get rid of all undo records for this buffer.
2719              (or (eq buffer-undo-list t)
2720                  (setq buffer-undo-list nil))
2721              ;; Effectively copy the after-revert-hook status,
2722              ;; since after-find-file will clobber it.
2723              (let ((global-hook (default-value 'after-revert-hook))
2724                    (local-hook-p (local-variable-p 'after-revert-hook
2725                                                    (current-buffer)))
2726                    (local-hook (and (local-variable-p 'after-revert-hook
2727                                                       (current-buffer))
2728                                     after-revert-hook)))
2729                (let (buffer-read-only
2730                      ;; Don't make undo records for the reversion.
2731                      (buffer-undo-list t))
2732                  (if revert-buffer-insert-file-contents-function
2733                      (funcall revert-buffer-insert-file-contents-function
2734                               file-name auto-save-p)
2735                    (if (not (file-exists-p file-name))
2736                        (error "File %s no longer exists!" file-name))
2737                    ;; Bind buffer-file-name to nil
2738                    ;; so that we don't try to lock the file.
2739                    (let ((buffer-file-name nil))
2740                      (or auto-save-p
2741                          (unlock-buffer)))
2742                    (widen)
2743                    (insert-file-contents file-name (not auto-save-p)
2744                                          nil nil t)))
2745                (goto-char (min opoint (point-max)))
2746                ;; Recompute the truename in case changes in symlinks
2747                ;; have changed the truename.
2748                ;XEmacs: already done by insert-file-contents
2749                ;;(setq buffer-file-truename
2750                      ;;(abbreviate-file-name (file-truename buffer-file-name)))
2751                (after-find-file nil nil t t preserve-modes)
2752                ;; Run after-revert-hook as it was before we reverted.
2753                (setq-default revert-buffer-internal-hook global-hook)
2754                (if local-hook-p
2755                    (progn
2756                      (make-local-variable 'revert-buffer-internal-hook)
2757                      (setq revert-buffer-internal-hook local-hook))
2758                  (kill-local-variable 'revert-buffer-internal-hook))
2759                (run-hooks 'revert-buffer-internal-hook))
2760              t)))))
2761
2762 (defun recover-file (file)
2763   "Visit file FILE, but get contents from its last auto-save file."
2764   ;; Actually putting the file name in the minibuffer should be used
2765   ;; only rarely.
2766   ;; Not just because users often use the default.
2767   (interactive "FRecover file: ")
2768   (setq file (expand-file-name file))
2769   (let ((handler (or (find-file-name-handler file 'recover-file)
2770                     (find-file-name-handler
2771                      (let ((buffer-file-name file))
2772                        (make-auto-save-file-name))
2773                      'recover-file))))
2774     (if handler
2775         (funcall handler 'recover-file file)
2776       (if (auto-save-file-name-p file)
2777           (error "%s is an auto-save file" file))
2778       (let ((file-name (let ((buffer-file-name file))
2779                          (make-auto-save-file-name))))
2780         (cond ((if (file-exists-p file)
2781                    (not (file-newer-than-file-p file-name file))
2782                  (not (file-exists-p file-name)))
2783                (error "Auto-save file %s not current" file-name))
2784               ((save-window-excursion
2785                  (if (not (eq system-type 'vax-vms))
2786                      (with-output-to-temp-buffer "*Directory*"
2787                        (buffer-disable-undo standard-output)
2788                        (call-process "ls" nil standard-output nil
2789                                      (if (file-symlink-p file) "-lL" "-l")
2790                                      file file-name)))
2791                  (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2792                (switch-to-buffer (find-file-noselect file t))
2793                (let ((buffer-read-only nil))
2794                  (erase-buffer)
2795                  (insert-file-contents file-name nil))
2796                (after-find-file nil nil t))
2797               (t (error "Recover-file cancelled.")))))))
2798
2799 (defun recover-session ()
2800   "Recover auto save files from a previous Emacs session.
2801 This command first displays a Dired buffer showing you the
2802 previous sessions that you could recover from.
2803 To choose one, move point to the proper line and then type C-c C-c.
2804 Then you'll be asked about a number of files to recover."
2805   (interactive)
2806   (unless (fboundp 'dired)
2807     (error "recover-session requires dired"))
2808   (if (null auto-save-list-file-prefix)
2809       (error
2810        "You set `auto-save-list-file-prefix' to disable making session files"))
2811   (dired (concat auto-save-list-file-prefix "*"))
2812   (goto-char (point-min))
2813   (or (looking-at "Move to the session you want to recover,")
2814       (let ((inhibit-read-only t))
2815         (insert "Move to the session you want to recover,\n"
2816                 "then type C-c C-c to select it.\n\n"
2817                 "You can also delete some of these files;\n"
2818                 "type d on a line to mark that file for deletion.\n\n")))
2819   (use-local-map (let ((map (make-sparse-keymap)))
2820                    (set-keymap-parents map (list (current-local-map)))
2821                    map))
2822   (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2823
2824 (defun recover-session-finish ()
2825   "Choose one saved session to recover auto-save files from.
2826 This command is used in the special Dired buffer created by
2827 \\[recover-session]."
2828   (interactive)
2829   ;; Get the name of the session file to recover from.
2830   (let ((file (dired-get-filename))
2831         files
2832         (buffer (get-buffer-create " *recover*")))
2833     ;; #### dired-do-flagged-delete in FSF.
2834     ;; This version is for ange-ftp
2835     ;;(dired-do-deletions t)
2836     ;; This version is for efs
2837     (dired-expunge-deletions)
2838     (unwind-protect
2839         (save-excursion
2840           ;; Read in the auto-save-list file.
2841           (set-buffer buffer)
2842           (erase-buffer)
2843           (insert-file-contents file)
2844           ;; Loop thru the text of that file
2845           ;; and get out the names of the files to recover.
2846           (while (not (eobp))
2847             (let (thisfile autofile)
2848               (if (eolp)
2849                   ;; This is a pair of lines for a non-file-visiting buffer.
2850                   ;; Get the auto-save file name and manufacture
2851                   ;; a "visited file name" from that.
2852                   (progn
2853                     (forward-line 1)
2854                     (setq autofile
2855                           (buffer-substring-no-properties
2856                            (point)
2857                            (save-excursion
2858                              (end-of-line)
2859                              (point))))
2860                     (setq thisfile
2861                           (expand-file-name
2862                            (substring
2863                             (file-name-nondirectory autofile)
2864                             1 -1)
2865                            (file-name-directory autofile)))
2866                     (forward-line 1))
2867                 ;; This pair of lines is a file-visiting
2868                 ;; buffer.  Use the visited file name.
2869                 (progn
2870                   (setq thisfile
2871                         (buffer-substring-no-properties
2872                          (point) (progn (end-of-line) (point))))
2873                   (forward-line 1)
2874                   (setq autofile
2875                         (buffer-substring-no-properties
2876                          (point) (progn (end-of-line) (point))))
2877                   (forward-line 1)))
2878               ;; Ignore a file if its auto-save file does not exist now.
2879               (if (file-exists-p autofile)
2880                   (setq files (cons thisfile files)))))
2881           (setq files (nreverse files))
2882           ;; The file contains a pair of line for each auto-saved buffer.
2883           ;; The first line of the pair contains the visited file name
2884           ;; or is empty if the buffer was not visiting a file.
2885           ;; The second line is the auto-save file name.
2886           (if files
2887               (map-y-or-n-p  "Recover %s? "
2888                              (lambda (file)
2889                                (condition-case nil
2890                                    (save-excursion (recover-file file))
2891                                  (error
2892                                   "Failed to recover `%s'" file)))
2893                              files
2894                              '("file" "files" "recover"))
2895             (message "No files can be recovered from this session now")))
2896       (kill-buffer buffer))))
2897
2898 (defun kill-some-buffers (&optional list)
2899   "For each buffer in LIST, ask whether to kill it.
2900 LIST defaults to all existing live buffers."
2901   (interactive)
2902   (if (null list)
2903       (setq list (buffer-list)))
2904   (while list
2905     (let* ((buffer (car list))
2906            (name (buffer-name buffer)))
2907       (and (not (string-equal name ""))
2908            (/= (aref name 0) ?\ )
2909            (yes-or-no-p
2910             (format
2911              (if (buffer-modified-p buffer)
2912                  (gettext "Buffer %s HAS BEEN EDITED.  Kill? ")
2913                (gettext "Buffer %s is unmodified.  Kill? "))
2914              name))
2915            (kill-buffer buffer)))
2916     (setq list (cdr list))))
2917 \f
2918 (defun auto-save-mode (arg)
2919   "Toggle auto-saving of contents of current buffer.
2920 With prefix argument ARG, turn auto-saving on if positive, else off."
2921   (interactive "P")
2922   (setq buffer-auto-save-file-name
2923         (and (if (null arg)
2924                  (or (not buffer-auto-save-file-name)
2925                      ;; If autosave is off because buffer has shrunk,
2926                      ;; then toggling should turn it on.
2927                      (< buffer-saved-size 0))
2928                (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2929              (if (and buffer-file-name auto-save-visited-file-name
2930                       (not buffer-read-only))
2931                  buffer-file-name
2932                (make-auto-save-file-name))))
2933   ;; If -1 was stored here, to temporarily turn off saving,
2934   ;; turn it back on.
2935   (and (< buffer-saved-size 0)
2936        (setq buffer-saved-size 0))
2937   (if (interactive-p)
2938       (if buffer-auto-save-file-name ;; rewritten for I18N3 snarfing
2939           (display-message 'command "Auto-save on (in this buffer)")
2940         (display-message 'command "Auto-save off (in this buffer)")))
2941   buffer-auto-save-file-name)
2942
2943 (defun rename-auto-save-file ()
2944   "Adjust current buffer's auto save file name for current conditions.
2945 Also rename any existing auto save file, if it was made in this session."
2946   (let ((osave buffer-auto-save-file-name))
2947     (setq buffer-auto-save-file-name
2948           (make-auto-save-file-name))
2949     (if (and osave buffer-auto-save-file-name
2950              (not (string= buffer-auto-save-file-name buffer-file-name))
2951              (not (string= buffer-auto-save-file-name osave))
2952              (file-exists-p osave)
2953              (recent-auto-save-p))
2954         (rename-file osave buffer-auto-save-file-name t))))
2955
2956 ;; see also ../packages/auto-save.el
2957 (defun make-auto-save-file-name (&optional filename)
2958   "Return file name to use for auto-saves of current buffer.
2959 Does not consider `auto-save-visited-file-name' as that variable is checked
2960 before calling this function.  You can redefine this for customization.
2961 See also `auto-save-file-name-p'."
2962   (let ((fname (or filename buffer-file-name))
2963         name)
2964     (setq name
2965           (if fname
2966               (concat (file-name-directory fname)
2967                       "#"
2968                       (file-name-nondirectory fname)
2969                       "#")
2970
2971             ;; Deal with buffers that don't have any associated files.  (Mail
2972             ;; mode tends to create a good number of these.)
2973
2974             (let ((buffer-name (buffer-name))
2975                   (limit 0))
2976               ;; Use technique from Sebastian Kremer's auto-save
2977               ;; package to turn slashes into \\!.  This ensures that
2978               ;; the auto-save buffer name is unique.
2979
2980               ;; #### - yuck!  yuck!  yuck!  move this functionality
2981               ;; somewhere else and make the name translation customizable.
2982               ;; Using "\!" as part of a filename on a UNIX filesystem is nearly
2983               ;; IMPOSSIBLE to get past a shell parser.  -stig
2984
2985               (while (string-match "[/\\]" buffer-name limit)
2986                 (setq buffer-name
2987                       (concat (substring buffer-name 0 (match-beginning 0))
2988                               (if (string= (substring buffer-name
2989                                                       (match-beginning 0)
2990                                                       (match-end 0))
2991                                            "/")
2992                                   "\\!"
2993                                 "\\\\")
2994                               (substring buffer-name (match-end 0))))
2995                 (setq limit (1+ (match-end 0))))
2996
2997               ;;    (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))
2998
2999               ;; jwz: putting the emacs PID in the auto-save file name
3000               ;; is bad news, because that defeats auto-save-recovery of
3001               ;; *mail* buffers -- the (sensible) code in sendmail.el
3002               ;; calls (make-auto-save-file-name) to determine whether
3003               ;; there is unsent, auto-saved mail to recover.  If that
3004               ;; mail came from a previous emacs process (far and away
3005               ;; the most likely case) then this can never succeed as
3006               ;; the pid differs.
3007
3008               (expand-file-name (format "#%s#" buffer-name)))
3009             ))
3010     ;; don't try to write auto-save files in unwritable places.  Unless
3011     ;; there's already an autosave file here, put ours somewhere safe. --Stig
3012     (if (or (file-writable-p name)
3013             (file-exists-p name))
3014         name
3015       (expand-file-name (concat "~/" (file-name-nondirectory name))))))
3016
3017 (defun auto-save-file-name-p (filename)
3018   "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3019 FILENAME should lack slashes.
3020 You can redefine this for customization."
3021   (string-match "\\`#.*#\\'" filename))
3022 \f
3023 (defun wildcard-to-regexp (wildcard)
3024   "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3025 The generated regexp will match a filename iff the filename
3026 matches that wildcard according to shell rules.  Only wildcards known
3027 by `sh' are supported."
3028   (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3029          ;; Copy the initial run of non-special characters.
3030          (result (substring wildcard 0 i))
3031          (len (length wildcard)))
3032     ;; If no special characters, we're almost done.
3033     (if i
3034         (while (< i len)
3035           (let ((ch (aref wildcard i))
3036                 j)
3037             (setq
3038              result
3039              (concat result
3040                      (cond
3041                       ((eq ch ?\[)      ; [...] maps to regexp char class
3042                        (progn
3043                          (setq i (1+ i))
3044                          (concat
3045                           (cond
3046                            ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3047                             (progn
3048                               (setq i (1+ i))
3049                               (if (eq (aref wildcard i) ?\])
3050                                   (progn
3051                                     (setq i (1+ i))
3052                                     "[^]")
3053                                 "[^")))
3054                            ((eq (aref wildcard i) ?^)
3055                             ;; Found "[^".  Insert a `\0' character
3056                             ;; (which cannot happen in a filename)
3057                             ;; into the character class, so that `^'
3058                             ;; is not the first character after `[',
3059                             ;; and thus non-special in a regexp.
3060                             (progn
3061                               (setq i (1+ i))
3062                               "[\000^"))
3063                            ((eq (aref wildcard i) ?\])
3064                             ;; I don't think `]' can appear in a
3065                             ;; character class in a wildcard, but
3066                             ;; let's be general here.
3067                             (progn
3068                               (setq i (1+ i))
3069                               "[]"))
3070                            (t "["))
3071                           (prog1        ; copy everything upto next `]'.
3072                               (substring wildcard
3073                                          i
3074                                          (setq j (string-match
3075                                                   "]" wildcard i)))
3076                             (setq i (if j (1- j) (1- len)))))))
3077                       ((eq ch ?.)  "\\.")
3078                       ((eq ch ?*)  "[^\000]*")
3079                       ((eq ch ?+)  "\\+")
3080                       ((eq ch ?^)  "\\^")
3081                       ((eq ch ?$)  "\\$")
3082                       ((eq ch ?\\) "\\\\") ; probably cannot happen...
3083                       ((eq ch ??)  "[^\000]")
3084                       (t (char-to-string ch)))))
3085             (setq i (1+ i)))))
3086     ;; Shell wildcards should match the entire filename,
3087     ;; not its part.  Make the regexp say so.
3088     (concat "\\`" result "\\'")))
3089 \f
3090 (defcustom list-directory-brief-switches
3091   (if (eq system-type 'vax-vms) "" "-CF")
3092   "*Switches for list-directory to pass to `ls' for brief listing."
3093   :type 'string
3094   :group 'dired)
3095
3096 (defcustom list-directory-verbose-switches
3097   (if (eq system-type 'vax-vms)
3098       "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3099     "-l")
3100   "*Switches for list-directory to pass to `ls' for verbose listing,"
3101   :type 'string
3102   :group 'dired)
3103
3104 (defun list-directory (dirname &optional verbose)
3105   "Display a list of files in or matching DIRNAME, a la `ls'.
3106 DIRNAME is globbed by the shell if necessary.
3107 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3108 Actions controlled by variables `list-directory-brief-switches'
3109 and `list-directory-verbose-switches'."
3110   (interactive (let ((pfx current-prefix-arg))
3111                  (list (read-file-name (if pfx (gettext "List directory (verbose): ")
3112                                          (gettext "List directory (brief): "))
3113                                        nil default-directory nil)
3114                        pfx)))
3115   (let ((switches (if verbose list-directory-verbose-switches
3116                     list-directory-brief-switches)))
3117     (or dirname (setq dirname default-directory))
3118     (setq dirname (expand-file-name dirname))
3119     (with-output-to-temp-buffer "*Directory*"
3120       (buffer-disable-undo standard-output)
3121       (princ "Directory ")
3122       (princ dirname)
3123       (terpri)
3124       (save-excursion
3125         (set-buffer "*Directory*")
3126         (setq default-directory (file-name-directory dirname))
3127         (let ((wildcard (not (file-directory-p dirname))))
3128           (insert-directory dirname switches wildcard (not wildcard)))))))
3129
3130 (defvar insert-directory-program "ls"
3131   "Absolute or relative name of the `ls' program used by `insert-directory'.")
3132
3133 ;; insert-directory
3134 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3135 ;;   FULL-DIRECTORY-P is nil.
3136 ;;   The single line of output must display FILE's name as it was
3137 ;;   given, namely, an absolute path name.
3138 ;; - must insert exactly one line for each file if WILDCARD or
3139 ;;   FULL-DIRECTORY-P is t, plus one optional "total" line
3140 ;;   before the file lines, plus optional text after the file lines.
3141 ;;   Lines are delimited by "\n", so filenames containing "\n" are not
3142 ;;   allowed.
3143 ;;   File lines should display the basename.
3144 ;; - must be consistent with
3145 ;;   - functions dired-move-to-filename, (these two define what a file line is)
3146 ;;               dired-move-to-end-of-filename,
3147 ;;               dired-between-files, (shortcut for (not (dired-move-to-filename)))
3148 ;;               dired-insert-headerline
3149 ;;               dired-after-subdir-garbage (defines what a "total" line is)
3150 ;;   - variable dired-subdir-regexp
3151 (defun insert-directory (file switches &optional wildcard full-directory-p)
3152   "Insert directory listing for FILE, formatted according to SWITCHES.
3153 Leaves point after the inserted text.
3154 SWITCHES may be a string of options, or a list of strings.
3155 Optional third arg WILDCARD means treat FILE as shell wildcard.
3156 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3157 switches do not contain `d', so that a full listing is expected.
3158
3159 This works by running a directory listing program
3160 whose name is in the variable `insert-directory-program'.
3161 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3162   ;; We need the directory in order to find the right handler.
3163   (let ((handler (find-file-name-handler (expand-file-name file)
3164                                          'insert-directory)))
3165     (if handler
3166         (funcall handler 'insert-directory file switches
3167                  wildcard full-directory-p)
3168       (cond
3169        ((eq system-type 'vax-vms)
3170         (vms-read-directory file switches (current-buffer)))
3171        ((and (fboundp 'mswindows-insert-directory)
3172              (eq system-type 'windows-nt))
3173         (mswindows-insert-directory file switches wildcard full-directory-p))
3174        (t
3175         (if wildcard
3176             ;; Run ls in the directory of the file pattern we asked for.
3177             (let ((default-directory
3178                       (if (file-name-absolute-p file)
3179                           (file-name-directory file)
3180                           (file-name-directory (expand-file-name file))))
3181                   (pattern (file-name-nondirectory file))
3182                   (beg 0))
3183               ;; Quote some characters that have special meanings in shells;
3184               ;; but don't quote the wildcards--we want them to be special.
3185               ;; We also currently don't quote the quoting characters
3186               ;; in case people want to use them explicitly to quote
3187               ;; wildcard characters.
3188               ;;#### Unix-specific
3189               (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3190                 (setq pattern
3191                       (concat (substring pattern 0 (match-beginning 0))
3192                               "\\"
3193                               (substring pattern (match-beginning 0)))
3194                       beg (1+ (match-end 0))))
3195               (call-process shell-file-name nil t nil
3196                             "-c" (concat "\\"  ;; Disregard shell aliases!
3197                                          insert-directory-program
3198                                          " -d "
3199                                          (if (stringp switches)
3200                                              switches
3201                                            (mapconcat 'identity switches " "))
3202                                          " "
3203                                          pattern)))
3204           ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3205           ;; directory if FILE is a symbolic link.
3206           (apply 'call-process
3207                  insert-directory-program nil t nil
3208                  (let (list)
3209                    (if (listp switches)
3210                        (setq list switches)
3211                      (if (not (equal switches ""))
3212                          (progn
3213                            ;; Split the switches at any spaces
3214                            ;; so we can pass separate options as separate args.
3215                            (while (string-match " " switches)
3216                              (setq list (cons (substring switches 0 (match-beginning 0))
3217                                               list)
3218                                    switches (substring switches (match-end 0))))
3219                            (setq list (cons switches list)))))
3220                    (append list
3221                            (list
3222                             (if full-directory-p
3223                                 (concat (file-name-as-directory file)
3224                                         ;;#### Unix-specific
3225                                         ".")
3226                               file)))))))))))
3227
3228 (defvar kill-emacs-query-functions nil
3229   "Functions to call with no arguments to query about killing XEmacs.
3230 If any of these functions returns nil, killing Emacs is cancelled.
3231 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3232 but `kill-emacs', the low level primitive, does not.
3233 See also `kill-emacs-hook'.")
3234
3235 (defun save-buffers-kill-emacs (&optional arg)
3236   "Offer to save each buffer, then kill this XEmacs process.
3237 With prefix arg, silently save all file-visiting buffers, then kill."
3238   (interactive "P")
3239   (save-some-buffers arg t)
3240   (and (or (not (memq t (mapcar #'(lambda (buf) (and (buffer-file-name buf)
3241                                                      (buffer-modified-p buf)))
3242                                 (buffer-list))))
3243            (yes-or-no-p "Modified buffers exist; exit anyway? "))
3244        (or (not (fboundp 'process-list))
3245            ;; process-list is not defined on VMS.
3246            (let ((processes (process-list))
3247                  active)
3248              (while processes
3249                (and (memq (process-status (car processes)) '(run stop open))
3250                     (let ((val (process-kill-without-query (car processes))))
3251                       (process-kill-without-query (car processes) val)
3252                       val)
3253                     (setq active t))
3254                (setq processes (cdr processes)))
3255              (or
3256               (not active)
3257               (save-excursion
3258                 (save-window-excursion
3259                   (delete-other-windows)
3260                   (list-processes)
3261                   (yes-or-no-p
3262                    "Active processes exist; kill them and exit anyway? "))))))
3263        ;; Query the user for other things, perhaps.
3264        (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3265        (kill-emacs)))
3266
3267 (defun symlink-expand-file-name (filename)
3268   "If FILENAME is a symlink, return its non-symlink equivalent.
3269 Unlike `file-truename', this doesn't chase symlinks in directory
3270 components of the file or expand a relative pathname into an
3271 absolute one."
3272   (let ((count 20))
3273     (while (and (> count 0) (file-symlink-p filename))
3274       (setq filename (file-symlink-p filename)
3275             count (1- count)))
3276     (if (> count 0)
3277         filename
3278       (error "Apparently circular symlink path"))))
3279
3280 ;; Suggested by Michael Kifer <kifer@CS.SunySB.EDU>
3281 (defun file-remote-p (file-name)
3282   "Test whether FILE-NAME is looked for on a remote system."
3283   (cond ((not allow-remote-paths) nil)
3284         ((featurep 'ange-ftp) (ange-ftp-ftp-path file-name))
3285         ((fboundp 'efs-ftp-path) (efs-ftp-path file-name))
3286         (t nil)))
3287
3288 ;; #### FSF has file-name-non-special here.
3289
3290 ;;; files.el ends here