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