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