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