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