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