]> code.delx.au - gnu-emacs/blob - lisp/files.el
(abbreviated-home-dir): New variable.
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992 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 ;;; Code:
24
25 (defconst delete-auto-save-files t
26 "*Non-nil means delete a buffer's auto-save file when the buffer is saved.")
27
28 (defconst directory-abbrev-alist
29 nil
30 "*Alist of abbreviations for file directories.
31 A list of elements of the form (FROM . TO), each meaning to replace
32 FROM with TO when it appears in a directory name. This replacement is
33 done when setting up the default directory of a newly visited file.
34 *Every* FROM string should start with `^'.
35
36 Use this feature when you have directories which you normally refer to
37 via absolute symbolic links. Make TO the name of the link, and FROM
38 the name it is linked to.")
39
40 ;;; Turn off backup files on VMS since it has version numbers.
41 (defconst make-backup-files (not (eq system-type 'vax-vms))
42 "*Create a backup of each file when it is saved for the first time.
43 This can be done by renaming the file or by copying.
44
45 Renaming means that Emacs renames the existing file so that it is a
46 backup file, then writes the buffer into a new file. Any other names
47 that the old file had will now refer to the backup file. The new file
48 is owned by you and its group is defaulted.
49
50 Copying means that Emacs copies the existing file into the backup
51 file, then writes the buffer on top of the existing file. Any other
52 names that the old file had will now refer to the new (edited) file.
53 The file's owner and group are unchanged.
54
55 The choice of renaming or copying is controlled by the variables
56 `backup-by-copying', `backup-by-copying-when-linked' and
57 `backup-by-copying-when-mismatch'.")
58
59 ;; Do this so that local variables based on the file name
60 ;; are not overridden by the major mode.
61 (defvar backup-inhibited nil
62 "Non-nil means don't make a backup file for this buffer.")
63 (put 'backup-inhibited 'permanent-local t)
64
65 (defconst backup-by-copying nil
66 "*Non-nil means always use copying to create backup files.
67 See documentation of variable `make-backup-files'.")
68
69 (defconst backup-by-copying-when-linked nil
70 "*Non-nil means use copying to create backups for files with multiple names.
71 This causes the alternate names to refer to the latest version as edited.
72 This variable is relevant only if `backup-by-copying' is nil.")
73
74 (defconst backup-by-copying-when-mismatch nil
75 "*Non-nil means create backups by copying if this preserves owner or group.
76 Renaming may still be used (subject to control of other variables)
77 when it would not result in changing the owner or group of the file;
78 that is, for files which are owned by you and whose group matches
79 the default for a new file created there by you.
80 This variable is relevant only if `backup-by-copying' is nil.")
81
82 (defvar backup-enable-predicate
83 '(lambda (name)
84 (or (< (length name) 5)
85 (not (string-equal "/tmp/" (substring name 0 5)))))
86 "Predicate that looks at a file name and decides whether to make backups.
87 Called with an absolute file name as argument, it returns t to enable backup.")
88
89 (defconst buffer-offer-save nil
90 "*Non-nil in a buffer means offer to save the buffer on exit
91 even if the buffer is not visiting a file.
92 Automatically local in all buffers.")
93 (make-variable-buffer-local 'buffer-offer-save)
94
95 (defconst find-file-existing-other-name nil
96 "*Non-nil means find a file under alternative names, in existing buffers.
97 This means if any existing buffer is visiting the file you want
98 under another name, you get the existing buffer instead of a new buffer.")
99
100 (defconst find-file-visit-truename nil
101 "*Non-nil means visit a file under its truename.
102 The truename of a file is found by chasing all links
103 both at the file level and at the levels of the containing directories.")
104
105 (defvar buffer-file-truename nil
106 "The truename of the file visited in the current buffer.
107 This variable is automatically local in all buffers, when non-nil.")
108 (make-variable-buffer-local 'buffer-file-truename)
109 (put 'buffer-file-truename 'permanent-local t)
110
111 (defvar buffer-file-number nil
112 "The device number and file number of the file visited in the current buffer.
113 The value is a list of the form (FILENUM DEVNUM).
114 This pair of numbers uniquely identifies the file.
115 If the buffer is visiting a new file, the value is nil.")
116 (make-variable-buffer-local 'buffer-file-number)
117 (put 'buffer-file-number 'permanent-local t)
118
119 (defconst file-precious-flag nil
120 "*Non-nil means protect against I/O errors while saving files.
121 Some modes set this non-nil in particular buffers.")
122
123 (defvar version-control nil
124 "*Control use of version numbers for backup files.
125 t means make numeric backup versions unconditionally.
126 nil means make them for files that have some already.
127 never means do not make them.")
128
129 (defvar dired-kept-versions 2
130 "*When cleaning directory, number of versions to keep.")
131
132 (defvar trim-versions-without-asking nil
133 "*If t, deletes excess backup versions silently.
134 If nil, asks confirmation. Any other value prevents any trimming.")
135
136 (defvar kept-old-versions 2
137 "*Number of oldest versions to keep when a new numbered backup is made.")
138
139 (defvar kept-new-versions 2
140 "*Number of newest versions to keep when a new numbered backup is made.
141 Includes the new backup. Must be > 0")
142
143 (defconst require-final-newline nil
144 "*Value of t says silently ensure a file ends in a newline when it is saved.
145 Non-nil but not t says ask user whether to add a newline when there isn't one.
146 nil means don't add newlines.")
147
148 (defconst auto-save-default t
149 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
150
151 (defconst auto-save-visited-file-name nil
152 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
153 Normally auto-save files are written under other names.")
154
155 (defconst save-abbrevs nil
156 "*Non-nil means save word abbrevs too when files are saved.
157 Loading an abbrev file sets this to t.")
158
159 (defconst find-file-run-dired t
160 "*Non-nil says run dired if find-file is given the name of a directory.")
161
162 (put 'find-file-not-found-hooks 'permanent-local t)
163 (defvar find-file-not-found-hooks nil
164 "List of functions to be called for `find-file' on nonexistent file.
165 These functions are called as soon as the error is detected.
166 `buffer-file-name' is already set up.
167 The functions are called in the order given until one of them returns non-nil.")
168
169 (put 'find-file-hooks 'permanent-local t)
170 (defvar find-file-hooks nil
171 "List of functions to be called after a buffer is loaded from a file.
172 The buffer's local variables (if any) will have been processed before the
173 functions are called.")
174
175 (put 'write-file-hooks 'permanent-local t)
176 (defvar write-file-hooks nil
177 "List of functions to be called before writing out a buffer to a file.
178 If one of them returns non-nil, the file is considered already written
179 and the rest are not called.
180 These hooks are considered to pertain to the visited file.
181 So this list is cleared if you change the visited file name.
182 See also `write-contents-hooks'.")
183
184 (defvar write-contents-hooks nil
185 "List of functions to be called before writing out a buffer to a file.
186 If one of them returns non-nil, the file is considered already written
187 and the rest are not called.
188 These hooks are considered to pertain to the buffer's contents,
189 not to the particular visited file; thus, `set-visited-file-name' does
190 not clear this variable, but changing the major mode does clear it.
191 See also `write-file-hooks'.")
192
193 (defconst enable-local-variables t
194 "*Control use of local-variables lists in files you visit.
195 The value can be t, nil or something else.
196 A value of t means local-variables lists are obeyed;
197 nil means they are ignored; anything else means query.
198
199 The command \\[normal-mode] always obeys local-variables lists
200 and ignores this variable.")
201
202 (defconst enable-local-eval 'maybe
203 "*Control processing of the \"variable\" `eval' in a file's local variables.
204 The value can be t, nil or something else.
205 A value of t means obey `eval' variables;
206 nil means ignore them; anything else means query.
207
208 The command \\[normal-mode] always obeys local-variables lists
209 and ignores this variable.")
210
211 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
212 (or (fboundp 'lock-buffer)
213 (fset 'lock-buffer 'ignore))
214 (or (fboundp 'unlock-buffer)
215 (fset 'unlock-buffer 'ignore))
216 \f
217 (defun pwd ()
218 "Show the current default directory."
219 (interactive nil)
220 (message "Directory %s" default-directory))
221
222 (defun cd (dir)
223 "Make DIR become the current buffer's default directory."
224 (interactive "DChange default directory: ")
225 (setq dir (expand-file-name dir))
226 (if (not (eq system-type 'vax-vms))
227 (setq dir (file-name-as-directory dir)))
228 (if (not (file-directory-p dir))
229 (error "%s is not a directory" dir)
230 (if (file-executable-p dir)
231 (setq default-directory dir)
232 (error "Cannot cd to %s: Permission denied" dir)))
233 ;; We used to call pwd at this point. That's not terribly helpful
234 ;; when we're invoking cd interactively, and the new cmushell-based
235 ;; shell has its own (better) facilities for this.
236 )
237
238 (defun load-file (file)
239 "Load the Lisp file named FILE."
240 (interactive "fLoad file: ")
241 (load (expand-file-name file) nil nil t))
242
243 (defun load-library (library)
244 "Load the library named LIBRARY.
245 This is an interface to the function `load'."
246 (interactive "sLoad library: ")
247 (load library))
248
249 ;; OTHER is the other file to be compared.
250 (defun file-local-copy (file)
251 "Copy the file FILE into a temporary file on this machine.
252 Returns the name of the local copy, or nil, if FILE is directly
253 accessible."
254 (let ((handler (find-file-name-handler file)))
255 (if handler
256 (funcall handler 'file-local-copy file)
257 nil)))
258
259 (defun file-truename (filename)
260 "Return the truename of FILENAME, which should be absolute.
261 The truename of a file name is found by chasing symbolic links
262 both at the level of the file and at the level of the directories
263 containing it, until no links are left at any level."
264 (if (string= filename "~")
265 (setq filename (expand-file-name filename)))
266 (let ((handler (find-file-name-handler filename)))
267 ;; For file name that has a special handler, call handler.
268 ;; This is so that ange-ftp can save time by doing a no-op.
269 (if handler
270 (funcall handler 'file-truename filename)
271 (let ((dir (file-name-directory filename))
272 target dirfile)
273 ;; Get the truename of the directory.
274 (setq dirfile (directory-file-name dir))
275 ;; If these are equal, we have the (or a) root directory.
276 (or (string= dir dirfile)
277 (setq dir (file-name-as-directory (file-truename dirfile))))
278 ;; Put it back on the file name.
279 (setq filename (concat dir (file-name-nondirectory filename)))
280 ;; Is the file name the name of a link?
281 (setq target (file-symlink-p filename))
282 (if target
283 ;; Yes => chase that link, then start all over
284 ;; since the link may point to a directory name that uses links.
285 (file-truename (expand-file-name target dir))
286 ;; No, we are done!
287 filename)))))
288
289 \f
290 (defun switch-to-buffer-other-window (buffer)
291 "Select buffer BUFFER in another window."
292 (interactive "BSwitch to buffer in other window: ")
293 (let ((pop-up-windows t))
294 (pop-to-buffer buffer t)))
295
296 (defun switch-to-buffer-other-frame (buffer)
297 "Switch to buffer BUFFER in another frame."
298 (interactive "BSwitch to buffer in other frame: ")
299 (let ((pop-up-frames t))
300 (pop-to-buffer buffer)))
301
302 (defun find-file (filename)
303 "Edit file FILENAME.
304 Switch to a buffer visiting file FILENAME,
305 creating one if none already exists."
306 (interactive "FFind file: ")
307 (switch-to-buffer (find-file-noselect filename)))
308
309 (defun find-file-other-window (filename)
310 "Edit file FILENAME, in another window.
311 May create a new window, or reuse an existing one.
312 See the function `display-buffer'."
313 (interactive "FFind file in other window: ")
314 (switch-to-buffer-other-window (find-file-noselect filename)))
315
316 (defun find-file-other-frame (filename)
317 "Edit file FILENAME, in another frame.
318 May create a new frame, or reuse an existing one.
319 See the function `display-buffer'."
320 (interactive "FFind file in other frame: ")
321 (switch-to-buffer-other-frame (find-file-noselect filename)))
322
323 (defun find-file-read-only (filename)
324 "Edit file FILENAME but don't allow changes.
325 Like \\[find-file] but marks buffer as read-only.
326 Use \\[toggle-read-only] to permit editing."
327 (interactive "fFind file read-only: ")
328 (find-file filename)
329 (setq buffer-read-only t))
330
331 (defun find-file-read-only-other-window (filename)
332 "Edit file FILENAME in another window but don't allow changes.
333 Like \\[find-file-other-window] but marks buffer as read-only.
334 Use \\[toggle-read-only] to permit editing."
335 (interactive "fFind file read-only other window: ")
336 (find-file filename)
337 (setq buffer-read-only t))
338
339 (defun find-file-read-only-other-frame (filename)
340 "Edit file FILENAME in another frame but don't allow changes.
341 Like \\[find-file-other-frame] but marks buffer as read-only.
342 Use \\[toggle-read-only] to permit editing."
343 (interactive "fFind file read-only other frame: ")
344 (find-file-other-frame filename)
345 (setq buffer-read-only t))
346
347 (defun find-alternate-file (filename)
348 "Find file FILENAME, select its buffer, kill previous buffer.
349 If the current buffer now contains an empty file that you just visited
350 \(presumably by mistake), use this command to visit the file you really want."
351 (interactive
352 (let ((file buffer-file-name)
353 (file-name nil)
354 (file-dir nil))
355 (and file
356 (setq file-name (file-name-nondirectory file)
357 file-dir (file-name-directory file)))
358 (list (read-file-name
359 "Find alternate file: " file-dir nil nil file-name))))
360 (and (buffer-modified-p)
361 ;; (not buffer-read-only)
362 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
363 (buffer-name))))
364 (error "Aborted"))
365 (let ((obuf (current-buffer))
366 (ofile buffer-file-name)
367 (oname (buffer-name)))
368 (rename-buffer " **lose**")
369 (setq buffer-file-name nil)
370 (unwind-protect
371 (progn
372 (unlock-buffer)
373 (find-file filename))
374 (cond ((eq obuf (current-buffer))
375 (setq buffer-file-name ofile)
376 (lock-buffer)
377 (rename-buffer oname))))
378 (or (eq (current-buffer) obuf)
379 (kill-buffer obuf))))
380
381 (defun create-file-buffer (filename)
382 "Create a suitably named buffer for visiting FILENAME, and return it.
383 FILENAME (sans directory) is used unchanged if that name is free;
384 otherwise a string <2> or <3> or ... is appended to get an unused name."
385 (let ((lastname (file-name-nondirectory filename)))
386 (if (string= lastname "")
387 (setq lastname filename))
388 (generate-new-buffer lastname)))
389
390 (defun generate-new-buffer (name)
391 "Create and return a buffer with a name based on NAME.
392 Choose the buffer's name using `generate-new-buffer-name'."
393 (get-buffer-create (generate-new-buffer-name name)))
394
395 (defconst automount-dir-prefix "^/tmp_mnt/"
396 "Regexp to match the automounter prefix in a directory name.")
397
398 (defvar abbreviated-home-dir nil
399 "The the user's homedir abbreviated according to `directory-abbrev-list'.")
400
401 (defun abbreviate-file-name (filename)
402 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
403 This also substitutes \"~\" for the user's home directory.
404 Type \\[describe-variable] directory-abbrev-alist RET for more information."
405 ;; Get rid of the prefixes added by the automounter.
406 (if (and (string-match automount-dir-prefix filename)
407 (file-exists-p (file-name-directory
408 (substring filename (1- (match-end 0))))))
409 (setq filename (substring filename (1- (match-end 0)))))
410 (let ((tail directory-abbrev-alist))
411 ;; If any elt of directory-abbrev-alist matches this name,
412 ;; abbreviate accordingly.
413 (while tail
414 (if (string-match (car (car tail)) filename)
415 (setq filename
416 (concat (cdr (car tail)) (substring filename (match-end 0)))))
417 (setq tail (cdr tail)))
418 ;; Compute and save the abbreviated homedir name.
419 ;; We defer computing this until the first time it's needed, to
420 ;; give time for directory-abbrev-alist to be set properly.
421 (or abbreviated-home-dir
422 (setq abbreviated-home-dir
423 (let ((abbreviated-home-dir "$foo"))
424 (concat "^" (abbreviate-file-name (expand-file-name "~"))))))
425 ;; If FILENAME starts with the abbreviated homedir,
426 ;; make it start with `~' instead.
427 (if (string-match abbreviated-home-dir filename)
428 (setq filename
429 (concat "~" (substring filename (match-end 0)))))
430 filename))
431
432 (defun find-file-noselect (filename &optional nowarn)
433 "Read file FILENAME into a buffer and return the buffer.
434 If a buffer exists visiting FILENAME, return that one, but
435 verify that the file has not changed since visited or saved.
436 The buffer is not selected, just returned to the caller."
437 (setq filename
438 (abbreviate-file-name
439 (expand-file-name filename)))
440 (if (file-directory-p filename)
441 (if find-file-run-dired
442 (dired-noselect filename)
443 (error "%s is a directory." filename))
444 (let* ((buf (get-file-buffer filename))
445 (truename (abbreviate-file-name (file-truename filename)))
446 (number (nthcdr 10 (file-attributes truename)))
447 ;; Find any buffer for a file which has same truename.
448 (same-truename
449 (or buf ; Shortcut
450 (let (found
451 (list (buffer-list)))
452 (while (and (not found) list)
453 (save-excursion
454 (set-buffer (car list))
455 (if (string= buffer-file-truename truename)
456 (setq found (car list))))
457 (setq list (cdr list)))
458 found)))
459 (same-number
460 (or buf ; Shortcut
461 (and number
462 (let (found
463 (list (buffer-list)))
464 (while (and (not found) list)
465 (save-excursion
466 (set-buffer (car list))
467 (if (equal buffer-file-number number)
468 (setq found (car list))))
469 (setq list (cdr list)))
470 found))))
471 error)
472 ;; Let user know if there is a buffer with the same truename.
473 (if (and (not buf) same-truename (not nowarn))
474 (message "%s and %s are the same file (%s)"
475 filename (buffer-file-name same-truename)
476 truename)
477 (if (and (not buf) same-number (not nowarn))
478 (message "%s and %s are the same file"
479 filename (buffer-file-name same-number))))
480
481 ;; Optionally also find that buffer.
482 (if (or find-file-existing-other-name find-file-visit-truename)
483 (setq buf (or same-truename same-number)))
484 (if buf
485 (or nowarn
486 (verify-visited-file-modtime buf)
487 (cond ((not (file-exists-p filename))
488 (error "File %s no longer exists!" filename))
489 ((yes-or-no-p
490 (format
491 (if (buffer-modified-p buf)
492 "File %s changed on disk. Discard your edits? "
493 "File %s changed on disk. Read the new version? ")
494 (file-name-nondirectory filename)))
495 (save-excursion
496 (set-buffer buf)
497 (revert-buffer t t)))))
498 (save-excursion
499 ;;; The truename stuff makes this obsolete.
500 ;;; (let* ((link-name (car (file-attributes filename)))
501 ;;; (linked-buf (and (stringp link-name)
502 ;;; (get-file-buffer link-name))))
503 ;;; (if (bufferp linked-buf)
504 ;;; (message "Symbolic link to file in buffer %s"
505 ;;; (buffer-name linked-buf))))
506 (setq buf (create-file-buffer filename))
507 (set-buffer buf)
508 (erase-buffer)
509 (condition-case ()
510 (insert-file-contents filename t)
511 (file-error
512 (setq error t)
513 ;; Run find-file-not-found-hooks until one returns non-nil.
514 (let ((hooks find-file-not-found-hooks))
515 (while (and hooks
516 (not (funcall (car hooks))))
517 (setq hooks (cdr hooks))))))
518 ;; Find the file's truename, and maybe use that as visited name.
519 (setq buffer-file-truename (abbreviate-file-name truename))
520 (setq buffer-file-number number)
521 (if find-file-visit-truename (setq filename buffer-file-truename))
522 ;; Set buffer's default directory to that of the file.
523 (setq default-directory (file-name-directory filename))
524 ;; Turn off backup files for certain file names. Since
525 ;; this is a permanent local, the major mode won't eliminate it.
526 (and (not (funcall backup-enable-predicate buffer-file-name))
527 (progn
528 (make-local-variable 'backup-inhibited)
529 (setq backup-inhibited t)))
530 (after-find-file error (not nowarn))))
531 buf)))
532 \f
533 (defun after-find-file (&optional error warn noauto)
534 "Called after finding a file and by the default revert function.
535 Sets buffer mode, parses local variables.
536 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
537 error in reading the file. WARN non-nil means warn if there
538 exists an auto-save file more recent than the visited file.
539 NOAUTO means don't mess with auto-save mode.
540 Finishes by calling the functions in `find-file-hooks'."
541 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
542 (if noninteractive
543 nil
544 (let* (not-serious
545 (msg
546 (cond ((and error (file-attributes buffer-file-name))
547 (setq buffer-read-only t)
548 "File exists, but is read-protected.")
549 ((not buffer-read-only)
550 (if (and warn
551 (file-newer-than-file-p (make-auto-save-file-name)
552 buffer-file-name))
553 "Auto save file is newer; consider M-x recover-file"
554 (setq not-serious t)
555 (if error "(New file)" nil)))
556 ((not error)
557 (setq not-serious t)
558 "Note: file is write protected")
559 ((file-attributes (directory-file-name default-directory))
560 "File not found and directory write-protected")
561 ((file-exists-p (file-name-directory buffer-file-name))
562 (setq buffer-read-only nil))
563 (t
564 (setq buffer-read-only nil)
565 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
566 "Use M-x make-dir RET RET to create the directory"
567 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
568 (if msg
569 (progn
570 (message msg)
571 (or not-serious (sit-for 1 nil t)))))
572 (if (and auto-save-default (not noauto))
573 (auto-save-mode t)))
574 (normal-mode t)
575 (mapcar 'funcall find-file-hooks))
576
577 (defun normal-mode (&optional find-file)
578 "Choose the major mode for this buffer automatically.
579 Also sets up any specified local variables of the file.
580 Uses the visited file name, the -*- line, and the local variables spec.
581
582 This function is called automatically from `find-file'. In that case,
583 we may set up specified local variables depending on the value of
584 `enable-local-variables': if it is t, we do; if it is nil, we don't;
585 otherwise, we query. `enable-local-variables' is ignored if you
586 run `normal-mode' explicitly."
587 (interactive)
588 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
589 (condition-case err
590 (set-auto-mode)
591 (error (message "File mode specification error: %s"
592 (prin1-to-string err))))
593 (condition-case err
594 (let ((enable-local-variables (or (not find-file)
595 enable-local-variables)))
596 (hack-local-variables))
597 (error (message "File local-variables error: %s"
598 (prin1-to-string err)))))
599
600 (defvar auto-mode-alist (mapcar 'purecopy
601 '(("\\.text\\'" . text-mode)
602 ("\\.c\\'" . c-mode)
603 ("\\.h\\'" . c-mode)
604 ("\\.tex\\'" . TeX-mode)
605 ("\\.ltx\\'" . LaTeX-mode)
606 ("\\.el\\'" . emacs-lisp-mode)
607 ("\\.mm\\'" . nroff-mode)
608 ("\\.me\\'" . nroff-mode)
609 ("\\.scm\\'" . scheme-mode)
610 ("\\.l\\'" . lisp-mode)
611 ("\\.lisp\\'" . lisp-mode)
612 ("\\.f\\'" . fortran-mode)
613 ("\\.for\\'" . fortran-mode)
614 ("\\.mss\\'" . scribe-mode)
615 ("\\.pl\\'" . prolog-mode)
616 ("\\.cc\\'" . c++-mode)
617 ("\\.C\\'" . c++-mode)
618 ;;; Less common extensions come here
619 ;;; so more common ones above are found faster.
620 ("\\.s\\'" . asm-mode)
621 ("ChangeLog\\'" . change-log-mode)
622 ("ChangeLog.[0-9]+\\'" . change-log-mode)
623 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
624 ;; The following should come after the ChangeLog pattern
625 ;; for the sake of ChangeLog.1, etc.
626 ("\\.[12345678]\\'" . nroff-mode)
627 ("\\.TeX\\'" . TeX-mode)
628 ("\\.sty\\'" . LaTeX-mode)
629 ("\\.bbl\\'" . LaTeX-mode)
630 ("\\.bib\\'" . bibtex-mode)
631 ("\\.article\\'" . text-mode)
632 ("\\.letter\\'" . text-mode)
633 ("\\.texinfo\\'" . texinfo-mode)
634 ("\\.texi\\'" . texinfo-mode)
635 ("\\.lsp\\'" . lisp-mode)
636 ("\\.awk\\'" . awk-mode)
637 ("\\.prolog\\'" . prolog-mode)
638 ;; Mailer puts message to be edited in
639 ;; /tmp/Re.... or Message
640 ("^/tmp/Re" . text-mode)
641 ("/Message[0-9]*\\'" . text-mode)
642 ;; some news reader is reported to use this
643 ("^/tmp/fol/" . text-mode)
644 ("\\.y\\'" . c-mode)
645 ("\\.oak\\'" . scheme-mode)
646 ("\\.scm.[0-9]*\\'" . scheme-mode)
647 ;; .emacs following a directory delimiter
648 ;; in either Unix or VMS syntax.
649 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
650 ("\\.ml\\'" . lisp-mode)))
651 "\
652 Alist of filename patterns vs corresponding major mode functions.
653 Each element looks like (REGEXP . FUNCTION).
654 Visiting a file whose name matches REGEXP causes FUNCTION to be called.")
655
656 (defun set-auto-mode ()
657 "Select major mode appropriate for current buffer.
658 This checks for a -*- mode tag in the buffer's text, or
659 compares the filename against the entries in auto-mode-alist. It does
660 not check for the \"mode:\" local variable in the Local Variables
661 section of the file; for that, use `hack-local-variables'.
662
663 If `enable-local-variables' is nil, this function does not check for a
664 -*- mode tag."
665 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
666 (let (beg end mode)
667 (save-excursion
668 (goto-char (point-min))
669 (skip-chars-forward " \t\n")
670 (if (and enable-local-variables
671 (search-forward "-*-" (save-excursion (end-of-line) (point)) t)
672 (progn
673 (skip-chars-forward " \t")
674 (setq beg (point))
675 (search-forward "-*-"
676 (save-excursion (end-of-line) (point))
677 t))
678 (progn
679 (forward-char -3)
680 (skip-chars-backward " \t")
681 (setq end (point))
682 (goto-char beg)
683 (if (search-forward ":" end t)
684 (progn
685 (goto-char beg)
686 (if (let ((case-fold-search t))
687 (search-forward "mode:" end t))
688 (progn
689 (skip-chars-forward " \t")
690 (setq beg (point))
691 (if (search-forward ";" end t)
692 (forward-char -1)
693 (goto-char end))
694 (skip-chars-backward " \t")
695 (setq mode (buffer-substring beg (point))))))
696 (setq mode (buffer-substring beg end)))))
697 (setq mode (intern (concat (downcase mode) "-mode")))
698 (let ((alist auto-mode-alist)
699 (name buffer-file-name))
700 (let ((case-fold-search (eq system-type 'vax-vms)))
701 ;; Remove backup-suffixes from file name.
702 (setq name (file-name-sans-versions name))
703 ;; Find first matching alist entry.
704 (while (and (not mode) alist)
705 (if (string-match (car (car alist)) name)
706 (setq mode (cdr (car alist))))
707 (setq alist (cdr alist)))))))
708 (if mode (funcall mode))))
709
710 (defun hack-local-variables-prop-line ()
711 ;; Set local variables specified in the -*- line.
712 ;; Returns t if mode was set.
713 (save-excursion
714 (goto-char (point-min))
715 (skip-chars-forward " \t\n\r")
716 (let ((result '())
717 (end (save-excursion (end-of-line) (point)))
718 mode-p)
719 ;; Parse the -*- line into the `result' alist.
720 (cond ((not (search-forward "-*-" end t))
721 ;; doesn't have one.
722 nil)
723 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
724 ;; Simple form: "-*- MODENAME -*-".
725 (setq result
726 (list (cons 'mode
727 (intern (buffer-substring
728 (match-beginning 1)
729 (match-end 1)))))))
730 (t
731 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
732 ;; (last ";" is optional).
733 (save-excursion
734 (if (search-forward "-*-" end t)
735 (setq end (- (point) 3))
736 (error "-*- not terminated before end of line")))
737 (while (< (point) end)
738 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
739 (error "malformed -*- line"))
740 (goto-char (match-end 0))
741 (let ((key (intern (downcase (buffer-substring
742 (match-beginning 1)
743 (match-end 1)))))
744 (val (save-restriction
745 (narrow-to-region (point) end)
746 (read (current-buffer)))))
747 (setq result (cons (cons key val) result))
748 (skip-chars-forward " \t;")))
749 (setq result (nreverse result))))
750
751 ;; Mode is magic.
752 (let (mode)
753 (while (setq mode (assq 'mode result))
754 (setq mode-p t result (delq mode result))
755 (funcall (intern (concat (downcase (symbol-name (cdr mode)))
756 "-mode")))))
757
758 (if (and result
759 (or (eq enable-local-variables t)
760 (and enable-local-variables
761 (save-window-excursion
762 (switch-to-buffer (current-buffer))
763 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
764 (file-name-nondirectory buffer-file-name)))))))
765 (while result
766 (let ((key (car (car result)))
767 (val (cdr (car result))))
768 ;; 'mode has already been removed from this list.
769 (hack-one-local-variable key val))
770 (setq result (cdr result))))
771 mode-p)))
772
773 (defun hack-local-variables ()
774 "Parse and put into effect this buffer's local variables spec."
775 (hack-local-variables-prop-line)
776 ;; Look for "Local variables:" line in last page.
777 (save-excursion
778 (goto-char (point-max))
779 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
780 (if (let ((case-fold-search t))
781 (and (search-forward "Local Variables:" nil t)
782 (or (eq enable-local-variables t)
783 (and enable-local-variables
784 (save-window-excursion
785 (switch-to-buffer (current-buffer))
786 (save-excursion
787 (beginning-of-line)
788 (set-window-start (selected-window) (point)))
789 (y-or-n-p (format "Set local variables as specified at end of %s? "
790 (file-name-nondirectory buffer-file-name))))))))
791 (let ((continue t)
792 prefix prefixlen suffix beg
793 (enable-local-eval enable-local-eval))
794 ;; The prefix is what comes before "local variables:" in its line.
795 ;; The suffix is what comes after "local variables:" in its line.
796 (skip-chars-forward " \t")
797 (or (eolp)
798 (setq suffix (buffer-substring (point)
799 (progn (end-of-line) (point)))))
800 (goto-char (match-beginning 0))
801 (or (bolp)
802 (setq prefix
803 (buffer-substring (point)
804 (progn (beginning-of-line) (point)))))
805
806 (if prefix (setq prefixlen (length prefix)
807 prefix (regexp-quote prefix)))
808 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
809 (while continue
810 ;; Look at next local variable spec.
811 (if selective-display (re-search-forward "[\n\C-m]")
812 (forward-line 1))
813 ;; Skip the prefix, if any.
814 (if prefix
815 (if (looking-at prefix)
816 (forward-char prefixlen)
817 (error "Local variables entry is missing the prefix")))
818 ;; Find the variable name; strip whitespace.
819 (skip-chars-forward " \t")
820 (setq beg (point))
821 (skip-chars-forward "^:\n")
822 (if (eolp) (error "Missing colon in local variables entry"))
823 (skip-chars-backward " \t")
824 (let* ((str (buffer-substring beg (point)))
825 (var (read str))
826 val)
827 ;; Setting variable named "end" means end of list.
828 (if (string-equal (downcase str) "end")
829 (setq continue nil)
830 ;; Otherwise read the variable value.
831 (skip-chars-forward "^:")
832 (forward-char 1)
833 (setq val (read (current-buffer)))
834 (skip-chars-backward "\n")
835 (skip-chars-forward " \t")
836 (or (if suffix (looking-at suffix) (eolp))
837 (error "Local variables entry is terminated incorrectly"))
838 ;; Set the variable. "Variables" mode and eval are funny.
839 (hack-one-local-variable var val))))))))
840
841 (defconst ignored-local-variables
842 '(enable-local-eval)
843 "Variables to be ignored in a file's local variable spec.")
844
845 ;; "Set" one variable in a local variables spec.
846 ;; A few variable names are treated specially.
847 (defun hack-one-local-variable (var val)
848 (cond ((eq var 'mode)
849 (funcall (intern (concat (downcase (symbol-name val))
850 "-mode"))))
851 ((memq var ignored-local-variables)
852 nil)
853 ;; "Setting" eval means either eval it or do nothing.
854 ((eq var 'eval)
855 (if (and (not (string= (user-login-name) "root"))
856 (or (eq enable-local-eval t)
857 (and enable-local-eval
858 (save-window-excursion
859 (switch-to-buffer (current-buffer))
860 (save-excursion
861 (beginning-of-line)
862 (set-window-start (selected-window) (point)))
863 (setq enable-local-eval
864 (y-or-n-p (format "Process `eval' local variable in file %s? "
865 (file-name-nondirectory buffer-file-name))))))))
866 (save-excursion (eval val))
867 (message "Ignoring `eval:' in file's local variables")))
868 ;; Ordinary variable, really set it.
869 (t (make-local-variable var)
870 (set var val))))
871
872 \f
873 (defun set-visited-file-name (filename)
874 "Change name of file visited in current buffer to FILENAME.
875 The next time the buffer is saved it will go in the newly specified file.
876 nil or empty string as argument means make buffer not be visiting any file.
877 Remember to delete the initial contents of the minibuffer
878 if you wish to pass an empty string as the argument."
879 (interactive "FSet visited file name: ")
880 (if filename
881 (setq filename
882 (if (string-equal filename "")
883 nil
884 (expand-file-name filename))))
885 (or (equal filename buffer-file-name)
886 (null filename)
887 (progn
888 (lock-buffer filename)
889 (unlock-buffer)))
890 (setq buffer-file-name filename)
891 (if filename ; make buffer name reflect filename.
892 (let ((new-name (file-name-nondirectory buffer-file-name)))
893 (if (string= new-name "")
894 (error "Empty file name"))
895 (if (eq system-type 'vax-vms)
896 (setq new-name (downcase new-name)))
897 (setq default-directory (file-name-directory buffer-file-name))
898 (rename-buffer new-name t)))
899 (setq buffer-backed-up nil)
900 (clear-visited-file-modtime)
901 (if filename
902 (progn
903 (setq buffer-file-truename
904 (abbreviate-file-name (file-truename buffer-file-name)))
905 (if find-file-visit-truename
906 (setq buffer-file-name buffer-file-truename))
907 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name))))
908 (setq buffer-file-truename nil buffer-file-number nil))
909 ;; write-file-hooks is normally used for things like ftp-find-file
910 ;; that visit things that are not local files as if they were files.
911 ;; Changing to visit an ordinary local file instead should flush the hook.
912 (kill-local-variable 'write-file-hooks)
913 (kill-local-variable 'revert-buffer-function)
914 (kill-local-variable 'backup-inhibited)
915 ;; Turn off backup files for certain file names.
916 ;; Since this is a permanent local, the major mode won't eliminate it.
917 (and (not (funcall backup-enable-predicate buffer-file-name))
918 (progn
919 (make-local-variable 'backup-inhibited)
920 (setq backup-inhibited t)))
921 ;; If auto-save was not already on, turn it on if appropriate.
922 (if (not buffer-auto-save-file-name)
923 (auto-save-mode (and buffer-file-name auto-save-default))
924 ;; If auto save is on, start using a new name.
925 ;; We deliberately don't rename or delete the old auto save
926 ;; for the old visited file name. This is because perhaps
927 ;; the user wants to save the new state and then compare with the
928 ;; previous state from the auto save file.
929 (setq buffer-auto-save-file-name
930 (make-auto-save-file-name)))
931 (if buffer-file-name
932 (set-buffer-modified-p t)))
933
934 (defun write-file (filename)
935 "Write current buffer into file FILENAME.
936 Makes buffer visit that file, and marks it not modified."
937 ;; (interactive "FWrite file: ")
938 (interactive
939 (list (if buffer-file-name
940 (read-file-name "Write file: "
941 nil nil nil nil)
942 (read-file-name "Write file: "
943 (cdr (assq 'default-directory
944 (buffer-local-variables)))
945 nil nil (buffer-name)))))
946 (or (null filename) (string-equal filename "")
947 (set-visited-file-name filename))
948 (set-buffer-modified-p t)
949 (save-buffer))
950 \f
951 (defun backup-buffer ()
952 "Make a backup of the disk file visited by the current buffer, if appropriate.
953 This is normally done before saving the buffer the first time.
954 If the value is non-nil, it is the result of `file-modes' on the original
955 file; this means that the caller, after saving the buffer, should change
956 the modes of the new file to agree with the old modes."
957 (if (and make-backup-files (not backup-inhibited)
958 (not buffer-backed-up)
959 (file-exists-p buffer-file-name)
960 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
961 '(?- ?l)))
962 (let ((real-file-name buffer-file-name)
963 backup-info backupname targets setmodes)
964 ;; If specified name is a symbolic link, chase it to the target.
965 ;; Thus we make the backups in the directory where the real file is.
966 (while (let ((tem (file-symlink-p real-file-name)))
967 (if tem
968 (setq real-file-name
969 (expand-file-name tem
970 (file-name-directory real-file-name))))
971 tem))
972 (setq backup-info (find-backup-file-name real-file-name)
973 backupname (car backup-info)
974 targets (cdr backup-info))
975 ;;; (if (file-directory-p buffer-file-name)
976 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
977 (condition-case ()
978 (let ((delete-old-versions
979 ;; If have old versions to maybe delete,
980 ;; ask the user to confirm now, before doing anything.
981 ;; But don't actually delete til later.
982 (and targets
983 (or (eq trim-versions-without-asking t) (eq trim-versions-without-asking nil))
984 (or trim-versions-without-asking
985 (y-or-n-p (format "Delete excess backup versions of %s? "
986 real-file-name))))))
987 ;; Actually write the back up file.
988 (condition-case ()
989 (if (or file-precious-flag
990 ; (file-symlink-p buffer-file-name)
991 backup-by-copying
992 (and backup-by-copying-when-linked
993 (> (file-nlinks real-file-name) 1))
994 (and backup-by-copying-when-mismatch
995 (let ((attr (file-attributes real-file-name)))
996 (or (nth 9 attr)
997 (/= (nth 2 attr) (user-uid))))))
998 (condition-case ()
999 (copy-file real-file-name backupname t t)
1000 (file-error
1001 ;; If copying fails because file BACKUPNAME
1002 ;; is not writable, delete that file and try again.
1003 (if (and (file-exists-p backupname)
1004 (not (file-writable-p backupname)))
1005 (delete-file backupname))
1006 (copy-file real-file-name backupname t t)))
1007 ;; rename-file should delete old backup.
1008 (rename-file real-file-name backupname t)
1009 (setq setmodes (file-modes backupname)))
1010 (file-error
1011 ;; If trouble writing the backup, write it in ~.
1012 (setq backupname (expand-file-name "~/%backup%~"))
1013 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1014 (sleep-for 1)
1015 (condition-case ()
1016 (copy-file real-file-name backupname t t)
1017 (file-error
1018 ;; If copying fails because file BACKUPNAME
1019 ;; is not writable, delete that file and try again.
1020 (if (and (file-exists-p backupname)
1021 (not (file-writable-p backupname)))
1022 (delete-file backupname))
1023 (copy-file real-file-name backupname t t)))))
1024 (setq buffer-backed-up t)
1025 ;; Now delete the old versions, if desired.
1026 (if delete-old-versions
1027 (while targets
1028 (condition-case ()
1029 (delete-file (car targets))
1030 (file-error nil))
1031 (setq targets (cdr targets))))
1032 setmodes)
1033 (file-error nil)))))
1034
1035 (defun file-name-sans-versions (name &optional keep-backup-version)
1036 "Return FILENAME sans backup versions or strings.
1037 This is a separate procedure so your site-init or startup file can
1038 redefine it.
1039 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1040 we do not remove backup version numbers, only true file version numbers."
1041 (let ((handler (find-file-name-handler name)))
1042 (if handler
1043 (funcall handler 'file-name-sans-versions name keep-backup-version)
1044 (substring name 0
1045 (if (eq system-type 'vax-vms)
1046 ;; VMS version number is (a) semicolon, optional
1047 ;; sign, zero or more digits or (b) period, option
1048 ;; sign, zero or more digits, provided this is the
1049 ;; second period encountered outside of the
1050 ;; device/directory part of the file name.
1051 (or (string-match ";[---+]?[0-9]*\\'" name)
1052 (if (string-match "\\.[^]>:]*\\(\\.[---+]?[0-9]*\\)\\'"
1053 name)
1054 (match-beginning 1))
1055 (length name))
1056 (if keep-backup-version
1057 (length name)
1058 (or (string-match "\\.~[0-9]+~\\'" name)
1059 (string-match "~\\'" name)
1060 (length name))))))))
1061
1062 (defun make-backup-file-name (file)
1063 "Create the non-numeric backup file name for FILE.
1064 This is a separate function so you can redefine it for customization."
1065 (concat file "~"))
1066
1067 (defun backup-file-name-p (file)
1068 "Return non-nil if FILE is a backup file name (numeric or not).
1069 This is a separate function so you can redefine it for customization.
1070 You may need to redefine `file-name-sans-versions' as well."
1071 (string-match "~$" file))
1072
1073 ;; This is used in various files.
1074 ;; The usage of bv-length is not very clean,
1075 ;; but I can't see a good alternative,
1076 ;; so as of now I am leaving it alone.
1077 (defun backup-extract-version (fn)
1078 "Given the name of a numeric backup file, return the backup number.
1079 Uses the free variable `bv-length', whose value should be
1080 the index in the name where the version number begins."
1081 (if (and (string-match "[0-9]+~$" fn bv-length)
1082 (= (match-beginning 0) bv-length))
1083 (string-to-int (substring fn bv-length -1))
1084 0))
1085
1086 ;; I believe there is no need to alter this behavior for VMS;
1087 ;; since backup files are not made on VMS, it should not get called.
1088 (defun find-backup-file-name (fn)
1089 "Find a file name for a backup file, and suggestions for deletions.
1090 Value is a list whose car is the name for the backup file
1091 and whose cdr is a list of old versions to consider deleting now."
1092 (if (eq version-control 'never)
1093 (list (make-backup-file-name fn))
1094 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1095 (bv-length (length base-versions))
1096 (possibilities (file-name-all-completions
1097 base-versions
1098 (file-name-directory fn)))
1099 (versions (sort (mapcar
1100 (function backup-extract-version)
1101 possibilities)
1102 '<))
1103 (high-water-mark (apply 'max 0 versions))
1104 (deserve-versions-p
1105 (or version-control
1106 (> high-water-mark 0)))
1107 (number-to-delete (- (length versions)
1108 kept-old-versions kept-new-versions -1)))
1109 (if (not deserve-versions-p)
1110 (list (make-backup-file-name fn))
1111 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1112 (if (> number-to-delete 0)
1113 (mapcar (function (lambda (n)
1114 (concat fn ".~" (int-to-string n) "~")))
1115 (let ((v (nthcdr kept-old-versions versions)))
1116 (rplacd (nthcdr (1- number-to-delete) v) ())
1117 v))))))))
1118
1119 (defun file-nlinks (filename)
1120 "Return number of names file FILENAME has."
1121 (car (cdr (file-attributes filename))))
1122
1123 (defun file-relative-name-1 (directory)
1124 (cond ((string= directory "/")
1125 filename)
1126 ((string-match (concat "^" (regexp-quote directory))
1127 filename)
1128 (substring filename (match-end 0)))
1129 (t
1130 (file-relative-name-1
1131 (file-name-directory (substring directory 0 -1))))))
1132
1133 (defun file-relative-name (filename &optional directory)
1134 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1135 (setq filename (expand-file-name filename)
1136 directory (file-name-as-directory (if directory
1137 (expand-file-name directory)
1138 default-directory)))
1139 (file-relative-name-1 directory))
1140 \f
1141 (defun save-buffer (&optional args)
1142 "Save current buffer in visited file if modified. Versions described below.
1143 By default, makes the previous version into a backup file
1144 if previously requested or if this is the first save.
1145 With 1 or 3 \\[universal-argument]'s, marks this version
1146 to become a backup when the next save is done.
1147 With 2 or 3 \\[universal-argument]'s,
1148 unconditionally makes the previous version into a backup file.
1149 With argument of 0, never makes the previous version into a backup file.
1150
1151 If a file's name is FOO, the names of its numbered backup versions are
1152 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1153 Numeric backups (rather than FOO~) will be made if value of
1154 `version-control' is not the atom `never' and either there are already
1155 numeric versions of the file being backed up, or `version-control' is
1156 non-nil.
1157 We don't want excessive versions piling up, so there are variables
1158 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1159 and `kept-new-versions', which tells how many newest versions to keep.
1160 Defaults are 2 old versions and 2 new.
1161 `dired-kept-versions' controls dired's clean-directory (.) command.
1162 If `trim-versions-without-asking' is nil, system will query user
1163 before trimming versions. Otherwise it does it silently."
1164 (interactive "p")
1165 (let ((modp (buffer-modified-p))
1166 (large (> (buffer-size) 50000))
1167 (make-backup-files (and make-backup-files (not (eq args 0)))))
1168 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1169 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1170 (basic-save-buffer)
1171 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1172
1173 (defun delete-auto-save-file-if-necessary (&optional force)
1174 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1175 Normally delete only if the file was written by this Emacs since
1176 the last real save, but optional arg FORCE non-nil means delete anyway."
1177 (and buffer-auto-save-file-name delete-auto-save-files
1178 (not (string= buffer-file-name buffer-auto-save-file-name))
1179 (or force (recent-auto-save-p))
1180 (progn
1181 (condition-case ()
1182 (delete-file buffer-auto-save-file-name)
1183 (file-error nil))
1184 (set-buffer-auto-saved))))
1185
1186 (defun basic-save-buffer ()
1187 "Save the current buffer in its visited file, if it has been modified."
1188 (interactive)
1189 (if (buffer-modified-p)
1190 (let ((recent-save (recent-auto-save-p))
1191 setmodes tempsetmodes)
1192 ;; On VMS, rename file and buffer to get rid of version number.
1193 (if (and (eq system-type 'vax-vms)
1194 (not (string= buffer-file-name
1195 (file-name-sans-versions buffer-file-name))))
1196 (let (buffer-new-name)
1197 ;; Strip VMS version number before save.
1198 (setq buffer-file-name
1199 (file-name-sans-versions buffer-file-name))
1200 ;; Construct a (unique) buffer name to correspond.
1201 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1202 (setq buffer-new-name (buffer-name buf))
1203 (kill-buffer buf))
1204 (rename-buffer buffer-new-name)))
1205 ;; If buffer has no file name, ask user for one.
1206 (or buffer-file-name
1207 (progn
1208 (setq buffer-file-name
1209 (expand-file-name (read-file-name "File to save in: ") nil)
1210 default-directory (file-name-directory buffer-file-name))
1211 (auto-save-mode auto-save-default)))
1212 (or (verify-visited-file-modtime (current-buffer))
1213 (not (file-exists-p buffer-file-name))
1214 (yes-or-no-p
1215 (format "%s has changed since visited or saved. Save anyway? "
1216 (file-name-nondirectory buffer-file-name)))
1217 (error "Save not confirmed"))
1218 (save-restriction
1219 (widen)
1220 (and (> (point-max) 1)
1221 (/= (char-after (1- (point-max))) ?\n)
1222 (or (eq require-final-newline t)
1223 (and require-final-newline
1224 (y-or-n-p
1225 (format "Buffer %s does not end in newline. Add one? "
1226 (buffer-name)))))
1227 (save-excursion
1228 (goto-char (point-max))
1229 (insert ?\n)))
1230 (let ((hooks (append write-contents-hooks write-file-hooks))
1231 (done nil))
1232 (while (and hooks
1233 (not (setq done (funcall (car hooks)))))
1234 (setq hooks (cdr hooks)))
1235 ;; If a hook returned t, file is already "written".
1236 (cond ((not done)
1237 (if (not (file-writable-p buffer-file-name))
1238 (let ((dir (file-name-directory buffer-file-name)))
1239 (if (not (file-directory-p dir))
1240 (error "%s is not a directory" dir)
1241 (if (not (file-exists-p buffer-file-name))
1242 (error "Directory %s write-protected" dir)
1243 (if (yes-or-no-p
1244 (format "File %s is write-protected; try to save anyway? "
1245 (file-name-nondirectory
1246 buffer-file-name)))
1247 (setq tempsetmodes t)
1248 (error "Attempt to save to a file which you aren't allowed to write"))))))
1249 (or buffer-backed-up
1250 (setq setmodes (backup-buffer)))
1251 (if file-precious-flag
1252 ;; If file is precious, write temp name, then rename it.
1253 (let ((dir (file-name-directory buffer-file-name))
1254 (realname buffer-file-name)
1255 tempname temp nogood i succeed)
1256 (setq i 0)
1257 (setq nogood t)
1258 ;; Find the temporary name to write under.
1259 (while nogood
1260 (setq tempname (format "%s#tmp#%d" dir i))
1261 (setq nogood (file-exists-p tempname))
1262 (setq i (1+ i)))
1263 (unwind-protect
1264 (progn (clear-visited-file-modtime)
1265 (write-region (point-min) (point-max)
1266 tempname nil realname)
1267 (setq succeed t))
1268 ;; If writing the temp file fails,
1269 ;; delete the temp file.
1270 (or succeed (delete-file tempname)))
1271 ;; We succeeded in writing the temp file,
1272 ;; so rename it.
1273 (rename-file tempname buffer-file-name t))
1274 ;; If file not writable, see if we can make it writable
1275 ;; temporarily while we write it.
1276 ;; But no need to do so if we have just backed it up
1277 ;; (setmodes is set) because that says we're superseding.
1278 (cond ((and tempsetmodes (not setmodes))
1279 ;; Change the mode back, after writing.
1280 (setq setmodes (file-modes buffer-file-name))
1281 (set-file-modes buffer-file-name 511)))
1282 (write-region (point-min) (point-max)
1283 buffer-file-name nil t)))))
1284 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
1285 (if setmodes
1286 (condition-case ()
1287 (set-file-modes buffer-file-name setmodes)
1288 (error nil))))
1289 ;; If the auto-save file was recent before this command,
1290 ;; delete it now.
1291 (delete-auto-save-file-if-necessary recent-save)
1292 (run-hooks 'after-save-hooks))
1293 (message "(No changes need to be saved)")))
1294
1295 (defun save-some-buffers (&optional arg exiting)
1296 "Save some modified file-visiting buffers. Asks user about each one.
1297 Optional argument (the prefix) non-nil means save all with no questions.
1298 Optional second argument EXITING means ask about certain non-file buffers
1299 as well as about file buffers."
1300 (interactive "P")
1301 (save-window-excursion
1302 (if (zerop (map-y-or-n-p
1303 (function
1304 (lambda (buffer)
1305 (and (buffer-modified-p buffer)
1306 (or
1307 (buffer-file-name buffer)
1308 (and exiting
1309 (progn
1310 (set-buffer buffer)
1311 (and buffer-offer-save (> (buffer-size) 0)))))
1312 (if arg
1313 t
1314 (if (buffer-file-name buffer)
1315 (format "Save file %s? "
1316 (buffer-file-name buffer))
1317 (format "Save buffer %s? "
1318 (buffer-name buffer)))))))
1319 (function
1320 (lambda (buffer)
1321 (set-buffer buffer)
1322 (save-buffer)))
1323 (buffer-list)
1324 '("buffer" "buffers" "save")
1325 (list (list ?\C-r (lambda (buf)
1326 (view-buffer buf)
1327 (setq view-exit-action
1328 '(lambda (ignore)
1329 (exit-recursive-edit)))
1330 (recursive-edit)
1331 ;; Return nil to ask about BUF again.
1332 nil)
1333 "display the current buffer"))
1334 ))
1335 (message "(No files need saving)"))))
1336 \f
1337 (defun not-modified (&optional arg)
1338 "Mark current buffer as unmodified, not needing to be saved.
1339 With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1340 (interactive "P")
1341 (message (if arg "Modification-flag set"
1342 "Modification-flag cleared"))
1343 (set-buffer-modified-p arg))
1344
1345 (defun toggle-read-only (&optional arg)
1346 "Change whether this buffer is visiting its file read-only.
1347 With arg, set read-only iff arg is positive."
1348 (interactive "P")
1349 (setq buffer-read-only
1350 (if (null arg)
1351 (not buffer-read-only)
1352 (> (prefix-numeric-value arg) 0)))
1353 ;; Force mode-line redisplay
1354 (set-buffer-modified-p (buffer-modified-p)))
1355
1356 (defun insert-file (filename)
1357 "Insert contents of file FILENAME into buffer after point.
1358 Set mark after the inserted text.
1359
1360 This function is meant for the user to run interactively.
1361 Don't call it from programs! Use `insert-file-contents' instead.
1362 \(Its calling sequence is different; see its documentation)."
1363 (interactive "fInsert file: ")
1364 (let ((tem (insert-file-contents filename)))
1365 (push-mark (+ (point) (car (cdr tem))))))
1366
1367 (defun append-to-file (start end filename)
1368 "Append the contents of the region to the end of file FILENAME.
1369 When called from a function, expects three arguments,
1370 START, END and FILENAME. START and END are buffer positions
1371 saying what text to write."
1372 (interactive "r\nFAppend to file: ")
1373 (write-region start end filename t))
1374
1375 (defun file-newest-backup (filename)
1376 "Return most recent backup file for FILENAME or nil if no backups exist."
1377 (let* ((filename (expand-file-name filename))
1378 (file (file-name-nondirectory filename))
1379 (dir (file-name-directory filename))
1380 (comp (file-name-all-completions file dir))
1381 newest)
1382 (while comp
1383 (setq file (concat dir (car comp))
1384 comp (cdr comp))
1385 (if (and (backup-file-name-p file)
1386 (or (null newest) (file-newer-than-file-p file newest)))
1387 (setq newest file)))
1388 newest))
1389
1390 (defun rename-uniquely ()
1391 "Rename current buffer to a similar name not already taken.
1392 This function is useful for creating multiple shell process buffers
1393 or multiple mail buffers, etc."
1394 (interactive)
1395 (let* ((new-buf (generate-new-buffer (buffer-name)))
1396 (name (buffer-name new-buf)))
1397 (kill-buffer new-buf)
1398 (rename-buffer name)
1399 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
1400
1401 (defun make-directory (dir &optional parents)
1402 "Create the directory DIR and any nonexistent parent dirs."
1403 (interactive "FMake directory: \nP")
1404 (let ((handler (find-file-name-handler dir)))
1405 (if handler
1406 (funcall handler 'make-directory dir parents)
1407 (if (not parents)
1408 (make-directory-internal dir)
1409 (let ((dir (directory-file-name (expand-file-name dir)))
1410 create-list)
1411 (while (not (file-exists-p dir))
1412 (setq create-list (cons dir create-list)
1413 dir (directory-file-name (file-name-directory dir))))
1414 (while create-list
1415 (make-directory-internal (car create-list))
1416 (setq create-list (cdr create-list))))))))
1417 \f
1418 (put 'revert-buffer-function 'permanent-local t)
1419 (defvar revert-buffer-function nil
1420 "Function to use to revert this buffer, or nil to do the default.")
1421
1422 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1423 (defvar revert-buffer-insert-file-contents-function nil
1424 "Function to use to insert contents when reverting this buffer.
1425 Gets two args, first the nominal file name to use,
1426 and second, t if reading the auto-save file.")
1427
1428 (defun revert-buffer (&optional check-auto noconfirm)
1429 "Replace the buffer text with the text of the visited file on disk.
1430 This undoes all changes since the file was visited or saved.
1431 With a prefix argument, offer to revert from latest auto-save file, if
1432 that is more recent than the visited file.
1433 When called from lisp, this is the first argument, CHECK-AUTO; it is optional.
1434 Optional second argument NOCONFIRM means don't ask for confirmation at all.
1435
1436 If the value of `revert-buffer-function' is non-nil, it is called to
1437 do the work."
1438 (interactive "P")
1439 (if revert-buffer-function
1440 (funcall revert-buffer-function (not check-auto) noconfirm)
1441 (let* ((opoint (point))
1442 (auto-save-p (and check-auto (recent-auto-save-p)
1443 buffer-auto-save-file-name
1444 (file-readable-p buffer-auto-save-file-name)
1445 (y-or-n-p
1446 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1447 (file-name (if auto-save-p
1448 buffer-auto-save-file-name
1449 buffer-file-name)))
1450 (cond ((null file-name)
1451 (error "Buffer does not seem to be associated with any file"))
1452 ((or noconfirm
1453 (yes-or-no-p (format "Revert buffer from file %s? "
1454 file-name)))
1455 ;; If file was backed up but has changed since,
1456 ;; we shd make another backup.
1457 (and (not auto-save-p)
1458 (not (verify-visited-file-modtime (current-buffer)))
1459 (setq buffer-backed-up nil))
1460 ;; Get rid of all undo records for this buffer.
1461 (or (eq buffer-undo-list t)
1462 (setq buffer-undo-list nil))
1463 (let ((buffer-read-only nil)
1464 ;; Don't make undo records for the reversion.
1465 (buffer-undo-list t))
1466 (if revert-buffer-insert-file-contents-function
1467 (funcall revert-buffer-insert-file-contents-function
1468 file-name auto-save-p)
1469 (if (not (file-exists-p file-name))
1470 (error "File %s no longer exists!" file-name))
1471 ;; Bind buffer-file-name to nil
1472 ;; so that we don't try to lock the file.
1473 (let ((buffer-file-name nil))
1474 (or auto-save-p
1475 (unlock-buffer))
1476 (erase-buffer))
1477 (insert-file-contents file-name (not auto-save-p))))
1478 (goto-char (min opoint (point-max)))
1479 (after-find-file nil nil t)
1480 t)))))
1481
1482 (defun recover-file (file)
1483 "Visit file FILE, but get contents from its last auto-save file."
1484 (interactive
1485 (let ((prompt-file buffer-file-name)
1486 (file-name nil)
1487 (file-dir nil))
1488 (and prompt-file
1489 (setq file-name (file-name-nondirectory prompt-file)
1490 file-dir (file-name-directory prompt-file)))
1491 (list (read-file-name "Recover file: "
1492 file-dir nil nil file-name))))
1493 (setq file (expand-file-name file))
1494 (if (auto-save-file-name-p file) (error "%s is an auto-save file" file))
1495 (let ((file-name (let ((buffer-file-name file))
1496 (make-auto-save-file-name))))
1497 (cond ((not (file-newer-than-file-p file-name file))
1498 (error "Auto-save file %s not current" file-name))
1499 ((save-window-excursion
1500 (if (not (eq system-type 'vax-vms))
1501 (with-output-to-temp-buffer "*Directory*"
1502 (buffer-disable-undo standard-output)
1503 (call-process "ls" nil standard-output nil
1504 (if (file-symlink-p file) "-lL" "-l")
1505 file file-name)))
1506 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1507 (switch-to-buffer (find-file-noselect file t))
1508 (let ((buffer-read-only nil))
1509 (erase-buffer)
1510 (insert-file-contents file-name nil))
1511 (after-find-file nil nil t))
1512 (t (error "Recover-file cancelled.")))))
1513
1514 (defun kill-some-buffers ()
1515 "For each buffer, ask whether to kill it."
1516 (interactive)
1517 (let ((list (buffer-list)))
1518 (while list
1519 (let* ((buffer (car list))
1520 (name (buffer-name buffer)))
1521 (and (not (string-equal name ""))
1522 (/= (aref name 0) ? )
1523 (yes-or-no-p
1524 (format "Buffer %s %s. Kill? "
1525 name
1526 (if (buffer-modified-p buffer)
1527 "HAS BEEN EDITED" "is unmodified")))
1528 (kill-buffer buffer)))
1529 (setq list (cdr list)))))
1530 \f
1531 (defun auto-save-mode (arg)
1532 "Toggle auto-saving of contents of current buffer.
1533 With prefix argument ARG, turn auto-saving on if positive, else off."
1534 (interactive "P")
1535 (setq buffer-auto-save-file-name
1536 (and (if (null arg)
1537 (not buffer-auto-save-file-name)
1538 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
1539 (if (and buffer-file-name auto-save-visited-file-name
1540 (not buffer-read-only))
1541 buffer-file-name
1542 (make-auto-save-file-name))))
1543 (if (interactive-p)
1544 (message "Auto-save %s (in this buffer)"
1545 (if buffer-auto-save-file-name "on" "off")))
1546 buffer-auto-save-file-name)
1547
1548 (defun rename-auto-save-file ()
1549 "Adjust current buffer's auto save file name for current conditions.
1550 Also rename any existing auto save file, if it was made in this session."
1551 (let ((osave buffer-auto-save-file-name))
1552 (setq buffer-auto-save-file-name
1553 (make-auto-save-file-name))
1554 (if (and osave buffer-auto-save-file-name
1555 (not (string= buffer-auto-save-file-name buffer-file-name))
1556 (not (string= buffer-auto-save-file-name osave))
1557 (file-exists-p osave)
1558 (recent-auto-save-p))
1559 (rename-file osave buffer-auto-save-file-name t))))
1560
1561 (defun make-auto-save-file-name ()
1562 "Return file name to use for auto-saves of current buffer.
1563 Does not consider `auto-save-visited-file-name' as that variable is checked
1564 before calling this function. You can redefine this for customization.
1565 See also `auto-save-file-name-p'."
1566 (if buffer-file-name
1567 (concat (file-name-directory buffer-file-name)
1568 "#"
1569 (file-name-nondirectory buffer-file-name)
1570 "#")
1571 ;; For non-file bfr, use bfr name and Emacs pid.
1572 (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))))
1573
1574 (defun auto-save-file-name-p (filename)
1575 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
1576 FILENAME should lack slashes. You can redefine this for customization."
1577 (string-match "^#.*#$" filename))
1578 \f
1579 (defconst list-directory-brief-switches
1580 (if (eq system-type 'vax-vms) "" "-CF")
1581 "*Switches for list-directory to pass to `ls' for brief listing,")
1582
1583 (defconst list-directory-verbose-switches
1584 (if (eq system-type 'vax-vms)
1585 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
1586 "-l")
1587 "*Switches for list-directory to pass to `ls' for verbose listing,")
1588
1589 (defun list-directory (dirname &optional verbose)
1590 "Display a list of files in or matching DIRNAME, a la `ls'.
1591 DIRNAME is globbed by the shell if necessary.
1592 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
1593 Actions controlled by variables `list-directory-brief-switches'
1594 and `list-directory-verbose-switches'."
1595 (interactive (let ((pfx current-prefix-arg))
1596 (list (read-file-name (if pfx "List directory (verbose): "
1597 "List directory (brief): ")
1598 nil default-directory nil)
1599 pfx)))
1600 (let ((switches (if verbose list-directory-verbose-switches
1601 list-directory-brief-switches)))
1602 (or dirname (setq dirname default-directory))
1603 (setq dirname (expand-file-name dirname))
1604 (with-output-to-temp-buffer "*Directory*"
1605 (buffer-disable-undo standard-output)
1606 (princ "Directory ")
1607 (princ dirname)
1608 (terpri)
1609 (save-excursion
1610 (set-buffer "*Directory*")
1611 (let ((wildcard (not (file-directory-p dirname))))
1612 (insert-directory dirname switches wildcard (not wildcard)))))))
1613
1614 (defvar insert-directory-program "ls"
1615 "Absolute or relative name of the `ls' program used by `insert-directory'.")
1616
1617 ;; insert-directory
1618 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
1619 ;; FULL-DIRECTORY-P is nil.
1620 ;; The single line of output must display FILE's name as it was
1621 ;; given, namely, an absolute path name.
1622 ;; - must insert exactly one line for each file if WILDCARD or
1623 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
1624 ;; before the file lines, plus optional text after the file lines.
1625 ;; Lines are delimited by "\n", so filenames containing "\n" are not
1626 ;; allowed.
1627 ;; File lines should display the basename.
1628 ;; - must be consistent with
1629 ;; - functions dired-move-to-filename, (these two define what a file line is)
1630 ;; dired-move-to-end-of-filename,
1631 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
1632 ;; dired-insert-headerline
1633 ;; dired-after-subdir-garbage (defines what a "total" line is)
1634 ;; - variable dired-subdir-regexp
1635 (defun insert-directory (file switches &optional wildcard full-directory-p)
1636 "Insert directory listing for of FILE, formatted according to SWITCHES.
1637 Leaves point after the inserted text.
1638 Optional third arg WILDCARD means treat FILE as shell wildcard.
1639 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
1640 switches do not contain `d', so that a full listing is expected.
1641
1642 This works by running a directory listing program
1643 whose name is in the variable `ls-program'.
1644 If WILDCARD, it also runs the shell specified by `shell-file-name'."
1645 (let ((handler (find-file-name-handler file)))
1646 (if handler
1647 (funcall handler 'insert-directory file switches
1648 wildcard full-directory-p)
1649 (if (eq system-type 'vax-vms)
1650 (vms-read-directory file switches (current-buffer))
1651 (if wildcard
1652 (let ((default-directory (file-name-directory file)))
1653 (call-process shell-file-name nil t nil
1654 "-c" (concat insert-directory-program
1655 " -d " switches " "
1656 (file-name-nondirectory file))))
1657 ;;; ;; Chase links till we reach a non-link.
1658 ;;; (let (symlink)
1659 ;;; (while (setq symlink (file-symlink-p file))
1660 ;;; (setq file symlink)))
1661 (call-process insert-directory-program nil t nil switches file))))))
1662
1663 (defun save-buffers-kill-emacs (&optional arg)
1664 "Offer to save each buffer, then kill this Emacs process.
1665 With prefix arg, silently save all file-visiting buffers, then kill."
1666 (interactive "P")
1667 (save-some-buffers arg t)
1668 (and (or (not (memq t (mapcar (function
1669 (lambda (buf) (and (buffer-file-name buf)
1670 (buffer-modified-p buf))))
1671 (buffer-list))))
1672 (yes-or-no-p "Modified buffers exist; exit anyway? "))
1673 (or (not (fboundp 'process-list))
1674 ;; process-list is not defined on VMS.
1675 (let ((processes (process-list))
1676 active)
1677 (while processes
1678 (and (memq (process-status (car processes)) '(run stop open))
1679 (let ((val (process-kill-without-query (car processes))))
1680 (process-kill-without-query (car processes) val)
1681 val)
1682 (setq active t))
1683 (setq processes (cdr processes)))
1684 (or (not active)
1685 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
1686 (kill-emacs)))
1687 \f
1688 (define-key ctl-x-map "\C-f" 'find-file)
1689 (define-key ctl-x-map "\C-q" 'toggle-read-only)
1690 (define-key ctl-x-map "\C-r" 'find-file-read-only)
1691 (define-key ctl-x-map "\C-v" 'find-alternate-file)
1692 (define-key ctl-x-map "\C-s" 'save-buffer)
1693 (define-key ctl-x-map "s" 'save-some-buffers)
1694 (define-key ctl-x-map "\C-w" 'write-file)
1695 (define-key ctl-x-map "i" 'insert-file)
1696 (define-key esc-map "~" 'not-modified)
1697 (define-key ctl-x-map "\C-d" 'list-directory)
1698 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
1699
1700 (define-key ctl-x-4-map "f" 'find-file-other-window)
1701 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
1702 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
1703 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
1704 (define-key ctl-x-4-map "\C-o" 'display-buffer)
1705
1706 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
1707 (define-key ctl-x-5-map "f" 'find-file-other-frame)
1708 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
1709 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
1710
1711 ;;; files.el ends here