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