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