]> code.delx.au - gnu-emacs/blob - lisp/files.el
* lisp/files.el (auto-mode-alist): Prefer C-mode for .xs. (Bug#7071)
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 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 ("\\.te?xt\\'" . text-mode)
2215 ("\\.[tT]e[xX]\\'" . tex-mode)
2216 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2217 ("\\.ltx\\'" . latex-mode)
2218 ("\\.dtx\\'" . doctex-mode)
2219 ("\\.org\\'" . org-mode)
2220 ("\\.el\\'" . emacs-lisp-mode)
2221 ("Project\\.ede\\'" . emacs-lisp-mode)
2222 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2223 ("\\.l\\'" . lisp-mode)
2224 ("\\.li?sp\\'" . lisp-mode)
2225 ("\\.[fF]\\'" . fortran-mode)
2226 ("\\.for\\'" . fortran-mode)
2227 ("\\.p\\'" . pascal-mode)
2228 ("\\.pas\\'" . pascal-mode)
2229 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode)
2230 ("\\.ad[abs]\\'" . ada-mode)
2231 ("\\.ad[bs].dg\\'" . ada-mode)
2232 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2233 ("Imakefile\\'" . makefile-imake-mode)
2234 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2235 ("\\.makepp\\'" . makefile-makepp-mode)
2236 ,@(if (memq system-type '(berkeley-unix darwin))
2237 '(("\\.mk\\'" . makefile-bsdmake-mode)
2238 ("GNUmakefile\\'" . makefile-gmake-mode)
2239 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2240 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2241 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2242 ("\\.am\\'" . makefile-automake-mode)
2243 ;; Less common extensions come here
2244 ;; so more common ones above are found faster.
2245 ("\\.texinfo\\'" . texinfo-mode)
2246 ("\\.te?xi\\'" . texinfo-mode)
2247 ("\\.[sS]\\'" . asm-mode)
2248 ("\\.asm\\'" . asm-mode)
2249 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2250 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2251 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2252 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2253 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2254 ("\\.bash\\'" . sh-mode)
2255 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2256 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2257 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2258 ("\\.m?spec\\'" . sh-mode)
2259 ("\\.m[mes]\\'" . nroff-mode)
2260 ("\\.man\\'" . nroff-mode)
2261 ("\\.sty\\'" . latex-mode)
2262 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2263 ("\\.bbl\\'" . latex-mode)
2264 ("\\.bib\\'" . bibtex-mode)
2265 ("\\.sql\\'" . sql-mode)
2266 ("\\.m[4c]\\'" . m4-mode)
2267 ("\\.mf\\'" . metafont-mode)
2268 ("\\.mp\\'" . metapost-mode)
2269 ("\\.vhdl?\\'" . vhdl-mode)
2270 ("\\.article\\'" . text-mode)
2271 ("\\.letter\\'" . text-mode)
2272 ("\\.i?tcl\\'" . tcl-mode)
2273 ("\\.exp\\'" . tcl-mode)
2274 ("\\.itk\\'" . tcl-mode)
2275 ("\\.icn\\'" . icon-mode)
2276 ("\\.sim\\'" . simula-mode)
2277 ("\\.mss\\'" . scribe-mode)
2278 ("\\.f9[05]\\'" . f90-mode)
2279 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2280 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2281 ("\\.srt\\'" . srecode-template-mode)
2282 ("\\.prolog\\'" . prolog-mode)
2283 ("\\.tar\\'" . tar-mode)
2284 ;; The list of archive file extensions should be in sync with
2285 ;; `auto-coding-alist' with `no-conversion' coding system.
2286 ("\\.\\(\
2287 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2288 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode)
2289 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2290 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2291 ;; Mailer puts message to be edited in
2292 ;; /tmp/Re.... or Message
2293 ("\\`/tmp/Re" . text-mode)
2294 ("/Message[0-9]*\\'" . text-mode)
2295 ;; some news reader is reported to use this
2296 ("\\`/tmp/fol/" . text-mode)
2297 ("\\.oak\\'" . scheme-mode)
2298 ("\\.sgml?\\'" . sgml-mode)
2299 ("\\.x[ms]l\\'" . xml-mode)
2300 ("\\.dtd\\'" . sgml-mode)
2301 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2302 ("\\.js\\'" . js-mode) ; javascript-mode would be better
2303 ("\\.[ds]?vh?\\'" . verilog-mode)
2304 ;; .emacs or .gnus or .viper following a directory delimiter in
2305 ;; Unix, MSDOG or VMS syntax.
2306 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2307 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2308 ;; _emacs following a directory delimiter
2309 ;; in MsDos syntax
2310 ("[:/]_emacs\\'" . emacs-lisp-mode)
2311 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2312 ("\\.ml\\'" . lisp-mode)
2313 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2314 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2315 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2316 ("\\.ld[si]?\\'" . ld-script-mode)
2317 ("ld\\.?script\\'" . ld-script-mode)
2318 ;; .xs is also used for ld scripts, but seems to be more commonly
2319 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2320 ("\\.xs\\'" . c-mode)
2321 ("\\.x[bdsru]?[cn]?\\'" . ld-script-mode)
2322 ;; Common Lisp ASDF package system.
2323 ("\\.asd\\'" . lisp-mode)
2324 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2325 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2326 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2327 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2328 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2329 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2330 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2331 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2332 ("BROWSE\\'" . ebrowse-tree-mode)
2333 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2334 ("#\\*mail\\*" . mail-mode)
2335 ("\\.g\\'" . antlr-mode)
2336 ("\\.ses\\'" . ses-mode)
2337 ("\\.docbook\\'" . sgml-mode)
2338 ("\\.com\\'" . dcl-mode)
2339 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2340 ;; Windows candidates may be opened case sensitively on Unix
2341 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2342 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2343 ("\\.ppd\\'" . conf-ppd-mode)
2344 ("java.+\\.conf\\'" . conf-javaprop-mode)
2345 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2346 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2347 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2348 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2349 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2350 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2351 ;; this has lower priority to avoid matching changelog.sgml etc.
2352 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2353 ;; either user's dot-files or under /etc or some such
2354 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2355 ;; alas not all ~/.*rc files are like this
2356 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2357 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2358 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2359 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2360 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2361 ;; this contains everything twice, with space and with colon :-(
2362 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2363 ;; Get rid of any trailing .n.m and try again.
2364 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2365 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2366 ;; Using mode nil rather than `ignore' would let the search continue
2367 ;; through this list (with the shortened name) rather than start over.
2368 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2369 ;; The following should come after the ChangeLog pattern
2370 ;; for the sake of ChangeLog.1, etc.
2371 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2372 ("\\.[1-9]\\'" . nroff-mode)
2373 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2374 "Alist of filename patterns vs corresponding major mode functions.
2375 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2376 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2377 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2378 mode function to use. FUNCTION will be called, unless it is nil.
2379
2380 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2381 calling FUNCTION (if it's not nil), we delete the suffix that matched
2382 REGEXP and search the list again for another match.
2383
2384 If the file name matches `inhibit-first-line-modes-regexps',
2385 then `auto-mode-alist' is not processed.
2386
2387 The extensions whose FUNCTION is `archive-mode' should also
2388 appear in `auto-coding-alist' with `no-conversion' coding system.
2389
2390 See also `interpreter-mode-alist', which detects executable script modes
2391 based on the interpreters they specify to run,
2392 and `magic-mode-alist', which determines modes based on file contents.")
2393 (put 'auto-mode-alist 'risky-local-variable t)
2394
2395 (defun conf-mode-maybe ()
2396 "Select Conf mode or XML mode according to start of file."
2397 (if (save-excursion
2398 (save-restriction
2399 (widen)
2400 (goto-char (point-min))
2401 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2402 (xml-mode)
2403 (conf-mode)))
2404
2405 (defvar interpreter-mode-alist
2406 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2407 ;; and pike-mode) are added through autoload directives in that
2408 ;; file. That way is discouraged since it spreads out the
2409 ;; definition of the initial value.
2410 (mapcar
2411 (lambda (l)
2412 (cons (purecopy (car l)) (cdr l)))
2413 '(("perl" . perl-mode)
2414 ("perl5" . perl-mode)
2415 ("miniperl" . perl-mode)
2416 ("wish" . tcl-mode)
2417 ("wishx" . tcl-mode)
2418 ("tcl" . tcl-mode)
2419 ("tclsh" . tcl-mode)
2420 ("scm" . scheme-mode)
2421 ("ash" . sh-mode)
2422 ("bash" . sh-mode)
2423 ("bash2" . sh-mode)
2424 ("csh" . sh-mode)
2425 ("dtksh" . sh-mode)
2426 ("es" . sh-mode)
2427 ("itcsh" . sh-mode)
2428 ("jsh" . sh-mode)
2429 ("ksh" . sh-mode)
2430 ("oash" . sh-mode)
2431 ("pdksh" . sh-mode)
2432 ("rc" . sh-mode)
2433 ("rpm" . sh-mode)
2434 ("sh" . sh-mode)
2435 ("sh5" . sh-mode)
2436 ("tcsh" . sh-mode)
2437 ("wksh" . sh-mode)
2438 ("wsh" . sh-mode)
2439 ("zsh" . sh-mode)
2440 ("tail" . text-mode)
2441 ("more" . text-mode)
2442 ("less" . text-mode)
2443 ("pg" . text-mode)
2444 ("make" . makefile-gmake-mode) ; Debian uses this
2445 ("guile" . scheme-mode)
2446 ("clisp" . lisp-mode)
2447 ("emacs" . emacs-lisp-mode)))
2448 "Alist mapping interpreter names to major modes.
2449 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2450 Each element looks like (INTERPRETER . MODE).
2451 If INTERPRETER matches the name of the interpreter specified in the first line
2452 of a script, mode MODE is enabled.
2453
2454 See also `auto-mode-alist'.")
2455
2456 (defvar inhibit-first-line-modes-regexps (mapcar 'purecopy '("\\.tar\\'" "\\.tgz\\'"))
2457 "List of regexps; if one matches a file name, don't look for `-*-'.")
2458
2459 (defvar inhibit-first-line-modes-suffixes nil
2460 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2461 When checking `inhibit-first-line-modes-regexps', we first discard
2462 from the end of the file name anything that matches one of these regexps.")
2463
2464 (defvar auto-mode-interpreter-regexp
2465 (purecopy "#![ \t]?\\([^ \t\n]*\
2466 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2467 "Regexp matching interpreters, for file mode determination.
2468 This regular expression is matched against the first line of a file
2469 to determine the file's mode in `set-auto-mode'. If it matches, the file
2470 is assumed to be interpreted by the interpreter matched by the second group
2471 of the regular expression. The mode is then determined as the mode
2472 associated with that interpreter in `interpreter-mode-alist'.")
2473
2474 (defvar magic-mode-alist nil
2475 "Alist of buffer beginnings vs. corresponding major mode functions.
2476 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2477 After visiting a file, if REGEXP matches the text at the beginning of the
2478 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2479 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2480 major mode.
2481
2482 If FUNCTION is nil, then it is not called. (That is a way of saying
2483 \"allow `auto-mode-alist' to decide for these files.\")")
2484 (put 'magic-mode-alist 'risky-local-variable t)
2485
2486 (defvar magic-fallback-mode-alist
2487 (purecopy
2488 `((image-type-auto-detected-p . image-mode)
2489 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2490 ;; The < comes before the groups (but the first) to reduce backtracking.
2491 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2492 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2493 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2494 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2495 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2496 comment-re "*"
2497 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2498 "[Hh][Tt][Mm][Ll]"))
2499 . html-mode)
2500 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2501 ;; These two must come after html, because they are more general:
2502 ("<\\?xml " . xml-mode)
2503 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2504 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2505 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2506 . sgml-mode)
2507 ("%!PS" . ps-mode)
2508 ("# xmcd " . conf-unix-mode)))
2509 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2510 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2511 After visiting a file, if REGEXP matches the text at the beginning of the
2512 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2513 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2514 have not specified a mode for this file.
2515
2516 If FUNCTION is nil, then it is not called.")
2517 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2518
2519 (defvar magic-mode-regexp-match-limit 4000
2520 "Upper limit on `magic-mode-alist' regexp matches.
2521 Also applies to `magic-fallback-mode-alist'.")
2522
2523 (defun set-auto-mode (&optional keep-mode-if-same)
2524 "Select major mode appropriate for current buffer.
2525
2526 To find the right major mode, this function checks for a -*- mode tag,
2527 checks if it uses an interpreter listed in `interpreter-mode-alist',
2528 matches the buffer beginning against `magic-mode-alist',
2529 compares the filename against the entries in `auto-mode-alist',
2530 then matches the buffer beginning against `magic-fallback-mode-alist'.
2531
2532 It does not check for the `mode:' local variable in the
2533 Local Variables section of the file; for that, use `hack-local-variables'.
2534
2535 If `enable-local-variables' is nil, this function does not check for a
2536 -*- mode tag.
2537
2538 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2539 set the major mode only if that would change it. In other words
2540 we don't actually set it to the same mode the buffer already has."
2541 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2542 (let (end done mode modes)
2543 ;; Find a -*- mode tag
2544 (save-excursion
2545 (goto-char (point-min))
2546 (skip-chars-forward " \t\n")
2547 (and enable-local-variables
2548 (setq end (set-auto-mode-1))
2549 (if (save-excursion (search-forward ":" end t))
2550 ;; Find all specifications for the `mode:' variable
2551 ;; and execute them left to right.
2552 (while (let ((case-fold-search t))
2553 (or (and (looking-at "mode:")
2554 (goto-char (match-end 0)))
2555 (re-search-forward "[ \t;]mode:" end t)))
2556 (skip-chars-forward " \t")
2557 (let ((beg (point)))
2558 (if (search-forward ";" end t)
2559 (forward-char -1)
2560 (goto-char end))
2561 (skip-chars-backward " \t")
2562 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2563 modes)))
2564 ;; Simple -*-MODE-*- case.
2565 (push (intern (concat (downcase (buffer-substring (point) end))
2566 "-mode"))
2567 modes))))
2568 ;; If we found modes to use, invoke them now, outside the save-excursion.
2569 (if modes
2570 (catch 'nop
2571 (dolist (mode (nreverse modes))
2572 (if (not (functionp mode))
2573 (message "Ignoring unknown mode `%s'" mode)
2574 (setq done t)
2575 (or (set-auto-mode-0 mode keep-mode-if-same)
2576 ;; continuing would call minor modes again, toggling them off
2577 (throw 'nop nil))))))
2578 ;; If we didn't, look for an interpreter specified in the first line.
2579 ;; As a special case, allow for things like "#!/bin/env perl", which
2580 ;; finds the interpreter anywhere in $PATH.
2581 (unless done
2582 (setq mode (save-excursion
2583 (goto-char (point-min))
2584 (if (looking-at auto-mode-interpreter-regexp)
2585 (match-string 2)
2586 ""))
2587 ;; Map interpreter name to a mode, signalling we're done at the
2588 ;; same time.
2589 done (assoc (file-name-nondirectory mode)
2590 interpreter-mode-alist))
2591 ;; If we found an interpreter mode to use, invoke it now.
2592 (if done
2593 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2594 ;; Next try matching the buffer beginning against magic-mode-alist.
2595 (unless done
2596 (if (setq done (save-excursion
2597 (goto-char (point-min))
2598 (save-restriction
2599 (narrow-to-region (point-min)
2600 (min (point-max)
2601 (+ (point-min) magic-mode-regexp-match-limit)))
2602 (assoc-default nil magic-mode-alist
2603 (lambda (re dummy)
2604 (if (functionp re)
2605 (funcall re)
2606 (looking-at re)))))))
2607 (set-auto-mode-0 done keep-mode-if-same)))
2608 ;; Next compare the filename against the entries in auto-mode-alist.
2609 (unless done
2610 (if buffer-file-name
2611 (let ((name buffer-file-name)
2612 (remote-id (file-remote-p buffer-file-name)))
2613 ;; Remove remote file name identification.
2614 (when (and (stringp remote-id)
2615 (string-match (regexp-quote remote-id) name))
2616 (setq name (substring name (match-end 0))))
2617 ;; Remove backup-suffixes from file name.
2618 (setq name (file-name-sans-versions name))
2619 (while name
2620 ;; Find first matching alist entry.
2621 (setq mode
2622 (if (memq system-type '(windows-nt cygwin))
2623 ;; System is case-insensitive.
2624 (let ((case-fold-search t))
2625 (assoc-default name auto-mode-alist
2626 'string-match))
2627 ;; System is case-sensitive.
2628 (or
2629 ;; First match case-sensitively.
2630 (let ((case-fold-search nil))
2631 (assoc-default name auto-mode-alist
2632 'string-match))
2633 ;; Fallback to case-insensitive match.
2634 (and auto-mode-case-fold
2635 (let ((case-fold-search t))
2636 (assoc-default name auto-mode-alist
2637 'string-match))))))
2638 (if (and mode
2639 (consp mode)
2640 (cadr mode))
2641 (setq mode (car mode)
2642 name (substring name 0 (match-beginning 0)))
2643 (setq name))
2644 (when mode
2645 (set-auto-mode-0 mode keep-mode-if-same)
2646 (setq done t))))))
2647 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2648 (unless done
2649 (if (setq done (save-excursion
2650 (goto-char (point-min))
2651 (save-restriction
2652 (narrow-to-region (point-min)
2653 (min (point-max)
2654 (+ (point-min) magic-mode-regexp-match-limit)))
2655 (assoc-default nil magic-fallback-mode-alist
2656 (lambda (re dummy)
2657 (if (functionp re)
2658 (funcall re)
2659 (looking-at re)))))))
2660 (set-auto-mode-0 done keep-mode-if-same)))))
2661
2662 ;; When `keep-mode-if-same' is set, we are working on behalf of
2663 ;; set-visited-file-name. In that case, if the major mode specified is the
2664 ;; same one we already have, don't actually reset it. We don't want to lose
2665 ;; minor modes such as Font Lock.
2666 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2667 "Apply MODE and return it.
2668 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2669 any aliases and compared to current major mode. If they are the
2670 same, do nothing and return nil."
2671 (unless (and keep-mode-if-same
2672 (eq (indirect-function mode)
2673 (indirect-function major-mode)))
2674 (when mode
2675 (funcall mode)
2676 mode)))
2677
2678 (defun set-auto-mode-1 ()
2679 "Find the -*- spec in the buffer.
2680 Call with point at the place to start searching from.
2681 If one is found, set point to the beginning
2682 and return the position of the end.
2683 Otherwise, return nil; point may be changed."
2684 (let (beg end)
2685 (and
2686 ;; Don't look for -*- if this file name matches any
2687 ;; of the regexps in inhibit-first-line-modes-regexps.
2688 (let ((temp inhibit-first-line-modes-regexps)
2689 (name (if buffer-file-name
2690 (file-name-sans-versions buffer-file-name)
2691 (buffer-name))))
2692 (while (let ((sufs inhibit-first-line-modes-suffixes))
2693 (while (and sufs (not (string-match (car sufs) name)))
2694 (setq sufs (cdr sufs)))
2695 sufs)
2696 (setq name (substring name 0 (match-beginning 0))))
2697 (while (and temp
2698 (not (string-match (car temp) name)))
2699 (setq temp (cdr temp)))
2700 (not temp))
2701
2702 (search-forward "-*-" (line-end-position
2703 ;; If the file begins with "#!"
2704 ;; (exec interpreter magic), look
2705 ;; for mode frobs in the first two
2706 ;; lines. You cannot necessarily
2707 ;; put them in the first line of
2708 ;; such a file without screwing up
2709 ;; the interpreter invocation.
2710 ;; The same holds for
2711 ;; '\"
2712 ;; in man pages (preprocessor
2713 ;; magic for the `man' program).
2714 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2715 (progn
2716 (skip-chars-forward " \t")
2717 (setq beg (point))
2718 (search-forward "-*-" (line-end-position) t))
2719 (progn
2720 (forward-char -3)
2721 (skip-chars-backward " \t")
2722 (setq end (point))
2723 (goto-char beg)
2724 end))))
2725 \f
2726 ;;; Handling file local variables
2727
2728 (defvar ignored-local-variables
2729 '(ignored-local-variables safe-local-variable-values
2730 file-local-variables-alist dir-local-variables-alist)
2731 "Variables to be ignored in a file's local variable spec.")
2732 (put 'ignored-local-variables 'risky-local-variable t)
2733
2734 (defvar hack-local-variables-hook nil
2735 "Normal hook run after processing a file's local variables specs.
2736 Major modes can use this to examine user-specified local variables
2737 in order to initialize other data structure based on them.")
2738
2739 (defcustom safe-local-variable-values nil
2740 "List variable-value pairs that are considered safe.
2741 Each element is a cons cell (VAR . VAL), where VAR is a variable
2742 symbol and VAL is a value that is considered safe."
2743 :risky t
2744 :group 'find-file
2745 :type 'alist)
2746
2747 (defcustom safe-local-eval-forms
2748 '((add-hook 'write-file-functions 'time-stamp)
2749 (add-hook 'before-save-hook 'time-stamp))
2750 "Expressions that are considered safe in an `eval:' local variable.
2751 Add expressions to this list if you want Emacs to evaluate them, when
2752 they appear in an `eval' local variable specification, without first
2753 asking you for confirmation."
2754 :risky t
2755 :group 'find-file
2756 :version "22.2"
2757 :type '(repeat sexp))
2758
2759 ;; Risky local variables:
2760 (mapc (lambda (var) (put var 'risky-local-variable t))
2761 '(after-load-alist
2762 buffer-auto-save-file-name
2763 buffer-file-name
2764 buffer-file-truename
2765 buffer-undo-list
2766 debugger
2767 default-text-properties
2768 eval
2769 exec-directory
2770 exec-path
2771 file-name-handler-alist
2772 frame-title-format
2773 global-mode-string
2774 header-line-format
2775 icon-title-format
2776 inhibit-quit
2777 load-path
2778 max-lisp-eval-depth
2779 max-specpdl-size
2780 minor-mode-map-alist
2781 minor-mode-overriding-map-alist
2782 mode-line-format
2783 mode-name
2784 overriding-local-map
2785 overriding-terminal-local-map
2786 process-environment
2787 standard-input
2788 standard-output
2789 unread-command-events))
2790
2791 ;; Safe local variables:
2792 ;;
2793 ;; For variables defined by major modes, the safety declarations can go into
2794 ;; the major mode's file, since that will be loaded before file variables are
2795 ;; processed.
2796 ;;
2797 ;; For variables defined by minor modes, put the safety declarations in the
2798 ;; file defining the minor mode after the defcustom/defvar using an autoload
2799 ;; cookie, e.g.:
2800 ;;
2801 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2802 ;;
2803 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2804 ;; minor mode file may not be loaded yet.
2805 ;;
2806 ;; For variables defined in the C source code the declaration should go here:
2807
2808 (mapc (lambda (pair)
2809 (put (car pair) 'safe-local-variable (cdr pair)))
2810 '((buffer-read-only . booleanp) ;; C source code
2811 (default-directory . stringp) ;; C source code
2812 (fill-column . integerp) ;; C source code
2813 (indent-tabs-mode . booleanp) ;; C source code
2814 (left-margin . integerp) ;; C source code
2815 (no-update-autoloads . booleanp)
2816 (tab-width . integerp) ;; C source code
2817 (truncate-lines . booleanp) ;; C source code
2818 (word-wrap . booleanp) ;; C source code
2819 (bidi-display-reordering . booleanp))) ;; C source code
2820
2821 (put 'bidi-paragraph-direction 'safe-local-variable
2822 (lambda (v) (memq v '(nil right-to-left left-to-right))))
2823
2824 (put 'c-set-style 'safe-local-eval-function t)
2825
2826 (defvar file-local-variables-alist nil
2827 "Alist of file-local variable settings in the current buffer.
2828 Each element in this list has the form (VAR . VALUE), where VAR
2829 is a file-local variable (a symbol) and VALUE is the value
2830 specified. The actual value in the buffer may differ from VALUE,
2831 if it is changed by the major or minor modes, or by the user.")
2832 (make-variable-buffer-local 'file-local-variables-alist)
2833
2834 (defvar dir-local-variables-alist nil
2835 "Alist of directory-local variable settings in the current buffer.
2836 Each element in this list has the form (VAR . VALUE), where VAR
2837 is a directory-local variable (a symbol) and VALUE is the value
2838 specified in .dir-locals.el. The actual value in the buffer
2839 may differ from VALUE, if it is changed by the major or minor modes,
2840 or by the user.")
2841 (make-variable-buffer-local 'dir-local-variables-alist)
2842
2843 (defvar before-hack-local-variables-hook nil
2844 "Normal hook run before setting file-local variables.
2845 It is called after checking for unsafe/risky variables and
2846 setting `file-local-variables-alist', and before applying the
2847 variables stored in `file-local-variables-alist'. A hook
2848 function is allowed to change the contents of this alist.
2849
2850 This hook is called only if there is at least one file-local
2851 variable to set.")
2852
2853 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2854 "Get confirmation before setting up local variable values.
2855 ALL-VARS is the list of all variables to be set up.
2856 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2857 RISKY-VARS is the list of those that are marked as risky.
2858 DIR-NAME is a directory name if these settings come from
2859 directory-local variables, or nil otherwise."
2860 (if noninteractive
2861 nil
2862 (let ((name (or dir-name
2863 (if buffer-file-name
2864 (file-name-nondirectory buffer-file-name)
2865 (concat "buffer " (buffer-name)))))
2866 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2867 prompt char)
2868 (save-window-excursion
2869 (let ((buf (get-buffer-create "*Local Variables*")))
2870 (pop-to-buffer buf)
2871 (set (make-local-variable 'cursor-type) nil)
2872 (erase-buffer)
2873 (if unsafe-vars
2874 (insert "The local variables list in " name
2875 "\ncontains values that may not be safe (*)"
2876 (if risky-vars
2877 ", and variables that are risky (**)."
2878 "."))
2879 (if risky-vars
2880 (insert "The local variables list in " name
2881 "\ncontains variables that are risky (**).")
2882 (insert "A local variables list is specified in " name ".")))
2883 (insert "\n\nDo you want to apply it? You can type
2884 y -- to apply the local variables list.
2885 n -- to ignore the local variables list.")
2886 (if offer-save
2887 (insert "
2888 ! -- to apply the local variables list, and permanently mark these
2889 values (*) as safe (in the future, they will be set automatically.)\n\n")
2890 (insert "\n\n"))
2891 (dolist (elt all-vars)
2892 (cond ((member elt unsafe-vars)
2893 (insert " * "))
2894 ((member elt risky-vars)
2895 (insert " ** "))
2896 (t
2897 (insert " ")))
2898 (princ (car elt) buf)
2899 (insert " : ")
2900 ;; Make strings with embedded whitespace easier to read.
2901 (let ((print-escape-newlines t))
2902 (prin1 (cdr elt) buf))
2903 (insert "\n"))
2904 (setq prompt
2905 (format "Please type %s%s: "
2906 (if offer-save "y, n, or !" "y or n")
2907 (if (< (line-number-at-pos) (window-body-height))
2908 ""
2909 ", or C-v to scroll")))
2910 (goto-char (point-min))
2911 (let ((cursor-in-echo-area t)
2912 (executing-kbd-macro executing-kbd-macro)
2913 (exit-chars
2914 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2915 done)
2916 (while (not done)
2917 (message "%s" prompt)
2918 (setq char (read-event))
2919 (if (numberp char)
2920 (cond ((eq char ?\C-v)
2921 (condition-case nil
2922 (scroll-up)
2923 (error (goto-char (point-min)))))
2924 ;; read-event returns -1 if we are in a kbd
2925 ;; macro and there are no more events in the
2926 ;; macro. In that case, attempt to get an
2927 ;; event interactively.
2928 ((and executing-kbd-macro (= char -1))
2929 (setq executing-kbd-macro nil))
2930 (t (setq done (memq (downcase char) exit-chars)))))))
2931 (setq char (downcase char))
2932 (when (and offer-save (= char ?!) unsafe-vars)
2933 (dolist (elt unsafe-vars)
2934 (add-to-list 'safe-local-variable-values elt))
2935 ;; When this is called from desktop-restore-file-buffer,
2936 ;; coding-system-for-read may be non-nil. Reset it before
2937 ;; writing to .emacs.
2938 (if (or custom-file user-init-file)
2939 (let ((coding-system-for-read nil))
2940 (customize-save-variable
2941 'safe-local-variable-values
2942 safe-local-variable-values))))
2943 (kill-buffer buf)
2944 (or (= char ?!)
2945 (= char ?\s)
2946 (= char ?y)))))))
2947
2948 (defun hack-local-variables-prop-line (&optional mode-only)
2949 "Return local variables specified in the -*- line.
2950 Ignore any specification for `mode:' and `coding:';
2951 `set-auto-mode' should already have handled `mode:',
2952 `set-auto-coding' should already have handled `coding:'.
2953
2954 If MODE-ONLY is non-nil, all we do is check whether the major
2955 mode is specified, returning t if it is specified. Otherwise,
2956 return an alist of elements (VAR . VAL), where VAR is a variable
2957 and VAL is the specified value."
2958 (save-excursion
2959 (goto-char (point-min))
2960 (let ((end (set-auto-mode-1))
2961 result mode-specified)
2962 ;; Parse the -*- line into the RESULT alist.
2963 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2964 (cond ((not end)
2965 nil)
2966 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2967 ;; Simple form: "-*- MODENAME -*-". Already handled.
2968 (setq mode-specified t)
2969 nil)
2970 (t
2971 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2972 ;; (last ";" is optional).
2973 (while (< (point) end)
2974 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2975 (error "Malformed -*- line"))
2976 (goto-char (match-end 0))
2977 ;; There used to be a downcase here,
2978 ;; but the manual didn't say so,
2979 ;; and people want to set var names that aren't all lc.
2980 (let ((key (intern (match-string 1)))
2981 (val (save-restriction
2982 (narrow-to-region (point) end)
2983 (let ((read-circle nil))
2984 (read (current-buffer))))))
2985 ;; It is traditional to ignore
2986 ;; case when checking for `mode' in set-auto-mode,
2987 ;; so we must do that here as well.
2988 ;; That is inconsistent, but we're stuck with it.
2989 ;; The same can be said for `coding' in set-auto-coding.
2990 (or (and (equal (downcase (symbol-name key)) "mode")
2991 (setq mode-specified t))
2992 (equal (downcase (symbol-name key)) "coding")
2993 (condition-case nil
2994 (push (cons (if (eq key 'eval)
2995 'eval
2996 (indirect-variable key))
2997 val) result)
2998 (error nil)))
2999 (skip-chars-forward " \t;")))))
3000
3001 (if mode-only
3002 mode-specified
3003 result))))
3004
3005 (defun hack-local-variables-filter (variables dir-name)
3006 "Filter local variable settings, querying the user if necessary.
3007 VARIABLES is the alist of variable-value settings. This alist is
3008 filtered based on the values of `ignored-local-variables',
3009 `enable-local-eval', `enable-local-variables', and (if necessary)
3010 user interaction. The results are added to
3011 `file-local-variables-alist', without applying them.
3012 DIR-NAME is a directory name if these settings come from
3013 directory-local variables, or nil otherwise."
3014 ;; Find those variables that we may want to save to
3015 ;; `safe-local-variable-values'.
3016 (let (all-vars risky-vars unsafe-vars)
3017 (dolist (elt variables)
3018 (let ((var (car elt))
3019 (val (cdr elt)))
3020 (cond ((memq var ignored-local-variables)
3021 ;; Ignore any variable in `ignored-local-variables'.
3022 nil)
3023 ;; Obey `enable-local-eval'.
3024 ((eq var 'eval)
3025 (when enable-local-eval
3026 (push elt all-vars)
3027 (or (eq enable-local-eval t)
3028 (hack-one-local-variable-eval-safep (eval (quote val)))
3029 (safe-local-variable-p var val)
3030 (push elt unsafe-vars))))
3031 ;; Ignore duplicates (except `mode') in the present list.
3032 ((and (assq var all-vars) (not (eq var 'mode))) nil)
3033 ;; Accept known-safe variables.
3034 ((or (memq var '(mode unibyte coding))
3035 (safe-local-variable-p var val))
3036 (push elt all-vars))
3037 ;; The variable is either risky or unsafe:
3038 ((not (eq enable-local-variables :safe))
3039 (push elt all-vars)
3040 (if (risky-local-variable-p var val)
3041 (push elt risky-vars)
3042 (push elt unsafe-vars))))))
3043 (and all-vars
3044 ;; Query, unless all vars are safe or user wants no querying.
3045 (or (and (eq enable-local-variables t)
3046 (null unsafe-vars)
3047 (null risky-vars))
3048 (memq enable-local-variables '(:all :safe))
3049 (hack-local-variables-confirm all-vars unsafe-vars
3050 risky-vars dir-name))
3051 (dolist (elt all-vars)
3052 (unless (memq (car elt) '(eval mode))
3053 (unless dir-name
3054 (setq dir-local-variables-alist
3055 (assq-delete-all (car elt) dir-local-variables-alist)))
3056 (setq file-local-variables-alist
3057 (assq-delete-all (car elt) file-local-variables-alist)))
3058 (push elt file-local-variables-alist)))))
3059
3060 (defun hack-local-variables (&optional mode-only)
3061 "Parse and put into effect this buffer's local variables spec.
3062 If MODE-ONLY is non-nil, all we do is check whether the major mode
3063 is specified, returning t if it is specified."
3064 (let ((enable-local-variables
3065 (and local-enable-local-variables enable-local-variables))
3066 result)
3067 (unless mode-only
3068 (setq file-local-variables-alist nil)
3069 (report-errors "Directory-local variables error: %s"
3070 (hack-dir-local-variables)))
3071 (when (or mode-only enable-local-variables)
3072 (setq result (hack-local-variables-prop-line mode-only))
3073 ;; Look for "Local variables:" line in last page.
3074 (save-excursion
3075 (goto-char (point-max))
3076 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3077 'move)
3078 (when (let ((case-fold-search t))
3079 (search-forward "Local Variables:" nil t))
3080 (skip-chars-forward " \t")
3081 ;; suffix is what comes after "local variables:" in its line.
3082 ;; prefix is what comes before "local variables:" in its line.
3083 (let ((suffix
3084 (concat
3085 (regexp-quote (buffer-substring (point)
3086 (line-end-position)))
3087 "$"))
3088 (prefix
3089 (concat "^" (regexp-quote
3090 (buffer-substring (line-beginning-position)
3091 (match-beginning 0)))))
3092 beg)
3093
3094 (forward-line 1)
3095 (let ((startpos (point))
3096 endpos
3097 (thisbuf (current-buffer)))
3098 (save-excursion
3099 (unless (let ((case-fold-search t))
3100 (re-search-forward
3101 (concat prefix "[ \t]*End:[ \t]*" suffix)
3102 nil t))
3103 ;; This used to be an error, but really all it means is
3104 ;; that this may simply not be a local-variables section,
3105 ;; so just ignore it.
3106 (message "Local variables list is not properly terminated"))
3107 (beginning-of-line)
3108 (setq endpos (point)))
3109
3110 (with-temp-buffer
3111 (insert-buffer-substring thisbuf startpos endpos)
3112 (goto-char (point-min))
3113 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3114 (while (not (eobp))
3115 ;; Discard the prefix.
3116 (if (looking-at prefix)
3117 (delete-region (point) (match-end 0))
3118 (error "Local variables entry is missing the prefix"))
3119 (end-of-line)
3120 ;; Discard the suffix.
3121 (if (looking-back suffix)
3122 (delete-region (match-beginning 0) (point))
3123 (error "Local variables entry is missing the suffix"))
3124 (forward-line 1))
3125 (goto-char (point-min))
3126
3127 (while (not (eobp))
3128 ;; Find the variable name; strip whitespace.
3129 (skip-chars-forward " \t")
3130 (setq beg (point))
3131 (skip-chars-forward "^:\n")
3132 (if (eolp) (error "Missing colon in local variables entry"))
3133 (skip-chars-backward " \t")
3134 (let* ((str (buffer-substring beg (point)))
3135 (var (let ((read-circle nil))
3136 (read str)))
3137 val)
3138 ;; Read the variable value.
3139 (skip-chars-forward "^:")
3140 (forward-char 1)
3141 (let ((read-circle nil))
3142 (setq val (read (current-buffer))))
3143 (if mode-only
3144 (if (eq var 'mode)
3145 (setq result t))
3146 (unless (eq var 'coding)
3147 (condition-case nil
3148 (push (cons (if (eq var 'eval)
3149 'eval
3150 (indirect-variable var))
3151 val) result)
3152 (error nil)))))
3153 (forward-line 1))))))))
3154 ;; Now we've read all the local variables.
3155 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3156 (cond (mode-only result)
3157 ;; Otherwise, set the variables.
3158 (enable-local-variables
3159 (hack-local-variables-filter result nil)
3160 (hack-local-variables-apply)))))
3161
3162 (defun hack-local-variables-apply ()
3163 (when file-local-variables-alist
3164 ;; Any 'evals must run in the Right sequence.
3165 (setq file-local-variables-alist
3166 (nreverse file-local-variables-alist))
3167 (run-hooks 'before-hack-local-variables-hook)
3168 (dolist (elt file-local-variables-alist)
3169 (hack-one-local-variable (car elt) (cdr elt))))
3170 (run-hooks 'hack-local-variables-hook))
3171
3172 (defun safe-local-variable-p (sym val)
3173 "Non-nil if SYM is safe as a file-local variable with value VAL.
3174 It is safe if any of these conditions are met:
3175
3176 * There is a matching entry (SYM . VAL) in the
3177 `safe-local-variable-values' user option.
3178
3179 * The `safe-local-variable' property of SYM is a function that
3180 evaluates to a non-nil value with VAL as an argument."
3181 (or (member (cons sym val) safe-local-variable-values)
3182 (let ((safep (get sym 'safe-local-variable)))
3183 (and (functionp safep) (funcall safep val)))))
3184
3185 (defun risky-local-variable-p (sym &optional ignored)
3186 "Non-nil if SYM could be dangerous as a file-local variable.
3187 It is dangerous if either of these conditions are met:
3188
3189 * Its `risky-local-variable' property is non-nil.
3190
3191 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3192 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3193 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3194 \"map-alist\", or \"bindat-spec\"."
3195 ;; If this is an alias, check the base name.
3196 (condition-case nil
3197 (setq sym (indirect-variable sym))
3198 (error nil))
3199 (or (get sym 'risky-local-variable)
3200 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3201 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3202 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3203 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3204
3205 (defun hack-one-local-variable-quotep (exp)
3206 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3207
3208 (defun hack-one-local-variable-constantp (exp)
3209 (or (and (not (symbolp exp)) (not (consp exp)))
3210 (memq exp '(t nil))
3211 (keywordp exp)
3212 (hack-one-local-variable-quotep exp)))
3213
3214 (defun hack-one-local-variable-eval-safep (exp)
3215 "Return t if it is safe to eval EXP when it is found in a file."
3216 (or (not (consp exp))
3217 ;; Detect certain `put' expressions.
3218 (and (eq (car exp) 'put)
3219 (hack-one-local-variable-quotep (nth 1 exp))
3220 (hack-one-local-variable-quotep (nth 2 exp))
3221 (let ((prop (nth 1 (nth 2 exp)))
3222 (val (nth 3 exp)))
3223 (cond ((memq prop '(lisp-indent-hook
3224 lisp-indent-function
3225 scheme-indent-function))
3226 ;; Only allow safe values (not functions).
3227 (or (numberp val)
3228 (and (hack-one-local-variable-quotep val)
3229 (eq (nth 1 val) 'defun))))
3230 ((eq prop 'edebug-form-spec)
3231 ;; Only allow indirect form specs.
3232 ;; During bootstrapping, edebug-basic-spec might not be
3233 ;; defined yet.
3234 (and (fboundp 'edebug-basic-spec)
3235 (hack-one-local-variable-quotep val)
3236 (edebug-basic-spec (nth 1 val)))))))
3237 ;; Allow expressions that the user requested.
3238 (member exp safe-local-eval-forms)
3239 ;; Certain functions can be allowed with safe arguments
3240 ;; or can specify verification functions to try.
3241 (and (symbolp (car exp))
3242 (let ((prop (get (car exp) 'safe-local-eval-function)))
3243 (cond ((eq prop t)
3244 (let ((ok t))
3245 (dolist (arg (cdr exp))
3246 (unless (hack-one-local-variable-constantp arg)
3247 (setq ok nil)))
3248 ok))
3249 ((functionp prop)
3250 (funcall prop exp))
3251 ((listp prop)
3252 (let ((ok nil))
3253 (dolist (function prop)
3254 (if (funcall function exp)
3255 (setq ok t)))
3256 ok)))))))
3257
3258 (defun hack-one-local-variable (var val)
3259 "Set local variable VAR with value VAL.
3260 If VAR is `mode', call `VAL-mode' as a function unless it's
3261 already the major mode."
3262 (cond ((eq var 'mode)
3263 (let ((mode (intern (concat (downcase (symbol-name val))
3264 "-mode"))))
3265 (unless (eq (indirect-function mode)
3266 (indirect-function major-mode))
3267 (if (memq mode minor-mode-list)
3268 ;; A minor mode must be passed an argument.
3269 ;; Otherwise, if the user enables the minor mode in a
3270 ;; major mode hook, this would toggle it off.
3271 (funcall mode 1)
3272 (funcall mode)))))
3273 ((eq var 'eval)
3274 (save-excursion (eval val)))
3275 (t
3276 ;; Make sure the string has no text properties.
3277 ;; Some text properties can get evaluated in various ways,
3278 ;; so it is risky to put them on with a local variable list.
3279 (if (stringp val)
3280 (set-text-properties 0 (length val) nil val))
3281 (set (make-local-variable var) val))))
3282 \f
3283 ;;; Handling directory-local variables, aka project settings.
3284
3285 (defvar dir-locals-class-alist '()
3286 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3287
3288 (defvar dir-locals-directory-cache '()
3289 "List of cached directory roots for directory-local variable classes.
3290 Each element in this list has the form (DIR CLASS MTIME).
3291 DIR is the name of the directory.
3292 CLASS is the name of a variable class (a symbol).
3293 MTIME is the recorded modification time of the directory-local
3294 variables file associated with this entry. This time is a list
3295 of two integers (the same format as `file-attributes'), and is
3296 used to test whether the cache entry is still valid.
3297 Alternatively, MTIME can be nil, which means the entry is always
3298 considered valid.")
3299
3300 (defsubst dir-locals-get-class-variables (class)
3301 "Return the variable list for CLASS."
3302 (cdr (assq class dir-locals-class-alist)))
3303
3304 (defun dir-locals-collect-mode-variables (mode-variables variables)
3305 "Collect directory-local variables from MODE-VARIABLES.
3306 VARIABLES is the initial list of variables.
3307 Returns the new list."
3308 (dolist (pair mode-variables variables)
3309 (let* ((variable (car pair))
3310 (value (cdr pair))
3311 (slot (assq variable variables)))
3312 ;; If variables are specified more than once, only use the last. (Why?)
3313 ;; The pseudo-variables mode and eval are different (bug#3430).
3314 (if (and slot (not (memq variable '(mode eval))))
3315 (setcdr slot value)
3316 ;; Need a new cons in case we setcdr later.
3317 (push (cons variable value) variables)))))
3318
3319 (defun dir-locals-collect-variables (class-variables root variables)
3320 "Collect entries from CLASS-VARIABLES into VARIABLES.
3321 ROOT is the root directory of the project.
3322 Return the new variables list."
3323 (let* ((file-name (buffer-file-name))
3324 (sub-file-name (if file-name
3325 (substring file-name (length root)))))
3326 (dolist (entry class-variables variables)
3327 (let ((key (car entry)))
3328 (cond
3329 ((stringp key)
3330 ;; Don't include this in the previous condition, because we
3331 ;; want to filter all strings before the next condition.
3332 (when (and sub-file-name
3333 (>= (length sub-file-name) (length key))
3334 (string= key (substring sub-file-name 0 (length key))))
3335 (setq variables (dir-locals-collect-variables
3336 (cdr entry) root variables))))
3337 ((or (not key)
3338 (derived-mode-p key))
3339 (setq variables (dir-locals-collect-mode-variables
3340 (cdr entry) variables))))))))
3341
3342 (defun dir-locals-set-directory-class (directory class &optional mtime)
3343 "Declare that the DIRECTORY root is an instance of CLASS.
3344 DIRECTORY is the name of a directory, a string.
3345 CLASS is the name of a project class, a symbol.
3346 MTIME is either the modification time of the directory-local
3347 variables file that defined this class, or nil.
3348
3349 When a file beneath DIRECTORY is visited, the mode-specific
3350 variables from CLASS are applied to the buffer. The variables
3351 for a class are defined using `dir-locals-set-class-variables'."
3352 (setq directory (file-name-as-directory (expand-file-name directory)))
3353 (unless (assq class dir-locals-class-alist)
3354 (error "No such class `%s'" (symbol-name class)))
3355 (push (list directory class mtime) dir-locals-directory-cache))
3356
3357 (defun dir-locals-set-class-variables (class variables)
3358 "Map the type CLASS to a list of variable settings.
3359 CLASS is the project class, a symbol. VARIABLES is a list
3360 that declares directory-local variables for the class.
3361 An element in VARIABLES is either of the form:
3362 (MAJOR-MODE . ALIST)
3363 or
3364 (DIRECTORY . LIST)
3365
3366 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3367 whose elements are of the form (VARIABLE . VALUE).
3368
3369 In the second form, DIRECTORY is a directory name (a string), and
3370 LIST is a list of the form accepted by the function.
3371
3372 When a file is visited, the file's class is found. A directory
3373 may be assigned a class using `dir-locals-set-directory-class'.
3374 Then variables are set in the file's buffer according to the
3375 class' LIST. The list is processed in order.
3376
3377 * If the element is of the form (MAJOR-MODE . ALIST), and the
3378 buffer's major mode is derived from MAJOR-MODE (as determined
3379 by `derived-mode-p'), then all the variables in ALIST are
3380 applied. A MAJOR-MODE of nil may be used to match any buffer.
3381 `make-local-variable' is called for each variable before it is
3382 set.
3383
3384 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3385 is an initial substring of the file's directory, then LIST is
3386 applied by recursively following these rules."
3387 (let ((elt (assq class dir-locals-class-alist)))
3388 (if elt
3389 (setcdr elt variables)
3390 (push (cons class variables) dir-locals-class-alist))))
3391
3392 (defconst dir-locals-file ".dir-locals.el"
3393 "File that contains directory-local variables.
3394 It has to be constant to enforce uniform values
3395 across different environments and users.")
3396
3397 (defun dir-locals-find-file (file)
3398 "Find the directory-local variables for FILE.
3399 This searches upward in the directory tree from FILE.
3400 If the directory root of FILE has been registered in
3401 `dir-locals-directory-cache' and the directory-local variables
3402 file has not been modified, return the matching entry in
3403 `dir-locals-directory-cache'.
3404 Otherwise, if a directory-local variables file is found, return
3405 the file name.
3406 Otherwise, return nil."
3407 (setq file (expand-file-name file))
3408 (let* ((dir-locals-file-name
3409 (if (eq system-type 'ms-dos)
3410 (dosified-file-name dir-locals-file)
3411 dir-locals-file))
3412 (locals-file (locate-dominating-file file dir-locals-file-name))
3413 (dir-elt nil))
3414 ;; `locate-dominating-file' may have abbreviated the name.
3415 (when locals-file
3416 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3417 ;; Find the best cached value in `dir-locals-directory-cache'.
3418 (dolist (elt dir-locals-directory-cache)
3419 (when (and (eq t (compare-strings file nil (length (car elt))
3420 (car elt) nil nil
3421 (memq system-type
3422 '(windows-nt cygwin ms-dos))))
3423 (> (length (car elt)) (length (car dir-elt))))
3424 (setq dir-elt elt)))
3425 (let ((use-cache (and dir-elt
3426 (or (null locals-file)
3427 (<= (length (file-name-directory locals-file))
3428 (length (car dir-elt)))))))
3429 (if use-cache
3430 ;; Check the validity of the cache.
3431 (if (and (file-readable-p (car dir-elt))
3432 (or (null (nth 2 dir-elt))
3433 (equal (nth 2 dir-elt)
3434 (nth 5 (file-attributes (car dir-elt))))))
3435 ;; This cache entry is OK.
3436 dir-elt
3437 ;; This cache entry is invalid; clear it.
3438 (setq dir-locals-directory-cache
3439 (delq dir-elt dir-locals-directory-cache))
3440 locals-file)
3441 locals-file))))
3442
3443 (defun dir-locals-read-from-file (file)
3444 "Load a variables FILE and register a new class and instance.
3445 FILE is the name of the file holding the variables to apply.
3446 The new class name is the same as the directory in which FILE
3447 is found. Returns the new class name."
3448 (with-temp-buffer
3449 (insert-file-contents file)
3450 (let* ((dir-name (file-name-directory file))
3451 (class-name (intern dir-name))
3452 (variables (let ((read-circle nil))
3453 (read (current-buffer)))))
3454 (dir-locals-set-class-variables class-name variables)
3455 (dir-locals-set-directory-class dir-name class-name
3456 (nth 5 (file-attributes file)))
3457 class-name)))
3458
3459 (defun hack-dir-local-variables ()
3460 "Read per-directory local variables for the current buffer.
3461 Store the directory-local variables in `dir-local-variables-alist'
3462 and `file-local-variables-alist', without applying them."
3463 (when (and enable-local-variables
3464 (not (file-remote-p (or (buffer-file-name) default-directory))))
3465 ;; Find the variables file.
3466 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory)))
3467 (class nil)
3468 (dir-name nil))
3469 (cond
3470 ((stringp variables-file)
3471 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3472 (setq class (dir-locals-read-from-file variables-file)))
3473 ((consp variables-file)
3474 (setq dir-name (nth 0 variables-file))
3475 (setq class (nth 1 variables-file))))
3476 (when class
3477 (let ((variables
3478 (dir-locals-collect-variables
3479 (dir-locals-get-class-variables class) dir-name nil)))
3480 (when variables
3481 (dolist (elt variables)
3482 (unless (memq (car elt) '(eval mode))
3483 (setq dir-local-variables-alist
3484 (assq-delete-all (car elt) dir-local-variables-alist)))
3485 (push elt dir-local-variables-alist))
3486 (hack-local-variables-filter variables dir-name)))))))
3487
3488 (defun hack-dir-local-variables-non-file-buffer ()
3489 (hack-dir-local-variables)
3490 (hack-local-variables-apply))
3491
3492 \f
3493 (defcustom change-major-mode-with-file-name t
3494 "Non-nil means \\[write-file] should set the major mode from the file name.
3495 However, the mode will not be changed if
3496 \(1) a local variables list or the `-*-' line specifies a major mode, or
3497 \(2) the current major mode is a \"special\" mode,
3498 \ not suitable for ordinary files, or
3499 \(3) the new file name does not particularly specify any mode."
3500 :type 'boolean
3501 :group 'editing-basics)
3502
3503 (defun set-visited-file-name (filename &optional no-query along-with-file)
3504 "Change name of file visited in current buffer to FILENAME.
3505 This also renames the buffer to correspond to the new file.
3506 The next time the buffer is saved it will go in the newly specified file.
3507 FILENAME nil or an empty string means mark buffer as not visiting any file.
3508 Remember to delete the initial contents of the minibuffer
3509 if you wish to pass an empty string as the argument.
3510
3511 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3512 confirmation in the case where another buffer is already visiting FILENAME.
3513
3514 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3515 the old visited file has been renamed to the new name FILENAME."
3516 (interactive "FSet visited file name: ")
3517 (if (buffer-base-buffer)
3518 (error "An indirect buffer cannot visit a file"))
3519 (let (truename)
3520 (if filename
3521 (setq filename
3522 (if (string-equal filename "")
3523 nil
3524 (expand-file-name filename))))
3525 (if filename
3526 (progn
3527 (setq truename (file-truename filename))
3528 (if find-file-visit-truename
3529 (setq filename truename))))
3530 (if filename
3531 (let ((new-name (file-name-nondirectory filename)))
3532 (if (string= new-name "")
3533 (error "Empty file name"))))
3534 (let ((buffer (and filename (find-buffer-visiting filename))))
3535 (and buffer (not (eq buffer (current-buffer)))
3536 (not no-query)
3537 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3538 filename)))
3539 (error "Aborted")))
3540 (or (equal filename buffer-file-name)
3541 (progn
3542 (and filename (lock-buffer filename))
3543 (unlock-buffer)))
3544 (setq buffer-file-name filename)
3545 (if filename ; make buffer name reflect filename.
3546 (let ((new-name (file-name-nondirectory buffer-file-name)))
3547 (setq default-directory (file-name-directory buffer-file-name))
3548 ;; If new-name == old-name, renaming would add a spurious <2>
3549 ;; and it's considered as a feature in rename-buffer.
3550 (or (string= new-name (buffer-name))
3551 (rename-buffer new-name t))))
3552 (setq buffer-backed-up nil)
3553 (or along-with-file
3554 (clear-visited-file-modtime))
3555 ;; Abbreviate the file names of the buffer.
3556 (if truename
3557 (progn
3558 (setq buffer-file-truename (abbreviate-file-name truename))
3559 (if find-file-visit-truename
3560 (setq buffer-file-name truename))))
3561 (setq buffer-file-number
3562 (if filename
3563 (nthcdr 10 (file-attributes buffer-file-name))
3564 nil)))
3565 ;; write-file-functions is normally used for things like ftp-find-file
3566 ;; that visit things that are not local files as if they were files.
3567 ;; Changing to visit an ordinary local file instead should flush the hook.
3568 (kill-local-variable 'write-file-functions)
3569 (kill-local-variable 'local-write-file-hooks)
3570 (kill-local-variable 'revert-buffer-function)
3571 (kill-local-variable 'backup-inhibited)
3572 ;; If buffer was read-only because of version control,
3573 ;; that reason is gone now, so make it writable.
3574 (if vc-mode
3575 (setq buffer-read-only nil))
3576 (kill-local-variable 'vc-mode)
3577 ;; Turn off backup files for certain file names.
3578 ;; Since this is a permanent local, the major mode won't eliminate it.
3579 (and buffer-file-name
3580 backup-enable-predicate
3581 (not (funcall backup-enable-predicate buffer-file-name))
3582 (progn
3583 (make-local-variable 'backup-inhibited)
3584 (setq backup-inhibited t)))
3585 (let ((oauto buffer-auto-save-file-name))
3586 ;; If auto-save was not already on, turn it on if appropriate.
3587 (if (not buffer-auto-save-file-name)
3588 (and buffer-file-name auto-save-default
3589 (auto-save-mode t))
3590 ;; If auto save is on, start using a new name.
3591 ;; We deliberately don't rename or delete the old auto save
3592 ;; for the old visited file name. This is because perhaps
3593 ;; the user wants to save the new state and then compare with the
3594 ;; previous state from the auto save file.
3595 (setq buffer-auto-save-file-name
3596 (make-auto-save-file-name)))
3597 ;; Rename the old auto save file if any.
3598 (and oauto buffer-auto-save-file-name
3599 (file-exists-p oauto)
3600 (rename-file oauto buffer-auto-save-file-name t)))
3601 (and buffer-file-name
3602 (not along-with-file)
3603 (set-buffer-modified-p t))
3604 ;; Update the major mode, if the file name determines it.
3605 (condition-case nil
3606 ;; Don't change the mode if it is special.
3607 (or (not change-major-mode-with-file-name)
3608 (get major-mode 'mode-class)
3609 ;; Don't change the mode if the local variable list specifies it.
3610 (hack-local-variables t)
3611 (set-auto-mode t))
3612 (error nil)))
3613
3614 (defun write-file (filename &optional confirm)
3615 "Write current buffer into file FILENAME.
3616 This makes the buffer visit that file, and marks it as not modified.
3617
3618 If you specify just a directory name as FILENAME, that means to use
3619 the default file name but in that directory. You can also yank
3620 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3621
3622 If the buffer is not already visiting a file, the default file name
3623 for the output file is the buffer name.
3624
3625 If optional second arg CONFIRM is non-nil, this function
3626 asks for confirmation before overwriting an existing file.
3627 Interactively, confirmation is required unless you supply a prefix argument."
3628 ;; (interactive "FWrite file: ")
3629 (interactive
3630 (list (if buffer-file-name
3631 (read-file-name "Write file: "
3632 nil nil nil nil)
3633 (read-file-name "Write file: " default-directory
3634 (expand-file-name
3635 (file-name-nondirectory (buffer-name))
3636 default-directory)
3637 nil nil))
3638 (not current-prefix-arg)))
3639 (or (null filename) (string-equal filename "")
3640 (progn
3641 ;; If arg is just a directory,
3642 ;; use the default file name, but in that directory.
3643 (if (file-directory-p filename)
3644 (setq filename (concat (file-name-as-directory filename)
3645 (file-name-nondirectory
3646 (or buffer-file-name (buffer-name))))))
3647 (and confirm
3648 (file-exists-p filename)
3649 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3650 (error "Canceled")))
3651 (set-visited-file-name filename (not confirm))))
3652 (set-buffer-modified-p t)
3653 ;; Make buffer writable if file is writable.
3654 (and buffer-file-name
3655 (file-writable-p buffer-file-name)
3656 (setq buffer-read-only nil))
3657 (save-buffer)
3658 ;; It's likely that the VC status at the new location is different from
3659 ;; the one at the old location.
3660 (vc-find-file-hook))
3661 \f
3662 (defun backup-buffer ()
3663 "Make a backup of the disk file visited by the current buffer, if appropriate.
3664 This is normally done before saving the buffer the first time.
3665
3666 A backup may be done by renaming or by copying; see documentation of
3667 variable `make-backup-files'. If it's done by renaming, then the file is
3668 no longer accessible under its old name.
3669
3670 The value is non-nil after a backup was made by renaming.
3671 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3672 MODES is the result of `file-modes' on the original
3673 file; this means that the caller, after saving the buffer, should change
3674 the modes of the new file to agree with the old modes.
3675 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3676 file; this means that the caller, after saving the buffer, should change
3677 the SELinux context of the new file to agree with the old context.
3678 BACKUPNAME is the backup file name, which is the old file renamed."
3679 (if (and make-backup-files (not backup-inhibited)
3680 (not buffer-backed-up)
3681 (file-exists-p buffer-file-name)
3682 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3683 '(?- ?l)))
3684 (let ((real-file-name buffer-file-name)
3685 backup-info backupname targets setmodes)
3686 ;; If specified name is a symbolic link, chase it to the target.
3687 ;; Thus we make the backups in the directory where the real file is.
3688 (setq real-file-name (file-chase-links real-file-name))
3689 (setq backup-info (find-backup-file-name real-file-name)
3690 backupname (car backup-info)
3691 targets (cdr backup-info))
3692 ;; (if (file-directory-p buffer-file-name)
3693 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3694 (if backup-info
3695 (condition-case ()
3696 (let ((delete-old-versions
3697 ;; If have old versions to maybe delete,
3698 ;; ask the user to confirm now, before doing anything.
3699 ;; But don't actually delete til later.
3700 (and targets
3701 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3702 (or delete-old-versions
3703 (y-or-n-p (format "Delete excess backup versions of %s? "
3704 real-file-name)))))
3705 (modes (file-modes buffer-file-name))
3706 (context (file-selinux-context buffer-file-name)))
3707 ;; Actually write the back up file.
3708 (condition-case ()
3709 (if (or file-precious-flag
3710 ; (file-symlink-p buffer-file-name)
3711 backup-by-copying
3712 ;; Don't rename a suid or sgid file.
3713 (and modes (< 0 (logand modes #o6000)))
3714 (not (file-writable-p (file-name-directory real-file-name)))
3715 (and backup-by-copying-when-linked
3716 (> (file-nlinks real-file-name) 1))
3717 (and (or backup-by-copying-when-mismatch
3718 (integerp backup-by-copying-when-privileged-mismatch))
3719 (let ((attr (file-attributes real-file-name)))
3720 (and (or backup-by-copying-when-mismatch
3721 (and (integerp (nth 2 attr))
3722 (integerp backup-by-copying-when-privileged-mismatch)
3723 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3724 (or (nth 9 attr)
3725 (not (file-ownership-preserved-p real-file-name)))))))
3726 (backup-buffer-copy real-file-name backupname modes context)
3727 ;; rename-file should delete old backup.
3728 (rename-file real-file-name backupname t)
3729 (setq setmodes (list modes context backupname)))
3730 (file-error
3731 ;; If trouble writing the backup, write it in ~.
3732 (setq backupname (expand-file-name
3733 (convert-standard-filename
3734 "~/%backup%~")))
3735 (message "Cannot write backup file; backing up in %s"
3736 backupname)
3737 (sleep-for 1)
3738 (backup-buffer-copy real-file-name backupname modes context)))
3739 (setq buffer-backed-up t)
3740 ;; Now delete the old versions, if desired.
3741 (if delete-old-versions
3742 (while targets
3743 (condition-case ()
3744 (delete-file (car targets))
3745 (file-error nil))
3746 (setq targets (cdr targets))))
3747 setmodes)
3748 (file-error nil))))))
3749
3750 (defun backup-buffer-copy (from-name to-name modes context)
3751 (let ((umask (default-file-modes)))
3752 (unwind-protect
3753 (progn
3754 ;; Create temp files with strict access rights. It's easy to
3755 ;; loosen them later, whereas it's impossible to close the
3756 ;; time-window of loose permissions otherwise.
3757 (set-default-file-modes ?\700)
3758 (when (condition-case nil
3759 ;; Try to overwrite old backup first.
3760 (copy-file from-name to-name t t t)
3761 (error t))
3762 (while (condition-case nil
3763 (progn
3764 (when (file-exists-p to-name)
3765 (delete-file to-name))
3766 (copy-file from-name to-name nil t t)
3767 nil)
3768 (file-already-exists t))
3769 ;; The file was somehow created by someone else between
3770 ;; `delete-file' and `copy-file', so let's try again.
3771 ;; rms says "I think there is also a possible race
3772 ;; condition for making backup files" (emacs-devel 20070821).
3773 nil)))
3774 ;; Reset the umask.
3775 (set-default-file-modes umask)))
3776 (and modes
3777 (set-file-modes to-name (logand modes #o1777)))
3778 (and context
3779 (set-file-selinux-context to-name context)))
3780
3781 (defun file-name-sans-versions (name &optional keep-backup-version)
3782 "Return file NAME sans backup versions or strings.
3783 This is a separate procedure so your site-init or startup file can
3784 redefine it.
3785 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3786 we do not remove backup version numbers, only true file version numbers."
3787 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3788 (if handler
3789 (funcall handler 'file-name-sans-versions name keep-backup-version)
3790 (substring name 0
3791 (if keep-backup-version
3792 (length name)
3793 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3794 (string-match "~\\'" name)
3795 (length name)))))))
3796
3797 (defun file-ownership-preserved-p (file)
3798 "Return t if deleting FILE and rewriting it would preserve the owner."
3799 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3800 (if handler
3801 (funcall handler 'file-ownership-preserved-p file)
3802 (let ((attributes (file-attributes file)))
3803 ;; Return t if the file doesn't exist, since it's true that no
3804 ;; information would be lost by an (attempted) delete and create.
3805 (or (null attributes)
3806 (= (nth 2 attributes) (user-uid)))))))
3807
3808 (defun file-name-sans-extension (filename)
3809 "Return FILENAME sans final \"extension\".
3810 The extension, in a file name, is the part that follows the last `.',
3811 except that a leading `.', if any, doesn't count."
3812 (save-match-data
3813 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3814 directory)
3815 (if (and (string-match "\\.[^.]*\\'" file)
3816 (not (eq 0 (match-beginning 0))))
3817 (if (setq directory (file-name-directory filename))
3818 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3819 ;; we don't want to expand it.
3820 (concat directory (substring file 0 (match-beginning 0)))
3821 (substring file 0 (match-beginning 0)))
3822 filename))))
3823
3824 (defun file-name-extension (filename &optional period)
3825 "Return FILENAME's final \"extension\".
3826 The extension, in a file name, is the part that follows the last `.',
3827 excluding version numbers and backup suffixes,
3828 except that a leading `.', if any, doesn't count.
3829 Return nil for extensionless file names such as `foo'.
3830 Return the empty string for file names such as `foo.'.
3831
3832 If PERIOD is non-nil, then the returned value includes the period
3833 that delimits the extension, and if FILENAME has no extension,
3834 the value is \"\"."
3835 (save-match-data
3836 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3837 (if (and (string-match "\\.[^.]*\\'" file)
3838 (not (eq 0 (match-beginning 0))))
3839 (substring file (+ (match-beginning 0) (if period 0 1)))
3840 (if period
3841 "")))))
3842
3843 (defcustom make-backup-file-name-function nil
3844 "A function to use instead of the default `make-backup-file-name'.
3845 A value of nil gives the default `make-backup-file-name' behavior.
3846
3847 This could be buffer-local to do something special for specific
3848 files. If you define it, you may need to change `backup-file-name-p'
3849 and `file-name-sans-versions' too.
3850
3851 See also `backup-directory-alist'."
3852 :group 'backup
3853 :type '(choice (const :tag "Default" nil)
3854 (function :tag "Your function")))
3855
3856 (defcustom backup-directory-alist nil
3857 "Alist of filename patterns and backup directory names.
3858 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3859 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3860 relative or absolute. If it is absolute, so that all matching files
3861 are backed up into the same directory, the file names in this
3862 directory will be the full name of the file backed up with all
3863 directory separators changed to `!' to prevent clashes. This will not
3864 work correctly if your filesystem truncates the resulting name.
3865
3866 For the common case of all backups going into one directory, the alist
3867 should contain a single element pairing \".\" with the appropriate
3868 directory name.
3869
3870 If this variable is nil, or it fails to match a filename, the backup
3871 is made in the original file's directory.
3872
3873 On MS-DOS filesystems without long names this variable is always
3874 ignored."
3875 :group 'backup
3876 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3877 (directory :tag "Backup directory name"))))
3878
3879 (defun normal-backup-enable-predicate (name)
3880 "Default `backup-enable-predicate' function.
3881 Checks for files in `temporary-file-directory',
3882 `small-temporary-file-directory', and /tmp."
3883 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3884 name 0 nil)))
3885 ;; Directory is under temporary-file-directory.
3886 (and (not (eq comp t))
3887 (< comp (- (length temporary-file-directory)))))
3888 (let ((comp (compare-strings "/tmp" 0 nil
3889 name 0 nil)))
3890 ;; Directory is under /tmp.
3891 (and (not (eq comp t))
3892 (< comp (- (length "/tmp")))))
3893 (if small-temporary-file-directory
3894 (let ((comp (compare-strings small-temporary-file-directory
3895 0 nil
3896 name 0 nil)))
3897 ;; Directory is under small-temporary-file-directory.
3898 (and (not (eq comp t))
3899 (< comp (- (length small-temporary-file-directory)))))))))
3900
3901 (defun make-backup-file-name (file)
3902 "Create the non-numeric backup file name for FILE.
3903 Normally this will just be the file's name with `~' appended.
3904 Customization hooks are provided as follows.
3905
3906 If the variable `make-backup-file-name-function' is non-nil, its value
3907 should be a function which will be called with FILE as its argument;
3908 the resulting name is used.
3909
3910 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3911 the documentation of that variable. If the directory for the backup
3912 doesn't exist, it is created."
3913 (if make-backup-file-name-function
3914 (funcall make-backup-file-name-function file)
3915 (if (and (eq system-type 'ms-dos)
3916 (not (msdos-long-file-names)))
3917 (let ((fn (file-name-nondirectory file)))
3918 (concat (file-name-directory file)
3919 (or (and (string-match "\\`[^.]+\\'" fn)
3920 (concat (match-string 0 fn) ".~"))
3921 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3922 (concat (match-string 0 fn) "~")))))
3923 (concat (make-backup-file-name-1 file) "~"))))
3924
3925 (defun make-backup-file-name-1 (file)
3926 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3927 (let ((alist backup-directory-alist)
3928 elt backup-directory abs-backup-directory)
3929 (while alist
3930 (setq elt (pop alist))
3931 (if (string-match (car elt) file)
3932 (setq backup-directory (cdr elt)
3933 alist nil)))
3934 ;; If backup-directory is relative, it should be relative to the
3935 ;; file's directory. By expanding explicitly here, we avoid
3936 ;; depending on default-directory.
3937 (if backup-directory
3938 (setq abs-backup-directory
3939 (expand-file-name backup-directory
3940 (file-name-directory file))))
3941 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3942 (condition-case nil
3943 (make-directory abs-backup-directory 'parents)
3944 (file-error (setq backup-directory nil
3945 abs-backup-directory nil))))
3946 (if (null backup-directory)
3947 file
3948 (if (file-name-absolute-p backup-directory)
3949 (progn
3950 (when (memq system-type '(windows-nt ms-dos cygwin))
3951 ;; Normalize DOSish file names: downcase the drive
3952 ;; letter, if any, and replace the leading "x:" with
3953 ;; "/drive_x".
3954 (or (file-name-absolute-p file)
3955 (setq file (expand-file-name file))) ; make defaults explicit
3956 ;; Replace any invalid file-name characters (for the
3957 ;; case of backing up remote files).
3958 (setq file (expand-file-name (convert-standard-filename file)))
3959 (if (eq (aref file 1) ?:)
3960 (setq file (concat "/"
3961 "drive_"
3962 (char-to-string (downcase (aref file 0)))
3963 (if (eq (aref file 2) ?/)
3964 ""
3965 "/")
3966 (substring file 2)))))
3967 ;; Make the name unique by substituting directory
3968 ;; separators. It may not really be worth bothering about
3969 ;; doubling `!'s in the original name...
3970 (expand-file-name
3971 (subst-char-in-string
3972 ?/ ?!
3973 (replace-regexp-in-string "!" "!!" file))
3974 backup-directory))
3975 (expand-file-name (file-name-nondirectory file)
3976 (file-name-as-directory abs-backup-directory))))))
3977
3978 (defun backup-file-name-p (file)
3979 "Return non-nil if FILE is a backup file name (numeric or not).
3980 This is a separate function so you can redefine it for customization.
3981 You may need to redefine `file-name-sans-versions' as well."
3982 (string-match "~\\'" file))
3983
3984 (defvar backup-extract-version-start)
3985
3986 ;; This is used in various files.
3987 ;; The usage of backup-extract-version-start is not very clean,
3988 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3989 (defun backup-extract-version (fn)
3990 "Given the name of a numeric backup file, FN, return the backup number.
3991 Uses the free variable `backup-extract-version-start', whose value should be
3992 the index in the name where the version number begins."
3993 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3994 (= (match-beginning 0) backup-extract-version-start))
3995 (string-to-number (substring fn backup-extract-version-start -1))
3996 0))
3997
3998 (defun find-backup-file-name (fn)
3999 "Find a file name for a backup file FN, and suggestions for deletions.
4000 Value is a list whose car is the name for the backup file
4001 and whose cdr is a list of old versions to consider deleting now.
4002 If the value is nil, don't make a backup.
4003 Uses `backup-directory-alist' in the same way as does
4004 `make-backup-file-name'."
4005 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
4006 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4007 (if handler
4008 (funcall handler 'find-backup-file-name fn)
4009 (if (or (eq version-control 'never)
4010 ;; We don't support numbered backups on plain MS-DOS
4011 ;; when long file names are unavailable.
4012 (and (eq system-type 'ms-dos)
4013 (not (msdos-long-file-names))))
4014 (list (make-backup-file-name fn))
4015 (let* ((basic-name (make-backup-file-name-1 fn))
4016 (base-versions (concat (file-name-nondirectory basic-name)
4017 ".~"))
4018 (backup-extract-version-start (length base-versions))
4019 (high-water-mark 0)
4020 (number-to-delete 0)
4021 possibilities deserve-versions-p versions)
4022 (condition-case ()
4023 (setq possibilities (file-name-all-completions
4024 base-versions
4025 (file-name-directory basic-name))
4026 versions (sort (mapcar #'backup-extract-version
4027 possibilities)
4028 #'<)
4029 high-water-mark (apply 'max 0 versions)
4030 deserve-versions-p (or version-control
4031 (> high-water-mark 0))
4032 number-to-delete (- (length versions)
4033 kept-old-versions
4034 kept-new-versions
4035 -1))
4036 (file-error (setq possibilities nil)))
4037 (if (not deserve-versions-p)
4038 (list (make-backup-file-name fn))
4039 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
4040 (if (and (> number-to-delete 0)
4041 ;; Delete nothing if there is overflow
4042 ;; in the number of versions to keep.
4043 (>= (+ kept-new-versions kept-old-versions -1) 0))
4044 (mapcar (lambda (n)
4045 (format "%s.~%d~" basic-name n))
4046 (let ((v (nthcdr kept-old-versions versions)))
4047 (rplacd (nthcdr (1- number-to-delete) v) ())
4048 v))))))))))
4049
4050 (defun file-nlinks (filename)
4051 "Return number of names file FILENAME has."
4052 (car (cdr (file-attributes filename))))
4053
4054 ;; (defun file-relative-name (filename &optional directory)
4055 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4056 ;; This function returns a relative file name which is equivalent to FILENAME
4057 ;; when used with that default directory as the default.
4058 ;; If this is impossible (which can happen on MSDOS and Windows
4059 ;; when the file name and directory use different drive names)
4060 ;; then it returns FILENAME."
4061 ;; (save-match-data
4062 ;; (let ((fname (expand-file-name filename)))
4063 ;; (setq directory (file-name-as-directory
4064 ;; (expand-file-name (or directory default-directory))))
4065 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4066 ;; ;; drive names, they can't be relative, so return the absolute name.
4067 ;; (if (and (or (eq system-type 'ms-dos)
4068 ;; (eq system-type 'cygwin)
4069 ;; (eq system-type 'windows-nt))
4070 ;; (not (string-equal (substring fname 0 2)
4071 ;; (substring directory 0 2))))
4072 ;; filename
4073 ;; (let ((ancestor ".")
4074 ;; (fname-dir (file-name-as-directory fname)))
4075 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4076 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4077 ;; (setq directory (file-name-directory (substring directory 0 -1))
4078 ;; ancestor (if (equal ancestor ".")
4079 ;; ".."
4080 ;; (concat "../" ancestor))))
4081 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4082 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4083 ;; ;; We matched within FNAME's directory part.
4084 ;; ;; Add the rest of FNAME onto ANCESTOR.
4085 ;; (let ((rest (substring fname (match-end 0))))
4086 ;; (if (and (equal ancestor ".")
4087 ;; (not (equal rest "")))
4088 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4089 ;; rest
4090 ;; (concat (file-name-as-directory ancestor) rest)))
4091 ;; ;; We matched FNAME's directory equivalent.
4092 ;; ancestor))))))
4093
4094 (defun file-relative-name (filename &optional directory)
4095 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4096 This function returns a relative file name which is equivalent to FILENAME
4097 when used with that default directory as the default.
4098 If FILENAME and DIRECTORY lie on different machines or on different drives
4099 on a DOS/Windows machine, it returns FILENAME in expanded form."
4100 (save-match-data
4101 (setq directory
4102 (file-name-as-directory (expand-file-name (or directory
4103 default-directory))))
4104 (setq filename (expand-file-name filename))
4105 (let ((fremote (file-remote-p filename))
4106 (dremote (file-remote-p directory)))
4107 (if ;; Conditions for separate trees
4108 (or
4109 ;; Test for different drives on DOS/Windows
4110 (and
4111 ;; Should `cygwin' really be included here? --stef
4112 (memq system-type '(ms-dos cygwin windows-nt))
4113 (not (eq t (compare-strings filename 0 2 directory 0 2))))
4114 ;; Test for different remote file system identification
4115 (not (equal fremote dremote)))
4116 filename
4117 (let ((ancestor ".")
4118 (filename-dir (file-name-as-directory filename)))
4119 (while (not
4120 (or
4121 (eq t (compare-strings filename-dir nil (length directory)
4122 directory nil nil case-fold-search))
4123 (eq t (compare-strings filename nil (length directory)
4124 directory nil nil case-fold-search))))
4125 (setq directory (file-name-directory (substring directory 0 -1))
4126 ancestor (if (equal ancestor ".")
4127 ".."
4128 (concat "../" ancestor))))
4129 ;; Now ancestor is empty, or .., or ../.., etc.
4130 (if (eq t (compare-strings filename nil (length directory)
4131 directory nil nil case-fold-search))
4132 ;; We matched within FILENAME's directory part.
4133 ;; Add the rest of FILENAME onto ANCESTOR.
4134 (let ((rest (substring filename (length directory))))
4135 (if (and (equal ancestor ".") (not (equal rest "")))
4136 ;; But don't bother with ANCESTOR if it would give us `./'.
4137 rest
4138 (concat (file-name-as-directory ancestor) rest)))
4139 ;; We matched FILENAME's directory equivalent.
4140 ancestor))))))
4141 \f
4142 (defun save-buffer (&optional args)
4143 "Save current buffer in visited file if modified.
4144 Variations are described below.
4145
4146 By default, makes the previous version into a backup file
4147 if previously requested or if this is the first save.
4148 Prefixed with one \\[universal-argument], marks this version
4149 to become a backup when the next save is done.
4150 Prefixed with two \\[universal-argument]'s,
4151 unconditionally makes the previous version into a backup file.
4152 Prefixed with three \\[universal-argument]'s, marks this version
4153 to become a backup when the next save is done,
4154 and unconditionally makes the previous version into a backup file.
4155
4156 With a numeric argument of 0, never make the previous version
4157 into a backup file.
4158
4159 If a file's name is FOO, the names of its numbered backup versions are
4160 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4161 Numeric backups (rather than FOO~) will be made if value of
4162 `version-control' is not the atom `never' and either there are already
4163 numeric versions of the file being backed up, or `version-control' is
4164 non-nil.
4165 We don't want excessive versions piling up, so there are variables
4166 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4167 and `kept-new-versions', which tells how many newest versions to keep.
4168 Defaults are 2 old versions and 2 new.
4169 `dired-kept-versions' controls dired's clean-directory (.) command.
4170 If `delete-old-versions' is nil, system will query user
4171 before trimming versions. Otherwise it does it silently.
4172
4173 If `vc-make-backup-files' is nil, which is the default,
4174 no backup files are made for files managed by version control.
4175 (This is because the version control system itself records previous versions.)
4176
4177 See the subroutine `basic-save-buffer' for more information."
4178 (interactive "p")
4179 (let ((modp (buffer-modified-p))
4180 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4181 (memq args '(16 64)))))
4182 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4183 ;; We used to display the message below only for files > 50KB, but
4184 ;; then Rmail-mbox never displays it due to buffer swapping. If
4185 ;; the test is ever re-introduced, be sure to handle saving of
4186 ;; Rmail files.
4187 (if (and modp (buffer-file-name))
4188 (message "Saving file %s..." (buffer-file-name)))
4189 (basic-save-buffer)
4190 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4191
4192 (defun delete-auto-save-file-if-necessary (&optional force)
4193 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4194 Normally delete only if the file was written by this Emacs since
4195 the last real save, but optional arg FORCE non-nil means delete anyway."
4196 (and buffer-auto-save-file-name delete-auto-save-files
4197 (not (string= buffer-file-name buffer-auto-save-file-name))
4198 (or force (recent-auto-save-p))
4199 (progn
4200 (condition-case ()
4201 (delete-file buffer-auto-save-file-name)
4202 (file-error nil))
4203 (set-buffer-auto-saved))))
4204
4205 (defvar auto-save-hook nil
4206 "Normal hook run just before auto-saving.")
4207
4208 (defcustom before-save-hook nil
4209 "Normal hook that is run before a buffer is saved to its file."
4210 :options '(copyright-update time-stamp)
4211 :type 'hook
4212 :group 'files)
4213
4214 (defcustom after-save-hook nil
4215 "Normal hook that is run after a buffer is saved to its file."
4216 :options '(executable-make-buffer-file-executable-if-script-p)
4217 :type 'hook
4218 :group 'files)
4219
4220 (defvar save-buffer-coding-system nil
4221 "If non-nil, use this coding system for saving the buffer.
4222 More precisely, use this coding system in place of the
4223 value of `buffer-file-coding-system', when saving the buffer.
4224 Calling `write-region' for any purpose other than saving the buffer
4225 will still use `buffer-file-coding-system'; this variable has no effect
4226 in such cases.")
4227
4228 (make-variable-buffer-local 'save-buffer-coding-system)
4229 (put 'save-buffer-coding-system 'permanent-local t)
4230
4231 (defun basic-save-buffer ()
4232 "Save the current buffer in its visited file, if it has been modified.
4233 The hooks `write-contents-functions' and `write-file-functions' get a chance
4234 to do the job of saving; if they do not, then the buffer is saved in
4235 the visited file in the usual way.
4236 Before and after saving the buffer, this function runs
4237 `before-save-hook' and `after-save-hook', respectively."
4238 (interactive)
4239 (save-current-buffer
4240 ;; In an indirect buffer, save its base buffer instead.
4241 (if (buffer-base-buffer)
4242 (set-buffer (buffer-base-buffer)))
4243 (if (buffer-modified-p)
4244 (let ((recent-save (recent-auto-save-p))
4245 setmodes)
4246 ;; If buffer has no file name, ask user for one.
4247 (or buffer-file-name
4248 (let ((filename
4249 (expand-file-name
4250 (read-file-name "File to save in: ") nil)))
4251 (if (file-exists-p filename)
4252 (if (file-directory-p filename)
4253 ;; Signal an error if the user specified the name of an
4254 ;; existing directory.
4255 (error "%s is a directory" filename)
4256 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4257 filename))
4258 (error "Canceled")))
4259 ;; Signal an error if the specified name refers to a
4260 ;; non-existing directory.
4261 (let ((dir (file-name-directory filename)))
4262 (unless (file-directory-p dir)
4263 (if (file-exists-p dir)
4264 (error "%s is not a directory" dir)
4265 (error "%s: no such directory" dir)))))
4266 (set-visited-file-name filename)))
4267 (or (verify-visited-file-modtime (current-buffer))
4268 (not (file-exists-p buffer-file-name))
4269 (yes-or-no-p
4270 (format "%s has changed since visited or saved. Save anyway? "
4271 (file-name-nondirectory buffer-file-name)))
4272 (error "Save not confirmed"))
4273 (save-restriction
4274 (widen)
4275 (save-excursion
4276 (and (> (point-max) (point-min))
4277 (not find-file-literally)
4278 (/= (char-after (1- (point-max))) ?\n)
4279 (not (and (eq selective-display t)
4280 (= (char-after (1- (point-max))) ?\r)))
4281 (or (eq require-final-newline t)
4282 (eq require-final-newline 'visit-save)
4283 (and require-final-newline
4284 (y-or-n-p
4285 (format "Buffer %s does not end in newline. Add one? "
4286 (buffer-name)))))
4287 (save-excursion
4288 (goto-char (point-max))
4289 (insert ?\n))))
4290 ;; Support VC version backups.
4291 (vc-before-save)
4292 (run-hooks 'before-save-hook)
4293 (or (run-hook-with-args-until-success 'write-contents-functions)
4294 (run-hook-with-args-until-success 'local-write-file-hooks)
4295 (run-hook-with-args-until-success 'write-file-functions)
4296 ;; If a hook returned t, file is already "written".
4297 ;; Otherwise, write it the usual way now.
4298 (setq setmodes (basic-save-buffer-1)))
4299 ;; Now we have saved the current buffer. Let's make sure
4300 ;; that buffer-file-coding-system is fixed to what
4301 ;; actually used for saving by binding it locally.
4302 (if save-buffer-coding-system
4303 (setq save-buffer-coding-system last-coding-system-used)
4304 (setq buffer-file-coding-system last-coding-system-used))
4305 (setq buffer-file-number
4306 (nthcdr 10 (file-attributes buffer-file-name)))
4307 (if setmodes
4308 (condition-case ()
4309 (progn
4310 (set-file-modes buffer-file-name (car setmodes))
4311 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))
4312 (error nil))))
4313 ;; If the auto-save file was recent before this command,
4314 ;; delete it now.
4315 (delete-auto-save-file-if-necessary recent-save)
4316 ;; Support VC `implicit' locking.
4317 (vc-after-save)
4318 (run-hooks 'after-save-hook))
4319 (message "(No changes need to be saved)"))))
4320
4321 ;; This does the "real job" of writing a buffer into its visited file
4322 ;; and making a backup file. This is what is normally done
4323 ;; but inhibited if one of write-file-functions returns non-nil.
4324 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4325 (defun basic-save-buffer-1 ()
4326 (prog1
4327 (if save-buffer-coding-system
4328 (let ((coding-system-for-write save-buffer-coding-system))
4329 (basic-save-buffer-2))
4330 (basic-save-buffer-2))
4331 (if buffer-file-coding-system-explicit
4332 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4333 (setq buffer-file-coding-system-explicit
4334 (cons last-coding-system-used nil)))))
4335
4336 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4337 (defun basic-save-buffer-2 ()
4338 (let (tempsetmodes setmodes)
4339 (if (not (file-writable-p buffer-file-name))
4340 (let ((dir (file-name-directory buffer-file-name)))
4341 (if (not (file-directory-p dir))
4342 (if (file-exists-p dir)
4343 (error "%s is not a directory" dir)
4344 (error "%s: no such directory" dir))
4345 (if (not (file-exists-p buffer-file-name))
4346 (error "Directory %s write-protected" dir)
4347 (if (yes-or-no-p
4348 (format "File %s is write-protected; try to save anyway? "
4349 (file-name-nondirectory
4350 buffer-file-name)))
4351 (setq tempsetmodes t)
4352 (error "Attempt to save to a file which you aren't allowed to write"))))))
4353 (or buffer-backed-up
4354 (setq setmodes (backup-buffer)))
4355 (let* ((dir (file-name-directory buffer-file-name))
4356 (dir-writable (file-writable-p dir)))
4357 (if (or (and file-precious-flag dir-writable)
4358 (and break-hardlink-on-save
4359 (> (file-nlinks buffer-file-name) 1)
4360 (or dir-writable
4361 (error (concat (format
4362 "Directory %s write-protected; " dir)
4363 "cannot break hardlink when saving")))))
4364 ;; Write temp name, then rename it.
4365 ;; This requires write access to the containing dir,
4366 ;; which is why we don't try it if we don't have that access.
4367 (let ((realname buffer-file-name)
4368 tempname succeed
4369 (umask (default-file-modes))
4370 (old-modtime (visited-file-modtime)))
4371 ;; Create temp files with strict access rights. It's easy to
4372 ;; loosen them later, whereas it's impossible to close the
4373 ;; time-window of loose permissions otherwise.
4374 (unwind-protect
4375 (progn
4376 (clear-visited-file-modtime)
4377 (set-default-file-modes ?\700)
4378 ;; Try various temporary names.
4379 ;; This code follows the example of make-temp-file,
4380 ;; but it calls write-region in the appropriate way
4381 ;; for saving the buffer.
4382 (while (condition-case ()
4383 (progn
4384 (setq tempname
4385 (make-temp-name
4386 (expand-file-name "tmp" dir)))
4387 ;; Pass in nil&nil rather than point-min&max
4388 ;; cause we're saving the whole buffer.
4389 ;; write-region-annotate-functions may use it.
4390 (write-region nil nil
4391 tempname nil realname
4392 buffer-file-truename 'excl)
4393 nil)
4394 (file-already-exists t))
4395 ;; The file was somehow created by someone else between
4396 ;; `make-temp-name' and `write-region', let's try again.
4397 nil)
4398 (setq succeed t))
4399 ;; Reset the umask.
4400 (set-default-file-modes umask)
4401 ;; If we failed, restore the buffer's modtime.
4402 (unless succeed
4403 (set-visited-file-modtime old-modtime)))
4404 ;; Since we have created an entirely new file,
4405 ;; make sure it gets the right permission bits set.
4406 (setq setmodes (or setmodes
4407 (list (or (file-modes buffer-file-name)
4408 (logand ?\666 umask))
4409 (file-selinux-context buffer-file-name)
4410 buffer-file-name)))
4411 ;; We succeeded in writing the temp file,
4412 ;; so rename it.
4413 (rename-file tempname buffer-file-name t))
4414 ;; If file not writable, see if we can make it writable
4415 ;; temporarily while we write it.
4416 ;; But no need to do so if we have just backed it up
4417 ;; (setmodes is set) because that says we're superseding.
4418 (cond ((and tempsetmodes (not setmodes))
4419 ;; Change the mode back, after writing.
4420 (setq setmodes (list (file-modes buffer-file-name)
4421 (file-selinux-context buffer-file-name)
4422 buffer-file-name))
4423 (set-file-modes buffer-file-name (logior (car setmodes) 128))
4424 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))))
4425 (let (success)
4426 (unwind-protect
4427 (progn
4428 ;; Pass in nil&nil rather than point-min&max to indicate
4429 ;; we're saving the buffer rather than just a region.
4430 ;; write-region-annotate-functions may make us of it.
4431 (write-region nil nil
4432 buffer-file-name nil t buffer-file-truename)
4433 (setq success t))
4434 ;; If we get an error writing the new file, and we made
4435 ;; the backup by renaming, undo the backing-up.
4436 (and setmodes (not success)
4437 (progn
4438 (rename-file (nth 2 setmodes) buffer-file-name t)
4439 (setq buffer-backed-up nil))))))
4440 setmodes))
4441
4442 (defun diff-buffer-with-file (&optional buffer)
4443 "View the differences between BUFFER and its associated file.
4444 This requires the external program `diff' to be in your `exec-path'."
4445 (interactive "bBuffer: ")
4446 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4447 (if (and buffer-file-name
4448 (file-exists-p buffer-file-name))
4449 (let ((tempfile (make-temp-file "buffer-content-")))
4450 (unwind-protect
4451 (progn
4452 (write-region nil nil tempfile nil 'nomessage)
4453 (diff buffer-file-name tempfile nil t)
4454 (sit-for 0))
4455 (when (file-exists-p tempfile)
4456 (delete-file tempfile))))
4457 (message "Buffer %s has no associated file on disc" (buffer-name))
4458 ;; Display that message for 1 second so that user can read it
4459 ;; in the minibuffer.
4460 (sit-for 1)))
4461 ;; return always nil, so that save-buffers-kill-emacs will not move
4462 ;; over to the next unsaved buffer when calling `d'.
4463 nil)
4464
4465 (defvar save-some-buffers-action-alist
4466 `((?\C-r
4467 ,(lambda (buf)
4468 (if (not enable-recursive-minibuffers)
4469 (progn (display-buffer buf)
4470 (setq other-window-scroll-buffer buf))
4471 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4472 (recursive-edit))
4473 ;; Return nil to ask about BUF again.
4474 nil)
4475 ,(purecopy "view this buffer"))
4476 (?d ,(lambda (buf)
4477 (if (null (buffer-file-name buf))
4478 (message "Not applicable: no file")
4479 (save-window-excursion (diff-buffer-with-file buf))
4480 (if (not enable-recursive-minibuffers)
4481 (progn (display-buffer (get-buffer-create "*Diff*"))
4482 (setq other-window-scroll-buffer "*Diff*"))
4483 (view-buffer (get-buffer-create "*Diff*")
4484 (lambda (_) (exit-recursive-edit)))
4485 (recursive-edit)))
4486 ;; Return nil to ask about BUF again.
4487 nil)
4488 ,(purecopy "view changes in this buffer")))
4489 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4490 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4491
4492 (defvar buffer-save-without-query nil
4493 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4494 (make-variable-buffer-local 'buffer-save-without-query)
4495
4496 (defun save-some-buffers (&optional arg pred)
4497 "Save some modified file-visiting buffers. Asks user about each one.
4498 You can answer `y' to save, `n' not to save, `C-r' to look at the
4499 buffer in question with `view-buffer' before deciding or `d' to
4500 view the differences using `diff-buffer-with-file'.
4501
4502 Optional argument (the prefix) non-nil means save all with no questions.
4503 Optional second argument PRED determines which buffers are considered:
4504 If PRED is nil, all the file-visiting buffers are considered.
4505 If PRED is t, then certain non-file buffers will also be considered.
4506 If PRED is a zero-argument function, it indicates for each buffer whether
4507 to consider it or not when called with that buffer current.
4508
4509 See `save-some-buffers-action-alist' if you want to
4510 change the additional actions you can take on files."
4511 (interactive "P")
4512 (save-window-excursion
4513 (let* (queried some-automatic
4514 files-done abbrevs-done)
4515 (dolist (buffer (buffer-list))
4516 ;; First save any buffers that we're supposed to save unconditionally.
4517 ;; That way the following code won't ask about them.
4518 (with-current-buffer buffer
4519 (when (and buffer-save-without-query (buffer-modified-p))
4520 (setq some-automatic t)
4521 (save-buffer))))
4522 ;; Ask about those buffers that merit it,
4523 ;; and record the number thus saved.
4524 (setq files-done
4525 (map-y-or-n-p
4526 (lambda (buffer)
4527 ;; Note that killing some buffers may kill others via
4528 ;; hooks (e.g. Rmail and its viewing buffer).
4529 (and (buffer-live-p buffer)
4530 (buffer-modified-p buffer)
4531 (not (buffer-base-buffer buffer))
4532 (or
4533 (buffer-file-name buffer)
4534 (and pred
4535 (progn
4536 (set-buffer buffer)
4537 (and buffer-offer-save (> (buffer-size) 0)))))
4538 (or (not (functionp pred))
4539 (with-current-buffer buffer (funcall pred)))
4540 (if arg
4541 t
4542 (setq queried t)
4543 (if (buffer-file-name buffer)
4544 (format "Save file %s? "
4545 (buffer-file-name buffer))
4546 (format "Save buffer %s? "
4547 (buffer-name buffer))))))
4548 (lambda (buffer)
4549 (with-current-buffer buffer
4550 (save-buffer)))
4551 (buffer-list)
4552 '("buffer" "buffers" "save")
4553 save-some-buffers-action-alist))
4554 ;; Maybe to save abbrevs, and record whether
4555 ;; we either saved them or asked to.
4556 (and save-abbrevs abbrevs-changed
4557 (progn
4558 (if (or arg
4559 (eq save-abbrevs 'silently)
4560 (y-or-n-p (format "Save abbrevs in %s? "
4561 abbrev-file-name)))
4562 (write-abbrev-file nil))
4563 ;; Don't keep bothering user if he says no.
4564 (setq abbrevs-changed nil)
4565 (setq abbrevs-done t)))
4566 (or queried (> files-done 0) abbrevs-done
4567 (message (if some-automatic
4568 "(Some special files were saved without asking)"
4569 "(No files need saving)"))))))
4570 \f
4571 (defun not-modified (&optional arg)
4572 "Mark current buffer as unmodified, not needing to be saved.
4573 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4574
4575 It is not a good idea to use this function in Lisp programs, because it
4576 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4577 (interactive "P")
4578 (message (if arg "Modification-flag set"
4579 "Modification-flag cleared"))
4580 (set-buffer-modified-p arg))
4581
4582 (defun toggle-read-only (&optional arg)
4583 "Change whether this buffer is read-only.
4584 With prefix argument ARG, make the buffer read-only if ARG is
4585 positive, otherwise make it writable. If buffer is read-only
4586 and `view-read-only' is non-nil, enter view mode."
4587 (interactive "P")
4588 (if (and arg
4589 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4590 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4591 nil ; do nothing.
4592 ;; Toggle.
4593 (cond
4594 ((and buffer-read-only view-mode)
4595 (View-exit-and-edit)
4596 (make-local-variable 'view-read-only)
4597 (setq view-read-only t)) ; Must leave view mode.
4598 ((and (not buffer-read-only) view-read-only
4599 ;; If view-mode is already active, `view-mode-enter' is a nop.
4600 (not view-mode)
4601 (not (eq (get major-mode 'mode-class) 'special)))
4602 (view-mode-enter))
4603 (t (setq buffer-read-only (not buffer-read-only))
4604 (force-mode-line-update)))
4605 (if (vc-backend buffer-file-name)
4606 (message "%s" (substitute-command-keys
4607 (concat "File is under version-control; "
4608 "use \\[vc-next-action] to check in/out"))))))
4609
4610 (defun insert-file (filename)
4611 "Insert contents of file FILENAME into buffer after point.
4612 Set mark after the inserted text.
4613
4614 This function is meant for the user to run interactively.
4615 Don't call it from programs! Use `insert-file-contents' instead.
4616 \(Its calling sequence is different; see its documentation)."
4617 (interactive "*fInsert file: ")
4618 (insert-file-1 filename #'insert-file-contents))
4619
4620 (defun append-to-file (start end filename)
4621 "Append the contents of the region to the end of file FILENAME.
4622 When called from a function, expects three arguments,
4623 START, END and FILENAME. START and END are normally buffer positions
4624 specifying the part of the buffer to write.
4625 If START is nil, that means to use the entire buffer contents.
4626 If START is a string, then output that string to the file
4627 instead of any buffer contents; END is ignored.
4628
4629 This does character code conversion and applies annotations
4630 like `write-region' does."
4631 (interactive "r\nFAppend to file: ")
4632 (write-region start end filename t))
4633
4634 (defun file-newest-backup (filename)
4635 "Return most recent backup file for FILENAME or nil if no backups exist."
4636 ;; `make-backup-file-name' will get us the right directory for
4637 ;; ordinary or numeric backups. It might create a directory for
4638 ;; backups as a side-effect, according to `backup-directory-alist'.
4639 (let* ((filename (file-name-sans-versions
4640 (make-backup-file-name (expand-file-name filename))))
4641 (file (file-name-nondirectory filename))
4642 (dir (file-name-directory filename))
4643 (comp (file-name-all-completions file dir))
4644 (newest nil)
4645 tem)
4646 (while comp
4647 (setq tem (pop comp))
4648 (cond ((and (backup-file-name-p tem)
4649 (string= (file-name-sans-versions tem) file))
4650 (setq tem (concat dir tem))
4651 (if (or (null newest)
4652 (file-newer-than-file-p tem newest))
4653 (setq newest tem)))))
4654 newest))
4655
4656 (defun rename-uniquely ()
4657 "Rename current buffer to a similar name not already taken.
4658 This function is useful for creating multiple shell process buffers
4659 or multiple mail buffers, etc."
4660 (interactive)
4661 (save-match-data
4662 (let ((base-name (buffer-name)))
4663 (and (string-match "<[0-9]+>\\'" base-name)
4664 (not (and buffer-file-name
4665 (string= base-name
4666 (file-name-nondirectory buffer-file-name))))
4667 ;; If the existing buffer name has a <NNN>,
4668 ;; which isn't part of the file name (if any),
4669 ;; then get rid of that.
4670 (setq base-name (substring base-name 0 (match-beginning 0))))
4671 (rename-buffer (generate-new-buffer-name base-name))
4672 (force-mode-line-update))))
4673
4674 (defun make-directory (dir &optional parents)
4675 "Create the directory DIR and optionally any nonexistent parent dirs.
4676 If DIR already exists as a directory, signal an error, unless
4677 PARENTS is non-nil.
4678
4679 Interactively, the default choice of directory to create is the
4680 current buffer's default directory. That is useful when you have
4681 visited a file in a nonexistent directory.
4682
4683 Noninteractively, the second (optional) argument PARENTS, if
4684 non-nil, says whether to create parent directories that don't
4685 exist. Interactively, this happens by default."
4686 (interactive
4687 (list (read-file-name "Make directory: " default-directory default-directory
4688 nil nil)
4689 t))
4690 ;; If default-directory is a remote directory,
4691 ;; make sure we find its make-directory handler.
4692 (setq dir (expand-file-name dir))
4693 (let ((handler (find-file-name-handler dir 'make-directory)))
4694 (if handler
4695 (funcall handler 'make-directory dir parents)
4696 (if (not parents)
4697 (make-directory-internal dir)
4698 (let ((dir (directory-file-name (expand-file-name dir)))
4699 create-list)
4700 (while (and (not (file-exists-p dir))
4701 ;; If directory is its own parent, then we can't
4702 ;; keep looping forever
4703 (not (equal dir
4704 (directory-file-name
4705 (file-name-directory dir)))))
4706 (setq create-list (cons dir create-list)
4707 dir (directory-file-name (file-name-directory dir))))
4708 (while create-list
4709 (make-directory-internal (car create-list))
4710 (setq create-list (cdr create-list))))))))
4711
4712 (defconst directory-files-no-dot-files-regexp
4713 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4714 "Regexp matching any file name except \".\" and \"..\".")
4715
4716 (defun delete-directory (directory &optional recursive trash)
4717 "Delete the directory named DIRECTORY. Does not follow symlinks.
4718 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4719 TRASH non-nil means to trash the directory instead, provided
4720 `delete-by-moving-to-trash' is non-nil.
4721
4722 When called interactively, TRASH is t if no prefix argument is
4723 given. With a prefix argument, TRASH is nil."
4724 (interactive
4725 (let* ((trashing (and delete-by-moving-to-trash
4726 (null current-prefix-arg)))
4727 (dir (expand-file-name
4728 (read-file-name
4729 (if trashing
4730 "Move directory to trash: "
4731 "Delete directory: ")
4732 default-directory default-directory nil nil))))
4733 (list dir
4734 (if (directory-files dir nil directory-files-no-dot-files-regexp)
4735 (y-or-n-p
4736 (format "Directory `%s' is not empty, really %s? "
4737 dir (if trashing "trash" "delete")))
4738 nil)
4739 (null current-prefix-arg))))
4740 ;; If default-directory is a remote directory, make sure we find its
4741 ;; delete-directory handler.
4742 (setq directory (directory-file-name (expand-file-name directory)))
4743 (let ((handler (find-file-name-handler directory 'delete-directory)))
4744 (cond
4745 (handler
4746 (funcall handler 'delete-directory directory recursive))
4747 ((and delete-by-moving-to-trash trash)
4748 ;; Only move non-empty dir to trash if recursive deletion was
4749 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4750 ;; case, where the operation fails in delete-directory-internal.
4751 ;; As `move-file-to-trash' trashes directories (empty or
4752 ;; otherwise) as a unit, we do not need to recurse here.
4753 (if (and (not recursive)
4754 ;; Check if directory is empty apart from "." and "..".
4755 (directory-files
4756 directory 'full directory-files-no-dot-files-regexp))
4757 (error "Directory is not empty, not moving to trash")
4758 (move-file-to-trash directory)))
4759 ;; Otherwise, call outselves recursively if needed.
4760 (t
4761 (if (and recursive (not (file-symlink-p directory)))
4762 (mapc (lambda (file)
4763 ;; This test is equivalent to
4764 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4765 ;; but more efficient
4766 (if (eq t (car (file-attributes file)))
4767 (delete-directory file recursive nil)
4768 (delete-file file nil)))
4769 ;; We do not want to delete "." and "..".
4770 (directory-files
4771 directory 'full directory-files-no-dot-files-regexp)))
4772 (delete-directory-internal directory)))))
4773
4774 (defun copy-directory (directory newname &optional keep-time parents)
4775 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4776 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4777
4778 This function always sets the file modes of the output files to match
4779 the corresponding input file.
4780
4781 The third arg KEEP-TIME non-nil means give the output files the same
4782 last-modified time as the old ones. (This works on only some systems.)
4783
4784 A prefix arg makes KEEP-TIME non-nil.
4785
4786 Noninteractively, the last argument PARENTS says whether to
4787 create parent directories if they don't exist. Interactively,
4788 this happens by default."
4789 (interactive
4790 (let ((dir (read-directory-name
4791 "Copy directory: " default-directory default-directory t nil)))
4792 (list dir
4793 (read-file-name
4794 (format "Copy directory %s to: " dir)
4795 default-directory default-directory nil nil)
4796 current-prefix-arg t)))
4797 ;; If default-directory is a remote directory, make sure we find its
4798 ;; copy-directory handler.
4799 (let ((handler (or (find-file-name-handler directory 'copy-directory)
4800 (find-file-name-handler newname 'copy-directory))))
4801 (if handler
4802 (funcall handler 'copy-directory directory newname keep-time parents)
4803
4804 ;; Compute target name.
4805 (setq directory (directory-file-name (expand-file-name directory))
4806 newname (directory-file-name (expand-file-name newname)))
4807 (if (not (file-directory-p newname)) (make-directory newname parents))
4808
4809 ;; Copy recursively.
4810 (mapc
4811 (lambda (file)
4812 (let ((target (expand-file-name
4813 (file-name-nondirectory file) newname))
4814 (attrs (file-attributes file)))
4815 (cond ((file-directory-p file)
4816 (copy-directory file target keep-time parents))
4817 ((stringp (car attrs)) ; Symbolic link
4818 (make-symbolic-link (car attrs) target t))
4819 (t
4820 (copy-file file target t keep-time)))))
4821 ;; We do not want to copy "." and "..".
4822 (directory-files directory 'full directory-files-no-dot-files-regexp))
4823
4824 ;; Set directory attributes.
4825 (set-file-modes newname (file-modes directory))
4826 (if keep-time
4827 (set-file-times newname (nth 5 (file-attributes directory)))))))
4828 \f
4829 (put 'revert-buffer-function 'permanent-local t)
4830 (defvar revert-buffer-function nil
4831 "Function to use to revert this buffer, or nil to do the default.
4832 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4833 which are the arguments that `revert-buffer' received.")
4834
4835 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4836 (defvar revert-buffer-insert-file-contents-function nil
4837 "Function to use to insert contents when reverting this buffer.
4838 Gets two args, first the nominal file name to use,
4839 and second, t if reading the auto-save file.
4840
4841 The function you specify is responsible for updating (or preserving) point.")
4842
4843 (defvar buffer-stale-function nil
4844 "Function to check whether a non-file buffer needs reverting.
4845 This should be a function with one optional argument NOCONFIRM.
4846 Auto Revert Mode passes t for NOCONFIRM. The function should return
4847 non-nil if the buffer should be reverted. A return value of
4848 `fast' means that the need for reverting was not checked, but
4849 that reverting the buffer is fast. The buffer is current when
4850 this function is called.
4851
4852 The idea behind the NOCONFIRM argument is that it should be
4853 non-nil if the buffer is going to be reverted without asking the
4854 user. In such situations, one has to be careful with potentially
4855 time consuming operations.
4856
4857 For more information on how this variable is used by Auto Revert mode,
4858 see Info node `(emacs)Supporting additional buffers'.")
4859
4860 (defvar before-revert-hook nil
4861 "Normal hook for `revert-buffer' to run before reverting.
4862 If `revert-buffer-function' is used to override the normal revert
4863 mechanism, this hook is not used.")
4864
4865 (defvar after-revert-hook nil
4866 "Normal hook for `revert-buffer' to run after reverting.
4867 Note that the hook value that it runs is the value that was in effect
4868 before reverting; that makes a difference if you have buffer-local
4869 hook functions.
4870
4871 If `revert-buffer-function' is used to override the normal revert
4872 mechanism, this hook is not used.")
4873
4874 (defvar revert-buffer-internal-hook)
4875
4876 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4877 "Replace current buffer text with the text of the visited file on disk.
4878 This undoes all changes since the file was visited or saved.
4879 With a prefix argument, offer to revert from latest auto-save file, if
4880 that is more recent than the visited file.
4881
4882 This command also implements an interface for special buffers
4883 that contain text which doesn't come from a file, but reflects
4884 some other data instead (e.g. Dired buffers, `buffer-list'
4885 buffers). This is done via the variable `revert-buffer-function'.
4886 In these cases, it should reconstruct the buffer contents from the
4887 appropriate data.
4888
4889 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4890 to revert from the auto-save file when this is nil. Note that the
4891 sense of this argument is the reverse of the prefix argument, for the
4892 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4893 to nil.
4894
4895 Optional second argument NOCONFIRM means don't ask for confirmation
4896 at all. \(The variable `revert-without-query' offers another way to
4897 revert buffers without querying for confirmation.)
4898
4899 Optional third argument PRESERVE-MODES non-nil means don't alter
4900 the files modes. Normally we reinitialize them using `normal-mode'.
4901
4902 If the value of `revert-buffer-function' is non-nil, it is called to
4903 do all the work for this command. Otherwise, the hooks
4904 `before-revert-hook' and `after-revert-hook' are run at the beginning
4905 and the end, and if `revert-buffer-insert-file-contents-function' is
4906 non-nil, it is called instead of rereading visited file contents."
4907
4908 ;; I admit it's odd to reverse the sense of the prefix argument, but
4909 ;; there is a lot of code out there which assumes that the first
4910 ;; argument should be t to avoid consulting the auto-save file, and
4911 ;; there's no straightforward way to encourage authors to notice a
4912 ;; reversal of the argument sense. So I'm just changing the user
4913 ;; interface, but leaving the programmatic interface the same.
4914 (interactive (list (not current-prefix-arg)))
4915 (if revert-buffer-function
4916 (funcall revert-buffer-function ignore-auto noconfirm)
4917 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4918 (current-buffer))
4919 (let* ((auto-save-p (and (not ignore-auto)
4920 (recent-auto-save-p)
4921 buffer-auto-save-file-name
4922 (file-readable-p buffer-auto-save-file-name)
4923 (y-or-n-p
4924 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4925 (file-name (if auto-save-p
4926 buffer-auto-save-file-name
4927 buffer-file-name)))
4928 (cond ((null file-name)
4929 (error "Buffer does not seem to be associated with any file"))
4930 ((or noconfirm
4931 (and (not (buffer-modified-p))
4932 (catch 'found
4933 (dolist (regexp revert-without-query)
4934 (when (string-match regexp file-name)
4935 (throw 'found t)))))
4936 (yes-or-no-p (format "Revert buffer from file %s? "
4937 file-name)))
4938 (run-hooks 'before-revert-hook)
4939 ;; If file was backed up but has changed since,
4940 ;; we should make another backup.
4941 (and (not auto-save-p)
4942 (not (verify-visited-file-modtime (current-buffer)))
4943 (setq buffer-backed-up nil))
4944 ;; Effectively copy the after-revert-hook status,
4945 ;; since after-find-file will clobber it.
4946 (let ((global-hook (default-value 'after-revert-hook))
4947 (local-hook (when (local-variable-p 'after-revert-hook)
4948 after-revert-hook))
4949 (inhibit-read-only t))
4950 (cond
4951 (revert-buffer-insert-file-contents-function
4952 (unless (eq buffer-undo-list t)
4953 ;; Get rid of all undo records for this buffer.
4954 (setq buffer-undo-list nil))
4955 ;; Don't make undo records for the reversion.
4956 (let ((buffer-undo-list t))
4957 (funcall revert-buffer-insert-file-contents-function
4958 file-name auto-save-p)))
4959 ((not (file-exists-p file-name))
4960 (error (if buffer-file-number
4961 "File %s no longer exists!"
4962 "Cannot revert nonexistent file %s")
4963 file-name))
4964 ((not (file-readable-p file-name))
4965 (error (if buffer-file-number
4966 "File %s no longer readable!"
4967 "Cannot revert unreadable file %s")
4968 file-name))
4969 (t
4970 ;; Bind buffer-file-name to nil
4971 ;; so that we don't try to lock the file.
4972 (let ((buffer-file-name nil))
4973 (or auto-save-p
4974 (unlock-buffer)))
4975 (widen)
4976 (let ((coding-system-for-read
4977 ;; Auto-saved file should be read by Emacs'
4978 ;; internal coding.
4979 (if auto-save-p 'auto-save-coding
4980 (or coding-system-for-read
4981 (and
4982 buffer-file-coding-system-explicit
4983 (car buffer-file-coding-system-explicit))))))
4984 (if (and (not enable-multibyte-characters)
4985 coding-system-for-read
4986 (not (memq (coding-system-base
4987 coding-system-for-read)
4988 '(no-conversion raw-text))))
4989 ;; As a coding system suitable for multibyte
4990 ;; buffer is specified, make the current
4991 ;; buffer multibyte.
4992 (set-buffer-multibyte t))
4993
4994 ;; This force after-insert-file-set-coding
4995 ;; (called from insert-file-contents) to set
4996 ;; buffer-file-coding-system to a proper value.
4997 (kill-local-variable 'buffer-file-coding-system)
4998
4999 ;; Note that this preserves point in an intelligent way.
5000 (if preserve-modes
5001 (let ((buffer-file-format buffer-file-format))
5002 (insert-file-contents file-name (not auto-save-p)
5003 nil nil t))
5004 (insert-file-contents file-name (not auto-save-p)
5005 nil nil t)))))
5006 ;; Recompute the truename in case changes in symlinks
5007 ;; have changed the truename.
5008 (setq buffer-file-truename
5009 (abbreviate-file-name (file-truename buffer-file-name)))
5010 (after-find-file nil nil t t preserve-modes)
5011 ;; Run after-revert-hook as it was before we reverted.
5012 (setq-default revert-buffer-internal-hook global-hook)
5013 (if local-hook
5014 (set (make-local-variable 'revert-buffer-internal-hook)
5015 local-hook)
5016 (kill-local-variable 'revert-buffer-internal-hook))
5017 (run-hooks 'revert-buffer-internal-hook))
5018 t))))))
5019
5020 (defun recover-this-file ()
5021 "Recover the visited file--get contents from its last auto-save file."
5022 (interactive)
5023 (recover-file buffer-file-name))
5024
5025 (defun recover-file (file)
5026 "Visit file FILE, but get contents from its last auto-save file."
5027 ;; Actually putting the file name in the minibuffer should be used
5028 ;; only rarely.
5029 ;; Not just because users often use the default.
5030 (interactive "FRecover file: ")
5031 (setq file (expand-file-name file))
5032 (if (auto-save-file-name-p (file-name-nondirectory file))
5033 (error "%s is an auto-save file" (abbreviate-file-name file)))
5034 (let ((file-name (let ((buffer-file-name file))
5035 (make-auto-save-file-name))))
5036 (cond ((if (file-exists-p file)
5037 (not (file-newer-than-file-p file-name file))
5038 (not (file-exists-p file-name)))
5039 (error "Auto-save file %s not current"
5040 (abbreviate-file-name file-name)))
5041 ((save-window-excursion
5042 (with-output-to-temp-buffer "*Directory*"
5043 (buffer-disable-undo standard-output)
5044 (save-excursion
5045 (let ((switches dired-listing-switches))
5046 (if (file-symlink-p file)
5047 (setq switches (concat switches "L")))
5048 (set-buffer standard-output)
5049 ;; Use insert-directory-safely, not insert-directory,
5050 ;; because these files might not exist. In particular,
5051 ;; FILE might not exist if the auto-save file was for
5052 ;; a buffer that didn't visit a file, such as "*mail*".
5053 ;; The code in v20.x called `ls' directly, so we need
5054 ;; to emulate what `ls' did in that case.
5055 (insert-directory-safely file switches)
5056 (insert-directory-safely file-name switches))))
5057 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
5058 (switch-to-buffer (find-file-noselect file t))
5059 (let ((inhibit-read-only t)
5060 ;; Keep the current buffer-file-coding-system.
5061 (coding-system buffer-file-coding-system)
5062 ;; Auto-saved file should be read with special coding.
5063 (coding-system-for-read 'auto-save-coding))
5064 (erase-buffer)
5065 (insert-file-contents file-name nil)
5066 (set-buffer-file-coding-system coding-system))
5067 (after-find-file nil nil t))
5068 (t (error "Recover-file cancelled")))))
5069
5070 (defun recover-session ()
5071 "Recover auto save files from a previous Emacs session.
5072 This command first displays a Dired buffer showing you the
5073 previous sessions that you could recover from.
5074 To choose one, move point to the proper line and then type C-c C-c.
5075 Then you'll be asked about a number of files to recover."
5076 (interactive)
5077 (if (null auto-save-list-file-prefix)
5078 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5079 (let ((dir (file-name-directory auto-save-list-file-prefix)))
5080 (unless (file-directory-p dir)
5081 (make-directory dir t))
5082 (unless (directory-files dir nil
5083 (concat "\\`" (regexp-quote
5084 (file-name-nondirectory
5085 auto-save-list-file-prefix)))
5086 t)
5087 (error "No previous sessions to recover")))
5088 (let ((ls-lisp-support-shell-wildcards t))
5089 (dired (concat auto-save-list-file-prefix "*")
5090 (concat dired-listing-switches "t")))
5091 (save-excursion
5092 (goto-char (point-min))
5093 (or (looking-at " Move to the session you want to recover,")
5094 (let ((inhibit-read-only t))
5095 ;; Each line starts with a space
5096 ;; so that Font Lock mode won't highlight the first character.
5097 (insert " Move to the session you want to recover,\n"
5098 " then type C-c C-c to select it.\n\n"
5099 " You can also delete some of these files;\n"
5100 " type d on a line to mark that file for deletion.\n\n"))))
5101 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5102 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
5103
5104 (defun recover-session-finish ()
5105 "Choose one saved session to recover auto-save files from.
5106 This command is used in the special Dired buffer created by
5107 \\[recover-session]."
5108 (interactive)
5109 ;; Get the name of the session file to recover from.
5110 (let ((file (dired-get-filename))
5111 files
5112 (buffer (get-buffer-create " *recover*")))
5113 (dired-unmark 1)
5114 (dired-do-flagged-delete t)
5115 (unwind-protect
5116 (with-current-buffer buffer
5117 ;; Read in the auto-save-list file.
5118 (erase-buffer)
5119 (insert-file-contents file)
5120 ;; Loop thru the text of that file
5121 ;; and get out the names of the files to recover.
5122 (while (not (eobp))
5123 (let (thisfile autofile)
5124 (if (eolp)
5125 ;; This is a pair of lines for a non-file-visiting buffer.
5126 ;; Get the auto-save file name and manufacture
5127 ;; a "visited file name" from that.
5128 (progn
5129 (forward-line 1)
5130 ;; If there is no auto-save file name, the
5131 ;; auto-save-list file is probably corrupted.
5132 (unless (eolp)
5133 (setq autofile
5134 (buffer-substring-no-properties
5135 (point)
5136 (line-end-position)))
5137 (setq thisfile
5138 (expand-file-name
5139 (substring
5140 (file-name-nondirectory autofile)
5141 1 -1)
5142 (file-name-directory autofile))))
5143 (forward-line 1))
5144 ;; This pair of lines is a file-visiting
5145 ;; buffer. Use the visited file name.
5146 (progn
5147 (setq thisfile
5148 (buffer-substring-no-properties
5149 (point) (progn (end-of-line) (point))))
5150 (forward-line 1)
5151 (setq autofile
5152 (buffer-substring-no-properties
5153 (point) (progn (end-of-line) (point))))
5154 (forward-line 1)))
5155 ;; Ignore a file if its auto-save file does not exist now.
5156 (if (and autofile (file-exists-p autofile))
5157 (setq files (cons thisfile files)))))
5158 (setq files (nreverse files))
5159 ;; The file contains a pair of line for each auto-saved buffer.
5160 ;; The first line of the pair contains the visited file name
5161 ;; or is empty if the buffer was not visiting a file.
5162 ;; The second line is the auto-save file name.
5163 (if files
5164 (map-y-or-n-p "Recover %s? "
5165 (lambda (file)
5166 (condition-case nil
5167 (save-excursion (recover-file file))
5168 (error
5169 "Failed to recover `%s'" file)))
5170 files
5171 '("file" "files" "recover"))
5172 (message "No files can be recovered from this session now")))
5173 (kill-buffer buffer))))
5174
5175 (defun kill-buffer-ask (buffer)
5176 "Kill BUFFER if confirmed."
5177 (when (yes-or-no-p
5178 (format "Buffer %s %s. Kill? " (buffer-name buffer)
5179 (if (buffer-modified-p buffer)
5180 "HAS BEEN EDITED" "is unmodified")))
5181 (kill-buffer buffer)))
5182
5183 (defun kill-some-buffers (&optional list)
5184 "Kill some buffers. Asks the user whether to kill each one of them.
5185 Non-interactively, if optional argument LIST is non-nil, it
5186 specifies the list of buffers to kill, asking for approval for each one."
5187 (interactive)
5188 (if (null list)
5189 (setq list (buffer-list)))
5190 (while list
5191 (let* ((buffer (car list))
5192 (name (buffer-name buffer)))
5193 (and name ; Can be nil for an indirect buffer
5194 ; if we killed the base buffer.
5195 (not (string-equal name ""))
5196 (/= (aref name 0) ?\s)
5197 (kill-buffer-ask buffer)))
5198 (setq list (cdr list))))
5199
5200 (defun kill-matching-buffers (regexp &optional internal-too)
5201 "Kill buffers whose name matches the specified REGEXP.
5202 The optional second argument indicates whether to kill internal buffers too."
5203 (interactive "sKill buffers matching this regular expression: \nP")
5204 (dolist (buffer (buffer-list))
5205 (let ((name (buffer-name buffer)))
5206 (when (and name (not (string-equal name ""))
5207 (or internal-too (/= (aref name 0) ?\s))
5208 (string-match regexp name))
5209 (kill-buffer-ask buffer)))))
5210
5211 \f
5212 (defun rename-auto-save-file ()
5213 "Adjust current buffer's auto save file name for current conditions.
5214 Also rename any existing auto save file, if it was made in this session."
5215 (let ((osave buffer-auto-save-file-name))
5216 (setq buffer-auto-save-file-name
5217 (make-auto-save-file-name))
5218 (if (and osave buffer-auto-save-file-name
5219 (not (string= buffer-auto-save-file-name buffer-file-name))
5220 (not (string= buffer-auto-save-file-name osave))
5221 (file-exists-p osave)
5222 (recent-auto-save-p))
5223 (rename-file osave buffer-auto-save-file-name t))))
5224
5225 (defun make-auto-save-file-name ()
5226 "Return file name to use for auto-saves of current buffer.
5227 Does not consider `auto-save-visited-file-name' as that variable is checked
5228 before calling this function. You can redefine this for customization.
5229 See also `auto-save-file-name-p'."
5230 (if buffer-file-name
5231 (let ((handler (find-file-name-handler buffer-file-name
5232 'make-auto-save-file-name)))
5233 (if handler
5234 (funcall handler 'make-auto-save-file-name)
5235 (let ((list auto-save-file-name-transforms)
5236 (filename buffer-file-name)
5237 result uniq)
5238 ;; Apply user-specified translations
5239 ;; to the file name.
5240 (while (and list (not result))
5241 (if (string-match (car (car list)) filename)
5242 (setq result (replace-match (cadr (car list)) t nil
5243 filename)
5244 uniq (car (cddr (car list)))))
5245 (setq list (cdr list)))
5246 (if result
5247 (if uniq
5248 (setq filename (concat
5249 (file-name-directory result)
5250 (subst-char-in-string
5251 ?/ ?!
5252 (replace-regexp-in-string "!" "!!"
5253 filename))))
5254 (setq filename result)))
5255 (setq result
5256 (if (and (eq system-type 'ms-dos)
5257 (not (msdos-long-file-names)))
5258 ;; We truncate the file name to DOS 8+3 limits
5259 ;; before doing anything else, because the regexp
5260 ;; passed to string-match below cannot handle
5261 ;; extensions longer than 3 characters, multiple
5262 ;; dots, and other atrocities.
5263 (let ((fn (dos-8+3-filename
5264 (file-name-nondirectory buffer-file-name))))
5265 (string-match
5266 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5267 fn)
5268 (concat (file-name-directory buffer-file-name)
5269 "#" (match-string 1 fn)
5270 "." (match-string 3 fn) "#"))
5271 (concat (file-name-directory filename)
5272 "#"
5273 (file-name-nondirectory filename)
5274 "#")))
5275 ;; Make sure auto-save file names don't contain characters
5276 ;; invalid for the underlying filesystem.
5277 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5278 ;; Don't modify remote (ange-ftp) filenames
5279 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5280 (convert-standard-filename result)
5281 result))))
5282
5283 ;; Deal with buffers that don't have any associated files. (Mail
5284 ;; mode tends to create a good number of these.)
5285
5286 (let ((buffer-name (buffer-name))
5287 (limit 0)
5288 file-name)
5289 ;; Restrict the characters used in the file name to those which
5290 ;; are known to be safe on all filesystems, url-encoding the
5291 ;; rest.
5292 ;; We do this on all platforms, because even if we are not
5293 ;; running on DOS/Windows, the current directory may be on a
5294 ;; mounted VFAT filesystem, such as a USB memory stick.
5295 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5296 (let* ((character (aref buffer-name (match-beginning 0)))
5297 (replacement
5298 ;; For multibyte characters, this will produce more than
5299 ;; 2 hex digits, so is not true URL encoding.
5300 (format "%%%02X" character)))
5301 (setq buffer-name (replace-match replacement t t buffer-name))
5302 (setq limit (1+ (match-end 0)))))
5303 ;; Generate the file name.
5304 (setq file-name
5305 (make-temp-file
5306 (let ((fname
5307 (expand-file-name
5308 (format "#%s#" buffer-name)
5309 ;; Try a few alternative directories, to get one we can
5310 ;; write it.
5311 (cond
5312 ((file-writable-p default-directory) default-directory)
5313 ((file-writable-p "/var/tmp/") "/var/tmp/")
5314 ("~/")))))
5315 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5316 ;; Don't modify remote (ange-ftp) filenames
5317 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5318 ;; The call to convert-standard-filename is in case
5319 ;; buffer-name includes characters not allowed by the
5320 ;; DOS/Windows filesystems. make-temp-file writes to the
5321 ;; file it creates, so we must fix the file name _before_
5322 ;; make-temp-file is called.
5323 (convert-standard-filename fname)
5324 fname))
5325 nil "#"))
5326 ;; make-temp-file creates the file,
5327 ;; but we don't want it to exist until we do an auto-save.
5328 (condition-case ()
5329 (delete-file file-name)
5330 (file-error nil))
5331 file-name)))
5332
5333 (defun auto-save-file-name-p (filename)
5334 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5335 FILENAME should lack slashes. You can redefine this for customization."
5336 (string-match "^#.*#$" filename))
5337 \f
5338 (defun wildcard-to-regexp (wildcard)
5339 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5340 The generated regexp will match a filename only if the filename
5341 matches that wildcard according to shell rules. Only wildcards known
5342 by `sh' are supported."
5343 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5344 ;; Copy the initial run of non-special characters.
5345 (result (substring wildcard 0 i))
5346 (len (length wildcard)))
5347 ;; If no special characters, we're almost done.
5348 (if i
5349 (while (< i len)
5350 (let ((ch (aref wildcard i))
5351 j)
5352 (setq
5353 result
5354 (concat result
5355 (cond
5356 ((and (eq ch ?\[)
5357 (< (1+ i) len)
5358 (eq (aref wildcard (1+ i)) ?\]))
5359 "\\[")
5360 ((eq ch ?\[) ; [...] maps to regexp char class
5361 (progn
5362 (setq i (1+ i))
5363 (concat
5364 (cond
5365 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5366 (progn
5367 (setq i (1+ i))
5368 (if (eq (aref wildcard i) ?\])
5369 (progn
5370 (setq i (1+ i))
5371 "[^]")
5372 "[^")))
5373 ((eq (aref wildcard i) ?^)
5374 ;; Found "[^". Insert a `\0' character
5375 ;; (which cannot happen in a filename)
5376 ;; into the character class, so that `^'
5377 ;; is not the first character after `[',
5378 ;; and thus non-special in a regexp.
5379 (progn
5380 (setq i (1+ i))
5381 "[\000^"))
5382 ((eq (aref wildcard i) ?\])
5383 ;; I don't think `]' can appear in a
5384 ;; character class in a wildcard, but
5385 ;; let's be general here.
5386 (progn
5387 (setq i (1+ i))
5388 "[]"))
5389 (t "["))
5390 (prog1 ; copy everything upto next `]'.
5391 (substring wildcard
5392 i
5393 (setq j (string-match
5394 "]" wildcard i)))
5395 (setq i (if j (1- j) (1- len)))))))
5396 ((eq ch ?.) "\\.")
5397 ((eq ch ?*) "[^\000]*")
5398 ((eq ch ?+) "\\+")
5399 ((eq ch ?^) "\\^")
5400 ((eq ch ?$) "\\$")
5401 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5402 ((eq ch ??) "[^\000]")
5403 (t (char-to-string ch)))))
5404 (setq i (1+ i)))))
5405 ;; Shell wildcards should match the entire filename,
5406 ;; not its part. Make the regexp say so.
5407 (concat "\\`" result "\\'")))
5408 \f
5409 (defcustom list-directory-brief-switches
5410 (purecopy "-CF")
5411 "Switches for `list-directory' to pass to `ls' for brief listing."
5412 :type 'string
5413 :group 'dired)
5414
5415 (defcustom list-directory-verbose-switches
5416 (purecopy "-l")
5417 "Switches for `list-directory' to pass to `ls' for verbose listing."
5418 :type 'string
5419 :group 'dired)
5420
5421 (defun file-expand-wildcards (pattern &optional full)
5422 "Expand wildcard pattern PATTERN.
5423 This returns a list of file names which match the pattern.
5424
5425 If PATTERN is written as an absolute file name,
5426 the values are absolute also.
5427
5428 If PATTERN is written as a relative file name, it is interpreted
5429 relative to the current default directory, `default-directory'.
5430 The file names returned are normally also relative to the current
5431 default directory. However, if FULL is non-nil, they are absolute."
5432 (save-match-data
5433 (let* ((nondir (file-name-nondirectory pattern))
5434 (dirpart (file-name-directory pattern))
5435 ;; A list of all dirs that DIRPART specifies.
5436 ;; This can be more than one dir
5437 ;; if DIRPART contains wildcards.
5438 (dirs (if (and dirpart
5439 (string-match "[[*?]"
5440 (or (file-remote-p dirpart 'localname)
5441 dirpart)))
5442 (mapcar 'file-name-as-directory
5443 (file-expand-wildcards (directory-file-name dirpart)))
5444 (list dirpart)))
5445 contents)
5446 (while dirs
5447 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5448 (file-directory-p (directory-file-name (car dirs))))
5449 (let ((this-dir-contents
5450 ;; Filter out "." and ".."
5451 (delq nil
5452 (mapcar #'(lambda (name)
5453 (unless (string-match "\\`\\.\\.?\\'"
5454 (file-name-nondirectory name))
5455 name))
5456 (directory-files (or (car dirs) ".") full
5457 (wildcard-to-regexp nondir))))))
5458 (setq contents
5459 (nconc
5460 (if (and (car dirs) (not full))
5461 (mapcar (function (lambda (name) (concat (car dirs) name)))
5462 this-dir-contents)
5463 this-dir-contents)
5464 contents))))
5465 (setq dirs (cdr dirs)))
5466 contents)))
5467
5468 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5469 (provide 'files '(remote-wildcards))
5470
5471 (defun list-directory (dirname &optional verbose)
5472 "Display a list of files in or matching DIRNAME, a la `ls'.
5473 DIRNAME is globbed by the shell if necessary.
5474 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5475 Actions controlled by variables `list-directory-brief-switches'
5476 and `list-directory-verbose-switches'."
5477 (interactive (let ((pfx current-prefix-arg))
5478 (list (read-file-name (if pfx "List directory (verbose): "
5479 "List directory (brief): ")
5480 nil default-directory nil)
5481 pfx)))
5482 (let ((switches (if verbose list-directory-verbose-switches
5483 list-directory-brief-switches))
5484 buffer)
5485 (or dirname (setq dirname default-directory))
5486 (setq dirname (expand-file-name dirname))
5487 (with-output-to-temp-buffer "*Directory*"
5488 (setq buffer standard-output)
5489 (buffer-disable-undo standard-output)
5490 (princ "Directory ")
5491 (princ dirname)
5492 (terpri)
5493 (with-current-buffer "*Directory*"
5494 (let ((wildcard (not (file-directory-p dirname))))
5495 (insert-directory dirname switches wildcard (not wildcard)))))
5496 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5497 (with-current-buffer buffer
5498 (setq default-directory
5499 (if (file-directory-p dirname)
5500 (file-name-as-directory dirname)
5501 (file-name-directory dirname))))))
5502
5503 (defun shell-quote-wildcard-pattern (pattern)
5504 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5505
5506 PATTERN is assumed to represent a file-name wildcard suitable for the
5507 underlying filesystem. For Unix and GNU/Linux, each character from the
5508 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5509 the parts of the pattern which don't include wildcard characters are
5510 quoted with double quotes.
5511
5512 This function leaves alone existing quote characters (\\ on Unix and \"
5513 on Windows), so PATTERN can use them to quote wildcard characters that
5514 need to be passed verbatim to shell commands."
5515 (save-match-data
5516 (cond
5517 ((memq system-type '(ms-dos windows-nt cygwin))
5518 ;; DOS/Windows don't allow `"' in file names. So if the
5519 ;; argument has quotes, we can safely assume it is already
5520 ;; quoted by the caller.
5521 (if (or (string-match "[\"]" pattern)
5522 ;; We quote [&()#$'] in case their shell is a port of a
5523 ;; Unixy shell. We quote [,=+] because stock DOS and
5524 ;; Windows shells require that in some cases, such as
5525 ;; passing arguments to batch files that use positional
5526 ;; arguments like %1.
5527 (not (string-match "[ \t;&()#$',=+]" pattern)))
5528 pattern
5529 (let ((result "\"")
5530 (beg 0)
5531 end)
5532 (while (string-match "[*?]+" pattern beg)
5533 (setq end (match-beginning 0)
5534 result (concat result (substring pattern beg end)
5535 "\""
5536 (substring pattern end (match-end 0))
5537 "\"")
5538 beg (match-end 0)))
5539 (concat result (substring pattern beg) "\""))))
5540 (t
5541 (let ((beg 0))
5542 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5543 (setq pattern
5544 (concat (substring pattern 0 (match-beginning 0))
5545 "\\"
5546 (substring pattern (match-beginning 0)))
5547 beg (1+ (match-end 0)))))
5548 pattern))))
5549
5550
5551 (defvar insert-directory-program (purecopy "ls")
5552 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5553
5554 (defcustom directory-free-space-program (purecopy "df")
5555 "Program to get the amount of free space on a file system.
5556 We assume the output has the format of `df'.
5557 The value of this variable must be just a command name or file name;
5558 if you want to specify options, use `directory-free-space-args'.
5559
5560 A value of nil disables this feature.
5561
5562 If the function `file-system-info' is defined, it is always used in
5563 preference to the program given by this variable."
5564 :type '(choice (string :tag "Program") (const :tag "None" nil))
5565 :group 'dired)
5566
5567 (defcustom directory-free-space-args
5568 (purecopy (if (eq system-type 'darwin) "-k" "-Pk"))
5569 "Options to use when running `directory-free-space-program'."
5570 :type 'string
5571 :group 'dired)
5572
5573 (defun get-free-disk-space (dir)
5574 "Return the amount of free space on directory DIR's file system.
5575 The return value is a string describing the amount of free
5576 space (normally, the number of free 1KB blocks).
5577
5578 This function calls `file-system-info' if it is available, or
5579 invokes the program specified by `directory-free-space-program'
5580 and `directory-free-space-args'. If the system call or program
5581 is unsuccessful, or if DIR is a remote directory, this function
5582 returns nil."
5583 (unless (file-remote-p dir)
5584 ;; Try to find the number of free blocks. Non-Posix systems don't
5585 ;; always have df, but might have an equivalent system call.
5586 (if (fboundp 'file-system-info)
5587 (let ((fsinfo (file-system-info dir)))
5588 (if fsinfo
5589 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5590 (setq dir (expand-file-name dir))
5591 (save-match-data
5592 (with-temp-buffer
5593 (when (and directory-free-space-program
5594 ;; Avoid failure if the default directory does
5595 ;; not exist (Bug#2631, Bug#3911).
5596 (let ((default-directory "/"))
5597 (eq (call-process directory-free-space-program
5598 nil t nil
5599 directory-free-space-args
5600 dir)
5601 0)))
5602 ;; Usual format is as follows:
5603 ;; Filesystem ... Used Available Capacity ...
5604 ;; /dev/sda6 ...48106535 35481255 10669850 ...
5605 (goto-char (point-min))
5606 (when (re-search-forward " +Avail[^ \n]*"
5607 (line-end-position) t)
5608 (let ((beg (match-beginning 0))
5609 (end (match-end 0))
5610 str)
5611 (forward-line 1)
5612 (setq str
5613 (buffer-substring-no-properties
5614 (+ beg (point) (- (point-min)))
5615 (+ end (point) (- (point-min)))))
5616 (when (string-match "\\` *\\([^ ]+\\)" str)
5617 (match-string 1 str))))))))))
5618
5619 ;; The following expression replaces `dired-move-to-filename-regexp'.
5620 (defvar directory-listing-before-filename-regexp
5621 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5622 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5623 ;; In some locales, month abbreviations are as short as 2 letters,
5624 ;; and they can be followed by ".".
5625 ;; In Breton, a month name can include a quote character.
5626 (month (concat l-or-quote l-or-quote "+\\.?"))
5627 (s " ")
5628 (yyyy "[0-9][0-9][0-9][0-9]")
5629 (dd "[ 0-3][0-9]")
5630 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5631 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5632 (zone "[-+][0-2][0-9][0-5][0-9]")
5633 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5634 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5635 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5636 "\\|" yyyy "-" iso-mm-dd "\\)"))
5637 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5638 s "+"
5639 "\\(" HH:MM "\\|" yyyy "\\)"))
5640 (western-comma (concat month s "+" dd "," s "+" yyyy))
5641 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5642 ;; omits the Kanji characters after month and day-of-month.
5643 ;; On Mac OS X 10.3, the date format in East Asian locales is
5644 ;; day-of-month digits followed by month digits.
5645 (mm "[ 0-1]?[0-9]")
5646 (east-asian
5647 (concat "\\(" mm l "?" s dd l "?" s "+"
5648 "\\|" dd s mm s "+" "\\)"
5649 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5650 ;; The "[0-9]" below requires the previous column to end in a digit.
5651 ;; This avoids recognizing `1 may 1997' as a date in the line:
5652 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5653
5654 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5655
5656 ;; For non-iso date formats, we add the ".*" in order to find
5657 ;; the last possible match. This avoids recognizing
5658 ;; `jservice 10 1024' as a date in the line:
5659 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5660
5661 ;; vc dired listings provide the state or blanks between file
5662 ;; permissions and date. The state is always surrounded by
5663 ;; parantheses:
5664 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5665 ;; This is not supported yet.
5666 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5667 "\\|.*[0-9][BkKMGTPEZY]? "
5668 "\\(" western "\\|" western-comma "\\|" east-asian "\\)"
5669 "\\) +")))
5670 "Regular expression to match up to the file name in a directory listing.
5671 The default value is designed to recognize dates and times
5672 regardless of the language.")
5673
5674 (defvar insert-directory-ls-version 'unknown)
5675
5676 ;; insert-directory
5677 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5678 ;; FULL-DIRECTORY-P is nil.
5679 ;; The single line of output must display FILE's name as it was
5680 ;; given, namely, an absolute path name.
5681 ;; - must insert exactly one line for each file if WILDCARD or
5682 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5683 ;; before the file lines, plus optional text after the file lines.
5684 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5685 ;; allowed.
5686 ;; File lines should display the basename.
5687 ;; - must be consistent with
5688 ;; - functions dired-move-to-filename, (these two define what a file line is)
5689 ;; dired-move-to-end-of-filename,
5690 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5691 ;; dired-insert-headerline
5692 ;; dired-after-subdir-garbage (defines what a "total" line is)
5693 ;; - variable dired-subdir-regexp
5694 ;; - may be passed "--dired" as the first argument in SWITCHES.
5695 ;; Filename handlers might have to remove this switch if their
5696 ;; "ls" command does not support it.
5697 (defun insert-directory (file switches &optional wildcard full-directory-p)
5698 "Insert directory listing for FILE, formatted according to SWITCHES.
5699 Leaves point after the inserted text.
5700 SWITCHES may be a string of options, or a list of strings
5701 representing individual options.
5702 Optional third arg WILDCARD means treat FILE as shell wildcard.
5703 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5704 switches do not contain `d', so that a full listing is expected.
5705
5706 This works by running a directory listing program
5707 whose name is in the variable `insert-directory-program'.
5708 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5709
5710 When SWITCHES contains the long `--dired' option, this function
5711 treats it specially, for the sake of dired. However, the
5712 normally equivalent short `-D' option is just passed on to
5713 `insert-directory-program', as any other option."
5714 ;; We need the directory in order to find the right handler.
5715 (let ((handler (find-file-name-handler (expand-file-name file)
5716 'insert-directory)))
5717 (if handler
5718 (funcall handler 'insert-directory file switches
5719 wildcard full-directory-p)
5720 (let (result (beg (point)))
5721
5722 ;; Read the actual directory using `insert-directory-program'.
5723 ;; RESULT gets the status code.
5724 (let* (;; We at first read by no-conversion, then after
5725 ;; putting text property `dired-filename, decode one
5726 ;; bunch by one to preserve that property.
5727 (coding-system-for-read 'no-conversion)
5728 ;; This is to control encoding the arguments in call-process.
5729 (coding-system-for-write
5730 (and enable-multibyte-characters
5731 (or file-name-coding-system
5732 default-file-name-coding-system))))
5733 (setq result
5734 (if wildcard
5735 ;; Run ls in the directory part of the file pattern
5736 ;; using the last component as argument.
5737 (let ((default-directory
5738 (if (file-name-absolute-p file)
5739 (file-name-directory file)
5740 (file-name-directory (expand-file-name file))))
5741 (pattern (file-name-nondirectory file)))
5742 (call-process
5743 shell-file-name nil t nil
5744 "-c"
5745 (concat (if (memq system-type '(ms-dos windows-nt))
5746 ""
5747 "\\") ; Disregard Unix shell aliases!
5748 insert-directory-program
5749 " -d "
5750 (if (stringp switches)
5751 switches
5752 (mapconcat 'identity switches " "))
5753 " -- "
5754 ;; Quote some characters that have
5755 ;; special meanings in shells; but
5756 ;; don't quote the wildcards--we want
5757 ;; them to be special. We also
5758 ;; currently don't quote the quoting
5759 ;; characters in case people want to
5760 ;; use them explicitly to quote
5761 ;; wildcard characters.
5762 (shell-quote-wildcard-pattern pattern))))
5763 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5764 ;; directory if FILE is a symbolic link.
5765 (unless full-directory-p
5766 (setq switches
5767 (if (stringp switches)
5768 (concat switches " -d")
5769 (add-to-list 'switches "-d" 'append))))
5770 (apply 'call-process
5771 insert-directory-program nil t nil
5772 (append
5773 (if (listp switches) switches
5774 (unless (equal switches "")
5775 ;; Split the switches at any spaces so we can
5776 ;; pass separate options as separate args.
5777 (split-string switches)))
5778 ;; Avoid lossage if FILE starts with `-'.
5779 '("--")
5780 (progn
5781 (if (string-match "\\`~" file)
5782 (setq file (expand-file-name file)))
5783 (list
5784 (if full-directory-p
5785 (concat (file-name-as-directory file) ".")
5786 file))))))))
5787
5788 ;; If we got "//DIRED//" in the output, it means we got a real
5789 ;; directory listing, even if `ls' returned nonzero.
5790 ;; So ignore any errors.
5791 (when (if (stringp switches)
5792 (string-match "--dired\\>" switches)
5793 (member "--dired" switches))
5794 (save-excursion
5795 (forward-line -2)
5796 (when (looking-at "//SUBDIRED//")
5797 (forward-line -1))
5798 (if (looking-at "//DIRED//")
5799 (setq result 0))))
5800
5801 (when (and (not (eq 0 result))
5802 (eq insert-directory-ls-version 'unknown))
5803 ;; The first time ls returns an error,
5804 ;; find the version numbers of ls,
5805 ;; and set insert-directory-ls-version
5806 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5807 ;; is equal or if the info cannot be obtained.
5808 ;; (That can mean it isn't GNU ls.)
5809 (let ((version-out
5810 (with-temp-buffer
5811 (call-process "ls" nil t nil "--version")
5812 (buffer-string))))
5813 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5814 (let* ((version (match-string 1 version-out))
5815 (split (split-string version "[.]"))
5816 (numbers (mapcar 'string-to-number split))
5817 (min '(5 2 1))
5818 comparison)
5819 (while (and (not comparison) (or numbers min))
5820 (cond ((null min)
5821 (setq comparison '>))
5822 ((null numbers)
5823 (setq comparison '<))
5824 ((> (car numbers) (car min))
5825 (setq comparison '>))
5826 ((< (car numbers) (car min))
5827 (setq comparison '<))
5828 (t
5829 (setq numbers (cdr numbers)
5830 min (cdr min)))))
5831 (setq insert-directory-ls-version (or comparison '=)))
5832 (setq insert-directory-ls-version nil))))
5833
5834 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5835 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5836 (setq result 0))
5837
5838 ;; If `insert-directory-program' failed, signal an error.
5839 (unless (eq 0 result)
5840 ;; Delete the error message it may have output.
5841 (delete-region beg (point))
5842 ;; On non-Posix systems, we cannot open a directory, so
5843 ;; don't even try, because that will always result in
5844 ;; the ubiquitous "Access denied". Instead, show the
5845 ;; command line so the user can try to guess what went wrong.
5846 (if (and (file-directory-p file)
5847 (memq system-type '(ms-dos windows-nt)))
5848 (error
5849 "Reading directory: \"%s %s -- %s\" exited with status %s"
5850 insert-directory-program
5851 (if (listp switches) (concat switches) switches)
5852 file result)
5853 ;; Unix. Access the file to get a suitable error.
5854 (access-file file "Reading directory")
5855 (error "Listing directory failed but `access-file' worked")))
5856
5857 (when (if (stringp switches)
5858 (string-match "--dired\\>" switches)
5859 (member "--dired" switches))
5860 ;; The following overshoots by one line for an empty
5861 ;; directory listed with "--dired", but without "-a"
5862 ;; switch, where the ls output contains a
5863 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5864 ;; We take care of that case later.
5865 (forward-line -2)
5866 (when (looking-at "//SUBDIRED//")
5867 (delete-region (point) (progn (forward-line 1) (point)))
5868 (forward-line -1))
5869 (if (looking-at "//DIRED//")
5870 (let ((end (line-end-position))
5871 (linebeg (point))
5872 error-lines)
5873 ;; Find all the lines that are error messages,
5874 ;; and record the bounds of each one.
5875 (goto-char beg)
5876 (while (< (point) linebeg)
5877 (or (eql (following-char) ?\s)
5878 (push (list (point) (line-end-position)) error-lines))
5879 (forward-line 1))
5880 (setq error-lines (nreverse error-lines))
5881 ;; Now read the numeric positions of file names.
5882 (goto-char linebeg)
5883 (forward-word 1)
5884 (forward-char 3)
5885 (while (< (point) end)
5886 (let ((start (insert-directory-adj-pos
5887 (+ beg (read (current-buffer)))
5888 error-lines))
5889 (end (insert-directory-adj-pos
5890 (+ beg (read (current-buffer)))
5891 error-lines)))
5892 (if (memq (char-after end) '(?\n ?\s))
5893 ;; End is followed by \n or by " -> ".
5894 (put-text-property start end 'dired-filename t)
5895 ;; It seems that we can't trust ls's output as to
5896 ;; byte positions of filenames.
5897 (put-text-property beg (point) 'dired-filename nil)
5898 (end-of-line))))
5899 (goto-char end)
5900 (beginning-of-line)
5901 (delete-region (point) (progn (forward-line 1) (point))))
5902 ;; Take care of the case where the ls output contains a
5903 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5904 ;; and we went one line too far back (see above).
5905 (forward-line 1))
5906 (if (looking-at "//DIRED-OPTIONS//")
5907 (delete-region (point) (progn (forward-line 1) (point)))))
5908
5909 ;; Now decode what read if necessary.
5910 (let ((coding (or coding-system-for-read
5911 file-name-coding-system
5912 default-file-name-coding-system
5913 'undecided))
5914 coding-no-eol
5915 val pos)
5916 (when (and enable-multibyte-characters
5917 (not (memq (coding-system-base coding)
5918 '(raw-text no-conversion))))
5919 ;; If no coding system is specified or detection is
5920 ;; requested, detect the coding.
5921 (if (eq (coding-system-base coding) 'undecided)
5922 (setq coding (detect-coding-region beg (point) t)))
5923 (if (not (eq (coding-system-base coding) 'undecided))
5924 (save-restriction
5925 (setq coding-no-eol
5926 (coding-system-change-eol-conversion coding 'unix))
5927 (narrow-to-region beg (point))
5928 (goto-char (point-min))
5929 (while (not (eobp))
5930 (setq pos (point)
5931 val (get-text-property (point) 'dired-filename))
5932 (goto-char (next-single-property-change
5933 (point) 'dired-filename nil (point-max)))
5934 ;; Force no eol conversion on a file name, so
5935 ;; that CR is preserved.
5936 (decode-coding-region pos (point)
5937 (if val coding-no-eol coding))
5938 (if val
5939 (put-text-property pos (point)
5940 'dired-filename t)))))))
5941
5942 (if full-directory-p
5943 ;; Try to insert the amount of free space.
5944 (save-excursion
5945 (goto-char beg)
5946 ;; First find the line to put it on.
5947 (when (re-search-forward "^ *\\(total\\)" nil t)
5948 (let ((available (get-free-disk-space ".")))
5949 (when available
5950 ;; Replace "total" with "used", to avoid confusion.
5951 (replace-match "total used in directory" nil nil nil 1)
5952 (end-of-line)
5953 (insert " available " available))))))))))
5954
5955 (defun insert-directory-adj-pos (pos error-lines)
5956 "Convert `ls --dired' file name position value POS to a buffer position.
5957 File name position values returned in ls --dired output
5958 count only stdout; they don't count the error messages sent to stderr.
5959 So this function converts to them to real buffer positions.
5960 ERROR-LINES is a list of buffer positions of error message lines,
5961 of the form (START END)."
5962 (while (and error-lines (< (caar error-lines) pos))
5963 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5964 (pop error-lines))
5965 pos)
5966
5967 (defun insert-directory-safely (file switches
5968 &optional wildcard full-directory-p)
5969 "Insert directory listing for FILE, formatted according to SWITCHES.
5970
5971 Like `insert-directory', but if FILE does not exist, it inserts a
5972 message to that effect instead of signaling an error."
5973 (if (file-exists-p file)
5974 (insert-directory file switches wildcard full-directory-p)
5975 ;; Simulate the message printed by `ls'.
5976 (insert (format "%s: No such file or directory\n" file))))
5977
5978 (defvar kill-emacs-query-functions nil
5979 "Functions to call with no arguments to query about killing Emacs.
5980 If any of these functions returns nil, killing Emacs is cancelled.
5981 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5982 the low level primitive, does not. See also `kill-emacs-hook'.")
5983
5984 (defcustom confirm-kill-emacs nil
5985 "How to ask for confirmation when leaving Emacs.
5986 If nil, the default, don't ask at all. If the value is non-nil, it should
5987 be a predicate function such as `yes-or-no-p'."
5988 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5989 (const :tag "Ask with y-or-n-p" y-or-n-p)
5990 (const :tag "Don't confirm" nil))
5991 :group 'convenience
5992 :version "21.1")
5993
5994 (defun save-buffers-kill-emacs (&optional arg)
5995 "Offer to save each buffer, then kill this Emacs process.
5996 With prefix ARG, silently save all file-visiting buffers, then kill."
5997 (interactive "P")
5998 (save-some-buffers arg t)
5999 (and (or (not (memq t (mapcar (function
6000 (lambda (buf) (and (buffer-file-name buf)
6001 (buffer-modified-p buf))))
6002 (buffer-list))))
6003 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6004 (or (not (fboundp 'process-list))
6005 ;; process-list is not defined on MSDOS.
6006 (let ((processes (process-list))
6007 active)
6008 (while processes
6009 (and (memq (process-status (car processes)) '(run stop open listen))
6010 (process-query-on-exit-flag (car processes))
6011 (setq active t))
6012 (setq processes (cdr processes)))
6013 (or (not active)
6014 (list-processes t)
6015 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
6016 ;; Query the user for other things, perhaps.
6017 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
6018 (or (null confirm-kill-emacs)
6019 (funcall confirm-kill-emacs "Really exit Emacs? "))
6020 (kill-emacs)))
6021
6022 (defun save-buffers-kill-terminal (&optional arg)
6023 "Offer to save each buffer, then kill the current connection.
6024 If the current frame has no client, kill Emacs itself.
6025
6026 With prefix ARG, silently save all file-visiting buffers, then kill.
6027
6028 If emacsclient was started with a list of filenames to edit, then
6029 only these files will be asked to be saved."
6030 (interactive "P")
6031 (if (frame-parameter (selected-frame) 'client)
6032 (server-save-buffers-kill-terminal arg)
6033 (save-buffers-kill-emacs arg)))
6034 \f
6035 ;; We use /: as a prefix to "quote" a file name
6036 ;; so that magic file name handlers will not apply to it.
6037
6038 (setq file-name-handler-alist
6039 (cons (cons (purecopy "\\`/:") 'file-name-non-special)
6040 file-name-handler-alist))
6041
6042 ;; We depend on being the last handler on the list,
6043 ;; so that anything else which does need handling
6044 ;; has been handled already.
6045 ;; So it is safe for us to inhibit *all* magic file name handlers.
6046
6047 (defun file-name-non-special (operation &rest arguments)
6048 (let ((file-name-handler-alist nil)
6049 (default-directory
6050 (if (eq operation 'insert-directory)
6051 (directory-file-name
6052 (expand-file-name
6053 (unhandled-file-name-directory default-directory)))
6054 default-directory))
6055 ;; Get a list of the indices of the args which are file names.
6056 (file-arg-indices
6057 (cdr (or (assq operation
6058 ;; The first six are special because they
6059 ;; return a file name. We want to include the /:
6060 ;; in the return value.
6061 ;; So just avoid stripping it in the first place.
6062 '((expand-file-name . nil)
6063 (file-name-directory . nil)
6064 (file-name-as-directory . nil)
6065 (directory-file-name . nil)
6066 (file-name-sans-versions . nil)
6067 (find-backup-file-name . nil)
6068 ;; `identity' means just return the first arg
6069 ;; not stripped of its quoting.
6070 (substitute-in-file-name identity)
6071 ;; `add' means add "/:" to the result.
6072 (file-truename add 0)
6073 ;; `quote' means add "/:" to buffer-file-name.
6074 (insert-file-contents quote 0)
6075 ;; `unquote-then-quote' means set buffer-file-name
6076 ;; temporarily to unquoted filename.
6077 (verify-visited-file-modtime unquote-then-quote)
6078 ;; List the arguments which are filenames.
6079 (file-name-completion 1)
6080 (file-name-all-completions 1)
6081 (write-region 2 5)
6082 (rename-file 0 1)
6083 (copy-file 0 1)
6084 (make-symbolic-link 0 1)
6085 (add-name-to-file 0 1)))
6086 ;; For all other operations, treat the first argument only
6087 ;; as the file name.
6088 '(nil 0))))
6089 method
6090 ;; Copy ARGUMENTS so we can replace elements in it.
6091 (arguments (copy-sequence arguments)))
6092 (if (symbolp (car file-arg-indices))
6093 (setq method (pop file-arg-indices)))
6094 ;; Strip off the /: from the file names that have it.
6095 (save-match-data
6096 (while (consp file-arg-indices)
6097 (let ((pair (nthcdr (car file-arg-indices) arguments)))
6098 (and (car pair)
6099 (string-match "\\`/:" (car pair))
6100 (setcar pair
6101 (if (= (length (car pair)) 2)
6102 "/"
6103 (substring (car pair) 2)))))
6104 (setq file-arg-indices (cdr file-arg-indices))))
6105 (cond ((eq method 'identity)
6106 (car arguments))
6107 ((eq method 'add)
6108 (concat "/:" (apply operation arguments)))
6109 ((eq method 'quote)
6110 (unwind-protect
6111 (apply operation arguments)
6112 (setq buffer-file-name (concat "/:" buffer-file-name))))
6113 ((eq method 'unquote-then-quote)
6114 (let (res)
6115 (setq buffer-file-name (substring buffer-file-name 2))
6116 (setq res (apply operation arguments))
6117 (setq buffer-file-name (concat "/:" buffer-file-name))
6118 res))
6119 (t
6120 (apply operation arguments)))))
6121 \f
6122 ;; Symbolic modes and read-file-modes.
6123
6124 (defun file-modes-char-to-who (char)
6125 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6126 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6127 Others, or All) for whom to produce the mask.
6128 The bit-mask that is returned extracts from mode bits the access rights
6129 for the specified category of users."
6130 (cond ((= char ?u) #o4700)
6131 ((= char ?g) #o2070)
6132 ((= char ?o) #o1007)
6133 ((= char ?a) #o7777)
6134 (t (error "%c: bad `who' character" char))))
6135
6136 (defun file-modes-char-to-right (char &optional from)
6137 "Convert CHAR to a numeric value of mode bits.
6138 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6139 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6140 (or from (setq from 0))
6141 (cond ((= char ?r) #o0444)
6142 ((= char ?w) #o0222)
6143 ((= char ?x) #o0111)
6144 ((= char ?s) #o1000)
6145 ((= char ?t) #o6000)
6146 ;; Rights relative to the previous file modes.
6147 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
6148 ((= char ?u) (let ((uright (logand #o4700 from)))
6149 (+ uright (/ uright #o10) (/ uright #o100))))
6150 ((= char ?g) (let ((gright (logand #o2070 from)))
6151 (+ gright (/ gright #o10) (* gright #o10))))
6152 ((= char ?o) (let ((oright (logand #o1007 from)))
6153 (+ oright (* oright #o10) (* oright #o100))))
6154 (t (error "%c: bad right character" char))))
6155
6156 (defun file-modes-rights-to-number (rights who-mask &optional from)
6157 "Convert a symbolic mode string specification to an equivalent number.
6158 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6159 WHO-MASK is the bit-mask specifying the category of users to which to
6160 apply the access permissions. See `file-modes-char-to-who'.
6161 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6162 RIGHTS request to add, remove, or set permissions based on existing ones,
6163 as in \"og+rX-w\"."
6164 (let* ((num-rights (or from 0))
6165 (list-rights (string-to-list rights))
6166 (op (pop list-rights)))
6167 (while (memq op '(?+ ?- ?=))
6168 (let ((num-right 0)
6169 char-right)
6170 (while (memq (setq char-right (pop list-rights))
6171 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
6172 (setq num-right
6173 (logior num-right
6174 (file-modes-char-to-right char-right num-rights))))
6175 (setq num-right (logand who-mask num-right)
6176 num-rights
6177 (cond ((= op ?+) (logior num-rights num-right))
6178 ((= op ?-) (logand num-rights (lognot num-right)))
6179 (t (logior (logand num-rights (lognot who-mask)) num-right)))
6180 op char-right)))
6181 num-rights))
6182
6183 (defun file-modes-symbolic-to-number (modes &optional from)
6184 "Convert symbolic file modes to numeric file modes.
6185 MODES is the string to convert, it should match
6186 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6187 See (info \"(coreutils)File permissions\") for more information on this
6188 notation.
6189 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6190 MODES request to add, remove, or set permissions based on existing ones,
6191 as in \"og+rX-w\"."
6192 (save-match-data
6193 (let ((case-fold-search nil)
6194 (num-modes (or from 0)))
6195 (while (/= (string-to-char modes) 0)
6196 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6197 (let ((num-who (apply 'logior 0
6198 (mapcar 'file-modes-char-to-who
6199 (match-string 1 modes)))))
6200 (when (= num-who 0)
6201 (setq num-who (default-file-modes)))
6202 (setq num-modes
6203 (file-modes-rights-to-number (substring modes (match-end 1))
6204 num-who num-modes)
6205 modes (substring modes (match-end 3))))
6206 (error "Parse error in modes near `%s'" (substring modes 0))))
6207 num-modes)))
6208
6209 (defun read-file-modes (&optional prompt orig-file)
6210 "Read file modes in octal or symbolic notation and return its numeric value.
6211 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6212 ORIG-FILE is the name of a file on whose mode bits to base returned
6213 permissions if what user types requests to add, remove, or set permissions
6214 based on existing mode bits, as in \"og+rX-w\"."
6215 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6216 (error "File not found")))
6217 (modestr (and (stringp orig-file)
6218 (nth 8 (file-attributes orig-file))))
6219 (default
6220 (and (stringp modestr)
6221 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6222 (replace-regexp-in-string
6223 "-" ""
6224 (format "u=%s,g=%s,o=%s"
6225 (match-string 1 modestr)
6226 (match-string 2 modestr)
6227 (match-string 3 modestr)))))
6228 (value (read-string (or prompt "File modes (octal or symbolic): ")
6229 nil nil default)))
6230 (save-match-data
6231 (if (string-match "^[0-7]+" value)
6232 (string-to-number value 8)
6233 (file-modes-symbolic-to-number value modes)))))
6234
6235 \f
6236 ;; Trashcan handling.
6237 (defcustom trash-directory nil
6238 "Directory for `move-file-to-trash' to move files and directories to.
6239 This directory is only used when the function `system-move-file-to-trash'
6240 is not defined.
6241 Relative paths are interpreted relative to `default-directory'.
6242 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6243 :type '(choice (const nil) directory)
6244 :group 'auto-save
6245 :version "23.2")
6246
6247 (defvar trash--hexify-table)
6248
6249 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6250
6251 (defun move-file-to-trash (filename)
6252 "Move the file (or directory) named FILENAME to the trash.
6253 When `delete-by-moving-to-trash' is non-nil, this function is
6254 called by `delete-file' and `delete-directory' instead of
6255 deleting files outright.
6256
6257 If the function `system-move-file-to-trash' is defined, call it
6258 with FILENAME as an argument.
6259 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6260 directory.
6261 Otherwise, trash FILENAME using the freedesktop.org conventions,
6262 like the GNOME, KDE and XFCE desktop environments. Emacs only
6263 moves files to \"home trash\", ignoring per-volume trashcans."
6264 (interactive "fMove file to trash: ")
6265 (cond (trash-directory
6266 ;; If `trash-directory' is non-nil, move the file there.
6267 (let* ((trash-dir (expand-file-name trash-directory))
6268 (fn (directory-file-name (expand-file-name filename)))
6269 (new-fn (expand-file-name (file-name-nondirectory fn)
6270 trash-dir)))
6271 ;; We can't trash a parent directory of trash-directory.
6272 (if (string-match fn trash-dir)
6273 (error "Trash directory `%s' is a subdirectory of `%s'"
6274 trash-dir filename))
6275 (unless (file-directory-p trash-dir)
6276 (make-directory trash-dir t))
6277 ;; Ensure that the trashed file-name is unique.
6278 (if (file-exists-p new-fn)
6279 (let ((version-control t)
6280 (backup-directory-alist nil))
6281 (setq new-fn (car (find-backup-file-name new-fn)))))
6282 (let (delete-by-moving-to-trash)
6283 (rename-file fn new-fn))))
6284 ;; If `system-move-file-to-trash' is defined, use it.
6285 ((fboundp 'system-move-file-to-trash)
6286 (system-move-file-to-trash filename))
6287 ;; Otherwise, use the freedesktop.org method, as specified at
6288 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6289 (t
6290 (let* ((xdg-data-dir
6291 (directory-file-name
6292 (expand-file-name "Trash"
6293 (or (getenv "XDG_DATA_HOME")
6294 "~/.local/share"))))
6295 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6296 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6297 (fn (directory-file-name (expand-file-name filename))))
6298
6299 ;; Check if we have permissions to delete.
6300 (unless (file-writable-p (directory-file-name
6301 (file-name-directory fn)))
6302 (error "Cannot move %s to trash: Permission denied" filename))
6303 ;; The trashed file cannot be the trash dir or its parent.
6304 (if (string-match fn trash-files-dir)
6305 (error "The trash directory %s is a subdirectory of %s"
6306 trash-files-dir filename))
6307 (if (string-match fn trash-info-dir)
6308 (error "The trash directory %s is a subdirectory of %s"
6309 trash-info-dir filename))
6310
6311 ;; Ensure that the trash directory exists; otherwise, create it.
6312 (let ((saved-default-file-modes (default-file-modes)))
6313 (set-default-file-modes ?\700)
6314 (unless (file-exists-p trash-files-dir)
6315 (make-directory trash-files-dir t))
6316 (unless (file-exists-p trash-info-dir)
6317 (make-directory trash-info-dir t))
6318 (set-default-file-modes saved-default-file-modes))
6319
6320 ;; Try to move to trash with .trashinfo undo information
6321 (save-excursion
6322 (with-temp-buffer
6323 (set-buffer-file-coding-system 'utf-8-unix)
6324 (insert "[Trash Info]\nPath=")
6325 ;; Perform url-encoding on FN. For compatibility with
6326 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6327 ;; for path separators.
6328 (unless (boundp 'trash--hexify-table)
6329 (setq trash--hexify-table (make-vector 256 nil))
6330 (let ((unreserved-chars
6331 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6332 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6333 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6334 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6335 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6336 ?\( ?\))))
6337 (dotimes (byte 256)
6338 (aset trash--hexify-table byte
6339 (if (memq byte unreserved-chars)
6340 (char-to-string byte)
6341 (format "%%%02x" byte))))))
6342 (mapc (lambda (byte)
6343 (insert (aref trash--hexify-table byte)))
6344 (if (multibyte-string-p fn)
6345 (encode-coding-string fn 'utf-8)
6346 fn))
6347 (insert "\nDeletionDate="
6348 (format-time-string "%Y-%m-%dT%T")
6349 "\n")
6350
6351 ;; Attempt to make .trashinfo file, trying up to 5
6352 ;; times. The .trashinfo file is opened with O_EXCL,
6353 ;; as per trash-spec 0.7, even if that can be a problem
6354 ;; on old NFS versions...
6355 (let* ((tries 5)
6356 (base-fn (expand-file-name
6357 (file-name-nondirectory fn)
6358 trash-files-dir))
6359 (new-fn base-fn)
6360 success info-fn)
6361 (while (> tries 0)
6362 (setq info-fn (expand-file-name
6363 (concat (file-name-nondirectory new-fn)
6364 ".trashinfo")
6365 trash-info-dir))
6366 (unless (condition-case nil
6367 (progn
6368 (write-region nil nil info-fn nil
6369 'quiet info-fn 'excl)
6370 (setq tries 0 success t))
6371 (file-already-exists nil))
6372 (setq tries (1- tries))
6373 ;; Uniqify new-fn. (Some file managers do not
6374 ;; like Emacs-style backup file names---e.g. bug
6375 ;; 170956 in Konqueror bug tracker.)
6376 (setq new-fn (make-temp-name (concat base-fn "_")))))
6377 (unless success
6378 (error "Cannot move %s to trash: Lock failed" filename))
6379
6380 ;; Finally, try to move the file to the trashcan.
6381 (let ((delete-by-moving-to-trash nil))
6382 (rename-file fn new-fn)))))))))
6383
6384 \f
6385 (define-key ctl-x-map "\C-f" 'find-file)
6386 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6387 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6388 (define-key ctl-x-map "\C-s" 'save-buffer)
6389 (define-key ctl-x-map "s" 'save-some-buffers)
6390 (define-key ctl-x-map "\C-w" 'write-file)
6391 (define-key ctl-x-map "i" 'insert-file)
6392 (define-key esc-map "~" 'not-modified)
6393 (define-key ctl-x-map "\C-d" 'list-directory)
6394 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6395 (define-key ctl-x-map "\C-q" 'toggle-read-only)
6396
6397 (define-key ctl-x-4-map "f" 'find-file-other-window)
6398 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6399 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6400 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6401 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6402
6403 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6404 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6405 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6406 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6407 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6408
6409 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6410 ;;; files.el ends here