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