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