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