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