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