Initial revision
[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           (set-buffer-major-mode buf)
980           (set-buffer buf)
981           (erase-buffer)
982           (if rawfile
983               (condition-case ()
984                   (insert-file-contents-literally filename t)
985                 (file-error
986                  (when (and (file-exists-p filename)
987                             (not (file-readable-p filename)))
988                    (kill-buffer buf)
989                    (signal 'file-error (list "File is not readable" filename)))
990                  ;; Unconditionally set error
991                  (setq error t)))
992             (condition-case ()
993                 (insert-file-contents filename t)
994               (file-error
995                (when (and (file-exists-p filename)
996                           (not (file-readable-p filename)))
997                  (kill-buffer buf)
998                  (signal 'file-error (list "File is not readable" filename)))
999                ;; Run find-file-not-found-hooks until one returns non-nil.
1000                (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
1001                    ;; If they fail too, set error.
1002                    (setq error t)))))
1003           ;; Find the file's truename, and maybe use that as visited name.
1004           ;; automatically computed in XEmacs, unless jka-compr was used!
1005           (unless buffer-file-truename
1006             (setq buffer-file-truename truename))
1007           (setq buffer-file-number number)
1008           ;; On VMS, we may want to remember which directory in a search list
1009           ;; the file was found in.
1010           (and (eq system-type 'vax-vms)
1011                (let (logical)
1012                  (if (string-match ":" (file-name-directory filename))
1013                      (setq logical (substring (file-name-directory filename)
1014                                               0 (match-beginning 0))))
1015                  (not (member logical find-file-not-true-dirname-list)))
1016                (setq buffer-file-name buffer-file-truename))
1017           (and find-file-use-truenames
1018                ;; This should be in C.  Put pathname abbreviations that have
1019                ;; been explicitly requested back into the pathname.  Most
1020                ;; importantly, strip out automounter /tmp_mnt directories so
1021                ;; 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 makes
1034               ;; `find-file-literally' a local variable and sets it to t.
1035               nil
1036             (after-find-file error (not nowarn))
1037             (setq buf (current-buffer)))))
1038       buf)))
1039 \f
1040 ;; FSF has `insert-file-literally' and `find-file-literally' here.
1041
1042 (defvar after-find-file-from-revert-buffer nil)
1043
1044 (defun after-find-file (&optional error warn noauto
1045                                   after-find-file-from-revert-buffer
1046                                   nomodes)
1047   "Called after finding a file and by the default revert function.
1048 Sets buffer mode, parses local variables.
1049 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1050 error in reading the file.  WARN non-nil means warn if there
1051 exists an auto-save file more recent than the visited file.
1052 NOAUTO means don't mess with auto-save mode.
1053 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1054  means this call was from `revert-buffer'.
1055 Fifth arg NOMODES non-nil means don't alter the file's modes.
1056 Finishes by calling the functions in `find-file-hooks'."
1057   (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1058   (if noninteractive
1059       nil
1060     (let* (not-serious
1061            (msg
1062             (cond ((and error (file-attributes buffer-file-name))
1063                    (setq buffer-read-only t)
1064                    (gettext "File exists, but cannot be read."))
1065                   ((not buffer-read-only)
1066                    (if (and warn
1067                             (file-newer-than-file-p (make-auto-save-file-name)
1068                                                     buffer-file-name))
1069                        (format "%s has auto save data; consider M-x recover-file"
1070                                (file-name-nondirectory buffer-file-name))
1071                      (setq not-serious t)
1072                      (if error (gettext "(New file)") nil)))
1073                   ((not error)
1074                    (setq not-serious t)
1075                    (gettext "Note: file is write protected"))
1076                   ((file-attributes (directory-file-name default-directory))
1077                    (gettext "File not found and directory write-protected"))
1078                   ((file-exists-p (file-name-directory buffer-file-name))
1079                    (setq buffer-read-only nil))
1080                   (t
1081                    ;; If the directory the buffer is in doesn't exist,
1082                    ;; offer to create it.  It's better to do this now
1083                    ;; than when we save the buffer, because we want
1084                    ;; autosaving to work.
1085                    (setq buffer-read-only nil)
1086                    ;; XEmacs
1087                    (or (file-exists-p (file-name-directory buffer-file-name))
1088                        (condition-case nil
1089                            (if (yes-or-no-p
1090                                 (format
1091                                  "\
1092 The directory containing %s does not exist.  Create? "
1093                                  (abbreviate-file-name buffer-file-name)))
1094                                (make-directory (file-name-directory
1095                                                 buffer-file-name)
1096                                                t))
1097                          (quit
1098                           (kill-buffer (current-buffer))
1099                           (signal 'quit nil))))
1100                    nil))))
1101       (if msg
1102           (progn
1103             (message "%s" msg)
1104             (or not-serious (sit-for 1 t)))))
1105     (if (and auto-save-default (not noauto))
1106         (auto-save-mode t)))
1107   (unless nomodes
1108     (normal-mode t)
1109     (run-hooks 'find-file-hooks)))
1110
1111 (defun normal-mode (&optional find-file)
1112   "Choose the major mode for this buffer automatically.
1113 Also sets up any specified local variables of the file.
1114 Uses the visited file name, the -*- line, and the local variables spec.
1115
1116 This function is called automatically from `find-file'.  In that case,
1117 we may set up specified local variables depending on the value of
1118 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1119 otherwise, we query.  `enable-local-variables' is ignored if you
1120 run `normal-mode' explicitly."
1121   (interactive)
1122   (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1123   (and (condition-case err
1124            (progn (set-auto-mode)
1125                   t)
1126          (error (message "File mode specification error: %s"
1127                          (prin1-to-string err))
1128                 nil))
1129        (condition-case err
1130            (hack-local-variables (not find-file))
1131          (error (lwarn 'local-variables 'warning
1132                   "File local-variables error: %s"
1133                   (error-message-string err))))))
1134
1135 ;; #### This variable sucks in the package model.  There should be a
1136 ;; way for new packages to add their entries to auto-mode-alist in a
1137 ;; clean way.  Per Abrahamsen suggested splitting auto-mode-alist to
1138 ;; several distinct variables such as, in order of precedence,
1139 ;; `user-auto-mode-alist' for users, `package-auto-mode-alist' for
1140 ;; packages and `auto-mode-alist' (which might also be called
1141 ;; `default-auto-mode-alist') for default stuff, such as some of the
1142 ;; entries below.
1143
1144 (defvar auto-mode-alist
1145   '(("\\.te?xt\\'" . text-mode)
1146     ("\\.[ch]\\'" . c-mode)
1147     ("\\.el\\'" . emacs-lisp-mode)
1148     ("\\.\\([CH]\\|cc\\|hh\\)\\'" . c++-mode)
1149     ("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode)
1150     ("\\.java\\'" . java-mode)
1151     ("\\.idl\\'" . idl-mode)
1152     ("\\.f\\(or\\)?\\'" . fortran-mode)
1153     ("\\.F\\(OR\\)?\\'" . fortran-mode)
1154     ("\\.[fF]90\\'" . f90-mode)
1155 ;;; Less common extensions come here
1156 ;;; so more common ones above are found faster.
1157     ("\\.p[lm]\\'" . perl-mode)
1158     ("\\.py\\'" . python-mode)
1159     ("\\.texi\\(nfo\\)?\\'" . texinfo-mode)
1160     ("\\.ad[abs]\\'" . ada-mode)
1161     ("\\.c?l\\(i?sp\\)?\\'" . lisp-mode)
1162     ("\\.p\\(as\\)?\\'" . pascal-mode)
1163     ("\\.ltx\\'" . latex-mode)
1164     ("\\.[sS]\\'" . asm-mode)
1165     ("[Cc]hange.?[Ll]og?\\(.[0-9]+\\)?\\'" . change-log-mode)
1166     ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1167     ("\\.scm?\\(?:\\.[0-9]*\\)?\\'" . scheme-mode)
1168     ("\\.e\\'" . eiffel-mode)
1169     ("\\.mss\\'" . scribe-mode)
1170     ("\\.m\\([mes]\\|an\\)\\'" . nroff-mode)
1171     ("\\.icn\\'" . icon-mode)
1172     ("\\.\\([ckz]?sh\\|shar\\)\\'" . sh-mode)
1173     ;; #### Unix-specific!
1174     ("/\\.\\(bash_\\|z\\)?\\(profile\\|login\||logout\\)\\'" . sh-mode)
1175     ("/\\.\\([ckz]sh\\|bash\\|tcsh\\|es\\|xinit\\|startx\\)rc\\'" . sh-mode)
1176     ("/\\.\\([kz]shenv\\|xsession\\)\\'" . sh-mode)
1177     ;; The following come after the ChangeLog pattern for the sake of
1178     ;; ChangeLog.1, etc. and after the .scm.[0-9] pattern too.
1179     ("\\.[12345678]\\'" . nroff-mode)
1180     ("\\.[tT]e[xX]\\'" . tex-mode)
1181     ("\\.\\(sty\\|cls\\|bbl\\)\\'" . latex-mode)
1182     ("\\.bib\\'" . bibtex-mode)
1183     ("\\.article\\'" . text-mode)
1184     ("\\.letter\\'" . text-mode)
1185     ("\\.\\(tcl\\|exp\\)\\'" . tcl-mode)
1186     ("\\.wrl\\'" . vrml-mode)
1187     ("\\.awk\\'" . awk-mode)
1188     ("\\.prolog\\'" . prolog-mode)
1189     ("\\.tar\\'" . tar-mode)
1190     ("\\.\\(arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
1191     ;; Mailer puts message to be edited in /tmp/Re.... or Message
1192     ;; #### Unix-specific!
1193     ("\\`/tmp/Re" . text-mode)
1194     ("/Message[0-9]*\\'" . text-mode)
1195     ("/drafts/[0-9]+\\'" . mh-letter-mode)
1196     ;; some news reader is reported to use this
1197     ("^/tmp/fol/" . text-mode)
1198     ("\\.y\\'" . c-mode)
1199     ("\\.lex\\'" . c-mode)
1200     ("\\.m\\'" . objc-mode)
1201     ("\\.oak\\'" . scheme-mode)
1202     ("\\.s?html?\\'" . html-mode)
1203     ("\\.htm?l?3\\'" . html3-mode)
1204     ("\\.\\(sgml?\\|dtd\\)\\'" . sgml-mode)
1205     ("\\.c?ps\\'" . postscript-mode)
1206     ;; .emacs following a directory delimiter in either Unix or
1207     ;; Windows syntax.
1208     ("[/\\][._].*emacs\\'" . emacs-lisp-mode)
1209     ("\\.m4\\'" . autoconf-mode)
1210     ("configure\\.in\\'" . autoconf-mode)
1211     ("\\.ml\\'" . lisp-mode)
1212     ("\\.ma?k\\'" . makefile-mode)
1213     ("[Mm]akefile\\(\\.\\|\\'\\)" . makefile-mode)
1214     ("\\.X\\(defaults\\|environment\\|resources\\|modmap\\)\\'" . xrdb-mode)
1215     ;; #### The following three are Unix-specific (but do we care?)
1216     ("/app-defaults/" . xrdb-mode)
1217     ("\\.[^/]*wm\\'" . winmgr-mode)
1218     ("\\.[^/]*wm2?rc" . winmgr-mode)
1219     ("\\.[Jj][Pp][Ee]?[Gg]\\'" . image-mode)
1220     ("\\.[Pp][Nn][Gg]\\'" . image-mode)
1221     ("\\.[Gg][Ii][Ff]\\'" . image-mode)
1222     )
1223 "Alist of filename patterns vs. corresponding major mode functions.
1224 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1225 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1226 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1227 mode function to use.  FUNCTION will be called, unless it is nil.
1228
1229 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1230 calling FUNCTION (if it's not nil), we delete the suffix that matched
1231 REGEXP and search the list again for another match.")
1232
1233 (defvar interpreter-mode-alist
1234   '(("^#!.*csh"   . sh-mode)
1235     ("^#!.*\\b\\(scope\\|wish\\|tcl\\|tclsh\\|expect\\)" . tcl-mode)
1236     ("^#!.*sh\\b" . sh-mode)
1237     ("perl"   . perl-mode)
1238     ("python" . python-mode)
1239     ("awk\\b" . awk-mode)
1240     ("rexx"   . rexx-mode)
1241     ("scm"    . scheme-mode)
1242     ("^:"     . sh-mode))
1243   "Alist mapping interpreter names to major modes.
1244 This alist is used to guess the major mode of a file based on the
1245 contents of the first line.  This line often contains something like:
1246 #!/bin/sh
1247 but may contain something more imaginative like
1248 #! /bin/env python
1249 or
1250 eval 'exec perl -w -S $0 ${1+\"$@\"}'.
1251
1252 Each alist element looks like (INTERPRETER . MODE).
1253 The car of each element is a regular expression which is compared
1254 with the name of the interpreter specified in the first line.
1255 If it matches, mode MODE is selected.")
1256
1257 (defvar inhibit-first-line-modes-regexps (purecopy '("\\.tar\\'" "\\.tgz\\'"
1258                                                      "\\.tar\\.gz\\'"))
1259   "List of regexps; if one matches a file name, don't look for `-*-'.")
1260
1261 (defvar inhibit-first-line-modes-suffixes nil
1262   "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1263 When checking `inhibit-first-line-modes-regexps', we first discard
1264 from the end of the file name anything that matches one of these regexps.")
1265
1266 (defvar user-init-file
1267   "" ; set by command-line
1268   "File name including directory of user's initialization file.")
1269
1270 (defun set-auto-mode (&optional just-from-file-name)
1271   "Select major mode appropriate for current buffer.
1272 This checks for a -*- mode tag in the buffer's text,
1273 compares the filename against the entries in `auto-mode-alist',
1274 or checks the interpreter that runs this file against
1275 `interpreter-mode-alist'.
1276
1277 It does not check for the `mode:' local variable in the
1278 Local Variables section of the file; for that, use `hack-local-variables'.
1279
1280 If `enable-local-variables' is nil, this function does not check for a
1281 -*- mode tag.
1282
1283 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1284 then we do not set anything but the major mode,
1285 and we don't even do that unless it would come from the file name."
1286   (save-excursion
1287     ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1288     ;; Do this by calling the hack-local-variables helper to avoid redundancy.
1289     ;; We bind enable-local-variables to nil this time because we're going to
1290     ;; call hack-local-variables-prop-line again later, "for real."  Note that
1291     ;; this temporary binding does not prevent hack-local-variables-prop-line
1292     ;; from setting the major mode.
1293     (or (and enable-local-variables
1294              (let ((enable-local-variables nil))
1295                (hack-local-variables-prop-line nil))
1296              )
1297         ;; It's not in the -*- line, so check the auto-mode-alist, unless
1298         ;; this buffer isn't associated with a file.
1299         (null buffer-file-name)
1300         (let ((name (file-name-sans-versions buffer-file-name))
1301               (keep-going t))
1302           (while keep-going
1303             (setq keep-going nil)
1304             (let ((alist auto-mode-alist)
1305                   (mode nil))
1306               ;; Find first matching alist entry.
1307               (let ((case-fold-search
1308                      (memq system-type '(vax-vms windows-nt))))
1309                 (while (and (not mode) alist)
1310                   (if (string-match (car (car alist)) name)
1311                       (if (and (consp (cdr (car alist)))
1312                                (nth 2 (car alist)))
1313                           (progn
1314                             (setq mode (car (cdr (car alist)))
1315                                   name (substring name 0 (match-beginning 0))
1316                                   keep-going t))
1317                         (setq mode (cdr (car alist))
1318                               keep-going nil)))
1319                   (setq alist (cdr alist))))
1320               (unless just-from-file-name
1321                 ;; If we can't deduce a mode from the file name,
1322                 ;; look for an interpreter specified in the first line.
1323                 (if (and (null mode)
1324                          (save-excursion ; XEmacs
1325                            (goto-char (point-min))
1326                            (looking-at "#!")))
1327                     (let ((firstline
1328                            (buffer-substring
1329                             (point-min)
1330                             (save-excursion
1331                               (goto-char (point-min)) (end-of-line) (point)))))
1332                       (setq alist interpreter-mode-alist)
1333                       (while alist
1334                         (if (string-match (car (car alist)) firstline)
1335                             (progn
1336                               (setq mode (cdr (car alist)))
1337                               (setq alist nil))
1338                           (setq alist (cdr alist)))))))
1339               (if mode
1340                   (if (not (fboundp mode))
1341                       (progn
1342                         (if (or (not (boundp 'package-get-base))
1343                                 (not package-get-base))
1344                             (load "package-get-base"))
1345                         (require 'package-get)
1346                         (let ((name (package-get-package-provider mode)))
1347                           (if name
1348                               (message "Mode %s is not installed.  Download package %s" mode name)
1349                             (message "Mode %s either doesn't exist or is not a known package" mode))
1350                           (sit-for 2)
1351                           (error "%s" mode)))
1352                     (unless (and just-from-file-name
1353                                  (or
1354                                   ;; Don't reinvoke major mode.
1355                                   (eq mode major-mode)
1356                                   ;; Don't lose on minor modes.
1357                                   (assq mode minor-mode-alist)))
1358                       (funcall mode))))))))))
1359
1360 (defvar hack-local-variables-hook nil
1361   "Normal hook run after processing a file's local variables specs.
1362 Major modes can use this to examine user-specified local variables
1363 in order to initialize other data structure based on them.
1364
1365 This hook runs even if there were no local variables or if their
1366 evaluation was suppressed.  See also `enable-local-variables' and
1367 `enable-local-eval'.")
1368
1369 (defun hack-local-variables (&optional force)
1370   "Parse, and bind or evaluate as appropriate, any local variables
1371 for current buffer."
1372   ;; Don't look for -*- if this file name matches any
1373   ;; of the regexps in inhibit-first-line-modes-regexps.
1374   (if (or (null buffer-file-name) ; don't lose if buffer has no file!
1375           (not (let ((temp inhibit-first-line-modes-regexps)
1376                      (name (if buffer-file-name
1377                                (file-name-sans-versions buffer-file-name)
1378                              (buffer-name))))
1379                  (while (let ((sufs inhibit-first-line-modes-suffixes))
1380                           (while (and sufs (not
1381                                             (string-match (car sufs) name)))
1382                             (setq sufs (cdr sufs)))
1383                           sufs)
1384                    (setq name (substring name 0 (match-beginning 0))))
1385                  (while (and temp
1386                              (not (string-match (car temp) name)))
1387                    (setq temp (cdr temp))
1388                    temp))))
1389       (progn
1390         ;; Look for variables in the -*- line.
1391         (hack-local-variables-prop-line force)
1392         ;; Look for "Local variables:" block in last page.
1393         (hack-local-variables-last-page force)))
1394   (run-hooks 'hack-local-variables-hook))
1395
1396 ;;; Local variables may be specified in the last page of the file (within 3k
1397 ;;; from the end of the file and after the last ^L) in the form
1398 ;;;
1399 ;;;   Local variables:
1400 ;;;   variable-name: variable-value
1401 ;;;   end:
1402 ;;;
1403 ;;; The lines may begin with a common prefix, like ";;;   " in the above
1404 ;;; example.  They may also have a common suffix (" */" for example).  In
1405 ;;; this form, the local variable "mode" can be used to change the major
1406 ;;; mode, and the local variable "eval" can be used to evaluate an arbitrary
1407 ;;; form.
1408 ;;;
1409 ;;; Local variables may also be specified in the first line of the file.
1410 ;;; Embedded in this line are a pair of "-*-" sequences.  What lies between
1411 ;;; them are variable-name/variable-value pairs, like:
1412 ;;;
1413 ;;;      -*- mode: emacs-lisp -*-
1414 ;;; or   -*- mode: postscript; version-control: never -*-
1415 ;;; or   -*- tags-file-name: "/foo/bar/TAGS" -*-
1416 ;;;
1417 ;;; The local variable "eval" is not used with this form. For hysterical
1418 ;;; reasons, the syntax "-*- modename -*-" is allowed as well.
1419 ;;;
1420
1421 (defun hack-local-variables-p (modeline)
1422   (or (eq enable-local-variables t)
1423       (and enable-local-variables
1424            (save-window-excursion
1425              (condition-case nil
1426                  (switch-to-buffer (current-buffer))
1427                (error
1428                 ;; If we fail to switch in the selected window,
1429                 ;; it is probably a minibuffer.
1430                 ;; So try another window.
1431                 (condition-case nil
1432                     (switch-to-buffer-other-window (current-buffer))
1433                   (error
1434                    (switch-to-buffer-other-frame (current-buffer))))))
1435              (or modeline (save-excursion
1436                              (beginning-of-line)
1437                              (set-window-start (selected-window) (point))))
1438              (y-or-n-p (format
1439                         "Set local variables as specified %s of %s? "
1440                         (if modeline "in -*- line" "at end")
1441                         (if buffer-file-name
1442                             (file-name-nondirectory buffer-file-name)
1443                             (concat "buffer " (buffer-name)))))))))
1444
1445 (defun hack-local-variables-last-page (&optional force)
1446   ;; Set local variables set in the "Local Variables:" block of the last page.
1447   (save-excursion
1448     (goto-char (point-max))
1449     (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1450     (if (let ((case-fold-search t))
1451           (and (search-forward "Local Variables:" nil t)
1452                (or force
1453                    (hack-local-variables-p nil))))
1454         (let ((continue t)
1455               prefix prefixlen suffix beg
1456               (enable-local-eval enable-local-eval))
1457           ;; The prefix is what comes before "local variables:" in its line.
1458           ;; The suffix is what comes after "local variables:" in its line.
1459           (skip-chars-forward " \t")
1460           (or (eolp)
1461               (setq suffix (buffer-substring (point)
1462                                              (progn (end-of-line) (point)))))
1463           (goto-char (match-beginning 0))
1464           (or (bolp)
1465               (setq prefix
1466                     (buffer-substring (point)
1467                                       (progn (beginning-of-line) (point)))))
1468           (if prefix (setq prefixlen (length prefix)
1469                            prefix (regexp-quote prefix)))
1470           (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1471           (while continue
1472             ;; Look at next local variable spec.
1473             (if selective-display (re-search-forward "[\n\C-m]")
1474               (forward-line 1))
1475             ;; Skip the prefix, if any.
1476             (if prefix
1477                 (if (looking-at prefix)
1478                     (forward-char prefixlen)
1479                   (error "Local variables entry is missing the prefix")))
1480             ;; Find the variable name; strip whitespace.
1481             (skip-chars-forward " \t")
1482             (setq beg (point))
1483             (skip-chars-forward "^:\n")
1484             (if (eolp) (error "Missing colon in local variables entry"))
1485             (skip-chars-backward " \t")
1486             (let* ((str (buffer-substring beg (point)))
1487                    (var (read str))
1488                   val)
1489               ;; Setting variable named "end" means end of list.
1490               (if (string-equal (downcase str) "end")
1491                   (setq continue nil)
1492                 ;; Otherwise read the variable value.
1493                 (skip-chars-forward "^:")
1494                 (forward-char 1)
1495                 (setq val (read (current-buffer)))
1496                 (skip-chars-backward "\n")
1497                 (skip-chars-forward " \t")
1498                 (or (if suffix (looking-at suffix) (eolp))
1499                     (error "Local variables entry is terminated incorrectly"))
1500                 ;; Set the variable.  "Variables" mode and eval are funny.
1501                 (hack-one-local-variable var val))))))))
1502
1503 ;; jwz - New Version 20.1/19.15
1504 (defun hack-local-variables-prop-line (&optional force)
1505   ;; Set local variables specified in the -*- line.
1506   ;; Returns t if mode was set.
1507   (let ((result nil))
1508     (save-excursion
1509       (goto-char (point-min))
1510       (skip-chars-forward " \t\n\r")
1511       (let ((end (save-excursion
1512                    ;; If the file begins with "#!"
1513                    ;; (un*x exec interpreter magic), look
1514                    ;; for mode frobs in the first two
1515                    ;; lines.  You cannot necessarily
1516                    ;; put them in the first line of
1517                    ;; such a file without screwing up
1518                    ;; the interpreter invocation.
1519                    (end-of-line (and (looking-at "^#!") 2))
1520                    (point))))
1521         ;; Parse the -*- line into the `result' alist.
1522         (cond ((not (search-forward "-*-" end t))
1523                ;; doesn't have one.
1524                (setq force t))
1525               ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1526                ;; Antiquated form: "-*- ModeName -*-".
1527                (setq result
1528                      (list (cons 'mode
1529                                  (intern (buffer-substring
1530                                           (match-beginning 1)
1531                                           (match-end 1)))))
1532                      ))
1533               (t
1534                ;; Usual form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1535                ;; (last ";" is optional).
1536                (save-excursion
1537                  (if (search-forward "-*-" end t)
1538                      (setq end (- (point) 3))
1539                    (error "-*- not terminated before end of line")))
1540                (while (< (point) end)
1541                  (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1542                      (error "malformed -*- line"))
1543                  (goto-char (match-end 0))
1544                  ;; There used to be a downcase here,
1545                  ;; but the manual didn't say so,
1546                  ;; and people want to set var names that aren't all lc.
1547                  (let ((key (intern (buffer-substring
1548                                      (match-beginning 1)
1549                                      (match-end 1))))
1550                        (val (save-restriction
1551                               (narrow-to-region (point) end)
1552                               (read (current-buffer)))))
1553                    ;; Case sensitivity!  Icepicks in my forehead!
1554                    (if (equal (downcase (symbol-name key)) "mode")
1555                        (setq key 'mode))
1556                    (setq result (cons (cons key val) result))
1557                    (skip-chars-forward " \t;")))
1558                (setq result (nreverse result))))))
1559
1560     (let ((set-any-p (or force
1561                          ;; It's OK to force null specifications.
1562                          (null result)
1563                          ;; It's OK to force mode-only specifications.
1564                          (let ((remaining result)
1565                                (mode-specs-only t))
1566                            (while remaining
1567                              (if (eq (car (car remaining)) 'mode)
1568                                  (setq remaining (cdr remaining))
1569                                ;; Otherwise, we have a real local.
1570                                (setq mode-specs-only nil
1571                                      remaining nil))
1572                              )
1573                            mode-specs-only)
1574                          ;; Otherwise, check.
1575                          (hack-local-variables-p t)))
1576           (mode-p nil))
1577       (while result
1578         (let ((key (car (car result)))
1579               (val (cdr (car result))))
1580           (cond ((eq key 'mode)
1581                  (setq mode-p t)
1582                  (let ((mode (intern (concat (downcase (symbol-name val))
1583                                              "-mode"))))
1584                    ;; Without this guard, `normal-mode' would potentially run
1585                    ;; the major mode function twice: once via `set-auto-mode'
1586                    ;; and once via `hack-local-variables'.
1587                    (if (not (eq mode major-mode))
1588                        (funcall mode))
1589                    ))
1590                 (set-any-p
1591                  (hack-one-local-variable key val))
1592                 (t
1593                  nil)))
1594         (setq result (cdr result)))
1595       mode-p)))
1596
1597 (defconst ignored-local-variables
1598   (list 'enable-local-eval)
1599   "Variables to be ignored in a file's local variable spec.")
1600
1601 ;; Get confirmation before setting these variables as locals in a file.
1602 (put 'debugger 'risky-local-variable t)
1603 (put 'enable-local-eval 'risky-local-variable t)
1604 (put 'ignored-local-variables 'risky-local-variable t)
1605 (put 'eval 'risky-local-variable t)
1606 (put 'file-name-handler-alist 'risky-local-variable t)
1607 (put 'minor-mode-map-alist 'risky-local-variable t)
1608 (put 'after-load-alist 'risky-local-variable t)
1609 (put 'buffer-file-name 'risky-local-variable t)
1610 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1611 (put 'buffer-file-truename 'risky-local-variable t)
1612 (put 'exec-path 'risky-local-variable t)
1613 (put 'load-path 'risky-local-variable t)
1614 (put 'exec-directory 'risky-local-variable t)
1615 (put 'process-environment 'risky-local-variable t)
1616 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1617 (put 'outline-level 'risky-local-variable t)
1618 (put 'rmail-output-file-alist 'risky-local-variable t)
1619
1620 ;; This one is safe because the user gets to check it before it is used.
1621 (put 'compile-command 'safe-local-variable t)
1622
1623 ;(defun hack-one-local-variable-quotep (exp)
1624 ;  (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1625
1626 ;; "Set" one variable in a local variables spec.
1627 ;; A few variable names are treated specially.
1628 (defun hack-one-local-variable (var val)
1629   (cond ((eq var 'mode)
1630          (funcall (intern (concat (downcase (symbol-name val))
1631                                   "-mode"))))
1632         ((memq var ignored-local-variables)
1633          nil)
1634         ;; "Setting" eval means either eval it or do nothing.
1635         ;; Likewise for setting hook variables.
1636         ((or (get var 'risky-local-variable)
1637              (and
1638               (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1639                             (symbol-name var))
1640               (not (get var 'safe-local-variable))))
1641 ;        ;; Permit evaling a put of a harmless property
1642 ;        ;; if the args do nothing tricky.
1643 ;        (if (or (and (eq var 'eval)
1644 ;                     (consp val)
1645 ;                     (eq (car val) 'put)
1646 ;                     (hack-one-local-variable-quotep (nth 1 val))
1647 ;                     (hack-one-local-variable-quotep (nth 2 val))
1648 ;                     ;; Only allow safe values of lisp-indent-hook;
1649 ;                     ;; not functions.
1650 ;                     (or (numberp (nth 3 val))
1651 ;                         (equal (nth 3 val) ''defun))
1652 ;                     (memq (nth 1 (nth 2 val))
1653 ;                           '(lisp-indent-hook)))
1654          (if (and (not (zerop (user-uid)))
1655                   (or (eq enable-local-eval t)
1656                       (and enable-local-eval
1657                            (save-window-excursion
1658                              (switch-to-buffer (current-buffer))
1659                              (save-excursion
1660                                (beginning-of-line)
1661                                (set-window-start (selected-window) (point)))
1662                              (setq enable-local-eval
1663                                    (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1664                                                      (file-name-nondirectory buffer-file-name))))))))
1665              (if (eq var 'eval)
1666                  (save-excursion (eval val))
1667                (make-local-variable var)
1668                (set var val))
1669            (message "Ignoring `eval:' in file's local variables")))
1670         ;; Ordinary variable, really set it.
1671         (t (make-local-variable var)
1672            (set var val))))
1673 \f
1674 (defcustom change-major-mode-with-file-name t
1675   "*Non-nil means \\[write-file] should set the major mode from the file name.
1676 However, the mode will not be changed if
1677 \(1) a local variables list or the `-*-' line specifies a major mode, or
1678 \(2) the current major mode is a \"special\" mode,
1679 \    not suitable for ordinary files, or
1680 \(3) the new file name does not particularly specify any mode."
1681   :type 'boolean
1682   :group 'editing-basics)
1683
1684 (defun set-visited-file-name (filename &optional no-query along-with-file)
1685   "Change name of file visited in current buffer to FILENAME.
1686 The next time the buffer is saved it will go in the newly specified file.
1687 nil or empty string as argument means make buffer not be visiting any file.
1688 Remember to delete the initial contents of the minibuffer
1689 if you wish to pass an empty string as the argument.
1690
1691 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1692 confirmation in the case where another buffer is already visiting FILENAME.
1693
1694 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1695 the old visited file has been renamed to the new name FILENAME."
1696   (interactive "FSet visited file name: ")
1697   (if (buffer-base-buffer)
1698       (error "An indirect buffer cannot visit a file"))
1699   (let (truename)
1700     (if filename
1701         (setq filename
1702               (if (string-equal filename "")
1703                   nil
1704                 (expand-file-name filename))))
1705     (if filename
1706         (progn
1707           (setq truename (file-truename filename))
1708           ;; #### Do we need to check if truename is non-nil?
1709           (if find-file-use-truenames
1710               (setq filename truename))))
1711     (let ((buffer (and filename (find-buffer-visiting filename))))
1712       (and buffer (not (eq buffer (current-buffer)))
1713            (not no-query)
1714            (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1715                                    filename)))
1716            (error "Aborted")))
1717     (or (equal filename buffer-file-name)
1718         (progn
1719           (and filename (lock-buffer filename))
1720           (unlock-buffer)))
1721     (setq buffer-file-name filename)
1722     (if filename                        ; make buffer name reflect filename.
1723         (let ((new-name (file-name-nondirectory buffer-file-name)))
1724           (if (string= new-name "")
1725               (error "Empty file name"))
1726           (if (eq system-type 'vax-vms)
1727               (setq new-name (downcase new-name)))
1728           (setq default-directory (file-name-directory buffer-file-name))
1729           (or (string= new-name (buffer-name))
1730               (rename-buffer new-name t))))
1731     (setq buffer-backed-up nil)
1732     (or along-with-file
1733         (clear-visited-file-modtime))
1734     (compute-buffer-file-truename) ; insert-file-contents does this too.
1735 ;    ;; Abbreviate the file names of the buffer.
1736 ;    (if truename
1737 ;        (progn
1738 ;          (setq buffer-file-truename (abbreviate-file-name truename))
1739 ;          (if find-file-visit-truename
1740 ;              (setq buffer-file-name buffer-file-truename))))
1741     (setq buffer-file-number
1742           (if filename
1743               (nthcdr 10 (file-attributes buffer-file-name))
1744               nil)))
1745   ;; write-file-hooks is normally used for things like ftp-find-file
1746   ;; that visit things that are not local files as if they were files.
1747   ;; Changing to visit an ordinary local file instead should flush the hook.
1748   (kill-local-variable 'write-file-hooks)
1749   (kill-local-variable 'after-save-hook)
1750   (kill-local-variable 'local-write-file-hooks)
1751   (kill-local-variable 'write-file-data-hooks)
1752   (kill-local-variable 'revert-buffer-function)
1753   (kill-local-variable 'backup-inhibited)
1754   ;; If buffer was read-only because of version control,
1755   ;; that reason is gone now, so make it writable.
1756   (when (boundp 'vc-mode)
1757     (if vc-mode
1758         (setq buffer-read-only nil))
1759     (kill-local-variable 'vc-mode))
1760   ;; Turn off backup files for certain file names.
1761   ;; Since this is a permanent local, the major mode won't eliminate it.
1762   (and buffer-file-name
1763        (not (funcall backup-enable-predicate buffer-file-name))
1764        (progn
1765          (make-local-variable 'backup-inhibited)
1766          (setq backup-inhibited t)))
1767   (let ((oauto buffer-auto-save-file-name))
1768     ;; If auto-save was not already on, turn it on if appropriate.
1769     (if (not buffer-auto-save-file-name)
1770         (and buffer-file-name auto-save-default
1771              (auto-save-mode t))
1772       ;; If auto save is on, start using a new name.
1773       ;; We deliberately don't rename or delete the old auto save
1774       ;; for the old visited file name.  This is because perhaps
1775       ;; the user wants to save the new state and then compare with the
1776       ;; previous state from the auto save file.
1777       (setq buffer-auto-save-file-name
1778             (make-auto-save-file-name)))
1779     ;; Rename the old auto save file if any.
1780     (and oauto buffer-auto-save-file-name
1781          (file-exists-p oauto)
1782          (rename-file oauto buffer-auto-save-file-name t)))
1783   (if buffer-file-name
1784       (not along-with-file)
1785       (set-buffer-modified-p t))
1786   ;; Update the major mode, if the file name determines it.
1787   (condition-case nil
1788       ;; Don't change the mode if it is special.
1789       (or (not change-major-mode-with-file-name)
1790           (get major-mode 'mode-class)
1791           ;; Don't change the mode if the local variable list specifies it.
1792           (hack-local-variables t)
1793           (set-auto-mode t))
1794     (error nil))
1795   ;; #### ??
1796   (run-hooks 'after-set-visited-file-name-hooks))
1797
1798 (defun write-file (filename &optional confirm codesys)
1799   "Write current buffer into file FILENAME.
1800 Makes buffer visit that file, and marks it not modified.
1801 If the buffer is already visiting a file, you can specify
1802 a directory name as FILENAME, to write a file of the same
1803 old name in that directory.
1804 If optional second arg CONFIRM is non-nil,
1805 ask for confirmation for overwriting an existing file.
1806 Under XEmacs/Mule, optional third argument specifies the
1807 coding system to use when encoding the file.  Interactively,
1808 with a prefix argument, you will be prompted for the coding system."
1809 ;;  (interactive "FWrite file: ")
1810   (interactive
1811    (list (if buffer-file-name
1812              (read-file-name "Write file: "
1813                                  nil nil nil nil)
1814            (read-file-name "Write file: "
1815                                (cdr (assq 'default-directory
1816                                           (buffer-local-variables)))
1817                                nil nil (buffer-name)))
1818          t
1819          (if (and current-prefix-arg (featurep 'mule))
1820              (read-coding-system "Coding system: "))))
1821   (and (eq (current-buffer) mouse-grabbed-buffer)
1822        (error "Can't write minibuffer window"))
1823   (or (null filename) (string-equal filename "")
1824       (progn
1825         ;; If arg is just a directory,
1826         ;; use same file name, but in that directory.
1827         (if (and (file-directory-p filename) buffer-file-name)
1828             (setq filename (concat (file-name-as-directory filename)
1829                                    (file-name-nondirectory buffer-file-name))))
1830         (and confirm
1831              (file-exists-p filename)
1832              (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1833                  (error "Canceled")))
1834         (set-visited-file-name filename)))
1835   (set-buffer-modified-p t)
1836   (setq buffer-read-only nil)
1837   (if codesys
1838       (let ((buffer-file-coding-system (get-coding-system codesys)))
1839         (save-buffer))
1840     (save-buffer)))
1841 \f
1842 (defun backup-buffer ()
1843   "Make a backup of the disk file visited by the current buffer, if appropriate.
1844 This is normally done before saving the buffer the first time.
1845 If the value is non-nil, it is the result of `file-modes' on the original file;
1846 this means that the caller, after saving the buffer, should change the modes
1847 of the new file to agree with the old modes."
1848   (if buffer-file-name
1849       (let ((handler (find-file-name-handler buffer-file-name 'backup-buffer)))
1850         (if handler
1851             (funcall handler 'backup-buffer)
1852           (if (and make-backup-files
1853                    (not backup-inhibited)
1854                    (not buffer-backed-up)
1855                    (file-exists-p buffer-file-name)
1856                    (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1857                          '(?- ?l)))
1858               (let ((real-file-name buffer-file-name)
1859                     backup-info backupname targets setmodes)
1860                 ;; If specified name is a symbolic link, chase it to the target.
1861                 ;; Thus we make the backups in the directory where the real file is.
1862                 (setq real-file-name (file-chase-links real-file-name))
1863                 (setq backup-info (find-backup-file-name real-file-name)
1864                       backupname (car backup-info)
1865                       targets (cdr backup-info))
1866 ;;;     (if (file-directory-p buffer-file-name)
1867 ;;;         (error "Cannot save buffer in directory %s" buffer-file-name))
1868                 (if backup-info
1869                     (condition-case ()
1870                         (let ((delete-old-versions
1871                                ;; If have old versions to maybe delete,
1872                                ;; ask the user to confirm now, before doing anything.
1873                                ;; But don't actually delete til later.
1874                                (and targets
1875                                     (or (eq delete-old-versions t)
1876                                         (eq delete-old-versions nil))
1877                                     (or delete-old-versions
1878                                         (y-or-n-p (format "Delete excess backup versions of %s? "
1879                                                           real-file-name))))))
1880                           ;; Actually write the back up file.
1881                           (condition-case ()
1882                               (if (or file-precious-flag
1883                                         ;                         (file-symlink-p buffer-file-name)
1884                                       backup-by-copying
1885                                       (and backup-by-copying-when-linked
1886                                            (> (file-nlinks real-file-name) 1))
1887                                       (and backup-by-copying-when-mismatch
1888                                            (let ((attr (file-attributes real-file-name)))
1889                                              (or (nth 9 attr)
1890                                                  (not (file-ownership-preserved-p real-file-name))))))
1891                                   (condition-case ()
1892                                       (copy-file real-file-name backupname t t)
1893                                     (file-error
1894                                      ;; If copying fails because file BACKUPNAME
1895                                      ;; is not writable, delete that file and try again.
1896                                      (if (and (file-exists-p backupname)
1897                                               (not (file-writable-p backupname)))
1898                                          (delete-file backupname))
1899                                      (copy-file real-file-name backupname t t)))
1900                                 ;; rename-file should delete old backup.
1901                                 (rename-file real-file-name backupname t)
1902                                 (setq setmodes (file-modes backupname)))
1903                             (file-error
1904                              ;; If trouble writing the backup, write it in ~.
1905                              (setq backupname (expand-file-name "~/%backup%~"))
1906                              (message "Cannot write backup file; backing up in ~/%%backup%%~")
1907                              (sleep-for 1)
1908                              (condition-case ()
1909                                  (copy-file real-file-name backupname t t)
1910                                (file-error
1911                                 ;; If copying fails because file BACKUPNAME
1912                                 ;; is not writable, delete that file and try again.
1913                                 (if (and (file-exists-p backupname)
1914                                          (not (file-writable-p backupname)))
1915                                     (delete-file backupname))
1916                                 (copy-file real-file-name backupname t t)))))
1917                           (setq buffer-backed-up t)
1918                           ;; Now delete the old versions, if desired.
1919                           (if delete-old-versions
1920                               (while targets
1921                                 (condition-case ()
1922                                     (delete-file (car targets))
1923                                   (file-error nil))
1924                                 (setq targets (cdr targets))))
1925                           setmodes)
1926                       (file-error nil)))))))))
1927
1928 (defun file-name-sans-versions (name &optional keep-backup-version)
1929   "Return FILENAME sans backup versions or strings.
1930 This is a separate procedure so your site-init or startup file can
1931 redefine it.
1932 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1933 we do not remove backup version numbers, only true file version numbers."
1934   (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1935     (if handler
1936         (funcall handler 'file-name-sans-versions name keep-backup-version)
1937       (substring name 0
1938                  (if (eq system-type 'vax-vms)
1939                      ;; VMS version number is (a) semicolon, optional
1940                      ;; sign, zero or more digits or (b) period, option
1941                      ;; sign, zero or more digits, provided this is the
1942                      ;; second period encountered outside of the
1943                      ;; device/directory part of the file name.
1944                      (or (string-match ";[-+]?[0-9]*\\'" name)
1945                          (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
1946                                            name)
1947                              (match-beginning 1))
1948                          (length name))
1949                    (if keep-backup-version
1950                        (length name)
1951                      (or (string-match "\\.~[0-9.]+~\\'" name)
1952                          ;; XEmacs - VC uses extensions like ".~tagname~" or ".~1.1.5.2~"
1953                          (let ((pos (string-match "\\.~\\([^.~ \t]+\\|[0-9.]+\\)~\\'" name)))
1954                            (and pos
1955                                 ;; #### - is this filesystem check too paranoid?
1956                                 (file-exists-p (substring name 0 pos))
1957                                 pos))
1958                          (string-match "~\\'" name)
1959                          (length name))))))))
1960
1961 (defun file-ownership-preserved-p (file)
1962   "Return t if deleting FILE and rewriting it would preserve the owner."
1963   (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1964     (if handler
1965         (funcall handler 'file-ownership-preserved-p file)
1966       (let ((attributes (file-attributes file)))
1967         ;; Return t if the file doesn't exist, since it's true that no
1968         ;; information would be lost by an (attempted) delete and create.
1969         (or (null attributes)
1970             (= (nth 2 attributes) (user-uid)))))))
1971
1972 (defun file-name-sans-extension (filename)
1973   "Return FILENAME sans final \"extension\".
1974 The extension, in a file name, is the part that follows the last `.'."
1975   (save-match-data
1976     (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1977           directory)
1978       (if (string-match "\\.[^.]*\\'" file)
1979           (if (setq directory (file-name-directory filename))
1980               (expand-file-name (substring file 0 (match-beginning 0))
1981                                 directory)
1982             (substring file 0 (match-beginning 0)))
1983         filename))))
1984
1985 (defun file-name-extension (filename &optional period)
1986   "Return FILENAME's final \"extension\".
1987 The extension, in a file name, is the part that follows the last `.'.
1988 Return nil for extensionless file names such as `foo'.
1989 Return the empty string for file names such as `foo.'.
1990
1991 If PERIOD is non-nil, then the returned value includes the period
1992 that delimits the extension, and if FILENAME has no extension,
1993 the value is \"\"."
1994   (save-match-data
1995     (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1996       (if (string-match "\\.[^.]*\\'" file)
1997           (substring file (+ (match-beginning 0) (if period 0 1)))
1998         (if period
1999             "")))))
2000
2001 (defun make-backup-file-name (file)
2002   "Create the non-numeric backup file name for FILE.
2003 This is a separate function so you can redefine it for customization."
2004   (if (eq system-type 'ms-dos)
2005       (let ((fn (file-name-nondirectory file)))
2006         (concat (file-name-directory file)
2007                 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
2008                     (substring fn 0 (match-end 1)))
2009                 ".bak"))
2010     (concat file "~")))
2011
2012 (defun backup-file-name-p (file)
2013   "Return non-nil if FILE is a backup file name (numeric or not).
2014 This is a separate function so you can redefine it for customization.
2015 You may need to redefine `file-name-sans-versions' as well."
2016   (if (eq system-type 'ms-dos)
2017       (string-match "\\.bak\\'" file)
2018       (string-match "~\\'" file)))
2019
2020 ;; This is used in various files.
2021 ;; The usage of bv-length is not very clean,
2022 ;; but I can't see a good alternative,
2023 ;; so as of now I am leaving it alone.
2024 (defun backup-extract-version (fn)
2025   "Given the name of a numeric backup file, return the backup number.
2026 Uses the free variable `bv-length', whose value should be
2027 the index in the name where the version number begins."
2028   (declare (special bv-length))
2029   (if (and (string-match "[0-9]+~\\'" fn bv-length)
2030            (= (match-beginning 0) bv-length))
2031       (string-to-int (substring fn bv-length -1))
2032       0))
2033
2034 ;; I believe there is no need to alter this behavior for VMS;
2035 ;; since backup files are not made on VMS, it should not get called.
2036 (defun find-backup-file-name (fn)
2037   "Find a file name for a backup file, and suggestions for deletions.
2038 Value is a list whose car is the name for the backup file
2039  and whose cdr is a list of old versions to consider deleting now.
2040 If the value is nil, don't make a backup."
2041   (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2042     ;; Run a handler for this function so that ange-ftp can refuse to do it.
2043     (if handler
2044         (funcall handler 'find-backup-file-name fn)
2045       (if (eq version-control 'never)
2046           (list (make-backup-file-name fn))
2047         (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
2048                ;; used by backup-extract-version:
2049                (bv-length (length base-versions))
2050                possibilities
2051                (versions nil)
2052                (high-water-mark 0)
2053                (deserve-versions-p nil)
2054                (number-to-delete 0))
2055           (condition-case ()
2056               (setq possibilities (file-name-all-completions
2057                                    base-versions
2058                                    (file-name-directory fn))
2059                     versions (sort (mapcar
2060                                     #'backup-extract-version
2061                                     possibilities)
2062                                    '<)
2063                     high-water-mark (apply #'max 0 versions)
2064                     deserve-versions-p (or version-control
2065                                            (> high-water-mark 0))
2066                     number-to-delete (- (length versions)
2067                                         kept-old-versions kept-new-versions -1))
2068             (file-error
2069              (setq possibilities nil)))
2070           (if (not deserve-versions-p)
2071               (list (make-backup-file-name fn))
2072             (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2073                   (if (and (> number-to-delete 0)
2074                            ;; Delete nothing if there is overflow
2075                            ;; in the number of versions to keep.
2076                            (>= (+ kept-new-versions kept-old-versions -1) 0))
2077                       (mapcar #'(lambda (n)
2078                                   (concat fn ".~" (int-to-string n) "~"))
2079                               (let ((v (nthcdr kept-old-versions versions)))
2080                                 (rplacd (nthcdr (1- number-to-delete) v) ())
2081                                 v))))))))))
2082
2083 (defun file-nlinks (filename)
2084   "Return number of names file FILENAME has."
2085   (car (cdr (file-attributes filename))))
2086
2087 (defun file-relative-name (filename &optional directory)
2088   "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2089 This function returns a relative file name which is equivalent to FILENAME
2090 when used with that default directory as the default.
2091 If this is impossible (which can happen on MSDOS and Windows
2092 when the file name and directory use different drive names)
2093 then it returns FILENAME."
2094   (save-match-data
2095     (let ((fname (expand-file-name filename)))
2096       (setq directory (file-name-as-directory
2097                        (expand-file-name (or directory default-directory))))
2098       ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2099       ;; drive names, they can't be relative, so return the absolute name.
2100       (if (and (or (eq system-type 'ms-dos)
2101                    (eq system-type 'windows-nt))
2102                (not (string-equal (substring fname  0 2)
2103                                   (substring directory 0 2))))
2104           filename
2105         (let ((ancestor ".")
2106               (fname-dir (file-name-as-directory fname)))
2107           (while (and (not (string-match (concat "^" (regexp-quote directory))
2108                                          fname-dir))
2109                       (not (string-match (concat "^" (regexp-quote directory)) fname)))
2110             (setq directory (file-name-directory (substring directory 0 -1))
2111                   ancestor (if (equal ancestor ".")
2112                                ".."
2113                              (concat "../" ancestor))))
2114           ;; Now ancestor is empty, or .., or ../.., etc.
2115           (if (string-match (concat "^" (regexp-quote directory)) fname)
2116               ;; We matched within FNAME's directory part.
2117               ;; Add the rest of FNAME onto ANCESTOR.
2118               (let ((rest (substring fname (match-end 0))))
2119                 (if (and (equal ancestor ".")
2120                          (not (equal rest "")))
2121                     ;; But don't bother with ANCESTOR if it would give us `./'.
2122                     rest
2123                   (concat (file-name-as-directory ancestor) rest)))
2124             ;; We matched FNAME's directory equivalent.
2125             ancestor))))))
2126 \f
2127 (defun save-buffer (&optional args)
2128   "Save current buffer in visited file if modified.  Versions described below.
2129
2130 By default, makes the previous version into a backup file
2131  if previously requested or if this is the first save.
2132 With 1 or 3 \\[universal-argument]'s, marks this version
2133  to become a backup when the next save is done.
2134 With 2 or 3 \\[universal-argument]'s,
2135  unconditionally makes the previous version into a backup file.
2136 With argument of 0, never makes the previous version into a backup file.
2137
2138 If a file's name is FOO, the names of its numbered backup versions are
2139  FOO.~i~ for various integers i.  A non-numbered backup file is called FOO~.
2140 Numeric backups (rather than FOO~) will be made if value of
2141  `version-control' is not the atom `never' and either there are already
2142  numeric versions of the file being backed up, or `version-control' is
2143  non-nil.
2144 We don't want excessive versions piling up, so there are variables
2145  `kept-old-versions', which tells XEmacs how many oldest versions to keep,
2146  and `kept-new-versions', which tells how many newest versions to keep.
2147  Defaults are 2 old versions and 2 new.
2148 `dired-kept-versions' controls dired's clean-directory (.) command.
2149 If `delete-old-versions' is nil, system will query user
2150  before trimming versions.  Otherwise it does it silently."
2151   (interactive "_p")
2152   (let ((modp (buffer-modified-p))
2153         (large (> (buffer-size) 50000))
2154         (make-backup-files (or (and make-backup-files (not (eq args 0)))
2155                                (memq args '(16 64)))))
2156     (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2157     (if (and modp large) (display-message
2158                           'progress (format "Saving file %s..."
2159                                             (buffer-file-name))))
2160     (basic-save-buffer)
2161     (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2162
2163 (defun delete-auto-save-file-if-necessary (&optional force)
2164   "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2165 Normally delete only if the file was written by this XEmacs
2166 since the last real save, but optional arg FORCE non-nil means delete anyway."
2167   (and buffer-auto-save-file-name delete-auto-save-files
2168        (not (string= buffer-file-name buffer-auto-save-file-name))
2169        (or force (recent-auto-save-p))
2170        (progn
2171          (condition-case ()
2172              (delete-file buffer-auto-save-file-name)
2173            (file-error nil))
2174          (set-buffer-auto-saved))))
2175
2176 ;; XEmacs change (from Sun)
2177 ;; used to communicate with continue-save-buffer:
2178 (defvar continue-save-buffer-hooks-tail nil)
2179
2180 ;; Not in FSFmacs
2181 (defun basic-write-file-data (realname truename)
2182   ;; call the hooks until the bytes are put
2183   ;; call write-region as a last resort
2184   (let ((region-written nil)
2185         (hooks write-file-data-hooks))
2186     (while (and hooks (not region-written))
2187       (setq region-written (funcall (car hooks) realname)
2188             hooks (cdr hooks)))
2189     (if (not region-written)
2190         (write-region (point-min) (point-max) realname nil t truename))))
2191
2192 (put 'after-save-hook 'permanent-local t)
2193 (defvar after-save-hook nil
2194   "Normal hook that is run after a buffer is saved to its file.
2195 These hooks are considered to pertain to the visited file.
2196 So this list is cleared if you change the visited file name.")
2197
2198 (defun files-fetch-hook-value (hook)
2199   (let ((localval (symbol-value hook))
2200         (globalval (default-value hook)))
2201     (if (memq t localval)
2202         (setq localval (append (delq t localval) (delq t globalval))))
2203     localval))
2204
2205 (defun basic-save-buffer ()
2206   "Save the current buffer in its visited file, if it has been modified.
2207 After saving the buffer, run `after-save-hook'."
2208   (interactive)
2209   (save-excursion
2210     ;; In an indirect buffer, save its base buffer instead.
2211     (if (buffer-base-buffer)
2212         (set-buffer (buffer-base-buffer)))
2213     (if (buffer-modified-p)
2214         (let ((recent-save (recent-auto-save-p)))
2215           ;; On VMS, rename file and buffer to get rid of version number.
2216           (if (and (eq system-type 'vax-vms)
2217                    (not (string= buffer-file-name
2218                                  (file-name-sans-versions buffer-file-name))))
2219               (let (buffer-new-name)
2220                 ;; Strip VMS version number before save.
2221                 (setq buffer-file-name
2222                       (file-name-sans-versions buffer-file-name))
2223                 ;; Construct a (unique) buffer name to correspond.
2224                 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2225                   (setq buffer-new-name (buffer-name buf))
2226                   (kill-buffer buf))
2227                 (rename-buffer buffer-new-name)))
2228           ;; If buffer has no file name, ask user for one.
2229           (or buffer-file-name
2230               (let ((filename
2231                      (expand-file-name
2232                       (read-file-name "File to save in: ") nil)))
2233                 (and (file-exists-p filename)
2234                      (or (y-or-n-p (format "File `%s' exists; overwrite? "
2235                                            filename))
2236                          (error "Canceled")))
2237                 (set-visited-file-name filename)))
2238           (or (verify-visited-file-modtime (current-buffer))
2239               (not (file-exists-p buffer-file-name))
2240               (yes-or-no-p
2241                (format "%s has changed since visited or saved.  Save anyway? "
2242                        (file-name-nondirectory buffer-file-name)))
2243               (error "Save not confirmed"))
2244           (save-restriction
2245             (widen)
2246             (and (> (point-max) 1)
2247                  (/= (char-after (1- (point-max))) ?\n)
2248                  (not (and (eq selective-display t)
2249                            (= (char-after (1- (point-max))) ?\r)))
2250                  (or (eq require-final-newline t)
2251                      (and require-final-newline
2252                           (y-or-n-p
2253                            (format "Buffer %s does not end in newline.  Add one? "
2254                                    (buffer-name)))))
2255                  (save-excursion
2256                    (goto-char (point-max))
2257                    (insert ?\n)))
2258             ;;
2259             ;; Run the write-file-hooks until one returns non-null.
2260             ;; Bind after-save-hook to nil while running the
2261             ;; write-file-hooks so that if this function is called
2262             ;; recursively (from inside a write-file-hook) the
2263             ;; after-hooks will only get run once (from the
2264             ;; outermost call).
2265             ;;
2266             ;; Ugh, have to duplicate logic of run-hook-with-args-until-success
2267             (let ((hooks (append (files-fetch-hook-value 'write-contents-hooks)
2268                                  (files-fetch-hook-value
2269                                   'local-write-file-hooks)
2270                                  (files-fetch-hook-value 'write-file-hooks)))
2271                   (after-save-hook nil)
2272                   (local-write-file-hooks nil)
2273                   (write-contents-hooks nil)
2274                   (write-file-hooks nil)
2275                   done)
2276               (while (and hooks
2277                           (let ((continue-save-buffer-hooks-tail hooks))
2278                             (not (setq done (funcall (car hooks))))))
2279                 (setq hooks (cdr hooks)))
2280               ;; If a hook returned t, file is already "written".
2281               ;; Otherwise, write it the usual way now.
2282               (if (not done)
2283                   (basic-save-buffer-1)))
2284             ;; XEmacs: next two clauses (buffer-file-number setting and
2285             ;; set-file-modes) moved into basic-save-buffer-1.
2286             )
2287           ;; If the auto-save file was recent before this command,
2288           ;; delete it now.
2289           (delete-auto-save-file-if-necessary recent-save)
2290           ;; Support VC `implicit' locking.
2291           (when (fboundp 'vc-after-save)
2292             (vc-after-save))
2293           (run-hooks 'after-save-hook))
2294       (display-message 'no-log "(No changes need to be saved)"))))
2295
2296 ;; This does the "real job" of writing a buffer into its visited file
2297 ;; and making a backup file.  This is what is normally done
2298 ;; but inhibited if one of write-file-hooks returns non-nil.
2299 ;; It returns a value to store in setmodes.
2300 (defun basic-save-buffer-1 ()
2301   (let (setmodes tempsetmodes)
2302     (if (not (file-writable-p buffer-file-name))
2303         (let ((dir (file-name-directory buffer-file-name)))
2304           (if (not (file-directory-p dir))
2305               (error "%s is not a directory" dir)
2306             (if (not (file-exists-p buffer-file-name))
2307                 (error "Directory %s write-protected" dir)
2308               (if (yes-or-no-p
2309                    (format "File %s is write-protected; try to save anyway? "
2310                            (file-name-nondirectory
2311                             buffer-file-name)))
2312                   (setq tempsetmodes t)
2313                 (error
2314                  "Attempt to save to a file which you aren't allowed to write"))))))
2315     (or buffer-backed-up
2316         (setq setmodes (backup-buffer)))
2317     (let ((dir (file-name-directory buffer-file-name)))
2318       (if (and file-precious-flag
2319                (file-writable-p dir))
2320           ;; If file is precious, write temp name, then rename it.
2321           ;; This requires write access to the containing dir,
2322           ;; which is why we don't try it if we don't have that access.
2323           (let ((realname buffer-file-name)
2324                 tempname nogood i succeed
2325                 (old-modtime (visited-file-modtime)))
2326             (setq i 0)
2327             (setq nogood t)
2328             ;; Find the temporary name to write under.
2329             (while nogood
2330               (setq tempname (format "%s#tmp#%d" dir i))
2331               (setq nogood (file-exists-p tempname))
2332               (setq i (1+ i)))
2333             (unwind-protect
2334                 (progn (clear-visited-file-modtime)
2335                        (write-region (point-min) (point-max)
2336                                      tempname nil realname
2337                                      buffer-file-truename)
2338                        (setq succeed t))
2339               ;; If writing the temp file fails,
2340               ;; delete the temp file.
2341               (or succeed
2342                   (progn
2343                     (delete-file tempname)
2344                     (set-visited-file-modtime old-modtime))))
2345             ;; Since we have created an entirely new file
2346             ;; and renamed it, make sure it gets the
2347             ;; right permission bits set.
2348             (setq setmodes (file-modes buffer-file-name))
2349             ;; We succeeded in writing the temp file,
2350             ;; so rename it.
2351             (rename-file tempname buffer-file-name t))
2352         ;; If file not writable, see if we can make it writable
2353         ;; temporarily while we write it.
2354         ;; But no need to do so if we have just backed it up
2355         ;; (setmodes is set) because that says we're superseding.
2356         (cond ((and tempsetmodes (not setmodes))
2357                ;; Change the mode back, after writing.
2358                (setq setmodes (file-modes buffer-file-name))
2359                (set-file-modes buffer-file-name 511)))
2360         (basic-write-file-data buffer-file-name buffer-file-truename)))
2361     (setq buffer-file-number
2362           (if buffer-file-name
2363               (nth 10 (file-attributes buffer-file-name))
2364             nil))
2365     (if setmodes
2366         (condition-case ()
2367             (set-file-modes buffer-file-name setmodes)
2368           (error nil)))))
2369
2370 ;; XEmacs change, from Sun
2371 (defun continue-save-buffer ()
2372   "Provide a clean way for a write-file-hook to wrap AROUND
2373 the execution of the remaining hooks and writing to disk.
2374 Do not call this function except from a functions
2375 on the write-file-hooks or write-contents-hooks list.
2376 A hook that calls this function must return non-nil,
2377 to signal completion to its caller.  continue-save-buffer
2378 always returns non-nil."
2379   (let ((hooks (cdr (or continue-save-buffer-hooks-tail
2380                         (error
2381          "continue-save-buffer called outside a write-file-hook!"))))
2382         (done nil))
2383     ;; Do something like this:
2384     ;; (let ((write-file-hooks hooks)) (basic-save-buffer))
2385     ;; First run the rest of the hooks.
2386     (while (and hooks
2387                 (let ((continue-save-buffer-hooks-tail hooks))
2388                   (not (setq done (funcall (car hooks))))))
2389       (setq hooks (cdr hooks)))
2390     ;;
2391     ;; If a hook returned t, file is already "written".
2392     (if (not done)
2393         (basic-save-buffer-1))
2394     'continue-save-buffer))
2395
2396 (defcustom save-some-buffers-query-display-buffer t
2397   "*Non-nil makes `\\[save-some-buffers]' switch to the buffer offered for saving."
2398   :type 'boolean
2399   :group 'editing-basics)
2400
2401 (defun save-some-buffers (&optional arg exiting)
2402   "Save some modified file-visiting buffers.  Asks user about each one.
2403 Optional argument (the prefix) non-nil means save all with no questions.
2404 Optional second argument EXITING means ask about certain non-file buffers
2405  as well as about file buffers."
2406   (interactive "P")
2407   (save-excursion
2408     ;; `delete-other-windows' can bomb during autoloads generation, so
2409     ;; guard it well.
2410     (if (or noninteractive
2411             (eq (selected-window) (minibuffer-window))
2412             (not save-some-buffers-query-display-buffer))
2413         ;; If playing with windows is unsafe or undesired, just do the
2414         ;; usual drill.
2415         (save-some-buffers-1 arg exiting nil)
2416       ;; Else, protect the windows.
2417       (when (save-window-excursion
2418               (save-some-buffers-1 arg exiting t))
2419         ;; Force redisplay.
2420         (sit-for 0)))))
2421
2422 ;; XEmacs - do not use queried flag
2423 (defun save-some-buffers-1 (arg exiting switch-buffer)
2424   (let* ((switched nil)
2425          (files-done
2426           (map-y-or-n-p
2427            (lambda (buffer)
2428              (and (buffer-modified-p buffer)
2429                   (not (buffer-base-buffer buffer))
2430                   ;; XEmacs addition:
2431                   (not (symbol-value-in-buffer 'save-buffers-skip buffer))
2432                   (or
2433                    (buffer-file-name buffer)
2434                    (and exiting
2435                         (progn
2436                           (set-buffer buffer)
2437                           (and buffer-offer-save (> (buffer-size) 0)))))
2438                   (if arg
2439                       t
2440                     ;; #### We should provide a per-buffer means to
2441                     ;; disable the switching.  For instance, you might
2442                     ;; want to turn it off for buffers the contents of
2443                     ;; which is meaningless to humans, such as
2444                     ;; `.newsrc.eld'.
2445                     (when switch-buffer
2446                       (unless (one-window-p)
2447                         (delete-other-windows))
2448                       (setq switched t)
2449                       ;; #### Consider using `display-buffer' here for 21.1!
2450                       ;;(display-buffer buffer nil (selected-frame)))
2451                       (switch-to-buffer buffer t))
2452                     (if (buffer-file-name buffer)
2453                         (format "Save file %s? "
2454                                 (buffer-file-name buffer))
2455                       (format "Save buffer %s? "
2456                               (buffer-name buffer))))))
2457            (lambda (buffer)
2458              (set-buffer buffer)
2459              (condition-case ()
2460                  (save-buffer)
2461                (error nil)))
2462            (buffer-list)
2463            '("buffer" "buffers" "save")
2464            ;;instead of this we just say "yes all", "no all", etc.
2465            ;;"save all the rest"
2466            ;;"save only this buffer" "save no more buffers")
2467            ;; this is rather bogus. --ben
2468            ;; (it makes the dialog box too big, and you get an error
2469            ;; "wrong type argument: framep, nil" when you hit q after
2470            ;; choosing the option from the dialog box)
2471
2472            ;; We should fix the dialog box rather than disabling
2473            ;; this!  --hniksic
2474            (list (list ?\C-r (lambda (buf)
2475                                ;; #### FSF has an EXIT-ACTION argument
2476                                ;; to `view-buffer'.
2477                                (view-buffer buf)
2478                                (setq view-exit-action
2479                                      (lambda (ignore)
2480                                        (exit-recursive-edit)))
2481                                (recursive-edit)
2482                                ;; Return nil to ask about BUF again.
2483                                nil)
2484                        "display the current buffer"))))
2485          (abbrevs-done
2486           (and save-abbrevs abbrevs-changed
2487                (progn
2488                  (if (or arg
2489                          (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
2490                      (write-abbrev-file nil))
2491                  ;; Don't keep bothering user if he says no.
2492                  (setq abbrevs-changed nil)
2493                  t))))
2494     (or (> files-done 0) abbrevs-done
2495         (display-message 'no-log "(No files need saving)"))
2496     switched))
2497
2498 \f
2499 (defun not-modified (&optional arg)
2500   "Mark current buffer as unmodified, not needing to be saved.
2501 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2502
2503 It is not a good idea to use this function in Lisp programs, because it
2504 prints a message in the minibuffer.  Instead, use `set-buffer-modified-p'."
2505   (interactive "_P")
2506   (if arg ;; rewritten for I18N3 snarfing
2507       (display-message 'command "Modification-flag set")
2508     (display-message 'command "Modification-flag cleared"))
2509   (set-buffer-modified-p arg))
2510
2511 (defun toggle-read-only (&optional arg)
2512   "Toggle the current buffer's read-only status.
2513 With arg, set read-only iff arg is positive."
2514   (interactive "_P")
2515   (setq buffer-read-only
2516         (if (null arg)
2517             (not buffer-read-only)
2518             (> (prefix-numeric-value arg) 0)))
2519   ;; Force modeline redisplay
2520   (redraw-modeline))
2521
2522 (defun insert-file (filename &optional codesys)
2523   "Insert contents of file FILENAME into buffer after point.
2524 Set mark after the inserted text.
2525
2526 Under XEmacs/Mule, optional second argument specifies the
2527 coding system to use when decoding the file.  Interactively,
2528 with a prefix argument, you will be prompted for the coding system.
2529
2530 This function is meant for the user to run interactively.
2531 Don't call it from programs!  Use `insert-file-contents' instead.
2532 \(Its calling sequence is different; see its documentation)."
2533   (interactive "*fInsert file: \nZCoding system: ")
2534   (if (file-directory-p filename)
2535       (signal 'file-error (list "Opening input file" "file is a directory"
2536                                 filename)))
2537   (let ((tem
2538          (if codesys
2539              (let ((coding-system-for-read
2540                     (get-coding-system codesys)))
2541                (insert-file-contents filename))
2542            (insert-file-contents filename))))
2543     (push-mark (+ (point) (car (cdr tem))))))
2544
2545 (defun append-to-file (start end filename &optional codesys)
2546   "Append the contents of the region to the end of file FILENAME.
2547 When called from a function, expects three arguments,
2548 START, END and FILENAME.  START and END are buffer positions
2549 saying what text to write.
2550 Under XEmacs/Mule, optional fourth argument specifies the
2551 coding system to use when encoding the file.  Interactively,
2552 with a prefix argument, you will be prompted for the coding system."
2553   (interactive "r\nFAppend to file: \nZCoding system: ")
2554   (if codesys
2555       (let ((buffer-file-coding-system (get-coding-system codesys)))
2556         (write-region start end filename t))
2557     (write-region start end filename t)))
2558
2559 (defun file-newest-backup (filename)
2560   "Return most recent backup file for FILENAME or nil if no backups exist."
2561   (let* ((filename (expand-file-name filename))
2562          (file (file-name-nondirectory filename))
2563          (dir  (file-name-directory    filename))
2564          (comp (file-name-all-completions file dir))
2565          newest)
2566     (while comp
2567       (setq file (concat dir (car comp))
2568             comp (cdr comp))
2569       (if (and (backup-file-name-p file)
2570                (or (null newest) (file-newer-than-file-p file newest)))
2571           (setq newest file)))
2572     newest))
2573
2574 (defun rename-uniquely ()
2575   "Rename current buffer to a similar name not already taken.
2576 This function is useful for creating multiple shell process buffers
2577 or multiple mail buffers, etc."
2578   (interactive)
2579   (save-match-data
2580     (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2581                                (not (and buffer-file-name
2582                                          (string= (buffer-name)
2583                                                   (file-name-nondirectory
2584                                                    buffer-file-name)))))
2585                           ;; If the existing buffer name has a <NNN>,
2586                           ;; which isn't part of the file name (if any),
2587                           ;; then get rid of that.
2588                           (substring (buffer-name) 0 (match-beginning 0))
2589                         (buffer-name)))
2590            (new-buf (generate-new-buffer base-name))
2591            (name (buffer-name new-buf)))
2592       (kill-buffer new-buf)
2593       (rename-buffer name)
2594       (redraw-modeline))))
2595
2596 (defun make-directory-path (path)
2597   "Create all the directories along path that don't exist yet."
2598   (interactive "Fdirectory path to create: ")
2599   (make-directory path t))
2600
2601 (defun make-directory (dir &optional parents)
2602   "Create the directory DIR and any nonexistent parent dirs.
2603 Interactively, the default choice of directory to create
2604 is the current default directory for file names.
2605 That is useful when you have visited a file in a nonexistent directory.
2606
2607 Noninteractively, the second (optional) argument PARENTS says whether
2608 to create parent directories if they don't exist."
2609   (interactive (list (let ((current-prefix-arg current-prefix-arg))
2610                        (read-directory-name "Create directory: "))
2611                      current-prefix-arg))
2612   (let ((handler (find-file-name-handler dir 'make-directory)))
2613     (if handler
2614         (funcall handler 'make-directory dir parents)
2615       (if (not parents)
2616           (make-directory-internal dir)
2617         (let ((dir (directory-file-name (expand-file-name dir)))
2618               create-list)
2619           (while (not (file-exists-p dir))
2620             (setq create-list (cons dir create-list)
2621                   dir (directory-file-name (file-name-directory dir))))
2622           (while create-list
2623             (make-directory-internal (car create-list))
2624             (setq create-list (cdr create-list))))))))
2625 \f
2626 (put 'revert-buffer-function 'permanent-local t)
2627 (defvar revert-buffer-function nil
2628   "Function to use to revert this buffer, or nil to do the default.
2629 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2630 which are the arguments that `revert-buffer' received.")
2631
2632 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2633 (defvar revert-buffer-insert-file-contents-function nil
2634   "Function to use to insert contents when reverting this buffer.
2635 Gets two args, first the nominal file name to use,
2636 and second, t if reading the auto-save file.")
2637
2638 (defvar before-revert-hook nil
2639   "Normal hook for `revert-buffer' to run before reverting.
2640 If `revert-buffer-function' is used to override the normal revert
2641 mechanism, this hook is not used.")
2642
2643 (defvar after-revert-hook nil
2644   "Normal hook for `revert-buffer' to run after reverting.
2645 Note that the hook value that it runs is the value that was in effect
2646 before reverting; that makes a difference if you have buffer-local
2647 hook functions.
2648
2649 If `revert-buffer-function' is used to override the normal revert
2650 mechanism, this hook is not used.")
2651
2652 (defvar revert-buffer-internal-hook nil
2653   "Don't use this.")
2654
2655 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2656   "Replace the buffer text with the text of the visited file on disk.
2657 This undoes all changes since the file was visited or saved.
2658 With a prefix argument, offer to revert from latest auto-save file, if
2659 that is more recent than the visited file.
2660
2661 This command also works for special buffers that contain text which
2662 doesn't come from a file, but reflects some other data base instead:
2663 for example, Dired buffers and buffer-list buffers.  In these cases,
2664 it reconstructs the buffer contents from the appropriate data base.
2665
2666 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2667 to revert from the auto-save file when this is nil.  Note that the
2668 sense of this argument is the reverse of the prefix argument, for the
2669 sake of backward compatibility.  IGNORE-AUTO is optional, defaulting
2670 to nil.
2671
2672 Optional second argument NOCONFIRM means don't ask for confirmation at
2673 all.
2674
2675 Optional third argument PRESERVE-MODES non-nil means don't alter
2676 the files modes.  Normally we reinitialize them using `normal-mode'.
2677
2678 If the value of `revert-buffer-function' is non-nil, it is called to
2679 do all the work for this command.  Otherwise, the hooks
2680 `before-revert-hook' and `after-revert-hook' are run at the beginning
2681 and the end, and if `revert-buffer-insert-file-contents-function' is
2682 non-nil, it is called instead of rereading visited file contents."
2683
2684   ;; I admit it's odd to reverse the sense of the prefix argument, but
2685   ;; there is a lot of code out there which assumes that the first
2686   ;; argument should be t to avoid consulting the auto-save file, and
2687   ;; there's no straightforward way to encourage authors to notice a
2688   ;; reversal of the argument sense.  So I'm just changing the user
2689   ;; interface, but leaving the programmatic interface the same.
2690   (interactive (list (not current-prefix-arg)))
2691   (if revert-buffer-function
2692       (funcall revert-buffer-function ignore-auto noconfirm)
2693     (let* ((opoint (point))
2694            (auto-save-p (and (not ignore-auto)
2695                              (recent-auto-save-p)
2696                              buffer-auto-save-file-name
2697                              (file-readable-p buffer-auto-save-file-name)
2698                              (y-or-n-p
2699    "Buffer has been auto-saved recently.  Revert from auto-save file? ")))
2700            (file-name (if auto-save-p
2701                           buffer-auto-save-file-name
2702                         buffer-file-name)))
2703       (cond ((null file-name)
2704              (error "Buffer does not seem to be associated with any file"))
2705             ((or noconfirm
2706                  (and (not (buffer-modified-p))
2707                       (let (found)
2708                         (dolist (rx revert-without-query found)
2709                           (when (string-match rx file-name)
2710                             (setq found t)))))
2711                  (yes-or-no-p (format "Revert buffer from file %s? "
2712                                       file-name)))
2713              (run-hooks 'before-revert-hook)
2714              ;; If file was backed up but has changed since,
2715              ;; we shd make another backup.
2716              (and (not auto-save-p)
2717                   (not (verify-visited-file-modtime (current-buffer)))
2718                   (setq buffer-backed-up nil))
2719              ;; Get rid of all undo records for this buffer.
2720              (or (eq buffer-undo-list t)
2721                  (setq buffer-undo-list nil))
2722              ;; Effectively copy the after-revert-hook status,
2723              ;; since after-find-file will clobber it.
2724              (let ((global-hook (default-value 'after-revert-hook))
2725                    (local-hook-p (local-variable-p 'after-revert-hook
2726                                                    (current-buffer)))
2727                    (local-hook (and (local-variable-p 'after-revert-hook
2728                                                       (current-buffer))
2729                                     after-revert-hook)))
2730                (let (buffer-read-only
2731                      ;; Don't make undo records for the reversion.
2732                      (buffer-undo-list t))
2733                  (if revert-buffer-insert-file-contents-function
2734                      (funcall revert-buffer-insert-file-contents-function
2735                               file-name auto-save-p)
2736                    (if (not (file-exists-p file-name))
2737                        (error "File %s no longer exists!" file-name))
2738                    ;; Bind buffer-file-name to nil
2739                    ;; so that we don't try to lock the file.
2740                    (let ((buffer-file-name nil))
2741                      (or auto-save-p
2742                          (unlock-buffer)))
2743                    (widen)
2744                    (insert-file-contents file-name (not auto-save-p)
2745                                          nil nil t)))
2746                (goto-char (min opoint (point-max)))
2747                ;; Recompute the truename in case changes in symlinks
2748                ;; have changed the truename.
2749                ;XEmacs: already done by insert-file-contents
2750                ;;(setq buffer-file-truename
2751                      ;;(abbreviate-file-name (file-truename buffer-file-name)))
2752                (after-find-file nil nil t t preserve-modes)
2753                ;; Run after-revert-hook as it was before we reverted.
2754                (setq-default revert-buffer-internal-hook global-hook)
2755                (if local-hook-p
2756                    (progn
2757                      (make-local-variable 'revert-buffer-internal-hook)
2758                      (setq revert-buffer-internal-hook local-hook))
2759                  (kill-local-variable 'revert-buffer-internal-hook))
2760                (run-hooks 'revert-buffer-internal-hook))
2761              t)))))
2762
2763 (defun recover-file (file)
2764   "Visit file FILE, but get contents from its last auto-save file."
2765   ;; Actually putting the file name in the minibuffer should be used
2766   ;; only rarely.
2767   ;; Not just because users often use the default.
2768   (interactive "FRecover file: ")
2769   (setq file (expand-file-name file))
2770   (let ((handler (or (find-file-name-handler file 'recover-file)
2771                     (find-file-name-handler
2772                      (let ((buffer-file-name file))
2773                        (make-auto-save-file-name))
2774                      'recover-file))))
2775     (if handler
2776         (funcall handler 'recover-file file)
2777       (if (auto-save-file-name-p file)
2778           (error "%s is an auto-save file" file))
2779       (let ((file-name (let ((buffer-file-name file))
2780                          (make-auto-save-file-name))))
2781         (cond ((if (file-exists-p file)
2782                    (not (file-newer-than-file-p file-name file))
2783                  (not (file-exists-p file-name)))
2784                (error "Auto-save file %s not current" file-name))
2785               ((save-window-excursion
2786                  (if (not (eq system-type 'vax-vms))
2787                      (with-output-to-temp-buffer "*Directory*"
2788                        (buffer-disable-undo standard-output)
2789                        (call-process "ls" nil standard-output nil
2790                                      (if (file-symlink-p file) "-lL" "-l")
2791                                      file file-name)))
2792                  (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2793                (switch-to-buffer (find-file-noselect file t))
2794                (let ((buffer-read-only nil))
2795                  (erase-buffer)
2796                  (insert-file-contents file-name nil))
2797                (after-find-file nil nil t))
2798               (t (error "Recover-file cancelled.")))))))
2799
2800 (defun recover-session ()
2801   "Recover auto save files from a previous Emacs session.
2802 This command first displays a Dired buffer showing you the
2803 previous sessions that you could recover from.
2804 To choose one, move point to the proper line and then type C-c C-c.
2805 Then you'll be asked about a number of files to recover."
2806   (interactive)
2807   (unless (fboundp 'dired)
2808     (error "recover-session requires dired"))
2809   (if (null auto-save-list-file-prefix)
2810       (error
2811        "You set `auto-save-list-file-prefix' to disable making session files"))
2812   (dired (concat auto-save-list-file-prefix "*"))
2813   (goto-char (point-min))
2814   (or (looking-at "Move to the session you want to recover,")
2815       (let ((inhibit-read-only t))
2816         (insert "Move to the session you want to recover,\n"
2817                 "then type C-c C-c to select it.\n\n"
2818                 "You can also delete some of these files;\n"
2819                 "type d on a line to mark that file for deletion.\n\n")))
2820   (use-local-map (let ((map (make-sparse-keymap)))
2821                    (set-keymap-parents map (list (current-local-map)))
2822                    map))
2823   (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2824
2825 (defun recover-session-finish ()
2826   "Choose one saved session to recover auto-save files from.
2827 This command is used in the special Dired buffer created by
2828 \\[recover-session]."
2829   (interactive)
2830   ;; Get the name of the session file to recover from.
2831   (let ((file (dired-get-filename))
2832         files
2833         (buffer (get-buffer-create " *recover*")))
2834     ;; #### dired-do-flagged-delete in FSF.
2835     ;; This version is for ange-ftp
2836     ;;(dired-do-deletions t)
2837     ;; This version is for efs
2838     (dired-expunge-deletions)
2839     (unwind-protect
2840         (save-excursion
2841           ;; Read in the auto-save-list file.
2842           (set-buffer buffer)
2843           (erase-buffer)
2844           (insert-file-contents file)
2845           ;; Loop thru the text of that file
2846           ;; and get out the names of the files to recover.
2847           (while (not (eobp))
2848             (let (thisfile autofile)
2849               (if (eolp)
2850                   ;; This is a pair of lines for a non-file-visiting buffer.
2851                   ;; Get the auto-save file name and manufacture
2852                   ;; a "visited file name" from that.
2853                   (progn
2854                     (forward-line 1)
2855                     (setq autofile
2856                           (buffer-substring-no-properties
2857                            (point)
2858                            (save-excursion
2859                              (end-of-line)
2860                              (point))))
2861                     (setq thisfile
2862                           (expand-file-name
2863                            (substring
2864                             (file-name-nondirectory autofile)
2865                             1 -1)
2866                            (file-name-directory autofile)))
2867                     (forward-line 1))
2868                 ;; This pair of lines is a file-visiting
2869                 ;; buffer.  Use the visited file name.
2870                 (progn
2871                   (setq thisfile
2872                         (buffer-substring-no-properties
2873                          (point) (progn (end-of-line) (point))))
2874                   (forward-line 1)
2875                   (setq autofile
2876                         (buffer-substring-no-properties
2877                          (point) (progn (end-of-line) (point))))
2878                   (forward-line 1)))
2879               ;; Ignore a file if its auto-save file does not exist now.
2880               (if (file-exists-p autofile)
2881                   (setq files (cons thisfile files)))))
2882           (setq files (nreverse files))
2883           ;; The file contains a pair of line for each auto-saved buffer.
2884           ;; The first line of the pair contains the visited file name
2885           ;; or is empty if the buffer was not visiting a file.
2886           ;; The second line is the auto-save file name.
2887           (if files
2888               (map-y-or-n-p  "Recover %s? "
2889                              (lambda (file)
2890                                (condition-case nil
2891                                    (save-excursion (recover-file file))
2892                                  (error
2893                                   "Failed to recover `%s'" file)))
2894                              files
2895                              '("file" "files" "recover"))
2896             (message "No files can be recovered from this session now")))
2897       (kill-buffer buffer))))
2898
2899 (defun kill-some-buffers (&optional list)
2900   "For each buffer in LIST, ask whether to kill it.
2901 LIST defaults to all existing live buffers."
2902   (interactive)
2903   (if (null list)
2904       (setq list (buffer-list)))
2905   (while list
2906     (let* ((buffer (car list))
2907            (name (buffer-name buffer)))
2908       (and (not (string-equal name ""))
2909            (/= (aref name 0) ?\ )
2910            (yes-or-no-p
2911             (format
2912              (if (buffer-modified-p buffer)
2913                  (gettext "Buffer %s HAS BEEN EDITED.  Kill? ")
2914                (gettext "Buffer %s is unmodified.  Kill? "))
2915              name))
2916            (kill-buffer buffer)))
2917     (setq list (cdr list))))
2918 \f
2919 (defun auto-save-mode (arg)
2920   "Toggle auto-saving of contents of current buffer.
2921 With prefix argument ARG, turn auto-saving on if positive, else off."
2922   (interactive "P")
2923   (setq buffer-auto-save-file-name
2924         (and (if (null arg)
2925                  (or (not buffer-auto-save-file-name)
2926                      ;; If autosave is off because buffer has shrunk,
2927                      ;; then toggling should turn it on.
2928                      (< buffer-saved-size 0))
2929                (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2930              (if (and buffer-file-name auto-save-visited-file-name
2931                       (not buffer-read-only))
2932                  buffer-file-name
2933                (make-auto-save-file-name))))
2934   ;; If -1 was stored here, to temporarily turn off saving,
2935   ;; turn it back on.
2936   (and (< buffer-saved-size 0)
2937        (setq buffer-saved-size 0))
2938   (if (interactive-p)
2939       (if buffer-auto-save-file-name ;; rewritten for I18N3 snarfing
2940           (display-message 'command "Auto-save on (in this buffer)")
2941         (display-message 'command "Auto-save off (in this buffer)")))
2942   buffer-auto-save-file-name)
2943
2944 (defun rename-auto-save-file ()
2945   "Adjust current buffer's auto save file name for current conditions.
2946 Also rename any existing auto save file, if it was made in this session."
2947   (let ((osave buffer-auto-save-file-name))
2948     (setq buffer-auto-save-file-name
2949           (make-auto-save-file-name))
2950     (if (and osave buffer-auto-save-file-name
2951              (not (string= buffer-auto-save-file-name buffer-file-name))
2952              (not (string= buffer-auto-save-file-name osave))
2953              (file-exists-p osave)
2954              (recent-auto-save-p))
2955         (rename-file osave buffer-auto-save-file-name t))))
2956
2957 ;; see also ../packages/auto-save.el
2958 (defun make-auto-save-file-name (&optional filename)
2959   "Return file name to use for auto-saves of current buffer.
2960 Does not consider `auto-save-visited-file-name' as that variable is checked
2961 before calling this function.  You can redefine this for customization.
2962 See also `auto-save-file-name-p'."
2963   (let ((fname (or filename buffer-file-name))
2964         name)
2965     (setq name
2966           (if fname
2967               (concat (file-name-directory fname)
2968                       "#"
2969                       (file-name-nondirectory fname)
2970                       "#")
2971
2972             ;; Deal with buffers that don't have any associated files.  (Mail
2973             ;; mode tends to create a good number of these.)
2974
2975             (let ((buffer-name (buffer-name))
2976                   (limit 0))
2977               ;; Use technique from Sebastian Kremer's auto-save
2978               ;; package to turn slashes into \\!.  This ensures that
2979               ;; the auto-save buffer name is unique.
2980
2981               ;; #### - yuck!  yuck!  yuck!  move this functionality
2982               ;; somewhere else and make the name translation customizable.
2983               ;; Using "\!" as part of a filename on a UNIX filesystem is nearly
2984               ;; IMPOSSIBLE to get past a shell parser.  -stig
2985
2986               (while (string-match "[/\\]" buffer-name limit)
2987                 (setq buffer-name
2988                       (concat (substring buffer-name 0 (match-beginning 0))
2989                               (if (string= (substring buffer-name
2990                                                       (match-beginning 0)
2991                                                       (match-end 0))
2992                                            "/")
2993                                   "\\!"
2994                                 "\\\\")
2995                               (substring buffer-name (match-end 0))))
2996                 (setq limit (1+ (match-end 0))))
2997
2998               ;;    (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))
2999
3000               ;; jwz: putting the emacs PID in the auto-save file name
3001               ;; is bad news, because that defeats auto-save-recovery of
3002               ;; *mail* buffers -- the (sensible) code in sendmail.el
3003               ;; calls (make-auto-save-file-name) to determine whether
3004               ;; there is unsent, auto-saved mail to recover.  If that
3005               ;; mail came from a previous emacs process (far and away
3006               ;; the most likely case) then this can never succeed as
3007               ;; the pid differs.
3008
3009               (expand-file-name (format "#%s#" buffer-name)))
3010             ))
3011     ;; don't try to write auto-save files in unwritable places.  Unless
3012     ;; there's already an autosave file here, put ours somewhere safe. --Stig
3013     (if (or (file-writable-p name)
3014             (file-exists-p name))
3015         name
3016       (expand-file-name (concat "~/" (file-name-nondirectory name))))))
3017
3018 (defun auto-save-file-name-p (filename)
3019   "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3020 FILENAME should lack slashes.
3021 You can redefine this for customization."
3022   (string-match "\\`#.*#\\'" filename))
3023 \f
3024 (defun wildcard-to-regexp (wildcard)
3025   "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3026 The generated regexp will match a filename iff the filename
3027 matches that wildcard according to shell rules.  Only wildcards known
3028 by `sh' are supported."
3029   (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3030          ;; Copy the initial run of non-special characters.
3031          (result (substring wildcard 0 i))
3032          (len (length wildcard)))
3033     ;; If no special characters, we're almost done.
3034     (if i
3035         (while (< i len)
3036           (let ((ch (aref wildcard i))
3037                 j)
3038             (setq
3039              result
3040              (concat result
3041                      (cond
3042                       ((eq ch ?\[)      ; [...] maps to regexp char class
3043                        (progn
3044                          (setq i (1+ i))
3045                          (concat
3046                           (cond
3047                            ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3048                             (progn
3049                               (setq i (1+ i))
3050                               (if (eq (aref wildcard i) ?\])
3051                                   (progn
3052                                     (setq i (1+ i))
3053                                     "[^]")
3054                                 "[^")))
3055                            ((eq (aref wildcard i) ?^)
3056                             ;; Found "[^".  Insert a `\0' character
3057                             ;; (which cannot happen in a filename)
3058                             ;; into the character class, so that `^'
3059                             ;; is not the first character after `[',
3060                             ;; and thus non-special in a regexp.
3061                             (progn
3062                               (setq i (1+ i))
3063                               "[\000^"))
3064                            ((eq (aref wildcard i) ?\])
3065                             ;; I don't think `]' can appear in a
3066                             ;; character class in a wildcard, but
3067                             ;; let's be general here.
3068                             (progn
3069                               (setq i (1+ i))
3070                               "[]"))
3071                            (t "["))
3072                           (prog1        ; copy everything upto next `]'.
3073                               (substring wildcard
3074                                          i
3075                                          (setq j (string-match
3076                                                   "]" wildcard i)))
3077                             (setq i (if j (1- j) (1- len)))))))
3078                       ((eq ch ?.)  "\\.")
3079                       ((eq ch ?*)  "[^\000]*")
3080                       ((eq ch ?+)  "\\+")
3081                       ((eq ch ?^)  "\\^")
3082                       ((eq ch ?$)  "\\$")
3083                       ((eq ch ?\\) "\\\\") ; probably cannot happen...
3084                       ((eq ch ??)  "[^\000]")
3085                       (t (char-to-string ch)))))
3086             (setq i (1+ i)))))
3087     ;; Shell wildcards should match the entire filename,
3088     ;; not its part.  Make the regexp say so.
3089     (concat "\\`" result "\\'")))
3090 \f
3091 (defcustom list-directory-brief-switches
3092   (if (eq system-type 'vax-vms) "" "-CF")
3093   "*Switches for list-directory to pass to `ls' for brief listing."
3094   :type 'string
3095   :group 'dired)
3096
3097 (defcustom list-directory-verbose-switches
3098   (if (eq system-type 'vax-vms)
3099       "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3100     "-l")
3101   "*Switches for list-directory to pass to `ls' for verbose listing,"
3102   :type 'string
3103   :group 'dired)
3104
3105 (defun list-directory (dirname &optional verbose)
3106   "Display a list of files in or matching DIRNAME, a la `ls'.
3107 DIRNAME is globbed by the shell if necessary.
3108 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3109 Actions controlled by variables `list-directory-brief-switches'
3110 and `list-directory-verbose-switches'."
3111   (interactive (let ((pfx current-prefix-arg))
3112                  (list (read-file-name (if pfx (gettext "List directory (verbose): ")
3113                                          (gettext "List directory (brief): "))
3114                                        nil default-directory nil)
3115                        pfx)))
3116   (let ((switches (if verbose list-directory-verbose-switches
3117                     list-directory-brief-switches)))
3118     (or dirname (setq dirname default-directory))
3119     (setq dirname (expand-file-name dirname))
3120     (with-output-to-temp-buffer "*Directory*"
3121       (buffer-disable-undo standard-output)
3122       (princ "Directory ")
3123       (princ dirname)
3124       (terpri)
3125       (save-excursion
3126         (set-buffer "*Directory*")
3127         (setq default-directory (file-name-directory dirname))
3128         (let ((wildcard (not (file-directory-p dirname))))
3129           (insert-directory dirname switches wildcard (not wildcard)))))))
3130
3131 (defvar insert-directory-program "ls"
3132   "Absolute or relative name of the `ls' program used by `insert-directory'.")
3133
3134 ;; insert-directory
3135 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3136 ;;   FULL-DIRECTORY-P is nil.
3137 ;;   The single line of output must display FILE's name as it was
3138 ;;   given, namely, an absolute path name.
3139 ;; - must insert exactly one line for each file if WILDCARD or
3140 ;;   FULL-DIRECTORY-P is t, plus one optional "total" line
3141 ;;   before the file lines, plus optional text after the file lines.
3142 ;;   Lines are delimited by "\n", so filenames containing "\n" are not
3143 ;;   allowed.
3144 ;;   File lines should display the basename.
3145 ;; - must be consistent with
3146 ;;   - functions dired-move-to-filename, (these two define what a file line is)
3147 ;;               dired-move-to-end-of-filename,
3148 ;;               dired-between-files, (shortcut for (not (dired-move-to-filename)))
3149 ;;               dired-insert-headerline
3150 ;;               dired-after-subdir-garbage (defines what a "total" line is)
3151 ;;   - variable dired-subdir-regexp
3152 (defun insert-directory (file switches &optional wildcard full-directory-p)
3153   "Insert directory listing for FILE, formatted according to SWITCHES.
3154 Leaves point after the inserted text.
3155 SWITCHES may be a string of options, or a list of strings.
3156 Optional third arg WILDCARD means treat FILE as shell wildcard.
3157 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3158 switches do not contain `d', so that a full listing is expected.
3159
3160 This works by running a directory listing program
3161 whose name is in the variable `insert-directory-program'.
3162 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3163   ;; We need the directory in order to find the right handler.
3164   (let ((handler (find-file-name-handler (expand-file-name file)
3165                                          'insert-directory)))
3166     (if handler
3167         (funcall handler 'insert-directory file switches
3168                  wildcard full-directory-p)
3169       (cond
3170        ((eq system-type 'vax-vms)
3171         (vms-read-directory file switches (current-buffer)))
3172        ((and (fboundp 'mswindows-insert-directory)
3173              (eq system-type 'windows-nt))
3174         (mswindows-insert-directory file switches wildcard full-directory-p))
3175        (t
3176         (if wildcard
3177             ;; Run ls in the directory of the file pattern we asked for.
3178             (let ((default-directory
3179                       (if (file-name-absolute-p file)
3180                           (file-name-directory file)
3181                           (file-name-directory (expand-file-name file))))
3182                   (pattern (file-name-nondirectory file))
3183                   (beg 0))
3184               ;; Quote some characters that have special meanings in shells;
3185               ;; but don't quote the wildcards--we want them to be special.
3186               ;; We also currently don't quote the quoting characters
3187               ;; in case people want to use them explicitly to quote
3188               ;; wildcard characters.
3189               ;;#### Unix-specific
3190               (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3191                 (setq pattern
3192                       (concat (substring pattern 0 (match-beginning 0))
3193                               "\\"
3194                               (substring pattern (match-beginning 0)))
3195                       beg (1+ (match-end 0))))
3196               (call-process shell-file-name nil t nil
3197                             "-c" (concat "\\"  ;; Disregard shell aliases!
3198                                          insert-directory-program
3199                                          " -d "
3200                                          (if (stringp switches)
3201                                              switches
3202                                            (mapconcat 'identity switches " "))
3203                                          " "
3204                                          pattern)))
3205           ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3206           ;; directory if FILE is a symbolic link.
3207           (apply 'call-process
3208                  insert-directory-program nil t nil
3209                  (let (list)
3210                    (if (listp switches)
3211                        (setq list switches)
3212                      (if (not (equal switches ""))
3213                          (progn
3214                            ;; Split the switches at any spaces
3215                            ;; so we can pass separate options as separate args.
3216                            (while (string-match " " switches)
3217                              (setq list (cons (substring switches 0 (match-beginning 0))
3218                                               list)
3219                                    switches (substring switches (match-end 0))))
3220                            (setq list (cons switches list)))))
3221                    (append list
3222                            (list
3223                             (if full-directory-p
3224                                 (concat (file-name-as-directory file)
3225                                         ;;#### Unix-specific
3226                                         ".")
3227                               file)))))))))))
3228
3229 (defvar kill-emacs-query-functions nil
3230   "Functions to call with no arguments to query about killing XEmacs.
3231 If any of these functions returns nil, killing Emacs is cancelled.
3232 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3233 but `kill-emacs', the low level primitive, does not.
3234 See also `kill-emacs-hook'.")
3235
3236 (defun save-buffers-kill-emacs (&optional arg)
3237   "Offer to save each buffer, then kill this XEmacs process.
3238 With prefix arg, silently save all file-visiting buffers, then kill."
3239   (interactive "P")
3240   (save-some-buffers arg t)
3241   (and (or (not (memq t (mapcar #'(lambda (buf) (and (buffer-file-name buf)
3242                                                      (buffer-modified-p buf)))
3243                                 (buffer-list))))
3244            (yes-or-no-p "Modified buffers exist; exit anyway? "))
3245        (or (not (fboundp 'process-list))
3246            ;; process-list is not defined on VMS.
3247            (let ((processes (process-list))
3248                  active)
3249              (while processes
3250                (and (memq (process-status (car processes)) '(run stop open))
3251                     (let ((val (process-kill-without-query (car processes))))
3252                       (process-kill-without-query (car processes) val)
3253                       val)
3254                     (setq active t))
3255                (setq processes (cdr processes)))
3256              (or
3257               (not active)
3258               (save-excursion
3259                 (save-window-excursion
3260                   (delete-other-windows)
3261                   (list-processes)
3262                   (yes-or-no-p
3263                    "Active processes exist; kill them and exit anyway? "))))))
3264        ;; Query the user for other things, perhaps.
3265        (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3266        (kill-emacs)))
3267
3268 (defun symlink-expand-file-name (filename)
3269   "If FILENAME is a symlink, return its non-symlink equivalent.
3270 Unlike `file-truename', this doesn't chase symlinks in directory
3271 components of the file or expand a relative pathname into an
3272 absolute one."
3273   (let ((count 20))
3274     (while (and (> count 0) (file-symlink-p filename))
3275       (setq filename (file-symlink-p filename)
3276             count (1- count)))
3277     (if (> count 0)
3278         filename
3279       (error "Apparently circular symlink path"))))
3280
3281 ;; Suggested by Michael Kifer <kifer@CS.SunySB.EDU>
3282 (defun file-remote-p (file-name)
3283   "Test whether FILE-NAME is looked for on a remote system."
3284   (cond ((not allow-remote-paths) nil)
3285         ((featurep 'ange-ftp) (ange-ftp-ftp-path file-name))
3286         ((fboundp 'efs-ftp-path) (efs-ftp-path file-name))
3287         (t nil)))
3288
3289 ;; #### FSF has file-name-non-special here.
3290
3291 ;;; files.el ends here