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