1 ;;; files.el --- file input and output commands for XEmacs.
3 ;; Copyright (C) 1985-1987, 1992-1995, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Sun Microsystems.
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: extensions, dumped
9 ;; This file is part of XEmacs.
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)
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.
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
26 ;;; Synched up with: FSF 20.3 (but diverging)
27 ;;; Warning: Merging this file is tough. Beware.
31 ;; This file is dumped with XEmacs.
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.
39 ;; XEmacs: Avoid compilation warnings.
40 (defvar coding-system-for-read)
41 (defvar buffer-file-coding-system)
44 "Support editing files."
48 "Backups of edited data files."
51 (defgroup find-file nil
52 "Finding and editing files."
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.")
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 ^.
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"
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.
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.
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.
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'."
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)
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'."
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."
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."
130 (defvar backup-enable-predicate
133 (string-match "^/tmp/" name)
134 (let ((tmpdir (temp-directory)))
136 (string-match (concat "\\`" (regexp-quote 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.")
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."
147 (make-variable-buffer-local 'buffer-offer-save)
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)
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 ""))
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)
170 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
171 "Non-nil means that buffer-file-number uniquely identifies files.")
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.
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.
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."
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."
197 ;; This is now defined in efs.
198 ;(defvar dired-kept-versions 2
199 ; "*When cleaning directory, number of versions to keep.")
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))
209 (defcustom kept-old-versions 2
210 "*Number of oldest versions to keep when a new numbered backup is made."
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"
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)
226 (sexp :tag "Ask" :format "%t\n" ask))
227 :group 'editing-basics)
229 (defcustom auto-save-default t
230 "*Non-nil says by default do auto-saving of every file-visiting buffer."
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."
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."
246 (defcustom find-file-run-dired t
247 "*Non-nil says run dired if `find-file' is given the name of a directory."
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.")
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.")
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)
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
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)
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'.")
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'.")
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'.")
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.
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))
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.
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))
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))
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))
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))
378 ;; leave ':' if part of drive specifier
379 (if (and (> (length name) 1)
380 (eq (aref name 1) ?:))
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.
393 "Show the current default directory."
395 (message "Directory %s" default-directory))
398 "Value of the CDPATH environment variable, as a list.
399 Not actually set up until the first time you use it.")
401 (defvar cdpath-previous nil
402 "Prior value of the CDPATH environment variable.")
404 (defun parse-colon-path (cd-path)
405 "Explode a colon-separated search path into a list of directory names.
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."
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))
416 (list (if (= cd-start cd-colon)
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)))
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))
439 (setq default-directory 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."
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))
454 (unless (and cd-path (equal (getenv "CDPATH") cdpath-previous))
456 (let ((trypath (parse-colon-path
457 (setq cdpath-previous (getenv "CDPATH")))))
458 (setq cd-path (or trypath (list "./")))))
460 (mapcar #'(lambda (x)
461 (let ((f (expand-file-name (concat x dir))))
462 (if (file-directory-p f)
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)))))
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))
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: ")
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:")))
493 ; (error "Couldn't locate library %s" library))))
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
499 (let ((handler (find-file-name-handler file 'file-local-copy)))
501 (funcall handler 'file-local-copy file)
504 ;; XEmacs change block
505 ; We have this in C and use the realpath() system call.
507 ;(defun file-truename (filename &optional counter prev-dirs)
508 ; [... lots of code snipped ...]
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."
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.
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)
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
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))
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.
561 ;; Chase links in the default dir of the symlink.
564 (file-name-directory newname))))))))
565 (setq newname (expand-file-name tem (file-name-directory newname)))
566 (setq count (1- count))))
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."
575 (bury-buffer (current-buffer)))
577 (if (<= arg 1) (other-buffer (current-buffer))
578 (nth (1+ arg) (buffer-list)))))
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.
588 ;; Change documented above undone --mrb
589 (pop-to-buffer buffer t (selected-frame))))
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)
601 (defun find-file (filename &optional codesys)
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: ")
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))))
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: ")
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))))
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: ")
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))))
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: ")
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)
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: ")
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)
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: ")
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)
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."
696 (save-selected-window
698 (let ((file buffer-file-name)
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: "))))))
709 (find-file-other-window filename)
710 (save-selected-window
712 (find-alternate-file filename codesys))))
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."
722 (let ((file buffer-file-name)
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? "
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)
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)
762 (rename-buffer oname))))
763 (or (eq (current-buffer) obuf)
764 (kill-buffer obuf))))
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)))
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)))))
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)))
783 (defvar abbreviated-home-dir nil
784 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
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)))
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.
803 (when (string-match (car (car tail)) filename)
805 (concat (cdr (car tail)) (substring filename (match-end 0)))))
806 (setq tail (cdr tail))))
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
814 (or abbreviated-home-dir
815 (setq abbreviated-home-dir
816 (let ((abbreviated-home-dir "$foo"))
819 (abbreviate-file-name (expand-file-name "~")))
821 (regexp-quote (string directory-sep-char))
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)
831 (string-match (concat "\\`[a-zA-Z]:"
833 (string directory-sep-char))
838 (match-string 1 filename)
839 (substring filename (match-end 0))))))
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"))
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))))
858 (let ((list (buffer-list)) found)
859 (while (and (not found) list)
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)))
867 (let ((number (nthcdr 10 (file-attributes truename)))
868 (list (buffer-list)) found)
869 (and buffer-file-numbers-unique
871 (while (and (not found) list)
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))
881 (setq found (car list))))
882 (setq list (cdr list))))
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.
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)))
895 (funcall wrap-func 'insert-file-contents-literally filename
896 visit start end replace)
897 (let ((file-name-handler-alist nil)
899 (after-insert-file-functions nil)
900 (coding-system-for-read 'binary)
901 (coding-system-for-write 'binary)
902 (jka-compr-compression-info-list nil)
903 (find-buffer-file-type-function
904 (if (fboundp 'find-buffer-file-type)
905 (symbol-function 'find-buffer-file-type)
909 (fset 'find-buffer-file-type (lambda (filename) t))
910 (insert-file-contents filename visit start end replace))
911 (if find-buffer-file-type-function
912 (fset 'find-buffer-file-type find-buffer-file-type-function)
913 (fmakunbound 'find-buffer-file-type)))))))
915 (defun find-file-noselect (filename &optional nowarn rawfile)
916 "Read file FILENAME into a buffer and return the buffer.
917 If a buffer exists visiting FILENAME, return that one, but
918 verify that the file has not changed since visited or saved.
919 The buffer is not selected, just returned to the caller.
920 If NOWARN is non-nil, warning messages will be suppressed.
921 If RAWFILE is non-nil, the file is read literally."
922 (setq filename (abbreviate-file-name (expand-file-name filename)))
923 (if (file-directory-p filename)
924 (if (and (fboundp 'dired-noselect) find-file-run-dired)
925 (dired-noselect (if find-file-use-truenames
926 (abbreviate-file-name (file-truename filename))
928 (error "%s is a directory" filename))
929 (let* ((buf (get-file-buffer filename))
930 (truename (abbreviate-file-name (file-truename filename)))
931 (number (nthcdr 10 (file-attributes truename)))
932 ; ;; Find any buffer for a file which has same truename.
933 ; (other (and (not buf) (find-buffer-visiting filename)))
936 ; ;; Let user know if there is a buffer with the same truename.
937 ; (if (and (not buf) same-truename (not nowarn))
938 ; (message "%s and %s are the same file (%s)"
939 ; filename (buffer-file-name same-truename)
941 ; (if (and (not buf) same-number (not nowarn))
942 ; (message "%s and %s are the same file"
943 ; filename (buffer-file-name same-number))))
944 ; ;; Optionally also find that buffer.
945 ; (if (or find-file-existing-other-name find-file-visit-truename)
946 ; (setq buf (or same-truename same-number)))
949 (or find-file-compare-truenames find-file-use-truenames)
953 (if (not (string-equal buffer-file-name filename))
954 (message "%s and %s are the same file (%s)"
955 filename buffer-file-name
956 buffer-file-truename))))
960 (verify-visited-file-modtime buf)
961 (cond ((not (file-exists-p filename))
962 (error "File %s no longer exists!" filename))
963 ;; Certain files should be reverted automatically
964 ;; if they have changed on disk and not in the buffer.
965 ((and (not (buffer-modified-p buf))
966 (dolist (rx revert-without-query nil)
967 (when (string-match rx filename)
969 (with-current-buffer buf
970 (message "Reverting file %s..." filename)
972 (message "Reverting file %s... done" filename)))
974 (if (string= (file-name-nondirectory filename)
977 (if (buffer-modified-p buf)
978 (gettext "File %s changed on disk. Discard your edits? ")
979 (gettext "File %s changed on disk. Reread from disk? "))
980 (file-name-nondirectory filename))
982 (if (buffer-modified-p buf)
983 (gettext "File %s changed on disk. Discard your edits in %s? ")
984 (gettext "File %s changed on disk. Reread from disk into %s? "))
985 (file-name-nondirectory filename)
987 (with-current-buffer buf
988 (revert-buffer t t)))))
989 ;; Else: we must create a new buffer for filename
991 ;;; The truename stuff makes this obsolete.
992 ;;; (let* ((link-name (car (file-attributes filename)))
993 ;;; (linked-buf (and (stringp link-name)
994 ;;; (get-file-buffer link-name))))
995 ;;; (if (bufferp linked-buf)
996 ;;; (message "Symbolic link to file in buffer %s"
997 ;;; (buffer-name linked-buf))))
998 (setq buf (create-file-buffer filename))
999 ;; Catch various signals, such as QUIT, and kill the buffer
1001 (condition-case data
1003 (set-buffer-major-mode buf)
1008 (insert-file-contents-literally filename t)
1009 (insert-file-contents filename t))
1011 (when (and (file-exists-p filename)
1012 (not (file-readable-p filename)))
1013 (signal 'file-error (list "File is not readable" filename)))
1015 ;; Unconditionally set error
1018 ;; Run find-file-not-found-hooks until one returns non-nil.
1019 (run-hook-with-args-until-success 'find-file-not-found-hooks)
1020 ;; If they fail too, set error.
1022 ;; Find the file's truename, and maybe use that as visited name.
1023 ;; automatically computed in XEmacs, unless jka-compr was used!
1024 (unless buffer-file-truename
1025 (setq buffer-file-truename truename))
1026 (setq buffer-file-number number)
1027 (and find-file-use-truenames
1028 ;; This should be in C. Put pathname
1029 ;; abbreviations that have been explicitly
1030 ;; requested back into the pathname. Most
1031 ;; importantly, strip out automounter /tmp_mnt
1032 ;; directories so that auto-save will work
1033 (setq buffer-file-name (abbreviate-file-name buffer-file-name)))
1034 ;; Set buffer's default directory to that of the file.
1035 (setq default-directory (file-name-directory buffer-file-name))
1036 ;; Turn off backup files for certain file names. Since
1037 ;; this is a permanent local, the major mode won't eliminate it.
1038 (and (not (funcall backup-enable-predicate buffer-file-name))
1040 (make-local-variable 'backup-inhibited)
1041 (setq backup-inhibited t)))
1043 ;; #### FSF 20.3 sets buffer-file-coding-system to
1044 ;; `no-conversion' here. Should we copy? It also
1045 ;; makes `find-file-literally' a local variable
1046 ;; and sets it to t.
1048 (after-find-file error (not nowarn))
1049 (setq buf (current-buffer))))
1052 (signal (car data) (cdr data))))
1056 ;; FSF has `insert-file-literally' and `find-file-literally' here.
1058 (defvar after-find-file-from-revert-buffer nil)
1060 (defun after-find-file (&optional error warn noauto
1061 after-find-file-from-revert-buffer
1063 "Called after finding a file and by the default revert function.
1064 Sets buffer mode, parses local variables.
1065 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1066 error in reading the file. WARN non-nil means warn if there
1067 exists an auto-save file more recent than the visited file.
1068 NOAUTO means don't mess with auto-save mode.
1069 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1070 means this call was from `revert-buffer'.
1071 Fifth arg NOMODES non-nil means don't alter the file's modes.
1072 Finishes by calling the functions in `find-file-hooks'."
1073 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1078 (cond ((and error (file-attributes buffer-file-name))
1079 (setq buffer-read-only t)
1080 (gettext "File exists, but cannot be read."))
1081 ((not buffer-read-only)
1083 (file-newer-than-file-p (make-auto-save-file-name)
1085 (format "%s has auto save data; consider M-x recover-file"
1086 (file-name-nondirectory buffer-file-name))
1087 (setq not-serious t)
1088 (if error (gettext "(New file)") nil)))
1090 (setq not-serious t)
1091 (gettext "Note: file is write protected"))
1092 ((file-attributes (directory-file-name default-directory))
1093 (gettext "File not found and directory write-protected"))
1094 ((file-exists-p (file-name-directory buffer-file-name))
1095 (setq buffer-read-only nil))
1097 ;; If the directory the buffer is in doesn't exist,
1098 ;; offer to create it. It's better to do this now
1099 ;; than when we save the buffer, because we want
1100 ;; autosaving to work.
1101 (setq buffer-read-only nil)
1103 (or (file-exists-p (file-name-directory buffer-file-name))
1108 The directory containing %s does not exist. Create? "
1109 (abbreviate-file-name buffer-file-name)))
1110 (make-directory (file-name-directory
1114 (kill-buffer (current-buffer))
1115 (signal 'quit nil))))
1120 (or not-serious (sit-for 1 t)))))
1121 (if (and auto-save-default (not noauto))
1122 (auto-save-mode t)))
1125 (run-hooks 'find-file-hooks)))
1127 (defun normal-mode (&optional find-file)
1128 "Choose the major mode for this buffer automatically.
1129 Also sets up any specified local variables of the file.
1130 Uses the visited file name, the -*- line, and the local variables spec.
1132 This function is called automatically from `find-file'. In that case,
1133 we may set up specified local variables depending on the value of
1134 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1135 otherwise, we query. `enable-local-variables' is ignored if you
1136 run `normal-mode' explicitly."
1138 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1139 (and (condition-case err
1140 (progn (set-auto-mode)
1142 (error (message "File mode specification error: %s"
1143 (prin1-to-string err))
1146 (hack-local-variables (not find-file))
1147 (error (lwarn 'local-variables 'warning
1148 "File local-variables error: %s"
1149 (error-message-string err))))))
1151 ;; `auto-mode-alist' used to contain entries for modes in core and in packages.
1152 ;; The applicable entries are now located in the corresponding modes in
1153 ;; packages, the ones here are for core modes. Ditto for
1154 ;; `interpreter-mode-alist' below.
1155 ;; Per Abrahamsen suggested splitting auto-mode-alist to
1156 ;; several distinct variables such as, in order of precedence,
1157 ;; `user-auto-mode-alist' for users, `package-auto-mode-alist' for
1158 ;; packages and `auto-mode-alist' (which might also be called
1159 ;; `default-auto-mode-alist') for default stuff, such as some of the
1162 (defvar auto-mode-alist
1163 '(("\\.te?xt\\'" . text-mode)
1164 ("\\.el\\'" . emacs-lisp-mode)
1165 ("\\.c?l\\(?:i?sp\\)?\\'" . lisp-mode)
1166 ("\\.article\\'" . text-mode)
1167 ("\\.letter\\'" . text-mode)
1168 ;; Mailer puts message to be edited in /tmp/Re.... or Message
1169 ;; #### Unix-specific!
1170 ("\\`/tmp/Re" . text-mode)
1171 ("/Message[0-9]*\\'" . text-mode)
1172 ;; some news reader is reported to use this
1173 ("^/tmp/fol/" . text-mode)
1174 ;; .emacs following a directory delimiter in either Unix or
1176 ("[/\\][._].*emacs\\'" . emacs-lisp-mode)
1177 ("\\.ml\\'" . lisp-mode)
1179 "Alist of filename patterns vs. corresponding major mode functions.
1180 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1181 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1182 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1183 mode function to use. FUNCTION will be called, unless it is nil.
1185 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1186 calling FUNCTION (if it's not nil), we delete the suffix that matched
1187 REGEXP and search the list again for another match.")
1189 (defvar interpreter-mode-alist
1190 '(("emacs" . emacs-lisp-mode))
1191 "Alist mapping interpreter names to major modes.
1192 This alist is used to guess the major mode of a file based on the
1193 contents of the first line. This line often contains something like:
1195 but may contain something more imaginative like
1198 eval 'exec perl -w -S $0 ${1+\"$@\"}'.
1200 Each alist element looks like (INTERPRETER . MODE).
1201 The car of each element is a regular expression which is compared
1202 with the name of the interpreter specified in the first line.
1203 If it matches, mode MODE is selected.")
1205 (defvar binary-file-regexps
1207 '("\\.\\(?:bz2\\|elc\\|g\\(if\\|z\\)\\|jp\\(eg\\|g\\)\\|png\\|PNG\\|t\\(ar\\|gz\\|iff\\)\\|[Zo]\\)\\'"))
1208 "List of regexps of filenames containing binary (non-text) data.")
1210 ; (eval-when-compile
1211 ; (require 'regexp-opt)
1213 ; (format "\\.\\(?:%s\\)\\'"
1228 (defvar inhibit-first-line-modes-regexps
1230 "List of regexps; if one matches a file name, don't look for `-*-'.")
1232 (defvar inhibit-first-line-modes-suffixes nil
1233 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1234 When checking `inhibit-first-line-modes-regexps', we first discard
1235 from the end of the file name anything that matches one of these regexps.")
1237 (defvar user-init-file
1238 nil ; set by command-line
1239 "File name including directory of user's initialization file.")
1241 (defun set-auto-mode (&optional just-from-file-name)
1242 "Select major mode appropriate for current buffer.
1243 This checks for a -*- mode tag in the buffer's text,
1244 compares the filename against the entries in `auto-mode-alist',
1245 or checks the interpreter that runs this file against
1246 `interpreter-mode-alist'.
1248 It does not check for the `mode:' local variable in the
1249 Local Variables section of the file; for that, use `hack-local-variables'.
1251 If `enable-local-variables' is nil, this function does not check for a
1254 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1255 then we do not set anything but the major mode,
1256 and we don't even do that unless it would come from the file name."
1258 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1259 ;; Do this by calling the hack-local-variables helper to avoid redundancy.
1260 ;; We bind enable-local-variables to nil this time because we're going to
1261 ;; call hack-local-variables-prop-line again later, "for real." Note that
1262 ;; this temporary binding does not prevent hack-local-variables-prop-line
1263 ;; from setting the major mode.
1264 (or (and enable-local-variables
1265 (let ((enable-local-variables nil))
1266 (hack-local-variables-prop-line nil))
1268 ;; It's not in the -*- line, so check the auto-mode-alist, unless
1269 ;; this buffer isn't associated with a file.
1270 (null buffer-file-name)
1271 (let ((name (file-name-sans-versions buffer-file-name))
1274 (setq keep-going nil)
1275 (let ((alist auto-mode-alist)
1278 ;; Find first matching alist entry.
1280 ;; #### This is incorrect. In NT, case sensitivity is a volume
1281 ;; property. For instance, NFS mounts *are* case sensitive.
1282 ;; Need internal function (file-name-case-sensitive f), F
1283 ;; being file or directory name. - kkm
1284 (let ((case-fold-search
1285 (eq system-type 'windows-nt)))
1286 (while (and (not mode) alist)
1287 (if (string-match (car (car alist)) name)
1288 (if (and (consp (cdr (car alist)))
1289 (nth 2 (car alist)))
1291 (setq mode (car (cdr (car alist)))
1292 name (substring name 0 (match-beginning 0))
1294 (setq mode (cdr (car alist))
1296 (setq alist (cdr alist))))
1297 (unless just-from-file-name
1298 ;; If we can't deduce a mode from the file name,
1299 ;; look for an interpreter specified in the first line.
1300 (if (and (null mode)
1301 (save-excursion ; XEmacs
1302 (goto-char (point-min))
1308 (goto-char (point-min)) (end-of-line) (point)))))
1309 (setq alist interpreter-mode-alist)
1311 (if (string-match (car (car alist)) firstline)
1313 (setq mode (cdr (car alist)))
1315 (setq alist (cdr alist)))))))
1317 (if (not (fboundp mode))
1318 (let ((name (package-get-package-provider mode)))
1320 (message "Mode %s is not installed. Download package %s" mode name)
1321 (message "Mode %s either doesn't exist or is not a known package" mode))
1324 (unless (and just-from-file-name
1326 ;; Don't reinvoke major mode.
1327 (eq mode major-mode)
1328 ;; Don't lose on minor modes.
1329 (assq mode minor-mode-alist)))
1330 (funcall mode))))))))))
1332 (defvar hack-local-variables-hook nil
1333 "Normal hook run after processing a file's local variables specs.
1334 Major modes can use this to examine user-specified local variables
1335 in order to initialize other data structure based on them.
1337 This hook runs even if there were no local variables or if their
1338 evaluation was suppressed. See also `enable-local-variables' and
1339 `enable-local-eval'.")
1341 (defun hack-local-variables (&optional force)
1342 "Parse, and bind or evaluate as appropriate, any local variables
1343 for current buffer."
1344 ;; Don't look for -*- if this file name matches any
1345 ;; of the regexps in inhibit-first-line-modes-regexps.
1346 (if (or (null buffer-file-name) ; don't lose if buffer has no file!
1347 (not (let ((temp inhibit-first-line-modes-regexps)
1348 (name (if buffer-file-name
1349 (file-name-sans-versions buffer-file-name)
1351 (while (let ((sufs inhibit-first-line-modes-suffixes))
1352 (while (and sufs (not
1353 (string-match (car sufs) name)))
1354 (setq sufs (cdr sufs)))
1356 (setq name (substring name 0 (match-beginning 0))))
1358 (not (string-match (car temp) name)))
1359 (setq temp (cdr temp))
1362 ;; Look for variables in the -*- line.
1363 (hack-local-variables-prop-line force)
1364 ;; Look for "Local variables:" block in last page.
1365 (hack-local-variables-last-page force)))
1366 (run-hooks 'hack-local-variables-hook))
1368 ;;; Local variables may be specified in the last page of the file (within 3k
1369 ;;; from the end of the file and after the last ^L) in the form
1371 ;;; Local variables:
1372 ;;; variable-name: variable-value
1375 ;;; The lines may begin with a common prefix, like ";;; " in the above
1376 ;;; example. They may also have a common suffix (" */" for example). In
1377 ;;; this form, the local variable "mode" can be used to change the major
1378 ;;; mode, and the local variable "eval" can be used to evaluate an arbitrary
1381 ;;; Local variables may also be specified in the first line of the file.
1382 ;;; Embedded in this line are a pair of "-*-" sequences. What lies between
1383 ;;; them are variable-name/variable-value pairs, like:
1385 ;;; -*- mode: emacs-lisp -*-
1386 ;;; or -*- mode: postscript; version-control: never -*-
1387 ;;; or -*- tags-file-name: "/foo/bar/TAGS" -*-
1389 ;;; The local variable "eval" is not used with this form. For hysterical
1390 ;;; reasons, the syntax "-*- modename -*-" is allowed as well.
1393 (defun hack-local-variables-p (modeline)
1394 (or (eq enable-local-variables t)
1395 (and enable-local-variables
1396 (save-window-excursion
1398 (switch-to-buffer (current-buffer))
1400 ;; If we fail to switch in the selected window,
1401 ;; it is probably a minibuffer.
1402 ;; So try another window.
1404 (switch-to-buffer-other-window (current-buffer))
1406 (switch-to-buffer-other-frame (current-buffer))))))
1407 (or modeline (save-excursion
1409 (set-window-start (selected-window) (point))))
1411 "Set local variables as specified %s of %s? "
1412 (if modeline "in -*- line" "at end")
1413 (if buffer-file-name
1414 (file-name-nondirectory buffer-file-name)
1415 (concat "buffer " (buffer-name)))))))))
1417 (defun hack-local-variables-last-page (&optional force)
1418 ;; Set local variables set in the "Local Variables:" block of the last page.
1420 (goto-char (point-max))
1421 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1422 (if (let ((case-fold-search t))
1423 (and (search-forward "Local Variables:" nil t)
1425 (hack-local-variables-p nil))))
1427 prefix prefixlen suffix start
1428 (enable-local-eval enable-local-eval))
1429 ;; The prefix is what comes before "local variables:" in its line.
1430 ;; The suffix is what comes after "local variables:" in its line.
1431 (skip-chars-forward " \t")
1433 (setq suffix (buffer-substring (point)
1434 (progn (end-of-line) (point)))))
1435 (goto-char (match-beginning 0))
1438 (buffer-substring (point)
1439 (progn (beginning-of-line) (point)))))
1440 (if prefix (setq prefixlen (length prefix)
1441 prefix (regexp-quote prefix)))
1442 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1444 ;; Look at next local variable spec.
1445 (if selective-display (re-search-forward "[\n\C-m]")
1447 ;; Skip the prefix, if any.
1449 (if (looking-at prefix)
1450 (forward-char prefixlen)
1451 (error "Local variables entry is missing the prefix")))
1452 ;; Find the variable name; strip whitespace.
1453 (skip-chars-forward " \t")
1454 (setq start (point))
1455 (skip-chars-forward "^:\n")
1456 (if (eolp) (error "Missing colon in local variables entry"))
1457 (skip-chars-backward " \t")
1458 (let* ((str (buffer-substring start (point)))
1461 ;; Setting variable named "end" means end of list.
1462 (if (string-equal (downcase str) "end")
1464 ;; Otherwise read the variable value.
1465 (skip-chars-forward "^:")
1467 (setq val (read (current-buffer)))
1468 (skip-chars-backward "\n")
1469 (skip-chars-forward " \t")
1470 (or (if suffix (looking-at suffix) (eolp))
1471 (error "Local variables entry is terminated incorrectly"))
1472 ;; Set the variable. "Variables" mode and eval are funny.
1473 (hack-one-local-variable var val))))))))
1475 ;; jwz - New Version 20.1/19.15
1476 (defun hack-local-variables-prop-line (&optional force)
1477 ;; Set local variables specified in the -*- line.
1478 ;; Returns t if mode was set.
1481 (goto-char (point-min))
1482 (skip-chars-forward " \t\n\r")
1483 (let ((end (save-excursion
1484 ;; If the file begins with "#!"
1485 ;; (un*x exec interpreter magic), look
1486 ;; for mode frobs in the first two
1487 ;; lines. You cannot necessarily
1488 ;; put them in the first line of
1489 ;; such a file without screwing up
1490 ;; the interpreter invocation.
1491 (end-of-line (and (looking-at "^#!") 2))
1493 ;; Parse the -*- line into the `result' alist.
1494 (cond ((not (search-forward "-*-" end t))
1495 ;; doesn't have one.
1497 ((looking-at "[ \t]*\\([^ \t\n\r:;]+?\\)\\([ \t]*-\\*-\\)")
1498 ;; Antiquated form: "-*- ModeName -*-".
1501 (intern (buffer-substring
1506 ;; Usual form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1507 ;; (last ";" is optional).
1509 (if (search-forward "-*-" end t)
1510 (setq end (- (point) 3))
1511 (error "-*- not terminated before end of line")))
1512 (while (< (point) end)
1513 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1514 (error "malformed -*- line"))
1515 (goto-char (match-end 0))
1516 ;; There used to be a downcase here,
1517 ;; but the manual didn't say so,
1518 ;; and people want to set var names that aren't all lc.
1519 (let ((key (intern (buffer-substring
1522 (val (save-restriction
1523 (narrow-to-region (point) end)
1524 (read (current-buffer)))))
1525 ;; Case sensitivity! Icepicks in my forehead!
1526 (if (equal (downcase (symbol-name key)) "mode")
1528 (setq result (cons (cons key val) result))
1529 (skip-chars-forward " \t;")))
1530 (setq result (nreverse result))))))
1532 (let ((set-any-p (or force
1533 ;; It's OK to force null specifications.
1535 ;; It's OK to force mode-only specifications.
1536 (let ((remaining result)
1537 (mode-specs-only t))
1539 (if (eq (car (car remaining)) 'mode)
1540 (setq remaining (cdr remaining))
1541 ;; Otherwise, we have a real local.
1542 (setq mode-specs-only nil
1546 ;; Otherwise, check.
1547 (hack-local-variables-p t)))
1550 (let ((key (car (car result)))
1551 (val (cdr (car result))))
1552 (cond ((eq key 'mode)
1554 (let ((mode (intern (concat (downcase (symbol-name val))
1556 ;; Without this guard, `normal-mode' would potentially run
1557 ;; the major mode function twice: once via `set-auto-mode'
1558 ;; and once via `hack-local-variables'.
1559 (if (not (eq mode major-mode))
1563 (hack-one-local-variable key val))
1566 (setq result (cdr result)))
1569 (defconst ignored-local-variables
1570 (list 'enable-local-eval)
1571 "Variables to be ignored in a file's local variable spec.")
1573 ;; Get confirmation before setting these variables as locals in a file.
1574 (put 'debugger 'risky-local-variable t)
1575 (put 'enable-local-eval 'risky-local-variable t)
1576 (put 'ignored-local-variables 'risky-local-variable t)
1577 (put 'eval 'risky-local-variable t)
1578 (put 'file-name-handler-alist 'risky-local-variable t)
1579 (put 'minor-mode-map-alist 'risky-local-variable t)
1580 (put 'after-load-alist 'risky-local-variable t)
1581 (put 'buffer-file-name 'risky-local-variable t)
1582 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1583 (put 'buffer-file-truename 'risky-local-variable t)
1584 (put 'exec-path 'risky-local-variable t)
1585 (put 'load-path 'risky-local-variable t)
1586 (put 'exec-directory 'risky-local-variable t)
1587 (put 'process-environment 'risky-local-variable t)
1588 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1589 (put 'outline-level 'risky-local-variable t)
1590 (put 'rmail-output-file-alist 'risky-local-variable t)
1592 ;; This one is safe because the user gets to check it before it is used.
1593 (put 'compile-command 'safe-local-variable t)
1595 ;(defun hack-one-local-variable-quotep (exp)
1596 ; (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1598 ;; "Set" one variable in a local variables spec.
1599 ;; A few variable names are treated specially.
1600 (defun hack-one-local-variable (var val)
1601 (cond ((eq var 'mode)
1602 (funcall (intern (concat (downcase (symbol-name val))
1604 ((memq var ignored-local-variables)
1606 ;; "Setting" eval means either eval it or do nothing.
1607 ;; Likewise for setting hook variables.
1608 ((or (get var 'risky-local-variable)
1610 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1612 (not (get var 'safe-local-variable))))
1613 ; ;; Permit evaling a put of a harmless property
1614 ; ;; if the args do nothing tricky.
1615 ; (if (or (and (eq var 'eval)
1617 ; (eq (car val) 'put)
1618 ; (hack-one-local-variable-quotep (nth 1 val))
1619 ; (hack-one-local-variable-quotep (nth 2 val))
1620 ; ;; Only allow safe values of lisp-indent-hook;
1622 ; (or (numberp (nth 3 val))
1623 ; (equal (nth 3 val) ''defun))
1624 ; (memq (nth 1 (nth 2 val))
1625 ; '(lisp-indent-hook)))
1626 (if (and (not (zerop (user-uid)))
1627 (or (eq enable-local-eval t)
1628 (and enable-local-eval
1629 (save-window-excursion
1630 (switch-to-buffer (current-buffer))
1633 (set-window-start (selected-window) (point)))
1634 (setq enable-local-eval
1635 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1636 (file-name-nondirectory buffer-file-name))))))))
1638 (save-excursion (eval val))
1639 (make-local-variable var)
1641 (message "Ignoring `eval:' in file's local variables")))
1642 ;; Ordinary variable, really set it.
1643 (t (make-local-variable var)
1646 (defcustom change-major-mode-with-file-name t
1647 "*Non-nil means \\[write-file] should set the major mode from the file name.
1648 However, the mode will not be changed if
1649 \(1) a local variables list or the `-*-' line specifies a major mode, or
1650 \(2) the current major mode is a \"special\" mode,
1651 \ not suitable for ordinary files, or
1652 \(3) the new file name does not particularly specify any mode."
1654 :group 'editing-basics)
1656 (defun set-visited-file-name (filename &optional no-query along-with-file)
1657 "Change name of file visited in current buffer to FILENAME.
1658 The next time the buffer is saved it will go in the newly specified file.
1659 nil or empty string as argument means make buffer not be visiting any file.
1660 Remember to delete the initial contents of the minibuffer
1661 if you wish to pass an empty string as the argument.
1663 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1664 confirmation in the case where another buffer is already visiting FILENAME.
1666 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1667 the old visited file has been renamed to the new name FILENAME."
1668 (interactive "FSet visited file name: ")
1669 (if (buffer-base-buffer)
1670 (error "An indirect buffer cannot visit a file"))
1674 (if (string-equal filename "")
1676 (expand-file-name filename))))
1679 (setq truename (file-truename filename))
1680 ;; #### Do we need to check if truename is non-nil?
1681 (if find-file-use-truenames
1682 (setq filename truename))))
1683 (let ((buffer (and filename (find-buffer-visiting filename))))
1684 (and buffer (not (eq buffer (current-buffer)))
1686 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1689 (or (equal filename buffer-file-name)
1691 (and filename (lock-buffer filename))
1693 (setq buffer-file-name filename)
1694 (if filename ; make buffer name reflect filename.
1695 (let ((new-name (file-name-nondirectory buffer-file-name)))
1696 (if (string= new-name "")
1697 (error "Empty file name"))
1698 (setq default-directory (file-name-directory buffer-file-name))
1699 (or (string= new-name (buffer-name))
1700 (rename-buffer new-name t))))
1701 (setq buffer-backed-up nil)
1703 (clear-visited-file-modtime))
1704 (compute-buffer-file-truename) ; insert-file-contents does this too.
1705 ; ;; Abbreviate the file names of the buffer.
1708 ; (setq buffer-file-truename (abbreviate-file-name truename))
1709 ; (if find-file-visit-truename
1710 ; (setq buffer-file-name buffer-file-truename))))
1711 (setq buffer-file-number
1713 (nthcdr 10 (file-attributes buffer-file-name))
1715 ;; write-file-hooks is normally used for things like ftp-find-file
1716 ;; that visit things that are not local files as if they were files.
1717 ;; Changing to visit an ordinary local file instead should flush the hook.
1718 (kill-local-variable 'write-file-hooks)
1719 (kill-local-variable 'after-save-hook)
1720 (kill-local-variable 'local-write-file-hooks)
1721 (kill-local-variable 'write-file-data-hooks)
1722 (kill-local-variable 'revert-buffer-function)
1723 (kill-local-variable 'backup-inhibited)
1724 ;; If buffer was read-only because of version control,
1725 ;; that reason is gone now, so make it writable.
1726 (when (boundp 'vc-mode)
1728 (setq buffer-read-only nil))
1729 (kill-local-variable 'vc-mode))
1730 ;; Turn off backup files for certain file names.
1731 ;; Since this is a permanent local, the major mode won't eliminate it.
1732 (and buffer-file-name
1733 (not (funcall backup-enable-predicate buffer-file-name))
1735 (make-local-variable 'backup-inhibited)
1736 (setq backup-inhibited t)))
1737 (let ((oauto buffer-auto-save-file-name))
1738 ;; If auto-save was not already on, turn it on if appropriate.
1739 (if (not buffer-auto-save-file-name)
1740 (and buffer-file-name auto-save-default
1742 ;; If auto save is on, start using a new name.
1743 ;; We deliberately don't rename or delete the old auto save
1744 ;; for the old visited file name. This is because perhaps
1745 ;; the user wants to save the new state and then compare with the
1746 ;; previous state from the auto save file.
1747 (setq buffer-auto-save-file-name
1748 (make-auto-save-file-name)))
1749 ;; Rename the old auto save file if any.
1750 (and oauto buffer-auto-save-file-name
1751 (file-exists-p oauto)
1752 (rename-file oauto buffer-auto-save-file-name t)))
1753 (if buffer-file-name
1754 (not along-with-file)
1755 (set-buffer-modified-p t))
1756 ;; Update the major mode, if the file name determines it.
1758 ;; Don't change the mode if it is special.
1759 (or (not change-major-mode-with-file-name)
1760 (get major-mode 'mode-class)
1761 ;; Don't change the mode if the local variable list specifies it.
1762 (hack-local-variables t)
1766 (run-hooks 'after-set-visited-file-name-hooks))
1768 (defun write-file (filename &optional confirm codesys)
1769 "Write current buffer into file FILENAME.
1770 Makes buffer visit that file, and marks it not modified.
1771 If the buffer is already visiting a file, you can specify
1772 a directory name as FILENAME, to write a file of the same
1773 old name in that directory.
1774 If optional second arg CONFIRM is non-nil,
1775 ask for confirmation for overwriting an existing file.
1776 Under XEmacs/Mule, optional third argument specifies the
1777 coding system to use when encoding the file. Interactively,
1778 with a prefix argument, you will be prompted for the coding system."
1779 ;; (interactive "FWrite file: ")
1781 (list (if buffer-file-name
1782 (read-file-name "Write file: "
1784 (read-file-name "Write file: "
1785 (cdr (assq 'default-directory
1786 (buffer-local-variables)))
1787 nil nil (buffer-name)))
1789 (if (and current-prefix-arg (featurep 'file-coding))
1790 (read-coding-system "Coding system: "))))
1791 (and (eq (current-buffer) mouse-grabbed-buffer)
1792 (error "Can't write minibuffer window"))
1793 (or (null filename) (string-equal filename "")
1795 ;; If arg is just a directory,
1796 ;; use same file name, but in that directory.
1797 (if (and (file-directory-p filename) buffer-file-name)
1798 (setq filename (concat (file-name-as-directory filename)
1799 (file-name-nondirectory buffer-file-name))))
1801 (file-exists-p filename)
1802 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1803 (error "Canceled")))
1804 (set-visited-file-name filename)))
1805 (set-buffer-modified-p t)
1806 (setq buffer-read-only nil)
1808 (let ((buffer-file-coding-system (get-coding-system codesys)))
1812 (defun backup-buffer ()
1813 "Make a backup of the disk file visited by the current buffer, if appropriate.
1814 This is normally done before saving the buffer the first time.
1815 If the value is non-nil, it is the result of `file-modes' on the original file;
1816 this means that the caller, after saving the buffer, should change the modes
1817 of the new file to agree with the old modes."
1818 (if buffer-file-name
1819 (let ((handler (find-file-name-handler buffer-file-name 'backup-buffer)))
1821 (funcall handler 'backup-buffer)
1822 (if (and make-backup-files
1823 (not backup-inhibited)
1824 (not buffer-backed-up)
1825 (file-exists-p buffer-file-name)
1826 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1828 (let ((real-file-name buffer-file-name)
1829 backup-info backupname targets setmodes)
1830 ;; If specified name is a symbolic link, chase it to the target.
1831 ;; Thus we make the backups in the directory where the real file is.
1832 (setq real-file-name (file-chase-links real-file-name))
1833 (setq backup-info (find-backup-file-name real-file-name)
1834 backupname (car backup-info)
1835 targets (cdr backup-info))
1836 ;;; (if (file-directory-p buffer-file-name)
1837 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1840 (let ((delete-old-versions
1841 ;; If have old versions to maybe delete,
1842 ;; ask the user to confirm now, before doing anything.
1843 ;; But don't actually delete till later.
1845 (or (eq delete-old-versions t)
1846 (eq delete-old-versions nil))
1847 (or delete-old-versions
1848 (y-or-n-p (format "Delete excess backup versions of %s? "
1849 real-file-name))))))
1850 ;; Actually write the back up file.
1852 (if (or file-precious-flag
1853 ; (file-symlink-p buffer-file-name)
1855 (and backup-by-copying-when-linked
1856 (> (file-nlinks real-file-name) 1))
1857 (and backup-by-copying-when-mismatch
1858 (let ((attr (file-attributes real-file-name)))
1860 (not (file-ownership-preserved-p real-file-name))))))
1862 (copy-file real-file-name backupname t t)
1864 ;; If copying fails because file BACKUPNAME
1865 ;; is not writable, delete that file and try again.
1866 (if (and (file-exists-p backupname)
1867 (not (file-writable-p backupname)))
1868 (delete-file backupname))
1869 (copy-file real-file-name backupname t t)))
1870 ;; rename-file should delete old backup.
1871 (rename-file real-file-name backupname t)
1872 (setq setmodes (file-modes backupname)))
1874 ;; If trouble writing the backup, write it in ~.
1877 (convert-standard-filename "~/%backup%~")))
1878 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1881 (copy-file real-file-name backupname t t)
1883 ;; If copying fails because file BACKUPNAME
1884 ;; is not writable, delete that file and try again.
1885 (if (and (file-exists-p backupname)
1886 (not (file-writable-p backupname)))
1887 (delete-file backupname))
1888 (copy-file real-file-name backupname t t)))))
1889 (setq buffer-backed-up t)
1890 ;; Now delete the old versions, if desired.
1891 (if delete-old-versions
1893 (ignore-file-errors (delete-file (car targets)))
1894 (setq targets (cdr targets))))
1896 (file-error nil)))))))))
1898 (defun file-name-sans-versions (name &optional keep-backup-version)
1899 "Return FILENAME sans backup versions or strings.
1900 This is a separate procedure so your site-init or startup file can
1902 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1903 we do not remove backup version numbers, only true file version numbers."
1904 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1906 (funcall handler 'file-name-sans-versions name keep-backup-version)
1908 (if keep-backup-version
1910 (or (string-match "\\.~[0-9.]+~\\'" name)
1911 ;; XEmacs - VC uses extensions like ".~tagname~" or ".~1.1.5.2~"
1912 (let ((pos (string-match "\\.~\\([^.~ \t]+\\|[0-9.]+\\)~\\'" name)))
1914 ;; #### - is this filesystem check too paranoid?
1915 (file-exists-p (substring name 0 pos))
1917 (string-match "~\\'" name)
1920 (defun file-ownership-preserved-p (file)
1921 "Return t if deleting FILE and rewriting it would preserve the owner."
1922 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1924 (funcall handler 'file-ownership-preserved-p file)
1925 (let ((attributes (file-attributes file)))
1926 ;; Return t if the file doesn't exist, since it's true that no
1927 ;; information would be lost by an (attempted) delete and create.
1928 (or (null attributes)
1929 (= (nth 2 attributes) (user-uid)))))))
1931 (defun file-name-sans-extension (filename)
1932 "Return FILENAME sans final \"extension\".
1933 The extension, in a file name, is the part that follows the last `.'."
1935 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1937 (if (string-match "\\.[^.]*\\'" file)
1938 (if (setq directory (file-name-directory filename))
1939 (expand-file-name (substring file 0 (match-beginning 0))
1941 (substring file 0 (match-beginning 0)))
1944 (defun file-name-extension (filename &optional period)
1945 "Return FILENAME's final \"extension\".
1946 The extension, in a file name, is the part that follows the last `.'.
1947 Return nil for extensionless file names such as `foo'.
1948 Return the empty string for file names such as `foo.'.
1950 If PERIOD is non-nil, then the returned value includes the period
1951 that delimits the extension, and if FILENAME has no extension,
1954 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1955 (if (string-match "\\.[^.]*\\'" file)
1956 (substring file (+ (match-beginning 0) (if period 0 1)))
1960 (defun make-backup-file-name (file)
1961 "Create the non-numeric backup file name for FILE.
1962 This is a separate function so you can redefine it for customization."
1963 ;; FSF has code here for MS-DOS short filenames, not supported in XEmacs.
1966 (defun backup-file-name-p (file)
1967 "Return non-nil if FILE is a backup file name (numeric or not).
1968 This is a separate function so you can redefine it for customization.
1969 You may need to redefine `file-name-sans-versions' as well."
1970 (string-match "~\\'" file))
1972 ;; This is used in various files.
1973 ;; The usage of bv-length is not very clean,
1974 ;; but I can't see a good alternative,
1975 ;; so as of now I am leaving it alone.
1976 (defun backup-extract-version (fn)
1977 "Given the name of a numeric backup file, return the backup number.
1978 Uses the free variable `bv-length', whose value should be
1979 the index in the name where the version number begins."
1980 (declare (special bv-length))
1981 (if (and (string-match "[0-9]+~\\'" fn bv-length)
1982 (= (match-beginning 0) bv-length))
1983 (string-to-int (substring fn bv-length -1))
1986 (defun find-backup-file-name (fn)
1987 "Find a file name for a backup file, and suggestions for deletions.
1988 Value is a list whose car is the name for the backup file
1989 and whose cdr is a list of old versions to consider deleting now.
1990 If the value is nil, don't make a backup."
1991 (declare (special bv-length))
1992 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
1993 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1995 (funcall handler 'find-backup-file-name fn)
1996 (if (eq version-control 'never)
1997 (list (make-backup-file-name fn))
1998 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1999 ;; used by backup-extract-version:
2000 (bv-length (length base-versions))
2004 (deserve-versions-p nil)
2005 (number-to-delete 0))
2007 (setq possibilities (file-name-all-completions
2009 (file-name-directory fn))
2010 versions (sort (mapcar
2011 #'backup-extract-version
2014 high-water-mark (apply #'max 0 versions)
2015 deserve-versions-p (or version-control
2016 (> high-water-mark 0))
2017 number-to-delete (- (length versions)
2018 kept-old-versions kept-new-versions -1))
2020 (setq possibilities nil)))
2021 (if (not deserve-versions-p)
2022 (list (make-backup-file-name fn))
2023 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2024 (if (and (> number-to-delete 0)
2025 ;; Delete nothing if there is overflow
2026 ;; in the number of versions to keep.
2027 (>= (+ kept-new-versions kept-old-versions -1) 0))
2028 (mapcar #'(lambda (n)
2029 (concat fn ".~" (int-to-string n) "~"))
2030 (let ((v (nthcdr kept-old-versions versions)))
2031 (rplacd (nthcdr (1- number-to-delete) v) ())
2034 (defun file-nlinks (filename)
2035 "Return number of names file FILENAME has."
2036 (car (cdr (file-attributes filename))))
2038 (defun file-relative-name (filename &optional directory)
2039 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2040 This function returns a relative file name which is equivalent to FILENAME
2041 when used with that default directory as the default.
2042 If this is impossible (which can happen on MS Windows when the file name
2043 and directory use different drive names) then it returns FILENAME."
2045 (let ((fname (expand-file-name filename)))
2046 (setq directory (file-name-as-directory
2047 (expand-file-name (or directory default-directory))))
2048 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2049 ;; drive names, they can't be relative, so return the absolute name.
2050 (if (and (eq system-type 'windows-nt)
2051 (not (string-equal (substring fname 0 2)
2052 (substring directory 0 2))))
2054 (let ((ancestor ".")
2055 (fname-dir (file-name-as-directory fname)))
2056 (while (and (not (string-match (concat "^" (regexp-quote directory))
2058 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2059 (setq directory (file-name-directory (substring directory 0 -1))
2060 ancestor (if (equal ancestor ".")
2062 (concat "../" ancestor))))
2063 ;; Now ancestor is empty, or .., or ../.., etc.
2064 (if (string-match (concat "^" (regexp-quote directory)) fname)
2065 ;; We matched within FNAME's directory part.
2066 ;; Add the rest of FNAME onto ANCESTOR.
2067 (let ((rest (substring fname (match-end 0))))
2068 (if (and (equal ancestor ".")
2069 (not (equal rest "")))
2070 ;; But don't bother with ANCESTOR if it would give us `./'.
2072 (concat (file-name-as-directory ancestor) rest)))
2073 ;; We matched FNAME's directory equivalent.
2076 (defun save-buffer (&optional args)
2077 "Save current buffer in visited file if modified. Versions described below.
2079 By default, makes the previous version into a backup file
2080 if previously requested or if this is the first save.
2081 With 1 or 3 \\[universal-argument]'s, marks this version
2082 to become a backup when the next save is done.
2083 With 2 or 3 \\[universal-argument]'s,
2084 unconditionally makes the previous version into a backup file.
2085 With argument of 0, never makes the previous version into a backup file.
2087 If a file's name is FOO, the names of its numbered backup versions are
2088 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2089 Numeric backups (rather than FOO~) will be made if value of
2090 `version-control' is not the atom `never' and either there are already
2091 numeric versions of the file being backed up, or `version-control' is
2093 We don't want excessive versions piling up, so there are variables
2094 `kept-old-versions', which tells XEmacs how many oldest versions to keep,
2095 and `kept-new-versions', which tells how many newest versions to keep.
2096 Defaults are 2 old versions and 2 new.
2097 `dired-kept-versions' controls dired's clean-directory (.) command.
2098 If `delete-old-versions' is nil, system will query user
2099 before trimming versions. Otherwise it does it silently."
2101 (let ((modp (buffer-modified-p))
2102 (large (> (buffer-size) 50000))
2103 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2104 (memq args '(16 64)))))
2105 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2106 (if (and modp large) (display-message
2107 'progress (format "Saving file %s..."
2108 (buffer-file-name))))
2110 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2112 (defun delete-auto-save-file-if-necessary (&optional force)
2113 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2114 Normally delete only if the file was written by this XEmacs
2115 since the last real save, but optional arg FORCE non-nil means delete anyway."
2116 (and buffer-auto-save-file-name delete-auto-save-files
2117 (not (string= buffer-file-name buffer-auto-save-file-name))
2118 (or force (recent-auto-save-p))
2120 (ignore-file-errors (delete-file buffer-auto-save-file-name))
2121 (set-buffer-auto-saved))))
2123 ;; XEmacs change (from Sun)
2124 ;; used to communicate with continue-save-buffer:
2125 (defvar continue-save-buffer-hooks-tail nil)
2128 (defun basic-write-file-data (realname truename)
2129 ;; call the hooks until the bytes are put
2130 ;; call write-region as a last resort
2131 (let ((region-written nil)
2132 (hooks write-file-data-hooks))
2133 (while (and hooks (not region-written))
2134 (setq region-written (funcall (car hooks) realname)
2136 (if (not region-written)
2137 (write-region (point-min) (point-max) realname nil t truename))))
2139 (put 'after-save-hook 'permanent-local t)
2140 (defvar after-save-hook nil
2141 "Normal hook that is run after a buffer is saved to its file.
2142 These hooks are considered to pertain to the visited file.
2143 So this list is cleared if you change the visited file name.")
2145 (defun files-fetch-hook-value (hook)
2146 (let ((localval (symbol-value hook))
2147 (globalval (default-value hook)))
2148 (if (memq t localval)
2149 (setq localval (append (delq t localval) (delq t globalval))))
2152 (defun basic-save-buffer ()
2153 "Save the current buffer in its visited file, if it has been modified.
2154 After saving the buffer, run `after-save-hook'."
2157 ;; In an indirect buffer, save its base buffer instead.
2158 (if (buffer-base-buffer)
2159 (set-buffer (buffer-base-buffer)))
2160 (if (buffer-modified-p)
2161 (let ((recent-save (recent-auto-save-p)))
2162 ;; If buffer has no file name, ask user for one.
2163 (or buffer-file-name
2166 (read-file-name "File to save in: ") nil)))
2167 (and (file-exists-p filename)
2168 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2170 (error "Canceled")))
2171 (set-visited-file-name filename)))
2172 (or (verify-visited-file-modtime (current-buffer))
2173 (not (file-exists-p buffer-file-name))
2175 (format "%s has changed since visited or saved. Save anyway? "
2176 (file-name-nondirectory buffer-file-name)))
2177 (error "Save not confirmed"))
2181 ;; Add final newline if required. See `require-final-newline'.
2182 (when (and (not (eq (char-before (point-max)) ?\n)) ; common case
2183 (char-before (point-max)) ; empty buffer?
2184 (not (and (eq selective-display t)
2185 (eq (char-before (point-max)) ?\r)))
2186 (or (eq require-final-newline t)
2187 (and require-final-newline
2189 (format "Buffer %s does not end in newline. Add one? "
2192 (goto-char (point-max))
2195 ;; Run the write-file-hooks until one returns non-nil.
2196 ;; Bind after-save-hook to nil while running the
2197 ;; write-file-hooks so that if this function is called
2198 ;; recursively (from inside a write-file-hook) the
2199 ;; after-hooks will only get run once (from the
2202 ;; Ugh, have to duplicate logic of run-hook-with-args-until-success
2203 (let ((hooks (append (files-fetch-hook-value 'write-contents-hooks)
2204 (files-fetch-hook-value
2205 'local-write-file-hooks)
2206 (files-fetch-hook-value 'write-file-hooks)))
2207 (after-save-hook nil)
2208 (local-write-file-hooks nil)
2209 (write-contents-hooks nil)
2210 (write-file-hooks nil)
2213 (let ((continue-save-buffer-hooks-tail hooks))
2214 (not (setq done (funcall (car hooks))))))
2215 (setq hooks (cdr hooks)))
2216 ;; If a hook returned t, file is already "written".
2217 ;; Otherwise, write it the usual way now.
2219 (basic-save-buffer-1)))
2220 ;; XEmacs: next two clauses (buffer-file-number setting and
2221 ;; set-file-modes) moved into basic-save-buffer-1.
2223 ;; If the auto-save file was recent before this command,
2225 (delete-auto-save-file-if-necessary recent-save)
2226 ;; Support VC `implicit' locking.
2227 (when (fboundp 'vc-after-save)
2229 (run-hooks 'after-save-hook))
2230 (display-message 'no-log "(No changes need to be saved)"))))
2232 ;; This does the "real job" of writing a buffer into its visited file
2233 ;; and making a backup file. This is what is normally done
2234 ;; but inhibited if one of write-file-hooks returns non-nil.
2235 ;; It returns a value to store in setmodes.
2236 (defun basic-save-buffer-1 ()
2237 (let (setmodes tempsetmodes)
2238 (if (not (file-writable-p buffer-file-name))
2239 (let ((dir (file-name-directory buffer-file-name)))
2240 (if (not (file-directory-p dir))
2241 (error "%s is not a directory" dir)
2242 (if (not (file-exists-p buffer-file-name))
2243 (error "Directory %s write-protected" dir)
2245 (format "File %s is write-protected; try to save anyway? "
2246 (file-name-nondirectory
2248 (setq tempsetmodes t)
2250 "Attempt to save to a file which you aren't allowed to write"))))))
2251 (or buffer-backed-up
2252 (setq setmodes (backup-buffer)))
2253 (let ((dir (file-name-directory buffer-file-name)))
2254 (if (and file-precious-flag
2255 (file-writable-p dir))
2256 ;; If file is precious, write temp name, then rename it.
2257 ;; This requires write access to the containing dir,
2258 ;; which is why we don't try it if we don't have that access.
2259 (let ((realname buffer-file-name)
2260 tempname nogood i succeed
2261 (old-modtime (visited-file-modtime)))
2264 ;; Find the temporary name to write under.
2266 (setq tempname (format "%s#tmp#%d" dir i))
2267 (setq nogood (file-exists-p tempname))
2270 (progn (clear-visited-file-modtime)
2271 (write-region (point-min) (point-max)
2272 tempname nil realname
2273 buffer-file-truename)
2275 ;; If writing the temp file fails,
2276 ;; delete the temp file.
2279 (delete-file tempname)
2280 (set-visited-file-modtime old-modtime))))
2281 ;; Since we have created an entirely new file
2282 ;; and renamed it, make sure it gets the
2283 ;; right permission bits set.
2284 (setq setmodes (file-modes buffer-file-name))
2285 ;; We succeeded in writing the temp file,
2287 (rename-file tempname buffer-file-name t))
2288 ;; If file not writable, see if we can make it writable
2289 ;; temporarily while we write it.
2290 ;; But no need to do so if we have just backed it up
2291 ;; (setmodes is set) because that says we're superseding.
2292 (cond ((and tempsetmodes (not setmodes))
2293 ;; Change the mode back, after writing.
2294 (setq setmodes (file-modes buffer-file-name))
2295 (set-file-modes buffer-file-name 511)))
2296 (basic-write-file-data buffer-file-name buffer-file-truename)))
2297 (setq buffer-file-number
2298 (if buffer-file-name
2299 (nth 10 (file-attributes buffer-file-name))
2303 (set-file-modes buffer-file-name setmodes)
2306 ;; XEmacs change, from Sun
2307 (defun continue-save-buffer ()
2308 "Provide a clean way for a write-file-hook to wrap AROUND
2309 the execution of the remaining hooks and writing to disk.
2310 Do not call this function except from a functions
2311 on the `write-file-hooks' or `write-contents-hooks' list.
2312 A hook that calls this function must return non-nil,
2313 to signal completion to its caller. `continue-save-buffer'
2314 always returns non-nil."
2315 (let ((hooks (cdr (or continue-save-buffer-hooks-tail
2317 "continue-save-buffer called outside a write-file-hook!"))))
2319 ;; Do something like this:
2320 ;; (let ((write-file-hooks hooks)) (basic-save-buffer))
2321 ;; First run the rest of the hooks.
2323 (let ((continue-save-buffer-hooks-tail hooks))
2324 (not (setq done (funcall (car hooks))))))
2325 (setq hooks (cdr hooks)))
2327 ;; If a hook returned t, file is already "written".
2329 (basic-save-buffer-1))
2330 'continue-save-buffer))
2332 (defcustom save-some-buffers-query-display-buffer t
2333 "*Non-nil makes `\\[save-some-buffers]' switch to the buffer offered for saving."
2335 :group 'editing-basics)
2337 (defun save-some-buffers (&optional arg exiting)
2338 "Save some modified file-visiting buffers. Asks user about each one.
2339 Optional argument (the prefix) non-nil means save all with no questions.
2340 Optional second argument EXITING means ask about certain non-file buffers
2341 as well as about file buffers."
2344 ;; `delete-other-windows' can bomb during autoloads generation, so
2346 (if (or noninteractive
2347 (eq (selected-window) (minibuffer-window))
2348 (not save-some-buffers-query-display-buffer))
2349 ;; If playing with windows is unsafe or undesired, just do the
2351 (save-some-buffers-1 arg exiting nil)
2352 ;; Else, protect the windows.
2353 (when (save-window-excursion
2354 (save-some-buffers-1 arg exiting t))
2358 ;; XEmacs - do not use queried flag
2359 (defun save-some-buffers-1 (arg exiting switch-buffer)
2360 (let* ((switched nil)
2366 (and (buffer-modified-p buffer)
2367 (not (buffer-base-buffer buffer))
2369 (not (symbol-value-in-buffer 'save-buffers-skip buffer))
2371 (buffer-file-name buffer)
2375 (and buffer-offer-save (> (buffer-size) 0)))))
2378 ;; #### We should provide a per-buffer means to
2379 ;; disable the switching. For instance, you might
2380 ;; want to turn it off for buffers the contents of
2381 ;; which is meaningless to humans, such as
2383 (when (and switch-buffer
2384 ;; map-y-or-n-p is displaying help
2385 (not (eq last-buffer buffer)))
2386 (unless (one-window-p)
2387 (delete-other-windows))
2389 ;; #### Consider using `display-buffer' here for 21.1!
2390 ;;(display-buffer buffer nil (selected-frame)))
2391 (switch-to-buffer buffer t))
2392 (if (buffer-file-name buffer)
2393 (format "Save file %s? "
2394 (buffer-file-name buffer))
2395 (format "Save buffer %s? "
2396 (buffer-name buffer)))))
2397 (setq last-buffer buffer)))
2404 '("buffer" "buffers" "save")
2405 ;;instead of this we just say "yes all", "no all", etc.
2406 ;;"save all the rest"
2407 ;;"save only this buffer" "save no more buffers")
2408 ;; this is rather bogus. --ben
2409 ;; (it makes the dialog box too big, and you get an error
2410 ;; "wrong type argument: framep, nil" when you hit q after
2411 ;; choosing the option from the dialog box)
2413 ;; We should fix the dialog box rather than disabling
2415 (list (list ?\C-r (lambda (buf)
2416 ;; #### FSF has an EXIT-ACTION argument
2417 ;; to `view-buffer'.
2419 (setq view-exit-action
2421 (exit-recursive-edit)))
2423 ;; Return nil to ask about BUF again.
2425 "%_Display Buffer"))))
2427 (and save-abbrevs abbrevs-changed
2430 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
2431 (write-abbrev-file nil))
2432 ;; Don't keep bothering user if he says no.
2433 (setq abbrevs-changed nil)
2435 (or (> files-done 0) abbrevs-done
2436 (display-message 'no-log "(No files need saving)"))
2440 (defun not-modified (&optional arg)
2441 "Mark current buffer as unmodified, not needing to be saved.
2442 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2444 It is not a good idea to use this function in Lisp programs, because it
2445 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2447 (if arg ;; rewritten for I18N3 snarfing
2448 (display-message 'command "Modification-flag set")
2449 (display-message 'command "Modification-flag cleared"))
2450 (set-buffer-modified-p arg))
2452 (defun toggle-read-only (&optional arg)
2453 "Toggle the current buffer's read-only status.
2454 With arg, set read-only iff arg is positive."
2456 (setq buffer-read-only
2458 (not buffer-read-only)
2459 (> (prefix-numeric-value arg) 0)))
2460 ;; Force modeline redisplay
2463 (defun insert-file (filename &optional codesys)
2464 "Insert contents of file FILENAME into buffer after point.
2465 Set mark after the inserted text.
2467 Under XEmacs/Mule, optional second argument specifies the
2468 coding system to use when decoding the file. Interactively,
2469 with a prefix argument, you will be prompted for the coding system.
2471 This function is meant for the user to run interactively.
2472 Don't call it from programs! Use `insert-file-contents' instead.
2473 \(Its calling sequence is different; see its documentation)."
2474 (interactive "*fInsert file: \nZCoding system: ")
2475 (if (file-directory-p filename)
2476 (signal 'file-error (list "Opening input file" "file is a directory"
2480 (let ((coding-system-for-read
2481 (get-coding-system codesys)))
2482 (insert-file-contents filename))
2483 (insert-file-contents filename))))
2484 (push-mark (+ (point) (car (cdr tem))))))
2486 (defun append-to-file (start end filename &optional codesys)
2487 "Append the contents of the region to the end of file FILENAME.
2488 When called from a function, expects three arguments,
2489 START, END and FILENAME. START and END are buffer positions
2490 saying what text to write.
2491 Under XEmacs/Mule, optional fourth argument specifies the
2492 coding system to use when encoding the file. Interactively,
2493 with a prefix argument, you will be prompted for the coding system."
2494 (interactive "r\nFAppend to file: \nZCoding system: ")
2496 (let ((buffer-file-coding-system (get-coding-system codesys)))
2497 (write-region start end filename t))
2498 (write-region start end filename t)))
2500 (defun file-newest-backup (filename)
2501 "Return most recent backup file for FILENAME or nil if no backups exist."
2502 (let* ((filename (expand-file-name filename))
2503 (file (file-name-nondirectory filename))
2504 (dir (file-name-directory filename))
2505 (comp (file-name-all-completions file dir))
2508 (setq file (concat dir (car comp))
2510 (if (and (backup-file-name-p file)
2511 (or (null newest) (file-newer-than-file-p file newest)))
2512 (setq newest file)))
2515 (defun rename-uniquely ()
2516 "Rename current buffer to a similar name not already taken.
2517 This function is useful for creating multiple shell process buffers
2518 or multiple mail buffers, etc."
2521 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2522 (not (and buffer-file-name
2523 (string= (buffer-name)
2524 (file-name-nondirectory
2525 buffer-file-name)))))
2526 ;; If the existing buffer name has a <NNN>,
2527 ;; which isn't part of the file name (if any),
2528 ;; then get rid of that.
2529 (substring (buffer-name) 0 (match-beginning 0))
2531 (new-buf (generate-new-buffer base-name))
2532 (name (buffer-name new-buf)))
2533 (kill-buffer new-buf)
2534 (rename-buffer name)
2535 (redraw-modeline))))
2537 (defun make-directory-path (path)
2538 "Create all the directories along path that don't exist yet."
2539 (interactive "Fdirectory path to create: ")
2540 (make-directory path t))
2542 (defun make-directory (dir &optional parents)
2543 "Create the directory DIR and any nonexistent parent dirs.
2544 Interactively, the default choice of directory to create
2545 is the current default directory for file names.
2546 That is useful when you have visited a file in a nonexistent directory.
2548 Noninteractively, the second (optional) argument PARENTS says whether
2549 to create parent directories if they don't exist."
2550 (interactive (list (let ((current-prefix-arg current-prefix-arg))
2551 (read-directory-name "Create directory: "))
2552 current-prefix-arg))
2553 (let ((handler (find-file-name-handler dir 'make-directory)))
2555 (funcall handler 'make-directory dir parents)
2557 (make-directory-internal dir)
2558 (let ((dir (directory-file-name (expand-file-name dir)))
2560 (while (not (file-exists-p dir))
2561 (setq create-list (cons dir create-list)
2562 dir (directory-file-name (file-name-directory dir))))
2564 (make-directory-internal (car create-list))
2565 (setq create-list (cdr create-list))))))))
2567 (put 'revert-buffer-function 'permanent-local t)
2568 (defvar revert-buffer-function nil
2569 "Function to use to revert this buffer, or nil to do the default.
2570 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2571 which are the arguments that `revert-buffer' received.")
2573 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2574 (defvar revert-buffer-insert-file-contents-function nil
2575 "Function to use to insert contents when reverting this buffer.
2576 Gets two args, first the nominal file name to use,
2577 and second, t if reading the auto-save file.
2578 If the current buffer contents are to be discarded, the function must do
2581 (defvar before-revert-hook nil
2582 "Normal hook for `revert-buffer' to run before reverting.
2583 If `revert-buffer-function' is used to override the normal revert
2584 mechanism, this hook is not used.")
2586 (defvar after-revert-hook nil
2587 "Normal hook for `revert-buffer' to run after reverting.
2588 Note that the hook value that it runs is the value that was in effect
2589 before reverting; that makes a difference if you have buffer-local
2592 If `revert-buffer-function' is used to override the normal revert
2593 mechanism, this hook is not used.")
2595 (defvar revert-buffer-internal-hook nil
2598 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2599 "Replace the buffer text with the text of the visited file on disk.
2600 This undoes all changes since the file was visited or saved.
2601 With a prefix argument, offer to revert from latest auto-save file, if
2602 that is more recent than the visited file.
2604 This command also refreshes certain special buffers that contain text
2605 which doesn't come from a file, but reflects some other data base
2606 instead: for example, Dired buffers and buffer-list buffers. This is
2607 implemented by having the modes set `revert-buffer-function'.
2609 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2610 to revert from the auto-save file when this is nil. Note that the
2611 sense of this argument is the reverse of the prefix argument, for the
2612 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2615 Optional second argument NOCONFIRM means don't ask for confirmation at
2618 Optional third argument PRESERVE-MODES non-nil means don't alter
2619 the buffer's modes. Otherwise, reinitialize them using `normal-mode'.
2621 If the value of `revert-buffer-function' is non-nil, it is called to
2622 do all the work for this command. Otherwise, the hooks
2623 `before-revert-hook' and `after-revert-hook' are run at the beginning
2624 and the end, and if `revert-buffer-insert-file-contents-function' is
2625 non-nil, it is called instead of rereading visited file contents.
2627 If the buffer-modified flag is nil, and we are not reverting from an
2628 auto-save file, then compare the contents of the buffer and the file.
2629 Revert only if they differ."
2631 ;; I admit it's odd to reverse the sense of the prefix argument, but
2632 ;; there is a lot of code out there which assumes that the first
2633 ;; argument should be t to avoid consulting the auto-save file, and
2634 ;; there's no straightforward way to encourage authors to notice a
2635 ;; reversal of the argument sense. So I'm just changing the user
2636 ;; interface, but leaving the programmatic interface the same.
2637 (interactive (list (not current-prefix-arg)))
2638 (if revert-buffer-function
2639 (funcall revert-buffer-function ignore-auto noconfirm)
2640 (let* ((opoint (point))
2644 (auto-save-p (and (not ignore-auto)
2645 (recent-auto-save-p)
2646 buffer-auto-save-file-name
2647 (file-readable-p buffer-auto-save-file-name)
2649 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2650 (file-name (if auto-save-p
2651 buffer-auto-save-file-name
2653 (cond ((null file-name)
2654 (error "Buffer does not seem to be associated with any file"))
2656 (and (not (buffer-modified-p))
2657 (dolist (rx revert-without-query found)
2658 (when (string-match rx file-name)
2660 ;; If we will call revert-buffer-internal, delay prompting
2661 (and (not auto-save-p)
2662 (not (buffer-modified-p))
2663 (setq delay-prompt t))
2664 (yes-or-no-p (format "Revert buffer from file %s? "
2666 (run-hooks 'before-revert-hook)
2667 (cond ((or auto-save-p
2669 ;; Do we need to do expensive reversion? Compare ...
2670 (and (setq newbuf (revert-buffer-internal
2672 ;; ... and if different, prompt
2676 (format "Revert buffer from file %s? "
2678 ;; If file was backed up but has changed since,
2679 ;; we should make another backup.
2680 (and (not auto-save-p)
2681 (not (verify-visited-file-modtime (current-buffer)))
2682 (setq buffer-backed-up nil))
2683 ;; Get rid of all undo records for this buffer.
2684 (or (eq buffer-undo-list t)
2685 (setq buffer-undo-list nil))
2686 ;; Effectively copy the after-revert-hook status,
2687 ;; since after-find-file will clobber it.
2688 (let ((global-hook (default-value 'after-revert-hook))
2689 (local-hook-p (local-variable-p 'after-revert-hook
2691 (local-hook (and (local-variable-p 'after-revert-hook
2693 after-revert-hook)))
2694 (let (buffer-read-only
2695 ;; Don't make undo records for the reversion.
2696 (buffer-undo-list t))
2697 (if revert-buffer-insert-file-contents-function
2698 (funcall revert-buffer-insert-file-contents-function
2699 file-name auto-save-p)
2700 (if (not (file-exists-p file-name))
2701 (error "File %s no longer exists!" file-name))
2702 ;; Bind buffer-file-name to nil
2703 ;; so that we don't try to lock the file.
2704 (let ((buffer-file-name nil))
2708 (insert-file-contents file-name (not auto-save-p)
2710 (goto-char (min opoint (point-max)))
2711 ;; Recompute the truename in case changes in symlinks
2712 ;; have changed the truename.
2713 ;;XEmacs: already done by insert-file-contents
2714 ;;(setq buffer-file-truename
2715 ;;(abbreviate-file-name (file-truename buffer-file-name)))
2716 (after-find-file nil nil t t preserve-modes)
2717 ;; Run after-revert-hook as it was before we reverted.
2718 (setq-default revert-buffer-internal-hook global-hook)
2721 (make-local-variable 'revert-buffer-internal-hook)
2722 (setq revert-buffer-internal-hook local-hook))
2723 (kill-local-variable 'revert-buffer-internal-hook))
2724 (run-hooks 'revert-buffer-internal-hook)))
2726 ;; The resultant buffer is identical, alter
2727 ;; modtime, update mods and exit
2728 (set-visited-file-modtime)
2729 (after-find-file nil nil t t t)
2730 ;; We preserved modes above so fixup the local
2731 ;; variables manually
2733 (hack-local-variables)
2734 (error (lwarn 'local-variables 'warning
2735 "File local-variables error: %s"
2736 (error-message-string err)))))
2740 ;; #### something like `revert-buffer-compare-with-file' is a better name
2741 ;; #### why is the argument optional?
2742 (defun revert-buffer-internal (&optional file-name)
2743 "Read contents of FILE-NAME into a buffer, and compare to current buffer.
2744 Return nil if identical, and the new buffer if different."
2746 (let* ((newbuf (get-buffer-create " *revert*"))
2750 (let (buffer-read-only
2751 (buffer-undo-list t)
2752 after-change-function
2753 after-change-functions
2754 before-change-function
2755 before-change-functions)
2756 (if revert-buffer-insert-file-contents-function
2757 (funcall revert-buffer-insert-file-contents-function
2759 (if (not (file-exists-p file-name))
2760 (error "File %s no longer exists!" file-name))
2762 (insert-file-contents file-name nil nil nil t)
2763 (setq bmin (point-min)
2764 bmax (point-max)))))
2765 (if (not (and (eq bmin (point-min))
2766 (eq bmax (point-max))
2767 (eq (compare-buffer-substrings
2768 newbuf bmin bmax (current-buffer) bmin bmax) 0)))
2770 (and (kill-buffer newbuf) nil))))
2772 (defun recover-file (file)
2773 "Visit file FILE, but get contents from its last auto-save file."
2774 ;; Actually putting the file name in the minibuffer should be used
2776 ;; Not just because users often use the default.
2777 (interactive "FRecover file: ")
2778 (setq file (expand-file-name file))
2779 (let ((handler (or (find-file-name-handler file 'recover-file)
2780 (find-file-name-handler
2781 (let ((buffer-file-name file))
2782 (make-auto-save-file-name))
2785 (funcall handler 'recover-file file)
2786 (if (auto-save-file-name-p (file-name-nondirectory file))
2787 (error "%s is an auto-save file" file))
2788 (let ((file-name (let ((buffer-file-name file))
2789 (make-auto-save-file-name))))
2790 (cond ((if (file-exists-p file)
2791 (not (file-newer-than-file-p file-name file))
2792 (not (file-exists-p file-name)))
2793 (error "Auto-save file %s not current" file-name))
2794 ((save-window-excursion
2795 ;; XEmacs change: use insert-directory instead of
2796 ;; calling ls directly.
2797 (with-output-to-temp-buffer "*Directory*"
2798 (buffer-disable-undo standard-output)
2800 (set-buffer "*Directory*")
2801 (setq default-directory (file-name-directory file))
2802 (insert-directory file
2803 (if (file-symlink-p file) "-lL" "-l"))
2804 (setq default-directory (file-name-directory file-name))
2805 (insert-directory file-name "-l")))
2806 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2807 (switch-to-buffer (find-file-noselect file t))
2808 (let ((buffer-read-only nil))
2810 (insert-file-contents file-name nil))
2811 (after-find-file nil nil t))
2812 (t (error "Recover-file cancelled.")))))))
2814 (defun recover-session ()
2815 "Recover auto save files from a previous Emacs session.
2816 This command first displays a Dired buffer showing you the
2817 previous sessions that you could recover from.
2818 To choose one, move point to the proper line and then type C-c C-c.
2819 Then you'll be asked about a number of files to recover."
2821 (unless (fboundp 'dired)
2822 (error "recover-session requires dired"))
2823 (if (null auto-save-list-file-prefix)
2825 "You set `auto-save-list-file-prefix' to disable making session files"))
2826 (dired (concat auto-save-list-file-prefix "*"))
2827 (goto-char (point-min))
2828 (or (looking-at "Move to the session you want to recover,")
2829 (let ((inhibit-read-only t))
2830 (insert "Move to the session you want to recover,\n"
2831 "then type C-c C-c to select it.\n\n"
2832 "You can also delete some of these files;\n"
2833 "type d on a line to mark that file for deletion.\n\n")))
2834 (use-local-map (let ((map (make-sparse-keymap)))
2835 (set-keymap-parents map (list (current-local-map)))
2837 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2839 (defun recover-session-finish ()
2840 "Choose one saved session to recover auto-save files from.
2841 This command is used in the special Dired buffer created by
2842 \\[recover-session]."
2844 ;; Get the name of the session file to recover from.
2845 (let ((file (dired-get-filename))
2847 (buffer (get-buffer-create " *recover*")))
2848 ;; #### dired-do-flagged-delete in FSF.
2849 ;; This version is for ange-ftp
2850 ;;(dired-do-deletions t)
2851 ;; This version is for efs
2852 (dired-expunge-deletions)
2855 ;; Read in the auto-save-list file.
2858 (insert-file-contents file)
2859 ;; Loop thru the text of that file
2860 ;; and get out the names of the files to recover.
2862 (let (thisfile autofile)
2864 ;; This is a pair of lines for a non-file-visiting buffer.
2865 ;; Get the auto-save file name and manufacture
2866 ;; a "visited file name" from that.
2870 (buffer-substring-no-properties
2878 (file-name-nondirectory autofile)
2880 (file-name-directory autofile)))
2882 ;; This pair of lines is a file-visiting
2883 ;; buffer. Use the visited file name.
2886 (buffer-substring-no-properties
2887 (point) (progn (end-of-line) (point))))
2890 (buffer-substring-no-properties
2891 (point) (progn (end-of-line) (point))))
2893 ;; Ignore a file if its auto-save file does not exist now.
2894 (if (file-exists-p autofile)
2895 (setq files (cons thisfile files)))))
2896 (setq files (nreverse files))
2897 ;; The file contains a pair of line for each auto-saved buffer.
2898 ;; The first line of the pair contains the visited file name
2899 ;; or is empty if the buffer was not visiting a file.
2900 ;; The second line is the auto-save file name.
2902 (map-y-or-n-p "Recover %s? "
2905 (save-excursion (recover-file file))
2907 "Failed to recover `%s'" file)))
2909 '("file" "files" "recover"))
2910 (message "No files can be recovered from this session now")))
2911 (kill-buffer buffer))))
2913 (defun kill-some-buffers (&optional list)
2914 "For each buffer in LIST, ask whether to kill it.
2915 LIST defaults to all existing live buffers."
2918 (setq list (buffer-list)))
2920 (let* ((buffer (car list))
2921 (name (buffer-name buffer)))
2922 (and (not (string-equal name ""))
2923 (/= (aref name 0) ?\ )
2926 (if (buffer-modified-p buffer)
2927 (gettext "Buffer %s HAS BEEN EDITED. Kill? ")
2928 (gettext "Buffer %s is unmodified. Kill? "))
2930 (kill-buffer buffer)))
2931 (setq list (cdr list))))
2933 (defun auto-save-mode (arg)
2934 "Toggle auto-saving of contents of current buffer.
2935 With prefix argument ARG, turn auto-saving on if positive, else off."
2937 (setq buffer-auto-save-file-name
2939 (or (not buffer-auto-save-file-name)
2940 ;; If autosave is off because buffer has shrunk,
2941 ;; then toggling should turn it on.
2942 (< buffer-saved-size 0))
2943 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2944 (if (and buffer-file-name auto-save-visited-file-name
2945 (not buffer-read-only))
2947 (make-auto-save-file-name))))
2948 ;; If -1 was stored here, to temporarily turn off saving,
2950 (and (< buffer-saved-size 0)
2951 (setq buffer-saved-size 0))
2953 (if buffer-auto-save-file-name ;; rewritten for I18N3 snarfing
2954 (display-message 'command "Auto-save on (in this buffer)")
2955 (display-message 'command "Auto-save off (in this buffer)")))
2956 buffer-auto-save-file-name)
2958 (defun rename-auto-save-file ()
2959 "Adjust current buffer's auto save file name for current conditions.
2960 Also rename any existing auto save file, if it was made in this session."
2961 (let ((osave buffer-auto-save-file-name))
2962 (setq buffer-auto-save-file-name
2963 (make-auto-save-file-name))
2964 (if (and osave buffer-auto-save-file-name
2965 (not (string= buffer-auto-save-file-name buffer-file-name))
2966 (not (string= buffer-auto-save-file-name osave))
2967 (file-exists-p osave)
2968 (recent-auto-save-p))
2969 (rename-file osave buffer-auto-save-file-name t))))
2971 ;; make-auto-save-file-name and auto-save-file-name-p are now only in
2975 (defun wildcard-to-regexp (wildcard)
2976 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2977 The generated regexp will match a filename iff the filename
2978 matches that wildcard according to shell rules. Only wildcards known
2979 by `sh' are supported."
2980 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
2981 ;; Copy the initial run of non-special characters.
2982 (result (substring wildcard 0 i))
2983 (len (length wildcard)))
2984 ;; If no special characters, we're almost done.
2987 (let ((ch (aref wildcard i))
2993 ((eq ch ?\[) ; [...] maps to regexp char class
2998 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3001 (if (eq (aref wildcard i) ?\])
3006 ((eq (aref wildcard i) ?^)
3007 ;; Found "[^". Insert a `\0' character
3008 ;; (which cannot happen in a filename)
3009 ;; into the character class, so that `^'
3010 ;; is not the first character after `[',
3011 ;; and thus non-special in a regexp.
3015 ((eq (aref wildcard i) ?\])
3016 ;; I don't think `]' can appear in a
3017 ;; character class in a wildcard, but
3018 ;; let's be general here.
3023 (prog1 ; copy everything upto next `]'.
3026 (setq j (string-match
3028 (setq i (if j (1- j) (1- len)))))))
3030 ((eq ch ?*) "[^\000]*")
3034 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3035 ((eq ch ??) "[^\000]")
3036 (t (char-to-string ch)))))
3038 ;; Shell wildcards should match the entire filename,
3039 ;; not its part. Make the regexp say so.
3040 (concat "\\`" result "\\'")))
3042 (defcustom list-directory-brief-switches "-CF"
3043 "*Switches for list-directory to pass to `ls' for brief listing."
3047 (defcustom list-directory-verbose-switches "-l"
3048 "*Switches for list-directory to pass to `ls' for verbose listing,"
3052 (defun list-directory (dirname &optional verbose)
3053 "Display a list of files in or matching DIRNAME, a la `ls'.
3054 DIRNAME is globbed by the shell if necessary.
3055 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3056 Actions controlled by variables `list-directory-brief-switches'
3057 and `list-directory-verbose-switches'."
3058 (interactive (let ((pfx current-prefix-arg))
3059 (list (read-file-name (if pfx (gettext "List directory (verbose): ")
3060 (gettext "List directory (brief): "))
3061 nil default-directory nil)
3063 (let ((switches (if verbose list-directory-verbose-switches
3064 list-directory-brief-switches)))
3065 (or dirname (setq dirname default-directory))
3066 (setq dirname (expand-file-name dirname))
3067 (with-output-to-temp-buffer "*Directory*"
3068 (buffer-disable-undo standard-output)
3069 (princ "Directory ")
3073 (set-buffer "*Directory*")
3074 (setq default-directory (file-name-directory dirname))
3075 (let ((wildcard (not (file-directory-p dirname))))
3076 (insert-directory dirname switches wildcard (not wildcard)))))))
3078 (defvar insert-directory-program "ls"
3079 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3082 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3083 ;; FULL-DIRECTORY-P is nil.
3084 ;; The single line of output must display FILE's name as it was
3085 ;; given, namely, an absolute path name.
3086 ;; - must insert exactly one line for each file if WILDCARD or
3087 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3088 ;; before the file lines, plus optional text after the file lines.
3089 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3091 ;; File lines should display the basename.
3092 ;; - must be consistent with
3093 ;; - functions dired-move-to-filename, (these two define what a file line is)
3094 ;; dired-move-to-end-of-filename,
3095 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3096 ;; dired-insert-headerline
3097 ;; dired-after-subdir-garbage (defines what a "total" line is)
3098 ;; - variable dired-subdir-regexp
3099 (defun insert-directory (file switches &optional wildcard full-directory-p)
3100 "Insert directory listing for FILE, formatted according to SWITCHES.
3101 Leaves point after the inserted text.
3102 SWITCHES may be a string of options, or a list of strings.
3103 Optional third arg WILDCARD means treat FILE as shell wildcard.
3104 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3105 switches do not contain `d', so that a full listing is expected.
3107 This works by running a directory listing program
3108 whose name is in the variable `insert-directory-program'.
3109 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3110 ;; We need the directory in order to find the right handler.
3111 (let ((handler (find-file-name-handler (expand-file-name file)
3112 'insert-directory)))
3114 (funcall handler 'insert-directory file switches
3115 wildcard full-directory-p)
3117 ;; [mswindows-insert-directory should be called
3118 ;; nt-insert-directory - kkm]. not true any more according to
3119 ;; my new naming scheme. --ben
3120 ((and (fboundp 'mswindows-insert-directory)
3121 (eq system-type 'windows-nt))
3122 (mswindows-insert-directory file switches wildcard full-directory-p))
3125 ;; Run ls in the directory of the file pattern we asked for.
3126 (let ((default-directory
3127 (if (file-name-absolute-p file)
3128 (file-name-directory file)
3129 (file-name-directory (expand-file-name file))))
3130 (pattern (file-name-nondirectory file))
3132 ;; Quote some characters that have special meanings in shells;
3133 ;; but don't quote the wildcards--we want them to be special.
3134 ;; We also currently don't quote the quoting characters
3135 ;; in case people want to use them explicitly to quote
3136 ;; wildcard characters.
3137 ;;#### Unix-specific
3138 (while (string-match "[ \t\n;<>&|()#$]" pattern start)
3140 (concat (substring pattern 0 (match-beginning 0))
3142 (substring pattern (match-beginning 0)))
3143 start (1+ (match-end 0))))
3144 (call-process shell-file-name nil t nil
3145 "-c" (concat "\\" ;; Disregard shell aliases!
3146 insert-directory-program
3148 (if (stringp switches)
3150 (mapconcat 'identity switches " "))
3153 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3154 ;; directory if FILE is a symbolic link.
3155 (apply 'call-process
3156 insert-directory-program nil t nil
3158 (if (listp switches)
3159 (setq list switches)
3160 (if (not (equal switches ""))
3162 ;; Split the switches at any spaces
3163 ;; so we can pass separate options as separate args.
3164 (while (string-match " " switches)
3165 (setq list (cons (substring switches 0 (match-beginning 0))
3167 switches (substring switches (match-end 0))))
3168 (setq list (cons switches list)))))
3171 (if full-directory-p
3172 (concat (file-name-as-directory file)
3173 ;;#### Unix-specific
3177 (defvar kill-emacs-query-functions nil
3178 "Functions to call with no arguments to query about killing XEmacs.
3179 If any of these functions returns nil, killing Emacs is cancelled.
3180 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3181 but `kill-emacs', the low level primitive, does not.
3182 See also `kill-emacs-hook'.")
3184 (defun save-buffers-kill-emacs (&optional arg)
3185 "Offer to save each buffer, then kill this XEmacs process.
3186 With prefix arg, silently save all file-visiting buffers, then kill."
3188 (save-some-buffers arg t)
3189 (and (or (not (memq t (mapcar #'(lambda (buf) (and (buffer-file-name buf)
3190 (buffer-modified-p buf)))
3192 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3193 (or (not (fboundp 'process-list))
3194 ;; process-list is not defined on VMS.
3195 (let ((processes (process-list))
3198 (and (memq (process-status (car processes)) '(run stop open))
3199 (let ((val (process-kill-without-query (car processes))))
3200 (process-kill-without-query (car processes) val)
3203 (setq processes (cdr processes)))
3207 (save-window-excursion
3208 (delete-other-windows)
3211 "Active processes exist; kill them and exit anyway? "))))))
3212 ;; Query the user for other things, perhaps.
3213 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3216 (defun symlink-expand-file-name (filename)
3217 "If FILENAME is a symlink, return its non-symlink equivalent.
3218 Unlike `file-truename', this doesn't chase symlinks in directory
3219 components of the file or expand a relative pathname into an
3222 (while (and (> count 0) (file-symlink-p filename))
3223 (setq filename (file-symlink-p filename)
3227 (error "Apparently circular symlink path"))))
3229 ;; Suggested by Michael Kifer <kifer@CS.SunySB.EDU>
3230 (defun file-remote-p (file-name)
3231 "Test whether FILE-NAME is looked for on a remote system."
3232 (cond ((not allow-remote-paths) nil)
3233 ((featurep 'ange-ftp) (ange-ftp-ftp-path file-name))
3234 ((fboundp 'efs-ftp-path) (efs-ftp-path file-name))
3237 ;; #### FSF has file-name-non-special here.
3239 ;;; files.el ends here