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