]> code.delx.au - gnu-emacs/blob - lisp/files.el
(set-auto-mode): Don't get confused by anything ending in "mode:" which isn't
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94 Free Software Foundation, Inc.
4
5 ;; Maintainer: FSF
6
7 ;; This file is part of GNU Emacs.
8
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22
23 ;;; Commentary:
24
25 ;; Defines most of Emacs's file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
28
29 ;;; Code:
30
31 (defconst delete-auto-save-files t
32 "*Non-nil means delete auto-save file when a buffer is saved or killed.")
33
34 (defconst directory-abbrev-alist
35 nil
36 "*Alist of abbreviations for file directories.
37 A list of elements of the form (FROM . TO), each meaning to replace
38 FROM with TO when it appears in a directory name. This replacement is
39 done when setting up the default directory of a newly visited file.
40 *Every* FROM string should start with `^'.
41
42 Do not use `~' in the TO strings.
43 They should be ordinary absolute directory names.
44
45 Use this feature when you have directories which you normally refer to
46 via absolute symbolic links. Make TO the name of the link, and FROM
47 the name it is linked to.")
48
49 ;;; Turn off backup files on VMS since it has version numbers.
50 (defconst make-backup-files (not (eq system-type 'vax-vms))
51 "*Non-nil means make a backup of a file the first time it is saved.
52 This can be done by renaming the file or by copying.
53
54 Renaming means that Emacs renames the existing file so that it is a
55 backup file, then writes the buffer into a new file. Any other names
56 that the old file had will now refer to the backup file. The new file
57 is owned by you and its group is defaulted.
58
59 Copying means that Emacs copies the existing file into the backup
60 file, then writes the buffer on top of the existing file. Any other
61 names that the old file had will now refer to the new (edited) file.
62 The file's owner and group are unchanged.
63
64 The choice of renaming or copying is controlled by the variables
65 `backup-by-copying', `backup-by-copying-when-linked' and
66 `backup-by-copying-when-mismatch'. See also `backup-inhibited'.")
67
68 ;; Do this so that local variables based on the file name
69 ;; are not overridden by the major mode.
70 (defvar backup-inhibited nil
71 "Non-nil means don't make a backup, regardless of the other parameters.
72 This variable is intended for use by making it local to a buffer.
73 But it is local only if you make it local.")
74 (put 'backup-inhibited 'permanent-local t)
75
76 (defconst backup-by-copying nil
77 "*Non-nil means always use copying to create backup files.
78 See documentation of variable `make-backup-files'.")
79
80 (defconst backup-by-copying-when-linked nil
81 "*Non-nil means use copying to create backups for files with multiple names.
82 This causes the alternate names to refer to the latest version as edited.
83 This variable is relevant only if `backup-by-copying' is nil.")
84
85 (defconst backup-by-copying-when-mismatch nil
86 "*Non-nil means create backups by copying if this preserves owner or group.
87 Renaming may still be used (subject to control of other variables)
88 when it would not result in changing the owner or group of the file;
89 that is, for files which are owned by you and whose group matches
90 the default for a new file created there by you.
91 This variable is relevant only if `backup-by-copying' is nil.")
92
93 (defvar backup-enable-predicate
94 '(lambda (name)
95 (or (< (length name) 5)
96 (not (string-equal "/tmp/" (substring name 0 5)))))
97 "Predicate that looks at a file name and decides whether to make backups.
98 Called with an absolute file name as argument, it returns t to enable backup.")
99
100 (defconst buffer-offer-save nil
101 "*Non-nil in a buffer means offer to save the buffer on exit
102 even if the buffer is not visiting a file.
103 Automatically local in all buffers.")
104 (make-variable-buffer-local 'buffer-offer-save)
105
106 (defconst find-file-existing-other-name nil
107 "*Non-nil means find a file under alternative names, in existing buffers.
108 This means if any existing buffer is visiting the file you want
109 under another name, you get the existing buffer instead of a new buffer.")
110
111 (defconst find-file-visit-truename nil
112 "*Non-nil means visit a file under its truename.
113 The truename of a file is found by chasing all links
114 both at the file level and at the levels of the containing directories.")
115
116 (defvar buffer-file-truename nil
117 "The abbreviated truename of the file visited in the current buffer.
118 That is, (abbreviate-file-name (file-truename buffer-file-name)).
119 This variable is automatically local in all buffers, when non-nil.")
120 (make-variable-buffer-local 'buffer-file-truename)
121 (put 'buffer-file-truename 'permanent-local t)
122
123 (defvar buffer-file-number nil
124 "The device number and file number of the file visited in the current buffer.
125 The value is a list of the form (FILENUM DEVNUM).
126 This pair of numbers uniquely identifies the file.
127 If the buffer is visiting a new file, the value is nil.")
128 (make-variable-buffer-local 'buffer-file-number)
129 (put 'buffer-file-number 'permanent-local t)
130
131 (defconst file-precious-flag nil
132 "*Non-nil means protect against I/O errors while saving files.
133 Some modes set this non-nil in particular buffers.")
134
135 (defvar version-control nil
136 "*Control use of version numbers for backup files.
137 t means make numeric backup versions unconditionally.
138 nil means make them for files that have some already.
139 `never' means do not make them.")
140
141 (defvar dired-kept-versions 2
142 "*When cleaning directory, number of versions to keep.")
143
144 (defvar delete-old-versions nil
145 "*If t, delete excess backup versions silently.
146 If nil, ask confirmation. Any other value prevents any trimming.")
147
148 (defvar kept-old-versions 2
149 "*Number of oldest versions to keep when a new numbered backup is made.")
150
151 (defvar kept-new-versions 2
152 "*Number of newest versions to keep when a new numbered backup is made.
153 Includes the new backup. Must be > 0")
154
155 (defconst require-final-newline nil
156 "*Value of t says silently ensure a file ends in a newline when it is saved.
157 Non-nil but not t says ask user whether to add a newline when there isn't one.
158 nil means don't add newlines.")
159
160 (defconst auto-save-default t
161 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
162
163 (defconst auto-save-visited-file-name nil
164 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
165 Normally auto-save files are written under other names.")
166
167 (defconst save-abbrevs nil
168 "*Non-nil means save word abbrevs too when files are saved.
169 Loading an abbrev file sets this to t.")
170
171 (defconst find-file-run-dired t
172 "*Non-nil says run dired if `find-file' is given the name of a directory.")
173
174 ;;;It is not useful to make this a local variable.
175 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
176 (defvar find-file-not-found-hooks nil
177 "List of functions to be called for `find-file' on nonexistent file.
178 These functions are called as soon as the error is detected.
179 `buffer-file-name' is already set up.
180 The functions are called in the order given until one of them returns non-nil.")
181
182 ;;;It is not useful to make this a local variable.
183 ;;;(put 'find-file-hooks 'permanent-local t)
184 (defvar find-file-hooks nil
185 "List of functions to be called after a buffer is loaded from a file.
186 The buffer's local variables (if any) will have been processed before the
187 functions are called.")
188
189 (defvar write-file-hooks nil
190 "List of functions to be called before writing out a buffer to a file.
191 If one of them returns non-nil, the file is considered already written
192 and the rest are not called.
193 These hooks are considered to pertain to the visited file.
194 So this list is cleared if you change the visited file name.
195 See also `write-contents-hooks'.
196 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
197 ;;; However, in case someone does make it local...
198 (put 'write-file-hooks 'permanent-local t)
199
200 (defvar local-write-file-hooks nil
201 "Just like `write-file-hooks', except intended for per-buffer use.
202 The functions in this list are called before the ones in
203 `write-file-hooks'.")
204 (make-variable-buffer-local 'local-write-file-hooks)
205 (put 'local-write-file-hooks 'permanent-local t)
206
207 (defvar write-contents-hooks nil
208 "List of functions to be called before writing out a buffer to a file.
209 If one of them returns non-nil, the file is considered already written
210 and the rest are not called.
211 These hooks are considered to pertain to the buffer's contents,
212 not to the particular visited file; thus, `set-visited-file-name' does
213 not clear this variable, but changing the major mode does clear it.
214 See also `write-file-hooks'.")
215
216 (defconst enable-local-variables t
217 "*Control use of local-variables lists in files you visit.
218 The value can be t, nil or something else.
219 A value of t means local-variables lists are obeyed;
220 nil means they are ignored; anything else means query.
221
222 The command \\[normal-mode] always obeys local-variables lists
223 and ignores this variable.")
224
225 (defconst enable-local-eval 'maybe
226 "*Control processing of the \"variable\" `eval' in a file's local variables.
227 The value can be t, nil or something else.
228 A value of t means obey `eval' variables;
229 nil means ignore them; anything else means query.
230
231 The command \\[normal-mode] always obeys local-variables lists
232 and ignores this variable.")
233
234 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
235 (or (fboundp 'lock-buffer)
236 (defalias 'lock-buffer 'ignore))
237 (or (fboundp 'unlock-buffer)
238 (defalias 'unlock-buffer 'ignore))
239
240 ;; This hook function provides support for ange-ftp host name
241 ;; completion. It runs the usual ange-ftp hook, but only for
242 ;; completion operations. Having this here avoids the need
243 ;; to load ange-ftp when it's not really in use.
244 (defun ange-ftp-completion-hook-function (op &rest args)
245 (if (memq op '(file-name-completion file-name-all-completions))
246 (apply 'ange-ftp-hook-function op args)
247 (let ((inhibit-file-name-handlers
248 (cons 'ange-ftp-completion-hook-function
249 (and (eq inhibit-file-name-operation op)
250 inhibit-file-name-handlers)))
251 (inhibit-file-name-operation op))
252 (apply op args))))
253 \f
254 (defun pwd ()
255 "Show the current default directory."
256 (interactive nil)
257 (message "Directory %s" default-directory))
258
259 (defvar cd-path nil
260 "Value of the CDPATH environment variable, as a list.
261 Not actually set up until the first time you you use it.")
262
263 (defun parse-colon-path (cd-path)
264 "Explode a colon-separated list of paths into a string list."
265 (and cd-path
266 (let (cd-prefix cd-list (cd-start 0) cd-colon)
267 (setq cd-path (concat cd-path ":"))
268 (while (setq cd-colon (string-match ":" cd-path cd-start))
269 (setq cd-list
270 (nconc cd-list
271 (list (if (= cd-start cd-colon)
272 nil
273 (substitute-in-file-name
274 (file-name-as-directory
275 (substring cd-path cd-start cd-colon)))))))
276 (setq cd-start (+ cd-colon 1)))
277 cd-list)))
278
279 (defun cd-absolute (dir)
280 "Change current directory to given absolute file name DIR."
281 ;; Put the name into directory syntax now,
282 ;; because otherwise expand-file-name may give some bad results.
283 (if (not (eq system-type 'vax-vms))
284 (setq dir (file-name-as-directory dir)))
285 (setq dir (abbreviate-file-name (expand-file-name dir)))
286 (if (not (file-directory-p dir))
287 (error "%s is not a directory" dir)
288 (if (file-executable-p dir)
289 (setq default-directory dir)
290 (error "Cannot cd to %s: Permission denied" dir))))
291
292 (defun cd (dir)
293 "Make DIR become the current buffer's default directory.
294 If your environment includes a `CDPATH' variable, try each one of that
295 colon-separated list of directories when resolving a relative directory name."
296 (interactive "FChange default directory: ")
297 (if (file-name-absolute-p dir)
298 (cd-absolute (expand-file-name dir))
299 (if (null cd-path)
300 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
301 (setq cd-path (or trypath (list "./")))))
302 (if (not (catch 'found
303 (mapcar
304 (function (lambda (x)
305 (let ((f (expand-file-name (concat x dir))))
306 (if (file-directory-p f)
307 (progn
308 (cd-absolute f)
309 (throw 'found t))))))
310 cd-path)
311 nil))
312 (error "No such directory found via CDPATH environment variable"))))
313
314 (defun load-file (file)
315 "Load the Lisp file named FILE."
316 (interactive "fLoad file: ")
317 (load (expand-file-name file) nil nil t))
318
319 (defun load-library (library)
320 "Load the library named LIBRARY.
321 This is an interface to the function `load'."
322 (interactive "sLoad library: ")
323 (load library))
324
325 (defun file-local-copy (file &optional buffer)
326 "Copy the file FILE into a temporary file on this machine.
327 Returns the name of the local copy, or nil, if FILE is directly
328 accessible."
329 (let ((handler (find-file-name-handler file 'file-local-copy)))
330 (if handler
331 (funcall handler 'file-local-copy file)
332 nil)))
333
334 (defun file-truename (filename &optional counter prev-dirs)
335 "Return the truename of FILENAME, which should be absolute.
336 The truename of a file name is found by chasing symbolic links
337 both at the level of the file and at the level of the directories
338 containing it, until no links are left at any level.
339
340 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
341 Do not specify them in other calls."
342 ;; COUNTER can be a cons cell whose car is the count of how many more links
343 ;; to chase before getting an error.
344 ;; PREV-DIRS can be a cons cell whose car is an alist
345 ;; of truenames we've just recently computed.
346 (if (or (string= filename "~")
347 (and (string= (substring filename 0 1) "~")
348 (string-match "~[^/]*" filename)))
349 (progn
350 (setq filename (expand-file-name filename))
351 (if (string= filename "")
352 (setq filename "/"))))
353 (or counter (setq counter (list 100)))
354 (let (done
355 ;; For speed, remove the ange-ftp completion handler from the list.
356 ;; We know it's not needed here.
357 ;; For even more speed, do this only on the outermost call.
358 (file-name-handler-alist
359 (if prev-dirs file-name-handler-alist
360 (let ((tem (copy-sequence file-name-handler-alist)))
361 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
362 (or prev-dirs (setq prev-dirs (list nil)))
363 ;; If this file directly leads to a link, process that iteratively
364 ;; so that we don't use lots of stack.
365 (while (not done)
366 (setcar counter (1- (car counter)))
367 (if (< (car counter) 0)
368 (error "Apparent cycle of symbolic links for %s" filename))
369 (let ((handler (find-file-name-handler filename 'file-truename)))
370 ;; For file name that has a special handler, call handler.
371 ;; This is so that ange-ftp can save time by doing a no-op.
372 (if handler
373 (setq filename (funcall handler 'file-truename filename)
374 done t)
375 (let ((dir (or (file-name-directory filename) default-directory))
376 target dirfile)
377 ;; Get the truename of the directory.
378 (setq dirfile (directory-file-name dir))
379 ;; If these are equal, we have the (or a) root directory.
380 (or (string= dir dirfile)
381 ;; If this is the same dir we last got the truename for,
382 ;; save time--don't recalculate.
383 (if (assoc dir (car prev-dirs))
384 (setq dir (cdr (assoc dir (car prev-dirs))))
385 (let ((old dir)
386 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
387 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
388 (setq dir new))))
389 (if (equal ".." (file-name-nondirectory filename))
390 (setq filename
391 (directory-file-name (file-name-directory (directory-file-name dir)))
392 done t)
393 (if (equal "." (file-name-nondirectory filename))
394 (setq filename (directory-file-name dir)
395 done t)
396 ;; Put it back on the file name.
397 (setq filename (concat dir (file-name-nondirectory filename)))
398 ;; Is the file name the name of a link?
399 (setq target (file-symlink-p filename))
400 (if target
401 ;; Yes => chase that link, then start all over
402 ;; since the link may point to a directory name that uses links.
403 ;; We can't safely use expand-file-name here
404 ;; since target might look like foo/../bar where foo
405 ;; is itself a link. Instead, we handle . and .. above.
406 (setq filename
407 (if (file-name-absolute-p target)
408 target
409 (concat dir target))
410 done nil)
411 ;; No, we are done!
412 (setq done t))))))))
413 filename))
414
415 (defun file-chase-links (filename)
416 "Chase links in FILENAME until a name that is not a link.
417 Does not examine containing directories for links,
418 unlike `file-truename'."
419 (let (tem (count 100) (newname filename))
420 (while (setq tem (file-symlink-p newname))
421 (if (= count 0)
422 (error "Apparent cycle of symbolic links for %s" filename))
423 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
424 (while (string-match "//+" tem)
425 (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
426 (substring tem (match-end 0)))))
427 ;; Handle `..' by hand, since it needs to work in the
428 ;; target of any directory symlink.
429 ;; This code is not quite complete; it does not handle
430 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
431 (while (string-match "\\`\\.\\./" tem)
432 (setq tem (substring tem 3))
433 (setq newname (file-name-as-directory
434 ;; Do the .. by hand.
435 (directory-file-name
436 (file-name-directory
437 ;; Chase links in the default dir of the symlink.
438 (file-chase-links
439 (directory-file-name
440 (file-name-directory newname))))))))
441 (setq newname (expand-file-name tem (file-name-directory newname)))
442 (setq count (1- count)))
443 newname))
444 \f
445 (defun switch-to-buffer-other-window (buffer)
446 "Select buffer BUFFER in another window."
447 (interactive "BSwitch to buffer in other window: ")
448 (let ((pop-up-windows t))
449 (pop-to-buffer buffer t)))
450
451 (defun switch-to-buffer-other-frame (buffer)
452 "Switch to buffer BUFFER in another frame."
453 (interactive "BSwitch to buffer in other frame: ")
454 (let ((pop-up-frames t))
455 (pop-to-buffer buffer t)
456 (raise-frame (window-frame (selected-window)))))
457
458 (defun find-file (filename)
459 "Edit file FILENAME.
460 Switch to a buffer visiting file FILENAME,
461 creating one if none already exists."
462 (interactive "FFind file: ")
463 (switch-to-buffer (find-file-noselect filename)))
464
465 (defun find-file-other-window (filename)
466 "Edit file FILENAME, in another window.
467 May create a new window, or reuse an existing one.
468 See the function `display-buffer'."
469 (interactive "FFind file in other window: ")
470 (switch-to-buffer-other-window (find-file-noselect filename)))
471
472 (defun find-file-other-frame (filename)
473 "Edit file FILENAME, in another frame.
474 May create a new frame, or reuse an existing one.
475 See the function `display-buffer'."
476 (interactive "FFind file in other frame: ")
477 (switch-to-buffer-other-frame (find-file-noselect filename)))
478
479 (defun find-file-read-only (filename)
480 "Edit file FILENAME but don't allow changes.
481 Like \\[find-file] but marks buffer as read-only.
482 Use \\[toggle-read-only] to permit editing."
483 (interactive "fFind file read-only: ")
484 (find-file filename)
485 (setq buffer-read-only t)
486 (current-buffer))
487
488 (defun find-file-read-only-other-window (filename)
489 "Edit file FILENAME in another window but don't allow changes.
490 Like \\[find-file-other-window] but marks buffer as read-only.
491 Use \\[toggle-read-only] to permit editing."
492 (interactive "fFind file read-only other window: ")
493 (find-file-other-window filename)
494 (setq buffer-read-only t)
495 (current-buffer))
496
497 (defun find-file-read-only-other-frame (filename)
498 "Edit file FILENAME in another frame but don't allow changes.
499 Like \\[find-file-other-frame] but marks buffer as read-only.
500 Use \\[toggle-read-only] to permit editing."
501 (interactive "fFind file read-only other frame: ")
502 (find-file-other-frame filename)
503 (setq buffer-read-only t)
504 (current-buffer))
505
506 (defun find-alternate-file (filename)
507 "Find file FILENAME, select its buffer, kill previous buffer.
508 If the current buffer now contains an empty file that you just visited
509 \(presumably by mistake), use this command to visit the file you really want."
510 (interactive
511 (let ((file buffer-file-name)
512 (file-name nil)
513 (file-dir nil))
514 (and file
515 (setq file-name (file-name-nondirectory file)
516 file-dir (file-name-directory file)))
517 (list (read-file-name
518 "Find alternate file: " file-dir nil nil file-name))))
519 (and (buffer-modified-p) (buffer-file-name)
520 ;; (not buffer-read-only)
521 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
522 (buffer-name))))
523 (error "Aborted"))
524 (let ((obuf (current-buffer))
525 (ofile buffer-file-name)
526 (onum buffer-file-number)
527 (otrue buffer-file-truename)
528 (oname (buffer-name)))
529 (rename-buffer " **lose**")
530 (setq buffer-file-name nil)
531 (setq buffer-file-number nil)
532 (setq buffer-file-truename nil)
533 (unwind-protect
534 (progn
535 (unlock-buffer)
536 (find-file filename))
537 (cond ((eq obuf (current-buffer))
538 (setq buffer-file-name ofile)
539 (setq buffer-file-number onum)
540 (setq buffer-file-truename otrue)
541 (lock-buffer)
542 (rename-buffer oname))))
543 (or (eq (current-buffer) obuf)
544 (kill-buffer obuf))))
545
546 (defun create-file-buffer (filename)
547 "Create a suitably named buffer for visiting FILENAME, and return it.
548 FILENAME (sans directory) is used unchanged if that name is free;
549 otherwise a string <2> or <3> or ... is appended to get an unused name."
550 (let ((lastname (file-name-nondirectory filename)))
551 (if (string= lastname "")
552 (setq lastname filename))
553 (generate-new-buffer lastname)))
554
555 (defun generate-new-buffer (name)
556 "Create and return a buffer with a name based on NAME.
557 Choose the buffer's name using `generate-new-buffer-name'."
558 (get-buffer-create (generate-new-buffer-name name)))
559
560 (defconst automount-dir-prefix "^/tmp_mnt/"
561 "Regexp to match the automounter prefix in a directory name.")
562
563 (defvar abbreviated-home-dir nil
564 "The user's homedir abbreviated according to `directory-abbrev-list'.")
565
566 (defun abbreviate-file-name (filename)
567 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
568 This also substitutes \"~\" for the user's home directory.
569 Type \\[describe-variable] directory-abbrev-alist RET for more information."
570 ;; Get rid of the prefixes added by the automounter.
571 (if (and (string-match automount-dir-prefix filename)
572 (file-exists-p (file-name-directory
573 (substring filename (1- (match-end 0))))))
574 (setq filename (substring filename (1- (match-end 0)))))
575 (let ((tail directory-abbrev-alist))
576 ;; If any elt of directory-abbrev-alist matches this name,
577 ;; abbreviate accordingly.
578 (while tail
579 (if (string-match (car (car tail)) filename)
580 (setq filename
581 (concat (cdr (car tail)) (substring filename (match-end 0)))))
582 (setq tail (cdr tail)))
583 ;; Compute and save the abbreviated homedir name.
584 ;; We defer computing this until the first time it's needed, to
585 ;; give time for directory-abbrev-alist to be set properly.
586 ;; We include a slash at the end, to avoid spurious matches
587 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
588 (or abbreviated-home-dir
589 (setq abbreviated-home-dir
590 (let ((abbreviated-home-dir "$foo"))
591 (concat "^" (abbreviate-file-name (expand-file-name "~"))
592 "\\(/\\|$\\)"))))
593
594 ;; If FILENAME starts with the abbreviated homedir,
595 ;; make it start with `~' instead.
596 (if (and (string-match abbreviated-home-dir filename)
597 ;; If the home dir is just /, don't change it.
598 (not (and (= (match-end 0) 1)
599 (= (aref filename 0) ?/)))
600 (not (and (or (eq system-type 'ms-dos)
601 (eq system-type 'windows-nt))
602 (save-match-data
603 (string-match "^[a-zA-Z]:/$" filename)))))
604 (setq filename
605 (concat "~"
606 (substring filename (match-beginning 1) (match-end 1))
607 (substring filename (match-end 0)))))
608 filename))
609
610 (defvar find-file-not-true-dirname-list nil
611 "*List of logical names for which visiting shouldn't save the true dirname.
612 On VMS, when you visit a file using a logical name that searches a path,
613 you may or may not want the visited file name to record the specific
614 directory where the file was found. If you *do not* want that, add the logical
615 name to this list as a string.")
616
617 (defun find-buffer-visiting (filename)
618 "Return the buffer visiting file FILENAME (a string).
619 This is like `get-file-buffer', except that it checks for any buffer
620 visiting the same file, possibly under a different name.
621 If there is no such live buffer, return nil."
622 (let ((buf (get-file-buffer filename))
623 (truename (abbreviate-file-name (file-truename filename))))
624 (or buf
625 (let ((list (buffer-list)) found)
626 (while (and (not found) list)
627 (save-excursion
628 (set-buffer (car list))
629 (if (and buffer-file-name
630 (string= buffer-file-truename truename))
631 (setq found (car list))))
632 (setq list (cdr list)))
633 found)
634 (let ((number (nthcdr 10 (file-attributes truename)))
635 (list (buffer-list)) found)
636 (and number
637 (while (and (not found) list)
638 (save-excursion
639 (set-buffer (car list))
640 (if (and buffer-file-name
641 (equal buffer-file-number number)
642 ;; Verify this buffer's file number
643 ;; still belongs to its file.
644 (file-exists-p buffer-file-name)
645 (equal (nthcdr 10 (file-attributes buffer-file-name))
646 number))
647 (setq found (car list))))
648 (setq list (cdr list))))
649 found))))
650
651 (defun find-file-noselect (filename &optional nowarn)
652 "Read file FILENAME into a buffer and return the buffer.
653 If a buffer exists visiting FILENAME, return that one, but
654 verify that the file has not changed since visited or saved.
655 The buffer is not selected, just returned to the caller."
656 (setq filename
657 (abbreviate-file-name
658 (expand-file-name filename)))
659 (if (file-directory-p filename)
660 (if find-file-run-dired
661 (dired-noselect filename)
662 (error "%s is a directory." filename))
663 (let* ((buf (get-file-buffer filename))
664 (truename (abbreviate-file-name (file-truename filename)))
665 (number (nthcdr 10 (file-attributes truename)))
666 ;; Find any buffer for a file which has same truename.
667 (other (and (not buf) (find-buffer-visiting filename)))
668 error)
669 ;; Let user know if there is a buffer with the same truename.
670 (if other
671 (progn
672 (or nowarn
673 (string-equal filename (buffer-file-name other))
674 (message "%s and %s are the same file"
675 filename (buffer-file-name other)))
676 ;; Optionally also find that buffer.
677 (if (or find-file-existing-other-name find-file-visit-truename)
678 (setq buf other))))
679 (if buf
680 (or nowarn
681 (verify-visited-file-modtime buf)
682 (cond ((not (file-exists-p filename))
683 (error "File %s no longer exists!" filename))
684 ((yes-or-no-p
685 (format
686 (if (buffer-modified-p buf)
687 "File %s changed on disk. Discard your edits? "
688 "File %s changed on disk. Reread from disk? ")
689 (file-name-nondirectory filename)))
690 (save-excursion
691 (set-buffer buf)
692 (revert-buffer t t)))))
693 (save-excursion
694 ;;; The truename stuff makes this obsolete.
695 ;;; (let* ((link-name (car (file-attributes filename)))
696 ;;; (linked-buf (and (stringp link-name)
697 ;;; (get-file-buffer link-name))))
698 ;;; (if (bufferp linked-buf)
699 ;;; (message "Symbolic link to file in buffer %s"
700 ;;; (buffer-name linked-buf))))
701 (setq buf (create-file-buffer filename))
702 (set-buffer-major-mode buf)
703 (set-buffer buf)
704 (erase-buffer)
705 (condition-case ()
706 (insert-file-contents filename t)
707 (file-error
708 ;; Run find-file-not-found-hooks until one returns non-nil.
709 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
710 ;; If they fail too, set error.
711 (setq error t))))
712 ;; Find the file's truename, and maybe use that as visited name.
713 (setq buffer-file-truename truename)
714 (setq buffer-file-number number)
715 ;; On VMS, we may want to remember which directory in a search list
716 ;; the file was found in.
717 (and (eq system-type 'vax-vms)
718 (let (logical)
719 (if (string-match ":" (file-name-directory filename))
720 (setq logical (substring (file-name-directory filename)
721 0 (match-beginning 0))))
722 (not (member logical find-file-not-true-dirname-list)))
723 (setq buffer-file-name buffer-file-truename))
724 (if find-file-visit-truename
725 (setq buffer-file-name
726 (setq filename
727 (expand-file-name buffer-file-truename))))
728 ;; Set buffer's default directory to that of the file.
729 (setq default-directory (file-name-directory filename))
730 ;; Turn off backup files for certain file names. Since
731 ;; this is a permanent local, the major mode won't eliminate it.
732 (and (not (funcall backup-enable-predicate buffer-file-name))
733 (progn
734 (make-local-variable 'backup-inhibited)
735 (setq backup-inhibited t)))
736 (after-find-file error (not nowarn))))
737 buf)))
738 \f
739 (defvar after-find-file-from-revert-buffer nil)
740
741 (defun after-find-file (&optional error warn noauto
742 after-find-file-from-revert-buffer)
743 "Called after finding a file and by the default revert function.
744 Sets buffer mode, parses local variables.
745 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
746 error in reading the file. WARN non-nil means warn if there
747 exists an auto-save file more recent than the visited file.
748 NOAUTO means don't mess with auto-save mode.
749 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
750 means this call was from `revert-buffer'.
751 Finishes by calling the functions in `find-file-hooks'."
752 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
753 (if noninteractive
754 nil
755 (let* (not-serious
756 (msg
757 (cond ((and error (file-attributes buffer-file-name))
758 (setq buffer-read-only t)
759 "File exists, but cannot be read.")
760 ((not buffer-read-only)
761 (if (and warn
762 (file-newer-than-file-p (make-auto-save-file-name)
763 buffer-file-name))
764 "Auto save file is newer; consider M-x recover-file"
765 (setq not-serious t)
766 (if error "(New file)" nil)))
767 ((not error)
768 (setq not-serious t)
769 "Note: file is write protected")
770 ((file-attributes (directory-file-name default-directory))
771 "File not found and directory write-protected")
772 ((file-exists-p (file-name-directory buffer-file-name))
773 (setq buffer-read-only nil))
774 (t
775 (setq buffer-read-only nil)
776 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
777 "Use M-x make-dir RET RET to create the directory"
778 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
779 (if msg
780 (progn
781 (message msg)
782 (or not-serious (sit-for 1 nil t)))))
783 (if (and auto-save-default (not noauto))
784 (auto-save-mode t)))
785 (normal-mode t)
786 (run-hooks 'find-file-hooks))
787
788 (defun normal-mode (&optional find-file)
789 "Choose the major mode for this buffer automatically.
790 Also sets up any specified local variables of the file.
791 Uses the visited file name, the -*- line, and the local variables spec.
792
793 This function is called automatically from `find-file'. In that case,
794 we may set up specified local variables depending on the value of
795 `enable-local-variables': if it is t, we do; if it is nil, we don't;
796 otherwise, we query. `enable-local-variables' is ignored if you
797 run `normal-mode' explicitly."
798 (interactive)
799 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
800 (condition-case err
801 (set-auto-mode)
802 (error (message "File mode specification error: %s"
803 (prin1-to-string err))))
804 (condition-case err
805 (let ((enable-local-variables (or (not find-file)
806 enable-local-variables)))
807 (hack-local-variables))
808 (error (message "File local-variables error: %s"
809 (prin1-to-string err)))))
810
811 (defvar auto-mode-alist (mapcar 'purecopy
812 '(("\\.text\\'" . text-mode)
813 ("\\.c\\'" . c-mode)
814 ("\\.h\\'" . c-mode)
815 ("\\.tex\\'" . TeX-mode)
816 ("\\.ltx\\'" . LaTeX-mode)
817 ("\\.el\\'" . emacs-lisp-mode)
818 ("\\.mm\\'" . nroff-mode)
819 ("\\.me\\'" . nroff-mode)
820 ("\\.ms\\'" . nroff-mode)
821 ("\\.man\\'" . nroff-mode)
822 ("\\.scm\\'" . scheme-mode)
823 ("\\.l\\'" . lisp-mode)
824 ("\\.lisp\\'" . lisp-mode)
825 ("\\.f\\'" . fortran-mode)
826 ("\\.for\\'" . fortran-mode)
827 ("\\.p\\'" . pascal-mode)
828 ("\\.pas\\'" . pascal-mode)
829 ("\\.mss\\'" . scribe-mode)
830 ("\\.ada\\'" . ada-mode)
831 ("\\.icn\\'" . icon-mode)
832 ("\\.pl\\'" . prolog-mode)
833 ("\\.cc\\'" . c++-mode)
834 ("\\.hh\\'" . c++-mode)
835 ("\\.C\\'" . c++-mode)
836 ("\\.H\\'" . c++-mode)
837 ;;; ("\\.mk\\'" . makefile-mode)
838 ;;; ("[Mm]akefile" . makefile-mode)
839 ;;; Less common extensions come here
840 ;;; so more common ones above are found faster.
841 ("\\.texinfo\\'" . texinfo-mode)
842 ("\\.texi\\'" . texinfo-mode)
843 ("\\.s\\'" . asm-mode)
844 ("ChangeLog\\'" . change-log-mode)
845 ("change.log\\'" . change-log-mode)
846 ("changelo\\'" . change-log-mode)
847 ("ChangeLog.[0-9]+\\'" . change-log-mode)
848 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
849 ;; The following should come after the ChangeLog pattern
850 ;; for the sake of ChangeLog.1, etc.
851 ("\\.[12345678]\\'" . nroff-mode)
852 ("\\.TeX\\'" . TeX-mode)
853 ("\\.sty\\'" . LaTeX-mode)
854 ("\\.bbl\\'" . LaTeX-mode)
855 ("\\.bib\\'" . bibtex-mode)
856 ("\\.article\\'" . text-mode)
857 ("\\.letter\\'" . text-mode)
858 ("\\.tcl\\'" . tcl-mode)
859 ("\\.lsp\\'" . lisp-mode)
860 ("\\.awk\\'" . awk-mode)
861 ("\\.prolog\\'" . prolog-mode)
862 ("\\.tar\\'" . tar-mode)
863 ;; Mailer puts message to be edited in
864 ;; /tmp/Re.... or Message
865 ("^/tmp/Re" . text-mode)
866 ("/Message[0-9]*\\'" . text-mode)
867 ;; some news reader is reported to use this
868 ("^/tmp/fol/" . text-mode)
869 ("\\.y\\'" . c-mode)
870 ("\\.lex\\'" . c-mode)
871 ("\\.oak\\'" . scheme-mode)
872 ("\\.scm.[0-9]*\\'" . scheme-mode)
873 ("\\.sgm\\'" . sgml-mode)
874 ("\\.sgml\\'" . sgml-mode)
875 ("\\.dtd\\'" . sgml-mode)
876 ;; .emacs following a directory delimiter
877 ;; in either Unix or VMS syntax.
878 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
879 ;; _emacs following a directory delimiter
880 ;; in MsDos syntax
881 ("[:/]_emacs\\'" . emacs-lisp-mode)
882 ("\\.ml\\'" . lisp-mode)))
883 "\
884 Alist of filename patterns vs corresponding major mode functions.
885 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
886 \(NON-NIL stands for anything that is not nil; the value does not matter.)
887 Visiting a file whose name matches REGEXP specifies FUNCTION as the
888 mode function to use. FUNCTION will be called, unless it is nil.
889
890 If the element has the form (REGEXP FUNCTION NON-NIL), then after
891 calling FUNCTION (if it's not nil), we delete the suffix that matched
892 REGEXP and search the list again for another match.")
893
894 (defconst interpreter-mode-alist
895 '(("perl" . perl-mode)
896 ("wish" . tcl-mode)
897 ("wishx" . tcl-mode)
898 ("tcl" . tcl-mode)
899 ("tclsh" . tcl-mode)
900 ("awk" . awk-mode)
901 ("gawk" . awk-mode)
902 ("scm" . scheme-mode))
903 "Alist mapping interpreter names to major modes.
904 This alist applies to files whose first line starts with `#!'.
905 Each element looks like (INTERPRETER . MODE).
906 The car of each element is compared with
907 the name of the interpreter specified in the first line.
908 If it matches, mode MODE is selected.")
909
910 (defconst inhibit-first-line-modes-regexps '("\\.tar$")
911 "List of regexps; if one matches a file name, don't look for `-*-'.")
912
913 (defvar user-init-file
914 "" ; set by command-line
915 "File name including directory of user's initialization file.")
916
917 (defun set-auto-mode ()
918 "Select major mode appropriate for current buffer.
919 This checks for a -*- mode tag in the buffer's text,
920 compares the filename against the entries in `auto-mode-alist',
921 or checks the interpreter that runs this file against
922 `interpreter-mode-alist'.
923
924 It does not check for the `mode:' local variable in the
925 Local Variables section of the file; for that, use `hack-local-variables'.
926
927 If `enable-local-variables' is nil, this function does not check for a
928 -*- mode tag."
929 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
930 (let (beg end done)
931 (save-excursion
932 (goto-char (point-min))
933 (skip-chars-forward " \t\n")
934 (and enable-local-variables
935 ;; Don't look for -*- if this file name matches any
936 ;; of the regexps in inhibit-first-line-modes-regexps.
937 (let ((temp inhibit-first-line-modes-regexps)
938 (name (file-name-sans-versions buffer-file-name)))
939 (while (and temp
940 (not (string-match (car temp)
941 name)))
942 (setq temp (cdr temp)))
943 (not temp))
944 (search-forward "-*-" (save-excursion
945 ;; If the file begins with "#!"
946 ;; (exec interpreter magic), look
947 ;; for mode frobs in the first two
948 ;; lines. You cannot necessarily
949 ;; put them in the first line of
950 ;; such a file without screwing up
951 ;; the interpreter invocation.
952 (end-of-line (and (looking-at "^#!") 2))
953 (point)) t)
954 (progn
955 (skip-chars-forward " \t")
956 (setq beg (point))
957 (search-forward "-*-"
958 (save-excursion (end-of-line) (point))
959 t))
960 (progn
961 (forward-char -3)
962 (skip-chars-backward " \t")
963 (setq end (point))
964 (goto-char beg)
965 (if (save-excursion (search-forward ":" end t))
966 ;; Find all specifications for the `mode:' variable
967 ;; and execute them left to right.
968 (while (let ((case-fold-search t))
969 (or (and (looking-at "mode:")
970 (goto-char (match-end 0)))
971 (re-search-forward "[ \t;]mode:" end t)))
972 (skip-chars-forward " \t")
973 (setq beg (point))
974 (if (search-forward ";" end t)
975 (forward-char -1)
976 (goto-char end))
977 (skip-chars-backward " \t")
978 (funcall (intern (concat (downcase (buffer-substring beg (point))) "-mode"))))
979 ;; Simple -*-MODE-*- case.
980 (funcall (intern (concat (downcase (buffer-substring beg end)) "-mode"))))
981 (setq done t)))
982 ;; If we didn't find a mode from a -*- line, try using the file name.
983 (if (and (not done) buffer-file-name)
984 (let ((name buffer-file-name)
985 (keep-going t))
986 ;; Remove backup-suffixes from file name.
987 (setq name (file-name-sans-versions name))
988 (while keep-going
989 (setq keep-going nil)
990 (let ((alist auto-mode-alist)
991 (mode nil))
992 ;; Find first matching alist entry.
993 (let ((case-fold-search (eq system-type 'vax-vms)))
994 (while (and (not mode) alist)
995 (if (string-match (car (car alist)) name)
996 (if (and (consp (cdr (car alist)))
997 (nth 2 (car alist)))
998 (progn
999 (setq mode (car (cdr (car alist)))
1000 name (substring name 0 (match-beginning 0))
1001 keep-going t))
1002 (setq mode (cdr (car alist))
1003 keep-going nil)))
1004 (setq alist (cdr alist))))
1005 (if mode
1006 (funcall mode)
1007 ;; If we can't deduce a mode from the file name,
1008 ;; look for an interpreter specified in the first line.
1009 (let ((interpreter
1010 (save-excursion
1011 (goto-char (point-min))
1012 (if (looking-at "#! *\\([^ \t\n]+\\)")
1013 (buffer-substring (match-beginning 1)
1014 (match-end 1))
1015 "")))
1016 elt)
1017 ;; Map interpreter name to a mode.
1018 (setq elt (assoc (file-name-nondirectory interpreter)
1019 interpreter-mode-alist))
1020 (if elt
1021 (funcall (cdr elt))))))))))))
1022
1023 (defun hack-local-variables-prop-line ()
1024 ;; Set local variables specified in the -*- line.
1025 ;; Ignore any specification for `mode:';
1026 ;; set-auto-mode should already have handled that.
1027 (save-excursion
1028 (goto-char (point-min))
1029 (let ((result nil)
1030 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
1031 ;; Parse the -*- line into the `result' alist.
1032 (cond ((not (search-forward "-*-" end t))
1033 ;; doesn't have one.
1034 nil)
1035 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1036 ;; Simple form: "-*- MODENAME -*-". Already handled.
1037 nil)
1038 (t
1039 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1040 ;; (last ";" is optional).
1041 (save-excursion
1042 (if (search-forward "-*-" end t)
1043 (setq end (- (point) 3))
1044 (error "-*- not terminated before end of line")))
1045 (while (< (point) end)
1046 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1047 (error "malformed -*- line"))
1048 (goto-char (match-end 0))
1049 (let ((key (intern (downcase (buffer-substring
1050 (match-beginning 1)
1051 (match-end 1)))))
1052 (val (save-restriction
1053 (narrow-to-region (point) end)
1054 (read (current-buffer)))))
1055 (or (eq key 'mode)
1056 (setq result (cons (cons key val) result)))
1057 (skip-chars-forward " \t;")))
1058 (setq result (nreverse result))))
1059
1060 (if (and result
1061 (or (eq enable-local-variables t)
1062 (and enable-local-variables
1063 (save-window-excursion
1064 (condition-case nil
1065 (switch-to-buffer (current-buffer))
1066 (error
1067 ;; If we fail to switch in the selected window,
1068 ;; it is probably a minibuffer.
1069 ;; So try another window.
1070 (condition-case nil
1071 (switch-to-buffer-other-window (current-buffer))
1072 (error
1073 (switch-to-buffer-other-frame (current-buffer))))))
1074 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1075 (file-name-nondirectory buffer-file-name)))))))
1076 (while result
1077 (hack-one-local-variable (car (car result)) (cdr (car result)))
1078 (setq result (cdr result)))))))
1079
1080 (defun hack-local-variables ()
1081 "Parse and put into effect this buffer's local variables spec."
1082 (hack-local-variables-prop-line)
1083 ;; Look for "Local variables:" line in last page.
1084 (save-excursion
1085 (goto-char (point-max))
1086 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1087 (if (let ((case-fold-search t))
1088 (and (search-forward "Local Variables:" nil t)
1089 (or (eq enable-local-variables t)
1090 (and enable-local-variables
1091 (save-window-excursion
1092 (switch-to-buffer (current-buffer))
1093 (save-excursion
1094 (beginning-of-line)
1095 (set-window-start (selected-window) (point)))
1096 (y-or-n-p (format "Set local variables as specified at end of %s? "
1097 (if buffer-file-name
1098 (file-name-nondirectory
1099 buffer-file-name)
1100 (concat "buffer "
1101 (buffer-name))))))))))
1102 (let ((continue t)
1103 prefix prefixlen suffix beg
1104 (enable-local-eval enable-local-eval))
1105 ;; The prefix is what comes before "local variables:" in its line.
1106 ;; The suffix is what comes after "local variables:" in its line.
1107 (skip-chars-forward " \t")
1108 (or (eolp)
1109 (setq suffix (buffer-substring (point)
1110 (progn (end-of-line) (point)))))
1111 (goto-char (match-beginning 0))
1112 (or (bolp)
1113 (setq prefix
1114 (buffer-substring (point)
1115 (progn (beginning-of-line) (point)))))
1116
1117 (if prefix (setq prefixlen (length prefix)
1118 prefix (regexp-quote prefix)))
1119 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1120 (while continue
1121 ;; Look at next local variable spec.
1122 (if selective-display (re-search-forward "[\n\C-m]")
1123 (forward-line 1))
1124 ;; Skip the prefix, if any.
1125 (if prefix
1126 (if (looking-at prefix)
1127 (forward-char prefixlen)
1128 (error "Local variables entry is missing the prefix")))
1129 ;; Find the variable name; strip whitespace.
1130 (skip-chars-forward " \t")
1131 (setq beg (point))
1132 (skip-chars-forward "^:\n")
1133 (if (eolp) (error "Missing colon in local variables entry"))
1134 (skip-chars-backward " \t")
1135 (let* ((str (buffer-substring beg (point)))
1136 (var (read str))
1137 val)
1138 ;; Setting variable named "end" means end of list.
1139 (if (string-equal (downcase str) "end")
1140 (setq continue nil)
1141 ;; Otherwise read the variable value.
1142 (skip-chars-forward "^:")
1143 (forward-char 1)
1144 (setq val (read (current-buffer)))
1145 (skip-chars-backward "\n")
1146 (skip-chars-forward " \t")
1147 (or (if suffix (looking-at suffix) (eolp))
1148 (error "Local variables entry is terminated incorrectly"))
1149 ;; Set the variable. "Variables" mode and eval are funny.
1150 (hack-one-local-variable var val))))))))
1151
1152 (defconst ignored-local-variables
1153 '(enable-local-eval)
1154 "Variables to be ignored in a file's local variable spec.")
1155
1156 ;; Get confirmation before setting these variables as locals in a file.
1157 (put 'debugger 'risky-local-variable t)
1158 (put 'enable-local-eval 'risky-local-variable t)
1159 (put 'eval 'risky-local-variable t)
1160 (put 'file-name-handler-alist 'risky-local-variable t)
1161 (put 'minor-mode-map-alist 'risky-local-variable t)
1162 (put 'after-load-alist 'risky-local-variable t)
1163 (put 'buffer-file-name 'risky-local-variable t)
1164 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1165 (put 'buffer-file-truename 'risky-local-variable t)
1166 (put 'exec-path 'risky-local-variable t)
1167 (put 'load-path 'risky-local-variable t)
1168 (put 'exec-directory 'risky-local-variable t)
1169 (put 'process-environment 'risky-local-variable t)
1170 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1171 (put 'outline-level 'risky-local-variable t)
1172 (put 'rmail-output-file-alist 'risky-local-variable t)
1173
1174 ;; This one is safe because the user gets to check it before it is used.
1175 (put 'compile-command 'safe-local-variable t)
1176
1177 (defun hack-one-local-variable-quotep (exp)
1178 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1179
1180 ;; "Set" one variable in a local variables spec.
1181 ;; A few variable names are treated specially.
1182 (defun hack-one-local-variable (var val)
1183 (cond ((eq var 'mode)
1184 (funcall (intern (concat (downcase (symbol-name val))
1185 "-mode"))))
1186 ((memq var ignored-local-variables)
1187 nil)
1188 ;; "Setting" eval means either eval it or do nothing.
1189 ;; Likewise for setting hook variables.
1190 ((or (get var 'risky-local-variable)
1191 (and
1192 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1193 (symbol-name var))
1194 (not (get var 'safe-local-variable))))
1195 ;; Permit evaling a put of a harmless property
1196 ;; if the args do nothing tricky.
1197 (if (or (and (eq var 'eval)
1198 (consp val)
1199 (eq (car val) 'put)
1200 (hack-one-local-variable-quotep (nth 1 val))
1201 (hack-one-local-variable-quotep (nth 2 val))
1202 ;; Only allow safe values of lisp-indent-hook;
1203 ;; not functions.
1204 (or (numberp (nth 3 val))
1205 (equal (nth 3 val) ''defun))
1206 (memq (nth 1 (nth 2 val))
1207 '(lisp-indent-hook)))
1208 ;; Permit eval if not root and user says ok.
1209 (and (not (zerop (user-uid)))
1210 (or (eq enable-local-eval t)
1211 (and enable-local-eval
1212 (save-window-excursion
1213 (switch-to-buffer (current-buffer))
1214 (save-excursion
1215 (beginning-of-line)
1216 (set-window-start (selected-window) (point)))
1217 (setq enable-local-eval
1218 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1219 (file-name-nondirectory buffer-file-name)))))))))
1220 (if (eq var 'eval)
1221 (save-excursion (eval val))
1222 (make-local-variable var)
1223 (set var val))
1224 (message "Ignoring `eval:' in file's local variables")))
1225 ;; Ordinary variable, really set it.
1226 (t (make-local-variable var)
1227 (set var val))))
1228
1229 \f
1230 (defun set-visited-file-name (filename)
1231 "Change name of file visited in current buffer to FILENAME.
1232 The next time the buffer is saved it will go in the newly specified file.
1233 nil or empty string as argument means make buffer not be visiting any file.
1234 Remember to delete the initial contents of the minibuffer
1235 if you wish to pass an empty string as the argument."
1236 (interactive "FSet visited file name: ")
1237 (let (truename)
1238 (if filename
1239 (setq filename
1240 (if (string-equal filename "")
1241 nil
1242 (expand-file-name filename))))
1243 (if filename
1244 (progn
1245 (setq truename (file-truename filename))
1246 (if find-file-visit-truename
1247 ;; Do not use the abbreviated filename, because
1248 ;; write-region will reset it to the expanded filename
1249 (setq filename truename))))
1250 (or (equal filename buffer-file-name)
1251 (progn
1252 (and filename (lock-buffer filename))
1253 (unlock-buffer)))
1254 (setq buffer-file-name filename)
1255 (if filename ; make buffer name reflect filename.
1256 (let ((new-name (file-name-nondirectory buffer-file-name)))
1257 (if (string= new-name "")
1258 (error "Empty file name"))
1259 (if (eq system-type 'vax-vms)
1260 (setq new-name (downcase new-name)))
1261 (setq default-directory (file-name-directory buffer-file-name))
1262 (or (string= new-name (buffer-name))
1263 (rename-buffer new-name t))))
1264 (setq buffer-backed-up nil)
1265 (clear-visited-file-modtime)
1266 (if truename
1267 (setq buffer-file-truename (abbreviate-file-name truename)))
1268 (setq buffer-file-number
1269 (if filename
1270 (nth 10 (file-attributes buffer-file-name))
1271 nil)))
1272 ;; write-file-hooks is normally used for things like ftp-find-file
1273 ;; that visit things that are not local files as if they were files.
1274 ;; Changing to visit an ordinary local file instead should flush the hook.
1275 (kill-local-variable 'write-file-hooks)
1276 (kill-local-variable 'local-write-file-hooks)
1277 (kill-local-variable 'revert-buffer-function)
1278 (kill-local-variable 'backup-inhibited)
1279 ;; If buffer was read-only because of version control,
1280 ;; that reason is gone now, so make it writable.
1281 (if vc-mode
1282 (setq buffer-read-only nil))
1283 (kill-local-variable 'vc-mode)
1284 ;; Turn off backup files for certain file names.
1285 ;; Since this is a permanent local, the major mode won't eliminate it.
1286 (and (not (funcall backup-enable-predicate buffer-file-name))
1287 (progn
1288 (make-local-variable 'backup-inhibited)
1289 (setq backup-inhibited t)))
1290 (let ((oauto buffer-auto-save-file-name))
1291 ;; If auto-save was not already on, turn it on if appropriate.
1292 (if (not buffer-auto-save-file-name)
1293 (and buffer-file-name auto-save-default
1294 (auto-save-mode t))
1295 ;; If auto save is on, start using a new name.
1296 ;; We deliberately don't rename or delete the old auto save
1297 ;; for the old visited file name. This is because perhaps
1298 ;; the user wants to save the new state and then compare with the
1299 ;; previous state from the auto save file.
1300 (setq buffer-auto-save-file-name
1301 (make-auto-save-file-name)))
1302 ;; Rename the old auto save file if any.
1303 (and oauto buffer-auto-save-file-name
1304 (file-exists-p oauto)
1305 (rename-file oauto buffer-auto-save-file-name t)))
1306 (if buffer-file-name
1307 (set-buffer-modified-p t)))
1308
1309 (defun write-file (filename)
1310 "Write current buffer into file FILENAME.
1311 Makes buffer visit that file, and marks it not modified.
1312 If the buffer is already visiting a file, you can specify
1313 a directory name as FILENAME, to write a file of the same
1314 old name in that directory."
1315 ;; (interactive "FWrite file: ")
1316 (interactive
1317 (list (if buffer-file-name
1318 (read-file-name "Write file: "
1319 nil nil nil nil)
1320 (read-file-name "Write file: "
1321 (cdr (assq 'default-directory
1322 (buffer-local-variables)))
1323 nil nil (buffer-name)))))
1324 (or (null filename) (string-equal filename "")
1325 (progn
1326 ;; If arg is just a directory,
1327 ;; use same file name, but in that directory.
1328 (if (and (file-directory-p filename) buffer-file-name)
1329 (setq filename (concat (file-name-as-directory filename)
1330 (file-name-nondirectory buffer-file-name))))
1331 (set-visited-file-name filename)))
1332 (set-buffer-modified-p t)
1333 (save-buffer))
1334 \f
1335 (defun backup-buffer ()
1336 "Make a backup of the disk file visited by the current buffer, if appropriate.
1337 This is normally done before saving the buffer the first time.
1338 If the value is non-nil, it is the result of `file-modes' on the original
1339 file; this means that the caller, after saving the buffer, should change
1340 the modes of the new file to agree with the old modes."
1341 (if (and make-backup-files (not backup-inhibited)
1342 (not buffer-backed-up)
1343 (file-exists-p buffer-file-name)
1344 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1345 '(?- ?l)))
1346 (let ((real-file-name buffer-file-name)
1347 backup-info backupname targets setmodes)
1348 ;; If specified name is a symbolic link, chase it to the target.
1349 ;; Thus we make the backups in the directory where the real file is.
1350 (setq real-file-name (file-chase-links real-file-name))
1351 (setq backup-info (find-backup-file-name real-file-name)
1352 backupname (car backup-info)
1353 targets (cdr backup-info))
1354 ;;; (if (file-directory-p buffer-file-name)
1355 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1356 (condition-case ()
1357 (let ((delete-old-versions
1358 ;; If have old versions to maybe delete,
1359 ;; ask the user to confirm now, before doing anything.
1360 ;; But don't actually delete til later.
1361 (and targets
1362 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1363 (or delete-old-versions
1364 (y-or-n-p (format "Delete excess backup versions of %s? "
1365 real-file-name))))))
1366 ;; Actually write the back up file.
1367 (condition-case ()
1368 (if (or file-precious-flag
1369 ; (file-symlink-p buffer-file-name)
1370 backup-by-copying
1371 (and backup-by-copying-when-linked
1372 (> (file-nlinks real-file-name) 1))
1373 (and backup-by-copying-when-mismatch
1374 (let ((attr (file-attributes real-file-name)))
1375 (or (nth 9 attr)
1376 (not (file-ownership-preserved-p real-file-name))))))
1377 (condition-case ()
1378 (copy-file real-file-name backupname t t)
1379 (file-error
1380 ;; If copying fails because file BACKUPNAME
1381 ;; is not writable, delete that file and try again.
1382 (if (and (file-exists-p backupname)
1383 (not (file-writable-p backupname)))
1384 (delete-file backupname))
1385 (copy-file real-file-name backupname t t)))
1386 ;; rename-file should delete old backup.
1387 (rename-file real-file-name backupname t)
1388 (setq setmodes (file-modes backupname)))
1389 (file-error
1390 ;; If trouble writing the backup, write it in ~.
1391 (setq backupname (expand-file-name "~/%backup%~"))
1392 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1393 (sleep-for 1)
1394 (condition-case ()
1395 (copy-file real-file-name backupname t t)
1396 (file-error
1397 ;; If copying fails because file BACKUPNAME
1398 ;; is not writable, delete that file and try again.
1399 (if (and (file-exists-p backupname)
1400 (not (file-writable-p backupname)))
1401 (delete-file backupname))
1402 (copy-file real-file-name backupname t t)))))
1403 (setq buffer-backed-up t)
1404 ;; Now delete the old versions, if desired.
1405 (if delete-old-versions
1406 (while targets
1407 (condition-case ()
1408 (delete-file (car targets))
1409 (file-error nil))
1410 (setq targets (cdr targets))))
1411 setmodes)
1412 (file-error nil)))))
1413
1414 (defun file-name-sans-versions (name &optional keep-backup-version)
1415 "Return FILENAME sans backup versions or strings.
1416 This is a separate procedure so your site-init or startup file can
1417 redefine it.
1418 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1419 we do not remove backup version numbers, only true file version numbers."
1420 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1421 (if handler
1422 (funcall handler 'file-name-sans-versions name keep-backup-version)
1423 (substring name 0
1424 (if (eq system-type 'vax-vms)
1425 ;; VMS version number is (a) semicolon, optional
1426 ;; sign, zero or more digits or (b) period, option
1427 ;; sign, zero or more digits, provided this is the
1428 ;; second period encountered outside of the
1429 ;; device/directory part of the file name.
1430 (or (string-match ";[-+]?[0-9]*\\'" name)
1431 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
1432 name)
1433 (match-beginning 1))
1434 (length name))
1435 (if keep-backup-version
1436 (length name)
1437 (or (string-match "\\.~[0-9]+~\\'" name)
1438 (string-match "~\\'" name)
1439 (length name))))))))
1440
1441 (defun file-ownership-preserved-p (file)
1442 "Returns t if deleting FILE and rewriting it would preserve the owner."
1443 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1444 (if handler
1445 (funcall handler 'file-ownership-preserved-p file)
1446 (= (nth 2 (file-attributes file)) (user-uid)))))
1447
1448 (defun file-name-sans-extension (filename)
1449 "Return FILENAME sans final \"extension\".
1450 The extension, in a file name, is the part that follows the last `.'."
1451 (save-match-data
1452 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1453 directory)
1454 (if (string-match "\\.[^.]*\\'" file)
1455 (if (setq directory (file-name-directory filename))
1456 (expand-file-name (substring file 0 (match-beginning 0))
1457 directory)
1458 (substring file 0 (match-beginning 0)))
1459 filename))))
1460
1461 (defun make-backup-file-name (file)
1462 "Create the non-numeric backup file name for FILE.
1463 This is a separate function so you can redefine it for customization."
1464 (if (eq system-type 'ms-dos)
1465 (let ((fn (file-name-nondirectory file)))
1466 (concat (file-name-directory file)
1467 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
1468 (substring fn 0 (match-end 1)))
1469 ".bak"))
1470 (concat file "~")))
1471
1472 (defun backup-file-name-p (file)
1473 "Return non-nil if FILE is a backup file name (numeric or not).
1474 This is a separate function so you can redefine it for customization.
1475 You may need to redefine `file-name-sans-versions' as well."
1476 (if (eq system-type 'ms-dos)
1477 (string-match "\\.bak$" file)
1478 (string-match "~$" file)))
1479
1480 ;; This is used in various files.
1481 ;; The usage of bv-length is not very clean,
1482 ;; but I can't see a good alternative,
1483 ;; so as of now I am leaving it alone.
1484 (defun backup-extract-version (fn)
1485 "Given the name of a numeric backup file, return the backup number.
1486 Uses the free variable `bv-length', whose value should be
1487 the index in the name where the version number begins."
1488 (if (and (string-match "[0-9]+~$" fn bv-length)
1489 (= (match-beginning 0) bv-length))
1490 (string-to-int (substring fn bv-length -1))
1491 0))
1492
1493 ;; I believe there is no need to alter this behavior for VMS;
1494 ;; since backup files are not made on VMS, it should not get called.
1495 (defun find-backup-file-name (fn)
1496 "Find a file name for a backup file, and suggestions for deletions.
1497 Value is a list whose car is the name for the backup file
1498 and whose cdr is a list of old versions to consider deleting now."
1499 (if (eq version-control 'never)
1500 (list (make-backup-file-name fn))
1501 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1502 (bv-length (length base-versions))
1503 possibilities
1504 (versions nil)
1505 (high-water-mark 0)
1506 (deserve-versions-p nil)
1507 (number-to-delete 0))
1508 (condition-case ()
1509 (setq possibilities (file-name-all-completions
1510 base-versions
1511 (file-name-directory fn))
1512 versions (sort (mapcar
1513 (function backup-extract-version)
1514 possibilities)
1515 '<)
1516 high-water-mark (apply 'max 0 versions)
1517 deserve-versions-p (or version-control
1518 (> high-water-mark 0))
1519 number-to-delete (- (length versions)
1520 kept-old-versions kept-new-versions -1))
1521 (file-error
1522 (setq possibilities nil)))
1523 (if (not deserve-versions-p)
1524 (list (make-backup-file-name fn))
1525 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1526 (if (and (> number-to-delete 0)
1527 ;; Delete nothing if there is overflow
1528 ;; in the number of versions to keep.
1529 (>= (+ kept-new-versions kept-old-versions -1) 0))
1530 (mapcar (function (lambda (n)
1531 (concat fn ".~" (int-to-string n) "~")))
1532 (let ((v (nthcdr kept-old-versions versions)))
1533 (rplacd (nthcdr (1- number-to-delete) v) ())
1534 v))))))))
1535
1536 (defun file-nlinks (filename)
1537 "Return number of names file FILENAME has."
1538 (car (cdr (file-attributes filename))))
1539
1540 (defun file-relative-name (filename &optional directory)
1541 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1542 (setq filename (expand-file-name filename)
1543 directory (file-name-as-directory (expand-file-name
1544 (or directory default-directory))))
1545 (let ((ancestor ""))
1546 (while (not (string-match (concat "^" (regexp-quote directory)) filename))
1547 (setq directory (file-name-directory (substring directory 0 -1))
1548 ancestor (concat "../" ancestor)))
1549 (concat ancestor (substring filename (match-end 0)))))
1550 \f
1551 (defun save-buffer (&optional args)
1552 "Save current buffer in visited file if modified. Versions described below.
1553 By default, makes the previous version into a backup file
1554 if previously requested or if this is the first save.
1555 With 1 or 3 \\[universal-argument]'s, marks this version
1556 to become a backup when the next save is done.
1557 With 2 or 3 \\[universal-argument]'s,
1558 unconditionally makes the previous version into a backup file.
1559 With argument of 0, never makes the previous version into a backup file.
1560
1561 If a file's name is FOO, the names of its numbered backup versions are
1562 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1563 Numeric backups (rather than FOO~) will be made if value of
1564 `version-control' is not the atom `never' and either there are already
1565 numeric versions of the file being backed up, or `version-control' is
1566 non-nil.
1567 We don't want excessive versions piling up, so there are variables
1568 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1569 and `kept-new-versions', which tells how many newest versions to keep.
1570 Defaults are 2 old versions and 2 new.
1571 `dired-kept-versions' controls dired's clean-directory (.) command.
1572 If `delete-old-versions' is nil, system will query user
1573 before trimming versions. Otherwise it does it silently."
1574 (interactive "p")
1575 (let ((modp (buffer-modified-p))
1576 (large (> (buffer-size) 50000))
1577 (make-backup-files (or (and make-backup-files (not (eq args 0)))
1578 (memq args '(16 64)))))
1579 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1580 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1581 (basic-save-buffer)
1582 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1583
1584 (defun delete-auto-save-file-if-necessary (&optional force)
1585 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1586 Normally delete only if the file was written by this Emacs since
1587 the last real save, but optional arg FORCE non-nil means delete anyway."
1588 (and buffer-auto-save-file-name delete-auto-save-files
1589 (not (string= buffer-file-name buffer-auto-save-file-name))
1590 (or force (recent-auto-save-p))
1591 (progn
1592 (condition-case ()
1593 (delete-file buffer-auto-save-file-name)
1594 (file-error nil))
1595 (set-buffer-auto-saved))))
1596
1597 (defun basic-save-buffer ()
1598 "Save the current buffer in its visited file, if it has been modified."
1599 (interactive)
1600 (if (buffer-modified-p)
1601 (let ((recent-save (recent-auto-save-p))
1602 setmodes tempsetmodes)
1603 ;; On VMS, rename file and buffer to get rid of version number.
1604 (if (and (eq system-type 'vax-vms)
1605 (not (string= buffer-file-name
1606 (file-name-sans-versions buffer-file-name))))
1607 (let (buffer-new-name)
1608 ;; Strip VMS version number before save.
1609 (setq buffer-file-name
1610 (file-name-sans-versions buffer-file-name))
1611 ;; Construct a (unique) buffer name to correspond.
1612 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1613 (setq buffer-new-name (buffer-name buf))
1614 (kill-buffer buf))
1615 (rename-buffer buffer-new-name)))
1616 ;; If buffer has no file name, ask user for one.
1617 (or buffer-file-name
1618 (set-visited-file-name
1619 (expand-file-name (read-file-name "File to save in: ") nil)))
1620 (or (verify-visited-file-modtime (current-buffer))
1621 (not (file-exists-p buffer-file-name))
1622 (yes-or-no-p
1623 (format "%s has changed since visited or saved. Save anyway? "
1624 (file-name-nondirectory buffer-file-name)))
1625 (error "Save not confirmed"))
1626 (save-restriction
1627 (widen)
1628 (and (> (point-max) 1)
1629 (/= (char-after (1- (point-max))) ?\n)
1630 (not (and (eq selective-display t)
1631 (= (char-after (1- (point-max))) ?\r)))
1632 (or (eq require-final-newline t)
1633 (and require-final-newline
1634 (y-or-n-p
1635 (format "Buffer %s does not end in newline. Add one? "
1636 (buffer-name)))))
1637 (save-excursion
1638 (goto-char (point-max))
1639 (insert ?\n)))
1640 (or (run-hook-with-args-until-success 'write-contents-hooks)
1641 (run-hook-with-args-until-success 'local-write-file-hooks)
1642 (run-hook-with-args-until-success 'write-file-hooks)
1643 ;; If a hook returned t, file is already "written".
1644 ;; Otherwise, write it the usual way now.
1645 (setq setmodes (basic-save-buffer-1)))
1646 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
1647 (if setmodes
1648 (condition-case ()
1649 (set-file-modes buffer-file-name setmodes)
1650 (error nil))))
1651 ;; If the auto-save file was recent before this command,
1652 ;; delete it now.
1653 (delete-auto-save-file-if-necessary recent-save)
1654 (run-hooks 'after-save-hook))
1655 (message "(No changes need to be saved)")))
1656
1657 ;; This does the "real job" of writing a buffer into its visited file
1658 ;; and making a backup file. This is what is normally done
1659 ;; but inhibited if one of write-file-hooks returns non-nil.
1660 ;; It returns a value to store in setmodes.
1661 (defun basic-save-buffer-1 ()
1662 (let (tempsetmodes setmodes)
1663 (if (not (file-writable-p buffer-file-name))
1664 (let ((dir (file-name-directory buffer-file-name)))
1665 (if (not (file-directory-p dir))
1666 (error "%s is not a directory" dir)
1667 (if (not (file-exists-p buffer-file-name))
1668 (error "Directory %s write-protected" dir)
1669 (if (yes-or-no-p
1670 (format "File %s is write-protected; try to save anyway? "
1671 (file-name-nondirectory
1672 buffer-file-name)))
1673 (setq tempsetmodes t)
1674 (error "Attempt to save to a file which you aren't allowed to write"))))))
1675 (or buffer-backed-up
1676 (setq setmodes (backup-buffer)))
1677 (let ((dir (file-name-directory buffer-file-name)))
1678 (if (and file-precious-flag
1679 (file-writable-p dir))
1680 ;; If file is precious, write temp name, then rename it.
1681 ;; This requires write access to the containing dir,
1682 ;; which is why we don't try it if we don't have that access.
1683 (let ((realname buffer-file-name)
1684 tempname temp nogood i succeed
1685 (old-modtime (visited-file-modtime)))
1686 (setq i 0)
1687 (setq nogood t)
1688 ;; Find the temporary name to write under.
1689 (while nogood
1690 (setq tempname (format "%s#tmp#%d" dir i))
1691 (setq nogood (file-exists-p tempname))
1692 (setq i (1+ i)))
1693 (unwind-protect
1694 (progn (clear-visited-file-modtime)
1695 (write-region (point-min) (point-max)
1696 tempname nil realname)
1697 (setq succeed t))
1698 ;; If writing the temp file fails,
1699 ;; delete the temp file.
1700 (or succeed
1701 (progn
1702 (delete-file tempname)
1703 (set-visited-file-modtime old-modtime))))
1704 ;; Since we have created an entirely new file
1705 ;; and renamed it, make sure it gets the
1706 ;; right permission bits set.
1707 (setq setmodes (file-modes buffer-file-name))
1708 ;; We succeeded in writing the temp file,
1709 ;; so rename it.
1710 (rename-file tempname buffer-file-name t))
1711 ;; If file not writable, see if we can make it writable
1712 ;; temporarily while we write it.
1713 ;; But no need to do so if we have just backed it up
1714 ;; (setmodes is set) because that says we're superseding.
1715 (cond ((and tempsetmodes (not setmodes))
1716 ;; Change the mode back, after writing.
1717 (setq setmodes (file-modes buffer-file-name))
1718 (set-file-modes buffer-file-name 511)))
1719 (write-region (point-min) (point-max)
1720 buffer-file-name nil t)))
1721 setmodes))
1722
1723 (defun save-some-buffers (&optional arg exiting)
1724 "Save some modified file-visiting buffers. Asks user about each one.
1725 Optional argument (the prefix) non-nil means save all with no questions.
1726 Optional second argument EXITING means ask about certain non-file buffers
1727 as well as about file buffers."
1728 (interactive "P")
1729 (save-window-excursion
1730 (let ((files-done
1731 (map-y-or-n-p
1732 (function
1733 (lambda (buffer)
1734 (and (buffer-modified-p buffer)
1735 (or
1736 (buffer-file-name buffer)
1737 (and exiting
1738 (progn
1739 (set-buffer buffer)
1740 (and buffer-offer-save (> (buffer-size) 0)))))
1741 (if arg
1742 t
1743 (if (buffer-file-name buffer)
1744 (format "Save file %s? "
1745 (buffer-file-name buffer))
1746 (format "Save buffer %s? "
1747 (buffer-name buffer)))))))
1748 (function
1749 (lambda (buffer)
1750 (set-buffer buffer)
1751 (save-buffer)))
1752 (buffer-list)
1753 '("buffer" "buffers" "save")
1754 (list (list ?\C-r (lambda (buf)
1755 (view-buffer buf)
1756 (setq view-exit-action
1757 '(lambda (ignore)
1758 (exit-recursive-edit)))
1759 (recursive-edit)
1760 ;; Return nil to ask about BUF again.
1761 nil)
1762 "display the current buffer"))))
1763 (abbrevs-done
1764 (and save-abbrevs abbrevs-changed
1765 (progn
1766 (if (or arg
1767 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
1768 (write-abbrev-file nil))
1769 ;; Don't keep bothering user if he says no.
1770 (setq abbrevs-changed nil)
1771 t))))
1772 (or (> files-done 0) abbrevs-done
1773 (message "(No files need saving)")))))
1774 \f
1775 (defun not-modified (&optional arg)
1776 "Mark current buffer as unmodified, not needing to be saved.
1777 With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1778 (interactive "P")
1779 (message (if arg "Modification-flag set"
1780 "Modification-flag cleared"))
1781 (set-buffer-modified-p arg))
1782
1783 (defun toggle-read-only (&optional arg)
1784 "Change whether this buffer is visiting its file read-only.
1785 With arg, set read-only iff arg is positive."
1786 (interactive "P")
1787 (setq buffer-read-only
1788 (if (null arg)
1789 (not buffer-read-only)
1790 (> (prefix-numeric-value arg) 0)))
1791 ;; Force mode-line redisplay
1792 (set-buffer-modified-p (buffer-modified-p)))
1793
1794 (defun insert-file (filename)
1795 "Insert contents of file FILENAME into buffer after point.
1796 Set mark after the inserted text.
1797
1798 This function is meant for the user to run interactively.
1799 Don't call it from programs! Use `insert-file-contents' instead.
1800 \(Its calling sequence is different; see its documentation)."
1801 (interactive "*fInsert file: ")
1802 (if (file-directory-p filename)
1803 (signal 'file-error (list "Opening input file" "file is a directory"
1804 filename)))
1805 (let ((tem (insert-file-contents filename)))
1806 (push-mark (+ (point) (car (cdr tem))))))
1807
1808 (defun append-to-file (start end filename)
1809 "Append the contents of the region to the end of file FILENAME.
1810 When called from a function, expects three arguments,
1811 START, END and FILENAME. START and END are buffer positions
1812 saying what text to write."
1813 (interactive "r\nFAppend to file: ")
1814 (write-region start end filename t))
1815
1816 (defun file-newest-backup (filename)
1817 "Return most recent backup file for FILENAME or nil if no backups exist."
1818 (let* ((filename (expand-file-name filename))
1819 (file (file-name-nondirectory filename))
1820 (dir (file-name-directory filename))
1821 (comp (file-name-all-completions file dir))
1822 newest)
1823 (while comp
1824 (setq file (concat dir (car comp))
1825 comp (cdr comp))
1826 (if (and (backup-file-name-p file)
1827 (or (null newest) (file-newer-than-file-p file newest)))
1828 (setq newest file)))
1829 newest))
1830
1831 (defun rename-uniquely ()
1832 "Rename current buffer to a similar name not already taken.
1833 This function is useful for creating multiple shell process buffers
1834 or multiple mail buffers, etc."
1835 (interactive)
1836 (let* ((new-buf (generate-new-buffer (buffer-name)))
1837 (name (buffer-name new-buf)))
1838 (kill-buffer new-buf)
1839 (rename-buffer name)
1840 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
1841
1842 (defun make-directory (dir &optional parents)
1843 "Create the directory DIR and any nonexistent parent dirs.
1844 Interactively, the default choice of directory to create
1845 is the current default directory for file names.
1846 That is useful when you have visited a file in a nonexistint directory.
1847
1848 Noninteractively, the second (optional) argument PARENTS says whether
1849 to create parent directories if they don't exist."
1850 (interactive
1851 (list (read-file-name "Make directory: " default-directory default-directory
1852 nil nil)
1853 t))
1854 (let ((handler (find-file-name-handler dir 'make-directory)))
1855 (if handler
1856 (funcall handler 'make-directory dir parents)
1857 (if (not parents)
1858 (make-directory-internal dir)
1859 (let ((dir (directory-file-name (expand-file-name dir)))
1860 create-list)
1861 (while (not (file-exists-p dir))
1862 (setq create-list (cons dir create-list)
1863 dir (directory-file-name (file-name-directory dir))))
1864 (while create-list
1865 (make-directory-internal (car create-list))
1866 (setq create-list (cdr create-list))))))))
1867 \f
1868 (put 'revert-buffer-function 'permanent-local t)
1869 (defvar revert-buffer-function nil
1870 "Function to use to revert this buffer, or nil to do the default.
1871 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
1872 which are the arguments that `revert-buffer' received.")
1873
1874 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1875 (defvar revert-buffer-insert-file-contents-function nil
1876 "Function to use to insert contents when reverting this buffer.
1877 Gets two args, first the nominal file name to use,
1878 and second, t if reading the auto-save file.")
1879
1880 (defun revert-buffer (&optional ignore-auto noconfirm)
1881 "Replace the buffer text with the text of the visited file on disk.
1882 This undoes all changes since the file was visited or saved.
1883 With a prefix argument, offer to revert from latest auto-save file, if
1884 that is more recent than the visited file.
1885
1886 When called from lisp, The first argument is IGNORE-AUTO; only offer
1887 to revert from the auto-save file when this is nil. Note that the
1888 sense of this argument is the reverse of the prefix argument, for the
1889 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
1890 to nil.
1891
1892 Optional second argument NOCONFIRM means don't ask for confirmation at
1893 all.
1894
1895 If the value of `revert-buffer-function' is non-nil, it is called to
1896 do the work.
1897
1898 The default revert function runs the hook `before-revert-hook' at the
1899 beginning and `after-revert-hook' at the end."
1900 ;; I admit it's odd to reverse the sense of the prefix argument, but
1901 ;; there is a lot of code out there which assumes that the first
1902 ;; argument should be t to avoid consulting the auto-save file, and
1903 ;; there's no straightforward way to encourage authors to notice a
1904 ;; reversal of the argument sense. So I'm just changing the user
1905 ;; interface, but leaving the programmatic interface the same.
1906 (interactive (list (not prefix-arg)))
1907 (if revert-buffer-function
1908 (funcall revert-buffer-function ignore-auto noconfirm)
1909 (let* ((opoint (point))
1910 (auto-save-p (and (not ignore-auto)
1911 (recent-auto-save-p)
1912 buffer-auto-save-file-name
1913 (file-readable-p buffer-auto-save-file-name)
1914 (y-or-n-p
1915 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1916 (file-name (if auto-save-p
1917 buffer-auto-save-file-name
1918 buffer-file-name)))
1919 (cond ((null file-name)
1920 (error "Buffer does not seem to be associated with any file"))
1921 ((or noconfirm
1922 (yes-or-no-p (format "Revert buffer from file %s? "
1923 file-name)))
1924 (run-hooks 'before-revert-hook)
1925 ;; If file was backed up but has changed since,
1926 ;; we shd make another backup.
1927 (and (not auto-save-p)
1928 (not (verify-visited-file-modtime (current-buffer)))
1929 (setq buffer-backed-up nil))
1930 ;; Get rid of all undo records for this buffer.
1931 (or (eq buffer-undo-list t)
1932 (setq buffer-undo-list nil))
1933 (let ((buffer-read-only nil)
1934 ;; Don't make undo records for the reversion.
1935 (buffer-undo-list t))
1936 (if revert-buffer-insert-file-contents-function
1937 (funcall revert-buffer-insert-file-contents-function
1938 file-name auto-save-p)
1939 (if (not (file-exists-p file-name))
1940 (error "File %s no longer exists!" file-name))
1941 ;; Bind buffer-file-name to nil
1942 ;; so that we don't try to lock the file.
1943 (let ((buffer-file-name nil))
1944 (or auto-save-p
1945 (unlock-buffer)))
1946 (widen)
1947 (insert-file-contents file-name (not auto-save-p)
1948 nil nil t)))
1949 (goto-char (min opoint (point-max)))
1950 (after-find-file nil nil t t)
1951 (run-hooks 'after-revert-hook)
1952 t)))))
1953
1954 (defun recover-file (file)
1955 "Visit file FILE, but get contents from its last auto-save file."
1956 (interactive
1957 (let ((prompt-file buffer-file-name)
1958 (file-name nil)
1959 (file-dir nil))
1960 (and prompt-file
1961 (setq file-name (file-name-nondirectory prompt-file)
1962 file-dir (file-name-directory prompt-file)))
1963 (list (read-file-name "Recover file: "
1964 file-dir nil nil file-name))))
1965 (setq file (expand-file-name file))
1966 (if (auto-save-file-name-p (file-name-nondirectory file))
1967 (error "%s is an auto-save file" file))
1968 (let ((file-name (let ((buffer-file-name file))
1969 (make-auto-save-file-name))))
1970 (cond ((not (file-newer-than-file-p file-name file))
1971 (error "Auto-save file %s not current" file-name))
1972 ((save-window-excursion
1973 (if (not (eq system-type 'vax-vms))
1974 (with-output-to-temp-buffer "*Directory*"
1975 (buffer-disable-undo standard-output)
1976 (call-process "ls" nil standard-output nil
1977 (if (file-symlink-p file) "-lL" "-l")
1978 file file-name)))
1979 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1980 (switch-to-buffer (find-file-noselect file t))
1981 (let ((buffer-read-only nil))
1982 (erase-buffer)
1983 (insert-file-contents file-name nil))
1984 (after-find-file nil nil t))
1985 (t (error "Recover-file cancelled.")))))
1986
1987 (defun kill-some-buffers ()
1988 "For each buffer, ask whether to kill it."
1989 (interactive)
1990 (let ((list (buffer-list)))
1991 (while list
1992 (let* ((buffer (car list))
1993 (name (buffer-name buffer)))
1994 (and (not (string-equal name ""))
1995 (/= (aref name 0) ? )
1996 (yes-or-no-p
1997 (format "Buffer %s %s. Kill? "
1998 name
1999 (if (buffer-modified-p buffer)
2000 "HAS BEEN EDITED" "is unmodified")))
2001 (kill-buffer buffer)))
2002 (setq list (cdr list)))))
2003 \f
2004 (defun auto-save-mode (arg)
2005 "Toggle auto-saving of contents of current buffer.
2006 With prefix argument ARG, turn auto-saving on if positive, else off."
2007 (interactive "P")
2008 (setq buffer-auto-save-file-name
2009 (and (if (null arg)
2010 (or (not buffer-auto-save-file-name)
2011 ;; If autosave is off because buffer has shrunk,
2012 ;; then toggling should turn it on.
2013 (< buffer-saved-size 0))
2014 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2015 (if (and buffer-file-name auto-save-visited-file-name
2016 (not buffer-read-only))
2017 buffer-file-name
2018 (make-auto-save-file-name))))
2019 ;; If -1 was stored here, to temporarily turn off saving,
2020 ;; turn it back on.
2021 (and (< buffer-saved-size 0)
2022 (setq buffer-saved-size 0))
2023 (if (interactive-p)
2024 (message "Auto-save %s (in this buffer)"
2025 (if buffer-auto-save-file-name "on" "off")))
2026 buffer-auto-save-file-name)
2027
2028 (defun rename-auto-save-file ()
2029 "Adjust current buffer's auto save file name for current conditions.
2030 Also rename any existing auto save file, if it was made in this session."
2031 (let ((osave buffer-auto-save-file-name))
2032 (setq buffer-auto-save-file-name
2033 (make-auto-save-file-name))
2034 (if (and osave buffer-auto-save-file-name
2035 (not (string= buffer-auto-save-file-name buffer-file-name))
2036 (not (string= buffer-auto-save-file-name osave))
2037 (file-exists-p osave)
2038 (recent-auto-save-p))
2039 (rename-file osave buffer-auto-save-file-name t))))
2040
2041 (defun make-auto-save-file-name ()
2042 "Return file name to use for auto-saves of current buffer.
2043 Does not consider `auto-save-visited-file-name' as that variable is checked
2044 before calling this function. You can redefine this for customization.
2045 See also `auto-save-file-name-p'."
2046 (if buffer-file-name
2047 (concat (file-name-directory buffer-file-name)
2048 "#"
2049 (file-name-nondirectory buffer-file-name)
2050 "#")
2051
2052 ;; Deal with buffers that don't have any associated files. (Mail
2053 ;; mode tends to create a good number of these.)
2054
2055 (let ((buffer-name (buffer-name))
2056 (limit 0))
2057 ;; Use technique from Sebastian Kremer's auto-save
2058 ;; package to turn slashes into \\!. This ensures that
2059 ;; the auto-save buffer name is unique.
2060
2061 (while (string-match "[/\\]" buffer-name limit)
2062 (setq buffer-name (concat (substring buffer-name 0 (match-beginning 0))
2063 (if (string= (substring buffer-name
2064 (match-beginning 0)
2065 (match-end 0))
2066 "/")
2067 "\\!"
2068 "\\\\")
2069 (substring buffer-name (match-end 0))))
2070 (setq limit (1+ (match-end 0))))
2071
2072 (expand-file-name (format "#%s#%s#" buffer-name (make-temp-name ""))))))
2073
2074 (defun auto-save-file-name-p (filename)
2075 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2076 FILENAME should lack slashes. You can redefine this for customization."
2077 (string-match "^#.*#$" filename))
2078 \f
2079 (defconst list-directory-brief-switches
2080 (if (eq system-type 'vax-vms) "" "-CF")
2081 "*Switches for list-directory to pass to `ls' for brief listing,")
2082
2083 (defconst list-directory-verbose-switches
2084 (if (eq system-type 'vax-vms)
2085 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2086 "-l")
2087 "*Switches for list-directory to pass to `ls' for verbose listing,")
2088
2089 (defun list-directory (dirname &optional verbose)
2090 "Display a list of files in or matching DIRNAME, a la `ls'.
2091 DIRNAME is globbed by the shell if necessary.
2092 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2093 Actions controlled by variables `list-directory-brief-switches'
2094 and `list-directory-verbose-switches'."
2095 (interactive (let ((pfx current-prefix-arg))
2096 (list (read-file-name (if pfx "List directory (verbose): "
2097 "List directory (brief): ")
2098 nil default-directory nil)
2099 pfx)))
2100 (let ((switches (if verbose list-directory-verbose-switches
2101 list-directory-brief-switches)))
2102 (or dirname (setq dirname default-directory))
2103 (setq dirname (expand-file-name dirname))
2104 (with-output-to-temp-buffer "*Directory*"
2105 (buffer-disable-undo standard-output)
2106 (princ "Directory ")
2107 (princ dirname)
2108 (terpri)
2109 (save-excursion
2110 (set-buffer "*Directory*")
2111 (let ((wildcard (not (file-directory-p dirname))))
2112 (insert-directory dirname switches wildcard (not wildcard)))))))
2113
2114 (defvar insert-directory-program "ls"
2115 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2116
2117 ;; insert-directory
2118 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2119 ;; FULL-DIRECTORY-P is nil.
2120 ;; The single line of output must display FILE's name as it was
2121 ;; given, namely, an absolute path name.
2122 ;; - must insert exactly one line for each file if WILDCARD or
2123 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2124 ;; before the file lines, plus optional text after the file lines.
2125 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2126 ;; allowed.
2127 ;; File lines should display the basename.
2128 ;; - must be consistent with
2129 ;; - functions dired-move-to-filename, (these two define what a file line is)
2130 ;; dired-move-to-end-of-filename,
2131 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2132 ;; dired-insert-headerline
2133 ;; dired-after-subdir-garbage (defines what a "total" line is)
2134 ;; - variable dired-subdir-regexp
2135 (defun insert-directory (file switches &optional wildcard full-directory-p)
2136 "Insert directory listing for FILE, formatted according to SWITCHES.
2137 Leaves point after the inserted text.
2138 SWITCHES may be a string of options, or a list of strings.
2139 Optional third arg WILDCARD means treat FILE as shell wildcard.
2140 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2141 switches do not contain `d', so that a full listing is expected.
2142
2143 This works by running a directory listing program
2144 whose name is in the variable `insert-directory-program'.
2145 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2146 ;; We need the directory in order to find the right handler.
2147 (let ((handler (find-file-name-handler (expand-file-name file)
2148 'insert-directory)))
2149 (if handler
2150 (funcall handler 'insert-directory file switches
2151 wildcard full-directory-p)
2152 (if (eq system-type 'vax-vms)
2153 (vms-read-directory file switches (current-buffer))
2154 (if wildcard
2155 ;; Run ls in the directory of the file pattern we asked for.
2156 (let ((default-directory
2157 (if (file-name-absolute-p file)
2158 (file-name-directory file)
2159 (file-name-directory (expand-file-name file))))
2160 (pattern (file-name-nondirectory file))
2161 (beg 0))
2162 ;; Quote some characters that have special meanings in shells;
2163 ;; but don't quote the wildcards--we want them to be special.
2164 ;; We also currently don't quote the quoting characters
2165 ;; in case people want to use them explicitly to quote
2166 ;; wildcard characters.
2167 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
2168 (setq pattern
2169 (concat (substring pattern 0 (match-beginning 0))
2170 "\\"
2171 (substring pattern (match-beginning 0)))
2172 beg (1+ (match-end 0))))
2173 (call-process shell-file-name nil t nil
2174 "-c" (concat insert-directory-program
2175 " -d "
2176 (if (stringp switches)
2177 switches
2178 (mapconcat 'identity switches " "))
2179 " "
2180 pattern)))
2181 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2182 ;; directory if FILE is a symbolic link.
2183 (apply 'call-process
2184 insert-directory-program nil t nil
2185 (let (list)
2186 (if (listp switches)
2187 (setq list switches)
2188 (if (not (equal switches ""))
2189 (progn
2190 ;; Split the switches at any spaces
2191 ;; so we can pass separate options as separate args.
2192 (while (string-match " " switches)
2193 (setq list (cons (substring switches 0 (match-beginning 0))
2194 list)
2195 switches (substring switches (match-end 0))))
2196 (setq list (cons switches list)))))
2197 (append list
2198 (list
2199 (if full-directory-p
2200 (concat (file-name-as-directory file) ".")
2201 file))))))))))
2202
2203 (defvar kill-emacs-query-functions nil
2204 "Functions to call with no arguments to query about killing Emacs.
2205 If any of these functions returns nil, killing Emacs is cancelled.")
2206
2207 (defun save-buffers-kill-emacs (&optional arg)
2208 "Offer to save each buffer, then kill this Emacs process.
2209 With prefix arg, silently save all file-visiting buffers, then kill."
2210 (interactive "P")
2211 (save-some-buffers arg t)
2212 (and (or (not (memq t (mapcar (function
2213 (lambda (buf) (and (buffer-file-name buf)
2214 (buffer-modified-p buf))))
2215 (buffer-list))))
2216 (yes-or-no-p "Modified buffers exist; exit anyway? "))
2217 (or (not (fboundp 'process-list))
2218 ;; process-list is not defined on VMS.
2219 (let ((processes (process-list))
2220 active)
2221 (while processes
2222 (and (memq (process-status (car processes)) '(run stop open))
2223 (let ((val (process-kill-without-query (car processes))))
2224 (process-kill-without-query (car processes) val)
2225 val)
2226 (setq active t))
2227 (setq processes (cdr processes)))
2228 (or (not active)
2229 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
2230 ;; Query the user for other things, perhaps.
2231 (not (run-hook-with-args-until-failure 'kill-emacs-query-functions))
2232 (kill-emacs)))
2233 \f
2234 (define-key ctl-x-map "\C-f" 'find-file)
2235 (define-key ctl-x-map "\C-q" 'toggle-read-only)
2236 (define-key ctl-x-map "\C-r" 'find-file-read-only)
2237 (define-key ctl-x-map "\C-v" 'find-alternate-file)
2238 (define-key ctl-x-map "\C-s" 'save-buffer)
2239 (define-key ctl-x-map "s" 'save-some-buffers)
2240 (define-key ctl-x-map "\C-w" 'write-file)
2241 (define-key ctl-x-map "i" 'insert-file)
2242 (define-key esc-map "~" 'not-modified)
2243 (define-key ctl-x-map "\C-d" 'list-directory)
2244 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
2245
2246 (define-key ctl-x-4-map "f" 'find-file-other-window)
2247 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
2248 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
2249 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
2250 (define-key ctl-x-4-map "\C-o" 'display-buffer)
2251
2252 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
2253 (define-key ctl-x-5-map "f" 'find-file-other-frame)
2254 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
2255 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
2256
2257 ;;; files.el ends here