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