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