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