lisp/cedet/semantic/db-typecache.el (semanticdb-typecache)
[bpt/emacs.git] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
29
30 ;;; Code:
31
32 (defvar font-lock-keywords)
33
34 (defgroup backup nil
35 "Backups of edited data files."
36 :group 'files)
37
38 (defgroup find-file nil
39 "Finding files."
40 :group 'files)
41
42
43 (defcustom delete-auto-save-files t
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
45
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
48 :type 'boolean
49 :group 'auto-save)
50
51 (defcustom directory-abbrev-alist
52 nil
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
58
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
62
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
66 :type '(repeat (cons :format "%v"
67 :value ("" . "")
68 (regexp :tag "From")
69 (regexp :tag "To")))
70 :group 'abbrev
71 :group 'find-file)
72
73 (defcustom make-backup-files t
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
76
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
81
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
86
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
91 :type 'boolean
92 :group 'backup)
93
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
96 (defvar backup-inhibited nil
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
99 But it is local only if you make it local.")
100 (put 'backup-inhibited 'permanent-local t)
101
102 (defcustom backup-by-copying nil
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
105 :type 'boolean
106 :group 'backup)
107
108 (defcustom backup-by-copying-when-linked nil
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
112 :type 'boolean
113 :group 'backup)
114
115 (defcustom backup-by-copying-when-mismatch nil
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
122 :type 'boolean
123 :group 'backup)
124
125 (defcustom backup-by-copying-when-privileged-mismatch 200
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
134 :type '(choice (const nil) integer)
135 :group 'backup)
136
137 (defvar backup-enable-predicate 'normal-backup-enable-predicate
138 "Predicate that looks at a file name and decides whether to make backups.
139 Called with an absolute file name as argument, it returns t to enable backup.")
140
141 (defcustom buffer-offer-save nil
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
145 :type 'boolean
146 :group 'backup)
147 (make-variable-buffer-local 'buffer-offer-save)
148
149 (defcustom find-file-existing-other-name t
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
153 :type 'boolean
154 :group 'find-file)
155
156 (defcustom find-file-visit-truename nil
157 "Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
160 :type 'boolean
161 :group 'find-file)
162 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
163
164 (defcustom revert-without-query nil
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
170 :type '(repeat regexp)
171 :group 'find-file)
172
173 (defvar buffer-file-number nil
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
177 If the buffer is visiting a new file, the value is nil.")
178 (make-variable-buffer-local 'buffer-file-number)
179 (put 'buffer-file-number 'permanent-local t)
180
181 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
182 "Non-nil means that `buffer-file-number' uniquely identifies files.")
183
184 (defvar buffer-file-read-only nil
185 "Non-nil if visited file was read-only when visited.")
186 (make-variable-buffer-local 'buffer-file-read-only)
187
188 (defcustom temporary-file-directory
189 (file-name-as-directory
190 (cond ((memq system-type '(ms-dos windows-nt))
191 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
192 (t
193 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
194 "The directory for writing temporary files."
195 :group 'files
196 :type 'directory)
197
198 (defcustom small-temporary-file-directory
199 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
204 :group 'files
205 :type '(choice (const nil) directory))
206
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
208 (defvar null-device "/dev/null" "The system null device.")
209
210 (declare-function msdos-long-file-names "msdos.c")
211 (declare-function w32-long-file-name "w32proc.c")
212 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
213 (declare-function dired-unmark "dired" (arg))
214 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
215 (declare-function dos-8+3-filename "dos-fns" (filename))
216 (declare-function view-mode-disable "view" ())
217 (declare-function dosified-file-name "dos-fns" (file-name))
218
219 (defvar file-name-invalid-regexp
220 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
221 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
222 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
223 "[\000-\037]\\|" ; control characters
224 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
225 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
226 ((memq system-type '(ms-dos windows-nt cygwin))
227 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
228 "[|<>\"?*\000-\037]")) ; invalid characters
229 (t "[\000]"))
230 "Regexp recognizing file names which aren't allowed by the filesystem.")
231
232 (defcustom file-precious-flag nil
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
235
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
240
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
244
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
248
249 See also: `break-hardlink-on-save'."
250 :type 'boolean
251 :group 'backup)
252
253 (defcustom break-hardlink-on-save nil
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
258
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
260
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
265
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
267 :type 'boolean
268 :group 'files
269 :version "23.1")
270
271 (defcustom version-control nil
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
276 :type '(choice (const :tag "Never" never)
277 (const :tag "If existing" nil)
278 (other :tag "Always" t))
279 :group 'backup
280 :group 'vc)
281 (put 'version-control 'safe-local-variable
282 '(lambda (x) (or (booleanp x) (equal x 'never))))
283
284 (defcustom dired-kept-versions 2
285 "When cleaning directory, number of versions to keep."
286 :type 'integer
287 :group 'backup
288 :group 'dired)
289
290 (defcustom delete-old-versions nil
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
293 :type '(choice (const :tag "Delete" t)
294 (const :tag "Ask" nil)
295 (other :tag "Leave" other))
296 :group 'backup)
297
298 (defcustom kept-old-versions 2
299 "Number of oldest versions to keep when a new numbered backup is made."
300 :type 'integer
301 :group 'backup)
302 (put 'kept-old-versions 'safe-local-variable 'integerp)
303
304 (defcustom kept-new-versions 2
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
307 :type 'integer
308 :group 'backup)
309 (put 'kept-new-versions 'safe-local-variable 'integerp)
310
311 (defcustom require-final-newline nil
312 "Whether to add a newline automatically at the end of the file.
313
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
319
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
322 :type '(choice (const :tag "When visiting" visit)
323 (const :tag "When saving" t)
324 (const :tag "When visiting or saving" visit-save)
325 (const :tag "Don't add newlines" nil)
326 (other :tag "Ask each time" ask))
327 :group 'editing-basics)
328
329 (defcustom mode-require-final-newline t
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
334
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
339
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
344 :type '(choice (const :tag "When visiting" visit)
345 (const :tag "When saving" t)
346 (const :tag "When visiting or saving" visit-save)
347 (const :tag "Don't add newlines" nil)
348 (other :tag "Ask each time" ask))
349 :group 'editing-basics
350 :version "22.1")
351
352 (defcustom auto-save-default t
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
354 :type 'boolean
355 :group 'auto-save)
356
357 (defcustom auto-save-file-name-transforms
358 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
361 ,(concat temporary-file-directory "\\2") t))
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
372
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
376
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
380
381 On MS-DOS filesystems without long names this variable is always
382 ignored."
383 :group 'auto-save
384 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
385 (boolean :tag "Uniquify")))
386 :version "21.1")
387
388 (defcustom save-abbrevs t
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
391 :type '(choice (const t) (const nil) (const silently))
392 :group 'abbrev)
393
394 (defcustom find-file-run-dired t
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
397 :type 'boolean
398 :group 'find-file)
399
400 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
404 :type '(hook :options (cvs-dired-noselect dired-noselect))
405 :group 'find-file)
406
407 ;;;It is not useful to make this a local variable.
408 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
409 (defvar find-file-not-found-functions nil
410 "List of functions to be called for `find-file' on nonexistent file.
411 These functions are called as soon as the error is detected.
412 Variable `buffer-file-name' is already set up.
413 The functions are called in the order given until one of them returns non-nil.")
414 (define-obsolete-variable-alias 'find-file-not-found-hooks
415 'find-file-not-found-functions "22.1")
416
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-hooks 'permanent-local t)
419 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
420 (defcustom find-file-hook nil
421 "List of functions to be called after a buffer is loaded from a file.
422 The buffer's local variables (if any) will have been processed before the
423 functions are called."
424 :group 'find-file
425 :type 'hook
426 :options '(auto-insert)
427 :version "22.1")
428
429 (defvar write-file-functions nil
430 "List of functions to be called before writing out a buffer to a file.
431 If one of them returns non-nil, the file is considered already written
432 and the rest are not called.
433 These hooks are considered to pertain to the visited file.
434 So any buffer-local binding of this variable is discarded if you change
435 the visited file name with \\[set-visited-file-name], but not when you
436 change the major mode.
437
438 This hook is not run if any of the functions in
439 `write-contents-functions' returns non-nil. Both hooks pertain
440 to how to save a buffer to file, for instance, choosing a suitable
441 coding system and setting mode bits. (See Info
442 node `(elisp)Saving Buffers'.) To perform various checks or
443 updates before the buffer is saved, use `before-save-hook'.")
444 (put 'write-file-functions 'permanent-local t)
445 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
446
447 (defvar local-write-file-hooks nil)
448 (make-variable-buffer-local 'local-write-file-hooks)
449 (put 'local-write-file-hooks 'permanent-local t)
450 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
451
452 (defvar write-contents-functions nil
453 "List of functions to be called before writing out a buffer to a file.
454 If one of them returns non-nil, the file is considered already written
455 and the rest are not called and neither are the functions in
456 `write-file-functions'.
457
458 This variable is meant to be used for hooks that pertain to the
459 buffer's contents, not to the particular visited file; thus,
460 `set-visited-file-name' does not clear this variable; but changing the
461 major mode does clear it.
462
463 For hooks that _do_ pertain to the particular visited file, use
464 `write-file-functions'. Both this variable and
465 `write-file-functions' relate to how a buffer is saved to file.
466 To perform various checks or updates before the buffer is saved,
467 use `before-save-hook'.")
468 (make-variable-buffer-local 'write-contents-functions)
469 (define-obsolete-variable-alias 'write-contents-hooks
470 'write-contents-functions "22.1")
471
472 (defcustom enable-local-variables t
473 "Control use of local variables in files you visit.
474 The value can be t, nil, :safe, :all, or something else.
475
476 A value of t means file local variables specifications are obeyed
477 if all the specified variable values are safe; if any values are
478 not safe, Emacs queries you, once, whether to set them all.
479 \(When you say yes to certain values, they are remembered as safe.)
480
481 :safe means set the safe variables, and ignore the rest.
482 :all means set all variables, whether safe or not.
483 (Don't set it permanently to :all.)
484 A value of nil means always ignore the file local variables.
485
486 Any other value means always query you once whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe, but
488 this has no effect when `enable-local-variables' is \"something else\".)
489
490 This variable also controls use of major modes specified in
491 a -*- line.
492
493 The command \\[normal-mode], when used interactively,
494 always obeys file local variable specifications and the -*- line,
495 and ignores this variable."
496 :type '(choice (const :tag "Query Unsafe" t)
497 (const :tag "Safe Only" :safe)
498 (const :tag "Do all" :all)
499 (const :tag "Ignore" nil)
500 (other :tag "Query" other))
501 :group 'find-file)
502
503 (defvar local-enable-local-variables t
504 "Like `enable-local-variables' but meant for buffer-local bindings.
505 The meaningful values are nil and non-nil. The default is non-nil.
506 If a major mode sets this to nil, buffer-locally, then any local
507 variables list in the file will be ignored.
508
509 This variable does not affect the use of major modes
510 specified in a -*- line.")
511
512 (defcustom enable-local-eval 'maybe
513 "Control processing of the \"variable\" `eval' in a file's local variables.
514 The value can be t, nil or something else.
515 A value of t means obey `eval' variables.
516 A value of nil means ignore them; anything else means query."
517 :type '(choice (const :tag "Obey" t)
518 (const :tag "Ignore" nil)
519 (other :tag "Query" other))
520 :group 'find-file)
521
522 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
523 (or (fboundp 'lock-buffer)
524 (defalias 'lock-buffer 'ignore))
525 (or (fboundp 'unlock-buffer)
526 (defalias 'unlock-buffer 'ignore))
527 (or (fboundp 'file-locked-p)
528 (defalias 'file-locked-p 'ignore))
529
530 (defcustom view-read-only nil
531 "Non-nil means buffers visiting files read-only do so in view mode.
532 In fact, this means that all read-only buffers normally have
533 View mode enabled, including buffers that are read-only because
534 you visit a file you cannot alter, and buffers you make read-only
535 using \\[toggle-read-only]."
536 :type 'boolean
537 :group 'view)
538
539 (defvar file-name-history nil
540 "History list of file names entered in the minibuffer.
541
542 Maximum length of the history list is determined by the value
543 of `history-length', which see.")
544 \f
545 (put 'ange-ftp-completion-hook-function 'safe-magic t)
546 (defun ange-ftp-completion-hook-function (op &rest args)
547 "Provides support for ange-ftp host name completion.
548 Runs the usual ange-ftp hook, but only for completion operations."
549 ;; Having this here avoids the need to load ange-ftp when it's not
550 ;; really in use.
551 (if (memq op '(file-name-completion file-name-all-completions))
552 (apply 'ange-ftp-hook-function op args)
553 (let ((inhibit-file-name-handlers
554 (cons 'ange-ftp-completion-hook-function
555 (and (eq inhibit-file-name-operation op)
556 inhibit-file-name-handlers)))
557 (inhibit-file-name-operation op))
558 (apply op args))))
559
560 (defun convert-standard-filename (filename)
561 "Convert a standard file's name to something suitable for the OS.
562 This means to guarantee valid names and perhaps to canonicalize
563 certain patterns.
564
565 FILENAME should be an absolute file name since the conversion rules
566 sometimes vary depending on the position in the file name. E.g. c:/foo
567 is a valid DOS file name, but c:/bar/c:/foo is not.
568
569 This function's standard definition is trivial; it just returns
570 the argument. However, on Windows and DOS, replace invalid
571 characters. On DOS, make sure to obey the 8.3 limitations.
572 In the native Windows build, turn Cygwin names into native names,
573 and also turn slashes into backslashes if the shell requires it (see
574 `w32-shell-dos-semantics').
575
576 See Info node `(elisp)Standard File Names' for more details."
577 (if (eq system-type 'cygwin)
578 (let ((name (copy-sequence filename))
579 (start 0))
580 ;; Replace invalid filename characters with !
581 (while (string-match "[?*:<>|\"\000-\037]" name start)
582 (aset name (match-beginning 0) ?!)
583 (setq start (match-end 0)))
584 name)
585 filename))
586
587 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
588 "Read directory name, prompting with PROMPT and completing in directory DIR.
589 Value is not expanded---you must call `expand-file-name' yourself.
590 Default name to DEFAULT-DIRNAME if user exits with the same
591 non-empty string that was inserted by this function.
592 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
593 or just DIR if INITIAL is nil.)
594 If the user exits with an empty minibuffer, this function returns
595 an empty string. (This can only happen if the user erased the
596 pre-inserted contents or if `insert-default-directory' is nil.)
597 Fourth arg MUSTMATCH non-nil means require existing directory's name.
598 Non-nil and non-t means also require confirmation after completion.
599 Fifth arg INITIAL specifies text to start with.
600 DIR should be an absolute directory name. It defaults to
601 the value of `default-directory'."
602 (unless dir
603 (setq dir default-directory))
604 (read-file-name prompt dir (or default-dirname
605 (if initial (expand-file-name initial dir)
606 dir))
607 mustmatch initial
608 'file-directory-p))
609
610 \f
611 (defun pwd ()
612 "Show the current default directory."
613 (interactive nil)
614 (message "Directory %s" default-directory))
615
616 (defvar cd-path nil
617 "Value of the CDPATH environment variable, as a list.
618 Not actually set up until the first time you use it.")
619
620 (defun parse-colon-path (cd-path)
621 "Explode a search path into a list of directory names.
622 Directories are separated by occurrences of `path-separator'
623 \(which is colon in GNU and GNU-like systems)."
624 ;; We could use split-string here.
625 (and cd-path
626 (let (cd-list (cd-start 0) cd-colon)
627 (setq cd-path (concat cd-path path-separator))
628 (while (setq cd-colon (string-match path-separator cd-path cd-start))
629 (setq cd-list
630 (nconc cd-list
631 (list (if (= cd-start cd-colon)
632 nil
633 (substitute-in-file-name
634 (file-name-as-directory
635 (substring cd-path cd-start cd-colon)))))))
636 (setq cd-start (+ cd-colon 1)))
637 cd-list)))
638
639 (defun cd-absolute (dir)
640 "Change current directory to given absolute file name DIR."
641 ;; Put the name into directory syntax now,
642 ;; because otherwise expand-file-name may give some bad results.
643 (setq dir (file-name-as-directory dir))
644 (setq dir (abbreviate-file-name (expand-file-name dir)))
645 (if (not (file-directory-p dir))
646 (if (file-exists-p dir)
647 (error "%s is not a directory" dir)
648 (error "%s: no such directory" dir))
649 (unless (file-executable-p dir)
650 (error "Cannot cd to %s: Permission denied" dir))
651 (setq default-directory dir)
652 (set (make-local-variable 'list-buffers-directory) dir)))
653
654 (defun cd (dir)
655 "Make DIR become the current buffer's default directory.
656 If your environment includes a `CDPATH' variable, try each one of
657 that list of directories (separated by occurrences of
658 `path-separator') when resolving a relative directory name.
659 The path separator is colon in GNU and GNU-like systems."
660 (interactive
661 (list (read-directory-name "Change default directory: "
662 default-directory default-directory
663 (and (member cd-path '(nil ("./")))
664 (null (getenv "CDPATH"))))))
665 (if (file-name-absolute-p dir)
666 (cd-absolute (expand-file-name dir))
667 (if (null cd-path)
668 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
669 (setq cd-path (or trypath (list "./")))))
670 (if (not (catch 'found
671 (mapc
672 (function (lambda (x)
673 (let ((f (expand-file-name (concat x dir))))
674 (if (file-directory-p f)
675 (progn
676 (cd-absolute f)
677 (throw 'found t))))))
678 cd-path)
679 nil))
680 (error "No such directory found via CDPATH environment variable"))))
681
682 (defun load-file (file)
683 "Load the Lisp file named FILE."
684 ;; This is a case where .elc makes a lot of sense.
685 (interactive (list (let ((completion-ignored-extensions
686 (remove ".elc" completion-ignored-extensions)))
687 (read-file-name "Load file: "))))
688 (load (expand-file-name file) nil nil t))
689
690 (defun locate-file (filename path &optional suffixes predicate)
691 "Search for FILENAME through PATH.
692 If found, return the absolute file name of FILENAME, with its suffixes;
693 otherwise return nil.
694 PATH should be a list of directories to look in, like the lists in
695 `exec-path' or `load-path'.
696 If SUFFIXES is non-nil, it should be a list of suffixes to append to
697 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
698 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
699 If non-nil, PREDICATE is used instead of `file-readable-p'.
700 PREDICATE can also be an integer to pass to the `access' system call,
701 in which case file-name handlers are ignored. This usage is deprecated.
702
703 For compatibility, PREDICATE can also be one of the symbols
704 `executable', `readable', `writable', or `exists', or a list of
705 one or more of those symbols."
706 (if (and predicate (symbolp predicate) (not (functionp predicate)))
707 (setq predicate (list predicate)))
708 (when (and (consp predicate) (not (functionp predicate)))
709 (setq predicate
710 (logior (if (memq 'executable predicate) 1 0)
711 (if (memq 'writable predicate) 2 0)
712 (if (memq 'readable predicate) 4 0))))
713 (locate-file-internal filename path suffixes predicate))
714
715 (defun locate-file-completion-table (dirs suffixes string pred action)
716 "Do completion for file names passed to `locate-file'."
717 (if (file-name-absolute-p string)
718 (let ((read-file-name-predicate pred))
719 (read-file-name-internal string nil action))
720 (let ((names nil)
721 (suffix (concat (regexp-opt suffixes t) "\\'"))
722 (string-dir (file-name-directory string)))
723 (dolist (dir dirs)
724 (unless dir
725 (setq dir default-directory))
726 (if string-dir (setq dir (expand-file-name string-dir dir)))
727 (when (file-directory-p dir)
728 (dolist (file (file-name-all-completions
729 (file-name-nondirectory string) dir))
730 (add-to-list 'names (if string-dir (concat string-dir file) file))
731 (when (string-match suffix file)
732 (setq file (substring file 0 (match-beginning 0)))
733 (push (if string-dir (concat string-dir file) file) names)))))
734 (complete-with-action action names string pred))))
735
736 (defun locate-file-completion (string path-and-suffixes action)
737 "Do completion for file names passed to `locate-file'.
738 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
739 (locate-file-completion-table (car path-and-suffixes)
740 (cdr path-and-suffixes)
741 string nil action))
742 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
743
744 (defvar locate-dominating-stop-dir-regexp
745 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
746 "Regexp of directory names which stop the search in `locate-dominating-file'.
747 Any directory whose name matches this regexp will be treated like
748 a kind of root directory by `locate-dominating-file' which will stop its search
749 when it bumps into it.
750 The default regexp prevents fruitless and time-consuming attempts to find
751 special files in directories in which filenames are interpreted as hostnames,
752 or mount points potentially requiring authentication as a different user.")
753
754 ;; (defun locate-dominating-files (file regexp)
755 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
756 ;; Stop at the first parent where a matching file is found and return the list
757 ;; of files that that match in this directory."
758 ;; (catch 'found
759 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
760 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
761 ;; (let ((user nil)
762 ;; ;; Abbreviate, so as to stop when we cross ~/.
763 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
764 ;; files)
765 ;; (while (and dir
766 ;; ;; As a heuristic, we stop looking up the hierarchy of
767 ;; ;; directories as soon as we find a directory belonging to
768 ;; ;; another user. This should save us from looking in
769 ;; ;; things like /net and /afs. This assumes that all the
770 ;; ;; files inside a project belong to the same user.
771 ;; (let ((prev-user user))
772 ;; (setq user (nth 2 (file-attributes dir)))
773 ;; (or (null prev-user) (equal user prev-user))))
774 ;; (if (setq files (condition-case nil
775 ;; (directory-files dir 'full regexp 'nosort)
776 ;; (error nil)))
777 ;; (throw 'found files)
778 ;; (if (equal dir
779 ;; (setq dir (file-name-directory
780 ;; (directory-file-name dir))))
781 ;; (setq dir nil))))
782 ;; nil)))
783
784 (defun locate-dominating-file (file name)
785 "Look up the directory hierarchy from FILE for a file named NAME.
786 Stop at the first parent directory containing a file NAME,
787 and return the directory. Return nil if not found."
788 ;; We used to use the above locate-dominating-files code, but the
789 ;; directory-files call is very costly, so we're much better off doing
790 ;; multiple calls using the code in here.
791 ;;
792 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
793 ;; `name' in /home or in /.
794 (setq file (abbreviate-file-name file))
795 (let ((root nil)
796 (prev-file file)
797 ;; `user' is not initialized outside the loop because
798 ;; `file' may not exist, so we may have to walk up part of the
799 ;; hierarchy before we find the "initial UID".
800 (user nil)
801 try)
802 (while (not (or root
803 (null file)
804 ;; FIXME: Disabled this heuristic because it is sometimes
805 ;; inappropriate.
806 ;; As a heuristic, we stop looking up the hierarchy of
807 ;; directories as soon as we find a directory belonging
808 ;; to another user. This should save us from looking in
809 ;; things like /net and /afs. This assumes that all the
810 ;; files inside a project belong to the same user.
811 ;; (let ((prev-user user))
812 ;; (setq user (nth 2 (file-attributes file)))
813 ;; (and prev-user (not (equal user prev-user))))
814 (string-match locate-dominating-stop-dir-regexp file)))
815 (setq try (file-exists-p (expand-file-name name file)))
816 (cond (try (setq root file))
817 ((equal file (setq prev-file file
818 file (file-name-directory
819 (directory-file-name file))))
820 (setq file nil))))
821 root))
822
823
824 (defun executable-find (command)
825 "Search for COMMAND in `exec-path' and return the absolute file name.
826 Return nil if COMMAND is not found anywhere in `exec-path'."
827 ;; Use 1 rather than file-executable-p to better match the behavior of
828 ;; call-process.
829 (locate-file command exec-path exec-suffixes 1))
830
831 (defun load-library (library)
832 "Load the Emacs Lisp library named LIBRARY.
833 This is an interface to the function `load'. LIBRARY is searched
834 for in `load-path', both with and without `load-suffixes' (as
835 well as `load-file-rep-suffixes').
836
837 See Info node `(emacs)Lisp Libraries' for more details.
838 See `load-file' for a different interface to `load'."
839 (interactive
840 (list (completing-read "Load library: "
841 (apply-partially 'locate-file-completion-table
842 load-path
843 (get-load-suffixes)))))
844 (load library))
845
846 (defun file-remote-p (file &optional identification connected)
847 "Test whether FILE specifies a location on a remote system.
848 Returns nil or a string identifying the remote connection (ideally
849 a prefix of FILE). For example, the remote identification for filename
850 \"/user@host:/foo\" could be \"/user@host:\".
851 A file is considered \"remote\" if accessing it is likely to be slower or
852 less reliable than accessing local files.
853 Furthermore, relative file names do not work across remote connections.
854
855 IDENTIFICATION specifies which part of the identification shall
856 be returned as string. IDENTIFICATION can be the symbol
857 `method', `user', `host' or `localname'; any other value is
858 handled like nil and means to return the complete identification
859 string.
860
861 If CONNECTED is non-nil, the function returns an identification only
862 if FILE is located on a remote system, and a connection is established
863 to that remote system.
864
865 `file-remote-p' will never open a connection on its own."
866 (let ((handler (find-file-name-handler file 'file-remote-p)))
867 (if handler
868 (funcall handler 'file-remote-p file identification connected)
869 nil)))
870
871 (defun file-local-copy (file)
872 "Copy the file FILE into a temporary file on this machine.
873 Returns the name of the local copy, or nil, if FILE is directly
874 accessible."
875 ;; This formerly had an optional BUFFER argument that wasn't used by
876 ;; anything.
877 (let ((handler (find-file-name-handler file 'file-local-copy)))
878 (if handler
879 (funcall handler 'file-local-copy file)
880 nil)))
881
882 (defun file-truename (filename &optional counter prev-dirs)
883 "Return the truename of FILENAME, which should be absolute.
884 The truename of a file name is found by chasing symbolic links
885 both at the level of the file and at the level of the directories
886 containing it, until no links are left at any level.
887
888 \(fn FILENAME)" ;; Don't document the optional arguments.
889 ;; COUNTER and PREV-DIRS are only used in recursive calls.
890 ;; COUNTER can be a cons cell whose car is the count of how many
891 ;; more links to chase before getting an error.
892 ;; PREV-DIRS can be a cons cell whose car is an alist
893 ;; of truenames we've just recently computed.
894 (cond ((or (string= filename "") (string= filename "~"))
895 (setq filename (expand-file-name filename))
896 (if (string= filename "")
897 (setq filename "/")))
898 ((and (string= (substring filename 0 1) "~")
899 (string-match "~[^/]*/?" filename))
900 (let ((first-part
901 (substring filename 0 (match-end 0)))
902 (rest (substring filename (match-end 0))))
903 (setq filename (concat (expand-file-name first-part) rest)))))
904
905 (or counter (setq counter (list 100)))
906 (let (done
907 ;; For speed, remove the ange-ftp completion handler from the list.
908 ;; We know it's not needed here.
909 ;; For even more speed, do this only on the outermost call.
910 (file-name-handler-alist
911 (if prev-dirs file-name-handler-alist
912 (let ((tem (copy-sequence file-name-handler-alist)))
913 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
914 (or prev-dirs (setq prev-dirs (list nil)))
915
916 ;; andrewi@harlequin.co.uk - none of the following code (except for
917 ;; invoking the file-name handler) currently applies on Windows
918 ;; (ie. there are no native symlinks), but there is an issue with
919 ;; case differences being ignored by the OS, and short "8.3 DOS"
920 ;; name aliases existing for all files. (The short names are not
921 ;; reported by directory-files, but can be used to refer to files.)
922 ;; It seems appropriate for file-truename to resolve these issues in
923 ;; the most natural way, which on Windows is to call the function
924 ;; `w32-long-file-name' - this returns the exact name of a file as
925 ;; it is stored on disk (expanding short name aliases with the full
926 ;; name in the process).
927 (if (eq system-type 'windows-nt)
928 (let ((handler (find-file-name-handler filename 'file-truename)))
929 ;; For file name that has a special handler, call handler.
930 ;; This is so that ange-ftp can save time by doing a no-op.
931 (if handler
932 (setq filename (funcall handler 'file-truename filename))
933 ;; If filename contains a wildcard, newname will be the old name.
934 (unless (string-match "[[*?]" filename)
935 ;; If filename exists, use the long name. If it doesn't exist,
936 ;; drill down until we find a directory that exists, and use
937 ;; the long name of that, with the extra non-existent path
938 ;; components concatenated.
939 (let ((longname (w32-long-file-name filename))
940 missing rest)
941 (if longname
942 (setq filename longname)
943 ;; Include the preceding directory separator in the missing
944 ;; part so subsequent recursion on the rest works.
945 (setq missing (concat "/" (file-name-nondirectory filename)))
946 (let ((length (length missing)))
947 (setq rest
948 (if (> length (length filename))
949 ""
950 (substring filename 0 (- length)))))
951 (setq filename (concat (file-truename rest) missing))))))
952 (setq done t)))
953
954 ;; If this file directly leads to a link, process that iteratively
955 ;; so that we don't use lots of stack.
956 (while (not done)
957 (setcar counter (1- (car counter)))
958 (if (< (car counter) 0)
959 (error "Apparent cycle of symbolic links for %s" filename))
960 (let ((handler (find-file-name-handler filename 'file-truename)))
961 ;; For file name that has a special handler, call handler.
962 ;; This is so that ange-ftp can save time by doing a no-op.
963 (if handler
964 (setq filename (funcall handler 'file-truename filename)
965 done t)
966 (let ((dir (or (file-name-directory filename) default-directory))
967 target dirfile)
968 ;; Get the truename of the directory.
969 (setq dirfile (directory-file-name dir))
970 ;; If these are equal, we have the (or a) root directory.
971 (or (string= dir dirfile)
972 ;; If this is the same dir we last got the truename for,
973 ;; save time--don't recalculate.
974 (if (assoc dir (car prev-dirs))
975 (setq dir (cdr (assoc dir (car prev-dirs))))
976 (let ((old dir)
977 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
978 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
979 (setq dir new))))
980 (if (equal ".." (file-name-nondirectory filename))
981 (setq filename
982 (directory-file-name (file-name-directory (directory-file-name dir)))
983 done t)
984 (if (equal "." (file-name-nondirectory filename))
985 (setq filename (directory-file-name dir)
986 done t)
987 ;; Put it back on the file name.
988 (setq filename (concat dir (file-name-nondirectory filename)))
989 ;; Is the file name the name of a link?
990 (setq target (file-symlink-p filename))
991 (if target
992 ;; Yes => chase that link, then start all over
993 ;; since the link may point to a directory name that uses links.
994 ;; We can't safely use expand-file-name here
995 ;; since target might look like foo/../bar where foo
996 ;; is itself a link. Instead, we handle . and .. above.
997 (setq filename
998 (if (file-name-absolute-p target)
999 target
1000 (concat dir target))
1001 done nil)
1002 ;; No, we are done!
1003 (setq done t))))))))
1004 filename))
1005
1006 (defun file-chase-links (filename &optional limit)
1007 "Chase links in FILENAME until a name that is not a link.
1008 Unlike `file-truename', this does not check whether a parent
1009 directory name is a symbolic link.
1010 If the optional argument LIMIT is a number,
1011 it means chase no more than that many links and then stop."
1012 (let (tem (newname filename)
1013 (count 0))
1014 (while (and (or (null limit) (< count limit))
1015 (setq tem (file-symlink-p newname)))
1016 (save-match-data
1017 (if (and (null limit) (= count 100))
1018 (error "Apparent cycle of symbolic links for %s" filename))
1019 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1020 (while (string-match "//+" tem)
1021 (setq tem (replace-match "/" nil nil tem)))
1022 ;; Handle `..' by hand, since it needs to work in the
1023 ;; target of any directory symlink.
1024 ;; This code is not quite complete; it does not handle
1025 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1026 (while (string-match "\\`\\.\\./" tem)
1027 (setq tem (substring tem 3))
1028 (setq newname (expand-file-name newname))
1029 ;; Chase links in the default dir of the symlink.
1030 (setq newname
1031 (file-chase-links
1032 (directory-file-name (file-name-directory newname))))
1033 ;; Now find the parent of that dir.
1034 (setq newname (file-name-directory newname)))
1035 (setq newname (expand-file-name tem (file-name-directory newname)))
1036 (setq count (1+ count))))
1037 newname))
1038
1039 (defun make-temp-file (prefix &optional dir-flag suffix)
1040 "Create a temporary file.
1041 The returned file name (created by appending some random characters at the end
1042 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1043 is guaranteed to point to a newly created empty file.
1044 You can then use `write-region' to write new data into the file.
1045
1046 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1047
1048 If SUFFIX is non-nil, add that at the end of the file name."
1049 (let ((umask (default-file-modes))
1050 file)
1051 (unwind-protect
1052 (progn
1053 ;; Create temp files with strict access rights. It's easy to
1054 ;; loosen them later, whereas it's impossible to close the
1055 ;; time-window of loose permissions otherwise.
1056 (set-default-file-modes ?\700)
1057 (while (condition-case ()
1058 (progn
1059 (setq file
1060 (make-temp-name
1061 (if (zerop (length prefix))
1062 (file-name-as-directory
1063 temporary-file-directory)
1064 (expand-file-name prefix
1065 temporary-file-directory))))
1066 (if suffix
1067 (setq file (concat file suffix)))
1068 (if dir-flag
1069 (make-directory file)
1070 (write-region "" nil file nil 'silent nil 'excl))
1071 nil)
1072 (file-already-exists t))
1073 ;; the file was somehow created by someone else between
1074 ;; `make-temp-name' and `write-region', let's try again.
1075 nil)
1076 file)
1077 ;; Reset the umask.
1078 (set-default-file-modes umask))))
1079
1080 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1081 "Change the encoding of FILE's name from CODING to NEW-CODING.
1082 The value is a new name of FILE.
1083 Signals a `file-already-exists' error if a file of the new name
1084 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1085 is non-nil. A number as fourth arg means request confirmation if
1086 the new name already exists. This is what happens in interactive
1087 use with M-x."
1088 (interactive
1089 (let ((default-coding (or file-name-coding-system
1090 default-file-name-coding-system))
1091 (filename (read-file-name "Recode filename: " nil nil t))
1092 from-coding to-coding)
1093 (if (and default-coding
1094 ;; We provide the default coding only when it seems that
1095 ;; the filename is correctly decoded by the default
1096 ;; coding.
1097 (let ((charsets (find-charset-string filename)))
1098 (and (not (memq 'eight-bit-control charsets))
1099 (not (memq 'eight-bit-graphic charsets)))))
1100 (setq from-coding (read-coding-system
1101 (format "Recode filename %s from (default %s): "
1102 filename default-coding)
1103 default-coding))
1104 (setq from-coding (read-coding-system
1105 (format "Recode filename %s from: " filename))))
1106
1107 ;; We provide the default coding only when a user is going to
1108 ;; change the encoding not from the default coding.
1109 (if (eq from-coding default-coding)
1110 (setq to-coding (read-coding-system
1111 (format "Recode filename %s from %s to: "
1112 filename from-coding)))
1113 (setq to-coding (read-coding-system
1114 (format "Recode filename %s from %s to (default %s): "
1115 filename from-coding default-coding)
1116 default-coding)))
1117 (list filename from-coding to-coding)))
1118
1119 (let* ((default-coding (or file-name-coding-system
1120 default-file-name-coding-system))
1121 ;; FILE should have been decoded by DEFAULT-CODING.
1122 (encoded (encode-coding-string file default-coding))
1123 (newname (decode-coding-string encoded coding))
1124 (new-encoded (encode-coding-string newname new-coding))
1125 ;; Suppress further encoding.
1126 (file-name-coding-system nil)
1127 (default-file-name-coding-system nil)
1128 (locale-coding-system nil))
1129 (rename-file encoded new-encoded ok-if-already-exists)
1130 newname))
1131 \f
1132 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1133 "Whether confirmation is requested before visiting a new file or buffer.
1134 If nil, confirmation is not requested.
1135 If the value is `after-completion', confirmation is only
1136 requested if the user called `minibuffer-complete' right before
1137 `minibuffer-complete-and-exit'.
1138 Any other non-nil value means to request confirmation.
1139
1140 This affects commands like `switch-to-buffer' and `find-file'."
1141 :group 'find-file
1142 :version "23.1"
1143 :type '(choice (const :tag "After completion" after-completion)
1144 (const :tag "Never" nil)
1145 (other :tag "Always" t)))
1146
1147 (defun confirm-nonexistent-file-or-buffer ()
1148 "Whether to request confirmation before visiting a new file or buffer.
1149 The variable `confirm-nonexistent-file-or-buffer' determines the
1150 return value, which may be passed as the REQUIRE-MATCH arg to
1151 `read-buffer' or `find-file-read-args'."
1152 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1153 'confirm-after-completion)
1154 (confirm-nonexistent-file-or-buffer
1155 'confirm)
1156 (t nil)))
1157
1158 (defun read-buffer-to-switch (prompt)
1159 "Read the name of a buffer to switch to and return as a string.
1160 It is intended for `switch-to-buffer' family of commands since they
1161 need to omit the name of current buffer from the list of completions
1162 and default values."
1163 (let ((rbts-completion-table (internal-complete-buffer-except)))
1164 (minibuffer-with-setup-hook
1165 (lambda ()
1166 (setq minibuffer-completion-table rbts-completion-table)
1167 ;; Since rbts-completion-table is built dynamically, we
1168 ;; can't just add it to the default value of
1169 ;; icomplete-with-completion-tables, so we add it
1170 ;; here manually.
1171 (if (and (boundp 'icomplete-with-completion-tables)
1172 (listp icomplete-with-completion-tables))
1173 (set (make-local-variable 'icomplete-with-completion-tables)
1174 (cons rbts-completion-table
1175 icomplete-with-completion-tables))))
1176 (read-buffer prompt (other-buffer (current-buffer))
1177 (confirm-nonexistent-file-or-buffer)))))
1178
1179 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
1180 "Select the buffer specified by BUFFER-OR-NAME in another window.
1181 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1182 nil. Return the buffer switched to.
1183
1184 If called interactively, prompt for the buffer name using the
1185 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1186 determines whether to request confirmation before creating a new
1187 buffer.
1188
1189 If BUFFER-OR-NAME is a string and does not identify an existing
1190 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1191 nil, switch to the buffer returned by `other-buffer'.
1192
1193 Optional second argument NORECORD non-nil means do not put this
1194 buffer at the front of the list of recently selected ones.
1195
1196 This uses the function `display-buffer' as a subroutine; see its
1197 documentation for additional customization information."
1198 (interactive
1199 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1200 (let ((pop-up-windows t)
1201 same-window-buffer-names same-window-regexps)
1202 (pop-to-buffer buffer-or-name t norecord)))
1203
1204 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
1205 "Switch to buffer BUFFER-OR-NAME in another frame.
1206 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1207 nil. Return the buffer switched to.
1208
1209 If called interactively, prompt for the buffer name using the
1210 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1211 determines whether to request confirmation before creating a new
1212 buffer.
1213
1214 If BUFFER-OR-NAME is a string and does not identify an existing
1215 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1216 nil, switch to the buffer returned by `other-buffer'.
1217
1218 Optional second arg NORECORD non-nil means do not put this
1219 buffer at the front of the list of recently selected ones.
1220
1221 This uses the function `display-buffer' as a subroutine; see its
1222 documentation for additional customization information."
1223 (interactive
1224 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1225 (let ((pop-up-frames t)
1226 same-window-buffer-names same-window-regexps)
1227 (pop-to-buffer buffer-or-name t norecord)))
1228
1229 (defun display-buffer-other-frame (buffer)
1230 "Display buffer BUFFER in another frame.
1231 This uses the function `display-buffer' as a subroutine; see
1232 its documentation for additional customization information."
1233 (interactive "BDisplay buffer in other frame: ")
1234 (let ((pop-up-frames t)
1235 same-window-buffer-names same-window-regexps
1236 (old-window (selected-window))
1237 new-window)
1238 (setq new-window (display-buffer buffer t))
1239 ;; This may have been here in order to prevent the new frame from hiding
1240 ;; the old frame. But it does more harm than good.
1241 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1242 ;;(lower-frame (window-frame new-window))
1243
1244 ;; This may have been here in order to make sure the old-frame gets the
1245 ;; focus. But not only can it cause an annoying flicker, with some
1246 ;; window-managers it just makes the window invisible, with no easy
1247 ;; way to recover it. --Stef
1248 ;;(make-frame-invisible (window-frame old-window))
1249 ;;(make-frame-visible (window-frame old-window))
1250 ))
1251
1252 (defvar find-file-default nil
1253 "Used within `find-file-read-args'.")
1254
1255 (defmacro minibuffer-with-setup-hook (fun &rest body)
1256 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1257 BODY should use the minibuffer at most once.
1258 Recursive uses of the minibuffer will not be affected."
1259 (declare (indent 1) (debug t))
1260 (let ((hook (make-symbol "setup-hook")))
1261 `(let (,hook)
1262 (setq ,hook
1263 (lambda ()
1264 ;; Clear out this hook so it does not interfere
1265 ;; with any recursive minibuffer usage.
1266 (remove-hook 'minibuffer-setup-hook ,hook)
1267 (funcall ,fun)))
1268 (unwind-protect
1269 (progn
1270 (add-hook 'minibuffer-setup-hook ,hook)
1271 ,@body)
1272 (remove-hook 'minibuffer-setup-hook ,hook)))))
1273
1274 (defun find-file-read-args (prompt mustmatch)
1275 (list (let ((find-file-default
1276 (and buffer-file-name
1277 (abbreviate-file-name buffer-file-name))))
1278 (minibuffer-with-setup-hook
1279 (lambda () (setq minibuffer-default find-file-default))
1280 (read-file-name prompt nil default-directory mustmatch)))
1281 t))
1282
1283 (defun find-file (filename &optional wildcards)
1284 "Edit file FILENAME.
1285 Switch to a buffer visiting file FILENAME,
1286 creating one if none already exists.
1287 Interactively, the default if you just type RET is the current directory,
1288 but the visited file name is available through the minibuffer history:
1289 type M-n to pull it into the minibuffer.
1290
1291 You can visit files on remote machines by specifying something
1292 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1293 also visit local files as a different user by specifying
1294 /sudo::FILE for the file name.
1295 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1296 manual, for more about this.
1297
1298 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1299 expand wildcards (if any) and visit multiple files. You can
1300 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1301
1302 To visit a file without any kind of conversion and without
1303 automatically choosing a major mode, use \\[find-file-literally]."
1304 (interactive
1305 (find-file-read-args "Find file: "
1306 (confirm-nonexistent-file-or-buffer)))
1307 (let ((value (find-file-noselect filename nil nil wildcards)))
1308 (if (listp value)
1309 (mapcar 'switch-to-buffer (nreverse value))
1310 (switch-to-buffer value))))
1311
1312 (defun find-file-other-window (filename &optional wildcards)
1313 "Edit file FILENAME, in another window.
1314
1315 Like \\[find-file] (which see), but creates a new window or reuses
1316 an existing one. See the function `display-buffer'.
1317
1318 Interactively, the default if you just type RET is the current directory,
1319 but the visited file name is available through the minibuffer history:
1320 type M-n to pull it into the minibuffer.
1321
1322 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1323 expand wildcards (if any) and visit multiple files."
1324 (interactive
1325 (find-file-read-args "Find file in other window: "
1326 (confirm-nonexistent-file-or-buffer)))
1327 (let ((value (find-file-noselect filename nil nil wildcards)))
1328 (if (listp value)
1329 (progn
1330 (setq value (nreverse value))
1331 (cons (switch-to-buffer-other-window (car value))
1332 (mapcar 'switch-to-buffer (cdr value))))
1333 (switch-to-buffer-other-window value))))
1334
1335 (defun find-file-other-frame (filename &optional wildcards)
1336 "Edit file FILENAME, in another frame.
1337
1338 Like \\[find-file] (which see), but creates a new frame or reuses
1339 an existing one. See the function `display-buffer'.
1340
1341 Interactively, the default if you just type RET is the current directory,
1342 but the visited file name is available through the minibuffer history:
1343 type M-n to pull it into the minibuffer.
1344
1345 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1346 expand wildcards (if any) and visit multiple files."
1347 (interactive
1348 (find-file-read-args "Find file in other frame: "
1349 (confirm-nonexistent-file-or-buffer)))
1350 (let ((value (find-file-noselect filename nil nil wildcards)))
1351 (if (listp value)
1352 (progn
1353 (setq value (nreverse value))
1354 (cons (switch-to-buffer-other-frame (car value))
1355 (mapcar 'switch-to-buffer (cdr value))))
1356 (switch-to-buffer-other-frame value))))
1357
1358 (defun find-file-existing (filename)
1359 "Edit the existing file FILENAME.
1360 Like \\[find-file], but only allow a file that exists, and do not allow
1361 file names with wildcards."
1362 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1363 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1364 (error "%s does not exist" filename)
1365 (find-file filename)
1366 (current-buffer)))
1367
1368 (defun find-file-read-only (filename &optional wildcards)
1369 "Edit file FILENAME but don't allow changes.
1370 Like \\[find-file], but marks buffer as read-only.
1371 Use \\[toggle-read-only] to permit editing."
1372 (interactive
1373 (find-file-read-args "Find file read-only: "
1374 (confirm-nonexistent-file-or-buffer)))
1375 (unless (or (and wildcards find-file-wildcards
1376 (not (string-match "\\`/:" filename))
1377 (string-match "[[*?]" filename))
1378 (file-exists-p filename))
1379 (error "%s does not exist" filename))
1380 (let ((value (find-file filename wildcards)))
1381 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1382 (if (listp value) value (list value)))
1383 value))
1384
1385 (defun find-file-read-only-other-window (filename &optional wildcards)
1386 "Edit file FILENAME in another window but don't allow changes.
1387 Like \\[find-file-other-window], but marks buffer as read-only.
1388 Use \\[toggle-read-only] to permit editing."
1389 (interactive
1390 (find-file-read-args "Find file read-only other window: "
1391 (confirm-nonexistent-file-or-buffer)))
1392 (unless (or (and wildcards find-file-wildcards
1393 (not (string-match "\\`/:" filename))
1394 (string-match "[[*?]" filename))
1395 (file-exists-p filename))
1396 (error "%s does not exist" filename))
1397 (let ((value (find-file-other-window filename wildcards)))
1398 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1399 (if (listp value) value (list value)))
1400 value))
1401
1402 (defun find-file-read-only-other-frame (filename &optional wildcards)
1403 "Edit file FILENAME in another frame but don't allow changes.
1404 Like \\[find-file-other-frame], but marks buffer as read-only.
1405 Use \\[toggle-read-only] to permit editing."
1406 (interactive
1407 (find-file-read-args "Find file read-only other frame: "
1408 (confirm-nonexistent-file-or-buffer)))
1409 (unless (or (and wildcards find-file-wildcards
1410 (not (string-match "\\`/:" filename))
1411 (string-match "[[*?]" filename))
1412 (file-exists-p filename))
1413 (error "%s does not exist" filename))
1414 (let ((value (find-file-other-frame filename wildcards)))
1415 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1416 (if (listp value) value (list value)))
1417 value))
1418
1419 (defun find-alternate-file-other-window (filename &optional wildcards)
1420 "Find file FILENAME as a replacement for the file in the next window.
1421 This command does not select that window.
1422
1423 See \\[find-file] for the possible forms of the FILENAME argument.
1424
1425 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1426 expand wildcards (if any) and replace the file with multiple files."
1427 (interactive
1428 (save-selected-window
1429 (other-window 1)
1430 (let ((file buffer-file-name)
1431 (file-name nil)
1432 (file-dir nil))
1433 (and file
1434 (setq file-name (file-name-nondirectory file)
1435 file-dir (file-name-directory file)))
1436 (list (read-file-name
1437 "Find alternate file: " file-dir nil
1438 (confirm-nonexistent-file-or-buffer) file-name)
1439 t))))
1440 (if (one-window-p)
1441 (find-file-other-window filename wildcards)
1442 (save-selected-window
1443 (other-window 1)
1444 (find-alternate-file filename wildcards))))
1445
1446 (defun find-alternate-file (filename &optional wildcards)
1447 "Find file FILENAME, select its buffer, kill previous buffer.
1448 If the current buffer now contains an empty file that you just visited
1449 \(presumably by mistake), use this command to visit the file you really want.
1450
1451 See \\[find-file] for the possible forms of the FILENAME argument.
1452
1453 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1454 expand wildcards (if any) and replace the file with multiple files.
1455
1456 If the current buffer is an indirect buffer, or the base buffer
1457 for one or more indirect buffers, the other buffer(s) are not
1458 killed."
1459 (interactive
1460 (let ((file buffer-file-name)
1461 (file-name nil)
1462 (file-dir nil))
1463 (and file
1464 (setq file-name (file-name-nondirectory file)
1465 file-dir (file-name-directory file)))
1466 (list (read-file-name
1467 "Find alternate file: " file-dir nil
1468 (confirm-nonexistent-file-or-buffer) file-name)
1469 t)))
1470 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1471 (error "Aborted"))
1472 (when (and (buffer-modified-p) (buffer-file-name))
1473 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1474 (buffer-name)))
1475 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1476 (error "Aborted"))
1477 (save-buffer)))
1478 (let ((obuf (current-buffer))
1479 (ofile buffer-file-name)
1480 (onum buffer-file-number)
1481 (odir dired-directory)
1482 (otrue buffer-file-truename)
1483 (oname (buffer-name)))
1484 (if (get-buffer " **lose**")
1485 (kill-buffer " **lose**"))
1486 (rename-buffer " **lose**")
1487 (unwind-protect
1488 (progn
1489 (unlock-buffer)
1490 ;; This prevents us from finding the same buffer
1491 ;; if we specified the same file again.
1492 (setq buffer-file-name nil)
1493 (setq buffer-file-number nil)
1494 (setq buffer-file-truename nil)
1495 ;; Likewise for dired buffers.
1496 (setq dired-directory nil)
1497 (find-file filename wildcards))
1498 (when (eq obuf (current-buffer))
1499 ;; This executes if find-file gets an error
1500 ;; and does not really find anything.
1501 ;; We put things back as they were.
1502 ;; If find-file actually finds something, we kill obuf below.
1503 (setq buffer-file-name ofile)
1504 (setq buffer-file-number onum)
1505 (setq buffer-file-truename otrue)
1506 (setq dired-directory odir)
1507 (lock-buffer)
1508 (rename-buffer oname)))
1509 (unless (eq (current-buffer) obuf)
1510 (with-current-buffer obuf
1511 ;; We already asked; don't ask again.
1512 (let ((kill-buffer-query-functions))
1513 (kill-buffer obuf))))))
1514 \f
1515 (defun create-file-buffer (filename)
1516 "Create a suitably named buffer for visiting FILENAME, and return it.
1517 FILENAME (sans directory) is used unchanged if that name is free;
1518 otherwise a string <2> or <3> or ... is appended to get an unused name.
1519 Spaces at the start of FILENAME (sans directory) are removed."
1520 (let ((lastname (file-name-nondirectory filename)))
1521 (if (string= lastname "")
1522 (setq lastname filename))
1523 (save-match-data
1524 (string-match "^ *\\(.*\\)" lastname)
1525 (generate-new-buffer (match-string 1 lastname)))))
1526
1527 (defun generate-new-buffer (name)
1528 "Create and return a buffer with a name based on NAME.
1529 Choose the buffer's name using `generate-new-buffer-name'."
1530 (get-buffer-create (generate-new-buffer-name name)))
1531
1532 (defcustom automount-dir-prefix "^/tmp_mnt/"
1533 "Regexp to match the automounter prefix in a directory name."
1534 :group 'files
1535 :type 'regexp)
1536
1537 (defvar abbreviated-home-dir nil
1538 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1539
1540 (defun abbreviate-file-name (filename)
1541 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1542 This also substitutes \"~\" for the user's home directory (unless the
1543 home directory is a root directory) and removes automounter prefixes
1544 \(see the variable `automount-dir-prefix')."
1545 ;; Get rid of the prefixes added by the automounter.
1546 (save-match-data
1547 (if (and automount-dir-prefix
1548 (string-match automount-dir-prefix filename)
1549 (file-exists-p (file-name-directory
1550 (substring filename (1- (match-end 0))))))
1551 (setq filename (substring filename (1- (match-end 0)))))
1552 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1553 ;; To fix this right, we need a `file-name-case-sensitive-p'
1554 ;; function, but we don't have that yet, so just guess.
1555 (let ((case-fold-search
1556 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1557 ;; If any elt of directory-abbrev-alist matches this name,
1558 ;; abbreviate accordingly.
1559 (dolist (dir-abbrev directory-abbrev-alist)
1560 (if (string-match (car dir-abbrev) filename)
1561 (setq filename
1562 (concat (cdr dir-abbrev)
1563 (substring filename (match-end 0))))))
1564 ;; Compute and save the abbreviated homedir name.
1565 ;; We defer computing this until the first time it's needed, to
1566 ;; give time for directory-abbrev-alist to be set properly.
1567 ;; We include a slash at the end, to avoid spurious matches
1568 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1569 (or abbreviated-home-dir
1570 (setq abbreviated-home-dir
1571 (let ((abbreviated-home-dir "$foo"))
1572 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1573 "\\(/\\|\\'\\)"))))
1574
1575 ;; If FILENAME starts with the abbreviated homedir,
1576 ;; make it start with `~' instead.
1577 (if (and (string-match abbreviated-home-dir filename)
1578 ;; If the home dir is just /, don't change it.
1579 (not (and (= (match-end 0) 1)
1580 (= (aref filename 0) ?/)))
1581 ;; MS-DOS root directories can come with a drive letter;
1582 ;; Novell Netware allows drive letters beyond `Z:'.
1583 (not (and (or (eq system-type 'ms-dos)
1584 (eq system-type 'cygwin)
1585 (eq system-type 'windows-nt))
1586 (save-match-data
1587 (string-match "^[a-zA-`]:/$" filename)))))
1588 (setq filename
1589 (concat "~"
1590 (match-string 1 filename)
1591 (substring filename (match-end 0)))))
1592 filename)))
1593
1594 (defcustom find-file-not-true-dirname-list nil
1595 "List of logical names for which visiting shouldn't save the true dirname."
1596 :type '(repeat (string :tag "Name"))
1597 :group 'find-file)
1598
1599 (defun find-buffer-visiting (filename &optional predicate)
1600 "Return the buffer visiting file FILENAME (a string).
1601 This is like `get-file-buffer', except that it checks for any buffer
1602 visiting the same file, possibly under a different name.
1603 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1604 and others are ignored.
1605 If there is no such live buffer, return nil."
1606 (let ((predicate (or predicate #'identity))
1607 (truename (abbreviate-file-name (file-truename filename))))
1608 (or (let ((buf (get-file-buffer filename)))
1609 (when (and buf (funcall predicate buf)) buf))
1610 (let ((list (buffer-list)) found)
1611 (while (and (not found) list)
1612 (save-excursion
1613 (set-buffer (car list))
1614 (if (and buffer-file-name
1615 (string= buffer-file-truename truename)
1616 (funcall predicate (current-buffer)))
1617 (setq found (car list))))
1618 (setq list (cdr list)))
1619 found)
1620 (let* ((attributes (file-attributes truename))
1621 (number (nthcdr 10 attributes))
1622 (list (buffer-list)) found)
1623 (and buffer-file-numbers-unique
1624 (car-safe number) ;Make sure the inode is not just nil.
1625 (while (and (not found) list)
1626 (with-current-buffer (car list)
1627 (if (and buffer-file-name
1628 (equal buffer-file-number number)
1629 ;; Verify this buffer's file number
1630 ;; still belongs to its file.
1631 (file-exists-p buffer-file-name)
1632 (equal (file-attributes buffer-file-truename)
1633 attributes)
1634 (funcall predicate (current-buffer)))
1635 (setq found (car list))))
1636 (setq list (cdr list))))
1637 found))))
1638 \f
1639 (defcustom find-file-wildcards t
1640 "Non-nil means file-visiting commands should handle wildcards.
1641 For example, if you specify `*.c', that would visit all the files
1642 whose names match the pattern."
1643 :group 'files
1644 :version "20.4"
1645 :type 'boolean)
1646
1647 (defcustom find-file-suppress-same-file-warnings nil
1648 "Non-nil means suppress warning messages for symlinked files.
1649 When nil, Emacs prints a warning when visiting a file that is already
1650 visited, but with a different name. Setting this option to t
1651 suppresses this warning."
1652 :group 'files
1653 :version "21.1"
1654 :type 'boolean)
1655
1656 (defcustom large-file-warning-threshold 10000000
1657 "Maximum size of file above which a confirmation is requested.
1658 When nil, never request confirmation."
1659 :group 'files
1660 :group 'find-file
1661 :version "22.1"
1662 :type '(choice integer (const :tag "Never request confirmation" nil)))
1663
1664 (defun abort-if-file-too-large (size op-type filename)
1665 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1666 OP-TYPE specifies the file operation being performed (for message to user)."
1667 (when (and large-file-warning-threshold size
1668 (> size large-file-warning-threshold)
1669 (not (y-or-n-p
1670 (format "File %s is large (%dMB), really %s? "
1671 (file-name-nondirectory filename)
1672 (/ size 1048576) op-type))))
1673 (error "Aborted")))
1674
1675 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1676 "Read file FILENAME into a buffer and return the buffer.
1677 If a buffer exists visiting FILENAME, return that one, but
1678 verify that the file has not changed since visited or saved.
1679 The buffer is not selected, just returned to the caller.
1680 Optional second arg NOWARN non-nil means suppress any warning messages.
1681 Optional third arg RAWFILE non-nil means the file is read literally.
1682 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1683 and visit all the matching files. When wildcards are actually
1684 used and expanded, return a list of buffers that are visiting
1685 the various files."
1686 (setq filename
1687 (abbreviate-file-name
1688 (expand-file-name filename)))
1689 (if (file-directory-p filename)
1690 (or (and find-file-run-dired
1691 (run-hook-with-args-until-success
1692 'find-directory-functions
1693 (if find-file-visit-truename
1694 (abbreviate-file-name (file-truename filename))
1695 filename)))
1696 (error "%s is a directory" filename))
1697 (if (and wildcards
1698 find-file-wildcards
1699 (not (string-match "\\`/:" filename))
1700 (string-match "[[*?]" filename))
1701 (let ((files (condition-case nil
1702 (file-expand-wildcards filename t)
1703 (error (list filename))))
1704 (find-file-wildcards nil))
1705 (if (null files)
1706 (find-file-noselect filename)
1707 (mapcar #'find-file-noselect files)))
1708 (let* ((buf (get-file-buffer filename))
1709 (truename (abbreviate-file-name (file-truename filename)))
1710 (attributes (file-attributes truename))
1711 (number (nthcdr 10 attributes))
1712 ;; Find any buffer for a file which has same truename.
1713 (other (and (not buf) (find-buffer-visiting filename))))
1714 ;; Let user know if there is a buffer with the same truename.
1715 (if other
1716 (progn
1717 (or nowarn
1718 find-file-suppress-same-file-warnings
1719 (string-equal filename (buffer-file-name other))
1720 (message "%s and %s are the same file"
1721 filename (buffer-file-name other)))
1722 ;; Optionally also find that buffer.
1723 (if (or find-file-existing-other-name find-file-visit-truename)
1724 (setq buf other))))
1725 ;; Check to see if the file looks uncommonly large.
1726 (when (not (or buf nowarn))
1727 (abort-if-file-too-large (nth 7 attributes) "open" filename))
1728 (if buf
1729 ;; We are using an existing buffer.
1730 (let (nonexistent)
1731 (or nowarn
1732 (verify-visited-file-modtime buf)
1733 (cond ((not (file-exists-p filename))
1734 (setq nonexistent t)
1735 (message "File %s no longer exists!" filename))
1736 ;; Certain files should be reverted automatically
1737 ;; if they have changed on disk and not in the buffer.
1738 ((and (not (buffer-modified-p buf))
1739 (let ((tail revert-without-query)
1740 (found nil))
1741 (while tail
1742 (if (string-match (car tail) filename)
1743 (setq found t))
1744 (setq tail (cdr tail)))
1745 found))
1746 (with-current-buffer buf
1747 (message "Reverting file %s..." filename)
1748 (revert-buffer t t)
1749 (message "Reverting file %s...done" filename)))
1750 ((yes-or-no-p
1751 (if (string= (file-name-nondirectory filename)
1752 (buffer-name buf))
1753 (format
1754 (if (buffer-modified-p buf)
1755 "File %s changed on disk. Discard your edits? "
1756 "File %s changed on disk. Reread from disk? ")
1757 (file-name-nondirectory filename))
1758 (format
1759 (if (buffer-modified-p buf)
1760 "File %s changed on disk. Discard your edits in %s? "
1761 "File %s changed on disk. Reread from disk into %s? ")
1762 (file-name-nondirectory filename)
1763 (buffer-name buf))))
1764 (with-current-buffer buf
1765 (revert-buffer t t)))))
1766 (with-current-buffer buf
1767
1768 ;; Check if a formerly read-only file has become
1769 ;; writable and vice versa, but if the buffer agrees
1770 ;; with the new state of the file, that is ok too.
1771 (let ((read-only (not (file-writable-p buffer-file-name))))
1772 (unless (or nonexistent
1773 (eq read-only buffer-file-read-only)
1774 (eq read-only buffer-read-only))
1775 (when (or nowarn
1776 (let ((question
1777 (format "File %s is %s on disk. Change buffer mode? "
1778 buffer-file-name
1779 (if read-only "read-only" "writable"))))
1780 (y-or-n-p question)))
1781 (setq buffer-read-only read-only)))
1782 (setq buffer-file-read-only read-only))
1783
1784 (when (and (not (eq (not (null rawfile))
1785 (not (null find-file-literally))))
1786 (not nonexistent)
1787 ;; It is confusing to ask whether to visit
1788 ;; non-literally if they have the file in
1789 ;; hexl-mode.
1790 (not (eq major-mode 'hexl-mode)))
1791 (if (buffer-modified-p)
1792 (if (y-or-n-p
1793 (format
1794 (if rawfile
1795 "The file %s is already visited normally,
1796 and you have edited the buffer. Now you have asked to visit it literally,
1797 meaning no coding system handling, format conversion, or local variables.
1798 Emacs can only visit a file in one way at a time.
1799
1800 Do you want to save the file, and visit it literally instead? "
1801 "The file %s is already visited literally,
1802 meaning no coding system handling, format conversion, or local variables.
1803 You have edited the buffer. Now you have asked to visit the file normally,
1804 but Emacs can only visit a file in one way at a time.
1805
1806 Do you want to save the file, and visit it normally instead? ")
1807 (file-name-nondirectory filename)))
1808 (progn
1809 (save-buffer)
1810 (find-file-noselect-1 buf filename nowarn
1811 rawfile truename number))
1812 (if (y-or-n-p
1813 (format
1814 (if rawfile
1815 "\
1816 Do you want to discard your changes, and visit the file literally now? "
1817 "\
1818 Do you want to discard your changes, and visit the file normally now? ")))
1819 (find-file-noselect-1 buf filename nowarn
1820 rawfile truename number)
1821 (error (if rawfile "File already visited non-literally"
1822 "File already visited literally"))))
1823 (if (y-or-n-p
1824 (format
1825 (if rawfile
1826 "The file %s is already visited normally.
1827 You have asked to visit it literally,
1828 meaning no coding system decoding, format conversion, or local variables.
1829 But Emacs can only visit a file in one way at a time.
1830
1831 Do you want to revisit the file literally now? "
1832 "The file %s is already visited literally,
1833 meaning no coding system decoding, format conversion, or local variables.
1834 You have asked to visit it normally,
1835 but Emacs can only visit a file in one way at a time.
1836
1837 Do you want to revisit the file normally now? ")
1838 (file-name-nondirectory filename)))
1839 (find-file-noselect-1 buf filename nowarn
1840 rawfile truename number)
1841 (error (if rawfile "File already visited non-literally"
1842 "File already visited literally"))))))
1843 ;; Return the buffer we are using.
1844 buf)
1845 ;; Create a new buffer.
1846 (setq buf (create-file-buffer filename))
1847 ;; find-file-noselect-1 may use a different buffer.
1848 (find-file-noselect-1 buf filename nowarn
1849 rawfile truename number))))))
1850
1851 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1852 (let (error)
1853 (with-current-buffer buf
1854 (kill-local-variable 'find-file-literally)
1855 ;; Needed in case we are re-visiting the file with a different
1856 ;; text representation.
1857 (kill-local-variable 'buffer-file-coding-system)
1858 (kill-local-variable 'cursor-type)
1859 (let ((inhibit-read-only t))
1860 (erase-buffer))
1861 (and (default-value 'enable-multibyte-characters)
1862 (not rawfile)
1863 (set-buffer-multibyte t))
1864 (if rawfile
1865 (condition-case ()
1866 (let ((inhibit-read-only t))
1867 (insert-file-contents-literally filename t))
1868 (file-error
1869 (when (and (file-exists-p filename)
1870 (not (file-readable-p filename)))
1871 (kill-buffer buf)
1872 (signal 'file-error (list "File is not readable"
1873 filename)))
1874 ;; Unconditionally set error
1875 (setq error t)))
1876 (condition-case ()
1877 (let ((inhibit-read-only t))
1878 (insert-file-contents filename t))
1879 (file-error
1880 (when (and (file-exists-p filename)
1881 (not (file-readable-p filename)))
1882 (kill-buffer buf)
1883 (signal 'file-error (list "File is not readable"
1884 filename)))
1885 ;; Run find-file-not-found-functions until one returns non-nil.
1886 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1887 ;; If they fail too, set error.
1888 (setq error t)))))
1889 ;; Record the file's truename, and maybe use that as visited name.
1890 (if (equal filename buffer-file-name)
1891 (setq buffer-file-truename truename)
1892 (setq buffer-file-truename
1893 (abbreviate-file-name (file-truename buffer-file-name))))
1894 (setq buffer-file-number number)
1895 (if find-file-visit-truename
1896 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1897 ;; Set buffer's default directory to that of the file.
1898 (setq default-directory (file-name-directory buffer-file-name))
1899 ;; Turn off backup files for certain file names. Since
1900 ;; this is a permanent local, the major mode won't eliminate it.
1901 (and backup-enable-predicate
1902 (not (funcall backup-enable-predicate buffer-file-name))
1903 (progn
1904 (make-local-variable 'backup-inhibited)
1905 (setq backup-inhibited t)))
1906 (if rawfile
1907 (progn
1908 (set-buffer-multibyte nil)
1909 (setq buffer-file-coding-system 'no-conversion)
1910 (set-buffer-major-mode buf)
1911 (make-local-variable 'find-file-literally)
1912 (setq find-file-literally t))
1913 (after-find-file error (not nowarn)))
1914 (current-buffer))))
1915 \f
1916 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1917 "Like `insert-file-contents', but only reads in the file literally.
1918 A buffer may be modified in several ways after reading into the buffer,
1919 to Emacs features such as format decoding, character code
1920 conversion, `find-file-hook', automatic uncompression, etc.
1921
1922 This function ensures that none of these modifications will take place."
1923 (let ((format-alist nil)
1924 (after-insert-file-functions nil)
1925 (coding-system-for-read 'no-conversion)
1926 (coding-system-for-write 'no-conversion)
1927 (find-buffer-file-type-function
1928 (if (fboundp 'find-buffer-file-type)
1929 (symbol-function 'find-buffer-file-type)
1930 nil))
1931 (inhibit-file-name-handlers
1932 (append '(jka-compr-handler image-file-handler epa-file-handler)
1933 inhibit-file-name-handlers))
1934 (inhibit-file-name-operation 'insert-file-contents))
1935 (unwind-protect
1936 (progn
1937 (fset 'find-buffer-file-type (lambda (filename) t))
1938 (insert-file-contents filename visit beg end replace))
1939 (if find-buffer-file-type-function
1940 (fset 'find-buffer-file-type find-buffer-file-type-function)
1941 (fmakunbound 'find-buffer-file-type)))))
1942
1943 (defun insert-file-1 (filename insert-func)
1944 (if (file-directory-p filename)
1945 (signal 'file-error (list "Opening input file" "file is a directory"
1946 filename)))
1947 ;; Check whether the file is uncommonly large
1948 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
1949 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1950 #'buffer-modified-p))
1951 (tem (funcall insert-func filename)))
1952 (push-mark (+ (point) (car (cdr tem))))
1953 (when buffer
1954 (message "File %s already visited and modified in buffer %s"
1955 filename (buffer-name buffer)))))
1956
1957 (defun insert-file-literally (filename)
1958 "Insert contents of file FILENAME into buffer after point with no conversion.
1959
1960 This function is meant for the user to run interactively.
1961 Don't call it from programs! Use `insert-file-contents-literally' instead.
1962 \(Its calling sequence is different; see its documentation)."
1963 (interactive "*fInsert file literally: ")
1964 (insert-file-1 filename #'insert-file-contents-literally))
1965
1966 (defvar find-file-literally nil
1967 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1968 This is a permanent local.")
1969 (put 'find-file-literally 'permanent-local t)
1970
1971 (defun find-file-literally (filename)
1972 "Visit file FILENAME with no conversion of any kind.
1973 Format conversion and character code conversion are both disabled,
1974 and multibyte characters are disabled in the resulting buffer.
1975 The major mode used is Fundamental mode regardless of the file name,
1976 and local variable specifications in the file are ignored.
1977 Automatic uncompression and adding a newline at the end of the
1978 file due to `require-final-newline' is also disabled.
1979
1980 You cannot absolutely rely on this function to result in
1981 visiting the file literally. If Emacs already has a buffer
1982 which is visiting the file, you get the existing buffer,
1983 regardless of whether it was created literally or not.
1984
1985 In a Lisp program, if you want to be sure of accessing a file's
1986 contents literally, you should create a temporary buffer and then read
1987 the file contents into it using `insert-file-contents-literally'."
1988 (interactive "FFind file literally: ")
1989 (switch-to-buffer (find-file-noselect filename nil t)))
1990 \f
1991 (defvar after-find-file-from-revert-buffer nil)
1992
1993 (defun after-find-file (&optional error warn noauto
1994 after-find-file-from-revert-buffer
1995 nomodes)
1996 "Called after finding a file and by the default revert function.
1997 Sets buffer mode, parses local variables.
1998 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1999 error in reading the file. WARN non-nil means warn if there
2000 exists an auto-save file more recent than the visited file.
2001 NOAUTO means don't mess with auto-save mode.
2002 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2003 means this call was from `revert-buffer'.
2004 Fifth arg NOMODES non-nil means don't alter the file's modes.
2005 Finishes by calling the functions in `find-file-hook'
2006 unless NOMODES is non-nil."
2007 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2008 (if noninteractive
2009 nil
2010 (let* (not-serious
2011 (msg
2012 (cond
2013 ((not warn) nil)
2014 ((and error (file-attributes buffer-file-name))
2015 (setq buffer-read-only t)
2016 "File exists, but cannot be read")
2017 ((not buffer-read-only)
2018 (if (and warn
2019 ;; No need to warn if buffer is auto-saved
2020 ;; under the name of the visited file.
2021 (not (and buffer-file-name
2022 auto-save-visited-file-name))
2023 (file-newer-than-file-p (or buffer-auto-save-file-name
2024 (make-auto-save-file-name))
2025 buffer-file-name))
2026 (format "%s has auto save data; consider M-x recover-this-file"
2027 (file-name-nondirectory buffer-file-name))
2028 (setq not-serious t)
2029 (if error "(New file)" nil)))
2030 ((not error)
2031 (setq not-serious t)
2032 "Note: file is write protected")
2033 ((file-attributes (directory-file-name default-directory))
2034 "File not found and directory write-protected")
2035 ((file-exists-p (file-name-directory buffer-file-name))
2036 (setq buffer-read-only nil))
2037 (t
2038 (setq buffer-read-only nil)
2039 "Use M-x make-directory RET RET to create the directory and its parents"))))
2040 (when msg
2041 (message "%s" msg)
2042 (or not-serious (sit-for 1 t))))
2043 (when (and auto-save-default (not noauto))
2044 (auto-save-mode t)))
2045 ;; Make people do a little extra work (C-x C-q)
2046 ;; before altering a backup file.
2047 (when (backup-file-name-p buffer-file-name)
2048 (setq buffer-read-only t))
2049 ;; When a file is marked read-only,
2050 ;; make the buffer read-only even if root is looking at it.
2051 (when (and (file-modes (buffer-file-name))
2052 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2053 (setq buffer-read-only t))
2054 (unless nomodes
2055 (when (and view-read-only view-mode)
2056 (view-mode-disable))
2057 (normal-mode t)
2058 ;; If requested, add a newline at the end of the file.
2059 (and (memq require-final-newline '(visit visit-save))
2060 (> (point-max) (point-min))
2061 (/= (char-after (1- (point-max))) ?\n)
2062 (not (and (eq selective-display t)
2063 (= (char-after (1- (point-max))) ?\r)))
2064 (save-excursion
2065 (goto-char (point-max))
2066 (insert "\n")))
2067 (when (and buffer-read-only
2068 view-read-only
2069 (not (eq (get major-mode 'mode-class) 'special)))
2070 (view-mode-enter))
2071 (run-hooks 'find-file-hook)))
2072
2073 (defmacro report-errors (format &rest body)
2074 "Eval BODY and turn any error into a FORMAT message.
2075 FORMAT can have a %s escape which will be replaced with the actual error.
2076 If `debug-on-error' is set, errors are not caught, so that you can
2077 debug them.
2078 Avoid using a large BODY since it is duplicated."
2079 (declare (debug t) (indent 1))
2080 `(if debug-on-error
2081 (progn . ,body)
2082 (condition-case err
2083 (progn . ,body)
2084 (error (message ,format (prin1-to-string err))))))
2085
2086 (defun normal-mode (&optional find-file)
2087 "Choose the major mode for this buffer automatically.
2088 Also sets up any specified local variables of the file.
2089 Uses the visited file name, the -*- line, and the local variables spec.
2090
2091 This function is called automatically from `find-file'. In that case,
2092 we may set up the file-specified mode and local variables,
2093 depending on the value of `enable-local-variables'.
2094 In addition, if `local-enable-local-variables' is nil, we do
2095 not set local variables (though we do notice a mode specified with -*-.)
2096
2097 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2098 or from Lisp without specifying the optional argument FIND-FILE;
2099 in that case, this function acts as if `enable-local-variables' were t."
2100 (interactive)
2101 (funcall (or default-major-mode 'fundamental-mode))
2102 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2103 (report-errors "File mode specification error: %s"
2104 (set-auto-mode))
2105 (report-errors "File local-variables error: %s"
2106 (hack-local-variables)))
2107 ;; Turn font lock off and on, to make sure it takes account of
2108 ;; whatever file local variables are relevant to it.
2109 (when (and font-lock-mode
2110 ;; Font-lock-mode (now in font-core.el) can be ON when
2111 ;; font-lock.el still hasn't been loaded.
2112 (boundp 'font-lock-keywords)
2113 (eq (car font-lock-keywords) t))
2114 (setq font-lock-keywords (cadr font-lock-keywords))
2115 (font-lock-mode 1))
2116
2117 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2118 (ucs-set-table-for-input)))
2119
2120 (defcustom auto-mode-case-fold nil
2121 "Non-nil means to try second pass through `auto-mode-alist'.
2122 This means that if the first case-sensitive search through the alist fails
2123 to find a matching major mode, a second case-insensitive search is made.
2124 On systems with case-insensitive file names, this variable is ignored,
2125 since only a single case-insensitive search through the alist is made."
2126 :group 'files
2127 :version "22.1"
2128 :type 'boolean)
2129
2130 (defvar auto-mode-alist
2131 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2132 ;; c++-mode, java-mode and more) are added through autoload
2133 ;; directives in that file. That way is discouraged since it
2134 ;; spreads out the definition of the initial value.
2135 (mapcar
2136 (lambda (elt)
2137 (cons (purecopy (car elt)) (cdr elt)))
2138 `(;; do this first, so that .html.pl is Polish html, not Perl
2139 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2140 ("\\.te?xt\\'" . text-mode)
2141 ("\\.[tT]e[xX]\\'" . tex-mode)
2142 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2143 ("\\.ltx\\'" . latex-mode)
2144 ("\\.dtx\\'" . doctex-mode)
2145 ("\\.org\\'" . org-mode)
2146 ("\\.el\\'" . emacs-lisp-mode)
2147 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2148 ("\\.l\\'" . lisp-mode)
2149 ("\\.li?sp\\'" . lisp-mode)
2150 ("\\.[fF]\\'" . fortran-mode)
2151 ("\\.for\\'" . fortran-mode)
2152 ("\\.p\\'" . pascal-mode)
2153 ("\\.pas\\'" . pascal-mode)
2154 ("\\.ad[abs]\\'" . ada-mode)
2155 ("\\.ad[bs].dg\\'" . ada-mode)
2156 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2157 ("Imakefile\\'" . makefile-imake-mode)
2158 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2159 ("\\.makepp\\'" . makefile-makepp-mode)
2160 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
2161 '(("\\.mk\\'" . makefile-bsdmake-mode)
2162 ("GNUmakefile\\'" . makefile-gmake-mode)
2163 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2164 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2165 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2166 ("\\.am\\'" . makefile-automake-mode)
2167 ;; Less common extensions come here
2168 ;; so more common ones above are found faster.
2169 ("\\.texinfo\\'" . texinfo-mode)
2170 ("\\.te?xi\\'" . texinfo-mode)
2171 ("\\.[sS]\\'" . asm-mode)
2172 ("\\.asm\\'" . asm-mode)
2173 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2174 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2175 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2176 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2177 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2178 ("\\.bash\\'" . sh-mode)
2179 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2180 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2181 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2182 ("\\.m?spec\\'" . sh-mode)
2183 ("\\.m[mes]\\'" . nroff-mode)
2184 ("\\.man\\'" . nroff-mode)
2185 ("\\.sty\\'" . latex-mode)
2186 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2187 ("\\.bbl\\'" . latex-mode)
2188 ("\\.bib\\'" . bibtex-mode)
2189 ("\\.sql\\'" . sql-mode)
2190 ("\\.m[4c]\\'" . m4-mode)
2191 ("\\.mf\\'" . metafont-mode)
2192 ("\\.mp\\'" . metapost-mode)
2193 ("\\.vhdl?\\'" . vhdl-mode)
2194 ("\\.article\\'" . text-mode)
2195 ("\\.letter\\'" . text-mode)
2196 ("\\.i?tcl\\'" . tcl-mode)
2197 ("\\.exp\\'" . tcl-mode)
2198 ("\\.itk\\'" . tcl-mode)
2199 ("\\.icn\\'" . icon-mode)
2200 ("\\.sim\\'" . simula-mode)
2201 ("\\.mss\\'" . scribe-mode)
2202 ("\\.f9[05]\\'" . f90-mode)
2203 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2204 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2205 ("\\.prolog\\'" . prolog-mode)
2206 ("\\.tar\\'" . tar-mode)
2207 ;; The list of archive file extensions should be in sync with
2208 ;; `auto-coding-alist' with `no-conversion' coding system.
2209 ("\\.\\(\
2210 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2211 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2212 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2213 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2214 ;; Mailer puts message to be edited in
2215 ;; /tmp/Re.... or Message
2216 ("\\`/tmp/Re" . text-mode)
2217 ("/Message[0-9]*\\'" . text-mode)
2218 ("\\.zone\\'" . zone-mode)
2219 ;; some news reader is reported to use this
2220 ("\\`/tmp/fol/" . text-mode)
2221 ("\\.oak\\'" . scheme-mode)
2222 ("\\.sgml?\\'" . sgml-mode)
2223 ("\\.x[ms]l\\'" . xml-mode)
2224 ("\\.dtd\\'" . sgml-mode)
2225 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2226 ("\\.js\\'" . js-mode) ; javascript-mode would be better
2227 ("\\.[ds]?v\\'" . verilog-mode)
2228 ;; .emacs or .gnus or .viper following a directory delimiter in
2229 ;; Unix, MSDOG or VMS syntax.
2230 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2231 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2232 ;; _emacs following a directory delimiter
2233 ;; in MsDos syntax
2234 ("[:/]_emacs\\'" . emacs-lisp-mode)
2235 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2236 ("\\.ml\\'" . lisp-mode)
2237 ;; Common Lisp ASDF package system.
2238 ("\\.asd\\'" . lisp-mode)
2239 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2240 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2241 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2242 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2243 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2244 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2245 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2246 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2247 ("BROWSE\\'" . ebrowse-tree-mode)
2248 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2249 ("#\\*mail\\*" . mail-mode)
2250 ("\\.g\\'" . antlr-mode)
2251 ("\\.ses\\'" . ses-mode)
2252 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2253 ("\\.docbook\\'" . sgml-mode)
2254 ("\\.com\\'" . dcl-mode)
2255 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2256 ;; Windows candidates may be opened case sensitively on Unix
2257 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2258 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2259 ("\\.ppd\\'" . conf-ppd-mode)
2260 ("java.+\\.conf\\'" . conf-javaprop-mode)
2261 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2262 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2263 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2264 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2265 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2266 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2267 ;; this has lower priority to avoid matching changelog.sgml etc.
2268 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2269 ;; either user's dot-files or under /etc or some such
2270 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2271 ;; alas not all ~/.*rc files are like this
2272 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2273 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2274 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2275 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2276 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2277 ;; this contains everything twice, with space and with colon :-(
2278 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2279 ;; Get rid of any trailing .n.m and try again.
2280 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2281 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2282 ;; Using mode nil rather than `ignore' would let the search continue
2283 ;; through this list (with the shortened name) rather than start over.
2284 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2285 ;; The following should come after the ChangeLog pattern
2286 ;; for the sake of ChangeLog.1, etc.
2287 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2288 ("\\.[1-9]\\'" . nroff-mode)
2289 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2290 "Alist of filename patterns vs corresponding major mode functions.
2291 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2292 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2293 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2294 mode function to use. FUNCTION will be called, unless it is nil.
2295
2296 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2297 calling FUNCTION (if it's not nil), we delete the suffix that matched
2298 REGEXP and search the list again for another match.
2299
2300 If the file name matches `inhibit-first-line-modes-regexps',
2301 then `auto-mode-alist' is not processed.
2302
2303 The extensions whose FUNCTION is `archive-mode' should also
2304 appear in `auto-coding-alist' with `no-conversion' coding system.
2305
2306 See also `interpreter-mode-alist', which detects executable script modes
2307 based on the interpreters they specify to run,
2308 and `magic-mode-alist', which determines modes based on file contents.")
2309
2310 (defun conf-mode-maybe ()
2311 "Select Conf mode or XML mode according to start of file."
2312 (if (save-excursion
2313 (save-restriction
2314 (widen)
2315 (goto-char (point-min))
2316 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2317 (xml-mode)
2318 (conf-mode)))
2319
2320 (defvar interpreter-mode-alist
2321 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2322 ;; and pike-mode) are added through autoload directives in that
2323 ;; file. That way is discouraged since it spreads out the
2324 ;; definition of the initial value.
2325 (mapc
2326 (lambda (l)
2327 (cons (purecopy (car l)) (cdr l)))
2328 '(("perl" . perl-mode)
2329 ("perl5" . perl-mode)
2330 ("miniperl" . perl-mode)
2331 ("wish" . tcl-mode)
2332 ("wishx" . tcl-mode)
2333 ("tcl" . tcl-mode)
2334 ("tclsh" . tcl-mode)
2335 ("scm" . scheme-mode)
2336 ("ash" . sh-mode)
2337 ("bash" . sh-mode)
2338 ("bash2" . sh-mode)
2339 ("csh" . sh-mode)
2340 ("dtksh" . sh-mode)
2341 ("es" . sh-mode)
2342 ("itcsh" . sh-mode)
2343 ("jsh" . sh-mode)
2344 ("ksh" . sh-mode)
2345 ("oash" . sh-mode)
2346 ("pdksh" . sh-mode)
2347 ("rc" . sh-mode)
2348 ("rpm" . sh-mode)
2349 ("sh" . sh-mode)
2350 ("sh5" . sh-mode)
2351 ("tcsh" . sh-mode)
2352 ("wksh" . sh-mode)
2353 ("wsh" . sh-mode)
2354 ("zsh" . sh-mode)
2355 ("tail" . text-mode)
2356 ("more" . text-mode)
2357 ("less" . text-mode)
2358 ("pg" . text-mode)
2359 ("make" . makefile-gmake-mode) ; Debian uses this
2360 ("guile" . scheme-mode)
2361 ("clisp" . lisp-mode)))
2362 "Alist mapping interpreter names to major modes.
2363 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2364 Each element looks like (INTERPRETER . MODE).
2365 If INTERPRETER matches the name of the interpreter specified in the first line
2366 of a script, mode MODE is enabled.
2367
2368 See also `auto-mode-alist'.")
2369
2370 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2371 "List of regexps; if one matches a file name, don't look for `-*-'.")
2372
2373 (defvar inhibit-first-line-modes-suffixes nil
2374 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2375 When checking `inhibit-first-line-modes-regexps', we first discard
2376 from the end of the file name anything that matches one of these regexps.")
2377
2378 (defvar auto-mode-interpreter-regexp
2379 "#![ \t]?\\([^ \t\n]*\
2380 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2381 "Regexp matching interpreters, for file mode determination.
2382 This regular expression is matched against the first line of a file
2383 to determine the file's mode in `set-auto-mode'. If it matches, the file
2384 is assumed to be interpreted by the interpreter matched by the second group
2385 of the regular expression. The mode is then determined as the mode
2386 associated with that interpreter in `interpreter-mode-alist'.")
2387
2388 (defvar magic-mode-alist nil
2389 "Alist of buffer beginnings vs. corresponding major mode functions.
2390 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2391 After visiting a file, if REGEXP matches the text at the beginning of the
2392 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2393 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2394 major mode.
2395
2396 If FUNCTION is nil, then it is not called. (That is a way of saying
2397 \"allow `auto-mode-alist' to decide for these files.\")")
2398 (put 'magic-mode-alist 'risky-local-variable t)
2399
2400 (defvar magic-fallback-mode-alist
2401 `((image-type-auto-detected-p . image-mode)
2402 ;; The < comes before the groups (but the first) to reduce backtracking.
2403 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2404 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2405 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2406 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2407 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2408 comment-re "*"
2409 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2410 "[Hh][Tt][Mm][Ll]"))
2411 . html-mode)
2412 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2413 ;; These two must come after html, because they are more general:
2414 ("<\\?xml " . xml-mode)
2415 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2416 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2417 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2418 . sgml-mode)
2419 ("%!PS" . ps-mode)
2420 ("# xmcd " . conf-unix-mode))
2421 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2422 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2423 After visiting a file, if REGEXP matches the text at the beginning of the
2424 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2425 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2426 have not specified a mode for this file.
2427
2428 If FUNCTION is nil, then it is not called.")
2429 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2430
2431 (defvar magic-mode-regexp-match-limit 4000
2432 "Upper limit on `magic-mode-alist' regexp matches.
2433 Also applies to `magic-fallback-mode-alist'.")
2434
2435 (defun set-auto-mode (&optional keep-mode-if-same)
2436 "Select major mode appropriate for current buffer.
2437
2438 To find the right major mode, this function checks for a -*- mode tag,
2439 checks if it uses an interpreter listed in `interpreter-mode-alist',
2440 matches the buffer beginning against `magic-mode-alist',
2441 compares the filename against the entries in `auto-mode-alist',
2442 then matches the buffer beginning against `magic-fallback-mode-alist'.
2443
2444 It does not check for the `mode:' local variable in the
2445 Local Variables section of the file; for that, use `hack-local-variables'.
2446
2447 If `enable-local-variables' is nil, this function does not check for a
2448 -*- mode tag.
2449
2450 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2451 set the major mode only if that would change it. In other words
2452 we don't actually set it to the same mode the buffer already has."
2453 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2454 (let (end done mode modes)
2455 ;; Find a -*- mode tag
2456 (save-excursion
2457 (goto-char (point-min))
2458 (skip-chars-forward " \t\n")
2459 (and enable-local-variables
2460 (setq end (set-auto-mode-1))
2461 (if (save-excursion (search-forward ":" end t))
2462 ;; Find all specifications for the `mode:' variable
2463 ;; and execute them left to right.
2464 (while (let ((case-fold-search t))
2465 (or (and (looking-at "mode:")
2466 (goto-char (match-end 0)))
2467 (re-search-forward "[ \t;]mode:" end t)))
2468 (skip-chars-forward " \t")
2469 (let ((beg (point)))
2470 (if (search-forward ";" end t)
2471 (forward-char -1)
2472 (goto-char end))
2473 (skip-chars-backward " \t")
2474 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2475 modes)))
2476 ;; Simple -*-MODE-*- case.
2477 (push (intern (concat (downcase (buffer-substring (point) end))
2478 "-mode"))
2479 modes))))
2480 ;; If we found modes to use, invoke them now, outside the save-excursion.
2481 (if modes
2482 (catch 'nop
2483 (dolist (mode (nreverse modes))
2484 (if (not (functionp mode))
2485 (message "Ignoring unknown mode `%s'" mode)
2486 (setq done t)
2487 (or (set-auto-mode-0 mode keep-mode-if-same)
2488 ;; continuing would call minor modes again, toggling them off
2489 (throw 'nop nil))))))
2490 ;; If we didn't, look for an interpreter specified in the first line.
2491 ;; As a special case, allow for things like "#!/bin/env perl", which
2492 ;; finds the interpreter anywhere in $PATH.
2493 (unless done
2494 (setq mode (save-excursion
2495 (goto-char (point-min))
2496 (if (looking-at auto-mode-interpreter-regexp)
2497 (match-string 2)
2498 ""))
2499 ;; Map interpreter name to a mode, signalling we're done at the
2500 ;; same time.
2501 done (assoc (file-name-nondirectory mode)
2502 interpreter-mode-alist))
2503 ;; If we found an interpreter mode to use, invoke it now.
2504 (if done
2505 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2506 ;; Next try matching the buffer beginning against magic-mode-alist.
2507 (unless done
2508 (if (setq done (save-excursion
2509 (goto-char (point-min))
2510 (save-restriction
2511 (narrow-to-region (point-min)
2512 (min (point-max)
2513 (+ (point-min) magic-mode-regexp-match-limit)))
2514 (assoc-default nil magic-mode-alist
2515 (lambda (re dummy)
2516 (if (functionp re)
2517 (funcall re)
2518 (looking-at re)))))))
2519 (set-auto-mode-0 done keep-mode-if-same)))
2520 ;; Next compare the filename against the entries in auto-mode-alist.
2521 (unless done
2522 (if buffer-file-name
2523 (let ((name buffer-file-name)
2524 (remote-id (file-remote-p buffer-file-name)))
2525 ;; Remove remote file name identification.
2526 (when (and (stringp remote-id)
2527 (string-match (regexp-quote remote-id) name))
2528 (setq name (substring name (match-end 0))))
2529 ;; Remove backup-suffixes from file name.
2530 (setq name (file-name-sans-versions name))
2531 (while name
2532 ;; Find first matching alist entry.
2533 (setq mode
2534 (if (memq system-type '(windows-nt cygwin))
2535 ;; System is case-insensitive.
2536 (let ((case-fold-search t))
2537 (assoc-default name auto-mode-alist
2538 'string-match))
2539 ;; System is case-sensitive.
2540 (or
2541 ;; First match case-sensitively.
2542 (let ((case-fold-search nil))
2543 (assoc-default name auto-mode-alist
2544 'string-match))
2545 ;; Fallback to case-insensitive match.
2546 (and auto-mode-case-fold
2547 (let ((case-fold-search t))
2548 (assoc-default name auto-mode-alist
2549 'string-match))))))
2550 (if (and mode
2551 (consp mode)
2552 (cadr mode))
2553 (setq mode (car mode)
2554 name (substring name 0 (match-beginning 0)))
2555 (setq name))
2556 (when mode
2557 (set-auto-mode-0 mode keep-mode-if-same)
2558 (setq done t))))))
2559 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2560 (unless done
2561 (if (setq done (save-excursion
2562 (goto-char (point-min))
2563 (save-restriction
2564 (narrow-to-region (point-min)
2565 (min (point-max)
2566 (+ (point-min) magic-mode-regexp-match-limit)))
2567 (assoc-default nil magic-fallback-mode-alist
2568 (lambda (re dummy)
2569 (if (functionp re)
2570 (funcall re)
2571 (looking-at re)))))))
2572 (set-auto-mode-0 done keep-mode-if-same)))))
2573
2574 ;; When `keep-mode-if-same' is set, we are working on behalf of
2575 ;; set-visited-file-name. In that case, if the major mode specified is the
2576 ;; same one we already have, don't actually reset it. We don't want to lose
2577 ;; minor modes such as Font Lock.
2578 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2579 "Apply MODE and return it.
2580 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2581 any aliases and compared to current major mode. If they are the
2582 same, do nothing and return nil."
2583 (unless (and keep-mode-if-same
2584 (eq (indirect-function mode)
2585 (indirect-function major-mode)))
2586 (when mode
2587 (funcall mode)
2588 mode)))
2589
2590 (defun set-auto-mode-1 ()
2591 "Find the -*- spec in the buffer.
2592 Call with point at the place to start searching from.
2593 If one is found, set point to the beginning
2594 and return the position of the end.
2595 Otherwise, return nil; point may be changed."
2596 (let (beg end)
2597 (and
2598 ;; Don't look for -*- if this file name matches any
2599 ;; of the regexps in inhibit-first-line-modes-regexps.
2600 (let ((temp inhibit-first-line-modes-regexps)
2601 (name (if buffer-file-name
2602 (file-name-sans-versions buffer-file-name)
2603 (buffer-name))))
2604 (while (let ((sufs inhibit-first-line-modes-suffixes))
2605 (while (and sufs (not (string-match (car sufs) name)))
2606 (setq sufs (cdr sufs)))
2607 sufs)
2608 (setq name (substring name 0 (match-beginning 0))))
2609 (while (and temp
2610 (not (string-match (car temp) name)))
2611 (setq temp (cdr temp)))
2612 (not temp))
2613
2614 (search-forward "-*-" (line-end-position
2615 ;; If the file begins with "#!"
2616 ;; (exec interpreter magic), look
2617 ;; for mode frobs in the first two
2618 ;; lines. You cannot necessarily
2619 ;; put them in the first line of
2620 ;; such a file without screwing up
2621 ;; the interpreter invocation.
2622 ;; The same holds for
2623 ;; '\"
2624 ;; in man pages (preprocessor
2625 ;; magic for the `man' program).
2626 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2627 (progn
2628 (skip-chars-forward " \t")
2629 (setq beg (point))
2630 (search-forward "-*-" (line-end-position) t))
2631 (progn
2632 (forward-char -3)
2633 (skip-chars-backward " \t")
2634 (setq end (point))
2635 (goto-char beg)
2636 end))))
2637 \f
2638 ;;; Handling file local variables
2639
2640 (defvar ignored-local-variables
2641 '(ignored-local-variables safe-local-variable-values
2642 file-local-variables-alist dir-local-variables-alist)
2643 "Variables to be ignored in a file's local variable spec.")
2644
2645 (defvar hack-local-variables-hook nil
2646 "Normal hook run after processing a file's local variables specs.
2647 Major modes can use this to examine user-specified local variables
2648 in order to initialize other data structure based on them.")
2649
2650 (defcustom safe-local-variable-values nil
2651 "List variable-value pairs that are considered safe.
2652 Each element is a cons cell (VAR . VAL), where VAR is a variable
2653 symbol and VAL is a value that is considered safe."
2654 :group 'find-file
2655 :type 'alist)
2656
2657 (defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
2658 "Expressions that are considered safe in an `eval:' local variable.
2659 Add expressions to this list if you want Emacs to evaluate them, when
2660 they appear in an `eval' local variable specification, without first
2661 asking you for confirmation."
2662 :group 'find-file
2663 :version "22.2"
2664 :type '(repeat sexp))
2665
2666 ;; Risky local variables:
2667 (mapc (lambda (var) (put var 'risky-local-variable t))
2668 '(after-load-alist
2669 auto-mode-alist
2670 buffer-auto-save-file-name
2671 buffer-file-name
2672 buffer-file-truename
2673 buffer-undo-list
2674 dabbrev-case-fold-search
2675 dabbrev-case-replace
2676 debugger
2677 default-text-properties
2678 display-time-string
2679 enable-local-eval
2680 enable-local-variables
2681 eval
2682 exec-directory
2683 exec-path
2684 file-name-handler-alist
2685 font-lock-defaults
2686 format-alist
2687 frame-title-format
2688 global-mode-string
2689 header-line-format
2690 icon-title-format
2691 ignored-local-variables
2692 imenu--index-alist
2693 imenu-generic-expression
2694 inhibit-quit
2695 input-method-alist
2696 load-path
2697 max-lisp-eval-depth
2698 max-specpdl-size
2699 minor-mode-alist
2700 minor-mode-map-alist
2701 minor-mode-overriding-map-alist
2702 mode-line-buffer-identification
2703 mode-line-format
2704 mode-line-client
2705 mode-line-modes
2706 mode-line-modified
2707 mode-line-mule-info
2708 mode-line-position
2709 mode-line-process
2710 mode-line-remote
2711 mode-name
2712 outline-level
2713 overriding-local-map
2714 overriding-terminal-local-map
2715 parse-time-rules
2716 process-environment
2717 rmail-output-file-alist
2718 safe-local-variable-values
2719 safe-local-eval-forms
2720 save-some-buffers-action-alist
2721 special-display-buffer-names
2722 standard-input
2723 standard-output
2724 unread-command-events
2725 vc-mode))
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
4403 (defvar buffer-save-without-query nil
4404 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4405 (make-variable-buffer-local 'buffer-save-without-query)
4406
4407 (defun save-some-buffers (&optional arg pred)
4408 "Save some modified file-visiting buffers. Asks user about each one.
4409 You can answer `y' to save, `n' not to save, `C-r' to look at the
4410 buffer in question with `view-buffer' before deciding or `d' to
4411 view the differences using `diff-buffer-with-file'.
4412
4413 Optional argument (the prefix) non-nil means save all with no questions.
4414 Optional second argument PRED determines which buffers are considered:
4415 If PRED is nil, all the file-visiting buffers are considered.
4416 If PRED is t, then certain non-file buffers will also be considered.
4417 If PRED is a zero-argument function, it indicates for each buffer whether
4418 to consider it or not when called with that buffer current.
4419
4420 See `save-some-buffers-action-alist' if you want to
4421 change the additional actions you can take on files."
4422 (interactive "P")
4423 (save-window-excursion
4424 (let* (queried some-automatic
4425 files-done abbrevs-done)
4426 (dolist (buffer (buffer-list))
4427 ;; First save any buffers that we're supposed to save unconditionally.
4428 ;; That way the following code won't ask about them.
4429 (with-current-buffer buffer
4430 (when (and buffer-save-without-query (buffer-modified-p))
4431 (setq some-automatic t)
4432 (save-buffer))))
4433 ;; Ask about those buffers that merit it,
4434 ;; and record the number thus saved.
4435 (setq files-done
4436 (map-y-or-n-p
4437 (lambda (buffer)
4438 ;; Note that killing some buffers may kill others via
4439 ;; hooks (e.g. Rmail and its viewing buffer).
4440 (and (buffer-live-p buffer)
4441 (buffer-modified-p buffer)
4442 (not (buffer-base-buffer buffer))
4443 (or
4444 (buffer-file-name buffer)
4445 (and pred
4446 (progn
4447 (set-buffer buffer)
4448 (and buffer-offer-save (> (buffer-size) 0)))))
4449 (or (not (functionp pred))
4450 (with-current-buffer buffer (funcall pred)))
4451 (if arg
4452 t
4453 (setq queried t)
4454 (if (buffer-file-name buffer)
4455 (format "Save file %s? "
4456 (buffer-file-name buffer))
4457 (format "Save buffer %s? "
4458 (buffer-name buffer))))))
4459 (lambda (buffer)
4460 (with-current-buffer buffer
4461 (save-buffer)))
4462 (buffer-list)
4463 '("buffer" "buffers" "save")
4464 save-some-buffers-action-alist))
4465 ;; Maybe to save abbrevs, and record whether
4466 ;; we either saved them or asked to.
4467 (and save-abbrevs abbrevs-changed
4468 (progn
4469 (if (or arg
4470 (eq save-abbrevs 'silently)
4471 (y-or-n-p (format "Save abbrevs in %s? "
4472 abbrev-file-name)))
4473 (write-abbrev-file nil))
4474 ;; Don't keep bothering user if he says no.
4475 (setq abbrevs-changed nil)
4476 (setq abbrevs-done t)))
4477 (or queried (> files-done 0) abbrevs-done
4478 (message (if some-automatic
4479 "(Some special files were saved without asking)"
4480 "(No files need saving)"))))))
4481 \f
4482 (defun not-modified (&optional arg)
4483 "Mark current buffer as unmodified, not needing to be saved.
4484 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4485
4486 It is not a good idea to use this function in Lisp programs, because it
4487 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4488 (interactive "P")
4489 (message (if arg "Modification-flag set"
4490 "Modification-flag cleared"))
4491 (set-buffer-modified-p arg))
4492
4493 (defun toggle-read-only (&optional arg)
4494 "Change whether this buffer is read-only.
4495 With prefix argument ARG, make the buffer read-only if ARG is
4496 positive, otherwise make it writable. If buffer is read-only
4497 and `view-read-only' is non-nil, enter view mode."
4498 (interactive "P")
4499 (if (and arg
4500 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4501 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4502 nil ; do nothing.
4503 ;; Toggle.
4504 (cond
4505 ((and buffer-read-only view-mode)
4506 (View-exit-and-edit)
4507 (make-local-variable 'view-read-only)
4508 (setq view-read-only t)) ; Must leave view mode.
4509 ((and (not buffer-read-only) view-read-only
4510 ;; If view-mode is already active, `view-mode-enter' is a nop.
4511 (not view-mode)
4512 (not (eq (get major-mode 'mode-class) 'special)))
4513 (view-mode-enter))
4514 (t (setq buffer-read-only (not buffer-read-only))
4515 (force-mode-line-update)))
4516 (if (vc-backend buffer-file-name)
4517 (message "%s" (substitute-command-keys
4518 (concat "File is under version-control; "
4519 "use \\[vc-next-action] to check in/out"))))))
4520
4521 (defun insert-file (filename)
4522 "Insert contents of file FILENAME into buffer after point.
4523 Set mark after the inserted text.
4524
4525 This function is meant for the user to run interactively.
4526 Don't call it from programs! Use `insert-file-contents' instead.
4527 \(Its calling sequence is different; see its documentation)."
4528 (interactive "*fInsert file: ")
4529 (insert-file-1 filename #'insert-file-contents))
4530
4531 (defun append-to-file (start end filename)
4532 "Append the contents of the region to the end of file FILENAME.
4533 When called from a function, expects three arguments,
4534 START, END and FILENAME. START and END are normally buffer positions
4535 specifying the part of the buffer to write.
4536 If START is nil, that means to use the entire buffer contents.
4537 If START is a string, then output that string to the file
4538 instead of any buffer contents; END is ignored.
4539
4540 This does character code conversion and applies annotations
4541 like `write-region' does."
4542 (interactive "r\nFAppend to file: ")
4543 (write-region start end filename t))
4544
4545 (defun file-newest-backup (filename)
4546 "Return most recent backup file for FILENAME or nil if no backups exist."
4547 ;; `make-backup-file-name' will get us the right directory for
4548 ;; ordinary or numeric backups. It might create a directory for
4549 ;; backups as a side-effect, according to `backup-directory-alist'.
4550 (let* ((filename (file-name-sans-versions
4551 (make-backup-file-name (expand-file-name filename))))
4552 (file (file-name-nondirectory filename))
4553 (dir (file-name-directory filename))
4554 (comp (file-name-all-completions file dir))
4555 (newest nil)
4556 tem)
4557 (while comp
4558 (setq tem (pop comp))
4559 (cond ((and (backup-file-name-p tem)
4560 (string= (file-name-sans-versions tem) file))
4561 (setq tem (concat dir tem))
4562 (if (or (null newest)
4563 (file-newer-than-file-p tem newest))
4564 (setq newest tem)))))
4565 newest))
4566
4567 (defun rename-uniquely ()
4568 "Rename current buffer to a similar name not already taken.
4569 This function is useful for creating multiple shell process buffers
4570 or multiple mail buffers, etc."
4571 (interactive)
4572 (save-match-data
4573 (let ((base-name (buffer-name)))
4574 (and (string-match "<[0-9]+>\\'" base-name)
4575 (not (and buffer-file-name
4576 (string= base-name
4577 (file-name-nondirectory buffer-file-name))))
4578 ;; If the existing buffer name has a <NNN>,
4579 ;; which isn't part of the file name (if any),
4580 ;; then get rid of that.
4581 (setq base-name (substring base-name 0 (match-beginning 0))))
4582 (rename-buffer (generate-new-buffer-name base-name))
4583 (force-mode-line-update))))
4584
4585 (defun make-directory (dir &optional parents)
4586 "Create the directory DIR and any nonexistent parent dirs.
4587 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4588
4589 Interactively, the default choice of directory to create
4590 is the current default directory for file names.
4591 That is useful when you have visited a file in a nonexistent directory.
4592
4593 Noninteractively, the second (optional) argument PARENTS says whether
4594 to create parent directories if they don't exist. Interactively,
4595 this happens by default."
4596 (interactive
4597 (list (read-file-name "Make directory: " default-directory default-directory
4598 nil nil)
4599 t))
4600 ;; If default-directory is a remote directory,
4601 ;; make sure we find its make-directory handler.
4602 (setq dir (expand-file-name dir))
4603 (let ((handler (find-file-name-handler dir 'make-directory)))
4604 (if handler
4605 (funcall handler 'make-directory dir parents)
4606 (if (not parents)
4607 (make-directory-internal dir)
4608 (let ((dir (directory-file-name (expand-file-name dir)))
4609 create-list)
4610 (while (and (not (file-exists-p dir))
4611 ;; If directory is its own parent, then we can't
4612 ;; keep looping forever
4613 (not (equal dir
4614 (directory-file-name
4615 (file-name-directory dir)))))
4616 (setq create-list (cons dir create-list)
4617 dir (directory-file-name (file-name-directory dir))))
4618 (while create-list
4619 (make-directory-internal (car create-list))
4620 (setq create-list (cdr create-list))))))))
4621 \f
4622 (put 'revert-buffer-function 'permanent-local t)
4623 (defvar revert-buffer-function nil
4624 "Function to use to revert this buffer, or nil to do the default.
4625 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4626 which are the arguments that `revert-buffer' received.")
4627
4628 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4629 (defvar revert-buffer-insert-file-contents-function nil
4630 "Function to use to insert contents when reverting this buffer.
4631 Gets two args, first the nominal file name to use,
4632 and second, t if reading the auto-save file.
4633
4634 The function you specify is responsible for updating (or preserving) point.")
4635
4636 (defvar buffer-stale-function nil
4637 "Function to check whether a non-file buffer needs reverting.
4638 This should be a function with one optional argument NOCONFIRM.
4639 Auto Revert Mode passes t for NOCONFIRM. The function should return
4640 non-nil if the buffer should be reverted. A return value of
4641 `fast' means that the need for reverting was not checked, but
4642 that reverting the buffer is fast. The buffer is current when
4643 this function is called.
4644
4645 The idea behind the NOCONFIRM argument is that it should be
4646 non-nil if the buffer is going to be reverted without asking the
4647 user. In such situations, one has to be careful with potentially
4648 time consuming operations.
4649
4650 For more information on how this variable is used by Auto Revert mode,
4651 see Info node `(emacs)Supporting additional buffers'.")
4652
4653 (defvar before-revert-hook nil
4654 "Normal hook for `revert-buffer' to run before reverting.
4655 If `revert-buffer-function' is used to override the normal revert
4656 mechanism, this hook is not used.")
4657
4658 (defvar after-revert-hook nil
4659 "Normal hook for `revert-buffer' to run after reverting.
4660 Note that the hook value that it runs is the value that was in effect
4661 before reverting; that makes a difference if you have buffer-local
4662 hook functions.
4663
4664 If `revert-buffer-function' is used to override the normal revert
4665 mechanism, this hook is not used.")
4666
4667 (defvar revert-buffer-internal-hook)
4668
4669 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4670 "Replace current buffer text with the text of the visited file on disk.
4671 This undoes all changes since the file was visited or saved.
4672 With a prefix argument, offer to revert from latest auto-save file, if
4673 that is more recent than the visited file.
4674
4675 This command also implements an interface for special buffers
4676 that contain text which doesn't come from a file, but reflects
4677 some other data instead (e.g. Dired buffers, `buffer-list'
4678 buffers). This is done via the variable `revert-buffer-function'.
4679 In these cases, it should reconstruct the buffer contents from the
4680 appropriate data.
4681
4682 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4683 to revert from the auto-save file when this is nil. Note that the
4684 sense of this argument is the reverse of the prefix argument, for the
4685 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4686 to nil.
4687
4688 Optional second argument NOCONFIRM means don't ask for confirmation
4689 at all. \(The variable `revert-without-query' offers another way to
4690 revert buffers without querying for confirmation.)
4691
4692 Optional third argument PRESERVE-MODES non-nil means don't alter
4693 the files modes. Normally we reinitialize them using `normal-mode'.
4694
4695 If the value of `revert-buffer-function' is non-nil, it is called to
4696 do all the work for this command. Otherwise, the hooks
4697 `before-revert-hook' and `after-revert-hook' are run at the beginning
4698 and the end, and if `revert-buffer-insert-file-contents-function' is
4699 non-nil, it is called instead of rereading visited file contents."
4700
4701 ;; I admit it's odd to reverse the sense of the prefix argument, but
4702 ;; there is a lot of code out there which assumes that the first
4703 ;; argument should be t to avoid consulting the auto-save file, and
4704 ;; there's no straightforward way to encourage authors to notice a
4705 ;; reversal of the argument sense. So I'm just changing the user
4706 ;; interface, but leaving the programmatic interface the same.
4707 (interactive (list (not current-prefix-arg)))
4708 (if revert-buffer-function
4709 (funcall revert-buffer-function ignore-auto noconfirm)
4710 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4711 (current-buffer))
4712 (let* ((auto-save-p (and (not ignore-auto)
4713 (recent-auto-save-p)
4714 buffer-auto-save-file-name
4715 (file-readable-p buffer-auto-save-file-name)
4716 (y-or-n-p
4717 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4718 (file-name (if auto-save-p
4719 buffer-auto-save-file-name
4720 buffer-file-name)))
4721 (cond ((null file-name)
4722 (error "Buffer does not seem to be associated with any file"))
4723 ((or noconfirm
4724 (and (not (buffer-modified-p))
4725 (catch 'found
4726 (dolist (regexp revert-without-query)
4727 (when (string-match regexp file-name)
4728 (throw 'found t)))))
4729 (yes-or-no-p (format "Revert buffer from file %s? "
4730 file-name)))
4731 (run-hooks 'before-revert-hook)
4732 ;; If file was backed up but has changed since,
4733 ;; we shd make another backup.
4734 (and (not auto-save-p)
4735 (not (verify-visited-file-modtime (current-buffer)))
4736 (setq buffer-backed-up nil))
4737 ;; Effectively copy the after-revert-hook status,
4738 ;; since after-find-file will clobber it.
4739 (let ((global-hook (default-value 'after-revert-hook))
4740 (local-hook (when (local-variable-p 'after-revert-hook)
4741 after-revert-hook))
4742 (inhibit-read-only t))
4743 (cond
4744 (revert-buffer-insert-file-contents-function
4745 (unless (eq buffer-undo-list t)
4746 ;; Get rid of all undo records for this buffer.
4747 (setq buffer-undo-list nil))
4748 ;; Don't make undo records for the reversion.
4749 (let ((buffer-undo-list t))
4750 (funcall revert-buffer-insert-file-contents-function
4751 file-name auto-save-p)))
4752 ((not (file-exists-p file-name))
4753 (error (if buffer-file-number
4754 "File %s no longer exists!"
4755 "Cannot revert nonexistent file %s")
4756 file-name))
4757 ((not (file-readable-p file-name))
4758 (error (if buffer-file-number
4759 "File %s no longer readable!"
4760 "Cannot revert unreadable file %s")
4761 file-name))
4762 (t
4763 ;; Bind buffer-file-name to nil
4764 ;; so that we don't try to lock the file.
4765 (let ((buffer-file-name nil))
4766 (or auto-save-p
4767 (unlock-buffer)))
4768 (widen)
4769 (let ((coding-system-for-read
4770 ;; Auto-saved file should be read by Emacs'
4771 ;; internal coding.
4772 (if auto-save-p 'auto-save-coding
4773 (or coding-system-for-read
4774 (and
4775 buffer-file-coding-system-explicit
4776 (car buffer-file-coding-system-explicit))))))
4777 (if (and (not enable-multibyte-characters)
4778 coding-system-for-read
4779 (not (memq (coding-system-base
4780 coding-system-for-read)
4781 '(no-conversion raw-text))))
4782 ;; As a coding system suitable for multibyte
4783 ;; buffer is specified, make the current
4784 ;; buffer multibyte.
4785 (set-buffer-multibyte t))
4786
4787 ;; This force after-insert-file-set-coding
4788 ;; (called from insert-file-contents) to set
4789 ;; buffer-file-coding-system to a proper value.
4790 (kill-local-variable 'buffer-file-coding-system)
4791
4792 ;; Note that this preserves point in an intelligent way.
4793 (if preserve-modes
4794 (let ((buffer-file-format buffer-file-format))
4795 (insert-file-contents file-name (not auto-save-p)
4796 nil nil t))
4797 (insert-file-contents file-name (not auto-save-p)
4798 nil nil t)))))
4799 ;; Recompute the truename in case changes in symlinks
4800 ;; have changed the truename.
4801 (setq buffer-file-truename
4802 (abbreviate-file-name (file-truename buffer-file-name)))
4803 (after-find-file nil nil t t preserve-modes)
4804 ;; Run after-revert-hook as it was before we reverted.
4805 (setq-default revert-buffer-internal-hook global-hook)
4806 (if local-hook
4807 (set (make-local-variable 'revert-buffer-internal-hook)
4808 local-hook)
4809 (kill-local-variable 'revert-buffer-internal-hook))
4810 (run-hooks 'revert-buffer-internal-hook))
4811 t))))))
4812
4813 (defun recover-this-file ()
4814 "Recover the visited file--get contents from its last auto-save file."
4815 (interactive)
4816 (recover-file buffer-file-name))
4817
4818 (defun recover-file (file)
4819 "Visit file FILE, but get contents from its last auto-save file."
4820 ;; Actually putting the file name in the minibuffer should be used
4821 ;; only rarely.
4822 ;; Not just because users often use the default.
4823 (interactive "FRecover file: ")
4824 (setq file (expand-file-name file))
4825 (if (auto-save-file-name-p (file-name-nondirectory file))
4826 (error "%s is an auto-save file" (abbreviate-file-name file)))
4827 (let ((file-name (let ((buffer-file-name file))
4828 (make-auto-save-file-name))))
4829 (cond ((if (file-exists-p file)
4830 (not (file-newer-than-file-p file-name file))
4831 (not (file-exists-p file-name)))
4832 (error "Auto-save file %s not current"
4833 (abbreviate-file-name file-name)))
4834 ((save-window-excursion
4835 (with-output-to-temp-buffer "*Directory*"
4836 (buffer-disable-undo standard-output)
4837 (save-excursion
4838 (let ((switches dired-listing-switches))
4839 (if (file-symlink-p file)
4840 (setq switches (concat switches "L")))
4841 (set-buffer standard-output)
4842 ;; Use insert-directory-safely, not insert-directory,
4843 ;; because these files might not exist. In particular,
4844 ;; FILE might not exist if the auto-save file was for
4845 ;; a buffer that didn't visit a file, such as "*mail*".
4846 ;; The code in v20.x called `ls' directly, so we need
4847 ;; to emulate what `ls' did in that case.
4848 (insert-directory-safely file switches)
4849 (insert-directory-safely file-name switches))))
4850 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4851 (switch-to-buffer (find-file-noselect file t))
4852 (let ((inhibit-read-only t)
4853 ;; Keep the current buffer-file-coding-system.
4854 (coding-system buffer-file-coding-system)
4855 ;; Auto-saved file should be read with special coding.
4856 (coding-system-for-read 'auto-save-coding))
4857 (erase-buffer)
4858 (insert-file-contents file-name nil)
4859 (set-buffer-file-coding-system coding-system))
4860 (after-find-file nil nil t))
4861 (t (error "Recover-file cancelled")))))
4862
4863 (defun recover-session ()
4864 "Recover auto save files from a previous Emacs session.
4865 This command first displays a Dired buffer showing you the
4866 previous sessions that you could recover from.
4867 To choose one, move point to the proper line and then type C-c C-c.
4868 Then you'll be asked about a number of files to recover."
4869 (interactive)
4870 (if (null auto-save-list-file-prefix)
4871 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4872 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4873 (unless (file-directory-p dir)
4874 (make-directory dir t))
4875 (unless (directory-files dir nil
4876 (concat "\\`" (regexp-quote
4877 (file-name-nondirectory
4878 auto-save-list-file-prefix)))
4879 t)
4880 (error "No previous sessions to recover")))
4881 (let ((ls-lisp-support-shell-wildcards t))
4882 (dired (concat auto-save-list-file-prefix "*")
4883 (concat dired-listing-switches "t")))
4884 (save-excursion
4885 (goto-char (point-min))
4886 (or (looking-at " Move to the session you want to recover,")
4887 (let ((inhibit-read-only t))
4888 ;; Each line starts with a space
4889 ;; so that Font Lock mode won't highlight the first character.
4890 (insert " Move to the session you want to recover,\n"
4891 " then type C-c C-c to select it.\n\n"
4892 " You can also delete some of these files;\n"
4893 " type d on a line to mark that file for deletion.\n\n"))))
4894 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4895 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4896
4897 (defun recover-session-finish ()
4898 "Choose one saved session to recover auto-save files from.
4899 This command is used in the special Dired buffer created by
4900 \\[recover-session]."
4901 (interactive)
4902 ;; Get the name of the session file to recover from.
4903 (let ((file (dired-get-filename))
4904 files
4905 (buffer (get-buffer-create " *recover*")))
4906 (dired-unmark 1)
4907 (dired-do-flagged-delete t)
4908 (unwind-protect
4909 (save-excursion
4910 ;; Read in the auto-save-list file.
4911 (set-buffer buffer)
4912 (erase-buffer)
4913 (insert-file-contents file)
4914 ;; Loop thru the text of that file
4915 ;; and get out the names of the files to recover.
4916 (while (not (eobp))
4917 (let (thisfile autofile)
4918 (if (eolp)
4919 ;; This is a pair of lines for a non-file-visiting buffer.
4920 ;; Get the auto-save file name and manufacture
4921 ;; a "visited file name" from that.
4922 (progn
4923 (forward-line 1)
4924 ;; If there is no auto-save file name, the
4925 ;; auto-save-list file is probably corrupted.
4926 (unless (eolp)
4927 (setq autofile
4928 (buffer-substring-no-properties
4929 (point)
4930 (line-end-position)))
4931 (setq thisfile
4932 (expand-file-name
4933 (substring
4934 (file-name-nondirectory autofile)
4935 1 -1)
4936 (file-name-directory autofile))))
4937 (forward-line 1))
4938 ;; This pair of lines is a file-visiting
4939 ;; buffer. Use the visited file name.
4940 (progn
4941 (setq thisfile
4942 (buffer-substring-no-properties
4943 (point) (progn (end-of-line) (point))))
4944 (forward-line 1)
4945 (setq autofile
4946 (buffer-substring-no-properties
4947 (point) (progn (end-of-line) (point))))
4948 (forward-line 1)))
4949 ;; Ignore a file if its auto-save file does not exist now.
4950 (if (and autofile (file-exists-p autofile))
4951 (setq files (cons thisfile files)))))
4952 (setq files (nreverse files))
4953 ;; The file contains a pair of line for each auto-saved buffer.
4954 ;; The first line of the pair contains the visited file name
4955 ;; or is empty if the buffer was not visiting a file.
4956 ;; The second line is the auto-save file name.
4957 (if files
4958 (map-y-or-n-p "Recover %s? "
4959 (lambda (file)
4960 (condition-case nil
4961 (save-excursion (recover-file file))
4962 (error
4963 "Failed to recover `%s'" file)))
4964 files
4965 '("file" "files" "recover"))
4966 (message "No files can be recovered from this session now")))
4967 (kill-buffer buffer))))
4968
4969 (defun kill-buffer-ask (buffer)
4970 "Kill BUFFER if confirmed."
4971 (when (yes-or-no-p
4972 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4973 (if (buffer-modified-p buffer)
4974 "HAS BEEN EDITED" "is unmodified")))
4975 (kill-buffer buffer)))
4976
4977 (defun kill-some-buffers (&optional list)
4978 "Kill some buffers. Asks the user whether to kill each one of them.
4979 Non-interactively, if optional argument LIST is non-nil, it
4980 specifies the list of buffers to kill, asking for approval for each one."
4981 (interactive)
4982 (if (null list)
4983 (setq list (buffer-list)))
4984 (while list
4985 (let* ((buffer (car list))
4986 (name (buffer-name buffer)))
4987 (and name ; Can be nil for an indirect buffer
4988 ; if we killed the base buffer.
4989 (not (string-equal name ""))
4990 (/= (aref name 0) ?\s)
4991 (kill-buffer-ask buffer)))
4992 (setq list (cdr list))))
4993
4994 (defun kill-matching-buffers (regexp &optional internal-too)
4995 "Kill buffers whose name matches the specified REGEXP.
4996 The optional second argument indicates whether to kill internal buffers too."
4997 (interactive "sKill buffers matching this regular expression: \nP")
4998 (dolist (buffer (buffer-list))
4999 (let ((name (buffer-name buffer)))
5000 (when (and name (not (string-equal name ""))
5001 (or internal-too (/= (aref name 0) ?\s))
5002 (string-match regexp name))
5003 (kill-buffer-ask buffer)))))
5004
5005 \f
5006 (defun auto-save-mode (arg)
5007 "Toggle auto-saving of contents of current buffer.
5008 With prefix argument ARG, turn auto-saving on if positive, else off."
5009 (interactive "P")
5010 (setq buffer-auto-save-file-name
5011 (and (if (null arg)
5012 (or (not buffer-auto-save-file-name)
5013 ;; If auto-save is off because buffer has shrunk,
5014 ;; then toggling should turn it on.
5015 (< buffer-saved-size 0))
5016 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
5017 (if (and buffer-file-name auto-save-visited-file-name
5018 (not buffer-read-only))
5019 buffer-file-name
5020 (make-auto-save-file-name))))
5021 ;; If -1 was stored here, to temporarily turn off saving,
5022 ;; turn it back on.
5023 (and (< buffer-saved-size 0)
5024 (setq buffer-saved-size 0))
5025 (if (interactive-p)
5026 (message "Auto-save %s (in this buffer)"
5027 (if buffer-auto-save-file-name "on" "off")))
5028 buffer-auto-save-file-name)
5029
5030 (defun rename-auto-save-file ()
5031 "Adjust current buffer's auto save file name for current conditions.
5032 Also rename any existing auto save file, if it was made in this session."
5033 (let ((osave buffer-auto-save-file-name))
5034 (setq buffer-auto-save-file-name
5035 (make-auto-save-file-name))
5036 (if (and osave buffer-auto-save-file-name
5037 (not (string= buffer-auto-save-file-name buffer-file-name))
5038 (not (string= buffer-auto-save-file-name osave))
5039 (file-exists-p osave)
5040 (recent-auto-save-p))
5041 (rename-file osave buffer-auto-save-file-name t))))
5042
5043 (defun make-auto-save-file-name ()
5044 "Return file name to use for auto-saves of current buffer.
5045 Does not consider `auto-save-visited-file-name' as that variable is checked
5046 before calling this function. You can redefine this for customization.
5047 See also `auto-save-file-name-p'."
5048 (if buffer-file-name
5049 (let ((handler (find-file-name-handler buffer-file-name
5050 'make-auto-save-file-name)))
5051 (if handler
5052 (funcall handler 'make-auto-save-file-name)
5053 (let ((list auto-save-file-name-transforms)
5054 (filename buffer-file-name)
5055 result uniq)
5056 ;; Apply user-specified translations
5057 ;; to the file name.
5058 (while (and list (not result))
5059 (if (string-match (car (car list)) filename)
5060 (setq result (replace-match (cadr (car list)) t nil
5061 filename)
5062 uniq (car (cddr (car list)))))
5063 (setq list (cdr list)))
5064 (if result
5065 (if uniq
5066 (setq filename (concat
5067 (file-name-directory result)
5068 (subst-char-in-string
5069 ?/ ?!
5070 (replace-regexp-in-string "!" "!!"
5071 filename))))
5072 (setq filename result)))
5073 (setq result
5074 (if (and (eq system-type 'ms-dos)
5075 (not (msdos-long-file-names)))
5076 ;; We truncate the file name to DOS 8+3 limits
5077 ;; before doing anything else, because the regexp
5078 ;; passed to string-match below cannot handle
5079 ;; extensions longer than 3 characters, multiple
5080 ;; dots, and other atrocities.
5081 (let ((fn (dos-8+3-filename
5082 (file-name-nondirectory buffer-file-name))))
5083 (string-match
5084 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5085 fn)
5086 (concat (file-name-directory buffer-file-name)
5087 "#" (match-string 1 fn)
5088 "." (match-string 3 fn) "#"))
5089 (concat (file-name-directory filename)
5090 "#"
5091 (file-name-nondirectory filename)
5092 "#")))
5093 ;; Make sure auto-save file names don't contain characters
5094 ;; invalid for the underlying filesystem.
5095 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5096 ;; Don't modify remote (ange-ftp) filenames
5097 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5098 (convert-standard-filename result)
5099 result))))
5100
5101 ;; Deal with buffers that don't have any associated files. (Mail
5102 ;; mode tends to create a good number of these.)
5103
5104 (let ((buffer-name (buffer-name))
5105 (limit 0)
5106 file-name)
5107 ;; Restrict the characters used in the file name to those which
5108 ;; are known to be safe on all filesystems, url-encoding the
5109 ;; rest.
5110 ;; We do this on all platforms, because even if we are not
5111 ;; running on DOS/Windows, the current directory may be on a
5112 ;; mounted VFAT filesystem, such as a USB memory stick.
5113 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5114 (let* ((character (aref buffer-name (match-beginning 0)))
5115 (replacement
5116 ;; For multibyte characters, this will produce more than
5117 ;; 2 hex digits, so is not true URL encoding.
5118 (format "%%%02X" character)))
5119 (setq buffer-name (replace-match replacement t t buffer-name))
5120 (setq limit (1+ (match-end 0)))))
5121 ;; Generate the file name.
5122 (setq file-name
5123 (make-temp-file
5124 (let ((fname
5125 (expand-file-name
5126 (format "#%s#" buffer-name)
5127 ;; Try a few alternative directories, to get one we can
5128 ;; write it.
5129 (cond
5130 ((file-writable-p default-directory) default-directory)
5131 ((file-writable-p "/var/tmp/") "/var/tmp/")
5132 ("~/")))))
5133 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5134 ;; Don't modify remote (ange-ftp) filenames
5135 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5136 ;; The call to convert-standard-filename is in case
5137 ;; buffer-name includes characters not allowed by the
5138 ;; DOS/Windows filesystems. make-temp-file writes to the
5139 ;; file it creates, so we must fix the file name _before_
5140 ;; make-temp-file is called.
5141 (convert-standard-filename fname)
5142 fname))
5143 nil "#"))
5144 ;; make-temp-file creates the file,
5145 ;; but we don't want it to exist until we do an auto-save.
5146 (condition-case ()
5147 (delete-file file-name)
5148 (file-error nil))
5149 file-name)))
5150
5151 (defun auto-save-file-name-p (filename)
5152 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5153 FILENAME should lack slashes. You can redefine this for customization."
5154 (string-match "^#.*#$" filename))
5155 \f
5156 (defun wildcard-to-regexp (wildcard)
5157 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5158 The generated regexp will match a filename only if the filename
5159 matches that wildcard according to shell rules. Only wildcards known
5160 by `sh' are supported."
5161 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5162 ;; Copy the initial run of non-special characters.
5163 (result (substring wildcard 0 i))
5164 (len (length wildcard)))
5165 ;; If no special characters, we're almost done.
5166 (if i
5167 (while (< i len)
5168 (let ((ch (aref wildcard i))
5169 j)
5170 (setq
5171 result
5172 (concat result
5173 (cond
5174 ((and (eq ch ?\[)
5175 (< (1+ i) len)
5176 (eq (aref wildcard (1+ i)) ?\]))
5177 "\\[")
5178 ((eq ch ?\[) ; [...] maps to regexp char class
5179 (progn
5180 (setq i (1+ i))
5181 (concat
5182 (cond
5183 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5184 (progn
5185 (setq i (1+ i))
5186 (if (eq (aref wildcard i) ?\])
5187 (progn
5188 (setq i (1+ i))
5189 "[^]")
5190 "[^")))
5191 ((eq (aref wildcard i) ?^)
5192 ;; Found "[^". Insert a `\0' character
5193 ;; (which cannot happen in a filename)
5194 ;; into the character class, so that `^'
5195 ;; is not the first character after `[',
5196 ;; and thus non-special in a regexp.
5197 (progn
5198 (setq i (1+ i))
5199 "[\000^"))
5200 ((eq (aref wildcard i) ?\])
5201 ;; I don't think `]' can appear in a
5202 ;; character class in a wildcard, but
5203 ;; let's be general here.
5204 (progn
5205 (setq i (1+ i))
5206 "[]"))
5207 (t "["))
5208 (prog1 ; copy everything upto next `]'.
5209 (substring wildcard
5210 i
5211 (setq j (string-match
5212 "]" wildcard i)))
5213 (setq i (if j (1- j) (1- len)))))))
5214 ((eq ch ?.) "\\.")
5215 ((eq ch ?*) "[^\000]*")
5216 ((eq ch ?+) "\\+")
5217 ((eq ch ?^) "\\^")
5218 ((eq ch ?$) "\\$")
5219 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5220 ((eq ch ??) "[^\000]")
5221 (t (char-to-string ch)))))
5222 (setq i (1+ i)))))
5223 ;; Shell wildcards should match the entire filename,
5224 ;; not its part. Make the regexp say so.
5225 (concat "\\`" result "\\'")))
5226 \f
5227 (defcustom list-directory-brief-switches
5228 "-CF"
5229 "Switches for `list-directory' to pass to `ls' for brief listing."
5230 :type 'string
5231 :group 'dired)
5232
5233 (defcustom list-directory-verbose-switches
5234 "-l"
5235 "Switches for `list-directory' to pass to `ls' for verbose listing."
5236 :type 'string
5237 :group 'dired)
5238
5239 (defun file-expand-wildcards (pattern &optional full)
5240 "Expand wildcard pattern PATTERN.
5241 This returns a list of file names which match the pattern.
5242
5243 If PATTERN is written as an absolute file name,
5244 the values are absolute also.
5245
5246 If PATTERN is written as a relative file name, it is interpreted
5247 relative to the current default directory, `default-directory'.
5248 The file names returned are normally also relative to the current
5249 default directory. However, if FULL is non-nil, they are absolute."
5250 (save-match-data
5251 (let* ((nondir (file-name-nondirectory pattern))
5252 (dirpart (file-name-directory pattern))
5253 ;; A list of all dirs that DIRPART specifies.
5254 ;; This can be more than one dir
5255 ;; if DIRPART contains wildcards.
5256 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5257 (mapcar 'file-name-as-directory
5258 (file-expand-wildcards (directory-file-name dirpart)))
5259 (list dirpart)))
5260 contents)
5261 (while dirs
5262 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5263 (file-directory-p (directory-file-name (car dirs))))
5264 (let ((this-dir-contents
5265 ;; Filter out "." and ".."
5266 (delq nil
5267 (mapcar #'(lambda (name)
5268 (unless (string-match "\\`\\.\\.?\\'"
5269 (file-name-nondirectory name))
5270 name))
5271 (directory-files (or (car dirs) ".") full
5272 (wildcard-to-regexp nondir))))))
5273 (setq contents
5274 (nconc
5275 (if (and (car dirs) (not full))
5276 (mapcar (function (lambda (name) (concat (car dirs) name)))
5277 this-dir-contents)
5278 this-dir-contents)
5279 contents))))
5280 (setq dirs (cdr dirs)))
5281 contents)))
5282
5283 (defun list-directory (dirname &optional verbose)
5284 "Display a list of files in or matching DIRNAME, a la `ls'.
5285 DIRNAME is globbed by the shell if necessary.
5286 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5287 Actions controlled by variables `list-directory-brief-switches'
5288 and `list-directory-verbose-switches'."
5289 (interactive (let ((pfx current-prefix-arg))
5290 (list (read-file-name (if pfx "List directory (verbose): "
5291 "List directory (brief): ")
5292 nil default-directory nil)
5293 pfx)))
5294 (let ((switches (if verbose list-directory-verbose-switches
5295 list-directory-brief-switches))
5296 buffer)
5297 (or dirname (setq dirname default-directory))
5298 (setq dirname (expand-file-name dirname))
5299 (with-output-to-temp-buffer "*Directory*"
5300 (setq buffer standard-output)
5301 (buffer-disable-undo standard-output)
5302 (princ "Directory ")
5303 (princ dirname)
5304 (terpri)
5305 (save-excursion
5306 (set-buffer "*Directory*")
5307 (let ((wildcard (not (file-directory-p dirname))))
5308 (insert-directory dirname switches wildcard (not wildcard)))))
5309 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5310 (with-current-buffer buffer
5311 (setq default-directory
5312 (if (file-directory-p dirname)
5313 (file-name-as-directory dirname)
5314 (file-name-directory dirname))))))
5315
5316 (defun shell-quote-wildcard-pattern (pattern)
5317 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5318
5319 PATTERN is assumed to represent a file-name wildcard suitable for the
5320 underlying filesystem. For Unix and GNU/Linux, each character from the
5321 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5322 the parts of the pattern which don't include wildcard characters are
5323 quoted with double quotes.
5324
5325 This function leaves alone existing quote characters (\\ on Unix and \"
5326 on Windows), so PATTERN can use them to quote wildcard characters that
5327 need to be passed verbatim to shell commands."
5328 (save-match-data
5329 (cond
5330 ((memq system-type '(ms-dos windows-nt cygwin))
5331 ;; DOS/Windows don't allow `"' in file names. So if the
5332 ;; argument has quotes, we can safely assume it is already
5333 ;; quoted by the caller.
5334 (if (or (string-match "[\"]" pattern)
5335 ;; We quote [&()#$'] in case their shell is a port of a
5336 ;; Unixy shell. We quote [,=+] because stock DOS and
5337 ;; Windows shells require that in some cases, such as
5338 ;; passing arguments to batch files that use positional
5339 ;; arguments like %1.
5340 (not (string-match "[ \t;&()#$',=+]" pattern)))
5341 pattern
5342 (let ((result "\"")
5343 (beg 0)
5344 end)
5345 (while (string-match "[*?]+" pattern beg)
5346 (setq end (match-beginning 0)
5347 result (concat result (substring pattern beg end)
5348 "\""
5349 (substring pattern end (match-end 0))
5350 "\"")
5351 beg (match-end 0)))
5352 (concat result (substring pattern beg) "\""))))
5353 (t
5354 (let ((beg 0))
5355 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5356 (setq pattern
5357 (concat (substring pattern 0 (match-beginning 0))
5358 "\\"
5359 (substring pattern (match-beginning 0)))
5360 beg (1+ (match-end 0)))))
5361 pattern))))
5362
5363
5364 (defvar insert-directory-program "ls"
5365 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5366
5367 (defcustom directory-free-space-program "df"
5368 "Program to get the amount of free space on a file system.
5369 We assume the output has the format of `df'.
5370 The value of this variable must be just a command name or file name;
5371 if you want to specify options, use `directory-free-space-args'.
5372
5373 A value of nil disables this feature.
5374
5375 If the function `file-system-info' is defined, it is always used in
5376 preference to the program given by this variable."
5377 :type '(choice (string :tag "Program") (const :tag "None" nil))
5378 :group 'dired)
5379
5380 (defcustom directory-free-space-args
5381 (if (eq system-type 'darwin) "-k" "-Pk")
5382 "Options to use when running `directory-free-space-program'."
5383 :type 'string
5384 :group 'dired)
5385
5386 (defun get-free-disk-space (dir)
5387 "Return the amount of free space on directory DIR's file system.
5388 The result is a string that gives the number of free 1KB blocks,
5389 or nil if the system call or the program which retrieve the information
5390 fail. It returns also nil when DIR is a remote directory.
5391
5392 This function calls `file-system-info' if it is available, or invokes the
5393 program specified by `directory-free-space-program' if that is non-nil."
5394 (unless (file-remote-p dir)
5395 ;; Try to find the number of free blocks. Non-Posix systems don't
5396 ;; always have df, but might have an equivalent system call.
5397 (if (fboundp 'file-system-info)
5398 (let ((fsinfo (file-system-info dir)))
5399 (if fsinfo
5400 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5401 (save-match-data
5402 (with-temp-buffer
5403 (when (and directory-free-space-program
5404 ;; Avoid failure if the default directory does
5405 ;; not exist (Bug#2631, Bug#3911).
5406 (let ((default-directory default-directory))
5407 (setq dir (expand-file-name dir))
5408 (unless (and (not (file-remote-p default-directory))
5409 (file-directory-p default-directory)
5410 (file-readable-p default-directory))
5411 (setq default-directory "/"))
5412 (eq (call-process directory-free-space-program
5413 nil t nil
5414 directory-free-space-args
5415 dir)
5416 0)))
5417 ;; Usual format is a header line followed by a line of
5418 ;; numbers.
5419 (goto-char (point-min))
5420 (forward-line 1)
5421 (if (not (eobp))
5422 (progn
5423 ;; Move to the end of the "available blocks" number.
5424 (skip-chars-forward "^ \t")
5425 (forward-word 3)
5426 ;; Copy it into AVAILABLE.
5427 (let ((end (point)))
5428 (forward-word -1)
5429 (buffer-substring (point) end))))))))))
5430
5431 ;; The following expression replaces `dired-move-to-filename-regexp'.
5432 (defvar directory-listing-before-filename-regexp
5433 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5434 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5435 ;; In some locales, month abbreviations are as short as 2 letters,
5436 ;; and they can be followed by ".".
5437 ;; In Breton, a month name can include a quote character.
5438 (month (concat l-or-quote l-or-quote "+\\.?"))
5439 (s " ")
5440 (yyyy "[0-9][0-9][0-9][0-9]")
5441 (dd "[ 0-3][0-9]")
5442 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5443 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5444 (zone "[-+][0-2][0-9][0-5][0-9]")
5445 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5446 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5447 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5448 "\\|" yyyy "-" iso-mm-dd "\\)"))
5449 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5450 s "+"
5451 "\\(" HH:MM "\\|" yyyy "\\)"))
5452 (western-comma (concat month s "+" dd "," s "+" yyyy))
5453 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5454 ;; omits the Kanji characters after month and day-of-month.
5455 ;; On Mac OS X 10.3, the date format in East Asian locales is
5456 ;; day-of-month digits followed by month digits.
5457 (mm "[ 0-1]?[0-9]")
5458 (east-asian
5459 (concat "\\(" mm l "?" s dd l "?" s "+"
5460 "\\|" dd s mm s "+" "\\)"
5461 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5462 ;; The "[0-9]" below requires the previous column to end in a digit.
5463 ;; This avoids recognizing `1 may 1997' as a date in the line:
5464 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5465
5466 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5467 ;; The ".*" below finds the last match if there are multiple matches.
5468 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5469 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5470
5471 ;; vc dired listings provide the state or blanks between file
5472 ;; permissions and date. The state is always surrounded by
5473 ;; parantheses:
5474 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5475 ;; This is not supported yet.
5476 (concat ".*[0-9][BkKMGTPEZY]?" s
5477 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5478 s "+"))
5479 "Regular expression to match up to the file name in a directory listing.
5480 The default value is designed to recognize dates and times
5481 regardless of the language.")
5482
5483 (defvar insert-directory-ls-version 'unknown)
5484
5485 ;; insert-directory
5486 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5487 ;; FULL-DIRECTORY-P is nil.
5488 ;; The single line of output must display FILE's name as it was
5489 ;; given, namely, an absolute path name.
5490 ;; - must insert exactly one line for each file if WILDCARD or
5491 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5492 ;; before the file lines, plus optional text after the file lines.
5493 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5494 ;; allowed.
5495 ;; File lines should display the basename.
5496 ;; - must be consistent with
5497 ;; - functions dired-move-to-filename, (these two define what a file line is)
5498 ;; dired-move-to-end-of-filename,
5499 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5500 ;; dired-insert-headerline
5501 ;; dired-after-subdir-garbage (defines what a "total" line is)
5502 ;; - variable dired-subdir-regexp
5503 ;; - may be passed "--dired" as the first argument in SWITCHES.
5504 ;; Filename handlers might have to remove this switch if their
5505 ;; "ls" command does not support it.
5506 (defun insert-directory (file switches &optional wildcard full-directory-p)
5507 "Insert directory listing for FILE, formatted according to SWITCHES.
5508 Leaves point after the inserted text.
5509 SWITCHES may be a string of options, or a list of strings
5510 representing individual options.
5511 Optional third arg WILDCARD means treat FILE as shell wildcard.
5512 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5513 switches do not contain `d', so that a full listing is expected.
5514
5515 This works by running a directory listing program
5516 whose name is in the variable `insert-directory-program'.
5517 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5518
5519 When SWITCHES contains the long `--dired' option, this function
5520 treats it specially, for the sake of dired. However, the
5521 normally equivalent short `-D' option is just passed on to
5522 `insert-directory-program', as any other option."
5523 ;; We need the directory in order to find the right handler.
5524 (let ((handler (find-file-name-handler (expand-file-name file)
5525 'insert-directory)))
5526 (if handler
5527 (funcall handler 'insert-directory file switches
5528 wildcard full-directory-p)
5529 (let (result (beg (point)))
5530
5531 ;; Read the actual directory using `insert-directory-program'.
5532 ;; RESULT gets the status code.
5533 (let* (;; We at first read by no-conversion, then after
5534 ;; putting text property `dired-filename, decode one
5535 ;; bunch by one to preserve that property.
5536 (coding-system-for-read 'no-conversion)
5537 ;; This is to control encoding the arguments in call-process.
5538 (coding-system-for-write
5539 (and enable-multibyte-characters
5540 (or file-name-coding-system
5541 default-file-name-coding-system))))
5542 (setq result
5543 (if wildcard
5544 ;; Run ls in the directory part of the file pattern
5545 ;; using the last component as argument.
5546 (let ((default-directory
5547 (if (file-name-absolute-p file)
5548 (file-name-directory file)
5549 (file-name-directory (expand-file-name file))))
5550 (pattern (file-name-nondirectory file)))
5551 (call-process
5552 shell-file-name nil t nil
5553 "-c"
5554 (concat (if (memq system-type '(ms-dos windows-nt))
5555 ""
5556 "\\") ; Disregard Unix shell aliases!
5557 insert-directory-program
5558 " -d "
5559 (if (stringp switches)
5560 switches
5561 (mapconcat 'identity switches " "))
5562 " -- "
5563 ;; Quote some characters that have
5564 ;; special meanings in shells; but
5565 ;; don't quote the wildcards--we want
5566 ;; them to be special. We also
5567 ;; currently don't quote the quoting
5568 ;; characters in case people want to
5569 ;; use them explicitly to quote
5570 ;; wildcard characters.
5571 (shell-quote-wildcard-pattern pattern))))
5572 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5573 ;; directory if FILE is a symbolic link.
5574 (apply 'call-process
5575 insert-directory-program nil t nil
5576 (append
5577 (if (listp switches) switches
5578 (unless (equal switches "")
5579 ;; Split the switches at any spaces so we can
5580 ;; pass separate options as separate args.
5581 (split-string switches)))
5582 ;; Avoid lossage if FILE starts with `-'.
5583 '("--")
5584 (progn
5585 (if (string-match "\\`~" file)
5586 (setq file (expand-file-name file)))
5587 (list
5588 (if full-directory-p
5589 (concat (file-name-as-directory file) ".")
5590 file))))))))
5591
5592 ;; If we got "//DIRED//" in the output, it means we got a real
5593 ;; directory listing, even if `ls' returned nonzero.
5594 ;; So ignore any errors.
5595 (when (if (stringp switches)
5596 (string-match "--dired\\>" switches)
5597 (member "--dired" switches))
5598 (save-excursion
5599 (forward-line -2)
5600 (when (looking-at "//SUBDIRED//")
5601 (forward-line -1))
5602 (if (looking-at "//DIRED//")
5603 (setq result 0))))
5604
5605 (when (and (not (eq 0 result))
5606 (eq insert-directory-ls-version 'unknown))
5607 ;; The first time ls returns an error,
5608 ;; find the version numbers of ls,
5609 ;; and set insert-directory-ls-version
5610 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5611 ;; is equal or if the info cannot be obtained.
5612 ;; (That can mean it isn't GNU ls.)
5613 (let ((version-out
5614 (with-temp-buffer
5615 (call-process "ls" nil t nil "--version")
5616 (buffer-string))))
5617 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5618 (let* ((version (match-string 1 version-out))
5619 (split (split-string version "[.]"))
5620 (numbers (mapcar 'string-to-number split))
5621 (min '(5 2 1))
5622 comparison)
5623 (while (and (not comparison) (or numbers min))
5624 (cond ((null min)
5625 (setq comparison '>))
5626 ((null numbers)
5627 (setq comparison '<))
5628 ((> (car numbers) (car min))
5629 (setq comparison '>))
5630 ((< (car numbers) (car min))
5631 (setq comparison '<))
5632 (t
5633 (setq numbers (cdr numbers)
5634 min (cdr min)))))
5635 (setq insert-directory-ls-version (or comparison '=)))
5636 (setq insert-directory-ls-version nil))))
5637
5638 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5639 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5640 (setq result 0))
5641
5642 ;; If `insert-directory-program' failed, signal an error.
5643 (unless (eq 0 result)
5644 ;; Delete the error message it may have output.
5645 (delete-region beg (point))
5646 ;; On non-Posix systems, we cannot open a directory, so
5647 ;; don't even try, because that will always result in
5648 ;; the ubiquitous "Access denied". Instead, show the
5649 ;; command line so the user can try to guess what went wrong.
5650 (if (and (file-directory-p file)
5651 (memq system-type '(ms-dos windows-nt)))
5652 (error
5653 "Reading directory: \"%s %s -- %s\" exited with status %s"
5654 insert-directory-program
5655 (if (listp switches) (concat switches) switches)
5656 file result)
5657 ;; Unix. Access the file to get a suitable error.
5658 (access-file file "Reading directory")
5659 (error "Listing directory failed but `access-file' worked")))
5660
5661 (when (if (stringp switches)
5662 (string-match "--dired\\>" switches)
5663 (member "--dired" switches))
5664 ;; The following overshoots by one line for an empty
5665 ;; directory listed with "--dired", but without "-a"
5666 ;; switch, where the ls output contains a
5667 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5668 ;; We take care of that case later.
5669 (forward-line -2)
5670 (when (looking-at "//SUBDIRED//")
5671 (delete-region (point) (progn (forward-line 1) (point)))
5672 (forward-line -1))
5673 (if (looking-at "//DIRED//")
5674 (let ((end (line-end-position))
5675 (linebeg (point))
5676 error-lines)
5677 ;; Find all the lines that are error messages,
5678 ;; and record the bounds of each one.
5679 (goto-char beg)
5680 (while (< (point) linebeg)
5681 (or (eql (following-char) ?\s)
5682 (push (list (point) (line-end-position)) error-lines))
5683 (forward-line 1))
5684 (setq error-lines (nreverse error-lines))
5685 ;; Now read the numeric positions of file names.
5686 (goto-char linebeg)
5687 (forward-word 1)
5688 (forward-char 3)
5689 (while (< (point) end)
5690 (let ((start (insert-directory-adj-pos
5691 (+ beg (read (current-buffer)))
5692 error-lines))
5693 (end (insert-directory-adj-pos
5694 (+ beg (read (current-buffer)))
5695 error-lines)))
5696 (if (memq (char-after end) '(?\n ?\s))
5697 ;; End is followed by \n or by " -> ".
5698 (put-text-property start end 'dired-filename t)
5699 ;; It seems that we can't trust ls's output as to
5700 ;; byte positions of filenames.
5701 (put-text-property beg (point) 'dired-filename nil)
5702 (end-of-line))))
5703 (goto-char end)
5704 (beginning-of-line)
5705 (delete-region (point) (progn (forward-line 1) (point))))
5706 ;; Take care of the case where the ls output contains a
5707 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5708 ;; and we went one line too far back (see above).
5709 (forward-line 1))
5710 (if (looking-at "//DIRED-OPTIONS//")
5711 (delete-region (point) (progn (forward-line 1) (point)))))
5712
5713 ;; Now decode what read if necessary.
5714 (let ((coding (or coding-system-for-read
5715 file-name-coding-system
5716 default-file-name-coding-system
5717 'undecided))
5718 coding-no-eol
5719 val pos)
5720 (when (and enable-multibyte-characters
5721 (not (memq (coding-system-base coding)
5722 '(raw-text no-conversion))))
5723 ;; If no coding system is specified or detection is
5724 ;; requested, detect the coding.
5725 (if (eq (coding-system-base coding) 'undecided)
5726 (setq coding (detect-coding-region beg (point) t)))
5727 (if (not (eq (coding-system-base coding) 'undecided))
5728 (save-restriction
5729 (setq coding-no-eol
5730 (coding-system-change-eol-conversion coding 'unix))
5731 (narrow-to-region beg (point))
5732 (goto-char (point-min))
5733 (while (not (eobp))
5734 (setq pos (point)
5735 val (get-text-property (point) 'dired-filename))
5736 (goto-char (next-single-property-change
5737 (point) 'dired-filename nil (point-max)))
5738 ;; Force no eol conversion on a file name, so
5739 ;; that CR is preserved.
5740 (decode-coding-region pos (point)
5741 (if val coding-no-eol coding))
5742 (if val
5743 (put-text-property pos (point)
5744 'dired-filename t)))))))
5745
5746 (if full-directory-p
5747 ;; Try to insert the amount of free space.
5748 (save-excursion
5749 (goto-char beg)
5750 ;; First find the line to put it on.
5751 (when (re-search-forward "^ *\\(total\\)" nil t)
5752 (let ((available (get-free-disk-space ".")))
5753 (when available
5754 ;; Replace "total" with "used", to avoid confusion.
5755 (replace-match "total used in directory" nil nil nil 1)
5756 (end-of-line)
5757 (insert " available " available))))))))))
5758
5759 (defun insert-directory-adj-pos (pos error-lines)
5760 "Convert `ls --dired' file name position value POS to a buffer position.
5761 File name position values returned in ls --dired output
5762 count only stdout; they don't count the error messages sent to stderr.
5763 So this function converts to them to real buffer positions.
5764 ERROR-LINES is a list of buffer positions of error message lines,
5765 of the form (START END)."
5766 (while (and error-lines (< (caar error-lines) pos))
5767 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5768 (pop error-lines))
5769 pos)
5770
5771 (defun insert-directory-safely (file switches
5772 &optional wildcard full-directory-p)
5773 "Insert directory listing for FILE, formatted according to SWITCHES.
5774
5775 Like `insert-directory', but if FILE does not exist, it inserts a
5776 message to that effect instead of signaling an error."
5777 (if (file-exists-p file)
5778 (insert-directory file switches wildcard full-directory-p)
5779 ;; Simulate the message printed by `ls'.
5780 (insert (format "%s: No such file or directory\n" file))))
5781
5782 (defvar kill-emacs-query-functions nil
5783 "Functions to call with no arguments to query about killing Emacs.
5784 If any of these functions returns nil, killing Emacs is cancelled.
5785 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5786 the low level primitive, does not. See also `kill-emacs-hook'.")
5787
5788 (defcustom confirm-kill-emacs nil
5789 "How to ask for confirmation when leaving Emacs.
5790 If nil, the default, don't ask at all. If the value is non-nil, it should
5791 be a predicate function such as `yes-or-no-p'."
5792 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5793 (const :tag "Ask with y-or-n-p" y-or-n-p)
5794 (const :tag "Don't confirm" nil))
5795 :group 'convenience
5796 :version "21.1")
5797
5798 (defun save-buffers-kill-emacs (&optional arg)
5799 "Offer to save each buffer, then kill this Emacs process.
5800 With prefix ARG, silently save all file-visiting buffers, then kill."
5801 (interactive "P")
5802 (save-some-buffers arg t)
5803 (and (or (not (memq t (mapcar (function
5804 (lambda (buf) (and (buffer-file-name buf)
5805 (buffer-modified-p buf))))
5806 (buffer-list))))
5807 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5808 (or (not (fboundp 'process-list))
5809 ;; process-list is not defined on MSDOS.
5810 (let ((processes (process-list))
5811 active)
5812 (while processes
5813 (and (memq (process-status (car processes)) '(run stop open listen))
5814 (process-query-on-exit-flag (car processes))
5815 (setq active t))
5816 (setq processes (cdr processes)))
5817 (or (not active)
5818 (list-processes t)
5819 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5820 ;; Query the user for other things, perhaps.
5821 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5822 (or (null confirm-kill-emacs)
5823 (funcall confirm-kill-emacs "Really exit Emacs? "))
5824 (kill-emacs)))
5825
5826 (defun save-buffers-kill-terminal (&optional arg)
5827 "Offer to save each buffer, then kill the current connection.
5828 If the current frame has no client, kill Emacs itself.
5829
5830 With prefix ARG, silently save all file-visiting buffers, then kill.
5831
5832 If emacsclient was started with a list of filenames to edit, then
5833 only these files will be asked to be saved."
5834 (interactive "P")
5835 (if (frame-parameter (selected-frame) 'client)
5836 (server-save-buffers-kill-terminal arg)
5837 (save-buffers-kill-emacs arg)))
5838 \f
5839 ;; We use /: as a prefix to "quote" a file name
5840 ;; so that magic file name handlers will not apply to it.
5841
5842 (setq file-name-handler-alist
5843 (cons '("\\`/:" . file-name-non-special)
5844 file-name-handler-alist))
5845
5846 ;; We depend on being the last handler on the list,
5847 ;; so that anything else which does need handling
5848 ;; has been handled already.
5849 ;; So it is safe for us to inhibit *all* magic file name handlers.
5850
5851 (defun file-name-non-special (operation &rest arguments)
5852 (let ((file-name-handler-alist nil)
5853 (default-directory
5854 (if (eq operation 'insert-directory)
5855 (directory-file-name
5856 (expand-file-name
5857 (unhandled-file-name-directory default-directory)))
5858 default-directory))
5859 ;; Get a list of the indices of the args which are file names.
5860 (file-arg-indices
5861 (cdr (or (assq operation
5862 ;; The first six are special because they
5863 ;; return a file name. We want to include the /:
5864 ;; in the return value.
5865 ;; So just avoid stripping it in the first place.
5866 '((expand-file-name . nil)
5867 (file-name-directory . nil)
5868 (file-name-as-directory . nil)
5869 (directory-file-name . nil)
5870 (file-name-sans-versions . nil)
5871 (find-backup-file-name . nil)
5872 ;; `identity' means just return the first arg
5873 ;; not stripped of its quoting.
5874 (substitute-in-file-name identity)
5875 ;; `add' means add "/:" to the result.
5876 (file-truename add 0)
5877 ;; `quote' means add "/:" to buffer-file-name.
5878 (insert-file-contents quote 0)
5879 ;; `unquote-then-quote' means set buffer-file-name
5880 ;; temporarily to unquoted filename.
5881 (verify-visited-file-modtime unquote-then-quote)
5882 ;; List the arguments which are filenames.
5883 (file-name-completion 1)
5884 (file-name-all-completions 1)
5885 (write-region 2 5)
5886 (rename-file 0 1)
5887 (copy-file 0 1)
5888 (make-symbolic-link 0 1)
5889 (add-name-to-file 0 1)))
5890 ;; For all other operations, treat the first argument only
5891 ;; as the file name.
5892 '(nil 0))))
5893 method
5894 ;; Copy ARGUMENTS so we can replace elements in it.
5895 (arguments (copy-sequence arguments)))
5896 (if (symbolp (car file-arg-indices))
5897 (setq method (pop file-arg-indices)))
5898 ;; Strip off the /: from the file names that have it.
5899 (save-match-data
5900 (while (consp file-arg-indices)
5901 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5902 (and (car pair)
5903 (string-match "\\`/:" (car pair))
5904 (setcar pair
5905 (if (= (length (car pair)) 2)
5906 "/"
5907 (substring (car pair) 2)))))
5908 (setq file-arg-indices (cdr file-arg-indices))))
5909 (cond ((eq method 'identity)
5910 (car arguments))
5911 ((eq method 'add)
5912 (concat "/:" (apply operation arguments)))
5913 ((eq method 'quote)
5914 (unwind-protect
5915 (apply operation arguments)
5916 (setq buffer-file-name (concat "/:" buffer-file-name))))
5917 ((eq method 'unquote-then-quote)
5918 (let (res)
5919 (setq buffer-file-name (substring buffer-file-name 2))
5920 (setq res (apply operation arguments))
5921 (setq buffer-file-name (concat "/:" buffer-file-name))
5922 res))
5923 (t
5924 (apply operation arguments)))))
5925 \f
5926 ;; Symbolic modes and read-file-modes.
5927
5928 (defun file-modes-char-to-who (char)
5929 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5930 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5931 Others, or All) for whom to produce the mask.
5932 The bit-mask that is returned extracts from mode bits the access rights
5933 for the specified category of users."
5934 (cond ((= char ?u) #o4700)
5935 ((= char ?g) #o2070)
5936 ((= char ?o) #o1007)
5937 ((= char ?a) #o7777)
5938 (t (error "%c: bad `who' character" char))))
5939
5940 (defun file-modes-char-to-right (char &optional from)
5941 "Convert CHAR to a numeric value of mode bits.
5942 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5943 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5944 (or from (setq from 0))
5945 (cond ((= char ?r) #o0444)
5946 ((= char ?w) #o0222)
5947 ((= char ?x) #o0111)
5948 ((= char ?s) #o1000)
5949 ((= char ?t) #o6000)
5950 ;; Rights relative to the previous file modes.
5951 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5952 ((= char ?u) (let ((uright (logand #o4700 from)))
5953 (+ uright (/ uright #o10) (/ uright #o100))))
5954 ((= char ?g) (let ((gright (logand #o2070 from)))
5955 (+ gright (/ gright #o10) (* gright #o10))))
5956 ((= char ?o) (let ((oright (logand #o1007 from)))
5957 (+ oright (* oright #o10) (* oright #o100))))
5958 (t (error "%c: bad right character" char))))
5959
5960 (defun file-modes-rights-to-number (rights who-mask &optional from)
5961 "Convert a symbolic mode string specification to an equivalent number.
5962 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
5963 WHO-MASK is the bit-mask specifying the category of users to which to
5964 apply the access permissions. See `file-modes-char-to-who'.
5965 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5966 RIGHTS request to add, remove, or set permissions based on existing ones,
5967 as in \"og+rX-w\"."
5968 (let* ((num-rights (or from 0))
5969 (list-rights (string-to-list rights))
5970 (op (pop list-rights)))
5971 (while (memq op '(?+ ?- ?=))
5972 (let ((num-right 0)
5973 char-right)
5974 (while (memq (setq char-right (pop list-rights))
5975 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5976 (setq num-right
5977 (logior num-right
5978 (file-modes-char-to-right char-right num-rights))))
5979 (setq num-right (logand who-mask num-right)
5980 num-rights
5981 (cond ((= op ?+) (logior num-rights num-right))
5982 ((= op ?-) (logand num-rights (lognot num-right)))
5983 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5984 op char-right)))
5985 num-rights))
5986
5987 (defun file-modes-symbolic-to-number (modes &optional from)
5988 "Convert symbolic file modes to numeric file modes.
5989 MODES is the string to convert, it should match
5990 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
5991 See (info \"(coreutils)File permissions\") for more information on this
5992 notation.
5993 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5994 MODES request to add, remove, or set permissions based on existing ones,
5995 as in \"og+rX-w\"."
5996 (save-match-data
5997 (let ((case-fold-search nil)
5998 (num-modes (or from 0)))
5999 (while (/= (string-to-char modes) 0)
6000 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6001 (let ((num-who (apply 'logior 0
6002 (mapcar 'file-modes-char-to-who
6003 (match-string 1 modes)))))
6004 (when (= num-who 0)
6005 (setq num-who (default-file-modes)))
6006 (setq num-modes
6007 (file-modes-rights-to-number (substring modes (match-end 1))
6008 num-who num-modes)
6009 modes (substring modes (match-end 3))))
6010 (error "Parse error in modes near `%s'" (substring modes 0))))
6011 num-modes)))
6012
6013 (defun read-file-modes (&optional prompt orig-file)
6014 "Read file modes in octal or symbolic notation and return its numeric value.
6015 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6016 ORIG-FILE is the name of a file on whose mode bits to base returned
6017 permissions if what user types requests to add, remove, or set permissions
6018 based on existing mode bits, as in \"og+rX-w\"."
6019 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6020 (error "File not found")))
6021 (modestr (and (stringp orig-file)
6022 (nth 8 (file-attributes orig-file))))
6023 (default
6024 (and (stringp modestr)
6025 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6026 (replace-regexp-in-string
6027 "-" ""
6028 (format "u=%s,g=%s,o=%s"
6029 (match-string 1 modestr)
6030 (match-string 2 modestr)
6031 (match-string 3 modestr)))))
6032 (value (read-string (or prompt "File modes (octal or symbolic): ")
6033 nil nil default)))
6034 (save-match-data
6035 (if (string-match "^[0-7]+" value)
6036 (string-to-number value 8)
6037 (file-modes-symbolic-to-number value modes)))))
6038
6039 \f
6040 ;; Trashcan handling.
6041 (defcustom trash-directory nil
6042 "Directory for `move-file-to-trash' to move files and directories to.
6043 This directory is only used when the function `system-move-file-to-trash'
6044 is not defined.
6045 Relative paths are interpreted relative to `default-directory'.
6046 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6047 :type '(choice (const nil) directory)
6048 :group 'auto-save
6049 :version "23.2")
6050
6051 (defvar trash--hexify-table)
6052
6053 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6054
6055 (defun move-file-to-trash (filename)
6056 "Move the file (or directory) named FILENAME to the trash.
6057 When `delete-by-moving-to-trash' is non-nil, this function is
6058 called by `delete-file' and `delete-directory' instead of
6059 deleting files outright.
6060
6061 If the function `system-move-file-to-trash' is defined, call it
6062 with FILENAME as an argument.
6063 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6064 directory.
6065 Otherwise, trash FILENAME using the freedesktop.org conventions,
6066 like the GNOME, KDE and XFCE desktop environments. Emacs only
6067 moves files to \"home trash\", ignoring per-volume trashcans."
6068 (interactive "fMove file to trash: ")
6069 (cond (trash-directory
6070 ;; If `trash-directory' is non-nil, move the file there.
6071 (let* ((trash-dir (expand-file-name trash-directory))
6072 (fn (directory-file-name (expand-file-name filename)))
6073 (new-fn (expand-file-name (file-name-nondirectory fn)
6074 trash-dir)))
6075 ;; We can't trash a parent directory of trash-directory.
6076 (if (string-match fn trash-dir)
6077 (error "Trash directory `%s' is a subdirectory of `%s'"
6078 trash-dir filename))
6079 (unless (file-directory-p trash-dir)
6080 (make-directory trash-dir t))
6081 ;; Ensure that the trashed file-name is unique.
6082 (if (file-exists-p new-fn)
6083 (let ((version-control t)
6084 (backup-directory-alist nil))
6085 (setq new-fn (car (find-backup-file-name new-fn)))))
6086 (let (delete-by-moving-to-trash)
6087 (rename-file fn new-fn))))
6088 ;; If `system-move-file-to-trash' is defined, use it.
6089 ((fboundp 'system-move-file-to-trash)
6090 (system-move-file-to-trash filename))
6091 ;; Otherwise, use the freedesktop.org method, as specified at
6092 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6093 (t
6094 (let* ((xdg-data-dir
6095 (directory-file-name
6096 (expand-file-name "Trash"
6097 (or (getenv "XDG_DATA_HOME")
6098 "~/.local/share"))))
6099 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6100 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6101 (fn (directory-file-name (expand-file-name filename))))
6102
6103 ;; Check if we have permissions to delete.
6104 (unless (file-writable-p (directory-file-name
6105 (file-name-directory fn)))
6106 (error "Cannot move %s to trash: Permission denied" filename))
6107 ;; The trashed file cannot be the trash dir or its parent.
6108 (if (string-match fn trash-files-dir)
6109 (error "The trash directory %s is a subdirectory of %s"
6110 trash-files-dir filename))
6111 (if (string-match fn trash-info-dir)
6112 (error "The trash directory %s is a subdirectory of %s"
6113 trash-info-dir filename))
6114
6115 ;; Ensure that the trash directory exists; otherwise, create it.
6116 (let ((saved-default-file-modes (default-file-modes)))
6117 (set-default-file-modes ?\700)
6118 (unless (file-exists-p trash-files-dir)
6119 (make-directory trash-files-dir t))
6120 (unless (file-exists-p trash-info-dir)
6121 (make-directory trash-info-dir t))
6122 (set-default-file-modes saved-default-file-modes))
6123
6124 ;; Try to move to trash with .trashinfo undo information
6125 (save-excursion
6126 (with-temp-buffer
6127 (set-buffer-file-coding-system 'utf-8-unix)
6128 (insert "[Trash Info]\nPath=")
6129 ;; Perform url-encoding on FN. For compatibility with
6130 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6131 ;; for path separators.
6132 (unless (boundp 'trash--hexify-table)
6133 (setq trash--hexify-table (make-vector 256 nil))
6134 (let ((unreserved-chars
6135 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6136 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6137 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6138 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6139 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6140 ?\( ?\))))
6141 (dotimes (byte 256)
6142 (aset trash--hexify-table byte
6143 (if (memq byte unreserved-chars)
6144 (char-to-string byte)
6145 (format "%%%02x" byte))))))
6146 (mapc (lambda (byte)
6147 (insert (aref trash--hexify-table byte)))
6148 (if (multibyte-string-p fn)
6149 (encode-coding-string fn 'utf-8)
6150 fn))
6151 (insert "\nDeletionDate="
6152 (format-time-string "%Y-%m-%dT%T")
6153 "\n")
6154
6155 ;; Attempt to make .trashinfo file, trying up to 5
6156 ;; times. The .trashinfo file is opened with O_EXCL,
6157 ;; as per trash-spec 0.7, even if that can be a problem
6158 ;; on old NFS versions...
6159 (let* ((tries 5)
6160 (base-fn (expand-file-name
6161 (file-name-nondirectory fn)
6162 trash-files-dir))
6163 (new-fn base-fn)
6164 success info-fn)
6165 (while (> tries 0)
6166 (setq info-fn (expand-file-name
6167 (concat (file-name-nondirectory new-fn)
6168 ".trashinfo")
6169 trash-info-dir))
6170 (unless (condition-case nil
6171 (progn
6172 (write-region nil nil info-fn nil
6173 'quiet info-fn 'excl)
6174 (setq tries 0 success t))
6175 (file-already-exists nil))
6176 (setq tries (1- tries))
6177 ;; Uniqify new-fn. (Some file managers do not
6178 ;; like Emacs-style backup file names---e.g. bug
6179 ;; 170956 in Konqueror bug tracker.)
6180 (setq new-fn (make-temp-name (concat base-fn "_")))))
6181 (unless success
6182 (error "Cannot move %s to trash: Lock failed" filename))
6183
6184 ;; Finally, try to move the file to the trashcan.
6185 (let ((delete-by-moving-to-trash nil))
6186 (rename-file fn new-fn)))))))))
6187
6188 \f
6189 (define-key ctl-x-map "\C-f" 'find-file)
6190 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6191 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6192 (define-key ctl-x-map "\C-s" 'save-buffer)
6193 (define-key ctl-x-map "s" 'save-some-buffers)
6194 (define-key ctl-x-map "\C-w" 'write-file)
6195 (define-key ctl-x-map "i" 'insert-file)
6196 (define-key esc-map "~" 'not-modified)
6197 (define-key ctl-x-map "\C-d" 'list-directory)
6198 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6199 (define-key ctl-x-map "\C-q" 'toggle-read-only)
6200
6201 (define-key ctl-x-4-map "f" 'find-file-other-window)
6202 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6203 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6204 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6205 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6206
6207 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6208 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6209 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6210 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6211 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6212
6213 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6214 ;;; files.el ends here