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