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