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