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