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