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