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