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