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