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