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