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