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