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