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