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