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