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