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 This function's standard definition is trivial; it just returns the argument.
376 However, on some systems, the function is redefined
377 with a definition that really does change some file names."
381 "Show the current default directory."
383 (message "Directory %s" default-directory))
386 "Value of the CDPATH environment variable, as a list.
387 Not actually set up until the first time you use it.")
389 (defvar cdpath-previous nil
390 "Prior value of the CDPATH environment variable.")
392 (defun parse-colon-path (cd-path)
393 "Explode a colon-separated search path into a list of directory names.
395 If you think you want to use this, you probably don't. This function
396 is provided for backward compatibility. A more robust implementation
397 of the same functionality is available as `split-path', which see."
399 (let (cd-list (cd-start 0) cd-colon)
400 (setq cd-path (concat cd-path path-separator))
401 (while (setq cd-colon (string-match path-separator cd-path cd-start))
404 (list (if (= cd-start cd-colon)
406 (substitute-in-file-name
407 (file-name-as-directory
408 (substring cd-path cd-start cd-colon)))))))
409 (setq cd-start (+ cd-colon 1)))
412 (defun cd-absolute (dir)
413 "Change current directory to given absolute file name DIR."
414 ;; Put the name into directory syntax now,
415 ;; because otherwise expand-file-name may give some bad results.
416 (setq dir (file-name-as-directory dir))
417 ;; XEmacs change: stig@hackvan.com
418 (if find-file-use-truenames
419 (setq dir (file-truename dir)))
420 (setq dir (abbreviate-file-name (expand-file-name dir)))
421 (cond ((not (file-directory-p dir))
422 (error "%s is not a directory" dir))
423 ;; this breaks ange-ftp, which doesn't (can't?) overload `file-executable-p'.
424 ;;((not (file-executable-p dir))
425 ;; (error "Cannot cd to %s: Permission denied" dir))
427 (setq default-directory dir))))
430 "Make DIR become the current buffer's default directory.
431 If your environment includes a `CDPATH' variable, try each one of that
432 colon-separated list of directories when resolving a relative directory name."
434 ;; XEmacs change? (read-file-name => read-directory-name)
435 (list (read-directory-name "Change default directory: "
436 default-directory default-directory
437 (and (member cd-path '(nil ("./")))
438 (null (getenv "CDPATH"))))))
439 (if (file-name-absolute-p dir)
440 (cd-absolute (expand-file-name dir))
442 (unless (and cd-path (equal (getenv "CDPATH") cdpath-previous))
444 (let ((trypath (parse-colon-path
445 (setq cdpath-previous (getenv "CDPATH")))))
446 (setq cd-path (or trypath (list "./")))))
448 (mapcar #'(lambda (x)
449 (let ((f (expand-file-name (concat x dir))))
450 (if (file-directory-p f)
456 ;; jwz: give a better error message to those of us with the
457 ;; good taste not to use a kludge like $CDPATH.
458 (if (equal cd-path '("./"))
459 (error "No such directory: %s" (expand-file-name dir))
460 (error "Directory not found in $CDPATH: %s" dir)))))
462 (defun load-file (file)
463 "Load the Lisp file named FILE."
464 (interactive "fLoad file: ")
465 (load (expand-file-name file) nil nil t))
467 ; We now dump utils/lib-complete.el which has improved versions of this.
468 ;(defun load-library (library)
469 ; "Load the library named LIBRARY.
470 ;This is an interface to the function `load'."
471 ; (interactive "sLoad library: ")
474 ;(defun find-library (library)
475 ; "Find the library of Lisp code named LIBRARY.
476 ;This searches `load-path' for a file named either \"LIBRARY\" or \"LIBRARY.el\"."
477 ; (interactive "sFind library file: ")
478 ; (let ((f (locate-file library load-path ":.el:")))
481 ; (error "Couldn't locate library %s" library))))
483 (defun file-local-copy (file &optional buffer)
484 "Copy the file FILE into a temporary file on this machine.
485 Returns the name of the local copy, or nil, if FILE is directly
487 (let ((handler (find-file-name-handler file 'file-local-copy)))
489 (funcall handler 'file-local-copy file)
492 ;; XEmacs change block
493 ; We have this in C and use the realpath() system call.
495 ;(defun file-truename (filename &optional counter prev-dirs)
496 ; [... lots of code snipped ...]
499 ;; XEmacs addition. Called from `insert-file-contents-internal'
500 ;; at the appropriate time.
501 (defun compute-buffer-file-truename (&optional buffer)
502 "Recompute BUFFER's value of `buffer-file-truename'
503 based on the current value of `buffer-file-name'.
504 BUFFER defaults to the current buffer if unspecified."
506 (set-buffer (or buffer (current-buffer)))
507 (cond ((null buffer-file-name)
508 (setq buffer-file-truename nil))
509 ((setq buffer-file-truename (file-truename buffer-file-name))
510 ;; it exists, we're done.
513 ;; the file doesn't exist, but maybe the directory does.
514 (let* ((dir (file-name-directory buffer-file-name))
515 (truedir (file-truename dir)))
516 (if truedir (setq dir truedir))
517 (setq buffer-file-truename
518 (expand-file-name (file-name-nondirectory buffer-file-name)
520 (if (and find-file-use-truenames buffer-file-truename)
521 (setq buffer-file-name (abbreviate-file-name buffer-file-truename)
522 default-directory (file-name-directory buffer-file-name)))
523 buffer-file-truename))
524 ;; End XEmacs change block
526 (defun file-chase-links (filename)
527 "Chase links in FILENAME until a name that is not a link.
528 Does not examine containing directories for links,
529 unlike `file-truename'."
530 (let (tem (count 100) (newname filename))
531 (while (setq tem (file-symlink-p newname))
534 (error "Apparent cycle of symbolic links for %s" filename))
535 ;; In the context of a link, `//' doesn't mean what XEmacs thinks.
536 (while (string-match "//+" tem)
537 (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
538 (substring tem (match-end 0)))))
539 ;; Handle `..' by hand, since it needs to work in the
540 ;; target of any directory symlink.
541 ;; This code is not quite complete; it does not handle
542 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
543 (while (string-match "\\`\\.\\./" tem) ;#### Unix specific
544 (setq tem (substring tem 3))
545 (setq newname (file-name-as-directory
546 ;; Do the .. by hand.
549 ;; Chase links in the default dir of the symlink.
552 (file-name-directory newname))))))))
553 (setq newname (expand-file-name tem (file-name-directory newname)))
554 (setq count (1- count))))
557 (defun switch-to-other-buffer (arg)
558 "Switch to the previous buffer. With a numeric arg, n, switch to the nth
559 most recent buffer. With an arg of 0, buries the current buffer at the
560 bottom of the buffer stack."
563 (bury-buffer (current-buffer)))
565 (if (<= arg 1) (other-buffer (current-buffer))
566 (nth (1+ arg) (buffer-list)))))
568 (defun switch-to-buffer-other-window (buffer)
569 "Select buffer BUFFER in another window."
570 (interactive "BSwitch to buffer in other window: ")
571 (let ((pop-up-windows t))
572 ;; XEmacs: this used to have (selected-frame) as the third argument,
573 ;; but this is obnoxious. If the user wants the buffer in a
574 ;; different frame, then it should be this way.
576 ;; Change documented above undone --mrb
577 (pop-to-buffer buffer t (selected-frame))))
579 (defun switch-to-buffer-other-frame (buffer)
580 "Switch to buffer BUFFER in a newly-created frame."
581 (interactive "BSwitch to buffer in other frame: ")
582 (let* ((name (get-frame-name-for-buffer buffer))
583 (frame (make-frame (if name
584 (list (cons 'name (symbol-name name)))))))
585 (pop-to-buffer buffer t frame)
586 (make-frame-visible frame)
589 (defun find-file (filename &optional codesys)
591 Switch to a buffer visiting file FILENAME,
592 creating one if none already exists.
593 Under XEmacs/Mule, optional second argument specifies the
594 coding system to use when decoding the file. Interactively,
595 with a prefix argument, you will be prompted for the coding system."
596 (interactive "FFind file: \nZCoding system: ")
598 (let ((coding-system-for-read
599 (get-coding-system codesys)))
600 (switch-to-buffer (find-file-noselect filename)))
601 (switch-to-buffer (find-file-noselect filename))))
603 (defun find-file-other-window (filename &optional codesys)
604 "Edit file FILENAME, in another window.
605 May create a new window, or reuse an existing one.
606 See the function `display-buffer'.
607 Under XEmacs/Mule, optional second argument specifies the
608 coding system to use when decoding the file. Interactively,
609 with a prefix argument, you will be prompted for the coding system."
610 (interactive "FFind file in other window: \nZCoding system: ")
612 (let ((coding-system-for-read
613 (get-coding-system codesys)))
614 (switch-to-buffer-other-window (find-file-noselect filename)))
615 (switch-to-buffer-other-window (find-file-noselect filename))))
617 (defun find-file-other-frame (filename &optional codesys)
618 "Edit file FILENAME, in a newly-created frame.
619 Under XEmacs/Mule, optional second argument specifies the
620 coding system to use when decoding the file. Interactively,
621 with a prefix argument, you will be prompted for the coding system."
622 (interactive "FFind file in other frame: \nZCoding system: ")
624 (let ((coding-system-for-read
625 (get-coding-system codesys)))
626 (switch-to-buffer-other-frame (find-file-noselect filename)))
627 (switch-to-buffer-other-frame (find-file-noselect filename))))
629 (defun find-file-read-only (filename &optional codesys)
630 "Edit file FILENAME but don't allow changes.
631 Like \\[find-file] but marks buffer as read-only.
632 Use \\[toggle-read-only] to permit editing.
633 Under XEmacs/Mule, optional second argument specifies the
634 coding system to use when decoding the file. Interactively,
635 with a prefix argument, you will be prompted for the coding system."
636 (interactive "fFind file read-only: \nZCoding system: ")
638 (let ((coding-system-for-read
639 (get-coding-system codesys)))
640 (find-file filename))
641 (find-file filename))
642 (setq buffer-read-only t)
645 (defun find-file-read-only-other-window (filename &optional codesys)
646 "Edit file FILENAME in another window but don't allow changes.
647 Like \\[find-file-other-window] but marks buffer as read-only.
648 Use \\[toggle-read-only] to permit editing.
649 Under XEmacs/Mule, optional second argument specifies the
650 coding system to use when decoding the file. Interactively,
651 with a prefix argument, you will be prompted for the coding system."
652 (interactive "fFind file read-only other window: \nZCoding system: ")
654 (let ((coding-system-for-read
655 (get-coding-system codesys)))
656 (find-file-other-window filename))
657 (find-file-other-window filename))
658 (setq buffer-read-only t)
661 (defun find-file-read-only-other-frame (filename &optional codesys)
662 "Edit file FILENAME in another frame but don't allow changes.
663 Like \\[find-file-other-frame] but marks buffer as read-only.
664 Use \\[toggle-read-only] to permit editing.
665 Under XEmacs/Mule, optional second argument specifies the
666 coding system to use when decoding the file. Interactively,
667 with a prefix argument, you will be prompted for the coding system."
668 (interactive "fFind file read-only other frame: \nZCoding system: ")
670 (let ((coding-system-for-read
671 (get-coding-system codesys)))
672 (find-file-other-frame filename))
673 (find-file-other-frame filename))
674 (setq buffer-read-only t)
677 (defun find-alternate-file-other-window (filename &optional codesys)
678 "Find file FILENAME as a replacement for the file in the next window.
679 This command does not select that window.
680 Under XEmacs/Mule, optional second argument specifies the
681 coding system to use when decoding the file. Interactively,
682 with a prefix argument, you will be prompted for the coding system."
684 (save-selected-window
686 (let ((file buffer-file-name)
690 (setq file-name (file-name-nondirectory file)
691 file-dir (file-name-directory file)))
692 (list (read-file-name
693 "Find alternate file: " file-dir nil nil file-name)
694 (if (and current-prefix-arg (featurep 'mule))
695 (read-coding-system "Coding-system: "))))))
697 (find-file-other-window filename)
698 (save-selected-window
700 (find-alternate-file filename codesys))))
702 (defun find-alternate-file (filename &optional codesys)
703 "Find file FILENAME, select its buffer, kill previous buffer.
704 If the current buffer now contains an empty file that you just visited
705 \(presumably by mistake), use this command to visit the file you really want.
706 Under XEmacs/Mule, optional second argument specifies the
707 coding system to use when decoding the file. Interactively,
708 with a prefix argument, you will be prompted for the coding system."
710 (let ((file buffer-file-name)
714 (setq file-name (file-name-nondirectory file)
715 file-dir (file-name-directory file)))
716 (list (read-file-name
717 "Find alternate file: " file-dir nil nil file-name)
718 (if (and current-prefix-arg (featurep 'mule))
719 (read-coding-system "Coding-system: ")))))
720 (and (buffer-modified-p) (buffer-file-name)
721 ;; (not buffer-read-only)
722 (not (yes-or-no-p (format
723 "Buffer %s is modified; kill anyway? "
726 (let ((obuf (current-buffer))
727 (ofile buffer-file-name)
728 (onum buffer-file-number)
729 (otrue buffer-file-truename)
730 (oname (buffer-name)))
731 (if (get-buffer " **lose**")
732 (kill-buffer " **lose**"))
733 (rename-buffer " **lose**")
734 (setq buffer-file-name nil)
735 (setq buffer-file-number nil)
736 (setq buffer-file-truename nil)
741 (let ((coding-system-for-read
742 (get-coding-system codesys)))
743 (find-file filename))
744 (find-file filename)))
745 (cond ((eq obuf (current-buffer))
746 (setq buffer-file-name ofile)
747 (setq buffer-file-number onum)
748 (setq buffer-file-truename otrue)
750 (rename-buffer oname))))
751 (or (eq (current-buffer) obuf)
752 (kill-buffer obuf))))
754 (defun create-file-buffer (filename)
755 "Create a suitably named buffer for visiting FILENAME, and return it.
756 FILENAME (sans directory) is used unchanged if that name is free;
757 otherwise a string <2> or <3> or ... is appended to get an unused name."
758 (let ((handler (find-file-name-handler filename 'create-file-buffer)))
760 (funcall handler 'create-file-buffer filename)
761 (let ((lastname (file-name-nondirectory filename)))
762 (if (string= lastname "")
763 (setq lastname filename))
764 (generate-new-buffer lastname)))))
766 (defun generate-new-buffer (name)
767 "Create and return a buffer with a name based on NAME.
768 Choose the buffer's name using `generate-new-buffer-name'."
769 (get-buffer-create (generate-new-buffer-name name)))
771 (defvar abbreviated-home-dir nil
772 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
774 (defun abbreviate-file-name (filename &optional hack-homedir)
775 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
776 See documentation of variable `directory-abbrev-alist' for more information.
777 If optional argument HACK-HOMEDIR is non-nil, then this also substitutes
778 \"~\" for the user's home directory."
779 (let ((handler (find-file-name-handler filename 'abbreviate-file-name)))
781 (funcall handler 'abbreviate-file-name filename hack-homedir)
782 ;; Get rid of the prefixes added by the automounter.
783 ;;(if (and (string-match automount-dir-prefix filename)
784 ;; (file-exists-p (file-name-directory
785 ;; (substring filename (1- (match-end 0))))))
786 ;; (setq filename (substring filename (1- (match-end 0)))))
787 (let ((tail directory-abbrev-alist))
788 ;; If any elt of directory-abbrev-alist matches this name,
789 ;; abbreviate accordingly.
791 (when (string-match (car (car tail)) filename)
793 (concat (cdr (car tail)) (substring filename (match-end 0)))))
794 (setq tail (cdr tail))))
796 ;; Compute and save the abbreviated homedir name.
797 ;; We defer computing this until the first time it's needed, to
798 ;; give time for directory-abbrev-alist to be set properly.
799 ;; We include a slash at the end, to avoid spurious matches
800 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
801 (or abbreviated-home-dir
802 (setq abbreviated-home-dir
803 (let ((abbreviated-home-dir "$foo"))
804 (concat "\\`" (regexp-quote (abbreviate-file-name
805 (expand-file-name "~")))
807 ;; If FILENAME starts with the abbreviated homedir,
808 ;; make it start with `~' instead.
809 (if (and (string-match abbreviated-home-dir filename)
810 ;; If the home dir is just /, don't change it.
811 (not (and (= (match-end 0) 1) ;#### unix-specific
812 (= (aref filename 0) ?/)))
813 (not (and (memq system-type '(ms-dos windows-nt))
815 (string-match "^[a-zA-Z]:/$" filename)))))
819 (match-beginning 1) (match-end 1))
820 (substring filename (match-end 0))))))
823 (defcustom find-file-not-true-dirname-list nil
824 "*List of logical names for which visiting shouldn't save the true dirname."
825 :type '(repeat (string :tag "Name"))
828 ;; This function is needed by FSF vc.el. I hope somebody can make it
829 ;; work for XEmacs. -sb.
830 ;; #### In what way does it not work? --hniksic
831 (defun find-buffer-visiting (filename)
832 "Return the buffer visiting file FILENAME (a string).
833 This is like `get-file-buffer', except that it checks for any buffer
834 visiting the same file, possibly under a different name.
835 If there is no such live buffer, return nil."
836 (let ((buf (get-file-buffer filename))
837 (truename (abbreviate-file-name (file-truename filename))))
839 (let ((list (buffer-list)) found)
840 (while (and (not found) list)
842 (set-buffer (car list))
843 (if (and buffer-file-name
844 (string= buffer-file-truename truename))
845 (setq found (car list))))
846 (setq list (cdr list)))
848 (let ((number (nthcdr 10 (file-attributes truename)))
849 (list (buffer-list)) found)
850 (and buffer-file-numbers-unique
852 (while (and (not found) list)
854 (set-buffer (car list))
855 (if (and buffer-file-number
856 (equal buffer-file-number number)
857 ;; Verify this buffer's file number
858 ;; still belongs to its file.
859 (file-exists-p buffer-file-name)
860 (equal (nthcdr 10 (file-attributes buffer-file-name))
862 (setq found (car list))))
863 (setq list (cdr list))))
866 (defun insert-file-contents-literally (filename &optional visit beg end replace)
867 "Like `insert-file-contents', q.v., but only reads in the file.
868 A buffer may be modified in several ways after reading into the buffer due
869 to advanced Emacs features, such as file-name-handlers, format decoding,
870 find-file-hooks, etc.
871 This function ensures that none of these modifications will take place."
872 (let ((file-name-handler-alist nil)
874 (after-insert-file-functions nil)
875 (find-buffer-file-type-function
876 (if (fboundp 'find-buffer-file-type)
877 (symbol-function 'find-buffer-file-type)
881 (fset 'find-buffer-file-type (lambda (filename) t))
882 (insert-file-contents filename visit beg end replace))
883 (if find-buffer-file-type-function
884 (fset 'find-buffer-file-type find-buffer-file-type-function)
885 (fmakunbound 'find-buffer-file-type)))))
887 (defun find-file-noselect (filename &optional nowarn rawfile)
888 "Read file FILENAME into a buffer and return the buffer.
889 If a buffer exists visiting FILENAME, return that one, but
890 verify that the file has not changed since visited or saved.
891 The buffer is not selected, just returned to the caller.
892 If NOWARN is non-nil, warning messages will be suppressed.
893 If RAWFILE is non-nil, the file is read literally."
894 (setq filename (abbreviate-file-name (expand-file-name filename)))
895 (if (file-directory-p filename)
896 (if (and (fboundp 'dired-noselect) find-file-run-dired)
897 (dired-noselect (if find-file-use-truenames
898 (abbreviate-file-name (file-truename filename))
900 (error "%s is a directory" filename))
901 (let* ((buf (get-file-buffer filename))
902 (truename (abbreviate-file-name (file-truename filename)))
903 (number (nthcdr 10 (file-attributes truename)))
904 ; ;; Find any buffer for a file which has same truename.
905 ; (other (and (not buf) (find-buffer-visiting filename)))
908 ; ;; Let user know if there is a buffer with the same truename.
909 ; (if (and (not buf) same-truename (not nowarn))
910 ; (message "%s and %s are the same file (%s)"
911 ; filename (buffer-file-name same-truename)
913 ; (if (and (not buf) same-number (not nowarn))
914 ; (message "%s and %s are the same file"
915 ; filename (buffer-file-name same-number))))
916 ; ;; Optionally also find that buffer.
917 ; (if (or find-file-existing-other-name find-file-visit-truename)
918 ; (setq buf (or same-truename same-number)))
921 (or find-file-compare-truenames find-file-use-truenames)
925 (if (not (string-equal buffer-file-name filename))
926 (message "%s and %s are the same file (%s)"
927 filename buffer-file-name
928 buffer-file-truename))))
932 (verify-visited-file-modtime buf)
933 (cond ((not (file-exists-p filename))
934 (error "File %s no longer exists!" filename))
935 ;; Certain files should be reverted automatically
936 ;; if they have changed on disk and not in the buffer.
937 ((and (not (buffer-modified-p buf))
938 (dolist (rx revert-without-query nil)
939 (when (string-match rx filename)
941 (with-current-buffer buf
942 (message "Reverting file %s..." filename)
944 (message "Reverting file %s... done" filename)))
946 (if (string= (file-name-nondirectory filename)
949 (if (buffer-modified-p buf)
950 (gettext "File %s changed on disk. Discard your edits? ")
951 (gettext "File %s changed on disk. Reread from disk? "))
952 (file-name-nondirectory filename))
954 (if (buffer-modified-p buf)
955 (gettext "File %s changed on disk. Discard your edits in %s? ")
956 (gettext "File %s changed on disk. Reread from disk into %s? "))
957 (file-name-nondirectory filename)
959 (with-current-buffer buf
960 (revert-buffer t t)))))
961 ;; Else: we must create a new buffer for filename
963 ;;; The truename stuff makes this obsolete.
964 ;;; (let* ((link-name (car (file-attributes filename)))
965 ;;; (linked-buf (and (stringp link-name)
966 ;;; (get-file-buffer link-name))))
967 ;;; (if (bufferp linked-buf)
968 ;;; (message "Symbolic link to file in buffer %s"
969 ;;; (buffer-name linked-buf))))
970 (setq buf (create-file-buffer filename))
971 ;; Catch various signals, such as QUIT, and kill the buffer
975 (set-buffer-major-mode buf)
980 (insert-file-contents-literally filename t)
981 (insert-file-contents filename t))
983 (when (and (file-exists-p filename)
984 (not (file-readable-p filename)))
985 (signal 'file-error (list "File is not readable" filename)))
987 ;; Unconditionally set error
990 ;; Run find-file-not-found-hooks until one returns non-nil.
991 (run-hook-with-args-until-success 'find-file-not-found-hooks)
992 ;; If they fail too, set error.
994 ;; Find the file's truename, and maybe use that as visited name.
995 ;; automatically computed in XEmacs, unless jka-compr was used!
996 (unless buffer-file-truename
997 (setq buffer-file-truename truename))
998 (setq buffer-file-number number)
999 (and find-file-use-truenames
1000 ;; This should be in C. Put pathname
1001 ;; abbreviations that have been explicitly
1002 ;; requested back into the pathname. Most
1003 ;; importantly, strip out automounter /tmp_mnt
1004 ;; directories so that auto-save will work
1005 (setq buffer-file-name (abbreviate-file-name buffer-file-name)))
1006 ;; Set buffer's default directory to that of the file.
1007 (setq default-directory (file-name-directory buffer-file-name))
1008 ;; Turn off backup files for certain file names. Since
1009 ;; this is a permanent local, the major mode won't eliminate it.
1010 (and (not (funcall backup-enable-predicate buffer-file-name))
1012 (make-local-variable 'backup-inhibited)
1013 (setq backup-inhibited t)))
1015 ;; #### FSF 20.3 sets buffer-file-coding-system to
1016 ;; `no-conversion' here. Should we copy? It also
1017 ;; makes `find-file-literally' a local variable
1018 ;; and sets it to t.
1020 (after-find-file error (not nowarn))
1021 (setq buf (current-buffer))))
1024 (signal (car data) (cdr data))))))
1027 ;; FSF has `insert-file-literally' and `find-file-literally' here.
1029 (defvar after-find-file-from-revert-buffer nil)
1031 (defun after-find-file (&optional error warn noauto
1032 after-find-file-from-revert-buffer
1034 "Called after finding a file and by the default revert function.
1035 Sets buffer mode, parses local variables.
1036 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1037 error in reading the file. WARN non-nil means warn if there
1038 exists an auto-save file more recent than the visited file.
1039 NOAUTO means don't mess with auto-save mode.
1040 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1041 means this call was from `revert-buffer'.
1042 Fifth arg NOMODES non-nil means don't alter the file's modes.
1043 Finishes by calling the functions in `find-file-hooks'."
1044 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1049 (cond ((and error (file-attributes buffer-file-name))
1050 (setq buffer-read-only t)
1051 (gettext "File exists, but cannot be read."))
1052 ((not buffer-read-only)
1054 (file-newer-than-file-p (make-auto-save-file-name)
1056 (format "%s has auto save data; consider M-x recover-file"
1057 (file-name-nondirectory buffer-file-name))
1058 (setq not-serious t)
1059 (if error (gettext "(New file)") nil)))
1061 (setq not-serious t)
1062 (gettext "Note: file is write protected"))
1063 ((file-attributes (directory-file-name default-directory))
1064 (gettext "File not found and directory write-protected"))
1065 ((file-exists-p (file-name-directory buffer-file-name))
1066 (setq buffer-read-only nil))
1068 ;; If the directory the buffer is in doesn't exist,
1069 ;; offer to create it. It's better to do this now
1070 ;; than when we save the buffer, because we want
1071 ;; autosaving to work.
1072 (setq buffer-read-only nil)
1074 (or (file-exists-p (file-name-directory buffer-file-name))
1079 The directory containing %s does not exist. Create? "
1080 (abbreviate-file-name buffer-file-name)))
1081 (make-directory (file-name-directory
1085 (kill-buffer (current-buffer))
1086 (signal 'quit nil))))
1091 (or not-serious (sit-for 1 t)))))
1092 (if (and auto-save-default (not noauto))
1093 (auto-save-mode t)))
1096 (run-hooks 'find-file-hooks)))
1098 (defun normal-mode (&optional find-file)
1099 "Choose the major mode for this buffer automatically.
1100 Also sets up any specified local variables of the file.
1101 Uses the visited file name, the -*- line, and the local variables spec.
1103 This function is called automatically from `find-file'. In that case,
1104 we may set up specified local variables depending on the value of
1105 `enable-local-variables': if it is t, we do; if it is nil, we don't;
1106 otherwise, we query. `enable-local-variables' is ignored if you
1107 run `normal-mode' explicitly."
1109 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1110 (and (condition-case err
1111 (progn (set-auto-mode)
1113 (error (message "File mode specification error: %s"
1114 (prin1-to-string err))
1117 (hack-local-variables (not find-file))
1118 (error (lwarn 'local-variables 'warning
1119 "File local-variables error: %s"
1120 (error-message-string err))))))
1122 ;; #### This variable sucks in the package model. There should be a
1123 ;; way for new packages to add their entries to auto-mode-alist in a
1124 ;; clean way. Per Abrahamsen suggested splitting auto-mode-alist to
1125 ;; several distinct variables such as, in order of precedence,
1126 ;; `user-auto-mode-alist' for users, `package-auto-mode-alist' for
1127 ;; packages and `auto-mode-alist' (which might also be called
1128 ;; `default-auto-mode-alist') for default stuff, such as some of the
1131 (defvar auto-mode-alist
1132 '(("\\.te?xt\\'" . text-mode)
1133 ("\\.[chi]\\'" . c-mode)
1134 ("\\.el\\'" . emacs-lisp-mode)
1135 ("\\.\\(?:[CH]\\|cc\\|hh\\)\\'" . c++-mode)
1136 ("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . c++-mode)
1137 ("\\.java\\'" . java-mode)
1138 ("\\.idl\\'" . idl-mode)
1139 ("\\.f\\(?:or\\)?\\'" . fortran-mode)
1140 ("\\.F\\(?:OR\\)?\\'" . fortran-mode)
1141 ("\\.[fF]90\\'" . f90-mode)
1142 ;;; Less common extensions come here
1143 ;;; so more common ones above are found faster.
1144 ("\\.\\([pP][Llm]\\|al\\)\\'" . perl-mode)
1145 ("\\.py\\'" . python-mode)
1146 ("\\.texi\\(?:nfo\\)?\\'" . texinfo-mode)
1147 ("\\.ad[abs]\\'" . ada-mode)
1148 ("\\.c?l\\(?:i?sp\\)?\\'" . lisp-mode)
1149 ("\\.p\\(?:as\\)?\\'" . pascal-mode)
1150 ("\\.ltx\\'" . latex-mode)
1151 ("\\.[sS]\\'" . asm-mode)
1152 ("[Cc]hange.?[Ll]og?\\(?:.[0-9]+\\)?\\'" . change-log-mode)
1153 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1154 ("\\.scm?\\(?:\\.[0-9]*\\)?\\'" . scheme-mode)
1155 ("\\.e\\'" . eiffel-mode)
1156 ("\\.mss\\'" . scribe-mode)
1157 ("\\.m\\(?:[mes]\\|an\\)\\'" . nroff-mode)
1158 ("\\.icn\\'" . icon-mode)
1159 ("\\.\\(?:[ckz]?sh\\|shar\\)\\'" . sh-mode)
1160 ;; #### Unix-specific!
1161 ("/\\.\\(?:bash_\\|z\\)?\\(profile\\|login\\|logout\\)\\'" . sh-mode)
1162 ("/\\.\\(?:[ckz]sh\\|bash\\|tcsh\\|es\\|xinit\\|startx\\)rc\\'" . sh-mode)
1163 ("/\\.\\(?:[kz]shenv\\|xsession\\)\\'" . sh-mode)
1164 ;; The following come after the ChangeLog pattern for the sake of
1165 ;; ChangeLog.1, etc. and after the .scm.[0-9] pattern too.
1166 ("\\.[12345678]\\'" . nroff-mode)
1167 ("\\.[tT]e[xX]\\'" . tex-mode)
1168 ("\\.\\(?:sty\\|cls\\|bbl\\)\\'" . latex-mode)
1169 ("\\.bib\\'" . bibtex-mode)
1170 ("\\.article\\'" . text-mode)
1171 ("\\.letter\\'" . text-mode)
1172 ("\\.\\(?:tcl\\|exp\\)\\'" . tcl-mode)
1173 ("\\.wrl\\'" . vrml-mode)
1174 ("\\.awk\\'" . awk-mode)
1175 ("\\.prolog\\'" . prolog-mode)
1176 ("\\.\\(?:arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
1177 ;; Mailer puts message to be edited in /tmp/Re.... or Message
1178 ;; #### Unix-specific!
1179 ("\\`/tmp/Re" . text-mode)
1180 ("/Message[0-9]*\\'" . text-mode)
1181 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1182 ;; some news reader is reported to use this
1183 ("^/tmp/fol/" . text-mode)
1184 ("\\.y\\'" . c-mode)
1185 ("\\.lex\\'" . c-mode)
1186 ("\\.m\\'" . objc-mode)
1187 ("\\.oak\\'" . scheme-mode)
1188 ("\\.s?html?\\'" . html-mode)
1189 ("\\.htm?l?3\\'" . html3-mode)
1190 ("\\.\\(?:sgml?\\|dtd\\)\\'" . sgml-mode)
1191 ("\\.c?ps\\'" . postscript-mode)
1192 ;; .emacs following a directory delimiter in either Unix or
1194 ("[/\\][._].*emacs\\'" . emacs-lisp-mode)
1195 ("\\.m4\\'" . autoconf-mode)
1196 ("configure\\.in\\'" . autoconf-mode)
1197 ("\\.ml\\'" . lisp-mode)
1198 ("\\.ma?k\\'" . makefile-mode)
1199 ("[Mm]akefile\\(\\.\\|\\'\\)" . makefile-mode)
1200 ("\\.X\\(defaults\\|environment\\|resources\\|modmap\\)\\'" . xrdb-mode)
1201 ;; #### The following three are Unix-specific (but do we care?)
1202 ("/app-defaults/" . xrdb-mode)
1203 ("\\.[^/]*wm2?\\(?:rc\\)?\\'" . winmgr-mode)
1204 ("\\.\\(?:jpe?g\\|JPE?G\\|png\\|PNG\\|gif\\|GIF\\|tiff?\\|TIFF?\\)\\'" . image-mode)
1206 "Alist of filename patterns vs. corresponding major mode functions.
1207 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1208 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1209 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1210 mode function to use. FUNCTION will be called, unless it is nil.
1212 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1213 calling FUNCTION (if it's not nil), we delete the suffix that matched
1214 REGEXP and search the list again for another match.")
1216 (defvar interpreter-mode-alist
1217 '(("^#!.*csh" . sh-mode)
1218 ("^#!.*\\b\\(scope\\|wish\\|tcl\\|tclsh\\|expect\\)" . tcl-mode)
1219 ("^#!.*sh\\b" . sh-mode)
1220 ("perl" . perl-mode)
1221 ("python" . python-mode)
1222 ("awk\\b" . awk-mode)
1223 ("rexx" . rexx-mode)
1224 ("scm\\|guile" . scheme-mode)
1225 ("emacs" . emacs-lisp-mode)
1226 ("make" . makefile-mode)
1228 "Alist mapping interpreter names to major modes.
1229 This alist is used to guess the major mode of a file based on the
1230 contents of the first line. This line often contains something like:
1232 but may contain something more imaginative like
1235 eval 'exec perl -w -S $0 ${1+\"$@\"}'.
1237 Each alist element looks like (INTERPRETER . MODE).
1238 The car of each element is a regular expression which is compared
1239 with the name of the interpreter specified in the first line.
1240 If it matches, mode MODE is selected.")
1242 (defvar binary-file-regexps
1244 '("\\.\\(?:bz2\\|elc\\|g\\(if\\|z\\)\\|jp\\(eg\\|g\\)\\|png\\|t\\(ar\\|gz\\|iff\\)\\|[Zo]\\)\\'"))
1245 "List of regexps of filenames containing binary (non-text) data.")
1247 ; (eval-when-compile
1248 ; (require 'regexp-opt)
1250 ; (format "\\.\\(?:%s\\)\\'"
1265 (defvar inhibit-first-line-modes-regexps
1266 (purecopy binary-file-regexps)
1267 "List of regexps; if one matches a file name, don't look for `-*-'.")
1269 (defvar inhibit-first-line-modes-suffixes nil
1270 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1271 When checking `inhibit-first-line-modes-regexps', we first discard
1272 from the end of the file name anything that matches one of these regexps.")
1274 (defvar user-init-file
1275 nil ; set by command-line
1276 "File name including directory of user's initialization file.")
1278 (defun set-auto-mode (&optional just-from-file-name)
1279 "Select major mode appropriate for current buffer.
1280 This checks for a -*- mode tag in the buffer's text,
1281 compares the filename against the entries in `auto-mode-alist',
1282 or checks the interpreter that runs this file against
1283 `interpreter-mode-alist'.
1285 It does not check for the `mode:' local variable in the
1286 Local Variables section of the file; for that, use `hack-local-variables'.
1288 If `enable-local-variables' is nil, this function does not check for a
1291 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1292 then we do not set anything but the major mode,
1293 and we don't even do that unless it would come from the file name."
1295 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1296 ;; Do this by calling the hack-local-variables helper to avoid redundancy.
1297 ;; We bind enable-local-variables to nil this time because we're going to
1298 ;; call hack-local-variables-prop-line again later, "for real." Note that
1299 ;; this temporary binding does not prevent hack-local-variables-prop-line
1300 ;; from setting the major mode.
1301 (or (and enable-local-variables
1302 (let ((enable-local-variables nil))
1303 (hack-local-variables-prop-line nil))
1305 ;; It's not in the -*- line, so check the auto-mode-alist, unless
1306 ;; this buffer isn't associated with a file.
1307 (null buffer-file-name)
1308 (let ((name (file-name-sans-versions buffer-file-name))
1311 (setq keep-going nil)
1312 (let ((alist auto-mode-alist)
1314 ;; Find first matching alist entry.
1315 (let ((case-fold-search
1316 (memq system-type '(windows-nt))))
1317 (while (and (not mode) alist)
1318 (if (string-match (car (car alist)) name)
1319 (if (and (consp (cdr (car alist)))
1320 (nth 2 (car alist)))
1322 (setq mode (car (cdr (car alist)))
1323 name (substring name 0 (match-beginning 0))
1325 (setq mode (cdr (car alist))
1327 (setq alist (cdr alist))))
1328 (unless just-from-file-name
1329 ;; If we can't deduce a mode from the file name,
1330 ;; look for an interpreter specified in the first line.
1331 (if (and (null mode)
1332 (save-excursion ; XEmacs
1333 (goto-char (point-min))
1339 (goto-char (point-min)) (end-of-line) (point)))))
1340 (setq alist interpreter-mode-alist)
1342 (if (string-match (car (car alist)) firstline)
1344 (setq mode (cdr (car alist)))
1346 (setq alist (cdr alist)))))))
1348 (if (not (fboundp mode))
1349 (let ((name (package-get-package-provider mode)))
1351 (message "Mode %s is not installed. Download package %s" mode name)
1352 (message "Mode %s either doesn't exist or is not a known package" mode))
1355 (unless (and just-from-file-name
1357 ;; Don't reinvoke major mode.
1358 (eq mode major-mode)
1359 ;; Don't lose on minor modes.
1360 (assq mode minor-mode-alist)))
1361 (funcall mode))))))))))
1363 (defvar hack-local-variables-hook nil
1364 "Normal hook run after processing a file's local variables specs.
1365 Major modes can use this to examine user-specified local variables
1366 in order to initialize other data structure based on them.
1368 This hook runs even if there were no local variables or if their
1369 evaluation was suppressed. See also `enable-local-variables' and
1370 `enable-local-eval'.")
1372 (defun hack-local-variables (&optional force)
1373 "Parse, and bind or evaluate as appropriate, any local variables
1374 for current buffer."
1375 ;; Don't look for -*- if this file name matches any
1376 ;; of the regexps in inhibit-first-line-modes-regexps.
1377 (if (or (null buffer-file-name) ; don't lose if buffer has no file!
1378 (not (let ((temp inhibit-first-line-modes-regexps)
1379 (name (if buffer-file-name
1380 (file-name-sans-versions buffer-file-name)
1382 (while (let ((sufs inhibit-first-line-modes-suffixes))
1383 (while (and sufs (not
1384 (string-match (car sufs) name)))
1385 (setq sufs (cdr sufs)))
1387 (setq name (substring name 0 (match-beginning 0))))
1389 (not (string-match (car temp) name)))
1390 (setq temp (cdr temp))
1393 ;; Look for variables in the -*- line.
1394 (hack-local-variables-prop-line force)
1395 ;; Look for "Local variables:" block in last page.
1396 (hack-local-variables-last-page force)))
1397 (run-hooks 'hack-local-variables-hook))
1399 ;;; Local variables may be specified in the last page of the file (within 3k
1400 ;;; from the end of the file and after the last ^L) in the form
1402 ;;; Local variables:
1403 ;;; variable-name: variable-value
1406 ;;; The lines may begin with a common prefix, like ";;; " in the above
1407 ;;; example. They may also have a common suffix (" */" for example). In
1408 ;;; this form, the local variable "mode" can be used to change the major
1409 ;;; mode, and the local variable "eval" can be used to evaluate an arbitrary
1412 ;;; Local variables may also be specified in the first line of the file.
1413 ;;; Embedded in this line are a pair of "-*-" sequences. What lies between
1414 ;;; them are variable-name/variable-value pairs, like:
1416 ;;; -*- mode: emacs-lisp -*-
1417 ;;; or -*- mode: postscript; version-control: never -*-
1418 ;;; or -*- tags-file-name: "/foo/bar/TAGS" -*-
1420 ;;; The local variable "eval" is not used with this form. For hysterical
1421 ;;; reasons, the syntax "-*- modename -*-" is allowed as well.
1424 (defun hack-local-variables-p (modeline)
1425 (or (eq enable-local-variables t)
1426 (and enable-local-variables
1427 (save-window-excursion
1429 (switch-to-buffer (current-buffer))
1431 ;; If we fail to switch in the selected window,
1432 ;; it is probably a minibuffer.
1433 ;; So try another window.
1435 (switch-to-buffer-other-window (current-buffer))
1437 (switch-to-buffer-other-frame (current-buffer))))))
1438 (or modeline (save-excursion
1440 (set-window-start (selected-window) (point))))
1442 "Set local variables as specified %s of %s? "
1443 (if modeline "in -*- line" "at end")
1444 (if buffer-file-name
1445 (file-name-nondirectory buffer-file-name)
1446 (concat "buffer " (buffer-name)))))))))
1448 (defun hack-local-variables-last-page (&optional force)
1449 ;; Set local variables set in the "Local Variables:" block of the last page.
1451 (goto-char (point-max))
1452 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1453 (if (let ((case-fold-search t))
1454 (and (search-forward "Local Variables:" nil t)
1456 (hack-local-variables-p nil))))
1458 prefix prefixlen suffix beg
1459 (enable-local-eval enable-local-eval))
1460 ;; The prefix is what comes before "local variables:" in its line.
1461 ;; The suffix is what comes after "local variables:" in its line.
1462 (skip-chars-forward " \t")
1464 (setq suffix (buffer-substring (point)
1465 (progn (end-of-line) (point)))))
1466 (goto-char (match-beginning 0))
1469 (buffer-substring (point)
1470 (progn (beginning-of-line) (point)))))
1471 (if prefix (setq prefixlen (length prefix)
1472 prefix (regexp-quote prefix)))
1473 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1475 ;; Look at next local variable spec.
1476 (if selective-display (re-search-forward "[\n\C-m]")
1478 ;; Skip the prefix, if any.
1480 (if (looking-at prefix)
1481 (forward-char prefixlen)
1482 (error "Local variables entry is missing the prefix")))
1483 ;; Find the variable name; strip whitespace.
1484 (skip-chars-forward " \t")
1486 (skip-chars-forward "^:\n")
1487 (if (eolp) (error "Missing colon in local variables entry"))
1488 (skip-chars-backward " \t")
1489 (let* ((str (buffer-substring beg (point)))
1492 ;; Setting variable named "end" means end of list.
1493 (if (string-equal (downcase str) "end")
1495 ;; Otherwise read the variable value.
1496 (skip-chars-forward "^:")
1498 (setq val (read (current-buffer)))
1499 (skip-chars-backward "\n")
1500 (skip-chars-forward " \t")
1501 (or (if suffix (looking-at suffix) (eolp))
1502 (error "Local variables entry is terminated incorrectly"))
1503 ;; Set the variable. "Variables" mode and eval are funny.
1504 (hack-one-local-variable var val))))))))
1506 ;; jwz - New Version 20.1/19.15
1507 (defun hack-local-variables-prop-line (&optional force)
1508 ;; Set local variables specified in the -*- line.
1509 ;; Returns t if mode was set.
1512 (goto-char (point-min))
1513 (skip-chars-forward " \t\n\r")
1514 (let ((end (save-excursion
1515 ;; If the file begins with "#!"
1516 ;; (un*x exec interpreter magic), look
1517 ;; for mode frobs in the first two
1518 ;; lines. You cannot necessarily
1519 ;; put them in the first line of
1520 ;; such a file without screwing up
1521 ;; the interpreter invocation.
1522 (end-of-line (and (looking-at "^#!") 2))
1524 ;; Parse the -*- line into the `result' alist.
1525 (cond ((not (search-forward "-*-" end t))
1526 ;; doesn't have one.
1528 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1529 ;; Antiquated form: "-*- ModeName -*-".
1532 (intern (buffer-substring
1537 ;; Usual form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1538 ;; (last ";" is optional).
1540 (if (search-forward "-*-" end t)
1541 (setq end (- (point) 3))
1542 (error "-*- not terminated before end of line")))
1543 (while (< (point) end)
1544 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1545 (error "malformed -*- line"))
1546 (goto-char (match-end 0))
1547 ;; There used to be a downcase here,
1548 ;; but the manual didn't say so,
1549 ;; and people want to set var names that aren't all lc.
1550 (let ((key (intern (buffer-substring
1553 (val (save-restriction
1554 (narrow-to-region (point) end)
1555 (read (current-buffer)))))
1556 ;; Case sensitivity! Icepicks in my forehead!
1557 (if (equal (downcase (symbol-name key)) "mode")
1559 (setq result (cons (cons key val) result))
1560 (skip-chars-forward " \t;")))
1561 (setq result (nreverse result))))))
1563 (let ((set-any-p (or force
1564 ;; It's OK to force null specifications.
1566 ;; It's OK to force mode-only specifications.
1567 (let ((remaining result)
1568 (mode-specs-only t))
1570 (if (eq (car (car remaining)) 'mode)
1571 (setq remaining (cdr remaining))
1572 ;; Otherwise, we have a real local.
1573 (setq mode-specs-only nil
1577 ;; Otherwise, check.
1578 (hack-local-variables-p t)))
1581 (let ((key (car (car result)))
1582 (val (cdr (car result))))
1583 (cond ((eq key 'mode)
1585 (let ((mode (intern (concat (downcase (symbol-name val))
1587 ;; Without this guard, `normal-mode' would potentially run
1588 ;; the major mode function twice: once via `set-auto-mode'
1589 ;; and once via `hack-local-variables'.
1590 (if (not (eq mode major-mode))
1594 (hack-one-local-variable key val))
1597 (setq result (cdr result)))
1600 (defconst ignored-local-variables
1601 (list 'enable-local-eval)
1602 "Variables to be ignored in a file's local variable spec.")
1604 ;; Get confirmation before setting these variables as locals in a file.
1605 (put 'debugger 'risky-local-variable t)
1606 (put 'enable-local-eval 'risky-local-variable t)
1607 (put 'ignored-local-variables 'risky-local-variable t)
1608 (put 'eval 'risky-local-variable t)
1609 (put 'file-name-handler-alist 'risky-local-variable t)
1610 (put 'minor-mode-map-alist 'risky-local-variable t)
1611 (put 'after-load-alist 'risky-local-variable t)
1612 (put 'buffer-file-name 'risky-local-variable t)
1613 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1614 (put 'buffer-file-truename 'risky-local-variable t)
1615 (put 'exec-path 'risky-local-variable t)
1616 (put 'load-path 'risky-local-variable t)
1617 (put 'exec-directory 'risky-local-variable t)
1618 (put 'process-environment 'risky-local-variable t)
1619 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1620 (put 'outline-level 'risky-local-variable t)
1621 (put 'rmail-output-file-alist 'risky-local-variable t)
1623 ;; This one is safe because the user gets to check it before it is used.
1624 (put 'compile-command 'safe-local-variable t)
1626 ;(defun hack-one-local-variable-quotep (exp)
1627 ; (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1629 ;; "Set" one variable in a local variables spec.
1630 ;; A few variable names are treated specially.
1631 (defun hack-one-local-variable (var val)
1632 (cond ((eq var 'mode)
1633 (funcall (intern (concat (downcase (symbol-name val))
1635 ((memq var ignored-local-variables)
1637 ;; "Setting" eval means either eval it or do nothing.
1638 ;; Likewise for setting hook variables.
1639 ((or (get var 'risky-local-variable)
1641 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1643 (not (get var 'safe-local-variable))))
1644 ; ;; Permit evaling a put of a harmless property
1645 ; ;; if the args do nothing tricky.
1646 ; (if (or (and (eq var 'eval)
1648 ; (eq (car val) 'put)
1649 ; (hack-one-local-variable-quotep (nth 1 val))
1650 ; (hack-one-local-variable-quotep (nth 2 val))
1651 ; ;; Only allow safe values of lisp-indent-hook;
1653 ; (or (numberp (nth 3 val))
1654 ; (equal (nth 3 val) ''defun))
1655 ; (memq (nth 1 (nth 2 val))
1656 ; '(lisp-indent-hook)))
1657 (if (and (not (zerop (user-uid)))
1658 (or (eq enable-local-eval t)
1659 (and enable-local-eval
1660 (save-window-excursion
1661 (switch-to-buffer (current-buffer))
1664 (set-window-start (selected-window) (point)))
1665 (setq enable-local-eval
1666 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1667 (file-name-nondirectory buffer-file-name))))))))
1669 (save-excursion (eval val))
1670 (make-local-variable var)
1672 (message "Ignoring `eval:' in file's local variables")))
1673 ;; Ordinary variable, really set it.
1674 (t (make-local-variable var)
1677 (defcustom change-major-mode-with-file-name t
1678 "*Non-nil means \\[write-file] should set the major mode from the file name.
1679 However, the mode will not be changed if
1680 \(1) a local variables list or the `-*-' line specifies a major mode, or
1681 \(2) the current major mode is a \"special\" mode,
1682 \ not suitable for ordinary files, or
1683 \(3) the new file name does not particularly specify any mode."
1685 :group 'editing-basics)
1687 (defun set-visited-file-name (filename &optional no-query along-with-file)
1688 "Change name of file visited in current buffer to FILENAME.
1689 The next time the buffer is saved it will go in the newly specified file.
1690 nil or empty string as argument means make buffer not be visiting any file.
1691 Remember to delete the initial contents of the minibuffer
1692 if you wish to pass an empty string as the argument.
1694 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1695 confirmation in the case where another buffer is already visiting FILENAME.
1697 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1698 the old visited file has been renamed to the new name FILENAME."
1699 (interactive "FSet visited file name: ")
1700 (if (buffer-base-buffer)
1701 (error "An indirect buffer cannot visit a file"))
1705 (if (string-equal filename "")
1707 (expand-file-name filename))))
1710 (setq truename (file-truename filename))
1711 ;; #### Do we need to check if truename is non-nil?
1712 (if find-file-use-truenames
1713 (setq filename truename))))
1714 (let ((buffer (and filename (find-buffer-visiting filename))))
1715 (and buffer (not (eq buffer (current-buffer)))
1717 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1720 (or (equal filename buffer-file-name)
1722 (and filename (lock-buffer filename))
1724 (setq buffer-file-name filename)
1725 (if filename ; make buffer name reflect filename.
1726 (let ((new-name (file-name-nondirectory buffer-file-name)))
1727 (if (string= new-name "")
1728 (error "Empty file name"))
1729 (setq default-directory (file-name-directory buffer-file-name))
1730 (or (string= new-name (buffer-name))
1731 (rename-buffer new-name t))))
1732 (setq buffer-backed-up nil)
1734 (clear-visited-file-modtime))
1735 (compute-buffer-file-truename) ; insert-file-contents does this too.
1736 ; ;; Abbreviate the file names of the buffer.
1739 ; (setq buffer-file-truename (abbreviate-file-name truename))
1740 ; (if find-file-visit-truename
1741 ; (setq buffer-file-name buffer-file-truename))))
1742 (setq buffer-file-number
1744 (nthcdr 10 (file-attributes buffer-file-name))
1746 ;; write-file-hooks is normally used for things like ftp-find-file
1747 ;; that visit things that are not local files as if they were files.
1748 ;; Changing to visit an ordinary local file instead should flush the hook.
1749 (kill-local-variable 'write-file-hooks)
1750 (kill-local-variable 'after-save-hook)
1751 (kill-local-variable 'local-write-file-hooks)
1752 (kill-local-variable 'write-file-data-hooks)
1753 (kill-local-variable 'revert-buffer-function)
1754 (kill-local-variable 'backup-inhibited)
1755 ;; If buffer was read-only because of version control,
1756 ;; that reason is gone now, so make it writable.
1757 (when (boundp 'vc-mode)
1759 (setq buffer-read-only nil))
1760 (kill-local-variable 'vc-mode))
1761 ;; Turn off backup files for certain file names.
1762 ;; Since this is a permanent local, the major mode won't eliminate it.
1763 (and buffer-file-name
1764 (not (funcall backup-enable-predicate buffer-file-name))
1766 (make-local-variable 'backup-inhibited)
1767 (setq backup-inhibited t)))
1768 (let ((oauto buffer-auto-save-file-name))
1769 ;; If auto-save was not already on, turn it on if appropriate.
1770 (if (not buffer-auto-save-file-name)
1771 (and buffer-file-name auto-save-default
1773 ;; If auto save is on, start using a new name.
1774 ;; We deliberately don't rename or delete the old auto save
1775 ;; for the old visited file name. This is because perhaps
1776 ;; the user wants to save the new state and then compare with the
1777 ;; previous state from the auto save file.
1778 (setq buffer-auto-save-file-name
1779 (make-auto-save-file-name)))
1780 ;; Rename the old auto save file if any.
1781 (and oauto buffer-auto-save-file-name
1782 (file-exists-p oauto)
1783 (rename-file oauto buffer-auto-save-file-name t)))
1784 (if buffer-file-name
1785 (not along-with-file)
1786 (set-buffer-modified-p t))
1787 ;; Update the major mode, if the file name determines it.
1789 ;; Don't change the mode if it is special.
1790 (or (not change-major-mode-with-file-name)
1791 (get major-mode 'mode-class)
1792 ;; Don't change the mode if the local variable list specifies it.
1793 (hack-local-variables t)
1797 (run-hooks 'after-set-visited-file-name-hooks))
1799 (defun write-file (filename &optional confirm codesys)
1800 "Write current buffer into file FILENAME.
1801 Makes buffer visit that file, and marks it not modified.
1802 If the buffer is already visiting a file, you can specify
1803 a directory name as FILENAME, to write a file of the same
1804 old name in that directory.
1805 If optional second arg CONFIRM is non-nil,
1806 ask for confirmation for overwriting an existing file.
1807 Under XEmacs/Mule, optional third argument specifies the
1808 coding system to use when encoding the file. Interactively,
1809 with a prefix argument, you will be prompted for the coding system."
1810 ;; (interactive "FWrite file: ")
1812 (list (if buffer-file-name
1813 (read-file-name "Write file: "
1815 (read-file-name "Write file: "
1816 (cdr (assq 'default-directory
1817 (buffer-local-variables)))
1818 nil nil (buffer-name)))
1820 (if (and current-prefix-arg (featurep 'mule))
1821 (read-coding-system "Coding system: "))))
1822 (and (eq (current-buffer) mouse-grabbed-buffer)
1823 (error "Can't write minibuffer window"))
1824 (or (null filename) (string-equal filename "")
1826 ;; If arg is just a directory,
1827 ;; use same file name, but in that directory.
1828 (if (and (file-directory-p filename) buffer-file-name)
1829 (setq filename (concat (file-name-as-directory filename)
1830 (file-name-nondirectory buffer-file-name))))
1832 (file-exists-p filename)
1833 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1834 (error "Canceled")))
1835 (set-visited-file-name filename)))
1836 (set-buffer-modified-p t)
1837 (setq buffer-read-only nil)
1839 (let ((buffer-file-coding-system (get-coding-system codesys)))
1843 (defun backup-buffer ()
1844 "Make a backup of the disk file visited by the current buffer, if appropriate.
1845 This is normally done before saving the buffer the first time.
1846 If the value is non-nil, it is the result of `file-modes' on the original file;
1847 this means that the caller, after saving the buffer, should change the modes
1848 of the new file to agree with the old modes."
1849 (if buffer-file-name
1850 (let ((handler (find-file-name-handler buffer-file-name 'backup-buffer)))
1852 (funcall handler 'backup-buffer)
1853 (if (and make-backup-files
1854 (not backup-inhibited)
1855 (not buffer-backed-up)
1856 (file-exists-p buffer-file-name)
1857 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1859 (let ((real-file-name buffer-file-name)
1860 backup-info backupname targets setmodes)
1861 ;; If specified name is a symbolic link, chase it to the target.
1862 ;; Thus we make the backups in the directory where the real file is.
1863 (setq real-file-name (file-chase-links real-file-name))
1864 (setq backup-info (find-backup-file-name real-file-name)
1865 backupname (car backup-info)
1866 targets (cdr backup-info))
1867 ;;; (if (file-directory-p buffer-file-name)
1868 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1871 (let ((delete-old-versions
1872 ;; If have old versions to maybe delete,
1873 ;; ask the user to confirm now, before doing anything.
1874 ;; But don't actually delete til later.
1876 (or (eq delete-old-versions t)
1877 (eq delete-old-versions nil))
1878 (or delete-old-versions
1879 (y-or-n-p (format "Delete excess backup versions of %s? "
1880 real-file-name))))))
1881 ;; Actually write the back up file.
1883 (if (or file-precious-flag
1884 ; (file-symlink-p buffer-file-name)
1886 (and backup-by-copying-when-linked
1887 (> (file-nlinks real-file-name) 1))
1888 (and backup-by-copying-when-mismatch
1889 (let ((attr (file-attributes real-file-name)))
1891 (not (file-ownership-preserved-p real-file-name))))))
1893 (copy-file real-file-name backupname t t)
1895 ;; If copying fails because file BACKUPNAME
1896 ;; is not writable, delete that file and try again.
1897 (if (and (file-exists-p backupname)
1898 (not (file-writable-p backupname)))
1899 (delete-file backupname))
1900 (copy-file real-file-name backupname t t)))
1901 ;; rename-file should delete old backup.
1902 (rename-file real-file-name backupname t)
1903 (setq setmodes (file-modes backupname)))
1905 ;; If trouble writing the backup, write it in ~.
1906 (setq backupname (expand-file-name "~/%backup%~"))
1907 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1910 (copy-file real-file-name backupname t t)
1912 ;; If copying fails because file BACKUPNAME
1913 ;; is not writable, delete that file and try again.
1914 (if (and (file-exists-p backupname)
1915 (not (file-writable-p backupname)))
1916 (delete-file backupname))
1917 (copy-file real-file-name backupname t t)))))
1918 (setq buffer-backed-up t)
1919 ;; Now delete the old versions, if desired.
1920 (if delete-old-versions
1922 (ignore-file-errors (delete-file (car targets)))
1923 (setq targets (cdr targets))))
1925 (file-error nil)))))))))
1927 (defun file-name-sans-versions (name &optional keep-backup-version)
1928 "Return FILENAME sans backup versions or strings.
1929 This is a separate procedure so your site-init or startup file can
1931 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1932 we do not remove backup version numbers, only true file version numbers."
1933 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1935 (funcall handler 'file-name-sans-versions name keep-backup-version)
1937 (if keep-backup-version
1939 (or (string-match "\\.~[0-9.]+~\\'" name)
1940 ;; XEmacs - VC uses extensions like ".~tagname~" or ".~1.1.5.2~"
1941 (let ((pos (string-match "\\.~\\([^.~ \t]+\\|[0-9.]+\\)~\\'" name)))
1943 ;; #### - is this filesystem check too paranoid?
1944 (file-exists-p (substring name 0 pos))
1946 (string-match "~\\'" name)
1949 (defun file-ownership-preserved-p (file)
1950 "Return t if deleting FILE and rewriting it would preserve the owner."
1951 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1953 (funcall handler 'file-ownership-preserved-p file)
1954 (let ((attributes (file-attributes file)))
1955 ;; Return t if the file doesn't exist, since it's true that no
1956 ;; information would be lost by an (attempted) delete and create.
1957 (or (null attributes)
1958 (= (nth 2 attributes) (user-uid)))))))
1960 (defun file-name-sans-extension (filename)
1961 "Return FILENAME sans final \"extension\".
1962 The extension, in a file name, is the part that follows the last `.'."
1964 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1966 (if (string-match "\\.[^.]*\\'" file)
1967 (if (setq directory (file-name-directory filename))
1968 (expand-file-name (substring file 0 (match-beginning 0))
1970 (substring file 0 (match-beginning 0)))
1973 (defun file-name-extension (filename &optional period)
1974 "Return FILENAME's final \"extension\".
1975 The extension, in a file name, is the part that follows the last `.'.
1976 Return nil for extensionless file names such as `foo'.
1977 Return the empty string for file names such as `foo.'.
1979 If PERIOD is non-nil, then the returned value includes the period
1980 that delimits the extension, and if FILENAME has no extension,
1983 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1984 (if (string-match "\\.[^.]*\\'" file)
1985 (substring file (+ (match-beginning 0) (if period 0 1)))
1989 (defun make-backup-file-name (file)
1990 "Create the non-numeric backup file name for FILE.
1991 This is a separate function so you can redefine it for customization."
1992 (if (eq system-type 'ms-dos)
1993 (let ((fn (file-name-nondirectory file)))
1994 (concat (file-name-directory file)
1995 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
1996 (substring fn 0 (match-end 1)))
2000 (defun backup-file-name-p (file)
2001 "Return non-nil if FILE is a backup file name (numeric or not).
2002 This is a separate function so you can redefine it for customization.
2003 You may need to redefine `file-name-sans-versions' as well."
2004 (if (eq system-type 'ms-dos)
2005 (string-match "\\.bak\\'" file)
2006 (string-match "~\\'" file)))
2008 ;; This is used in various files.
2009 ;; The usage of bv-length is not very clean,
2010 ;; but I can't see a good alternative,
2011 ;; so as of now I am leaving it alone.
2012 (defun backup-extract-version (fn)
2013 "Given the name of a numeric backup file, return the backup number.
2014 Uses the free variable `bv-length', whose value should be
2015 the index in the name where the version number begins."
2016 (declare (special bv-length))
2017 (if (and (string-match "[0-9]+~\\'" fn bv-length)
2018 (= (match-beginning 0) bv-length))
2019 (string-to-int (substring fn bv-length -1))
2022 (defun find-backup-file-name (fn)
2023 "Find a file name for a backup file, and suggestions for deletions.
2024 Value is a list whose car is the name for the backup file
2025 and whose cdr is a list of old versions to consider deleting now.
2026 If the value is nil, don't make a backup."
2027 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2028 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2030 (funcall handler 'find-backup-file-name fn)
2031 (if (eq version-control 'never)
2032 (list (make-backup-file-name fn))
2033 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
2034 ;; used by backup-extract-version:
2035 (bv-length (length base-versions))
2039 (deserve-versions-p nil)
2040 (number-to-delete 0))
2042 (setq possibilities (file-name-all-completions
2044 (file-name-directory fn))
2045 versions (sort (mapcar
2046 #'backup-extract-version
2049 high-water-mark (apply #'max 0 versions)
2050 deserve-versions-p (or version-control
2051 (> high-water-mark 0))
2052 number-to-delete (- (length versions)
2053 kept-old-versions kept-new-versions -1))
2055 (setq possibilities nil)))
2056 (if (not deserve-versions-p)
2057 (list (make-backup-file-name fn))
2058 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2059 (if (and (> number-to-delete 0)
2060 ;; Delete nothing if there is overflow
2061 ;; in the number of versions to keep.
2062 (>= (+ kept-new-versions kept-old-versions -1) 0))
2063 (mapcar #'(lambda (n)
2064 (concat fn ".~" (int-to-string n) "~"))
2065 (let ((v (nthcdr kept-old-versions versions)))
2066 (rplacd (nthcdr (1- number-to-delete) v) ())
2069 (defun file-nlinks (filename)
2070 "Return number of names file FILENAME has."
2071 (car (cdr (file-attributes filename))))
2073 (defun file-relative-name (filename &optional directory)
2074 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2075 This function returns a relative file name which is equivalent to FILENAME
2076 when used with that default directory as the default.
2077 If this is impossible (which can happen on MSDOS and Windows
2078 when the file name and directory use different drive names)
2079 then it returns FILENAME."
2081 (let ((fname (expand-file-name filename)))
2082 (setq directory (file-name-as-directory
2083 (expand-file-name (or directory default-directory))))
2084 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2085 ;; drive names, they can't be relative, so return the absolute name.
2086 (if (and (memq system-type '(ms-dos windows-nt))
2087 (not (string-equal (substring fname 0 2)
2088 (substring directory 0 2))))
2090 (let ((ancestor ".")
2091 (fname-dir (file-name-as-directory fname)))
2092 (while (and (not (string-match (concat "^" (regexp-quote directory))
2094 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2095 (setq directory (file-name-directory (substring directory 0 -1))
2096 ancestor (if (equal ancestor ".")
2098 (concat "../" ancestor))))
2099 ;; Now ancestor is empty, or .., or ../.., etc.
2100 (if (string-match (concat "^" (regexp-quote directory)) fname)
2101 ;; We matched within FNAME's directory part.
2102 ;; Add the rest of FNAME onto ANCESTOR.
2103 (let ((rest (substring fname (match-end 0))))
2104 (if (and (equal ancestor ".")
2105 (not (equal rest "")))
2106 ;; But don't bother with ANCESTOR if it would give us `./'.
2108 (concat (file-name-as-directory ancestor) rest)))
2109 ;; We matched FNAME's directory equivalent.
2112 (defun save-buffer (&optional args)
2113 "Save current buffer in visited file if modified. Versions described below.
2115 By default, makes the previous version into a backup file
2116 if previously requested or if this is the first save.
2117 With 1 or 3 \\[universal-argument]'s, marks this version
2118 to become a backup when the next save is done.
2119 With 2 or 3 \\[universal-argument]'s,
2120 unconditionally makes the previous version into a backup file.
2121 With argument of 0, never makes the previous version into a backup file.
2123 If a file's name is FOO, the names of its numbered backup versions are
2124 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2125 Numeric backups (rather than FOO~) will be made if value of
2126 `version-control' is not the atom `never' and either there are already
2127 numeric versions of the file being backed up, or `version-control' is
2129 We don't want excessive versions piling up, so there are variables
2130 `kept-old-versions', which tells XEmacs how many oldest versions to keep,
2131 and `kept-new-versions', which tells how many newest versions to keep.
2132 Defaults are 2 old versions and 2 new.
2133 `dired-kept-versions' controls dired's clean-directory (.) command.
2134 If `delete-old-versions' is nil, system will query user
2135 before trimming versions. Otherwise it does it silently."
2137 (let ((modp (buffer-modified-p))
2138 (large (> (buffer-size) 50000))
2139 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2140 (memq args '(16 64)))))
2141 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2142 (if (and modp large) (display-message
2143 'progress (format "Saving file %s..."
2144 (buffer-file-name))))
2146 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2148 (defun delete-auto-save-file-if-necessary (&optional force)
2149 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2150 Normally delete only if the file was written by this XEmacs
2151 since the last real save, but optional arg FORCE non-nil means delete anyway."
2152 (and buffer-auto-save-file-name delete-auto-save-files
2153 (not (string= buffer-file-name buffer-auto-save-file-name))
2154 (or force (recent-auto-save-p))
2156 (ignore-file-errors (delete-file buffer-auto-save-file-name))
2157 (set-buffer-auto-saved))))
2159 ;; XEmacs change (from Sun)
2160 ;; used to communicate with continue-save-buffer:
2161 (defvar continue-save-buffer-hooks-tail nil)
2164 (defun basic-write-file-data (realname truename)
2165 ;; call the hooks until the bytes are put
2166 ;; call write-region as a last resort
2167 (let ((region-written nil)
2168 (hooks write-file-data-hooks))
2169 (while (and hooks (not region-written))
2170 (setq region-written (funcall (car hooks) realname)
2172 (if (not region-written)
2173 (write-region (point-min) (point-max) realname nil t truename))))
2175 (put 'after-save-hook 'permanent-local t)
2176 (defvar after-save-hook nil
2177 "Normal hook that is run after a buffer is saved to its file.
2178 These hooks are considered to pertain to the visited file.
2179 So this list is cleared if you change the visited file name.")
2181 (defun files-fetch-hook-value (hook)
2182 (let ((localval (symbol-value hook))
2183 (globalval (default-value hook)))
2184 (if (memq t localval)
2185 (setq localval (append (delq t localval) (delq t globalval))))
2188 (defun basic-save-buffer ()
2189 "Save the current buffer in its visited file, if it has been modified.
2190 After saving the buffer, run `after-save-hook'."
2193 ;; In an indirect buffer, save its base buffer instead.
2194 (if (buffer-base-buffer)
2195 (set-buffer (buffer-base-buffer)))
2196 (if (buffer-modified-p)
2197 (let ((recent-save (recent-auto-save-p)))
2198 ;; If buffer has no file name, ask user for one.
2199 (or buffer-file-name
2202 (read-file-name "File to save in: ") nil)))
2203 (and (file-exists-p filename)
2204 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2206 (error "Canceled")))
2207 (set-visited-file-name filename)))
2208 (or (verify-visited-file-modtime (current-buffer))
2209 (not (file-exists-p buffer-file-name))
2211 (format "%s has changed since visited or saved. Save anyway? "
2212 (file-name-nondirectory buffer-file-name)))
2213 (error "Save not confirmed"))
2216 (and (> (point-max) 1)
2217 (/= (char-after (1- (point-max))) ?\n)
2218 (not (and (eq selective-display t)
2219 (= (char-after (1- (point-max))) ?\r)))
2220 (or (eq require-final-newline t)
2221 (and require-final-newline
2223 (format "Buffer %s does not end in newline. Add one? "
2226 (goto-char (point-max))
2229 ;; Run the write-file-hooks until one returns non-null.
2230 ;; Bind after-save-hook to nil while running the
2231 ;; write-file-hooks so that if this function is called
2232 ;; recursively (from inside a write-file-hook) the
2233 ;; after-hooks will only get run once (from the
2236 ;; Ugh, have to duplicate logic of run-hook-with-args-until-success
2237 (let ((hooks (append (files-fetch-hook-value 'write-contents-hooks)
2238 (files-fetch-hook-value
2239 'local-write-file-hooks)
2240 (files-fetch-hook-value 'write-file-hooks)))
2241 (after-save-hook nil)
2242 (local-write-file-hooks nil)
2243 (write-contents-hooks nil)
2244 (write-file-hooks nil)
2247 (let ((continue-save-buffer-hooks-tail hooks))
2248 (not (setq done (funcall (car hooks))))))
2249 (setq hooks (cdr hooks)))
2250 ;; If a hook returned t, file is already "written".
2251 ;; Otherwise, write it the usual way now.
2253 (basic-save-buffer-1)))
2254 ;; XEmacs: next two clauses (buffer-file-number setting and
2255 ;; set-file-modes) moved into basic-save-buffer-1.
2257 ;; If the auto-save file was recent before this command,
2259 (delete-auto-save-file-if-necessary recent-save)
2260 ;; Support VC `implicit' locking.
2261 (when (fboundp 'vc-after-save)
2263 (run-hooks 'after-save-hook))
2264 (display-message 'no-log "(No changes need to be saved)"))))
2266 ;; This does the "real job" of writing a buffer into its visited file
2267 ;; and making a backup file. This is what is normally done
2268 ;; but inhibited if one of write-file-hooks returns non-nil.
2269 ;; It returns a value to store in setmodes.
2270 (defun basic-save-buffer-1 ()
2271 (let (setmodes tempsetmodes)
2272 (if (not (file-writable-p buffer-file-name))
2273 (let ((dir (file-name-directory buffer-file-name)))
2274 (if (not (file-directory-p dir))
2275 (error "%s is not a directory" dir)
2276 (if (not (file-exists-p buffer-file-name))
2277 (error "Directory %s write-protected" dir)
2279 (format "File %s is write-protected; try to save anyway? "
2280 (file-name-nondirectory
2282 (setq tempsetmodes t)
2284 "Attempt to save to a file which you aren't allowed to write"))))))
2285 (or buffer-backed-up
2286 (setq setmodes (backup-buffer)))
2287 (let ((dir (file-name-directory buffer-file-name)))
2288 (if (and file-precious-flag
2289 (file-writable-p dir))
2290 ;; If file is precious, write temp name, then rename it.
2291 ;; This requires write access to the containing dir,
2292 ;; which is why we don't try it if we don't have that access.
2293 (let ((realname buffer-file-name)
2294 tempname nogood i succeed
2295 (old-modtime (visited-file-modtime)))
2298 ;; Find the temporary name to write under.
2300 (setq tempname (format "%s#tmp#%d" dir i))
2301 (setq nogood (file-exists-p tempname))
2304 (progn (clear-visited-file-modtime)
2305 (write-region (point-min) (point-max)
2306 tempname nil realname
2307 buffer-file-truename)
2309 ;; If writing the temp file fails,
2310 ;; delete the temp file.
2313 (delete-file tempname)
2314 (set-visited-file-modtime old-modtime))))
2315 ;; Since we have created an entirely new file
2316 ;; and renamed it, make sure it gets the
2317 ;; right permission bits set.
2318 (setq setmodes (file-modes buffer-file-name))
2319 ;; We succeeded in writing the temp file,
2321 (rename-file tempname buffer-file-name t))
2322 ;; If file not writable, see if we can make it writable
2323 ;; temporarily while we write it.
2324 ;; But no need to do so if we have just backed it up
2325 ;; (setmodes is set) because that says we're superseding.
2326 (cond ((and tempsetmodes (not setmodes))
2327 ;; Change the mode back, after writing.
2328 (setq setmodes (file-modes buffer-file-name))
2329 (set-file-modes buffer-file-name 511)))
2330 (basic-write-file-data buffer-file-name buffer-file-truename)))
2331 (setq buffer-file-number
2332 (if buffer-file-name
2333 (nth 10 (file-attributes buffer-file-name))
2337 (set-file-modes buffer-file-name setmodes)
2340 ;; XEmacs change, from Sun
2341 (defun continue-save-buffer ()
2342 "Provide a clean way for a write-file-hook to wrap AROUND
2343 the execution of the remaining hooks and writing to disk.
2344 Do not call this function except from a functions
2345 on the write-file-hooks or write-contents-hooks list.
2346 A hook that calls this function must return non-nil,
2347 to signal completion to its caller. continue-save-buffer
2348 always returns non-nil."
2349 (let ((hooks (cdr (or continue-save-buffer-hooks-tail
2351 "continue-save-buffer called outside a write-file-hook!"))))
2353 ;; Do something like this:
2354 ;; (let ((write-file-hooks hooks)) (basic-save-buffer))
2355 ;; First run the rest of the hooks.
2357 (let ((continue-save-buffer-hooks-tail hooks))
2358 (not (setq done (funcall (car hooks))))))
2359 (setq hooks (cdr hooks)))
2361 ;; If a hook returned t, file is already "written".
2363 (basic-save-buffer-1))
2364 'continue-save-buffer))
2366 (defcustom save-some-buffers-query-display-buffer t
2367 "*Non-nil makes `\\[save-some-buffers]' switch to the buffer offered for saving."
2369 :group 'editing-basics)
2371 (defun save-some-buffers (&optional arg exiting)
2372 "Save some modified file-visiting buffers. Asks user about each one.
2373 Optional argument (the prefix) non-nil means save all with no questions.
2374 Optional second argument EXITING means ask about certain non-file buffers
2375 as well as about file buffers."
2378 ;; `delete-other-windows' can bomb during autoloads generation, so
2380 (if (or noninteractive
2381 (eq (selected-window) (minibuffer-window))
2382 (not save-some-buffers-query-display-buffer))
2383 ;; If playing with windows is unsafe or undesired, just do the
2385 (save-some-buffers-1 arg exiting nil)
2386 ;; Else, protect the windows.
2387 (when (save-window-excursion
2388 (save-some-buffers-1 arg exiting t))
2392 ;; XEmacs - do not use queried flag
2393 (defun save-some-buffers-1 (arg exiting switch-buffer)
2394 (let* ((switched nil)
2398 (and (buffer-modified-p buffer)
2399 (not (buffer-base-buffer buffer))
2401 (not (symbol-value-in-buffer 'save-buffers-skip buffer))
2403 (buffer-file-name buffer)
2407 (and buffer-offer-save (> (buffer-size) 0)))))
2410 ;; #### We should provide a per-buffer means to
2411 ;; disable the switching. For instance, you might
2412 ;; want to turn it off for buffers the contents of
2413 ;; which is meaningless to humans, such as
2416 (unless (one-window-p)
2417 (delete-other-windows))
2419 ;; #### Consider using `display-buffer' here for 21.1!
2420 ;;(display-buffer buffer nil (selected-frame)))
2421 (switch-to-buffer buffer t))
2422 (if (buffer-file-name buffer)
2423 (format "Save file %s? "
2424 (buffer-file-name buffer))
2425 (format "Save buffer %s? "
2426 (buffer-name buffer))))))
2433 '("buffer" "buffers" "save")
2434 ;;instead of this we just say "yes all", "no all", etc.
2435 ;;"save all the rest"
2436 ;;"save only this buffer" "save no more buffers")
2437 ;; this is rather bogus. --ben
2438 ;; (it makes the dialog box too big, and you get an error
2439 ;; "wrong type argument: framep, nil" when you hit q after
2440 ;; choosing the option from the dialog box)
2442 ;; We should fix the dialog box rather than disabling
2444 (list (list ?\C-r (lambda (buf)
2445 ;; #### FSF has an EXIT-ACTION argument
2446 ;; to `view-buffer'.
2448 (setq view-exit-action
2450 (exit-recursive-edit)))
2452 ;; Return nil to ask about BUF again.
2454 "display the current buffer"))))
2456 (and save-abbrevs abbrevs-changed
2459 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
2460 (write-abbrev-file nil))
2461 ;; Don't keep bothering user if he says no.
2462 (setq abbrevs-changed nil)
2464 (or (> files-done 0) abbrevs-done
2465 (display-message 'no-log "(No files need saving)"))
2469 (defun not-modified (&optional arg)
2470 "Mark current buffer as unmodified, not needing to be saved.
2471 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2473 It is not a good idea to use this function in Lisp programs, because it
2474 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2476 (if arg ;; rewritten for I18N3 snarfing
2477 (display-message 'command "Modification-flag set")
2478 (display-message 'command "Modification-flag cleared"))
2479 (set-buffer-modified-p arg))
2481 (defun toggle-read-only (&optional arg)
2482 "Toggle the current buffer's read-only status.
2483 With arg, set read-only iff arg is positive."
2485 (setq buffer-read-only
2487 (not buffer-read-only)
2488 (> (prefix-numeric-value arg) 0)))
2489 ;; Force modeline redisplay
2492 (defun insert-file (filename &optional codesys)
2493 "Insert contents of file FILENAME into buffer after point.
2494 Set mark after the inserted text.
2496 Under XEmacs/Mule, optional second argument specifies the
2497 coding system to use when decoding the file. Interactively,
2498 with a prefix argument, you will be prompted for the coding system.
2500 This function is meant for the user to run interactively.
2501 Don't call it from programs! Use `insert-file-contents' instead.
2502 \(Its calling sequence is different; see its documentation)."
2503 (interactive "*fInsert file: \nZCoding system: ")
2504 (if (file-directory-p filename)
2505 (signal 'file-error (list "Opening input file" "file is a directory"
2509 (let ((coding-system-for-read
2510 (get-coding-system codesys)))
2511 (insert-file-contents filename))
2512 (insert-file-contents filename))))
2513 (push-mark (+ (point) (car (cdr tem))))))
2515 (defun append-to-file (start end filename &optional codesys)
2516 "Append the contents of the region to the end of file FILENAME.
2517 When called from a function, expects three arguments,
2518 START, END and FILENAME. START and END are buffer positions
2519 saying what text to write.
2520 Under XEmacs/Mule, optional fourth argument specifies the
2521 coding system to use when encoding the file. Interactively,
2522 with a prefix argument, you will be prompted for the coding system."
2523 (interactive "r\nFAppend to file: \nZCoding system: ")
2525 (let ((buffer-file-coding-system (get-coding-system codesys)))
2526 (write-region start end filename t))
2527 (write-region start end filename t)))
2529 (defun file-newest-backup (filename)
2530 "Return most recent backup file for FILENAME or nil if no backups exist."
2531 (let* ((filename (expand-file-name filename))
2532 (file (file-name-nondirectory filename))
2533 (dir (file-name-directory filename))
2534 (comp (file-name-all-completions file dir))
2537 (setq file (concat dir (car comp))
2539 (if (and (backup-file-name-p file)
2540 (or (null newest) (file-newer-than-file-p file newest)))
2541 (setq newest file)))
2544 (defun rename-uniquely ()
2545 "Rename current buffer to a similar name not already taken.
2546 This function is useful for creating multiple shell process buffers
2547 or multiple mail buffers, etc."
2550 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2551 (not (and buffer-file-name
2552 (string= (buffer-name)
2553 (file-name-nondirectory
2554 buffer-file-name)))))
2555 ;; If the existing buffer name has a <NNN>,
2556 ;; which isn't part of the file name (if any),
2557 ;; then get rid of that.
2558 (substring (buffer-name) 0 (match-beginning 0))
2560 (new-buf (generate-new-buffer base-name))
2561 (name (buffer-name new-buf)))
2562 (kill-buffer new-buf)
2563 (rename-buffer name)
2564 (redraw-modeline))))
2566 (defun make-directory-path (path)
2567 "Create all the directories along path that don't exist yet."
2568 (interactive "Fdirectory path to create: ")
2569 (make-directory path t))
2571 (defun make-directory (dir &optional parents)
2572 "Create the directory DIR and any nonexistent parent dirs.
2573 Interactively, the default choice of directory to create
2574 is the current default directory for file names.
2575 That is useful when you have visited a file in a nonexistent directory.
2577 Noninteractively, the second (optional) argument PARENTS says whether
2578 to create parent directories if they don't exist."
2579 (interactive (list (let ((current-prefix-arg current-prefix-arg))
2580 (read-directory-name "Create directory: "))
2581 current-prefix-arg))
2582 (let ((handler (find-file-name-handler dir 'make-directory)))
2584 (funcall handler 'make-directory dir parents)
2586 (make-directory-internal dir)
2587 (let ((dir (directory-file-name (expand-file-name dir)))
2589 (while (not (file-exists-p dir))
2590 (setq create-list (cons dir create-list)
2591 dir (directory-file-name (file-name-directory dir))))
2593 (make-directory-internal (car create-list))
2594 (setq create-list (cdr create-list))))))))
2596 (put 'revert-buffer-function 'permanent-local t)
2597 (defvar revert-buffer-function nil
2598 "Function to use to revert this buffer, or nil to do the default.
2599 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2600 which are the arguments that `revert-buffer' received.")
2602 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2603 (defvar revert-buffer-insert-file-contents-function nil
2604 "Function to use to insert contents when reverting this buffer.
2605 Gets two args, first the nominal file name to use,
2606 and second, t if reading the auto-save file.")
2608 (defvar before-revert-hook nil
2609 "Normal hook for `revert-buffer' to run before reverting.
2610 If `revert-buffer-function' is used to override the normal revert
2611 mechanism, this hook is not used.")
2613 (defvar after-revert-hook nil
2614 "Normal hook for `revert-buffer' to run after reverting.
2615 Note that the hook value that it runs is the value that was in effect
2616 before reverting; that makes a difference if you have buffer-local
2619 If `revert-buffer-function' is used to override the normal revert
2620 mechanism, this hook is not used.")
2622 (defvar revert-buffer-internal-hook nil
2625 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2626 "Replace the buffer text with the text of the visited file on disk.
2627 This undoes all changes since the file was visited or saved.
2628 With a prefix argument, offer to revert from latest auto-save file, if
2629 that is more recent than the visited file.
2631 This command also works for special buffers that contain text which
2632 doesn't come from a file, but reflects some other data base instead:
2633 for example, Dired buffers and buffer-list buffers. In these cases,
2634 it reconstructs the buffer contents from the appropriate data base.
2636 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2637 to revert from the auto-save file when this is nil. Note that the
2638 sense of this argument is the reverse of the prefix argument, for the
2639 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2642 Optional second argument NOCONFIRM means don't ask for confirmation at
2645 Optional third argument PRESERVE-MODES non-nil means don't alter
2646 the files modes. Normally we reinitialize them using `normal-mode'.
2648 If the value of `revert-buffer-function' is non-nil, it is called to
2649 do all the work for this command. Otherwise, the hooks
2650 `before-revert-hook' and `after-revert-hook' are run at the beginning
2651 and the end, and if `revert-buffer-insert-file-contents-function' is
2652 non-nil, it is called instead of rereading visited file contents."
2654 ;; I admit it's odd to reverse the sense of the prefix argument, but
2655 ;; there is a lot of code out there which assumes that the first
2656 ;; argument should be t to avoid consulting the auto-save file, and
2657 ;; there's no straightforward way to encourage authors to notice a
2658 ;; reversal of the argument sense. So I'm just changing the user
2659 ;; interface, but leaving the programmatic interface the same.
2660 (interactive (list (not current-prefix-arg)))
2661 (if revert-buffer-function
2662 (funcall revert-buffer-function ignore-auto noconfirm)
2663 (let* ((opoint (point))
2664 (auto-save-p (and (not ignore-auto)
2665 (recent-auto-save-p)
2666 buffer-auto-save-file-name
2667 (file-readable-p buffer-auto-save-file-name)
2669 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2670 (file-name (if auto-save-p
2671 buffer-auto-save-file-name
2673 (cond ((null file-name)
2674 (error "Buffer does not seem to be associated with any file"))
2676 (and (not (buffer-modified-p))
2678 (dolist (rx revert-without-query found)
2679 (when (string-match rx file-name)
2681 (yes-or-no-p (format "Revert buffer from file %s? "
2683 (run-hooks 'before-revert-hook)
2684 ;; If file was backed up but has changed since,
2685 ;; we shd make another backup.
2686 (and (not auto-save-p)
2687 (not (verify-visited-file-modtime (current-buffer)))
2688 (setq buffer-backed-up nil))
2689 ;; Get rid of all undo records for this buffer.
2690 (or (eq buffer-undo-list t)
2691 (setq buffer-undo-list nil))
2692 ;; Effectively copy the after-revert-hook status,
2693 ;; since after-find-file will clobber it.
2694 (let ((global-hook (default-value 'after-revert-hook))
2695 (local-hook-p (local-variable-p 'after-revert-hook
2697 (local-hook (and (local-variable-p 'after-revert-hook
2699 after-revert-hook)))
2700 (let (buffer-read-only
2701 ;; Don't make undo records for the reversion.
2702 (buffer-undo-list t))
2703 (if revert-buffer-insert-file-contents-function
2704 (funcall revert-buffer-insert-file-contents-function
2705 file-name auto-save-p)
2706 (if (not (file-exists-p file-name))
2707 (error "File %s no longer exists!" file-name))
2708 ;; Bind buffer-file-name to nil
2709 ;; so that we don't try to lock the file.
2710 (let ((buffer-file-name nil))
2714 (insert-file-contents file-name (not auto-save-p)
2716 (goto-char (min opoint (point-max)))
2717 ;; Recompute the truename in case changes in symlinks
2718 ;; have changed the truename.
2719 ;XEmacs: already done by insert-file-contents
2720 ;;(setq buffer-file-truename
2721 ;;(abbreviate-file-name (file-truename buffer-file-name)))
2722 (after-find-file nil nil t t preserve-modes)
2723 ;; Run after-revert-hook as it was before we reverted.
2724 (setq-default revert-buffer-internal-hook global-hook)
2727 (make-local-variable 'revert-buffer-internal-hook)
2728 (setq revert-buffer-internal-hook local-hook))
2729 (kill-local-variable 'revert-buffer-internal-hook))
2730 (run-hooks 'revert-buffer-internal-hook))
2733 (defun recover-file (file)
2734 "Visit file FILE, but get contents from its last auto-save file."
2735 ;; Actually putting the file name in the minibuffer should be used
2737 ;; Not just because users often use the default.
2738 (interactive "FRecover file: ")
2739 (setq file (expand-file-name file))
2740 (let ((handler (or (find-file-name-handler file 'recover-file)
2741 (find-file-name-handler
2742 (let ((buffer-file-name file))
2743 (make-auto-save-file-name))
2746 (funcall handler 'recover-file file)
2747 (if (auto-save-file-name-p file)
2748 (error "%s is an auto-save file" file))
2749 (let ((file-name (let ((buffer-file-name file))
2750 (make-auto-save-file-name))))
2751 (cond ((if (file-exists-p file)
2752 (not (file-newer-than-file-p file-name file))
2753 (not (file-exists-p file-name)))
2754 (error "Auto-save file %s not current" file-name))
2755 ((save-window-excursion
2756 (if (not (eq system-type 'windows-nt))
2757 (with-output-to-temp-buffer "*Directory*"
2758 (buffer-disable-undo standard-output)
2759 (call-process "ls" nil standard-output nil
2760 (if (file-symlink-p file) "-lL" "-l")
2762 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2763 (switch-to-buffer (find-file-noselect file t))
2764 (let ((buffer-read-only nil))
2766 (insert-file-contents file-name nil))
2767 (after-find-file nil nil t))
2768 (t (error "Recover-file cancelled.")))))))
2770 (defun recover-session ()
2771 "Recover auto save files from a previous Emacs session.
2772 This command first displays a Dired buffer showing you the
2773 previous sessions that you could recover from.
2774 To choose one, move point to the proper line and then type C-c C-c.
2775 Then you'll be asked about a number of files to recover."
2777 (unless (fboundp 'dired)
2778 (error "recover-session requires dired"))
2779 (if (null auto-save-list-file-prefix)
2781 "You set `auto-save-list-file-prefix' to disable making session files"))
2782 (dired (concat auto-save-list-file-prefix "*"))
2783 (goto-char (point-min))
2784 (or (looking-at "Move to the session you want to recover,")
2785 (let ((inhibit-read-only t))
2786 (insert "Move to the session you want to recover,\n"
2787 "then type C-c C-c to select it.\n\n"
2788 "You can also delete some of these files;\n"
2789 "type d on a line to mark that file for deletion.\n\n")))
2790 (use-local-map (let ((map (make-sparse-keymap)))
2791 (set-keymap-parents map (list (current-local-map)))
2793 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2795 (defun recover-session-finish ()
2796 "Choose one saved session to recover auto-save files from.
2797 This command is used in the special Dired buffer created by
2798 \\[recover-session]."
2800 ;; Get the name of the session file to recover from.
2801 (let ((file (dired-get-filename))
2803 (buffer (get-buffer-create " *recover*")))
2804 ;; #### dired-do-flagged-delete in FSF.
2805 ;; This version is for ange-ftp
2806 ;;(dired-do-deletions t)
2807 ;; This version is for efs
2808 (dired-expunge-deletions)
2811 ;; Read in the auto-save-list file.
2814 (insert-file-contents file)
2815 ;; Loop thru the text of that file
2816 ;; and get out the names of the files to recover.
2818 (let (thisfile autofile)
2820 ;; This is a pair of lines for a non-file-visiting buffer.
2821 ;; Get the auto-save file name and manufacture
2822 ;; a "visited file name" from that.
2826 (buffer-substring-no-properties
2834 (file-name-nondirectory autofile)
2836 (file-name-directory autofile)))
2838 ;; This pair of lines is a file-visiting
2839 ;; buffer. Use the visited file name.
2842 (buffer-substring-no-properties
2843 (point) (progn (end-of-line) (point))))
2846 (buffer-substring-no-properties
2847 (point) (progn (end-of-line) (point))))
2849 ;; Ignore a file if its auto-save file does not exist now.
2850 (if (file-exists-p autofile)
2851 (setq files (cons thisfile files)))))
2852 (setq files (nreverse files))
2853 ;; The file contains a pair of line for each auto-saved buffer.
2854 ;; The first line of the pair contains the visited file name
2855 ;; or is empty if the buffer was not visiting a file.
2856 ;; The second line is the auto-save file name.
2858 (map-y-or-n-p "Recover %s? "
2861 (save-excursion (recover-file file))
2863 "Failed to recover `%s'" file)))
2865 '("file" "files" "recover"))
2866 (message "No files can be recovered from this session now")))
2867 (kill-buffer buffer))))
2869 (defun kill-some-buffers (&optional list)
2870 "For each buffer in LIST, ask whether to kill it.
2871 LIST defaults to all existing live buffers."
2874 (setq list (buffer-list)))
2876 (let* ((buffer (car list))
2877 (name (buffer-name buffer)))
2878 (and (not (string-equal name ""))
2879 (/= (aref name 0) ?\ )
2882 (if (buffer-modified-p buffer)
2883 (gettext "Buffer %s HAS BEEN EDITED. Kill? ")
2884 (gettext "Buffer %s is unmodified. Kill? "))
2886 (kill-buffer buffer)))
2887 (setq list (cdr list))))
2889 (defun auto-save-mode (arg)
2890 "Toggle auto-saving of contents of current buffer.
2891 With prefix argument ARG, turn auto-saving on if positive, else off."
2893 (setq buffer-auto-save-file-name
2895 (or (not buffer-auto-save-file-name)
2896 ;; If autosave is off because buffer has shrunk,
2897 ;; then toggling should turn it on.
2898 (< buffer-saved-size 0))
2899 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2900 (if (and buffer-file-name auto-save-visited-file-name
2901 (not buffer-read-only))
2903 (make-auto-save-file-name))))
2904 ;; If -1 was stored here, to temporarily turn off saving,
2906 (and (< buffer-saved-size 0)
2907 (setq buffer-saved-size 0))
2909 (if buffer-auto-save-file-name ;; rewritten for I18N3 snarfing
2910 (display-message 'command "Auto-save on (in this buffer)")
2911 (display-message 'command "Auto-save off (in this buffer)")))
2912 buffer-auto-save-file-name)
2914 (defun rename-auto-save-file ()
2915 "Adjust current buffer's auto save file name for current conditions.
2916 Also rename any existing auto save file, if it was made in this session."
2917 (let ((osave buffer-auto-save-file-name))
2918 (setq buffer-auto-save-file-name
2919 (make-auto-save-file-name))
2920 (if (and osave buffer-auto-save-file-name
2921 (not (string= buffer-auto-save-file-name buffer-file-name))
2922 (not (string= buffer-auto-save-file-name osave))
2923 (file-exists-p osave)
2924 (recent-auto-save-p))
2925 (rename-file osave buffer-auto-save-file-name t))))
2927 ;; see also ../packages/auto-save.el
2928 (defun make-auto-save-file-name (&optional filename)
2929 "Return file name to use for auto-saves of current buffer.
2930 Does not consider `auto-save-visited-file-name' as that variable is checked
2931 before calling this function. You can redefine this for customization.
2932 See also `auto-save-file-name-p'."
2933 (let ((fname (or filename buffer-file-name))
2937 (concat (file-name-directory fname)
2939 (file-name-nondirectory fname)
2942 ;; Deal with buffers that don't have any associated files. (Mail
2943 ;; mode tends to create a good number of these.)
2945 (let ((buffer-name (buffer-name))
2947 ;; Use technique from Sebastian Kremer's auto-save
2948 ;; package to turn slashes into \\!. This ensures that
2949 ;; the auto-save buffer name is unique.
2951 ;; #### - yuck! yuck! yuck! move this functionality
2952 ;; somewhere else and make the name translation customizable.
2953 ;; Using "\!" as part of a filename on a UNIX filesystem is nearly
2954 ;; IMPOSSIBLE to get past a shell parser. -stig
2956 (while (string-match "[/\\]" buffer-name limit)
2958 (concat (substring buffer-name 0 (match-beginning 0))
2959 (if (string= (substring buffer-name
2965 (substring buffer-name (match-end 0))))
2966 (setq limit (1+ (match-end 0))))
2968 ;; (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))
2970 ;; jwz: putting the emacs PID in the auto-save file name
2971 ;; is bad news, because that defeats auto-save-recovery of
2972 ;; *mail* buffers -- the (sensible) code in sendmail.el
2973 ;; calls (make-auto-save-file-name) to determine whether
2974 ;; there is unsent, auto-saved mail to recover. If that
2975 ;; mail came from a previous emacs process (far and away
2976 ;; the most likely case) then this can never succeed as
2979 (expand-file-name (format "#%s#" buffer-name)))
2981 ;; don't try to write auto-save files in unwritable places. Unless
2982 ;; there's already an autosave file here, put ours somewhere safe. --Stig
2983 (if (or (file-writable-p name)
2984 (file-exists-p name))
2986 (expand-file-name (concat "~/" (file-name-nondirectory name))))))
2988 (defun auto-save-file-name-p (filename)
2989 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2990 FILENAME should lack slashes.
2991 You can redefine this for customization."
2992 (string-match "\\`#.*#\\'" filename))
2994 (defun wildcard-to-regexp (wildcard)
2995 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2996 The generated regexp will match a filename iff the filename
2997 matches that wildcard according to shell rules. Only wildcards known
2998 by `sh' are supported."
2999 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3000 ;; Copy the initial run of non-special characters.
3001 (result (substring wildcard 0 i))
3002 (len (length wildcard)))
3003 ;; If no special characters, we're almost done.
3006 (let ((ch (aref wildcard i))
3012 ((eq ch ?\[) ; [...] maps to regexp char class
3017 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3020 (if (eq (aref wildcard i) ?\])
3025 ((eq (aref wildcard i) ?^)
3026 ;; Found "[^". Insert a `\0' character
3027 ;; (which cannot happen in a filename)
3028 ;; into the character class, so that `^'
3029 ;; is not the first character after `[',
3030 ;; and thus non-special in a regexp.
3034 ((eq (aref wildcard i) ?\])
3035 ;; I don't think `]' can appear in a
3036 ;; character class in a wildcard, but
3037 ;; let's be general here.
3042 (prog1 ; copy everything upto next `]'.
3045 (setq j (string-match
3047 (setq i (if j (1- j) (1- len)))))))
3049 ((eq ch ?*) "[^\000]*")
3053 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3054 ((eq ch ??) "[^\000]")
3055 (t (char-to-string ch)))))
3057 ;; Shell wildcards should match the entire filename,
3058 ;; not its part. Make the regexp say so.
3059 (concat "\\`" result "\\'")))
3061 (defcustom list-directory-brief-switches "-CF"
3062 "*Switches for list-directory to pass to `ls' for brief listing."
3066 (defcustom list-directory-verbose-switches "-l"
3067 "*Switches for list-directory to pass to `ls' for verbose listing,"
3071 (defun list-directory (dirname &optional verbose)
3072 "Display a list of files in or matching DIRNAME, a la `ls'.
3073 DIRNAME is globbed by the shell if necessary.
3074 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3075 Actions controlled by variables `list-directory-brief-switches'
3076 and `list-directory-verbose-switches'."
3077 (interactive (let ((pfx current-prefix-arg))
3078 (list (read-file-name (if pfx (gettext "List directory (verbose): ")
3079 (gettext "List directory (brief): "))
3080 nil default-directory nil)
3082 (let ((switches (if verbose list-directory-verbose-switches
3083 list-directory-brief-switches)))
3084 (or dirname (setq dirname default-directory))
3085 (setq dirname (expand-file-name dirname))
3086 (with-output-to-temp-buffer "*Directory*"
3087 (buffer-disable-undo standard-output)
3088 (princ "Directory ")
3092 (set-buffer "*Directory*")
3093 (setq default-directory (file-name-directory dirname))
3094 (let ((wildcard (not (file-directory-p dirname))))
3095 (insert-directory dirname switches wildcard (not wildcard)))))))
3097 (defvar insert-directory-program "ls"
3098 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3101 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3102 ;; FULL-DIRECTORY-P is nil.
3103 ;; The single line of output must display FILE's name as it was
3104 ;; given, namely, an absolute path name.
3105 ;; - must insert exactly one line for each file if WILDCARD or
3106 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3107 ;; before the file lines, plus optional text after the file lines.
3108 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3110 ;; File lines should display the basename.
3111 ;; - must be consistent with
3112 ;; - functions dired-move-to-filename, (these two define what a file line is)
3113 ;; dired-move-to-end-of-filename,
3114 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3115 ;; dired-insert-headerline
3116 ;; dired-after-subdir-garbage (defines what a "total" line is)
3117 ;; - variable dired-subdir-regexp
3118 (defun insert-directory (file switches &optional wildcard full-directory-p)
3119 "Insert directory listing for FILE, formatted according to SWITCHES.
3120 Leaves point after the inserted text.
3121 SWITCHES may be a string of options, or a list of strings.
3122 Optional third arg WILDCARD means treat FILE as shell wildcard.
3123 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3124 switches do not contain `d', so that a full listing is expected.
3126 This works by running a directory listing program
3127 whose name is in the variable `insert-directory-program'.
3128 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3129 ;; We need the directory in order to find the right handler.
3130 (let ((handler (find-file-name-handler (expand-file-name file)
3131 'insert-directory)))
3133 (funcall handler 'insert-directory file switches
3134 wildcard full-directory-p)
3136 ((and (fboundp 'mswindows-insert-directory)
3137 (eq system-type 'windows-nt))
3138 (mswindows-insert-directory file switches wildcard full-directory-p))
3141 ;; Run ls in the directory of the file pattern we asked for.
3142 (let ((default-directory
3143 (if (file-name-absolute-p file)
3144 (file-name-directory file)
3145 (file-name-directory (expand-file-name file))))
3146 (pattern (file-name-nondirectory file))
3148 ;; Quote some characters that have special meanings in shells;
3149 ;; but don't quote the wildcards--we want them to be special.
3150 ;; We also currently don't quote the quoting characters
3151 ;; in case people want to use them explicitly to quote
3152 ;; wildcard characters.
3153 ;;#### Unix-specific
3154 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3156 (concat (substring pattern 0 (match-beginning 0))
3158 (substring pattern (match-beginning 0)))
3159 beg (1+ (match-end 0))))
3160 (call-process shell-file-name nil t nil
3161 "-c" (concat "\\" ;; Disregard shell aliases!
3162 insert-directory-program
3164 (if (stringp switches)
3166 (mapconcat 'identity switches " "))
3169 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3170 ;; directory if FILE is a symbolic link.
3171 (apply 'call-process
3172 insert-directory-program nil t nil
3174 (if (listp switches)
3175 (setq list switches)
3176 (if (not (equal switches ""))
3178 ;; Split the switches at any spaces
3179 ;; so we can pass separate options as separate args.
3180 (while (string-match " " switches)
3181 (setq list (cons (substring switches 0 (match-beginning 0))
3183 switches (substring switches (match-end 0))))
3184 (setq list (cons switches list)))))
3187 (if full-directory-p
3188 (concat (file-name-as-directory file)
3189 ;;#### Unix-specific
3193 (defvar kill-emacs-query-functions nil
3194 "Functions to call with no arguments to query about killing XEmacs.
3195 If any of these functions returns nil, killing Emacs is cancelled.
3196 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3197 but `kill-emacs', the low level primitive, does not.
3198 See also `kill-emacs-hook'.")
3200 (defun save-buffers-kill-emacs (&optional arg)
3201 "Offer to save each buffer, then kill this XEmacs process.
3202 With prefix arg, silently save all file-visiting buffers, then kill."
3204 (save-some-buffers arg t)
3205 (and (or (not (memq t (mapcar #'(lambda (buf) (and (buffer-file-name buf)
3206 (buffer-modified-p buf)))
3208 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3209 (or (not (fboundp 'process-list))
3210 ;; process-list is not defined on VMS.
3211 (let ((processes (process-list))
3214 (and (memq (process-status (car processes)) '(run stop open))
3215 (let ((val (process-kill-without-query (car processes))))
3216 (process-kill-without-query (car processes) val)
3219 (setq processes (cdr processes)))
3223 (save-window-excursion
3224 (delete-other-windows)
3227 "Active processes exist; kill them and exit anyway? "))))))
3228 ;; Query the user for other things, perhaps.
3229 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3232 (defun symlink-expand-file-name (filename)
3233 "If FILENAME is a symlink, return its non-symlink equivalent.
3234 Unlike `file-truename', this doesn't chase symlinks in directory
3235 components of the file or expand a relative pathname into an
3238 (while (and (> count 0) (file-symlink-p filename))
3239 (setq filename (file-symlink-p filename)
3243 (error "Apparently circular symlink path"))))
3245 ;; Suggested by Michael Kifer <kifer@CS.SunySB.EDU>
3246 (defun file-remote-p (file-name)
3247 "Test whether FILE-NAME is looked for on a remote system."
3248 (cond ((not allow-remote-paths) nil)
3249 ((featurep 'ange-ftp) (ange-ftp-ftp-path file-name))
3250 ((fboundp 'efs-ftp-path) (efs-ftp-path file-name))
3253 ;; #### FSF has file-name-non-special here.
3255 ;;; files.el ends here