Major simplification; most of file contents deleted.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
9596811a
RS
3;; Copyright (C) 1985, 86, 87, 92, 93,
4;; 94, 95, 1996 Free Software Foundation, Inc.
b4da00e9 5
3a801d0c
ER
6;; Maintainer: FSF
7
b4da00e9
RM
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
e5167999 12;; the Free Software Foundation; either version 2, or (at your option)
b4da00e9
RM
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
693f800d
RS
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
b4da00e9 24
e41b2db1
ER
25;;; Commentary:
26
27;; Defines most of Emacs's file- and directory-handling functions,
28;; including basic file visiting, backup generation, link handling,
29;; ITS-id version control, load- and write-hook handling, and the like.
30
e5167999
ER
31;;; Code:
32
d7fa5aa2 33(defvar delete-auto-save-files t
d1739e52 34 "*Non-nil means delete auto-save file when a buffer is saved or killed.")
b4da00e9 35
d7fa5aa2 36(defvar directory-abbrev-alist
b4da00e9
RM
37 nil
38 "*Alist of abbreviations for file directories.
39A list of elements of the form (FROM . TO), each meaning to replace
40FROM with TO when it appears in a directory name. This replacement is
41done when setting up the default directory of a newly visited file.
42*Every* FROM string should start with `^'.
43
65151a1b
RS
44Do not use `~' in the TO strings.
45They should be ordinary absolute directory names.
46
b4da00e9
RM
47Use this feature when you have directories which you normally refer to
48via absolute symbolic links. Make TO the name of the link, and FROM
49the name it is linked to.")
50
51;;; Turn off backup files on VMS since it has version numbers.
d7fa5aa2 52(defvar make-backup-files (not (eq system-type 'vax-vms))
4ea836c1 53 "*Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
54This can be done by renaming the file or by copying.
55
56Renaming means that Emacs renames the existing file so that it is a
57backup file, then writes the buffer into a new file. Any other names
58that the old file had will now refer to the backup file. The new file
59is owned by you and its group is defaulted.
60
61Copying means that Emacs copies the existing file into the backup
62file, then writes the buffer on top of the existing file. Any other
63names that the old file had will now refer to the new (edited) file.
64The file's owner and group are unchanged.
65
66The choice of renaming or copying is controlled by the variables
67`backup-by-copying', `backup-by-copying-when-linked' and
f862241d 68`backup-by-copying-when-mismatch'. See also `backup-inhibited'.")
b4da00e9
RM
69
70;; Do this so that local variables based on the file name
71;; are not overridden by the major mode.
72(defvar backup-inhibited nil
f862241d
RS
73 "Non-nil means don't make a backup, regardless of the other parameters.
74This variable is intended for use by making it local to a buffer.
75But it is local only if you make it local.")
b4da00e9
RM
76(put 'backup-inhibited 'permanent-local t)
77
d7fa5aa2 78(defvar backup-by-copying nil
b4da00e9
RM
79 "*Non-nil means always use copying to create backup files.
80See documentation of variable `make-backup-files'.")
81
d7fa5aa2 82(defvar backup-by-copying-when-linked nil
b4da00e9
RM
83 "*Non-nil means use copying to create backups for files with multiple names.
84This causes the alternate names to refer to the latest version as edited.
85This variable is relevant only if `backup-by-copying' is nil.")
86
d7fa5aa2 87(defvar backup-by-copying-when-mismatch nil
b4da00e9
RM
88 "*Non-nil means create backups by copying if this preserves owner or group.
89Renaming may still be used (subject to control of other variables)
90when it would not result in changing the owner or group of the file;
91that is, for files which are owned by you and whose group matches
92the default for a new file created there by you.
93This variable is relevant only if `backup-by-copying' is nil.")
94
95(defvar backup-enable-predicate
96 '(lambda (name)
97 (or (< (length name) 5)
98 (not (string-equal "/tmp/" (substring name 0 5)))))
99 "Predicate that looks at a file name and decides whether to make backups.
100Called with an absolute file name as argument, it returns t to enable backup.")
101
d7fa5aa2 102(defvar buffer-offer-save nil
b4da00e9
RM
103 "*Non-nil in a buffer means offer to save the buffer on exit
104even if the buffer is not visiting a file.
105Automatically local in all buffers.")
106(make-variable-buffer-local 'buffer-offer-save)
107
d7fa5aa2 108(defvar find-file-existing-other-name t
f3e23606
RS
109 "*Non-nil means find a file under alternative names, in existing buffers.
110This means if any existing buffer is visiting the file you want
111under another name, you get the existing buffer instead of a new buffer.")
112
d7fa5aa2 113(defvar find-file-visit-truename nil
f3e23606
RS
114 "*Non-nil means visit a file under its truename.
115The truename of a file is found by chasing all links
116both at the file level and at the levels of the containing directories.")
117
d7fa5aa2
RS
118(defvar find-file-revert-without-query
119 nil
ebeb898f
RS
120 "*Specify which files should be reverted without query.
121The value is a list of regular expressions.
122If the file name matches one of these regular expressions,
123then `find-file' reverts the file without querying
124if the file has changed on disk and you have not edited the buffer.")
125
f3e23606
RS
126(defvar buffer-file-number nil
127 "The device number and file number of the file visited in the current buffer.
128The value is a list of the form (FILENUM DEVNUM).
129This pair of numbers uniquely identifies the file.
130If the buffer is visiting a new file, the value is nil.")
131(make-variable-buffer-local 'buffer-file-number)
132(put 'buffer-file-number 'permanent-local t)
133
de88363f
RS
134(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
135 "Non-nil means that buffer-file-number uniquely identifies files.")
136
d7fa5aa2 137(defvar file-precious-flag nil
b4da00e9 138 "*Non-nil means protect against I/O errors while saving files.
560f4415 139Some modes set this non-nil in particular buffers.
4b7271c1
KH
140
141This feature works by writing the new contents into a temporary file
142and then renaming the temporary file to replace the original.
143In this way, any I/O error in writing leaves the original untouched,
144and there is never any instant where the file is nonexistent.
145
146Note that this feature forces backups to be made by copying.
560f4415
KH
147Yet, at the same time, saving a precious file
148breaks any hard links between it and other files.")
b4da00e9
RM
149
150(defvar version-control nil
151 "*Control use of version numbers for backup files.
152t means make numeric backup versions unconditionally.
153nil means make them for files that have some already.
399f8dd6 154`never' means do not make them.")
b4da00e9
RM
155
156(defvar dired-kept-versions 2
157 "*When cleaning directory, number of versions to keep.")
158
de7d5e1b
RS
159(defvar delete-old-versions nil
160 "*If t, delete excess backup versions silently.
161If nil, ask confirmation. Any other value prevents any trimming.")
b4da00e9
RM
162
163(defvar kept-old-versions 2
164 "*Number of oldest versions to keep when a new numbered backup is made.")
165
166(defvar kept-new-versions 2
167 "*Number of newest versions to keep when a new numbered backup is made.
168Includes the new backup. Must be > 0")
169
d7fa5aa2 170(defvar require-final-newline nil
b4da00e9
RM
171 "*Value of t says silently ensure a file ends in a newline when it is saved.
172Non-nil but not t says ask user whether to add a newline when there isn't one.
173nil means don't add newlines.")
174
d7fa5aa2 175(defvar auto-save-default t
b4da00e9
RM
176 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
177
d7fa5aa2 178(defvar auto-save-visited-file-name nil
b4da00e9
RM
179 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
180Normally auto-save files are written under other names.")
181
d7fa5aa2 182(defvar save-abbrevs nil
b4da00e9
RM
183 "*Non-nil means save word abbrevs too when files are saved.
184Loading an abbrev file sets this to t.")
185
d7fa5aa2 186(defvar find-file-run-dired t
320b4233 187 "*Non-nil says run dired if `find-file' is given the name of a directory.")
b4da00e9 188
92966e6f
RS
189;;;It is not useful to make this a local variable.
190;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
191(defvar find-file-not-found-hooks nil
192 "List of functions to be called for `find-file' on nonexistent file.
193These functions are called as soon as the error is detected.
194`buffer-file-name' is already set up.
195The functions are called in the order given until one of them returns non-nil.")
196
92966e6f
RS
197;;;It is not useful to make this a local variable.
198;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
199(defvar find-file-hooks nil
200 "List of functions to be called after a buffer is loaded from a file.
201The buffer's local variables (if any) will have been processed before the
202functions are called.")
203
b4da00e9
RM
204(defvar write-file-hooks nil
205 "List of functions to be called before writing out a buffer to a file.
206If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
207and the rest are not called.
208These hooks are considered to pertain to the visited file.
209So this list is cleared if you change the visited file name.
f82966e4
KH
210
211Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
212See also `write-contents-hooks'.")
b19f1da4
BF
213;;; However, in case someone does make it local...
214(put 'write-file-hooks 'permanent-local t)
c9dca4e0 215
c9dca4e0
RS
216(defvar local-write-file-hooks nil
217 "Just like `write-file-hooks', except intended for per-buffer use.
218The functions in this list are called before the ones in
f82966e4
KH
219`write-file-hooks'.
220
221This variable is meant to be used for hooks that have to do with a
222particular visited file. Therefore, it is a permanent local, so that
223changing the major mode does not clear it. However, calling
224`set-visited-file-name' does clear it.")
b19f1da4
BF
225(make-variable-buffer-local 'local-write-file-hooks)
226(put 'local-write-file-hooks 'permanent-local t)
8c0e7b73
JB
227
228(defvar write-contents-hooks nil
229 "List of functions to be called before writing out a buffer to a file.
230If one of them returns non-nil, the file is considered already written
231and the rest are not called.
f82966e4
KH
232
233This variable is meant to be used for hooks that pertain to the
234buffer's contents, not to the particular visited file; thus,
235`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
236major mode does clear it.
237
238This variable automatically becomes buffer-local whenever it is set.
659ebcc6 239If you use `add-hook' to add elements to the list, use nil for the
693f800d 240LOCAL argument.
f82966e4 241
8c0e7b73 242See also `write-file-hooks'.")
f82966e4 243(make-variable-buffer-local 'write-contents-hooks)
b4da00e9 244
d7fa5aa2 245(defvar enable-local-variables t
93a2702d 246 "*Control use of local variables in files you visit.
b4da00e9 247The value can be t, nil or something else.
93a2702d 248A value of t means file local variables specifications are obeyed;
b4da00e9
RM
249nil means they are ignored; anything else means query.
250
93a2702d
RS
251The command \\[normal-mode] always obeys file local variable
252specifications and ignores this variable.")
b4da00e9 253
d7fa5aa2 254(defvar enable-local-eval 'maybe
d207b766
RS
255 "*Control processing of the \"variable\" `eval' in a file's local variables.
256The value can be t, nil or something else.
257A value of t means obey `eval' variables;
258nil means ignore them; anything else means query.
259
260The command \\[normal-mode] always obeys local-variables lists
261and ignores this variable.")
b4da00e9
RM
262
263;; Avoid losing in versions where CLASH_DETECTION is disabled.
264(or (fboundp 'lock-buffer)
231c4e10 265 (defalias 'lock-buffer 'ignore))
b4da00e9 266(or (fboundp 'unlock-buffer)
231c4e10 267 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
268(or (fboundp 'file-locked-p)
269 (defalias 'file-locked-p 'ignore))
93fe0a35
RS
270
271;; This hook function provides support for ange-ftp host name
272;; completion. It runs the usual ange-ftp hook, but only for
273;; completion operations. Having this here avoids the need
274;; to load ange-ftp when it's not really in use.
275(defun ange-ftp-completion-hook-function (op &rest args)
276 (if (memq op '(file-name-completion file-name-all-completions))
277 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
278 (let ((inhibit-file-name-handlers
279 (cons 'ange-ftp-completion-hook-function
280 (and (eq inhibit-file-name-operation op)
281 inhibit-file-name-handlers)))
282 (inhibit-file-name-operation op))
93fe0a35 283 (apply op args))))
567c1ca9
RS
284
285(defun convert-standard-filename (filename)
286 "Convert a standard file's name to something suitable for the current OS.
287This function's standard definition is trivial; it just returns the argument.
288However, on some systems, the function is redefined
289with a definition that really does change some file names."
290 filename)
b4da00e9
RM
291\f
292(defun pwd ()
293 "Show the current default directory."
294 (interactive nil)
295 (message "Directory %s" default-directory))
296
231c4e10
ER
297(defvar cd-path nil
298 "Value of the CDPATH environment variable, as a list.
299Not actually set up until the first time you you use it.")
300
306faa42
RS
301(defvar path-separator ":"
302 "Character used to separate concatenated paths.")
303
231c4e10
ER
304(defun parse-colon-path (cd-path)
305 "Explode a colon-separated list of paths into a string list."
306 (and cd-path
307 (let (cd-prefix cd-list (cd-start 0) cd-colon)
306faa42
RS
308 (setq cd-path (concat cd-path path-separator))
309 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 310 (setq cd-list
9daefb36 311 (nconc cd-list
c52e4104
RS
312 (list (if (= cd-start cd-colon)
313 nil
314 (substitute-in-file-name
e33e80e4
RS
315 (file-name-as-directory
316 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
317 (setq cd-start (+ cd-colon 1)))
318 cd-list)))
319
320(defun cd-absolute (dir)
30c5ce9c 321 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
322 ;; Put the name into directory syntax now,
323 ;; because otherwise expand-file-name may give some bad results.
b4da00e9
RM
324 (if (not (eq system-type 'vax-vms))
325 (setq dir (file-name-as-directory dir)))
f4a0f59b 326 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9
RM
327 (if (not (file-directory-p dir))
328 (error "%s is not a directory" dir)
329 (if (file-executable-p dir)
330 (setq default-directory dir)
9daefb36 331 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 332
231c4e10
ER
333(defun cd (dir)
334 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
335If your environment includes a `CDPATH' variable, try each one of that
336colon-separated list of directories when resolving a relative directory name."
dac4ea74
RS
337 (interactive
338 (list (read-file-name "Change default directory: "
2121cd9c
RM
339 default-directory default-directory
340 (and (member cd-path '(nil ("./")))
341 (null (getenv "CDPATH"))))))
30c5ce9c
RS
342 (if (file-name-absolute-p dir)
343 (cd-absolute (expand-file-name dir))
344 (if (null cd-path)
345 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
346 (setq cd-path (or trypath (list "./")))))
347 (if (not (catch 'found
348 (mapcar
349 (function (lambda (x)
350 (let ((f (expand-file-name (concat x dir))))
351 (if (file-directory-p f)
352 (progn
353 (cd-absolute f)
354 (throw 'found t))))))
355 cd-path)
356 nil))
357 (error "No such directory found via CDPATH environment variable"))))
231c4e10 358
b4da00e9
RM
359(defun load-file (file)
360 "Load the Lisp file named FILE."
361 (interactive "fLoad file: ")
362 (load (expand-file-name file) nil nil t))
363
364(defun load-library (library)
365 "Load the library named LIBRARY.
366This is an interface to the function `load'."
367 (interactive "sLoad library: ")
368 (load library))
5d68c2c2 369
7c4b8f8c 370(defun file-local-copy (file &optional buffer)
5d68c2c2
RS
371 "Copy the file FILE into a temporary file on this machine.
372Returns the name of the local copy, or nil, if FILE is directly
373accessible."
6eaebaa2 374 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
375 (if handler
376 (funcall handler 'file-local-copy file)
377 nil)))
f3e23606 378
05ef1cda 379(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
380 "Return the truename of FILENAME, which should be absolute.
381The truename of a file name is found by chasing symbolic links
382both at the level of the file and at the level of the directories
05ef1cda
RS
383containing it, until no links are left at any level.
384
385The arguments COUNTER and PREV-DIRS are used only in recursive calls.
386Do not specify them in other calls."
387 ;; COUNTER can be a cons cell whose car is the count of how many more links
388 ;; to chase before getting an error.
389 ;; PREV-DIRS can be a cons cell whose car is an alist
390 ;; of truenames we've just recently computed.
cc37a58c 391
cc37a58c
SM
392 ;; The last test looks dubious, maybe `+' is meant here? --simon.
393 (if (or (string= filename "") (string= filename "~")
7a5a26a6
RS
394 (and (string= (substring filename 0 1) "~")
395 (string-match "~[^/]*" filename)))
1cc2fbeb
RS
396 (progn
397 (setq filename (expand-file-name filename))
398 (if (string= filename "")
399 (setq filename "/"))))
05ef1cda 400 (or counter (setq counter (list 100)))
b505828b
RS
401 (let (done
402 ;; For speed, remove the ange-ftp completion handler from the list.
403 ;; We know it's not needed here.
404 ;; For even more speed, do this only on the outermost call.
405 (file-name-handler-alist
406 (if prev-dirs file-name-handler-alist
407 (let ((tem (copy-sequence file-name-handler-alist)))
408 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
409 (or prev-dirs (setq prev-dirs (list nil)))
05ef1cda
RS
410 ;; If this file directly leads to a link, process that iteratively
411 ;; so that we don't use lots of stack.
412 (while (not done)
413 (setcar counter (1- (car counter)))
414 (if (< (car counter) 0)
415 (error "Apparent cycle of symbolic links for %s" filename))
416 (let ((handler (find-file-name-handler filename 'file-truename)))
417 ;; For file name that has a special handler, call handler.
418 ;; This is so that ange-ftp can save time by doing a no-op.
419 (if handler
420 (setq filename (funcall handler 'file-truename filename)
421 done t)
fb145562 422 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
423 target dirfile)
424 ;; Get the truename of the directory.
425 (setq dirfile (directory-file-name dir))
426 ;; If these are equal, we have the (or a) root directory.
427 (or (string= dir dirfile)
428 ;; If this is the same dir we last got the truename for,
429 ;; save time--don't recalculate.
430 (if (assoc dir (car prev-dirs))
431 (setq dir (cdr (assoc dir (car prev-dirs))))
432 (let ((old dir)
433 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
434 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
435 (setq dir new))))
436 (if (equal ".." (file-name-nondirectory filename))
437 (setq filename
438 (directory-file-name (file-name-directory (directory-file-name dir)))
439 done t)
440 (if (equal "." (file-name-nondirectory filename))
441 (setq filename (directory-file-name dir)
442 done t)
443 ;; Put it back on the file name.
444 (setq filename (concat dir (file-name-nondirectory filename)))
445 ;; Is the file name the name of a link?
446 (setq target (file-symlink-p filename))
447 (if target
448 ;; Yes => chase that link, then start all over
449 ;; since the link may point to a directory name that uses links.
450 ;; We can't safely use expand-file-name here
451 ;; since target might look like foo/../bar where foo
452 ;; is itself a link. Instead, we handle . and .. above.
453 (setq filename
454 (if (file-name-absolute-p target)
455 target
456 (concat dir target))
457 done nil)
458 ;; No, we are done!
459 (setq done t))))))))
460 filename))
5dbfdacd 461
5dadeb29
RS
462(defun file-chase-links (filename)
463 "Chase links in FILENAME until a name that is not a link.
464Does not examine containing directories for links,
465unlike `file-truename'."
466 (let (tem (count 100) (newname filename))
467 (while (setq tem (file-symlink-p newname))
468 (if (= count 0)
469 (error "Apparent cycle of symbolic links for %s" filename))
f01de0db
KH
470 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
471 (while (string-match "//+" tem)
472 (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
473 (substring tem (match-end 0)))))
cf65b429
RS
474 ;; Handle `..' by hand, since it needs to work in the
475 ;; target of any directory symlink.
476 ;; This code is not quite complete; it does not handle
477 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
f01de0db 478 (while (string-match "\\`\\.\\./" tem)
cf65b429
RS
479 (setq tem (substring tem 3))
480 (setq newname (file-name-as-directory
481 ;; Do the .. by hand.
482 (directory-file-name
483 (file-name-directory
484 ;; Chase links in the default dir of the symlink.
485 (file-chase-links
486 (directory-file-name
487 (file-name-directory newname))))))))
5dadeb29
RS
488 (setq newname (expand-file-name tem (file-name-directory newname)))
489 (setq count (1- count)))
490 newname))
b4da00e9 491\f
467ff692
RS
492(defun switch-to-buffer-other-window (buffer &optional norecord)
493 "Select buffer BUFFER in another window.
494Optional second arg NORECORD non-nil means
495do not put this buffer at the front of the list of recently selected ones."
b4da00e9
RM
496 (interactive "BSwitch to buffer in other window: ")
497 (let ((pop-up-windows t))
467ff692 498 (pop-to-buffer buffer t norecord)))
b4da00e9 499
467ff692
RS
500(defun switch-to-buffer-other-frame (buffer &optional norecord)
501 "Switch to buffer BUFFER in another frame.
502Optional second arg NORECORD non-nil means
503do not put this buffer at the front of the list of recently selected ones."
f98955ea
JB
504 (interactive "BSwitch to buffer in other frame: ")
505 (let ((pop-up-frames t))
467ff692 506 (pop-to-buffer buffer t norecord)
336b7f41 507 (raise-frame (window-frame (selected-window)))))
5bbbceb1 508
82d0954a 509(defun find-file (filename &optional coding-system)
b4da00e9
RM
510 "Edit file FILENAME.
511Switch to a buffer visiting file FILENAME,
82d0954a
KH
512creating one if none already exists.
513A prefix argument enables user to specify the coding-system interactively."
514 (interactive "FFind file: \nZCoding-system: ")
515 (if coding-system
516 (let ((coding-system-for-read coding-system))
517 (switch-to-buffer (find-file-noselect filename)))
518 (switch-to-buffer (find-file-noselect filename))))
519
520(defun find-file-other-window (filename &optional coding-system)
b4da00e9
RM
521 "Edit file FILENAME, in another window.
522May create a new window, or reuse an existing one.
82d0954a 523A prefix argument enables user to specify the coding-system interactively.
b4da00e9 524See the function `display-buffer'."
82d0954a
KH
525 (interactive "FFind file in other window: \nZCoding-system: ")
526 (if coding-system
527 (let ((coding-system-for-read coding-system))
528 (switch-to-buffer-other-window (find-file-noselect filename)))
529 (switch-to-buffer-other-window (find-file-noselect filename))))
b4da00e9 530
82d0954a 531(defun find-file-other-frame (filename &optional coding-system)
f98955ea
JB
532 "Edit file FILENAME, in another frame.
533May create a new frame, or reuse an existing one.
82d0954a 534A prefix argument enables user to specify the coding-system interactively.
5bbbceb1 535See the function `display-buffer'."
82d0954a
KH
536 (interactive "FFind file in other frame: \nZCoding-system: ")
537 (if coding-system
538 (let ((coding-system-for-read coding-system))
539 (switch-to-buffer-other-frame (find-file-noselect filename)))
540 (switch-to-buffer-other-frame (find-file-noselect filename))))
5bbbceb1 541
82d0954a 542(defun find-file-read-only (filename &optional coding-system)
b4da00e9
RM
543 "Edit file FILENAME but don't allow changes.
544Like \\[find-file] but marks buffer as read-only.
82d0954a 545A prefix argument enables user to specify the coding-system interactively.
b4da00e9 546Use \\[toggle-read-only] to permit editing."
82d0954a
KH
547 (interactive "fFind file read-only: \nZCoding-system: ")
548 (find-file filename coding-system)
320b4233
RS
549 (setq buffer-read-only t)
550 (current-buffer))
b4da00e9 551
82d0954a 552(defun find-file-read-only-other-window (filename &optional coding-system)
b4da00e9
RM
553 "Edit file FILENAME in another window but don't allow changes.
554Like \\[find-file-other-window] but marks buffer as read-only.
82d0954a 555A prefix argument enables user to specify the coding-system interactively.
b4da00e9 556Use \\[toggle-read-only] to permit editing."
82d0954a
KH
557 (interactive "fFind file read-only other window: \nZCoding-system: ")
558 (find-file-other-window filename coding-system)
320b4233
RS
559 (setq buffer-read-only t)
560 (current-buffer))
b4da00e9 561
82d0954a 562(defun find-file-read-only-other-frame (filename &optional coding-system)
f98955ea
JB
563 "Edit file FILENAME in another frame but don't allow changes.
564Like \\[find-file-other-frame] but marks buffer as read-only.
82d0954a 565A prefix argument enables user to specify the coding-system interactively.
5bbbceb1 566Use \\[toggle-read-only] to permit editing."
82d0954a
KH
567 (interactive "fFind file read-only other frame: \nZCoding-system: ")
568 (find-file-other-frame filename coding-system)
320b4233
RS
569 (setq buffer-read-only t)
570 (current-buffer))
5bbbceb1 571
82d0954a 572(defun find-alternate-file-other-window (filename &optional coding-system)
60eaf370 573 "Find file FILENAME as a replacement for the file in the next window.
82d0954a
KH
574This command does not select that window.
575A prefix argument enables user to specify the coding-system interactively."
60eaf370
RS
576 (interactive
577 (save-selected-window
578 (other-window 1)
579 (let ((file buffer-file-name)
580 (file-name nil)
581 (file-dir nil))
582 (and file
583 (setq file-name (file-name-nondirectory file)
584 file-dir (file-name-directory file)))
585 (list (read-file-name
82d0954a
KH
586 "Find alternate file: " file-dir nil nil file-name)
587 (if current-prefix-arg
588 (read-coding-system "Coding-system: "))))))
60eaf370 589 (if (one-window-p)
82d0954a 590 (find-file-other-window filename coding-system)
60eaf370
RS
591 (save-selected-window
592 (other-window 1)
82d0954a 593 (find-alternate-file filename coding-system))))
60eaf370 594
82d0954a 595(defun find-alternate-file (filename &optional coding-system)
b4da00e9
RM
596 "Find file FILENAME, select its buffer, kill previous buffer.
597If the current buffer now contains an empty file that you just visited
82d0954a
KH
598\(presumably by mistake), use this command to visit the file you really want.
599A prefix argument enables user to specify the coding-system interactively."
b4da00e9
RM
600 (interactive
601 (let ((file buffer-file-name)
602 (file-name nil)
603 (file-dir nil))
604 (and file
605 (setq file-name (file-name-nondirectory file)
606 file-dir (file-name-directory file)))
a61f59b4 607 (list (read-file-name
82d0954a
KH
608 "Find alternate file: " file-dir nil nil file-name)
609 (if current-prefix-arg
610 (read-coding-system "Coding-system: ")))))
2aa8cc2d 611 (and (buffer-modified-p) (buffer-file-name)
b4da00e9
RM
612 ;; (not buffer-read-only)
613 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
614 (buffer-name))))
615 (error "Aborted"))
616 (let ((obuf (current-buffer))
617 (ofile buffer-file-name)
8bb27285
RS
618 (onum buffer-file-number)
619 (otrue buffer-file-truename)
b4da00e9 620 (oname (buffer-name)))
baf9b8c4
RS
621 (if (get-buffer " **lose**")
622 (kill-buffer " **lose**"))
b4da00e9 623 (rename-buffer " **lose**")
b4da00e9
RM
624 (unwind-protect
625 (progn
626 (unlock-buffer)
a4ad4d96
RS
627 (setq buffer-file-name nil)
628 (setq buffer-file-number nil)
629 (setq buffer-file-truename nil)
82d0954a 630 (find-file filename coding-system))
b4da00e9
RM
631 (cond ((eq obuf (current-buffer))
632 (setq buffer-file-name ofile)
8bb27285
RS
633 (setq buffer-file-number onum)
634 (setq buffer-file-truename otrue)
b4da00e9
RM
635 (lock-buffer)
636 (rename-buffer oname))))
637 (or (eq (current-buffer) obuf)
638 (kill-buffer obuf))))
639
640(defun create-file-buffer (filename)
641 "Create a suitably named buffer for visiting FILENAME, and return it.
642FILENAME (sans directory) is used unchanged if that name is free;
643otherwise a string <2> or <3> or ... is appended to get an unused name."
644 (let ((lastname (file-name-nondirectory filename)))
645 (if (string= lastname "")
646 (setq lastname filename))
647 (generate-new-buffer lastname)))
648
5bbbceb1
JB
649(defun generate-new-buffer (name)
650 "Create and return a buffer with a name based on NAME.
29165787 651Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
652 (get-buffer-create (generate-new-buffer-name name)))
653
d7fa5aa2 654(defvar automount-dir-prefix "^/tmp_mnt/"
e373f201
JB
655 "Regexp to match the automounter prefix in a directory name.")
656
ffb3a4db 657(defvar abbreviated-home-dir nil
292297c6 658 "The user's homedir abbreviated according to `directory-abbrev-list'.")
ffb3a4db 659
5bbbceb1 660(defun abbreviate-file-name (filename)
29165787 661 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 662This also substitutes \"~\" for the user's home directory.
29165787 663Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201 664 ;; Get rid of the prefixes added by the automounter.
a8f34fc0
RS
665 (if (and automount-dir-prefix
666 (string-match automount-dir-prefix filename)
e373f201
JB
667 (file-exists-p (file-name-directory
668 (substring filename (1- (match-end 0))))))
669 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 670 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
671 ;; If any elt of directory-abbrev-alist matches this name,
672 ;; abbreviate accordingly.
5bbbceb1
JB
673 (while tail
674 (if (string-match (car (car tail)) filename)
675 (setq filename
676 (concat (cdr (car tail)) (substring filename (match-end 0)))))
677 (setq tail (cdr tail)))
ffb3a4db
RS
678 ;; Compute and save the abbreviated homedir name.
679 ;; We defer computing this until the first time it's needed, to
680 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
681 ;; We include a slash at the end, to avoid spurious matches
682 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
683 (or abbreviated-home-dir
684 (setq abbreviated-home-dir
685 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
686 (concat "^" (abbreviate-file-name (expand-file-name "~"))
687 "\\(/\\|$\\)"))))
76d5492b 688
ffb3a4db
RS
689 ;; If FILENAME starts with the abbreviated homedir,
690 ;; make it start with `~' instead.
ca33ccb5
RS
691 (if (and (string-match abbreviated-home-dir filename)
692 ;; If the home dir is just /, don't change it.
693 (not (and (= (match-end 0) 1)
288201bd 694 (= (aref filename 0) ?/)))
567c1ca9
RS
695 ;; MS-DOS root directories can come with a drive letter;
696 ;; Novell Netware allows drive letters beyond `Z:'.
76d5492b 697 (not (and (or (eq system-type 'ms-dos)
c32d49e8 698 (eq system-type 'windows-nt))
288201bd 699 (save-match-data
567c1ca9 700 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 701 (setq filename
28dbf501 702 (concat "~"
3a8a836d 703 (substring filename (match-beginning 1) (match-end 1))
28dbf501 704 (substring filename (match-end 0)))))
5bbbceb1
JB
705 filename))
706
1770543d
RS
707(defvar find-file-not-true-dirname-list nil
708 "*List of logical names for which visiting shouldn't save the true dirname.
709On VMS, when you visit a file using a logical name that searches a path,
710you may or may not want the visited file name to record the specific
711directory where the file was found. If you *do not* want that, add the logical
712name to this list as a string.")
713
138c44f6
KH
714(defun find-buffer-visiting (filename)
715 "Return the buffer visiting file FILENAME (a string).
716This is like `get-file-buffer', except that it checks for any buffer
717visiting the same file, possibly under a different name.
718If there is no such live buffer, return nil."
719 (let ((buf (get-file-buffer filename))
720 (truename (abbreviate-file-name (file-truename filename))))
721 (or buf
722 (let ((list (buffer-list)) found)
723 (while (and (not found) list)
724 (save-excursion
725 (set-buffer (car list))
726 (if (and buffer-file-name
727 (string= buffer-file-truename truename))
728 (setq found (car list))))
729 (setq list (cdr list)))
730 found)
0f933cf6 731 (let ((number (nthcdr 10 (file-attributes truename)))
138c44f6 732 (list (buffer-list)) found)
de88363f
RS
733 (and buffer-file-numbers-unique
734 number
181c830f
RS
735 (while (and (not found) list)
736 (save-excursion
737 (set-buffer (car list))
d49ab5a0
RS
738 (if (and buffer-file-name
739 (equal buffer-file-number number)
181c830f
RS
740 ;; Verify this buffer's file number
741 ;; still belongs to its file.
742 (file-exists-p buffer-file-name)
743 (equal (nthcdr 10 (file-attributes buffer-file-name))
744 number))
745 (setq found (car list))))
746 (setq list (cdr list))))
138c44f6
KH
747 found))))
748
40dfe94d
RS
749(defun insert-file-contents-literally (filename &optional visit beg end replace)
750 "Like `insert-file-contents', q.v., but only reads in the file.
751A buffer may be modified in several ways after reading into the buffer due
752to advanced Emacs features, such as file-name-handlers, format decoding,
753find-file-hooks, etc.
6e6f5d9e
RS
754 This function ensures that none of these modifications will take place.
755
756This function does not work for remote files, because it turns off
757file name handlers and remote file access uses a file name handler."
40dfe94d
RS
758 (let ((file-name-handler-alist nil)
759 (format-alist nil)
760 (after-insert-file-functions nil)
76d5492b 761 (find-buffer-file-type-function
40dfe94d
RS
762 (if (fboundp 'find-buffer-file-type)
763 (symbol-function 'find-buffer-file-type)
764 nil)))
765 (unwind-protect
766 (progn
767 (fset 'find-buffer-file-type (lambda (filename) t))
768 (insert-file-contents filename visit beg end replace))
769 (if find-buffer-file-type-function
770 (fset 'find-buffer-file-type find-buffer-file-type-function)
771 (fmakunbound 'find-buffer-file-type)))))
772
773(defun find-file-noselect (filename &optional nowarn rawfile)
b4da00e9
RM
774 "Read file FILENAME into a buffer and return the buffer.
775If a buffer exists visiting FILENAME, return that one, but
776verify that the file has not changed since visited or saved.
82d0954a
KH
777The buffer is not selected, just returned to the caller.
778Optional first arg NOWARN non-nil means suppress any warning messages.
779Optional second arg RAWFILE non-nil means the file is read literally"
e373f201
JB
780 (setq filename
781 (abbreviate-file-name
782 (expand-file-name filename)))
b4da00e9
RM
783 (if (file-directory-p filename)
784 (if find-file-run-dired
4147a3cc
KH
785 (dired-noselect (if find-file-visit-truename
786 (abbreviate-file-name (file-truename filename))
787 filename))
ba369f54 788 (error "%s is a directory" filename))
f3e23606
RS
789 (let* ((buf (get-file-buffer filename))
790 (truename (abbreviate-file-name (file-truename filename)))
791 (number (nthcdr 10 (file-attributes truename)))
792 ;; Find any buffer for a file which has same truename.
138c44f6 793 (other (and (not buf) (find-buffer-visiting filename)))
f3e23606
RS
794 error)
795 ;; Let user know if there is a buffer with the same truename.
138c44f6
KH
796 (if other
797 (progn
327bebe8
RS
798 (or nowarn
799 (string-equal filename (buffer-file-name other))
800 (message "%s and %s are the same file"
801 filename (buffer-file-name other)))
138c44f6
KH
802 ;; Optionally also find that buffer.
803 (if (or find-file-existing-other-name find-file-visit-truename)
804 (setq buf other))))
b4da00e9
RM
805 (if buf
806 (or nowarn
807 (verify-visited-file-modtime buf)
808 (cond ((not (file-exists-p filename))
809 (error "File %s no longer exists!" filename))
ebeb898f
RS
810 ;; Certain files should be reverted automatically
811 ;; if they have changed on disk and not in the buffer.
812 ((and (not (buffer-modified-p buf))
813 (let ((tail find-file-revert-without-query)
814 (found nil))
815 (while tail
816 (if (string-match (car tail) filename)
817 (setq found t))
818 (setq tail (cdr tail)))
819 found))
820 (with-current-buffer buf
821 (message "Reverting file %s..." filename)
822 (revert-buffer t t)
823 (message "Reverting file %s...done" filename)))
b4da00e9 824 ((yes-or-no-p
b7d19f4a
KH
825 (if (string= (file-name-nondirectory filename)
826 (buffer-name buf))
827 (format
828 (if (buffer-modified-p buf)
829 "File %s changed on disk. Discard your edits? "
830 "File %s changed on disk. Reread from disk? ")
831 (file-name-nondirectory filename))
832 (format
833 (if (buffer-modified-p buf)
834 "File %s changed on disk. Discard your edits in %s? "
835 "File %s changed on disk. Reread from disk into %s? ")
836 (file-name-nondirectory filename)
837 (buffer-name buf))))
ebeb898f 838 (with-current-buffer buf
b4da00e9
RM
839 (revert-buffer t t)))))
840 (save-excursion
f3e23606
RS
841;;; The truename stuff makes this obsolete.
842;;; (let* ((link-name (car (file-attributes filename)))
843;;; (linked-buf (and (stringp link-name)
844;;; (get-file-buffer link-name))))
845;;; (if (bufferp linked-buf)
846;;; (message "Symbolic link to file in buffer %s"
847;;; (buffer-name linked-buf))))
b4da00e9 848 (setq buf (create-file-buffer filename))
a2e12c0c 849 (set-buffer-major-mode buf)
b4da00e9
RM
850 (set-buffer buf)
851 (erase-buffer)
40dfe94d
RS
852 (if rawfile
853 (condition-case ()
854 (insert-file-contents-literally filename t)
855 (file-error
856 ;; Unconditionally set error
857 (setq error t)))
858 (condition-case ()
859 (insert-file-contents filename t)
860 (file-error
861 ;; Run find-file-not-found-hooks until one returns non-nil.
862 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
863 ;; If they fail too, set error.
864 (setq error t)))))
f3e23606 865 ;; Find the file's truename, and maybe use that as visited name.
138c44f6 866 (setq buffer-file-truename truename)
1770543d
RS
867 (setq buffer-file-number number)
868 ;; On VMS, we may want to remember which directory in a search list
869 ;; the file was found in.
870 (and (eq system-type 'vax-vms)
871 (let (logical)
872 (if (string-match ":" (file-name-directory filename))
873 (setq logical (substring (file-name-directory filename)
874 0 (match-beginning 0))))
875 (not (member logical find-file-not-true-dirname-list)))
876 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 877 (if find-file-visit-truename
27d0420c
RS
878 (setq buffer-file-name
879 (setq filename
880 (expand-file-name buffer-file-truename))))
b4da00e9
RM
881 ;; Set buffer's default directory to that of the file.
882 (setq default-directory (file-name-directory filename))
883 ;; Turn off backup files for certain file names. Since
884 ;; this is a permanent local, the major mode won't eliminate it.
885 (and (not (funcall backup-enable-predicate buffer-file-name))
886 (progn
887 (make-local-variable 'backup-inhibited)
888 (setq backup-inhibited t)))
40dfe94d
RS
889 (if rawfile
890 nil
fa660969
KH
891 (after-find-file error (not nowarn))
892 (setq buf (current-buffer)))))
b4da00e9
RM
893 buf)))
894\f
f7d786d0
RS
895(defvar after-find-file-from-revert-buffer nil)
896
e0ab8879 897(defun after-find-file (&optional error warn noauto
9a30563f
RS
898 after-find-file-from-revert-buffer
899 nomodes)
b4da00e9
RM
900 "Called after finding a file and by the default revert function.
901Sets buffer mode, parses local variables.
8cfb9d46 902Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
903error in reading the file. WARN non-nil means warn if there
904exists an auto-save file more recent than the visited file.
8cfb9d46 905NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
906Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
907 means this call was from `revert-buffer'.
9a30563f
RS
908Fifth arg NOMODES non-nil means don't alter the file's modes.
909Finishes by calling the functions in `find-file-hooks'
910unless NOMODES is non-nil."
b4da00e9
RM
911 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
912 (if noninteractive
913 nil
914 (let* (not-serious
915 (msg
916 (cond ((and error (file-attributes buffer-file-name))
917 (setq buffer-read-only t)
ff78d520 918 "File exists, but cannot be read.")
b4da00e9
RM
919 ((not buffer-read-only)
920 (if (and warn
921 (file-newer-than-file-p (make-auto-save-file-name)
922 buffer-file-name))
6a6a0b8b
RS
923 (format "%s has auto save data; consider M-x recover-file"
924 (file-name-nondirectory buffer-file-name))
b4da00e9
RM
925 (setq not-serious t)
926 (if error "(New file)" nil)))
927 ((not error)
928 (setq not-serious t)
929 "Note: file is write protected")
930 ((file-attributes (directory-file-name default-directory))
931 "File not found and directory write-protected")
4e43240a
RS
932 ((file-exists-p (file-name-directory buffer-file-name))
933 (setq buffer-read-only nil))
b4da00e9 934 (t
5bbbceb1 935 (setq buffer-read-only nil)
4e43240a
RS
936 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
937 "Use M-x make-dir RET RET to create the directory"
938 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
939 (if msg
940 (progn
941 (message msg)
942 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 943 (if (and auto-save-default (not noauto))
b4da00e9 944 (auto-save-mode t)))
9a30563f
RS
945 (if nomodes
946 nil
947 (normal-mode t)
948 (run-hooks 'find-file-hooks)))
b4da00e9
RM
949
950(defun normal-mode (&optional find-file)
951 "Choose the major mode for this buffer automatically.
952Also sets up any specified local variables of the file.
953Uses the visited file name, the -*- line, and the local variables spec.
954
955This function is called automatically from `find-file'. In that case,
956we may set up specified local variables depending on the value of
957`enable-local-variables': if it is t, we do; if it is nil, we don't;
958otherwise, we query. `enable-local-variables' is ignored if you
959run `normal-mode' explicitly."
960 (interactive)
961 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
962 (condition-case err
963 (set-auto-mode)
964 (error (message "File mode specification error: %s"
965 (prin1-to-string err))))
966 (condition-case err
7b3f3dc2
JB
967 (let ((enable-local-variables (or (not find-file)
968 enable-local-variables)))
969 (hack-local-variables))
b4da00e9
RM
970 (error (message "File local-variables error: %s"
971 (prin1-to-string err)))))
972
f76e0cd0 973(defvar auto-mode-alist
567c1ca9 974 '(("\\.te?xt\\'" . text-mode)
f76e0cd0
RS
975 ("\\.c\\'" . c-mode)
976 ("\\.h\\'" . c-mode)
977 ("\\.tex\\'" . tex-mode)
978 ("\\.ltx\\'" . latex-mode)
979 ("\\.el\\'" . emacs-lisp-mode)
980 ("\\.mm\\'" . nroff-mode)
981 ("\\.me\\'" . nroff-mode)
982 ("\\.ms\\'" . nroff-mode)
983 ("\\.man\\'" . nroff-mode)
984 ("\\.scm\\'" . scheme-mode)
985 ("\\.l\\'" . lisp-mode)
986 ("\\.lisp\\'" . lisp-mode)
987 ("\\.f\\'" . fortran-mode)
0254679b 988 ("\\.F\\'" . fortran-mode)
f76e0cd0
RS
989 ("\\.for\\'" . fortran-mode)
990 ("\\.p\\'" . pascal-mode)
991 ("\\.pas\\'" . pascal-mode)
992 ("\\.mss\\'" . scribe-mode)
993 ("\\.ad[abs]\\'" . ada-mode)
994 ("\\.icn\\'" . icon-mode)
995 ("\\.pl\\'" . perl-mode)
35394129 996 ("\\.pm\\'" . perl-mode)
f76e0cd0
RS
997 ("\\.cc\\'" . c++-mode)
998 ("\\.hh\\'" . c++-mode)
bfc6cac9 999 ("\\.hpp\\'" . c++-mode)
f76e0cd0
RS
1000 ("\\.C\\'" . c++-mode)
1001 ("\\.H\\'" . c++-mode)
1002 ("\\.cpp\\'" . c++-mode)
1003 ("\\.cxx\\'" . c++-mode)
1004 ("\\.hxx\\'" . c++-mode)
1005 ("\\.c\\+\\+\\'" . c++-mode)
1006 ("\\.h\\+\\+\\'" . c++-mode)
1fbd6d0f 1007 ("\\.m\\'" . objc-mode)
95b53225 1008 ("\\.java\\'" . java-mode)
1fbd6d0f 1009 ("\\.sim\\'" . simula-mode)
f76e0cd0 1010 ("\\.mk\\'" . makefile-mode)
5da565f8 1011 ("\\(M\\|m\\|GNUm\\)akefile\\(.in\\)?\\'" . makefile-mode)
7b3f3dc2
JB
1012;;; Less common extensions come here
1013;;; so more common ones above are found faster.
f76e0cd0 1014 ("\\.texinfo\\'" . texinfo-mode)
567c1ca9 1015 ("\\.te?xi\\'" . texinfo-mode)
f76e0cd0 1016 ("\\.s\\'" . asm-mode)
600a5f71
KH
1017 ("\\.S\\'" . asm-mode)
1018 ("\\.asm\\'" . asm-mode)
f76e0cd0
RS
1019 ("ChangeLog\\'" . change-log-mode)
1020 ("change.log\\'" . change-log-mode)
1021 ("changelo\\'" . change-log-mode)
1022 ("ChangeLog.[0-9]+\\'" . change-log-mode)
6e6f5d9e
RS
1023 ;; for MSDOS and MS-Windows (which are case-insensitive)
1024 ("changelog\\'" . change-log-mode)
1025 ("changelog.[0-9]+\\'" . change-log-mode)
f76e0cd0
RS
1026 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1027 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
7458cc35 1028 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
d1194c85
RS
1029 ("/\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1030 ("/\\.\\(bash_logout\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1031 ("/\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
c1fe251a
KH
1032;;; The following should come after the ChangeLog pattern
1033;;; for the sake of ChangeLog.1, etc.
1034;;; and after the .scm.[0-9] pattern too.
f76e0cd0
RS
1035 ("\\.[12345678]\\'" . nroff-mode)
1036 ("\\.TeX\\'" . tex-mode)
1037 ("\\.sty\\'" . latex-mode)
1038 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1039 ("\\.bbl\\'" . latex-mode)
1040 ("\\.bib\\'" . bibtex-mode)
1041 ("\\.article\\'" . text-mode)
1042 ("\\.letter\\'" . text-mode)
1043 ("\\.tcl\\'" . tcl-mode)
e1ec01c2 1044 ("\\.exp\\'" . tcl-mode)
c87c4cda
KH
1045 ("\\.itcl\\'" . tcl-mode)
1046 ("\\.itk\\'" . tcl-mode)
f76e0cd0
RS
1047 ("\\.f90\\'" . f90-mode)
1048 ("\\.lsp\\'" . lisp-mode)
1049 ("\\.awk\\'" . awk-mode)
1050 ("\\.prolog\\'" . prolog-mode)
1051 ("\\.tar\\'" . tar-mode)
1052 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
12a8a239 1053 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\)\\'" . archive-mode)
f76e0cd0
RS
1054 ;; Mailer puts message to be edited in
1055 ;; /tmp/Re.... or Message
628b6035 1056 ("\\`/tmp/Re" . text-mode)
f76e0cd0
RS
1057 ("/Message[0-9]*\\'" . text-mode)
1058 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1059 ;; some news reader is reported to use this
628b6035 1060 ("\\`/tmp/fol/" . text-mode)
f76e0cd0
RS
1061 ("\\.y\\'" . c-mode)
1062 ("\\.lex\\'" . c-mode)
1063 ("\\.oak\\'" . scheme-mode)
693f800d 1064 ("\\.sgml?\\'" . sgml-mode)
f76e0cd0 1065 ("\\.dtd\\'" . sgml-mode)
c2c84cd7 1066 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
693f800d 1067 ("\\.s?html?\\'" . html-mode)
f76e0cd0
RS
1068 ;; .emacs following a directory delimiter
1069 ;; in either Unix or VMS syntax.
1070 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
1071 ;; _emacs following a directory delimiter
1072 ;; in MsDos syntax
1073 ("[:/]_emacs\\'" . emacs-lisp-mode)
1074 ("\\.ml\\'" . lisp-mode))
7b3f3dc2
JB
1075 "\
1076Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
1077Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1078\(NON-NIL stands for anything that is not nil; the value does not matter.)
1079Visiting a file whose name matches REGEXP specifies FUNCTION as the
1080mode function to use. FUNCTION will be called, unless it is nil.
1081
1082If the element has the form (REGEXP FUNCTION NON-NIL), then after
1083calling FUNCTION (if it's not nil), we delete the suffix that matched
1084REGEXP and search the list again for another match.")
7b3f3dc2 1085
d7fa5aa2 1086(defvar interpreter-mode-alist
c907d156 1087 '(("perl" . perl-mode)
e049945b 1088 ("perl5" . perl-mode)
c907d156 1089 ("wish" . tcl-mode)
e3998da1 1090 ("wishx" . tcl-mode)
8db739de 1091 ("tcl" . tcl-mode)
e3998da1 1092 ("tclsh" . tcl-mode)
8db739de 1093 ("awk" . awk-mode)
dfeadd84 1094 ("mawk" . awk-mode)
d4f567a1 1095 ("nawk" . awk-mode)
8db739de 1096 ("gawk" . awk-mode)
d1194c85
RS
1097 ("scm" . scheme-mode)
1098 ("ash" . sh-mode)
1099 ("bash" . sh-mode)
1100 ("csh" . sh-mode)
1101 ("dtksh" . sh-mode)
1102 ("es" . sh-mode)
1103 ("itcsh" . sh-mode)
1104 ("jsh" . sh-mode)
1105 ("ksh" . sh-mode)
1106 ("oash" . sh-mode)
1107 ("pdksh" . sh-mode)
1108 ("rc" . sh-mode)
1109 ("sh" . sh-mode)
1110 ("sh5" . sh-mode)
1111 ("tcsh" . sh-mode)
1112 ("wksh" . sh-mode)
1113 ("wsh" . sh-mode)
1114 ("zsh" . sh-mode)
1115 ("tail" . text-mode)
1116 ("more" . text-mode)
1117 ("less" . text-mode)
1118 ("pg" . text-mode))
c907d156
RS
1119 "Alist mapping interpreter names to major modes.
1120This alist applies to files whose first line starts with `#!'.
1121Each element looks like (INTERPRETER . MODE).
1122The car of each element is compared with
1123the name of the interpreter specified in the first line.
1124If it matches, mode MODE is selected.")
1125
d7fa5aa2 1126(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 1127 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 1128
d7fa5aa2 1129(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
1130 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1131When checking `inhibit-first-line-modes-regexps', we first discard
1132from the end of the file name anything that matches one of these regexps.")
1133
bb157910
RS
1134(defvar user-init-file
1135 "" ; set by command-line
1136 "File name including directory of user's initialization file.")
1137
b4da00e9
RM
1138(defun set-auto-mode ()
1139 "Select major mode appropriate for current buffer.
e3998da1
RS
1140This checks for a -*- mode tag in the buffer's text,
1141compares the filename against the entries in `auto-mode-alist',
1142or checks the interpreter that runs this file against
1143`interpreter-mode-alist'.
1144
1145It does not check for the `mode:' local variable in the
1146Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1147
f3e23606 1148If `enable-local-variables' is nil, this function does not check for a
7b3f3dc2 1149-*- mode tag."
b4da00e9 1150 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
d0fc03ef 1151 (let (beg end done modes)
b4da00e9
RM
1152 (save-excursion
1153 (goto-char (point-min))
1154 (skip-chars-forward " \t\n")
9fa7bfe5
RS
1155 (and enable-local-variables
1156 ;; Don't look for -*- if this file name matches any
45fb3bb8 1157 ;; of the regexps in inhibit-first-line-modes-regexps.
cae111fa 1158 (let ((temp inhibit-first-line-modes-regexps)
4bc3d240
RS
1159 (name (if buffer-file-name
1160 (file-name-sans-versions buffer-file-name)
1161 (buffer-name))))
38832b4c
KH
1162 (while (let ((sufs inhibit-first-line-modes-suffixes))
1163 (while (and sufs (not (string-match (car sufs) name)))
1164 (setq sufs (cdr sufs)))
1165 sufs)
1166 (setq name (substring name 0 (match-beginning 0))))
9fa7bfe5 1167 (while (and temp
b20ff6d0 1168 (not (string-match (car temp) name)))
9fa7bfe5
RS
1169 (setq temp (cdr temp)))
1170 (not temp))
1171 (search-forward "-*-" (save-excursion
1172 ;; If the file begins with "#!"
1173 ;; (exec interpreter magic), look
1174 ;; for mode frobs in the first two
1175 ;; lines. You cannot necessarily
1176 ;; put them in the first line of
1177 ;; such a file without screwing up
1178 ;; the interpreter invocation.
1179 (end-of-line (and (looking-at "^#!") 2))
1180 (point)) t)
1181 (progn
1182 (skip-chars-forward " \t")
1183 (setq beg (point))
1184 (search-forward "-*-"
1185 (save-excursion (end-of-line) (point))
1186 t))
1187 (progn
1188 (forward-char -3)
1189 (skip-chars-backward " \t")
1190 (setq end (point))
1191 (goto-char beg)
1192 (if (save-excursion (search-forward ":" end t))
1193 ;; Find all specifications for the `mode:' variable
57a0155c 1194 ;; and execute them left to right.
9fa7bfe5 1195 (while (let ((case-fold-search t))
6054fcc6
KH
1196 (or (and (looking-at "mode:")
1197 (goto-char (match-end 0)))
1198 (re-search-forward "[ \t;]mode:" end t)))
9fa7bfe5
RS
1199 (skip-chars-forward " \t")
1200 (setq beg (point))
1201 (if (search-forward ";" end t)
1202 (forward-char -1)
1203 (goto-char end))
1204 (skip-chars-backward " \t")
d0fc03ef
RS
1205 (setq modes (cons (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1206 modes)))
9fa7bfe5 1207 ;; Simple -*-MODE-*- case.
d0fc03ef
RS
1208 (setq modes (cons (intern (concat (downcase (buffer-substring beg end))
1209 "-mode"))
1210 modes))))))
1211 ;; If we found modes to use, invoke them now,
1212 ;; outside the save-excursion.
1213 (if modes
668d9a3e 1214 (progn (mapcar 'funcall (nreverse modes))
d0fc03ef
RS
1215 (setq done t)))
1216 ;; If we didn't find a mode from a -*- line, try using the file name.
1217 (if (and (not done) buffer-file-name)
1218 (let ((name buffer-file-name)
1219 (keep-going t))
1220 ;; Remove backup-suffixes from file name.
1221 (setq name (file-name-sans-versions name))
1222 (while keep-going
1223 (setq keep-going nil)
1224 (let ((alist auto-mode-alist)
1225 (mode nil))
1226 ;; Find first matching alist entry.
76d5492b 1227 (let ((case-fold-search
d0fc03ef
RS
1228 (memq system-type '(vax-vms windows-nt))))
1229 (while (and (not mode) alist)
1230 (if (string-match (car (car alist)) name)
1231 (if (and (consp (cdr (car alist)))
1232 (nth 2 (car alist)))
1233 (progn
1234 (setq mode (car (cdr (car alist)))
1235 name (substring name 0 (match-beginning 0))
1236 keep-going t))
1237 (setq mode (cdr (car alist))
1238 keep-going nil)))
1239 (setq alist (cdr alist))))
1240 (if mode
1241 (funcall mode)
1242 ;; If we can't deduce a mode from the file name,
1243 ;; look for an interpreter specified in the first line.
1540e4e9
KH
1244 ;; As a special case, allow for things like "#!/bin/env perl",
1245 ;; which finds the interpreter anywhere in $PATH.
d0fc03ef
RS
1246 (let ((interpreter
1247 (save-excursion
1248 (goto-char (point-min))
dfeadd84 1249 (if (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
1540e4e9
KH
1250 (buffer-substring (match-beginning 2)
1251 (match-end 2))
d0fc03ef
RS
1252 "")))
1253 elt)
1254 ;; Map interpreter name to a mode.
1255 (setq elt (assoc (file-name-nondirectory interpreter)
1256 interpreter-mode-alist))
1257 (if elt
1258 (funcall (cdr elt)))))))))))
b4da00e9 1259
f3e23606
RS
1260(defun hack-local-variables-prop-line ()
1261 ;; Set local variables specified in the -*- line.
9fa7bfe5
RS
1262 ;; Ignore any specification for `mode:';
1263 ;; set-auto-mode should already have handled that.
f3e23606
RS
1264 (save-excursion
1265 (goto-char (point-min))
13a66180
KH
1266 (let ((result nil)
1267 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
f3e23606
RS
1268 ;; Parse the -*- line into the `result' alist.
1269 (cond ((not (search-forward "-*-" end t))
1270 ;; doesn't have one.
1271 nil)
1272 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1273 ;; Simple form: "-*- MODENAME -*-". Already handled.
1274 nil)
f3e23606
RS
1275 (t
1276 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1277 ;; (last ";" is optional).
1278 (save-excursion
1279 (if (search-forward "-*-" end t)
1280 (setq end (- (point) 3))
1281 (error "-*- not terminated before end of line")))
1282 (while (< (point) end)
1283 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1284 (error "malformed -*- line"))
1285 (goto-char (match-end 0))
1c26a6f3
KH
1286 ;; There used to be a downcase here,
1287 ;; but the manual didn't say so,
1288 ;; and people want to set var names that aren't all lc.
1289 (let ((key (intern (buffer-substring
1290 (match-beginning 1)
1291 (match-end 1))))
f3e23606
RS
1292 (val (save-restriction
1293 (narrow-to-region (point) end)
1294 (read (current-buffer)))))
93a2702d
RS
1295 ;; It is traditional to ignore
1296 ;; case when checking for `mode' in set-auto-mode,
1297 ;; so we must do that here as well.
1298 ;; That is inconsistent, but we're stuck with it.
1299 (or (equal (downcase (symbol-name key)) "mode")
13a66180 1300 (setq result (cons (cons key val) result)))
f3e23606
RS
1301 (skip-chars-forward " \t;")))
1302 (setq result (nreverse result))))
76d5492b 1303
f3e23606
RS
1304 (if (and result
1305 (or (eq enable-local-variables t)
1306 (and enable-local-variables
1307 (save-window-excursion
6f931919
RS
1308 (condition-case nil
1309 (switch-to-buffer (current-buffer))
1310 (error
1311 ;; If we fail to switch in the selected window,
1312 ;; it is probably a minibuffer.
1313 ;; So try another window.
1314 (condition-case nil
1315 (switch-to-buffer-other-window (current-buffer))
1316 (error
1317 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1318 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1319 (file-name-nondirectory buffer-file-name)))))))
2837b9df
RS
1320 (let ((enable-local-eval enable-local-eval))
1321 (while result
1322 (hack-one-local-variable (car (car result)) (cdr (car result)))
1323 (setq result (cdr result))))))))
f3e23606 1324
1d517019
RS
1325(defvar hack-local-variables-hook nil
1326 "Normal hook run after processing a file's local variables specs.
1327Major modes can use this to examine user-specified local variables
1328in order to initialize other data structure based on them.")
1329
7b3f3dc2 1330(defun hack-local-variables ()
5792c834 1331 "Parse and put into effect this buffer's local variables spec."
f3e23606 1332 (hack-local-variables-prop-line)
b4da00e9
RM
1333 ;; Look for "Local variables:" line in last page.
1334 (save-excursion
1335 (goto-char (point-max))
1336 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1337 (if (let ((case-fold-search t))
1338 (and (search-forward "Local Variables:" nil t)
7b3f3dc2 1339 (or (eq enable-local-variables t)
b4da00e9
RM
1340 (and enable-local-variables
1341 (save-window-excursion
1342 (switch-to-buffer (current-buffer))
1343 (save-excursion
1344 (beginning-of-line)
1345 (set-window-start (selected-window) (point)))
1346 (y-or-n-p (format "Set local variables as specified at end of %s? "
51de78c1 1347 (if buffer-file-name
76d5492b 1348 (file-name-nondirectory
51de78c1
RS
1349 buffer-file-name)
1350 (concat "buffer "
1351 (buffer-name))))))))))
b4da00e9 1352 (let ((continue t)
2bba782c
RS
1353 prefix prefixlen suffix beg
1354 (enable-local-eval enable-local-eval))
b4da00e9
RM
1355 ;; The prefix is what comes before "local variables:" in its line.
1356 ;; The suffix is what comes after "local variables:" in its line.
1357 (skip-chars-forward " \t")
1358 (or (eolp)
1359 (setq suffix (buffer-substring (point)
1360 (progn (end-of-line) (point)))))
1361 (goto-char (match-beginning 0))
1362 (or (bolp)
1363 (setq prefix
1364 (buffer-substring (point)
1365 (progn (beginning-of-line) (point)))))
7b3f3dc2 1366
b4da00e9
RM
1367 (if prefix (setq prefixlen (length prefix)
1368 prefix (regexp-quote prefix)))
1369 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1370 (while continue
1371 ;; Look at next local variable spec.
1372 (if selective-display (re-search-forward "[\n\C-m]")
1373 (forward-line 1))
1374 ;; Skip the prefix, if any.
1375 (if prefix
1376 (if (looking-at prefix)
1377 (forward-char prefixlen)
1378 (error "Local variables entry is missing the prefix")))
1379 ;; Find the variable name; strip whitespace.
1380 (skip-chars-forward " \t")
1381 (setq beg (point))
1382 (skip-chars-forward "^:\n")
1383 (if (eolp) (error "Missing colon in local variables entry"))
1384 (skip-chars-backward " \t")
1385 (let* ((str (buffer-substring beg (point)))
1386 (var (read str))
1387 val)
1388 ;; Setting variable named "end" means end of list.
1389 (if (string-equal (downcase str) "end")
1390 (setq continue nil)
1391 ;; Otherwise read the variable value.
1392 (skip-chars-forward "^:")
1393 (forward-char 1)
1394 (setq val (read (current-buffer)))
1395 (skip-chars-backward "\n")
1396 (skip-chars-forward " \t")
1397 (or (if suffix (looking-at suffix) (eolp))
1398 (error "Local variables entry is terminated incorrectly"))
1399 ;; Set the variable. "Variables" mode and eval are funny.
1d517019
RS
1400 (hack-one-local-variable var val)))))))
1401 (run-hooks 'hack-local-variables-hook))
f3e23606 1402
d7fa5aa2 1403(defvar ignored-local-variables
f3e23606
RS
1404 '(enable-local-eval)
1405 "Variables to be ignored in a file's local variable spec.")
1406
be0218a8 1407;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1408(put 'debugger 'risky-local-variable t)
f6fa3ee3 1409(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1410(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1411(put 'eval 'risky-local-variable t)
1412(put 'file-name-handler-alist 'risky-local-variable t)
1413(put 'minor-mode-map-alist 'risky-local-variable t)
1414(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3
RS
1415(put 'buffer-file-name 'risky-local-variable t)
1416(put 'buffer-auto-save-file-name 'risky-local-variable t)
1417(put 'buffer-file-truename 'risky-local-variable t)
b0ffcc0d
RS
1418(put 'exec-path 'risky-local-variable t)
1419(put 'load-path 'risky-local-variable t)
1420(put 'exec-directory 'risky-local-variable t)
1421(put 'process-environment 'risky-local-variable t)
eba1c87a
RS
1422(put 'dabbrev-case-fold-search 'risky-local-variable t)
1423(put 'dabbrev-case-replace 'risky-local-variable t)
9afa8bf7
RS
1424;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1425(put 'outline-level 'risky-local-variable t)
d98b741d 1426(put 'rmail-output-file-alist 'risky-local-variable t)
f6fa3ee3 1427
6672c42b
RS
1428;; This one is safe because the user gets to check it before it is used.
1429(put 'compile-command 'safe-local-variable t)
1430
d0bd3513
RS
1431(defun hack-one-local-variable-quotep (exp)
1432 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1433
f3e23606
RS
1434;; "Set" one variable in a local variables spec.
1435;; A few variable names are treated specially.
1436(defun hack-one-local-variable (var val)
1437 (cond ((eq var 'mode)
1438 (funcall (intern (concat (downcase (symbol-name val))
1439 "-mode"))))
1440 ((memq var ignored-local-variables)
1441 nil)
1442 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 1443 ;; Likewise for setting hook variables.
be0218a8 1444 ((or (get var 'risky-local-variable)
6672c42b
RS
1445 (and
1446 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1447 (symbol-name var))
1448 (not (get var 'safe-local-variable))))
0225ae5e 1449 ;; Permit evalling a put of a harmless property.
d0bd3513
RS
1450 ;; if the args do nothing tricky.
1451 (if (or (and (eq var 'eval)
1452 (consp val)
1453 (eq (car val) 'put)
1454 (hack-one-local-variable-quotep (nth 1 val))
1455 (hack-one-local-variable-quotep (nth 2 val))
1456 ;; Only allow safe values of lisp-indent-hook;
1457 ;; not functions.
1458 (or (numberp (nth 3 val))
dc417415 1459 (equal (nth 3 val) ''defun))
d0bd3513
RS
1460 (memq (nth 1 (nth 2 val))
1461 '(lisp-indent-hook)))
1462 ;; Permit eval if not root and user says ok.
c7e62660 1463 (and (not (zerop (user-uid)))
d0bd3513
RS
1464 (or (eq enable-local-eval t)
1465 (and enable-local-eval
1466 (save-window-excursion
1467 (switch-to-buffer (current-buffer))
1468 (save-excursion
1469 (beginning-of-line)
1470 (set-window-start (selected-window) (point)))
1471 (setq enable-local-eval
1472 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1473 (file-name-nondirectory buffer-file-name)))))))))
7d3221d7
RS
1474 (if (eq var 'eval)
1475 (save-excursion (eval val))
1476 (make-local-variable var)
1477 (set var val))
f3e23606
RS
1478 (message "Ignoring `eval:' in file's local variables")))
1479 ;; Ordinary variable, really set it.
1480 (t (make-local-variable var)
1481 (set var val))))
1482
b4da00e9 1483\f
f36012a6 1484(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9
RM
1485 "Change name of file visited in current buffer to FILENAME.
1486The next time the buffer is saved it will go in the newly specified file.
1487nil or empty string as argument means make buffer not be visiting any file.
1488Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
1489if you wish to pass an empty string as the argument.
1490
1491The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
1492confirmation in the case where another buffer is already visiting FILENAME.
1493
1494The optional third argument ALONG-WITH-FILE, if non-nil, means that
1495the old visited file has been renamed to the new name FILENAME."
b4da00e9 1496 (interactive "FSet visited file name: ")
c11a94fe
RS
1497 (if (buffer-base-buffer)
1498 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
1499 (let (truename)
1500 (if filename
1501 (setq filename
1502 (if (string-equal filename "")
1503 nil
1504 (expand-file-name filename))))
1505 (if filename
1506 (progn
1507 (setq truename (file-truename filename))
1508 (if find-file-visit-truename
a522e5bf 1509 (setq filename truename))))
11e314fa 1510 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 1511 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 1512 (not no-query)
7b89d38e
RS
1513 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1514 filename)))
1515 (error "Aborted")))
a522e5bf
RS
1516 (or (equal filename buffer-file-name)
1517 (progn
1518 (and filename (lock-buffer filename))
1519 (unlock-buffer)))
1520 (setq buffer-file-name filename)
1521 (if filename ; make buffer name reflect filename.
1522 (let ((new-name (file-name-nondirectory buffer-file-name)))
1523 (if (string= new-name "")
1524 (error "Empty file name"))
1525 (if (eq system-type 'vax-vms)
1526 (setq new-name (downcase new-name)))
1527 (setq default-directory (file-name-directory buffer-file-name))
1528 (or (string= new-name (buffer-name))
1529 (rename-buffer new-name t))))
1530 (setq buffer-backed-up nil)
f36012a6
RS
1531 (or along-with-file
1532 (clear-visited-file-modtime))
8ccdc29e 1533 ;; Abbreviate the file names of the buffer.
4826e97f 1534 (if truename
8ccdc29e
RS
1535 (progn
1536 (setq buffer-file-truename (abbreviate-file-name truename))
1537 (if find-file-visit-truename
1538 (setq buffer-file-name buffer-file-truename))))
a522e5bf
RS
1539 (setq buffer-file-number
1540 (if filename
2a47b4f5 1541 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 1542 nil)))
b4da00e9
RM
1543 ;; write-file-hooks is normally used for things like ftp-find-file
1544 ;; that visit things that are not local files as if they were files.
1545 ;; Changing to visit an ordinary local file instead should flush the hook.
1546 (kill-local-variable 'write-file-hooks)
c9dca4e0 1547 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
1548 (kill-local-variable 'revert-buffer-function)
1549 (kill-local-variable 'backup-inhibited)
ee81c959
RS
1550 ;; If buffer was read-only because of version control,
1551 ;; that reason is gone now, so make it writable.
1552 (if vc-mode
1553 (setq buffer-read-only nil))
1554 (kill-local-variable 'vc-mode)
b4da00e9
RM
1555 ;; Turn off backup files for certain file names.
1556 ;; Since this is a permanent local, the major mode won't eliminate it.
1557 (and (not (funcall backup-enable-predicate buffer-file-name))
1558 (progn
1559 (make-local-variable 'backup-inhibited)
1560 (setq backup-inhibited t)))
c77a81cf
RS
1561 (let ((oauto buffer-auto-save-file-name))
1562 ;; If auto-save was not already on, turn it on if appropriate.
1563 (if (not buffer-auto-save-file-name)
1564 (and buffer-file-name auto-save-default
1565 (auto-save-mode t))
1566 ;; If auto save is on, start using a new name.
1567 ;; We deliberately don't rename or delete the old auto save
1568 ;; for the old visited file name. This is because perhaps
1569 ;; the user wants to save the new state and then compare with the
1570 ;; previous state from the auto save file.
1571 (setq buffer-auto-save-file-name
1572 (make-auto-save-file-name)))
1573 ;; Rename the old auto save file if any.
1574 (and oauto buffer-auto-save-file-name
e6f0e76c 1575 (file-exists-p oauto)
c77a81cf 1576 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
1577 (and buffer-file-name
1578 (not along-with-file)
1579 (set-buffer-modified-p t)))
b4da00e9 1580
82d0954a 1581(defun write-file (filename &optional confirm coding-system)
b4da00e9 1582 "Write current buffer into file FILENAME.
41f48cb1
RS
1583Makes buffer visit that file, and marks it not modified.
1584If the buffer is already visiting a file, you can specify
1585a directory name as FILENAME, to write a file of the same
c2fb8488 1586old name in that directory.
7458cc35 1587
c2fb8488 1588If optional second arg CONFIRM is non-nil,
7458cc35 1589ask for confirmation for overwriting an existing file.
82d0954a
KH
1590Interactively, confirmation is required unless you supply a prefix argument.
1591
1592A prefix argument also enables user to interactively specify a
1593coding-system for encoding the file."
b4da00e9
RM
1594;; (interactive "FWrite file: ")
1595 (interactive
1596 (list (if buffer-file-name
1597 (read-file-name "Write file: "
1598 nil nil nil nil)
1599 (read-file-name "Write file: "
1600 (cdr (assq 'default-directory
1601 (buffer-local-variables)))
c2fb8488 1602 nil nil (buffer-name)))
82d0954a
KH
1603 (not current-prefix-arg)
1604 (if current-prefix-arg
1605 (read-coding-system "Coding-system: "))
1606 ))
b4da00e9 1607 (or (null filename) (string-equal filename "")
41f48cb1
RS
1608 (progn
1609 ;; If arg is just a directory,
1610 ;; use same file name, but in that directory.
1611 (if (and (file-directory-p filename) buffer-file-name)
1612 (setq filename (concat (file-name-as-directory filename)
1613 (file-name-nondirectory buffer-file-name))))
c2fb8488
RS
1614 (and confirm
1615 (file-exists-p filename)
1616 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1617 (error "Canceled")))
5f65549e 1618 (set-visited-file-name filename (not confirm))))
b4da00e9 1619 (set-buffer-modified-p t)
82d0954a
KH
1620 (if coding-system
1621 (let ((coding-system-for-write coding-system))
1622 ;; It is convenient to change buffer-file-coding-system to the
1623 ;; specified one.
1624 (set-buffer-file-coding-system coding-system)
1625 (save-buffer))
1626 (save-buffer)))
b4da00e9
RM
1627\f
1628(defun backup-buffer ()
1629 "Make a backup of the disk file visited by the current buffer, if appropriate.
1630This is normally done before saving the buffer the first time.
1631If the value is non-nil, it is the result of `file-modes' on the original
1632file; this means that the caller, after saving the buffer, should change
27ab6944
KH
1633the modes of the new file to agree with the old modes.
1634
1635A backup may be done by renaming or by copying; see documentation of
1636variable `make-backup-files'. If it's done by renaming, then the file is
1637no longer accessible under its old name."
b4da00e9
RM
1638 (if (and make-backup-files (not backup-inhibited)
1639 (not buffer-backed-up)
1640 (file-exists-p buffer-file-name)
1641 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1642 '(?- ?l)))
1643 (let ((real-file-name buffer-file-name)
1644 backup-info backupname targets setmodes)
1645 ;; If specified name is a symbolic link, chase it to the target.
1646 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 1647 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
1648 (setq backup-info (find-backup-file-name real-file-name)
1649 backupname (car backup-info)
1650 targets (cdr backup-info))
1651;;; (if (file-directory-p buffer-file-name)
1652;;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
1653 (if backup-info
1654 (condition-case ()
1655 (let ((delete-old-versions
1656 ;; If have old versions to maybe delete,
1657 ;; ask the user to confirm now, before doing anything.
1658 ;; But don't actually delete til later.
1659 (and targets
1660 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1661 (or delete-old-versions
1662 (y-or-n-p (format "Delete excess backup versions of %s? "
1663 real-file-name))))))
1664 ;; Actually write the back up file.
1665 (condition-case ()
1666 (if (or file-precious-flag
1667 ; (file-symlink-p buffer-file-name)
1668 backup-by-copying
1669 (and backup-by-copying-when-linked
1670 (> (file-nlinks real-file-name) 1))
1671 (and backup-by-copying-when-mismatch
1672 (let ((attr (file-attributes real-file-name)))
1673 (or (nth 9 attr)
1674 (not (file-ownership-preserved-p real-file-name))))))
1675 (condition-case ()
1676 (copy-file real-file-name backupname t t)
1677 (file-error
1678 ;; If copying fails because file BACKUPNAME
1679 ;; is not writable, delete that file and try again.
1680 (if (and (file-exists-p backupname)
1681 (not (file-writable-p backupname)))
1682 (delete-file backupname))
1683 (copy-file real-file-name backupname t t)))
1684 ;; rename-file should delete old backup.
1685 (rename-file real-file-name backupname t)
1686 (setq setmodes (file-modes backupname)))
1687 (file-error
1688 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
1689 (setq backupname (expand-file-name
1690 (convert-standard-filename
1691 "~/%backup%~")))
1692 (message "Cannot write backup file; backing up in %s"
1693 (file-name-nondirectory backupname))
eb650569
RS
1694 (sleep-for 1)
1695 (condition-case ()
1696 (copy-file real-file-name backupname t t)
1697 (file-error
1698 ;; If copying fails because file BACKUPNAME
1699 ;; is not writable, delete that file and try again.
1700 (if (and (file-exists-p backupname)
1701 (not (file-writable-p backupname)))
1702 (delete-file backupname))
1703 (copy-file real-file-name backupname t t)))))
1704 (setq buffer-backed-up t)
1705 ;; Now delete the old versions, if desired.
1706 (if delete-old-versions
1707 (while targets
1708 (condition-case ()
1709 (delete-file (car targets))
1710 (file-error nil))
1711 (setq targets (cdr targets))))
1712 setmodes)
1713 (file-error nil))))))
b4da00e9 1714
c3554e95 1715(defun file-name-sans-versions (name &optional keep-backup-version)
b4da00e9
RM
1716 "Return FILENAME sans backup versions or strings.
1717This is a separate procedure so your site-init or startup file can
c3554e95
RS
1718redefine it.
1719If the optional argument KEEP-BACKUP-VERSION is non-nil,
1720we do not remove backup version numbers, only true file version numbers."
6eaebaa2 1721 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
1722 (if handler
1723 (funcall handler 'file-name-sans-versions name keep-backup-version)
1724 (substring name 0
1725 (if (eq system-type 'vax-vms)
1726 ;; VMS version number is (a) semicolon, optional
1727 ;; sign, zero or more digits or (b) period, option
1728 ;; sign, zero or more digits, provided this is the
1729 ;; second period encountered outside of the
1730 ;; device/directory part of the file name.
26add1bf
KH
1731 (or (string-match ";[-+]?[0-9]*\\'" name)
1732 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
1733 name)
1734 (match-beginning 1))
1735 (length name))
1736 (if keep-backup-version
1737 (length name)
dbb12f2c 1738 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
1739 (string-match "~\\'" name)
1740 (length name))))))))
b4da00e9 1741
cb0cd911
RS
1742(defun file-ownership-preserved-p (file)
1743 "Returns t if deleting FILE and rewriting it would preserve the owner."
1744 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1745 (if handler
1746 (funcall handler 'file-ownership-preserved-p file)
ec5533be 1747 (let ((attributes (file-attributes file)))
306faa42
RS
1748 ;; Return t if the file doesn't exist, since it's true that no
1749 ;; information would be lost by an (attempted) delete and create.
1750 (or (null attributes)
1751 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 1752
20b5d24c
RS
1753(defun file-name-sans-extension (filename)
1754 "Return FILENAME sans final \"extension\".
1755The extension, in a file name, is the part that follows the last `.'."
1756 (save-match-data
1757 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1758 directory)
1759 (if (string-match "\\.[^.]*\\'" file)
1760 (if (setq directory (file-name-directory filename))
1761 (expand-file-name (substring file 0 (match-beginning 0))
1762 directory)
1763 (substring file 0 (match-beginning 0)))
1764 filename))))
1765
93a2702d
RS
1766(defun file-name-extension (filename &optional period)
1767 "Return FILENAME's final \"extension\".
1768The extension, in a file name, is the part that follows the last `.'.
1769Return nil for extensionless file names such as `foo'.
1770Return the empty string for file names such as `foo.'.
1771
1772If PERIOD is non-nil, then the returned value includes the period
1773that delimits the extension, and if FILENAME has no extension,
1774the value is \"\"."
1775 (save-match-data
1776 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1777 (if (string-match "\\.[^.]*\\'" file)
1778 (substring file (+ (match-beginning 0) (if period 0 1)))
1779 (if period
1780 "")))))
1781
b4da00e9
RM
1782(defun make-backup-file-name (file)
1783 "Create the non-numeric backup file name for FILE.
1784This is a separate function so you can redefine it for customization."
28ee503c
KH
1785 (if (and (eq system-type 'ms-dos)
1786 (not (msdos-long-file-names)))
bb157910
RS
1787 (let ((fn (file-name-nondirectory file)))
1788 (concat (file-name-directory file)
066327ae
KH
1789 (or
1790 (and (string-match "\\`[^.]+\\'" fn)
1791 (concat (match-string 0 fn) ".~"))
1792 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
1793 (concat (match-string 0 fn) "~")))))
bb157910 1794 (concat file "~")))
b4da00e9
RM
1795
1796(defun backup-file-name-p (file)
1797 "Return non-nil if FILE is a backup file name (numeric or not).
1798This is a separate function so you can redefine it for customization.
1799You may need to redefine `file-name-sans-versions' as well."
066327ae 1800 (string-match "~\\'" file))
b4da00e9 1801
2d051399
RS
1802;; This is used in various files.
1803;; The usage of bv-length is not very clean,
1804;; but I can't see a good alternative,
1805;; so as of now I am leaving it alone.
1806(defun backup-extract-version (fn)
1807 "Given the name of a numeric backup file, return the backup number.
1808Uses the free variable `bv-length', whose value should be
1809the index in the name where the version number begins."
1810 (if (and (string-match "[0-9]+~$" fn bv-length)
1811 (= (match-beginning 0) bv-length))
1812 (string-to-int (substring fn bv-length -1))
1813 0))
1814
b4da00e9
RM
1815;; I believe there is no need to alter this behavior for VMS;
1816;; since backup files are not made on VMS, it should not get called.
1817(defun find-backup-file-name (fn)
1818 "Find a file name for a backup file, and suggestions for deletions.
1819Value is a list whose car is the name for the backup file
eb650569
RS
1820 and whose cdr is a list of old versions to consider deleting now.
1821If the value is nil, don't make a backup."
1822 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
1823 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1824 (if handler
1825 (funcall handler 'find-backup-file-name fn)
1826 (if (eq version-control 'never)
b4da00e9 1827 (list (make-backup-file-name fn))
eb650569
RS
1828 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1829 (bv-length (length base-versions))
1830 possibilities
1831 (versions nil)
1832 (high-water-mark 0)
1833 (deserve-versions-p nil)
1834 (number-to-delete 0))
1835 (condition-case ()
1836 (setq possibilities (file-name-all-completions
1837 base-versions
1838 (file-name-directory fn))
1839 versions (sort (mapcar
1840 (function backup-extract-version)
1841 possibilities)
1842 '<)
1843 high-water-mark (apply 'max 0 versions)
1844 deserve-versions-p (or version-control
1845 (> high-water-mark 0))
1846 number-to-delete (- (length versions)
1847 kept-old-versions kept-new-versions -1))
1848 (file-error
1849 (setq possibilities nil)))
1850 (if (not deserve-versions-p)
1851 (list (make-backup-file-name fn))
1852 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1853 (if (and (> number-to-delete 0)
1854 ;; Delete nothing if there is overflow
1855 ;; in the number of versions to keep.
1856 (>= (+ kept-new-versions kept-old-versions -1) 0))
1857 (mapcar (function (lambda (n)
1858 (concat fn ".~" (int-to-string n) "~")))
1859 (let ((v (nthcdr kept-old-versions versions)))
1860 (rplacd (nthcdr (1- number-to-delete) v) ())
1861 v))))))))))
b4da00e9 1862
b4da00e9
RM
1863(defun file-nlinks (filename)
1864 "Return number of names file FILENAME has."
1865 (car (cdr (file-attributes filename))))
6c636af9
RM
1866
1867(defun file-relative-name (filename &optional directory)
2d6562a5
RS
1868 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
1869This function returns a relative file name which is equivalent to FILENAME
1870when used with that default directory as the default.
1871If this is impossible (which can happen on MSDOS and Windows
1872when the file name and directory use different drive names)
1873then it returns FILENAME."
96c188b0 1874 (save-match-data
2d6562a5
RS
1875 (setq fname (expand-file-name filename)
1876 directory (file-name-as-directory
1877 (expand-file-name (or directory default-directory))))
1878 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
1879 ;; drive names, they can't be relative, so return the absolute name.
1880 (if (and (or (eq system-type 'ms-dos)
1881 (eq system-type 'windows-nt))
1882 (not (string-equal (substring fname 0 2)
1883 (substring directory 0 2))))
1884 filename
1885 (let ((ancestor ""))
1886 (while (not (string-match (concat "^" (regexp-quote directory)) fname))
1887 (setq directory (file-name-directory (substring directory 0 -1))
1888 ancestor (concat "../" ancestor)))
1889 (concat ancestor (substring fname (match-end 0)))))))
b4da00e9
RM
1890\f
1891(defun save-buffer (&optional args)
1892 "Save current buffer in visited file if modified. Versions described below.
1893By default, makes the previous version into a backup file
1894 if previously requested or if this is the first save.
ac9650be 1895With 1 \\[universal-argument], marks this version
b4da00e9 1896 to become a backup when the next save is done.
ac9650be 1897With 2 \\[universal-argument]'s,
b4da00e9 1898 unconditionally makes the previous version into a backup file.
ac9650be
RS
1899With 3 \\[universal-argument]'s, marks this version
1900 to become a backup when the next save is done,
1901 and unconditionally makes the previous version into a backup file.
1902
b4da00e9
RM
1903With argument of 0, never makes the previous version into a backup file.
1904
1905If a file's name is FOO, the names of its numbered backup versions are
1906 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1907Numeric backups (rather than FOO~) will be made if value of
1908 `version-control' is not the atom `never' and either there are already
1909 numeric versions of the file being backed up, or `version-control' is
1910 non-nil.
1911We don't want excessive versions piling up, so there are variables
1912 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1913 and `kept-new-versions', which tells how many newest versions to keep.
1914 Defaults are 2 old versions and 2 new.
1915`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 1916If `delete-old-versions' is nil, system will query user
b4da00e9
RM
1917 before trimming versions. Otherwise it does it silently."
1918 (interactive "p")
1919 (let ((modp (buffer-modified-p))
1920 (large (> (buffer-size) 50000))
b5a8e0fc
RS
1921 (make-backup-files (or (and make-backup-files (not (eq args 0)))
1922 (memq args '(16 64)))))
b4da00e9
RM
1923 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1924 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1925 (basic-save-buffer)
1926 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1927
1928(defun delete-auto-save-file-if-necessary (&optional force)
1929 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1930Normally delete only if the file was written by this Emacs since
1931the last real save, but optional arg FORCE non-nil means delete anyway."
1932 (and buffer-auto-save-file-name delete-auto-save-files
1933 (not (string= buffer-file-name buffer-auto-save-file-name))
1934 (or force (recent-auto-save-p))
1935 (progn
1936 (condition-case ()
1937 (delete-file buffer-auto-save-file-name)
1938 (file-error nil))
1939 (set-buffer-auto-saved))))
1940
1cc852cc
RS
1941(defvar after-save-hook nil
1942 "Normal hook that is run after a buffer is saved to its file.")
1943
b4da00e9 1944(defun basic-save-buffer ()
1cc852cc
RS
1945 "Save the current buffer in its visited file, if it has been modified.
1946After saving the buffer, run `after-save-hook'."
b4da00e9 1947 (interactive)
c11a94fe
RS
1948 (save-excursion
1949 ;; In an indirect buffer, save its base buffer instead.
1950 (if (buffer-base-buffer)
1951 (set-buffer (buffer-base-buffer)))
1952 (if (buffer-modified-p)
1953 (let ((recent-save (recent-auto-save-p))
1954 setmodes tempsetmodes)
1955 ;; On VMS, rename file and buffer to get rid of version number.
1956 (if (and (eq system-type 'vax-vms)
1957 (not (string= buffer-file-name
1958 (file-name-sans-versions buffer-file-name))))
1959 (let (buffer-new-name)
1960 ;; Strip VMS version number before save.
1961 (setq buffer-file-name
1962 (file-name-sans-versions buffer-file-name))
1963 ;; Construct a (unique) buffer name to correspond.
1964 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1965 (setq buffer-new-name (buffer-name buf))
1966 (kill-buffer buf))
1967 (rename-buffer buffer-new-name)))
1968 ;; If buffer has no file name, ask user for one.
1969 (or buffer-file-name
182891ef
RS
1970 (let ((filename
1971 (expand-file-name
1972 (read-file-name "File to save in: ") nil)))
1973 (and (file-exists-p filename)
1974 (or (y-or-n-p (format "File `%s' exists; overwrite? "
1975 filename))
1976 (error "Canceled")))
1977 (set-visited-file-name filename)))
c11a94fe
RS
1978 (or (verify-visited-file-modtime (current-buffer))
1979 (not (file-exists-p buffer-file-name))
1980 (yes-or-no-p
1981 (format "%s has changed since visited or saved. Save anyway? "
1982 (file-name-nondirectory buffer-file-name)))
1983 (error "Save not confirmed"))
1984 (save-restriction
1985 (widen)
1986 (and (> (point-max) 1)
1987 (/= (char-after (1- (point-max))) ?\n)
1988 (not (and (eq selective-display t)
1989 (= (char-after (1- (point-max))) ?\r)))
1990 (or (eq require-final-newline t)
1991 (and require-final-newline
1992 (y-or-n-p
1993 (format "Buffer %s does not end in newline. Add one? "
1994 (buffer-name)))))
1995 (save-excursion
1996 (goto-char (point-max))
1997 (insert ?\n)))
1998 (or (run-hook-with-args-until-success 'write-contents-hooks)
1999 (run-hook-with-args-until-success 'local-write-file-hooks)
2000 (run-hook-with-args-until-success 'write-file-hooks)
2001 ;; If a hook returned t, file is already "written".
2002 ;; Otherwise, write it the usual way now.
2003 (setq setmodes (basic-save-buffer-1)))
2a47b4f5
RS
2004 (setq buffer-file-number
2005 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
2006 (if setmodes
2007 (condition-case ()
2008 (set-file-modes buffer-file-name setmodes)
2009 (error nil))))
2010 ;; If the auto-save file was recent before this command,
2011 ;; delete it now.
2012 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
2013 ;; Support VC `implicit' locking.
2014 (vc-after-save)
c11a94fe
RS
2015 (run-hooks 'after-save-hook))
2016 (message "(No changes need to be saved)"))))
b4da00e9 2017
87d26afc
RS
2018;; This does the "real job" of writing a buffer into its visited file
2019;; and making a backup file. This is what is normally done
2020;; but inhibited if one of write-file-hooks returns non-nil.
2021;; It returns a value to store in setmodes.
2022(defun basic-save-buffer-1 ()
2023 (let (tempsetmodes setmodes)
2024 (if (not (file-writable-p buffer-file-name))
2025 (let ((dir (file-name-directory buffer-file-name)))
2026 (if (not (file-directory-p dir))
2027 (error "%s is not a directory" dir)
2028 (if (not (file-exists-p buffer-file-name))
2029 (error "Directory %s write-protected" dir)
2030 (if (yes-or-no-p
2031 (format "File %s is write-protected; try to save anyway? "
2032 (file-name-nondirectory
2033 buffer-file-name)))
2034 (setq tempsetmodes t)
2035 (error "Attempt to save to a file which you aren't allowed to write"))))))
2036 (or buffer-backed-up
2037 (setq setmodes (backup-buffer)))
76d5492b 2038 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
2039 (if (and file-precious-flag
2040 (file-writable-p dir))
2041 ;; If file is precious, write temp name, then rename it.
2042 ;; This requires write access to the containing dir,
2043 ;; which is why we don't try it if we don't have that access.
2044 (let ((realname buffer-file-name)
6782610c
RS
2045 tempname temp nogood i succeed
2046 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
2047 (setq i 0)
2048 (setq nogood t)
2049 ;; Find the temporary name to write under.
2050 (while nogood
567c1ca9 2051 (setq tempname (format
28ee503c
KH
2052 (if (and (eq system-type 'ms-dos)
2053 (not (msdos-long-file-names)))
567c1ca9
RS
2054 "%s#%d.tm#" ; MSDOS limits files to 8+3
2055 "%s#tmp#%d")
2056 dir i))
f4a0f59b
RS
2057 (setq nogood (file-exists-p tempname))
2058 (setq i (1+ i)))
2059 (unwind-protect
2060 (progn (clear-visited-file-modtime)
2061 (write-region (point-min) (point-max)
89095962
RS
2062 tempname nil realname
2063 buffer-file-truename)
f4a0f59b
RS
2064 (setq succeed t))
2065 ;; If writing the temp file fails,
2066 ;; delete the temp file.
76d5492b 2067 (or succeed
6782610c
RS
2068 (progn
2069 (delete-file tempname)
2070 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
2071 ;; Since we have created an entirely new file
2072 ;; and renamed it, make sure it gets the
2073 ;; right permission bits set.
2074 (setq setmodes (file-modes buffer-file-name))
2075 ;; We succeeded in writing the temp file,
2076 ;; so rename it.
2077 (rename-file tempname buffer-file-name t))
2078 ;; If file not writable, see if we can make it writable
2079 ;; temporarily while we write it.
2080 ;; But no need to do so if we have just backed it up
2081 ;; (setmodes is set) because that says we're superseding.
2082 (cond ((and tempsetmodes (not setmodes))
2083 ;; Change the mode back, after writing.
2084 (setq setmodes (file-modes buffer-file-name))
2085 (set-file-modes buffer-file-name 511)))
2086 (write-region (point-min) (point-max)
89095962 2087 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
2088 setmodes))
2089
b4da00e9
RM
2090(defun save-some-buffers (&optional arg exiting)
2091 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
2092Optional argument (the prefix) non-nil means save all with no questions.
2093Optional second argument EXITING means ask about certain non-file buffers
2094 as well as about file buffers."
b4da00e9 2095 (interactive "P")
907482b9 2096 (save-window-excursion
76d5492b
RM
2097 (let* ((queried nil)
2098 (files-done
2099 (map-y-or-n-p
2100 (function
2101 (lambda (buffer)
2102 (and (buffer-modified-p buffer)
2103 (not (buffer-base-buffer buffer))
2104 (or
2105 (buffer-file-name buffer)
2106 (and exiting
2107 (progn
2108 (set-buffer buffer)
2109 (and buffer-offer-save (> (buffer-size) 0)))))
2110 (if arg
2111 t
2112 (setq queried t)
2113 (if (buffer-file-name buffer)
2114 (format "Save file %s? "
2115 (buffer-file-name buffer))
2116 (format "Save buffer %s? "
2117 (buffer-name buffer)))))))
2118 (function
2119 (lambda (buffer)
2120 (set-buffer buffer)
2121 (save-buffer)))
2122 (buffer-list)
2123 '("buffer" "buffers" "save")
2124 (list (list ?\C-r (lambda (buf)
2125 (view-buffer buf)
2126 (setq view-exit-action
2127 '(lambda (ignore)
2128 (exit-recursive-edit)))
2129 (recursive-edit)
2130 ;; Return nil to ask about BUF again.
2131 nil)
2132 "display the current buffer"))))
2133 (abbrevs-done
2134 (and save-abbrevs abbrevs-changed
2135 (progn
2136 (if (or arg
2137 (y-or-n-p (format "Save abbrevs in %s? "
2138 abbrev-file-name)))
2139 (write-abbrev-file nil))
2140 ;; Don't keep bothering user if he says no.
2141 (setq abbrevs-changed nil)
2142 t))))
2143 (or queried (> files-done 0) abbrevs-done
5625c2fc 2144 (message "(No files need saving)")))))
b4da00e9
RM
2145\f
2146(defun not-modified (&optional arg)
2147 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
2148With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2149
2150It is not a good idea to use this function in Lisp programs, because it
2151prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
2152 (interactive "P")
2153 (message (if arg "Modification-flag set"
2154 "Modification-flag cleared"))
2155 (set-buffer-modified-p arg))
2156
2157(defun toggle-read-only (&optional arg)
2158 "Change whether this buffer is visiting its file read-only.
2159With arg, set read-only iff arg is positive."
2160 (interactive "P")
2161 (setq buffer-read-only
2162 (if (null arg)
2163 (not buffer-read-only)
2164 (> (prefix-numeric-value arg) 0)))
3941fe2c 2165 (force-mode-line-update))
b4da00e9 2166
82d0954a 2167(defun insert-file (filename &optional coding-system)
b4da00e9
RM
2168 "Insert contents of file FILENAME into buffer after point.
2169Set mark after the inserted text.
82d0954a 2170A prefix argument enables user to specify the coding-system interactively.
b4da00e9
RM
2171
2172This function is meant for the user to run interactively.
2173Don't call it from programs! Use `insert-file-contents' instead.
2174\(Its calling sequence is different; see its documentation)."
82d0954a 2175 (interactive "*fInsert file: \nZCoding-system: ")
3be6243a
RS
2176 (if (file-directory-p filename)
2177 (signal 'file-error (list "Opening input file" "file is a directory"
2178 filename)))
82d0954a
KH
2179 (let ((tem
2180 (if coding-system
2181 (let ((coding-system-for-read coding-system))
2182 (insert-file-contents filename))
2183 (insert-file-contents filename))))
b4da00e9
RM
2184 (push-mark (+ (point) (car (cdr tem))))))
2185
82d0954a 2186(defun append-to-file (start end filename &optional coding-system)
b4da00e9
RM
2187 "Append the contents of the region to the end of file FILENAME.
2188When called from a function, expects three arguments,
2189START, END and FILENAME. START and END are buffer positions
82d0954a
KH
2190saying what text to write.
2191A prefix argument enables user to specify the coding-system interactively."
2192 (interactive "r\nFAppend to file: \nZCoding-system: ")
2193 (if coding-system
2194 (let ((coding-system-for-write coding-system))
2195 (write-region start end filename t))
2196 (write-region start end filename t)))
b4da00e9
RM
2197
2198(defun file-newest-backup (filename)
2199 "Return most recent backup file for FILENAME or nil if no backups exist."
2200 (let* ((filename (expand-file-name filename))
2201 (file (file-name-nondirectory filename))
2202 (dir (file-name-directory filename))
2203 (comp (file-name-all-completions file dir))
cf7e94a0
RS
2204 (newest nil)
2205 tem)
b4da00e9 2206 (while comp
cf7e94a0 2207 (setq tem (car comp)
b4da00e9 2208 comp (cdr comp))
cf7e94a0
RS
2209 (cond ((and (backup-file-name-p tem)
2210 (string= (file-name-sans-versions tem) file))
2211 (setq tem (concat dir tem))
2212 (if (or (null newest)
2213 (file-newer-than-file-p tem newest))
2214 (setq newest tem)))))
b4da00e9
RM
2215 newest))
2216
2217(defun rename-uniquely ()
2218 "Rename current buffer to a similar name not already taken.
2219This function is useful for creating multiple shell process buffers
2220or multiple mail buffers, etc."
2221 (interactive)
40eb8038 2222 (save-match-data
ed34f320
RS
2223 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2224 (not (and buffer-file-name
2225 (string= (buffer-name)
2226 (file-name-nondirectory
2227 buffer-file-name)))))
2228 ;; If the existing buffer name has a <NNN>,
2229 ;; which isn't part of the file name (if any),
2230 ;; then get rid of that.
40eb8038
RS
2231 (substring (buffer-name) 0 (match-beginning 0))
2232 (buffer-name)))
2233 (new-buf (generate-new-buffer base-name))
2234 (name (buffer-name new-buf)))
2235 (kill-buffer new-buf)
2236 (rename-buffer name)
3941fe2c 2237 (force-mode-line-update))))
5bbbceb1 2238
4e43240a 2239(defun make-directory (dir &optional parents)
5ce8bb89
RS
2240 "Create the directory DIR and any nonexistent parent dirs.
2241Interactively, the default choice of directory to create
2242is the current default directory for file names.
0225ae5e 2243That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
2244
2245Noninteractively, the second (optional) argument PARENTS says whether
2246to create parent directories if they don't exist."
2247 (interactive
2248 (list (read-file-name "Make directory: " default-directory default-directory
2249 nil nil)
2250 t))
6eaebaa2 2251 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
2252 (if handler
2253 (funcall handler 'make-directory dir parents)
2254 (if (not parents)
2255 (make-directory-internal dir)
2256 (let ((dir (directory-file-name (expand-file-name dir)))
2257 create-list)
2258 (while (not (file-exists-p dir))
76d5492b 2259 (setq create-list (cons dir create-list)
4e43240a
RS
2260 dir (directory-file-name (file-name-directory dir))))
2261 (while create-list
2262 (make-directory-internal (car create-list))
2263 (setq create-list (cdr create-list))))))))
b4da00e9
RM
2264\f
2265(put 'revert-buffer-function 'permanent-local t)
2266(defvar revert-buffer-function nil
0973d78b
RS
2267 "Function to use to revert this buffer, or nil to do the default.
2268The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2269which are the arguments that `revert-buffer' received.")
b4da00e9
RM
2270
2271(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2272(defvar revert-buffer-insert-file-contents-function nil
2273 "Function to use to insert contents when reverting this buffer.
2274Gets two args, first the nominal file name to use,
2275and second, t if reading the auto-save file.")
2276
5f76e7d4
KH
2277(defvar before-revert-hook nil
2278 "Normal hook for `revert-buffer' to run before reverting.
2279If `revert-buffer-function' is used to override the normal revert
2280mechanism, this hook is not used.")
2281
2282(defvar after-revert-hook nil
2283 "Normal hook for `revert-buffer' to run after reverting.
2284Note that the hook value that it runs is the value that was in effect
2285before reverting; that makes a difference if you have buffer-local
2286hook functions.
2287
2288If `revert-buffer-function' is used to override the normal revert
2289mechanism, this hook is not used.")
2290
9a30563f 2291(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 2292 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 2293This undoes all changes since the file was visited or saved.
8c0e7b73
JB
2294With a prefix argument, offer to revert from latest auto-save file, if
2295that is more recent than the visited file.
1ab31687 2296
7e7c9c4e
RS
2297This command also works for special buffers that contain text which
2298doesn't come from a file, but reflects some other data base instead:
2299for example, Dired buffers and buffer-list buffers. In these cases,
2300it reconstructs the buffer contents from the appropriate data base.
2301
65ee6096 2302When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
2303to revert from the auto-save file when this is nil. Note that the
2304sense of this argument is the reverse of the prefix argument, for the
2305sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2306to nil.
2307
2308Optional second argument NOCONFIRM means don't ask for confirmation at
2309all.
b4da00e9 2310
5b2b26d5
RS
2311Optional third argument PRESERVE-MODES non-nil means don't alter
2312the files modes. Normally we reinitialize them using `normal-mode'.
2313
8c0e7b73 2314If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
2315do all the work for this command. Otherwise, the hooks
2316`before-revert-hook' and `after-revert-hook' are run at the beginning
2317and the end, and if `revert-buffer-insert-file-contents-function' is
2318non-nil, it is called instead of rereading visited file contents."
fb6208a6 2319
1ab31687
JB
2320 ;; I admit it's odd to reverse the sense of the prefix argument, but
2321 ;; there is a lot of code out there which assumes that the first
2322 ;; argument should be t to avoid consulting the auto-save file, and
2323 ;; there's no straightforward way to encourage authors to notice a
2324 ;; reversal of the argument sense. So I'm just changing the user
2325 ;; interface, but leaving the programmatic interface the same.
e0867e99 2326 (interactive (list (not current-prefix-arg)))
b4da00e9 2327 (if revert-buffer-function
1ab31687 2328 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 2329 (let* ((opoint (point))
1ab31687
JB
2330 (auto-save-p (and (not ignore-auto)
2331 (recent-auto-save-p)
b4da00e9
RM
2332 buffer-auto-save-file-name
2333 (file-readable-p buffer-auto-save-file-name)
2334 (y-or-n-p
2335 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2336 (file-name (if auto-save-p
2337 buffer-auto-save-file-name
2338 buffer-file-name)))
2339 (cond ((null file-name)
2340 (error "Buffer does not seem to be associated with any file"))
2341 ((or noconfirm
2342 (yes-or-no-p (format "Revert buffer from file %s? "
2343 file-name)))
4fbf62ee 2344 (run-hooks 'before-revert-hook)
b4da00e9
RM
2345 ;; If file was backed up but has changed since,
2346 ;; we shd make another backup.
2347 (and (not auto-save-p)
5bbbceb1 2348 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
2349 (setq buffer-backed-up nil))
2350 ;; Get rid of all undo records for this buffer.
2351 (or (eq buffer-undo-list t)
2352 (setq buffer-undo-list nil))
ba5c8c93
KH
2353 ;; Effectively copy the after-revert-hook status,
2354 ;; since after-find-file will clobber it.
2355 (let ((global-hook (default-value 'after-revert-hook))
2356 (local-hook-p (local-variable-p 'after-revert-hook))
2357 (local-hook (and (local-variable-p 'after-revert-hook)
2358 after-revert-hook)))
2359 (let (buffer-read-only
2360 ;; Don't make undo records for the reversion.
2361 (buffer-undo-list t))
2362 (if revert-buffer-insert-file-contents-function
2363 (funcall revert-buffer-insert-file-contents-function
2364 file-name auto-save-p)
2365 (if (not (file-exists-p file-name))
2366 (error "File %s no longer exists!" file-name))
2367 ;; Bind buffer-file-name to nil
2368 ;; so that we don't try to lock the file.
2369 (let ((buffer-file-name nil))
2370 (or auto-save-p
2371 (unlock-buffer)))
2372 (widen)
2373 (insert-file-contents file-name (not auto-save-p)
2374 nil nil t)))
2375 (goto-char (min opoint (point-max)))
2376 ;; Recompute the truename in case changes in symlinks
2377 ;; have changed the truename.
2378 (setq buffer-file-truename
2379 (abbreviate-file-name (file-truename buffer-file-name)))
9a30563f 2380 (after-find-file nil nil t t preserve-modes)
ba5c8c93
KH
2381 ;; Run after-revert-hook as it was before we reverted.
2382 (setq-default revert-buffer-internal-hook global-hook)
2383 (if local-hook-p
2384 (progn
2385 (make-local-variable 'revert-buffer-internal-hook)
2386 (setq revert-buffer-internal-hook local-hook))
2387 (kill-local-variable 'revert-buffer-internal-hook))
2388 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 2389 t)))))
b4da00e9
RM
2390
2391(defun recover-file (file)
2392 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
2393 ;; Actually putting the file name in the minibuffer should be used
2394 ;; only rarely.
2395 ;; Not just because users often use the default.
e1dadc17 2396 (interactive "FRecover file: ")
b4da00e9 2397 (setq file (expand-file-name file))
f7da6740
RS
2398 (if (auto-save-file-name-p (file-name-nondirectory file))
2399 (error "%s is an auto-save file" file))
b4da00e9
RM
2400 (let ((file-name (let ((buffer-file-name file))
2401 (make-auto-save-file-name))))
945e1965
RS
2402 (cond ((if (file-exists-p file)
2403 (not (file-newer-than-file-p file-name file))
2404 (not (file-exists-p file-name)))
b4da00e9
RM
2405 (error "Auto-save file %s not current" file-name))
2406 ((save-window-excursion
2407 (if (not (eq system-type 'vax-vms))
2408 (with-output-to-temp-buffer "*Directory*"
2409 (buffer-disable-undo standard-output)
2410 (call-process "ls" nil standard-output nil
2dc2b736
RS
2411 (if (file-symlink-p file) "-lL" "-l")
2412 file file-name)))
b4da00e9
RM
2413 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2414 (switch-to-buffer (find-file-noselect file t))
82d0954a
KH
2415 (let ((buffer-read-only nil)
2416 ;; Auto-saved file shoule be read without any code conversion.
2417 (coding-system-for-read 'no-conversion))
b4da00e9
RM
2418 (erase-buffer)
2419 (insert-file-contents file-name nil))
8cfb9d46 2420 (after-find-file nil nil t))
b4da00e9
RM
2421 (t (error "Recover-file cancelled.")))))
2422
6598027d 2423(defun recover-session ()
9aee5392
RS
2424 "Recover auto save files from a previous Emacs session.
2425This command first displays a Dired buffer showing you the
2426previous sessions that you could recover from.
2427To choose one, move point to the proper line and then type C-c C-c.
2428Then you'll be asked about a number of files to recover."
2429 (interactive)
363a5030
RS
2430 (if (null auto-save-list-file-prefix)
2431 (error "You set `auto-save-list-file-prefix' to disable making session files"))
6f4983e6 2432 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
2433 (dired (concat auto-save-list-file-prefix "*")
2434 (concat dired-listing-switches "t")))
9aee5392
RS
2435 (goto-char (point-min))
2436 (or (looking-at "Move to the session you want to recover,")
2437 (let ((inhibit-read-only t))
033ef863
RS
2438 (insert "Move to the session you want to recover,\n"
2439 "then type C-c C-c to select it.\n\n"
2440 "You can also delete some of these files;\n"
2441 "type d on a line to mark that file for deletion.\n\n")))
9aee5392 2442 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 2443 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 2444
80280bb7 2445(defun recover-session-finish ()
9aee5392
RS
2446 "Choose one saved session to recover auto-save files from.
2447This command is used in the special Dired buffer created by
80280bb7 2448\\[recover-session]."
9aee5392
RS
2449 (interactive)
2450 ;; Get the name of the session file to recover from.
2451 (let ((file (dired-get-filename))
953a03b2 2452 files
9aee5392 2453 (buffer (get-buffer-create " *recover*")))
033ef863 2454 (dired-do-flagged-delete t)
9aee5392
RS
2455 (unwind-protect
2456 (save-excursion
2457 ;; Read in the auto-save-list file.
2458 (set-buffer buffer)
2459 (erase-buffer)
2460 (insert-file-contents file)
953a03b2
RS
2461 ;; Loop thru the text of that file
2462 ;; and get out the names of the files to recover.
2463 (while (not (eobp))
2464 (let (thisfile autofile)
2465 (if (eolp)
2466 ;; This is a pair of lines for a non-file-visiting buffer.
2467 ;; Get the auto-save file name and manufacture
2468 ;; a "visited file name" from that.
2469 (progn
2470 (forward-line 1)
2471 (setq autofile
2472 (buffer-substring-no-properties
2473 (point)
2474 (save-excursion
2475 (end-of-line)
2476 (point))))
2477 (setq thisfile
2478 (expand-file-name
2479 (substring
2480 (file-name-nondirectory autofile)
2481 1 -1)
2482 (file-name-directory autofile)))
2483 (forward-line 1))
2484 ;; This pair of lines is a file-visiting
2485 ;; buffer. Use the visited file name.
2486 (progn
2487 (setq thisfile
2488 (buffer-substring-no-properties
2489 (point) (progn (end-of-line) (point))))
2490 (forward-line 1)
2491 (setq autofile
2492 (buffer-substring-no-properties
2493 (point) (progn (end-of-line) (point))))
2494 (forward-line 1)))
2495 ;; Ignore a file if its auto-save file does not exist now.
2496 (if (file-exists-p autofile)
2497 (setq files (cons thisfile files)))))
2498 (setq files (nreverse files))
945e1965
RS
2499 ;; The file contains a pair of line for each auto-saved buffer.
2500 ;; The first line of the pair contains the visited file name
2501 ;; or is empty if the buffer was not visiting a file.
2502 ;; The second line is the auto-save file name.
953a03b2
RS
2503 (if files
2504 (map-y-or-n-p "Recover %s? "
2505 (lambda (file)
2506 (condition-case nil
2507 (save-excursion (recover-file file))
76d5492b 2508 (error
953a03b2
RS
2509 "Failed to recover `%s'" file)))
2510 files
2511 '("file" "files" "recover"))
2512 (message "No files can be recovered from this session now")))
9aee5392
RS
2513 (kill-buffer buffer))))
2514
73ba610a
RS
2515(defun kill-some-buffers (&optional list)
2516 "For each buffer in LIST, ask whether to kill it.
2517LIST defaults to all existing live buffers."
b4da00e9 2518 (interactive)
73ba610a
RS
2519 (if (null list)
2520 (setq list (buffer-list)))
2521 (while list
2522 (let* ((buffer (car list))
2523 (name (buffer-name buffer)))
2524 (and (not (string-equal name ""))
2525 (/= (aref name 0) ? )
2526 (yes-or-no-p
2527 (format "Buffer %s %s. Kill? "
2528 name
2529 (if (buffer-modified-p buffer)
2530 "HAS BEEN EDITED" "is unmodified")))
2531 (kill-buffer buffer)))
2532 (setq list (cdr list))))
b4da00e9
RM
2533\f
2534(defun auto-save-mode (arg)
2535 "Toggle auto-saving of contents of current buffer.
f3e23606 2536With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
2537 (interactive "P")
2538 (setq buffer-auto-save-file-name
2539 (and (if (null arg)
74b9c2af
RS
2540 (or (not buffer-auto-save-file-name)
2541 ;; If autosave is off because buffer has shrunk,
2542 ;; then toggling should turn it on.
2543 (< buffer-saved-size 0))
b4da00e9
RM
2544 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2545 (if (and buffer-file-name auto-save-visited-file-name
2546 (not buffer-read-only))
2547 buffer-file-name
2548 (make-auto-save-file-name))))
0b7f1ef2
RS
2549 ;; If -1 was stored here, to temporarily turn off saving,
2550 ;; turn it back on.
2551 (and (< buffer-saved-size 0)
2552 (setq buffer-saved-size 0))
b4da00e9
RM
2553 (if (interactive-p)
2554 (message "Auto-save %s (in this buffer)"
2555 (if buffer-auto-save-file-name "on" "off")))
2556 buffer-auto-save-file-name)
2557
2558(defun rename-auto-save-file ()
2559 "Adjust current buffer's auto save file name for current conditions.
2560Also rename any existing auto save file, if it was made in this session."
2561 (let ((osave buffer-auto-save-file-name))
2562 (setq buffer-auto-save-file-name
2563 (make-auto-save-file-name))
2564 (if (and osave buffer-auto-save-file-name
2565 (not (string= buffer-auto-save-file-name buffer-file-name))
2566 (not (string= buffer-auto-save-file-name osave))
2567 (file-exists-p osave)
2568 (recent-auto-save-p))
2569 (rename-file osave buffer-auto-save-file-name t))))
2570
2571(defun make-auto-save-file-name ()
2572 "Return file name to use for auto-saves of current buffer.
2573Does not consider `auto-save-visited-file-name' as that variable is checked
2574before calling this function. You can redefine this for customization.
2575See also `auto-save-file-name-p'."
2576 (if buffer-file-name
28ee503c
KH
2577 (if (and (eq system-type 'ms-dos)
2578 (not (msdos-long-file-names)))
4503dacb
RS
2579 (let ((fn (file-name-nondirectory buffer-file-name)))
2580 (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn)
2581 (concat (file-name-directory buffer-file-name)
2582 "#" (match-string 1 fn)
2583 "." (match-string 3 fn) "#"))
2584 (concat (file-name-directory buffer-file-name)
2585 "#"
2586 (file-name-nondirectory buffer-file-name)
2587 "#"))
0a1763b4
RS
2588
2589 ;; Deal with buffers that don't have any associated files. (Mail
2590 ;; mode tends to create a good number of these.)
2591
7d483e8c 2592 (let ((buffer-name (buffer-name))
0a1763b4 2593 (limit 0))
c3348e10
RS
2594 ;; Eliminate all slashes and backslashes by
2595 ;; replacing them with sequences that start with %.
2596 ;; Quote % also, to keep distinct names distinct.
2597 (while (string-match "[/\\%]" buffer-name limit)
2598 (let* ((character (aref buffer-name (match-beginning 0)))
2599 (replacement
2600 (cond ((eq character ?%) "%%")
2601 ((eq character ?/) "%+")
2602 ((eq character ?\\) "%-"))))
2603 (setq buffer-name (replace-match replacement t t buffer-name))
2604 (setq limit (1+ (match-end 0)))))
a8abaf83
RS
2605 ;; Generate the file name.
2606 (expand-file-name
2607 (format "#%s#%s#" buffer-name (make-temp-name ""))
2608 ;; Try a few alternative directories, to get one we can write it.
2609 (cond
2610 ((file-writable-p default-directory) default-directory)
2611 ((file-writable-p "/var/tmp/") "/var/tmp/")
2612 ("~/"))))))
b4da00e9
RM
2613
2614(defun auto-save-file-name-p (filename)
2615 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2616FILENAME should lack slashes. You can redefine this for customization."
2617 (string-match "^#.*#$" filename))
2618\f
6f4983e6
RS
2619(defun wildcard-to-regexp (wildcard)
2620 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2621The generated regexp will match a filename iff the filename
2622matches that wildcard according to shell rules. Only wildcards known
2623by `sh' are supported."
2624 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
2625 ;; Copy the initial run of non-special characters.
2626 (result (substring wildcard 0 i))
2627 (len (length wildcard)))
2628 ;; If no special characters, we're almost done.
2629 (if i
2630 (while (< i len)
2631 (let ((ch (aref wildcard i))
2632 j)
2633 (setq
2634 result
2635 (concat result
2636 (cond
7e7c9c4e
RS
2637 ((and (eq ch ?\[)
2638 (< (1+ i) len)
2639 (eq (aref wildcard (1+ i)) ?\]))
2640 "\\[")
6f4983e6
RS
2641 ((eq ch ?\[) ; [...] maps to regexp char class
2642 (progn
2643 (setq i (1+ i))
2644 (concat
2645 (cond
2646 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
2647 (progn
2648 (setq i (1+ i))
2649 (if (eq (aref wildcard i) ?\])
2650 (progn
2651 (setq i (1+ i))
2652 "[^]")
2653 "[^")))
2654 ((eq (aref wildcard i) ?^)
2655 ;; Found "[^". Insert a `\0' character
2656 ;; (which cannot happen in a filename)
2657 ;; into the character class, so that `^'
2658 ;; is not the first character after `[',
2659 ;; and thus non-special in a regexp.
2660 (progn
2661 (setq i (1+ i))
2662 "[\000^"))
2663 ((eq (aref wildcard i) ?\])
2664 ;; I don't think `]' can appear in a
2665 ;; character class in a wildcard, but
2666 ;; let's be general here.
2667 (progn
2668 (setq i (1+ i))
2669 "[]"))
2670 (t "["))
2671 (prog1 ; copy everything upto next `]'.
2672 (substring wildcard
2673 i
2674 (setq j (string-match
2675 "]" wildcard i)))
2676 (setq i (if j (1- j) (1- len)))))))
2677 ((eq ch ?.) "\\.")
2678 ((eq ch ?*) "[^\000]*")
2679 ((eq ch ?+) "\\+")
2680 ((eq ch ?^) "\\^")
2681 ((eq ch ?$) "\\$")
2682 ((eq ch ?\\) "\\\\") ; probably cannot happen...
2683 ((eq ch ??) "[^\000]")
2684 (t (char-to-string ch)))))
2685 (setq i (1+ i)))))
2686 ;; Shell wildcards should match the entire filename,
2687 ;; not its part. Make the regexp say so.
2688 (concat "\\`" result "\\'")))
2689\f
d7fa5aa2 2690(defvar list-directory-brief-switches
b4da00e9
RM
2691 (if (eq system-type 'vax-vms) "" "-CF")
2692 "*Switches for list-directory to pass to `ls' for brief listing,")
2693
d7fa5aa2 2694(defvar list-directory-verbose-switches
b4da00e9
RM
2695 (if (eq system-type 'vax-vms)
2696 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2697 "-l")
2698 "*Switches for list-directory to pass to `ls' for verbose listing,")
2699
2700(defun list-directory (dirname &optional verbose)
2701 "Display a list of files in or matching DIRNAME, a la `ls'.
2702DIRNAME is globbed by the shell if necessary.
2703Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2704Actions controlled by variables `list-directory-brief-switches'
2705and `list-directory-verbose-switches'."
2706 (interactive (let ((pfx current-prefix-arg))
2707 (list (read-file-name (if pfx "List directory (verbose): "
2708 "List directory (brief): ")
2709 nil default-directory nil)
2710 pfx)))
2711 (let ((switches (if verbose list-directory-verbose-switches
2712 list-directory-brief-switches)))
2713 (or dirname (setq dirname default-directory))
2714 (setq dirname (expand-file-name dirname))
2715 (with-output-to-temp-buffer "*Directory*"
2716 (buffer-disable-undo standard-output)
2717 (princ "Directory ")
2718 (princ dirname)
2719 (terpri)
c3554e95
RS
2720 (save-excursion
2721 (set-buffer "*Directory*")
5a8a160e
RS
2722 (setq default-directory
2723 (if (file-directory-p dirname)
2724 (file-name-as-directory dirname)
2725 (file-name-directory dirname)))
c3554e95
RS
2726 (let ((wildcard (not (file-directory-p dirname))))
2727 (insert-directory dirname switches wildcard (not wildcard)))))))
2728
2729(defvar insert-directory-program "ls"
2730 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2731
2732;; insert-directory
2733;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2734;; FULL-DIRECTORY-P is nil.
2735;; The single line of output must display FILE's name as it was
2736;; given, namely, an absolute path name.
2737;; - must insert exactly one line for each file if WILDCARD or
2738;; FULL-DIRECTORY-P is t, plus one optional "total" line
2739;; before the file lines, plus optional text after the file lines.
2740;; Lines are delimited by "\n", so filenames containing "\n" are not
2741;; allowed.
2742;; File lines should display the basename.
2743;; - must be consistent with
2744;; - functions dired-move-to-filename, (these two define what a file line is)
2745;; dired-move-to-end-of-filename,
2746;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2747;; dired-insert-headerline
2748;; dired-after-subdir-garbage (defines what a "total" line is)
2749;; - variable dired-subdir-regexp
2750(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 2751 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 2752Leaves point after the inserted text.
727d277d 2753SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
2754Optional third arg WILDCARD means treat FILE as shell wildcard.
2755Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2756switches do not contain `d', so that a full listing is expected.
2757
2758This works by running a directory listing program
406e12d9 2759whose name is in the variable `insert-directory-program'.
c3554e95 2760If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e
RS
2761 ;; We need the directory in order to find the right handler.
2762 (let ((handler (find-file-name-handler (expand-file-name file)
2763 'insert-directory)))
c3554e95
RS
2764 (if handler
2765 (funcall handler 'insert-directory file switches
2766 wildcard full-directory-p)
b4da00e9 2767 (if (eq system-type 'vax-vms)
c3554e95 2768 (vms-read-directory file switches (current-buffer))
b7fa904c
RS
2769 (or (= 0
2770 (if wildcard
2771 ;; Run ls in the directory of the file pattern we asked for.
2772 (let ((default-directory
2773 (if (file-name-absolute-p file)
2774 (file-name-directory file)
2775 (file-name-directory (expand-file-name file))))
2776 (pattern (file-name-nondirectory file))
2777 (beg 0))
2778 ;; Quote some characters that have special meanings in shells;
2779 ;; but don't quote the wildcards--we want them to be special.
2780 ;; We also currently don't quote the quoting characters
2781 ;; in case people want to use them explicitly to quote
2782 ;; wildcard characters.
2783 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
2784 (setq pattern
2785 (concat (substring pattern 0 (match-beginning 0))
2786 "\\"
2787 (substring pattern (match-beginning 0)))
2788 beg (1+ (match-end 0))))
2789 (call-process shell-file-name nil t nil
2790 "-c" (concat "\\" ;; Disregard shell aliases!
2791 insert-directory-program
2792 " -d "
2793 (if (stringp switches)
2794 switches
2795 (mapconcat 'identity switches " "))
a8bf610e 2796 " -- "
b7fa904c
RS
2797 pattern)))
2798 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2799 ;; directory if FILE is a symbolic link.
2800 (apply 'call-process
2801 insert-directory-program nil t nil
2802 (let (list)
2803 (if (listp switches)
2804 (setq list switches)
2805 (if (not (equal switches ""))
2806 (progn
2807 ;; Split the switches at any spaces
2808 ;; so we can pass separate options as separate args.
2809 (while (string-match " " switches)
2810 (setq list (cons (substring switches 0 (match-beginning 0))
2811 list)
2812 switches (substring switches (match-end 0))))
2813 (setq list (nreverse (cons switches list))))))
2814 (append list
a8bf610e
RS
2815 ;; Avoid lossage if FILE starts with `-'.
2816 '("--")
b7fa904c
RS
2817 (list
2818 (if full-directory-p
2819 (concat (file-name-as-directory file) ".")
2820 file)))))))
2821 ;; We get here if ls failed.
2822 ;; Access the file to get a suitable error.
2823 (access-file file "Reading directory"))))))
b4da00e9 2824
88902b35 2825(defvar kill-emacs-query-functions nil
65d5c6de 2826 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
2827If any of these functions returns nil, killing Emacs is cancelled.
2828`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
2829but `kill-emacs', the low level primitive, does not.
2830See also `kill-emacs-hook'.")
88902b35 2831
b4da00e9
RM
2832(defun save-buffers-kill-emacs (&optional arg)
2833 "Offer to save each buffer, then kill this Emacs process.
2834With prefix arg, silently save all file-visiting buffers, then kill."
2835 (interactive "P")
2836 (save-some-buffers arg t)
2837 (and (or (not (memq t (mapcar (function
2838 (lambda (buf) (and (buffer-file-name buf)
2839 (buffer-modified-p buf))))
2840 (buffer-list))))
2841 (yes-or-no-p "Modified buffers exist; exit anyway? "))
2842 (or (not (fboundp 'process-list))
2843 ;; process-list is not defined on VMS.
2844 (let ((processes (process-list))
2845 active)
2846 (while processes
528415e7 2847 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
2848 (let ((val (process-kill-without-query (car processes))))
2849 (process-kill-without-query (car processes) val)
2850 val)
2851 (setq active t))
2852 (setq processes (cdr processes)))
2853 (or (not active)
2854 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 2855 ;; Query the user for other things, perhaps.
fb15c113 2856 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
b4da00e9
RM
2857 (kill-emacs)))
2858\f
47afc068
RS
2859;; We use /: as a prefix to "quote" a file name
2860;; so that magic file name handlers will not apply to it.
2861
2862(setq file-name-handler-alist
2863 (cons '("\\`/:" . file-name-non-special)
2864 file-name-handler-alist))
2865
2866;; We depend on being the last handler on the list,
2867;; so that anything else which does need handling
2868;; has been handled already.
2869;; So it is safe for us to inhibit *all* magic file name handlers.
2870
2871(defun file-name-non-special (operation &rest arguments)
2872 (let ((file-name-handler-alist nil)
2873 ;; Get a list of the indices of the args which are file names.
2874 (file-arg-indices
2875 (cdr (or (assq operation
2876 ;; The first four are special because they
2877 ;; return a file name. We want to include the /:
2878 ;; in the return value.
2879 ;; So just avoid stripping it in the first place.
2880 '((expand-file-name . nil)
2881 (file-name-directory . nil)
2882 (file-name-as-directory . nil)
2883 (directory-file-name . nil)
2884 (rename-file 0 1)
2885 (copy-file 0 1)
2886 (make-symbolic-link 0 1)
2887 (add-name-to-file 0 1)))
2888 ;; For all other operations, treat the first argument only
2889 ;; as the file name.
2890 '(nil 0))))
2891 ;; Copy ARGUMENTS so we can replace elements in it.
2892 (arguments (copy-sequence arguments)))
2893 ;; Strip off the /: from the file names that have this handler.
2894 (save-match-data
2895 (while file-arg-indices
2896 (and (nth (car file-arg-indices) arguments)
2897 (string-match "\\`/:" (nth (car file-arg-indices) arguments))
2898 (setcar (nthcdr (car file-arg-indices) arguments)
2899 (substring (nth (car file-arg-indices) arguments) 2)))
2900 (setq file-arg-indices (cdr file-arg-indices))))
2901 (apply operation arguments)))
2902\f
b4da00e9
RM
2903(define-key ctl-x-map "\C-f" 'find-file)
2904(define-key ctl-x-map "\C-q" 'toggle-read-only)
2905(define-key ctl-x-map "\C-r" 'find-file-read-only)
2906(define-key ctl-x-map "\C-v" 'find-alternate-file)
2907(define-key ctl-x-map "\C-s" 'save-buffer)
2908(define-key ctl-x-map "s" 'save-some-buffers)
2909(define-key ctl-x-map "\C-w" 'write-file)
2910(define-key ctl-x-map "i" 'insert-file)
2911(define-key esc-map "~" 'not-modified)
2912(define-key ctl-x-map "\C-d" 'list-directory)
2913(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
2914
2915(define-key ctl-x-4-map "f" 'find-file-other-window)
2916(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
2917(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
2918(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 2919(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 2920
f98955ea
JB
2921(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
2922(define-key ctl-x-5-map "f" 'find-file-other-frame)
2923(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
2924(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
2925
2926;;; files.el ends here