]> code.delx.au - gnu-emacs/blob - lisp/files.el
(magic-mode-regexp-match-limit): New defvar.
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005 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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, 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 (defvar font-lock-keywords)
34
35
36 (defgroup backup nil
37 "Backups of edited data files."
38 :group 'files)
39
40 (defgroup find-file nil
41 "Finding files."
42 :group 'files)
43
44
45 (defcustom delete-auto-save-files t
46 "*Non-nil means delete auto-save file when a buffer is saved or killed.
47
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
50 :type 'boolean
51 :group 'auto-save)
52
53 (defcustom directory-abbrev-alist
54 nil
55 "*Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
60
61 Do not use `~' in the TO strings.
62 They should be ordinary absolute directory names.
63
64 Use this feature when you have directories which you normally refer to
65 via absolute symbolic links. Make TO the name of the link, and FROM
66 the name it is linked to."
67 :type '(repeat (cons :format "%v"
68 :value ("" . "")
69 (regexp :tag "From")
70 (regexp :tag "To")))
71 :group 'abbrev
72 :group 'find-file)
73
74 ;; Turn off backup files on VMS since it has version numbers.
75 (defcustom make-backup-files (not (eq system-type 'vax-vms))
76 "*Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
78
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
83
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
88
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 :type 'boolean
94 :group 'backup)
95
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
98 (defvar backup-inhibited nil
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
101 But it is local only if you make it local.")
102 (put 'backup-inhibited 'permanent-local t)
103
104 (defcustom backup-by-copying nil
105 "*Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
107 :type 'boolean
108 :group 'backup)
109
110 (defcustom backup-by-copying-when-linked nil
111 "*Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
114 :type 'boolean
115 :group 'backup)
116
117 (defcustom backup-by-copying-when-mismatch nil
118 "*Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
124 :type 'boolean
125 :group 'backup)
126
127 (defcustom backup-by-copying-when-privileged-mismatch 200
128 "*Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
136 :type '(choice (const nil) integer)
137 :group 'backup)
138
139 (defvar backup-enable-predicate 'normal-backup-enable-predicate
140 "Predicate that looks at a file name and decides whether to make backups.
141 Called with an absolute file name as argument, it returns t to enable backup.")
142
143 (defcustom buffer-offer-save nil
144 "*Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
147 :type 'boolean
148 :group 'backup)
149 (make-variable-buffer-local 'buffer-offer-save)
150
151 (defcustom find-file-existing-other-name t
152 "*Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
155 :type 'boolean
156 :group 'find-file)
157
158 (defcustom find-file-visit-truename nil
159 "*Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
162 :type 'boolean
163 :group 'find-file)
164
165 (defcustom revert-without-query nil
166 "*Specify which files should be reverted without query.
167 The value is a list of regular expressions.
168 If the file name matches one of these regular expressions,
169 then `revert-buffer' reverts the file without querying
170 if the file has changed on disk and you have not edited the buffer."
171 :type '(repeat regexp)
172 :group 'find-file)
173
174 (defvar buffer-file-number nil
175 "The device number and file number of the file visited in the current buffer.
176 The value is a list of the form (FILENUM DEVNUM).
177 This pair of numbers uniquely identifies the file.
178 If the buffer is visiting a new file, the value is nil.")
179 (make-variable-buffer-local 'buffer-file-number)
180 (put 'buffer-file-number 'permanent-local t)
181
182 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
183 "Non-nil means that `buffer-file-number' uniquely identifies files.")
184
185 (defvar buffer-file-read-only nil
186 "Non-nil if visited file was read-only when visited.")
187 (make-variable-buffer-local 'buffer-file-read-only)
188
189 (defcustom temporary-file-directory
190 (file-name-as-directory
191 (cond ((memq system-type '(ms-dos windows-nt))
192 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
193 ((memq system-type '(vax-vms axp-vms))
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
195 (t
196 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
197 "The directory for writing temporary files."
198 :group 'files
199 :type 'directory)
200
201 (defcustom small-temporary-file-directory
202 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
207 :group 'files
208 :type '(choice (const nil) directory))
209
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
211 (defvar null-device "/dev/null" "The system null device.")
212
213 (defvar file-name-invalid-regexp
214 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
215 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
216 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
217 "[\000-\031]\\|" ; control characters
218 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
219 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
220 ((memq system-type '(ms-dos windows-nt cygwin))
221 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
222 "[|<>\"?*\000-\031]")) ; invalid characters
223 (t "[\000]"))
224 "Regexp recognizing file names which aren't allowed by the filesystem.")
225
226 (defcustom file-precious-flag nil
227 "*Non-nil means protect against I/O errors while saving files.
228 Some modes set this non-nil in particular buffers.
229
230 This feature works by writing the new contents into a temporary file
231 and then renaming the temporary file to replace the original.
232 In this way, any I/O error in writing leaves the original untouched,
233 and there is never any instant where the file is nonexistent.
234
235 Note that this feature forces backups to be made by copying.
236 Yet, at the same time, saving a precious file
237 breaks any hard links between it and other files."
238 :type 'boolean
239 :group 'backup)
240
241 (defcustom version-control nil
242 "*Control use of version numbers for backup files.
243 t means make numeric backup versions unconditionally.
244 nil means make them for files that have some already.
245 `never' means do not make them."
246 :type '(choice (const :tag "Never" never)
247 (const :tag "If existing" nil)
248 (other :tag "Always" t))
249 :group 'backup
250 :group 'vc)
251
252 (defcustom dired-kept-versions 2
253 "*When cleaning directory, number of versions to keep."
254 :type 'integer
255 :group 'backup
256 :group 'dired)
257
258 (defcustom delete-old-versions nil
259 "*If t, delete excess backup versions silently.
260 If nil, ask confirmation. Any other value prevents any trimming."
261 :type '(choice (const :tag "Delete" t)
262 (const :tag "Ask" nil)
263 (other :tag "Leave" other))
264 :group 'backup)
265
266 (defcustom kept-old-versions 2
267 "*Number of oldest versions to keep when a new numbered backup is made."
268 :type 'integer
269 :group 'backup)
270
271 (defcustom kept-new-versions 2
272 "*Number of newest versions to keep when a new numbered backup is made.
273 Includes the new backup. Must be > 0"
274 :type 'integer
275 :group 'backup)
276
277 (defcustom require-final-newline nil
278 "*Whether to add a newline automatically at the end of the file.
279
280 A value of t means do this only when the file is about to be saved.
281 A value of `visit' means do this right after the file is visited.
282 A value of `visit-save' means do it at both of those times.
283 Any other non-nil value means ask user whether to add a newline, when saving.
284 nil means don't add newlines.
285
286 Certain major modes set this locally to the value obtained
287 from `mode-require-final-newline'."
288 :type '(choice (const :tag "When visiting" visit)
289 (const :tag "When saving" t)
290 (const :tag "When visiting or saving" visit-save)
291 (const :tag "Don't add newlines" nil)
292 (other :tag "Ask each time" ask))
293 :group 'editing-basics)
294
295 (defcustom mode-require-final-newline t
296 "*Whether to add a newline at end of file, in certain major modes.
297 Those modes set `require-final-newline' to this value when you enable them.
298 They do so because they are often used for files that are supposed
299 to end in newlines, and the question is how to arrange that.
300
301 A value of t means do this only when the file is about to be saved.
302 A value of `visit' means do this right after the file is visited.
303 A value of `visit-save' means do it at both of those times.
304 Any other non-nil value means ask user whether to add a newline, when saving.
305
306 nil means do not add newlines. That is a risky choice in this variable
307 since this value is used for modes for files that ought to have final newlines.
308 So if you set this to nil, you must explicitly check and add
309 a final newline, whenever you save a file that really needs one."
310 :type '(choice (const :tag "When visiting" visit)
311 (const :tag "When saving" t)
312 (const :tag "When visiting or saving" visit-save)
313 (const :tag "Don't add newlines" nil)
314 (other :tag "Ask each time" ask))
315 :group 'editing-basics
316 :version "22.1")
317
318 (defcustom auto-save-default t
319 "*Non-nil says by default do auto-saving of every file-visiting buffer."
320 :type 'boolean
321 :group 'auto-save)
322
323 (defcustom auto-save-visited-file-name nil
324 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
325 Normally auto-save files are written under other names."
326 :type 'boolean
327 :group 'auto-save)
328
329 (defcustom auto-save-file-name-transforms
330 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
331 ;; Don't put "\\2" inside expand-file-name, since it will be
332 ;; transformed to "/2" on DOS/Windows.
333 ,(concat temporary-file-directory "\\2") t))
334 "*Transforms to apply to buffer file name before making auto-save file name.
335 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
336 REGEXP is a regular expression to match against the file name.
337 If it matches, `replace-match' is used to replace the
338 matching part with REPLACEMENT.
339 If the optional element UNIQUIFY is non-nil, the auto-save file name is
340 constructed by taking the directory part of the replaced file-name,
341 concatenated with the buffer file name with all directory separators
342 changed to `!' to prevent clashes. This will not work
343 correctly if your filesystem truncates the resulting name.
344
345 All the transforms in the list are tried, in the order they are listed.
346 When one transform applies, its result is final;
347 no further transforms are tried.
348
349 The default value is set up to put the auto-save file into the
350 temporary directory (see the variable `temporary-file-directory') for
351 editing a remote file.
352
353 On MS-DOS filesystems without long names this variable is always
354 ignored."
355 :group 'auto-save
356 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
357 (boolean :tag "Uniquify")))
358 :version "21.1")
359
360 (defcustom save-abbrevs t
361 "*Non-nil means save word abbrevs too when files are saved.
362 If `silently', don't ask the user before saving."
363 :type '(choice (const t) (const nil) (const silently))
364 :group 'abbrev)
365
366 (defcustom find-file-run-dired t
367 "*Non-nil means allow `find-file' to visit directories.
368 To visit the directory, `find-file' runs `find-directory-functions'."
369 :type 'boolean
370 :group 'find-file)
371
372 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
373 "*List of functions to try in sequence to visit a directory.
374 Each function is called with the directory name as the sole argument
375 and should return either a buffer or nil."
376 :type '(hook :options (cvs-dired-noselect dired-noselect))
377 :group 'find-file)
378
379 ;;;It is not useful to make this a local variable.
380 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
381 (defvar find-file-not-found-functions nil
382 "List of functions to be called for `find-file' on nonexistent file.
383 These functions are called as soon as the error is detected.
384 Variable `buffer-file-name' is already set up.
385 The functions are called in the order given until one of them returns non-nil.")
386 (define-obsolete-variable-alias 'find-file-not-found-hooks
387 'find-file-not-found-functions "22.1")
388
389 ;;;It is not useful to make this a local variable.
390 ;;;(put 'find-file-hooks 'permanent-local t)
391 (defcustom find-file-hook nil
392 "List of functions to be called after a buffer is loaded from a file.
393 The buffer's local variables (if any) will have been processed before the
394 functions are called."
395 :group 'find-file
396 :type 'hook
397 :options '(auto-insert)
398 :version "22.1")
399 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
400
401 (defvar write-file-functions nil
402 "List of functions to be called before writing out a buffer to a file.
403 If one of them returns non-nil, the file is considered already written
404 and the rest are not called.
405 These hooks are considered to pertain to the visited file.
406 So any buffer-local binding of this variable is discarded if you change
407 the visited file name with \\[set-visited-file-name], but not when you
408 change the major mode.
409
410 This hook is not run if any of the functions in
411 `write-contents-functions' returns non-nil. Both hooks pertain
412 to how to save a buffer to file, for instance, choosing a suitable
413 coding system and setting mode bits. (See Info
414 node `(elisp)Saving Buffers'.) To perform various checks or
415 updates before the buffer is saved, use `before-save-hook'.")
416 (put 'write-file-functions 'permanent-local t)
417 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
418
419 (defvar local-write-file-hooks nil)
420 (make-variable-buffer-local 'local-write-file-hooks)
421 (put 'local-write-file-hooks 'permanent-local t)
422 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
423
424 (defvar write-contents-functions nil
425 "List of functions to be called before writing out a buffer to a file.
426 If one of them returns non-nil, the file is considered already written
427 and the rest are not called and neither are the functions in
428 `write-file-functions'.
429
430 This variable is meant to be used for hooks that pertain to the
431 buffer's contents, not to the particular visited file; thus,
432 `set-visited-file-name' does not clear this variable; but changing the
433 major mode does clear it.
434
435 For hooks that _do_ pertain to the particular visited file, use
436 `write-file-functions'. Both this variable and
437 `write-file-functions' relate to how a buffer is saved to file.
438 To perform various checks or updates before the buffer is saved,
439 use `before-save-hook'.")
440 (make-variable-buffer-local 'write-contents-functions)
441 (define-obsolete-variable-alias 'write-contents-hooks
442 'write-contents-functions "22.1")
443
444 (defcustom enable-local-variables t
445 "*Control use of local variables in files you visit.
446 The value can be t, nil or something else.
447 A value of t means file local variables specifications are obeyed;
448 nil means they are ignored; anything else means query.
449 This variable also controls use of major modes specified in
450 a -*- line.
451
452 The command \\[normal-mode], when used interactively,
453 always obeys file local variable specifications and the -*- line,
454 and ignores this variable."
455 :type '(choice (const :tag "Obey" t)
456 (const :tag "Ignore" nil)
457 (other :tag "Query" other))
458 :group 'find-file)
459
460 (defvar local-enable-local-variables t
461 "Like `enable-local-variables' but meant for buffer-local bindings.
462 The meaningful values are nil and non-nil. The default is non-nil.
463 If a major mode sets this to nil, buffer-locally, then any local
464 variables list in the file will be ignored.
465
466 This variable does not affect the use of major modes
467 specified in a -*- line.")
468
469 (defcustom enable-local-eval 'maybe
470 "*Control processing of the \"variable\" `eval' in a file's local variables.
471 The value can be t, nil or something else.
472 A value of t means obey `eval' variables;
473 nil means ignore them; anything else means query."
474 :type '(choice (const :tag "Obey" t)
475 (const :tag "Ignore" nil)
476 (other :tag "Query" other))
477 :group 'find-file)
478
479 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
480 (or (fboundp 'lock-buffer)
481 (defalias 'lock-buffer 'ignore))
482 (or (fboundp 'unlock-buffer)
483 (defalias 'unlock-buffer 'ignore))
484 (or (fboundp 'file-locked-p)
485 (defalias 'file-locked-p 'ignore))
486
487 (defcustom view-read-only nil
488 "*Non-nil means buffers visiting files read-only do so in view mode.
489 In fact, this means that all read-only buffers normally have
490 View mode enabled, including buffers that are read-only because
491 you visit a file you cannot alter, and buffers you make read-only
492 using \\[toggle-read-only]."
493 :type 'boolean
494 :group 'view)
495
496 (put 'ange-ftp-completion-hook-function 'safe-magic t)
497 (defun ange-ftp-completion-hook-function (op &rest args)
498 "Provides support for ange-ftp host name completion.
499 Runs the usual ange-ftp hook, but only for completion operations."
500 ;; Having this here avoids the need to load ange-ftp when it's not
501 ;; really in use.
502 (if (memq op '(file-name-completion file-name-all-completions))
503 (apply 'ange-ftp-hook-function op args)
504 (let ((inhibit-file-name-handlers
505 (cons 'ange-ftp-completion-hook-function
506 (and (eq inhibit-file-name-operation op)
507 inhibit-file-name-handlers)))
508 (inhibit-file-name-operation op))
509 (apply op args))))
510
511 (defun convert-standard-filename (filename)
512 "Convert a standard file's name to something suitable for the OS.
513 This means to guarantee valid names and perhaps to canonicalize
514 certain patterns.
515
516 FILENAME should be an absolute file name since the conversion rules
517 sometimes vary depending on the position in the file name. E.g. c:/foo
518 is a valid DOS file name, but c:/bar/c:/foo is not.
519
520 This function's standard definition is trivial; it just returns
521 the argument. However, on Windows and DOS, replace invalid
522 characters. On DOS, make sure to obey the 8.3 limitations. On
523 Windows, turn Cygwin names into native names, and also turn
524 slashes into backslashes if the shell requires it (see
525 `w32-shell-dos-semantics').
526
527 See Info node `(elisp)Standard File Names' for more details."
528 filename)
529
530 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
531 "Read directory name, prompting with PROMPT and completing in directory DIR.
532 Value is not expanded---you must call `expand-file-name' yourself.
533 Default name to DEFAULT-DIRNAME if user exits with the same
534 non-empty string that was inserted by this function.
535 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
536 or just DIR if INITIAL is nil.)
537 If the user exits with an empty minibuffer, this function returns
538 an empty string. (This can only happen if the user erased the
539 pre-inserted contents or if `insert-default-directory' is nil.)
540 Fourth arg MUSTMATCH non-nil means require existing directory's name.
541 Non-nil and non-t means also require confirmation after completion.
542 Fifth arg INITIAL specifies text to start with.
543 DIR should be an absolute directory name. It defaults to
544 the value of `default-directory'."
545 (unless dir
546 (setq dir default-directory))
547 (read-file-name prompt dir (or default-dirname
548 (if initial (expand-file-name initial dir)
549 dir))
550 mustmatch initial
551 'file-directory-p))
552
553 \f
554 (defun pwd ()
555 "Show the current default directory."
556 (interactive nil)
557 (message "Directory %s" default-directory))
558
559 (defvar cd-path nil
560 "Value of the CDPATH environment variable, as a list.
561 Not actually set up until the first time you use it.")
562
563 (defun parse-colon-path (cd-path)
564 "Explode a search path into a list of directory names.
565 Directories are separated by occurrences of `path-separator'
566 \(which is colon in GNU and GNU-like systems)."
567 ;; We could use split-string here.
568 (and cd-path
569 (let (cd-list (cd-start 0) cd-colon)
570 (setq cd-path (concat cd-path path-separator))
571 (while (setq cd-colon (string-match path-separator cd-path cd-start))
572 (setq cd-list
573 (nconc cd-list
574 (list (if (= cd-start cd-colon)
575 nil
576 (substitute-in-file-name
577 (file-name-as-directory
578 (substring cd-path cd-start cd-colon)))))))
579 (setq cd-start (+ cd-colon 1)))
580 cd-list)))
581
582 (defun cd-absolute (dir)
583 "Change current directory to given absolute file name DIR."
584 ;; Put the name into directory syntax now,
585 ;; because otherwise expand-file-name may give some bad results.
586 (if (not (eq system-type 'vax-vms))
587 (setq dir (file-name-as-directory dir)))
588 (setq dir (abbreviate-file-name (expand-file-name dir)))
589 (if (not (file-directory-p dir))
590 (if (file-exists-p dir)
591 (error "%s is not a directory" dir)
592 (error "%s: no such directory" dir))
593 (if (file-executable-p dir)
594 (setq default-directory dir)
595 (error "Cannot cd to %s: Permission denied" dir))))
596
597 (defun cd (dir)
598 "Make DIR become the current buffer's default directory.
599 If your environment includes a `CDPATH' variable, try each one of
600 that list of directories (separated by occurrences of
601 `path-separator') when resolving a relative directory name.
602 The path separator is colon in GNU and GNU-like systems."
603 (interactive
604 (list (read-directory-name "Change default directory: "
605 default-directory default-directory
606 (and (member cd-path '(nil ("./")))
607 (null (getenv "CDPATH"))))))
608 (if (file-name-absolute-p dir)
609 (cd-absolute (expand-file-name dir))
610 (if (null cd-path)
611 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
612 (setq cd-path (or trypath (list "./")))))
613 (if (not (catch 'found
614 (mapcar
615 (function (lambda (x)
616 (let ((f (expand-file-name (concat x dir))))
617 (if (file-directory-p f)
618 (progn
619 (cd-absolute f)
620 (throw 'found t))))))
621 cd-path)
622 nil))
623 (error "No such directory found via CDPATH environment variable"))))
624
625 (defun load-file (file)
626 "Load the Lisp file named FILE."
627 ;; This is a case where .elc makes a lot of sense.
628 (interactive (list (let ((completion-ignored-extensions
629 (remove ".elc" completion-ignored-extensions)))
630 (read-file-name "Load file: "))))
631 (load (expand-file-name file) nil nil t))
632
633 (defun locate-file (filename path &optional suffixes predicate)
634 "Search for FILENAME through PATH.
635 If found, return the absolute file name of FILENAME, with its suffixes;
636 otherwise return nil.
637 PATH should be a list of directories to look in, like the lists in
638 `exec-path' or `load-path'.
639 If SUFFIXES is non-nil, it should be a list of suffixes to append to
640 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
641 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
642 If non-nil, PREDICATE is used instead of `file-readable-p'.
643 PREDICATE can also be an integer to pass to the `access' system call,
644 in which case file-name handlers are ignored. This usage is deprecated.
645
646 For compatibility, PREDICATE can also be one of the symbols
647 `executable', `readable', `writable', or `exists', or a list of
648 one or more of those symbols."
649 (if (and predicate (symbolp predicate) (not (functionp predicate)))
650 (setq predicate (list predicate)))
651 (when (and (consp predicate) (not (functionp predicate)))
652 (setq predicate
653 (logior (if (memq 'executable predicate) 1 0)
654 (if (memq 'writable predicate) 2 0)
655 (if (memq 'readable predicate) 4 0))))
656 (locate-file-internal filename path suffixes predicate))
657
658 (defun locate-file-completion (string path-and-suffixes action)
659 "Do completion for file names passed to `locate-file'.
660 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
661 (if (file-name-absolute-p string)
662 (read-file-name-internal string nil action)
663 (let ((names nil)
664 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
665 (string-dir (file-name-directory string)))
666 (dolist (dir (car path-and-suffixes))
667 (unless dir
668 (setq dir default-directory))
669 (if string-dir (setq dir (expand-file-name string-dir dir)))
670 (when (file-directory-p dir)
671 (dolist (file (file-name-all-completions
672 (file-name-nondirectory string) dir))
673 (push (if string-dir (concat string-dir file) file) names)
674 (when (string-match suffix file)
675 (setq file (substring file 0 (match-beginning 0)))
676 (push (if string-dir (concat string-dir file) file) names)))))
677 (cond
678 ((eq action t) (all-completions string names))
679 ((null action) (try-completion string names))
680 (t (test-completion string names))))))
681
682 (defun executable-find (command)
683 "Search for COMMAND in `exec-path' and return the absolute file name.
684 Return nil if COMMAND is not found anywhere in `exec-path'."
685 ;; Use 1 rather than file-executable-p to better match the behavior of
686 ;; call-process.
687 (locate-file command exec-path exec-suffixes 1))
688
689 (defun load-library (library)
690 "Load the library named LIBRARY.
691 This is an interface to the function `load'."
692 (interactive
693 (list (completing-read "Load library: "
694 'locate-file-completion
695 (cons load-path load-suffixes))))
696 (load library))
697
698 (defun file-remote-p (file)
699 "Test whether FILE specifies a location on a remote system.
700 Return an identification of the system if the location is indeed
701 remote. The identification of the system may comprise a method
702 to access the system and its hostname, amongst other things.
703
704 For example, the filename \"/user@host:/foo\" specifies a location
705 on the system \"/user@host:\"."
706 (let ((handler (find-file-name-handler file 'file-remote-p)))
707 (if handler
708 (funcall handler 'file-remote-p file)
709 nil)))
710
711 (defun file-local-copy (file)
712 "Copy the file FILE into a temporary file on this machine.
713 Returns the name of the local copy, or nil, if FILE is directly
714 accessible."
715 ;; This formerly had an optional BUFFER argument that wasn't used by
716 ;; anything.
717 (let ((handler (find-file-name-handler file 'file-local-copy)))
718 (if handler
719 (funcall handler 'file-local-copy file)
720 nil)))
721
722 (defun file-truename (filename &optional counter prev-dirs)
723 "Return the truename of FILENAME, which should be absolute.
724 The truename of a file name is found by chasing symbolic links
725 both at the level of the file and at the level of the directories
726 containing it, until no links are left at any level.
727
728 \(fn FILENAME)" ;; Don't document the optional arguments.
729 ;; COUNTER and PREV-DIRS are only used in recursive calls.
730 ;; COUNTER can be a cons cell whose car is the count of how many
731 ;; more links to chase before getting an error.
732 ;; PREV-DIRS can be a cons cell whose car is an alist
733 ;; of truenames we've just recently computed.
734 (cond ((or (string= filename "") (string= filename "~"))
735 (setq filename (expand-file-name filename))
736 (if (string= filename "")
737 (setq filename "/")))
738 ((and (string= (substring filename 0 1) "~")
739 (string-match "~[^/]*/?" filename))
740 (let ((first-part
741 (substring filename 0 (match-end 0)))
742 (rest (substring filename (match-end 0))))
743 (setq filename (concat (expand-file-name first-part) rest)))))
744
745 (or counter (setq counter (list 100)))
746 (let (done
747 ;; For speed, remove the ange-ftp completion handler from the list.
748 ;; We know it's not needed here.
749 ;; For even more speed, do this only on the outermost call.
750 (file-name-handler-alist
751 (if prev-dirs file-name-handler-alist
752 (let ((tem (copy-sequence file-name-handler-alist)))
753 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
754 (or prev-dirs (setq prev-dirs (list nil)))
755
756 ;; andrewi@harlequin.co.uk - none of the following code (except for
757 ;; invoking the file-name handler) currently applies on Windows
758 ;; (ie. there are no native symlinks), but there is an issue with
759 ;; case differences being ignored by the OS, and short "8.3 DOS"
760 ;; name aliases existing for all files. (The short names are not
761 ;; reported by directory-files, but can be used to refer to files.)
762 ;; It seems appropriate for file-truename to resolve these issues in
763 ;; the most natural way, which on Windows is to call the function
764 ;; `w32-long-file-name' - this returns the exact name of a file as
765 ;; it is stored on disk (expanding short name aliases with the full
766 ;; name in the process).
767 (if (eq system-type 'windows-nt)
768 (let ((handler (find-file-name-handler filename 'file-truename)))
769 ;; For file name that has a special handler, call handler.
770 ;; This is so that ange-ftp can save time by doing a no-op.
771 (if handler
772 (setq filename (funcall handler 'file-truename filename))
773 ;; If filename contains a wildcard, newname will be the old name.
774 (unless (string-match "[[*?]" filename)
775 ;; If filename exists, use the long name
776 (setq filename (or (w32-long-file-name filename) filename))))
777 (setq done t)))
778
779 ;; If this file directly leads to a link, process that iteratively
780 ;; so that we don't use lots of stack.
781 (while (not done)
782 (setcar counter (1- (car counter)))
783 (if (< (car counter) 0)
784 (error "Apparent cycle of symbolic links for %s" filename))
785 (let ((handler (find-file-name-handler filename 'file-truename)))
786 ;; For file name that has a special handler, call handler.
787 ;; This is so that ange-ftp can save time by doing a no-op.
788 (if handler
789 (setq filename (funcall handler 'file-truename filename)
790 done t)
791 (let ((dir (or (file-name-directory filename) default-directory))
792 target dirfile)
793 ;; Get the truename of the directory.
794 (setq dirfile (directory-file-name dir))
795 ;; If these are equal, we have the (or a) root directory.
796 (or (string= dir dirfile)
797 ;; If this is the same dir we last got the truename for,
798 ;; save time--don't recalculate.
799 (if (assoc dir (car prev-dirs))
800 (setq dir (cdr (assoc dir (car prev-dirs))))
801 (let ((old dir)
802 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
803 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
804 (setq dir new))))
805 (if (equal ".." (file-name-nondirectory filename))
806 (setq filename
807 (directory-file-name (file-name-directory (directory-file-name dir)))
808 done t)
809 (if (equal "." (file-name-nondirectory filename))
810 (setq filename (directory-file-name dir)
811 done t)
812 ;; Put it back on the file name.
813 (setq filename (concat dir (file-name-nondirectory filename)))
814 ;; Is the file name the name of a link?
815 (setq target (file-symlink-p filename))
816 (if target
817 ;; Yes => chase that link, then start all over
818 ;; since the link may point to a directory name that uses links.
819 ;; We can't safely use expand-file-name here
820 ;; since target might look like foo/../bar where foo
821 ;; is itself a link. Instead, we handle . and .. above.
822 (setq filename
823 (if (file-name-absolute-p target)
824 target
825 (concat dir target))
826 done nil)
827 ;; No, we are done!
828 (setq done t))))))))
829 filename))
830
831 (defun file-chase-links (filename &optional limit)
832 "Chase links in FILENAME until a name that is not a link.
833 Unlike `file-truename', this does not check whether a parent
834 directory name is a symbolic link.
835 If the optional argument LIMIT is a number,
836 it means chase no more than that many links and then stop."
837 (let (tem (newname filename)
838 (count 0))
839 (while (and (or (null limit) (< count limit))
840 (setq tem (file-symlink-p newname)))
841 (save-match-data
842 (if (and (null limit) (= count 100))
843 (error "Apparent cycle of symbolic links for %s" filename))
844 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
845 (while (string-match "//+" tem)
846 (setq tem (replace-match "/" nil nil tem)))
847 ;; Handle `..' by hand, since it needs to work in the
848 ;; target of any directory symlink.
849 ;; This code is not quite complete; it does not handle
850 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
851 (while (string-match "\\`\\.\\./" tem)
852 (setq tem (substring tem 3))
853 (setq newname (expand-file-name newname))
854 ;; Chase links in the default dir of the symlink.
855 (setq newname
856 (file-chase-links
857 (directory-file-name (file-name-directory newname))))
858 ;; Now find the parent of that dir.
859 (setq newname (file-name-directory newname)))
860 (setq newname (expand-file-name tem (file-name-directory newname)))
861 (setq count (1+ count))))
862 newname))
863
864 (defun make-temp-file (prefix &optional dir-flag suffix)
865 "Create a temporary file.
866 The returned file name (created by appending some random characters at the end
867 of PREFIX, and expanding against `temporary-file-directory' if necessary),
868 is guaranteed to point to a newly created empty file.
869 You can then use `write-region' to write new data into the file.
870
871 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
872
873 If SUFFIX is non-nil, add that at the end of the file name."
874 (let ((umask (default-file-modes))
875 file)
876 (unwind-protect
877 (progn
878 ;; Create temp files with strict access rights. It's easy to
879 ;; loosen them later, whereas it's impossible to close the
880 ;; time-window of loose permissions otherwise.
881 (set-default-file-modes ?\700)
882 (while (condition-case ()
883 (progn
884 (setq file
885 (make-temp-name
886 (expand-file-name prefix temporary-file-directory)))
887 (if suffix
888 (setq file (concat file suffix)))
889 (if dir-flag
890 (make-directory file)
891 (write-region "" nil file nil 'silent nil 'excl))
892 nil)
893 (file-already-exists t))
894 ;; the file was somehow created by someone else between
895 ;; `make-temp-name' and `write-region', let's try again.
896 nil)
897 file)
898 ;; Reset the umask.
899 (set-default-file-modes umask))))
900
901 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
902 "Change the encoding of FILE's name from CODING to NEW-CODING.
903 The value is a new name of FILE.
904 Signals a `file-already-exists' error if a file of the new name
905 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
906 is non-nil. A number as fourth arg means request confirmation if
907 the new name already exists. This is what happens in interactive
908 use with M-x."
909 (interactive
910 (let ((default-coding (or file-name-coding-system
911 default-file-name-coding-system))
912 (filename (read-file-name "Recode filename: " nil nil t))
913 from-coding to-coding)
914 (if (and default-coding
915 ;; We provide the default coding only when it seems that
916 ;; the filename is correctly decoded by the default
917 ;; coding.
918 (let ((charsets (find-charset-string filename)))
919 (and (not (memq 'eight-bit-control charsets))
920 (not (memq 'eight-bit-graphic charsets)))))
921 (setq from-coding (read-coding-system
922 (format "Recode filename %s from (default %s): "
923 filename default-coding)
924 default-coding))
925 (setq from-coding (read-coding-system
926 (format "Recode filename %s from: " filename))))
927
928 ;; We provide the default coding only when a user is going to
929 ;; change the encoding not from the default coding.
930 (if (eq from-coding default-coding)
931 (setq to-coding (read-coding-system
932 (format "Recode filename %s from %s to: "
933 filename from-coding)))
934 (setq to-coding (read-coding-system
935 (format "Recode filename %s from %s to (default %s): "
936 filename from-coding default-coding)
937 default-coding)))
938 (list filename from-coding to-coding)))
939
940 (let* ((default-coding (or file-name-coding-system
941 default-file-name-coding-system))
942 ;; FILE should have been decoded by DEFAULT-CODING.
943 (encoded (encode-coding-string file default-coding))
944 (newname (decode-coding-string encoded coding))
945 (new-encoded (encode-coding-string newname new-coding))
946 ;; Suppress further encoding.
947 (file-name-coding-system nil)
948 (default-file-name-coding-system nil)
949 (locale-coding-system nil))
950 (rename-file encoded new-encoded ok-if-already-exists)
951 newname))
952 \f
953 (defun switch-to-buffer-other-window (buffer &optional norecord)
954 "Select buffer BUFFER in another window.
955 If BUFFER does not identify an existing buffer, then this function
956 creates a buffer with that name.
957
958 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
959 or nil. If BUFFER is nil, then this function chooses a buffer
960 using `other-buffer'.
961 Optional second arg NORECORD non-nil means
962 do not put this buffer at the front of the list of recently selected ones.
963 This function returns the buffer it switched to.
964
965 This uses the function `display-buffer' as a subroutine; see its
966 documentation for additional customization information."
967 (interactive "BSwitch to buffer in other window: ")
968 (let ((pop-up-windows t)
969 ;; Don't let these interfere.
970 same-window-buffer-names same-window-regexps)
971 (pop-to-buffer buffer t norecord)))
972
973 (defun switch-to-buffer-other-frame (buffer &optional norecord)
974 "Switch to buffer BUFFER in another frame.
975 Optional second arg NORECORD non-nil means
976 do not put this buffer at the front of the list of recently selected ones.
977
978 This uses the function `display-buffer' as a subroutine; see its
979 documentation for additional customization information."
980 (interactive "BSwitch to buffer in other frame: ")
981 (let ((pop-up-frames t)
982 same-window-buffer-names same-window-regexps)
983 (pop-to-buffer buffer t norecord)
984 (raise-frame (window-frame (selected-window)))))
985
986 (defvar find-file-default nil
987 "Used within `find-file-read-args'.")
988
989 (defmacro minibuffer-with-setup-hook (fun &rest body)
990 "Add FUN to `minibuffer-setup-hook' while executing BODY.
991 BODY should use the minibuffer at most once.
992 Recursive uses of the minibuffer will not be affected."
993 (declare (indent 1) (debug t))
994 (let ((hook (make-symbol "setup-hook")))
995 `(let (,hook)
996 (setq ,hook
997 (lambda ()
998 ;; Clear out this hook so it does not interfere
999 ;; with any recursive minibuffer usage.
1000 (remove-hook 'minibuffer-setup-hook ,hook)
1001 (,fun)))
1002 (unwind-protect
1003 (progn
1004 (add-hook 'minibuffer-setup-hook ,hook)
1005 ,@body)
1006 (remove-hook 'minibuffer-setup-hook ,hook)))))
1007
1008 (defun find-file-read-args (prompt mustmatch)
1009 (list (let ((find-file-default
1010 (and buffer-file-name
1011 (abbreviate-file-name buffer-file-name))))
1012 (minibuffer-with-setup-hook
1013 (lambda () (setq minibuffer-default find-file-default))
1014 (read-file-name prompt nil default-directory mustmatch)))
1015 t))
1016
1017 (defun find-file (filename &optional wildcards)
1018 "Edit file FILENAME.
1019 Switch to a buffer visiting file FILENAME,
1020 creating one if none already exists.
1021 Interactively, the default if you just type RET is the current directory,
1022 but the visited file name is available through the minibuffer history:
1023 type M-n to pull it into the minibuffer.
1024
1025 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1026 expand wildcards (if any) and visit multiple files. You can
1027 suppress wildcard expansion by setting `find-file-wildcards'.
1028
1029 To visit a file without any kind of conversion and without
1030 automatically choosing a major mode, use \\[find-file-literally]."
1031 (interactive (find-file-read-args "Find file: " nil))
1032 (let ((value (find-file-noselect filename nil nil wildcards)))
1033 (if (listp value)
1034 (mapcar 'switch-to-buffer (nreverse value))
1035 (switch-to-buffer value))))
1036
1037 (defun find-file-other-window (filename &optional wildcards)
1038 "Edit file FILENAME, in another window.
1039 May create a new window, or reuse an existing one.
1040 See the function `display-buffer'.
1041
1042 Interactively, the default if you just type RET is the current directory,
1043 but the visited file name is available through the minibuffer history:
1044 type M-n to pull it into the minibuffer.
1045
1046 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1047 expand wildcards (if any) and visit multiple files."
1048 (interactive (find-file-read-args "Find file in other window: " nil))
1049 (let ((value (find-file-noselect filename nil nil wildcards)))
1050 (if (listp value)
1051 (progn
1052 (setq value (nreverse value))
1053 (cons (switch-to-buffer-other-window (car value))
1054 (mapcar 'switch-to-buffer (cdr value))))
1055 (switch-to-buffer-other-window value))))
1056
1057 (defun find-file-other-frame (filename &optional wildcards)
1058 "Edit file FILENAME, in another frame.
1059 May create a new frame, or reuse an existing one.
1060 See the function `display-buffer'.
1061
1062 Interactively, the default if you just type RET is the current directory,
1063 but the visited file name is available through the minibuffer history:
1064 type M-n to pull it into the minibuffer.
1065
1066 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1067 expand wildcards (if any) and visit multiple files."
1068 (interactive (find-file-read-args "Find file in other frame: " nil))
1069 (let ((value (find-file-noselect filename nil nil wildcards)))
1070 (if (listp value)
1071 (progn
1072 (setq value (nreverse value))
1073 (cons (switch-to-buffer-other-frame (car value))
1074 (mapcar 'switch-to-buffer (cdr value))))
1075 (switch-to-buffer-other-frame value))))
1076
1077 (defun find-file-existing (filename &optional wildcards)
1078 "Edit the existing file FILENAME.
1079 Like \\[find-file] but only allow files that exists."
1080 (interactive (find-file-read-args "Find existing file: " t))
1081 (unless (file-exists-p filename) (error "%s does not exist" filename))
1082 (find-file filename wildcards)
1083 (current-buffer))
1084
1085 (defun find-file-read-only (filename &optional wildcards)
1086 "Edit file FILENAME but don't allow changes.
1087 Like \\[find-file] but marks buffer as read-only.
1088 Use \\[toggle-read-only] to permit editing."
1089 (interactive (find-file-read-args "Find file read-only: " nil))
1090 (unless (or (and wildcards find-file-wildcards
1091 (not (string-match "\\`/:" filename))
1092 (string-match "[[*?]" filename))
1093 (file-exists-p filename))
1094 (error "%s does not exist" filename))
1095 (let ((value (find-file filename wildcards)))
1096 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1097 (if (listp value) value (list value)))
1098 value))
1099
1100 (defun find-file-read-only-other-window (filename &optional wildcards)
1101 "Edit file FILENAME in another window but don't allow changes.
1102 Like \\[find-file-other-window] but marks buffer as read-only.
1103 Use \\[toggle-read-only] to permit editing."
1104 (interactive (find-file-read-args "Find file read-only other window: " nil))
1105 (unless (or (and wildcards find-file-wildcards
1106 (not (string-match "\\`/:" filename))
1107 (string-match "[[*?]" filename))
1108 (file-exists-p filename))
1109 (error "%s does not exist" filename))
1110 (let ((value (find-file-other-window filename wildcards)))
1111 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1112 (if (listp value) value (list value)))
1113 value))
1114
1115 (defun find-file-read-only-other-frame (filename &optional wildcards)
1116 "Edit file FILENAME in another frame but don't allow changes.
1117 Like \\[find-file-other-frame] but marks buffer as read-only.
1118 Use \\[toggle-read-only] to permit editing."
1119 (interactive (find-file-read-args "Find file read-only other frame: " nil))
1120 (unless (or (and wildcards find-file-wildcards
1121 (not (string-match "\\`/:" filename))
1122 (string-match "[[*?]" filename))
1123 (file-exists-p filename))
1124 (error "%s does not exist" filename))
1125 (let ((value (find-file-other-frame filename wildcards)))
1126 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1127 (if (listp value) value (list value)))
1128 value))
1129
1130 (defun find-alternate-file-other-window (filename &optional wildcards)
1131 "Find file FILENAME as a replacement for the file in the next window.
1132 This command does not select that window.
1133
1134 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1135 expand wildcards (if any) and replace the file with multiple files."
1136 (interactive
1137 (save-selected-window
1138 (other-window 1)
1139 (let ((file buffer-file-name)
1140 (file-name nil)
1141 (file-dir nil))
1142 (and file
1143 (setq file-name (file-name-nondirectory file)
1144 file-dir (file-name-directory file)))
1145 (list (read-file-name
1146 "Find alternate file: " file-dir nil nil file-name)
1147 t))))
1148 (if (one-window-p)
1149 (find-file-other-window filename wildcards)
1150 (save-selected-window
1151 (other-window 1)
1152 (find-alternate-file filename wildcards))))
1153
1154 (defun find-alternate-file (filename &optional wildcards)
1155 "Find file FILENAME, select its buffer, kill previous buffer.
1156 If the current buffer now contains an empty file that you just visited
1157 \(presumably by mistake), use this command to visit the file you really want.
1158
1159 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1160 expand wildcards (if any) and replace the file with multiple files."
1161 (interactive
1162 (let ((file buffer-file-name)
1163 (file-name nil)
1164 (file-dir nil))
1165 (and file
1166 (setq file-name (file-name-nondirectory file)
1167 file-dir (file-name-directory file)))
1168 (list (read-file-name
1169 "Find alternate file: " file-dir nil nil file-name)
1170 t)))
1171 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1172 (error "Aborted"))
1173 (when (and (buffer-modified-p) (buffer-file-name))
1174 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1175 (buffer-name)))
1176 (save-buffer)
1177 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1178 (error "Aborted"))))
1179 (let ((obuf (current-buffer))
1180 (ofile buffer-file-name)
1181 (onum buffer-file-number)
1182 (odir dired-directory)
1183 (otrue buffer-file-truename)
1184 (oname (buffer-name)))
1185 (if (get-buffer " **lose**")
1186 (kill-buffer " **lose**"))
1187 (rename-buffer " **lose**")
1188 (unwind-protect
1189 (progn
1190 (unlock-buffer)
1191 ;; This prevents us from finding the same buffer
1192 ;; if we specified the same file again.
1193 (setq buffer-file-name nil)
1194 (setq buffer-file-number nil)
1195 (setq buffer-file-truename nil)
1196 ;; Likewise for dired buffers.
1197 (setq dired-directory nil)
1198 (find-file filename wildcards))
1199 (when (eq obuf (current-buffer))
1200 ;; This executes if find-file gets an error
1201 ;; and does not really find anything.
1202 ;; We put things back as they were.
1203 ;; If find-file actually finds something, we kill obuf below.
1204 (setq buffer-file-name ofile)
1205 (setq buffer-file-number onum)
1206 (setq buffer-file-truename otrue)
1207 (setq dired-directory odir)
1208 (lock-buffer)
1209 (rename-buffer oname)))
1210 (unless (eq (current-buffer) obuf)
1211 (with-current-buffer obuf
1212 ;; We already asked; don't ask again.
1213 (let ((kill-buffer-query-functions))
1214 (kill-buffer obuf))))))
1215 \f
1216 (defun create-file-buffer (filename)
1217 "Create a suitably named buffer for visiting FILENAME, and return it.
1218 FILENAME (sans directory) is used unchanged if that name is free;
1219 otherwise a string <2> or <3> or ... is appended to get an unused name."
1220 (let ((lastname (file-name-nondirectory filename)))
1221 (if (string= lastname "")
1222 (setq lastname filename))
1223 (generate-new-buffer lastname)))
1224
1225 (defun generate-new-buffer (name)
1226 "Create and return a buffer with a name based on NAME.
1227 Choose the buffer's name using `generate-new-buffer-name'."
1228 (get-buffer-create (generate-new-buffer-name name)))
1229
1230 (defcustom automount-dir-prefix "^/tmp_mnt/"
1231 "Regexp to match the automounter prefix in a directory name."
1232 :group 'files
1233 :type 'regexp)
1234
1235 (defvar abbreviated-home-dir nil
1236 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1237
1238 (defun abbreviate-file-name (filename)
1239 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1240 This also substitutes \"~\" for the user's home directory and
1241 removes automounter prefixes (see the variable `automount-dir-prefix')."
1242 ;; Get rid of the prefixes added by the automounter.
1243 (if (and automount-dir-prefix
1244 (string-match automount-dir-prefix filename)
1245 (file-exists-p (file-name-directory
1246 (substring filename (1- (match-end 0))))))
1247 (setq filename (substring filename (1- (match-end 0)))))
1248 (let ((tail directory-abbrev-alist))
1249 ;; If any elt of directory-abbrev-alist matches this name,
1250 ;; abbreviate accordingly.
1251 (while tail
1252 (if (string-match (car (car tail)) filename)
1253 (setq filename
1254 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1255 (setq tail (cdr tail)))
1256 ;; Compute and save the abbreviated homedir name.
1257 ;; We defer computing this until the first time it's needed, to
1258 ;; give time for directory-abbrev-alist to be set properly.
1259 ;; We include a slash at the end, to avoid spurious matches
1260 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1261 (or abbreviated-home-dir
1262 (setq abbreviated-home-dir
1263 (let ((abbreviated-home-dir "$foo"))
1264 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1265 "\\(/\\|$\\)"))))
1266
1267 ;; If FILENAME starts with the abbreviated homedir,
1268 ;; make it start with `~' instead.
1269 (if (and (string-match abbreviated-home-dir filename)
1270 ;; If the home dir is just /, don't change it.
1271 (not (and (= (match-end 0) 1)
1272 (= (aref filename 0) ?/)))
1273 ;; MS-DOS root directories can come with a drive letter;
1274 ;; Novell Netware allows drive letters beyond `Z:'.
1275 (not (and (or (eq system-type 'ms-dos)
1276 (eq system-type 'cygwin)
1277 (eq system-type 'windows-nt))
1278 (save-match-data
1279 (string-match "^[a-zA-`]:/$" filename)))))
1280 (setq filename
1281 (concat "~"
1282 (substring filename (match-beginning 1) (match-end 1))
1283 (substring filename (match-end 0)))))
1284 filename))
1285
1286 (defcustom find-file-not-true-dirname-list nil
1287 "*List of logical names for which visiting shouldn't save the true dirname.
1288 On VMS, when you visit a file using a logical name that searches a path,
1289 you may or may not want the visited file name to record the specific
1290 directory where the file was found. If you *do not* want that, add the logical
1291 name to this list as a string."
1292 :type '(repeat (string :tag "Name"))
1293 :group 'find-file)
1294
1295 (defun find-buffer-visiting (filename &optional predicate)
1296 "Return the buffer visiting file FILENAME (a string).
1297 This is like `get-file-buffer', except that it checks for any buffer
1298 visiting the same file, possibly under a different name.
1299 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1300 and others are ignored.
1301 If there is no such live buffer, return nil."
1302 (let ((predicate (or predicate #'identity))
1303 (truename (abbreviate-file-name (file-truename filename))))
1304 (or (let ((buf (get-file-buffer filename)))
1305 (when (and buf (funcall predicate buf)) buf))
1306 (let ((list (buffer-list)) found)
1307 (while (and (not found) list)
1308 (save-excursion
1309 (set-buffer (car list))
1310 (if (and buffer-file-name
1311 (string= buffer-file-truename truename)
1312 (funcall predicate (current-buffer)))
1313 (setq found (car list))))
1314 (setq list (cdr list)))
1315 found)
1316 (let* ((attributes (file-attributes truename))
1317 (number (nthcdr 10 attributes))
1318 (list (buffer-list)) found)
1319 (and buffer-file-numbers-unique
1320 number
1321 (while (and (not found) list)
1322 (with-current-buffer (car list)
1323 (if (and buffer-file-name
1324 (equal buffer-file-number number)
1325 ;; Verify this buffer's file number
1326 ;; still belongs to its file.
1327 (file-exists-p buffer-file-name)
1328 (equal (file-attributes buffer-file-truename)
1329 attributes)
1330 (funcall predicate (current-buffer)))
1331 (setq found (car list))))
1332 (setq list (cdr list))))
1333 found))))
1334 \f
1335 (defcustom find-file-wildcards t
1336 "*Non-nil means file-visiting commands should handle wildcards.
1337 For example, if you specify `*.c', that would visit all the files
1338 whose names match the pattern."
1339 :group 'files
1340 :version "20.4"
1341 :type 'boolean)
1342
1343 (defcustom find-file-suppress-same-file-warnings nil
1344 "*Non-nil means suppress warning messages for symlinked files.
1345 When nil, Emacs prints a warning when visiting a file that is already
1346 visited, but with a different name. Setting this option to t
1347 suppresses this warning."
1348 :group 'files
1349 :version "21.1"
1350 :type 'boolean)
1351
1352 (defcustom large-file-warning-threshold 10000000
1353 "Maximum size of file above which a confirmation is requested.
1354 When nil, never request confirmation."
1355 :group 'files
1356 :group 'find-file
1357 :version "22.1"
1358 :type '(choice integer (const :tag "Never request confirmation" nil)))
1359
1360 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1361 "Read file FILENAME into a buffer and return the buffer.
1362 If a buffer exists visiting FILENAME, return that one, but
1363 verify that the file has not changed since visited or saved.
1364 The buffer is not selected, just returned to the caller.
1365 Optional second arg NOWARN non-nil means suppress any warning messages.
1366 Optional third arg RAWFILE non-nil means the file is read literally.
1367 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1368 and visit all the matching files. When wildcards are actually
1369 used and expanded, return a list of buffers that are visiting
1370 the various files."
1371 (setq filename
1372 (abbreviate-file-name
1373 (expand-file-name filename)))
1374 (if (file-directory-p filename)
1375 (or (and find-file-run-dired
1376 (run-hook-with-args-until-success
1377 'find-directory-functions
1378 (if find-file-visit-truename
1379 (abbreviate-file-name (file-truename filename))
1380 filename)))
1381 (error "%s is a directory" filename))
1382 (if (and wildcards
1383 find-file-wildcards
1384 (not (string-match "\\`/:" filename))
1385 (string-match "[[*?]" filename))
1386 (let ((files (condition-case nil
1387 (file-expand-wildcards filename t)
1388 (error (list filename))))
1389 (find-file-wildcards nil))
1390 (if (null files)
1391 (find-file-noselect filename)
1392 (mapcar #'find-file-noselect files)))
1393 (let* ((buf (get-file-buffer filename))
1394 (truename (abbreviate-file-name (file-truename filename)))
1395 (attributes (file-attributes truename))
1396 (number (nthcdr 10 attributes))
1397 ;; Find any buffer for a file which has same truename.
1398 (other (and (not buf) (find-buffer-visiting filename))))
1399 ;; Let user know if there is a buffer with the same truename.
1400 (if other
1401 (progn
1402 (or nowarn
1403 find-file-suppress-same-file-warnings
1404 (string-equal filename (buffer-file-name other))
1405 (message "%s and %s are the same file"
1406 filename (buffer-file-name other)))
1407 ;; Optionally also find that buffer.
1408 (if (or find-file-existing-other-name find-file-visit-truename)
1409 (setq buf other))))
1410 ;; Check to see if the file looks uncommonly large.
1411 (when (and large-file-warning-threshold (nth 7 attributes)
1412 ;; Don't ask again if we already have the file or
1413 ;; if we're asked to be quiet.
1414 (not (or buf nowarn))
1415 (> (nth 7 attributes) large-file-warning-threshold)
1416 (not (y-or-n-p
1417 (format "File %s is large (%dMB), really open? "
1418 (file-name-nondirectory filename)
1419 (/ (nth 7 attributes) 1048576)))))
1420 (error "Aborted"))
1421 (if buf
1422 ;; We are using an existing buffer.
1423 (progn
1424 (or nowarn
1425 (verify-visited-file-modtime buf)
1426 (cond ((not (file-exists-p filename))
1427 (error "File %s no longer exists!" filename))
1428 ;; Certain files should be reverted automatically
1429 ;; if they have changed on disk and not in the buffer.
1430 ((and (not (buffer-modified-p buf))
1431 (let ((tail revert-without-query)
1432 (found nil))
1433 (while tail
1434 (if (string-match (car tail) filename)
1435 (setq found t))
1436 (setq tail (cdr tail)))
1437 found))
1438 (with-current-buffer buf
1439 (message "Reverting file %s..." filename)
1440 (revert-buffer t t)
1441 (message "Reverting file %s...done" filename)))
1442 ((yes-or-no-p
1443 (if (string= (file-name-nondirectory filename)
1444 (buffer-name buf))
1445 (format
1446 (if (buffer-modified-p buf)
1447 "File %s changed on disk. Discard your edits? "
1448 "File %s changed on disk. Reread from disk? ")
1449 (file-name-nondirectory filename))
1450 (format
1451 (if (buffer-modified-p buf)
1452 "File %s changed on disk. Discard your edits in %s? "
1453 "File %s changed on disk. Reread from disk into %s? ")
1454 (file-name-nondirectory filename)
1455 (buffer-name buf))))
1456 (with-current-buffer buf
1457 (revert-buffer t t)))))
1458 (with-current-buffer buf
1459
1460 ;; Check if a formerly read-only file has become
1461 ;; writable and vice versa, but if the buffer agrees
1462 ;; with the new state of the file, that is ok too.
1463 (let ((read-only (not (file-writable-p buffer-file-name))))
1464 (unless (or (eq read-only buffer-file-read-only)
1465 (eq read-only buffer-read-only))
1466 (when (or nowarn
1467 (let ((question
1468 (format "File %s is %s on disk. Change buffer mode? "
1469 buffer-file-name
1470 (if read-only "read-only" "writable"))))
1471 (y-or-n-p question)))
1472 (setq buffer-read-only read-only)))
1473 (setq buffer-file-read-only read-only))
1474
1475 (when (and (not (eq (not (null rawfile))
1476 (not (null find-file-literally))))
1477 ;; It is confusing to ask whether to visit
1478 ;; non-literally if they have the file in
1479 ;; hexl-mode.
1480 (not (eq major-mode 'hexl-mode)))
1481 (if (buffer-modified-p)
1482 (if (y-or-n-p (if rawfile
1483 "Save file and revisit literally? "
1484 "Save file and revisit non-literally? "))
1485 (progn
1486 (save-buffer)
1487 (find-file-noselect-1 buf filename nowarn
1488 rawfile truename number))
1489 (if (y-or-n-p (if rawfile
1490 "Discard your edits and revisit file literally? "
1491 "Discard your edits and revisit file non-literally? "))
1492 (find-file-noselect-1 buf filename nowarn
1493 rawfile truename number)
1494 (error (if rawfile "File already visited non-literally"
1495 "File already visited literally"))))
1496 (if (y-or-n-p (if rawfile
1497 "Revisit file literally? "
1498 "Revisit file non-literally? "))
1499 (find-file-noselect-1 buf filename nowarn
1500 rawfile truename number)
1501 (error (if rawfile "File already visited non-literally"
1502 "File already visited literally"))))))
1503 ;; Return the buffer we are using.
1504 buf)
1505 ;; Create a new buffer.
1506 (setq buf (create-file-buffer filename))
1507 ;; find-file-noselect-1 may use a different buffer.
1508 (find-file-noselect-1 buf filename nowarn
1509 rawfile truename number))))))
1510
1511 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1512 (let (error)
1513 (with-current-buffer buf
1514 (kill-local-variable 'find-file-literally)
1515 ;; Needed in case we are re-visiting the file with a different
1516 ;; text representation.
1517 (kill-local-variable 'buffer-file-coding-system)
1518 (kill-local-variable 'cursor-type)
1519 (let ((inhibit-read-only t))
1520 (erase-buffer))
1521 (and (default-value 'enable-multibyte-characters)
1522 (not rawfile)
1523 (set-buffer-multibyte t))
1524 (if rawfile
1525 (condition-case ()
1526 (let ((inhibit-read-only t))
1527 (insert-file-contents-literally filename t))
1528 (file-error
1529 (when (and (file-exists-p filename)
1530 (not (file-readable-p filename)))
1531 (kill-buffer buf)
1532 (signal 'file-error (list "File is not readable"
1533 filename)))
1534 ;; Unconditionally set error
1535 (setq error t)))
1536 (condition-case ()
1537 (let ((inhibit-read-only t))
1538 (insert-file-contents filename t))
1539 (file-error
1540 (when (and (file-exists-p filename)
1541 (not (file-readable-p filename)))
1542 (kill-buffer buf)
1543 (signal 'file-error (list "File is not readable"
1544 filename)))
1545 ;; Run find-file-not-found-hooks until one returns non-nil.
1546 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1547 ;; If they fail too, set error.
1548 (setq error t)))))
1549 ;; Record the file's truename, and maybe use that as visited name.
1550 (if (equal filename buffer-file-name)
1551 (setq buffer-file-truename truename)
1552 (setq buffer-file-truename
1553 (abbreviate-file-name (file-truename buffer-file-name))))
1554 (setq buffer-file-number number)
1555 ;; On VMS, we may want to remember which directory in a search list
1556 ;; the file was found in.
1557 (and (eq system-type 'vax-vms)
1558 (let (logical)
1559 (if (string-match ":" (file-name-directory filename))
1560 (setq logical (substring (file-name-directory filename)
1561 0 (match-beginning 0))))
1562 (not (member logical find-file-not-true-dirname-list)))
1563 (setq buffer-file-name buffer-file-truename))
1564 (if find-file-visit-truename
1565 (setq buffer-file-name
1566 (setq filename
1567 (expand-file-name buffer-file-truename))))
1568 ;; Set buffer's default directory to that of the file.
1569 (setq default-directory (file-name-directory buffer-file-name))
1570 ;; Turn off backup files for certain file names. Since
1571 ;; this is a permanent local, the major mode won't eliminate it.
1572 (and (not (funcall backup-enable-predicate buffer-file-name))
1573 (progn
1574 (make-local-variable 'backup-inhibited)
1575 (setq backup-inhibited t)))
1576 (if rawfile
1577 (progn
1578 (set-buffer-multibyte nil)
1579 (setq buffer-file-coding-system 'no-conversion)
1580 (set-buffer-major-mode buf)
1581 (make-local-variable 'find-file-literally)
1582 (setq find-file-literally t))
1583 (after-find-file error (not nowarn)))
1584 (current-buffer))))
1585 \f
1586 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1587 "Like `insert-file-contents', but only reads in the file literally.
1588 A buffer may be modified in several ways after reading into the buffer,
1589 to Emacs features such as format decoding, character code
1590 conversion, `find-file-hook', automatic uncompression, etc.
1591
1592 This function ensures that none of these modifications will take place."
1593 (let ((format-alist nil)
1594 (after-insert-file-functions nil)
1595 (coding-system-for-read 'no-conversion)
1596 (coding-system-for-write 'no-conversion)
1597 (find-buffer-file-type-function
1598 (if (fboundp 'find-buffer-file-type)
1599 (symbol-function 'find-buffer-file-type)
1600 nil))
1601 (inhibit-file-name-handlers
1602 (append '(jka-compr-handler image-file-handler)
1603 inhibit-file-name-handlers))
1604 (inhibit-file-name-operation 'insert-file-contents))
1605 (unwind-protect
1606 (progn
1607 (fset 'find-buffer-file-type (lambda (filename) t))
1608 (insert-file-contents filename visit beg end replace))
1609 (if find-buffer-file-type-function
1610 (fset 'find-buffer-file-type find-buffer-file-type-function)
1611 (fmakunbound 'find-buffer-file-type)))))
1612
1613 (defun insert-file-1 (filename insert-func)
1614 (if (file-directory-p filename)
1615 (signal 'file-error (list "Opening input file" "file is a directory"
1616 filename)))
1617 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1618 #'buffer-modified-p))
1619 (tem (funcall insert-func filename)))
1620 (push-mark (+ (point) (car (cdr tem))))
1621 (when buffer
1622 (message "File %s already visited and modified in buffer %s"
1623 filename (buffer-name buffer)))))
1624
1625 (defun insert-file-literally (filename)
1626 "Insert contents of file FILENAME into buffer after point with no conversion.
1627
1628 This function is meant for the user to run interactively.
1629 Don't call it from programs! Use `insert-file-contents-literally' instead.
1630 \(Its calling sequence is different; see its documentation)."
1631 (interactive "*fInsert file literally: ")
1632 (insert-file-1 filename #'insert-file-contents-literally))
1633
1634 (defvar find-file-literally nil
1635 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1636 This is a permanent local.")
1637 (put 'find-file-literally 'permanent-local t)
1638
1639 (defun find-file-literally (filename)
1640 "Visit file FILENAME with no conversion of any kind.
1641 Format conversion and character code conversion are both disabled,
1642 and multibyte characters are disabled in the resulting buffer.
1643 The major mode used is Fundamental mode regardless of the file name,
1644 and local variable specifications in the file are ignored.
1645 Automatic uncompression and adding a newline at the end of the
1646 file due to `require-final-newline' is also disabled.
1647
1648 You cannot absolutely rely on this function to result in
1649 visiting the file literally. If Emacs already has a buffer
1650 which is visiting the file, you get the existing buffer,
1651 regardless of whether it was created literally or not.
1652
1653 In a Lisp program, if you want to be sure of accessing a file's
1654 contents literally, you should create a temporary buffer and then read
1655 the file contents into it using `insert-file-contents-literally'."
1656 (interactive "FFind file literally: ")
1657 (switch-to-buffer (find-file-noselect filename nil t)))
1658 \f
1659 (defvar after-find-file-from-revert-buffer nil)
1660
1661 (defun after-find-file (&optional error warn noauto
1662 after-find-file-from-revert-buffer
1663 nomodes)
1664 "Called after finding a file and by the default revert function.
1665 Sets buffer mode, parses local variables.
1666 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1667 error in reading the file. WARN non-nil means warn if there
1668 exists an auto-save file more recent than the visited file.
1669 NOAUTO means don't mess with auto-save mode.
1670 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1671 means this call was from `revert-buffer'.
1672 Fifth arg NOMODES non-nil means don't alter the file's modes.
1673 Finishes by calling the functions in `find-file-hook'
1674 unless NOMODES is non-nil."
1675 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1676 (if noninteractive
1677 nil
1678 (let* (not-serious
1679 (msg
1680 (cond
1681 ((not warn) nil)
1682 ((and error (file-attributes buffer-file-name))
1683 (setq buffer-read-only t)
1684 "File exists, but cannot be read")
1685 ((not buffer-read-only)
1686 (if (and warn
1687 ;; No need to warn if buffer is auto-saved
1688 ;; under the name of the visited file.
1689 (not (and buffer-file-name
1690 auto-save-visited-file-name))
1691 (file-newer-than-file-p (or buffer-auto-save-file-name
1692 (make-auto-save-file-name))
1693 buffer-file-name))
1694 (format "%s has auto save data; consider M-x recover-this-file"
1695 (file-name-nondirectory buffer-file-name))
1696 (setq not-serious t)
1697 (if error "(New file)" nil)))
1698 ((not error)
1699 (setq not-serious t)
1700 "Note: file is write protected")
1701 ((file-attributes (directory-file-name default-directory))
1702 "File not found and directory write-protected")
1703 ((file-exists-p (file-name-directory buffer-file-name))
1704 (setq buffer-read-only nil))
1705 (t
1706 (setq buffer-read-only nil)
1707 "Use M-x make-directory RET RET to create the directory and its parents"))))
1708 (when msg
1709 (message "%s" msg)
1710 (or not-serious (sit-for 1 t))))
1711 (when (and auto-save-default (not noauto))
1712 (auto-save-mode t)))
1713 ;; Make people do a little extra work (C-x C-q)
1714 ;; before altering a backup file.
1715 (when (backup-file-name-p buffer-file-name)
1716 (setq buffer-read-only t))
1717 ;; When a file is marked read-only,
1718 ;; make the buffer read-only even if root is looking at it.
1719 (when (and (file-modes (buffer-file-name))
1720 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1721 (setq buffer-read-only t))
1722 (unless nomodes
1723 (when (and view-read-only view-mode)
1724 (view-mode-disable))
1725 (normal-mode t)
1726 ;; If requested, add a newline at the end of the file.
1727 (and (memq require-final-newline '(visit visit-save))
1728 (> (point-max) (point-min))
1729 (/= (char-after (1- (point-max))) ?\n)
1730 (not (and (eq selective-display t)
1731 (= (char-after (1- (point-max))) ?\r)))
1732 (save-excursion
1733 (goto-char (point-max))
1734 (insert "\n")))
1735 (when (and buffer-read-only
1736 view-read-only
1737 (not (eq (get major-mode 'mode-class) 'special)))
1738 (view-mode-enter))
1739 (run-hooks 'find-file-hook)))
1740
1741 (defmacro report-errors (format &rest body)
1742 "Eval BODY and turn any error into a FORMAT message.
1743 FORMAT can have a %s escape which will be replaced with the actual error.
1744 If `debug-on-error' is set, errors are not caught, so that you can
1745 debug them.
1746 Avoid using a large BODY since it is duplicated."
1747 (declare (debug t) (indent 1))
1748 `(if debug-on-error
1749 (progn . ,body)
1750 (condition-case err
1751 (progn . ,body)
1752 (error (message ,format (prin1-to-string err))))))
1753
1754 (defun normal-mode (&optional find-file)
1755 "Choose the major mode for this buffer automatically.
1756 Also sets up any specified local variables of the file.
1757 Uses the visited file name, the -*- line, and the local variables spec.
1758
1759 This function is called automatically from `find-file'. In that case,
1760 we may set up the file-specified mode and local variables,
1761 depending on the value of `enable-local-variables': if it is t, we do;
1762 if it is nil, we don't; otherwise, we query.
1763 In addition, if `local-enable-local-variables' is nil, we do
1764 not set local variables (though we do notice a mode specified with -*-.)
1765
1766 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1767 or from Lisp without specifying the optional argument FIND-FILE;
1768 in that case, this function acts as if `enable-local-variables' were t."
1769 (interactive)
1770 (funcall (or default-major-mode 'fundamental-mode))
1771 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1772 (report-errors "File mode specification error: %s"
1773 (set-auto-mode))
1774 (report-errors "File local-variables error: %s"
1775 (hack-local-variables)))
1776 ;; Turn font lock off and on, to make sure it takes account of
1777 ;; whatever file local variables are relevant to it.
1778 (when (and font-lock-mode
1779 ;; Font-lock-mode (now in font-core.el) can be ON when
1780 ;; font-lock.el still hasn't been loaded.
1781 (boundp 'font-lock-keywords)
1782 (eq (car font-lock-keywords) t))
1783 (setq font-lock-keywords (cadr font-lock-keywords))
1784 (font-lock-mode 1))
1785
1786 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1787 (ucs-set-table-for-input)))
1788
1789 (defvar auto-mode-alist
1790 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1791 ;; c++-mode, java-mode and more) are added through autoload
1792 ;; directives in that file. That way is discouraged since it
1793 ;; spreads out the definition of the initial value.
1794 (mapc
1795 (lambda (elt)
1796 (cons (purecopy (car elt)) (cdr elt)))
1797 `(;; do this first, so that .html.pl is Polish html, not Perl
1798 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1799 ("\\.te?xt\\'" . text-mode)
1800 ("\\.[tT]e[xX]\\'" . tex-mode)
1801 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1802 ("\\.ltx\\'" . latex-mode)
1803 ("\\.dtx\\'" . doctex-mode)
1804 ("\\.el\\'" . emacs-lisp-mode)
1805 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1806 ("\\.l\\'" . lisp-mode)
1807 ("\\.li?sp\\'" . lisp-mode)
1808 ("\\.[fF]\\'" . fortran-mode)
1809 ("\\.for\\'" . fortran-mode)
1810 ("\\.p\\'" . pascal-mode)
1811 ("\\.pas\\'" . pascal-mode)
1812 ("\\.ad[abs]\\'" . ada-mode)
1813 ("\\.ad[bs].dg\\'" . ada-mode)
1814 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1815 ("Imakefile\\'" . makefile-imake-mode)
1816 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1817 '(("\\.mk\\'" . makefile-bsdmake-mode)
1818 ("GNUmakefile\\'" . makefile-gmake-mode)
1819 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1820 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1821 ("[Mm]akefile\\'" . makefile-gmake-mode)))
1822 ("Makeppfile\\'" . makefile-makepp-mode)
1823 ("\\.am\\'" . makefile-automake-mode)
1824 ;; Less common extensions come here
1825 ;; so more common ones above are found faster.
1826 ("\\.texinfo\\'" . texinfo-mode)
1827 ("\\.te?xi\\'" . texinfo-mode)
1828 ("\\.[sS]\\'" . asm-mode)
1829 ("\\.asm\\'" . asm-mode)
1830 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1831 ("[cC]hange[lL]og\\.[0-9]+\\'" . change-log-mode)
1832 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1833 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1834 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1835 ("\\.bash\\'" . sh-mode)
1836 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1837 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1838 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1839 ("\\.m?spec\\'" . sh-mode)
1840 ("\\.m[mes]\\'" . nroff-mode)
1841 ("\\.man\\'" . nroff-mode)
1842 ("\\.sty\\'" . latex-mode)
1843 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
1844 ("\\.bbl\\'" . latex-mode)
1845 ("\\.bib\\'" . bibtex-mode)
1846 ("\\.sql\\'" . sql-mode)
1847 ("\\.m[4c]\\'" . m4-mode)
1848 ("\\.mf\\'" . metafont-mode)
1849 ("\\.mp\\'" . metapost-mode)
1850 ("\\.vhdl?\\'" . vhdl-mode)
1851 ("\\.article\\'" . text-mode)
1852 ("\\.letter\\'" . text-mode)
1853 ("\\.i?tcl\\'" . tcl-mode)
1854 ("\\.exp\\'" . tcl-mode)
1855 ("\\.itk\\'" . tcl-mode)
1856 ("\\.icn\\'" . icon-mode)
1857 ("\\.sim\\'" . simula-mode)
1858 ("\\.mss\\'" . scribe-mode)
1859 ("\\.f9[05]\\'" . f90-mode)
1860 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1861 ("\\.pro\\'" . idlwave-mode)
1862 ("\\.prolog\\'" . prolog-mode)
1863 ("\\.tar\\'" . tar-mode)
1864 ;; The list of archive file extensions should be in sync with
1865 ;; `auto-coding-alist' with `no-conversion' coding system.
1866 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|[jew]ar\\|xpi\\)\\'" . archive-mode)
1867 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . archive-mode)
1868 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
1869 ;; Mailer puts message to be edited in
1870 ;; /tmp/Re.... or Message
1871 ("\\`/tmp/Re" . text-mode)
1872 ("/Message[0-9]*\\'" . text-mode)
1873 ("\\.zone\\'" . zone-mode)
1874 ;; some news reader is reported to use this
1875 ("\\`/tmp/fol/" . text-mode)
1876 ("\\.oak\\'" . scheme-mode)
1877 ("\\.sgml?\\'" . sgml-mode)
1878 ("\\.x[ms]l\\'" . xml-mode)
1879 ("\\.dtd\\'" . sgml-mode)
1880 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1881 ("\\.js\\'" . java-mode) ; javascript-mode would be better
1882 ("\\.x[bp]m\\'" . c-mode)
1883 ;; .emacs or .gnus or .viper following a directory delimiter in
1884 ;; Unix, MSDOG or VMS syntax.
1885 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
1886 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1887 ;; _emacs following a directory delimiter
1888 ;; in MsDos syntax
1889 ("[:/]_emacs\\'" . emacs-lisp-mode)
1890 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1891 ("\\.ml\\'" . lisp-mode)
1892 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1893 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1894 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1895 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1896 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1897 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1898 ("BROWSE\\'" . ebrowse-tree-mode)
1899 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1900 ("#\\*mail\\*" . mail-mode)
1901 ("\\.g\\'" . antlr-mode)
1902 ("\\.ses\\'" . ses-mode)
1903 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
1904 ("\\.docbook\\'" . sgml-mode)
1905 ("\\.com\\'" . dcl-mode)
1906 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
1907 ;; Windows candidates may be opened case sensitively on Unix
1908 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
1909 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
1910 ("\\.ppd\\'" . conf-ppd-mode)
1911 ("java.+\\.conf\\'" . conf-javaprop-mode)
1912 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
1913 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1914 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
1915 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1916 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
1917 ;; either user's dot-files or under /etc or some such
1918 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
1919 ;; alas not all ~/.*rc files are like this
1920 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1921 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
1922 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
1923 ("/X11.+app-defaults/" . conf-xdefaults-mode)
1924 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
1925 ;; this contains everything twice, with space and with colon :-(
1926 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
1927 ;; Get rid of any trailing .n.m and try again.
1928 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1929 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1930 ;; Using mode nil rather than `ignore' would let the search continue
1931 ;; through this list (with the shortened name) rather than start over.
1932 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
1933 ;; The following should come after the ChangeLog pattern
1934 ;; for the sake of ChangeLog.1, etc.
1935 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1936 ("\\.[1-9]\\'" . nroff-mode)
1937 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
1938 "Alist of filename patterns vs corresponding major mode functions.
1939 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1940 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1941 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1942 mode function to use. FUNCTION will be called, unless it is nil.
1943
1944 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1945 calling FUNCTION (if it's not nil), we delete the suffix that matched
1946 REGEXP and search the list again for another match.
1947
1948 If the file name matches `inhibit-first-line-modes-regexps',
1949 then `auto-mode-alist' is not processed.
1950
1951 See also `interpreter-mode-alist', which detects executable script modes
1952 based on the interpreters they specify to run,
1953 and `magic-mode-alist', which determines modes based on file contents.")
1954
1955 (defvar interpreter-mode-alist
1956 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1957 ;; and pike-mode) are added through autoload directives in that
1958 ;; file. That way is discouraged since it spreads out the
1959 ;; definition of the initial value.
1960 (mapc
1961 (lambda (l)
1962 (cons (purecopy (car l)) (cdr l)))
1963 '(("perl" . perl-mode)
1964 ("perl5" . perl-mode)
1965 ("miniperl" . perl-mode)
1966 ("wish" . tcl-mode)
1967 ("wishx" . tcl-mode)
1968 ("tcl" . tcl-mode)
1969 ("tclsh" . tcl-mode)
1970 ("scm" . scheme-mode)
1971 ("ash" . sh-mode)
1972 ("bash" . sh-mode)
1973 ("bash2" . sh-mode)
1974 ("csh" . sh-mode)
1975 ("dtksh" . sh-mode)
1976 ("es" . sh-mode)
1977 ("itcsh" . sh-mode)
1978 ("jsh" . sh-mode)
1979 ("ksh" . sh-mode)
1980 ("oash" . sh-mode)
1981 ("pdksh" . sh-mode)
1982 ("rc" . sh-mode)
1983 ("rpm" . sh-mode)
1984 ("sh" . sh-mode)
1985 ("sh5" . sh-mode)
1986 ("tcsh" . sh-mode)
1987 ("wksh" . sh-mode)
1988 ("wsh" . sh-mode)
1989 ("zsh" . sh-mode)
1990 ("tail" . text-mode)
1991 ("more" . text-mode)
1992 ("less" . text-mode)
1993 ("pg" . text-mode)
1994 ("make" . makefile-gmake-mode) ; Debian uses this
1995 ("guile" . scheme-mode)
1996 ("clisp" . lisp-mode)))
1997 "Alist mapping interpreter names to major modes.
1998 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
1999 Each element looks like (INTERPRETER . MODE).
2000 If INTERPRETER matches the name of the interpreter specified in the first line
2001 of a script, mode MODE is enabled.
2002
2003 See also `auto-mode-alist'.")
2004
2005 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2006 "List of regexps; if one matches a file name, don't look for `-*-'.")
2007
2008 (defvar inhibit-first-line-modes-suffixes nil
2009 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2010 When checking `inhibit-first-line-modes-regexps', we first discard
2011 from the end of the file name anything that matches one of these regexps.")
2012
2013 (defvar auto-mode-interpreter-regexp
2014 "#![ \t]?\\([^ \t\n]*\
2015 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2016 "Regexp matching interpreters, for file mode determination.
2017 This regular expression is matched against the first line of a file
2018 to determine the file's mode in `set-auto-mode'. If it matches, the file
2019 is assumed to be interpreted by the interpreter matched by the second group
2020 of the regular expression. The mode is then determined as the mode
2021 associated with that interpreter in `interpreter-mode-alist'.")
2022
2023 (defvar magic-mode-alist
2024 `(;; The < comes before the groups (but the first) to reduce backtracking.
2025 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2026 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2027 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
2028 (concat "\\(?:<\\?xml\\s +[^>]*>\\)?\\s *<"
2029 comment-re "*"
2030 "\\(?:!DOCTYPE\\s +[^>]*>\\s *<\\s *" comment-re "*\\)?"
2031 "[Hh][Tt][Mm][Ll]"))
2032 . html-mode)
2033 ;; These two must come after html, because they are more general:
2034 ("<\\?xml " . xml-mode)
2035 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2036 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
2037 (concat "\\s *<" comment-re "*!DOCTYPE "))
2038 . sgml-mode)
2039 ("%![^V]" . ps-mode)
2040 ("# xmcd " . conf-unix-mode))
2041 "Alist of buffer beginnings vs. corresponding major mode functions.
2042 Each element looks like (REGEXP . FUNCTION). After visiting a file,
2043 if REGEXP matches the text at the beginning of the buffer,
2044 `normal-mode' will call FUNCTION rather than allowing `auto-mode-alist'
2045 to decide the buffer's major mode.
2046
2047 If FUNCTION is nil, then it is not called. (That is a way of saying
2048 \"allow `auto-mode-alist' to decide for these files.\")")
2049
2050 (defvar magic-mode-regexp-match-limit 4000
2051 "Upper limit on `magic-mode-alist' regexp matches.")
2052
2053 (defun set-auto-mode (&optional keep-mode-if-same)
2054 "Select major mode appropriate for current buffer.
2055
2056 This checks for a -*- mode tag in the buffer's text, checks the
2057 interpreter that runs this file against `interpreter-mode-alist',
2058 compares the buffer beginning against `magic-mode-alist', or
2059 compares the filename against the entries in `auto-mode-alist'.
2060
2061 It does not check for the `mode:' local variable in the
2062 Local Variables section of the file; for that, use `hack-local-variables'.
2063
2064 If `enable-local-variables' is nil, this function does not check for a
2065 -*- mode tag.
2066
2067 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2068 only set the major mode, if that would change it."
2069 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2070 (let (end done mode modes)
2071 ;; Find a -*- mode tag
2072 (save-excursion
2073 (goto-char (point-min))
2074 (skip-chars-forward " \t\n")
2075 (and enable-local-variables
2076 (setq end (set-auto-mode-1))
2077 (if (save-excursion (search-forward ":" end t))
2078 ;; Find all specifications for the `mode:' variable
2079 ;; and execute them left to right.
2080 (while (let ((case-fold-search t))
2081 (or (and (looking-at "mode:")
2082 (goto-char (match-end 0)))
2083 (re-search-forward "[ \t;]mode:" end t)))
2084 (skip-chars-forward " \t")
2085 (let ((beg (point)))
2086 (if (search-forward ";" end t)
2087 (forward-char -1)
2088 (goto-char end))
2089 (skip-chars-backward " \t")
2090 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2091 modes)))
2092 ;; Simple -*-MODE-*- case.
2093 (push (intern (concat (downcase (buffer-substring (point) end))
2094 "-mode"))
2095 modes))))
2096 ;; If we found modes to use, invoke them now, outside the save-excursion.
2097 (if modes
2098 (catch 'nop
2099 (dolist (mode (nreverse modes))
2100 (if (not (functionp mode))
2101 (message "Ignoring unknown mode `%s'" mode)
2102 (setq done t)
2103 (or (set-auto-mode-0 mode keep-mode-if-same)
2104 ;; continuing would call minor modes again, toggling them off
2105 (throw 'nop nil))))))
2106 (unless done
2107 ;; If we didn't, look for an interpreter specified in the first line.
2108 ;; As a special case, allow for things like "#!/bin/env perl", which
2109 ;; finds the interpreter anywhere in $PATH.
2110 (setq mode (save-excursion
2111 (goto-char (point-min))
2112 (if (looking-at auto-mode-interpreter-regexp)
2113 (match-string 2)
2114 ""))
2115 ;; Map interpreter name to a mode, signalling we're done at the
2116 ;; same time.
2117 done (assoc (file-name-nondirectory mode)
2118 interpreter-mode-alist))
2119 ;; If we found an interpreter mode to use, invoke it now.
2120 (if done
2121 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2122 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2123 (unless done
2124 (if (setq done (save-excursion
2125 (goto-char (point-min))
2126 (save-restriction
2127 (narrow-to-region (point-min)
2128 (min (point-max)
2129 (+ (point-min) magic-mode-regexp-match-limit)))
2130 (assoc-default nil magic-mode-alist
2131 (lambda (re dummy)
2132 (looking-at re))))))
2133 (set-auto-mode-0 done keep-mode-if-same)
2134 ;; Compare the filename against the entries in auto-mode-alist.
2135 (if buffer-file-name
2136 (let ((name buffer-file-name))
2137 ;; Remove backup-suffixes from file name.
2138 (setq name (file-name-sans-versions name))
2139 (while name
2140 ;; Find first matching alist entry.
2141 (let ((case-fold-search
2142 (memq system-type '(vax-vms windows-nt cygwin))))
2143 (if (and (setq mode (assoc-default name auto-mode-alist
2144 'string-match))
2145 (consp mode)
2146 (cadr mode))
2147 (setq mode (car mode)
2148 name (substring name 0 (match-beginning 0)))
2149 (setq name)))
2150 (when mode
2151 (set-auto-mode-0 mode keep-mode-if-same)))))))))
2152
2153 ;; When `keep-mode-if-same' is set, we are working on behalf of
2154 ;; set-visited-file-name. In that case, if the major mode specified is the
2155 ;; same one we already have, don't actually reset it. We don't want to lose
2156 ;; minor modes such as Font Lock.
2157 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2158 "Apply MODE and return it.
2159 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2160 any aliases and compared to current major mode. If they are the
2161 same, do nothing and return nil."
2162 (when keep-mode-if-same
2163 (while (symbolp (symbol-function mode))
2164 (setq mode (symbol-function mode)))
2165 (if (eq mode major-mode)
2166 (setq mode nil)))
2167 (when mode
2168 (funcall mode)
2169 mode))
2170
2171 (defun set-auto-mode-1 ()
2172 "Find the -*- spec in the buffer.
2173 Call with point at the place to start searching from.
2174 If one is found, set point to the beginning
2175 and return the position of the end.
2176 Otherwise, return nil; point may be changed."
2177 (let (beg end)
2178 (and
2179 ;; Don't look for -*- if this file name matches any
2180 ;; of the regexps in inhibit-first-line-modes-regexps.
2181 (let ((temp inhibit-first-line-modes-regexps)
2182 (name (if buffer-file-name
2183 (file-name-sans-versions buffer-file-name)
2184 (buffer-name))))
2185 (while (let ((sufs inhibit-first-line-modes-suffixes))
2186 (while (and sufs (not (string-match (car sufs) name)))
2187 (setq sufs (cdr sufs)))
2188 sufs)
2189 (setq name (substring name 0 (match-beginning 0))))
2190 (while (and temp
2191 (not (string-match (car temp) name)))
2192 (setq temp (cdr temp)))
2193 (not temp))
2194
2195 (search-forward "-*-" (line-end-position
2196 ;; If the file begins with "#!"
2197 ;; (exec interpreter magic), look
2198 ;; for mode frobs in the first two
2199 ;; lines. You cannot necessarily
2200 ;; put them in the first line of
2201 ;; such a file without screwing up
2202 ;; the interpreter invocation.
2203 (and (looking-at "^#!") 2)) t)
2204 (progn
2205 (skip-chars-forward " \t")
2206 (setq beg (point))
2207 (search-forward "-*-" (line-end-position) t))
2208 (progn
2209 (forward-char -3)
2210 (skip-chars-backward " \t")
2211 (setq end (point))
2212 (goto-char beg)
2213 end))))
2214
2215 (defun hack-local-variables-confirm (string flag-to-check)
2216 (or (eq flag-to-check t)
2217 (and flag-to-check
2218 (save-window-excursion
2219 (condition-case nil
2220 (switch-to-buffer (current-buffer))
2221 (error
2222 ;; If we fail to switch in the selected window,
2223 ;; it is probably a minibuffer or dedicated window.
2224 ;; So try another window.
2225 (let ((pop-up-frames nil))
2226 ;; Refrain from popping up frames since it can't
2227 ;; be undone by save-window-excursion.
2228 (pop-to-buffer (current-buffer)))))
2229 (save-excursion
2230 (beginning-of-line)
2231 (set-window-start (selected-window) (point)))
2232 (y-or-n-p (format string
2233 (if buffer-file-name
2234 (file-name-nondirectory buffer-file-name)
2235 (concat "buffer " (buffer-name)))))))))
2236
2237 (defun hack-local-variables-prop-line (&optional mode-only)
2238 "Set local variables specified in the -*- line.
2239 Ignore any specification for `mode:' and `coding:';
2240 `set-auto-mode' should already have handled `mode:',
2241 `set-auto-coding' should already have handled `coding:'.
2242 If MODE-ONLY is non-nil, all we do is check whether the major mode
2243 is specified, returning t if it is specified."
2244 (save-excursion
2245 (goto-char (point-min))
2246 (let ((result nil)
2247 (end (set-auto-mode-1))
2248 mode-specified
2249 (enable-local-variables
2250 (and local-enable-local-variables enable-local-variables)))
2251 ;; Parse the -*- line into the RESULT alist.
2252 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2253 (cond ((not end)
2254 nil)
2255 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2256 ;; Simple form: "-*- MODENAME -*-". Already handled.
2257 (setq mode-specified t)
2258 nil)
2259 (t
2260 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2261 ;; (last ";" is optional).
2262 (while (< (point) end)
2263 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2264 (error "Malformed -*- line"))
2265 (goto-char (match-end 0))
2266 ;; There used to be a downcase here,
2267 ;; but the manual didn't say so,
2268 ;; and people want to set var names that aren't all lc.
2269 (let ((key (intern (buffer-substring
2270 (match-beginning 1)
2271 (match-end 1))))
2272 (val (save-restriction
2273 (narrow-to-region (point) end)
2274 (read (current-buffer)))))
2275 ;; It is traditional to ignore
2276 ;; case when checking for `mode' in set-auto-mode,
2277 ;; so we must do that here as well.
2278 ;; That is inconsistent, but we're stuck with it.
2279 ;; The same can be said for `coding' in set-auto-coding.
2280 (or (equal (downcase (symbol-name key)) "mode")
2281 (equal (downcase (symbol-name key)) "coding")
2282 (setq result (cons (cons key val) result)))
2283 (if (equal (downcase (symbol-name key)) "mode")
2284 (setq mode-specified t))
2285 (skip-chars-forward " \t;")))
2286 (setq result (nreverse result))))
2287
2288 (if mode-only mode-specified
2289 (if (and result
2290 (or mode-only
2291 (hack-local-variables-confirm
2292 "Set local variables as specified in -*- line of %s? "
2293 enable-local-variables)))
2294 (let ((enable-local-eval enable-local-eval))
2295 (while result
2296 (hack-one-local-variable (car (car result)) (cdr (car result)))
2297 (setq result (cdr result)))))
2298 nil))))
2299
2300 (defvar hack-local-variables-hook nil
2301 "Normal hook run after processing a file's local variables specs.
2302 Major modes can use this to examine user-specified local variables
2303 in order to initialize other data structure based on them.")
2304
2305 (defun hack-local-variables (&optional mode-only)
2306 "Parse and put into effect this buffer's local variables spec.
2307 If MODE-ONLY is non-nil, all we do is check whether the major mode
2308 is specified, returning t if it is specified."
2309 (let ((mode-specified
2310 ;; If MODE-ONLY is t, we check here for specifying the mode
2311 ;; in the -*- line. If MODE-ONLY is nil, we process
2312 ;; the -*- line here.
2313 (hack-local-variables-prop-line mode-only))
2314 (enable-local-variables
2315 (and local-enable-local-variables enable-local-variables)))
2316 ;; Look for "Local variables:" line in last page.
2317 (save-excursion
2318 (goto-char (point-max))
2319 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
2320 (when (let ((case-fold-search t))
2321 (and (search-forward "Local Variables:" nil t)
2322 (or mode-only
2323 (hack-local-variables-confirm
2324 "Set local variables as specified at end of %s? "
2325 enable-local-variables))))
2326 (skip-chars-forward " \t")
2327 (let ((enable-local-eval enable-local-eval)
2328 ;; suffix is what comes after "local variables:" in its line.
2329 (suffix
2330 (concat
2331 (regexp-quote (buffer-substring (point) (line-end-position)))
2332 "$"))
2333 ;; prefix is what comes before "local variables:" in its line.
2334 (prefix
2335 (concat "^" (regexp-quote
2336 (buffer-substring (line-beginning-position)
2337 (match-beginning 0)))))
2338 beg)
2339
2340 (forward-line 1)
2341 (let ((startpos (point))
2342 endpos
2343 (thisbuf (current-buffer)))
2344 (save-excursion
2345 (unless (let ((case-fold-search t))
2346 (re-search-forward
2347 (concat prefix "[ \t]*End:[ \t]*" suffix)
2348 nil t))
2349 (error "Local variables list is not properly terminated"))
2350 (beginning-of-line)
2351 (setq endpos (point)))
2352
2353 (with-temp-buffer
2354 (insert-buffer-substring thisbuf startpos endpos)
2355 (goto-char (point-min))
2356 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2357 (while (not (eobp))
2358 ;; Discard the prefix.
2359 (if (looking-at prefix)
2360 (delete-region (point) (match-end 0))
2361 (error "Local variables entry is missing the prefix"))
2362 (end-of-line)
2363 ;; Discard the suffix.
2364 (if (looking-back suffix)
2365 (delete-region (match-beginning 0) (point))
2366 (error "Local variables entry is missing the suffix"))
2367 (forward-line 1))
2368 (goto-char (point-min))
2369
2370 (while (not (eobp))
2371 ;; Find the variable name; strip whitespace.
2372 (skip-chars-forward " \t")
2373 (setq beg (point))
2374 (skip-chars-forward "^:\n")
2375 (if (eolp) (error "Missing colon in local variables entry"))
2376 (skip-chars-backward " \t")
2377 (let* ((str (buffer-substring beg (point)))
2378 (var (read str))
2379 val)
2380 ;; Read the variable value.
2381 (skip-chars-forward "^:")
2382 (forward-char 1)
2383 (setq val (read (current-buffer)))
2384 (if mode-only
2385 (if (eq var 'mode)
2386 (setq mode-specified t))
2387 ;; Set the variable. "Variables" mode and eval are funny.
2388 (with-current-buffer thisbuf
2389 (hack-one-local-variable var val))))
2390 (forward-line 1)))))))
2391 (unless mode-only
2392 (run-hooks 'hack-local-variables-hook))
2393 mode-specified))
2394
2395 (defvar ignored-local-variables ()
2396 "Variables to be ignored in a file's local variable spec.")
2397
2398 ;; Get confirmation before setting these variables as locals in a file.
2399 (put 'debugger 'risky-local-variable t)
2400 (put 'enable-local-eval 'risky-local-variable t)
2401 (put 'ignored-local-variables 'risky-local-variable t)
2402 (put 'eval 'risky-local-variable t)
2403 (put 'file-name-handler-alist 'risky-local-variable t)
2404 (put 'inhibit-quit 'risky-local-variable t)
2405 (put 'minor-mode-alist 'risky-local-variable t)
2406 (put 'minor-mode-map-alist 'risky-local-variable t)
2407 (put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2408 (put 'overriding-local-map 'risky-local-variable t)
2409 (put 'overriding-terminal-local-map 'risky-local-variable t)
2410 (put 'auto-mode-alist 'risky-local-variable t)
2411 (put 'after-load-alist 'risky-local-variable t)
2412 (put 'buffer-file-name 'risky-local-variable t)
2413 (put 'buffer-undo-list 'risky-local-variable t)
2414 (put 'buffer-auto-save-file-name 'risky-local-variable t)
2415 (put 'buffer-file-truename 'risky-local-variable t)
2416 (put 'default-text-properties 'risky-local-variable t)
2417 (put 'exec-path 'risky-local-variable t)
2418 (put 'load-path 'risky-local-variable t)
2419 (put 'exec-directory 'risky-local-variable t)
2420 (put 'process-environment 'risky-local-variable t)
2421 (put 'dabbrev-case-fold-search 'risky-local-variable t)
2422 (put 'dabbrev-case-replace 'risky-local-variable t)
2423 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2424 (put 'outline-level 'risky-local-variable t)
2425 (put 'rmail-output-file-alist 'risky-local-variable t)
2426 (put 'font-lock-defaults 'risky-local-variable t)
2427 (put 'special-display-buffer-names 'risky-local-variable t)
2428 (put 'frame-title-format 'risky-local-variable t)
2429 (put 'global-mode-string 'risky-local-variable t)
2430 (put 'header-line-format 'risky-local-variable t)
2431 (put 'icon-title-format 'risky-local-variable t)
2432 (put 'input-method-alist 'risky-local-variable t)
2433 (put 'format-alist 'risky-local-variable t)
2434 (put 'vc-mode 'risky-local-variable t)
2435 (put 'imenu-generic-expression 'risky-local-variable t)
2436 (put 'imenu--index-alist 'risky-local-variable t)
2437 (put 'standard-input 'risky-local-variable t)
2438 (put 'standard-output 'risky-local-variable t)
2439 (put 'unread-command-events 'risky-local-variable t)
2440 (put 'max-lisp-eval-depth 'risky-local-variable t)
2441 (put 'max-specpdl-size 'risky-local-variable t)
2442 (put 'mode-line-format 'risky-local-variable t)
2443 (put 'mode-line-modified 'risky-local-variable t)
2444 (put 'mode-line-mule-info 'risky-local-variable t)
2445 (put 'mode-line-buffer-identification 'risky-local-variable t)
2446 (put 'mode-line-modes 'risky-local-variable t)
2447 (put 'mode-line-position 'risky-local-variable t)
2448 (put 'mode-line-process 'risky-local-variable t)
2449 (put 'mode-name 'risky-local-variable t)
2450 (put 'display-time-string 'risky-local-variable t)
2451 (put 'parse-time-rules 'risky-local-variable t)
2452
2453 ;; This case is safe because the user gets to check it before it is used.
2454 (put 'compile-command 'safe-local-variable 'stringp)
2455
2456 (defun risky-local-variable-p (sym &optional val)
2457 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2458 If VAL is nil or omitted, the question is whether any value might be
2459 dangerous."
2460 ;; If this is an alias, check the base name.
2461 (condition-case nil
2462 (setq sym (indirect-variable sym))
2463 (error nil))
2464 (let ((safep (get sym 'safe-local-variable)))
2465 (or (get sym 'risky-local-variable)
2466 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2467 (symbol-name sym))
2468 (not safep))
2469 ;; If the safe-local-variable property isn't t or nil,
2470 ;; then it must return non-nil on the proposed value to be safe.
2471 (and (not (memq safep '(t nil)))
2472 (or (null val)
2473 (not (funcall safep val)))))))
2474
2475 (defcustom safe-local-eval-forms nil
2476 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2477 Add expressions to this list if you want Emacs to evaluate them, when
2478 they appear in an `eval' local variable specification, without first
2479 asking you for confirmation."
2480 :group 'find-file
2481 :version "22.1"
2482 :type '(repeat sexp))
2483
2484 (put 'c-set-style 'safe-local-eval-function t)
2485
2486 (defun hack-one-local-variable-quotep (exp)
2487 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2488
2489 (defun hack-one-local-variable-constantp (exp)
2490 (or (and (not (symbolp exp)) (not (consp exp)))
2491 (memq exp '(t nil))
2492 (keywordp exp)
2493 (hack-one-local-variable-quotep exp)))
2494
2495 (defun hack-one-local-variable-eval-safep (exp)
2496 "Return t if it is safe to eval EXP when it is found in a file."
2497 (or (not (consp exp))
2498 ;; Detect certain `put' expressions.
2499 (and (eq (car exp) 'put)
2500 (hack-one-local-variable-quotep (nth 1 exp))
2501 (hack-one-local-variable-quotep (nth 2 exp))
2502 (memq (nth 1 (nth 2 exp))
2503 '(lisp-indent-hook))
2504 ;; Only allow safe values of lisp-indent-hook;
2505 ;; not functions.
2506 (or (numberp (nth 3 exp))
2507 (equal (nth 3 exp) ''defun)))
2508 ;; Allow expressions that the user requested.
2509 (member exp safe-local-eval-forms)
2510 ;; Certain functions can be allowed with safe arguments
2511 ;; or can specify verification functions to try.
2512 (and (symbolp (car exp))
2513 (let ((prop (get (car exp) 'safe-local-eval-function)))
2514 (cond ((eq prop t)
2515 (let ((ok t))
2516 (dolist (arg (cdr exp))
2517 (unless (hack-one-local-variable-constantp arg)
2518 (setq ok nil)))
2519 ok))
2520 ((functionp prop)
2521 (funcall prop exp))
2522 ((listp prop)
2523 (let ((ok nil))
2524 (dolist (function prop)
2525 (if (funcall function exp)
2526 (setq ok t)))
2527 ok)))))))
2528
2529 (defun hack-one-local-variable (var val)
2530 "\"Set\" one variable in a local variables spec.
2531 A few patterns are specified so that any name which matches one
2532 is considered risky."
2533 (cond ((eq var 'mode)
2534 (funcall (intern (concat (downcase (symbol-name val))
2535 "-mode"))))
2536 ((eq var 'coding)
2537 ;; We have already handled coding: tag in set-auto-coding.
2538 nil)
2539 ((memq var ignored-local-variables)
2540 nil)
2541 ;; "Setting" eval means either eval it or do nothing.
2542 ;; Likewise for setting hook variables.
2543 ((risky-local-variable-p var val)
2544 ;; Permit evalling a put of a harmless property.
2545 ;; if the args do nothing tricky.
2546 (if (or (and (eq var 'eval)
2547 (hack-one-local-variable-eval-safep val))
2548 ;; Permit eval if not root and user says ok.
2549 (and (not (zerop (user-uid)))
2550 (hack-local-variables-confirm
2551 "Process `eval' or hook local variables in %s? "
2552 enable-local-eval)))
2553 (if (eq var 'eval)
2554 (save-excursion (eval val))
2555 (make-local-variable var)
2556 (set var val))
2557 (message "Ignoring risky spec in the local variables list")))
2558 ;; Ordinary variable, really set it.
2559 (t (make-local-variable var)
2560 ;; Make sure the string has no text properties.
2561 ;; Some text properties can get evaluated in various ways,
2562 ;; so it is risky to put them on with a local variable list.
2563 (if (stringp val)
2564 (set-text-properties 0 (length val) nil val))
2565 (set var val))))
2566
2567 \f
2568 (defcustom change-major-mode-with-file-name t
2569 "*Non-nil means \\[write-file] should set the major mode from the file name.
2570 However, the mode will not be changed if
2571 \(1) a local variables list or the `-*-' line specifies a major mode, or
2572 \(2) the current major mode is a \"special\" mode,
2573 \ not suitable for ordinary files, or
2574 \(3) the new file name does not particularly specify any mode."
2575 :type 'boolean
2576 :group 'editing-basics)
2577
2578 (defun set-visited-file-name (filename &optional no-query along-with-file)
2579 "Change name of file visited in current buffer to FILENAME.
2580 This also renames the buffer to correspond to the new file.
2581 The next time the buffer is saved it will go in the newly specified file.
2582 FILENAME nil or an empty string means mark buffer as not visiting any file.
2583 Remember to delete the initial contents of the minibuffer
2584 if you wish to pass an empty string as the argument.
2585
2586 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2587 confirmation in the case where another buffer is already visiting FILENAME.
2588
2589 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2590 the old visited file has been renamed to the new name FILENAME."
2591 (interactive "FSet visited file name: ")
2592 (if (buffer-base-buffer)
2593 (error "An indirect buffer cannot visit a file"))
2594 (let (truename)
2595 (if filename
2596 (setq filename
2597 (if (string-equal filename "")
2598 nil
2599 (expand-file-name filename))))
2600 (if filename
2601 (progn
2602 (setq truename (file-truename filename))
2603 (if find-file-visit-truename
2604 (setq filename truename))))
2605 (if filename
2606 (let ((new-name (file-name-nondirectory filename)))
2607 (if (string= new-name "")
2608 (error "Empty file name"))))
2609 (let ((buffer (and filename (find-buffer-visiting filename))))
2610 (and buffer (not (eq buffer (current-buffer)))
2611 (not no-query)
2612 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2613 filename)))
2614 (error "Aborted")))
2615 (or (equal filename buffer-file-name)
2616 (progn
2617 (and filename (lock-buffer filename))
2618 (unlock-buffer)))
2619 (setq buffer-file-name filename)
2620 (if filename ; make buffer name reflect filename.
2621 (let ((new-name (file-name-nondirectory buffer-file-name)))
2622 (if (eq system-type 'vax-vms)
2623 (setq new-name (downcase new-name)))
2624 (setq default-directory (file-name-directory buffer-file-name))
2625 ;; If new-name == old-name, renaming would add a spurious <2>
2626 ;; and it's considered as a feature in rename-buffer.
2627 (or (string= new-name (buffer-name))
2628 (rename-buffer new-name t))))
2629 (setq buffer-backed-up nil)
2630 (or along-with-file
2631 (clear-visited-file-modtime))
2632 ;; Abbreviate the file names of the buffer.
2633 (if truename
2634 (progn
2635 (setq buffer-file-truename (abbreviate-file-name truename))
2636 (if find-file-visit-truename
2637 (setq buffer-file-name truename))))
2638 (setq buffer-file-number
2639 (if filename
2640 (nthcdr 10 (file-attributes buffer-file-name))
2641 nil)))
2642 ;; write-file-functions is normally used for things like ftp-find-file
2643 ;; that visit things that are not local files as if they were files.
2644 ;; Changing to visit an ordinary local file instead should flush the hook.
2645 (kill-local-variable 'write-file-functions)
2646 (kill-local-variable 'local-write-file-hooks)
2647 (kill-local-variable 'revert-buffer-function)
2648 (kill-local-variable 'backup-inhibited)
2649 ;; If buffer was read-only because of version control,
2650 ;; that reason is gone now, so make it writable.
2651 (if vc-mode
2652 (setq buffer-read-only nil))
2653 (kill-local-variable 'vc-mode)
2654 ;; Turn off backup files for certain file names.
2655 ;; Since this is a permanent local, the major mode won't eliminate it.
2656 (and buffer-file-name
2657 (not (funcall backup-enable-predicate buffer-file-name))
2658 (progn
2659 (make-local-variable 'backup-inhibited)
2660 (setq backup-inhibited t)))
2661 (let ((oauto buffer-auto-save-file-name))
2662 ;; If auto-save was not already on, turn it on if appropriate.
2663 (if (not buffer-auto-save-file-name)
2664 (and buffer-file-name auto-save-default
2665 (auto-save-mode t))
2666 ;; If auto save is on, start using a new name.
2667 ;; We deliberately don't rename or delete the old auto save
2668 ;; for the old visited file name. This is because perhaps
2669 ;; the user wants to save the new state and then compare with the
2670 ;; previous state from the auto save file.
2671 (setq buffer-auto-save-file-name
2672 (make-auto-save-file-name)))
2673 ;; Rename the old auto save file if any.
2674 (and oauto buffer-auto-save-file-name
2675 (file-exists-p oauto)
2676 (rename-file oauto buffer-auto-save-file-name t)))
2677 (and buffer-file-name
2678 (not along-with-file)
2679 (set-buffer-modified-p t))
2680 ;; Update the major mode, if the file name determines it.
2681 (condition-case nil
2682 ;; Don't change the mode if it is special.
2683 (or (not change-major-mode-with-file-name)
2684 (get major-mode 'mode-class)
2685 ;; Don't change the mode if the local variable list specifies it.
2686 (hack-local-variables t)
2687 (set-auto-mode t))
2688 (error nil)))
2689
2690 (defun write-file (filename &optional confirm)
2691 "Write current buffer into file FILENAME.
2692 This makes the buffer visit that file, and marks it as not modified.
2693
2694 If you specify just a directory name as FILENAME, that means to use
2695 the default file name but in that directory. You can also yank
2696 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2697
2698 If the buffer is not already visiting a file, the default file name
2699 for the output file is the buffer name.
2700
2701 If optional second arg CONFIRM is non-nil, this function
2702 asks for confirmation before overwriting an existing file.
2703 Interactively, confirmation is required unless you supply a prefix argument."
2704 ;; (interactive "FWrite file: ")
2705 (interactive
2706 (list (if buffer-file-name
2707 (read-file-name "Write file: "
2708 nil nil nil nil)
2709 (read-file-name "Write file: " default-directory
2710 (expand-file-name
2711 (file-name-nondirectory (buffer-name))
2712 default-directory)
2713 nil nil))
2714 (not current-prefix-arg)))
2715 (or (null filename) (string-equal filename "")
2716 (progn
2717 ;; If arg is just a directory,
2718 ;; use the default file name, but in that directory.
2719 (if (file-directory-p filename)
2720 (setq filename (concat (file-name-as-directory filename)
2721 (file-name-nondirectory
2722 (or buffer-file-name (buffer-name))))))
2723 (and confirm
2724 (file-exists-p filename)
2725 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2726 (error "Canceled")))
2727 (set-visited-file-name filename (not confirm))))
2728 (set-buffer-modified-p t)
2729 ;; Make buffer writable if file is writable.
2730 (and buffer-file-name
2731 (file-writable-p buffer-file-name)
2732 (setq buffer-read-only nil))
2733 (save-buffer)
2734 ;; It's likely that the VC status at the new location is different from
2735 ;; the one at the old location.
2736 (vc-find-file-hook))
2737 \f
2738 (defun backup-buffer ()
2739 "Make a backup of the disk file visited by the current buffer, if appropriate.
2740 This is normally done before saving the buffer the first time.
2741
2742 A backup may be done by renaming or by copying; see documentation of
2743 variable `make-backup-files'. If it's done by renaming, then the file is
2744 no longer accessible under its old name.
2745
2746 The value is non-nil after a backup was made by renaming.
2747 It has the form (MODES . BACKUPNAME).
2748 MODES is the result of `file-modes' on the original
2749 file; this means that the caller, after saving the buffer, should change
2750 the modes of the new file to agree with the old modes.
2751 BACKUPNAME is the backup file name, which is the old file renamed."
2752 (if (and make-backup-files (not backup-inhibited)
2753 (not buffer-backed-up)
2754 (file-exists-p buffer-file-name)
2755 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2756 '(?- ?l)))
2757 (let ((real-file-name buffer-file-name)
2758 backup-info backupname targets setmodes)
2759 ;; If specified name is a symbolic link, chase it to the target.
2760 ;; Thus we make the backups in the directory where the real file is.
2761 (setq real-file-name (file-chase-links real-file-name))
2762 (setq backup-info (find-backup-file-name real-file-name)
2763 backupname (car backup-info)
2764 targets (cdr backup-info))
2765 ;; (if (file-directory-p buffer-file-name)
2766 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2767 (if backup-info
2768 (condition-case ()
2769 (let ((delete-old-versions
2770 ;; If have old versions to maybe delete,
2771 ;; ask the user to confirm now, before doing anything.
2772 ;; But don't actually delete til later.
2773 (and targets
2774 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2775 (or delete-old-versions
2776 (y-or-n-p (format "Delete excess backup versions of %s? "
2777 real-file-name)))))
2778 (modes (file-modes buffer-file-name)))
2779 ;; Actually write the back up file.
2780 (condition-case ()
2781 (if (or file-precious-flag
2782 ; (file-symlink-p buffer-file-name)
2783 backup-by-copying
2784 ;; Don't rename a suid or sgid file.
2785 (and modes (< 0 (logand modes #o6000)))
2786 (not (file-writable-p (file-name-directory real-file-name)))
2787 (and backup-by-copying-when-linked
2788 (> (file-nlinks real-file-name) 1))
2789 (and (or backup-by-copying-when-mismatch
2790 (integerp backup-by-copying-when-privileged-mismatch))
2791 (let ((attr (file-attributes real-file-name)))
2792 (and (or backup-by-copying-when-mismatch
2793 (and (integerp (nth 2 attr))
2794 (integerp backup-by-copying-when-privileged-mismatch)
2795 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2796 (or (nth 9 attr)
2797 (not (file-ownership-preserved-p real-file-name)))))))
2798 (backup-buffer-copy real-file-name backupname modes)
2799 ;; rename-file should delete old backup.
2800 (rename-file real-file-name backupname t)
2801 (setq setmodes (cons modes backupname)))
2802 (file-error
2803 ;; If trouble writing the backup, write it in ~.
2804 (setq backupname (expand-file-name
2805 (convert-standard-filename
2806 "~/%backup%~")))
2807 (message "Cannot write backup file; backing up in %s"
2808 (file-name-nondirectory backupname))
2809 (sleep-for 1)
2810 (backup-buffer-copy real-file-name backupname modes)))
2811 (setq buffer-backed-up t)
2812 ;; Now delete the old versions, if desired.
2813 (if delete-old-versions
2814 (while targets
2815 (condition-case ()
2816 (delete-file (car targets))
2817 (file-error nil))
2818 (setq targets (cdr targets))))
2819 setmodes)
2820 (file-error nil))))))
2821
2822 (defun backup-buffer-copy (from-name to-name modes)
2823 (let ((umask (default-file-modes)))
2824 (unwind-protect
2825 (progn
2826 ;; Create temp files with strict access rights. It's easy to
2827 ;; loosen them later, whereas it's impossible to close the
2828 ;; time-window of loose permissions otherwise.
2829 (set-default-file-modes ?\700)
2830 (while (condition-case ()
2831 (progn
2832 (condition-case nil
2833 (delete-file to-name)
2834 (file-error nil))
2835 (copy-file from-name to-name t t 'excl)
2836 nil)
2837 (file-already-exists t))
2838 ;; The file was somehow created by someone else between
2839 ;; `delete-file' and `copy-file', so let's try again.
2840 nil))
2841 ;; Reset the umask.
2842 (set-default-file-modes umask)))
2843 (and modes
2844 (set-file-modes to-name (logand modes #o1777))))
2845
2846 (defun file-name-sans-versions (name &optional keep-backup-version)
2847 "Return file NAME sans backup versions or strings.
2848 This is a separate procedure so your site-init or startup file can
2849 redefine it.
2850 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2851 we do not remove backup version numbers, only true file version numbers."
2852 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2853 (if handler
2854 (funcall handler 'file-name-sans-versions name keep-backup-version)
2855 (substring name 0
2856 (if (eq system-type 'vax-vms)
2857 ;; VMS version number is (a) semicolon, optional
2858 ;; sign, zero or more digits or (b) period, option
2859 ;; sign, zero or more digits, provided this is the
2860 ;; second period encountered outside of the
2861 ;; device/directory part of the file name.
2862 (or (string-match ";[-+]?[0-9]*\\'" name)
2863 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2864 name)
2865 (match-beginning 1))
2866 (length name))
2867 (if keep-backup-version
2868 (length name)
2869 (or (string-match "\\.~[0-9.]+~\\'" name)
2870 (string-match "~\\'" name)
2871 (length name))))))))
2872
2873 (defun file-ownership-preserved-p (file)
2874 "Return t if deleting FILE and rewriting it would preserve the owner."
2875 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2876 (if handler
2877 (funcall handler 'file-ownership-preserved-p file)
2878 (let ((attributes (file-attributes file)))
2879 ;; Return t if the file doesn't exist, since it's true that no
2880 ;; information would be lost by an (attempted) delete and create.
2881 (or (null attributes)
2882 (= (nth 2 attributes) (user-uid)))))))
2883
2884 (defun file-name-sans-extension (filename)
2885 "Return FILENAME sans final \"extension\".
2886 The extension, in a file name, is the part that follows the last `.',
2887 except that a leading `.', if any, doesn't count."
2888 (save-match-data
2889 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2890 directory)
2891 (if (and (string-match "\\.[^.]*\\'" file)
2892 (not (eq 0 (match-beginning 0))))
2893 (if (setq directory (file-name-directory filename))
2894 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2895 ;; we don't want to expand it.
2896 (concat directory (substring file 0 (match-beginning 0)))
2897 (substring file 0 (match-beginning 0)))
2898 filename))))
2899
2900 (defun file-name-extension (filename &optional period)
2901 "Return FILENAME's final \"extension\".
2902 The extension, in a file name, is the part that follows the last `.',
2903 except that a leading `.', if any, doesn't count.
2904 Return nil for extensionless file names such as `foo'.
2905 Return the empty string for file names such as `foo.'.
2906
2907 If PERIOD is non-nil, then the returned value includes the period
2908 that delimits the extension, and if FILENAME has no extension,
2909 the value is \"\"."
2910 (save-match-data
2911 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2912 (if (and (string-match "\\.[^.]*\\'" file)
2913 (not (eq 0 (match-beginning 0))))
2914 (substring file (+ (match-beginning 0) (if period 0 1)))
2915 (if period
2916 "")))))
2917
2918 (defcustom make-backup-file-name-function nil
2919 "A function to use instead of the default `make-backup-file-name'.
2920 A value of nil gives the default `make-backup-file-name' behavior.
2921
2922 This could be buffer-local to do something special for specific
2923 files. If you define it, you may need to change `backup-file-name-p'
2924 and `file-name-sans-versions' too.
2925
2926 See also `backup-directory-alist'."
2927 :group 'backup
2928 :type '(choice (const :tag "Default" nil)
2929 (function :tag "Your function")))
2930
2931 (defcustom backup-directory-alist nil
2932 "Alist of filename patterns and backup directory names.
2933 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2934 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2935 relative or absolute. If it is absolute, so that all matching files
2936 are backed up into the same directory, the file names in this
2937 directory will be the full name of the file backed up with all
2938 directory separators changed to `!' to prevent clashes. This will not
2939 work correctly if your filesystem truncates the resulting name.
2940
2941 For the common case of all backups going into one directory, the alist
2942 should contain a single element pairing \".\" with the appropriate
2943 directory name.
2944
2945 If this variable is nil, or it fails to match a filename, the backup
2946 is made in the original file's directory.
2947
2948 On MS-DOS filesystems without long names this variable is always
2949 ignored."
2950 :group 'backup
2951 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2952 (directory :tag "Backup directory name"))))
2953
2954 (defun normal-backup-enable-predicate (name)
2955 "Default `backup-enable-predicate' function.
2956 Checks for files in `temporary-file-directory',
2957 `small-temporary-file-directory', and /tmp."
2958 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2959 name 0 nil)))
2960 ;; Directory is under temporary-file-directory.
2961 (and (not (eq comp t))
2962 (< comp (- (length temporary-file-directory)))))
2963 (let ((comp (compare-strings "/tmp" 0 nil
2964 name 0 nil)))
2965 ;; Directory is under /tmp.
2966 (and (not (eq comp t))
2967 (< comp (- (length "/tmp")))))
2968 (if small-temporary-file-directory
2969 (let ((comp (compare-strings small-temporary-file-directory
2970 0 nil
2971 name 0 nil)))
2972 ;; Directory is under small-temporary-file-directory.
2973 (and (not (eq comp t))
2974 (< comp (- (length small-temporary-file-directory)))))))))
2975
2976 (defun make-backup-file-name (file)
2977 "Create the non-numeric backup file name for FILE.
2978 Normally this will just be the file's name with `~' appended.
2979 Customization hooks are provided as follows.
2980
2981 If the variable `make-backup-file-name-function' is non-nil, its value
2982 should be a function which will be called with FILE as its argument;
2983 the resulting name is used.
2984
2985 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2986 the documentation of that variable. If the directory for the backup
2987 doesn't exist, it is created."
2988 (if make-backup-file-name-function
2989 (funcall make-backup-file-name-function file)
2990 (if (and (eq system-type 'ms-dos)
2991 (not (msdos-long-file-names)))
2992 (let ((fn (file-name-nondirectory file)))
2993 (concat (file-name-directory file)
2994 (or (and (string-match "\\`[^.]+\\'" fn)
2995 (concat (match-string 0 fn) ".~"))
2996 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2997 (concat (match-string 0 fn) "~")))))
2998 (concat (make-backup-file-name-1 file) "~"))))
2999
3000 (defun make-backup-file-name-1 (file)
3001 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3002 (let ((alist backup-directory-alist)
3003 elt backup-directory)
3004 (while alist
3005 (setq elt (pop alist))
3006 (if (string-match (car elt) file)
3007 (setq backup-directory (cdr elt)
3008 alist nil)))
3009 (if (and backup-directory (not (file-exists-p backup-directory)))
3010 (condition-case nil
3011 (make-directory backup-directory 'parents)
3012 (file-error (setq backup-directory nil))))
3013 (if (null backup-directory)
3014 file
3015 (if (file-name-absolute-p backup-directory)
3016 (progn
3017 (when (memq system-type '(windows-nt ms-dos cygwin))
3018 ;; Normalize DOSish file names: downcase the drive
3019 ;; letter, if any, and replace the leading "x:" with
3020 ;; "/drive_x".
3021 (or (file-name-absolute-p file)
3022 (setq file (expand-file-name file))) ; make defaults explicit
3023 ;; Replace any invalid file-name characters (for the
3024 ;; case of backing up remote files).
3025 (setq file (expand-file-name (convert-standard-filename file)))
3026 (if (eq (aref file 1) ?:)
3027 (setq file (concat "/"
3028 "drive_"
3029 (char-to-string (downcase (aref file 0)))
3030 (if (eq (aref file 2) ?/)
3031 ""
3032 "/")
3033 (substring file 2)))))
3034 ;; Make the name unique by substituting directory
3035 ;; separators. It may not really be worth bothering about
3036 ;; doubling `!'s in the original name...
3037 (expand-file-name
3038 (subst-char-in-string
3039 ?/ ?!
3040 (replace-regexp-in-string "!" "!!" file))
3041 backup-directory))
3042 (expand-file-name (file-name-nondirectory file)
3043 (file-name-as-directory
3044 (expand-file-name backup-directory
3045 (file-name-directory file))))))))
3046
3047 (defun backup-file-name-p (file)
3048 "Return non-nil if FILE is a backup file name (numeric or not).
3049 This is a separate function so you can redefine it for customization.
3050 You may need to redefine `file-name-sans-versions' as well."
3051 (string-match "~\\'" file))
3052
3053 (defvar backup-extract-version-start)
3054
3055 ;; This is used in various files.
3056 ;; The usage of backup-extract-version-start is not very clean,
3057 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3058 (defun backup-extract-version (fn)
3059 "Given the name of a numeric backup file, FN, return the backup number.
3060 Uses the free variable `backup-extract-version-start', whose value should be
3061 the index in the name where the version number begins."
3062 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3063 (= (match-beginning 0) backup-extract-version-start))
3064 (string-to-number (substring fn backup-extract-version-start -1))
3065 0))
3066
3067 ;; I believe there is no need to alter this behavior for VMS;
3068 ;; since backup files are not made on VMS, it should not get called.
3069 (defun find-backup-file-name (fn)
3070 "Find a file name for a backup file FN, and suggestions for deletions.
3071 Value is a list whose car is the name for the backup file
3072 and whose cdr is a list of old versions to consider deleting now.
3073 If the value is nil, don't make a backup.
3074 Uses `backup-directory-alist' in the same way as does
3075 `make-backup-file-name'."
3076 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3077 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3078 (if handler
3079 (funcall handler 'find-backup-file-name fn)
3080 (if (or (eq version-control 'never)
3081 ;; We don't support numbered backups on plain MS-DOS
3082 ;; when long file names are unavailable.
3083 (and (eq system-type 'ms-dos)
3084 (not (msdos-long-file-names))))
3085 (list (make-backup-file-name fn))
3086 (let* ((basic-name (make-backup-file-name-1 fn))
3087 (base-versions (concat (file-name-nondirectory basic-name)
3088 ".~"))
3089 (backup-extract-version-start (length base-versions))
3090 (high-water-mark 0)
3091 (number-to-delete 0)
3092 possibilities deserve-versions-p versions)
3093 (condition-case ()
3094 (setq possibilities (file-name-all-completions
3095 base-versions
3096 (file-name-directory basic-name))
3097 versions (sort (mapcar #'backup-extract-version
3098 possibilities)
3099 #'<)
3100 high-water-mark (apply 'max 0 versions)
3101 deserve-versions-p (or version-control
3102 (> high-water-mark 0))
3103 number-to-delete (- (length versions)
3104 kept-old-versions
3105 kept-new-versions
3106 -1))
3107 (file-error (setq possibilities nil)))
3108 (if (not deserve-versions-p)
3109 (list (make-backup-file-name fn))
3110 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3111 (if (and (> number-to-delete 0)
3112 ;; Delete nothing if there is overflow
3113 ;; in the number of versions to keep.
3114 (>= (+ kept-new-versions kept-old-versions -1) 0))
3115 (mapcar (lambda (n)
3116 (format "%s.~%d~" basic-name n))
3117 (let ((v (nthcdr kept-old-versions versions)))
3118 (rplacd (nthcdr (1- number-to-delete) v) ())
3119 v))))))))))
3120
3121 (defun file-nlinks (filename)
3122 "Return number of names file FILENAME has."
3123 (car (cdr (file-attributes filename))))
3124
3125 ;; (defun file-relative-name (filename &optional directory)
3126 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3127 ;; This function returns a relative file name which is equivalent to FILENAME
3128 ;; when used with that default directory as the default.
3129 ;; If this is impossible (which can happen on MSDOS and Windows
3130 ;; when the file name and directory use different drive names)
3131 ;; then it returns FILENAME."
3132 ;; (save-match-data
3133 ;; (let ((fname (expand-file-name filename)))
3134 ;; (setq directory (file-name-as-directory
3135 ;; (expand-file-name (or directory default-directory))))
3136 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3137 ;; ;; drive names, they can't be relative, so return the absolute name.
3138 ;; (if (and (or (eq system-type 'ms-dos)
3139 ;; (eq system-type 'cygwin)
3140 ;; (eq system-type 'windows-nt))
3141 ;; (not (string-equal (substring fname 0 2)
3142 ;; (substring directory 0 2))))
3143 ;; filename
3144 ;; (let ((ancestor ".")
3145 ;; (fname-dir (file-name-as-directory fname)))
3146 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3147 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3148 ;; (setq directory (file-name-directory (substring directory 0 -1))
3149 ;; ancestor (if (equal ancestor ".")
3150 ;; ".."
3151 ;; (concat "../" ancestor))))
3152 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3153 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3154 ;; ;; We matched within FNAME's directory part.
3155 ;; ;; Add the rest of FNAME onto ANCESTOR.
3156 ;; (let ((rest (substring fname (match-end 0))))
3157 ;; (if (and (equal ancestor ".")
3158 ;; (not (equal rest "")))
3159 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3160 ;; rest
3161 ;; (concat (file-name-as-directory ancestor) rest)))
3162 ;; ;; We matched FNAME's directory equivalent.
3163 ;; ancestor))))))
3164
3165 (defun file-relative-name (filename &optional directory)
3166 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3167 This function returns a relative file name which is equivalent to FILENAME
3168 when used with that default directory as the default.
3169 If FILENAME and DIRECTORY lie on different machines or on different drives
3170 on a DOS/Windows machine, it returns FILENAME in expanded form."
3171 (save-match-data
3172 (setq directory
3173 (file-name-as-directory (expand-file-name (or directory
3174 default-directory))))
3175 (setq filename (expand-file-name filename))
3176 (let ((fremote (file-remote-p filename))
3177 (dremote (file-remote-p directory)))
3178 (if ;; Conditions for separate trees
3179 (or
3180 ;; Test for different drives on DOS/Windows
3181 (and
3182 ;; Should `cygwin' really be included here? --stef
3183 (memq system-type '(ms-dos cygwin windows-nt))
3184 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3185 ;; Test for different remote file system identification
3186 (not (equal fremote dremote)))
3187 filename
3188 (let ((ancestor ".")
3189 (filename-dir (file-name-as-directory filename)))
3190 (while (not
3191 (or
3192 (eq t (compare-strings filename-dir nil (length directory)
3193 directory nil nil case-fold-search))
3194 (eq t (compare-strings filename nil (length directory)
3195 directory nil nil case-fold-search))))
3196 (setq directory (file-name-directory (substring directory 0 -1))
3197 ancestor (if (equal ancestor ".")
3198 ".."
3199 (concat "../" ancestor))))
3200 ;; Now ancestor is empty, or .., or ../.., etc.
3201 (if (eq t (compare-strings filename nil (length directory)
3202 directory nil nil case-fold-search))
3203 ;; We matched within FILENAME's directory part.
3204 ;; Add the rest of FILENAME onto ANCESTOR.
3205 (let ((rest (substring filename (length directory))))
3206 (if (and (equal ancestor ".") (not (equal rest "")))
3207 ;; But don't bother with ANCESTOR if it would give us `./'.
3208 rest
3209 (concat (file-name-as-directory ancestor) rest)))
3210 ;; We matched FILENAME's directory equivalent.
3211 ancestor))))))
3212 \f
3213 (defun save-buffer (&optional args)
3214 "Save current buffer in visited file if modified.
3215 Variations are described below.
3216
3217 By default, makes the previous version into a backup file
3218 if previously requested or if this is the first save.
3219 Prefixed with one \\[universal-argument], marks this version
3220 to become a backup when the next save is done.
3221 Prefixed with two \\[universal-argument]'s,
3222 unconditionally makes the previous version into a backup file.
3223 Prefixed with three \\[universal-argument]'s, marks this version
3224 to become a backup when the next save is done,
3225 and unconditionally makes the previous version into a backup file.
3226
3227 With a numeric argument of 0, never make the previous version
3228 into a backup file.
3229
3230 If a file's name is FOO, the names of its numbered backup versions are
3231 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3232 Numeric backups (rather than FOO~) will be made if value of
3233 `version-control' is not the atom `never' and either there are already
3234 numeric versions of the file being backed up, or `version-control' is
3235 non-nil.
3236 We don't want excessive versions piling up, so there are variables
3237 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3238 and `kept-new-versions', which tells how many newest versions to keep.
3239 Defaults are 2 old versions and 2 new.
3240 `dired-kept-versions' controls dired's clean-directory (.) command.
3241 If `delete-old-versions' is nil, system will query user
3242 before trimming versions. Otherwise it does it silently.
3243
3244 If `vc-make-backup-files' is nil, which is the default,
3245 no backup files are made for files managed by version control.
3246 (This is because the version control system itself records previous versions.)
3247
3248 See the subroutine `basic-save-buffer' for more information."
3249 (interactive "p")
3250 (let ((modp (buffer-modified-p))
3251 (large (> (buffer-size) 50000))
3252 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3253 (memq args '(16 64)))))
3254 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3255 (if (and modp large (buffer-file-name))
3256 (message "Saving file %s..." (buffer-file-name)))
3257 (basic-save-buffer)
3258 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3259
3260 (defun delete-auto-save-file-if-necessary (&optional force)
3261 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3262 Normally delete only if the file was written by this Emacs since
3263 the last real save, but optional arg FORCE non-nil means delete anyway."
3264 (and buffer-auto-save-file-name delete-auto-save-files
3265 (not (string= buffer-file-name buffer-auto-save-file-name))
3266 (or force (recent-auto-save-p))
3267 (progn
3268 (condition-case ()
3269 (delete-file buffer-auto-save-file-name)
3270 (file-error nil))
3271 (set-buffer-auto-saved))))
3272
3273 (defvar auto-save-hook nil
3274 "Normal hook run just before auto-saving.")
3275
3276 (defcustom before-save-hook nil
3277 "Normal hook that is run before a buffer is saved to its file."
3278 :options '(copyright-update time-stamp)
3279 :type 'hook
3280 :group 'files)
3281
3282 (defcustom after-save-hook nil
3283 "Normal hook that is run after a buffer is saved to its file."
3284 :options '(executable-make-buffer-file-executable-if-script-p)
3285 :type 'hook
3286 :group 'files)
3287
3288 (defvar save-buffer-coding-system nil
3289 "If non-nil, use this coding system for saving the buffer.
3290 More precisely, use this coding system in place of the
3291 value of `buffer-file-coding-system', when saving the buffer.
3292 Calling `write-region' for any purpose other than saving the buffer
3293 will still use `buffer-file-coding-system'; this variable has no effect
3294 in such cases.")
3295
3296 (make-variable-buffer-local 'save-buffer-coding-system)
3297 (put 'save-buffer-coding-system 'permanent-local t)
3298
3299 (defun basic-save-buffer ()
3300 "Save the current buffer in its visited file, if it has been modified.
3301 The hooks `write-contents-functions' and `write-file-functions' get a chance
3302 to do the job of saving; if they do not, then the buffer is saved in
3303 the visited file in the usual way.
3304 Before and after saving the buffer, this function runs
3305 `before-save-hook' and `after-save-hook', respectively."
3306 (interactive)
3307 (save-current-buffer
3308 ;; In an indirect buffer, save its base buffer instead.
3309 (if (buffer-base-buffer)
3310 (set-buffer (buffer-base-buffer)))
3311 (if (buffer-modified-p)
3312 (let ((recent-save (recent-auto-save-p))
3313 setmodes)
3314 ;; On VMS, rename file and buffer to get rid of version number.
3315 (if (and (eq system-type 'vax-vms)
3316 (not (string= buffer-file-name
3317 (file-name-sans-versions buffer-file-name))))
3318 (let (buffer-new-name)
3319 ;; Strip VMS version number before save.
3320 (setq buffer-file-name
3321 (file-name-sans-versions buffer-file-name))
3322 ;; Construct a (unique) buffer name to correspond.
3323 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3324 (setq buffer-new-name (buffer-name buf))
3325 (kill-buffer buf))
3326 (rename-buffer buffer-new-name)))
3327 ;; If buffer has no file name, ask user for one.
3328 (or buffer-file-name
3329 (let ((filename
3330 (expand-file-name
3331 (read-file-name "File to save in: ") nil)))
3332 (and (file-exists-p filename)
3333 (or (y-or-n-p (format "File `%s' exists; overwrite? "
3334 filename))
3335 (error "Canceled")))
3336 (set-visited-file-name filename)))
3337 (or (verify-visited-file-modtime (current-buffer))
3338 (not (file-exists-p buffer-file-name))
3339 (yes-or-no-p
3340 (format "%s has changed since visited or saved. Save anyway? "
3341 (file-name-nondirectory buffer-file-name)))
3342 (error "Save not confirmed"))
3343 (save-restriction
3344 (widen)
3345 (save-excursion
3346 (and (> (point-max) (point-min))
3347 (not find-file-literally)
3348 (/= (char-after (1- (point-max))) ?\n)
3349 (not (and (eq selective-display t)
3350 (= (char-after (1- (point-max))) ?\r)))
3351 (or (eq require-final-newline t)
3352 (eq require-final-newline 'visit-save)
3353 (and require-final-newline
3354 (y-or-n-p
3355 (format "Buffer %s does not end in newline. Add one? "
3356 (buffer-name)))))
3357 (save-excursion
3358 (goto-char (point-max))
3359 (insert ?\n))))
3360 ;; Support VC version backups.
3361 (vc-before-save)
3362 (run-hooks 'before-save-hook)
3363 (or (run-hook-with-args-until-success 'write-contents-functions)
3364 (run-hook-with-args-until-success 'local-write-file-hooks)
3365 (run-hook-with-args-until-success 'write-file-functions)
3366 ;; If a hook returned t, file is already "written".
3367 ;; Otherwise, write it the usual way now.
3368 (setq setmodes (basic-save-buffer-1)))
3369 ;; Now we have saved the current buffer. Let's make sure
3370 ;; that buffer-file-coding-system is fixed to what
3371 ;; actually used for saving by binding it locally.
3372 (if save-buffer-coding-system
3373 (setq save-buffer-coding-system last-coding-system-used)
3374 (setq buffer-file-coding-system last-coding-system-used))
3375 (setq buffer-file-number
3376 (nthcdr 10 (file-attributes buffer-file-name)))
3377 (if setmodes
3378 (condition-case ()
3379 (set-file-modes buffer-file-name (car setmodes))
3380 (error nil))))
3381 ;; If the auto-save file was recent before this command,
3382 ;; delete it now.
3383 (delete-auto-save-file-if-necessary recent-save)
3384 ;; Support VC `implicit' locking.
3385 (vc-after-save)
3386 (run-hooks 'after-save-hook))
3387 (message "(No changes need to be saved)"))))
3388
3389 ;; This does the "real job" of writing a buffer into its visited file
3390 ;; and making a backup file. This is what is normally done
3391 ;; but inhibited if one of write-file-functions returns non-nil.
3392 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3393 (defun basic-save-buffer-1 ()
3394 (prog1
3395 (if save-buffer-coding-system
3396 (let ((coding-system-for-write save-buffer-coding-system))
3397 (basic-save-buffer-2))
3398 (basic-save-buffer-2))
3399 (setq buffer-file-coding-system-explicit last-coding-system-used)))
3400
3401 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3402 (defun basic-save-buffer-2 ()
3403 (let (tempsetmodes setmodes)
3404 (if (not (file-writable-p buffer-file-name))
3405 (let ((dir (file-name-directory buffer-file-name)))
3406 (if (not (file-directory-p dir))
3407 (if (file-exists-p dir)
3408 (error "%s is not a directory" dir)
3409 (error "%s: no such directory" buffer-file-name))
3410 (if (not (file-exists-p buffer-file-name))
3411 (error "Directory %s write-protected" dir)
3412 (if (yes-or-no-p
3413 (format "File %s is write-protected; try to save anyway? "
3414 (file-name-nondirectory
3415 buffer-file-name)))
3416 (setq tempsetmodes t)
3417 (error "Attempt to save to a file which you aren't allowed to write"))))))
3418 (or buffer-backed-up
3419 (setq setmodes (backup-buffer)))
3420 (let ((dir (file-name-directory buffer-file-name)))
3421 (if (and file-precious-flag
3422 (file-writable-p dir))
3423 ;; If file is precious, write temp name, then rename it.
3424 ;; This requires write access to the containing dir,
3425 ;; which is why we don't try it if we don't have that access.
3426 (let ((realname buffer-file-name)
3427 tempname succeed
3428 (umask (default-file-modes))
3429 (old-modtime (visited-file-modtime)))
3430 ;; Create temp files with strict access rights. It's easy to
3431 ;; loosen them later, whereas it's impossible to close the
3432 ;; time-window of loose permissions otherwise.
3433 (unwind-protect
3434 (progn
3435 (clear-visited-file-modtime)
3436 (set-default-file-modes ?\700)
3437 ;; Try various temporary names.
3438 ;; This code follows the example of make-temp-file,
3439 ;; but it calls write-region in the appropriate way
3440 ;; for saving the buffer.
3441 (while (condition-case ()
3442 (progn
3443 (setq tempname
3444 (make-temp-name
3445 (expand-file-name "tmp" dir)))
3446 (write-region (point-min) (point-max)
3447 tempname nil realname
3448 buffer-file-truename 'excl)
3449 nil)
3450 (file-already-exists t))
3451 ;; The file was somehow created by someone else between
3452 ;; `make-temp-name' and `write-region', let's try again.
3453 nil)
3454 (setq succeed t))
3455 ;; Reset the umask.
3456 (set-default-file-modes umask)
3457 ;; If we failed, restore the buffer's modtime.
3458 (unless succeed
3459 (set-visited-file-modtime old-modtime)))
3460 ;; Since we have created an entirely new file,
3461 ;; make sure it gets the right permission bits set.
3462 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
3463 buffer-file-name)))
3464 ;; We succeeded in writing the temp file,
3465 ;; so rename it.
3466 (rename-file tempname buffer-file-name t))
3467 ;; If file not writable, see if we can make it writable
3468 ;; temporarily while we write it.
3469 ;; But no need to do so if we have just backed it up
3470 ;; (setmodes is set) because that says we're superseding.
3471 (cond ((and tempsetmodes (not setmodes))
3472 ;; Change the mode back, after writing.
3473 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3474 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3475 (let (success)
3476 (unwind-protect
3477 (progn
3478 (write-region (point-min) (point-max)
3479 buffer-file-name nil t buffer-file-truename)
3480 (setq success t))
3481 ;; If we get an error writing the new file, and we made
3482 ;; the backup by renaming, undo the backing-up.
3483 (and setmodes (not success)
3484 (progn
3485 (rename-file (cdr setmodes) buffer-file-name t)
3486 (setq buffer-backed-up nil)))))))
3487 setmodes))
3488
3489 (defun diff-buffer-with-file (&optional buffer)
3490 "View the differences between BUFFER and its associated file.
3491 This requires the external program `diff' to be in your `exec-path'."
3492 (interactive "bBuffer: ")
3493 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3494 (if (and buffer-file-name
3495 (file-exists-p buffer-file-name))
3496 (let ((tempfile (make-temp-file "buffer-content-")))
3497 (unwind-protect
3498 (save-restriction
3499 (widen)
3500 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3501 (diff buffer-file-name tempfile nil t)
3502 (sit-for 0))
3503 (when (file-exists-p tempfile)
3504 (delete-file tempfile))))
3505 (message "Buffer %s has no associated file on disc" (buffer-name))
3506 ;; Display that message for 1 second so that user can read it
3507 ;; in the minibuffer.
3508 (sit-for 1)))
3509 ;; return always nil, so that save-buffers-kill-emacs will not move
3510 ;; over to the next unsaved buffer when calling `d'.
3511 nil)
3512
3513 (defvar save-some-buffers-action-alist
3514 '((?\C-r
3515 (lambda (buf)
3516 (view-buffer buf
3517 (lambda (ignore)
3518 (exit-recursive-edit)))
3519 (recursive-edit)
3520 ;; Return nil to ask about BUF again.
3521 nil)
3522 "view this file")
3523 (?d diff-buffer-with-file
3524 "view changes in file"))
3525 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3526 (put 'save-some-buffers-action-alist 'risky-local-variable t)
3527
3528 (defvar buffer-save-without-query nil
3529 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3530 (make-variable-buffer-local 'buffer-save-without-query)
3531
3532 (defun save-some-buffers (&optional arg pred)
3533 "Save some modified file-visiting buffers. Asks user about each one.
3534 You can answer `y' to save, `n' not to save, `C-r' to look at the
3535 buffer in question with `view-buffer' before deciding or `d' to
3536 view the differences using `diff-buffer-with-file'.
3537
3538 Optional argument (the prefix) non-nil means save all with no questions.
3539 Optional second argument PRED determines which buffers are considered:
3540 If PRED is nil, all the file-visiting buffers are considered.
3541 If PRED is t, then certain non-file buffers will also be considered.
3542 If PRED is a zero-argument function, it indicates for each buffer whether
3543 to consider it or not when called with that buffer current.
3544
3545 See `save-some-buffers-action-alist' if you want to
3546 change the additional actions you can take on files."
3547 (interactive "P")
3548 (save-window-excursion
3549 (let* (queried some-automatic
3550 files-done abbrevs-done)
3551 (dolist (buffer (buffer-list))
3552 ;; First save any buffers that we're supposed to save unconditionally.
3553 ;; That way the following code won't ask about them.
3554 (with-current-buffer buffer
3555 (when (and buffer-save-without-query (buffer-modified-p))
3556 (setq some-automatic t)
3557 (save-buffer))))
3558 ;; Ask about those buffers that merit it,
3559 ;; and record the number thus saved.
3560 (setq files-done
3561 (map-y-or-n-p
3562 (function
3563 (lambda (buffer)
3564 (and (buffer-modified-p buffer)
3565 (not (buffer-base-buffer buffer))
3566 (or
3567 (buffer-file-name buffer)
3568 (and pred
3569 (progn
3570 (set-buffer buffer)
3571 (and buffer-offer-save (> (buffer-size) 0)))))
3572 (or (not (functionp pred))
3573 (with-current-buffer buffer (funcall pred)))
3574 (if arg
3575 t
3576 (setq queried t)
3577 (if (buffer-file-name buffer)
3578 (format "Save file %s? "
3579 (buffer-file-name buffer))
3580 (format "Save buffer %s? "
3581 (buffer-name buffer)))))))
3582 (function
3583 (lambda (buffer)
3584 (set-buffer buffer)
3585 (save-buffer)))
3586 (buffer-list)
3587 '("buffer" "buffers" "save")
3588 save-some-buffers-action-alist))
3589 ;; Maybe to save abbrevs, and record whether
3590 ;; we either saved them or asked to.
3591 (and save-abbrevs abbrevs-changed
3592 (progn
3593 (if (or arg
3594 (eq save-abbrevs 'silently)
3595 (y-or-n-p (format "Save abbrevs in %s? "
3596 abbrev-file-name)))
3597 (write-abbrev-file nil))
3598 ;; Don't keep bothering user if he says no.
3599 (setq abbrevs-changed nil)
3600 (setq abbrevs-done t)))
3601 (or queried (> files-done 0) abbrevs-done
3602 (message (if some-automatic
3603 "(Some special files were saved without asking)"
3604 "(No files need saving)"))))))
3605 \f
3606 (defun not-modified (&optional arg)
3607 "Mark current buffer as unmodified, not needing to be saved.
3608 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3609
3610 It is not a good idea to use this function in Lisp programs, because it
3611 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3612 (interactive "P")
3613 (message (if arg "Modification-flag set"
3614 "Modification-flag cleared"))
3615 (set-buffer-modified-p arg))
3616
3617 (defun toggle-read-only (&optional arg)
3618 "Change whether this buffer is visiting its file read-only.
3619 With arg, set read-only iff arg is positive.
3620 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3621 (interactive "P")
3622 (if (and arg
3623 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3624 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3625 nil ; do nothing.
3626 ;; Toggle.
3627 (cond
3628 ((and buffer-read-only view-mode)
3629 (View-exit-and-edit)
3630 (make-local-variable 'view-read-only)
3631 (setq view-read-only t)) ; Must leave view mode.
3632 ((and (not buffer-read-only) view-read-only
3633 ;; If view-mode is already active, `view-mode-enter' is a nop.
3634 (not view-mode)
3635 (not (eq (get major-mode 'mode-class) 'special)))
3636 (view-mode-enter))
3637 (t (setq buffer-read-only (not buffer-read-only))
3638 (force-mode-line-update)))
3639 (if (vc-backend buffer-file-name)
3640 (message "%s" (substitute-command-keys
3641 (concat "File is under version-control; "
3642 "use \\[vc-next-action] to check in/out"))))))
3643
3644 (defun insert-file (filename)
3645 "Insert contents of file FILENAME into buffer after point.
3646 Set mark after the inserted text.
3647
3648 This function is meant for the user to run interactively.
3649 Don't call it from programs! Use `insert-file-contents' instead.
3650 \(Its calling sequence is different; see its documentation)."
3651 (interactive "*fInsert file: ")
3652 (insert-file-1 filename #'insert-file-contents))
3653
3654 (defun append-to-file (start end filename)
3655 "Append the contents of the region to the end of file FILENAME.
3656 When called from a function, expects three arguments,
3657 START, END and FILENAME. START and END are buffer positions
3658 saying what text to write."
3659 (interactive "r\nFAppend to file: ")
3660 (write-region start end filename t))
3661
3662 (defun file-newest-backup (filename)
3663 "Return most recent backup file for FILENAME or nil if no backups exist."
3664 ;; `make-backup-file-name' will get us the right directory for
3665 ;; ordinary or numeric backups. It might create a directory for
3666 ;; backups as a side-effect, according to `backup-directory-alist'.
3667 (let* ((filename (file-name-sans-versions
3668 (make-backup-file-name (expand-file-name filename))))
3669 (file (file-name-nondirectory filename))
3670 (dir (file-name-directory filename))
3671 (comp (file-name-all-completions file dir))
3672 (newest nil)
3673 tem)
3674 (while comp
3675 (setq tem (pop comp))
3676 (cond ((and (backup-file-name-p tem)
3677 (string= (file-name-sans-versions tem) file))
3678 (setq tem (concat dir tem))
3679 (if (or (null newest)
3680 (file-newer-than-file-p tem newest))
3681 (setq newest tem)))))
3682 newest))
3683
3684 (defun rename-uniquely ()
3685 "Rename current buffer to a similar name not already taken.
3686 This function is useful for creating multiple shell process buffers
3687 or multiple mail buffers, etc."
3688 (interactive)
3689 (save-match-data
3690 (let ((base-name (buffer-name)))
3691 (and (string-match "<[0-9]+>\\'" base-name)
3692 (not (and buffer-file-name
3693 (string= base-name
3694 (file-name-nondirectory buffer-file-name))))
3695 ;; If the existing buffer name has a <NNN>,
3696 ;; which isn't part of the file name (if any),
3697 ;; then get rid of that.
3698 (setq base-name (substring base-name 0 (match-beginning 0))))
3699 (rename-buffer (generate-new-buffer-name base-name))
3700 (force-mode-line-update))))
3701
3702 (defun make-directory (dir &optional parents)
3703 "Create the directory DIR and any nonexistent parent dirs.
3704 Interactively, the default choice of directory to create
3705 is the current default directory for file names.
3706 That is useful when you have visited a file in a nonexistent directory.
3707
3708 Noninteractively, the second (optional) argument PARENTS says whether
3709 to create parent directories if they don't exist. Interactively,
3710 this happens by default."
3711 (interactive
3712 (list (read-file-name "Make directory: " default-directory default-directory
3713 nil nil)
3714 t))
3715 ;; If default-directory is a remote directory,
3716 ;; make sure we find its make-directory handler.
3717 (setq dir (expand-file-name dir))
3718 (let ((handler (find-file-name-handler dir 'make-directory)))
3719 (if handler
3720 (funcall handler 'make-directory dir parents)
3721 (if (not parents)
3722 (make-directory-internal dir)
3723 (let ((dir (directory-file-name (expand-file-name dir)))
3724 create-list)
3725 (while (not (file-exists-p dir))
3726 (setq create-list (cons dir create-list)
3727 dir (directory-file-name (file-name-directory dir))))
3728 (while create-list
3729 (make-directory-internal (car create-list))
3730 (setq create-list (cdr create-list))))))))
3731 \f
3732 (put 'revert-buffer-function 'permanent-local t)
3733 (defvar revert-buffer-function nil
3734 "Function to use to revert this buffer, or nil to do the default.
3735 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3736 which are the arguments that `revert-buffer' received.")
3737
3738 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3739 (defvar revert-buffer-insert-file-contents-function nil
3740 "Function to use to insert contents when reverting this buffer.
3741 Gets two args, first the nominal file name to use,
3742 and second, t if reading the auto-save file.
3743
3744 The function you specify is responsible for updating (or preserving) point.")
3745
3746 (defvar buffer-stale-function nil
3747 "Function to check whether a non-file buffer needs reverting.
3748 This should be a function with one optional argument NOCONFIRM.
3749 Auto Revert Mode passes t for NOCONFIRM. The function should return
3750 non-nil if the buffer should be reverted. A return value of
3751 `fast' means that the need for reverting was not checked, but
3752 that reverting the buffer is fast. The buffer is current when
3753 this function is called.
3754
3755 The idea behind the NOCONFIRM argument is that it should be
3756 non-nil if the buffer is going to be reverted without asking the
3757 user. In such situations, one has to be careful with potentially
3758 time consuming operations.
3759
3760 For more information on how this variable is used by Auto Revert mode,
3761 see Info node `(emacs-xtra)Supporting additional buffers'.")
3762
3763 (defvar before-revert-hook nil
3764 "Normal hook for `revert-buffer' to run before reverting.
3765 If `revert-buffer-function' is used to override the normal revert
3766 mechanism, this hook is not used.")
3767
3768 (defvar after-revert-hook nil
3769 "Normal hook for `revert-buffer' to run after reverting.
3770 Note that the hook value that it runs is the value that was in effect
3771 before reverting; that makes a difference if you have buffer-local
3772 hook functions.
3773
3774 If `revert-buffer-function' is used to override the normal revert
3775 mechanism, this hook is not used.")
3776
3777 (defvar revert-buffer-internal-hook)
3778
3779 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
3780 "Replace current buffer text with the text of the visited file on disk.
3781 This undoes all changes since the file was visited or saved.
3782 With a prefix argument, offer to revert from latest auto-save file, if
3783 that is more recent than the visited file.
3784
3785 This command also works for special buffers that contain text which
3786 doesn't come from a file, but reflects some other data base instead:
3787 for example, Dired buffers and `buffer-list' buffers. In these cases,
3788 it reconstructs the buffer contents from the appropriate data base.
3789
3790 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3791 to revert from the auto-save file when this is nil. Note that the
3792 sense of this argument is the reverse of the prefix argument, for the
3793 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3794 to nil.
3795
3796 Optional second argument NOCONFIRM means don't ask for confirmation at
3797 all. (The local variable `revert-without-query', if non-nil, prevents
3798 confirmation.)
3799
3800 Optional third argument PRESERVE-MODES non-nil means don't alter
3801 the files modes. Normally we reinitialize them using `normal-mode'.
3802
3803 If the value of `revert-buffer-function' is non-nil, it is called to
3804 do all the work for this command. Otherwise, the hooks
3805 `before-revert-hook' and `after-revert-hook' are run at the beginning
3806 and the end, and if `revert-buffer-insert-file-contents-function' is
3807 non-nil, it is called instead of rereading visited file contents."
3808
3809 ;; I admit it's odd to reverse the sense of the prefix argument, but
3810 ;; there is a lot of code out there which assumes that the first
3811 ;; argument should be t to avoid consulting the auto-save file, and
3812 ;; there's no straightforward way to encourage authors to notice a
3813 ;; reversal of the argument sense. So I'm just changing the user
3814 ;; interface, but leaving the programmatic interface the same.
3815 (interactive (list (not current-prefix-arg)))
3816 (if revert-buffer-function
3817 (funcall revert-buffer-function ignore-auto noconfirm)
3818 (with-current-buffer (or (buffer-base-buffer (current-buffer))
3819 (current-buffer))
3820 (let* ((auto-save-p (and (not ignore-auto)
3821 (recent-auto-save-p)
3822 buffer-auto-save-file-name
3823 (file-readable-p buffer-auto-save-file-name)
3824 (y-or-n-p
3825 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3826 (file-name (if auto-save-p
3827 buffer-auto-save-file-name
3828 buffer-file-name)))
3829 (cond ((null file-name)
3830 (error "Buffer does not seem to be associated with any file"))
3831 ((or noconfirm
3832 (and (not (buffer-modified-p))
3833 (let ((tail revert-without-query)
3834 (found nil))
3835 (while tail
3836 (if (string-match (car tail) file-name)
3837 (setq found t))
3838 (setq tail (cdr tail)))
3839 found))
3840 (yes-or-no-p (format "Revert buffer from file %s? "
3841 file-name)))
3842 (run-hooks 'before-revert-hook)
3843 ;; If file was backed up but has changed since,
3844 ;; we shd make another backup.
3845 (and (not auto-save-p)
3846 (not (verify-visited-file-modtime (current-buffer)))
3847 (setq buffer-backed-up nil))
3848 ;; Get rid of all undo records for this buffer.
3849 (or (eq buffer-undo-list t)
3850 (setq buffer-undo-list nil))
3851 ;; Effectively copy the after-revert-hook status,
3852 ;; since after-find-file will clobber it.
3853 (let ((global-hook (default-value 'after-revert-hook))
3854 (local-hook-p (local-variable-p 'after-revert-hook))
3855 (local-hook (and (local-variable-p 'after-revert-hook)
3856 after-revert-hook)))
3857 (let (buffer-read-only
3858 ;; Don't make undo records for the reversion.
3859 (buffer-undo-list t))
3860 (if revert-buffer-insert-file-contents-function
3861 (funcall revert-buffer-insert-file-contents-function
3862 file-name auto-save-p)
3863 (if (not (file-exists-p file-name))
3864 (error (if buffer-file-number
3865 "File %s no longer exists!"
3866 "Cannot revert nonexistent file %s")
3867 file-name))
3868 ;; Bind buffer-file-name to nil
3869 ;; so that we don't try to lock the file.
3870 (let ((buffer-file-name nil))
3871 (or auto-save-p
3872 (unlock-buffer)))
3873 (widen)
3874 (let ((coding-system-for-read
3875 ;; Auto-saved file shoule be read by Emacs'
3876 ;; internal coding.
3877 (if auto-save-p 'auto-save-coding
3878 (or coding-system-for-read
3879 buffer-file-coding-system-explicit))))
3880 ;; This force after-insert-file-set-coding
3881 ;; (called from insert-file-contents) to set
3882 ;; buffer-file-coding-system to a proper value.
3883 (kill-local-variable 'buffer-file-coding-system)
3884
3885 ;; Note that this preserves point in an intelligent way.
3886 (if preserve-modes
3887 (let ((buffer-file-format buffer-file-format))
3888 (insert-file-contents file-name (not auto-save-p)
3889 nil nil t))
3890 (insert-file-contents file-name (not auto-save-p)
3891 nil nil t)))))
3892 ;; Recompute the truename in case changes in symlinks
3893 ;; have changed the truename.
3894 (setq buffer-file-truename
3895 (abbreviate-file-name (file-truename buffer-file-name)))
3896 (after-find-file nil nil t t preserve-modes)
3897 ;; Run after-revert-hook as it was before we reverted.
3898 (setq-default revert-buffer-internal-hook global-hook)
3899 (if local-hook-p
3900 (set (make-local-variable 'revert-buffer-internal-hook)
3901 local-hook)
3902 (kill-local-variable 'revert-buffer-internal-hook))
3903 (run-hooks 'revert-buffer-internal-hook))
3904 t))))))
3905
3906 (defun recover-this-file ()
3907 "Recover the visited file--get contents from its last auto-save file."
3908 (interactive)
3909 (recover-file buffer-file-name))
3910
3911 (defun recover-file (file)
3912 "Visit file FILE, but get contents from its last auto-save file."
3913 ;; Actually putting the file name in the minibuffer should be used
3914 ;; only rarely.
3915 ;; Not just because users often use the default.
3916 (interactive "FRecover file: ")
3917 (setq file (expand-file-name file))
3918 (if (auto-save-file-name-p (file-name-nondirectory file))
3919 (error "%s is an auto-save file" (abbreviate-file-name file)))
3920 (let ((file-name (let ((buffer-file-name file))
3921 (make-auto-save-file-name))))
3922 (cond ((if (file-exists-p file)
3923 (not (file-newer-than-file-p file-name file))
3924 (not (file-exists-p file-name)))
3925 (error "Auto-save file %s not current"
3926 (abbreviate-file-name file-name)))
3927 ((save-window-excursion
3928 (with-output-to-temp-buffer "*Directory*"
3929 (buffer-disable-undo standard-output)
3930 (save-excursion
3931 (let ((switches dired-listing-switches))
3932 (if (file-symlink-p file)
3933 (setq switches (concat switches "L")))
3934 (set-buffer standard-output)
3935 ;; Use insert-directory-safely, not insert-directory,
3936 ;; because these files might not exist. In particular,
3937 ;; FILE might not exist if the auto-save file was for
3938 ;; a buffer that didn't visit a file, such as "*mail*".
3939 ;; The code in v20.x called `ls' directly, so we need
3940 ;; to emulate what `ls' did in that case.
3941 (insert-directory-safely file switches)
3942 (insert-directory-safely file-name switches))))
3943 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3944 (switch-to-buffer (find-file-noselect file t))
3945 (let ((buffer-read-only nil)
3946 ;; Keep the current buffer-file-coding-system.
3947 (coding-system buffer-file-coding-system)
3948 ;; Auto-saved file shoule be read with special coding.
3949 (coding-system-for-read 'auto-save-coding))
3950 (erase-buffer)
3951 (insert-file-contents file-name nil)
3952 (set-buffer-file-coding-system coding-system))
3953 (after-find-file nil nil t))
3954 (t (error "Recover-file cancelled")))))
3955
3956 (defun recover-session ()
3957 "Recover auto save files from a previous Emacs session.
3958 This command first displays a Dired buffer showing you the
3959 previous sessions that you could recover from.
3960 To choose one, move point to the proper line and then type C-c C-c.
3961 Then you'll be asked about a number of files to recover."
3962 (interactive)
3963 (if (null auto-save-list-file-prefix)
3964 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3965 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3966 (unless (file-directory-p dir)
3967 (make-directory dir t))
3968 (unless (directory-files dir nil
3969 (concat "\\`" (regexp-quote
3970 (file-name-nondirectory
3971 auto-save-list-file-prefix)))
3972 t)
3973 (error "No previous sessions to recover")))
3974 (let ((ls-lisp-support-shell-wildcards t))
3975 (dired (concat auto-save-list-file-prefix "*")
3976 (concat dired-listing-switches "t")))
3977 (save-excursion
3978 (goto-char (point-min))
3979 (or (looking-at " Move to the session you want to recover,")
3980 (let ((inhibit-read-only t))
3981 ;; Each line starts with a space
3982 ;; so that Font Lock mode won't highlight the first character.
3983 (insert " Move to the session you want to recover,\n"
3984 " then type C-c C-c to select it.\n\n"
3985 " You can also delete some of these files;\n"
3986 " type d on a line to mark that file for deletion.\n\n"))))
3987 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3988 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3989
3990 (defun recover-session-finish ()
3991 "Choose one saved session to recover auto-save files from.
3992 This command is used in the special Dired buffer created by
3993 \\[recover-session]."
3994 (interactive)
3995 ;; Get the name of the session file to recover from.
3996 (let ((file (dired-get-filename))
3997 files
3998 (buffer (get-buffer-create " *recover*")))
3999 (dired-unmark 1)
4000 (dired-do-flagged-delete t)
4001 (unwind-protect
4002 (save-excursion
4003 ;; Read in the auto-save-list file.
4004 (set-buffer buffer)
4005 (erase-buffer)
4006 (insert-file-contents file)
4007 ;; Loop thru the text of that file
4008 ;; and get out the names of the files to recover.
4009 (while (not (eobp))
4010 (let (thisfile autofile)
4011 (if (eolp)
4012 ;; This is a pair of lines for a non-file-visiting buffer.
4013 ;; Get the auto-save file name and manufacture
4014 ;; a "visited file name" from that.
4015 (progn
4016 (forward-line 1)
4017 ;; If there is no auto-save file name, the
4018 ;; auto-save-list file is probably corrupted.
4019 (unless (eolp)
4020 (setq autofile
4021 (buffer-substring-no-properties
4022 (point)
4023 (save-excursion
4024 (end-of-line)
4025 (point))))
4026 (setq thisfile
4027 (expand-file-name
4028 (substring
4029 (file-name-nondirectory autofile)
4030 1 -1)
4031 (file-name-directory autofile))))
4032 (forward-line 1))
4033 ;; This pair of lines is a file-visiting
4034 ;; buffer. Use the visited file name.
4035 (progn
4036 (setq thisfile
4037 (buffer-substring-no-properties
4038 (point) (progn (end-of-line) (point))))
4039 (forward-line 1)
4040 (setq autofile
4041 (buffer-substring-no-properties
4042 (point) (progn (end-of-line) (point))))
4043 (forward-line 1)))
4044 ;; Ignore a file if its auto-save file does not exist now.
4045 (if (and autofile (file-exists-p autofile))
4046 (setq files (cons thisfile files)))))
4047 (setq files (nreverse files))
4048 ;; The file contains a pair of line for each auto-saved buffer.
4049 ;; The first line of the pair contains the visited file name
4050 ;; or is empty if the buffer was not visiting a file.
4051 ;; The second line is the auto-save file name.
4052 (if files
4053 (map-y-or-n-p "Recover %s? "
4054 (lambda (file)
4055 (condition-case nil
4056 (save-excursion (recover-file file))
4057 (error
4058 "Failed to recover `%s'" file)))
4059 files
4060 '("file" "files" "recover"))
4061 (message "No files can be recovered from this session now")))
4062 (kill-buffer buffer))))
4063
4064 (defun kill-some-buffers (&optional list)
4065 "Kill some buffers. Asks the user whether to kill each one of them.
4066 Non-interactively, if optional argument LIST is non-nil, it
4067 specifies the list of buffers to kill, asking for approval for each one."
4068 (interactive)
4069 (if (null list)
4070 (setq list (buffer-list)))
4071 (while list
4072 (let* ((buffer (car list))
4073 (name (buffer-name buffer)))
4074 (and name ; Can be nil for an indirect buffer
4075 ; if we killed the base buffer.
4076 (not (string-equal name ""))
4077 (/= (aref name 0) ?\s)
4078 (yes-or-no-p
4079 (format "Buffer %s %s. Kill? "
4080 name
4081 (if (buffer-modified-p buffer)
4082 "HAS BEEN EDITED" "is unmodified")))
4083 (kill-buffer buffer)))
4084 (setq list (cdr list))))
4085 \f
4086 (defun auto-save-mode (arg)
4087 "Toggle auto-saving of contents of current buffer.
4088 With prefix argument ARG, turn auto-saving on if positive, else off."
4089 (interactive "P")
4090 (setq buffer-auto-save-file-name
4091 (and (if (null arg)
4092 (or (not buffer-auto-save-file-name)
4093 ;; If auto-save is off because buffer has shrunk,
4094 ;; then toggling should turn it on.
4095 (< buffer-saved-size 0))
4096 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4097 (if (and buffer-file-name auto-save-visited-file-name
4098 (not buffer-read-only))
4099 buffer-file-name
4100 (make-auto-save-file-name))))
4101 ;; If -1 was stored here, to temporarily turn off saving,
4102 ;; turn it back on.
4103 (and (< buffer-saved-size 0)
4104 (setq buffer-saved-size 0))
4105 (if (interactive-p)
4106 (message "Auto-save %s (in this buffer)"
4107 (if buffer-auto-save-file-name "on" "off")))
4108 buffer-auto-save-file-name)
4109
4110 (defun rename-auto-save-file ()
4111 "Adjust current buffer's auto save file name for current conditions.
4112 Also rename any existing auto save file, if it was made in this session."
4113 (let ((osave buffer-auto-save-file-name))
4114 (setq buffer-auto-save-file-name
4115 (make-auto-save-file-name))
4116 (if (and osave buffer-auto-save-file-name
4117 (not (string= buffer-auto-save-file-name buffer-file-name))
4118 (not (string= buffer-auto-save-file-name osave))
4119 (file-exists-p osave)
4120 (recent-auto-save-p))
4121 (rename-file osave buffer-auto-save-file-name t))))
4122
4123 (defun make-auto-save-file-name ()
4124 "Return file name to use for auto-saves of current buffer.
4125 Does not consider `auto-save-visited-file-name' as that variable is checked
4126 before calling this function. You can redefine this for customization.
4127 See also `auto-save-file-name-p'."
4128 (if buffer-file-name
4129 (let ((handler (find-file-name-handler buffer-file-name
4130 'make-auto-save-file-name)))
4131 (if handler
4132 (funcall handler 'make-auto-save-file-name)
4133 (let ((list auto-save-file-name-transforms)
4134 (filename buffer-file-name)
4135 result uniq)
4136 ;; Apply user-specified translations
4137 ;; to the file name.
4138 (while (and list (not result))
4139 (if (string-match (car (car list)) filename)
4140 (setq result (replace-match (cadr (car list)) t nil
4141 filename)
4142 uniq (car (cddr (car list)))))
4143 (setq list (cdr list)))
4144 (if result
4145 (if uniq
4146 (setq filename (concat
4147 (file-name-directory result)
4148 (subst-char-in-string
4149 ?/ ?!
4150 (replace-regexp-in-string "!" "!!"
4151 filename))))
4152 (setq filename result)))
4153 (setq result
4154 (if (and (eq system-type 'ms-dos)
4155 (not (msdos-long-file-names)))
4156 ;; We truncate the file name to DOS 8+3 limits
4157 ;; before doing anything else, because the regexp
4158 ;; passed to string-match below cannot handle
4159 ;; extensions longer than 3 characters, multiple
4160 ;; dots, and other atrocities.
4161 (let ((fn (dos-8+3-filename
4162 (file-name-nondirectory buffer-file-name))))
4163 (string-match
4164 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4165 fn)
4166 (concat (file-name-directory buffer-file-name)
4167 "#" (match-string 1 fn)
4168 "." (match-string 3 fn) "#"))
4169 (concat (file-name-directory filename)
4170 "#"
4171 (file-name-nondirectory filename)
4172 "#")))
4173 ;; Make sure auto-save file names don't contain characters
4174 ;; invalid for the underlying filesystem.
4175 (if (and (memq system-type '(ms-dos windows-nt))
4176 ;; Don't modify remote (ange-ftp) filenames
4177 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4178 (convert-standard-filename result)
4179 result))))
4180
4181 ;; Deal with buffers that don't have any associated files. (Mail
4182 ;; mode tends to create a good number of these.)
4183
4184 (let ((buffer-name (buffer-name))
4185 (limit 0)
4186 file-name)
4187 ;; Eliminate all slashes and backslashes by
4188 ;; replacing them with sequences that start with %.
4189 ;; Quote % also, to keep distinct names distinct.
4190 (while (string-match "[/\\%]" buffer-name limit)
4191 (let* ((character (aref buffer-name (match-beginning 0)))
4192 (replacement
4193 (cond ((eq character ?%) "%%")
4194 ((eq character ?/) "%+")
4195 ((eq character ?\\) "%-"))))
4196 (setq buffer-name (replace-match replacement t t buffer-name))
4197 (setq limit (1+ (match-end 0)))))
4198 ;; Generate the file name.
4199 (setq file-name
4200 (make-temp-file
4201 (let ((fname
4202 (expand-file-name
4203 (format "#%s#" buffer-name)
4204 ;; Try a few alternative directories, to get one we can
4205 ;; write it.
4206 (cond
4207 ((file-writable-p default-directory) default-directory)
4208 ((file-writable-p "/var/tmp/") "/var/tmp/")
4209 ("~/")))))
4210 (if (and (memq system-type '(ms-dos windows-nt))
4211 ;; Don't modify remote (ange-ftp) filenames
4212 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4213 ;; The call to convert-standard-filename is in case
4214 ;; buffer-name includes characters not allowed by the
4215 ;; DOS/Windows filesystems. make-temp-file writes to the
4216 ;; file it creates, so we must fix the file name _before_
4217 ;; make-temp-file is called.
4218 (convert-standard-filename fname)
4219 fname))
4220 nil "#"))
4221 ;; make-temp-file creates the file,
4222 ;; but we don't want it to exist until we do an auto-save.
4223 (condition-case ()
4224 (delete-file file-name)
4225 (file-error nil))
4226 file-name)))
4227
4228 (defun auto-save-file-name-p (filename)
4229 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4230 FILENAME should lack slashes. You can redefine this for customization."
4231 (string-match "^#.*#$" filename))
4232 \f
4233 (defun wildcard-to-regexp (wildcard)
4234 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4235 The generated regexp will match a filename iff the filename
4236 matches that wildcard according to shell rules. Only wildcards known
4237 by `sh' are supported."
4238 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4239 ;; Copy the initial run of non-special characters.
4240 (result (substring wildcard 0 i))
4241 (len (length wildcard)))
4242 ;; If no special characters, we're almost done.
4243 (if i
4244 (while (< i len)
4245 (let ((ch (aref wildcard i))
4246 j)
4247 (setq
4248 result
4249 (concat result
4250 (cond
4251 ((and (eq ch ?\[)
4252 (< (1+ i) len)
4253 (eq (aref wildcard (1+ i)) ?\]))
4254 "\\[")
4255 ((eq ch ?\[) ; [...] maps to regexp char class
4256 (progn
4257 (setq i (1+ i))
4258 (concat
4259 (cond
4260 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4261 (progn
4262 (setq i (1+ i))
4263 (if (eq (aref wildcard i) ?\])
4264 (progn
4265 (setq i (1+ i))
4266 "[^]")
4267 "[^")))
4268 ((eq (aref wildcard i) ?^)
4269 ;; Found "[^". Insert a `\0' character
4270 ;; (which cannot happen in a filename)
4271 ;; into the character class, so that `^'
4272 ;; is not the first character after `[',
4273 ;; and thus non-special in a regexp.
4274 (progn
4275 (setq i (1+ i))
4276 "[\000^"))
4277 ((eq (aref wildcard i) ?\])
4278 ;; I don't think `]' can appear in a
4279 ;; character class in a wildcard, but
4280 ;; let's be general here.
4281 (progn
4282 (setq i (1+ i))
4283 "[]"))
4284 (t "["))
4285 (prog1 ; copy everything upto next `]'.
4286 (substring wildcard
4287 i
4288 (setq j (string-match
4289 "]" wildcard i)))
4290 (setq i (if j (1- j) (1- len)))))))
4291 ((eq ch ?.) "\\.")
4292 ((eq ch ?*) "[^\000]*")
4293 ((eq ch ?+) "\\+")
4294 ((eq ch ?^) "\\^")
4295 ((eq ch ?$) "\\$")
4296 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4297 ((eq ch ??) "[^\000]")
4298 (t (char-to-string ch)))))
4299 (setq i (1+ i)))))
4300 ;; Shell wildcards should match the entire filename,
4301 ;; not its part. Make the regexp say so.
4302 (concat "\\`" result "\\'")))
4303 \f
4304 (defcustom list-directory-brief-switches
4305 (if (eq system-type 'vax-vms) "" "-CF")
4306 "*Switches for `list-directory' to pass to `ls' for brief listing."
4307 :type 'string
4308 :group 'dired)
4309
4310 (defcustom list-directory-verbose-switches
4311 (if (eq system-type 'vax-vms)
4312 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4313 "-l")
4314 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4315 :type 'string
4316 :group 'dired)
4317
4318 (defun file-expand-wildcards (pattern &optional full)
4319 "Expand wildcard pattern PATTERN.
4320 This returns a list of file names which match the pattern.
4321
4322 If PATTERN is written as an absolute file name,
4323 the values are absolute also.
4324
4325 If PATTERN is written as a relative file name, it is interpreted
4326 relative to the current default directory, `default-directory'.
4327 The file names returned are normally also relative to the current
4328 default directory. However, if FULL is non-nil, they are absolute."
4329 (save-match-data
4330 (let* ((nondir (file-name-nondirectory pattern))
4331 (dirpart (file-name-directory pattern))
4332 ;; A list of all dirs that DIRPART specifies.
4333 ;; This can be more than one dir
4334 ;; if DIRPART contains wildcards.
4335 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4336 (mapcar 'file-name-as-directory
4337 (file-expand-wildcards (directory-file-name dirpart)))
4338 (list dirpart)))
4339 contents)
4340 (while dirs
4341 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4342 (file-directory-p (directory-file-name (car dirs))))
4343 (let ((this-dir-contents
4344 ;; Filter out "." and ".."
4345 (delq nil
4346 (mapcar #'(lambda (name)
4347 (unless (string-match "\\`\\.\\.?\\'"
4348 (file-name-nondirectory name))
4349 name))
4350 (directory-files (or (car dirs) ".") full
4351 (wildcard-to-regexp nondir))))))
4352 (setq contents
4353 (nconc
4354 (if (and (car dirs) (not full))
4355 (mapcar (function (lambda (name) (concat (car dirs) name)))
4356 this-dir-contents)
4357 this-dir-contents)
4358 contents))))
4359 (setq dirs (cdr dirs)))
4360 contents)))
4361
4362 (defun list-directory (dirname &optional verbose)
4363 "Display a list of files in or matching DIRNAME, a la `ls'.
4364 DIRNAME is globbed by the shell if necessary.
4365 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4366 Actions controlled by variables `list-directory-brief-switches'
4367 and `list-directory-verbose-switches'."
4368 (interactive (let ((pfx current-prefix-arg))
4369 (list (read-file-name (if pfx "List directory (verbose): "
4370 "List directory (brief): ")
4371 nil default-directory nil)
4372 pfx)))
4373 (let ((switches (if verbose list-directory-verbose-switches
4374 list-directory-brief-switches))
4375 buffer)
4376 (or dirname (setq dirname default-directory))
4377 (setq dirname (expand-file-name dirname))
4378 (with-output-to-temp-buffer "*Directory*"
4379 (setq buffer standard-output)
4380 (buffer-disable-undo standard-output)
4381 (princ "Directory ")
4382 (princ dirname)
4383 (terpri)
4384 (save-excursion
4385 (set-buffer "*Directory*")
4386 (let ((wildcard (not (file-directory-p dirname))))
4387 (insert-directory dirname switches wildcard (not wildcard)))))
4388 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4389 (with-current-buffer buffer
4390 (setq default-directory
4391 (if (file-directory-p dirname)
4392 (file-name-as-directory dirname)
4393 (file-name-directory dirname))))))
4394
4395 (defun shell-quote-wildcard-pattern (pattern)
4396 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4397
4398 PATTERN is assumed to represent a file-name wildcard suitable for the
4399 underlying filesystem. For Unix and GNU/Linux, the characters from the
4400 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4401 the parts of the pattern which don't include wildcard characters are
4402 quoted with double quotes.
4403 Existing quote characters in PATTERN are left alone, so you can pass
4404 PATTERN that already quotes some of the special characters."
4405 (save-match-data
4406 (cond
4407 ((memq system-type '(ms-dos windows-nt cygwin))
4408 ;; DOS/Windows don't allow `"' in file names. So if the
4409 ;; argument has quotes, we can safely assume it is already
4410 ;; quoted by the caller.
4411 (if (or (string-match "[\"]" pattern)
4412 ;; We quote [&()#$'] in case their shell is a port of a
4413 ;; Unixy shell. We quote [,=+] because stock DOS and
4414 ;; Windows shells require that in some cases, such as
4415 ;; passing arguments to batch files that use positional
4416 ;; arguments like %1.
4417 (not (string-match "[ \t;&()#$',=+]" pattern)))
4418 pattern
4419 (let ((result "\"")
4420 (beg 0)
4421 end)
4422 (while (string-match "[*?]+" pattern beg)
4423 (setq end (match-beginning 0)
4424 result (concat result (substring pattern beg end)
4425 "\""
4426 (substring pattern end (match-end 0))
4427 "\"")
4428 beg (match-end 0)))
4429 (concat result (substring pattern beg) "\""))))
4430 (t
4431 (let ((beg 0))
4432 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4433 (setq pattern
4434 (concat (substring pattern 0 (match-beginning 0))
4435 "\\"
4436 (substring pattern (match-beginning 0)))
4437 beg (1+ (match-end 0)))))
4438 pattern))))
4439
4440
4441 (defvar insert-directory-program "ls"
4442 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4443
4444 (defcustom directory-free-space-program "df"
4445 "*Program to get the amount of free space on a file system.
4446 We assume the output has the format of `df'.
4447 The value of this variable must be just a command name or file name;
4448 if you want to specify options, use `directory-free-space-args'.
4449
4450 A value of nil disables this feature.
4451
4452 If the function `file-system-info' is defined, it is always used in
4453 preference to the program given by this variable."
4454 :type '(choice (string :tag "Program") (const :tag "None" nil))
4455 :group 'dired)
4456
4457 (defcustom directory-free-space-args
4458 (if (eq system-type 'darwin) "-k" "-Pk")
4459 "*Options to use when running `directory-free-space-program'."
4460 :type 'string
4461 :group 'dired)
4462
4463 (defun get-free-disk-space (dir)
4464 "Return the amount of free space on directory DIR's file system.
4465 The result is a string that gives the number of free 1KB blocks,
4466 or nil if the system call or the program which retrieve the information
4467 fail.
4468
4469 This function calls `file-system-info' if it is available, or invokes the
4470 program specified by `directory-free-space-program' if that is non-nil."
4471 ;; Try to find the number of free blocks. Non-Posix systems don't
4472 ;; always have df, but might have an equivalent system call.
4473 (if (fboundp 'file-system-info)
4474 (let ((fsinfo (file-system-info dir)))
4475 (if fsinfo
4476 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4477 (save-match-data
4478 (with-temp-buffer
4479 (when (and directory-free-space-program
4480 (eq 0 (call-process directory-free-space-program
4481 nil t nil
4482 directory-free-space-args
4483 dir)))
4484 ;; Usual format is a header line followed by a line of
4485 ;; numbers.
4486 (goto-char (point-min))
4487 (forward-line 1)
4488 (if (not (eobp))
4489 (progn
4490 ;; Move to the end of the "available blocks" number.
4491 (skip-chars-forward "^ \t")
4492 (forward-word 3)
4493 ;; Copy it into AVAILABLE.
4494 (let ((end (point)))
4495 (forward-word -1)
4496 (buffer-substring (point) end)))))))))
4497
4498 ;; The following expression replaces `dired-move-to-filename-regexp'.
4499 (defvar directory-listing-before-filename-regexp
4500 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4501 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4502 ;; In some locales, month abbreviations are as short as 2 letters,
4503 ;; and they can be followed by ".".
4504 ;; In Breton, a month name can include a quote character.
4505 (month (concat l-or-quote l-or-quote "+\\.?"))
4506 (s " ")
4507 (yyyy "[0-9][0-9][0-9][0-9]")
4508 (dd "[ 0-3][0-9]")
4509 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4510 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4511 (zone "[-+][0-2][0-9][0-5][0-9]")
4512 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4513 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4514 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4515 "\\|" yyyy "-" iso-mm-dd "\\)"))
4516 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4517 s "+"
4518 "\\(" HH:MM "\\|" yyyy "\\)"))
4519 (western-comma (concat month s "+" dd "," s "+" yyyy))
4520 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4521 ;; omits the Kanji characters after month and day-of-month.
4522 ;; On Mac OS X 10.3, the date format in East Asian locales is
4523 ;; day-of-month digits followed by month digits.
4524 (mm "[ 0-1]?[0-9]")
4525 (east-asian
4526 (concat "\\(" mm l "?" s dd l "?" s "+"
4527 "\\|" dd s mm s "+" "\\)"
4528 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4529 ;; The "[0-9]" below requires the previous column to end in a digit.
4530 ;; This avoids recognizing `1 may 1997' as a date in the line:
4531 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4532
4533 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4534 ;; The ".*" below finds the last match if there are multiple matches.
4535 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4536 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4537
4538 ;; vc dired listings provide the state or blanks between file
4539 ;; permissions and date. The state is always surrounded by
4540 ;; parantheses:
4541 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4542 ;; This is not supported yet.
4543 (concat ".*[0-9][BkKMGTPEZY]?" s
4544 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4545 s "+"))
4546 "Regular expression to match up to the file name in a directory listing.
4547 The default value is designed to recognize dates and times
4548 regardless of the language.")
4549
4550 (defvar insert-directory-ls-version 'unknown)
4551
4552 ;; insert-directory
4553 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4554 ;; FULL-DIRECTORY-P is nil.
4555 ;; The single line of output must display FILE's name as it was
4556 ;; given, namely, an absolute path name.
4557 ;; - must insert exactly one line for each file if WILDCARD or
4558 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4559 ;; before the file lines, plus optional text after the file lines.
4560 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4561 ;; allowed.
4562 ;; File lines should display the basename.
4563 ;; - must be consistent with
4564 ;; - functions dired-move-to-filename, (these two define what a file line is)
4565 ;; dired-move-to-end-of-filename,
4566 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4567 ;; dired-insert-headerline
4568 ;; dired-after-subdir-garbage (defines what a "total" line is)
4569 ;; - variable dired-subdir-regexp
4570 ;; - may be passed "--dired" as the first argument in SWITCHES.
4571 ;; Filename handlers might have to remove this switch if their
4572 ;; "ls" command does not support it.
4573 (defun insert-directory (file switches &optional wildcard full-directory-p)
4574 "Insert directory listing for FILE, formatted according to SWITCHES.
4575 Leaves point after the inserted text.
4576 SWITCHES may be a string of options, or a list of strings
4577 representing individual options.
4578 Optional third arg WILDCARD means treat FILE as shell wildcard.
4579 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4580 switches do not contain `d', so that a full listing is expected.
4581
4582 This works by running a directory listing program
4583 whose name is in the variable `insert-directory-program'.
4584 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4585
4586 When SWITCHES contains the long `--dired' option, this function
4587 treats it specially, for the sake of dired. However, the
4588 normally equivalent short `-D' option is just passed on to
4589 `insert-directory-program', as any other option."
4590 ;; We need the directory in order to find the right handler.
4591 (let ((handler (find-file-name-handler (expand-file-name file)
4592 'insert-directory)))
4593 (if handler
4594 (funcall handler 'insert-directory file switches
4595 wildcard full-directory-p)
4596 (if (eq system-type 'vax-vms)
4597 (vms-read-directory file switches (current-buffer))
4598 (let (result (beg (point)))
4599
4600 ;; Read the actual directory using `insert-directory-program'.
4601 ;; RESULT gets the status code.
4602 (let* (;; We at first read by no-conversion, then after
4603 ;; putting text property `dired-filename, decode one
4604 ;; bunch by one to preserve that property.
4605 (coding-system-for-read 'no-conversion)
4606 ;; This is to control encoding the arguments in call-process.
4607 (coding-system-for-write
4608 (and enable-multibyte-characters
4609 (or file-name-coding-system
4610 default-file-name-coding-system))))
4611 (setq result
4612 (if wildcard
4613 ;; Run ls in the directory part of the file pattern
4614 ;; using the last component as argument.
4615 (let ((default-directory
4616 (if (file-name-absolute-p file)
4617 (file-name-directory file)
4618 (file-name-directory (expand-file-name file))))
4619 (pattern (file-name-nondirectory file)))
4620 (call-process
4621 shell-file-name nil t nil
4622 "-c"
4623 (concat (if (memq system-type '(ms-dos windows-nt))
4624 ""
4625 "\\") ; Disregard Unix shell aliases!
4626 insert-directory-program
4627 " -d "
4628 (if (stringp switches)
4629 switches
4630 (mapconcat 'identity switches " "))
4631 " -- "
4632 ;; Quote some characters that have
4633 ;; special meanings in shells; but
4634 ;; don't quote the wildcards--we want
4635 ;; them to be special. We also
4636 ;; currently don't quote the quoting
4637 ;; characters in case people want to
4638 ;; use them explicitly to quote
4639 ;; wildcard characters.
4640 (shell-quote-wildcard-pattern pattern))))
4641 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4642 ;; directory if FILE is a symbolic link.
4643 (apply 'call-process
4644 insert-directory-program nil t nil
4645 (append
4646 (if (listp switches) switches
4647 (unless (equal switches "")
4648 ;; Split the switches at any spaces so we can
4649 ;; pass separate options as separate args.
4650 (split-string switches)))
4651 ;; Avoid lossage if FILE starts with `-'.
4652 '("--")
4653 (progn
4654 (if (string-match "\\`~" file)
4655 (setq file (expand-file-name file)))
4656 (list
4657 (if full-directory-p
4658 (concat (file-name-as-directory file) ".")
4659 file))))))))
4660
4661 ;; If we got "//DIRED//" in the output, it means we got a real
4662 ;; directory listing, even if `ls' returned nonzero.
4663 ;; So ignore any errors.
4664 (when (if (stringp switches)
4665 (string-match "--dired\\>" switches)
4666 (member "--dired" switches))
4667 (save-excursion
4668 (forward-line -2)
4669 (when (looking-at "//SUBDIRED//")
4670 (forward-line -1))
4671 (if (looking-at "//DIRED//")
4672 (setq result 0))))
4673
4674 (when (and (not (eq 0 result))
4675 (eq insert-directory-ls-version 'unknown))
4676 ;; The first time ls returns an error,
4677 ;; find the version numbers of ls,
4678 ;; and set insert-directory-ls-version
4679 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4680 ;; is equal or if the info cannot be obtained.
4681 ;; (That can mean it isn't GNU ls.)
4682 (let ((version-out
4683 (with-temp-buffer
4684 (call-process "ls" nil t nil "--version")
4685 (buffer-string))))
4686 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
4687 (let* ((version (match-string 1 version-out))
4688 (split (split-string version "[.]"))
4689 (numbers (mapcar 'string-to-number split))
4690 (min '(5 2 1))
4691 comparison)
4692 (while (and (not comparison) (or numbers min))
4693 (cond ((null min)
4694 (setq comparison '>))
4695 ((null numbers)
4696 (setq comparison '<))
4697 ((> (car numbers) (car min))
4698 (setq comparison '>))
4699 ((< (car numbers) (car min))
4700 (setq comparison '<))
4701 (t
4702 (setq numbers (cdr numbers)
4703 min (cdr min)))))
4704 (setq insert-directory-ls-version (or comparison '=)))
4705 (setq insert-directory-ls-version nil))))
4706
4707 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4708 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
4709 (setq result 0))
4710
4711 ;; If `insert-directory-program' failed, signal an error.
4712 (unless (eq 0 result)
4713 ;; Delete the error message it may have output.
4714 (delete-region beg (point))
4715 ;; On non-Posix systems, we cannot open a directory, so
4716 ;; don't even try, because that will always result in
4717 ;; the ubiquitous "Access denied". Instead, show the
4718 ;; command line so the user can try to guess what went wrong.
4719 (if (and (file-directory-p file)
4720 (memq system-type '(ms-dos windows-nt)))
4721 (error
4722 "Reading directory: \"%s %s -- %s\" exited with status %s"
4723 insert-directory-program
4724 (if (listp switches) (concat switches) switches)
4725 file result)
4726 ;; Unix. Access the file to get a suitable error.
4727 (access-file file "Reading directory")
4728 (error "Listing directory failed but `access-file' worked")))
4729
4730 (when (if (stringp switches)
4731 (string-match "--dired\\>" switches)
4732 (member "--dired" switches))
4733 ;; The following overshoots by one line for an empty
4734 ;; directory listed with "--dired", but without "-a"
4735 ;; switch, where the ls output contains a
4736 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
4737 ;; We take care of that case later.
4738 (forward-line -2)
4739 (when (looking-at "//SUBDIRED//")
4740 (delete-region (point) (progn (forward-line 1) (point)))
4741 (forward-line -1))
4742 (if (looking-at "//DIRED//")
4743 (let ((end (line-end-position))
4744 (linebeg (point))
4745 error-lines)
4746 ;; Find all the lines that are error messages,
4747 ;; and record the bounds of each one.
4748 (goto-char beg)
4749 (while (< (point) linebeg)
4750 (or (eql (following-char) ?\s)
4751 (push (list (point) (line-end-position)) error-lines))
4752 (forward-line 1))
4753 (setq error-lines (nreverse error-lines))
4754 ;; Now read the numeric positions of file names.
4755 (goto-char linebeg)
4756 (forward-word 1)
4757 (forward-char 3)
4758 (while (< (point) end)
4759 (let ((start (insert-directory-adj-pos
4760 (+ beg (read (current-buffer)))
4761 error-lines))
4762 (end (insert-directory-adj-pos
4763 (+ beg (read (current-buffer)))
4764 error-lines)))
4765 (if (memq (char-after end) '(?\n ?\s))
4766 ;; End is followed by \n or by " -> ".
4767 (put-text-property start end 'dired-filename t)
4768 ;; It seems that we can't trust ls's output as to
4769 ;; byte positions of filenames.
4770 (put-text-property beg (point) 'dired-filename nil)
4771 (end-of-line))))
4772 (goto-char end)
4773 (beginning-of-line)
4774 (delete-region (point) (progn (forward-line 1) (point))))
4775 ;; Take care of the case where the ls output contains a
4776 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
4777 ;; and we went one line too far back (see above).
4778 (forward-line 1))
4779 (if (looking-at "//DIRED-OPTIONS//")
4780 (delete-region (point) (progn (forward-line 1) (point)))))
4781
4782 ;; Now decode what read if necessary.
4783 (let ((coding (or coding-system-for-read
4784 file-name-coding-system
4785 default-file-name-coding-system
4786 'undecided))
4787 coding-no-eol
4788 val pos)
4789 (when (and enable-multibyte-characters
4790 (not (memq (coding-system-base coding)
4791 '(raw-text no-conversion))))
4792 ;; If no coding system is specified or detection is
4793 ;; requested, detect the coding.
4794 (if (eq (coding-system-base coding) 'undecided)
4795 (setq coding (detect-coding-region beg (point) t)))
4796 (if (not (eq (coding-system-base coding) 'undecided))
4797 (save-restriction
4798 (setq coding-no-eol
4799 (coding-system-change-eol-conversion coding 'unix))
4800 (narrow-to-region beg (point))
4801 (goto-char (point-min))
4802 (while (not (eobp))
4803 (setq pos (point)
4804 val (get-text-property (point) 'dired-filename))
4805 (goto-char (next-single-property-change
4806 (point) 'dired-filename nil (point-max)))
4807 ;; Force no eol conversion on a file name, so
4808 ;; that CR is preserved.
4809 (decode-coding-region pos (point)
4810 (if val coding-no-eol coding))
4811 (if val
4812 (put-text-property pos (point)
4813 'dired-filename t)))))))
4814
4815 (if full-directory-p
4816 ;; Try to insert the amount of free space.
4817 (save-excursion
4818 (goto-char beg)
4819 ;; First find the line to put it on.
4820 (when (re-search-forward "^ *\\(total\\)" nil t)
4821 (let ((available (get-free-disk-space ".")))
4822 (when available
4823 ;; Replace "total" with "used", to avoid confusion.
4824 (replace-match "total used in directory" nil nil nil 1)
4825 (end-of-line)
4826 (insert " available " available)))))))))))
4827
4828 (defun insert-directory-adj-pos (pos error-lines)
4829 "Convert `ls --dired' file name position value POS to a buffer position.
4830 File name position values returned in ls --dired output
4831 count only stdout; they don't count the error messages sent to stderr.
4832 So this function converts to them to real buffer positions.
4833 ERROR-LINES is a list of buffer positions of error message lines,
4834 of the form (START END)."
4835 (while (and error-lines (< (caar error-lines) pos))
4836 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
4837 (pop error-lines))
4838 pos)
4839
4840 (defun insert-directory-safely (file switches
4841 &optional wildcard full-directory-p)
4842 "Insert directory listing for FILE, formatted according to SWITCHES.
4843
4844 Like `insert-directory', but if FILE does not exist, it inserts a
4845 message to that effect instead of signaling an error."
4846 (if (file-exists-p file)
4847 (insert-directory file switches wildcard full-directory-p)
4848 ;; Simulate the message printed by `ls'.
4849 (insert (format "%s: No such file or directory\n" file))))
4850
4851 (defvar kill-emacs-query-functions nil
4852 "Functions to call with no arguments to query about killing Emacs.
4853 If any of these functions returns nil, killing Emacs is cancelled.
4854 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4855 but `kill-emacs', the low level primitive, does not.
4856 See also `kill-emacs-hook'.")
4857
4858 (defcustom confirm-kill-emacs nil
4859 "How to ask for confirmation when leaving Emacs.
4860 If nil, the default, don't ask at all. If the value is non-nil, it should
4861 be a predicate function such as `yes-or-no-p'."
4862 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4863 (const :tag "Ask with y-or-n-p" y-or-n-p)
4864 (const :tag "Don't confirm" nil))
4865 :group 'convenience
4866 :version "21.1")
4867
4868 (defun save-buffers-kill-emacs (&optional arg)
4869 "Offer to save each buffer, then kill this Emacs process.
4870 With prefix arg, silently save all file-visiting buffers, then kill."
4871 (interactive "P")
4872 (save-some-buffers arg t)
4873 (and (or (not (memq t (mapcar (function
4874 (lambda (buf) (and (buffer-file-name buf)
4875 (buffer-modified-p buf))))
4876 (buffer-list))))
4877 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4878 (or (not (fboundp 'process-list))
4879 ;; process-list is not defined on VMS.
4880 (let ((processes (process-list))
4881 active)
4882 (while processes
4883 (and (memq (process-status (car processes)) '(run stop open listen))
4884 (process-query-on-exit-flag (car processes))
4885 (setq active t))
4886 (setq processes (cdr processes)))
4887 (or (not active)
4888 (list-processes t)
4889 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
4890 ;; Query the user for other things, perhaps.
4891 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
4892 (or (null confirm-kill-emacs)
4893 (funcall confirm-kill-emacs "Really exit Emacs? "))
4894 (kill-emacs)))
4895 \f
4896 ;; We use /: as a prefix to "quote" a file name
4897 ;; so that magic file name handlers will not apply to it.
4898
4899 (setq file-name-handler-alist
4900 (cons '("\\`/:" . file-name-non-special)
4901 file-name-handler-alist))
4902
4903 ;; We depend on being the last handler on the list,
4904 ;; so that anything else which does need handling
4905 ;; has been handled already.
4906 ;; So it is safe for us to inhibit *all* magic file name handlers.
4907
4908 (defun file-name-non-special (operation &rest arguments)
4909 (let ((file-name-handler-alist nil)
4910 (default-directory
4911 (if (eq operation 'insert-directory)
4912 (directory-file-name
4913 (expand-file-name
4914 (unhandled-file-name-directory default-directory)))
4915 default-directory))
4916 ;; Get a list of the indices of the args which are file names.
4917 (file-arg-indices
4918 (cdr (or (assq operation
4919 ;; The first six are special because they
4920 ;; return a file name. We want to include the /:
4921 ;; in the return value.
4922 ;; So just avoid stripping it in the first place.
4923 '((expand-file-name . nil)
4924 (file-name-directory . nil)
4925 (file-name-as-directory . nil)
4926 (directory-file-name . nil)
4927 (file-name-sans-versions . nil)
4928 (find-backup-file-name . nil)
4929 ;; `identity' means just return the first arg
4930 ;; not stripped of its quoting.
4931 (substitute-in-file-name identity)
4932 ;; `add' means add "/:" to the result.
4933 (file-truename add 0)
4934 ;; `quote' means add "/:" to buffer-file-name.
4935 (insert-file-contents quote 0)
4936 ;; `unquote-then-quote' means set buffer-file-name
4937 ;; temporarily to unquoted filename.
4938 (verify-visited-file-modtime unquote-then-quote)
4939 ;; List the arguments which are filenames.
4940 (file-name-completion 1)
4941 (file-name-all-completions 1)
4942 (write-region 2 5)
4943 (rename-file 0 1)
4944 (copy-file 0 1)
4945 (make-symbolic-link 0 1)
4946 (add-name-to-file 0 1)))
4947 ;; For all other operations, treat the first argument only
4948 ;; as the file name.
4949 '(nil 0))))
4950 method
4951 ;; Copy ARGUMENTS so we can replace elements in it.
4952 (arguments (copy-sequence arguments)))
4953 (if (symbolp (car file-arg-indices))
4954 (setq method (pop file-arg-indices)))
4955 ;; Strip off the /: from the file names that have it.
4956 (save-match-data
4957 (while (consp file-arg-indices)
4958 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4959 (and (car pair)
4960 (string-match "\\`/:" (car pair))
4961 (setcar pair
4962 (if (= (length (car pair)) 2)
4963 "/"
4964 (substring (car pair) 2)))))
4965 (setq file-arg-indices (cdr file-arg-indices))))
4966 (cond ((eq method 'identity)
4967 (car arguments))
4968 ((eq method 'add)
4969 (concat "/:" (apply operation arguments)))
4970 ((eq method 'quote)
4971 (unwind-protect
4972 (apply operation arguments)
4973 (setq buffer-file-name (concat "/:" buffer-file-name))))
4974 ((eq method 'unquote-then-quote)
4975 (let (res)
4976 (setq buffer-file-name (substring buffer-file-name 2))
4977 (setq res (apply operation arguments))
4978 (setq buffer-file-name (concat "/:" buffer-file-name))
4979 res))
4980 (t
4981 (apply operation arguments)))))
4982 \f
4983 (define-key ctl-x-map "\C-f" 'find-file)
4984 (define-key ctl-x-map "\C-r" 'find-file-read-only)
4985 (define-key ctl-x-map "\C-v" 'find-alternate-file)
4986 (define-key ctl-x-map "\C-s" 'save-buffer)
4987 (define-key ctl-x-map "s" 'save-some-buffers)
4988 (define-key ctl-x-map "\C-w" 'write-file)
4989 (define-key ctl-x-map "i" 'insert-file)
4990 (define-key esc-map "~" 'not-modified)
4991 (define-key ctl-x-map "\C-d" 'list-directory)
4992 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4993 (define-key ctl-x-map "\C-q" 'toggle-read-only)
4994
4995 (define-key ctl-x-4-map "f" 'find-file-other-window)
4996 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4997 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4998 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
4999 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5000
5001 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5002 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5003 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5004 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5005
5006 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5007 ;;; files.el ends here