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