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