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