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