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