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