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