1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 1995 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
31 (defconst delete-auto-save-files t
32 "*Non-nil means delete auto-save file when a buffer is saved or killed.")
34 (defconst directory-abbrev-alist
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 `^'.
42 Do not use `~' in the TO strings.
43 They should be ordinary absolute directory names.
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.")
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.
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.
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.
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'.")
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)
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'.")
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.")
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.")
93 (defvar backup-enable-predicate
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.")
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)
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.")
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.")
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)
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)
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.
135 This feature works by writing the new contents into a temporary file
136 and then renaming the temporary file to replace the original.
137 In this way, any I/O error in writing leaves the original untouched,
138 and there is never any instant where the file is nonexistent.
140 Note that this feature forces backups to be made by copying.
141 Yet, at the same time, saving a precious file
142 breaks any hard links between it and other files.")
144 (defvar version-control nil
145 "*Control use of version numbers for backup files.
146 t means make numeric backup versions unconditionally.
147 nil means make them for files that have some already.
148 `never' means do not make them.")
150 (defvar dired-kept-versions 2
151 "*When cleaning directory, number of versions to keep.")
153 (defvar delete-old-versions nil
154 "*If t, delete excess backup versions silently.
155 If nil, ask confirmation. Any other value prevents any trimming.")
157 (defvar kept-old-versions 2
158 "*Number of oldest versions to keep when a new numbered backup is made.")
160 (defvar kept-new-versions 2
161 "*Number of newest versions to keep when a new numbered backup is made.
162 Includes the new backup. Must be > 0")
164 (defconst require-final-newline nil
165 "*Value of t says silently ensure a file ends in a newline when it is saved.
166 Non-nil but not t says ask user whether to add a newline when there isn't one.
167 nil means don't add newlines.")
169 (defconst auto-save-default t
170 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
172 (defconst auto-save-visited-file-name nil
173 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
174 Normally auto-save files are written under other names.")
176 (defconst save-abbrevs nil
177 "*Non-nil means save word abbrevs too when files are saved.
178 Loading an abbrev file sets this to t.")
180 (defconst find-file-run-dired t
181 "*Non-nil says run dired if `find-file' is given the name of a directory.")
183 ;;;It is not useful to make this a local variable.
184 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
185 (defvar find-file-not-found-hooks nil
186 "List of functions to be called for `find-file' on nonexistent file.
187 These functions are called as soon as the error is detected.
188 `buffer-file-name' is already set up.
189 The functions are called in the order given until one of them returns non-nil.")
191 ;;;It is not useful to make this a local variable.
192 ;;;(put 'find-file-hooks 'permanent-local t)
193 (defvar find-file-hooks nil
194 "List of functions to be called after a buffer is loaded from a file.
195 The buffer's local variables (if any) will have been processed before the
196 functions are called.")
198 (defvar write-file-hooks nil
199 "List of functions to be called before writing out a buffer to a file.
200 If one of them returns non-nil, the file is considered already written
201 and the rest are not called.
202 These hooks are considered to pertain to the visited file.
203 So this list is cleared if you change the visited file name.
204 See also `write-contents-hooks'.
205 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
206 ;;; However, in case someone does make it local...
207 (put 'write-file-hooks 'permanent-local t)
209 (defvar local-write-file-hooks nil
210 "Just like `write-file-hooks', except intended for per-buffer use.
211 The functions in this list are called before the ones in
212 `write-file-hooks'.")
213 (make-variable-buffer-local 'local-write-file-hooks)
214 (put 'local-write-file-hooks 'permanent-local t)
216 (defvar write-contents-hooks nil
217 "List of functions to be called before writing out a buffer to a file.
218 If one of them returns non-nil, the file is considered already written
219 and the rest are not called.
220 These hooks are considered to pertain to the buffer's contents,
221 not to the particular visited file; thus, `set-visited-file-name' does
222 not clear this variable, but changing the major mode does clear it.
223 See also `write-file-hooks'.")
225 (defconst enable-local-variables t
226 "*Control use of local-variables lists in files you visit.
227 The value can be t, nil or something else.
228 A value of t means local-variables lists are obeyed;
229 nil means they are ignored; anything else means query.
231 The command \\[normal-mode] always obeys local-variables lists
232 and ignores this variable.")
234 (defconst enable-local-eval 'maybe
235 "*Control processing of the \"variable\" `eval' in a file's local variables.
236 The value can be t, nil or something else.
237 A value of t means obey `eval' variables;
238 nil means ignore them; anything else means query.
240 The command \\[normal-mode] always obeys local-variables lists
241 and ignores this variable.")
243 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
244 (or (fboundp 'lock-buffer)
245 (defalias 'lock-buffer 'ignore))
246 (or (fboundp 'unlock-buffer)
247 (defalias 'unlock-buffer 'ignore))
249 ;; This hook function provides support for ange-ftp host name
250 ;; completion. It runs the usual ange-ftp hook, but only for
251 ;; completion operations. Having this here avoids the need
252 ;; to load ange-ftp when it's not really in use.
253 (defun ange-ftp-completion-hook-function (op &rest args)
254 (if (memq op '(file-name-completion file-name-all-completions))
255 (apply 'ange-ftp-hook-function op args)
256 (let ((inhibit-file-name-handlers
257 (cons 'ange-ftp-completion-hook-function
258 (and (eq inhibit-file-name-operation op)
259 inhibit-file-name-handlers)))
260 (inhibit-file-name-operation op))
264 "Show the current default directory."
266 (message "Directory %s" default-directory))
269 "Value of the CDPATH environment variable, as a list.
270 Not actually set up until the first time you you use it.")
272 (defvar path-separator ":"
273 "Character used to separate concatenated paths.")
275 (defun parse-colon-path (cd-path)
276 "Explode a colon-separated list of paths into a string list."
278 (let (cd-prefix cd-list (cd-start 0) cd-colon)
279 (setq cd-path (concat cd-path path-separator))
280 (while (setq cd-colon (string-match path-separator cd-path cd-start))
283 (list (if (= cd-start cd-colon)
285 (substitute-in-file-name
286 (file-name-as-directory
287 (substring cd-path cd-start cd-colon)))))))
288 (setq cd-start (+ cd-colon 1)))
291 (defun cd-absolute (dir)
292 "Change current directory to given absolute file name DIR."
293 ;; Put the name into directory syntax now,
294 ;; because otherwise expand-file-name may give some bad results.
295 (if (not (eq system-type 'vax-vms))
296 (setq dir (file-name-as-directory dir)))
297 (setq dir (abbreviate-file-name (expand-file-name dir)))
298 (if (not (file-directory-p dir))
299 (error "%s is not a directory" dir)
300 (if (file-executable-p dir)
301 (setq default-directory dir)
302 (error "Cannot cd to %s: Permission denied" dir))))
305 "Make DIR become the current buffer's default directory.
306 If your environment includes a `CDPATH' variable, try each one of that
307 colon-separated list of directories when resolving a relative directory name."
308 (interactive "FChange default directory: ")
309 (if (file-name-absolute-p dir)
310 (cd-absolute (expand-file-name dir))
312 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
313 (setq cd-path (or trypath (list "./")))))
314 (if (not (catch 'found
316 (function (lambda (x)
317 (let ((f (expand-file-name (concat x dir))))
318 (if (file-directory-p f)
321 (throw 'found t))))))
324 (error "No such directory found via CDPATH environment variable"))))
326 (defun load-file (file)
327 "Load the Lisp file named FILE."
328 (interactive "fLoad file: ")
329 (load (expand-file-name file) nil nil t))
331 (defun load-library (library)
332 "Load the library named LIBRARY.
333 This is an interface to the function `load'."
334 (interactive "sLoad library: ")
337 (defun file-local-copy (file &optional buffer)
338 "Copy the file FILE into a temporary file on this machine.
339 Returns the name of the local copy, or nil, if FILE is directly
341 (let ((handler (find-file-name-handler file 'file-local-copy)))
343 (funcall handler 'file-local-copy file)
346 (defun file-truename (filename &optional counter prev-dirs)
347 "Return the truename of FILENAME, which should be absolute.
348 The truename of a file name is found by chasing symbolic links
349 both at the level of the file and at the level of the directories
350 containing it, until no links are left at any level.
352 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
353 Do not specify them in other calls."
354 ;; COUNTER can be a cons cell whose car is the count of how many more links
355 ;; to chase before getting an error.
356 ;; PREV-DIRS can be a cons cell whose car is an alist
357 ;; of truenames we've just recently computed.
358 (if (or (string= filename "~")
359 (and (string= (substring filename 0 1) "~")
360 (string-match "~[^/]*" filename)))
362 (setq filename (expand-file-name filename))
363 (if (string= filename "")
364 (setq filename "/"))))
365 (or counter (setq counter (list 100)))
367 ;; For speed, remove the ange-ftp completion handler from the list.
368 ;; We know it's not needed here.
369 ;; For even more speed, do this only on the outermost call.
370 (file-name-handler-alist
371 (if prev-dirs file-name-handler-alist
372 (let ((tem (copy-sequence file-name-handler-alist)))
373 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
374 (or prev-dirs (setq prev-dirs (list nil)))
375 ;; If this file directly leads to a link, process that iteratively
376 ;; so that we don't use lots of stack.
378 (setcar counter (1- (car counter)))
379 (if (< (car counter) 0)
380 (error "Apparent cycle of symbolic links for %s" filename))
381 (let ((handler (find-file-name-handler filename 'file-truename)))
382 ;; For file name that has a special handler, call handler.
383 ;; This is so that ange-ftp can save time by doing a no-op.
385 (setq filename (funcall handler 'file-truename filename)
387 (let ((dir (or (file-name-directory filename) default-directory))
389 ;; Get the truename of the directory.
390 (setq dirfile (directory-file-name dir))
391 ;; If these are equal, we have the (or a) root directory.
392 (or (string= dir dirfile)
393 ;; If this is the same dir we last got the truename for,
394 ;; save time--don't recalculate.
395 (if (assoc dir (car prev-dirs))
396 (setq dir (cdr (assoc dir (car prev-dirs))))
398 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
399 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
401 (if (equal ".." (file-name-nondirectory filename))
403 (directory-file-name (file-name-directory (directory-file-name dir)))
405 (if (equal "." (file-name-nondirectory filename))
406 (setq filename (directory-file-name dir)
408 ;; Put it back on the file name.
409 (setq filename (concat dir (file-name-nondirectory filename)))
410 ;; Is the file name the name of a link?
411 (setq target (file-symlink-p filename))
413 ;; Yes => chase that link, then start all over
414 ;; since the link may point to a directory name that uses links.
415 ;; We can't safely use expand-file-name here
416 ;; since target might look like foo/../bar where foo
417 ;; is itself a link. Instead, we handle . and .. above.
419 (if (file-name-absolute-p target)
427 (defun file-chase-links (filename)
428 "Chase links in FILENAME until a name that is not a link.
429 Does not examine containing directories for links,
430 unlike `file-truename'."
431 (let (tem (count 100) (newname filename))
432 (while (setq tem (file-symlink-p newname))
434 (error "Apparent cycle of symbolic links for %s" filename))
435 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
436 (while (string-match "//+" tem)
437 (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
438 (substring tem (match-end 0)))))
439 ;; Handle `..' by hand, since it needs to work in the
440 ;; target of any directory symlink.
441 ;; This code is not quite complete; it does not handle
442 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
443 (while (string-match "\\`\\.\\./" tem)
444 (setq tem (substring tem 3))
445 (setq newname (file-name-as-directory
446 ;; Do the .. by hand.
449 ;; Chase links in the default dir of the symlink.
452 (file-name-directory newname))))))))
453 (setq newname (expand-file-name tem (file-name-directory newname)))
454 (setq count (1- count)))
457 (defun switch-to-buffer-other-window (buffer)
458 "Select buffer BUFFER in another window."
459 (interactive "BSwitch to buffer in other window: ")
460 (let ((pop-up-windows t))
461 (pop-to-buffer buffer t)))
463 (defun switch-to-buffer-other-frame (buffer)
464 "Switch to buffer BUFFER in another frame."
465 (interactive "BSwitch to buffer in other frame: ")
466 (let ((pop-up-frames t))
467 (pop-to-buffer buffer t)
468 (raise-frame (window-frame (selected-window)))))
470 (defun find-file (filename)
472 Switch to a buffer visiting file FILENAME,
473 creating one if none already exists."
474 (interactive "FFind file: ")
475 (switch-to-buffer (find-file-noselect filename)))
477 (defun find-file-other-window (filename)
478 "Edit file FILENAME, in another window.
479 May create a new window, or reuse an existing one.
480 See the function `display-buffer'."
481 (interactive "FFind file in other window: ")
482 (switch-to-buffer-other-window (find-file-noselect filename)))
484 (defun find-file-other-frame (filename)
485 "Edit file FILENAME, in another frame.
486 May create a new frame, or reuse an existing one.
487 See the function `display-buffer'."
488 (interactive "FFind file in other frame: ")
489 (switch-to-buffer-other-frame (find-file-noselect filename)))
491 (defun find-file-read-only (filename)
492 "Edit file FILENAME but don't allow changes.
493 Like \\[find-file] but marks buffer as read-only.
494 Use \\[toggle-read-only] to permit editing."
495 (interactive "fFind file read-only: ")
497 (setq buffer-read-only t)
500 (defun find-file-read-only-other-window (filename)
501 "Edit file FILENAME in another window but don't allow changes.
502 Like \\[find-file-other-window] but marks buffer as read-only.
503 Use \\[toggle-read-only] to permit editing."
504 (interactive "fFind file read-only other window: ")
505 (find-file-other-window filename)
506 (setq buffer-read-only t)
509 (defun find-file-read-only-other-frame (filename)
510 "Edit file FILENAME in another frame but don't allow changes.
511 Like \\[find-file-other-frame] but marks buffer as read-only.
512 Use \\[toggle-read-only] to permit editing."
513 (interactive "fFind file read-only other frame: ")
514 (find-file-other-frame filename)
515 (setq buffer-read-only t)
518 (defun find-alternate-file (filename)
519 "Find file FILENAME, select its buffer, kill previous buffer.
520 If the current buffer now contains an empty file that you just visited
521 \(presumably by mistake), use this command to visit the file you really want."
523 (let ((file buffer-file-name)
527 (setq file-name (file-name-nondirectory file)
528 file-dir (file-name-directory file)))
529 (list (read-file-name
530 "Find alternate file: " file-dir nil nil file-name))))
531 (and (buffer-modified-p) (buffer-file-name)
532 ;; (not buffer-read-only)
533 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
536 (let ((obuf (current-buffer))
537 (ofile buffer-file-name)
538 (onum buffer-file-number)
539 (otrue buffer-file-truename)
540 (oname (buffer-name)))
541 (rename-buffer " **lose**")
542 (setq buffer-file-name nil)
543 (setq buffer-file-number nil)
544 (setq buffer-file-truename nil)
548 (find-file filename))
549 (cond ((eq obuf (current-buffer))
550 (setq buffer-file-name ofile)
551 (setq buffer-file-number onum)
552 (setq buffer-file-truename otrue)
554 (rename-buffer oname))))
555 (or (eq (current-buffer) obuf)
556 (kill-buffer obuf))))
558 (defun create-file-buffer (filename)
559 "Create a suitably named buffer for visiting FILENAME, and return it.
560 FILENAME (sans directory) is used unchanged if that name is free;
561 otherwise a string <2> or <3> or ... is appended to get an unused name."
562 (let ((lastname (file-name-nondirectory filename)))
563 (if (string= lastname "")
564 (setq lastname filename))
565 (generate-new-buffer lastname)))
567 (defun generate-new-buffer (name)
568 "Create and return a buffer with a name based on NAME.
569 Choose the buffer's name using `generate-new-buffer-name'."
570 (get-buffer-create (generate-new-buffer-name name)))
572 (defconst automount-dir-prefix "^/tmp_mnt/"
573 "Regexp to match the automounter prefix in a directory name.")
575 (defvar abbreviated-home-dir nil
576 "The user's homedir abbreviated according to `directory-abbrev-list'.")
578 (defun abbreviate-file-name (filename)
579 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
580 This also substitutes \"~\" for the user's home directory.
581 Type \\[describe-variable] directory-abbrev-alist RET for more information."
582 ;; Get rid of the prefixes added by the automounter.
583 (if (and (string-match automount-dir-prefix filename)
584 (file-exists-p (file-name-directory
585 (substring filename (1- (match-end 0))))))
586 (setq filename (substring filename (1- (match-end 0)))))
587 (let ((tail directory-abbrev-alist))
588 ;; If any elt of directory-abbrev-alist matches this name,
589 ;; abbreviate accordingly.
591 (if (string-match (car (car tail)) filename)
593 (concat (cdr (car tail)) (substring filename (match-end 0)))))
594 (setq tail (cdr tail)))
595 ;; Compute and save the abbreviated homedir name.
596 ;; We defer computing this until the first time it's needed, to
597 ;; give time for directory-abbrev-alist to be set properly.
598 ;; We include a slash at the end, to avoid spurious matches
599 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
600 (or abbreviated-home-dir
601 (setq abbreviated-home-dir
602 (let ((abbreviated-home-dir "$foo"))
603 (concat "^" (abbreviate-file-name (expand-file-name "~"))
606 ;; If FILENAME starts with the abbreviated homedir,
607 ;; make it start with `~' instead.
608 (if (and (string-match abbreviated-home-dir filename)
609 ;; If the home dir is just /, don't change it.
610 (not (and (= (match-end 0) 1)
611 (= (aref filename 0) ?/)))
612 (not (and (or (eq system-type 'ms-dos)
613 (eq system-type 'windows-nt))
615 (string-match "^[a-zA-Z]:/$" filename)))))
618 (substring filename (match-beginning 1) (match-end 1))
619 (substring filename (match-end 0)))))
622 (defvar find-file-not-true-dirname-list nil
623 "*List of logical names for which visiting shouldn't save the true dirname.
624 On VMS, when you visit a file using a logical name that searches a path,
625 you may or may not want the visited file name to record the specific
626 directory where the file was found. If you *do not* want that, add the logical
627 name to this list as a string.")
629 (defun find-buffer-visiting (filename)
630 "Return the buffer visiting file FILENAME (a string).
631 This is like `get-file-buffer', except that it checks for any buffer
632 visiting the same file, possibly under a different name.
633 If there is no such live buffer, return nil."
634 (let ((buf (get-file-buffer filename))
635 (truename (abbreviate-file-name (file-truename filename))))
637 (let ((list (buffer-list)) found)
638 (while (and (not found) list)
640 (set-buffer (car list))
641 (if (and buffer-file-name
642 (string= buffer-file-truename truename))
643 (setq found (car list))))
644 (setq list (cdr list)))
646 (let ((number (nthcdr 10 (file-attributes truename)))
647 (list (buffer-list)) found)
649 (while (and (not found) list)
651 (set-buffer (car list))
652 (if (and buffer-file-name
653 (equal buffer-file-number number)
654 ;; Verify this buffer's file number
655 ;; still belongs to its file.
656 (file-exists-p buffer-file-name)
657 (equal (nthcdr 10 (file-attributes buffer-file-name))
659 (setq found (car list))))
660 (setq list (cdr list))))
663 (defun find-file-noselect (filename &optional nowarn)
664 "Read file FILENAME into a buffer and return the buffer.
665 If a buffer exists visiting FILENAME, return that one, but
666 verify that the file has not changed since visited or saved.
667 The buffer is not selected, just returned to the caller."
669 (abbreviate-file-name
670 (expand-file-name filename)))
671 (if (file-directory-p filename)
672 (if find-file-run-dired
673 (dired-noselect filename)
674 (error "%s is a directory." filename))
675 (let* ((buf (get-file-buffer filename))
676 (truename (abbreviate-file-name (file-truename filename)))
677 (number (nthcdr 10 (file-attributes truename)))
678 ;; Find any buffer for a file which has same truename.
679 (other (and (not buf) (find-buffer-visiting filename)))
681 ;; Let user know if there is a buffer with the same truename.
685 (string-equal filename (buffer-file-name other))
686 (message "%s and %s are the same file"
687 filename (buffer-file-name other)))
688 ;; Optionally also find that buffer.
689 (if (or find-file-existing-other-name find-file-visit-truename)
693 (verify-visited-file-modtime buf)
694 (cond ((not (file-exists-p filename))
695 (error "File %s no longer exists!" filename))
697 (if (string= (file-name-nondirectory filename)
700 (if (buffer-modified-p buf)
701 "File %s changed on disk. Discard your edits? "
702 "File %s changed on disk. Reread from disk? ")
703 (file-name-nondirectory filename))
705 (if (buffer-modified-p buf)
706 "File %s changed on disk. Discard your edits in %s? "
707 "File %s changed on disk. Reread from disk into %s? ")
708 (file-name-nondirectory filename)
712 (revert-buffer t t)))))
714 ;;; The truename stuff makes this obsolete.
715 ;;; (let* ((link-name (car (file-attributes filename)))
716 ;;; (linked-buf (and (stringp link-name)
717 ;;; (get-file-buffer link-name))))
718 ;;; (if (bufferp linked-buf)
719 ;;; (message "Symbolic link to file in buffer %s"
720 ;;; (buffer-name linked-buf))))
721 (setq buf (create-file-buffer filename))
722 (set-buffer-major-mode buf)
726 (insert-file-contents filename t)
728 ;; Run find-file-not-found-hooks until one returns non-nil.
729 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
730 ;; If they fail too, set error.
732 ;; Find the file's truename, and maybe use that as visited name.
733 (setq buffer-file-truename truename)
734 (setq buffer-file-number number)
735 ;; On VMS, we may want to remember which directory in a search list
736 ;; the file was found in.
737 (and (eq system-type 'vax-vms)
739 (if (string-match ":" (file-name-directory filename))
740 (setq logical (substring (file-name-directory filename)
741 0 (match-beginning 0))))
742 (not (member logical find-file-not-true-dirname-list)))
743 (setq buffer-file-name buffer-file-truename))
744 (if find-file-visit-truename
745 (setq buffer-file-name
747 (expand-file-name buffer-file-truename))))
748 ;; Set buffer's default directory to that of the file.
749 (setq default-directory (file-name-directory filename))
750 ;; Turn off backup files for certain file names. Since
751 ;; this is a permanent local, the major mode won't eliminate it.
752 (and (not (funcall backup-enable-predicate buffer-file-name))
754 (make-local-variable 'backup-inhibited)
755 (setq backup-inhibited t)))
756 (after-find-file error (not nowarn))))
759 (defvar after-find-file-from-revert-buffer nil)
761 (defun after-find-file (&optional error warn noauto
762 after-find-file-from-revert-buffer)
763 "Called after finding a file and by the default revert function.
764 Sets buffer mode, parses local variables.
765 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
766 error in reading the file. WARN non-nil means warn if there
767 exists an auto-save file more recent than the visited file.
768 NOAUTO means don't mess with auto-save mode.
769 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
770 means this call was from `revert-buffer'.
771 Finishes by calling the functions in `find-file-hooks'."
772 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
777 (cond ((and error (file-attributes buffer-file-name))
778 (setq buffer-read-only t)
779 "File exists, but cannot be read.")
780 ((not buffer-read-only)
782 (file-newer-than-file-p (make-auto-save-file-name)
784 "Auto save file is newer; consider M-x recover-file"
786 (if error "(New file)" nil)))
789 "Note: file is write protected")
790 ((file-attributes (directory-file-name default-directory))
791 "File not found and directory write-protected")
792 ((file-exists-p (file-name-directory buffer-file-name))
793 (setq buffer-read-only nil))
795 (setq buffer-read-only nil)
796 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
797 "Use M-x make-dir RET RET to create the directory"
798 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
802 (or not-serious (sit-for 1 nil t)))))
803 (if (and auto-save-default (not noauto))
806 (run-hooks 'find-file-hooks))
808 (defun normal-mode (&optional find-file)
809 "Choose the major mode for this buffer automatically.
810 Also sets up any specified local variables of the file.
811 Uses the visited file name, the -*- line, and the local variables spec.
813 This function is called automatically from `find-file'. In that case,
814 we may set up specified local variables depending on the value of
815 `enable-local-variables': if it is t, we do; if it is nil, we don't;
816 otherwise, we query. `enable-local-variables' is ignored if you
817 run `normal-mode' explicitly."
819 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
822 (error (message "File mode specification error: %s"
823 (prin1-to-string err))))
825 (let ((enable-local-variables (or (not find-file)
826 enable-local-variables)))
827 (hack-local-variables))
828 (error (message "File local-variables error: %s"
829 (prin1-to-string err)))))
831 (defvar auto-mode-alist (mapcar 'purecopy
832 '(("\\.text\\'" . text-mode)
835 ("\\.tex\\'" . tex-mode)
836 ("\\.ltx\\'" . latex-mode)
837 ("\\.el\\'" . emacs-lisp-mode)
838 ("\\.mm\\'" . nroff-mode)
839 ("\\.me\\'" . nroff-mode)
840 ("\\.ms\\'" . nroff-mode)
841 ("\\.man\\'" . nroff-mode)
842 ("\\.scm\\'" . scheme-mode)
843 ("\\.l\\'" . lisp-mode)
844 ("\\.lisp\\'" . lisp-mode)
845 ("\\.f\\'" . fortran-mode)
846 ("\\.for\\'" . fortran-mode)
847 ("\\.p\\'" . pascal-mode)
848 ("\\.pas\\'" . pascal-mode)
849 ("\\.mss\\'" . scribe-mode)
850 ("\\.ada\\'" . ada-mode)
851 ("\\.icn\\'" . icon-mode)
852 ("\\.pl\\'" . prolog-mode)
853 ("\\.cc\\'" . c++-mode)
854 ("\\.hh\\'" . c++-mode)
855 ("\\.C\\'" . c++-mode)
856 ("\\.H\\'" . c++-mode)
857 ("\\.cpp\\'" . c++-mode)
858 ("\\.cxx\\'" . c++-mode)
859 ("\\.hxx\\'" . c++-mode)
860 ("\\.c\\+\\+\\'" . c++-mode)
861 ("\\.h\\+\\+\\'" . c++-mode)
862 ;;; ("\\.mk\\'" . makefile-mode)
863 ;;; ("[Mm]akefile" . makefile-mode)
864 ;;; Less common extensions come here
865 ;;; so more common ones above are found faster.
866 ("\\.texinfo\\'" . texinfo-mode)
867 ("\\.texi\\'" . texinfo-mode)
868 ("\\.s\\'" . asm-mode)
869 ("ChangeLog\\'" . change-log-mode)
870 ("change.log\\'" . change-log-mode)
871 ("changelo\\'" . change-log-mode)
872 ("ChangeLog.[0-9]+\\'" . change-log-mode)
873 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
874 ;; The following should come after the ChangeLog pattern
875 ;; for the sake of ChangeLog.1, etc.
876 ("\\.[12345678]\\'" . nroff-mode)
877 ("\\.TeX\\'" . tex-mode)
878 ("\\.sty\\'" . latex-mode)
879 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
880 ("\\.bbl\\'" . latex-mode)
881 ("\\.bib\\'" . bibtex-mode)
882 ("\\.article\\'" . text-mode)
883 ("\\.letter\\'" . text-mode)
884 ("\\.tcl\\'" . tcl-mode)
885 ("\\.lsp\\'" . lisp-mode)
886 ("\\.awk\\'" . awk-mode)
887 ("\\.prolog\\'" . prolog-mode)
888 ("\\.tar\\'" . tar-mode)
889 ;; Mailer puts message to be edited in
890 ;; /tmp/Re.... or Message
891 ("^/tmp/Re" . text-mode)
892 ("/Message[0-9]*\\'" . text-mode)
893 ("/drafts/[0-9]+\\'" . mh-letter-mode)
894 ;; some news reader is reported to use this
895 ("^/tmp/fol/" . text-mode)
897 ("\\.lex\\'" . c-mode)
898 ("\\.oak\\'" . scheme-mode)
899 ("\\.scm.[0-9]*\\'" . scheme-mode)
900 ("\\.sgm\\'" . sgml-mode)
901 ("\\.sgml\\'" . sgml-mode)
902 ("\\.dtd\\'" . sgml-mode)
903 ;; .emacs following a directory delimiter
904 ;; in either Unix or VMS syntax.
905 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
906 ;; _emacs following a directory delimiter
908 ("[:/]_emacs\\'" . emacs-lisp-mode)
909 ("\\.ml\\'" . lisp-mode)))
911 Alist of filename patterns vs corresponding major mode functions.
912 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
913 \(NON-NIL stands for anything that is not nil; the value does not matter.)
914 Visiting a file whose name matches REGEXP specifies FUNCTION as the
915 mode function to use. FUNCTION will be called, unless it is nil.
917 If the element has the form (REGEXP FUNCTION NON-NIL), then after
918 calling FUNCTION (if it's not nil), we delete the suffix that matched
919 REGEXP and search the list again for another match.")
921 (defconst interpreter-mode-alist
922 '(("perl" . perl-mode)
929 ("scm" . scheme-mode))
930 "Alist mapping interpreter names to major modes.
931 This alist applies to files whose first line starts with `#!'.
932 Each element looks like (INTERPRETER . MODE).
933 The car of each element is compared with
934 the name of the interpreter specified in the first line.
935 If it matches, mode MODE is selected.")
937 (defconst inhibit-first-line-modes-regexps '("\\.tar\\'")
938 "List of regexps; if one matches a file name, don't look for `-*-'.")
940 (defconst inhibit-first-line-modes-suffixes nil
941 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
942 When checking `inhibit-first-line-modes-regexps', we first discard
943 from the end of the file name anything that matches one of these regexps.")
945 (defvar user-init-file
946 "" ; set by command-line
947 "File name including directory of user's initialization file.")
949 (defun set-auto-mode ()
950 "Select major mode appropriate for current buffer.
951 This checks for a -*- mode tag in the buffer's text,
952 compares the filename against the entries in `auto-mode-alist',
953 or checks the interpreter that runs this file against
954 `interpreter-mode-alist'.
956 It does not check for the `mode:' local variable in the
957 Local Variables section of the file; for that, use `hack-local-variables'.
959 If `enable-local-variables' is nil, this function does not check for a
961 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
964 (goto-char (point-min))
965 (skip-chars-forward " \t\n")
966 (and enable-local-variables
967 ;; Don't look for -*- if this file name matches any
968 ;; of the regexps in inhibit-first-line-modes-regexps.
969 (let ((temp inhibit-first-line-modes-regexps)
970 (name (if buffer-file-name
971 (file-name-sans-versions buffer-file-name)
973 (while (let ((sufs inhibit-first-line-modes-suffixes))
974 (while (and sufs (not (string-match (car sufs) name)))
975 (setq sufs (cdr sufs)))
977 (setq name (substring name 0 (match-beginning 0))))
979 (not (string-match (car temp) name)))
980 (setq temp (cdr temp)))
982 (search-forward "-*-" (save-excursion
983 ;; If the file begins with "#!"
984 ;; (exec interpreter magic), look
985 ;; for mode frobs in the first two
986 ;; lines. You cannot necessarily
987 ;; put them in the first line of
988 ;; such a file without screwing up
989 ;; the interpreter invocation.
990 (end-of-line (and (looking-at "^#!") 2))
993 (skip-chars-forward " \t")
995 (search-forward "-*-"
996 (save-excursion (end-of-line) (point))
1000 (skip-chars-backward " \t")
1003 (if (save-excursion (search-forward ":" end t))
1004 ;; Find all specifications for the `mode:' variable
1005 ;; and execute them left to right.
1006 (while (let ((case-fold-search t))
1007 (or (and (looking-at "mode:")
1008 (goto-char (match-end 0)))
1009 (re-search-forward "[ \t;]mode:" end t)))
1010 (skip-chars-forward " \t")
1012 (if (search-forward ";" end t)
1015 (skip-chars-backward " \t")
1016 (funcall (intern (concat (downcase (buffer-substring beg (point))) "-mode")))
1018 ;; Simple -*-MODE-*- case.
1019 (funcall (intern (concat (downcase (buffer-substring beg end)) "-mode")))
1021 ;; If we didn't find a mode from a -*- line, try using the file name.
1022 (if (and (not done) buffer-file-name)
1023 (let ((name buffer-file-name)
1025 ;; Remove backup-suffixes from file name.
1026 (setq name (file-name-sans-versions name))
1028 (setq keep-going nil)
1029 (let ((alist auto-mode-alist)
1031 ;; Find first matching alist entry.
1032 (let ((case-fold-search
1033 (memq system-type '(vax-vms windows-nt))))
1034 (while (and (not mode) alist)
1035 (if (string-match (car (car alist)) name)
1036 (if (and (consp (cdr (car alist)))
1037 (nth 2 (car alist)))
1039 (setq mode (car (cdr (car alist)))
1040 name (substring name 0 (match-beginning 0))
1042 (setq mode (cdr (car alist))
1044 (setq alist (cdr alist))))
1047 ;; If we can't deduce a mode from the file name,
1048 ;; look for an interpreter specified in the first line.
1051 (goto-char (point-min))
1052 (if (looking-at "#! *\\([^ \t\n]+\\)")
1053 (buffer-substring (match-beginning 1)
1057 ;; Map interpreter name to a mode.
1058 (setq elt (assoc (file-name-nondirectory interpreter)
1059 interpreter-mode-alist))
1061 (funcall (cdr elt))))))))))))
1063 (defun hack-local-variables-prop-line ()
1064 ;; Set local variables specified in the -*- line.
1065 ;; Ignore any specification for `mode:';
1066 ;; set-auto-mode should already have handled that.
1068 (goto-char (point-min))
1070 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
1071 ;; Parse the -*- line into the `result' alist.
1072 (cond ((not (search-forward "-*-" end t))
1073 ;; doesn't have one.
1075 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1076 ;; Simple form: "-*- MODENAME -*-". Already handled.
1079 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1080 ;; (last ";" is optional).
1082 (if (search-forward "-*-" end t)
1083 (setq end (- (point) 3))
1084 (error "-*- not terminated before end of line")))
1085 (while (< (point) end)
1086 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1087 (error "malformed -*- line"))
1088 (goto-char (match-end 0))
1089 ;; There used to be a downcase here,
1090 ;; but the manual didn't say so,
1091 ;; and people want to set var names that aren't all lc.
1092 (let ((key (intern (buffer-substring
1095 (val (save-restriction
1096 (narrow-to-region (point) end)
1097 (read (current-buffer)))))
1099 (setq result (cons (cons key val) result)))
1100 (skip-chars-forward " \t;")))
1101 (setq result (nreverse result))))
1104 (or (eq enable-local-variables t)
1105 (and enable-local-variables
1106 (save-window-excursion
1108 (switch-to-buffer (current-buffer))
1110 ;; If we fail to switch in the selected window,
1111 ;; it is probably a minibuffer.
1112 ;; So try another window.
1114 (switch-to-buffer-other-window (current-buffer))
1116 (switch-to-buffer-other-frame (current-buffer))))))
1117 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1118 (file-name-nondirectory buffer-file-name)))))))
1120 (hack-one-local-variable (car (car result)) (cdr (car result)))
1121 (setq result (cdr result)))))))
1123 (defvar hack-local-variables-hook nil
1124 "Normal hook run after processing a file's local variables specs.
1125 Major modes can use this to examine user-specified local variables
1126 in order to initialize other data structure based on them.")
1128 (defun hack-local-variables ()
1129 "Parse and put into effect this buffer's local variables spec."
1130 (hack-local-variables-prop-line)
1131 ;; Look for "Local variables:" line in last page.
1133 (goto-char (point-max))
1134 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1135 (if (let ((case-fold-search t))
1136 (and (search-forward "Local Variables:" nil t)
1137 (or (eq enable-local-variables t)
1138 (and enable-local-variables
1139 (save-window-excursion
1140 (switch-to-buffer (current-buffer))
1143 (set-window-start (selected-window) (point)))
1144 (y-or-n-p (format "Set local variables as specified at end of %s? "
1145 (if buffer-file-name
1146 (file-name-nondirectory
1149 (buffer-name))))))))))
1151 prefix prefixlen suffix beg
1152 (enable-local-eval enable-local-eval))
1153 ;; The prefix is what comes before "local variables:" in its line.
1154 ;; The suffix is what comes after "local variables:" in its line.
1155 (skip-chars-forward " \t")
1157 (setq suffix (buffer-substring (point)
1158 (progn (end-of-line) (point)))))
1159 (goto-char (match-beginning 0))
1162 (buffer-substring (point)
1163 (progn (beginning-of-line) (point)))))
1165 (if prefix (setq prefixlen (length prefix)
1166 prefix (regexp-quote prefix)))
1167 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1169 ;; Look at next local variable spec.
1170 (if selective-display (re-search-forward "[\n\C-m]")
1172 ;; Skip the prefix, if any.
1174 (if (looking-at prefix)
1175 (forward-char prefixlen)
1176 (error "Local variables entry is missing the prefix")))
1177 ;; Find the variable name; strip whitespace.
1178 (skip-chars-forward " \t")
1180 (skip-chars-forward "^:\n")
1181 (if (eolp) (error "Missing colon in local variables entry"))
1182 (skip-chars-backward " \t")
1183 (let* ((str (buffer-substring beg (point)))
1186 ;; Setting variable named "end" means end of list.
1187 (if (string-equal (downcase str) "end")
1189 ;; Otherwise read the variable value.
1190 (skip-chars-forward "^:")
1192 (setq val (read (current-buffer)))
1193 (skip-chars-backward "\n")
1194 (skip-chars-forward " \t")
1195 (or (if suffix (looking-at suffix) (eolp))
1196 (error "Local variables entry is terminated incorrectly"))
1197 ;; Set the variable. "Variables" mode and eval are funny.
1198 (hack-one-local-variable var val)))))))
1199 (run-hooks 'hack-local-variables-hook))
1201 (defconst ignored-local-variables
1202 '(enable-local-eval)
1203 "Variables to be ignored in a file's local variable spec.")
1205 ;; Get confirmation before setting these variables as locals in a file.
1206 (put 'debugger 'risky-local-variable t)
1207 (put 'enable-local-eval 'risky-local-variable t)
1208 (put 'ignored-local-variables 'risky-local-variable t)
1209 (put 'eval 'risky-local-variable t)
1210 (put 'file-name-handler-alist 'risky-local-variable t)
1211 (put 'minor-mode-map-alist 'risky-local-variable t)
1212 (put 'after-load-alist 'risky-local-variable t)
1213 (put 'buffer-file-name 'risky-local-variable t)
1214 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1215 (put 'buffer-file-truename 'risky-local-variable t)
1216 (put 'exec-path 'risky-local-variable t)
1217 (put 'load-path 'risky-local-variable t)
1218 (put 'exec-directory 'risky-local-variable t)
1219 (put 'process-environment 'risky-local-variable t)
1220 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1221 (put 'outline-level 'risky-local-variable t)
1222 (put 'rmail-output-file-alist 'risky-local-variable t)
1224 ;; This one is safe because the user gets to check it before it is used.
1225 (put 'compile-command 'safe-local-variable t)
1227 (defun hack-one-local-variable-quotep (exp)
1228 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1230 ;; "Set" one variable in a local variables spec.
1231 ;; A few variable names are treated specially.
1232 (defun hack-one-local-variable (var val)
1233 (cond ((eq var 'mode)
1234 (funcall (intern (concat (downcase (symbol-name val))
1236 ((memq var ignored-local-variables)
1238 ;; "Setting" eval means either eval it or do nothing.
1239 ;; Likewise for setting hook variables.
1240 ((or (get var 'risky-local-variable)
1242 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1244 (not (get var 'safe-local-variable))))
1245 ;; Permit evaling a put of a harmless property
1246 ;; if the args do nothing tricky.
1247 (if (or (and (eq var 'eval)
1250 (hack-one-local-variable-quotep (nth 1 val))
1251 (hack-one-local-variable-quotep (nth 2 val))
1252 ;; Only allow safe values of lisp-indent-hook;
1254 (or (numberp (nth 3 val))
1255 (equal (nth 3 val) ''defun))
1256 (memq (nth 1 (nth 2 val))
1257 '(lisp-indent-hook)))
1258 ;; Permit eval if not root and user says ok.
1259 (and (not (zerop (user-uid)))
1260 (or (eq enable-local-eval t)
1261 (and enable-local-eval
1262 (save-window-excursion
1263 (switch-to-buffer (current-buffer))
1266 (set-window-start (selected-window) (point)))
1267 (setq enable-local-eval
1268 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1269 (file-name-nondirectory buffer-file-name)))))))))
1271 (save-excursion (eval val))
1272 (make-local-variable var)
1274 (message "Ignoring `eval:' in file's local variables")))
1275 ;; Ordinary variable, really set it.
1276 (t (make-local-variable var)
1280 (defun set-visited-file-name (filename)
1281 "Change name of file visited in current buffer to FILENAME.
1282 The next time the buffer is saved it will go in the newly specified file.
1283 nil or empty string as argument means make buffer not be visiting any file.
1284 Remember to delete the initial contents of the minibuffer
1285 if you wish to pass an empty string as the argument."
1286 (interactive "FSet visited file name: ")
1287 (if (buffer-base-buffer)
1288 (error "An indirect buffer cannot visit a file"))
1292 (if (string-equal filename "")
1294 (expand-file-name filename))))
1297 (setq truename (file-truename filename))
1298 (if find-file-visit-truename
1299 ;; Do not use the abbreviated filename, because
1300 ;; write-region will reset it to the expanded filename
1301 (setq filename truename))))
1302 (or (equal filename buffer-file-name)
1304 (and filename (lock-buffer filename))
1306 (setq buffer-file-name filename)
1307 (if filename ; make buffer name reflect filename.
1308 (let ((new-name (file-name-nondirectory buffer-file-name)))
1309 (if (string= new-name "")
1310 (error "Empty file name"))
1311 (if (eq system-type 'vax-vms)
1312 (setq new-name (downcase new-name)))
1313 (setq default-directory (file-name-directory buffer-file-name))
1314 (or (string= new-name (buffer-name))
1315 (rename-buffer new-name t))))
1316 (setq buffer-backed-up nil)
1317 (clear-visited-file-modtime)
1319 (setq buffer-file-truename (abbreviate-file-name truename)))
1320 (setq buffer-file-number
1322 (nth 10 (file-attributes buffer-file-name))
1324 ;; write-file-hooks is normally used for things like ftp-find-file
1325 ;; that visit things that are not local files as if they were files.
1326 ;; Changing to visit an ordinary local file instead should flush the hook.
1327 (kill-local-variable 'write-file-hooks)
1328 (kill-local-variable 'local-write-file-hooks)
1329 (kill-local-variable 'revert-buffer-function)
1330 (kill-local-variable 'backup-inhibited)
1331 ;; If buffer was read-only because of version control,
1332 ;; that reason is gone now, so make it writable.
1334 (setq buffer-read-only nil))
1335 (kill-local-variable 'vc-mode)
1336 ;; Turn off backup files for certain file names.
1337 ;; Since this is a permanent local, the major mode won't eliminate it.
1338 (and (not (funcall backup-enable-predicate buffer-file-name))
1340 (make-local-variable 'backup-inhibited)
1341 (setq backup-inhibited t)))
1342 (let ((oauto buffer-auto-save-file-name))
1343 ;; If auto-save was not already on, turn it on if appropriate.
1344 (if (not buffer-auto-save-file-name)
1345 (and buffer-file-name auto-save-default
1347 ;; If auto save is on, start using a new name.
1348 ;; We deliberately don't rename or delete the old auto save
1349 ;; for the old visited file name. This is because perhaps
1350 ;; the user wants to save the new state and then compare with the
1351 ;; previous state from the auto save file.
1352 (setq buffer-auto-save-file-name
1353 (make-auto-save-file-name)))
1354 ;; Rename the old auto save file if any.
1355 (and oauto buffer-auto-save-file-name
1356 (file-exists-p oauto)
1357 (rename-file oauto buffer-auto-save-file-name t)))
1358 (if buffer-file-name
1359 (set-buffer-modified-p t)))
1361 (defun write-file (filename &optional confirm)
1362 "Write current buffer into file FILENAME.
1363 Makes buffer visit that file, and marks it not modified.
1364 If the buffer is already visiting a file, you can specify
1365 a directory name as FILENAME, to write a file of the same
1366 old name in that directory.
1367 If optional second arg CONFIRM is non-nil,
1368 ask for confirmation for overwriting an existing file."
1369 ;; (interactive "FWrite file: ")
1371 (list (if buffer-file-name
1372 (read-file-name "Write file: "
1374 (read-file-name "Write file: "
1375 (cdr (assq 'default-directory
1376 (buffer-local-variables)))
1377 nil nil (buffer-name)))
1379 (or (null filename) (string-equal filename "")
1381 ;; If arg is just a directory,
1382 ;; use same file name, but in that directory.
1383 (if (and (file-directory-p filename) buffer-file-name)
1384 (setq filename (concat (file-name-as-directory filename)
1385 (file-name-nondirectory buffer-file-name))))
1387 (file-exists-p filename)
1388 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1389 (error "Canceled")))
1390 (set-visited-file-name filename)))
1391 (set-buffer-modified-p t)
1394 (defun backup-buffer ()
1395 "Make a backup of the disk file visited by the current buffer, if appropriate.
1396 This is normally done before saving the buffer the first time.
1397 If the value is non-nil, it is the result of `file-modes' on the original
1398 file; this means that the caller, after saving the buffer, should change
1399 the modes of the new file to agree with the old modes."
1400 (if (and make-backup-files (not backup-inhibited)
1401 (not buffer-backed-up)
1402 (file-exists-p buffer-file-name)
1403 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1405 (let ((real-file-name buffer-file-name)
1406 backup-info backupname targets setmodes)
1407 ;; If specified name is a symbolic link, chase it to the target.
1408 ;; Thus we make the backups in the directory where the real file is.
1409 (setq real-file-name (file-chase-links real-file-name))
1410 (setq backup-info (find-backup-file-name real-file-name)
1411 backupname (car backup-info)
1412 targets (cdr backup-info))
1413 ;;; (if (file-directory-p buffer-file-name)
1414 ;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1417 (let ((delete-old-versions
1418 ;; If have old versions to maybe delete,
1419 ;; ask the user to confirm now, before doing anything.
1420 ;; But don't actually delete til later.
1422 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1423 (or delete-old-versions
1424 (y-or-n-p (format "Delete excess backup versions of %s? "
1425 real-file-name))))))
1426 ;; Actually write the back up file.
1428 (if (or file-precious-flag
1429 ; (file-symlink-p buffer-file-name)
1431 (and backup-by-copying-when-linked
1432 (> (file-nlinks real-file-name) 1))
1433 (and backup-by-copying-when-mismatch
1434 (let ((attr (file-attributes real-file-name)))
1436 (not (file-ownership-preserved-p real-file-name))))))
1438 (copy-file real-file-name backupname t t)
1440 ;; If copying fails because file BACKUPNAME
1441 ;; is not writable, delete that file and try again.
1442 (if (and (file-exists-p backupname)
1443 (not (file-writable-p backupname)))
1444 (delete-file backupname))
1445 (copy-file real-file-name backupname t t)))
1446 ;; rename-file should delete old backup.
1447 (rename-file real-file-name backupname t)
1448 (setq setmodes (file-modes backupname)))
1450 ;; If trouble writing the backup, write it in ~.
1451 (setq backupname (expand-file-name "~/%backup%~"))
1452 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1455 (copy-file real-file-name backupname t t)
1457 ;; If copying fails because file BACKUPNAME
1458 ;; is not writable, delete that file and try again.
1459 (if (and (file-exists-p backupname)
1460 (not (file-writable-p backupname)))
1461 (delete-file backupname))
1462 (copy-file real-file-name backupname t t)))))
1463 (setq buffer-backed-up t)
1464 ;; Now delete the old versions, if desired.
1465 (if delete-old-versions
1468 (delete-file (car targets))
1470 (setq targets (cdr targets))))
1472 (file-error nil))))))
1474 (defun file-name-sans-versions (name &optional keep-backup-version)
1475 "Return FILENAME sans backup versions or strings.
1476 This is a separate procedure so your site-init or startup file can
1478 If the optional argument KEEP-BACKUP-VERSION is non-nil,
1479 we do not remove backup version numbers, only true file version numbers."
1480 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
1482 (funcall handler 'file-name-sans-versions name keep-backup-version)
1484 (if (eq system-type 'vax-vms)
1485 ;; VMS version number is (a) semicolon, optional
1486 ;; sign, zero or more digits or (b) period, option
1487 ;; sign, zero or more digits, provided this is the
1488 ;; second period encountered outside of the
1489 ;; device/directory part of the file name.
1490 (or (string-match ";[-+]?[0-9]*\\'" name)
1491 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
1493 (match-beginning 1))
1495 (if keep-backup-version
1497 (or (string-match "\\.~[0-9]+~\\'" name)
1498 (string-match "~\\'" name)
1499 (length name))))))))
1501 (defun file-ownership-preserved-p (file)
1502 "Returns t if deleting FILE and rewriting it would preserve the owner."
1503 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1505 (funcall handler 'file-ownership-preserved-p file)
1506 (let ((attributes (file-attributes file)))
1507 ;; Return t if the file doesn't exist, since it's true that no
1508 ;; information would be lost by an (attempted) delete and create.
1509 (or (null attributes)
1510 (= (nth 2 attributes) (user-uid)))))))
1512 (defun file-name-sans-extension (filename)
1513 "Return FILENAME sans final \"extension\".
1514 The extension, in a file name, is the part that follows the last `.'."
1516 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1518 (if (string-match "\\.[^.]*\\'" file)
1519 (if (setq directory (file-name-directory filename))
1520 (expand-file-name (substring file 0 (match-beginning 0))
1522 (substring file 0 (match-beginning 0)))
1525 (defun make-backup-file-name (file)
1526 "Create the non-numeric backup file name for FILE.
1527 This is a separate function so you can redefine it for customization."
1528 (if (eq system-type 'ms-dos)
1529 (let ((fn (file-name-nondirectory file)))
1530 (concat (file-name-directory file)
1531 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
1532 (substring fn 0 (match-end 1)))
1536 (defun backup-file-name-p (file)
1537 "Return non-nil if FILE is a backup file name (numeric or not).
1538 This is a separate function so you can redefine it for customization.
1539 You may need to redefine `file-name-sans-versions' as well."
1540 (if (eq system-type 'ms-dos)
1541 (string-match "\\.bak$" file)
1542 (string-match "~$" file)))
1544 ;; This is used in various files.
1545 ;; The usage of bv-length is not very clean,
1546 ;; but I can't see a good alternative,
1547 ;; so as of now I am leaving it alone.
1548 (defun backup-extract-version (fn)
1549 "Given the name of a numeric backup file, return the backup number.
1550 Uses the free variable `bv-length', whose value should be
1551 the index in the name where the version number begins."
1552 (if (and (string-match "[0-9]+~$" fn bv-length)
1553 (= (match-beginning 0) bv-length))
1554 (string-to-int (substring fn bv-length -1))
1557 ;; I believe there is no need to alter this behavior for VMS;
1558 ;; since backup files are not made on VMS, it should not get called.
1559 (defun find-backup-file-name (fn)
1560 "Find a file name for a backup file, and suggestions for deletions.
1561 Value is a list whose car is the name for the backup file
1562 and whose cdr is a list of old versions to consider deleting now.
1563 If the value is nil, don't make a backup."
1564 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
1565 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1567 (funcall handler 'find-backup-file-name fn)
1568 (if (eq version-control 'never)
1569 (list (make-backup-file-name fn))
1570 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1571 (bv-length (length base-versions))
1575 (deserve-versions-p nil)
1576 (number-to-delete 0))
1578 (setq possibilities (file-name-all-completions
1580 (file-name-directory fn))
1581 versions (sort (mapcar
1582 (function backup-extract-version)
1585 high-water-mark (apply 'max 0 versions)
1586 deserve-versions-p (or version-control
1587 (> high-water-mark 0))
1588 number-to-delete (- (length versions)
1589 kept-old-versions kept-new-versions -1))
1591 (setq possibilities nil)))
1592 (if (not deserve-versions-p)
1593 (list (make-backup-file-name fn))
1594 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1595 (if (and (> number-to-delete 0)
1596 ;; Delete nothing if there is overflow
1597 ;; in the number of versions to keep.
1598 (>= (+ kept-new-versions kept-old-versions -1) 0))
1599 (mapcar (function (lambda (n)
1600 (concat fn ".~" (int-to-string n) "~")))
1601 (let ((v (nthcdr kept-old-versions versions)))
1602 (rplacd (nthcdr (1- number-to-delete) v) ())
1605 (defun file-nlinks (filename)
1606 "Return number of names file FILENAME has."
1607 (car (cdr (file-attributes filename))))
1609 (defun file-relative-name (filename &optional directory)
1610 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1611 (setq filename (expand-file-name filename)
1612 directory (file-name-as-directory (expand-file-name
1613 (or directory default-directory))))
1614 (let ((ancestor ""))
1615 (while (not (string-match (concat "^" (regexp-quote directory)) filename))
1616 (setq directory (file-name-directory (substring directory 0 -1))
1617 ancestor (concat "../" ancestor)))
1618 (concat ancestor (substring filename (match-end 0)))))
1620 (defun save-buffer (&optional args)
1621 "Save current buffer in visited file if modified. Versions described below.
1622 By default, makes the previous version into a backup file
1623 if previously requested or if this is the first save.
1624 With 1 or 3 \\[universal-argument]'s, marks this version
1625 to become a backup when the next save is done.
1626 With 2 or 3 \\[universal-argument]'s,
1627 unconditionally makes the previous version into a backup file.
1628 With argument of 0, never makes the previous version into a backup file.
1630 If a file's name is FOO, the names of its numbered backup versions are
1631 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1632 Numeric backups (rather than FOO~) will be made if value of
1633 `version-control' is not the atom `never' and either there are already
1634 numeric versions of the file being backed up, or `version-control' is
1636 We don't want excessive versions piling up, so there are variables
1637 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1638 and `kept-new-versions', which tells how many newest versions to keep.
1639 Defaults are 2 old versions and 2 new.
1640 `dired-kept-versions' controls dired's clean-directory (.) command.
1641 If `delete-old-versions' is nil, system will query user
1642 before trimming versions. Otherwise it does it silently."
1644 (let ((modp (buffer-modified-p))
1645 (large (> (buffer-size) 50000))
1646 (make-backup-files (or (and make-backup-files (not (eq args 0)))
1647 (memq args '(16 64)))))
1648 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1649 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1651 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1653 (defun delete-auto-save-file-if-necessary (&optional force)
1654 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1655 Normally delete only if the file was written by this Emacs since
1656 the last real save, but optional arg FORCE non-nil means delete anyway."
1657 (and buffer-auto-save-file-name delete-auto-save-files
1658 (not (string= buffer-file-name buffer-auto-save-file-name))
1659 (or force (recent-auto-save-p))
1662 (delete-file buffer-auto-save-file-name)
1664 (set-buffer-auto-saved))))
1666 (defun basic-save-buffer ()
1667 "Save the current buffer in its visited file, if it has been modified."
1670 ;; In an indirect buffer, save its base buffer instead.
1671 (if (buffer-base-buffer)
1672 (set-buffer (buffer-base-buffer)))
1673 (if (buffer-modified-p)
1674 (let ((recent-save (recent-auto-save-p))
1675 setmodes tempsetmodes)
1676 ;; On VMS, rename file and buffer to get rid of version number.
1677 (if (and (eq system-type 'vax-vms)
1678 (not (string= buffer-file-name
1679 (file-name-sans-versions buffer-file-name))))
1680 (let (buffer-new-name)
1681 ;; Strip VMS version number before save.
1682 (setq buffer-file-name
1683 (file-name-sans-versions buffer-file-name))
1684 ;; Construct a (unique) buffer name to correspond.
1685 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1686 (setq buffer-new-name (buffer-name buf))
1688 (rename-buffer buffer-new-name)))
1689 ;; If buffer has no file name, ask user for one.
1690 (or buffer-file-name
1691 (set-visited-file-name
1692 (expand-file-name (read-file-name "File to save in: ") nil)))
1693 (or (verify-visited-file-modtime (current-buffer))
1694 (not (file-exists-p buffer-file-name))
1696 (format "%s has changed since visited or saved. Save anyway? "
1697 (file-name-nondirectory buffer-file-name)))
1698 (error "Save not confirmed"))
1701 (and (> (point-max) 1)
1702 (/= (char-after (1- (point-max))) ?\n)
1703 (not (and (eq selective-display t)
1704 (= (char-after (1- (point-max))) ?\r)))
1705 (or (eq require-final-newline t)
1706 (and require-final-newline
1708 (format "Buffer %s does not end in newline. Add one? "
1711 (goto-char (point-max))
1713 (or (run-hook-with-args-until-success 'write-contents-hooks)
1714 (run-hook-with-args-until-success 'local-write-file-hooks)
1715 (run-hook-with-args-until-success 'write-file-hooks)
1716 ;; If a hook returned t, file is already "written".
1717 ;; Otherwise, write it the usual way now.
1718 (setq setmodes (basic-save-buffer-1)))
1719 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
1722 (set-file-modes buffer-file-name setmodes)
1724 ;; If the auto-save file was recent before this command,
1726 (delete-auto-save-file-if-necessary recent-save)
1727 (run-hooks 'after-save-hook))
1728 (message "(No changes need to be saved)"))))
1730 ;; This does the "real job" of writing a buffer into its visited file
1731 ;; and making a backup file. This is what is normally done
1732 ;; but inhibited if one of write-file-hooks returns non-nil.
1733 ;; It returns a value to store in setmodes.
1734 (defun basic-save-buffer-1 ()
1735 (let (tempsetmodes setmodes)
1736 (if (not (file-writable-p buffer-file-name))
1737 (let ((dir (file-name-directory buffer-file-name)))
1738 (if (not (file-directory-p dir))
1739 (error "%s is not a directory" dir)
1740 (if (not (file-exists-p buffer-file-name))
1741 (error "Directory %s write-protected" dir)
1743 (format "File %s is write-protected; try to save anyway? "
1744 (file-name-nondirectory
1746 (setq tempsetmodes t)
1747 (error "Attempt to save to a file which you aren't allowed to write"))))))
1748 (or buffer-backed-up
1749 (setq setmodes (backup-buffer)))
1750 (let ((dir (file-name-directory buffer-file-name)))
1751 (if (and file-precious-flag
1752 (file-writable-p dir))
1753 ;; If file is precious, write temp name, then rename it.
1754 ;; This requires write access to the containing dir,
1755 ;; which is why we don't try it if we don't have that access.
1756 (let ((realname buffer-file-name)
1757 tempname temp nogood i succeed
1758 (old-modtime (visited-file-modtime)))
1761 ;; Find the temporary name to write under.
1763 (setq tempname (format "%s#tmp#%d" dir i))
1764 (setq nogood (file-exists-p tempname))
1767 (progn (clear-visited-file-modtime)
1768 (write-region (point-min) (point-max)
1769 tempname nil realname)
1771 ;; If writing the temp file fails,
1772 ;; delete the temp file.
1775 (delete-file tempname)
1776 (set-visited-file-modtime old-modtime))))
1777 ;; Since we have created an entirely new file
1778 ;; and renamed it, make sure it gets the
1779 ;; right permission bits set.
1780 (setq setmodes (file-modes buffer-file-name))
1781 ;; We succeeded in writing the temp file,
1783 (rename-file tempname buffer-file-name t))
1784 ;; If file not writable, see if we can make it writable
1785 ;; temporarily while we write it.
1786 ;; But no need to do so if we have just backed it up
1787 ;; (setmodes is set) because that says we're superseding.
1788 (cond ((and tempsetmodes (not setmodes))
1789 ;; Change the mode back, after writing.
1790 (setq setmodes (file-modes buffer-file-name))
1791 (set-file-modes buffer-file-name 511)))
1792 (write-region (point-min) (point-max)
1793 buffer-file-name nil t)))
1796 (defun save-some-buffers (&optional arg exiting)
1797 "Save some modified file-visiting buffers. Asks user about each one.
1798 Optional argument (the prefix) non-nil means save all with no questions.
1799 Optional second argument EXITING means ask about certain non-file buffers
1800 as well as about file buffers."
1802 (save-window-excursion
1807 (and (buffer-modified-p buffer)
1808 (not (buffer-base-buffer buffer))
1810 (buffer-file-name buffer)
1814 (and buffer-offer-save (> (buffer-size) 0)))))
1817 (if (buffer-file-name buffer)
1818 (format "Save file %s? "
1819 (buffer-file-name buffer))
1820 (format "Save buffer %s? "
1821 (buffer-name buffer)))))))
1827 '("buffer" "buffers" "save")
1828 (list (list ?\C-r (lambda (buf)
1830 (setq view-exit-action
1832 (exit-recursive-edit)))
1834 ;; Return nil to ask about BUF again.
1836 "display the current buffer"))))
1838 (and save-abbrevs abbrevs-changed
1841 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
1842 (write-abbrev-file nil))
1843 ;; Don't keep bothering user if he says no.
1844 (setq abbrevs-changed nil)
1846 (or (> files-done 0) abbrevs-done
1847 (message "(No files need saving)")))))
1849 (defun not-modified (&optional arg)
1850 "Mark current buffer as unmodified, not needing to be saved.
1851 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
1853 It is not a good idea to use this function in Lisp programs, because it
1854 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
1856 (message (if arg "Modification-flag set"
1857 "Modification-flag cleared"))
1858 (set-buffer-modified-p arg))
1860 (defun toggle-read-only (&optional arg)
1861 "Change whether this buffer is visiting its file read-only.
1862 With arg, set read-only iff arg is positive."
1864 (setq buffer-read-only
1866 (not buffer-read-only)
1867 (> (prefix-numeric-value arg) 0)))
1868 (force-mode-line-update))
1870 (defun insert-file (filename)
1871 "Insert contents of file FILENAME into buffer after point.
1872 Set mark after the inserted text.
1874 This function is meant for the user to run interactively.
1875 Don't call it from programs! Use `insert-file-contents' instead.
1876 \(Its calling sequence is different; see its documentation)."
1877 (interactive "*fInsert file: ")
1878 (if (file-directory-p filename)
1879 (signal 'file-error (list "Opening input file" "file is a directory"
1881 (let ((tem (insert-file-contents filename)))
1882 (push-mark (+ (point) (car (cdr tem))))))
1884 (defun append-to-file (start end filename)
1885 "Append the contents of the region to the end of file FILENAME.
1886 When called from a function, expects three arguments,
1887 START, END and FILENAME. START and END are buffer positions
1888 saying what text to write."
1889 (interactive "r\nFAppend to file: ")
1890 (write-region start end filename t))
1892 (defun file-newest-backup (filename)
1893 "Return most recent backup file for FILENAME or nil if no backups exist."
1894 (let* ((filename (expand-file-name filename))
1895 (file (file-name-nondirectory filename))
1896 (dir (file-name-directory filename))
1897 (comp (file-name-all-completions file dir))
1900 (setq file (concat dir (car comp))
1902 (if (and (backup-file-name-p file)
1903 (or (null newest) (file-newer-than-file-p file newest)))
1904 (setq newest file)))
1907 (defun rename-uniquely ()
1908 "Rename current buffer to a similar name not already taken.
1909 This function is useful for creating multiple shell process buffers
1910 or multiple mail buffers, etc."
1913 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
1914 (not (and buffer-file-name
1915 (string= (buffer-name)
1916 (file-name-nondirectory
1917 buffer-file-name)))))
1918 ;; If the existing buffer name has a <NNN>,
1919 ;; which isn't part of the file name (if any),
1920 ;; then get rid of that.
1921 (substring (buffer-name) 0 (match-beginning 0))
1923 (new-buf (generate-new-buffer base-name))
1924 (name (buffer-name new-buf)))
1925 (kill-buffer new-buf)
1926 (rename-buffer name)
1927 (force-mode-line-update))))
1929 (defun make-directory (dir &optional parents)
1930 "Create the directory DIR and any nonexistent parent dirs.
1931 Interactively, the default choice of directory to create
1932 is the current default directory for file names.
1933 That is useful when you have visited a file in a nonexistint directory.
1935 Noninteractively, the second (optional) argument PARENTS says whether
1936 to create parent directories if they don't exist."
1938 (list (read-file-name "Make directory: " default-directory default-directory
1941 (let ((handler (find-file-name-handler dir 'make-directory)))
1943 (funcall handler 'make-directory dir parents)
1945 (make-directory-internal dir)
1946 (let ((dir (directory-file-name (expand-file-name dir)))
1948 (while (not (file-exists-p dir))
1949 (setq create-list (cons dir create-list)
1950 dir (directory-file-name (file-name-directory dir))))
1952 (make-directory-internal (car create-list))
1953 (setq create-list (cdr create-list))))))))
1955 (put 'revert-buffer-function 'permanent-local t)
1956 (defvar revert-buffer-function nil
1957 "Function to use to revert this buffer, or nil to do the default.
1958 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
1959 which are the arguments that `revert-buffer' received.")
1961 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1962 (defvar revert-buffer-insert-file-contents-function nil
1963 "Function to use to insert contents when reverting this buffer.
1964 Gets two args, first the nominal file name to use,
1965 and second, t if reading the auto-save file.")
1967 (defvar before-revert-hook nil
1968 "Normal hook for `revert-buffer' to run before reverting.
1969 If `revert-buffer-function' is used to override the normal revert
1970 mechanism, this hook is not used.")
1972 (defvar after-revert-hook nil
1973 "Normal hook for `revert-buffer' to run after reverting.
1974 Note that the hook value that it runs is the value that was in effect
1975 before reverting; that makes a difference if you have buffer-local
1978 If `revert-buffer-function' is used to override the normal revert
1979 mechanism, this hook is not used.")
1981 (defun revert-buffer (&optional ignore-auto noconfirm)
1982 "Replace the buffer text with the text of the visited file on disk.
1983 This undoes all changes since the file was visited or saved.
1984 With a prefix argument, offer to revert from latest auto-save file, if
1985 that is more recent than the visited file.
1987 When called from Lisp, the first argument is IGNORE-AUTO; only offer
1988 to revert from the auto-save file when this is nil. Note that the
1989 sense of this argument is the reverse of the prefix argument, for the
1990 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
1993 Optional second argument NOCONFIRM means don't ask for confirmation at
1996 If the value of `revert-buffer-function' is non-nil, it is called to
1999 The default revert function runs the hook `before-revert-hook' at the
2000 beginning and `after-revert-hook' at the end."
2001 ;; I admit it's odd to reverse the sense of the prefix argument, but
2002 ;; there is a lot of code out there which assumes that the first
2003 ;; argument should be t to avoid consulting the auto-save file, and
2004 ;; there's no straightforward way to encourage authors to notice a
2005 ;; reversal of the argument sense. So I'm just changing the user
2006 ;; interface, but leaving the programmatic interface the same.
2007 (interactive (list (not current-prefix-arg)))
2008 (if revert-buffer-function
2009 (funcall revert-buffer-function ignore-auto noconfirm)
2010 (let* ((opoint (point))
2011 (auto-save-p (and (not ignore-auto)
2012 (recent-auto-save-p)
2013 buffer-auto-save-file-name
2014 (file-readable-p buffer-auto-save-file-name)
2016 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2017 (file-name (if auto-save-p
2018 buffer-auto-save-file-name
2020 (cond ((null file-name)
2021 (error "Buffer does not seem to be associated with any file"))
2023 (yes-or-no-p (format "Revert buffer from file %s? "
2025 (run-hooks 'before-revert-hook)
2026 ;; If file was backed up but has changed since,
2027 ;; we shd make another backup.
2028 (and (not auto-save-p)
2029 (not (verify-visited-file-modtime (current-buffer)))
2030 (setq buffer-backed-up nil))
2031 ;; Get rid of all undo records for this buffer.
2032 (or (eq buffer-undo-list t)
2033 (setq buffer-undo-list nil))
2034 ;; Effectively copy the after-revert-hook status,
2035 ;; since after-find-file will clobber it.
2036 (let ((global-hook (default-value 'after-revert-hook))
2037 (local-hook-p (local-variable-p 'after-revert-hook))
2038 (local-hook (and (local-variable-p 'after-revert-hook)
2039 after-revert-hook)))
2040 (let (buffer-read-only
2041 ;; Don't make undo records for the reversion.
2042 (buffer-undo-list t))
2043 (if revert-buffer-insert-file-contents-function
2044 (funcall revert-buffer-insert-file-contents-function
2045 file-name auto-save-p)
2046 (if (not (file-exists-p file-name))
2047 (error "File %s no longer exists!" file-name))
2048 ;; Bind buffer-file-name to nil
2049 ;; so that we don't try to lock the file.
2050 (let ((buffer-file-name nil))
2054 (insert-file-contents file-name (not auto-save-p)
2056 (goto-char (min opoint (point-max)))
2057 ;; Recompute the truename in case changes in symlinks
2058 ;; have changed the truename.
2059 (setq buffer-file-truename
2060 (abbreviate-file-name (file-truename buffer-file-name)))
2061 (after-find-file nil nil t t)
2062 ;; Run after-revert-hook as it was before we reverted.
2063 (setq-default revert-buffer-internal-hook global-hook)
2066 (make-local-variable 'revert-buffer-internal-hook)
2067 (setq revert-buffer-internal-hook local-hook))
2068 (kill-local-variable 'revert-buffer-internal-hook))
2069 (run-hooks 'revert-buffer-internal-hook))
2072 (defun recover-file (file)
2073 "Visit file FILE, but get contents from its last auto-save file."
2074 ;; Actually putting the file name in the minibuffer should be used
2076 ;; Not just because users often use the default.
2077 (interactive "fRecover file: ")
2078 (setq file (expand-file-name file))
2079 (if (auto-save-file-name-p (file-name-nondirectory file))
2080 (error "%s is an auto-save file" file))
2081 (let ((file-name (let ((buffer-file-name file))
2082 (make-auto-save-file-name))))
2083 (cond ((not (file-newer-than-file-p file-name file))
2084 (error "Auto-save file %s not current" file-name))
2085 ((save-window-excursion
2086 (if (not (eq system-type 'vax-vms))
2087 (with-output-to-temp-buffer "*Directory*"
2088 (buffer-disable-undo standard-output)
2089 (call-process "ls" nil standard-output nil
2090 (if (file-symlink-p file) "-lL" "-l")
2092 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2093 (switch-to-buffer (find-file-noselect file t))
2094 (let ((buffer-read-only nil))
2096 (insert-file-contents file-name nil))
2097 (after-find-file nil nil t))
2098 (t (error "Recover-file cancelled.")))))
2100 (defun recover-session ()
2101 "Recover auto save files from a previous Emacs session.
2102 This command first displays a Dired buffer showing you the
2103 previous sessions that you could recover from.
2104 To choose one, move point to the proper line and then type C-c C-c.
2105 Then you'll be asked about a number of files to recover."
2108 (goto-char (point-min))
2109 (or (looking-at "Move to the session you want to recover,")
2110 (let ((inhibit-read-only t))
2111 (insert "Move to the session you want to recover,\n")
2112 (insert "then type C-c C-c to select it.\n\n")))
2113 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
2114 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
2116 (defun recover-session-finish ()
2117 "Choose one saved session to recover auto-save files from.
2118 This command is used in the special Dired buffer created by
2119 \\[recover-session]."
2121 ;; Get the name of the session file to recover from.
2122 (let ((file (dired-get-filename))
2123 (buffer (get-buffer-create " *recover*")))
2126 ;; Read in the auto-save-list file.
2129 (insert-file-contents file)
2130 (map-y-or-n-p "Recover %s? "
2131 (lambda (file) (save-excursion (recover-file file)))
2136 (buffer-substring-no-properties
2137 (point) (progn (end-of-line) (point)))
2138 (while (and (eolp) (not (eobp)))
2139 (forward-line 2)))))
2140 '("file" "files" "recover")))
2141 (kill-buffer buffer))))
2143 (defun kill-some-buffers ()
2144 "For each buffer, ask whether to kill it."
2146 (let ((list (buffer-list)))
2148 (let* ((buffer (car list))
2149 (name (buffer-name buffer)))
2150 (and (not (string-equal name ""))
2151 (/= (aref name 0) ? )
2153 (format "Buffer %s %s. Kill? "
2155 (if (buffer-modified-p buffer)
2156 "HAS BEEN EDITED" "is unmodified")))
2157 (kill-buffer buffer)))
2158 (setq list (cdr list)))))
2160 (defun auto-save-mode (arg)
2161 "Toggle auto-saving of contents of current buffer.
2162 With prefix argument ARG, turn auto-saving on if positive, else off."
2164 (setq buffer-auto-save-file-name
2166 (or (not buffer-auto-save-file-name)
2167 ;; If autosave is off because buffer has shrunk,
2168 ;; then toggling should turn it on.
2169 (< buffer-saved-size 0))
2170 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2171 (if (and buffer-file-name auto-save-visited-file-name
2172 (not buffer-read-only))
2174 (make-auto-save-file-name))))
2175 ;; If -1 was stored here, to temporarily turn off saving,
2177 (and (< buffer-saved-size 0)
2178 (setq buffer-saved-size 0))
2180 (message "Auto-save %s (in this buffer)"
2181 (if buffer-auto-save-file-name "on" "off")))
2182 buffer-auto-save-file-name)
2184 (defun rename-auto-save-file ()
2185 "Adjust current buffer's auto save file name for current conditions.
2186 Also rename any existing auto save file, if it was made in this session."
2187 (let ((osave buffer-auto-save-file-name))
2188 (setq buffer-auto-save-file-name
2189 (make-auto-save-file-name))
2190 (if (and osave buffer-auto-save-file-name
2191 (not (string= buffer-auto-save-file-name buffer-file-name))
2192 (not (string= buffer-auto-save-file-name osave))
2193 (file-exists-p osave)
2194 (recent-auto-save-p))
2195 (rename-file osave buffer-auto-save-file-name t))))
2197 (defun make-auto-save-file-name ()
2198 "Return file name to use for auto-saves of current buffer.
2199 Does not consider `auto-save-visited-file-name' as that variable is checked
2200 before calling this function. You can redefine this for customization.
2201 See also `auto-save-file-name-p'."
2202 (if buffer-file-name
2203 (concat (file-name-directory buffer-file-name)
2205 (file-name-nondirectory buffer-file-name)
2208 ;; Deal with buffers that don't have any associated files. (Mail
2209 ;; mode tends to create a good number of these.)
2211 (let ((buffer-name (buffer-name))
2213 ;; Use technique from Sebastian Kremer's auto-save
2214 ;; package to turn slashes into \\!. This ensures that
2215 ;; the auto-save buffer name is unique.
2217 (while (string-match "[/\\]" buffer-name limit)
2218 (setq buffer-name (concat (substring buffer-name 0 (match-beginning 0))
2219 (if (string= (substring buffer-name
2225 (substring buffer-name (match-end 0))))
2226 (setq limit (1+ (match-end 0))))
2228 (expand-file-name (format "#%s#%s#" buffer-name (make-temp-name ""))))))
2230 (defun auto-save-file-name-p (filename)
2231 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2232 FILENAME should lack slashes. You can redefine this for customization."
2233 (string-match "^#.*#$" filename))
2235 (defconst list-directory-brief-switches
2236 (if (eq system-type 'vax-vms) "" "-CF")
2237 "*Switches for list-directory to pass to `ls' for brief listing,")
2239 (defconst list-directory-verbose-switches
2240 (if (eq system-type 'vax-vms)
2241 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2243 "*Switches for list-directory to pass to `ls' for verbose listing,")
2245 (defun list-directory (dirname &optional verbose)
2246 "Display a list of files in or matching DIRNAME, a la `ls'.
2247 DIRNAME is globbed by the shell if necessary.
2248 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2249 Actions controlled by variables `list-directory-brief-switches'
2250 and `list-directory-verbose-switches'."
2251 (interactive (let ((pfx current-prefix-arg))
2252 (list (read-file-name (if pfx "List directory (verbose): "
2253 "List directory (brief): ")
2254 nil default-directory nil)
2256 (let ((switches (if verbose list-directory-verbose-switches
2257 list-directory-brief-switches)))
2258 (or dirname (setq dirname default-directory))
2259 (setq dirname (expand-file-name dirname))
2260 (with-output-to-temp-buffer "*Directory*"
2261 (buffer-disable-undo standard-output)
2262 (princ "Directory ")
2266 (set-buffer "*Directory*")
2267 (let ((wildcard (not (file-directory-p dirname))))
2268 (insert-directory dirname switches wildcard (not wildcard)))))))
2270 (defvar insert-directory-program "ls"
2271 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2274 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2275 ;; FULL-DIRECTORY-P is nil.
2276 ;; The single line of output must display FILE's name as it was
2277 ;; given, namely, an absolute path name.
2278 ;; - must insert exactly one line for each file if WILDCARD or
2279 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
2280 ;; before the file lines, plus optional text after the file lines.
2281 ;; Lines are delimited by "\n", so filenames containing "\n" are not
2283 ;; File lines should display the basename.
2284 ;; - must be consistent with
2285 ;; - functions dired-move-to-filename, (these two define what a file line is)
2286 ;; dired-move-to-end-of-filename,
2287 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2288 ;; dired-insert-headerline
2289 ;; dired-after-subdir-garbage (defines what a "total" line is)
2290 ;; - variable dired-subdir-regexp
2291 (defun insert-directory (file switches &optional wildcard full-directory-p)
2292 "Insert directory listing for FILE, formatted according to SWITCHES.
2293 Leaves point after the inserted text.
2294 SWITCHES may be a string of options, or a list of strings.
2295 Optional third arg WILDCARD means treat FILE as shell wildcard.
2296 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2297 switches do not contain `d', so that a full listing is expected.
2299 This works by running a directory listing program
2300 whose name is in the variable `insert-directory-program'.
2301 If WILDCARD, it also runs the shell specified by `shell-file-name'."
2302 ;; We need the directory in order to find the right handler.
2303 (let ((handler (find-file-name-handler (expand-file-name file)
2304 'insert-directory)))
2306 (funcall handler 'insert-directory file switches
2307 wildcard full-directory-p)
2308 (if (eq system-type 'vax-vms)
2309 (vms-read-directory file switches (current-buffer))
2311 ;; Run ls in the directory of the file pattern we asked for.
2312 (let ((default-directory
2313 (if (file-name-absolute-p file)
2314 (file-name-directory file)
2315 (file-name-directory (expand-file-name file))))
2316 (pattern (file-name-nondirectory file))
2318 ;; Quote some characters that have special meanings in shells;
2319 ;; but don't quote the wildcards--we want them to be special.
2320 ;; We also currently don't quote the quoting characters
2321 ;; in case people want to use them explicitly to quote
2322 ;; wildcard characters.
2323 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
2325 (concat (substring pattern 0 (match-beginning 0))
2327 (substring pattern (match-beginning 0)))
2328 beg (1+ (match-end 0))))
2329 (call-process shell-file-name nil t nil
2330 "-c" (concat "\\" ;; Disregard shell aliases!
2331 insert-directory-program
2333 (if (stringp switches)
2335 (mapconcat 'identity switches " "))
2338 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2339 ;; directory if FILE is a symbolic link.
2340 (apply 'call-process
2341 insert-directory-program nil t nil
2343 (if (listp switches)
2344 (setq list switches)
2345 (if (not (equal switches ""))
2347 ;; Split the switches at any spaces
2348 ;; so we can pass separate options as separate args.
2349 (while (string-match " " switches)
2350 (setq list (cons (substring switches 0 (match-beginning 0))
2352 switches (substring switches (match-end 0))))
2353 (setq list (cons switches list)))))
2356 (if full-directory-p
2357 (concat (file-name-as-directory file) ".")
2360 (defvar kill-emacs-query-functions nil
2361 "Functions to call with no arguments to query about killing Emacs.
2362 If any of these functions returns nil, killing Emacs is cancelled.
2363 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
2364 but `kill-emacs', the low level primitive, does not.
2365 See also `kill-emacs-hook'.")
2367 (defun save-buffers-kill-emacs (&optional arg)
2368 "Offer to save each buffer, then kill this Emacs process.
2369 With prefix arg, silently save all file-visiting buffers, then kill."
2371 (save-some-buffers arg t)
2372 (and (or (not (memq t (mapcar (function
2373 (lambda (buf) (and (buffer-file-name buf)
2374 (buffer-modified-p buf))))
2376 (yes-or-no-p "Modified buffers exist; exit anyway? "))
2377 (or (not (fboundp 'process-list))
2378 ;; process-list is not defined on VMS.
2379 (let ((processes (process-list))
2382 (and (memq (process-status (car processes)) '(run stop open))
2383 (let ((val (process-kill-without-query (car processes))))
2384 (process-kill-without-query (car processes) val)
2387 (setq processes (cdr processes)))
2389 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
2390 ;; Query the user for other things, perhaps.
2391 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
2394 (define-key ctl-x-map "\C-f" 'find-file)
2395 (define-key ctl-x-map "\C-q" 'toggle-read-only)
2396 (define-key ctl-x-map "\C-r" 'find-file-read-only)
2397 (define-key ctl-x-map "\C-v" 'find-alternate-file)
2398 (define-key ctl-x-map "\C-s" 'save-buffer)
2399 (define-key ctl-x-map "s" 'save-some-buffers)
2400 (define-key ctl-x-map "\C-w" 'write-file)
2401 (define-key ctl-x-map "i" 'insert-file)
2402 (define-key esc-map "~" 'not-modified)
2403 (define-key ctl-x-map "\C-d" 'list-directory)
2404 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
2406 (define-key ctl-x-4-map "f" 'find-file-other-window)
2407 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
2408 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
2409 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
2410 (define-key ctl-x-4-map "\C-o" 'display-buffer)
2412 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
2413 (define-key ctl-x-5-map "f" 'find-file-other-frame)
2414 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
2415 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
2417 ;;; files.el ends here