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