]> code.delx.au - gnu-emacs/blob - lisp/files.el
merge trun
[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: "))))
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 See also `inhibit-local-variables-suffixes'.")
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 When checking `inhibit-local-variables-regexps', we first discard
2513 from the end of the file name anything that matches one of these regexps.")
2514
2515 ;; TODO explicitly add case-fold-search t?
2516 (defun inhibit-local-variables-p ()
2517 "Return non-nil if file local variables should be ignored.
2518 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2519 and `inhibit-local-variables-suffixes'."
2520 (let ((temp inhibit-local-variables-regexps)
2521 (name (if buffer-file-name
2522 (file-name-sans-versions buffer-file-name)
2523 (buffer-name))))
2524 (while (let ((sufs inhibit-local-variables-suffixes))
2525 (while (and sufs (not (string-match (car sufs) name)))
2526 (setq sufs (cdr sufs)))
2527 sufs)
2528 (setq name (substring name 0 (match-beginning 0))))
2529 (while (and temp
2530 (not (string-match (car temp) name)))
2531 (setq temp (cdr temp)))
2532 temp))
2533
2534 (defvar auto-mode-interpreter-regexp
2535 (purecopy "#![ \t]?\\([^ \t\n]*\
2536 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2537 "Regexp matching interpreters, for file mode determination.
2538 This regular expression is matched against the first line of a file
2539 to determine the file's mode in `set-auto-mode'. If it matches, the file
2540 is assumed to be interpreted by the interpreter matched by the second group
2541 of the regular expression. The mode is then determined as the mode
2542 associated with that interpreter in `interpreter-mode-alist'.")
2543
2544 (defvar magic-mode-alist nil
2545 "Alist of buffer beginnings vs. corresponding major mode functions.
2546 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2547 After visiting a file, if REGEXP matches the text at the beginning of the
2548 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2549 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2550 major mode.
2551
2552 If FUNCTION is nil, then it is not called. (That is a way of saying
2553 \"allow `auto-mode-alist' to decide for these files.\")")
2554 (put 'magic-mode-alist 'risky-local-variable t)
2555
2556 (defvar magic-fallback-mode-alist
2557 (purecopy
2558 `((image-type-auto-detected-p . image-mode)
2559 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2560 ;; The < comes before the groups (but the first) to reduce backtracking.
2561 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2562 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2563 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2564 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2565 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2566 comment-re "*"
2567 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2568 "[Hh][Tt][Mm][Ll]"))
2569 . html-mode)
2570 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2571 ;; These two must come after html, because they are more general:
2572 ("<\\?xml " . xml-mode)
2573 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2574 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2575 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2576 . sgml-mode)
2577 ("%!PS" . ps-mode)
2578 ("# xmcd " . conf-unix-mode)))
2579 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2580 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2581 After visiting a file, if REGEXP matches the text at the beginning of the
2582 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2583 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2584 have not specified a mode for this file.
2585
2586 If FUNCTION is nil, then it is not called.")
2587 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2588
2589 (defvar magic-mode-regexp-match-limit 4000
2590 "Upper limit on `magic-mode-alist' regexp matches.
2591 Also applies to `magic-fallback-mode-alist'.")
2592
2593 (defun set-auto-mode (&optional keep-mode-if-same)
2594 "Select major mode appropriate for current buffer.
2595
2596 To find the right major mode, this function checks for a -*- mode tag
2597 checks for a `mode:' entry in the Local Variables section of the file,
2598 checks if it uses an interpreter listed in `interpreter-mode-alist',
2599 matches the buffer beginning against `magic-mode-alist',
2600 compares the filename against the entries in `auto-mode-alist',
2601 then matches the buffer beginning against `magic-fallback-mode-alist'.
2602
2603 If `enable-local-variables' is nil, or if the file name matches
2604 `inhibit-local-variables-regexps', this function does not check
2605 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2606 is nil, then the only mode: tag that can be relevant is a -*- one.
2607
2608 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2609 set the major mode only if that would change it. In other words
2610 we don't actually set it to the same mode the buffer already has."
2611 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2612 (let ((try-locals (not (inhibit-local-variables-p)))
2613 end done mode modes)
2614 ;; Once we drop the deprecated feature where mode: is also allowed to
2615 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2616 ;; remove this section and just let (hack-local-variables t) handle it.
2617 ;; Find a -*- mode tag.
2618 (save-excursion
2619 (goto-char (point-min))
2620 (skip-chars-forward " \t\n")
2621 ;; Note by design local-enable-local-variables does not matter here.
2622 (and enable-local-variables
2623 try-locals
2624 (setq end (set-auto-mode-1))
2625 (if (save-excursion (search-forward ":" end t))
2626 ;; Find all specifications for the `mode:' variable
2627 ;; and execute them left to right.
2628 (while (let ((case-fold-search t))
2629 (or (and (looking-at "mode:")
2630 (goto-char (match-end 0)))
2631 (re-search-forward "[ \t;]mode:" end t)))
2632 (skip-chars-forward " \t")
2633 (let ((beg (point)))
2634 (if (search-forward ";" end t)
2635 (forward-char -1)
2636 (goto-char end))
2637 (skip-chars-backward " \t")
2638 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2639 modes)))
2640 ;; Simple -*-MODE-*- case.
2641 (push (intern (concat (downcase (buffer-substring (point) end))
2642 "-mode"))
2643 modes))))
2644 ;; If we found modes to use, invoke them now, outside the save-excursion.
2645 (if modes
2646 (catch 'nop
2647 (dolist (mode (nreverse modes))
2648 (if (not (functionp mode))
2649 (message "Ignoring unknown mode `%s'" mode)
2650 (setq done t)
2651 (or (set-auto-mode-0 mode keep-mode-if-same)
2652 ;; continuing would call minor modes again, toggling them off
2653 (throw 'nop nil))))))
2654 ;; hack-local-variables checks local-enable-local-variables etc, but
2655 ;; we might as well be explicit here for the sake of clarity.
2656 (and (not done)
2657 enable-local-variables
2658 local-enable-local-variables
2659 try-locals
2660 (setq mode (hack-local-variables t))
2661 (not (memq mode modes)) ; already tried and failed
2662 (if (not (functionp mode))
2663 (message "Ignoring unknown mode `%s'" mode)
2664 (setq done t)
2665 (set-auto-mode-0 mode keep-mode-if-same)))
2666 ;; If we didn't, look for an interpreter specified in the first line.
2667 ;; As a special case, allow for things like "#!/bin/env perl", which
2668 ;; finds the interpreter anywhere in $PATH.
2669 (unless done
2670 (setq mode (save-excursion
2671 (goto-char (point-min))
2672 (if (looking-at auto-mode-interpreter-regexp)
2673 (match-string 2)
2674 ""))
2675 ;; Map interpreter name to a mode, signaling we're done at the
2676 ;; same time.
2677 done (assoc (file-name-nondirectory mode)
2678 interpreter-mode-alist))
2679 ;; If we found an interpreter mode to use, invoke it now.
2680 (if done
2681 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2682 ;; Next try matching the buffer beginning against magic-mode-alist.
2683 (unless done
2684 (if (setq done (save-excursion
2685 (goto-char (point-min))
2686 (save-restriction
2687 (narrow-to-region (point-min)
2688 (min (point-max)
2689 (+ (point-min) magic-mode-regexp-match-limit)))
2690 (assoc-default nil magic-mode-alist
2691 (lambda (re _dummy)
2692 (if (functionp re)
2693 (funcall re)
2694 (looking-at re)))))))
2695 (set-auto-mode-0 done keep-mode-if-same)))
2696 ;; Next compare the filename against the entries in auto-mode-alist.
2697 (unless done
2698 (if buffer-file-name
2699 (let ((name buffer-file-name)
2700 (remote-id (file-remote-p buffer-file-name)))
2701 ;; Remove backup-suffixes from file name.
2702 (setq name (file-name-sans-versions name))
2703 ;; Remove remote file name identification.
2704 (when (and (stringp remote-id)
2705 (string-match (regexp-quote remote-id) name))
2706 (setq name (substring name (match-end 0))))
2707 (while name
2708 ;; Find first matching alist entry.
2709 (setq mode
2710 (if (memq system-type '(windows-nt cygwin))
2711 ;; System is case-insensitive.
2712 (let ((case-fold-search t))
2713 (assoc-default name auto-mode-alist
2714 'string-match))
2715 ;; System is case-sensitive.
2716 (or
2717 ;; First match case-sensitively.
2718 (let ((case-fold-search nil))
2719 (assoc-default name auto-mode-alist
2720 'string-match))
2721 ;; Fallback to case-insensitive match.
2722 (and auto-mode-case-fold
2723 (let ((case-fold-search t))
2724 (assoc-default name auto-mode-alist
2725 'string-match))))))
2726 (if (and mode
2727 (consp mode)
2728 (cadr mode))
2729 (setq mode (car mode)
2730 name (substring name 0 (match-beginning 0)))
2731 (setq name nil))
2732 (when mode
2733 (set-auto-mode-0 mode keep-mode-if-same)
2734 (setq done t))))))
2735 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2736 (unless done
2737 (if (setq done (save-excursion
2738 (goto-char (point-min))
2739 (save-restriction
2740 (narrow-to-region (point-min)
2741 (min (point-max)
2742 (+ (point-min) magic-mode-regexp-match-limit)))
2743 (assoc-default nil magic-fallback-mode-alist
2744 (lambda (re _dummy)
2745 (if (functionp re)
2746 (funcall re)
2747 (looking-at re)))))))
2748 (set-auto-mode-0 done keep-mode-if-same)))))
2749
2750 ;; When `keep-mode-if-same' is set, we are working on behalf of
2751 ;; set-visited-file-name. In that case, if the major mode specified is the
2752 ;; same one we already have, don't actually reset it. We don't want to lose
2753 ;; minor modes such as Font Lock.
2754 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2755 "Apply MODE and return it.
2756 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2757 any aliases and compared to current major mode. If they are the
2758 same, do nothing and return nil."
2759 (unless (and keep-mode-if-same
2760 (eq (indirect-function mode)
2761 (indirect-function major-mode)))
2762 (when mode
2763 (funcall mode)
2764 mode)))
2765
2766 (defvar file-auto-mode-skip "^\\(#!\\|'\\\\\"\\)"
2767 "Regexp of lines to skip when looking for file-local settings.
2768 If the first line matches this regular expression, then the -*-...-*- file-
2769 local settings will be consulted on the second line instead of the first.")
2770
2771 (defun set-auto-mode-1 ()
2772 "Find the -*- spec in the buffer.
2773 Call with point at the place to start searching from.
2774 If one is found, set point to the beginning and return the position
2775 of the end. Otherwise, return nil; may change point.
2776 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2777 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2778 have no effect."
2779 (let (beg end)
2780 (and
2781 ;; Don't look for -*- if this file name matches any
2782 ;; of the regexps in inhibit-local-variables-regexps.
2783 (not (inhibit-local-variables-p))
2784 (search-forward "-*-" (line-end-position
2785 ;; If the file begins with "#!" (exec
2786 ;; interpreter magic), look for mode frobs
2787 ;; in the first two lines. You cannot
2788 ;; necessarily put them in the first line
2789 ;; of such a file without screwing up the
2790 ;; interpreter invocation. The same holds
2791 ;; for '\" in man pages (preprocessor
2792 ;; magic for the `man' program).
2793 (and (looking-at file-auto-mode-skip) 2)) t)
2794 (progn
2795 (skip-chars-forward " \t")
2796 (setq beg (point))
2797 (search-forward "-*-" (line-end-position) t))
2798 (progn
2799 (forward-char -3)
2800 (skip-chars-backward " \t")
2801 (setq end (point))
2802 (goto-char beg)
2803 end))))
2804 \f
2805 ;;; Handling file local variables
2806
2807 (defvar ignored-local-variables
2808 '(ignored-local-variables safe-local-variable-values
2809 file-local-variables-alist dir-local-variables-alist)
2810 "Variables to be ignored in a file's local variable spec.")
2811 (put 'ignored-local-variables 'risky-local-variable t)
2812
2813 (defvar hack-local-variables-hook nil
2814 "Normal hook run after processing a file's local variables specs.
2815 Major modes can use this to examine user-specified local variables
2816 in order to initialize other data structure based on them.")
2817
2818 (defcustom safe-local-variable-values nil
2819 "List variable-value pairs that are considered safe.
2820 Each element is a cons cell (VAR . VAL), where VAR is a variable
2821 symbol and VAL is a value that is considered safe."
2822 :risky t
2823 :group 'find-file
2824 :type 'alist)
2825
2826 (defcustom safe-local-eval-forms
2827 ;; This should be here at least as long as Emacs supports write-file-hooks.
2828 '((add-hook 'write-file-hooks 'time-stamp)
2829 (add-hook 'write-file-functions 'time-stamp)
2830 (add-hook 'before-save-hook 'time-stamp nil t)
2831 (add-hook 'before-save-hook 'delete-trailing-whitespace nil t))
2832 "Expressions that are considered safe in an `eval:' local variable.
2833 Add expressions to this list if you want Emacs to evaluate them, when
2834 they appear in an `eval' local variable specification, without first
2835 asking you for confirmation."
2836 :risky t
2837 :group 'find-file
2838 :version "24.1" ; added write-file-hooks
2839 :type '(repeat sexp))
2840
2841 ;; Risky local variables:
2842 (mapc (lambda (var) (put var 'risky-local-variable t))
2843 '(after-load-alist
2844 buffer-auto-save-file-name
2845 buffer-file-name
2846 buffer-file-truename
2847 buffer-undo-list
2848 debugger
2849 default-text-properties
2850 eval
2851 exec-directory
2852 exec-path
2853 file-name-handler-alist
2854 frame-title-format
2855 global-mode-string
2856 header-line-format
2857 icon-title-format
2858 inhibit-quit
2859 load-path
2860 max-lisp-eval-depth
2861 max-specpdl-size
2862 minor-mode-map-alist
2863 minor-mode-overriding-map-alist
2864 mode-line-format
2865 mode-name
2866 overriding-local-map
2867 overriding-terminal-local-map
2868 process-environment
2869 standard-input
2870 standard-output
2871 unread-command-events))
2872
2873 ;; Safe local variables:
2874 ;;
2875 ;; For variables defined by major modes, the safety declarations can go into
2876 ;; the major mode's file, since that will be loaded before file variables are
2877 ;; processed.
2878 ;;
2879 ;; For variables defined by minor modes, put the safety declarations in the
2880 ;; file defining the minor mode after the defcustom/defvar using an autoload
2881 ;; cookie, e.g.:
2882 ;;
2883 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2884 ;;
2885 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2886 ;; minor mode file may not be loaded yet.
2887 ;;
2888 ;; For variables defined in the C source code the declaration should go here:
2889
2890 (dolist (pair
2891 '((buffer-read-only . booleanp) ;; C source code
2892 (default-directory . stringp) ;; C source code
2893 (fill-column . integerp) ;; C source code
2894 (indent-tabs-mode . booleanp) ;; C source code
2895 (left-margin . integerp) ;; C source code
2896 (no-update-autoloads . booleanp)
2897 (lexical-binding . booleanp) ;; C source code
2898 (tab-width . integerp) ;; C source code
2899 (truncate-lines . booleanp) ;; C source code
2900 (word-wrap . booleanp) ;; C source code
2901 (bidi-display-reordering . booleanp))) ;; C source code
2902 (put (car pair) 'safe-local-variable (cdr pair)))
2903
2904 (put 'bidi-paragraph-direction 'safe-local-variable
2905 (lambda (v) (memq v '(nil right-to-left left-to-right))))
2906
2907 (put 'c-set-style 'safe-local-eval-function t)
2908
2909 (defvar file-local-variables-alist nil
2910 "Alist of file-local variable settings in the current buffer.
2911 Each element in this list has the form (VAR . VALUE), where VAR
2912 is a file-local variable (a symbol) and VALUE is the value
2913 specified. The actual value in the buffer may differ from VALUE,
2914 if it is changed by the major or minor modes, or by the user.")
2915 (make-variable-buffer-local 'file-local-variables-alist)
2916 (put 'file-local-variables-alist 'permanent-local t)
2917
2918 (defvar dir-local-variables-alist nil
2919 "Alist of directory-local variable settings in the current buffer.
2920 Each element in this list has the form (VAR . VALUE), where VAR
2921 is a directory-local variable (a symbol) and VALUE is the value
2922 specified in .dir-locals.el. The actual value in the buffer
2923 may differ from VALUE, if it is changed by the major or minor modes,
2924 or by the user.")
2925 (make-variable-buffer-local 'dir-local-variables-alist)
2926
2927 (defvar before-hack-local-variables-hook nil
2928 "Normal hook run before setting file-local variables.
2929 It is called after checking for unsafe/risky variables and
2930 setting `file-local-variables-alist', and before applying the
2931 variables stored in `file-local-variables-alist'. A hook
2932 function is allowed to change the contents of this alist.
2933
2934 This hook is called only if there is at least one file-local
2935 variable to set.")
2936
2937 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2938 "Get confirmation before setting up local variable values.
2939 ALL-VARS is the list of all variables to be set up.
2940 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2941 RISKY-VARS is the list of those that are marked as risky.
2942 If these settings come from directory-local variables, then
2943 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2944 (unless noninteractive
2945 (let ((name (cond (dir-name)
2946 (buffer-file-name
2947 (file-name-nondirectory buffer-file-name))
2948 ((concat "buffer " (buffer-name)))))
2949 (offer-save (and (eq enable-local-variables t)
2950 unsafe-vars))
2951 (buf (get-buffer-create "*Local Variables*")))
2952 ;; Set up the contents of the *Local Variables* buffer.
2953 (with-current-buffer buf
2954 (erase-buffer)
2955 (cond
2956 (unsafe-vars
2957 (insert "The local variables list in " name
2958 "\ncontains values that may not be safe (*)"
2959 (if risky-vars
2960 ", and variables that are risky (**)."
2961 ".")))
2962 (risky-vars
2963 (insert "The local variables list in " name
2964 "\ncontains variables that are risky (**)."))
2965 (t
2966 (insert "A local variables list is specified in " name ".")))
2967 (insert "\n\nDo you want to apply it? You can type
2968 y -- to apply the local variables list.
2969 n -- to ignore the local variables list.")
2970 (if offer-save
2971 (insert "
2972 ! -- to apply the local variables list, and permanently mark these
2973 values (*) as safe (in the future, they will be set automatically.)\n\n")
2974 (insert "\n\n"))
2975 (dolist (elt all-vars)
2976 (cond ((member elt unsafe-vars)
2977 (insert " * "))
2978 ((member elt risky-vars)
2979 (insert " ** "))
2980 (t
2981 (insert " ")))
2982 (princ (car elt) buf)
2983 (insert " : ")
2984 ;; Make strings with embedded whitespace easier to read.
2985 (let ((print-escape-newlines t))
2986 (prin1 (cdr elt) buf))
2987 (insert "\n"))
2988 (set (make-local-variable 'cursor-type) nil)
2989 (set-buffer-modified-p nil)
2990 (goto-char (point-min)))
2991
2992 ;; Display the buffer and read a choice.
2993 (save-window-excursion
2994 (pop-to-buffer buf)
2995 (let* ((exit-chars '(?y ?n ?\s ?\C-g ?\C-v))
2996 (prompt (format "Please type %s%s: "
2997 (if offer-save "y, n, or !" "y or n")
2998 (if (< (line-number-at-pos (point-max))
2999 (window-body-height))
3000 ""
3001 (push ?\C-v exit-chars)
3002 ", or C-v to scroll")))
3003 char)
3004 (if offer-save (push ?! exit-chars))
3005 (while (null char)
3006 (setq char (read-char-choice prompt exit-chars t))
3007 (when (eq char ?\C-v)
3008 (condition-case nil
3009 (scroll-up)
3010 (error (goto-char (point-min))
3011 (recenter 1)))
3012 (setq char nil)))
3013 (when (and offer-save (= char ?!) unsafe-vars)
3014 (customize-push-and-save 'safe-local-variable-values unsafe-vars))
3015 (prog1 (memq char '(?! ?\s ?y))
3016 (quit-window t)))))))
3017
3018 (defun hack-local-variables-prop-line (&optional mode-only)
3019 "Return local variables specified in the -*- line.
3020 Returns an alist of elements (VAR . VAL), where VAR is a variable
3021 and VAL is the specified value. Ignores any specification for
3022 `mode:' and `coding:' (which should have already been handled
3023 by `set-auto-mode' and `set-auto-coding', respectively).
3024 Return nil if the -*- line is malformed.
3025
3026 If MODE-ONLY is non-nil, just returns the symbol specifying the
3027 mode, if there is one, otherwise nil."
3028 (catch 'malformed-line
3029 (save-excursion
3030 (goto-char (point-min))
3031 (let ((end (set-auto-mode-1))
3032 result)
3033 (cond ((not end)
3034 nil)
3035 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
3036 ;; Simple form: "-*- MODENAME -*-".
3037 (if mode-only
3038 (intern (concat (match-string 1) "-mode"))))
3039 (t
3040 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3041 ;; (last ";" is optional).
3042 ;; If MODE-ONLY, just check for `mode'.
3043 ;; Otherwise, parse the -*- line into the RESULT alist.
3044 (while (and (or (not mode-only)
3045 (not result))
3046 (< (point) end))
3047 (unless (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
3048 (message "Malformed mode-line")
3049 (throw 'malformed-line nil))
3050 (goto-char (match-end 0))
3051 ;; There used to be a downcase here,
3052 ;; but the manual didn't say so,
3053 ;; and people want to set var names that aren't all lc.
3054 (let* ((key (intern (match-string 1)))
3055 (val (save-restriction
3056 (narrow-to-region (point) end)
3057 (let ((read-circle nil))
3058 (read (current-buffer)))))
3059 ;; It is traditional to ignore
3060 ;; case when checking for `mode' in set-auto-mode,
3061 ;; so we must do that here as well.
3062 ;; That is inconsistent, but we're stuck with it.
3063 ;; The same can be said for `coding' in set-auto-coding.
3064 (keyname (downcase (symbol-name key))))
3065 (if mode-only
3066 (and (equal keyname "mode")
3067 (setq result
3068 (intern (concat (downcase (symbol-name val))
3069 "-mode"))))
3070 (or (equal keyname "coding")
3071 (condition-case nil
3072 (push (cons (cond ((eq key 'eval) 'eval)
3073 ;; Downcase "Mode:".
3074 ((equal keyname "mode") 'mode)
3075 (t (indirect-variable key)))
3076 val) result)
3077 (error nil))))
3078 (skip-chars-forward " \t;")))
3079 result))))))
3080
3081 (defun hack-local-variables-filter (variables dir-name)
3082 "Filter local variable settings, querying the user if necessary.
3083 VARIABLES is the alist of variable-value settings. This alist is
3084 filtered based on the values of `ignored-local-variables',
3085 `enable-local-eval', `enable-local-variables', and (if necessary)
3086 user interaction. The results are added to
3087 `file-local-variables-alist', without applying them.
3088 If these settings come from directory-local variables, then
3089 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3090 ;; Find those variables that we may want to save to
3091 ;; `safe-local-variable-values'.
3092 (let (all-vars risky-vars unsafe-vars)
3093 (dolist (elt variables)
3094 (let ((var (car elt))
3095 (val (cdr elt)))
3096 (cond ((memq var ignored-local-variables)
3097 ;; Ignore any variable in `ignored-local-variables'.
3098 nil)
3099 ;; Obey `enable-local-eval'.
3100 ((eq var 'eval)
3101 (when enable-local-eval
3102 (let ((safe (or (hack-one-local-variable-eval-safep val)
3103 ;; In case previously marked safe (bug#5636).
3104 (safe-local-variable-p var val))))
3105 ;; If not safe and e-l-v = :safe, ignore totally.
3106 (when (or safe (not (eq enable-local-variables :safe)))
3107 (push elt all-vars)
3108 (or (eq enable-local-eval t)
3109 safe
3110 (push elt unsafe-vars))))))
3111 ;; Ignore duplicates (except `mode') in the present list.
3112 ((and (assq var all-vars) (not (eq var 'mode))) nil)
3113 ;; Accept known-safe variables.
3114 ((or (memq var '(mode unibyte coding))
3115 (safe-local-variable-p var val))
3116 (push elt all-vars))
3117 ;; The variable is either risky or unsafe:
3118 ((not (eq enable-local-variables :safe))
3119 (push elt all-vars)
3120 (if (risky-local-variable-p var val)
3121 (push elt risky-vars)
3122 (push elt unsafe-vars))))))
3123 (and all-vars
3124 ;; Query, unless all vars are safe or user wants no querying.
3125 (or (and (eq enable-local-variables t)
3126 (null unsafe-vars)
3127 (null risky-vars))
3128 (memq enable-local-variables '(:all :safe))
3129 (hack-local-variables-confirm all-vars unsafe-vars
3130 risky-vars dir-name))
3131 (dolist (elt all-vars)
3132 (unless (memq (car elt) '(eval mode))
3133 (unless dir-name
3134 (setq dir-local-variables-alist
3135 (assq-delete-all (car elt) dir-local-variables-alist)))
3136 (setq file-local-variables-alist
3137 (assq-delete-all (car elt) file-local-variables-alist)))
3138 (push elt file-local-variables-alist)))))
3139
3140 (defun hack-local-variables (&optional mode-only)
3141 "Parse and put into effect this buffer's local variables spec.
3142 Uses `hack-local-variables-apply' to apply the variables.
3143
3144 If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
3145 is specified, and return the corresponding mode symbol, or nil.
3146 In this case, we try to ignore minor-modes, and only return a
3147 major-mode.
3148
3149 If `enable-local-variables' or `local-enable-local-variables' is nil,
3150 this function does nothing. If `inhibit-local-variables-regexps'
3151 applies to the file in question, the file is not scanned for
3152 local variables, but directory-local variables may still be applied."
3153 ;; We don't let inhibit-local-variables-p influence the value of
3154 ;; enable-local-variables, because then it would affect dir-local
3155 ;; variables. We don't want to search eg tar files for file local
3156 ;; variable sections, but there is no reason dir-locals cannot apply
3157 ;; to them. The real meaning of inhibit-local-variables-p is "do
3158 ;; not scan this file for local variables".
3159 (let ((enable-local-variables
3160 (and local-enable-local-variables enable-local-variables))
3161 result)
3162 (unless mode-only
3163 (setq file-local-variables-alist nil)
3164 (report-errors "Directory-local variables error: %s"
3165 ;; Note this is a no-op if enable-local-variables is nil.
3166 (hack-dir-local-variables)))
3167 ;; This entire function is basically a no-op if enable-local-variables
3168 ;; is nil. All it does is set file-local-variables-alist to nil.
3169 (when enable-local-variables
3170 ;; This part used to ignore enable-local-variables when mode-only
3171 ;; was non-nil. That was inappropriate, eg consider the
3172 ;; (artificial) example of:
3173 ;; (setq local-enable-local-variables nil)
3174 ;; Open a file foo.txt that contains "mode: sh".
3175 ;; It correctly opens in text-mode.
3176 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3177 (unless (or (inhibit-local-variables-p)
3178 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3179 ;; mode, then we're done, and have no need to scan further.
3180 (and (setq result (hack-local-variables-prop-line mode-only))
3181 mode-only))
3182 ;; Look for "Local variables:" line in last page.
3183 (save-excursion
3184 (goto-char (point-max))
3185 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3186 'move)
3187 (when (let ((case-fold-search t))
3188 (search-forward "Local Variables:" nil t))
3189 (skip-chars-forward " \t")
3190 ;; suffix is what comes after "local variables:" in its line.
3191 ;; prefix is what comes before "local variables:" in its line.
3192 (let ((suffix
3193 (concat
3194 (regexp-quote (buffer-substring (point)
3195 (line-end-position)))
3196 "$"))
3197 (prefix
3198 (concat "^" (regexp-quote
3199 (buffer-substring (line-beginning-position)
3200 (match-beginning 0)))))
3201 beg)
3202
3203 (forward-line 1)
3204 (let ((startpos (point))
3205 endpos
3206 (thisbuf (current-buffer)))
3207 (save-excursion
3208 (unless (let ((case-fold-search t))
3209 (re-search-forward
3210 (concat prefix "[ \t]*End:[ \t]*" suffix)
3211 nil t))
3212 ;; This used to be an error, but really all it means is
3213 ;; that this may simply not be a local-variables section,
3214 ;; so just ignore it.
3215 (message "Local variables list is not properly terminated"))
3216 (beginning-of-line)
3217 (setq endpos (point)))
3218
3219 (with-temp-buffer
3220 (insert-buffer-substring thisbuf startpos endpos)
3221 (goto-char (point-min))
3222 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3223 (while (not (eobp))
3224 ;; Discard the prefix.
3225 (if (looking-at prefix)
3226 (delete-region (point) (match-end 0))
3227 (error "Local variables entry is missing the prefix"))
3228 (end-of-line)
3229 ;; Discard the suffix.
3230 (if (looking-back suffix)
3231 (delete-region (match-beginning 0) (point))
3232 (error "Local variables entry is missing the suffix"))
3233 (forward-line 1))
3234 (goto-char (point-min))
3235
3236 (while (and (not (eobp))
3237 (or (not mode-only)
3238 (not result)))
3239 ;; Find the variable name; strip whitespace.
3240 (skip-chars-forward " \t")
3241 (setq beg (point))
3242 (skip-chars-forward "^:\n")
3243 (if (eolp) (error "Missing colon in local variables entry"))
3244 (skip-chars-backward " \t")
3245 (let* ((str (buffer-substring beg (point)))
3246 (var (let ((read-circle nil))
3247 (read str)))
3248 val val2)
3249 (and (equal (downcase (symbol-name var)) "mode")
3250 (setq var 'mode))
3251 ;; Read the variable value.
3252 (skip-chars-forward "^:")
3253 (forward-char 1)
3254 (let ((read-circle nil))
3255 (setq val (read (current-buffer))))
3256 (if mode-only
3257 (and (eq var 'mode)
3258 ;; Specifying minor-modes via mode: is
3259 ;; deprecated, but try to reject them anyway.
3260 (not (string-match
3261 "-minor\\'"
3262 (setq val2 (downcase (symbol-name val)))))
3263 (setq result (intern (concat val2 "-mode"))))
3264 (unless (eq var 'coding)
3265 (condition-case nil
3266 (push (cons (if (eq var 'eval)
3267 'eval
3268 (indirect-variable var))
3269 val) result)
3270 (error nil)))))
3271 (forward-line 1))))))))
3272 ;; Now we've read all the local variables.
3273 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3274 (if mode-only result
3275 ;; Otherwise, set the variables.
3276 (hack-local-variables-filter result nil)
3277 (hack-local-variables-apply)))))
3278
3279 (defun hack-local-variables-apply ()
3280 "Apply the elements of `file-local-variables-alist'.
3281 If there are any elements, runs `before-hack-local-variables-hook',
3282 then calls `hack-one-local-variable' to apply the alist elements one by one.
3283 Finishes by running `hack-local-variables-hook', regardless of whether
3284 the alist is empty or not.
3285
3286 Note that this function ignores a `mode' entry if it specifies the same
3287 major mode as the buffer already has."
3288 (when file-local-variables-alist
3289 ;; Any 'evals must run in the Right sequence.
3290 (setq file-local-variables-alist
3291 (nreverse file-local-variables-alist))
3292 (run-hooks 'before-hack-local-variables-hook)
3293 (dolist (elt file-local-variables-alist)
3294 (hack-one-local-variable (car elt) (cdr elt))))
3295 (run-hooks 'hack-local-variables-hook))
3296
3297 (defun safe-local-variable-p (sym val)
3298 "Non-nil if SYM is safe as a file-local variable with value VAL.
3299 It is safe if any of these conditions are met:
3300
3301 * There is a matching entry (SYM . VAL) in the
3302 `safe-local-variable-values' user option.
3303
3304 * The `safe-local-variable' property of SYM is a function that
3305 evaluates to a non-nil value with VAL as an argument."
3306 (or (member (cons sym val) safe-local-variable-values)
3307 (let ((safep (get sym 'safe-local-variable)))
3308 (and (functionp safep)
3309 ;; If the function signals an error, that means it
3310 ;; can't assure us that the value is safe.
3311 (with-demoted-errors (funcall safep val))))))
3312
3313 (defun risky-local-variable-p (sym &optional _ignored)
3314 "Non-nil if SYM could be dangerous as a file-local variable.
3315 It is dangerous if either of these conditions are met:
3316
3317 * Its `risky-local-variable' property is non-nil.
3318
3319 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3320 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3321 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3322 \"map-alist\", or \"bindat-spec\"."
3323 ;; If this is an alias, check the base name.
3324 (condition-case nil
3325 (setq sym (indirect-variable sym))
3326 (error nil))
3327 (or (get sym 'risky-local-variable)
3328 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3329 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3330 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3331 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3332
3333 (defun hack-one-local-variable-quotep (exp)
3334 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3335
3336 (defun hack-one-local-variable-constantp (exp)
3337 (or (and (not (symbolp exp)) (not (consp exp)))
3338 (memq exp '(t nil))
3339 (keywordp exp)
3340 (hack-one-local-variable-quotep exp)))
3341
3342 (defun hack-one-local-variable-eval-safep (exp)
3343 "Return t if it is safe to eval EXP when it is found in a file."
3344 (or (not (consp exp))
3345 ;; Detect certain `put' expressions.
3346 (and (eq (car exp) 'put)
3347 (hack-one-local-variable-quotep (nth 1 exp))
3348 (hack-one-local-variable-quotep (nth 2 exp))
3349 (let ((prop (nth 1 (nth 2 exp)))
3350 (val (nth 3 exp)))
3351 (cond ((memq prop '(lisp-indent-hook
3352 lisp-indent-function
3353 scheme-indent-function))
3354 ;; Only allow safe values (not functions).
3355 (or (numberp val)
3356 (and (hack-one-local-variable-quotep val)
3357 (eq (nth 1 val) 'defun))))
3358 ((eq prop 'edebug-form-spec)
3359 ;; Only allow indirect form specs.
3360 ;; During bootstrapping, edebug-basic-spec might not be
3361 ;; defined yet.
3362 (and (fboundp 'edebug-basic-spec)
3363 (hack-one-local-variable-quotep val)
3364 (edebug-basic-spec (nth 1 val)))))))
3365 ;; Allow expressions that the user requested.
3366 (member exp safe-local-eval-forms)
3367 ;; Certain functions can be allowed with safe arguments
3368 ;; or can specify verification functions to try.
3369 (and (symbolp (car exp))
3370 ;; Allow (minor)-modes calls with no arguments.
3371 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3372 (or (and (member (cdr exp) '(nil (1) (0) (-1)))
3373 (string-match "-mode\\'" (symbol-name (car exp))))
3374 (let ((prop (get (car exp) 'safe-local-eval-function)))
3375 (cond ((eq prop t)
3376 (let ((ok t))
3377 (dolist (arg (cdr exp))
3378 (unless (hack-one-local-variable-constantp arg)
3379 (setq ok nil)))
3380 ok))
3381 ((functionp prop)
3382 (funcall prop exp))
3383 ((listp prop)
3384 (let ((ok nil))
3385 (dolist (function prop)
3386 (if (funcall function exp)
3387 (setq ok t)))
3388 ok))))))))
3389
3390 (defun hack-one-local-variable (var val)
3391 "Set local variable VAR with value VAL.
3392 If VAR is `mode', call `VAL-mode' as a function unless it's
3393 already the major mode."
3394 (cond ((eq var 'mode)
3395 (let ((mode (intern (concat (downcase (symbol-name val))
3396 "-mode"))))
3397 (unless (eq (indirect-function mode)
3398 (indirect-function major-mode))
3399 (if (memq mode minor-mode-list)
3400 ;; A minor mode must be passed an argument.
3401 ;; Otherwise, if the user enables the minor mode in a
3402 ;; major mode hook, this would toggle it off.
3403 (funcall mode 1)
3404 (funcall mode)))))
3405 ((eq var 'eval)
3406 (save-excursion (eval val)))
3407 (t
3408 ;; Make sure the string has no text properties.
3409 ;; Some text properties can get evaluated in various ways,
3410 ;; so it is risky to put them on with a local variable list.
3411 (if (stringp val)
3412 (set-text-properties 0 (length val) nil val))
3413 (set (make-local-variable var) val))))
3414 \f
3415 ;;; Handling directory-local variables, aka project settings.
3416
3417 (defvar dir-locals-class-alist '()
3418 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3419
3420 (defvar dir-locals-directory-cache '()
3421 "List of cached directory roots for directory-local variable classes.
3422 Each element in this list has the form (DIR CLASS MTIME).
3423 DIR is the name of the directory.
3424 CLASS is the name of a variable class (a symbol).
3425 MTIME is the recorded modification time of the directory-local
3426 variables file associated with this entry. This time is a list
3427 of two integers (the same format as `file-attributes'), and is
3428 used to test whether the cache entry is still valid.
3429 Alternatively, MTIME can be nil, which means the entry is always
3430 considered valid.")
3431
3432 (defsubst dir-locals-get-class-variables (class)
3433 "Return the variable list for CLASS."
3434 (cdr (assq class dir-locals-class-alist)))
3435
3436 (defun dir-locals-collect-mode-variables (mode-variables variables)
3437 "Collect directory-local variables from MODE-VARIABLES.
3438 VARIABLES is the initial list of variables.
3439 Returns the new list."
3440 (dolist (pair mode-variables variables)
3441 (let* ((variable (car pair))
3442 (value (cdr pair))
3443 (slot (assq variable variables)))
3444 ;; If variables are specified more than once, only use the last. (Why?)
3445 ;; The pseudo-variables mode and eval are different (bug#3430).
3446 (if (and slot (not (memq variable '(mode eval))))
3447 (setcdr slot value)
3448 ;; Need a new cons in case we setcdr later.
3449 (push (cons variable value) variables)))))
3450
3451 (defun dir-locals-collect-variables (class-variables root variables)
3452 "Collect entries from CLASS-VARIABLES into VARIABLES.
3453 ROOT is the root directory of the project.
3454 Return the new variables list."
3455 (let* ((file-name (buffer-file-name))
3456 (sub-file-name (if file-name
3457 ;; FIXME: Why not use file-relative-name?
3458 (substring file-name (length root)))))
3459 (condition-case err
3460 (dolist (entry class-variables variables)
3461 (let ((key (car entry)))
3462 (cond
3463 ((stringp key)
3464 ;; Don't include this in the previous condition, because we
3465 ;; want to filter all strings before the next condition.
3466 (when (and sub-file-name
3467 (>= (length sub-file-name) (length key))
3468 (string-prefix-p key sub-file-name))
3469 (setq variables (dir-locals-collect-variables
3470 (cdr entry) root variables))))
3471 ((or (not key)
3472 (derived-mode-p key))
3473 (let* ((alist (cdr entry))
3474 (subdirs (assq 'subdirs alist)))
3475 (if (or (not subdirs)
3476 (progn
3477 (setq alist (delq subdirs alist))
3478 (cdr-safe subdirs))
3479 ;; TODO someone might want to extend this to allow
3480 ;; integer values for subdir, where N means
3481 ;; variables apply to this directory and N levels
3482 ;; below it (0 == nil).
3483 (equal root default-directory))
3484 (setq variables (dir-locals-collect-mode-variables
3485 alist variables))))))))
3486 (error
3487 ;; The file's content might be invalid (e.g. have a merge conflict), but
3488 ;; that shouldn't prevent the user from opening the file.
3489 (message ".dir-locals error: %s" (error-message-string err))
3490 nil))))
3491
3492 (defun dir-locals-set-directory-class (directory class &optional mtime)
3493 "Declare that the DIRECTORY root is an instance of CLASS.
3494 DIRECTORY is the name of a directory, a string.
3495 CLASS is the name of a project class, a symbol.
3496 MTIME is either the modification time of the directory-local
3497 variables file that defined this class, or nil.
3498
3499 When a file beneath DIRECTORY is visited, the mode-specific
3500 variables from CLASS are applied to the buffer. The variables
3501 for a class are defined using `dir-locals-set-class-variables'."
3502 (setq directory (file-name-as-directory (expand-file-name directory)))
3503 (unless (assq class dir-locals-class-alist)
3504 (error "No such class `%s'" (symbol-name class)))
3505 (push (list directory class mtime) dir-locals-directory-cache))
3506
3507 (defun dir-locals-set-class-variables (class variables)
3508 "Map the type CLASS to a list of variable settings.
3509 CLASS is the project class, a symbol. VARIABLES is a list
3510 that declares directory-local variables for the class.
3511 An element in VARIABLES is either of the form:
3512 (MAJOR-MODE . ALIST)
3513 or
3514 (DIRECTORY . LIST)
3515
3516 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3517 whose elements are of the form (VARIABLE . VALUE).
3518
3519 In the second form, DIRECTORY is a directory name (a string), and
3520 LIST is a list of the form accepted by the function.
3521
3522 When a file is visited, the file's class is found. A directory
3523 may be assigned a class using `dir-locals-set-directory-class'.
3524 Then variables are set in the file's buffer according to the
3525 VARIABLES list of the class. The list is processed in order.
3526
3527 * If the element is of the form (MAJOR-MODE . ALIST), and the
3528 buffer's major mode is derived from MAJOR-MODE (as determined
3529 by `derived-mode-p'), then all the variables in ALIST are
3530 applied. A MAJOR-MODE of nil may be used to match any buffer.
3531 `make-local-variable' is called for each variable before it is
3532 set.
3533
3534 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3535 is an initial substring of the file's directory, then LIST is
3536 applied by recursively following these rules."
3537 (let ((elt (assq class dir-locals-class-alist)))
3538 (if elt
3539 (setcdr elt variables)
3540 (push (cons class variables) dir-locals-class-alist))))
3541
3542 (defconst dir-locals-file ".dir-locals.el"
3543 "File that contains directory-local variables.
3544 It has to be constant to enforce uniform values
3545 across different environments and users.")
3546
3547 (defun dir-locals-find-file (file)
3548 "Find the directory-local variables for FILE.
3549 This searches upward in the directory tree from FILE.
3550 It stops at the first directory that has been registered in
3551 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3552 If it finds an entry in the cache, it checks that it is valid.
3553 A cache entry with no modification time element (normally, one that
3554 has been assigned directly using `dir-locals-set-directory-class', not
3555 set from a file) is always valid.
3556 A cache entry based on a `dir-locals-file' is valid if the modification
3557 time stored in the cache matches the current file modification time.
3558 If not, the cache entry is cleared so that the file will be re-read.
3559
3560 This function returns either nil (no directory local variables found),
3561 or the matching entry from `dir-locals-directory-cache' (a list),
3562 or the full path to the `dir-locals-file' (a string) in the case
3563 of no valid cache entry."
3564 (setq file (expand-file-name file))
3565 (let* ((dir-locals-file-name
3566 (if (eq system-type 'ms-dos)
3567 (dosified-file-name dir-locals-file)
3568 dir-locals-file))
3569 (locals-file (locate-dominating-file file dir-locals-file-name))
3570 (dir-elt nil))
3571 ;; `locate-dominating-file' may have abbreviated the name.
3572 (and locals-file
3573 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3574 ;; Let dir-locals-read-from-file inform us via demoted-errors
3575 ;; about unreadable files, etc.
3576 ;; Maybe we'd want to keep searching though - that is
3577 ;; a locate-dominating-file issue.
3578 ;;; (or (not (file-readable-p locals-file))
3579 ;;; (not (file-regular-p locals-file)))
3580 ;;; (setq locals-file nil))
3581 ;; Find the best cached value in `dir-locals-directory-cache'.
3582 (dolist (elt dir-locals-directory-cache)
3583 (when (and (eq t (compare-strings file nil (length (car elt))
3584 (car elt) nil nil
3585 (memq system-type
3586 '(windows-nt cygwin ms-dos))))
3587 (> (length (car elt)) (length (car dir-elt))))
3588 (setq dir-elt elt)))
3589 (if (and dir-elt
3590 (or (null locals-file)
3591 (<= (length (file-name-directory locals-file))
3592 (length (car dir-elt)))))
3593 ;; Found a potential cache entry. Check validity.
3594 ;; A cache entry with no MTIME is assumed to always be valid
3595 ;; (ie, set directly, not from a dir-locals file).
3596 ;; Note, we don't bother to check that there is a matching class
3597 ;; element in dir-locals-class-alist, since that's done by
3598 ;; dir-locals-set-directory-class.
3599 (if (or (null (nth 2 dir-elt))
3600 (let ((cached-file (expand-file-name dir-locals-file-name
3601 (car dir-elt))))
3602 (and (file-readable-p cached-file)
3603 (equal (nth 2 dir-elt)
3604 (nth 5 (file-attributes cached-file))))))
3605 ;; This cache entry is OK.
3606 dir-elt
3607 ;; This cache entry is invalid; clear it.
3608 (setq dir-locals-directory-cache
3609 (delq dir-elt dir-locals-directory-cache))
3610 ;; Return the first existing dir-locals file. Might be the same
3611 ;; as dir-elt's, might not (eg latter might have been deleted).
3612 locals-file)
3613 ;; No cache entry.
3614 locals-file)))
3615
3616 (defun dir-locals-read-from-file (file)
3617 "Load a variables FILE and register a new class and instance.
3618 FILE is the name of the file holding the variables to apply.
3619 The new class name is the same as the directory in which FILE
3620 is found. Returns the new class name."
3621 (with-temp-buffer
3622 ;; This is with-demoted-errors, but we want to mention dir-locals
3623 ;; in any error message.
3624 (let (err)
3625 (condition-case err
3626 (progn
3627 (insert-file-contents file)
3628 (let* ((dir-name (file-name-directory file))
3629 (class-name (intern dir-name))
3630 (variables (let ((read-circle nil))
3631 (read (current-buffer)))))
3632 (dir-locals-set-class-variables class-name variables)
3633 (dir-locals-set-directory-class dir-name class-name
3634 (nth 5 (file-attributes file)))
3635 class-name))
3636 (error (message "Error reading dir-locals: %S" err) nil)))))
3637
3638 (defcustom enable-remote-dir-locals nil
3639 "Non-nil means dir-local variables will be applied to remote files."
3640 :version "24.3"
3641 :type 'boolean
3642 :group 'find-file)
3643
3644 (defun hack-dir-local-variables ()
3645 "Read per-directory local variables for the current buffer.
3646 Store the directory-local variables in `dir-local-variables-alist'
3647 and `file-local-variables-alist', without applying them."
3648 (when (and enable-local-variables
3649 (or enable-remote-dir-locals
3650 (not (file-remote-p (or (buffer-file-name)
3651 default-directory)))))
3652 ;; Find the variables file.
3653 (let ((variables-file (dir-locals-find-file
3654 (or (buffer-file-name) default-directory)))
3655 (class nil)
3656 (dir-name nil))
3657 (cond
3658 ((stringp variables-file)
3659 (setq dir-name (file-name-directory variables-file)
3660 class (dir-locals-read-from-file variables-file)))
3661 ((consp variables-file)
3662 (setq dir-name (nth 0 variables-file))
3663 (setq class (nth 1 variables-file))))
3664 (when class
3665 (let ((variables
3666 (dir-locals-collect-variables
3667 (dir-locals-get-class-variables class) dir-name nil)))
3668 (when variables
3669 (dolist (elt variables)
3670 (unless (memq (car elt) '(eval mode))
3671 (setq dir-local-variables-alist
3672 (assq-delete-all (car elt) dir-local-variables-alist)))
3673 (push elt dir-local-variables-alist))
3674 (hack-local-variables-filter variables dir-name)))))))
3675
3676 (defun hack-dir-local-variables-non-file-buffer ()
3677 "Apply directory-local variables to a non-file buffer.
3678 For non-file buffers, such as Dired buffers, directory-local
3679 variables are looked for in `default-directory' and its parent
3680 directories."
3681 (hack-dir-local-variables)
3682 (hack-local-variables-apply))
3683
3684 \f
3685 (defcustom change-major-mode-with-file-name t
3686 "Non-nil means \\[write-file] should set the major mode from the file name.
3687 However, the mode will not be changed if
3688 \(1) a local variables list or the `-*-' line specifies a major mode, or
3689 \(2) the current major mode is a \"special\" mode,
3690 \ not suitable for ordinary files, or
3691 \(3) the new file name does not particularly specify any mode."
3692 :type 'boolean
3693 :group 'editing-basics)
3694
3695 (defun set-visited-file-name (filename &optional no-query along-with-file)
3696 "Change name of file visited in current buffer to FILENAME.
3697 This also renames the buffer to correspond to the new file.
3698 The next time the buffer is saved it will go in the newly specified file.
3699 FILENAME nil or an empty string means mark buffer as not visiting any file.
3700 Remember to delete the initial contents of the minibuffer
3701 if you wish to pass an empty string as the argument.
3702
3703 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3704 confirmation in the case where another buffer is already visiting FILENAME.
3705
3706 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3707 the old visited file has been renamed to the new name FILENAME."
3708 (interactive "FSet visited file name: ")
3709 (if (buffer-base-buffer)
3710 (error "An indirect buffer cannot visit a file"))
3711 (let (truename old-try-locals)
3712 (if filename
3713 (setq filename
3714 (if (string-equal filename "")
3715 nil
3716 (expand-file-name filename))))
3717 (if filename
3718 (progn
3719 (setq truename (file-truename filename))
3720 (if find-file-visit-truename
3721 (setq filename truename))))
3722 (if filename
3723 (let ((new-name (file-name-nondirectory filename)))
3724 (if (string= new-name "")
3725 (error "Empty file name"))))
3726 (let ((buffer (and filename (find-buffer-visiting filename))))
3727 (and buffer (not (eq buffer (current-buffer)))
3728 (not no-query)
3729 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3730 filename)))
3731 (error "Aborted")))
3732 (or (equal filename buffer-file-name)
3733 (progn
3734 (and filename (lock-buffer filename))
3735 (unlock-buffer)))
3736 (setq old-try-locals (not (inhibit-local-variables-p))
3737 buffer-file-name filename)
3738 (if filename ; make buffer name reflect filename.
3739 (let ((new-name (file-name-nondirectory buffer-file-name)))
3740 (setq default-directory (file-name-directory buffer-file-name))
3741 ;; If new-name == old-name, renaming would add a spurious <2>
3742 ;; and it's considered as a feature in rename-buffer.
3743 (or (string= new-name (buffer-name))
3744 (rename-buffer new-name t))))
3745 (setq buffer-backed-up nil)
3746 (or along-with-file
3747 (clear-visited-file-modtime))
3748 ;; Abbreviate the file names of the buffer.
3749 (if truename
3750 (progn
3751 (setq buffer-file-truename (abbreviate-file-name truename))
3752 (if find-file-visit-truename
3753 (setq buffer-file-name truename))))
3754 (setq buffer-file-number
3755 (if filename
3756 (nthcdr 10 (file-attributes buffer-file-name))
3757 nil))
3758 ;; write-file-functions is normally used for things like ftp-find-file
3759 ;; that visit things that are not local files as if they were files.
3760 ;; Changing to visit an ordinary local file instead should flush the hook.
3761 (kill-local-variable 'write-file-functions)
3762 (kill-local-variable 'local-write-file-hooks)
3763 (kill-local-variable 'revert-buffer-function)
3764 (kill-local-variable 'backup-inhibited)
3765 ;; If buffer was read-only because of version control,
3766 ;; that reason is gone now, so make it writable.
3767 (if vc-mode
3768 (setq buffer-read-only nil))
3769 (kill-local-variable 'vc-mode)
3770 ;; Turn off backup files for certain file names.
3771 ;; Since this is a permanent local, the major mode won't eliminate it.
3772 (and buffer-file-name
3773 backup-enable-predicate
3774 (not (funcall backup-enable-predicate buffer-file-name))
3775 (progn
3776 (make-local-variable 'backup-inhibited)
3777 (setq backup-inhibited t)))
3778 (let ((oauto buffer-auto-save-file-name))
3779 ;; If auto-save was not already on, turn it on if appropriate.
3780 (if (not buffer-auto-save-file-name)
3781 (and buffer-file-name auto-save-default
3782 (auto-save-mode t))
3783 ;; If auto save is on, start using a new name.
3784 ;; We deliberately don't rename or delete the old auto save
3785 ;; for the old visited file name. This is because perhaps
3786 ;; the user wants to save the new state and then compare with the
3787 ;; previous state from the auto save file.
3788 (setq buffer-auto-save-file-name
3789 (make-auto-save-file-name)))
3790 ;; Rename the old auto save file if any.
3791 (and oauto buffer-auto-save-file-name
3792 (file-exists-p oauto)
3793 (rename-file oauto buffer-auto-save-file-name t)))
3794 (and buffer-file-name
3795 (not along-with-file)
3796 (set-buffer-modified-p t))
3797 ;; Update the major mode, if the file name determines it.
3798 (condition-case nil
3799 ;; Don't change the mode if it is special.
3800 (or (not change-major-mode-with-file-name)
3801 (get major-mode 'mode-class)
3802 ;; Don't change the mode if the local variable list specifies it.
3803 ;; The file name can influence whether the local variables apply.
3804 (and old-try-locals
3805 ;; h-l-v also checks it, but might as well be explicit.
3806 (not (inhibit-local-variables-p))
3807 (hack-local-variables t))
3808 ;; TODO consider making normal-mode handle this case.
3809 (let ((old major-mode))
3810 (set-auto-mode t)
3811 (or (eq old major-mode)
3812 (hack-local-variables))))
3813 (error nil))))
3814
3815 (defun write-file (filename &optional confirm)
3816 "Write current buffer into file FILENAME.
3817 This makes the buffer visit that file, and marks it as not modified.
3818
3819 If you specify just a directory name as FILENAME, that means to use
3820 the default file name but in that directory. You can also yank
3821 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3822
3823 If the buffer is not already visiting a file, the default file name
3824 for the output file is the buffer name.
3825
3826 If optional second arg CONFIRM is non-nil, this function
3827 asks for confirmation before overwriting an existing file.
3828 Interactively, confirmation is required unless you supply a prefix argument."
3829 ;; (interactive "FWrite file: ")
3830 (interactive
3831 (list (if buffer-file-name
3832 (read-file-name "Write file: "
3833 nil nil nil nil)
3834 (read-file-name "Write file: " default-directory
3835 (expand-file-name
3836 (file-name-nondirectory (buffer-name))
3837 default-directory)
3838 nil nil))
3839 (not current-prefix-arg)))
3840 (or (null filename) (string-equal filename "")
3841 (progn
3842 ;; If arg is just a directory,
3843 ;; use the default file name, but in that directory.
3844 (if (file-directory-p filename)
3845 (setq filename (concat (file-name-as-directory filename)
3846 (file-name-nondirectory
3847 (or buffer-file-name (buffer-name))))))
3848 (and confirm
3849 (file-exists-p filename)
3850 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3851 (error "Canceled")))
3852 (set-visited-file-name filename (not confirm))))
3853 (set-buffer-modified-p t)
3854 ;; Make buffer writable if file is writable.
3855 (and buffer-file-name
3856 (file-writable-p buffer-file-name)
3857 (setq buffer-read-only nil))
3858 (save-buffer)
3859 ;; It's likely that the VC status at the new location is different from
3860 ;; the one at the old location.
3861 (vc-find-file-hook))
3862 \f
3863 (defun backup-buffer ()
3864 "Make a backup of the disk file visited by the current buffer, if appropriate.
3865 This is normally done before saving the buffer the first time.
3866
3867 A backup may be done by renaming or by copying; see documentation of
3868 variable `make-backup-files'. If it's done by renaming, then the file is
3869 no longer accessible under its old name.
3870
3871 The value is non-nil after a backup was made by renaming.
3872 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3873 MODES is the result of `file-modes' on the original
3874 file; this means that the caller, after saving the buffer, should change
3875 the modes of the new file to agree with the old modes.
3876 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3877 file; this means that the caller, after saving the buffer, should change
3878 the SELinux context of the new file to agree with the old context.
3879 BACKUPNAME is the backup file name, which is the old file renamed."
3880 (if (and make-backup-files (not backup-inhibited)
3881 (not buffer-backed-up)
3882 (file-exists-p buffer-file-name)
3883 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3884 '(?- ?l)))
3885 (let ((real-file-name buffer-file-name)
3886 backup-info backupname targets setmodes)
3887 ;; If specified name is a symbolic link, chase it to the target.
3888 ;; Thus we make the backups in the directory where the real file is.
3889 (setq real-file-name (file-chase-links real-file-name))
3890 (setq backup-info (find-backup-file-name real-file-name)
3891 backupname (car backup-info)
3892 targets (cdr backup-info))
3893 ;; (if (file-directory-p buffer-file-name)
3894 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3895 (if backup-info
3896 (condition-case ()
3897 (let ((delete-old-versions
3898 ;; If have old versions to maybe delete,
3899 ;; ask the user to confirm now, before doing anything.
3900 ;; But don't actually delete til later.
3901 (and targets
3902 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3903 (or delete-old-versions
3904 (y-or-n-p (format "Delete excess backup versions of %s? "
3905 real-file-name)))))
3906 (modes (file-modes buffer-file-name))
3907 (context (file-selinux-context buffer-file-name)))
3908 ;; Actually write the back up file.
3909 (condition-case ()
3910 (if (or file-precious-flag
3911 ; (file-symlink-p buffer-file-name)
3912 backup-by-copying
3913 ;; Don't rename a suid or sgid file.
3914 (and modes (< 0 (logand modes #o6000)))
3915 (not (file-writable-p (file-name-directory real-file-name)))
3916 (and backup-by-copying-when-linked
3917 (> (file-nlinks real-file-name) 1))
3918 (and (or backup-by-copying-when-mismatch
3919 (integerp backup-by-copying-when-privileged-mismatch))
3920 (let ((attr (file-attributes real-file-name)))
3921 (and (or backup-by-copying-when-mismatch
3922 (and (integerp (nth 2 attr))
3923 (integerp backup-by-copying-when-privileged-mismatch)
3924 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3925 (or (nth 9 attr)
3926 (not (file-ownership-preserved-p real-file-name)))))))
3927 (backup-buffer-copy real-file-name backupname modes context)
3928 ;; rename-file should delete old backup.
3929 (rename-file real-file-name backupname t)
3930 (setq setmodes (list modes context backupname)))
3931 (file-error
3932 ;; If trouble writing the backup, write it in
3933 ;; .emacs.d/%backup%.
3934 (setq backupname (locate-user-emacs-file "%backup%~"))
3935 (message "Cannot write backup file; backing up in %s"
3936 backupname)
3937 (sleep-for 1)
3938 (backup-buffer-copy real-file-name backupname modes context)))
3939 (setq buffer-backed-up t)
3940 ;; Now delete the old versions, if desired.
3941 (if delete-old-versions
3942 (while targets
3943 (condition-case ()
3944 (delete-file (car targets))
3945 (file-error nil))
3946 (setq targets (cdr targets))))
3947 setmodes)
3948 (file-error nil))))))
3949
3950 (defun backup-buffer-copy (from-name to-name modes context)
3951 (let ((umask (default-file-modes)))
3952 (unwind-protect
3953 (progn
3954 ;; Create temp files with strict access rights. It's easy to
3955 ;; loosen them later, whereas it's impossible to close the
3956 ;; time-window of loose permissions otherwise.
3957 (set-default-file-modes ?\700)
3958 (when (condition-case nil
3959 ;; Try to overwrite old backup first.
3960 (copy-file from-name to-name t t t)
3961 (error t))
3962 (while (condition-case nil
3963 (progn
3964 (when (file-exists-p to-name)
3965 (delete-file to-name))
3966 (copy-file from-name to-name nil t t)
3967 nil)
3968 (file-already-exists t))
3969 ;; The file was somehow created by someone else between
3970 ;; `delete-file' and `copy-file', so let's try again.
3971 ;; rms says "I think there is also a possible race
3972 ;; condition for making backup files" (emacs-devel 20070821).
3973 nil)))
3974 ;; Reset the umask.
3975 (set-default-file-modes umask)))
3976 (and modes
3977 (set-file-modes to-name (logand modes #o1777)))
3978 (and context
3979 (set-file-selinux-context to-name context)))
3980
3981 (defvar file-name-version-regexp
3982 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
3983 ;; The last ~[[:digit]]+ matches relative versions in git,
3984 ;; e.g. `foo.js.~HEAD~1~'.
3985 "Regular expression matching the backup/version part of a file name.
3986 Used by `file-name-sans-versions'.")
3987
3988 (defun file-name-sans-versions (name &optional keep-backup-version)
3989 "Return file NAME sans backup versions or strings.
3990 This is a separate procedure so your site-init or startup file can
3991 redefine it.
3992 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3993 we do not remove backup version numbers, only true file version numbers.
3994 See also `file-name-version-regexp'."
3995 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3996 (if handler
3997 (funcall handler 'file-name-sans-versions name keep-backup-version)
3998 (substring name 0
3999 (unless keep-backup-version
4000 (string-match (concat file-name-version-regexp "\\'")
4001 name))))))
4002
4003 (defun file-ownership-preserved-p (file)
4004 "Return t if deleting FILE and rewriting it would preserve the owner."
4005 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
4006 (if handler
4007 (funcall handler 'file-ownership-preserved-p file)
4008 (let ((attributes (file-attributes file 'integer)))
4009 ;; Return t if the file doesn't exist, since it's true that no
4010 ;; information would be lost by an (attempted) delete and create.
4011 (or (null attributes)
4012 (= (nth 2 attributes) (user-uid))
4013 ;; Files created on Windows by Administrator (RID=500)
4014 ;; have the Administrators group (RID=544) recorded as
4015 ;; their owner. Rewriting them will still preserve the
4016 ;; owner.
4017 (and (eq system-type 'windows-nt)
4018 (= (user-uid) 500) (= (nth 2 attributes) 544)))))))
4019
4020 (defun file-name-sans-extension (filename)
4021 "Return FILENAME sans final \"extension\".
4022 The extension, in a file name, is the part that follows the last `.',
4023 except that a leading `.', if any, doesn't count."
4024 (save-match-data
4025 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
4026 directory)
4027 (if (and (string-match "\\.[^.]*\\'" file)
4028 (not (eq 0 (match-beginning 0))))
4029 (if (setq directory (file-name-directory filename))
4030 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4031 ;; we don't want to expand it.
4032 (concat directory (substring file 0 (match-beginning 0)))
4033 (substring file 0 (match-beginning 0)))
4034 filename))))
4035
4036 (defun file-name-extension (filename &optional period)
4037 "Return FILENAME's final \"extension\".
4038 The extension, in a file name, is the part that follows the last `.',
4039 excluding version numbers and backup suffixes,
4040 except that a leading `.', if any, doesn't count.
4041 Return nil for extensionless file names such as `foo'.
4042 Return the empty string for file names such as `foo.'.
4043
4044 If PERIOD is non-nil, then the returned value includes the period
4045 that delimits the extension, and if FILENAME has no extension,
4046 the value is \"\"."
4047 (save-match-data
4048 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
4049 (if (and (string-match "\\.[^.]*\\'" file)
4050 (not (eq 0 (match-beginning 0))))
4051 (substring file (+ (match-beginning 0) (if period 0 1)))
4052 (if period
4053 "")))))
4054
4055 (defun file-name-base (&optional filename)
4056 "Return the base name of the FILENAME: no directory, no extension.
4057 FILENAME defaults to `buffer-file-name'."
4058 (file-name-sans-extension
4059 (file-name-nondirectory (or filename (buffer-file-name)))))
4060
4061 (defcustom make-backup-file-name-function nil
4062 "A function to use instead of the default `make-backup-file-name'.
4063 A value of nil gives the default `make-backup-file-name' behavior.
4064
4065 This could be buffer-local to do something special for specific
4066 files. If you define it, you may need to change `backup-file-name-p'
4067 and `file-name-sans-versions' too.
4068
4069 See also `backup-directory-alist'."
4070 :group 'backup
4071 :type '(choice (const :tag "Default" nil)
4072 (function :tag "Your function")))
4073
4074 (defcustom backup-directory-alist nil
4075 "Alist of filename patterns and backup directory names.
4076 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4077 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4078 relative or absolute. If it is absolute, so that all matching files
4079 are backed up into the same directory, the file names in this
4080 directory will be the full name of the file backed up with all
4081 directory separators changed to `!' to prevent clashes. This will not
4082 work correctly if your filesystem truncates the resulting name.
4083
4084 For the common case of all backups going into one directory, the alist
4085 should contain a single element pairing \".\" with the appropriate
4086 directory name.
4087
4088 If this variable is nil, or it fails to match a filename, the backup
4089 is made in the original file's directory.
4090
4091 On MS-DOS filesystems without long names this variable is always
4092 ignored."
4093 :group 'backup
4094 :type '(repeat (cons (regexp :tag "Regexp matching filename")
4095 (directory :tag "Backup directory name"))))
4096
4097 (defun normal-backup-enable-predicate (name)
4098 "Default `backup-enable-predicate' function.
4099 Checks for files in `temporary-file-directory',
4100 `small-temporary-file-directory', and /tmp."
4101 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
4102 name 0 nil)))
4103 ;; Directory is under temporary-file-directory.
4104 (and (not (eq comp t))
4105 (< comp (- (length temporary-file-directory)))))
4106 (let ((comp (compare-strings "/tmp" 0 nil
4107 name 0 nil)))
4108 ;; Directory is under /tmp.
4109 (and (not (eq comp t))
4110 (< comp (- (length "/tmp")))))
4111 (if small-temporary-file-directory
4112 (let ((comp (compare-strings small-temporary-file-directory
4113 0 nil
4114 name 0 nil)))
4115 ;; Directory is under small-temporary-file-directory.
4116 (and (not (eq comp t))
4117 (< comp (- (length small-temporary-file-directory)))))))))
4118
4119 (defun make-backup-file-name (file)
4120 "Create the non-numeric backup file name for FILE.
4121 Normally this will just be the file's name with `~' appended.
4122 Customization hooks are provided as follows.
4123
4124 If the variable `make-backup-file-name-function' is non-nil, its value
4125 should be a function which will be called with FILE as its argument;
4126 the resulting name is used.
4127
4128 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4129 the documentation of that variable. If the directory for the backup
4130 doesn't exist, it is created."
4131 (if make-backup-file-name-function
4132 (funcall make-backup-file-name-function file)
4133 (if (and (eq system-type 'ms-dos)
4134 (not (msdos-long-file-names)))
4135 (let ((fn (file-name-nondirectory file)))
4136 (concat (file-name-directory file)
4137 (or (and (string-match "\\`[^.]+\\'" fn)
4138 (concat (match-string 0 fn) ".~"))
4139 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
4140 (concat (match-string 0 fn) "~")))))
4141 (concat (make-backup-file-name-1 file) "~"))))
4142
4143 (defun make-backup-file-name-1 (file)
4144 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4145 (let ((alist backup-directory-alist)
4146 elt backup-directory abs-backup-directory)
4147 (while alist
4148 (setq elt (pop alist))
4149 (if (string-match (car elt) file)
4150 (setq backup-directory (cdr elt)
4151 alist nil)))
4152 ;; If backup-directory is relative, it should be relative to the
4153 ;; file's directory. By expanding explicitly here, we avoid
4154 ;; depending on default-directory.
4155 (if backup-directory
4156 (setq abs-backup-directory
4157 (expand-file-name backup-directory
4158 (file-name-directory file))))
4159 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
4160 (condition-case nil
4161 (make-directory abs-backup-directory 'parents)
4162 (file-error (setq backup-directory nil
4163 abs-backup-directory nil))))
4164 (if (null backup-directory)
4165 file
4166 (if (file-name-absolute-p backup-directory)
4167 (progn
4168 (when (memq system-type '(windows-nt ms-dos cygwin))
4169 ;; Normalize DOSish file names: downcase the drive
4170 ;; letter, if any, and replace the leading "x:" with
4171 ;; "/drive_x".
4172 (or (file-name-absolute-p file)
4173 (setq file (expand-file-name file))) ; make defaults explicit
4174 ;; Replace any invalid file-name characters (for the
4175 ;; case of backing up remote files).
4176 (setq file (expand-file-name (convert-standard-filename file)))
4177 (if (eq (aref file 1) ?:)
4178 (setq file (concat "/"
4179 "drive_"
4180 (char-to-string (downcase (aref file 0)))
4181 (if (eq (aref file 2) ?/)
4182 ""
4183 "/")
4184 (substring file 2)))))
4185 ;; Make the name unique by substituting directory
4186 ;; separators. It may not really be worth bothering about
4187 ;; doubling `!'s in the original name...
4188 (expand-file-name
4189 (subst-char-in-string
4190 ?/ ?!
4191 (replace-regexp-in-string "!" "!!" file))
4192 backup-directory))
4193 (expand-file-name (file-name-nondirectory file)
4194 (file-name-as-directory abs-backup-directory))))))
4195
4196 (defun backup-file-name-p (file)
4197 "Return non-nil if FILE is a backup file name (numeric or not).
4198 This is a separate function so you can redefine it for customization.
4199 You may need to redefine `file-name-sans-versions' as well."
4200 (string-match "~\\'" file))
4201
4202 (defvar backup-extract-version-start)
4203
4204 ;; This is used in various files.
4205 ;; The usage of backup-extract-version-start is not very clean,
4206 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4207 (defun backup-extract-version (fn)
4208 "Given the name of a numeric backup file, FN, return the backup number.
4209 Uses the free variable `backup-extract-version-start', whose value should be
4210 the index in the name where the version number begins."
4211 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
4212 (= (match-beginning 0) backup-extract-version-start))
4213 (string-to-number (substring fn backup-extract-version-start -1))
4214 0))
4215
4216 (defun find-backup-file-name (fn)
4217 "Find a file name for a backup file FN, and suggestions for deletions.
4218 Value is a list whose car is the name for the backup file
4219 and whose cdr is a list of old versions to consider deleting now.
4220 If the value is nil, don't make a backup.
4221 Uses `backup-directory-alist' in the same way as does
4222 `make-backup-file-name'."
4223 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
4224 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4225 (if handler
4226 (funcall handler 'find-backup-file-name fn)
4227 (if (or (eq version-control 'never)
4228 ;; We don't support numbered backups on plain MS-DOS
4229 ;; when long file names are unavailable.
4230 (and (eq system-type 'ms-dos)
4231 (not (msdos-long-file-names))))
4232 (list (make-backup-file-name fn))
4233 (let* ((basic-name (make-backup-file-name-1 fn))
4234 (base-versions (concat (file-name-nondirectory basic-name)
4235 ".~"))
4236 (backup-extract-version-start (length base-versions))
4237 (high-water-mark 0)
4238 (number-to-delete 0)
4239 possibilities deserve-versions-p versions)
4240 (condition-case ()
4241 (setq possibilities (file-name-all-completions
4242 base-versions
4243 (file-name-directory basic-name))
4244 versions (sort (mapcar #'backup-extract-version
4245 possibilities)
4246 #'<)
4247 high-water-mark (apply 'max 0 versions)
4248 deserve-versions-p (or version-control
4249 (> high-water-mark 0))
4250 number-to-delete (- (length versions)
4251 kept-old-versions
4252 kept-new-versions
4253 -1))
4254 (file-error (setq possibilities nil)))
4255 (if (not deserve-versions-p)
4256 (list (make-backup-file-name fn))
4257 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
4258 (if (and (> number-to-delete 0)
4259 ;; Delete nothing if there is overflow
4260 ;; in the number of versions to keep.
4261 (>= (+ kept-new-versions kept-old-versions -1) 0))
4262 (mapcar (lambda (n)
4263 (format "%s.~%d~" basic-name n))
4264 (let ((v (nthcdr kept-old-versions versions)))
4265 (rplacd (nthcdr (1- number-to-delete) v) ())
4266 v))))))))))
4267
4268 (defun file-nlinks (filename)
4269 "Return number of names file FILENAME has."
4270 (car (cdr (file-attributes filename))))
4271
4272 ;; (defun file-relative-name (filename &optional directory)
4273 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4274 ;; This function returns a relative file name which is equivalent to FILENAME
4275 ;; when used with that default directory as the default.
4276 ;; If this is impossible (which can happen on MSDOS and Windows
4277 ;; when the file name and directory use different drive names)
4278 ;; then it returns FILENAME."
4279 ;; (save-match-data
4280 ;; (let ((fname (expand-file-name filename)))
4281 ;; (setq directory (file-name-as-directory
4282 ;; (expand-file-name (or directory default-directory))))
4283 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4284 ;; ;; drive names, they can't be relative, so return the absolute name.
4285 ;; (if (and (or (eq system-type 'ms-dos)
4286 ;; (eq system-type 'cygwin)
4287 ;; (eq system-type 'windows-nt))
4288 ;; (not (string-equal (substring fname 0 2)
4289 ;; (substring directory 0 2))))
4290 ;; filename
4291 ;; (let ((ancestor ".")
4292 ;; (fname-dir (file-name-as-directory fname)))
4293 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4294 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4295 ;; (setq directory (file-name-directory (substring directory 0 -1))
4296 ;; ancestor (if (equal ancestor ".")
4297 ;; ".."
4298 ;; (concat "../" ancestor))))
4299 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4300 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4301 ;; ;; We matched within FNAME's directory part.
4302 ;; ;; Add the rest of FNAME onto ANCESTOR.
4303 ;; (let ((rest (substring fname (match-end 0))))
4304 ;; (if (and (equal ancestor ".")
4305 ;; (not (equal rest "")))
4306 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4307 ;; rest
4308 ;; (concat (file-name-as-directory ancestor) rest)))
4309 ;; ;; We matched FNAME's directory equivalent.
4310 ;; ancestor))))))
4311
4312 (defun file-relative-name (filename &optional directory)
4313 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4314 This function returns a relative file name which is equivalent to FILENAME
4315 when used with that default directory as the default.
4316 If FILENAME and DIRECTORY lie on different machines or on different drives
4317 on a DOS/Windows machine, it returns FILENAME in expanded form."
4318 (save-match-data
4319 (setq directory
4320 (file-name-as-directory (expand-file-name (or directory
4321 default-directory))))
4322 (setq filename (expand-file-name filename))
4323 (let ((fremote (file-remote-p filename))
4324 (dremote (file-remote-p directory))
4325 (fold-case (or (memq system-type '(ms-dos cygwin windows-nt))
4326 read-file-name-completion-ignore-case)))
4327 (if ;; Conditions for separate trees
4328 (or
4329 ;; Test for different filesystems on DOS/Windows
4330 (and
4331 ;; Should `cygwin' really be included here? --stef
4332 (memq system-type '(ms-dos cygwin windows-nt))
4333 (or
4334 ;; Test for different drive letters
4335 (not (eq t (compare-strings filename 0 2 directory 0 2 fold-case)))
4336 ;; Test for UNCs on different servers
4337 (not (eq t (compare-strings
4338 (progn
4339 (if (string-match "\\`//\\([^:/]+\\)/" filename)
4340 (match-string 1 filename)
4341 ;; Windows file names cannot have ? in
4342 ;; them, so use that to detect when
4343 ;; neither FILENAME nor DIRECTORY is a
4344 ;; UNC.
4345 "?"))
4346 0 nil
4347 (progn
4348 (if (string-match "\\`//\\([^:/]+\\)/" directory)
4349 (match-string 1 directory)
4350 "?"))
4351 0 nil t)))))
4352 ;; Test for different remote file system identification
4353 (not (equal fremote dremote)))
4354 filename
4355 (let ((ancestor ".")
4356 (filename-dir (file-name-as-directory filename)))
4357 (while (not
4358 (or
4359 (eq t (compare-strings filename-dir nil (length directory)
4360 directory nil nil fold-case))
4361 (eq t (compare-strings filename nil (length directory)
4362 directory nil nil fold-case))))
4363 (setq directory (file-name-directory (substring directory 0 -1))
4364 ancestor (if (equal ancestor ".")
4365 ".."
4366 (concat "../" ancestor))))
4367 ;; Now ancestor is empty, or .., or ../.., etc.
4368 (if (eq t (compare-strings filename nil (length directory)
4369 directory nil nil fold-case))
4370 ;; We matched within FILENAME's directory part.
4371 ;; Add the rest of FILENAME onto ANCESTOR.
4372 (let ((rest (substring filename (length directory))))
4373 (if (and (equal ancestor ".") (not (equal rest "")))
4374 ;; But don't bother with ANCESTOR if it would give us `./'.
4375 rest
4376 (concat (file-name-as-directory ancestor) rest)))
4377 ;; We matched FILENAME's directory equivalent.
4378 ancestor))))))
4379 \f
4380 (defun save-buffer (&optional args)
4381 "Save current buffer in visited file if modified.
4382 Variations are described below.
4383
4384 By default, makes the previous version into a backup file
4385 if previously requested or if this is the first save.
4386 Prefixed with one \\[universal-argument], marks this version
4387 to become a backup when the next save is done.
4388 Prefixed with two \\[universal-argument]'s,
4389 unconditionally makes the previous version into a backup file.
4390 Prefixed with three \\[universal-argument]'s, marks this version
4391 to become a backup when the next save is done,
4392 and unconditionally makes the previous version into a backup file.
4393
4394 With a numeric argument of 0, never make the previous version
4395 into a backup file.
4396
4397 If a file's name is FOO, the names of its numbered backup versions are
4398 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4399 Numeric backups (rather than FOO~) will be made if value of
4400 `version-control' is not the atom `never' and either there are already
4401 numeric versions of the file being backed up, or `version-control' is
4402 non-nil.
4403 We don't want excessive versions piling up, so there are variables
4404 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4405 and `kept-new-versions', which tells how many newest versions to keep.
4406 Defaults are 2 old versions and 2 new.
4407 `dired-kept-versions' controls dired's clean-directory (.) command.
4408 If `delete-old-versions' is nil, system will query user
4409 before trimming versions. Otherwise it does it silently.
4410
4411 If `vc-make-backup-files' is nil, which is the default,
4412 no backup files are made for files managed by version control.
4413 (This is because the version control system itself records previous versions.)
4414
4415 See the subroutine `basic-save-buffer' for more information."
4416 (interactive "p")
4417 (let ((modp (buffer-modified-p))
4418 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4419 (memq args '(16 64)))))
4420 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4421 ;; We used to display the message below only for files > 50KB, but
4422 ;; then Rmail-mbox never displays it due to buffer swapping. If
4423 ;; the test is ever re-introduced, be sure to handle saving of
4424 ;; Rmail files.
4425 (if (and modp (buffer-file-name))
4426 (message "Saving file %s..." (buffer-file-name)))
4427 (basic-save-buffer)
4428 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4429
4430 (defun delete-auto-save-file-if-necessary (&optional force)
4431 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4432 Normally delete only if the file was written by this Emacs since
4433 the last real save, but optional arg FORCE non-nil means delete anyway."
4434 (and buffer-auto-save-file-name delete-auto-save-files
4435 (not (string= buffer-file-name buffer-auto-save-file-name))
4436 (or force (recent-auto-save-p))
4437 (progn
4438 (condition-case ()
4439 (delete-file buffer-auto-save-file-name)
4440 (file-error nil))
4441 (set-buffer-auto-saved))))
4442
4443 (defvar auto-save-hook nil
4444 "Normal hook run just before auto-saving.")
4445
4446 (defcustom before-save-hook nil
4447 "Normal hook that is run before a buffer is saved to its file."
4448 :options '(copyright-update time-stamp)
4449 :type 'hook
4450 :group 'files)
4451
4452 (defcustom after-save-hook nil
4453 "Normal hook that is run after a buffer is saved to its file."
4454 :options '(executable-make-buffer-file-executable-if-script-p)
4455 :type 'hook
4456 :group 'files)
4457
4458 (defvar save-buffer-coding-system nil
4459 "If non-nil, use this coding system for saving the buffer.
4460 More precisely, use this coding system in place of the
4461 value of `buffer-file-coding-system', when saving the buffer.
4462 Calling `write-region' for any purpose other than saving the buffer
4463 will still use `buffer-file-coding-system'; this variable has no effect
4464 in such cases.")
4465
4466 (make-variable-buffer-local 'save-buffer-coding-system)
4467 (put 'save-buffer-coding-system 'permanent-local t)
4468
4469 (defun basic-save-buffer ()
4470 "Save the current buffer in its visited file, if it has been modified.
4471 The hooks `write-contents-functions' and `write-file-functions' get a chance
4472 to do the job of saving; if they do not, then the buffer is saved in
4473 the visited file in the usual way.
4474 Before and after saving the buffer, this function runs
4475 `before-save-hook' and `after-save-hook', respectively."
4476 (interactive)
4477 (save-current-buffer
4478 ;; In an indirect buffer, save its base buffer instead.
4479 (if (buffer-base-buffer)
4480 (set-buffer (buffer-base-buffer)))
4481 (if (or (buffer-modified-p)
4482 ;; handle the case when no modification has been made but
4483 ;; the file disappeared since visited
4484 (and buffer-file-name
4485 (not (file-exists-p buffer-file-name))))
4486 (let ((recent-save (recent-auto-save-p))
4487 setmodes)
4488 ;; If buffer has no file name, ask user for one.
4489 (or buffer-file-name
4490 (let ((filename
4491 (expand-file-name
4492 (read-file-name "File to save in: "
4493 nil (expand-file-name (buffer-name))))))
4494 (if (file-exists-p filename)
4495 (if (file-directory-p filename)
4496 ;; Signal an error if the user specified the name of an
4497 ;; existing directory.
4498 (error "%s is a directory" filename)
4499 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4500 filename))
4501 (error "Canceled")))
4502 ;; Signal an error if the specified name refers to a
4503 ;; non-existing directory.
4504 (let ((dir (file-name-directory filename)))
4505 (unless (file-directory-p dir)
4506 (if (file-exists-p dir)
4507 (error "%s is not a directory" dir)
4508 (error "%s: no such directory" dir)))))
4509 (set-visited-file-name filename)))
4510 (or (verify-visited-file-modtime (current-buffer))
4511 (not (file-exists-p buffer-file-name))
4512 (yes-or-no-p
4513 (format
4514 "%s has changed since visited or saved. Save anyway? "
4515 (file-name-nondirectory buffer-file-name)))
4516 (user-error "Save not confirmed"))
4517 (save-restriction
4518 (widen)
4519 (save-excursion
4520 (and (> (point-max) (point-min))
4521 (not find-file-literally)
4522 (/= (char-after (1- (point-max))) ?\n)
4523 (not (and (eq selective-display t)
4524 (= (char-after (1- (point-max))) ?\r)))
4525 (or (eq require-final-newline t)
4526 (eq require-final-newline 'visit-save)
4527 (and require-final-newline
4528 (y-or-n-p
4529 (format "Buffer %s does not end in newline. Add one? "
4530 (buffer-name)))))
4531 (save-excursion
4532 (goto-char (point-max))
4533 (insert ?\n))))
4534 ;; Support VC version backups.
4535 (vc-before-save)
4536 (run-hooks 'before-save-hook)
4537 (or (run-hook-with-args-until-success 'write-contents-functions)
4538 (run-hook-with-args-until-success 'local-write-file-hooks)
4539 (run-hook-with-args-until-success 'write-file-functions)
4540 ;; If a hook returned t, file is already "written".
4541 ;; Otherwise, write it the usual way now.
4542 (setq setmodes (basic-save-buffer-1)))
4543 ;; Now we have saved the current buffer. Let's make sure
4544 ;; that buffer-file-coding-system is fixed to what
4545 ;; actually used for saving by binding it locally.
4546 (if save-buffer-coding-system
4547 (setq save-buffer-coding-system last-coding-system-used)
4548 (setq buffer-file-coding-system last-coding-system-used))
4549 (setq buffer-file-number
4550 (nthcdr 10 (file-attributes buffer-file-name)))
4551 (if setmodes
4552 (condition-case ()
4553 (progn
4554 (set-file-modes buffer-file-name (car setmodes))
4555 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))
4556 (error nil))))
4557 ;; If the auto-save file was recent before this command,
4558 ;; delete it now.
4559 (delete-auto-save-file-if-necessary recent-save)
4560 ;; Support VC `implicit' locking.
4561 (vc-after-save)
4562 (run-hooks 'after-save-hook))
4563 (message "(No changes need to be saved)"))))
4564
4565 ;; This does the "real job" of writing a buffer into its visited file
4566 ;; and making a backup file. This is what is normally done
4567 ;; but inhibited if one of write-file-functions returns non-nil.
4568 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4569 (defun basic-save-buffer-1 ()
4570 (prog1
4571 (if save-buffer-coding-system
4572 (let ((coding-system-for-write save-buffer-coding-system))
4573 (basic-save-buffer-2))
4574 (basic-save-buffer-2))
4575 (if buffer-file-coding-system-explicit
4576 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4577 (setq buffer-file-coding-system-explicit
4578 (cons last-coding-system-used nil)))))
4579
4580 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4581 (defun basic-save-buffer-2 ()
4582 (let (tempsetmodes setmodes)
4583 (if (not (file-writable-p buffer-file-name))
4584 (let ((dir (file-name-directory buffer-file-name)))
4585 (if (not (file-directory-p dir))
4586 (if (file-exists-p dir)
4587 (error "%s is not a directory" dir)
4588 (error "%s: no such directory" dir))
4589 (if (not (file-exists-p buffer-file-name))
4590 (error "Directory %s write-protected" dir)
4591 (if (yes-or-no-p
4592 (format
4593 "File %s is write-protected; try to save anyway? "
4594 (file-name-nondirectory
4595 buffer-file-name)))
4596 (setq tempsetmodes t)
4597 (error "Attempt to save to a file which you aren't allowed to write"))))))
4598 (or buffer-backed-up
4599 (setq setmodes (backup-buffer)))
4600 (let* ((dir (file-name-directory buffer-file-name))
4601 (dir-writable (file-writable-p dir)))
4602 (if (or (and file-precious-flag dir-writable)
4603 (and break-hardlink-on-save
4604 (file-exists-p buffer-file-name)
4605 (> (file-nlinks buffer-file-name) 1)
4606 (or dir-writable
4607 (error (concat (format
4608 "Directory %s write-protected; " dir)
4609 "cannot break hardlink when saving")))))
4610 ;; Write temp name, then rename it.
4611 ;; This requires write access to the containing dir,
4612 ;; which is why we don't try it if we don't have that access.
4613 (let ((realname buffer-file-name)
4614 tempname succeed
4615 (umask (default-file-modes))
4616 (old-modtime (visited-file-modtime)))
4617 ;; Create temp files with strict access rights. It's easy to
4618 ;; loosen them later, whereas it's impossible to close the
4619 ;; time-window of loose permissions otherwise.
4620 (unwind-protect
4621 (progn
4622 (clear-visited-file-modtime)
4623 (set-default-file-modes ?\700)
4624 ;; Try various temporary names.
4625 ;; This code follows the example of make-temp-file,
4626 ;; but it calls write-region in the appropriate way
4627 ;; for saving the buffer.
4628 (while (condition-case ()
4629 (progn
4630 (setq tempname
4631 (make-temp-name
4632 (expand-file-name "tmp" dir)))
4633 ;; Pass in nil&nil rather than point-min&max
4634 ;; cause we're saving the whole buffer.
4635 ;; write-region-annotate-functions may use it.
4636 (write-region nil nil
4637 tempname nil realname
4638 buffer-file-truename 'excl)
4639 nil)
4640 (file-already-exists t))
4641 ;; The file was somehow created by someone else between
4642 ;; `make-temp-name' and `write-region', let's try again.
4643 nil)
4644 (setq succeed t))
4645 ;; Reset the umask.
4646 (set-default-file-modes umask)
4647 ;; If we failed, restore the buffer's modtime.
4648 (unless succeed
4649 (set-visited-file-modtime old-modtime)))
4650 ;; Since we have created an entirely new file,
4651 ;; make sure it gets the right permission bits set.
4652 (setq setmodes (or setmodes
4653 (list (or (file-modes buffer-file-name)
4654 (logand ?\666 umask))
4655 (file-selinux-context buffer-file-name)
4656 buffer-file-name)))
4657 ;; We succeeded in writing the temp file,
4658 ;; so rename it.
4659 (rename-file tempname buffer-file-name t))
4660 ;; If file not writable, see if we can make it writable
4661 ;; temporarily while we write it.
4662 ;; But no need to do so if we have just backed it up
4663 ;; (setmodes is set) because that says we're superseding.
4664 (cond ((and tempsetmodes (not setmodes))
4665 ;; Change the mode back, after writing.
4666 (setq setmodes (list (file-modes buffer-file-name)
4667 (file-selinux-context buffer-file-name)
4668 buffer-file-name))
4669 (set-file-modes buffer-file-name (logior (car setmodes) 128))
4670 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))))
4671 (let (success)
4672 (unwind-protect
4673 (progn
4674 ;; Pass in nil&nil rather than point-min&max to indicate
4675 ;; we're saving the buffer rather than just a region.
4676 ;; write-region-annotate-functions may make us of it.
4677 (write-region nil nil
4678 buffer-file-name nil t buffer-file-truename)
4679 (setq success t))
4680 ;; If we get an error writing the new file, and we made
4681 ;; the backup by renaming, undo the backing-up.
4682 (and setmodes (not success)
4683 (progn
4684 (rename-file (nth 2 setmodes) buffer-file-name t)
4685 (setq buffer-backed-up nil))))))
4686 setmodes))
4687
4688 (declare-function diff-no-select "diff"
4689 (old new &optional switches no-async buf))
4690
4691 (defvar save-some-buffers-action-alist
4692 `((?\C-r
4693 ,(lambda (buf)
4694 (if (not enable-recursive-minibuffers)
4695 (progn (display-buffer buf)
4696 (setq other-window-scroll-buffer buf))
4697 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4698 (recursive-edit))
4699 ;; Return nil to ask about BUF again.
4700 nil)
4701 ,(purecopy "view this buffer"))
4702 (?d ,(lambda (buf)
4703 (if (null (buffer-file-name buf))
4704 (message "Not applicable: no file")
4705 (require 'diff) ;for diff-no-select.
4706 (let ((diffbuf (diff-no-select (buffer-file-name buf) buf
4707 nil 'noasync)))
4708 (if (not enable-recursive-minibuffers)
4709 (progn (display-buffer diffbuf)
4710 (setq other-window-scroll-buffer diffbuf))
4711 (view-buffer diffbuf (lambda (_) (exit-recursive-edit)))
4712 (recursive-edit))))
4713 ;; Return nil to ask about BUF again.
4714 nil)
4715 ,(purecopy "view changes in this buffer")))
4716 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4717 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4718
4719 (defvar buffer-save-without-query nil
4720 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4721 (make-variable-buffer-local 'buffer-save-without-query)
4722
4723 (defun save-some-buffers (&optional arg pred)
4724 "Save some modified file-visiting buffers. Asks user about each one.
4725 You can answer `y' to save, `n' not to save, `C-r' to look at the
4726 buffer in question with `view-buffer' before deciding or `d' to
4727 view the differences using `diff-buffer-with-file'.
4728
4729 This command first saves any buffers where `buffer-save-without-query' is
4730 non-nil, without asking.
4731
4732 Optional argument (the prefix) non-nil means save all with no questions.
4733 Optional second argument PRED determines which buffers are considered:
4734 If PRED is nil, all the file-visiting buffers are considered.
4735 If PRED is t, then certain non-file buffers will also be considered.
4736 If PRED is a zero-argument function, it indicates for each buffer whether
4737 to consider it or not when called with that buffer current.
4738
4739 See `save-some-buffers-action-alist' if you want to
4740 change the additional actions you can take on files."
4741 (interactive "P")
4742 (save-window-excursion
4743 (let* (queried autosaved-buffers
4744 files-done abbrevs-done)
4745 (dolist (buffer (buffer-list))
4746 ;; First save any buffers that we're supposed to save unconditionally.
4747 ;; That way the following code won't ask about them.
4748 (with-current-buffer buffer
4749 (when (and buffer-save-without-query (buffer-modified-p))
4750 (push (buffer-name) autosaved-buffers)
4751 (save-buffer))))
4752 ;; Ask about those buffers that merit it,
4753 ;; and record the number thus saved.
4754 (setq files-done
4755 (map-y-or-n-p
4756 (lambda (buffer)
4757 ;; Note that killing some buffers may kill others via
4758 ;; hooks (e.g. Rmail and its viewing buffer).
4759 (and (buffer-live-p buffer)
4760 (buffer-modified-p buffer)
4761 (not (buffer-base-buffer buffer))
4762 (or
4763 (buffer-file-name buffer)
4764 (and pred
4765 (progn
4766 (set-buffer buffer)
4767 (and buffer-offer-save (> (buffer-size) 0)))))
4768 (or (not (functionp pred))
4769 (with-current-buffer buffer (funcall pred)))
4770 (if arg
4771 t
4772 (setq queried t)
4773 (if (buffer-file-name buffer)
4774 (format "Save file %s? "
4775 (buffer-file-name buffer))
4776 (format "Save buffer %s? "
4777 (buffer-name buffer))))))
4778 (lambda (buffer)
4779 (with-current-buffer buffer
4780 (save-buffer)))
4781 (buffer-list)
4782 '("buffer" "buffers" "save")
4783 save-some-buffers-action-alist))
4784 ;; Maybe to save abbrevs, and record whether
4785 ;; we either saved them or asked to.
4786 (and save-abbrevs abbrevs-changed
4787 (progn
4788 (if (or arg
4789 (eq save-abbrevs 'silently)
4790 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
4791 (write-abbrev-file nil))
4792 ;; Don't keep bothering user if he says no.
4793 (setq abbrevs-changed nil)
4794 (setq abbrevs-done t)))
4795 (or queried (> files-done 0) abbrevs-done
4796 (cond
4797 ((null autosaved-buffers)
4798 (message "(No files need saving)"))
4799 ((= (length autosaved-buffers) 1)
4800 (message "(Saved %s)" (car autosaved-buffers)))
4801 (t
4802 (message "(Saved %d files: %s)"
4803 (length autosaved-buffers)
4804 (mapconcat 'identity autosaved-buffers ", "))))))))
4805 \f
4806 (defun not-modified (&optional arg)
4807 "Mark current buffer as unmodified, not needing to be saved.
4808 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4809
4810 It is not a good idea to use this function in Lisp programs, because it
4811 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4812 (interactive "P")
4813 (message (if arg "Modification-flag set"
4814 "Modification-flag cleared"))
4815 (set-buffer-modified-p arg))
4816
4817 (defun toggle-read-only (&optional arg interactive)
4818 (declare (obsolete read-only-mode "24.3"))
4819 (interactive (list current-prefix-arg t))
4820 (if interactive
4821 (call-interactively 'read-only-mode)
4822 (read-only-mode (or arg 'toggle))))
4823
4824 (defun insert-file (filename)
4825 "Insert contents of file FILENAME into buffer after point.
4826 Set mark after the inserted text.
4827
4828 This function is meant for the user to run interactively.
4829 Don't call it from programs! Use `insert-file-contents' instead.
4830 \(Its calling sequence is different; see its documentation)."
4831 (interactive "*fInsert file: ")
4832 (insert-file-1 filename #'insert-file-contents))
4833
4834 (defun append-to-file (start end filename)
4835 "Append the contents of the region to the end of file FILENAME.
4836 When called from a function, expects three arguments,
4837 START, END and FILENAME. START and END are normally buffer positions
4838 specifying the part of the buffer to write.
4839 If START is nil, that means to use the entire buffer contents.
4840 If START is a string, then output that string to the file
4841 instead of any buffer contents; END is ignored.
4842
4843 This does character code conversion and applies annotations
4844 like `write-region' does."
4845 (interactive "r\nFAppend to file: ")
4846 (write-region start end filename t))
4847
4848 (defun file-newest-backup (filename)
4849 "Return most recent backup file for FILENAME or nil if no backups exist."
4850 ;; `make-backup-file-name' will get us the right directory for
4851 ;; ordinary or numeric backups. It might create a directory for
4852 ;; backups as a side-effect, according to `backup-directory-alist'.
4853 (let* ((filename (file-name-sans-versions
4854 (make-backup-file-name (expand-file-name filename))))
4855 (file (file-name-nondirectory filename))
4856 (dir (file-name-directory filename))
4857 (comp (file-name-all-completions file dir))
4858 (newest nil)
4859 tem)
4860 (while comp
4861 (setq tem (pop comp))
4862 (cond ((and (backup-file-name-p tem)
4863 (string= (file-name-sans-versions tem) file))
4864 (setq tem (concat dir tem))
4865 (if (or (null newest)
4866 (file-newer-than-file-p tem newest))
4867 (setq newest tem)))))
4868 newest))
4869
4870 (defun rename-uniquely ()
4871 "Rename current buffer to a similar name not already taken.
4872 This function is useful for creating multiple shell process buffers
4873 or multiple mail buffers, etc.
4874
4875 Note that some commands, in particular those based on `compilation-mode'
4876 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4877 appropriate mode even if it has been renamed. So as well as renaming
4878 the buffer, you also need to switch buffers before running another
4879 instance of such commands."
4880 (interactive)
4881 (save-match-data
4882 (let ((base-name (buffer-name)))
4883 (and (string-match "<[0-9]+>\\'" base-name)
4884 (not (and buffer-file-name
4885 (string= base-name
4886 (file-name-nondirectory buffer-file-name))))
4887 ;; If the existing buffer name has a <NNN>,
4888 ;; which isn't part of the file name (if any),
4889 ;; then get rid of that.
4890 (setq base-name (substring base-name 0 (match-beginning 0))))
4891 (rename-buffer (generate-new-buffer-name base-name))
4892 (force-mode-line-update))))
4893
4894 (defun make-directory (dir &optional parents)
4895 "Create the directory DIR and optionally any nonexistent parent dirs.
4896 If DIR already exists as a directory, signal an error, unless
4897 PARENTS is non-nil.
4898
4899 Interactively, the default choice of directory to create is the
4900 current buffer's default directory. That is useful when you have
4901 visited a file in a nonexistent directory.
4902
4903 Noninteractively, the second (optional) argument PARENTS, if
4904 non-nil, says whether to create parent directories that don't
4905 exist. Interactively, this happens by default.
4906
4907 If creating the directory or directories fail, an error will be
4908 raised."
4909 (interactive
4910 (list (read-file-name "Make directory: " default-directory default-directory
4911 nil nil)
4912 t))
4913 ;; If default-directory is a remote directory,
4914 ;; make sure we find its make-directory handler.
4915 (setq dir (expand-file-name dir))
4916 (let ((handler (find-file-name-handler dir 'make-directory)))
4917 (if handler
4918 (funcall handler 'make-directory dir parents)
4919 (if (not parents)
4920 (make-directory-internal dir)
4921 (let ((dir (directory-file-name (expand-file-name dir)))
4922 create-list)
4923 (while (and (not (file-exists-p dir))
4924 ;; If directory is its own parent, then we can't
4925 ;; keep looping forever
4926 (not (equal dir
4927 (directory-file-name
4928 (file-name-directory dir)))))
4929 (setq create-list (cons dir create-list)
4930 dir (directory-file-name (file-name-directory dir))))
4931 (while create-list
4932 (make-directory-internal (car create-list))
4933 (setq create-list (cdr create-list))))))))
4934
4935 (defconst directory-files-no-dot-files-regexp
4936 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4937 "Regexp matching any file name except \".\" and \"..\".")
4938
4939 (defun delete-directory (directory &optional recursive trash)
4940 "Delete the directory named DIRECTORY. Does not follow symlinks.
4941 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4942 TRASH non-nil means to trash the directory instead, provided
4943 `delete-by-moving-to-trash' is non-nil.
4944
4945 When called interactively, TRASH is t if no prefix argument is
4946 given. With a prefix argument, TRASH is nil."
4947 (interactive
4948 (let* ((trashing (and delete-by-moving-to-trash
4949 (null current-prefix-arg)))
4950 (dir (expand-file-name
4951 (read-directory-name
4952 (if trashing
4953 "Move directory to trash: "
4954 "Delete directory: ")
4955 default-directory default-directory nil nil))))
4956 (list dir
4957 (if (directory-files dir nil directory-files-no-dot-files-regexp)
4958 (y-or-n-p
4959 (format "Directory `%s' is not empty, really %s? "
4960 dir (if trashing "trash" "delete")))
4961 nil)
4962 (null current-prefix-arg))))
4963 ;; If default-directory is a remote directory, make sure we find its
4964 ;; delete-directory handler.
4965 (setq directory (directory-file-name (expand-file-name directory)))
4966 (let ((handler (find-file-name-handler directory 'delete-directory)))
4967 (cond
4968 (handler
4969 (funcall handler 'delete-directory directory recursive))
4970 ((and delete-by-moving-to-trash trash)
4971 ;; Only move non-empty dir to trash if recursive deletion was
4972 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4973 ;; case, where the operation fails in delete-directory-internal.
4974 ;; As `move-file-to-trash' trashes directories (empty or
4975 ;; otherwise) as a unit, we do not need to recurse here.
4976 (if (and (not recursive)
4977 ;; Check if directory is empty apart from "." and "..".
4978 (directory-files
4979 directory 'full directory-files-no-dot-files-regexp))
4980 (error "Directory is not empty, not moving to trash")
4981 (move-file-to-trash directory)))
4982 ;; Otherwise, call ourselves recursively if needed.
4983 (t
4984 (if (and recursive (not (file-symlink-p directory)))
4985 (mapc (lambda (file)
4986 ;; This test is equivalent to
4987 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4988 ;; but more efficient
4989 (if (eq t (car (file-attributes file)))
4990 (delete-directory file recursive nil)
4991 (delete-file file nil)))
4992 ;; We do not want to delete "." and "..".
4993 (directory-files
4994 directory 'full directory-files-no-dot-files-regexp)))
4995 (delete-directory-internal directory)))))
4996
4997 (defun file-equal-p (file1 file2)
4998 "Return non-nil if files FILE1 and FILE2 name the same file.
4999 If FILE1 or FILE2 does not exist, the return value is unspecified."
5000 (let ((handler (or (find-file-name-handler file1 'file-equal-p)
5001 (find-file-name-handler file2 'file-equal-p))))
5002 (if handler
5003 (funcall handler 'file-equal-p file1 file2)
5004 (let (f1-attr f2-attr)
5005 (and (setq f1-attr (file-attributes (file-truename file1)))
5006 (setq f2-attr (file-attributes (file-truename file2)))
5007 (equal f1-attr f2-attr))))))
5008
5009 (defun file-in-directory-p (file dir)
5010 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5011 A directory is considered to be \"in\" itself.
5012 Return nil if DIR is not an existing directory."
5013 (let ((handler (or (find-file-name-handler file 'file-in-directory-p)
5014 (find-file-name-handler dir 'file-in-directory-p))))
5015 (if handler
5016 (funcall handler 'file-in-directory-p file dir)
5017 (when (file-directory-p dir) ; DIR must exist.
5018 (setq file (file-truename file)
5019 dir (file-truename dir))
5020 (let ((ls1 (split-string file "/" t))
5021 (ls2 (split-string dir "/" t))
5022 (root (if (string-match "\\`/" file) "/" ""))
5023 (mismatch nil))
5024 (while (and ls1 ls2 (not mismatch))
5025 (if (string-equal (car ls1) (car ls2))
5026 (setq root (concat root (car ls1) "/"))
5027 (setq mismatch t))
5028 (setq ls1 (cdr ls1)
5029 ls2 (cdr ls2)))
5030 (unless mismatch
5031 (file-equal-p root dir)))))))
5032
5033 (defun copy-directory (directory newname &optional keep-time parents copy-contents)
5034 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5035 This function always sets the file modes of the output files to match
5036 the corresponding input file.
5037
5038 The third arg KEEP-TIME non-nil means give the output files the same
5039 last-modified time as the old ones. (This works on only some systems.)
5040
5041 A prefix arg makes KEEP-TIME non-nil.
5042
5043 Noninteractively, the last argument PARENTS says whether to
5044 create parent directories if they don't exist. Interactively,
5045 this happens by default.
5046
5047 If NEWNAME names an existing directory, copy DIRECTORY as a
5048 subdirectory there. However, if called from Lisp with a non-nil
5049 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5050 directly into NEWNAME instead."
5051 (interactive
5052 (let ((dir (read-directory-name
5053 "Copy directory: " default-directory default-directory t nil)))
5054 (list dir
5055 (read-directory-name
5056 (format "Copy directory %s to: " dir)
5057 default-directory default-directory nil nil)
5058 current-prefix-arg t nil)))
5059 (when (file-in-directory-p newname directory)
5060 (error "Cannot copy `%s' into its subdirectory `%s'"
5061 directory newname))
5062 ;; If default-directory is a remote directory, make sure we find its
5063 ;; copy-directory handler.
5064 (let ((handler (or (find-file-name-handler directory 'copy-directory)
5065 (find-file-name-handler newname 'copy-directory))))
5066 (if handler
5067 (funcall handler 'copy-directory directory
5068 newname keep-time parents copy-contents)
5069
5070 ;; Compute target name.
5071 (setq directory (directory-file-name (expand-file-name directory))
5072 newname (directory-file-name (expand-file-name newname)))
5073
5074 (cond ((not (file-directory-p newname))
5075 ;; If NEWNAME is not an existing directory, create it;
5076 ;; that is where we will copy the files of DIRECTORY.
5077 (make-directory newname parents))
5078 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5079 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5080 ((not copy-contents)
5081 (setq newname (expand-file-name
5082 (file-name-nondirectory
5083 (directory-file-name directory))
5084 newname))
5085 (and (file-exists-p newname)
5086 (not (file-directory-p newname))
5087 (error "Cannot overwrite non-directory %s with a directory"
5088 newname))
5089 (make-directory newname t)))
5090
5091 ;; Copy recursively.
5092 (dolist (file
5093 ;; We do not want to copy "." and "..".
5094 (directory-files directory 'full
5095 directory-files-no-dot-files-regexp))
5096 (let ((target (expand-file-name (file-name-nondirectory file) newname))
5097 (filetype (car (file-attributes file))))
5098 (cond
5099 ((eq filetype t) ; Directory but not a symlink.
5100 (copy-directory file newname keep-time parents))
5101 ((stringp filetype) ; Symbolic link
5102 (make-symbolic-link filetype target t))
5103 ((copy-file file target t keep-time)))))
5104
5105 ;; Set directory attributes.
5106 (let ((modes (file-modes directory))
5107 (times (and keep-time (nth 5 (file-attributes directory)))))
5108 (if modes (set-file-modes newname modes))
5109 (if times (set-file-times newname times))))))
5110
5111 \f
5112 ;; At time of writing, only info uses this.
5113 (defun prune-directory-list (dirs &optional keep reject)
5114 "Return a copy of DIRS with all non-existent directories removed.
5115 The optional argument KEEP is a list of directories to retain even if
5116 they don't exist, and REJECT is a list of directories to remove from
5117 DIRS, even if they exist; REJECT takes precedence over KEEP.
5118
5119 Note that membership in REJECT and KEEP is checked using simple string
5120 comparison."
5121 (apply #'nconc
5122 (mapcar (lambda (dir)
5123 (and (not (member dir reject))
5124 (or (member dir keep) (file-directory-p dir))
5125 (list dir)))
5126 dirs)))
5127
5128 \f
5129 (put 'revert-buffer-function 'permanent-local t)
5130 (defvar revert-buffer-function nil
5131 "Function to use to revert this buffer, or nil to do the default.
5132 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5133 which are the arguments that `revert-buffer' received.")
5134
5135 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
5136 (defvar revert-buffer-insert-file-contents-function nil
5137 "Function to use to insert contents when reverting this buffer.
5138 Gets two args, first the nominal file name to use,
5139 and second, t if reading the auto-save file.
5140
5141 The function you specify is responsible for updating (or preserving) point.")
5142
5143 (defvar buffer-stale-function nil
5144 "Function to check whether a non-file buffer needs reverting.
5145 This should be a function with one optional argument NOCONFIRM.
5146 Auto Revert Mode passes t for NOCONFIRM. The function should return
5147 non-nil if the buffer should be reverted. A return value of
5148 `fast' means that the need for reverting was not checked, but
5149 that reverting the buffer is fast. The buffer is current when
5150 this function is called.
5151
5152 The idea behind the NOCONFIRM argument is that it should be
5153 non-nil if the buffer is going to be reverted without asking the
5154 user. In such situations, one has to be careful with potentially
5155 time consuming operations.
5156
5157 For more information on how this variable is used by Auto Revert mode,
5158 see Info node `(emacs)Supporting additional buffers'.")
5159
5160 (defvar before-revert-hook nil
5161 "Normal hook for `revert-buffer' to run before reverting.
5162 If `revert-buffer-function' is used to override the normal revert
5163 mechanism, this hook is not used.")
5164
5165 (defvar after-revert-hook nil
5166 "Normal hook for `revert-buffer' to run after reverting.
5167 Note that the hook value that it runs is the value that was in effect
5168 before reverting; that makes a difference if you have buffer-local
5169 hook functions.
5170
5171 If `revert-buffer-function' is used to override the normal revert
5172 mechanism, this hook is not used.")
5173
5174 (defvar revert-buffer-in-progress-p nil
5175 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5176 This is true even if a `revert-buffer-function' is being used.")
5177
5178 (defvar revert-buffer-internal-hook)
5179
5180 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
5181 "Replace current buffer text with the text of the visited file on disk.
5182 This undoes all changes since the file was visited or saved.
5183 With a prefix argument, offer to revert from latest auto-save file, if
5184 that is more recent than the visited file.
5185
5186 This command also implements an interface for special buffers
5187 that contain text which doesn't come from a file, but reflects
5188 some other data instead (e.g. Dired buffers, `buffer-list'
5189 buffers). This is done via the variable `revert-buffer-function'.
5190 In these cases, it should reconstruct the buffer contents from the
5191 appropriate data.
5192
5193 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5194 to revert from the auto-save file when this is nil. Note that the
5195 sense of this argument is the reverse of the prefix argument, for the
5196 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5197 to nil.
5198
5199 Optional second argument NOCONFIRM means don't ask for confirmation
5200 at all. (The variable `revert-without-query' offers another way to
5201 revert buffers without querying for confirmation.)
5202
5203 Optional third argument PRESERVE-MODES non-nil means don't alter
5204 the files modes. Normally we reinitialize them using `normal-mode'.
5205
5206 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5207
5208 If the value of `revert-buffer-function' is non-nil, it is called to
5209 do all the work for this command. Otherwise, the hooks
5210 `before-revert-hook' and `after-revert-hook' are run at the beginning
5211 and the end, and if `revert-buffer-insert-file-contents-function' is
5212 non-nil, it is called instead of rereading visited file contents."
5213
5214 ;; I admit it's odd to reverse the sense of the prefix argument, but
5215 ;; there is a lot of code out there which assumes that the first
5216 ;; argument should be t to avoid consulting the auto-save file, and
5217 ;; there's no straightforward way to encourage authors to notice a
5218 ;; reversal of the argument sense. So I'm just changing the user
5219 ;; interface, but leaving the programmatic interface the same.
5220 (interactive (list (not current-prefix-arg)))
5221 (if revert-buffer-function
5222 (let ((revert-buffer-in-progress-p t))
5223 (funcall revert-buffer-function ignore-auto noconfirm))
5224 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5225 (current-buffer))
5226 (let* ((revert-buffer-in-progress-p t)
5227 (auto-save-p (and (not ignore-auto)
5228 (recent-auto-save-p)
5229 buffer-auto-save-file-name
5230 (file-readable-p buffer-auto-save-file-name)
5231 (y-or-n-p
5232 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5233 (file-name (if auto-save-p
5234 buffer-auto-save-file-name
5235 buffer-file-name)))
5236 (cond ((null file-name)
5237 (error "Buffer does not seem to be associated with any file"))
5238 ((or noconfirm
5239 (and (not (buffer-modified-p))
5240 (catch 'found
5241 (dolist (regexp revert-without-query)
5242 (when (string-match regexp file-name)
5243 (throw 'found t)))))
5244 (yes-or-no-p (format "Revert buffer from file %s? "
5245 file-name)))
5246 (run-hooks 'before-revert-hook)
5247 ;; If file was backed up but has changed since,
5248 ;; we should make another backup.
5249 (and (not auto-save-p)
5250 (not (verify-visited-file-modtime (current-buffer)))
5251 (setq buffer-backed-up nil))
5252 ;; Effectively copy the after-revert-hook status,
5253 ;; since after-find-file will clobber it.
5254 (let ((global-hook (default-value 'after-revert-hook))
5255 (local-hook (when (local-variable-p 'after-revert-hook)
5256 after-revert-hook))
5257 (inhibit-read-only t))
5258 (cond
5259 (revert-buffer-insert-file-contents-function
5260 (unless (eq buffer-undo-list t)
5261 ;; Get rid of all undo records for this buffer.
5262 (setq buffer-undo-list nil))
5263 ;; Don't make undo records for the reversion.
5264 (let ((buffer-undo-list t))
5265 (funcall revert-buffer-insert-file-contents-function
5266 file-name auto-save-p)))
5267 ((not (file-exists-p file-name))
5268 (error (if buffer-file-number
5269 "File %s no longer exists!"
5270 "Cannot revert nonexistent file %s")
5271 file-name))
5272 ((not (file-readable-p file-name))
5273 (error (if buffer-file-number
5274 "File %s no longer readable!"
5275 "Cannot revert unreadable file %s")
5276 file-name))
5277 (t
5278 ;; Bind buffer-file-name to nil
5279 ;; so that we don't try to lock the file.
5280 (let ((buffer-file-name nil))
5281 (or auto-save-p
5282 (unlock-buffer)))
5283 (widen)
5284 (let ((coding-system-for-read
5285 ;; Auto-saved file should be read by Emacs's
5286 ;; internal coding.
5287 (if auto-save-p 'auto-save-coding
5288 (or coding-system-for-read
5289 (and
5290 buffer-file-coding-system-explicit
5291 (car buffer-file-coding-system-explicit))))))
5292 (if (and (not enable-multibyte-characters)
5293 coding-system-for-read
5294 (not (memq (coding-system-base
5295 coding-system-for-read)
5296 '(no-conversion raw-text))))
5297 ;; As a coding system suitable for multibyte
5298 ;; buffer is specified, make the current
5299 ;; buffer multibyte.
5300 (set-buffer-multibyte t))
5301
5302 ;; This force after-insert-file-set-coding
5303 ;; (called from insert-file-contents) to set
5304 ;; buffer-file-coding-system to a proper value.
5305 (kill-local-variable 'buffer-file-coding-system)
5306
5307 ;; Note that this preserves point in an intelligent way.
5308 (if preserve-modes
5309 (let ((buffer-file-format buffer-file-format))
5310 (insert-file-contents file-name (not auto-save-p)
5311 nil nil t))
5312 (insert-file-contents file-name (not auto-save-p)
5313 nil nil t)))))
5314 ;; Recompute the truename in case changes in symlinks
5315 ;; have changed the truename.
5316 (setq buffer-file-truename
5317 (abbreviate-file-name (file-truename buffer-file-name)))
5318 (after-find-file nil nil t nil preserve-modes)
5319 ;; Run after-revert-hook as it was before we reverted.
5320 (setq-default revert-buffer-internal-hook global-hook)
5321 (if local-hook
5322 (set (make-local-variable 'revert-buffer-internal-hook)
5323 local-hook)
5324 (kill-local-variable 'revert-buffer-internal-hook))
5325 (run-hooks 'revert-buffer-internal-hook))
5326 t))))))
5327
5328 (defun recover-this-file ()
5329 "Recover the visited file--get contents from its last auto-save file."
5330 (interactive)
5331 (recover-file buffer-file-name))
5332
5333 (defun recover-file (file)
5334 "Visit file FILE, but get contents from its last auto-save file."
5335 ;; Actually putting the file name in the minibuffer should be used
5336 ;; only rarely.
5337 ;; Not just because users often use the default.
5338 (interactive "FRecover file: ")
5339 (setq file (expand-file-name file))
5340 (if (auto-save-file-name-p (file-name-nondirectory file))
5341 (error "%s is an auto-save file" (abbreviate-file-name file)))
5342 (let ((file-name (let ((buffer-file-name file))
5343 (make-auto-save-file-name))))
5344 (cond ((if (file-exists-p file)
5345 (not (file-newer-than-file-p file-name file))
5346 (not (file-exists-p file-name)))
5347 (error "Auto-save file %s not current"
5348 (abbreviate-file-name file-name)))
5349 ((with-temp-buffer-window
5350 "*Directory*" nil
5351 #'(lambda (window _value)
5352 (with-selected-window window
5353 (unwind-protect
5354 (yes-or-no-p (format "Recover auto save file %s? " file-name))
5355 (when (window-live-p window)
5356 (quit-restore-window window 'kill)))))
5357 (with-current-buffer standard-output
5358 (let ((switches dired-listing-switches))
5359 (if (file-symlink-p file)
5360 (setq switches (concat switches " -L")))
5361 ;; Use insert-directory-safely, not insert-directory,
5362 ;; because these files might not exist. In particular,
5363 ;; FILE might not exist if the auto-save file was for
5364 ;; a buffer that didn't visit a file, such as "*mail*".
5365 ;; The code in v20.x called `ls' directly, so we need
5366 ;; to emulate what `ls' did in that case.
5367 (insert-directory-safely file switches)
5368 (insert-directory-safely file-name switches))))
5369 (switch-to-buffer (find-file-noselect file t))
5370 (let ((inhibit-read-only t)
5371 ;; Keep the current buffer-file-coding-system.
5372 (coding-system buffer-file-coding-system)
5373 ;; Auto-saved file should be read with special coding.
5374 (coding-system-for-read 'auto-save-coding))
5375 (erase-buffer)
5376 (insert-file-contents file-name nil)
5377 (set-buffer-file-coding-system coding-system))
5378 (after-find-file nil nil t))
5379 (t (user-error "Recover-file cancelled")))))
5380
5381 (defun recover-session ()
5382 "Recover auto save files from a previous Emacs session.
5383 This command first displays a Dired buffer showing you the
5384 previous sessions that you could recover from.
5385 To choose one, move point to the proper line and then type C-c C-c.
5386 Then you'll be asked about a number of files to recover."
5387 (interactive)
5388 (if (null auto-save-list-file-prefix)
5389 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5390 (let ((dir (file-name-directory auto-save-list-file-prefix)))
5391 (unless (file-directory-p dir)
5392 (make-directory dir t))
5393 (unless (directory-files dir nil
5394 (concat "\\`" (regexp-quote
5395 (file-name-nondirectory
5396 auto-save-list-file-prefix)))
5397 t)
5398 (error "No previous sessions to recover")))
5399 (let ((ls-lisp-support-shell-wildcards t))
5400 (dired (concat auto-save-list-file-prefix "*")
5401 (concat dired-listing-switches " -t")))
5402 (save-excursion
5403 (goto-char (point-min))
5404 (or (looking-at " Move to the session you want to recover,")
5405 (let ((inhibit-read-only t))
5406 ;; Each line starts with a space
5407 ;; so that Font Lock mode won't highlight the first character.
5408 (insert " Move to the session you want to recover,\n"
5409 " then type C-c C-c to select it.\n\n"
5410 " You can also delete some of these files;\n"
5411 " type d on a line to mark that file for deletion.\n\n"))))
5412 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5413 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
5414
5415 (defun recover-session-finish ()
5416 "Choose one saved session to recover auto-save files from.
5417 This command is used in the special Dired buffer created by
5418 \\[recover-session]."
5419 (interactive)
5420 ;; Get the name of the session file to recover from.
5421 (let ((file (dired-get-filename))
5422 files
5423 (buffer (get-buffer-create " *recover*")))
5424 (dired-unmark 1)
5425 (dired-do-flagged-delete t)
5426 (unwind-protect
5427 (with-current-buffer buffer
5428 ;; Read in the auto-save-list file.
5429 (erase-buffer)
5430 (insert-file-contents file)
5431 ;; Loop thru the text of that file
5432 ;; and get out the names of the files to recover.
5433 (while (not (eobp))
5434 (let (thisfile autofile)
5435 (if (eolp)
5436 ;; This is a pair of lines for a non-file-visiting buffer.
5437 ;; Get the auto-save file name and manufacture
5438 ;; a "visited file name" from that.
5439 (progn
5440 (forward-line 1)
5441 ;; If there is no auto-save file name, the
5442 ;; auto-save-list file is probably corrupted.
5443 (unless (eolp)
5444 (setq autofile
5445 (buffer-substring-no-properties
5446 (point)
5447 (line-end-position)))
5448 (setq thisfile
5449 (expand-file-name
5450 (substring
5451 (file-name-nondirectory autofile)
5452 1 -1)
5453 (file-name-directory autofile))))
5454 (forward-line 1))
5455 ;; This pair of lines is a file-visiting
5456 ;; buffer. Use the visited file name.
5457 (progn
5458 (setq thisfile
5459 (buffer-substring-no-properties
5460 (point) (progn (end-of-line) (point))))
5461 (forward-line 1)
5462 (setq autofile
5463 (buffer-substring-no-properties
5464 (point) (progn (end-of-line) (point))))
5465 (forward-line 1)))
5466 ;; Ignore a file if its auto-save file does not exist now.
5467 (if (and autofile (file-exists-p autofile))
5468 (setq files (cons thisfile files)))))
5469 (setq files (nreverse files))
5470 ;; The file contains a pair of line for each auto-saved buffer.
5471 ;; The first line of the pair contains the visited file name
5472 ;; or is empty if the buffer was not visiting a file.
5473 ;; The second line is the auto-save file name.
5474 (if files
5475 (map-y-or-n-p "Recover %s? "
5476 (lambda (file)
5477 (condition-case nil
5478 (save-excursion (recover-file file))
5479 (error
5480 "Failed to recover `%s'" file)))
5481 files
5482 '("file" "files" "recover"))
5483 (message "No files can be recovered from this session now")))
5484 (kill-buffer buffer))))
5485
5486 (defun kill-buffer-ask (buffer)
5487 "Kill BUFFER if confirmed."
5488 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5489 (buffer-name buffer)
5490 (if (buffer-modified-p buffer)
5491 "HAS BEEN EDITED" "is unmodified")))
5492 (kill-buffer buffer)))
5493
5494 (defun kill-some-buffers (&optional list)
5495 "Kill some buffers. Asks the user whether to kill each one of them.
5496 Non-interactively, if optional argument LIST is non-nil, it
5497 specifies the list of buffers to kill, asking for approval for each one."
5498 (interactive)
5499 (if (null list)
5500 (setq list (buffer-list)))
5501 (while list
5502 (let* ((buffer (car list))
5503 (name (buffer-name buffer)))
5504 (and name ; Can be nil for an indirect buffer
5505 ; if we killed the base buffer.
5506 (not (string-equal name ""))
5507 (/= (aref name 0) ?\s)
5508 (kill-buffer-ask buffer)))
5509 (setq list (cdr list))))
5510
5511 (defun kill-matching-buffers (regexp &optional internal-too)
5512 "Kill buffers whose name matches the specified REGEXP.
5513 The optional second argument indicates whether to kill internal buffers too."
5514 (interactive "sKill buffers matching this regular expression: \nP")
5515 (dolist (buffer (buffer-list))
5516 (let ((name (buffer-name buffer)))
5517 (when (and name (not (string-equal name ""))
5518 (or internal-too (/= (aref name 0) ?\s))
5519 (string-match regexp name))
5520 (kill-buffer-ask buffer)))))
5521
5522 \f
5523 (defun rename-auto-save-file ()
5524 "Adjust current buffer's auto save file name for current conditions.
5525 Also rename any existing auto save file, if it was made in this session."
5526 (let ((osave buffer-auto-save-file-name))
5527 (setq buffer-auto-save-file-name
5528 (make-auto-save-file-name))
5529 (if (and osave buffer-auto-save-file-name
5530 (not (string= buffer-auto-save-file-name buffer-file-name))
5531 (not (string= buffer-auto-save-file-name osave))
5532 (file-exists-p osave)
5533 (recent-auto-save-p))
5534 (rename-file osave buffer-auto-save-file-name t))))
5535
5536 (defun make-auto-save-file-name ()
5537 "Return file name to use for auto-saves of current buffer.
5538 Does not consider `auto-save-visited-file-name' as that variable is checked
5539 before calling this function. You can redefine this for customization.
5540 See also `auto-save-file-name-p'."
5541 (if buffer-file-name
5542 (let ((handler (find-file-name-handler buffer-file-name
5543 'make-auto-save-file-name)))
5544 (if handler
5545 (funcall handler 'make-auto-save-file-name)
5546 (let ((list auto-save-file-name-transforms)
5547 (filename buffer-file-name)
5548 result uniq)
5549 ;; Apply user-specified translations
5550 ;; to the file name.
5551 (while (and list (not result))
5552 (if (string-match (car (car list)) filename)
5553 (setq result (replace-match (cadr (car list)) t nil
5554 filename)
5555 uniq (car (cddr (car list)))))
5556 (setq list (cdr list)))
5557 (if result
5558 (if uniq
5559 (setq filename (concat
5560 (file-name-directory result)
5561 (subst-char-in-string
5562 ?/ ?!
5563 (replace-regexp-in-string "!" "!!"
5564 filename))))
5565 (setq filename result)))
5566 (setq result
5567 (if (and (eq system-type 'ms-dos)
5568 (not (msdos-long-file-names)))
5569 ;; We truncate the file name to DOS 8+3 limits
5570 ;; before doing anything else, because the regexp
5571 ;; passed to string-match below cannot handle
5572 ;; extensions longer than 3 characters, multiple
5573 ;; dots, and other atrocities.
5574 (let ((fn (dos-8+3-filename
5575 (file-name-nondirectory buffer-file-name))))
5576 (string-match
5577 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5578 fn)
5579 (concat (file-name-directory buffer-file-name)
5580 "#" (match-string 1 fn)
5581 "." (match-string 3 fn) "#"))
5582 (concat (file-name-directory filename)
5583 "#"
5584 (file-name-nondirectory filename)
5585 "#")))
5586 ;; Make sure auto-save file names don't contain characters
5587 ;; invalid for the underlying filesystem.
5588 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5589 ;; Don't modify remote (ange-ftp) filenames
5590 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5591 (convert-standard-filename result)
5592 result))))
5593
5594 ;; Deal with buffers that don't have any associated files. (Mail
5595 ;; mode tends to create a good number of these.)
5596
5597 (let ((buffer-name (buffer-name))
5598 (limit 0)
5599 file-name)
5600 ;; Restrict the characters used in the file name to those which
5601 ;; are known to be safe on all filesystems, url-encoding the
5602 ;; rest.
5603 ;; We do this on all platforms, because even if we are not
5604 ;; running on DOS/Windows, the current directory may be on a
5605 ;; mounted VFAT filesystem, such as a USB memory stick.
5606 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5607 (let* ((character (aref buffer-name (match-beginning 0)))
5608 (replacement
5609 ;; For multibyte characters, this will produce more than
5610 ;; 2 hex digits, so is not true URL encoding.
5611 (format "%%%02X" character)))
5612 (setq buffer-name (replace-match replacement t t buffer-name))
5613 (setq limit (1+ (match-end 0)))))
5614 ;; Generate the file name.
5615 (setq file-name
5616 (make-temp-file
5617 (let ((fname
5618 (expand-file-name
5619 (format "#%s#" buffer-name)
5620 ;; Try a few alternative directories, to get one we can
5621 ;; write it.
5622 (cond
5623 ((file-writable-p default-directory) default-directory)
5624 ((file-writable-p "/var/tmp/") "/var/tmp/")
5625 ("~/")))))
5626 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5627 ;; Don't modify remote (ange-ftp) filenames
5628 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5629 ;; The call to convert-standard-filename is in case
5630 ;; buffer-name includes characters not allowed by the
5631 ;; DOS/Windows filesystems. make-temp-file writes to the
5632 ;; file it creates, so we must fix the file name _before_
5633 ;; make-temp-file is called.
5634 (convert-standard-filename fname)
5635 fname))
5636 nil "#"))
5637 ;; make-temp-file creates the file,
5638 ;; but we don't want it to exist until we do an auto-save.
5639 (condition-case ()
5640 (delete-file file-name)
5641 (file-error nil))
5642 file-name)))
5643
5644 (defun auto-save-file-name-p (filename)
5645 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5646 FILENAME should lack slashes. You can redefine this for customization."
5647 (string-match "^#.*#$" filename))
5648 \f
5649 (defun wildcard-to-regexp (wildcard)
5650 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5651 The generated regexp will match a filename only if the filename
5652 matches that wildcard according to shell rules. Only wildcards known
5653 by `sh' are supported."
5654 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5655 ;; Copy the initial run of non-special characters.
5656 (result (substring wildcard 0 i))
5657 (len (length wildcard)))
5658 ;; If no special characters, we're almost done.
5659 (if i
5660 (while (< i len)
5661 (let ((ch (aref wildcard i))
5662 j)
5663 (setq
5664 result
5665 (concat result
5666 (cond
5667 ((and (eq ch ?\[)
5668 (< (1+ i) len)
5669 (eq (aref wildcard (1+ i)) ?\]))
5670 "\\[")
5671 ((eq ch ?\[) ; [...] maps to regexp char class
5672 (progn
5673 (setq i (1+ i))
5674 (concat
5675 (cond
5676 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5677 (progn
5678 (setq i (1+ i))
5679 (if (eq (aref wildcard i) ?\])
5680 (progn
5681 (setq i (1+ i))
5682 "[^]")
5683 "[^")))
5684 ((eq (aref wildcard i) ?^)
5685 ;; Found "[^". Insert a `\0' character
5686 ;; (which cannot happen in a filename)
5687 ;; into the character class, so that `^'
5688 ;; is not the first character after `[',
5689 ;; and thus non-special in a regexp.
5690 (progn
5691 (setq i (1+ i))
5692 "[\000^"))
5693 ((eq (aref wildcard i) ?\])
5694 ;; I don't think `]' can appear in a
5695 ;; character class in a wildcard, but
5696 ;; let's be general here.
5697 (progn
5698 (setq i (1+ i))
5699 "[]"))
5700 (t "["))
5701 (prog1 ; copy everything upto next `]'.
5702 (substring wildcard
5703 i
5704 (setq j (string-match
5705 "]" wildcard i)))
5706 (setq i (if j (1- j) (1- len)))))))
5707 ((eq ch ?.) "\\.")
5708 ((eq ch ?*) "[^\000]*")
5709 ((eq ch ?+) "\\+")
5710 ((eq ch ?^) "\\^")
5711 ((eq ch ?$) "\\$")
5712 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5713 ((eq ch ??) "[^\000]")
5714 (t (char-to-string ch)))))
5715 (setq i (1+ i)))))
5716 ;; Shell wildcards should match the entire filename,
5717 ;; not its part. Make the regexp say so.
5718 (concat "\\`" result "\\'")))
5719 \f
5720 (defcustom list-directory-brief-switches
5721 (purecopy "-CF")
5722 "Switches for `list-directory' to pass to `ls' for brief listing."
5723 :type 'string
5724 :group 'dired)
5725
5726 (defcustom list-directory-verbose-switches
5727 (purecopy "-l")
5728 "Switches for `list-directory' to pass to `ls' for verbose listing."
5729 :type 'string
5730 :group 'dired)
5731
5732 (defun file-expand-wildcards (pattern &optional full)
5733 "Expand wildcard pattern PATTERN.
5734 This returns a list of file names which match the pattern.
5735
5736 If PATTERN is written as an absolute file name,
5737 the values are absolute also.
5738
5739 If PATTERN is written as a relative file name, it is interpreted
5740 relative to the current default directory, `default-directory'.
5741 The file names returned are normally also relative to the current
5742 default directory. However, if FULL is non-nil, they are absolute."
5743 (save-match-data
5744 (let* ((nondir (file-name-nondirectory pattern))
5745 (dirpart (file-name-directory pattern))
5746 ;; A list of all dirs that DIRPART specifies.
5747 ;; This can be more than one dir
5748 ;; if DIRPART contains wildcards.
5749 (dirs (if (and dirpart
5750 (string-match "[[*?]"
5751 (or (file-remote-p dirpart 'localname)
5752 dirpart)))
5753 (mapcar 'file-name-as-directory
5754 (file-expand-wildcards (directory-file-name dirpart)))
5755 (list dirpart)))
5756 contents)
5757 (while dirs
5758 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5759 (and (file-directory-p (directory-file-name (car dirs)))
5760 (file-readable-p (car dirs))))
5761 (let ((this-dir-contents
5762 ;; Filter out "." and ".."
5763 (delq nil
5764 (mapcar #'(lambda (name)
5765 (unless (string-match "\\`\\.\\.?\\'"
5766 (file-name-nondirectory name))
5767 name))
5768 (directory-files (or (car dirs) ".") full
5769 (wildcard-to-regexp nondir))))))
5770 (setq contents
5771 (nconc
5772 (if (and (car dirs) (not full))
5773 (mapcar (function (lambda (name) (concat (car dirs) name)))
5774 this-dir-contents)
5775 this-dir-contents)
5776 contents))))
5777 (setq dirs (cdr dirs)))
5778 contents)))
5779
5780 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5781 (provide 'files '(remote-wildcards))
5782
5783 (defun list-directory (dirname &optional verbose)
5784 "Display a list of files in or matching DIRNAME, a la `ls'.
5785 DIRNAME is globbed by the shell if necessary.
5786 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5787 Actions controlled by variables `list-directory-brief-switches'
5788 and `list-directory-verbose-switches'."
5789 (interactive (let ((pfx current-prefix-arg))
5790 (list (read-directory-name (if pfx "List directory (verbose): "
5791 "List directory (brief): ")
5792 nil default-directory nil)
5793 pfx)))
5794 (let ((switches (if verbose list-directory-verbose-switches
5795 list-directory-brief-switches))
5796 buffer)
5797 (or dirname (setq dirname default-directory))
5798 (setq dirname (expand-file-name dirname))
5799 (with-output-to-temp-buffer "*Directory*"
5800 (setq buffer standard-output)
5801 (buffer-disable-undo standard-output)
5802 (princ "Directory ")
5803 (princ dirname)
5804 (terpri)
5805 (with-current-buffer "*Directory*"
5806 (let ((wildcard (not (file-directory-p dirname))))
5807 (insert-directory dirname switches wildcard (not wildcard)))))
5808 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5809 (with-current-buffer buffer
5810 (setq default-directory
5811 (if (file-directory-p dirname)
5812 (file-name-as-directory dirname)
5813 (file-name-directory dirname))))))
5814
5815 (defun shell-quote-wildcard-pattern (pattern)
5816 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5817
5818 PATTERN is assumed to represent a file-name wildcard suitable for the
5819 underlying filesystem. For Unix and GNU/Linux, each character from the
5820 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5821 the parts of the pattern which don't include wildcard characters are
5822 quoted with double quotes.
5823
5824 This function leaves alone existing quote characters (\\ on Unix and \"
5825 on Windows), so PATTERN can use them to quote wildcard characters that
5826 need to be passed verbatim to shell commands."
5827 (save-match-data
5828 (cond
5829 ((memq system-type '(ms-dos windows-nt cygwin))
5830 ;; DOS/Windows don't allow `"' in file names. So if the
5831 ;; argument has quotes, we can safely assume it is already
5832 ;; quoted by the caller.
5833 (if (or (string-match "[\"]" pattern)
5834 ;; We quote [&()#$'] in case their shell is a port of a
5835 ;; Unixy shell. We quote [,=+] because stock DOS and
5836 ;; Windows shells require that in some cases, such as
5837 ;; passing arguments to batch files that use positional
5838 ;; arguments like %1.
5839 (not (string-match "[ \t;&()#$',=+]" pattern)))
5840 pattern
5841 (let ((result "\"")
5842 (beg 0)
5843 end)
5844 (while (string-match "[*?]+" pattern beg)
5845 (setq end (match-beginning 0)
5846 result (concat result (substring pattern beg end)
5847 "\""
5848 (substring pattern end (match-end 0))
5849 "\"")
5850 beg (match-end 0)))
5851 (concat result (substring pattern beg) "\""))))
5852 (t
5853 (let ((beg 0))
5854 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5855 (setq pattern
5856 (concat (substring pattern 0 (match-beginning 0))
5857 "\\"
5858 (substring pattern (match-beginning 0)))
5859 beg (1+ (match-end 0)))))
5860 pattern))))
5861
5862
5863 (defvar insert-directory-program (purecopy "ls")
5864 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5865
5866 (defcustom directory-free-space-program (purecopy "df")
5867 "Program to get the amount of free space on a file system.
5868 We assume the output has the format of `df'.
5869 The value of this variable must be just a command name or file name;
5870 if you want to specify options, use `directory-free-space-args'.
5871
5872 A value of nil disables this feature.
5873
5874 If the function `file-system-info' is defined, it is always used in
5875 preference to the program given by this variable."
5876 :type '(choice (string :tag "Program") (const :tag "None" nil))
5877 :group 'dired)
5878
5879 (defcustom directory-free-space-args
5880 (purecopy (if (eq system-type 'darwin) "-k" "-Pk"))
5881 "Options to use when running `directory-free-space-program'."
5882 :type 'string
5883 :group 'dired)
5884
5885 (defun get-free-disk-space (dir)
5886 "Return the amount of free space on directory DIR's file system.
5887 The return value is a string describing the amount of free
5888 space (normally, the number of free 1KB blocks).
5889
5890 This function calls `file-system-info' if it is available, or
5891 invokes the program specified by `directory-free-space-program'
5892 and `directory-free-space-args'. If the system call or program
5893 is unsuccessful, or if DIR is a remote directory, this function
5894 returns nil."
5895 (unless (file-remote-p dir)
5896 ;; Try to find the number of free blocks. Non-Posix systems don't
5897 ;; always have df, but might have an equivalent system call.
5898 (if (fboundp 'file-system-info)
5899 (let ((fsinfo (file-system-info dir)))
5900 (if fsinfo
5901 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5902 (setq dir (expand-file-name dir))
5903 (save-match-data
5904 (with-temp-buffer
5905 (when (and directory-free-space-program
5906 ;; Avoid failure if the default directory does
5907 ;; not exist (Bug#2631, Bug#3911).
5908 (let ((default-directory
5909 (locate-dominating-file dir 'file-directory-p)))
5910 (eq (process-file directory-free-space-program
5911 nil t nil
5912 directory-free-space-args
5913 (file-relative-name dir))
5914 0)))
5915 ;; Assume that the "available" column is before the
5916 ;; "capacity" column. Find the "%" and scan backward.
5917 (goto-char (point-min))
5918 (forward-line 1)
5919 (when (re-search-forward
5920 "[[:space:]]+[^[:space:]]+%[^%]*$"
5921 (line-end-position) t)
5922 (goto-char (match-beginning 0))
5923 (let ((endpt (point)))
5924 (skip-chars-backward "^[:space:]")
5925 (buffer-substring-no-properties (point) endpt)))))))))
5926
5927 ;; The following expression replaces `dired-move-to-filename-regexp'.
5928 (defvar directory-listing-before-filename-regexp
5929 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5930 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5931 ;; In some locales, month abbreviations are as short as 2 letters,
5932 ;; and they can be followed by ".".
5933 ;; In Breton, a month name can include a quote character.
5934 (month (concat l-or-quote l-or-quote "+\\.?"))
5935 (s " ")
5936 (yyyy "[0-9][0-9][0-9][0-9]")
5937 (dd "[ 0-3][0-9]")
5938 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5939 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5940 (zone "[-+][0-2][0-9][0-5][0-9]")
5941 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5942 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5943 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5944 "\\|" yyyy "-" iso-mm-dd "\\)"))
5945 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5946 s "+"
5947 "\\(" HH:MM "\\|" yyyy "\\)"))
5948 (western-comma (concat month s "+" dd "," s "+" yyyy))
5949 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5950 ;; omits the Kanji characters after month and day-of-month.
5951 ;; On Mac OS X 10.3, the date format in East Asian locales is
5952 ;; day-of-month digits followed by month digits.
5953 (mm "[ 0-1]?[0-9]")
5954 (east-asian
5955 (concat "\\(" mm l "?" s dd l "?" s "+"
5956 "\\|" dd s mm s "+" "\\)"
5957 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5958 ;; The "[0-9]" below requires the previous column to end in a digit.
5959 ;; This avoids recognizing `1 may 1997' as a date in the line:
5960 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5961
5962 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5963
5964 ;; For non-iso date formats, we add the ".*" in order to find
5965 ;; the last possible match. This avoids recognizing
5966 ;; `jservice 10 1024' as a date in the line:
5967 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5968
5969 ;; vc dired listings provide the state or blanks between file
5970 ;; permissions and date. The state is always surrounded by
5971 ;; parentheses:
5972 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5973 ;; This is not supported yet.
5974 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5975 "\\|.*[0-9][BkKMGTPEZY]? "
5976 "\\(" western "\\|" western-comma "\\|" east-asian "\\)"
5977 "\\) +")))
5978 "Regular expression to match up to the file name in a directory listing.
5979 The default value is designed to recognize dates and times
5980 regardless of the language.")
5981
5982 (defvar insert-directory-ls-version 'unknown)
5983
5984 ;; insert-directory
5985 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5986 ;; FULL-DIRECTORY-P is nil.
5987 ;; The single line of output must display FILE's name as it was
5988 ;; given, namely, an absolute path name.
5989 ;; - must insert exactly one line for each file if WILDCARD or
5990 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5991 ;; before the file lines, plus optional text after the file lines.
5992 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5993 ;; allowed.
5994 ;; File lines should display the basename.
5995 ;; - must be consistent with
5996 ;; - functions dired-move-to-filename, (these two define what a file line is)
5997 ;; dired-move-to-end-of-filename,
5998 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5999 ;; dired-insert-headerline
6000 ;; dired-after-subdir-garbage (defines what a "total" line is)
6001 ;; - variable dired-subdir-regexp
6002 ;; - may be passed "--dired" as the first argument in SWITCHES.
6003 ;; Filename handlers might have to remove this switch if their
6004 ;; "ls" command does not support it.
6005 (defun insert-directory (file switches &optional wildcard full-directory-p)
6006 "Insert directory listing for FILE, formatted according to SWITCHES.
6007 Leaves point after the inserted text.
6008 SWITCHES may be a string of options, or a list of strings
6009 representing individual options.
6010 Optional third arg WILDCARD means treat FILE as shell wildcard.
6011 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6012 switches do not contain `d', so that a full listing is expected.
6013
6014 This works by running a directory listing program
6015 whose name is in the variable `insert-directory-program'.
6016 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6017
6018 When SWITCHES contains the long `--dired' option, this function
6019 treats it specially, for the sake of dired. However, the
6020 normally equivalent short `-D' option is just passed on to
6021 `insert-directory-program', as any other option."
6022 ;; We need the directory in order to find the right handler.
6023 (let ((handler (find-file-name-handler (expand-file-name file)
6024 'insert-directory)))
6025 (if handler
6026 (funcall handler 'insert-directory file switches
6027 wildcard full-directory-p)
6028 (let (result (beg (point)))
6029
6030 ;; Read the actual directory using `insert-directory-program'.
6031 ;; RESULT gets the status code.
6032 (let* (;; We at first read by no-conversion, then after
6033 ;; putting text property `dired-filename, decode one
6034 ;; bunch by one to preserve that property.
6035 (coding-system-for-read 'no-conversion)
6036 ;; This is to control encoding the arguments in call-process.
6037 (coding-system-for-write
6038 (and enable-multibyte-characters
6039 (or file-name-coding-system
6040 default-file-name-coding-system))))
6041 (setq result
6042 (if wildcard
6043 ;; Run ls in the directory part of the file pattern
6044 ;; using the last component as argument.
6045 (let ((default-directory
6046 (if (file-name-absolute-p file)
6047 (file-name-directory file)
6048 (file-name-directory (expand-file-name file))))
6049 (pattern (file-name-nondirectory file)))
6050 ;; NB since switches is passed to the shell, be
6051 ;; careful of malicious values, eg "-l;reboot".
6052 ;; See eg dired-safe-switches-p.
6053 (call-process
6054 shell-file-name nil t nil
6055 "-c"
6056 (concat (if (memq system-type '(ms-dos windows-nt))
6057 ""
6058 "\\") ; Disregard Unix shell aliases!
6059 insert-directory-program
6060 " -d "
6061 (if (stringp switches)
6062 switches
6063 (mapconcat 'identity switches " "))
6064 " -- "
6065 ;; Quote some characters that have
6066 ;; special meanings in shells; but
6067 ;; don't quote the wildcards--we want
6068 ;; them to be special. We also
6069 ;; currently don't quote the quoting
6070 ;; characters in case people want to
6071 ;; use them explicitly to quote
6072 ;; wildcard characters.
6073 (shell-quote-wildcard-pattern pattern))))
6074 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6075 ;; directory if FILE is a symbolic link.
6076 (unless full-directory-p
6077 (setq switches
6078 (if (stringp switches)
6079 (concat switches " -d")
6080 (add-to-list 'switches "-d" 'append))))
6081 (apply 'call-process
6082 insert-directory-program nil t nil
6083 (append
6084 (if (listp switches) switches
6085 (unless (equal switches "")
6086 ;; Split the switches at any spaces so we can
6087 ;; pass separate options as separate args.
6088 (split-string switches)))
6089 ;; Avoid lossage if FILE starts with `-'.
6090 '("--")
6091 (progn
6092 (if (string-match "\\`~" file)
6093 (setq file (expand-file-name file)))
6094 (list
6095 (if full-directory-p
6096 (concat (file-name-as-directory file) ".")
6097 file))))))))
6098
6099 ;; If we got "//DIRED//" in the output, it means we got a real
6100 ;; directory listing, even if `ls' returned nonzero.
6101 ;; So ignore any errors.
6102 (when (if (stringp switches)
6103 (string-match "--dired\\>" switches)
6104 (member "--dired" switches))
6105 (save-excursion
6106 (forward-line -2)
6107 (when (looking-at "//SUBDIRED//")
6108 (forward-line -1))
6109 (if (looking-at "//DIRED//")
6110 (setq result 0))))
6111
6112 (when (and (not (eq 0 result))
6113 (eq insert-directory-ls-version 'unknown))
6114 ;; The first time ls returns an error,
6115 ;; find the version numbers of ls,
6116 ;; and set insert-directory-ls-version
6117 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6118 ;; is equal or if the info cannot be obtained.
6119 ;; (That can mean it isn't GNU ls.)
6120 (let ((version-out
6121 (with-temp-buffer
6122 (call-process "ls" nil t nil "--version")
6123 (buffer-string))))
6124 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
6125 (let* ((version (match-string 1 version-out))
6126 (split (split-string version "[.]"))
6127 (numbers (mapcar 'string-to-number split))
6128 (min '(5 2 1))
6129 comparison)
6130 (while (and (not comparison) (or numbers min))
6131 (cond ((null min)
6132 (setq comparison '>))
6133 ((null numbers)
6134 (setq comparison '<))
6135 ((> (car numbers) (car min))
6136 (setq comparison '>))
6137 ((< (car numbers) (car min))
6138 (setq comparison '<))
6139 (t
6140 (setq numbers (cdr numbers)
6141 min (cdr min)))))
6142 (setq insert-directory-ls-version (or comparison '=)))
6143 (setq insert-directory-ls-version nil))))
6144
6145 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6146 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
6147 (setq result 0))
6148
6149 ;; If `insert-directory-program' failed, signal an error.
6150 (unless (eq 0 result)
6151 ;; Delete the error message it may have output.
6152 (delete-region beg (point))
6153 ;; On non-Posix systems, we cannot open a directory, so
6154 ;; don't even try, because that will always result in
6155 ;; the ubiquitous "Access denied". Instead, show the
6156 ;; command line so the user can try to guess what went wrong.
6157 (if (and (file-directory-p file)
6158 (memq system-type '(ms-dos windows-nt)))
6159 (error
6160 "Reading directory: \"%s %s -- %s\" exited with status %s"
6161 insert-directory-program
6162 (if (listp switches) (concat switches) switches)
6163 file result)
6164 ;; Unix. Access the file to get a suitable error.
6165 (access-file file "Reading directory")
6166 (error "Listing directory failed but `access-file' worked")))
6167
6168 (when (if (stringp switches)
6169 (string-match "--dired\\>" switches)
6170 (member "--dired" switches))
6171 ;; The following overshoots by one line for an empty
6172 ;; directory listed with "--dired", but without "-a"
6173 ;; switch, where the ls output contains a
6174 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6175 ;; We take care of that case later.
6176 (forward-line -2)
6177 (when (looking-at "//SUBDIRED//")
6178 (delete-region (point) (progn (forward-line 1) (point)))
6179 (forward-line -1))
6180 (if (looking-at "//DIRED//")
6181 (let ((end (line-end-position))
6182 (linebeg (point))
6183 error-lines)
6184 ;; Find all the lines that are error messages,
6185 ;; and record the bounds of each one.
6186 (goto-char beg)
6187 (while (< (point) linebeg)
6188 (or (eql (following-char) ?\s)
6189 (push (list (point) (line-end-position)) error-lines))
6190 (forward-line 1))
6191 (setq error-lines (nreverse error-lines))
6192 ;; Now read the numeric positions of file names.
6193 (goto-char linebeg)
6194 (forward-word 1)
6195 (forward-char 3)
6196 (while (< (point) end)
6197 (let ((start (insert-directory-adj-pos
6198 (+ beg (read (current-buffer)))
6199 error-lines))
6200 (end (insert-directory-adj-pos
6201 (+ beg (read (current-buffer)))
6202 error-lines)))
6203 (if (memq (char-after end) '(?\n ?\s))
6204 ;; End is followed by \n or by " -> ".
6205 (put-text-property start end 'dired-filename t)
6206 ;; It seems that we can't trust ls's output as to
6207 ;; byte positions of filenames.
6208 (put-text-property beg (point) 'dired-filename nil)
6209 (end-of-line))))
6210 (goto-char end)
6211 (beginning-of-line)
6212 (delete-region (point) (progn (forward-line 1) (point))))
6213 ;; Take care of the case where the ls output contains a
6214 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6215 ;; and we went one line too far back (see above).
6216 (forward-line 1))
6217 (if (looking-at "//DIRED-OPTIONS//")
6218 (delete-region (point) (progn (forward-line 1) (point)))))
6219
6220 ;; Now decode what read if necessary.
6221 (let ((coding (or coding-system-for-read
6222 file-name-coding-system
6223 default-file-name-coding-system
6224 'undecided))
6225 coding-no-eol
6226 val pos)
6227 (when (and enable-multibyte-characters
6228 (not (memq (coding-system-base coding)
6229 '(raw-text no-conversion))))
6230 ;; If no coding system is specified or detection is
6231 ;; requested, detect the coding.
6232 (if (eq (coding-system-base coding) 'undecided)
6233 (setq coding (detect-coding-region beg (point) t)))
6234 (if (not (eq (coding-system-base coding) 'undecided))
6235 (save-restriction
6236 (setq coding-no-eol
6237 (coding-system-change-eol-conversion coding 'unix))
6238 (narrow-to-region beg (point))
6239 (goto-char (point-min))
6240 (while (not (eobp))
6241 (setq pos (point)
6242 val (get-text-property (point) 'dired-filename))
6243 (goto-char (next-single-property-change
6244 (point) 'dired-filename nil (point-max)))
6245 ;; Force no eol conversion on a file name, so
6246 ;; that CR is preserved.
6247 (decode-coding-region pos (point)
6248 (if val coding-no-eol coding))
6249 (if val
6250 (put-text-property pos (point)
6251 'dired-filename t)))))))
6252
6253 (if full-directory-p
6254 ;; Try to insert the amount of free space.
6255 (save-excursion
6256 (goto-char beg)
6257 ;; First find the line to put it on.
6258 (when (re-search-forward "^ *\\(total\\)" nil t)
6259 (let ((available (get-free-disk-space ".")))
6260 (when available
6261 ;; Replace "total" with "used", to avoid confusion.
6262 (replace-match "total used in directory" nil nil nil 1)
6263 (end-of-line)
6264 (insert " available " available))))))))))
6265
6266 (defun insert-directory-adj-pos (pos error-lines)
6267 "Convert `ls --dired' file name position value POS to a buffer position.
6268 File name position values returned in ls --dired output
6269 count only stdout; they don't count the error messages sent to stderr.
6270 So this function converts to them to real buffer positions.
6271 ERROR-LINES is a list of buffer positions of error message lines,
6272 of the form (START END)."
6273 (while (and error-lines (< (caar error-lines) pos))
6274 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
6275 (pop error-lines))
6276 pos)
6277
6278 (defun insert-directory-safely (file switches
6279 &optional wildcard full-directory-p)
6280 "Insert directory listing for FILE, formatted according to SWITCHES.
6281
6282 Like `insert-directory', but if FILE does not exist, it inserts a
6283 message to that effect instead of signaling an error."
6284 (if (file-exists-p file)
6285 (insert-directory file switches wildcard full-directory-p)
6286 ;; Simulate the message printed by `ls'.
6287 (insert (format "%s: No such file or directory\n" file))))
6288
6289 (defvar kill-emacs-query-functions nil
6290 "Functions to call with no arguments to query about killing Emacs.
6291 If any of these functions returns nil, killing Emacs is canceled.
6292 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6293 the low level primitive, does not. See also `kill-emacs-hook'.")
6294
6295 (defcustom confirm-kill-emacs nil
6296 "How to ask for confirmation when leaving Emacs.
6297 If nil, the default, don't ask at all. If the value is non-nil, it should
6298 be a predicate function such as `yes-or-no-p'."
6299 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
6300 (const :tag "Ask with y-or-n-p" y-or-n-p)
6301 (const :tag "Don't confirm" nil))
6302 :group 'convenience
6303 :version "21.1")
6304
6305 (defun save-buffers-kill-emacs (&optional arg)
6306 "Offer to save each buffer, then kill this Emacs process.
6307 With prefix ARG, silently save all file-visiting buffers without asking.
6308 If there are active processes where `process-query-on-exit-flag'
6309 returns non-nil, asks whether processes should be killed.
6310 Runs the members of `kill-emacs-query-functions' in turn and stops
6311 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6312 (interactive "P")
6313 (save-some-buffers arg t)
6314 (and (or (not (memq t (mapcar (function
6315 (lambda (buf) (and (buffer-file-name buf)
6316 (buffer-modified-p buf))))
6317 (buffer-list))))
6318 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6319 (or (not (fboundp 'process-list))
6320 ;; process-list is not defined on MSDOS.
6321 (let ((processes (process-list))
6322 active)
6323 (while processes
6324 (and (memq (process-status (car processes)) '(run stop open listen))
6325 (process-query-on-exit-flag (car processes))
6326 (setq active t))
6327 (setq processes (cdr processes)))
6328 (or (not active)
6329 (with-temp-buffer-window
6330 (get-buffer-create "*Process List*") nil
6331 #'(lambda (window _value)
6332 (with-selected-window window
6333 (unwind-protect
6334 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")
6335 (when (window-live-p window)
6336 (quit-restore-window window 'kill)))))
6337 (list-processes t)))))
6338 ;; Query the user for other things, perhaps.
6339 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
6340 (or (null confirm-kill-emacs)
6341 (funcall confirm-kill-emacs "Really exit Emacs? "))
6342 (kill-emacs)))
6343
6344 (defun save-buffers-kill-terminal (&optional arg)
6345 "Offer to save each buffer, then kill the current connection.
6346 If the current frame has no client, kill Emacs itself.
6347
6348 With prefix ARG, silently save all file-visiting buffers, then kill.
6349
6350 If emacsclient was started with a list of filenames to edit, then
6351 only these files will be asked to be saved."
6352 (interactive "P")
6353 (if (frame-parameter (selected-frame) 'client)
6354 (server-save-buffers-kill-terminal arg)
6355 (save-buffers-kill-emacs arg)))
6356 \f
6357 ;; We use /: as a prefix to "quote" a file name
6358 ;; so that magic file name handlers will not apply to it.
6359
6360 (setq file-name-handler-alist
6361 (cons (cons (purecopy "\\`/:") 'file-name-non-special)
6362 file-name-handler-alist))
6363
6364 ;; We depend on being the last handler on the list,
6365 ;; so that anything else which does need handling
6366 ;; has been handled already.
6367 ;; So it is safe for us to inhibit *all* magic file name handlers.
6368
6369 (defun file-name-non-special (operation &rest arguments)
6370 (let ((file-name-handler-alist nil)
6371 (default-directory
6372 (if (eq operation 'insert-directory)
6373 (directory-file-name
6374 (expand-file-name
6375 (unhandled-file-name-directory default-directory)))
6376 default-directory))
6377 ;; Get a list of the indices of the args which are file names.
6378 (file-arg-indices
6379 (cdr (or (assq operation
6380 ;; The first six are special because they
6381 ;; return a file name. We want to include the /:
6382 ;; in the return value.
6383 ;; So just avoid stripping it in the first place.
6384 '((expand-file-name . nil)
6385 (file-name-directory . nil)
6386 (file-name-as-directory . nil)
6387 (directory-file-name . nil)
6388 (file-name-sans-versions . nil)
6389 (find-backup-file-name . nil)
6390 ;; `identity' means just return the first arg
6391 ;; not stripped of its quoting.
6392 (substitute-in-file-name identity)
6393 ;; `add' means add "/:" to the result.
6394 (file-truename add 0)
6395 (insert-file-contents insert-file-contents 0)
6396 ;; `unquote-then-quote' means set buffer-file-name
6397 ;; temporarily to unquoted filename.
6398 (verify-visited-file-modtime unquote-then-quote)
6399 ;; List the arguments which are filenames.
6400 (file-name-completion 1)
6401 (file-name-all-completions 1)
6402 (write-region 2 5)
6403 (rename-file 0 1)
6404 (copy-file 0 1)
6405 (make-symbolic-link 0 1)
6406 (add-name-to-file 0 1)))
6407 ;; For all other operations, treat the first argument only
6408 ;; as the file name.
6409 '(nil 0))))
6410 method
6411 ;; Copy ARGUMENTS so we can replace elements in it.
6412 (arguments (copy-sequence arguments)))
6413 (if (symbolp (car file-arg-indices))
6414 (setq method (pop file-arg-indices)))
6415 ;; Strip off the /: from the file names that have it.
6416 (save-match-data
6417 (while (consp file-arg-indices)
6418 (let ((pair (nthcdr (car file-arg-indices) arguments)))
6419 (and (car pair)
6420 (string-match "\\`/:" (car pair))
6421 (setcar pair
6422 (if (= (length (car pair)) 2)
6423 "/"
6424 (substring (car pair) 2)))))
6425 (setq file-arg-indices (cdr file-arg-indices))))
6426 (pcase method
6427 (`identity (car arguments))
6428 (`add (concat "/:" (apply operation arguments)))
6429 (`insert-file-contents
6430 (let ((visit (nth 1 arguments)))
6431 (prog1
6432 (apply operation arguments)
6433 (when (and visit buffer-file-name)
6434 (setq buffer-file-name (concat "/:" buffer-file-name))))))
6435 (`unquote-then-quote
6436 (let ((buffer-file-name (substring buffer-file-name 2)))
6437 (apply operation arguments)))
6438 (_
6439 (apply operation arguments)))))
6440 \f
6441 ;; Symbolic modes and read-file-modes.
6442
6443 (defun file-modes-char-to-who (char)
6444 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6445 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6446 Others, or All) for whom to produce the mask.
6447 The bit-mask that is returned extracts from mode bits the access rights
6448 for the specified category of users."
6449 (cond ((= char ?u) #o4700)
6450 ((= char ?g) #o2070)
6451 ((= char ?o) #o1007)
6452 ((= char ?a) #o7777)
6453 (t (error "%c: bad `who' character" char))))
6454
6455 (defun file-modes-char-to-right (char &optional from)
6456 "Convert CHAR to a numeric value of mode bits.
6457 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6458 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6459 (or from (setq from 0))
6460 (cond ((= char ?r) #o0444)
6461 ((= char ?w) #o0222)
6462 ((= char ?x) #o0111)
6463 ((= char ?s) #o1000)
6464 ((= char ?t) #o6000)
6465 ;; Rights relative to the previous file modes.
6466 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
6467 ((= char ?u) (let ((uright (logand #o4700 from)))
6468 (+ uright (/ uright #o10) (/ uright #o100))))
6469 ((= char ?g) (let ((gright (logand #o2070 from)))
6470 (+ gright (/ gright #o10) (* gright #o10))))
6471 ((= char ?o) (let ((oright (logand #o1007 from)))
6472 (+ oright (* oright #o10) (* oright #o100))))
6473 (t (error "%c: bad right character" char))))
6474
6475 (defun file-modes-rights-to-number (rights who-mask &optional from)
6476 "Convert a symbolic mode string specification to an equivalent number.
6477 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6478 WHO-MASK is the bit-mask specifying the category of users to which to
6479 apply the access permissions. See `file-modes-char-to-who'.
6480 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6481 RIGHTS request to add, remove, or set permissions based on existing ones,
6482 as in \"og+rX-w\"."
6483 (let* ((num-rights (or from 0))
6484 (list-rights (string-to-list rights))
6485 (op (pop list-rights)))
6486 (while (memq op '(?+ ?- ?=))
6487 (let ((num-right 0)
6488 char-right)
6489 (while (memq (setq char-right (pop list-rights))
6490 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
6491 (setq num-right
6492 (logior num-right
6493 (file-modes-char-to-right char-right num-rights))))
6494 (setq num-right (logand who-mask num-right)
6495 num-rights
6496 (cond ((= op ?+) (logior num-rights num-right))
6497 ((= op ?-) (logand num-rights (lognot num-right)))
6498 (t (logior (logand num-rights (lognot who-mask)) num-right)))
6499 op char-right)))
6500 num-rights))
6501
6502 (defun file-modes-symbolic-to-number (modes &optional from)
6503 "Convert symbolic file modes to numeric file modes.
6504 MODES is the string to convert, it should match
6505 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6506 See Info node `(coreutils)File permissions' for more information on this
6507 notation.
6508 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6509 MODES request to add, remove, or set permissions based on existing ones,
6510 as in \"og+rX-w\"."
6511 (save-match-data
6512 (let ((case-fold-search nil)
6513 (num-modes (or from 0)))
6514 (while (/= (string-to-char modes) 0)
6515 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6516 (let ((num-who (apply 'logior 0
6517 (mapcar 'file-modes-char-to-who
6518 (match-string 1 modes)))))
6519 (when (= num-who 0)
6520 (setq num-who (default-file-modes)))
6521 (setq num-modes
6522 (file-modes-rights-to-number (substring modes (match-end 1))
6523 num-who num-modes)
6524 modes (substring modes (match-end 3))))
6525 (error "Parse error in modes near `%s'" (substring modes 0))))
6526 num-modes)))
6527
6528 (defun read-file-modes (&optional prompt orig-file)
6529 "Read file modes in octal or symbolic notation and return its numeric value.
6530 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6531 ORIG-FILE is the name of a file on whose mode bits to base returned
6532 permissions if what user types requests to add, remove, or set permissions
6533 based on existing mode bits, as in \"og+rX-w\"."
6534 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6535 (error "File not found")))
6536 (modestr (and (stringp orig-file)
6537 (nth 8 (file-attributes orig-file))))
6538 (default
6539 (and (stringp modestr)
6540 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6541 (replace-regexp-in-string
6542 "-" ""
6543 (format "u=%s,g=%s,o=%s"
6544 (match-string 1 modestr)
6545 (match-string 2 modestr)
6546 (match-string 3 modestr)))))
6547 (value (read-string (or prompt "File modes (octal or symbolic): ")
6548 nil nil default)))
6549 (save-match-data
6550 (if (string-match "^[0-7]+" value)
6551 (string-to-number value 8)
6552 (file-modes-symbolic-to-number value modes)))))
6553
6554 \f
6555 ;; Trashcan handling.
6556 (defcustom trash-directory nil
6557 "Directory for `move-file-to-trash' to move files and directories to.
6558 This directory is only used when the function `system-move-file-to-trash'
6559 is not defined.
6560 Relative paths are interpreted relative to `default-directory'.
6561 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6562 :type '(choice (const nil) directory)
6563 :group 'auto-save
6564 :version "23.2")
6565
6566 (defvar trash--hexify-table)
6567
6568 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6569
6570 (defun move-file-to-trash (filename)
6571 "Move the file (or directory) named FILENAME to the trash.
6572 When `delete-by-moving-to-trash' is non-nil, this function is
6573 called by `delete-file' and `delete-directory' instead of
6574 deleting files outright.
6575
6576 If the function `system-move-file-to-trash' is defined, call it
6577 with FILENAME as an argument.
6578 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6579 directory.
6580 Otherwise, trash FILENAME using the freedesktop.org conventions,
6581 like the GNOME, KDE and XFCE desktop environments. Emacs only
6582 moves files to \"home trash\", ignoring per-volume trashcans."
6583 (interactive "fMove file to trash: ")
6584 (cond (trash-directory
6585 ;; If `trash-directory' is non-nil, move the file there.
6586 (let* ((trash-dir (expand-file-name trash-directory))
6587 (fn (directory-file-name (expand-file-name filename)))
6588 (new-fn (expand-file-name (file-name-nondirectory fn)
6589 trash-dir)))
6590 ;; We can't trash a parent directory of trash-directory.
6591 (if (string-prefix-p fn trash-dir)
6592 (error "Trash directory `%s' is a subdirectory of `%s'"
6593 trash-dir filename))
6594 (unless (file-directory-p trash-dir)
6595 (make-directory trash-dir t))
6596 ;; Ensure that the trashed file-name is unique.
6597 (if (file-exists-p new-fn)
6598 (let ((version-control t)
6599 (backup-directory-alist nil))
6600 (setq new-fn (car (find-backup-file-name new-fn)))))
6601 (let (delete-by-moving-to-trash)
6602 (rename-file fn new-fn))))
6603 ;; If `system-move-file-to-trash' is defined, use it.
6604 ((fboundp 'system-move-file-to-trash)
6605 (system-move-file-to-trash filename))
6606 ;; Otherwise, use the freedesktop.org method, as specified at
6607 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6608 (t
6609 (let* ((xdg-data-dir
6610 (directory-file-name
6611 (expand-file-name "Trash"
6612 (or (getenv "XDG_DATA_HOME")
6613 "~/.local/share"))))
6614 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6615 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6616 (fn (directory-file-name (expand-file-name filename))))
6617
6618 ;; Check if we have permissions to delete.
6619 (unless (file-writable-p (directory-file-name
6620 (file-name-directory fn)))
6621 (error "Cannot move %s to trash: Permission denied" filename))
6622 ;; The trashed file cannot be the trash dir or its parent.
6623 (if (string-prefix-p fn trash-files-dir)
6624 (error "The trash directory %s is a subdirectory of %s"
6625 trash-files-dir filename))
6626 (if (string-prefix-p fn trash-info-dir)
6627 (error "The trash directory %s is a subdirectory of %s"
6628 trash-info-dir filename))
6629
6630 ;; Ensure that the trash directory exists; otherwise, create it.
6631 (let ((saved-default-file-modes (default-file-modes)))
6632 (unwind-protect
6633 (progn
6634 (set-default-file-modes #o700)
6635 (unless (file-exists-p trash-files-dir)
6636 (make-directory trash-files-dir t))
6637 (unless (file-exists-p trash-info-dir)
6638 (make-directory trash-info-dir t)))
6639 (set-default-file-modes saved-default-file-modes)))
6640
6641 ;; Try to move to trash with .trashinfo undo information
6642 (save-excursion
6643 (with-temp-buffer
6644 (set-buffer-file-coding-system 'utf-8-unix)
6645 (insert "[Trash Info]\nPath=")
6646 ;; Perform url-encoding on FN. For compatibility with
6647 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6648 ;; for path separators.
6649 (unless (boundp 'trash--hexify-table)
6650 (setq trash--hexify-table (make-vector 256 nil))
6651 (let ((unreserved-chars
6652 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6653 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6654 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6655 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6656 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6657 ?\( ?\))))
6658 (dotimes (byte 256)
6659 (aset trash--hexify-table byte
6660 (if (memq byte unreserved-chars)
6661 (char-to-string byte)
6662 (format "%%%02x" byte))))))
6663 (mapc (lambda (byte)
6664 (insert (aref trash--hexify-table byte)))
6665 (if (multibyte-string-p fn)
6666 (encode-coding-string fn 'utf-8)
6667 fn))
6668 (insert "\nDeletionDate="
6669 (format-time-string "%Y-%m-%dT%T")
6670 "\n")
6671
6672 ;; Attempt to make .trashinfo file, trying up to 5
6673 ;; times. The .trashinfo file is opened with O_EXCL,
6674 ;; as per trash-spec 0.7, even if that can be a problem
6675 ;; on old NFS versions...
6676 (let* ((tries 5)
6677 (base-fn (expand-file-name
6678 (file-name-nondirectory fn)
6679 trash-files-dir))
6680 (new-fn base-fn)
6681 success info-fn)
6682 (while (> tries 0)
6683 (setq info-fn (expand-file-name
6684 (concat (file-name-nondirectory new-fn)
6685 ".trashinfo")
6686 trash-info-dir))
6687 (unless (condition-case nil
6688 (progn
6689 (write-region nil nil info-fn nil
6690 'quiet info-fn 'excl)
6691 (setq tries 0 success t))
6692 (file-already-exists nil))
6693 (setq tries (1- tries))
6694 ;; Uniquify new-fn. (Some file managers do not
6695 ;; like Emacs-style backup file names---e.g. bug
6696 ;; 170956 in Konqueror bug tracker.)
6697 (setq new-fn (make-temp-name (concat base-fn "_")))))
6698 (unless success
6699 (error "Cannot move %s to trash: Lock failed" filename))
6700
6701 ;; Finally, try to move the file to the trashcan.
6702 (let ((delete-by-moving-to-trash nil))
6703 (rename-file fn new-fn)))))))))
6704
6705 \f
6706 (define-key ctl-x-map "\C-f" 'find-file)
6707 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6708 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6709 (define-key ctl-x-map "\C-s" 'save-buffer)
6710 (define-key ctl-x-map "s" 'save-some-buffers)
6711 (define-key ctl-x-map "\C-w" 'write-file)
6712 (define-key ctl-x-map "i" 'insert-file)
6713 (define-key esc-map "~" 'not-modified)
6714 (define-key ctl-x-map "\C-d" 'list-directory)
6715 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6716 (define-key ctl-x-map "\C-q" 'read-only-mode)
6717
6718 (define-key ctl-x-4-map "f" 'find-file-other-window)
6719 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6720 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6721 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6722 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6723
6724 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6725 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6726 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6727 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6728 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6729
6730 ;;; files.el ends here