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