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